4 * Created on: 05.01.2010
8 #include "common/avl.h"
13 #include "olsr_cookie.h"
14 #include "scheduler.h"
15 #include "kernel_routes.h"
16 #include "kernel_tunnel.h"
18 #include "duplicate_set.h"
20 #include "gateway_default_handler.h"
26 #ifdef LINUX_NETLINK_ROUTING
27 struct avl_tree gateway_tree;
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;
34 static struct olsr_iptunnel_entry *v4gw_tunnel, *v6gw_tunnel;
35 static bool v4gw_choosen_external, v6gw_choosen_external;
38 * Reconstructs an uplink/downlink speed value from the encoded
39 * 1 byte transport value (3 bit mantissa, 5 bit exponent)
44 deserialize_gw_speed(uint8_t value) {
47 speed = (value >> 3)+1;
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
62 serialize_gw_speed(uint32_t speed) {
65 if (speed == 0 || speed > 320000000) {
69 while (speed > 32 || (speed % 10) == 0) {
73 return ((speed-1) << 3) | exp;
77 * Initialize gateway system
80 olsr_init_gateways(void) {
81 gw_mem_cookie = olsr_alloc_cookie("Gateway cookie", OLSR_COOKIE_TYPE_MEMORY);
82 olsr_cookie_set_memory_size(gw_mem_cookie, sizeof(struct gateway_entry));
84 avl_init(&gateway_tree, avl_comp_default);
85 current_ipv4_gw = NULL;
86 current_ipv6_gw = NULL;
91 refresh_smartgw_netmask();
93 if (olsr_os_init_iptunnel()) {
98 * initialize default gateway handler,
99 * can be overwritten with olsr_set_inetgw_handler
101 olsr_gw_default_init();
105 void refresh_smartgw_netmask(void) {
107 memset(&smart_gateway_netmask, 0, sizeof(smart_gateway_netmask));
109 if (olsr_cnf->smart_gw_active) {
110 union olsr_ip_addr gw_net;
111 memset(&gw_net, 0, sizeof(gw_net));
113 ip = (uint8_t *) &smart_gateway_netmask;
115 if (olsr_cnf->smart_gw_uplink > 0 || olsr_cnf->smart_gw_downlink > 0) {
116 ip[GW_HNA_FLAGS] |= GW_HNA_FLAG_LINKSPEED;
117 ip[GW_HNA_DOWNLINK] = serialize_gw_speed(olsr_cnf->smart_gw_downlink);
118 ip[GW_HNA_UPLINK] = serialize_gw_speed(olsr_cnf->smart_gw_uplink);
120 if (olsr_cnf->ip_version == AF_INET6 && olsr_cnf->smart_gw_prefix.prefix_len > 0) {
121 ip[GW_HNA_FLAGS] |= GW_HNA_FLAG_IPV6PREFIX;
122 ip[GW_HNA_V6PREFIXLEN] = olsr_cnf->smart_gw_prefix.prefix_len;
123 memcpy(&ip[GW_HNA_V6PREFIX], &olsr_cnf->smart_gw_prefix.prefix, 8);
129 * Cleanup gateway tunnel system
131 void olsr_cleanup_gateways(void) {
132 if (current_ipv4_gw) {
133 olsr_os_del_ipip_tunnel(v4gw_tunnel);
135 if (current_ipv6_gw) {
136 olsr_os_del_ipip_tunnel(v6gw_tunnel);
139 // TODO: add olsr_remove_ifchange_handler() for both tunnels
141 olsr_os_cleanup_iptunnel();
145 * Triggers the first lookup of an gateway. This lookup might
146 * take some time to wait for routing/gateway information.
149 olsr_trigger_inetgw_startup(void) {
150 gw_handler->handle_startup();
154 * Triggers an instant gateway selection based on the current data
155 * @param ipv4 trigger a ipv4 gateway lookup
156 * @param ipv6 trigger a ipv6 gateway lookup
157 * @return 0 if successful, -1 otherwise
160 olsr_trigger_inetgw_selection(bool ipv4, bool ipv6) {
161 gw_handler->select_gateway(ipv4, ipv6);
162 return ((ipv4 && current_ipv4_gw == NULL) || (ipv6 && current_ipv6_gw == NULL)) ? -1 : 0;
166 * Triggers a check if the one of the gateways have been lost
167 * through ETX = infinity
169 void olsr_trigger_gatewayloss_check(void) {
171 bool ipv4 = false, ipv6 = false;
172 if (current_ipv4_gw) {
173 tc = olsr_lookup_tc_entry(¤t_ipv4_gw->originator);
174 if (tc == NULL || tc->path_cost == ROUTE_COST_BROKEN) {
178 if (current_ipv6_gw) {
179 tc = olsr_lookup_tc_entry(¤t_ipv6_gw->originator);
180 if (tc == NULL || tc->path_cost == ROUTE_COST_BROKEN) {
185 olsr_trigger_inetgw_selection(ipv4, ipv6);
189 * Set a new gateway handler. Do only call this once during startup from
190 * a plugin to overwrite the default handler.
191 * @param h pointer to gateway handler struct
194 olsr_set_inetgw_handler(struct olsr_gw_handler *h) {
199 * Sets a new internet gateway.
200 * An external set command might trigger an internal one if
201 * address is not a legal gateway.
203 * @param originator ip address of the node with the new gateway
204 * @param ipv4 set ipv4 gateway
205 * @param ipv6 set ipv6 gateway
206 * @param external true if change was triggered directly by an user,
207 * false if triggered by automatic lookup.
208 * @return true if an error happened, false otherwise
211 olsr_set_inet_gateway(union olsr_ip_addr *originator, bool ipv4, bool ipv6, bool external) {
212 struct gateway_entry *entry, *oldV4, *oldV6;
213 struct olsr_iptunnel_entry *tunnelV4, *tunnelV6;
215 oldV4 = current_ipv4_gw;
216 oldV6 = current_ipv6_gw;
217 tunnelV4 = v4gw_tunnel;
218 tunnelV6 = v6gw_tunnel;
220 ipv4 = ipv4 && (olsr_cnf->ip_version == AF_INET || olsr_cnf->use_niit);
221 ipv6 = ipv6 && (olsr_cnf->ip_version == AF_INET6);
224 current_ipv4_gw = NULL;
227 current_ipv6_gw = NULL;
230 entry = olsr_find_gateway_entry(originator);
232 if (ipv4 && entry != current_ipv4_gw && entry->ipv4
233 && (!entry->ipv4nat || olsr_cnf->smart_gw_allow_nat)) {
234 /* valid ipv4 gateway */
235 current_ipv4_gw = entry;
237 if (ipv6 && entry != current_ipv6_gw && entry->ipv6) {
238 /* valid ipv6 gateway */
239 current_ipv6_gw = entry;
244 if (oldV4 != current_ipv4_gw) {
245 if ((v4gw_tunnel = olsr_os_add_ipip_tunnel(¤t_ipv4_gw->originator, true)) != NULL) {
246 olsr_os_inetgw_tunnel_route(v4gw_tunnel->if_index, true, true);
247 v4gw_choosen_external = external;
249 // TODO: add olsr_add_ifchange_handler() for new ipv4 tunnel
252 // TODO: what to do now ? Choose another one ? Fire up a timer ?
253 current_ipv4_gw = NULL;
256 olsr_os_del_ipip_tunnel(tunnelV4);
258 // TODO: add olsr_remove_ifchange_handler() for old ipv4 tunnel
262 if (oldV6 != current_ipv6_gw) {
263 if ((v6gw_tunnel = olsr_os_add_ipip_tunnel(¤t_ipv6_gw->originator, false)) != NULL) {
264 olsr_os_inetgw_tunnel_route(v6gw_tunnel->if_index, false, true);
265 v6gw_choosen_external = external;
267 // TODO: add olsr_add_ifchange_handler() for new ipv6 tunnel
270 // TODO: what to do now ? Choose another one ? Fire up a timer ?
271 current_ipv6_gw = NULL;
274 olsr_os_del_ipip_tunnel(tunnelV6);
276 // TODO: add olsr_remove_ifchange_handler() for old ipv6 tunnel
279 return (ipv4 && current_ipv4_gw == NULL) || (ipv6 && current_ipv6_gw == NULL);
283 * returns the gateway_entry of the current ipv4 internet gw.
284 * @return pointer to gateway_entry or NULL if not set
286 struct gateway_entry *olsr_get_ipv4_inet_gateway(bool *ext) {
288 *ext = v4gw_choosen_external;
290 return current_ipv4_gw;
294 * returns the gateway_entry of the current ipv6 internet gw.
295 * @return pointer to gateway_entry or NULL if not set
297 struct gateway_entry *olsr_get_ipv6_inet_gateway(bool *ext) {
299 *ext = v6gw_choosen_external;
301 return current_ipv6_gw;
306 * @return gateway_entry for corresponding router
308 struct gateway_entry *
309 olsr_find_gateway_entry(union olsr_ip_addr *originator) {
310 struct avl_node *node = avl_find(&gateway_tree, originator);
312 return node == NULL ? NULL : node2gateway(node);
316 * update a gateway_entry based on data received from a HNA
317 * @param originator ip of the source of the HNA
318 * @param mask netmask of the HNA
319 * @param prefixlen of the HNA
322 olsr_update_gateway_entry(union olsr_ip_addr *originator, union olsr_ip_addr *mask, int prefixlen, uint16_t seqno) {
323 struct gateway_entry *gw;
326 ptr = ((uint8_t *)mask) + ((prefixlen+7)/8);
328 gw = olsr_find_gateway_entry(originator);
330 struct ipaddr_str buf;
331 gw = olsr_cookie_malloc(gw_mem_cookie);
333 gw->originator = *originator;
334 gw->node.key = &gw->originator;
336 avl_insert(&gateway_tree, &gw->node, AVL_DUP_NO);
338 else if (olsr_seqno_diff(seqno, gw->seqno) <= 0) {
339 /* ignore older HNAs */
343 /* keep new HNA seqno */
346 if ((ptr[GW_HNA_FLAGS] & GW_HNA_FLAG_LINKSPEED) != 0) {
347 gw->uplink = deserialize_gw_speed(ptr[GW_HNA_UPLINK]);
348 gw->downlink = deserialize_gw_speed(ptr[GW_HNA_DOWNLINK]);
355 gw->ipv4 = (ptr[GW_HNA_FLAGS] & GW_HNA_FLAG_IPV4) != 0;
356 gw->ipv4nat = (ptr[GW_HNA_FLAGS] & GW_HNA_FLAG_IPV4_NAT) != 0;
358 if (olsr_cnf->ip_version == AF_INET6) {
359 gw->ipv6 = (ptr[GW_HNA_FLAGS] & GW_HNA_FLAG_IPV6) != 0;
361 /* do not reset prefixlength for ::ffff:0:0 HNAs */
362 if (prefixlen == ipv6_internet_route.prefix_len) {
363 memset(&gw->external_prefix, 0, sizeof(gw->external_prefix));
365 if ((ptr[GW_HNA_FLAGS] & GW_HNA_FLAG_IPV6PREFIX) != 0
366 && memcmp(mask->v6.s6_addr, &ipv6_internet_route.prefix, olsr_cnf->ipsize) == 0) {
367 /* this is the right prefix (2000::/3), so we can copy the prefix */
368 gw->external_prefix.prefix_len = ptr[GW_HNA_V6PREFIXLEN];
369 memcpy(&gw->external_prefix.prefix, &ptr[GW_HNA_V6PREFIX], 8);
374 /* stop cleanup timer if necessary */
375 if (gw->cleanup_timer) {
376 olsr_stop_timer(gw->cleanup_timer);
377 gw->cleanup_timer = NULL;
380 /* call update handler */
381 gw_handler->handle_update_gw(gw);
384 static void cleanup_gateway_handler(void *ptr) {
385 struct gateway_entry *gw = ptr;
387 if (gw->ipv4 || gw->ipv6) {
391 /* remove gateway entry */
392 avl_delete(&gateway_tree, &gw->node);
393 olsr_cookie_free(gw_mem_cookie, gw);
397 * Delete a gateway based on the originator IP and the prefixlength of a HNA.
398 * Should only be called if prefix is a smart_gw prefix or if node is removed
404 olsr_delete_gateway_entry(union olsr_ip_addr *originator, uint8_t prefixlen) {
405 struct gateway_entry *gw;
407 gw = olsr_find_gateway_entry(originator);
408 if (gw && (gw->cleanup_timer == NULL || gw->ipv4 || gw->ipv6)) {
409 if (olsr_cnf->ip_version == AF_INET && prefixlen == 0) {
414 else if (olsr_cnf->ip_version == AF_INET6 && prefixlen == ipv6_internet_route.prefix_len) {
418 else if (olsr_cnf->ip_version == AF_INET6 && prefixlen == ipv6_mappedv4_route.prefix_len) {
424 if (prefixlen == FORCE_DELETE_GW_ENTRY || !(gw->ipv4 || gw->ipv6)) {
425 /* prevent this gateway from being choosen as the new gateway */
430 /* handle gateway loss */
431 gw_handler->handle_delete_gw(gw);
433 /* cleanup gateway if necessary */
434 if (current_ipv4_gw == gw) {
435 olsr_os_inetgw_tunnel_route(v4gw_tunnel->if_index, true, false);
436 olsr_os_del_ipip_tunnel(v4gw_tunnel);
438 // TODO: add olsr_remove_ifchange_handler() for ipv4 tunnel
439 current_ipv4_gw = NULL;
442 if (current_ipv6_gw == gw) {
443 olsr_os_inetgw_tunnel_route(v6gw_tunnel->if_index, false, false);
444 olsr_os_del_ipip_tunnel(v6gw_tunnel);
446 // TODO: add olsr_remove_ifchange_handler() for ipv6 tunnel
447 current_ipv6_gw = NULL;
451 /* remove gateway entry */
452 olsr_set_timer(&gw->cleanup_timer, GW_CLEANUP_INTERVAL, 0, false, cleanup_gateway_handler, gw, NULL);
455 gw_handler->handle_update_gw(gw);
461 * Checks if a prefix/netmask combination is a smart gateway
464 * @return true if is a valid smart gateway HNA, false otherwise
467 olsr_is_smart_gateway(struct olsr_ip_prefix *prefix, union olsr_ip_addr *mask) {
470 if (!is_prefix_inetgw(prefix)) {
474 ptr = ((uint8_t *)mask) + ((prefix->prefix_len+7)/8);
475 return ptr[GW_HNA_PAD] == 0 && ptr[GW_HNA_FLAGS] != 0;
479 * Apply the smart gateway modifications to an outgoing HNA
480 * @param mask pointer to netmask of the HNA
481 * @param prefixlen of the HNA
484 olsr_modifiy_inetgw_netmask(union olsr_ip_addr *mask, int prefixlen) {
485 uint8_t *ptr = ((uint8_t *)mask) + ((prefixlen+7)/8);
487 memcpy(ptr, &smart_gateway_netmask, sizeof(smart_gateway_netmask) - prefixlen/8);
488 if (olsr_cnf->has_ipv4_gateway) {
489 ptr[GW_HNA_FLAGS] |= GW_HNA_FLAG_IPV4;
491 if (olsr_cnf->smart_gw_uplink_nat) {
492 ptr[GW_HNA_FLAGS] |= GW_HNA_FLAG_IPV4_NAT;
495 if (olsr_cnf->has_ipv6_gateway) {
496 ptr[GW_HNA_FLAGS] |= GW_HNA_FLAG_IPV6;
498 if (!olsr_cnf->has_ipv6_gateway || prefixlen != ipv6_internet_route.prefix_len){
499 ptr[GW_HNA_FLAGS] &= ~GW_HNA_FLAG_IPV6PREFIX;
504 * Print debug information about gateway entries
507 olsr_print_gateway_entries(void) {
509 struct ipaddr_str buf;
510 struct gateway_entry *gw;
511 const int addrsize = olsr_cnf->ip_version == AF_INET ? 15 : 39;
513 OLSR_PRINTF(0, "\n--- %s ---------------------------------------------------- GATEWAYS\n\n",
514 olsr_wallclock_string());
515 OLSR_PRINTF(0, "%-*s %-6s %-9s %-9s %s\n", addrsize, "IP address", "Type", "Uplink", "Downlink",
516 olsr_cnf->ip_version == AF_INET ? "" : "External Prefix");
518 OLSR_FOR_ALL_GATEWAY_ENTRIES(gw) {
519 OLSR_PRINTF(0, "%-*s %s%c%s%c%c %-9u %-9u %s\n", addrsize, olsr_ip_to_string(&buf, &gw->originator),
520 gw->ipv4nat ? "" : " ",
521 gw->ipv4 ? '4' : ' ',
522 gw->ipv4nat ? "(N)" : "",
523 (gw->ipv4 && gw->ipv6) ? ',' : ' ',
524 gw->ipv6 ? '6' : ' ',
525 gw->uplink, gw->downlink,
526 gw->external_prefix.prefix_len == 0 ? "" : olsr_ip_prefix_to_string(&gw->external_prefix));
527 } OLSR_FOR_ALL_GATEWAY_ENTRIES_END(gw)