gateway: initialise a set of fixed tunnel names in/for multi-gateway mode
[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 /** structure that holds an interface name, mark and a pointer to the gateway that uses it */
30 struct interfaceName {
31   char name[IFNAMSIZ]; /**< interface name */
32   uint8_t mark; /**< marking */
33   struct gateway_entry *gw; /**< gateway that uses this interface name */
34 };
35
36 /** the gateway tree */
37 struct avl_tree gateway_tree;
38
39 /** gateway cookie */
40 static struct olsr_cookie_info *gateway_entry_mem_cookie = NULL;
41
42 /** gateway container cookie */
43 static struct olsr_cookie_info *gw_container_entry_mem_cookie = NULL;
44
45 /** the gateway netmask for the HNA */
46 static uint8_t smart_gateway_netmask[sizeof(union olsr_ip_addr)];
47
48 /** the gateway handler/plugin */
49 static struct olsr_gw_handler *gw_handler;
50
51 /** the IPv4 gateway list */
52 static struct gw_list gw_list_ipv4;
53
54 /** the IPv6 gateway list */
55 static struct gw_list gw_list_ipv6;
56
57 /** the current IPv4 gateway */
58 static struct gw_container_entry *current_ipv4_gw;
59
60 /** the current IPv6 gateway */
61 static struct gw_container_entry *current_ipv6_gw;
62
63 /** interface names for smart gateway tunnel interfaces, IPv4 */
64 struct interfaceName * sgwTunnel4InterfaceNames;
65
66 /** interface names for smart gateway tunnel interfaces, IPv6 */
67 struct interfaceName * sgwTunnel6InterfaceNames;
68
69 /*
70  * Forward Declarations
71  */
72
73 static void olsr_delete_gateway_tree_entry(struct gateway_entry * gw, uint8_t prefixlen, bool immediate);
74
75 /*
76  * Helper Functions
77  */
78
79 #define TUNNEL_NAME (olsr_cnf->ip_version == AF_INET ? TUNNEL_ENDPOINT_IF : TUNNEL_ENDPOINT_IF6)
80
81 #define OLSR_IP_ADDR_2_HNA_PTR(mask, prefixlen) (((uint8_t *)mask) + ((prefixlen+7)/8))
82
83 /**
84  * Convert an encoded 1 byte transport value (5 bits mantissa, 3 bits exponent)
85  * to an uplink/downlink speed value
86  *
87  * @param value the encoded 1 byte transport value
88  * @return the uplink/downlink speed value (in kbit/s)
89  */
90 static uint32_t deserialize_gw_speed(uint8_t value) {
91   uint32_t speed;
92   uint32_t exp;
93
94   if (!value) {
95     /* 0 and 1 alias onto 0 during serialisation. We take 0 here to mean 0 and
96      * not 1 (since a bandwidth of 1 is no bandwidth at all really) */
97     return 0;
98   }
99
100   speed = (value >> 3) + 1;
101   exp = value & 7;
102
103   while (exp-- > 0) {
104     speed *= 10;
105   }
106   return speed;
107 }
108
109 /**
110  * Convert an uplink/downlink speed value into an encoded 1 byte transport
111  * value (5 bits mantissa, 3 bits exponent)
112  *
113  * @param speed the uplink/downlink speed value (in kbit/s)
114  * @return value the encoded 1 byte transport value
115  */
116 static uint8_t serialize_gw_speed(uint32_t speed) {
117   uint8_t exp = 0;
118
119   if (speed == 0) {
120     return 0;
121   }
122
123   if (speed > 320000000) {
124     return 0xff;
125   }
126
127   while ((speed > 32 || (speed % 10) == 0) && exp < 7) {
128     speed /= 10;
129     exp++;
130   }
131   return ((speed - 1) << 3) | exp;
132 }
133
134 /**
135  * Dummy for generating an interface name for an olsr ipip tunnel
136  * @param target IP destination of the tunnel
137  * @param name pointer to output buffer (length IFNAMSIZ)
138  */
139 static void generate_iptunnel_name(union olsr_ip_addr *target, char * name) {
140   static uint32_t counter = 0;
141
142   memset(name, 0, IFNAMSIZ);
143   snprintf(name, IFNAMSIZ, "tnl_%08x", olsr_cnf->ip_version == AF_INET ? target->v4.s_addr : ++counter);
144 }
145
146 /*
147  * Callback Functions
148  */
149
150 /**
151  * Callback for tunnel interface monitoring which will set the route into the tunnel
152  * when the interface comes up again.
153  *
154  * @param if_index the interface index
155  * @param ifh the interface
156  * @param flag interface change flags
157  */
158 static void smartgw_tunnel_monitor(int if_index __attribute__ ((unused)),
159     struct interface *ifh __attribute__ ((unused)), enum olsr_ifchg_flag flag __attribute__ ((unused))) {
160   return;
161 }
162
163 /**
164  * Timer callback to remove and cleanup a gateway entry
165  *
166  * @param ptr
167  */
168 static void cleanup_gateway_handler(void *ptr) {
169   struct gateway_entry *gw = ptr;
170
171   if (gw->ipv4 || gw->ipv6) {
172     /* do not clean it up when it is in use */
173     return;
174   }
175
176   /* remove gateway entry */
177   avl_delete(&gateway_tree, &gw->node);
178   olsr_cookie_free(gateway_entry_mem_cookie, gw);
179 }
180
181 /*
182  * Main Interface
183  */
184
185 /**
186  * Initialize gateway system
187  */
188 int olsr_init_gateways(void) {
189   gateway_entry_mem_cookie = olsr_alloc_cookie("gateway_entry_mem_cookie", OLSR_COOKIE_TYPE_MEMORY);
190   olsr_cookie_set_memory_size(gateway_entry_mem_cookie, sizeof(struct gateway_entry));
191
192   gw_container_entry_mem_cookie = olsr_alloc_cookie("gw_container_entry_mem_cookie", OLSR_COOKIE_TYPE_MEMORY);
193   olsr_cookie_set_memory_size(gw_container_entry_mem_cookie, sizeof(struct gw_container_entry));
194
195   avl_init(&gateway_tree, avl_comp_default);
196
197   olsr_gw_list_init(&gw_list_ipv4, olsr_cnf->smart_gw_use_count);
198   olsr_gw_list_init(&gw_list_ipv6, olsr_cnf->smart_gw_use_count);
199
200   if (olsr_cnf->smart_gw_use_count <= 1) {
201     sgwTunnel4InterfaceNames = NULL;
202     sgwTunnel6InterfaceNames = NULL;
203   } else {
204     uint8_t i;
205
206     /* setup the SGW tunnel name/mark pairs */
207     sgwTunnel4InterfaceNames = olsr_malloc(sizeof(struct interfaceName) * olsr_cnf->smart_gw_use_count, "sgwTunnel4InterfaceNames");
208     sgwTunnel6InterfaceNames = olsr_malloc(sizeof(struct interfaceName) * olsr_cnf->smart_gw_use_count, "sgwTunnel6InterfaceNames");
209     for (i = 0; i < olsr_cnf->smart_gw_use_count; i++) {
210       struct interfaceName * ifn = &sgwTunnel4InterfaceNames[i];
211       ifn->gw = NULL;
212       ifn->mark = i + olsr_cnf->smart_gw_mark_offset_tunnels;
213       snprintf(&ifn->name[0], sizeof(ifn->name), "tnl4_%03u", ifn->mark);
214
215       ifn = &sgwTunnel6InterfaceNames[i];
216       ifn->gw = NULL;
217       ifn->mark = i + olsr_cnf->smart_gw_mark_offset_tunnels;
218       snprintf(&ifn->name[0], sizeof(ifn->name), "tnl6_%03u", ifn->mark);
219     }
220   }
221
222   current_ipv4_gw = NULL;
223   current_ipv6_gw = NULL;
224
225   gw_handler = NULL;
226
227   refresh_smartgw_netmask();
228
229   /* initialize default gateway handler */
230   gw_handler = &gw_def_handler;
231   gw_handler->init();
232
233   if (olsr_os_init_iptunnel(TUNNEL_NAME)) {
234     return 1;
235   }
236
237   olsr_add_ifchange_handler(smartgw_tunnel_monitor);
238
239   return 0;
240 }
241
242 /**
243  * Cleanup gateway tunnel system
244  */
245 void olsr_cleanup_gateways(void) {
246   struct avl_node * avlnode = NULL;
247   struct gw_container_entry * gw;
248
249   olsr_remove_ifchange_handler(smartgw_tunnel_monitor);
250
251   olsr_os_cleanup_iptunnel(TUNNEL_NAME);
252
253   /* remove all gateways in the gateway tree that are not the active gateway */
254   while ((avlnode = avl_walk_first(&gateway_tree))) {
255     struct gateway_entry* tree_gw = node2gateway(avlnode);
256     if ((tree_gw != olsr_get_inet_gateway(false)) && (tree_gw != olsr_get_inet_gateway(true))) {
257       olsr_delete_gateway_tree_entry(tree_gw, FORCE_DELETE_GW_ENTRY, true);
258     }
259   }
260
261   /* remove all active IPv4 gateways (should be at most 1 now) */
262   OLSR_FOR_ALL_GWS(&gw_list_ipv4.head, gw) {
263     if (gw && gw->gw) {
264       olsr_delete_gateway_entry(&gw->gw->originator, FORCE_DELETE_GW_ENTRY, true);
265     }
266   }
267   OLSR_FOR_ALL_GWS_END(gw);
268
269   /* remove all active IPv6 gateways (should be at most 1 now) */
270   OLSR_FOR_ALL_GWS(&gw_list_ipv6.head, gw) {
271     if (gw && gw->gw) {
272       olsr_delete_gateway_entry(&gw->gw->originator, FORCE_DELETE_GW_ENTRY, true);
273     }
274   }
275   OLSR_FOR_ALL_GWS_END(gw);
276
277   /* there should be no more gateways */
278   assert(!avl_walk_first(&gateway_tree));
279   assert(!current_ipv4_gw);
280   assert(!current_ipv6_gw);
281
282   assert(gw_handler);
283   gw_handler->cleanup();
284   gw_handler = NULL;
285
286   if (sgwTunnel4InterfaceNames) {
287     free(sgwTunnel4InterfaceNames);
288     sgwTunnel4InterfaceNames = NULL;
289   }
290   if (sgwTunnel6InterfaceNames) {
291     free(sgwTunnel6InterfaceNames);
292     sgwTunnel6InterfaceNames = NULL;
293   }
294
295   olsr_gw_list_cleanup(&gw_list_ipv6);
296   olsr_gw_list_cleanup(&gw_list_ipv4);
297   olsr_free_cookie(gw_container_entry_mem_cookie);
298   olsr_free_cookie(gateway_entry_mem_cookie);
299 }
300
301 /**
302  * Triggers the first lookup of a gateway.
303  */
304 void olsr_trigger_inetgw_startup(void) {
305   assert(gw_handler);
306   gw_handler->startup();
307 }
308
309 /**
310  * Print debug information about gateway entries
311  */
312 #ifndef NODEBUG
313 void olsr_print_gateway_entries(void) {
314   struct ipaddr_str buf;
315   struct gateway_entry *gw;
316   const int addrsize = olsr_cnf->ip_version == AF_INET ? (INET_ADDRSTRLEN - 1) : (INET6_ADDRSTRLEN - 1);
317
318   OLSR_PRINTF(0, "\n--- %s ---------------------------------------------------- GATEWAYS\n\n", olsr_wallclock_string());
319   OLSR_PRINTF(0, "%-*s %-6s %-9s %-9s %s\n",
320       addrsize, "IP address", "Type", "Uplink", "Downlink", olsr_cnf->ip_version == AF_INET ? "" : "External Prefix");
321
322   OLSR_FOR_ALL_GATEWAY_ENTRIES(gw) {
323     OLSR_PRINTF(0, "%-*s %s%c%s%c%c %-9u %-9u %s\n",
324         addrsize,
325         olsr_ip_to_string(&buf, &gw->originator),
326         gw->ipv4nat ? "" : "   ",
327         gw->ipv4 ? '4' : ' ',
328         gw->ipv4nat ? "(N)" : "",
329         (gw->ipv4 && gw->ipv6) ? ',' : ' ',
330         gw->ipv6 ? '6' : ' ',
331         gw->uplink,
332         gw->downlink,
333         gw->external_prefix.prefix_len == 0 ? "" : olsr_ip_prefix_to_string(&gw->external_prefix));
334   } OLSR_FOR_ALL_GATEWAY_ENTRIES_END(gw)
335 }
336 #endif /* NODEBUG */
337
338 /*
339  * Tx Path Interface
340  */
341
342 /**
343  * Apply the smart gateway modifications to an outgoing HNA
344  *
345  * @param mask pointer to netmask of the HNA
346  * @param prefixlen of the HNA
347  */
348 void olsr_modifiy_inetgw_netmask(union olsr_ip_addr *mask, int prefixlen) {
349   uint8_t *ptr = OLSR_IP_ADDR_2_HNA_PTR(mask, prefixlen);
350
351   memcpy(ptr, &smart_gateway_netmask, sizeof(smart_gateway_netmask) - prefixlen / 8);
352   if (olsr_cnf->has_ipv4_gateway) {
353     ptr[GW_HNA_FLAGS] |= GW_HNA_FLAG_IPV4;
354
355     if (olsr_cnf->smart_gw_uplink_nat) {
356       ptr[GW_HNA_FLAGS] |= GW_HNA_FLAG_IPV4_NAT;
357     }
358   }
359   if (olsr_cnf->has_ipv6_gateway) {
360     ptr[GW_HNA_FLAGS] |= GW_HNA_FLAG_IPV6;
361   }
362   if (!olsr_cnf->has_ipv6_gateway || prefixlen != ipv6_internet_route.prefix_len) {
363     ptr[GW_HNA_FLAGS] &= ~GW_HNA_FLAG_IPV6PREFIX;
364   }
365 }
366
367 /*
368  * SgwDynSpeed Plugin Interface
369  */
370
371 /**
372  * Setup the gateway netmask
373  */
374 void refresh_smartgw_netmask(void) {
375   uint8_t *ip;
376   memset(&smart_gateway_netmask, 0, sizeof(smart_gateway_netmask));
377
378   if (olsr_cnf->smart_gw_active) {
379     ip = (uint8_t *) &smart_gateway_netmask;
380
381     if (olsr_cnf->smart_gw_uplink > 0 && olsr_cnf->smart_gw_downlink > 0) {
382       /* the link is bi-directional with a non-zero bandwidth */
383       ip[GW_HNA_FLAGS] |= GW_HNA_FLAG_LINKSPEED;
384       ip[GW_HNA_DOWNLINK] = serialize_gw_speed(olsr_cnf->smart_gw_downlink);
385       ip[GW_HNA_UPLINK] = serialize_gw_speed(olsr_cnf->smart_gw_uplink);
386     }
387     if (olsr_cnf->ip_version == AF_INET6 && olsr_cnf->smart_gw_prefix.prefix_len > 0) {
388       ip[GW_HNA_FLAGS] |= GW_HNA_FLAG_IPV6PREFIX;
389       ip[GW_HNA_V6PREFIXLEN] = olsr_cnf->smart_gw_prefix.prefix_len;
390       memcpy(&ip[GW_HNA_V6PREFIX], &olsr_cnf->smart_gw_prefix.prefix, 8);
391     }
392   }
393 }
394
395 /*
396  * TC/SPF/HNA Interface
397  */
398
399 /**
400  * Checks if a HNA prefix/netmask combination is a smart gateway
401  *
402  * @param prefix
403  * @param mask
404  * @return true if is a valid smart gateway HNA, false otherwise
405  */
406 bool olsr_is_smart_gateway(struct olsr_ip_prefix *prefix, union olsr_ip_addr *mask) {
407   uint8_t *ptr;
408
409   if (!is_prefix_inetgw(prefix)) {
410     return false;
411   }
412
413   ptr = OLSR_IP_ADDR_2_HNA_PTR(mask, prefix->prefix_len);
414   return ptr[GW_HNA_PAD] == 0 && ptr[GW_HNA_FLAGS] != 0;
415 }
416
417 /**
418  * Update a gateway_entry based on a HNA
419  *
420  * @param originator ip of the source of the HNA
421  * @param mask netmask of the HNA
422  * @param prefixlen of the HNA
423  * @param seqno the sequence number of the HNA
424  */
425 void olsr_update_gateway_entry(union olsr_ip_addr *originator, union olsr_ip_addr *mask, int prefixlen, uint16_t seqno) {
426   struct gw_container_entry * new_gw_in_list;
427   uint8_t *ptr;
428   struct gateway_entry *gw = node2gateway(avl_find(&gateway_tree, originator));
429
430   if (!gw) {
431     gw = olsr_cookie_malloc(gateway_entry_mem_cookie);
432     gw->originator = *originator;
433     gw->node.key = &gw->originator;
434
435     avl_insert(&gateway_tree, &gw->node, AVL_DUP_NO);
436   } else if (olsr_seqno_diff(seqno, gw->seqno) <= 0) {
437     /* ignore older HNAs */
438     return;
439   }
440
441   /* keep new HNA seqno */
442   gw->seqno = seqno;
443
444   ptr = OLSR_IP_ADDR_2_HNA_PTR(mask, prefixlen);
445   if ((ptr[GW_HNA_FLAGS] & GW_HNA_FLAG_LINKSPEED) != 0) {
446     gw->uplink = deserialize_gw_speed(ptr[GW_HNA_UPLINK]);
447     gw->downlink = deserialize_gw_speed(ptr[GW_HNA_DOWNLINK]);
448   } else {
449     gw->uplink = 0;
450     gw->downlink = 0;
451   }
452
453   gw->ipv4 = (ptr[GW_HNA_FLAGS] & GW_HNA_FLAG_IPV4) != 0;
454   gw->ipv4nat = (ptr[GW_HNA_FLAGS] & GW_HNA_FLAG_IPV4_NAT) != 0;
455
456   if (olsr_cnf->ip_version == AF_INET6) {
457     gw->ipv6 = (ptr[GW_HNA_FLAGS] & GW_HNA_FLAG_IPV6) != 0;
458
459     /* do not reset prefixlength for ::ffff:0:0 HNAs */
460     if (prefixlen == ipv6_internet_route.prefix_len) {
461       memset(&gw->external_prefix, 0, sizeof(gw->external_prefix));
462
463       if ((ptr[GW_HNA_FLAGS] & GW_HNA_FLAG_IPV6PREFIX) != 0
464           && memcmp(mask->v6.s6_addr, &ipv6_internet_route.prefix, olsr_cnf->ipsize) == 0) {
465         /* this is the right prefix (2000::/3), so we can copy the prefix */
466         gw->external_prefix.prefix_len = ptr[GW_HNA_V6PREFIXLEN];
467         memcpy(&gw->external_prefix.prefix, &ptr[GW_HNA_V6PREFIX], 8);
468       }
469     }
470   }
471
472   /* stop cleanup timer if necessary */
473   if (gw->cleanup_timer) {
474     olsr_stop_timer(gw->cleanup_timer);
475     gw->cleanup_timer = NULL;
476   }
477
478   /* update the costs of the gateway when it is an active gateway */
479   new_gw_in_list = olsr_gw_list_find(&gw_list_ipv4, gw);
480   if (new_gw_in_list) {
481     assert(gw_handler);
482     new_gw_in_list = olsr_gw_list_update(&gw_list_ipv4, new_gw_in_list, gw_handler->getcosts(new_gw_in_list->gw));
483   }
484
485   /* call update handler */
486   assert(gw_handler);
487   gw_handler->update(gw);
488 }
489
490 /**
491  * Delete a gateway based on the originator IP and the prefixlength of a HNA.
492  * Should only be called if prefix is a smart_gw prefix or if node is removed
493  * from TC set.
494  *
495  * @param originator
496  * @param prefixlen
497  * @param immediate when set to true then the gateway is removed from the
498  * gateway tree immediately, else it is removed on a delayed schedule.
499  */
500 void olsr_delete_gateway_entry(union olsr_ip_addr *originator, uint8_t prefixlen, bool immediate) {
501   olsr_delete_gateway_tree_entry(node2gateway(avl_find(&gateway_tree, originator)), prefixlen, immediate);
502 }
503
504 /**
505  * Delete a gateway entry .
506  *
507  * @param gw a gateway entry from the gateway tree
508  * @param prefixlen
509  * @param immediate when set to true then the gateway is removed from the
510  * gateway tree immediately, else it is removed on a delayed schedule.
511  */
512 static void olsr_delete_gateway_tree_entry(struct gateway_entry * gw, uint8_t prefixlen, bool immediate) {
513   bool change = false;
514
515   if (!gw) {
516     return;
517   }
518
519   if (immediate && gw->cleanup_timer) {
520     /* stop timer if we have to remove immediately */
521     olsr_stop_timer(gw->cleanup_timer);
522     gw->cleanup_timer = NULL;
523   }
524
525   if (gw->cleanup_timer == NULL || gw->ipv4 || gw->ipv6) {
526     /* the gw  is not scheduled for deletion */
527
528     if (olsr_cnf->ip_version == AF_INET && prefixlen == 0) {
529       change = gw->ipv4;
530       gw->ipv4 = false;
531       gw->ipv4nat = false;
532     } else if (olsr_cnf->ip_version == AF_INET6 && prefixlen == ipv6_internet_route.prefix_len) {
533       change = gw->ipv6;
534       gw->ipv6 = false;
535     } else if (olsr_cnf->ip_version == AF_INET6 && prefixlen == ipv6_mappedv4_route.prefix_len) {
536       change = gw->ipv4;
537       gw->ipv4 = false;
538       gw->ipv4nat = false;
539     }
540
541     if (prefixlen == FORCE_DELETE_GW_ENTRY || !(gw->ipv4 || gw->ipv6)) {
542       struct gw_container_entry * gw_in_list;
543
544       /* prevent this gateway from being chosen as the new gateway */
545       gw->ipv4 = false;
546       gw->ipv4nat = false;
547       gw->ipv6 = false;
548
549       /* handle gateway loss */
550       assert(gw_handler);
551       gw_handler->delete(gw);
552
553       /* cleanup gateway if necessary */
554       gw_in_list = olsr_gw_list_find(&gw_list_ipv4, gw);
555       if (gw_in_list) {
556         if (current_ipv4_gw && current_ipv4_gw->gw == gw) {
557           olsr_os_inetgw_tunnel_route(current_ipv4_gw->tunnel->if_index, true, false, NULL);
558           current_ipv4_gw = NULL;
559         }
560
561         if (gw_in_list->tunnel) {
562           olsr_os_del_ipip_tunnel(gw_in_list->tunnel);
563           gw_in_list->tunnel = NULL;
564         }
565
566         gw_in_list->gw = NULL;
567         gw_in_list = olsr_gw_list_remove(&gw_list_ipv4, gw_in_list);
568         olsr_cookie_free(gw_container_entry_mem_cookie, gw_in_list);
569       }
570
571       gw_in_list = olsr_gw_list_find(&gw_list_ipv6, gw);
572       if (gw_in_list) {
573         if (current_ipv6_gw && current_ipv6_gw->gw == gw) {
574           olsr_os_inetgw_tunnel_route(current_ipv6_gw->tunnel->if_index, false, false, NULL);
575           current_ipv6_gw = NULL;
576         }
577
578         if (gw_in_list->tunnel) {
579           olsr_os_del_ipip_tunnel(gw_in_list->tunnel);
580           gw_in_list->tunnel = NULL;
581         }
582
583         gw_in_list->gw = NULL;
584         gw_in_list = olsr_gw_list_remove(&gw_list_ipv6, gw_in_list);
585         olsr_cookie_free(gw_container_entry_mem_cookie, gw_in_list);
586       }
587
588       if (!immediate) {
589         /* remove gateway entry on a delayed schedule */
590         olsr_set_timer(&gw->cleanup_timer, GW_CLEANUP_INTERVAL, 0, false, cleanup_gateway_handler, gw, NULL);
591       } else {
592         cleanup_gateway_handler(gw);
593       }
594
595       /* when the current gateway was deleted, then immediately choose a new gateway */
596       if (!current_ipv4_gw || !current_ipv6_gw) {
597         assert(gw_handler);
598         gw_handler->choose(!current_ipv4_gw, !current_ipv6_gw);
599       }
600
601     } else if (change) {
602       assert(gw_handler);
603       gw_handler->update(gw);
604     }
605   }
606 }
607
608 /**
609  * Triggers a check if the one of the gateways have been lost or has an
610  * ETX = infinity
611  */
612 void olsr_trigger_gatewayloss_check(void) {
613   bool ipv4 = false;
614   bool ipv6 = false;
615
616   if (current_ipv4_gw && current_ipv4_gw->gw) {
617     struct tc_entry *tc = olsr_lookup_tc_entry(&current_ipv4_gw->gw->originator);
618     ipv4 = (tc == NULL || tc->path_cost == ROUTE_COST_BROKEN);
619   }
620   if (current_ipv6_gw && current_ipv6_gw->gw) {
621     struct tc_entry *tc = olsr_lookup_tc_entry(&current_ipv6_gw->gw->originator);
622     ipv6 = (tc == NULL || tc->path_cost == ROUTE_COST_BROKEN);
623   }
624
625   if (ipv4 || ipv6) {
626     assert(gw_handler);
627     gw_handler->choose(ipv4, ipv6);
628   }
629 }
630
631 /*
632  * Gateway Plugin Functions
633  */
634
635 /**
636  * Sets a new internet gateway.
637  *
638  * @param originator ip address of the node with the new gateway
639  * @param path_cost the path cost
640  * @param ipv4 set ipv4 gateway
641  * @param ipv6 set ipv6 gateway
642  * @return true if an error happened, false otherwise
643  */
644 bool olsr_set_inet_gateway(union olsr_ip_addr *originator, uint64_t path_cost, bool ipv4, bool ipv6) {
645   struct gateway_entry *new_gw;
646
647   ipv4 = ipv4 && (olsr_cnf->ip_version == AF_INET || olsr_cnf->use_niit);
648   ipv6 = ipv6 && (olsr_cnf->ip_version == AF_INET6);
649   if (!ipv4 && !ipv6) {
650     return true;
651   }
652
653   new_gw = node2gateway(avl_find(&gateway_tree, originator));
654   if (!new_gw) {
655     /* the originator is not in the gateway tree, we can't set it as gateway */
656     return true;
657   }
658
659   /* handle IPv4 */
660   if (ipv4 && new_gw->ipv4 && (!new_gw->ipv4nat || olsr_cnf->smart_gw_allow_nat) && (!current_ipv4_gw || current_ipv4_gw->gw != new_gw)) {
661     /* new gw is different than the current gw */
662
663     struct gw_container_entry * new_gw_in_list = olsr_gw_list_find(&gw_list_ipv4, new_gw);
664     if (new_gw_in_list) {
665       /* new gw is already in the gw list */
666       assert(new_gw_in_list->tunnel);
667       olsr_os_inetgw_tunnel_route(new_gw_in_list->tunnel->if_index, true, true, NULL);
668       current_ipv4_gw = olsr_gw_list_update(&gw_list_ipv4, new_gw_in_list, path_cost);
669     } else {
670       /* new gw is not yet in the gw list */
671       char name[IFNAMSIZ];
672       struct olsr_iptunnel_entry *new_v4gw_tunnel;
673
674       if (olsr_gw_list_full(&gw_list_ipv4)) {
675         /* the list is full: remove the worst active gateway */
676         struct gw_container_entry* worst = olsr_gw_list_get_worst_entry(&gw_list_ipv4);
677         assert(worst);
678
679         if (worst->tunnel) {
680           olsr_os_del_ipip_tunnel(worst->tunnel);
681           worst->tunnel = NULL;
682         }
683         worst->gw = NULL;
684         olsr_cookie_free(gw_container_entry_mem_cookie, olsr_gw_list_remove(&gw_list_ipv4, worst));
685       }
686
687       generate_iptunnel_name(&new_gw->originator, name);
688       new_v4gw_tunnel = olsr_os_add_ipip_tunnel(&new_gw->originator, true, name);
689       if (new_v4gw_tunnel) {
690         olsr_os_inetgw_tunnel_route(new_v4gw_tunnel->if_index, true, true, NULL);
691
692         new_gw_in_list = olsr_cookie_malloc(gw_container_entry_mem_cookie);
693         new_gw_in_list->gw = new_gw;
694         new_gw_in_list->tunnel = new_v4gw_tunnel;
695         new_gw_in_list->path_cost = path_cost;
696         current_ipv4_gw = olsr_gw_list_add(&gw_list_ipv4, new_gw_in_list);
697       } else {
698         /* adding the tunnel failed, we try again in the next cycle */
699         ipv4 = false;
700       }
701     }
702   }
703
704   /* handle IPv6 */
705   if (ipv6 && new_gw->ipv6 && (!current_ipv6_gw || current_ipv6_gw->gw != new_gw)) {
706     /* new gw is different than the current gw */
707
708         struct gw_container_entry * new_gw_in_list = olsr_gw_list_find(&gw_list_ipv6, new_gw);
709     if (new_gw_in_list) {
710       /* new gw is already in the gw list */
711       assert(new_gw_in_list->tunnel);
712       olsr_os_inetgw_tunnel_route(new_gw_in_list->tunnel->if_index, true, true, NULL);
713       current_ipv6_gw = olsr_gw_list_update(&gw_list_ipv6, new_gw_in_list, path_cost);
714     } else {
715       /* new gw is not yet in the gw list */
716       char name[IFNAMSIZ];
717       struct olsr_iptunnel_entry *new_v6gw_tunnel;
718
719       if (olsr_gw_list_full(&gw_list_ipv6)) {
720         /* the list is full: remove the worst active gateway */
721         struct gw_container_entry* worst = olsr_gw_list_get_worst_entry(&gw_list_ipv6);
722         assert(worst);
723
724         if (worst->tunnel) {
725           olsr_os_del_ipip_tunnel(worst->tunnel);
726           worst->tunnel = NULL;
727         }
728         worst->gw = NULL;
729         olsr_cookie_free(gw_container_entry_mem_cookie, olsr_gw_list_remove(&gw_list_ipv6, worst));
730       }
731
732       generate_iptunnel_name(&new_gw->originator, name);
733       new_v6gw_tunnel = olsr_os_add_ipip_tunnel(&new_gw->originator, false, name);
734       if (new_v6gw_tunnel) {
735         olsr_os_inetgw_tunnel_route(new_v6gw_tunnel->if_index, false, true, NULL);
736
737         new_gw_in_list = olsr_cookie_malloc(gw_container_entry_mem_cookie);
738         new_gw_in_list->gw = new_gw;
739         new_gw_in_list->tunnel = new_v6gw_tunnel;
740         new_gw_in_list->path_cost = path_cost;
741         current_ipv6_gw = olsr_gw_list_add(&gw_list_ipv6, new_gw_in_list);
742       } else {
743         /* adding the tunnel failed, we try again in the next cycle */
744         ipv6 = false;
745       }
746     }
747   }
748
749   return !ipv4 && !ipv6;
750 }
751
752 /**
753  * @param ipv6 if set to true then the IPv6 gateway is returned, otherwise the IPv4
754  * gateway is returned
755  * @return a pointer to the gateway_entry of the current ipv4 internet gw or
756  * NULL if not set.
757  */
758 struct gateway_entry *olsr_get_inet_gateway(bool ipv6) {
759         if (ipv6) {
760                 return current_ipv6_gw ? current_ipv6_gw->gw : NULL;
761         }
762
763         return current_ipv4_gw ? current_ipv4_gw->gw : NULL;
764 }
765
766 #endif /* __linux__ */