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