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