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