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