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