gateway: ensure cleanup uses the reverse order of init
[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.h"
24
25 #include <assert.h>
26 #include <net/if.h>
27
28 /** the gateway tree */
29 struct avl_tree gateway_tree;
30
31 /** gateway cookie */
32 static struct olsr_cookie_info *gw_mem_cookie = NULL;
33
34 /** the gateway netmask for the HNA */
35 static uint8_t smart_gateway_netmask[sizeof(union olsr_ip_addr)];
36
37 /** the gateway handler/plugin */
38 static struct olsr_gw_handler *gw_handler;
39
40 /** the current IPv4 gateway */
41 static struct gateway_entry *current_ipv4_gw;
42
43 /** the tunnel of the current IPv4  gateway */
44 static struct olsr_iptunnel_entry *v4gw_tunnel;
45
46 /** the current IPv6 gateway */
47 static struct gateway_entry *current_ipv6_gw;
48
49 /** the tunnel of the current IPv6  gateway */
50 static struct olsr_iptunnel_entry *v6gw_tunnel;
51
52 /*
53  * Helper Functions
54  */
55
56 #define OLSR_IP_ADDR_2_HNA_PTR(mask, prefixlen) (((uint8_t *)mask) + ((prefixlen+7)/8))
57
58 /**
59  * Convert an encoded 1 byte transport value (5 bits mantissa, 3 bits exponent)
60  * to an uplink/downlink speed value
61  *
62  * @param value the encoded 1 byte transport value
63  * @return the uplink/downlink speed value (in kbit/s)
64  */
65 static uint32_t deserialize_gw_speed(uint8_t value) {
66   uint32_t speed;
67   uint32_t exp;
68
69   if (!value) {
70     /* 0 and 1 alias onto 0 during serialisation. We take 0 here to mean 0 and
71      * not 1 (since a bandwidth of 1 is no bandwidth at all really) */
72     return 0;
73   }
74
75   speed = (value >> 3) + 1;
76   exp = value & 7;
77
78   while (exp-- > 0) {
79     speed *= 10;
80   }
81   return speed;
82 }
83
84 /**
85  * Convert an uplink/downlink speed value into an encoded 1 byte transport
86  * value (5 bits mantissa, 3 bits exponent)
87  *
88  * @param speed the uplink/downlink speed value (in kbit/s)
89  * @return value the encoded 1 byte transport value
90  */
91 static uint8_t serialize_gw_speed(uint32_t speed) {
92   uint8_t exp = 0;
93
94   if (speed == 0) {
95     return 0;
96   }
97
98   if (speed > 320000000) {
99     return 0xff;
100   }
101
102   while ((speed > 32 || (speed % 10) == 0) && exp < 7) {
103     speed /= 10;
104     exp++;
105   }
106   return ((speed - 1) << 3) | exp;
107 }
108
109 /*
110  * Callback Functions
111  */
112
113 /**
114  * Callback for tunnel interface monitoring which will set the route into the tunnel
115  * when the interface comes up again.
116  *
117  * @param if_index the interface index
118  * @param ifh the interface
119  * @param flag interface change flags
120  */
121 static void smartgw_tunnel_monitor(int if_index __attribute__ ((unused)),
122     struct interface *ifh __attribute__ ((unused)), enum olsr_ifchg_flag flag __attribute__ ((unused))) {
123   return;
124 }
125
126 /**
127  * Timer callback to remove and cleanup a gateway entry
128  *
129  * @param ptr
130  */
131 static void cleanup_gateway_handler(void *ptr) {
132   struct gateway_entry *gw = ptr;
133
134   if (gw->ipv4 || gw->ipv6) {
135     /* do not clean it up when it is in use */
136     return;
137   }
138
139   /* remove gateway entry */
140   avl_delete(&gateway_tree, &gw->node);
141   olsr_cookie_free(gw_mem_cookie, gw);
142 }
143
144 /*
145  * Main Interface
146  */
147
148 /**
149  * Initialize gateway system
150  */
151 int olsr_init_gateways(void) {
152   gw_mem_cookie = olsr_alloc_cookie("Gateway cookie", OLSR_COOKIE_TYPE_MEMORY);
153   olsr_cookie_set_memory_size(gw_mem_cookie, sizeof(struct gateway_entry));
154
155   avl_init(&gateway_tree, avl_comp_default);
156
157   current_ipv4_gw = NULL;
158   v4gw_tunnel = NULL;
159
160   current_ipv6_gw = NULL;
161   v6gw_tunnel = NULL;
162
163   gw_handler = NULL;
164
165   refresh_smartgw_netmask();
166
167   /* initialize default gateway handler */
168   gw_handler = &gw_def_handler;
169   gw_handler->init();
170
171   if (olsr_os_init_iptunnel(olsr_cnf->ip_version == AF_INET ? TUNNEL_ENDPOINT_IF : TUNNEL_ENDPOINT_IF6)) {
172     return 1;
173   }
174
175   olsr_add_ifchange_handler(smartgw_tunnel_monitor);
176
177   return 0;
178 }
179
180 /**
181  * Cleanup gateway tunnel system
182  */
183 void olsr_cleanup_gateways(void) {
184   olsr_remove_ifchange_handler(smartgw_tunnel_monitor);
185
186   olsr_os_cleanup_iptunnel(olsr_cnf->ip_version == AF_INET ? TUNNEL_ENDPOINT_IF : TUNNEL_ENDPOINT_IF6);
187
188   if (current_ipv4_gw) {
189     olsr_os_del_ipip_tunnel(v4gw_tunnel);
190   }
191   if (current_ipv6_gw) {
192     olsr_os_del_ipip_tunnel(v6gw_tunnel);
193   }
194
195   assert(gw_handler);
196   gw_handler->cleanup();
197   gw_handler = NULL;
198
199   olsr_free_cookie(gw_mem_cookie);
200 }
201
202 /**
203  * Triggers the first lookup of a gateway.
204  */
205 void olsr_trigger_inetgw_startup(void) {
206   assert(gw_handler);
207   gw_handler->startup();
208 }
209
210 /**
211  * Print debug information about gateway entries
212  */
213 void olsr_print_gateway_entries(void) {
214 #ifndef NODEBUG
215   struct ipaddr_str buf;
216   struct gateway_entry *gw;
217   const int addrsize = olsr_cnf->ip_version == AF_INET ? 15 : 39;
218
219   OLSR_PRINTF(0, "\n--- %s ---------------------------------------------------- GATEWAYS\n\n", olsr_wallclock_string());
220   OLSR_PRINTF(0, "%-*s %-6s %-9s %-9s %s\n",
221       addrsize, "IP address", "Type", "Uplink", "Downlink", olsr_cnf->ip_version == AF_INET ? "" : "External Prefix");
222
223   OLSR_FOR_ALL_GATEWAY_ENTRIES(gw) {
224     OLSR_PRINTF(0, "%-*s %s%c%s%c%c %-9u %-9u %s\n",
225         addrsize,
226         olsr_ip_to_string(&buf, &gw->originator),
227         gw->ipv4nat ? "" : "   ",
228         gw->ipv4 ? '4' : ' ',
229         gw->ipv4nat ? "(N)" : "",
230         (gw->ipv4 && gw->ipv6) ? ',' : ' ',
231         gw->ipv6 ? '6' : ' ',
232         gw->uplink,
233         gw->downlink,
234         gw->external_prefix.prefix_len == 0 ? "" : olsr_ip_prefix_to_string(&gw->external_prefix));
235   } OLSR_FOR_ALL_GATEWAY_ENTRIES_END(gw)
236 #endif /* NODEBUG */
237 }
238
239 /*
240  * Tx Path Interface
241  */
242
243 /**
244  * Apply the smart gateway modifications to an outgoing HNA
245  *
246  * @param mask pointer to netmask of the HNA
247  * @param prefixlen of the HNA
248  */
249 void olsr_modifiy_inetgw_netmask(union olsr_ip_addr *mask, int prefixlen) {
250   uint8_t *ptr = OLSR_IP_ADDR_2_HNA_PTR(mask, prefixlen);
251
252   memcpy(ptr, &smart_gateway_netmask, sizeof(smart_gateway_netmask) - prefixlen / 8);
253   if (olsr_cnf->has_ipv4_gateway) {
254     ptr[GW_HNA_FLAGS] |= GW_HNA_FLAG_IPV4;
255
256     if (olsr_cnf->smart_gw_uplink_nat) {
257       ptr[GW_HNA_FLAGS] |= GW_HNA_FLAG_IPV4_NAT;
258     }
259   }
260   if (olsr_cnf->has_ipv6_gateway) {
261     ptr[GW_HNA_FLAGS] |= GW_HNA_FLAG_IPV6;
262   }
263   if (!olsr_cnf->has_ipv6_gateway || prefixlen != ipv6_internet_route.prefix_len) {
264     ptr[GW_HNA_FLAGS] &= ~GW_HNA_FLAG_IPV6PREFIX;
265   }
266 }
267
268 /*
269  * SgwDynSpeed Plugin Interface
270  */
271
272 /**
273  * Setup the gateway netmask
274  */
275 void refresh_smartgw_netmask(void) {
276   uint8_t *ip;
277   memset(&smart_gateway_netmask, 0, sizeof(smart_gateway_netmask));
278
279   if (olsr_cnf->smart_gw_active) {
280     ip = (uint8_t *) &smart_gateway_netmask;
281
282     if (olsr_cnf->smart_gw_uplink > 0 && olsr_cnf->smart_gw_downlink > 0) {
283       /* the link is bi-directional with a non-zero bandwidth */
284       ip[GW_HNA_FLAGS] |= GW_HNA_FLAG_LINKSPEED;
285       ip[GW_HNA_DOWNLINK] = serialize_gw_speed(olsr_cnf->smart_gw_downlink);
286       ip[GW_HNA_UPLINK] = serialize_gw_speed(olsr_cnf->smart_gw_uplink);
287     }
288     if (olsr_cnf->ip_version == AF_INET6 && olsr_cnf->smart_gw_prefix.prefix_len > 0) {
289       ip[GW_HNA_FLAGS] |= GW_HNA_FLAG_IPV6PREFIX;
290       ip[GW_HNA_V6PREFIXLEN] = olsr_cnf->smart_gw_prefix.prefix_len;
291       memcpy(&ip[GW_HNA_V6PREFIX], &olsr_cnf->smart_gw_prefix.prefix, 8);
292     }
293   }
294 }
295
296 /*
297  * TC/SPF/HNA Interface
298  */
299
300 /**
301  * Checks if a HNA prefix/netmask combination is a smart gateway
302  *
303  * @param prefix
304  * @param mask
305  * @return true if is a valid smart gateway HNA, false otherwise
306  */
307 bool olsr_is_smart_gateway(struct olsr_ip_prefix *prefix, union olsr_ip_addr *mask) {
308   uint8_t *ptr;
309
310   if (!is_prefix_inetgw(prefix)) {
311     return false;
312   }
313
314   ptr = OLSR_IP_ADDR_2_HNA_PTR(mask, prefix->prefix_len);
315   return ptr[GW_HNA_PAD] == 0 && ptr[GW_HNA_FLAGS] != 0;
316 }
317
318 /**
319  * Update a gateway_entry based on a HNA
320  *
321  * @param originator ip of the source of the HNA
322  * @param mask netmask of the HNA
323  * @param prefixlen of the HNA
324  * @param seqno the sequence number of the HNA
325  */
326 void olsr_update_gateway_entry(union olsr_ip_addr *originator, union olsr_ip_addr *mask, int prefixlen, uint16_t seqno) {
327   struct gateway_entry *gw = node2gateway(avl_find(&gateway_tree, originator));
328   uint8_t *ptr = OLSR_IP_ADDR_2_HNA_PTR(mask, prefixlen);
329
330   if (!gw) {
331     gw = olsr_cookie_malloc(gw_mem_cookie);
332     gw->originator = *originator;
333     gw->node.key = &gw->originator;
334
335     avl_insert(&gateway_tree, &gw->node, AVL_DUP_NO);
336   } else if (olsr_seqno_diff(seqno, gw->seqno) <= 0) {
337     /* ignore older HNAs */
338     return;
339   }
340
341   /* keep new HNA seqno */
342   gw->seqno = seqno;
343
344   if ((ptr[GW_HNA_FLAGS] & GW_HNA_FLAG_LINKSPEED) != 0) {
345     gw->uplink = deserialize_gw_speed(ptr[GW_HNA_UPLINK]);
346     gw->downlink = deserialize_gw_speed(ptr[GW_HNA_DOWNLINK]);
347   } else {
348     gw->uplink = 0;
349     gw->downlink = 0;
350   }
351
352   gw->ipv4 = (ptr[GW_HNA_FLAGS] & GW_HNA_FLAG_IPV4) != 0;
353   gw->ipv4nat = (ptr[GW_HNA_FLAGS] & GW_HNA_FLAG_IPV4_NAT) != 0;
354
355   if (olsr_cnf->ip_version == AF_INET6) {
356     gw->ipv6 = (ptr[GW_HNA_FLAGS] & GW_HNA_FLAG_IPV6) != 0;
357
358     /* do not reset prefixlength for ::ffff:0:0 HNAs */
359     if (prefixlen == ipv6_internet_route.prefix_len) {
360       memset(&gw->external_prefix, 0, sizeof(gw->external_prefix));
361
362       if ((ptr[GW_HNA_FLAGS] & GW_HNA_FLAG_IPV6PREFIX) != 0
363           && memcmp(mask->v6.s6_addr, &ipv6_internet_route.prefix, olsr_cnf->ipsize) == 0) {
364         /* this is the right prefix (2000::/3), so we can copy the prefix */
365         gw->external_prefix.prefix_len = ptr[GW_HNA_V6PREFIXLEN];
366         memcpy(&gw->external_prefix.prefix, &ptr[GW_HNA_V6PREFIX], 8);
367       }
368     }
369   }
370
371   /* stop cleanup timer if necessary */
372   if (gw->cleanup_timer) {
373     olsr_stop_timer(gw->cleanup_timer);
374     gw->cleanup_timer = NULL;
375   }
376
377   /* call update handler */
378   assert(gw_handler);
379   gw_handler->update(gw);
380 }
381
382 /**
383  * Delete a gateway based on the originator IP and the prefixlength of a HNA.
384  * Should only be called if prefix is a smart_gw prefix or if node is removed
385  * from TC set.
386  *
387  * @param originator
388  * @param prefixlen
389  */
390 void olsr_delete_gateway_entry(union olsr_ip_addr *originator, uint8_t prefixlen) {
391   struct gateway_entry *gw = node2gateway(avl_find(&gateway_tree, originator));
392   bool change = false;
393
394   if (gw && (gw->cleanup_timer == NULL || gw->ipv4 || gw->ipv6)) {
395     /* found a gw and it wasn't deleted yet */
396
397     if (olsr_cnf->ip_version == AF_INET && prefixlen == 0) {
398       change = gw->ipv4;
399       gw->ipv4 = false;
400       gw->ipv4nat = false;
401     } else if (olsr_cnf->ip_version == AF_INET6 && prefixlen == ipv6_internet_route.prefix_len) {
402       change = gw->ipv6;
403       gw->ipv6 = false;
404     } else if (olsr_cnf->ip_version == AF_INET6 && prefixlen == ipv6_mappedv4_route.prefix_len) {
405       change = gw->ipv4;
406       gw->ipv4 = false;
407       gw->ipv4nat = false;
408     }
409
410     if (prefixlen == FORCE_DELETE_GW_ENTRY || !(gw->ipv4 || gw->ipv6)) {
411       /* prevent this gateway from being chosen as the new gateway */
412       gw->ipv4 = false;
413       gw->ipv4nat = false;
414       gw->ipv6 = false;
415
416       /* handle gateway loss */
417       assert(gw_handler);
418       gw_handler->delete(gw);
419
420       /* cleanup gateway if necessary */
421       if (current_ipv4_gw == gw) {
422         olsr_os_inetgw_tunnel_route(v4gw_tunnel->if_index, true, false);
423         olsr_os_del_ipip_tunnel(v4gw_tunnel);
424
425         current_ipv4_gw = NULL;
426         v4gw_tunnel = NULL;
427       }
428       if (current_ipv6_gw == gw) {
429         olsr_os_inetgw_tunnel_route(v6gw_tunnel->if_index, false, false);
430         olsr_os_del_ipip_tunnel(v6gw_tunnel);
431
432         current_ipv6_gw = NULL;
433         v6gw_tunnel = NULL;
434       }
435
436       /* remove gateway entry on a delayed schedule */
437       olsr_set_timer(&gw->cleanup_timer, GW_CLEANUP_INTERVAL, 0, false, cleanup_gateway_handler, gw, NULL);
438     } else if (change) {
439       assert(gw_handler);
440       gw_handler->update(gw);
441     }
442   }
443 }
444
445 /**
446  * Triggers a check if the one of the gateways have been lost or has an
447  * ETX = infinity
448  */
449 void olsr_trigger_gatewayloss_check(void) {
450   bool ipv4 = false;
451   bool ipv6 = false;
452
453   if (current_ipv4_gw) {
454     struct tc_entry *tc = olsr_lookup_tc_entry(&current_ipv4_gw->originator);
455     ipv4 = (tc == NULL || tc->path_cost == ROUTE_COST_BROKEN);
456   }
457   if (current_ipv6_gw) {
458     struct tc_entry *tc = olsr_lookup_tc_entry(&current_ipv6_gw->originator);
459     ipv6 = (tc == NULL || tc->path_cost == ROUTE_COST_BROKEN);
460   }
461
462   if (ipv4 || ipv6) {
463     assert(gw_handler);
464     gw_handler->choose(ipv4, ipv6);
465   }
466 }
467
468 /*
469  * Gateway Plugin Functions
470  */
471
472 /**
473  * Sets a new internet gateway.
474  *
475  * @param originator ip address of the node with the new gateway
476  * @param ipv4 set ipv4 gateway
477  * @param ipv6 set ipv6 gateway
478  * @return true if an error happened, false otherwise
479  */
480 bool olsr_set_inet_gateway(union olsr_ip_addr *originator, bool ipv4, bool ipv6) {
481   struct gateway_entry *entry;
482   struct gateway_entry *oldV4 = current_ipv4_gw;
483   struct gateway_entry *oldV6 = current_ipv6_gw;
484   struct olsr_iptunnel_entry *oldV4Tunnel = v4gw_tunnel;
485   struct olsr_iptunnel_entry *oldV6Tunnel = v6gw_tunnel;
486
487   ipv4 = ipv4 && (olsr_cnf->ip_version == AF_INET || olsr_cnf->use_niit);
488   ipv6 = ipv6 && (olsr_cnf->ip_version == AF_INET6);
489   if (!ipv4 && !ipv6) {
490     return true;
491   }
492
493   entry = node2gateway(avl_find(&gateway_tree, originator));
494   if (!entry) {
495     return true;
496   }
497
498   /* handle IPv4 */
499   if (ipv4) {
500     current_ipv4_gw = NULL;
501     if (entry->ipv4 && (!entry->ipv4nat || olsr_cnf->smart_gw_allow_nat)) {
502       /* valid ipv4 gateway */
503       current_ipv4_gw = entry;
504       if (oldV4 != current_ipv4_gw) {
505         if ((v4gw_tunnel = olsr_os_add_ipip_tunnel(&current_ipv4_gw->originator, true)) != NULL) {
506           olsr_os_inetgw_tunnel_route(v4gw_tunnel->if_index, true, true);
507         } else {
508           /* adding the tunnel failed, we try again in the next cycle */
509           current_ipv4_gw = NULL;
510         }
511         if (oldV4 != NULL) {
512           olsr_os_del_ipip_tunnel(oldV4Tunnel);
513         }
514       }
515     }
516   }
517
518   /* handle IPv6 */
519   if (ipv6) {
520     current_ipv6_gw = NULL;
521     if (entry->ipv6) {
522       /* valid ipv6 gateway */
523       current_ipv6_gw = entry;
524       if (oldV6 != current_ipv6_gw) {
525         if ((v6gw_tunnel = olsr_os_add_ipip_tunnel(&current_ipv6_gw->originator, false)) != NULL) {
526           olsr_os_inetgw_tunnel_route(v6gw_tunnel->if_index, false, true);
527         } else {
528           /* adding the tunnel failed, we try again in the next cycle */
529           current_ipv6_gw = NULL;
530         }
531         if (oldV6 != NULL) {
532           olsr_os_del_ipip_tunnel(oldV6Tunnel);
533         }
534       }
535     }
536   }
537
538   return (ipv4 && current_ipv4_gw == NULL) || (ipv6 && current_ipv6_gw == NULL);
539 }
540
541 /**
542  * @param if set to true then the IPv6 gateway is returned, otherwise the IPv4
543  * gateway is returned
544  * @return a pointer to the gateway_entry of the current ipv4 internet gw or
545  * NULL if not set.
546  */
547 struct gateway_entry *olsr_get_inet_gateway(bool ipv6) {
548         if (ipv6) {
549                 return current_ipv6_gw;
550         }
551
552         return current_ipv4_gw;
553 }
554
555 #endif /* __linux__ */