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