1 // SPDX-License-Identifier: GPL-2.0
2 /* Copyright (C) 2009-2020 B.A.T.M.A.N. contributors:
7 #include "gateway_client.h"
10 #include <linux/atomic.h>
11 #include <linux/byteorder/generic.h>
12 #include <linux/errno.h>
13 #include <linux/etherdevice.h>
14 #include <linux/gfp.h>
15 #include <linux/if_ether.h>
16 #include <linux/if_vlan.h>
19 #include <linux/ipv6.h>
20 #include <linux/kernel.h>
21 #include <linux/kref.h>
22 #include <linux/list.h>
23 #include <linux/lockdep.h>
24 #include <linux/netdevice.h>
25 #include <linux/netlink.h>
26 #include <linux/rculist.h>
27 #include <linux/rcupdate.h>
28 #include <linux/skbuff.h>
29 #include <linux/slab.h>
30 #include <linux/spinlock.h>
31 #include <linux/stddef.h>
32 #include <linux/udp.h>
34 #include <uapi/linux/batadv_packet.h>
35 #include <uapi/linux/batman_adv.h>
37 #include "hard-interface.h"
40 #include "originator.h"
42 #include "soft-interface.h"
43 #include "translation-table.h"
45 /* These are the offsets of the "hw type" and "hw address length" in the dhcp
46 * packet starting at the beginning of the dhcp header
48 #define BATADV_DHCP_HTYPE_OFFSET 1
49 #define BATADV_DHCP_HLEN_OFFSET 2
50 /* Value of htype representing Ethernet */
51 #define BATADV_DHCP_HTYPE_ETHERNET 0x01
52 /* This is the offset of the "chaddr" field in the dhcp packet starting at the
53 * beginning of the dhcp header
55 #define BATADV_DHCP_CHADDR_OFFSET 28
58 * batadv_gw_node_release() - release gw_node from lists and queue for free
59 * after rcu grace period
60 * @ref: kref pointer of the gw_node
62 static void batadv_gw_node_release(struct kref *ref)
64 struct batadv_gw_node *gw_node;
66 gw_node = container_of(ref, struct batadv_gw_node, refcount);
68 batadv_orig_node_put(gw_node->orig_node);
69 kfree_rcu(gw_node, rcu);
73 * batadv_gw_node_put() - decrement the gw_node refcounter and possibly release
75 * @gw_node: gateway node to free
77 void batadv_gw_node_put(struct batadv_gw_node *gw_node)
79 kref_put(&gw_node->refcount, batadv_gw_node_release);
83 * batadv_gw_get_selected_gw_node() - Get currently selected gateway
84 * @bat_priv: the bat priv with all the soft interface information
86 * Return: selected gateway (with increased refcnt), NULL on errors
88 struct batadv_gw_node *
89 batadv_gw_get_selected_gw_node(struct batadv_priv *bat_priv)
91 struct batadv_gw_node *gw_node;
94 gw_node = rcu_dereference(bat_priv->gw.curr_gw);
98 if (!kref_get_unless_zero(&gw_node->refcount))
107 * batadv_gw_get_selected_orig() - Get originator of currently selected gateway
108 * @bat_priv: the bat priv with all the soft interface information
110 * Return: orig_node of selected gateway (with increased refcnt), NULL on errors
112 struct batadv_orig_node *
113 batadv_gw_get_selected_orig(struct batadv_priv *bat_priv)
115 struct batadv_gw_node *gw_node;
116 struct batadv_orig_node *orig_node = NULL;
118 gw_node = batadv_gw_get_selected_gw_node(bat_priv);
123 orig_node = gw_node->orig_node;
127 if (!kref_get_unless_zero(&orig_node->refcount))
134 batadv_gw_node_put(gw_node);
138 static void batadv_gw_select(struct batadv_priv *bat_priv,
139 struct batadv_gw_node *new_gw_node)
141 struct batadv_gw_node *curr_gw_node;
143 spin_lock_bh(&bat_priv->gw.list_lock);
146 kref_get(&new_gw_node->refcount);
148 curr_gw_node = rcu_replace_pointer(bat_priv->gw.curr_gw, new_gw_node,
152 batadv_gw_node_put(curr_gw_node);
154 spin_unlock_bh(&bat_priv->gw.list_lock);
158 * batadv_gw_reselect() - force a gateway reselection
159 * @bat_priv: the bat priv with all the soft interface information
161 * Set a flag to remind the GW component to perform a new gateway reselection.
162 * However this function does not ensure that the current gateway is going to be
163 * deselected. The reselection mechanism may elect the same gateway once again.
165 * This means that invoking batadv_gw_reselect() does not guarantee a gateway
166 * change and therefore a uevent is not necessarily expected.
168 void batadv_gw_reselect(struct batadv_priv *bat_priv)
170 atomic_set(&bat_priv->gw.reselect, 1);
174 * batadv_gw_check_client_stop() - check if client mode has been switched off
175 * @bat_priv: the bat priv with all the soft interface information
177 * This function assumes the caller has checked that the gw state *is actually
178 * changing*. This function is not supposed to be called when there is no state
181 void batadv_gw_check_client_stop(struct batadv_priv *bat_priv)
183 struct batadv_gw_node *curr_gw;
185 if (atomic_read(&bat_priv->gw.mode) != BATADV_GW_MODE_CLIENT)
188 curr_gw = batadv_gw_get_selected_gw_node(bat_priv);
192 /* deselect the current gateway so that next time that client mode is
193 * enabled a proper GW_ADD event can be sent
195 batadv_gw_select(bat_priv, NULL);
197 /* if batman-adv is switching the gw client mode off and a gateway was
198 * already selected, send a DEL uevent
200 batadv_throw_uevent(bat_priv, BATADV_UEV_GW, BATADV_UEV_DEL, NULL);
202 batadv_gw_node_put(curr_gw);
206 * batadv_gw_election() - Elect the best gateway
207 * @bat_priv: the bat priv with all the soft interface information
209 void batadv_gw_election(struct batadv_priv *bat_priv)
211 struct batadv_gw_node *curr_gw = NULL;
212 struct batadv_gw_node *next_gw = NULL;
213 struct batadv_neigh_node *router = NULL;
214 struct batadv_neigh_ifinfo *router_ifinfo = NULL;
215 char gw_addr[18] = { '\0' };
217 if (atomic_read(&bat_priv->gw.mode) != BATADV_GW_MODE_CLIENT)
220 if (!bat_priv->algo_ops->gw.get_best_gw_node)
223 curr_gw = batadv_gw_get_selected_gw_node(bat_priv);
225 if (!batadv_atomic_dec_not_zero(&bat_priv->gw.reselect) && curr_gw)
228 /* if gw.reselect is set to 1 it means that a previous call to
229 * gw.is_eligible() said that we have a new best GW, therefore it can
230 * now be picked from the list and selected
232 next_gw = bat_priv->algo_ops->gw.get_best_gw_node(bat_priv);
234 if (curr_gw == next_gw)
238 sprintf(gw_addr, "%pM", next_gw->orig_node->orig);
240 router = batadv_orig_router_get(next_gw->orig_node,
243 batadv_gw_reselect(bat_priv);
247 router_ifinfo = batadv_neigh_ifinfo_get(router,
249 if (!router_ifinfo) {
250 batadv_gw_reselect(bat_priv);
255 if (curr_gw && !next_gw) {
256 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
257 "Removing selected gateway - no gateway in range\n");
258 batadv_throw_uevent(bat_priv, BATADV_UEV_GW, BATADV_UEV_DEL,
260 } else if (!curr_gw && next_gw) {
261 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
262 "Adding route to gateway %pM (bandwidth: %u.%u/%u.%u MBit, tq: %i)\n",
263 next_gw->orig_node->orig,
264 next_gw->bandwidth_down / 10,
265 next_gw->bandwidth_down % 10,
266 next_gw->bandwidth_up / 10,
267 next_gw->bandwidth_up % 10,
268 router_ifinfo->bat_iv.tq_avg);
269 batadv_throw_uevent(bat_priv, BATADV_UEV_GW, BATADV_UEV_ADD,
272 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
273 "Changing route to gateway %pM (bandwidth: %u.%u/%u.%u MBit, tq: %i)\n",
274 next_gw->orig_node->orig,
275 next_gw->bandwidth_down / 10,
276 next_gw->bandwidth_down % 10,
277 next_gw->bandwidth_up / 10,
278 next_gw->bandwidth_up % 10,
279 router_ifinfo->bat_iv.tq_avg);
280 batadv_throw_uevent(bat_priv, BATADV_UEV_GW, BATADV_UEV_CHANGE,
284 batadv_gw_select(bat_priv, next_gw);
288 batadv_gw_node_put(curr_gw);
290 batadv_gw_node_put(next_gw);
292 batadv_neigh_node_put(router);
294 batadv_neigh_ifinfo_put(router_ifinfo);
298 * batadv_gw_check_election() - Elect orig node as best gateway when eligible
299 * @bat_priv: the bat priv with all the soft interface information
300 * @orig_node: orig node which is to be checked
302 void batadv_gw_check_election(struct batadv_priv *bat_priv,
303 struct batadv_orig_node *orig_node)
305 struct batadv_orig_node *curr_gw_orig;
307 /* abort immediately if the routing algorithm does not support gateway
310 if (!bat_priv->algo_ops->gw.is_eligible)
313 curr_gw_orig = batadv_gw_get_selected_orig(bat_priv);
317 /* this node already is the gateway */
318 if (curr_gw_orig == orig_node)
321 if (!bat_priv->algo_ops->gw.is_eligible(bat_priv, curr_gw_orig,
326 batadv_gw_reselect(bat_priv);
329 batadv_orig_node_put(curr_gw_orig);
333 * batadv_gw_node_add() - add gateway node to list of available gateways
334 * @bat_priv: the bat priv with all the soft interface information
335 * @orig_node: originator announcing gateway capabilities
336 * @gateway: announced bandwidth information
338 * Has to be called with the appropriate locks being acquired
341 static void batadv_gw_node_add(struct batadv_priv *bat_priv,
342 struct batadv_orig_node *orig_node,
343 struct batadv_tvlv_gateway_data *gateway)
345 struct batadv_gw_node *gw_node;
347 lockdep_assert_held(&bat_priv->gw.list_lock);
349 if (gateway->bandwidth_down == 0)
352 gw_node = kzalloc(sizeof(*gw_node), GFP_ATOMIC);
356 kref_init(&gw_node->refcount);
357 INIT_HLIST_NODE(&gw_node->list);
358 kref_get(&orig_node->refcount);
359 gw_node->orig_node = orig_node;
360 gw_node->bandwidth_down = ntohl(gateway->bandwidth_down);
361 gw_node->bandwidth_up = ntohl(gateway->bandwidth_up);
363 kref_get(&gw_node->refcount);
364 hlist_add_head_rcu(&gw_node->list, &bat_priv->gw.gateway_list);
365 bat_priv->gw.generation++;
367 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
368 "Found new gateway %pM -> gw bandwidth: %u.%u/%u.%u MBit\n",
370 ntohl(gateway->bandwidth_down) / 10,
371 ntohl(gateway->bandwidth_down) % 10,
372 ntohl(gateway->bandwidth_up) / 10,
373 ntohl(gateway->bandwidth_up) % 10);
375 /* don't return reference to new gw_node */
376 batadv_gw_node_put(gw_node);
380 * batadv_gw_node_get() - retrieve gateway node from list of available gateways
381 * @bat_priv: the bat priv with all the soft interface information
382 * @orig_node: originator announcing gateway capabilities
384 * Return: gateway node if found or NULL otherwise.
386 struct batadv_gw_node *batadv_gw_node_get(struct batadv_priv *bat_priv,
387 struct batadv_orig_node *orig_node)
389 struct batadv_gw_node *gw_node_tmp, *gw_node = NULL;
392 hlist_for_each_entry_rcu(gw_node_tmp, &bat_priv->gw.gateway_list,
394 if (gw_node_tmp->orig_node != orig_node)
397 if (!kref_get_unless_zero(&gw_node_tmp->refcount))
400 gw_node = gw_node_tmp;
409 * batadv_gw_node_update() - update list of available gateways with changed
410 * bandwidth information
411 * @bat_priv: the bat priv with all the soft interface information
412 * @orig_node: originator announcing gateway capabilities
413 * @gateway: announced bandwidth information
415 void batadv_gw_node_update(struct batadv_priv *bat_priv,
416 struct batadv_orig_node *orig_node,
417 struct batadv_tvlv_gateway_data *gateway)
419 struct batadv_gw_node *gw_node, *curr_gw = NULL;
421 spin_lock_bh(&bat_priv->gw.list_lock);
422 gw_node = batadv_gw_node_get(bat_priv, orig_node);
424 batadv_gw_node_add(bat_priv, orig_node, gateway);
425 spin_unlock_bh(&bat_priv->gw.list_lock);
428 spin_unlock_bh(&bat_priv->gw.list_lock);
430 if (gw_node->bandwidth_down == ntohl(gateway->bandwidth_down) &&
431 gw_node->bandwidth_up == ntohl(gateway->bandwidth_up))
434 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
435 "Gateway bandwidth of originator %pM changed from %u.%u/%u.%u MBit to %u.%u/%u.%u MBit\n",
437 gw_node->bandwidth_down / 10,
438 gw_node->bandwidth_down % 10,
439 gw_node->bandwidth_up / 10,
440 gw_node->bandwidth_up % 10,
441 ntohl(gateway->bandwidth_down) / 10,
442 ntohl(gateway->bandwidth_down) % 10,
443 ntohl(gateway->bandwidth_up) / 10,
444 ntohl(gateway->bandwidth_up) % 10);
446 gw_node->bandwidth_down = ntohl(gateway->bandwidth_down);
447 gw_node->bandwidth_up = ntohl(gateway->bandwidth_up);
449 if (ntohl(gateway->bandwidth_down) == 0) {
450 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
451 "Gateway %pM removed from gateway list\n",
454 /* Note: We don't need a NULL check here, since curr_gw never
457 spin_lock_bh(&bat_priv->gw.list_lock);
458 if (!hlist_unhashed(&gw_node->list)) {
459 hlist_del_init_rcu(&gw_node->list);
460 batadv_gw_node_put(gw_node);
461 bat_priv->gw.generation++;
463 spin_unlock_bh(&bat_priv->gw.list_lock);
465 curr_gw = batadv_gw_get_selected_gw_node(bat_priv);
466 if (gw_node == curr_gw)
467 batadv_gw_reselect(bat_priv);
470 batadv_gw_node_put(curr_gw);
475 batadv_gw_node_put(gw_node);
479 * batadv_gw_node_delete() - Remove orig_node from gateway list
480 * @bat_priv: the bat priv with all the soft interface information
481 * @orig_node: orig node which is currently in process of being removed
483 void batadv_gw_node_delete(struct batadv_priv *bat_priv,
484 struct batadv_orig_node *orig_node)
486 struct batadv_tvlv_gateway_data gateway;
488 gateway.bandwidth_down = 0;
489 gateway.bandwidth_up = 0;
491 batadv_gw_node_update(bat_priv, orig_node, &gateway);
495 * batadv_gw_node_free() - Free gateway information from soft interface
496 * @bat_priv: the bat priv with all the soft interface information
498 void batadv_gw_node_free(struct batadv_priv *bat_priv)
500 struct batadv_gw_node *gw_node;
501 struct hlist_node *node_tmp;
503 spin_lock_bh(&bat_priv->gw.list_lock);
504 hlist_for_each_entry_safe(gw_node, node_tmp,
505 &bat_priv->gw.gateway_list, list) {
506 hlist_del_init_rcu(&gw_node->list);
507 batadv_gw_node_put(gw_node);
508 bat_priv->gw.generation++;
510 spin_unlock_bh(&bat_priv->gw.list_lock);
514 * batadv_gw_dump() - Dump gateways into a message
515 * @msg: Netlink message to dump into
516 * @cb: Control block containing additional options
518 * Return: Error code, or length of message
520 int batadv_gw_dump(struct sk_buff *msg, struct netlink_callback *cb)
522 struct batadv_hard_iface *primary_if = NULL;
523 struct net *net = sock_net(cb->skb->sk);
524 struct net_device *soft_iface;
525 struct batadv_priv *bat_priv;
529 ifindex = batadv_netlink_get_ifindex(cb->nlh,
530 BATADV_ATTR_MESH_IFINDEX);
534 soft_iface = dev_get_by_index(net, ifindex);
535 if (!soft_iface || !batadv_softif_is_valid(soft_iface)) {
540 bat_priv = netdev_priv(soft_iface);
542 primary_if = batadv_primary_if_get_selected(bat_priv);
543 if (!primary_if || primary_if->if_status != BATADV_IF_ACTIVE) {
548 if (!bat_priv->algo_ops->gw.dump) {
553 bat_priv->algo_ops->gw.dump(msg, cb, bat_priv);
559 batadv_hardif_put(primary_if);
567 * batadv_gw_dhcp_recipient_get() - check if a packet is a DHCP message
568 * @skb: the packet to check
569 * @header_len: a pointer to the batman-adv header size
570 * @chaddr: buffer where the client address will be stored. Valid
571 * only if the function returns BATADV_DHCP_TO_CLIENT
573 * This function may re-allocate the data buffer of the skb passed as argument.
576 * - BATADV_DHCP_NO if the packet is not a dhcp message or if there was an error
578 * - BATADV_DHCP_TO_SERVER if this is a message going to the DHCP server
579 * - BATADV_DHCP_TO_CLIENT if this is a message going to a DHCP client
581 enum batadv_dhcp_recipient
582 batadv_gw_dhcp_recipient_get(struct sk_buff *skb, unsigned int *header_len,
585 enum batadv_dhcp_recipient ret = BATADV_DHCP_NO;
586 struct ethhdr *ethhdr;
588 struct ipv6hdr *ipv6hdr;
589 struct udphdr *udphdr;
590 struct vlan_ethhdr *vhdr;
595 /* check for ethernet header */
596 if (!pskb_may_pull(skb, *header_len + ETH_HLEN))
597 return BATADV_DHCP_NO;
599 ethhdr = eth_hdr(skb);
600 proto = ethhdr->h_proto;
601 *header_len += ETH_HLEN;
603 /* check for initial vlan header */
604 if (proto == htons(ETH_P_8021Q)) {
605 if (!pskb_may_pull(skb, *header_len + VLAN_HLEN))
606 return BATADV_DHCP_NO;
608 vhdr = vlan_eth_hdr(skb);
609 proto = vhdr->h_vlan_encapsulated_proto;
610 *header_len += VLAN_HLEN;
613 /* check for ip header */
615 case htons(ETH_P_IP):
616 if (!pskb_may_pull(skb, *header_len + sizeof(*iphdr)))
617 return BATADV_DHCP_NO;
619 iphdr = (struct iphdr *)(skb->data + *header_len);
620 *header_len += iphdr->ihl * 4;
622 /* check for udp header */
623 if (iphdr->protocol != IPPROTO_UDP)
624 return BATADV_DHCP_NO;
627 case htons(ETH_P_IPV6):
628 if (!pskb_may_pull(skb, *header_len + sizeof(*ipv6hdr)))
629 return BATADV_DHCP_NO;
631 ipv6hdr = (struct ipv6hdr *)(skb->data + *header_len);
632 *header_len += sizeof(*ipv6hdr);
634 /* check for udp header */
635 if (ipv6hdr->nexthdr != IPPROTO_UDP)
636 return BATADV_DHCP_NO;
640 return BATADV_DHCP_NO;
643 if (!pskb_may_pull(skb, *header_len + sizeof(*udphdr)))
644 return BATADV_DHCP_NO;
646 udphdr = (struct udphdr *)(skb->data + *header_len);
647 *header_len += sizeof(*udphdr);
649 /* check for bootp port */
651 case htons(ETH_P_IP):
652 if (udphdr->dest == htons(67))
653 ret = BATADV_DHCP_TO_SERVER;
654 else if (udphdr->source == htons(67))
655 ret = BATADV_DHCP_TO_CLIENT;
657 case htons(ETH_P_IPV6):
658 if (udphdr->dest == htons(547))
659 ret = BATADV_DHCP_TO_SERVER;
660 else if (udphdr->source == htons(547))
661 ret = BATADV_DHCP_TO_CLIENT;
665 chaddr_offset = *header_len + BATADV_DHCP_CHADDR_OFFSET;
666 /* store the client address if the message is going to a client */
667 if (ret == BATADV_DHCP_TO_CLIENT) {
668 if (!pskb_may_pull(skb, chaddr_offset + ETH_ALEN))
669 return BATADV_DHCP_NO;
671 /* check if the DHCP packet carries an Ethernet DHCP */
672 p = skb->data + *header_len + BATADV_DHCP_HTYPE_OFFSET;
673 if (*p != BATADV_DHCP_HTYPE_ETHERNET)
674 return BATADV_DHCP_NO;
676 /* check if the DHCP packet carries a valid Ethernet address */
677 p = skb->data + *header_len + BATADV_DHCP_HLEN_OFFSET;
679 return BATADV_DHCP_NO;
681 ether_addr_copy(chaddr, skb->data + chaddr_offset);
688 * batadv_gw_out_of_range() - check if the dhcp request destination is the best
690 * @bat_priv: the bat priv with all the soft interface information
691 * @skb: the outgoing packet
693 * Check if the skb is a DHCP request and if it is sent to the current best GW
694 * server. Due to topology changes it may be the case that the GW server
695 * previously selected is not the best one anymore.
697 * This call might reallocate skb data.
698 * Must be invoked only when the DHCP packet is going TO a DHCP SERVER.
700 * Return: true if the packet destination is unicast and it is not the best gw,
703 bool batadv_gw_out_of_range(struct batadv_priv *bat_priv,
706 struct batadv_neigh_node *neigh_curr = NULL;
707 struct batadv_neigh_node *neigh_old = NULL;
708 struct batadv_orig_node *orig_dst_node = NULL;
709 struct batadv_gw_node *gw_node = NULL;
710 struct batadv_gw_node *curr_gw = NULL;
711 struct batadv_neigh_ifinfo *curr_ifinfo, *old_ifinfo;
712 struct ethhdr *ethhdr = (struct ethhdr *)skb->data;
713 bool out_of_range = false;
717 vid = batadv_get_vid(skb, 0);
719 if (is_multicast_ether_addr(ethhdr->h_dest))
722 orig_dst_node = batadv_transtable_search(bat_priv, ethhdr->h_source,
723 ethhdr->h_dest, vid);
727 gw_node = batadv_gw_node_get(bat_priv, orig_dst_node);
731 switch (atomic_read(&bat_priv->gw.mode)) {
732 case BATADV_GW_MODE_SERVER:
733 /* If we are a GW then we are our best GW. We can artificially
734 * set the tq towards ourself as the maximum value
736 curr_tq_avg = BATADV_TQ_MAX_VALUE;
738 case BATADV_GW_MODE_CLIENT:
739 curr_gw = batadv_gw_get_selected_gw_node(bat_priv);
743 /* packet is going to our gateway */
744 if (curr_gw->orig_node == orig_dst_node)
747 /* If the dhcp packet has been sent to a different gw,
748 * we have to evaluate whether the old gw is still
751 neigh_curr = batadv_find_router(bat_priv, curr_gw->orig_node,
756 curr_ifinfo = batadv_neigh_ifinfo_get(neigh_curr,
761 curr_tq_avg = curr_ifinfo->bat_iv.tq_avg;
762 batadv_neigh_ifinfo_put(curr_ifinfo);
765 case BATADV_GW_MODE_OFF:
770 neigh_old = batadv_find_router(bat_priv, orig_dst_node, NULL);
774 old_ifinfo = batadv_neigh_ifinfo_get(neigh_old, BATADV_IF_DEFAULT);
778 if ((curr_tq_avg - old_ifinfo->bat_iv.tq_avg) > BATADV_GW_THRESHOLD)
780 batadv_neigh_ifinfo_put(old_ifinfo);
784 batadv_orig_node_put(orig_dst_node);
786 batadv_gw_node_put(curr_gw);
788 batadv_gw_node_put(gw_node);
790 batadv_neigh_node_put(neigh_old);
792 batadv_neigh_node_put(neigh_curr);