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