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