gateway: introduce and use removeGatewayFromList function
[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  * Remove a gateway from a gateway list.
458  *
459  * @param gw_list a pointer to the gateway list
460  * @param ipv4 true when dealing with an IPv4 gateway / gateway list
461  * @param gw a pointer to the gateway to remove from the list
462  */
463 static void removeGatewayFromList(struct gw_list * gw_list, bool ipv4, struct gw_container_entry * gw) {
464   if (gw->tunnel) {
465     struct interfaceName * ifn = find_interfaceName(gw->gw);
466     if (ifn) {
467       olsr_os_inetgw_tunnel_route(gw->tunnel->if_index, ipv4, false, ifn->mark);
468     }
469     olsr_os_del_ipip_tunnel(gw->tunnel);
470     set_unused_iptunnel_name(gw->gw);
471     gw->tunnel = NULL;
472   }
473   gw->gw = NULL;
474   olsr_cookie_free(gw_container_entry_mem_cookie, olsr_gw_list_remove(gw_list, gw));
475 }
476
477 /*
478  * Main Interface
479  */
480
481 /**
482  * Initialize gateway system
483  */
484 int olsr_init_gateways(void) {
485   int retries = 5;
486
487   gateway_entry_mem_cookie = olsr_alloc_cookie("gateway_entry_mem_cookie", OLSR_COOKIE_TYPE_MEMORY);
488   olsr_cookie_set_memory_size(gateway_entry_mem_cookie, sizeof(struct gateway_entry));
489
490   gw_container_entry_mem_cookie = olsr_alloc_cookie("gw_container_entry_mem_cookie", OLSR_COOKIE_TYPE_MEMORY);
491   olsr_cookie_set_memory_size(gw_container_entry_mem_cookie, sizeof(struct gw_container_entry));
492
493   avl_init(&gateway_tree, avl_comp_default);
494
495   olsr_gw_list_init(&gw_list_ipv4, olsr_cnf->smart_gw_use_count);
496   olsr_gw_list_init(&gw_list_ipv6, olsr_cnf->smart_gw_use_count);
497
498   if (!multi_gateway_mode()) {
499     sgwEgressInterfaceNames = NULL;
500     sgwTunnel4InterfaceNames = NULL;
501     sgwTunnel6InterfaceNames = NULL;
502   } else {
503     uint8_t i;
504     struct sgw_egress_if * egressif;
505
506     /* setup the egress interface name/mark pairs */
507     sgwEgressInterfaceNames = olsr_malloc(sizeof(struct interfaceName) * olsr_cnf->smart_gw_egress_interfaces_count, "sgwEgressInterfaceNames");
508     i = 0;
509     egressif = olsr_cnf->smart_gw_egress_interfaces;
510     while (egressif) {
511       struct interfaceName * ifn = &sgwEgressInterfaceNames[i];
512       ifn->gw = NULL;
513       ifn->mark = i + olsr_cnf->smart_gw_mark_offset_egress;
514       egressif->mark = ifn->mark;
515       snprintf(&ifn->name[0], sizeof(ifn->name), egressif->name, egressif->mark);
516
517       egressif = egressif->next;
518       i++;
519     }
520     assert(i == olsr_cnf->smart_gw_egress_interfaces_count);
521
522     /* setup the SGW tunnel name/mark pairs */
523     sgwTunnel4InterfaceNames = olsr_malloc(sizeof(struct interfaceName) * olsr_cnf->smart_gw_use_count, "sgwTunnel4InterfaceNames");
524     sgwTunnel6InterfaceNames = olsr_malloc(sizeof(struct interfaceName) * olsr_cnf->smart_gw_use_count, "sgwTunnel6InterfaceNames");
525     for (i = 0; i < olsr_cnf->smart_gw_use_count; i++) {
526       struct interfaceName * ifn = &sgwTunnel4InterfaceNames[i];
527       ifn->gw = NULL;
528       ifn->mark = i + olsr_cnf->smart_gw_mark_offset_tunnels;
529       snprintf(&ifn->name[0], sizeof(ifn->name), "tnl_4%03u", ifn->mark);
530
531       ifn = &sgwTunnel6InterfaceNames[i];
532       ifn->gw = NULL;
533       ifn->mark = i + olsr_cnf->smart_gw_mark_offset_tunnels;
534       snprintf(&ifn->name[0], sizeof(ifn->name), "tnl_6%03u", ifn->mark);
535     }
536   }
537
538   current_ipv4_gw = NULL;
539   current_ipv6_gw = NULL;
540
541   gw_handler = NULL;
542
543   refresh_smartgw_netmask();
544
545   /* initialize default gateway handler */
546   gw_handler = &gw_def_handler;
547   gw_handler->init();
548
549
550   /*
551    * There appears to be a kernel bug in some kernels (at least in the 3.0
552    * Debian Squeeze kernel, but not in the Fedora 17 kernels) around
553    * initialising the IPIP server tunnel (loading the IPIP module), so we retry
554    * a few times before giving up
555    */
556   while (retries-- > 0) {
557     if (!olsr_os_init_iptunnel(server_tunnel_name())) {
558       retries = 5;
559       break;
560     }
561
562     olsr_printf(0, "Could not initialise the IPIP server tunnel, retrying %d more times\n", retries);
563   }
564   if (retries <= 0) {
565     return 1;
566   }
567
568   olsr_add_ifchange_handler(smartgw_tunnel_monitor);
569
570   return 0;
571 }
572
573 /**
574  * Startup gateway system
575  */
576 int olsr_startup_gateways(void) {
577   bool ok = true;
578
579   if (!multi_gateway_mode()) {
580     return 0;
581   }
582
583   ok = ok && multiGwRulesGeneric(true);
584   ok = ok && multiGwRulesSgwServerTunnel(true);
585   ok = ok && multiGwRulesOlsrInterfaces(true);
586   ok = ok && multiGwRulesEgressInterfaces(true);
587   ok = ok && multiGwRulesSgwTunnels(true);
588   if (!ok) {
589     olsr_printf(0, "Could not setup multi-gateway iptables and ip rules\n");
590     olsr_shutdown_gateways();
591     return 1;
592   }
593
594   return 0;
595 }
596
597 /**
598  * Shutdown gateway tunnel system
599  */
600 void olsr_shutdown_gateways(void) {
601   if (!multi_gateway_mode()) {
602     return;
603   }
604
605   (void)multiGwRulesSgwTunnels(false);
606   (void)multiGwRulesEgressInterfaces(false);
607   (void)multiGwRulesOlsrInterfaces(false);
608   (void)multiGwRulesSgwServerTunnel(false);
609   (void)multiGwRulesGeneric(false);
610 }
611
612 /**
613  * Cleanup gateway tunnel system
614  */
615 void olsr_cleanup_gateways(void) {
616   struct gateway_entry * tree_gw;
617   struct gw_container_entry * gw;
618
619   olsr_remove_ifchange_handler(smartgw_tunnel_monitor);
620
621   /* remove all gateways in the gateway tree that are not the active gateway */
622   OLSR_FOR_ALL_GATEWAY_ENTRIES(tree_gw) {
623     if ((tree_gw != olsr_get_inet_gateway(false)) && (tree_gw != olsr_get_inet_gateway(true))) {
624       olsr_delete_gateway_tree_entry(tree_gw, FORCE_DELETE_GW_ENTRY, true);
625     }
626   } OLSR_FOR_ALL_GATEWAY_ENTRIES_END(gw)
627
628   /* remove all active IPv4 gateways (should be at most 1 now) */
629   OLSR_FOR_ALL_GWS(&gw_list_ipv4.head, gw) {
630     if (gw && gw->gw) {
631       olsr_delete_gateway_entry(&gw->gw->originator, FORCE_DELETE_GW_ENTRY, true);
632     }
633   }
634   OLSR_FOR_ALL_GWS_END(gw);
635
636   /* remove all active IPv6 gateways (should be at most 1 now) */
637   OLSR_FOR_ALL_GWS(&gw_list_ipv6.head, gw) {
638     if (gw && gw->gw) {
639       olsr_delete_gateway_entry(&gw->gw->originator, FORCE_DELETE_GW_ENTRY, true);
640     }
641   }
642   OLSR_FOR_ALL_GWS_END(gw);
643
644   /* there should be no more gateways */
645   assert(!avl_walk_first(&gateway_tree));
646   assert(!current_ipv4_gw);
647   assert(!current_ipv6_gw);
648
649   olsr_os_cleanup_iptunnel(server_tunnel_name());
650
651   assert(gw_handler);
652   gw_handler->cleanup();
653   gw_handler = NULL;
654
655   if (sgwEgressInterfaceNames) {
656     free(sgwEgressInterfaceNames);
657     sgwEgressInterfaceNames = NULL;
658   }
659   if (sgwTunnel4InterfaceNames) {
660     free(sgwTunnel4InterfaceNames);
661     sgwTunnel4InterfaceNames = NULL;
662   }
663   if (sgwTunnel6InterfaceNames) {
664     free(sgwTunnel6InterfaceNames);
665     sgwTunnel6InterfaceNames = NULL;
666   }
667
668   olsr_gw_list_cleanup(&gw_list_ipv6);
669   olsr_gw_list_cleanup(&gw_list_ipv4);
670   olsr_free_cookie(gw_container_entry_mem_cookie);
671   olsr_free_cookie(gateway_entry_mem_cookie);
672 }
673
674 /**
675  * Triggers the first lookup of a gateway.
676  */
677 void olsr_trigger_inetgw_startup(void) {
678   assert(gw_handler);
679   gw_handler->startup();
680 }
681
682 /**
683  * Print debug information about gateway entries
684  */
685 #ifndef NODEBUG
686 void olsr_print_gateway_entries(void) {
687   struct ipaddr_str buf;
688   struct gateway_entry *gw;
689   const int addrsize = olsr_cnf->ip_version == AF_INET ? (INET_ADDRSTRLEN - 1) : (INET6_ADDRSTRLEN - 1);
690
691   OLSR_PRINTF(0, "\n--- %s ---------------------------------------------------- GATEWAYS\n\n", olsr_wallclock_string());
692   OLSR_PRINTF(0, "%-*s %-6s %-9s %-9s %s\n",
693       addrsize, "IP address", "Type", "Uplink", "Downlink", olsr_cnf->ip_version == AF_INET ? "" : "External Prefix");
694
695   OLSR_FOR_ALL_GATEWAY_ENTRIES(gw) {
696     OLSR_PRINTF(0, "%-*s %s%c%s%c%c %-9u %-9u %s\n",
697         addrsize,
698         olsr_ip_to_string(&buf, &gw->originator),
699         gw->ipv4nat ? "" : "   ",
700         gw->ipv4 ? '4' : ' ',
701         gw->ipv4nat ? "(N)" : "",
702         (gw->ipv4 && gw->ipv6) ? ',' : ' ',
703         gw->ipv6 ? '6' : ' ',
704         gw->uplink,
705         gw->downlink,
706         gw->external_prefix.prefix_len == 0 ? "" : olsr_ip_prefix_to_string(&gw->external_prefix));
707   } OLSR_FOR_ALL_GATEWAY_ENTRIES_END(gw)
708 }
709 #endif /* NODEBUG */
710
711 /*
712  * Tx Path Interface
713  */
714
715 /**
716  * Apply the smart gateway modifications to an outgoing HNA
717  *
718  * @param mask pointer to netmask of the HNA
719  * @param prefixlen of the HNA
720  */
721 void olsr_modifiy_inetgw_netmask(union olsr_ip_addr *mask, int prefixlen) {
722   uint8_t *ptr = hna_mask_to_hna_pointer(mask, prefixlen);
723
724   /* copy the current settings for uplink/downlink into the mask */
725   memcpy(ptr, &smart_gateway_netmask, sizeof(smart_gateway_netmask) - prefixlen / 8);
726   if (olsr_cnf->has_ipv4_gateway) {
727     ptr[GW_HNA_FLAGS] |= GW_HNA_FLAG_IPV4;
728
729     if (olsr_cnf->smart_gw_uplink_nat) {
730       ptr[GW_HNA_FLAGS] |= GW_HNA_FLAG_IPV4_NAT;
731     }
732   }
733   if (olsr_cnf->has_ipv6_gateway) {
734     ptr[GW_HNA_FLAGS] |= GW_HNA_FLAG_IPV6;
735   }
736   if (!olsr_cnf->has_ipv6_gateway || prefixlen != ipv6_internet_route.prefix_len) {
737     ptr[GW_HNA_FLAGS] &= ~GW_HNA_FLAG_IPV6PREFIX;
738   }
739 }
740
741 /*
742  * SgwDynSpeed Plugin Interface
743  */
744
745 /**
746  * Setup the gateway netmask
747  */
748 void refresh_smartgw_netmask(void) {
749   uint8_t *ip;
750
751   /* clear the mask */
752   memset(&smart_gateway_netmask, 0, sizeof(smart_gateway_netmask));
753
754   if (olsr_cnf->smart_gw_active) {
755     ip = (uint8_t *) &smart_gateway_netmask;
756
757     ip[GW_HNA_FLAGS] |= GW_HNA_FLAG_LINKSPEED;
758     ip[GW_HNA_DOWNLINK] = serialize_gw_speed(olsr_cnf->smart_gw_downlink);
759     ip[GW_HNA_UPLINK] = serialize_gw_speed(olsr_cnf->smart_gw_uplink);
760
761     if (olsr_cnf->ip_version == AF_INET6 && olsr_cnf->smart_gw_prefix.prefix_len > 0) {
762       ip[GW_HNA_FLAGS] |= GW_HNA_FLAG_IPV6PREFIX;
763       ip[GW_HNA_V6PREFIXLEN] = olsr_cnf->smart_gw_prefix.prefix_len;
764       memcpy(&ip[GW_HNA_V6PREFIX], &olsr_cnf->smart_gw_prefix.prefix, 8);
765     }
766   }
767 }
768
769 /*
770  * TC/SPF/HNA Interface
771  */
772
773 /**
774  * Checks if a HNA prefix/netmask combination is a smart gateway
775  *
776  * @param prefix
777  * @param mask
778  * @return true if is a valid smart gateway HNA, false otherwise
779  */
780 bool olsr_is_smart_gateway(struct olsr_ip_prefix *prefix, union olsr_ip_addr *mask) {
781   uint8_t *ptr;
782
783   if (!is_prefix_inetgw(prefix)) {
784     return false;
785   }
786
787   ptr = hna_mask_to_hna_pointer(mask, prefix->prefix_len);
788   return ptr[GW_HNA_PAD] == 0 && ptr[GW_HNA_FLAGS] != 0;
789 }
790
791 /**
792  * Update a gateway_entry based on a HNA
793  *
794  * @param originator ip of the source of the HNA
795  * @param mask netmask of the HNA
796  * @param prefixlen of the HNA
797  * @param seqno the sequence number of the HNA
798  */
799 void olsr_update_gateway_entry(union olsr_ip_addr *originator, union olsr_ip_addr *mask, int prefixlen, uint16_t seqno) {
800   struct gw_container_entry * new_gw_in_list;
801   uint8_t *ptr;
802   struct gateway_entry *gw = node2gateway(avl_find(&gateway_tree, originator));
803
804   if (!gw) {
805     gw = olsr_cookie_malloc(gateway_entry_mem_cookie);
806     gw->originator = *originator;
807     gw->node.key = &gw->originator;
808
809     avl_insert(&gateway_tree, &gw->node, AVL_DUP_NO);
810   } else if (olsr_seqno_diff(seqno, gw->seqno) <= 0) {
811     /* ignore older HNAs */
812     return;
813   }
814
815   /* keep new HNA seqno */
816   gw->seqno = seqno;
817
818   ptr = hna_mask_to_hna_pointer(mask, prefixlen);
819   if ((ptr[GW_HNA_FLAGS] & GW_HNA_FLAG_LINKSPEED) != 0) {
820     gw->uplink = deserialize_gw_speed(ptr[GW_HNA_UPLINK]);
821     gw->downlink = deserialize_gw_speed(ptr[GW_HNA_DOWNLINK]);
822   } else {
823     gw->uplink = 0;
824     gw->downlink = 0;
825   }
826
827   gw->ipv4 = (ptr[GW_HNA_FLAGS] & GW_HNA_FLAG_IPV4) != 0;
828   gw->ipv4nat = (ptr[GW_HNA_FLAGS] & GW_HNA_FLAG_IPV4_NAT) != 0;
829
830   if (olsr_cnf->ip_version == AF_INET6) {
831     gw->ipv6 = (ptr[GW_HNA_FLAGS] & GW_HNA_FLAG_IPV6) != 0;
832
833     /* do not reset prefixlength for ::ffff:0:0 HNAs */
834     if (prefixlen == ipv6_internet_route.prefix_len) {
835       memset(&gw->external_prefix, 0, sizeof(gw->external_prefix));
836
837       if ((ptr[GW_HNA_FLAGS] & GW_HNA_FLAG_IPV6PREFIX) != 0
838           && memcmp(mask->v6.s6_addr, &ipv6_internet_route.prefix, olsr_cnf->ipsize) == 0) {
839         /* this is the right prefix (2000::/3), so we can copy the prefix */
840         gw->external_prefix.prefix_len = ptr[GW_HNA_V6PREFIXLEN];
841         memcpy(&gw->external_prefix.prefix, &ptr[GW_HNA_V6PREFIX], 8);
842       }
843     }
844   }
845
846   /* stop cleanup timer if necessary */
847   if (gw->cleanup_timer) {
848     olsr_stop_timer(gw->cleanup_timer);
849     gw->cleanup_timer = NULL;
850   }
851
852   /* update the costs of the gateway when it is an active gateway */
853   new_gw_in_list = olsr_gw_list_find(&gw_list_ipv4, gw);
854   if (new_gw_in_list) {
855     assert(gw_handler);
856     new_gw_in_list = olsr_gw_list_update(&gw_list_ipv4, new_gw_in_list, gw_handler->getcosts(new_gw_in_list->gw));
857     assert(new_gw_in_list);
858   }
859
860   new_gw_in_list = olsr_gw_list_find(&gw_list_ipv6, gw);
861   if (new_gw_in_list) {
862     assert(gw_handler);
863     new_gw_in_list = olsr_gw_list_update(&gw_list_ipv6, new_gw_in_list, gw_handler->getcosts(new_gw_in_list->gw));
864     assert(new_gw_in_list);
865   }
866
867   /* call update handler */
868   assert(gw_handler);
869   gw_handler->update(gw);
870 }
871
872 /**
873  * Delete a gateway based on the originator IP and the prefixlength of a HNA.
874  * Should only be called if prefix is a smart_gw prefix or if node is removed
875  * from TC set.
876  *
877  * @param originator
878  * @param prefixlen
879  * @param immediate when set to true then the gateway is removed from the
880  * gateway tree immediately, else it is removed on a delayed schedule.
881  */
882 void olsr_delete_gateway_entry(union olsr_ip_addr *originator, uint8_t prefixlen, bool immediate) {
883   olsr_delete_gateway_tree_entry(node2gateway(avl_find(&gateway_tree, originator)), prefixlen, immediate);
884 }
885
886 /**
887  * Delete a gateway entry .
888  *
889  * @param gw a gateway entry from the gateway tree
890  * @param prefixlen
891  * @param immediate when set to true then the gateway is removed from the
892  * gateway tree immediately, else it is removed on a delayed schedule.
893  */
894 static void olsr_delete_gateway_tree_entry(struct gateway_entry * gw, uint8_t prefixlen, bool immediate) {
895   bool change = false;
896
897   if (!gw) {
898     return;
899   }
900
901   if (immediate && gw->cleanup_timer) {
902     /* stop timer if we have to remove immediately */
903     olsr_stop_timer(gw->cleanup_timer);
904     gw->cleanup_timer = NULL;
905   }
906
907   if (gw->cleanup_timer == NULL || gw->ipv4 || gw->ipv6) {
908     /* the gw  is not scheduled for deletion */
909
910     if (olsr_cnf->ip_version == AF_INET && prefixlen == 0) {
911       change = gw->ipv4;
912       gw->ipv4 = false;
913       gw->ipv4nat = false;
914     } else if (olsr_cnf->ip_version == AF_INET6 && prefixlen == ipv6_internet_route.prefix_len) {
915       change = gw->ipv6;
916       gw->ipv6 = false;
917     } else if (olsr_cnf->ip_version == AF_INET6 && prefixlen == ipv6_mappedv4_route.prefix_len) {
918       change = gw->ipv4;
919       gw->ipv4 = false;
920       gw->ipv4nat = false;
921     }
922
923     if (prefixlen == FORCE_DELETE_GW_ENTRY || !(gw->ipv4 || gw->ipv6)) {
924       struct gw_container_entry * gw_in_list;
925
926       /* prevent this gateway from being chosen as the new gateway */
927       gw->ipv4 = false;
928       gw->ipv4nat = false;
929       gw->ipv6 = false;
930
931       /* handle gateway loss */
932       assert(gw_handler);
933       gw_handler->delete(gw);
934
935       /* cleanup gateway if necessary */
936       gw_in_list = olsr_gw_list_find(&gw_list_ipv4, gw);
937       if (gw_in_list) {
938         if (current_ipv4_gw && current_ipv4_gw->gw == gw) {
939           olsr_os_inetgw_tunnel_route(current_ipv4_gw->tunnel->if_index, true, false, olsr_cnf->rt_table_tunnel);
940           current_ipv4_gw = NULL;
941         }
942
943         if (gw_in_list->tunnel) {
944           struct interfaceName * ifn = find_interfaceName(gw_in_list->gw);
945           if (ifn) {
946             olsr_os_inetgw_tunnel_route(gw_in_list->tunnel->if_index, true, false, ifn->mark);
947           }
948           olsr_os_del_ipip_tunnel(gw_in_list->tunnel);
949           set_unused_iptunnel_name(gw_in_list->gw);
950           gw_in_list->tunnel = NULL;
951         }
952
953         gw_in_list->gw = NULL;
954         gw_in_list = olsr_gw_list_remove(&gw_list_ipv4, gw_in_list);
955         olsr_cookie_free(gw_container_entry_mem_cookie, gw_in_list);
956       }
957
958       gw_in_list = olsr_gw_list_find(&gw_list_ipv6, gw);
959       if (gw_in_list) {
960         if (current_ipv6_gw && current_ipv6_gw->gw == gw) {
961           olsr_os_inetgw_tunnel_route(current_ipv6_gw->tunnel->if_index, false, false, olsr_cnf->rt_table_tunnel);
962           current_ipv6_gw = NULL;
963         }
964
965         if (gw_in_list->tunnel) {
966           struct interfaceName * ifn = find_interfaceName(gw_in_list->gw);
967           if (ifn) {
968             olsr_os_inetgw_tunnel_route(gw_in_list->tunnel->if_index, false, false, ifn->mark);
969           }
970           olsr_os_del_ipip_tunnel(gw_in_list->tunnel);
971           set_unused_iptunnel_name(gw_in_list->gw);
972           gw_in_list->tunnel = NULL;
973         }
974
975         gw_in_list->gw = NULL;
976         gw_in_list = olsr_gw_list_remove(&gw_list_ipv6, gw_in_list);
977         olsr_cookie_free(gw_container_entry_mem_cookie, gw_in_list);
978       }
979
980       if (!immediate) {
981         /* remove gateway entry on a delayed schedule */
982         olsr_set_timer(&gw->cleanup_timer, GW_CLEANUP_INTERVAL, 0, false, cleanup_gateway_handler, gw, NULL);
983       } else {
984         cleanup_gateway_handler(gw);
985       }
986
987       /* when the current gateway was deleted, then immediately choose a new gateway */
988       if (!current_ipv4_gw || !current_ipv6_gw) {
989         assert(gw_handler);
990         gw_handler->choose(!current_ipv4_gw, !current_ipv6_gw);
991       }
992
993     } else if (change) {
994       assert(gw_handler);
995       gw_handler->update(gw);
996     }
997   }
998 }
999
1000 /**
1001  * Triggers a check if the one of the gateways have been lost or has an
1002  * ETX = infinity
1003  */
1004 void olsr_trigger_gatewayloss_check(void) {
1005   bool ipv4 = false;
1006   bool ipv6 = false;
1007
1008   if (current_ipv4_gw && current_ipv4_gw->gw) {
1009     struct tc_entry *tc = olsr_lookup_tc_entry(&current_ipv4_gw->gw->originator);
1010     ipv4 = (tc == NULL || tc->path_cost == ROUTE_COST_BROKEN);
1011   }
1012   if (current_ipv6_gw && current_ipv6_gw->gw) {
1013     struct tc_entry *tc = olsr_lookup_tc_entry(&current_ipv6_gw->gw->originator);
1014     ipv6 = (tc == NULL || tc->path_cost == ROUTE_COST_BROKEN);
1015   }
1016
1017   if (ipv4 || ipv6) {
1018     assert(gw_handler);
1019     gw_handler->choose(ipv4, ipv6);
1020   }
1021 }
1022
1023 /*
1024  * Gateway Plugin Functions
1025  */
1026
1027 /**
1028  * Sets a new internet gateway.
1029  *
1030  * @param originator ip address of the node with the new gateway
1031  * @param path_cost the path cost
1032  * @param ipv4 set ipv4 gateway
1033  * @param ipv6 set ipv6 gateway
1034  * @return true if an error happened, false otherwise
1035  */
1036 bool olsr_set_inet_gateway(union olsr_ip_addr *originator, uint64_t path_cost, bool ipv4, bool ipv6) {
1037   struct gateway_entry *new_gw;
1038
1039   ipv4 = ipv4 && (olsr_cnf->ip_version == AF_INET || olsr_cnf->use_niit);
1040   ipv6 = ipv6 && (olsr_cnf->ip_version == AF_INET6);
1041   if (!ipv4 && !ipv6) {
1042     return true;
1043   }
1044
1045   new_gw = node2gateway(avl_find(&gateway_tree, originator));
1046   if (!new_gw) {
1047     /* the originator is not in the gateway tree, we can't set it as gateway */
1048     return true;
1049   }
1050
1051   /* handle IPv4 */
1052   if (ipv4 &&
1053       new_gw->ipv4 &&
1054       (!new_gw->ipv4nat || olsr_cnf->smart_gw_allow_nat) &&
1055       (!current_ipv4_gw || current_ipv4_gw->gw != new_gw || current_ipv4_gw->path_cost != path_cost)) {
1056     /* new gw is different than the current gw, or costs have changed */
1057
1058     struct gw_container_entry * new_gw_in_list = olsr_gw_list_find(&gw_list_ipv4, new_gw);
1059     if (new_gw_in_list) {
1060       /* new gw is already in the gw list */
1061       assert(new_gw_in_list->tunnel);
1062       olsr_os_inetgw_tunnel_route(new_gw_in_list->tunnel->if_index, true, true, olsr_cnf->rt_table_tunnel);
1063       current_ipv4_gw = olsr_gw_list_update(&gw_list_ipv4, new_gw_in_list, path_cost);
1064     } else {
1065       /* new gw is not yet in the gw list */
1066       char name[IFNAMSIZ];
1067       struct olsr_iptunnel_entry *new_v4gw_tunnel;
1068       struct interfaceName * interfaceName;
1069
1070       if (olsr_gw_list_full(&gw_list_ipv4)) {
1071         /* the list is full: remove the worst active gateway */
1072         struct gw_container_entry* worst = olsr_gw_list_get_worst_entry(&gw_list_ipv4);
1073         assert(worst);
1074
1075         removeGatewayFromList(&gw_list_ipv4, true, worst);
1076       }
1077
1078       get_unused_iptunnel_name(new_gw, name, &interfaceName);
1079       new_v4gw_tunnel = olsr_os_add_ipip_tunnel(&new_gw->originator, true, name);
1080       if (new_v4gw_tunnel) {
1081         if (interfaceName) {
1082           olsr_os_inetgw_tunnel_route(new_v4gw_tunnel->if_index, true, true, interfaceName->mark);
1083         }
1084         olsr_os_inetgw_tunnel_route(new_v4gw_tunnel->if_index, true, true, olsr_cnf->rt_table_tunnel);
1085
1086         new_gw_in_list = olsr_cookie_malloc(gw_container_entry_mem_cookie);
1087         new_gw_in_list->gw = new_gw;
1088         new_gw_in_list->tunnel = new_v4gw_tunnel;
1089         new_gw_in_list->path_cost = path_cost;
1090         current_ipv4_gw = olsr_gw_list_add(&gw_list_ipv4, new_gw_in_list);
1091       } else {
1092         /* adding the tunnel failed, we try again in the next cycle */
1093         set_unused_iptunnel_name(new_gw);
1094         ipv4 = false;
1095       }
1096     }
1097   }
1098
1099   /* handle IPv6 */
1100   if (ipv6 &&
1101       new_gw->ipv6 &&
1102       (!current_ipv6_gw || current_ipv6_gw->gw != new_gw || current_ipv6_gw->path_cost != path_cost)) {
1103     /* new gw is different than the current gw, or costs have changed */
1104
1105         struct gw_container_entry * new_gw_in_list = olsr_gw_list_find(&gw_list_ipv6, new_gw);
1106     if (new_gw_in_list) {
1107       /* new gw is already in the gw list */
1108       assert(new_gw_in_list->tunnel);
1109       olsr_os_inetgw_tunnel_route(new_gw_in_list->tunnel->if_index, true, true, olsr_cnf->rt_table_tunnel);
1110       current_ipv6_gw = olsr_gw_list_update(&gw_list_ipv6, new_gw_in_list, path_cost);
1111     } else {
1112       /* new gw is not yet in the gw list */
1113       char name[IFNAMSIZ];
1114       struct olsr_iptunnel_entry *new_v6gw_tunnel;
1115       struct interfaceName * interfaceName;
1116
1117       if (olsr_gw_list_full(&gw_list_ipv6)) {
1118         /* the list is full: remove the worst active gateway */
1119         struct gw_container_entry* worst = olsr_gw_list_get_worst_entry(&gw_list_ipv6);
1120         assert(worst);
1121
1122         removeGatewayFromList(&gw_list_ipv6, false, worst);
1123       }
1124
1125       get_unused_iptunnel_name(new_gw, name, &interfaceName);
1126       new_v6gw_tunnel = olsr_os_add_ipip_tunnel(&new_gw->originator, false, name);
1127       if (new_v6gw_tunnel) {
1128         if (interfaceName) {
1129           olsr_os_inetgw_tunnel_route(new_v6gw_tunnel->if_index, false, true, interfaceName->mark);
1130         }
1131         olsr_os_inetgw_tunnel_route(new_v6gw_tunnel->if_index, false, true, olsr_cnf->rt_table_tunnel);
1132
1133         new_gw_in_list = olsr_cookie_malloc(gw_container_entry_mem_cookie);
1134         new_gw_in_list->gw = new_gw;
1135         new_gw_in_list->tunnel = new_v6gw_tunnel;
1136         new_gw_in_list->path_cost = path_cost;
1137         current_ipv6_gw = olsr_gw_list_add(&gw_list_ipv6, new_gw_in_list);
1138       } else {
1139         /* adding the tunnel failed, we try again in the next cycle */
1140         set_unused_iptunnel_name(new_gw);
1141         ipv6 = false;
1142       }
1143     }
1144   }
1145
1146   return !ipv4 && !ipv6;
1147 }
1148
1149 /**
1150  * @param ipv6 if set to true then the IPv6 gateway is returned, otherwise the IPv4
1151  * gateway is returned
1152  * @return a pointer to the gateway_entry of the current ipv4 internet gw or
1153  * NULL if not set.
1154  */
1155 struct gateway_entry *olsr_get_inet_gateway(bool ipv6) {
1156         if (ipv6) {
1157                 return current_ipv6_gw ? current_ipv6_gw->gw : NULL;
1158         }
1159
1160         return current_ipv4_gw ? current_ipv4_gw->gw : NULL;
1161 }
1162
1163 #endif /* __linux__ */