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