gateway: add asserts to validate 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 /** 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
218   olsr_os_cleanup_iptunnel(olsr_cnf->ip_version == AF_INET ? TUNNEL_ENDPOINT_IF : TUNNEL_ENDPOINT_IF6);
219 }
220
221 /**
222  * Triggers the first lookup of a gateway.
223  */
224 void olsr_trigger_inetgw_startup(void) {
225   assert(gw_handler);
226   gw_handler->handle_startup();
227 }
228
229 /**
230  * Print debug information about gateway entries
231  */
232 void olsr_print_gateway_entries(void) {
233 #ifndef NODEBUG
234   struct ipaddr_str buf;
235   struct gateway_entry *gw;
236   const int addrsize = olsr_cnf->ip_version == AF_INET ? 15 : 39;
237
238   OLSR_PRINTF(0, "\n--- %s ---------------------------------------------------- GATEWAYS\n\n", olsr_wallclock_string());
239   OLSR_PRINTF(0, "%-*s %-6s %-9s %-9s %s\n",
240       addrsize, "IP address", "Type", "Uplink", "Downlink", olsr_cnf->ip_version == AF_INET ? "" : "External Prefix");
241
242   OLSR_FOR_ALL_GATEWAY_ENTRIES(gw) {
243     OLSR_PRINTF(0, "%-*s %s%c%s%c%c %-9u %-9u %s\n",
244         addrsize,
245         olsr_ip_to_string(&buf, &gw->originator),
246         gw->ipv4nat ? "" : "   ",
247         gw->ipv4 ? '4' : ' ',
248         gw->ipv4nat ? "(N)" : "",
249         (gw->ipv4 && gw->ipv6) ? ',' : ' ',
250         gw->ipv6 ? '6' : ' ',
251         gw->uplink,
252         gw->downlink,
253         gw->external_prefix.prefix_len == 0 ? "" : olsr_ip_prefix_to_string(&gw->external_prefix));
254   } OLSR_FOR_ALL_GATEWAY_ENTRIES_END(gw)
255 #endif
256 }
257
258 /*
259  * Tx Path Interface
260  */
261
262 /**
263  * Apply the smart gateway modifications to an outgoing HNA
264  *
265  * @param mask pointer to netmask of the HNA
266  * @param prefixlen of the HNA
267  */
268 void olsr_modifiy_inetgw_netmask(union olsr_ip_addr *mask, int prefixlen) {
269   uint8_t *ptr = OLSR_IP_ADDR_2_HNA_PTR(mask, prefixlen);
270
271   memcpy(ptr, &smart_gateway_netmask, sizeof(smart_gateway_netmask) - prefixlen / 8);
272   if (olsr_cnf->has_ipv4_gateway) {
273     ptr[GW_HNA_FLAGS] |= GW_HNA_FLAG_IPV4;
274
275     if (olsr_cnf->smart_gw_uplink_nat) {
276       ptr[GW_HNA_FLAGS] |= GW_HNA_FLAG_IPV4_NAT;
277     }
278   }
279   if (olsr_cnf->has_ipv6_gateway) {
280     ptr[GW_HNA_FLAGS] |= GW_HNA_FLAG_IPV6;
281   }
282   if (!olsr_cnf->has_ipv6_gateway || prefixlen != ipv6_internet_route.prefix_len) {
283     ptr[GW_HNA_FLAGS] &= ~GW_HNA_FLAG_IPV6PREFIX;
284   }
285 }
286
287 /*
288  * SgwDynSpeed Plugin Interface
289  */
290
291 /**
292  * Setup the gateway netmask
293  */
294 void refresh_smartgw_netmask(void) {
295   uint8_t *ip;
296   memset(&smart_gateway_netmask, 0, sizeof(smart_gateway_netmask));
297
298   if (olsr_cnf->smart_gw_active) {
299     ip = (uint8_t *) &smart_gateway_netmask;
300
301     if (olsr_cnf->smart_gw_uplink > 0 && olsr_cnf->smart_gw_downlink > 0) {
302       /* the link is bi-directional with a non-zero bandwidth */
303       ip[GW_HNA_FLAGS] |= GW_HNA_FLAG_LINKSPEED;
304       ip[GW_HNA_DOWNLINK] = serialize_gw_speed(olsr_cnf->smart_gw_downlink);
305       ip[GW_HNA_UPLINK] = serialize_gw_speed(olsr_cnf->smart_gw_uplink);
306     }
307     if (olsr_cnf->ip_version == AF_INET6 && olsr_cnf->smart_gw_prefix.prefix_len > 0) {
308       ip[GW_HNA_FLAGS] |= GW_HNA_FLAG_IPV6PREFIX;
309       ip[GW_HNA_V6PREFIXLEN] = olsr_cnf->smart_gw_prefix.prefix_len;
310       memcpy(&ip[GW_HNA_V6PREFIX], &olsr_cnf->smart_gw_prefix.prefix, 8);
311     }
312   }
313 }
314
315 /*
316  * TC/SPF/HNA Interface
317  */
318
319 /**
320  * Checks if a HNA prefix/netmask combination is a smart gateway
321  *
322  * @param prefix
323  * @param mask
324  * @return true if is a valid smart gateway HNA, false otherwise
325  */
326 bool olsr_is_smart_gateway(struct olsr_ip_prefix *prefix, union olsr_ip_addr *mask) {
327   uint8_t *ptr;
328
329   if (!is_prefix_inetgw(prefix)) {
330     return false;
331   }
332
333   ptr = OLSR_IP_ADDR_2_HNA_PTR(mask, prefix->prefix_len);
334   return ptr[GW_HNA_PAD] == 0 && ptr[GW_HNA_FLAGS] != 0;
335 }
336
337 /**
338  * Update a gateway_entry based on a HNA
339  *
340  * @param originator ip of the source of the HNA
341  * @param mask netmask of the HNA
342  * @param prefixlen of the HNA
343  * @param seqno the sequence number of the HNA
344  */
345 void olsr_update_gateway_entry(union olsr_ip_addr *originator, union olsr_ip_addr *mask, int prefixlen, uint16_t seqno) {
346   struct gateway_entry *gw = olsr_find_gateway_entry(originator);
347   uint8_t *ptr = OLSR_IP_ADDR_2_HNA_PTR(mask, prefixlen);
348
349   if (!gw) {
350     gw = olsr_cookie_malloc(gw_mem_cookie);
351     gw->originator = *originator;
352     gw->node.key = &gw->originator;
353
354     avl_insert(&gateway_tree, &gw->node, AVL_DUP_NO);
355   } else if (olsr_seqno_diff(seqno, gw->seqno) <= 0) {
356     /* ignore older HNAs */
357     return;
358   }
359
360   /* keep new HNA seqno */
361   gw->seqno = seqno;
362
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->handle_update_gw(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  */
409 void olsr_delete_gateway_entry(union olsr_ip_addr *originator, uint8_t prefixlen) {
410   struct gateway_entry *gw = olsr_find_gateway_entry(originator);
411   bool change = false;
412
413   if (gw && (gw->cleanup_timer == NULL || gw->ipv4 || gw->ipv6)) {
414     /* found a gw and it wasn't deleted yet */
415
416     if (olsr_cnf->ip_version == AF_INET && prefixlen == 0) {
417       change = gw->ipv4;
418       gw->ipv4 = false;
419       gw->ipv4nat = false;
420     } else if (olsr_cnf->ip_version == AF_INET6 && prefixlen == ipv6_internet_route.prefix_len) {
421       change = gw->ipv6;
422       gw->ipv6 = false;
423     } else if (olsr_cnf->ip_version == AF_INET6 && prefixlen == ipv6_mappedv4_route.prefix_len) {
424       change = gw->ipv4;
425       gw->ipv4 = false;
426       gw->ipv4nat = false;
427     }
428
429     if (prefixlen == FORCE_DELETE_GW_ENTRY || !(gw->ipv4 || gw->ipv6)) {
430       /* prevent this gateway from being chosen as the new gateway */
431       gw->ipv4 = false;
432       gw->ipv4nat = false;
433       gw->ipv6 = false;
434
435       /* handle gateway loss */
436       assert(gw_handler);
437       gw_handler->handle_delete_gw(gw);
438
439       /* cleanup gateway if necessary */
440       if (current_ipv4_gw == gw) {
441         olsr_os_inetgw_tunnel_route(v4gw_tunnel->if_index, true, false);
442         olsr_os_del_ipip_tunnel(v4gw_tunnel);
443
444         current_ipv4_gw = NULL;
445         v4gw_tunnel = NULL;
446       }
447       if (current_ipv6_gw == gw) {
448         olsr_os_inetgw_tunnel_route(v6gw_tunnel->if_index, false, false);
449         olsr_os_del_ipip_tunnel(v6gw_tunnel);
450
451         current_ipv6_gw = NULL;
452         v6gw_tunnel = NULL;
453       }
454
455       /* remove gateway entry on a delayed schedule */
456       olsr_set_timer(&gw->cleanup_timer, GW_CLEANUP_INTERVAL, 0, false, cleanup_gateway_handler, gw, NULL);
457     } else if (change) {
458       assert(gw_handler);
459       gw_handler->handle_update_gw(gw);
460     }
461   }
462 }
463
464 /**
465  * Triggers a check if the one of the gateways have been lost or has an
466  * ETX = infinity
467  */
468 void olsr_trigger_gatewayloss_check(void) {
469   bool ipv4 = false;
470   bool ipv6 = false;
471
472   if (current_ipv4_gw) {
473     struct tc_entry *tc = olsr_lookup_tc_entry(&current_ipv4_gw->originator);
474     ipv4 = (tc == NULL || tc->path_cost == ROUTE_COST_BROKEN);
475   }
476   if (current_ipv6_gw) {
477     struct tc_entry *tc = olsr_lookup_tc_entry(&current_ipv6_gw->originator);
478     ipv6 = (tc == NULL || tc->path_cost == ROUTE_COST_BROKEN);
479   }
480
481   if (ipv4 || ipv6) {
482     olsr_trigger_inetgw_selection(ipv4, ipv6);
483   }
484 }
485
486 /*
487  * Gateway Plugin Functions
488  */
489
490 /**
491  * Set a new gateway handler.
492  * Only call this once: during startup (from a plugin to override the default
493  * handler)
494  *
495  * @param h pointer to gateway handler struct
496  */
497 void olsr_set_inetgw_handler(struct olsr_gw_handler *h) {
498   assert(h);
499   gw_handler = h;
500 }
501
502 /**
503  * Sets a new internet gateway.
504  *
505  * @param originator ip address of the node with the new gateway
506  * @param ipv4 set ipv4 gateway
507  * @param ipv6 set ipv6 gateway
508  * @return true if an error happened, false otherwise
509  */
510 bool olsr_set_inet_gateway(union olsr_ip_addr *originator, bool ipv4, bool ipv6) {
511   struct gateway_entry *entry;
512   struct gateway_entry *oldV4 = current_ipv4_gw;
513   struct gateway_entry *oldV6 = current_ipv6_gw;
514   struct olsr_iptunnel_entry *tunnelV4 = v4gw_tunnel;
515   struct olsr_iptunnel_entry *tunnelV6 = v6gw_tunnel;
516
517   ipv4 = ipv4 && (olsr_cnf->ip_version == AF_INET || olsr_cnf->use_niit);
518   ipv6 = ipv6 && (olsr_cnf->ip_version == AF_INET6);
519
520   if (ipv4) {
521     current_ipv4_gw = NULL;
522   }
523   if (ipv6) {
524     current_ipv6_gw = NULL;
525   }
526
527   entry = olsr_find_gateway_entry(originator);
528   if (entry != NULL) {
529     if (ipv4 && entry != current_ipv4_gw && entry->ipv4 && (!entry->ipv4nat || olsr_cnf->smart_gw_allow_nat)) {
530       /* valid ipv4 gateway */
531       current_ipv4_gw = entry;
532     }
533     if (ipv6 && entry != current_ipv6_gw && entry->ipv6) {
534       /* valid ipv6 gateway */
535       current_ipv6_gw = entry;
536     }
537   }
538
539   /* handle IPv4 */
540   if (oldV4 != current_ipv4_gw) {
541     if ((v4gw_tunnel = olsr_os_add_ipip_tunnel(&current_ipv4_gw->originator, true)) != NULL) {
542       olsr_os_inetgw_tunnel_route(v4gw_tunnel->if_index, true, true);
543     } else {
544       /* adding the tunnel failed, we try again in the next cycle */
545       current_ipv4_gw = NULL;
546     }
547     if (oldV4 != NULL) {
548       olsr_os_del_ipip_tunnel(tunnelV4);
549     }
550   }
551   /* handle IPv6 */
552   if (oldV6 != current_ipv6_gw) {
553     if ((v6gw_tunnel = olsr_os_add_ipip_tunnel(&current_ipv6_gw->originator, false)) != NULL) {
554       olsr_os_inetgw_tunnel_route(v6gw_tunnel->if_index, false, true);
555     } else {
556       /* adding the tunnel failed, we try again in the next cycle */
557       current_ipv6_gw = NULL;
558     }
559     if (oldV6 != NULL) {
560       olsr_os_del_ipip_tunnel(tunnelV6);
561     }
562   }
563   return (ipv4 && current_ipv4_gw == NULL) || (ipv6 && current_ipv6_gw == NULL);
564 }
565
566 /**
567  * @return a pointer to the gateway_entry of the current ipv4 internet gw or
568  * NULL if not set.
569  */
570 struct gateway_entry *olsr_get_ipv4_inet_gateway(void) {
571   return current_ipv4_gw;
572 }
573
574 /**
575  * @return a pointer to the gateway_entry of the current ipv4 internet gw or
576  * NULL if not set.
577  */
578 struct gateway_entry *olsr_get_ipv6_inet_gateway(void) {
579   return current_ipv6_gw;
580 }
581
582 #endif /* linux */