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