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