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