Compile fixes for BSD and WIN32
[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  * Initialize gateway system
78  */
79 int
80 olsr_init_gateways(void) {
81   uint8_t *ip;
82   gw_mem_cookie = olsr_alloc_cookie("Gateway cookie", OLSR_COOKIE_TYPE_MEMORY);
83   olsr_cookie_set_memory_size(gw_mem_cookie, sizeof(struct gateway_entry));
84
85   avl_init(&gateway_tree, avl_comp_default);
86   current_ipv4_gw = NULL;
87   current_ipv6_gw = NULL;
88
89   v4gw_tunnel = NULL;
90   v6gw_tunnel = NULL;
91
92   memset(&smart_gateway_netmask, 0, sizeof(smart_gateway_netmask));
93
94   if (olsr_cnf->smart_gw_active) {
95     union olsr_ip_addr gw_net;
96     memset(&gw_net, 0, sizeof(gw_net));
97
98     ip = (uint8_t *) &smart_gateway_netmask;
99
100     if (olsr_cnf->smart_gw_uplink > 0 || olsr_cnf->smart_gw_downlink > 0) {
101       ip[GW_HNA_FLAGS] |= GW_HNA_FLAG_LINKSPEED;
102       ip[GW_HNA_DOWNLINK] = serialize_gw_speed(olsr_cnf->smart_gw_downlink);
103       ip[GW_HNA_UPLINK] = serialize_gw_speed(olsr_cnf->smart_gw_uplink);
104     }
105     if (olsr_cnf->ip_version == AF_INET6 && olsr_cnf->smart_gw_prefix.prefix_len > 0) {
106       ip[GW_HNA_FLAGS] |= GW_HNA_FLAG_IPV6PREFIX;
107       ip[GW_HNA_V6PREFIXLEN] = olsr_cnf->smart_gw_prefix.prefix_len;
108       memcpy(&ip[GW_HNA_V6PREFIX], &olsr_cnf->smart_gw_prefix.prefix, 8);
109     }
110   }
111   if (olsr_os_init_iptunnel()) {
112     return 1;
113   }
114   /*
115    * initialize default gateway handler,
116    * can be overwritten with olsr_set_inetgw_handler
117    */
118   olsr_gw_default_init();
119   return 0;
120 }
121
122 /**
123  * Cleanup gateway tunnel system
124  */
125 void olsr_cleanup_gateways(void) {
126   if (current_ipv4_gw) {
127     olsr_os_del_ipip_tunnel(v4gw_tunnel);
128   }
129   if (current_ipv6_gw) {
130     olsr_os_del_ipip_tunnel(v6gw_tunnel);
131   }
132   olsr_os_cleanup_iptunnel();
133 }
134
135 /**
136  * Triggers the first lookup of an gateway. This lookup might
137  * take some time to wait for routing/gateway information.
138  */
139 void
140 olsr_trigger_inetgw_startup(void) {
141   gw_handler->handle_startup();
142 }
143
144 /**
145  * Triggers an instant gateway selection based on the current data
146  * @param ipv4 trigger a ipv4 gateway lookup
147  * @param ipv6 trigger a ipv6 gateway lookup
148  * @return 0 if successful, -1 otherwise
149  */
150 int
151 olsr_trigger_inetgw_selection(bool ipv4, bool ipv6) {
152   gw_handler->select_gateway(ipv4, ipv6);
153   return ((ipv4 && current_ipv4_gw == NULL) || (ipv6 && current_ipv6_gw == NULL)) ? -1 : 0;
154 }
155
156 /**
157  * Set a new gateway handler. Do only call this once during startup from
158  * a plugin to overwrite the default handler.
159  * @param h pointer to gateway handler struct
160  */
161 void
162 olsr_set_inetgw_handler(struct olsr_gw_handler *h) {
163   gw_handler = h;
164 }
165
166 /**
167  * Sets a new internet gateway.
168  * An external set command might trigger an internal one if
169  * address is not a legal gateway.
170  *
171  * @param originator ip address of the node with the new gateway
172  * @param ipv4 set ipv4 gateway
173  * @param ipv6 set ipv6 gateway
174  * @param external true if change was triggered directly by an user,
175  *   false if triggered by automatic lookup.
176  * @return true if an error happened, false otherwise
177  */
178 bool
179 olsr_set_inet_gateway(union olsr_ip_addr *originator, bool ipv4, bool ipv6, bool external) {
180   struct gateway_entry *entry, *oldV4, *oldV6;
181   struct olsr_iptunnel_entry *tunnelV4, *tunnelV6;
182
183   oldV4 = current_ipv4_gw;
184   oldV6 = current_ipv6_gw;
185   tunnelV4 = v4gw_tunnel;
186   tunnelV6 = v6gw_tunnel;
187
188   ipv4 = ipv4 && (olsr_cnf->ip_version == AF_INET || olsr_cnf->use_niit);
189   ipv6 = ipv6 && (olsr_cnf->ip_version == AF_INET6);
190
191   if (ipv4) {
192     current_ipv4_gw = NULL;
193   }
194   if (ipv6) {
195     current_ipv6_gw = NULL;
196   }
197
198   entry = olsr_find_gateway_entry(originator);
199   if (entry != NULL) {
200     if (ipv4 && entry != current_ipv4_gw && entry->ipv4
201         && (!entry->ipv4nat || olsr_cnf->smart_gw_allow_nat)) {
202       /* valid ipv4 gateway */
203       current_ipv4_gw = entry;
204     }
205     if (ipv6 && entry != current_ipv6_gw && entry->ipv6) {
206       /* valid ipv6 gateway */
207       current_ipv6_gw = entry;
208     }
209   }
210
211   /* handle IPv4 */
212   if (oldV4 != current_ipv4_gw) {
213     if ((v4gw_tunnel = olsr_os_add_ipip_tunnel(&current_ipv4_gw->originator, true)) != NULL) {
214       olsr_os_inetgw_tunnel_route(v4gw_tunnel->if_index, true, true);
215       v4gw_choosen_external = external;
216     }
217     else {
218       // TODO: what to do now ? Choose another one ? Fire up a timer ?
219       current_ipv4_gw = NULL;
220     }
221     if (oldV4 != NULL) {
222       olsr_os_del_ipip_tunnel(tunnelV4);
223     }
224   }
225   /* handle IPv6 */
226   if (oldV6 != current_ipv6_gw) {
227     if ((v6gw_tunnel = olsr_os_add_ipip_tunnel(&current_ipv6_gw->originator, false)) != NULL) {
228       olsr_os_inetgw_tunnel_route(v6gw_tunnel->if_index, false, true);
229       v6gw_choosen_external = external;
230     }
231     else {
232       // TODO: what to do now ? Choose another one ? Fire up a timer ?
233       current_ipv6_gw = NULL;
234     }
235     if (oldV6 != NULL) {
236       olsr_os_del_ipip_tunnel(tunnelV6);
237     }
238   }
239   return (ipv4 && current_ipv4_gw == NULL) || (ipv6 && current_ipv6_gw == NULL);
240 }
241
242 /**
243  * returns the gateway_entry of the current ipv4 internet gw.
244  * @return pointer to gateway_entry or NULL if not set
245  */
246 struct gateway_entry *olsr_get_ipv4_inet_gateway(bool *ext) {
247   if (ext) {
248     *ext = v4gw_choosen_external;
249   }
250   return current_ipv4_gw;
251 }
252
253 /**
254  * returns the gateway_entry of the current ipv6 internet gw.
255  * @return pointer to gateway_entry or NULL if not set
256  */
257 struct gateway_entry *olsr_get_ipv6_inet_gateway(bool *ext) {
258   if (ext) {
259     *ext = v6gw_choosen_external;
260   }
261   return current_ipv6_gw;
262 }
263
264 /**
265  * @param originator
266  * @return gateway_entry for corresponding router
267  */
268 struct gateway_entry *
269 olsr_find_gateway_entry(union olsr_ip_addr *originator) {
270   struct avl_node *node = avl_find(&gateway_tree, originator);
271
272   return node == NULL ? NULL : node2gateway(node);
273 }
274
275 /**
276  * update a gateway_entry based on data received from a HNA
277  * @param originator ip of the source of the HNA
278  * @param mask netmask of the HNA
279  * @param prefixlen of the HNA
280  */
281 void
282 olsr_update_gateway_entry(union olsr_ip_addr *originator, union olsr_ip_addr *mask, int prefixlen, uint16_t seqno) {
283   struct gateway_entry *gw;
284   uint8_t *ptr;
285
286   ptr = ((uint8_t *)mask) + ((prefixlen+7)/8);
287
288   gw = olsr_find_gateway_entry(originator);
289   if (!gw) {
290     struct ipaddr_str buf;
291     gw = olsr_cookie_malloc(gw_mem_cookie);
292
293     gw->originator = *originator;
294     gw->node.key = &gw->originator;
295
296     avl_insert(&gateway_tree, &gw->node, AVL_DUP_NO);
297   }
298   else if (olsr_seqno_diff(seqno, gw->seqno) <= 0) {
299     /* ignore older HNAs */
300     return;
301   }
302
303   /* keep new HNA seqno */
304   gw->seqno = seqno;
305
306   if ((ptr[GW_HNA_FLAGS] & GW_HNA_FLAG_LINKSPEED) != 0) {
307     gw->uplink = deserialize_gw_speed(ptr[GW_HNA_UPLINK]);
308     gw->downlink = deserialize_gw_speed(ptr[GW_HNA_DOWNLINK]);
309   }
310   else {
311     gw->uplink = 1;
312     gw->downlink = 1;
313   }
314
315   gw->ipv4 = (ptr[GW_HNA_FLAGS] & GW_HNA_FLAG_IPV4) != 0;
316   gw->ipv4nat = (ptr[GW_HNA_FLAGS] & GW_HNA_FLAG_IPV4_NAT) != 0;
317
318   if (olsr_cnf->ip_version == AF_INET6) {
319     gw->ipv6 = (ptr[GW_HNA_FLAGS] & GW_HNA_FLAG_IPV6) != 0;
320
321     /* do not reset prefixlength for ::ffff:0:0 HNAs */
322     if (prefixlen == ipv6_internet_route.prefix_len) {
323       memset(&gw->external_prefix, 0, sizeof(gw->external_prefix));
324
325       if ((ptr[GW_HNA_FLAGS] & GW_HNA_FLAG_IPV6PREFIX) != 0
326           && memcmp(mask->v6.s6_addr, &ipv6_internet_route.prefix, olsr_cnf->ipsize) == 0) {
327         /* this is the right prefix (2000::/3), so we can copy the prefix */
328         gw->external_prefix.prefix_len = ptr[GW_HNA_V6PREFIXLEN];
329         memcpy(&gw->external_prefix.prefix, &ptr[GW_HNA_V6PREFIX], 8);
330       }
331     }
332   }
333
334   /* stop cleanup timer if necessary */
335   if (gw->cleanup_timer) {
336     olsr_stop_timer(gw->cleanup_timer);
337     gw->cleanup_timer = NULL;
338   }
339
340   /* call update handler */
341   gw_handler->handle_update_gw(gw);
342 }
343
344 static void cleanup_gateway_handler(void *ptr) {
345   struct gateway_entry *gw = ptr;
346
347   if (gw->ipv4 || gw->ipv6) {
348     return;
349   }
350
351   /* remove gateway entry */
352   avl_delete(&gateway_tree, &gw->node);
353   olsr_cookie_free(gw_mem_cookie, gw);
354 }
355
356 /**
357  * Delete a gateway based on the originator IP and the prefixlength of a HNA.
358  * Should only be called if prefix is a smart_gw prefix or if node is removed
359  * from TC set.
360  * @param originator
361  * @param prefixlen
362  */
363 void
364 olsr_delete_gateway_entry(union olsr_ip_addr *originator, uint8_t prefixlen) {
365   struct gateway_entry *gw;
366   bool change = false;
367   gw = olsr_find_gateway_entry(originator);
368   if (gw && (gw->cleanup_timer == NULL || gw->ipv4 || gw->ipv6)) {
369     if (olsr_cnf->ip_version == AF_INET && prefixlen == 0) {
370       change = gw->ipv4;
371       gw->ipv4 = false;
372       gw->ipv4nat = false;
373     }
374     else if (olsr_cnf->ip_version == AF_INET6 && prefixlen == ipv6_internet_route.prefix_len) {
375       change = gw->ipv6;
376       gw->ipv6 = false;
377     }
378     else if (olsr_cnf->ip_version == AF_INET6 && prefixlen == ipv6_mappedv4_route.prefix_len) {
379       change = gw->ipv4;
380       gw->ipv4 = false;
381       gw->ipv4nat = false;
382     }
383
384     if (prefixlen == FORCE_DELETE_GW_ENTRY || !(gw->ipv4 || gw->ipv6)) {
385       /* prevent this gateway from being choosen as the new gateway */
386       gw->ipv4 = false;
387       gw->ipv4nat = false;
388       gw->ipv6 = false;
389
390       /* handle gateway loss */
391       gw_handler->handle_delete_gw(gw);
392       /* cleanup gateway if necessary */
393       if (current_ipv4_gw == gw) {
394         olsr_os_inetgw_tunnel_route(v4gw_tunnel->if_index, true, false);
395         olsr_os_del_ipip_tunnel(v4gw_tunnel);
396         current_ipv4_gw = NULL;
397         v4gw_tunnel = NULL;
398       }
399       if (current_ipv6_gw == gw) {
400         olsr_os_inetgw_tunnel_route(v6gw_tunnel->if_index, false, false);
401         olsr_os_del_ipip_tunnel(v6gw_tunnel);
402         current_ipv6_gw = NULL;
403         v6gw_tunnel = NULL;
404       }
405
406       /* remove gateway entry */
407       olsr_set_timer(&gw->cleanup_timer, GW_CLEANUP_INTERVAL, 0, false, cleanup_gateway_handler, gw, NULL);
408     }
409     else if (change) {
410       gw_handler->handle_update_gw(gw);
411     }
412   }
413 }
414
415 /**
416  * Checks if a prefix/netmask combination is a smart gateway
417  * @param prefix
418  * @param mask
419  * @return true if is a valid smart gateway HNA, false otherwise
420  */
421 bool
422 olsr_is_smart_gateway(struct olsr_ip_prefix *prefix, union olsr_ip_addr *mask) {
423   uint8_t *ptr;
424
425   if (!is_prefix_inetgw(prefix)) {
426     return false;
427   }
428
429   ptr = ((uint8_t *)mask) + ((prefix->prefix_len+7)/8);
430   return ptr[GW_HNA_PAD] == 0 && ptr[GW_HNA_FLAGS] != 0;
431 }
432
433 /**
434  * Apply the smart gateway modifications to an outgoing HNA
435  * @param mask pointer to netmask of the HNA
436  * @param prefixlen of the HNA
437  */
438 void
439 olsr_modifiy_inetgw_netmask(union olsr_ip_addr *mask, int prefixlen) {
440   uint8_t *ptr = ((uint8_t *)mask) + ((prefixlen+7)/8);
441
442   memcpy(ptr, &smart_gateway_netmask, sizeof(smart_gateway_netmask) - prefixlen/8);
443   if (olsr_cnf->has_ipv4_gateway) {
444     ptr[GW_HNA_FLAGS] |= GW_HNA_FLAG_IPV4;
445
446     if (olsr_cnf->smart_gw_uplink_nat) {
447       ptr[GW_HNA_FLAGS] |= GW_HNA_FLAG_IPV4_NAT;
448     }
449   }
450   if (olsr_cnf->has_ipv6_gateway) {
451     ptr[GW_HNA_FLAGS] |= GW_HNA_FLAG_IPV6;
452   }
453   if (!olsr_cnf->has_ipv6_gateway || prefixlen != ipv6_internet_route.prefix_len){
454     ptr[GW_HNA_FLAGS] &= ~GW_HNA_FLAG_IPV6PREFIX;
455   }
456 }
457
458 /**
459  * Print debug information about gateway entries
460  */
461 void
462 olsr_print_gateway_entries(void) {
463 #ifndef NODEBUG
464   struct ipaddr_str buf;
465   struct gateway_entry *gw;
466   const int addrsize = olsr_cnf->ip_version == AF_INET ? 15 : 39;
467
468   OLSR_PRINTF(0, "\n--- %s ---------------------------------------------------- GATEWAYS\n\n",
469       olsr_wallclock_string());
470   OLSR_PRINTF(0, "%-*s %-6s %-9s %-9s %s\n", addrsize, "IP address", "Type", "Uplink", "Downlink",
471       olsr_cnf->ip_version == AF_INET ? "" : "External Prefix");
472
473   OLSR_FOR_ALL_GATEWAY_ENTRIES(gw) {
474     OLSR_PRINTF(0, "%-*s %s%c%s%c%c %-9u %-9u %s\n", addrsize, olsr_ip_to_string(&buf, &gw->originator),
475         gw->ipv4nat ? "" : "   ",
476         gw->ipv4 ? '4' : ' ',
477         gw->ipv4nat ? "(N)" : "",
478         (gw->ipv4 && gw->ipv6) ? ',' : ' ',
479         gw->ipv6 ? '6' : ' ',
480         gw->uplink, gw->downlink,
481         gw->external_prefix.prefix_len == 0 ? "" : olsr_ip_prefix_to_string(&gw->external_prefix));
482   } OLSR_FOR_ALL_GATEWAY_ENTRIES_END(gw)
483 #endif
484 }
485
486 #endif /* !WIN32 */