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