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