2 * Copyright (C) 2009-2011 B.A.T.M.A.N. contributors:
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of version 2 of the GNU General Public
8 * License as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
23 #include "bat_sysfs.h"
24 #include "gateway_client.h"
25 #include "gateway_common.h"
26 #include "hard-interface.h"
27 #include "originator.h"
28 #include "translation-table.h"
31 #include <linux/ipv6.h>
32 #include <linux/udp.h>
33 #include <linux/if_vlan.h>
35 /* This is the offset of the options field in a dhcp packet starting at
36 * the beginning of the dhcp header */
37 #define DHCP_OPTIONS_OFFSET 240
38 #define DHCP_REQUEST 3
40 static void gw_node_free_ref(struct gw_node *gw_node)
42 if (atomic_dec_and_test(&gw_node->refcount))
43 kfree_rcu(gw_node, rcu);
46 static struct gw_node *gw_get_selected_gw_node(struct bat_priv *bat_priv)
48 struct gw_node *gw_node;
51 gw_node = rcu_dereference(bat_priv->curr_gw);
55 if (!atomic_inc_not_zero(&gw_node->refcount))
63 struct orig_node *gw_get_selected_orig(struct bat_priv *bat_priv)
65 struct gw_node *gw_node;
66 struct orig_node *orig_node = NULL;
68 gw_node = gw_get_selected_gw_node(bat_priv);
73 orig_node = gw_node->orig_node;
77 if (!atomic_inc_not_zero(&orig_node->refcount))
84 gw_node_free_ref(gw_node);
88 static void gw_select(struct bat_priv *bat_priv, struct gw_node *new_gw_node)
90 struct gw_node *curr_gw_node;
92 spin_lock_bh(&bat_priv->gw_list_lock);
94 if (new_gw_node && !atomic_inc_not_zero(&new_gw_node->refcount))
97 curr_gw_node = rcu_dereference_protected(bat_priv->curr_gw, 1);
98 rcu_assign_pointer(bat_priv->curr_gw, new_gw_node);
101 gw_node_free_ref(curr_gw_node);
103 spin_unlock_bh(&bat_priv->gw_list_lock);
106 void gw_deselect(struct bat_priv *bat_priv)
108 atomic_set(&bat_priv->gw_reselect, 1);
111 static struct gw_node *gw_get_best_gw_node(struct bat_priv *bat_priv)
113 struct neigh_node *router;
114 struct hlist_node *node;
115 struct gw_node *gw_node, *curr_gw = NULL;
116 uint32_t max_gw_factor = 0, tmp_gw_factor = 0;
121 hlist_for_each_entry_rcu(gw_node, node, &bat_priv->gw_list, list) {
122 if (gw_node->deleted)
125 router = orig_node_get_router(gw_node->orig_node);
129 if (!atomic_inc_not_zero(&gw_node->refcount))
132 switch (atomic_read(&bat_priv->gw_sel_class)) {
133 case 1: /* fast connection */
134 gw_bandwidth_to_kbit(gw_node->orig_node->gw_flags,
137 tmp_gw_factor = (router->tq_avg * router->tq_avg *
139 (TQ_LOCAL_WINDOW_SIZE *
140 TQ_LOCAL_WINDOW_SIZE * 64);
142 if ((tmp_gw_factor > max_gw_factor) ||
143 ((tmp_gw_factor == max_gw_factor) &&
144 (router->tq_avg > max_tq))) {
146 gw_node_free_ref(curr_gw);
148 atomic_inc(&curr_gw->refcount);
153 * 2: stable connection (use best statistic)
154 * 3: fast-switch (use best statistic but change as
155 * soon as a better gateway appears)
156 * XX: late-switch (use best statistic but change as
157 * soon as a better gateway appears which has
158 * $routing_class more tq points)
160 if (router->tq_avg > max_tq) {
162 gw_node_free_ref(curr_gw);
164 atomic_inc(&curr_gw->refcount);
169 if (router->tq_avg > max_tq)
170 max_tq = router->tq_avg;
172 if (tmp_gw_factor > max_gw_factor)
173 max_gw_factor = tmp_gw_factor;
175 gw_node_free_ref(gw_node);
178 neigh_node_free_ref(router);
185 void gw_election(struct bat_priv *bat_priv)
187 struct gw_node *curr_gw = NULL, *next_gw = NULL;
188 struct neigh_node *router = NULL;
189 char gw_addr[18] = { '\0' };
192 * The batman daemon checks here if we already passed a full originator
193 * cycle in order to make sure we don't choose the first gateway we
194 * hear about. This check is based on the daemon's uptime which we
197 if (atomic_read(&bat_priv->gw_mode) != GW_MODE_CLIENT)
200 if (!atomic_dec_not_zero(&bat_priv->gw_reselect))
203 curr_gw = gw_get_selected_gw_node(bat_priv);
205 next_gw = gw_get_best_gw_node(bat_priv);
207 if (curr_gw == next_gw)
211 sprintf(gw_addr, "%pM", next_gw->orig_node->orig);
213 router = orig_node_get_router(next_gw->orig_node);
215 gw_deselect(bat_priv);
220 if ((curr_gw) && (!next_gw)) {
221 bat_dbg(DBG_BATMAN, bat_priv,
222 "Removing selected gateway - no gateway in range\n");
223 throw_uevent(bat_priv, UEV_GW, UEV_DEL, NULL);
224 } else if ((!curr_gw) && (next_gw)) {
225 bat_dbg(DBG_BATMAN, bat_priv,
226 "Adding route to gateway %pM (gw_flags: %i, tq: %i)\n",
227 next_gw->orig_node->orig,
228 next_gw->orig_node->gw_flags,
230 throw_uevent(bat_priv, UEV_GW, UEV_ADD, gw_addr);
232 bat_dbg(DBG_BATMAN, bat_priv,
233 "Changing route to gateway %pM "
234 "(gw_flags: %i, tq: %i)\n",
235 next_gw->orig_node->orig,
236 next_gw->orig_node->gw_flags,
238 throw_uevent(bat_priv, UEV_GW, UEV_CHANGE, gw_addr);
241 gw_select(bat_priv, next_gw);
245 gw_node_free_ref(curr_gw);
247 gw_node_free_ref(next_gw);
249 neigh_node_free_ref(router);
252 void gw_check_election(struct bat_priv *bat_priv, struct orig_node *orig_node)
254 struct orig_node *curr_gw_orig;
255 struct neigh_node *router_gw = NULL, *router_orig = NULL;
256 uint8_t gw_tq_avg, orig_tq_avg;
258 curr_gw_orig = gw_get_selected_orig(bat_priv);
262 router_gw = orig_node_get_router(curr_gw_orig);
266 /* this node already is the gateway */
267 if (curr_gw_orig == orig_node)
270 router_orig = orig_node_get_router(orig_node);
274 gw_tq_avg = router_gw->tq_avg;
275 orig_tq_avg = router_orig->tq_avg;
277 /* the TQ value has to be better */
278 if (orig_tq_avg < gw_tq_avg)
282 * if the routing class is greater than 3 the value tells us how much
283 * greater the TQ value of the new gateway must be
285 if ((atomic_read(&bat_priv->gw_sel_class) > 3) &&
286 (orig_tq_avg - gw_tq_avg < atomic_read(&bat_priv->gw_sel_class)))
289 bat_dbg(DBG_BATMAN, bat_priv,
290 "Restarting gateway selection: better gateway found (tq curr: "
292 gw_tq_avg, orig_tq_avg);
295 gw_deselect(bat_priv);
298 orig_node_free_ref(curr_gw_orig);
300 neigh_node_free_ref(router_gw);
302 neigh_node_free_ref(router_orig);
307 static void gw_node_add(struct bat_priv *bat_priv,
308 struct orig_node *orig_node, uint8_t new_gwflags)
310 struct gw_node *gw_node;
313 gw_node = kzalloc(sizeof(*gw_node), GFP_ATOMIC);
317 INIT_HLIST_NODE(&gw_node->list);
318 gw_node->orig_node = orig_node;
319 atomic_set(&gw_node->refcount, 1);
321 spin_lock_bh(&bat_priv->gw_list_lock);
322 hlist_add_head_rcu(&gw_node->list, &bat_priv->gw_list);
323 spin_unlock_bh(&bat_priv->gw_list_lock);
325 gw_bandwidth_to_kbit(new_gwflags, &down, &up);
326 bat_dbg(DBG_BATMAN, bat_priv,
327 "Found new gateway %pM -> gw_class: %i - %i%s/%i%s\n",
328 orig_node->orig, new_gwflags,
329 (down > 2048 ? down / 1024 : down),
330 (down > 2048 ? "MBit" : "KBit"),
331 (up > 2048 ? up / 1024 : up),
332 (up > 2048 ? "MBit" : "KBit"));
335 void gw_node_update(struct bat_priv *bat_priv,
336 struct orig_node *orig_node, uint8_t new_gwflags)
338 struct hlist_node *node;
339 struct gw_node *gw_node, *curr_gw;
342 * Note: We don't need a NULL check here, since curr_gw never gets
343 * dereferenced. If curr_gw is NULL we also should not exit as we may
344 * have this gateway in our list (duplication check!) even though we
345 * have no currently selected gateway.
347 curr_gw = gw_get_selected_gw_node(bat_priv);
350 hlist_for_each_entry_rcu(gw_node, node, &bat_priv->gw_list, list) {
351 if (gw_node->orig_node != orig_node)
354 bat_dbg(DBG_BATMAN, bat_priv,
355 "Gateway class of originator %pM changed from "
357 orig_node->orig, gw_node->orig_node->gw_flags,
360 gw_node->deleted = 0;
362 if (new_gwflags == NO_FLAGS) {
363 gw_node->deleted = jiffies;
364 bat_dbg(DBG_BATMAN, bat_priv,
365 "Gateway %pM removed from gateway list\n",
368 if (gw_node == curr_gw)
375 if (new_gwflags == NO_FLAGS)
378 gw_node_add(bat_priv, orig_node, new_gwflags);
382 gw_deselect(bat_priv);
387 gw_node_free_ref(curr_gw);
390 void gw_node_delete(struct bat_priv *bat_priv, struct orig_node *orig_node)
392 gw_node_update(bat_priv, orig_node, 0);
395 void gw_node_purge(struct bat_priv *bat_priv)
397 struct gw_node *gw_node, *curr_gw;
398 struct hlist_node *node, *node_tmp;
399 unsigned long timeout = 2 * PURGE_TIMEOUT * HZ;
402 curr_gw = gw_get_selected_gw_node(bat_priv);
404 spin_lock_bh(&bat_priv->gw_list_lock);
406 hlist_for_each_entry_safe(gw_node, node, node_tmp,
407 &bat_priv->gw_list, list) {
408 if (((!gw_node->deleted) ||
409 (time_before(jiffies, gw_node->deleted + timeout))) &&
410 atomic_read(&bat_priv->mesh_state) == MESH_ACTIVE)
413 if (curr_gw == gw_node)
416 hlist_del_rcu(&gw_node->list);
417 gw_node_free_ref(gw_node);
420 spin_unlock_bh(&bat_priv->gw_list_lock);
422 /* gw_deselect() needs to acquire the gw_list_lock */
424 gw_deselect(bat_priv);
427 gw_node_free_ref(curr_gw);
431 * fails if orig_node has no router
433 static int _write_buffer_text(struct bat_priv *bat_priv, struct seq_file *seq,
434 const struct gw_node *gw_node)
436 struct gw_node *curr_gw;
437 struct neigh_node *router;
438 int down, up, ret = -1;
440 gw_bandwidth_to_kbit(gw_node->orig_node->gw_flags, &down, &up);
442 router = orig_node_get_router(gw_node->orig_node);
446 curr_gw = gw_get_selected_gw_node(bat_priv);
448 ret = seq_printf(seq, "%s %pM (%3i) %pM [%10s]: %3i - %i%s/%i%s\n",
449 (curr_gw == gw_node ? "=>" : " "),
450 gw_node->orig_node->orig,
451 router->tq_avg, router->addr,
452 router->if_incoming->net_dev->name,
453 gw_node->orig_node->gw_flags,
454 (down > 2048 ? down / 1024 : down),
455 (down > 2048 ? "MBit" : "KBit"),
456 (up > 2048 ? up / 1024 : up),
457 (up > 2048 ? "MBit" : "KBit"));
459 neigh_node_free_ref(router);
461 gw_node_free_ref(curr_gw);
466 int gw_client_seq_print_text(struct seq_file *seq, void *offset)
468 struct net_device *net_dev = (struct net_device *)seq->private;
469 struct bat_priv *bat_priv = netdev_priv(net_dev);
470 struct hard_iface *primary_if;
471 struct gw_node *gw_node;
472 struct hlist_node *node;
473 int gw_count = 0, ret = 0;
475 primary_if = primary_if_get_selected(bat_priv);
477 ret = seq_printf(seq, "BATMAN mesh %s disabled - please "
478 "specify interfaces to enable it\n",
483 if (primary_if->if_status != IF_ACTIVE) {
484 ret = seq_printf(seq, "BATMAN mesh %s disabled - "
485 "primary interface not active\n",
490 seq_printf(seq, " %-12s (%s/%i) %17s [%10s]: gw_class ... "
491 "[B.A.T.M.A.N. adv %s, MainIF/MAC: %s/%pM (%s)]\n",
492 "Gateway", "#", TQ_MAX_VALUE, "Nexthop",
493 "outgoingIF", SOURCE_VERSION, primary_if->net_dev->name,
494 primary_if->net_dev->dev_addr, net_dev->name);
497 hlist_for_each_entry_rcu(gw_node, node, &bat_priv->gw_list, list) {
498 if (gw_node->deleted)
501 /* fails if orig_node has no router */
502 if (_write_buffer_text(bat_priv, seq, gw_node) < 0)
510 seq_printf(seq, "No gateways in range ...\n");
514 hardif_free_ref(primary_if);
518 static bool is_type_dhcprequest(struct sk_buff *skb, int header_len)
524 if (skb_linearize(skb) < 0)
527 pkt_len = skb_headlen(skb);
529 if (pkt_len < header_len + DHCP_OPTIONS_OFFSET + 1)
532 p = skb->data + header_len + DHCP_OPTIONS_OFFSET;
533 pkt_len -= header_len + DHCP_OPTIONS_OFFSET + 1;
535 /* Access the dhcp option lists. Each entry is made up by:
536 * - octet 1: option type
537 * - octet 2: option data len (only if type != 255 and 0)
538 * - octet 3: option data */
539 while (*p != 255 && !ret) {
540 /* p now points to the first octet: option type */
542 /* type 53 is the message type option.
543 * Jump the len octet and go to the data octet */
548 /* check if the message type is what we need */
549 if (*p == DHCP_REQUEST)
552 } else if (*p == 0) {
553 /* option type 0 (padding), just go forward */
559 /* This is any other option. So we get the length... */
565 /* ...and then we jump over the data */
576 bool gw_is_dhcp_target(struct sk_buff *skb, unsigned int *header_len)
578 struct ethhdr *ethhdr;
580 struct ipv6hdr *ipv6hdr;
581 struct udphdr *udphdr;
583 /* check for ethernet header */
584 if (!pskb_may_pull(skb, *header_len + ETH_HLEN))
586 ethhdr = (struct ethhdr *)skb->data;
587 *header_len += ETH_HLEN;
589 /* check for initial vlan header */
590 if (ntohs(ethhdr->h_proto) == ETH_P_8021Q) {
591 if (!pskb_may_pull(skb, *header_len + VLAN_HLEN))
593 ethhdr = (struct ethhdr *)(skb->data + VLAN_HLEN);
594 *header_len += VLAN_HLEN;
597 /* check for ip header */
598 switch (ntohs(ethhdr->h_proto)) {
600 if (!pskb_may_pull(skb, *header_len + sizeof(*iphdr)))
602 iphdr = (struct iphdr *)(skb->data + *header_len);
603 *header_len += iphdr->ihl * 4;
605 /* check for udp header */
606 if (iphdr->protocol != IPPROTO_UDP)
611 if (!pskb_may_pull(skb, *header_len + sizeof(*ipv6hdr)))
613 ipv6hdr = (struct ipv6hdr *)(skb->data + *header_len);
614 *header_len += sizeof(*ipv6hdr);
616 /* check for udp header */
617 if (ipv6hdr->nexthdr != IPPROTO_UDP)
625 if (!pskb_may_pull(skb, *header_len + sizeof(*udphdr)))
627 udphdr = (struct udphdr *)(skb->data + *header_len);
628 *header_len += sizeof(*udphdr);
630 /* check for bootp port */
631 if ((ntohs(ethhdr->h_proto) == ETH_P_IP) &&
632 (ntohs(udphdr->dest) != 67))
635 if ((ntohs(ethhdr->h_proto) == ETH_P_IPV6) &&
636 (ntohs(udphdr->dest) != 547))
642 bool gw_out_of_range(struct bat_priv *bat_priv,
643 struct sk_buff *skb, struct ethhdr *ethhdr)
645 struct neigh_node *neigh_curr = NULL, *neigh_old = NULL;
646 struct orig_node *orig_dst_node = NULL;
647 struct gw_node *curr_gw = NULL;
648 bool ret, out_of_range = false;
649 unsigned int header_len = 0;
652 ret = gw_is_dhcp_target(skb, &header_len);
656 orig_dst_node = transtable_search(bat_priv, ethhdr->h_source,
661 if (!orig_dst_node->gw_flags)
664 ret = is_type_dhcprequest(skb, header_len);
668 switch (atomic_read(&bat_priv->gw_mode)) {
670 /* If we are a GW then we are our best GW. We can artificially
671 * set the tq towards ourself as the maximum value */
672 curr_tq_avg = TQ_MAX_VALUE;
675 curr_gw = gw_get_selected_gw_node(bat_priv);
679 /* packet is going to our gateway */
680 if (curr_gw->orig_node == orig_dst_node)
683 /* If the dhcp packet has been sent to a different gw,
684 * we have to evaluate whether the old gw is still
686 neigh_curr = find_router(bat_priv, curr_gw->orig_node, NULL);
690 curr_tq_avg = neigh_curr->tq_avg;
697 neigh_old = find_router(bat_priv, orig_dst_node, NULL);
701 if (curr_tq_avg - neigh_old->tq_avg > GW_THRESHOLD)
706 orig_node_free_ref(orig_dst_node);
708 gw_node_free_ref(curr_gw);
710 neigh_node_free_ref(neigh_old);
712 neigh_node_free_ref(neigh_curr);