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