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