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