gateway: rename hooks
[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->choose(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   /* initialize default gateway handler */
194   gw_handler = &gw_def_handler;
195   gw_handler->init();
196
197   return 0;
198 }
199
200 /**
201  * Cleanup gateway tunnel system
202  */
203 void olsr_cleanup_gateways(void) {
204   if (current_ipv4_gw) {
205     olsr_os_del_ipip_tunnel(v4gw_tunnel);
206   }
207   if (current_ipv6_gw) {
208     olsr_os_del_ipip_tunnel(v6gw_tunnel);
209   }
210
211   olsr_remove_ifchange_handler(smartgw_tunnel_monitor);
212
213   assert(gw_handler);
214   gw_handler->cleanup();
215   gw_handler = NULL;
216
217   olsr_os_cleanup_iptunnel(olsr_cnf->ip_version == AF_INET ? TUNNEL_ENDPOINT_IF : TUNNEL_ENDPOINT_IF6);
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
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   struct gateway_entry *gw = olsr_find_gateway_entry(originator);
346   uint8_t *ptr = OLSR_IP_ADDR_2_HNA_PTR(mask, prefixlen);
347
348   if (!gw) {
349     gw = olsr_cookie_malloc(gw_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   if ((ptr[GW_HNA_FLAGS] & GW_HNA_FLAG_LINKSPEED) != 0) {
363     gw->uplink = deserialize_gw_speed(ptr[GW_HNA_UPLINK]);
364     gw->downlink = deserialize_gw_speed(ptr[GW_HNA_DOWNLINK]);
365   } else {
366     gw->uplink = 0;
367     gw->downlink = 0;
368   }
369
370   gw->ipv4 = (ptr[GW_HNA_FLAGS] & GW_HNA_FLAG_IPV4) != 0;
371   gw->ipv4nat = (ptr[GW_HNA_FLAGS] & GW_HNA_FLAG_IPV4_NAT) != 0;
372
373   if (olsr_cnf->ip_version == AF_INET6) {
374     gw->ipv6 = (ptr[GW_HNA_FLAGS] & GW_HNA_FLAG_IPV6) != 0;
375
376     /* do not reset prefixlength for ::ffff:0:0 HNAs */
377     if (prefixlen == ipv6_internet_route.prefix_len) {
378       memset(&gw->external_prefix, 0, sizeof(gw->external_prefix));
379
380       if ((ptr[GW_HNA_FLAGS] & GW_HNA_FLAG_IPV6PREFIX) != 0
381           && memcmp(mask->v6.s6_addr, &ipv6_internet_route.prefix, olsr_cnf->ipsize) == 0) {
382         /* this is the right prefix (2000::/3), so we can copy the prefix */
383         gw->external_prefix.prefix_len = ptr[GW_HNA_V6PREFIXLEN];
384         memcpy(&gw->external_prefix.prefix, &ptr[GW_HNA_V6PREFIX], 8);
385       }
386     }
387   }
388
389   /* stop cleanup timer if necessary */
390   if (gw->cleanup_timer) {
391     olsr_stop_timer(gw->cleanup_timer);
392     gw->cleanup_timer = NULL;
393   }
394
395   /* call update handler */
396   assert(gw_handler);
397   gw_handler->update(gw);
398 }
399
400 /**
401  * Delete a gateway based on the originator IP and the prefixlength of a HNA.
402  * Should only be called if prefix is a smart_gw prefix or if node is removed
403  * from TC set.
404  *
405  * @param originator
406  * @param prefixlen
407  */
408 void olsr_delete_gateway_entry(union olsr_ip_addr *originator, uint8_t prefixlen) {
409   struct gateway_entry *gw = olsr_find_gateway_entry(originator);
410   bool change = false;
411
412   if (gw && (gw->cleanup_timer == NULL || gw->ipv4 || gw->ipv6)) {
413     /* found a gw and it wasn't deleted yet */
414
415     if (olsr_cnf->ip_version == AF_INET && prefixlen == 0) {
416       change = gw->ipv4;
417       gw->ipv4 = false;
418       gw->ipv4nat = false;
419     } else if (olsr_cnf->ip_version == AF_INET6 && prefixlen == ipv6_internet_route.prefix_len) {
420       change = gw->ipv6;
421       gw->ipv6 = false;
422     } else if (olsr_cnf->ip_version == AF_INET6 && prefixlen == ipv6_mappedv4_route.prefix_len) {
423       change = gw->ipv4;
424       gw->ipv4 = false;
425       gw->ipv4nat = false;
426     }
427
428     if (prefixlen == FORCE_DELETE_GW_ENTRY || !(gw->ipv4 || gw->ipv6)) {
429       /* prevent this gateway from being chosen as the new gateway */
430       gw->ipv4 = false;
431       gw->ipv4nat = false;
432       gw->ipv6 = false;
433
434       /* handle gateway loss */
435       assert(gw_handler);
436       gw_handler->delete(gw);
437
438       /* cleanup gateway if necessary */
439       if (current_ipv4_gw == gw) {
440         olsr_os_inetgw_tunnel_route(v4gw_tunnel->if_index, true, false);
441         olsr_os_del_ipip_tunnel(v4gw_tunnel);
442
443         current_ipv4_gw = NULL;
444         v4gw_tunnel = NULL;
445       }
446       if (current_ipv6_gw == gw) {
447         olsr_os_inetgw_tunnel_route(v6gw_tunnel->if_index, false, false);
448         olsr_os_del_ipip_tunnel(v6gw_tunnel);
449
450         current_ipv6_gw = NULL;
451         v6gw_tunnel = NULL;
452       }
453
454       /* remove gateway entry on a delayed schedule */
455       olsr_set_timer(&gw->cleanup_timer, GW_CLEANUP_INTERVAL, 0, false, cleanup_gateway_handler, gw, NULL);
456     } else if (change) {
457       assert(gw_handler);
458       gw_handler->update(gw);
459     }
460   }
461 }
462
463 /**
464  * Triggers a check if the one of the gateways have been lost or has an
465  * ETX = infinity
466  */
467 void olsr_trigger_gatewayloss_check(void) {
468   bool ipv4 = false;
469   bool ipv6 = false;
470
471   if (current_ipv4_gw) {
472     struct tc_entry *tc = olsr_lookup_tc_entry(&current_ipv4_gw->originator);
473     ipv4 = (tc == NULL || tc->path_cost == ROUTE_COST_BROKEN);
474   }
475   if (current_ipv6_gw) {
476     struct tc_entry *tc = olsr_lookup_tc_entry(&current_ipv6_gw->originator);
477     ipv6 = (tc == NULL || tc->path_cost == ROUTE_COST_BROKEN);
478   }
479
480   if (ipv4 || ipv6) {
481     olsr_trigger_inetgw_selection(ipv4, ipv6);
482   }
483 }
484
485 /*
486  * Gateway Plugin Functions
487  */
488
489 /**
490  * Sets a new internet gateway.
491  *
492  * @param originator ip address of the node with the new gateway
493  * @param ipv4 set ipv4 gateway
494  * @param ipv6 set ipv6 gateway
495  * @return true if an error happened, false otherwise
496  */
497 bool olsr_set_inet_gateway(union olsr_ip_addr *originator, bool ipv4, bool ipv6) {
498   struct gateway_entry *entry;
499   struct gateway_entry *oldV4 = current_ipv4_gw;
500   struct gateway_entry *oldV6 = current_ipv6_gw;
501   struct olsr_iptunnel_entry *tunnelV4 = v4gw_tunnel;
502   struct olsr_iptunnel_entry *tunnelV6 = v6gw_tunnel;
503
504   ipv4 = ipv4 && (olsr_cnf->ip_version == AF_INET || olsr_cnf->use_niit);
505   ipv6 = ipv6 && (olsr_cnf->ip_version == AF_INET6);
506
507   if (ipv4) {
508     current_ipv4_gw = NULL;
509   }
510   if (ipv6) {
511     current_ipv6_gw = NULL;
512   }
513
514   entry = olsr_find_gateway_entry(originator);
515   if (entry != NULL) {
516     if (ipv4 && entry != current_ipv4_gw && entry->ipv4 && (!entry->ipv4nat || olsr_cnf->smart_gw_allow_nat)) {
517       /* valid ipv4 gateway */
518       current_ipv4_gw = entry;
519     }
520     if (ipv6 && entry != current_ipv6_gw && entry->ipv6) {
521       /* valid ipv6 gateway */
522       current_ipv6_gw = entry;
523     }
524   }
525
526   /* handle IPv4 */
527   if (oldV4 != current_ipv4_gw) {
528     if ((v4gw_tunnel = olsr_os_add_ipip_tunnel(&current_ipv4_gw->originator, true)) != NULL) {
529       olsr_os_inetgw_tunnel_route(v4gw_tunnel->if_index, true, true);
530     } else {
531       /* adding the tunnel failed, we try again in the next cycle */
532       current_ipv4_gw = NULL;
533     }
534     if (oldV4 != NULL) {
535       olsr_os_del_ipip_tunnel(tunnelV4);
536     }
537   }
538   /* handle IPv6 */
539   if (oldV6 != current_ipv6_gw) {
540     if ((v6gw_tunnel = olsr_os_add_ipip_tunnel(&current_ipv6_gw->originator, false)) != NULL) {
541       olsr_os_inetgw_tunnel_route(v6gw_tunnel->if_index, false, true);
542     } else {
543       /* adding the tunnel failed, we try again in the next cycle */
544       current_ipv6_gw = NULL;
545     }
546     if (oldV6 != NULL) {
547       olsr_os_del_ipip_tunnel(tunnelV6);
548     }
549   }
550   return (ipv4 && current_ipv4_gw == NULL) || (ipv6 && current_ipv6_gw == NULL);
551 }
552
553 /**
554  * @return a pointer to the gateway_entry of the current ipv4 internet gw or
555  * NULL if not set.
556  */
557 struct gateway_entry *olsr_get_ipv4_inet_gateway(void) {
558   return current_ipv4_gw;
559 }
560
561 /**
562  * @return a pointer to the gateway_entry of the current ipv4 internet gw or
563  * NULL if not set.
564  */
565 struct gateway_entry *olsr_get_ipv6_inet_gateway(void) {
566   return current_ipv6_gw;
567 }
568
569 #endif /* linux */