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