gateway: reset bandwidth to zero when no link speed is advertised
[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   bool ipv4 = false;
260   bool ipv6 = false;
261
262   if (current_ipv4_gw) {
263         struct tc_entry *tc = olsr_lookup_tc_entry(&current_ipv4_gw->originator);
264         ipv4 = (tc == NULL || tc->path_cost == ROUTE_COST_BROKEN);
265   }
266   if (current_ipv6_gw) {
267         struct tc_entry *tc = olsr_lookup_tc_entry(&current_ipv6_gw->originator);
268         ipv6 = (tc == NULL || tc->path_cost == ROUTE_COST_BROKEN);
269   }
270
271   if (ipv4 || ipv6) {
272     olsr_trigger_inetgw_selection(ipv4, ipv6);
273   }
274 }
275
276 /**
277  * Update a gateway_entry based on a HNA
278  *
279  * @param originator ip of the source of the HNA
280  * @param mask netmask of the HNA
281  * @param prefixlen of the HNA
282  * @param seqno the sequence number of the HNA
283  */
284 void
285 olsr_update_gateway_entry(union olsr_ip_addr *originator, union olsr_ip_addr *mask, int prefixlen, uint16_t seqno) {
286   struct gateway_entry *gw = olsr_find_gateway_entry(originator);
287   uint8_t *ptr = OLSR_IP_ADDR_2_HNA_PTR(mask, prefixlen);
288
289   if (!gw) {
290     gw = olsr_cookie_malloc(gw_mem_cookie);
291     gw->originator = *originator;
292     gw->node.key = &gw->originator;
293
294     avl_insert(&gateway_tree, &gw->node, AVL_DUP_NO);
295   }
296   else if (olsr_seqno_diff(seqno, gw->seqno) <= 0) {
297     /* ignore older HNAs */
298     return;
299   }
300
301   /* keep new HNA seqno */
302   gw->seqno = seqno;
303
304   if ((ptr[GW_HNA_FLAGS] & GW_HNA_FLAG_LINKSPEED) != 0) {
305     gw->uplink = deserialize_gw_speed(ptr[GW_HNA_UPLINK]);
306     gw->downlink = deserialize_gw_speed(ptr[GW_HNA_DOWNLINK]);
307   }
308   else {
309     gw->uplink = 0;
310     gw->downlink = 0;
311   }
312
313   gw->ipv4 = (ptr[GW_HNA_FLAGS] & GW_HNA_FLAG_IPV4) != 0;
314   gw->ipv4nat = (ptr[GW_HNA_FLAGS] & GW_HNA_FLAG_IPV4_NAT) != 0;
315
316   if (olsr_cnf->ip_version == AF_INET6) {
317     gw->ipv6 = (ptr[GW_HNA_FLAGS] & GW_HNA_FLAG_IPV6) != 0;
318
319     /* do not reset prefixlength for ::ffff:0:0 HNAs */
320     if (prefixlen == ipv6_internet_route.prefix_len) {
321       memset(&gw->external_prefix, 0, sizeof(gw->external_prefix));
322
323       if ((ptr[GW_HNA_FLAGS] & GW_HNA_FLAG_IPV6PREFIX) != 0
324           && memcmp(mask->v6.s6_addr, &ipv6_internet_route.prefix, olsr_cnf->ipsize) == 0) {
325         /* this is the right prefix (2000::/3), so we can copy the prefix */
326         gw->external_prefix.prefix_len = ptr[GW_HNA_V6PREFIXLEN];
327         memcpy(&gw->external_prefix.prefix, &ptr[GW_HNA_V6PREFIX], 8);
328       }
329     }
330   }
331
332   /* stop cleanup timer if necessary */
333   if (gw->cleanup_timer) {
334     olsr_stop_timer(gw->cleanup_timer);
335     gw->cleanup_timer = NULL;
336   }
337
338   /* call update handler */
339   gw_handler->handle_update_gw(gw);
340 }
341
342 /**
343  * Delete a gateway based on the originator IP and the prefixlength of a HNA.
344  * Should only be called if prefix is a smart_gw prefix or if node is removed
345  * from TC set.
346  *
347  * @param originator
348  * @param prefixlen
349  */
350 void
351 olsr_delete_gateway_entry(union olsr_ip_addr *originator, uint8_t prefixlen) {
352   struct gateway_entry *gw = olsr_find_gateway_entry(originator);
353   bool change = false;
354
355   if (gw && (gw->cleanup_timer == NULL || gw->ipv4 || gw->ipv6)) {
356     /* found a gw and it wasn't deleted yet */
357
358     if (olsr_cnf->ip_version == AF_INET && prefixlen == 0) {
359       change = gw->ipv4;
360       gw->ipv4 = false;
361       gw->ipv4nat = false;
362     }
363     else if (olsr_cnf->ip_version == AF_INET6 && prefixlen == ipv6_internet_route.prefix_len) {
364       change = gw->ipv6;
365       gw->ipv6 = false;
366     }
367     else if (olsr_cnf->ip_version == AF_INET6 && prefixlen == ipv6_mappedv4_route.prefix_len) {
368       change = gw->ipv4;
369       gw->ipv4 = false;
370       gw->ipv4nat = false;
371     }
372
373     if (prefixlen == FORCE_DELETE_GW_ENTRY || !(gw->ipv4 || gw->ipv6)) {
374       /* prevent this gateway from being chosen as the new gateway */
375       gw->ipv4 = false;
376       gw->ipv4nat = false;
377       gw->ipv6 = false;
378
379       /* handle gateway loss */
380       gw_handler->handle_delete_gw(gw);
381
382       /* cleanup gateway if necessary */
383       if (current_ipv4_gw == gw) {
384         olsr_os_inetgw_tunnel_route(v4gw_tunnel->if_index, true, false);
385         olsr_os_del_ipip_tunnel(v4gw_tunnel);
386
387         current_ipv4_gw = NULL;
388         v4gw_tunnel = NULL;
389       }
390       if (current_ipv6_gw == gw) {
391         olsr_os_inetgw_tunnel_route(v6gw_tunnel->if_index, false, false);
392         olsr_os_del_ipip_tunnel(v6gw_tunnel);
393
394         current_ipv6_gw = NULL;
395         v6gw_tunnel = NULL;
396       }
397
398       /* remove gateway entry on a delayed schedule */
399       olsr_set_timer(&gw->cleanup_timer, GW_CLEANUP_INTERVAL, 0, false, cleanup_gateway_handler, gw, NULL);
400     }
401     else if (change) {
402       gw_handler->handle_update_gw(gw);
403     }
404   }
405 }
406
407 /**
408  * Print debug information about gateway entries
409  */
410 void
411 olsr_print_gateway_entries(void) {
412 #ifndef NODEBUG
413   struct ipaddr_str buf;
414   struct gateway_entry *gw;
415   const int addrsize = olsr_cnf->ip_version == AF_INET ? 15 : 39;
416
417   OLSR_PRINTF(0, "\n--- %s ---------------------------------------------------- GATEWAYS\n\n",
418       olsr_wallclock_string());
419   OLSR_PRINTF(0, "%-*s %-6s %-9s %-9s %s\n", addrsize, "IP address", "Type", "Uplink", "Downlink",
420       olsr_cnf->ip_version == AF_INET ? "" : "External Prefix");
421
422   OLSR_FOR_ALL_GATEWAY_ENTRIES(gw) {
423     OLSR_PRINTF(0, "%-*s %s%c%s%c%c %-9u %-9u %s\n", addrsize, olsr_ip_to_string(&buf, &gw->originator),
424         gw->ipv4nat ? "" : "   ",
425         gw->ipv4 ? '4' : ' ',
426         gw->ipv4nat ? "(N)" : "",
427         (gw->ipv4 && gw->ipv6) ? ',' : ' ',
428         gw->ipv6 ? '6' : ' ',
429         gw->uplink, gw->downlink,
430         gw->external_prefix.prefix_len == 0 ? "" : olsr_ip_prefix_to_string(&gw->external_prefix));
431   } OLSR_FOR_ALL_GATEWAY_ENTRIES_END(gw)
432 #endif
433 }
434
435 /**
436  * Set a new gateway handler.
437  * Only call this once: during startup (from a plugin to override the default
438  * handler)
439  *
440  * @param h pointer to gateway handler struct
441  */
442 void
443 olsr_set_inetgw_handler(struct olsr_gw_handler *h) {
444   assert(h);
445   gw_handler = h;
446 }
447
448 /**
449  * Sets a new internet gateway.
450  *
451  * @param originator ip address of the node with the new gateway
452  * @param ipv4 set ipv4 gateway
453  * @param ipv6 set ipv6 gateway
454  * @param external true if change was triggered directly by an user,
455  *   false if triggered by automatic lookup.
456  * @return true if an error happened, false otherwise
457  */
458 bool
459 olsr_set_inet_gateway(union olsr_ip_addr *originator, bool ipv4, bool ipv6, bool external) {
460   struct gateway_entry *entry;
461   struct gateway_entry *oldV4 = current_ipv4_gw;
462   struct gateway_entry *oldV6 = current_ipv6_gw;
463   struct olsr_iptunnel_entry *tunnelV4 = v4gw_tunnel;
464   struct olsr_iptunnel_entry *tunnelV6 = v6gw_tunnel;
465
466   ipv4 = ipv4 && (olsr_cnf->ip_version == AF_INET || olsr_cnf->use_niit);
467   ipv6 = ipv6 && (olsr_cnf->ip_version == AF_INET6);
468
469   if (ipv4) {
470     current_ipv4_gw = NULL;
471   }
472   if (ipv6) {
473     current_ipv6_gw = NULL;
474   }
475
476   entry = olsr_find_gateway_entry(originator);
477   if (entry != NULL) {
478     if (ipv4 && entry != current_ipv4_gw && entry->ipv4
479         && (!entry->ipv4nat || olsr_cnf->smart_gw_allow_nat)) {
480       /* valid ipv4 gateway */
481       current_ipv4_gw = entry;
482     }
483     if (ipv6 && entry != current_ipv6_gw && entry->ipv6) {
484       /* valid ipv6 gateway */
485       current_ipv6_gw = entry;
486     }
487   }
488
489   /* handle IPv4 */
490   if (oldV4 != current_ipv4_gw) {
491     if ((v4gw_tunnel = olsr_os_add_ipip_tunnel(&current_ipv4_gw->originator, true)) != NULL) {
492       olsr_os_inetgw_tunnel_route(v4gw_tunnel->if_index, true, true);
493       v4gw_choosen_external = external;
494     }
495     else {
496       /* adding the tunnel failed, we try again in the next cycle */
497       current_ipv4_gw = NULL;
498     }
499     if (oldV4 != NULL) {
500       olsr_os_del_ipip_tunnel(tunnelV4);
501     }
502   }
503   /* handle IPv6 */
504   if (oldV6 != current_ipv6_gw) {
505     if ((v6gw_tunnel = olsr_os_add_ipip_tunnel(&current_ipv6_gw->originator, false)) != NULL) {
506       olsr_os_inetgw_tunnel_route(v6gw_tunnel->if_index, false, true);
507       v6gw_choosen_external = external;
508     }
509     else {
510       /* adding the tunnel failed, we try again in the next cycle */
511       current_ipv6_gw = NULL;
512     }
513     if (oldV6 != NULL) {
514       olsr_os_del_ipip_tunnel(tunnelV6);
515     }
516   }
517   return (ipv4 && current_ipv4_gw == NULL) || (ipv6 && current_ipv6_gw == NULL);
518 }
519
520 /**
521  * @return a pointer to the gateway_entry of the current ipv4 internet gw or
522  * NULL if not set. Also updates *ext (if not NULL) to indicate whether or not
523  * the gw was chosen externally.
524  */
525 struct gateway_entry *olsr_get_ipv4_inet_gateway(bool *ext) {
526   if (ext) {
527     *ext = v4gw_choosen_external;
528   }
529   return current_ipv4_gw;
530 }
531
532 /**
533  * @return a pointer to the gateway_entry of the current ipv4 internet gw or
534  * NULL if not set. Also updates *ext (if not NULL) to indicate whether or not
535  * the gw was chosen externally.
536  */
537 struct gateway_entry *olsr_get_ipv6_inet_gateway(bool *ext) {
538   if (ext) {
539     *ext = v6gw_choosen_external;
540   }
541   return current_ipv6_gw;
542 }
543
544 /**
545  * Checks if a HNA prefix/netmask combination is a smart gateway
546  *
547  * @param prefix
548  * @param mask
549  * @return true if is a valid smart gateway HNA, false otherwise
550  */
551 bool
552 olsr_is_smart_gateway(struct olsr_ip_prefix *prefix, union olsr_ip_addr *mask) {
553   uint8_t *ptr;
554
555   if (!is_prefix_inetgw(prefix)) {
556     return false;
557   }
558
559   ptr = OLSR_IP_ADDR_2_HNA_PTR(mask, prefix->prefix_len);
560   return ptr[GW_HNA_PAD] == 0 && ptr[GW_HNA_FLAGS] != 0;
561 }
562
563 /**
564  * Apply the smart gateway modifications to an outgoing HNA
565  *
566  * @param mask pointer to netmask of the HNA
567  * @param prefixlen of the HNA
568  */
569 void
570 olsr_modifiy_inetgw_netmask(union olsr_ip_addr *mask, int prefixlen) {
571   uint8_t *ptr = OLSR_IP_ADDR_2_HNA_PTR(mask, prefixlen);
572
573   memcpy(ptr, &smart_gateway_netmask, sizeof(smart_gateway_netmask) - prefixlen/8);
574   if (olsr_cnf->has_ipv4_gateway) {
575     ptr[GW_HNA_FLAGS] |= GW_HNA_FLAG_IPV4;
576
577     if (olsr_cnf->smart_gw_uplink_nat) {
578       ptr[GW_HNA_FLAGS] |= GW_HNA_FLAG_IPV4_NAT;
579     }
580   }
581   if (olsr_cnf->has_ipv6_gateway) {
582     ptr[GW_HNA_FLAGS] |= GW_HNA_FLAG_IPV6;
583   }
584   if (!olsr_cnf->has_ipv6_gateway || prefixlen != ipv6_internet_route.prefix_len){
585     ptr[GW_HNA_FLAGS] &= ~GW_HNA_FLAG_IPV6PREFIX;
586   }
587 }
588
589 #endif /* linux */