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