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