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