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