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