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