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