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