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