2 * Copyright (C) 2009-2012 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 *batadv_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 batadv_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;
119 struct orig_node *orig_node;
122 hlist_for_each_entry_rcu(gw_node, node, &bat_priv->gw_list, list) {
123 if (gw_node->deleted)
126 orig_node = gw_node->orig_node;
127 router = batadv_orig_node_get_router(orig_node);
131 if (!atomic_inc_not_zero(&gw_node->refcount))
134 switch (atomic_read(&bat_priv->gw_sel_class)) {
135 case 1: /* fast connection */
136 batadv_gw_bandwidth_to_kbit(orig_node->gw_flags,
139 tmp_gw_factor = (router->tq_avg * router->tq_avg *
141 (TQ_LOCAL_WINDOW_SIZE *
142 TQ_LOCAL_WINDOW_SIZE * 64);
144 if ((tmp_gw_factor > max_gw_factor) ||
145 ((tmp_gw_factor == max_gw_factor) &&
146 (router->tq_avg > max_tq))) {
148 gw_node_free_ref(curr_gw);
150 atomic_inc(&curr_gw->refcount);
155 * 2: stable connection (use best statistic)
156 * 3: fast-switch (use best statistic but change as
157 * soon as a better gateway appears)
158 * XX: late-switch (use best statistic but change as
159 * soon as a better gateway appears which has
160 * $routing_class more tq points)
162 if (router->tq_avg > max_tq) {
164 gw_node_free_ref(curr_gw);
166 atomic_inc(&curr_gw->refcount);
171 if (router->tq_avg > max_tq)
172 max_tq = router->tq_avg;
174 if (tmp_gw_factor > max_gw_factor)
175 max_gw_factor = tmp_gw_factor;
177 gw_node_free_ref(gw_node);
180 batadv_neigh_node_free_ref(router);
187 void batadv_gw_election(struct bat_priv *bat_priv)
189 struct gw_node *curr_gw = NULL, *next_gw = NULL;
190 struct neigh_node *router = NULL;
191 char gw_addr[18] = { '\0' };
194 * The batman daemon checks here if we already passed a full originator
195 * cycle in order to make sure we don't choose the first gateway we
196 * hear about. This check is based on the daemon's uptime which we
199 if (atomic_read(&bat_priv->gw_mode) != GW_MODE_CLIENT)
202 if (!atomic_dec_not_zero(&bat_priv->gw_reselect))
205 curr_gw = gw_get_selected_gw_node(bat_priv);
207 next_gw = gw_get_best_gw_node(bat_priv);
209 if (curr_gw == next_gw)
213 sprintf(gw_addr, "%pM", next_gw->orig_node->orig);
215 router = batadv_orig_node_get_router(next_gw->orig_node);
217 batadv_gw_deselect(bat_priv);
222 if ((curr_gw) && (!next_gw)) {
223 bat_dbg(DBG_BATMAN, bat_priv,
224 "Removing selected gateway - no gateway in range\n");
225 batadv_throw_uevent(bat_priv, UEV_GW, UEV_DEL, NULL);
226 } else if ((!curr_gw) && (next_gw)) {
227 bat_dbg(DBG_BATMAN, bat_priv,
228 "Adding route to gateway %pM (gw_flags: %i, tq: %i)\n",
229 next_gw->orig_node->orig, next_gw->orig_node->gw_flags,
231 batadv_throw_uevent(bat_priv, UEV_GW, UEV_ADD, gw_addr);
233 bat_dbg(DBG_BATMAN, bat_priv,
234 "Changing route to gateway %pM (gw_flags: %i, tq: %i)\n",
235 next_gw->orig_node->orig, next_gw->orig_node->gw_flags,
237 batadv_throw_uevent(bat_priv, UEV_GW, UEV_CHANGE, gw_addr);
240 gw_select(bat_priv, next_gw);
244 gw_node_free_ref(curr_gw);
246 gw_node_free_ref(next_gw);
248 batadv_neigh_node_free_ref(router);
251 void batadv_gw_check_election(struct bat_priv *bat_priv,
252 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 = batadv_gw_get_selected_orig(bat_priv);
262 router_gw = batadv_orig_node_get_router(curr_gw_orig);
266 /* this node already is the gateway */
267 if (curr_gw_orig == orig_node)
270 router_orig = batadv_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: %i, tq new: %i)\n",
291 gw_tq_avg, orig_tq_avg);
294 batadv_gw_deselect(bat_priv);
297 batadv_orig_node_free_ref(curr_gw_orig);
299 batadv_neigh_node_free_ref(router_gw);
301 batadv_neigh_node_free_ref(router_orig);
306 static void gw_node_add(struct bat_priv *bat_priv,
307 struct orig_node *orig_node, uint8_t new_gwflags)
309 struct gw_node *gw_node;
312 gw_node = kzalloc(sizeof(*gw_node), GFP_ATOMIC);
316 INIT_HLIST_NODE(&gw_node->list);
317 gw_node->orig_node = orig_node;
318 atomic_set(&gw_node->refcount, 1);
320 spin_lock_bh(&bat_priv->gw_list_lock);
321 hlist_add_head_rcu(&gw_node->list, &bat_priv->gw_list);
322 spin_unlock_bh(&bat_priv->gw_list_lock);
324 batadv_gw_bandwidth_to_kbit(new_gwflags, &down, &up);
325 bat_dbg(DBG_BATMAN, bat_priv,
326 "Found new gateway %pM -> gw_class: %i - %i%s/%i%s\n",
327 orig_node->orig, new_gwflags,
328 (down > 2048 ? down / 1024 : down),
329 (down > 2048 ? "MBit" : "KBit"),
330 (up > 2048 ? up / 1024 : up),
331 (up > 2048 ? "MBit" : "KBit"));
334 void batadv_gw_node_update(struct bat_priv *bat_priv,
335 struct orig_node *orig_node, uint8_t new_gwflags)
337 struct hlist_node *node;
338 struct gw_node *gw_node, *curr_gw;
341 * Note: We don't need a NULL check here, since curr_gw never gets
342 * dereferenced. If curr_gw is NULL we also should not exit as we may
343 * have this gateway in our list (duplication check!) even though we
344 * have no currently selected gateway.
346 curr_gw = gw_get_selected_gw_node(bat_priv);
349 hlist_for_each_entry_rcu(gw_node, node, &bat_priv->gw_list, list) {
350 if (gw_node->orig_node != orig_node)
353 bat_dbg(DBG_BATMAN, bat_priv,
354 "Gateway class of originator %pM changed from %i to %i\n",
355 orig_node->orig, gw_node->orig_node->gw_flags,
358 gw_node->deleted = 0;
360 if (new_gwflags == NO_FLAGS) {
361 gw_node->deleted = jiffies;
362 bat_dbg(DBG_BATMAN, bat_priv,
363 "Gateway %pM removed from gateway list\n",
366 if (gw_node == curr_gw)
373 if (new_gwflags == NO_FLAGS)
376 gw_node_add(bat_priv, orig_node, new_gwflags);
380 batadv_gw_deselect(bat_priv);
385 gw_node_free_ref(curr_gw);
388 void batadv_gw_node_delete(struct bat_priv *bat_priv,
389 struct orig_node *orig_node)
391 batadv_gw_node_update(bat_priv, orig_node, 0);
394 void batadv_gw_node_purge(struct bat_priv *bat_priv)
396 struct gw_node *gw_node, *curr_gw;
397 struct hlist_node *node, *node_tmp;
398 unsigned long timeout = msecs_to_jiffies(2 * PURGE_TIMEOUT);
401 curr_gw = gw_get_selected_gw_node(bat_priv);
403 spin_lock_bh(&bat_priv->gw_list_lock);
405 hlist_for_each_entry_safe(gw_node, node, node_tmp,
406 &bat_priv->gw_list, list) {
407 if (((!gw_node->deleted) ||
408 (time_before(jiffies, gw_node->deleted + timeout))) &&
409 atomic_read(&bat_priv->mesh_state) == MESH_ACTIVE)
412 if (curr_gw == gw_node)
415 hlist_del_rcu(&gw_node->list);
416 gw_node_free_ref(gw_node);
419 spin_unlock_bh(&bat_priv->gw_list_lock);
421 /* gw_deselect() needs to acquire the gw_list_lock */
423 batadv_gw_deselect(bat_priv);
426 gw_node_free_ref(curr_gw);
430 * fails if orig_node has no router
432 static int _write_buffer_text(struct bat_priv *bat_priv, struct seq_file *seq,
433 const struct gw_node *gw_node)
435 struct gw_node *curr_gw;
436 struct neigh_node *router;
437 int down, up, ret = -1;
439 batadv_gw_bandwidth_to_kbit(gw_node->orig_node->gw_flags, &down, &up);
441 router = batadv_orig_node_get_router(gw_node->orig_node);
445 curr_gw = gw_get_selected_gw_node(bat_priv);
447 ret = seq_printf(seq, "%s %pM (%3i) %pM [%10s]: %3i - %i%s/%i%s\n",
448 (curr_gw == gw_node ? "=>" : " "),
449 gw_node->orig_node->orig,
450 router->tq_avg, router->addr,
451 router->if_incoming->net_dev->name,
452 gw_node->orig_node->gw_flags,
453 (down > 2048 ? down / 1024 : down),
454 (down > 2048 ? "MBit" : "KBit"),
455 (up > 2048 ? up / 1024 : up),
456 (up > 2048 ? "MBit" : "KBit"));
458 batadv_neigh_node_free_ref(router);
460 gw_node_free_ref(curr_gw);
465 int batadv_gw_client_seq_print_text(struct seq_file *seq, void *offset)
467 struct net_device *net_dev = (struct net_device *)seq->private;
468 struct bat_priv *bat_priv = netdev_priv(net_dev);
469 struct hard_iface *primary_if;
470 struct gw_node *gw_node;
471 struct hlist_node *node;
472 int gw_count = 0, ret = 0;
474 primary_if = primary_if_get_selected(bat_priv);
476 ret = seq_printf(seq,
477 "BATMAN mesh %s disabled - please specify interfaces to enable it\n",
482 if (primary_if->if_status != IF_ACTIVE) {
483 ret = seq_printf(seq,
484 "BATMAN mesh %s disabled - primary interface not active\n",
490 " %-12s (%s/%i) %17s [%10s]: gw_class ... [B.A.T.M.A.N. adv %s, MainIF/MAC: %s/%pM (%s)]\n",
491 "Gateway", "#", TQ_MAX_VALUE, "Nexthop", "outgoingIF",
492 SOURCE_VERSION, primary_if->net_dev->name,
493 primary_if->net_dev->dev_addr, net_dev->name);
496 hlist_for_each_entry_rcu(gw_node, node, &bat_priv->gw_list, list) {
497 if (gw_node->deleted)
500 /* fails if orig_node has no router */
501 if (_write_buffer_text(bat_priv, seq, gw_node) < 0)
509 seq_printf(seq, "No gateways in range ...\n");
513 hardif_free_ref(primary_if);
517 static bool is_type_dhcprequest(struct sk_buff *skb, int header_len)
523 if (skb_linearize(skb) < 0)
526 pkt_len = skb_headlen(skb);
528 if (pkt_len < header_len + DHCP_OPTIONS_OFFSET + 1)
531 p = skb->data + header_len + DHCP_OPTIONS_OFFSET;
532 pkt_len -= header_len + DHCP_OPTIONS_OFFSET + 1;
534 /* Access the dhcp option lists. Each entry is made up by:
535 * - octet 1: option type
536 * - octet 2: option data len (only if type != 255 and 0)
537 * - octet 3: option data */
538 while (*p != 255 && !ret) {
539 /* p now points to the first octet: option type */
541 /* type 53 is the message type option.
542 * Jump the len octet and go to the data octet */
547 /* check if the message type is what we need */
548 if (*p == DHCP_REQUEST)
551 } else if (*p == 0) {
552 /* option type 0 (padding), just go forward */
558 /* This is any other option. So we get the length... */
564 /* ...and then we jump over the data */
565 if (pkt_len < 1 + (*p))
575 bool batadv_gw_is_dhcp_target(struct sk_buff *skb, unsigned int *header_len)
577 struct ethhdr *ethhdr;
579 struct ipv6hdr *ipv6hdr;
580 struct udphdr *udphdr;
582 /* check for ethernet header */
583 if (!pskb_may_pull(skb, *header_len + ETH_HLEN))
585 ethhdr = (struct ethhdr *)skb->data;
586 *header_len += ETH_HLEN;
588 /* check for initial vlan header */
589 if (ntohs(ethhdr->h_proto) == ETH_P_8021Q) {
590 if (!pskb_may_pull(skb, *header_len + VLAN_HLEN))
592 ethhdr = (struct ethhdr *)(skb->data + VLAN_HLEN);
593 *header_len += VLAN_HLEN;
596 /* check for ip header */
597 switch (ntohs(ethhdr->h_proto)) {
599 if (!pskb_may_pull(skb, *header_len + sizeof(*iphdr)))
601 iphdr = (struct iphdr *)(skb->data + *header_len);
602 *header_len += iphdr->ihl * 4;
604 /* check for udp header */
605 if (iphdr->protocol != IPPROTO_UDP)
610 if (!pskb_may_pull(skb, *header_len + sizeof(*ipv6hdr)))
612 ipv6hdr = (struct ipv6hdr *)(skb->data + *header_len);
613 *header_len += sizeof(*ipv6hdr);
615 /* check for udp header */
616 if (ipv6hdr->nexthdr != IPPROTO_UDP)
624 if (!pskb_may_pull(skb, *header_len + sizeof(*udphdr)))
626 udphdr = (struct udphdr *)(skb->data + *header_len);
627 *header_len += sizeof(*udphdr);
629 /* check for bootp port */
630 if ((ntohs(ethhdr->h_proto) == ETH_P_IP) &&
631 (ntohs(udphdr->dest) != 67))
634 if ((ntohs(ethhdr->h_proto) == ETH_P_IPV6) &&
635 (ntohs(udphdr->dest) != 547))
641 bool batadv_gw_out_of_range(struct bat_priv *bat_priv,
642 struct sk_buff *skb, struct ethhdr *ethhdr)
644 struct neigh_node *neigh_curr = NULL, *neigh_old = NULL;
645 struct orig_node *orig_dst_node = NULL;
646 struct gw_node *curr_gw = NULL;
647 bool ret, out_of_range = false;
648 unsigned int header_len = 0;
651 ret = batadv_gw_is_dhcp_target(skb, &header_len);
655 orig_dst_node = transtable_search(bat_priv, ethhdr->h_source,
660 if (!orig_dst_node->gw_flags)
663 ret = is_type_dhcprequest(skb, header_len);
667 switch (atomic_read(&bat_priv->gw_mode)) {
669 /* If we are a GW then we are our best GW. We can artificially
670 * set the tq towards ourself as the maximum value */
671 curr_tq_avg = TQ_MAX_VALUE;
674 curr_gw = gw_get_selected_gw_node(bat_priv);
678 /* packet is going to our gateway */
679 if (curr_gw->orig_node == orig_dst_node)
682 /* If the dhcp packet has been sent to a different gw,
683 * we have to evaluate whether the old gw is still
685 neigh_curr = find_router(bat_priv, curr_gw->orig_node, NULL);
689 curr_tq_avg = neigh_curr->tq_avg;
696 neigh_old = find_router(bat_priv, orig_dst_node, NULL);
700 if (curr_tq_avg - neigh_old->tq_avg > GW_THRESHOLD)
705 batadv_orig_node_free_ref(orig_dst_node);
707 gw_node_free_ref(curr_gw);
709 batadv_neigh_node_free_ref(neigh_old);
711 batadv_neigh_node_free_ref(neigh_curr);