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