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