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