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