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