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