gateway: find_interfaceName only works in multi-gateway mode
[olsrd.git] / src / gateway.c
1 /*
2  * gateway.c
3  *
4  *  Created on: 05.01.2010
5  *      Author: henning
6  */
7
8 #ifdef __linux__
9
10 #include "common/avl.h"
11 #include "defs.h"
12 #include "ipcalc.h"
13 #include "olsr.h"
14 #include "olsr_cfg.h"
15 #include "olsr_cookie.h"
16 #include "scheduler.h"
17 #include "kernel_routes.h"
18 #include "kernel_tunnel.h"
19 #include "net_os.h"
20 #include "duplicate_set.h"
21 #include "log.h"
22 #include "gateway_default_handler.h"
23 #include "gateway_list.h"
24 #include "gateway.h"
25
26 #include <assert.h>
27 #include <net/if.h>
28
29 /*
30  * Defines for the multi-gateway script
31  */
32
33 #define SCRIPT_MODE_GENERIC   "generic"
34 #define SCRIPT_MODE_OLSRIF    "olsrif"
35 #define SCRIPT_MODE_SGWSRVTUN "sgwsrvtun"
36 #define SCRIPT_MODE_EGRESSIF  "egressif"
37 #define SCRIPT_MODE_SGWTUN    "sgwtun"
38
39 /** structure that holds an interface name, mark and a pointer to the gateway that uses it */
40 struct interfaceName {
41   char name[IFNAMSIZ]; /**< interface name */
42   uint8_t mark; /**< marking */
43   struct gateway_entry *gw; /**< gateway that uses this interface name */
44 };
45
46 /** the gateway tree */
47 struct avl_tree gateway_tree;
48
49 /** gateway cookie */
50 static struct olsr_cookie_info *gateway_entry_mem_cookie = NULL;
51
52 /** gateway container cookie */
53 static struct olsr_cookie_info *gw_container_entry_mem_cookie = NULL;
54
55 /** the gateway netmask for the HNA */
56 static uint8_t smart_gateway_netmask[sizeof(union olsr_ip_addr)];
57
58 /** the gateway handler/plugin */
59 static struct olsr_gw_handler *gw_handler;
60
61 /** the IPv4 gateway list */
62 static struct gw_list gw_list_ipv4;
63
64 /** the IPv6 gateway list */
65 static struct gw_list gw_list_ipv6;
66
67 /** the current IPv4 gateway */
68 static struct gw_container_entry *current_ipv4_gw;
69
70 /** the current IPv6 gateway */
71 static struct gw_container_entry *current_ipv6_gw;
72
73 /** interface names for smart gateway egress interfaces */
74 struct interfaceName * sgwEgressInterfaceNames;
75
76 /** interface names for smart gateway tunnel interfaces, IPv4 */
77 struct interfaceName * sgwTunnel4InterfaceNames;
78
79 /** interface names for smart gateway tunnel interfaces, IPv6 */
80 struct interfaceName * sgwTunnel6InterfaceNames;
81
82 /*
83  * Forward Declarations
84  */
85
86 static void olsr_delete_gateway_tree_entry(struct gateway_entry * gw, uint8_t prefixlen, bool immediate);
87
88 /*
89  * Helper Functions
90  */
91
92 /**
93  * @return the gateway 'server' tunnel name to use
94  */
95 static inline const char * server_tunnel_name(void) {
96   return (olsr_cnf->ip_version == AF_INET ? TUNNEL_ENDPOINT_IF : TUNNEL_ENDPOINT_IF6);
97 }
98
99 /**
100  * Convert the netmask of the HNA (in the form of an IP address) to a HNA
101  * pointer.
102  *
103  * @param mask the netmask of the HNA (in the form of an IP address)
104  * @param prefixlen the prefix length
105  * @return a pointer to the HNA
106  */
107 static inline uint8_t * hna_mask_to_hna_pointer(union olsr_ip_addr *mask, int prefixlen) {
108   return (((uint8_t *)mask) + ((prefixlen+7)/8));
109 }
110
111 /**
112  * @return true if multi-gateway mode is enabled
113  */
114 static inline bool multi_gateway_mode(void) {
115   return (olsr_cnf->smart_gw_use_count > 1);
116 }
117
118 /**
119  * Convert an encoded 1 byte transport value (5 bits mantissa, 3 bits exponent)
120  * to an uplink/downlink speed value
121  *
122  * @param value the encoded 1 byte transport value
123  * @return the uplink/downlink speed value (in kbit/s)
124  */
125 static uint32_t deserialize_gw_speed(uint8_t value) {
126   uint32_t speed;
127   uint32_t exp;
128
129   if (!value) {
130     /* 0 and 1 alias onto 0 during serialisation. We take 0 here to mean 0 and
131      * not 1 (since a bandwidth of 1 is no bandwidth at all really) */
132     return 0;
133   }
134
135   speed = (value >> 3) + 1;
136   exp = value & 7;
137
138   while (exp-- > 0) {
139     speed *= 10;
140   }
141   return speed;
142 }
143
144 /**
145  * Convert an uplink/downlink speed value into an encoded 1 byte transport
146  * value (5 bits mantissa, 3 bits exponent)
147  *
148  * @param speed the uplink/downlink speed value (in kbit/s)
149  * @return value the encoded 1 byte transport value
150  */
151 static uint8_t serialize_gw_speed(uint32_t speed) {
152   uint8_t exp = 0;
153
154   if (speed == 0) {
155     return 0;
156   }
157
158   if (speed > 320000000) {
159     return 0xff;
160   }
161
162   while ((speed > 32 || (speed % 10) == 0) && exp < 7) {
163     speed /= 10;
164     exp++;
165   }
166   return ((speed - 1) << 3) | exp;
167 }
168
169 /**
170  * Find an interfaceName struct corresponding to a certain gateway
171  * (when gw != NULL) or to an empty interfaceName struct (when gw == NULL).
172  *
173  * @param gw the gateway to find (when not NULL), or the empty struct to find (when NULL)
174  * @return a pointer to the struct, or NULL when not found
175  */
176 static struct interfaceName * find_interfaceName(struct gateway_entry *gw) {
177   struct interfaceName * sgwTunnelInterfaceNames;
178   uint8_t i = 0;
179
180   if (!multi_gateway_mode()) {
181     return NULL;
182   }
183
184   assert(sgwTunnel4InterfaceNames);
185   assert(sgwTunnel6InterfaceNames);
186
187   sgwTunnelInterfaceNames = (olsr_cnf->ip_version == AF_INET) ? sgwTunnel4InterfaceNames : sgwTunnel6InterfaceNames;
188   while (i < olsr_cnf->smart_gw_use_count) {
189     struct interfaceName * ifn = &sgwTunnelInterfaceNames[i];
190     if (ifn->gw == gw) {
191       return ifn;
192     }
193     i++;
194   }
195
196   return NULL;
197 }
198
199 /**
200  * Get an unused olsr ipip tunnel name for a certain gateway and store it in name.
201  *
202  * @param gw pointer to the gateway
203  * @param name pointer to output buffer (length IFNAMSIZ)
204  * @param interfaceName a pointer to the location where to store a pointer to the interfaceName struct
205  */
206 static void get_unused_iptunnel_name(struct gateway_entry *gw, char * name, struct interfaceName ** interfaceName) {
207   static uint32_t counter = 0;
208
209   assert(gw);
210   assert(name);
211   assert(interfaceName);
212
213   memset(name, 0, IFNAMSIZ);
214
215   if (multi_gateway_mode()) {
216     struct interfaceName * ifn = find_interfaceName(NULL);
217
218     if (ifn) {
219       strncpy(&name[0], &ifn->name[0], sizeof(ifn->name));
220       *interfaceName = ifn;
221       ifn->gw = gw;
222       return;
223     }
224
225     /* do not return, fall-through to classic naming as fallback */
226   }
227
228   snprintf(name, IFNAMSIZ, "tnl_%08x", (olsr_cnf->ip_version == AF_INET) ? gw->originator.v4.s_addr : ++counter);
229   *interfaceName = NULL;
230 }
231
232 /**
233  * Set an olsr ipip tunnel name that is used by a certain gateway as unused
234  *
235  * @param gw pointer to the gateway
236  */
237 static void set_unused_iptunnel_name(struct gateway_entry *gw) {
238   struct interfaceName * ifn;
239
240   if (!multi_gateway_mode()) {
241     return;
242   }
243
244   assert(gw);
245
246   ifn = find_interfaceName(gw);
247   if (ifn) {
248     ifn->gw = NULL;
249     return;
250   }
251 }
252
253 /**
254  * Run the multi-gateway script/
255  *
256  * @param mode the mode (see SCRIPT_MODE_* defines)
257  * @param add true to add policy routing, false to remove it
258  * @param ifname the interface name (optional)
259  * @param ifmark the interface mark (optional
260  * @return true when successful
261  */
262 static bool multiGwRunScript(const char * mode, bool add, const char * ifname, uint8_t * ifmark) {
263   struct autobuf buf;
264   int r;
265
266   abuf_init(&buf, 1024);
267
268   abuf_appendf(&buf, "\"%s\"", olsr_cnf->smart_gw_policyrouting_script);
269
270   abuf_appendf(&buf, " \"%s\"", (olsr_cnf->ip_version == AF_INET) ? "ipv4" : "ipv6");
271
272   assert(!strcmp(mode, SCRIPT_MODE_GENERIC) || !strcmp(mode, SCRIPT_MODE_OLSRIF) ||
273       !strcmp(mode, SCRIPT_MODE_SGWSRVTUN) || !strcmp(mode, SCRIPT_MODE_EGRESSIF) ||
274       !strcmp(mode, SCRIPT_MODE_SGWTUN));
275   abuf_appendf(&buf, " \"%s\"", mode);
276
277   abuf_appendf(&buf, " \"%s\"", add ? "add" : "del");
278
279   if (ifname) {
280     assert(!strcmp(mode, SCRIPT_MODE_OLSRIF) || !strcmp(mode, SCRIPT_MODE_SGWSRVTUN) ||
281         !strcmp(mode, SCRIPT_MODE_EGRESSIF) || !strcmp(mode, SCRIPT_MODE_SGWTUN));
282     abuf_appendf(&buf, " \"%s\"", ifname);
283   } else {
284     assert(!strcmp(mode, SCRIPT_MODE_GENERIC));
285   }
286   if (ifmark) {
287     assert(!strcmp(mode, SCRIPT_MODE_EGRESSIF) || !strcmp(mode, SCRIPT_MODE_SGWTUN));
288     assert(ifname);
289     abuf_appendf(&buf, " \"%u\"", *ifmark);
290   } else {
291     assert(!strcmp(mode, SCRIPT_MODE_GENERIC) || !strcmp(mode, SCRIPT_MODE_OLSRIF) ||
292       !strcmp(mode, SCRIPT_MODE_SGWSRVTUN));
293   }
294
295   r = system(buf.buf);
296
297   abuf_free(&buf);
298
299   return (r == 0);
300 }
301
302 /**
303  * Setup generic multi-gateway iptables and ip rules
304  *
305  * - generic (on olsrd start/stop)
306  * iptablesExecutable -t mangle -A OUTPUT -j CONNMARK --restore-mark
307  *
308  * @param add true to add policy routing, false to remove it
309  * @return true when successful
310  */
311 static bool multiGwRulesGeneric(bool add) {
312   return multiGwRunScript(SCRIPT_MODE_GENERIC, add, NULL, NULL);
313 }
314
315 /**
316  * Setup multi-gateway iptables and ip rules for all OLSR interfaces.
317  *
318  * - olsr interfaces (on olsrd start/stop)
319  * iptablesExecutable -t mangle -A PREROUTING -i ${olsrInterface} -j CONNMARK --restore-mark
320  *
321  * @param add true to add policy routing, false to remove it
322  * @return true when successful
323  */
324 static bool multiGwRulesOlsrInterfaces(bool add) {
325   bool ok = true;
326   struct interface * ifn;
327
328   for (ifn = ifnet; ifn; ifn = ifn->int_next) {
329     if (!multiGwRunScript(SCRIPT_MODE_OLSRIF, add, ifn->int_name, NULL)) {
330       ok = false;
331       if (add) {
332         return ok;
333       }
334     }
335   }
336
337   return ok;
338 }
339
340 /**
341  * Setup multi-gateway iptables and ip rules for the smart gateway server tunnel.
342  *
343  * - sgw server tunnel interface (on olsrd start/stop)
344  * iptablesExecutable -t mangle -A PREROUTING  -i tunl0 -j CONNMARK --restore-mark
345  *
346  * @param add true to add policy routing, false to remove it
347  * @return true when successful
348  */
349 static bool multiGwRulesSgwServerTunnel(bool add) {
350   return multiGwRunScript(SCRIPT_MODE_SGWSRVTUN, add, server_tunnel_name(), NULL);
351 }
352
353 /**
354  * Setup multi-gateway iptables and ip rules for all egress interfaces.
355  *
356  * - egress interfaces (on interface start/stop)
357  * iptablesExecutable -t mangle -A POSTROUTING -m conntrack --ctstate NEW -o ${egressInterface} -j CONNMARK --set-mark ${egressInterfaceMark}
358  * iptablesExecutable -t mangle -A INPUT       -m conntrack --ctstate NEW -i ${egressInterface} -j CONNMARK --set-mark ${egressInterfaceMark}
359  * ip rule add fwmark ${egressInterfaceMark} table ${egressInterfaceMark} pref ${egressInterfaceMark}
360  *
361  * like table:
362  * ppp0 91
363  * eth0 92
364  *
365  * @param add true to add policy routing, false to remove it
366  * @return true when successful
367  */
368 static bool multiGwRulesEgressInterfaces(bool add) {
369   bool ok = true;
370   unsigned int i = 0;
371
372   for (i = 0; i < olsr_cnf->smart_gw_egress_interfaces_count; i++) {
373     struct interfaceName * ifn = &sgwEgressInterfaceNames[i];
374     if (!multiGwRunScript(SCRIPT_MODE_EGRESSIF, add, ifn->name, &ifn->mark)) {
375       ok = false;
376       if (add) {
377         return ok;
378       }
379     }
380   }
381
382   return ok;
383 }
384
385 /**
386  * Setup multi-gateway iptables and ip rules for the smart gateway client tunnels.
387  *
388  * - sgw tunnels (on sgw tunnel start/stop)
389  * iptablesExecutable -t mangle -A POSTROUTING -m conntrack --ctstate NEW -o ${sgwTunnelInterface} -j CONNMARK --set-mark ${sgwTunnelInterfaceMark}
390  * ip rule add fwmark ${sgwTunnelInterfaceMark} table ${sgwTunnelInterfaceMark} pref ${sgwTunnelInterfaceMark}
391  *
392  * like table:
393  * tnl_101 101
394  * tnl_102 102
395  * tnl_103 103
396  * tnl_104 104
397  * tnl_105 105
398  * tnl_106 106
399  * tnl_107 107
400  * tnl_108 108
401  */
402 static bool multiGwRulesSgwTunnels(bool add) {
403   bool ok = true;
404   unsigned int i = 0;
405
406   while (i < olsr_cnf->smart_gw_use_count) {
407     struct interfaceName * ifn = (olsr_cnf->ip_version == AF_INET) ? &sgwTunnel4InterfaceNames[i] : &sgwTunnel6InterfaceNames[i];
408     if (!multiGwRunScript(SCRIPT_MODE_SGWTUN, add, ifn->name, &ifn->mark)) {
409       ok = false;
410       if (add) {
411         return ok;
412       }
413     }
414
415     i++;
416   }
417
418   return ok;
419 }
420
421 /*
422  * Callback Functions
423  */
424
425 /**
426  * Callback for tunnel interface monitoring which will set the route into the tunnel
427  * when the interface comes up again.
428  *
429  * @param if_index the interface index
430  * @param ifh the interface
431  * @param flag interface change flags
432  */
433 static void smartgw_tunnel_monitor(int if_index __attribute__ ((unused)),
434     struct interface *ifh __attribute__ ((unused)), enum olsr_ifchg_flag flag __attribute__ ((unused))) {
435   return;
436 }
437
438 /**
439  * Timer callback to remove and cleanup a gateway entry
440  *
441  * @param ptr
442  */
443 static void cleanup_gateway_handler(void *ptr) {
444   struct gateway_entry *gw = ptr;
445
446   if (gw->ipv4 || gw->ipv6) {
447     /* do not clean it up when it is in use */
448     return;
449   }
450
451   /* remove gateway entry */
452   avl_delete(&gateway_tree, &gw->node);
453   olsr_cookie_free(gateway_entry_mem_cookie, gw);
454 }
455
456 /*
457  * Main Interface
458  */
459
460 /**
461  * Initialize gateway system
462  */
463 int olsr_init_gateways(void) {
464   gateway_entry_mem_cookie = olsr_alloc_cookie("gateway_entry_mem_cookie", OLSR_COOKIE_TYPE_MEMORY);
465   olsr_cookie_set_memory_size(gateway_entry_mem_cookie, sizeof(struct gateway_entry));
466
467   gw_container_entry_mem_cookie = olsr_alloc_cookie("gw_container_entry_mem_cookie", OLSR_COOKIE_TYPE_MEMORY);
468   olsr_cookie_set_memory_size(gw_container_entry_mem_cookie, sizeof(struct gw_container_entry));
469
470   avl_init(&gateway_tree, avl_comp_default);
471
472   olsr_gw_list_init(&gw_list_ipv4, olsr_cnf->smart_gw_use_count);
473   olsr_gw_list_init(&gw_list_ipv6, olsr_cnf->smart_gw_use_count);
474
475   if (!multi_gateway_mode()) {
476     sgwEgressInterfaceNames = NULL;
477     sgwTunnel4InterfaceNames = NULL;
478     sgwTunnel6InterfaceNames = NULL;
479   } else {
480     uint8_t i;
481     struct sgw_egress_if * egressif;
482
483     /* setup the egress interface name/mark pairs */
484     sgwEgressInterfaceNames = olsr_malloc(sizeof(struct interfaceName) * olsr_cnf->smart_gw_egress_interfaces_count, "sgwEgressInterfaceNames");
485     i = 0;
486     egressif = olsr_cnf->smart_gw_egress_interfaces;
487     while (egressif) {
488       struct interfaceName * ifn = &sgwEgressInterfaceNames[i];
489       ifn->gw = NULL;
490       ifn->mark = i + olsr_cnf->smart_gw_mark_offset_egress;
491       egressif->mark = ifn->mark;
492       snprintf(&ifn->name[0], sizeof(ifn->name), egressif->name, egressif->mark);
493
494       egressif = egressif->next;
495       i++;
496     }
497     assert(i == olsr_cnf->smart_gw_egress_interfaces_count);
498
499     /* setup the SGW tunnel name/mark pairs */
500     sgwTunnel4InterfaceNames = olsr_malloc(sizeof(struct interfaceName) * olsr_cnf->smart_gw_use_count, "sgwTunnel4InterfaceNames");
501     sgwTunnel6InterfaceNames = olsr_malloc(sizeof(struct interfaceName) * olsr_cnf->smart_gw_use_count, "sgwTunnel6InterfaceNames");
502     for (i = 0; i < olsr_cnf->smart_gw_use_count; i++) {
503       struct interfaceName * ifn = &sgwTunnel4InterfaceNames[i];
504       ifn->gw = NULL;
505       ifn->mark = i + olsr_cnf->smart_gw_mark_offset_tunnels;
506       snprintf(&ifn->name[0], sizeof(ifn->name), "tnl_4%03u", ifn->mark);
507
508       ifn = &sgwTunnel6InterfaceNames[i];
509       ifn->gw = NULL;
510       ifn->mark = i + olsr_cnf->smart_gw_mark_offset_tunnels;
511       snprintf(&ifn->name[0], sizeof(ifn->name), "tnl_6%03u", ifn->mark);
512     }
513   }
514
515   current_ipv4_gw = NULL;
516   current_ipv6_gw = NULL;
517
518   gw_handler = NULL;
519
520   refresh_smartgw_netmask();
521
522   /* initialize default gateway handler */
523   gw_handler = &gw_def_handler;
524   gw_handler->init();
525
526   if (olsr_os_init_iptunnel(server_tunnel_name())) {
527     return 1;
528   }
529
530   olsr_add_ifchange_handler(smartgw_tunnel_monitor);
531
532   return 0;
533 }
534
535 /**
536  * Startup gateway system
537  */
538 int olsr_startup_gateways(void) {
539   bool ok = true;
540
541   if (!multi_gateway_mode()) {
542     return 0;
543   }
544
545   ok = ok && multiGwRulesGeneric(true);
546   ok = ok && multiGwRulesSgwServerTunnel(true);
547   ok = ok && multiGwRulesOlsrInterfaces(true);
548   ok = ok && multiGwRulesEgressInterfaces(true);
549   ok = ok && multiGwRulesSgwTunnels(true);
550   if (!ok) {
551     olsr_printf(0, "Could not setup multi-gateway iptables and ip rules\n");
552     olsr_shutdown_gateways();
553     return 1;
554   }
555
556   return 0;
557 }
558
559 /**
560  * Shutdown gateway tunnel system
561  */
562 void olsr_shutdown_gateways(void) {
563   if (!multi_gateway_mode()) {
564     return;
565   }
566
567   (void)multiGwRulesSgwTunnels(false);
568   (void)multiGwRulesEgressInterfaces(false);
569   (void)multiGwRulesOlsrInterfaces(false);
570   (void)multiGwRulesSgwServerTunnel(false);
571   (void)multiGwRulesGeneric(false);
572 }
573
574 /**
575  * Cleanup gateway tunnel system
576  */
577 void olsr_cleanup_gateways(void) {
578   struct gateway_entry * tree_gw;
579   struct gw_container_entry * gw;
580
581   olsr_remove_ifchange_handler(smartgw_tunnel_monitor);
582
583   /* remove all gateways in the gateway tree that are not the active gateway */
584   OLSR_FOR_ALL_GATEWAY_ENTRIES(tree_gw) {
585     if ((tree_gw != olsr_get_inet_gateway(false)) && (tree_gw != olsr_get_inet_gateway(true))) {
586       olsr_delete_gateway_tree_entry(tree_gw, FORCE_DELETE_GW_ENTRY, true);
587     }
588   } OLSR_FOR_ALL_GATEWAY_ENTRIES_END(gw)
589
590   /* remove all active IPv4 gateways (should be at most 1 now) */
591   OLSR_FOR_ALL_GWS(&gw_list_ipv4.head, gw) {
592     if (gw && gw->gw) {
593       olsr_delete_gateway_entry(&gw->gw->originator, FORCE_DELETE_GW_ENTRY, true);
594     }
595   }
596   OLSR_FOR_ALL_GWS_END(gw);
597
598   /* remove all active IPv6 gateways (should be at most 1 now) */
599   OLSR_FOR_ALL_GWS(&gw_list_ipv6.head, gw) {
600     if (gw && gw->gw) {
601       olsr_delete_gateway_entry(&gw->gw->originator, FORCE_DELETE_GW_ENTRY, true);
602     }
603   }
604   OLSR_FOR_ALL_GWS_END(gw);
605
606   /* there should be no more gateways */
607   assert(!avl_walk_first(&gateway_tree));
608   assert(!current_ipv4_gw);
609   assert(!current_ipv6_gw);
610
611   olsr_os_cleanup_iptunnel(server_tunnel_name());
612
613   assert(gw_handler);
614   gw_handler->cleanup();
615   gw_handler = NULL;
616
617   if (sgwEgressInterfaceNames) {
618     free(sgwEgressInterfaceNames);
619     sgwEgressInterfaceNames = NULL;
620   }
621   if (sgwTunnel4InterfaceNames) {
622     free(sgwTunnel4InterfaceNames);
623     sgwTunnel4InterfaceNames = NULL;
624   }
625   if (sgwTunnel6InterfaceNames) {
626     free(sgwTunnel6InterfaceNames);
627     sgwTunnel6InterfaceNames = NULL;
628   }
629
630   olsr_gw_list_cleanup(&gw_list_ipv6);
631   olsr_gw_list_cleanup(&gw_list_ipv4);
632   olsr_free_cookie(gw_container_entry_mem_cookie);
633   olsr_free_cookie(gateway_entry_mem_cookie);
634 }
635
636 /**
637  * Triggers the first lookup of a gateway.
638  */
639 void olsr_trigger_inetgw_startup(void) {
640   assert(gw_handler);
641   gw_handler->startup();
642 }
643
644 /**
645  * Print debug information about gateway entries
646  */
647 #ifndef NODEBUG
648 void olsr_print_gateway_entries(void) {
649   struct ipaddr_str buf;
650   struct gateway_entry *gw;
651   const int addrsize = olsr_cnf->ip_version == AF_INET ? (INET_ADDRSTRLEN - 1) : (INET6_ADDRSTRLEN - 1);
652
653   OLSR_PRINTF(0, "\n--- %s ---------------------------------------------------- GATEWAYS\n\n", olsr_wallclock_string());
654   OLSR_PRINTF(0, "%-*s %-6s %-9s %-9s %s\n",
655       addrsize, "IP address", "Type", "Uplink", "Downlink", olsr_cnf->ip_version == AF_INET ? "" : "External Prefix");
656
657   OLSR_FOR_ALL_GATEWAY_ENTRIES(gw) {
658     OLSR_PRINTF(0, "%-*s %s%c%s%c%c %-9u %-9u %s\n",
659         addrsize,
660         olsr_ip_to_string(&buf, &gw->originator),
661         gw->ipv4nat ? "" : "   ",
662         gw->ipv4 ? '4' : ' ',
663         gw->ipv4nat ? "(N)" : "",
664         (gw->ipv4 && gw->ipv6) ? ',' : ' ',
665         gw->ipv6 ? '6' : ' ',
666         gw->uplink,
667         gw->downlink,
668         gw->external_prefix.prefix_len == 0 ? "" : olsr_ip_prefix_to_string(&gw->external_prefix));
669   } OLSR_FOR_ALL_GATEWAY_ENTRIES_END(gw)
670 }
671 #endif /* NODEBUG */
672
673 /*
674  * Tx Path Interface
675  */
676
677 /**
678  * Apply the smart gateway modifications to an outgoing HNA
679  *
680  * @param mask pointer to netmask of the HNA
681  * @param prefixlen of the HNA
682  */
683 void olsr_modifiy_inetgw_netmask(union olsr_ip_addr *mask, int prefixlen) {
684   uint8_t *ptr = hna_mask_to_hna_pointer(mask, prefixlen);
685
686   /* copy the current settings for uplink/downlink into the mask */
687   memcpy(ptr, &smart_gateway_netmask, sizeof(smart_gateway_netmask) - prefixlen / 8);
688   if (olsr_cnf->has_ipv4_gateway) {
689     ptr[GW_HNA_FLAGS] |= GW_HNA_FLAG_IPV4;
690
691     if (olsr_cnf->smart_gw_uplink_nat) {
692       ptr[GW_HNA_FLAGS] |= GW_HNA_FLAG_IPV4_NAT;
693     }
694   }
695   if (olsr_cnf->has_ipv6_gateway) {
696     ptr[GW_HNA_FLAGS] |= GW_HNA_FLAG_IPV6;
697   }
698   if (!olsr_cnf->has_ipv6_gateway || prefixlen != ipv6_internet_route.prefix_len) {
699     ptr[GW_HNA_FLAGS] &= ~GW_HNA_FLAG_IPV6PREFIX;
700   }
701 }
702
703 /*
704  * SgwDynSpeed Plugin Interface
705  */
706
707 /**
708  * Setup the gateway netmask
709  */
710 void refresh_smartgw_netmask(void) {
711   uint8_t *ip;
712
713   /* clear the mask */
714   memset(&smart_gateway_netmask, 0, sizeof(smart_gateway_netmask));
715
716   if (olsr_cnf->smart_gw_active) {
717     ip = (uint8_t *) &smart_gateway_netmask;
718
719     ip[GW_HNA_FLAGS] |= GW_HNA_FLAG_LINKSPEED;
720     ip[GW_HNA_DOWNLINK] = serialize_gw_speed(olsr_cnf->smart_gw_downlink);
721     ip[GW_HNA_UPLINK] = serialize_gw_speed(olsr_cnf->smart_gw_uplink);
722
723     if (olsr_cnf->ip_version == AF_INET6 && olsr_cnf->smart_gw_prefix.prefix_len > 0) {
724       ip[GW_HNA_FLAGS] |= GW_HNA_FLAG_IPV6PREFIX;
725       ip[GW_HNA_V6PREFIXLEN] = olsr_cnf->smart_gw_prefix.prefix_len;
726       memcpy(&ip[GW_HNA_V6PREFIX], &olsr_cnf->smart_gw_prefix.prefix, 8);
727     }
728   }
729 }
730
731 /*
732  * TC/SPF/HNA Interface
733  */
734
735 /**
736  * Checks if a HNA prefix/netmask combination is a smart gateway
737  *
738  * @param prefix
739  * @param mask
740  * @return true if is a valid smart gateway HNA, false otherwise
741  */
742 bool olsr_is_smart_gateway(struct olsr_ip_prefix *prefix, union olsr_ip_addr *mask) {
743   uint8_t *ptr;
744
745   if (!is_prefix_inetgw(prefix)) {
746     return false;
747   }
748
749   ptr = hna_mask_to_hna_pointer(mask, prefix->prefix_len);
750   return ptr[GW_HNA_PAD] == 0 && ptr[GW_HNA_FLAGS] != 0;
751 }
752
753 /**
754  * Update a gateway_entry based on a HNA
755  *
756  * @param originator ip of the source of the HNA
757  * @param mask netmask of the HNA
758  * @param prefixlen of the HNA
759  * @param seqno the sequence number of the HNA
760  */
761 void olsr_update_gateway_entry(union olsr_ip_addr *originator, union olsr_ip_addr *mask, int prefixlen, uint16_t seqno) {
762   struct gw_container_entry * new_gw_in_list;
763   uint8_t *ptr;
764   struct gateway_entry *gw = node2gateway(avl_find(&gateway_tree, originator));
765
766   if (!gw) {
767     gw = olsr_cookie_malloc(gateway_entry_mem_cookie);
768     gw->originator = *originator;
769     gw->node.key = &gw->originator;
770
771     avl_insert(&gateway_tree, &gw->node, AVL_DUP_NO);
772   } else if (olsr_seqno_diff(seqno, gw->seqno) <= 0) {
773     /* ignore older HNAs */
774     return;
775   }
776
777   /* keep new HNA seqno */
778   gw->seqno = seqno;
779
780   ptr = hna_mask_to_hna_pointer(mask, prefixlen);
781   if ((ptr[GW_HNA_FLAGS] & GW_HNA_FLAG_LINKSPEED) != 0) {
782     gw->uplink = deserialize_gw_speed(ptr[GW_HNA_UPLINK]);
783     gw->downlink = deserialize_gw_speed(ptr[GW_HNA_DOWNLINK]);
784   } else {
785     gw->uplink = 0;
786     gw->downlink = 0;
787   }
788
789   gw->ipv4 = (ptr[GW_HNA_FLAGS] & GW_HNA_FLAG_IPV4) != 0;
790   gw->ipv4nat = (ptr[GW_HNA_FLAGS] & GW_HNA_FLAG_IPV4_NAT) != 0;
791
792   if (olsr_cnf->ip_version == AF_INET6) {
793     gw->ipv6 = (ptr[GW_HNA_FLAGS] & GW_HNA_FLAG_IPV6) != 0;
794
795     /* do not reset prefixlength for ::ffff:0:0 HNAs */
796     if (prefixlen == ipv6_internet_route.prefix_len) {
797       memset(&gw->external_prefix, 0, sizeof(gw->external_prefix));
798
799       if ((ptr[GW_HNA_FLAGS] & GW_HNA_FLAG_IPV6PREFIX) != 0
800           && memcmp(mask->v6.s6_addr, &ipv6_internet_route.prefix, olsr_cnf->ipsize) == 0) {
801         /* this is the right prefix (2000::/3), so we can copy the prefix */
802         gw->external_prefix.prefix_len = ptr[GW_HNA_V6PREFIXLEN];
803         memcpy(&gw->external_prefix.prefix, &ptr[GW_HNA_V6PREFIX], 8);
804       }
805     }
806   }
807
808   /* stop cleanup timer if necessary */
809   if (gw->cleanup_timer) {
810     olsr_stop_timer(gw->cleanup_timer);
811     gw->cleanup_timer = NULL;
812   }
813
814   /* update the costs of the gateway when it is an active gateway */
815   new_gw_in_list = olsr_gw_list_find(&gw_list_ipv4, gw);
816   if (new_gw_in_list) {
817     assert(gw_handler);
818     new_gw_in_list = olsr_gw_list_update(&gw_list_ipv4, new_gw_in_list, gw_handler->getcosts(new_gw_in_list->gw));
819     assert(new_gw_in_list);
820   }
821
822   new_gw_in_list = olsr_gw_list_find(&gw_list_ipv6, gw);
823   if (new_gw_in_list) {
824     assert(gw_handler);
825     new_gw_in_list = olsr_gw_list_update(&gw_list_ipv6, new_gw_in_list, gw_handler->getcosts(new_gw_in_list->gw));
826     assert(new_gw_in_list);
827   }
828
829   /* call update handler */
830   assert(gw_handler);
831   gw_handler->update(gw);
832 }
833
834 /**
835  * Delete a gateway based on the originator IP and the prefixlength of a HNA.
836  * Should only be called if prefix is a smart_gw prefix or if node is removed
837  * from TC set.
838  *
839  * @param originator
840  * @param prefixlen
841  * @param immediate when set to true then the gateway is removed from the
842  * gateway tree immediately, else it is removed on a delayed schedule.
843  */
844 void olsr_delete_gateway_entry(union olsr_ip_addr *originator, uint8_t prefixlen, bool immediate) {
845   olsr_delete_gateway_tree_entry(node2gateway(avl_find(&gateway_tree, originator)), prefixlen, immediate);
846 }
847
848 /**
849  * Delete a gateway entry .
850  *
851  * @param gw a gateway entry from the gateway tree
852  * @param prefixlen
853  * @param immediate when set to true then the gateway is removed from the
854  * gateway tree immediately, else it is removed on a delayed schedule.
855  */
856 static void olsr_delete_gateway_tree_entry(struct gateway_entry * gw, uint8_t prefixlen, bool immediate) {
857   bool change = false;
858
859   if (!gw) {
860     return;
861   }
862
863   if (immediate && gw->cleanup_timer) {
864     /* stop timer if we have to remove immediately */
865     olsr_stop_timer(gw->cleanup_timer);
866     gw->cleanup_timer = NULL;
867   }
868
869   if (gw->cleanup_timer == NULL || gw->ipv4 || gw->ipv6) {
870     /* the gw  is not scheduled for deletion */
871
872     if (olsr_cnf->ip_version == AF_INET && prefixlen == 0) {
873       change = gw->ipv4;
874       gw->ipv4 = false;
875       gw->ipv4nat = false;
876     } else if (olsr_cnf->ip_version == AF_INET6 && prefixlen == ipv6_internet_route.prefix_len) {
877       change = gw->ipv6;
878       gw->ipv6 = false;
879     } else if (olsr_cnf->ip_version == AF_INET6 && prefixlen == ipv6_mappedv4_route.prefix_len) {
880       change = gw->ipv4;
881       gw->ipv4 = false;
882       gw->ipv4nat = false;
883     }
884
885     if (prefixlen == FORCE_DELETE_GW_ENTRY || !(gw->ipv4 || gw->ipv6)) {
886       struct gw_container_entry * gw_in_list;
887
888       /* prevent this gateway from being chosen as the new gateway */
889       gw->ipv4 = false;
890       gw->ipv4nat = false;
891       gw->ipv6 = false;
892
893       /* handle gateway loss */
894       assert(gw_handler);
895       gw_handler->delete(gw);
896
897       /* cleanup gateway if necessary */
898       gw_in_list = olsr_gw_list_find(&gw_list_ipv4, gw);
899       if (gw_in_list) {
900         if (current_ipv4_gw && current_ipv4_gw->gw == gw) {
901           olsr_os_inetgw_tunnel_route(current_ipv4_gw->tunnel->if_index, true, false, olsr_cnf->rt_table_tunnel);
902           current_ipv4_gw = NULL;
903         }
904
905         if (gw_in_list->tunnel) {
906           struct interfaceName * ifn = find_interfaceName(gw_in_list->gw);
907           if (ifn) {
908             olsr_os_inetgw_tunnel_route(gw_in_list->tunnel->if_index, true, false, ifn->mark);
909           }
910           olsr_os_del_ipip_tunnel(gw_in_list->tunnel);
911           set_unused_iptunnel_name(gw_in_list->gw);
912           gw_in_list->tunnel = NULL;
913         }
914
915         gw_in_list->gw = NULL;
916         gw_in_list = olsr_gw_list_remove(&gw_list_ipv4, gw_in_list);
917         olsr_cookie_free(gw_container_entry_mem_cookie, gw_in_list);
918       }
919
920       gw_in_list = olsr_gw_list_find(&gw_list_ipv6, gw);
921       if (gw_in_list) {
922         if (current_ipv6_gw && current_ipv6_gw->gw == gw) {
923           olsr_os_inetgw_tunnel_route(current_ipv6_gw->tunnel->if_index, false, false, olsr_cnf->rt_table_tunnel);
924           current_ipv6_gw = NULL;
925         }
926
927         if (gw_in_list->tunnel) {
928           struct interfaceName * ifn = find_interfaceName(gw_in_list->gw);
929           if (ifn) {
930             olsr_os_inetgw_tunnel_route(gw_in_list->tunnel->if_index, false, false, ifn->mark);
931           }
932           olsr_os_del_ipip_tunnel(gw_in_list->tunnel);
933           set_unused_iptunnel_name(gw_in_list->gw);
934           gw_in_list->tunnel = NULL;
935         }
936
937         gw_in_list->gw = NULL;
938         gw_in_list = olsr_gw_list_remove(&gw_list_ipv6, gw_in_list);
939         olsr_cookie_free(gw_container_entry_mem_cookie, gw_in_list);
940       }
941
942       if (!immediate) {
943         /* remove gateway entry on a delayed schedule */
944         olsr_set_timer(&gw->cleanup_timer, GW_CLEANUP_INTERVAL, 0, false, cleanup_gateway_handler, gw, NULL);
945       } else {
946         cleanup_gateway_handler(gw);
947       }
948
949       /* when the current gateway was deleted, then immediately choose a new gateway */
950       if (!current_ipv4_gw || !current_ipv6_gw) {
951         assert(gw_handler);
952         gw_handler->choose(!current_ipv4_gw, !current_ipv6_gw);
953       }
954
955     } else if (change) {
956       assert(gw_handler);
957       gw_handler->update(gw);
958     }
959   }
960 }
961
962 /**
963  * Triggers a check if the one of the gateways have been lost or has an
964  * ETX = infinity
965  */
966 void olsr_trigger_gatewayloss_check(void) {
967   bool ipv4 = false;
968   bool ipv6 = false;
969
970   if (current_ipv4_gw && current_ipv4_gw->gw) {
971     struct tc_entry *tc = olsr_lookup_tc_entry(&current_ipv4_gw->gw->originator);
972     ipv4 = (tc == NULL || tc->path_cost == ROUTE_COST_BROKEN);
973   }
974   if (current_ipv6_gw && current_ipv6_gw->gw) {
975     struct tc_entry *tc = olsr_lookup_tc_entry(&current_ipv6_gw->gw->originator);
976     ipv6 = (tc == NULL || tc->path_cost == ROUTE_COST_BROKEN);
977   }
978
979   if (ipv4 || ipv6) {
980     assert(gw_handler);
981     gw_handler->choose(ipv4, ipv6);
982   }
983 }
984
985 /*
986  * Gateway Plugin Functions
987  */
988
989 /**
990  * Sets a new internet gateway.
991  *
992  * @param originator ip address of the node with the new gateway
993  * @param path_cost the path cost
994  * @param ipv4 set ipv4 gateway
995  * @param ipv6 set ipv6 gateway
996  * @return true if an error happened, false otherwise
997  */
998 bool olsr_set_inet_gateway(union olsr_ip_addr *originator, uint64_t path_cost, bool ipv4, bool ipv6) {
999   struct gateway_entry *new_gw;
1000
1001   ipv4 = ipv4 && (olsr_cnf->ip_version == AF_INET || olsr_cnf->use_niit);
1002   ipv6 = ipv6 && (olsr_cnf->ip_version == AF_INET6);
1003   if (!ipv4 && !ipv6) {
1004     return true;
1005   }
1006
1007   new_gw = node2gateway(avl_find(&gateway_tree, originator));
1008   if (!new_gw) {
1009     /* the originator is not in the gateway tree, we can't set it as gateway */
1010     return true;
1011   }
1012
1013   /* handle IPv4 */
1014   if (ipv4 &&
1015       new_gw->ipv4 &&
1016       (!new_gw->ipv4nat || olsr_cnf->smart_gw_allow_nat) &&
1017       (!current_ipv4_gw || current_ipv4_gw->gw != new_gw || current_ipv4_gw->path_cost != path_cost)) {
1018     /* new gw is different than the current gw, or costs have changed */
1019
1020     struct gw_container_entry * new_gw_in_list = olsr_gw_list_find(&gw_list_ipv4, new_gw);
1021     if (new_gw_in_list) {
1022       /* new gw is already in the gw list */
1023       assert(new_gw_in_list->tunnel);
1024       olsr_os_inetgw_tunnel_route(new_gw_in_list->tunnel->if_index, true, true, olsr_cnf->rt_table_tunnel);
1025       current_ipv4_gw = olsr_gw_list_update(&gw_list_ipv4, new_gw_in_list, path_cost);
1026     } else {
1027       /* new gw is not yet in the gw list */
1028       char name[IFNAMSIZ];
1029       struct olsr_iptunnel_entry *new_v4gw_tunnel;
1030       struct interfaceName * interfaceName;
1031
1032       if (olsr_gw_list_full(&gw_list_ipv4)) {
1033         /* the list is full: remove the worst active gateway */
1034         struct gw_container_entry* worst = olsr_gw_list_get_worst_entry(&gw_list_ipv4);
1035         assert(worst);
1036
1037         if (worst->tunnel) {
1038           struct interfaceName * ifn = find_interfaceName(worst->gw);
1039           if (ifn) {
1040             olsr_os_inetgw_tunnel_route(worst->tunnel->if_index, true, false, ifn->mark);
1041           }
1042           olsr_os_del_ipip_tunnel(worst->tunnel);
1043           set_unused_iptunnel_name(worst->gw);
1044           worst->tunnel = NULL;
1045         }
1046         worst->gw = NULL;
1047         olsr_cookie_free(gw_container_entry_mem_cookie, olsr_gw_list_remove(&gw_list_ipv4, worst));
1048       }
1049
1050       get_unused_iptunnel_name(new_gw, name, &interfaceName);
1051       new_v4gw_tunnel = olsr_os_add_ipip_tunnel(&new_gw->originator, true, name);
1052       if (new_v4gw_tunnel) {
1053         if (interfaceName) {
1054           olsr_os_inetgw_tunnel_route(new_v4gw_tunnel->if_index, true, true, interfaceName->mark);
1055         }
1056         olsr_os_inetgw_tunnel_route(new_v4gw_tunnel->if_index, true, true, olsr_cnf->rt_table_tunnel);
1057
1058         new_gw_in_list = olsr_cookie_malloc(gw_container_entry_mem_cookie);
1059         new_gw_in_list->gw = new_gw;
1060         new_gw_in_list->tunnel = new_v4gw_tunnel;
1061         new_gw_in_list->path_cost = path_cost;
1062         current_ipv4_gw = olsr_gw_list_add(&gw_list_ipv4, new_gw_in_list);
1063       } else {
1064         /* adding the tunnel failed, we try again in the next cycle */
1065         set_unused_iptunnel_name(new_gw);
1066         ipv4 = false;
1067       }
1068     }
1069   }
1070
1071   /* handle IPv6 */
1072   if (ipv6 &&
1073       new_gw->ipv6 &&
1074       (!current_ipv6_gw || current_ipv6_gw->gw != new_gw || current_ipv6_gw->path_cost != path_cost)) {
1075     /* new gw is different than the current gw, or costs have changed */
1076
1077         struct gw_container_entry * new_gw_in_list = olsr_gw_list_find(&gw_list_ipv6, new_gw);
1078     if (new_gw_in_list) {
1079       /* new gw is already in the gw list */
1080       assert(new_gw_in_list->tunnel);
1081       olsr_os_inetgw_tunnel_route(new_gw_in_list->tunnel->if_index, true, true, olsr_cnf->rt_table_tunnel);
1082       current_ipv6_gw = olsr_gw_list_update(&gw_list_ipv6, new_gw_in_list, path_cost);
1083     } else {
1084       /* new gw is not yet in the gw list */
1085       char name[IFNAMSIZ];
1086       struct olsr_iptunnel_entry *new_v6gw_tunnel;
1087       struct interfaceName * interfaceName;
1088
1089       if (olsr_gw_list_full(&gw_list_ipv6)) {
1090         /* the list is full: remove the worst active gateway */
1091         struct gw_container_entry* worst = olsr_gw_list_get_worst_entry(&gw_list_ipv6);
1092         assert(worst);
1093
1094         if (worst->tunnel) {
1095           struct interfaceName * ifn = find_interfaceName(worst->gw);
1096           if (ifn) {
1097             olsr_os_inetgw_tunnel_route(worst->tunnel->if_index, false, false, ifn->mark);
1098           }
1099           olsr_os_del_ipip_tunnel(worst->tunnel);
1100           set_unused_iptunnel_name(worst->gw);
1101           worst->tunnel = NULL;
1102         }
1103         worst->gw = NULL;
1104         olsr_cookie_free(gw_container_entry_mem_cookie, olsr_gw_list_remove(&gw_list_ipv6, worst));
1105       }
1106
1107       get_unused_iptunnel_name(new_gw, name, &interfaceName);
1108       new_v6gw_tunnel = olsr_os_add_ipip_tunnel(&new_gw->originator, false, name);
1109       if (new_v6gw_tunnel) {
1110         if (interfaceName) {
1111           olsr_os_inetgw_tunnel_route(new_v6gw_tunnel->if_index, false, true, interfaceName->mark);
1112         }
1113         olsr_os_inetgw_tunnel_route(new_v6gw_tunnel->if_index, false, true, olsr_cnf->rt_table_tunnel);
1114
1115         new_gw_in_list = olsr_cookie_malloc(gw_container_entry_mem_cookie);
1116         new_gw_in_list->gw = new_gw;
1117         new_gw_in_list->tunnel = new_v6gw_tunnel;
1118         new_gw_in_list->path_cost = path_cost;
1119         current_ipv6_gw = olsr_gw_list_add(&gw_list_ipv6, new_gw_in_list);
1120       } else {
1121         /* adding the tunnel failed, we try again in the next cycle */
1122         set_unused_iptunnel_name(new_gw);
1123         ipv6 = false;
1124       }
1125     }
1126   }
1127
1128   return !ipv4 && !ipv6;
1129 }
1130
1131 /**
1132  * @param ipv6 if set to true then the IPv6 gateway is returned, otherwise the IPv4
1133  * gateway is returned
1134  * @return a pointer to the gateway_entry of the current ipv4 internet gw or
1135  * NULL if not set.
1136  */
1137 struct gateway_entry *olsr_get_inet_gateway(bool ipv6) {
1138         if (ipv6) {
1139                 return current_ipv6_gw ? current_ipv6_gw->gw : NULL;
1140         }
1141
1142         return current_ipv4_gw ? current_ipv4_gw->gw : NULL;
1143 }
1144
1145 #endif /* __linux__ */