1 /* Copyright (C) 2007-2016 B.A.T.M.A.N. contributors:
3 * Marek Lindner, Simon Wunderlich
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of version 2 of the GNU General Public
7 * License as published by the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, see <http://www.gnu.org/licenses/>.
18 #include "hard-interface.h"
21 #include <linux/atomic.h>
22 #include <linux/bug.h>
23 #include <linux/byteorder/generic.h>
24 #include <linux/errno.h>
27 #include <linux/if_arp.h>
28 #include <linux/if_ether.h>
29 #include <linux/kernel.h>
30 #include <linux/kref.h>
31 #include <linux/list.h>
32 #include <linux/netdevice.h>
33 #include <linux/printk.h>
34 #include <linux/rculist.h>
35 #include <linux/rtnetlink.h>
36 #include <linux/slab.h>
37 #include <linux/spinlock.h>
38 #include <linux/workqueue.h>
41 #include "bridge_loop_avoidance.h"
43 #include "distributed-arp-table.h"
44 #include "gateway_client.h"
45 #include "originator.h"
48 #include "soft-interface.h"
50 #include "translation-table.h"
53 * batadv_hardif_release - release hard interface from lists and queue for
54 * free after rcu grace period
55 * @ref: kref pointer of the hard interface
57 void batadv_hardif_release(struct kref *ref)
59 struct batadv_hard_iface *hard_iface;
61 hard_iface = container_of(ref, struct batadv_hard_iface, refcount);
62 dev_put(hard_iface->net_dev);
64 kfree_rcu(hard_iface, rcu);
67 struct batadv_hard_iface *
68 batadv_hardif_get_by_netdev(const struct net_device *net_dev)
70 struct batadv_hard_iface *hard_iface;
73 list_for_each_entry_rcu(hard_iface, &batadv_hardif_list, list) {
74 if (hard_iface->net_dev == net_dev &&
75 kref_get_unless_zero(&hard_iface->refcount))
87 * batadv_mutual_parents - check if two devices are each others parent
88 * @dev1: 1st net_device
89 * @dev2: 2nd net_device
91 * veth devices come in pairs and each is the parent of the other!
93 * Return: true if the devices are each others parent, otherwise false
95 static bool batadv_mutual_parents(const struct net_device *dev1,
96 const struct net_device *dev2)
98 int dev1_parent_iflink = dev_get_iflink(dev1);
99 int dev2_parent_iflink = dev_get_iflink(dev2);
101 if (!dev1_parent_iflink || !dev2_parent_iflink)
104 return (dev1_parent_iflink == dev2->ifindex) &&
105 (dev2_parent_iflink == dev1->ifindex);
109 * batadv_is_on_batman_iface - check if a device is a batman iface descendant
110 * @net_dev: the device to check
112 * If the user creates any virtual device on top of a batman-adv interface, it
113 * is important to prevent this new interface to be used to create a new mesh
114 * network (this behaviour would lead to a batman-over-batman configuration).
115 * This function recursively checks all the fathers of the device passed as
116 * argument looking for a batman-adv soft interface.
118 * Return: true if the device is descendant of a batman-adv mesh interface (or
119 * if it is a batman-adv interface itself), false otherwise
121 static bool batadv_is_on_batman_iface(const struct net_device *net_dev)
123 struct net_device *parent_dev;
124 struct net *net = dev_net(net_dev);
127 /* check if this is a batman-adv mesh interface */
128 if (batadv_softif_is_valid(net_dev))
131 /* no more parents..stop recursion */
132 if (dev_get_iflink(net_dev) == 0 ||
133 dev_get_iflink(net_dev) == net_dev->ifindex)
136 /* recurse over the parent device */
137 parent_dev = __dev_get_by_index(net, dev_get_iflink(net_dev));
138 /* if we got a NULL parent_dev there is something broken.. */
139 if (WARN(!parent_dev, "Cannot find parent device"))
142 if (batadv_mutual_parents(net_dev, parent_dev))
145 ret = batadv_is_on_batman_iface(parent_dev);
150 static bool batadv_is_valid_iface(const struct net_device *net_dev)
152 if (net_dev->flags & IFF_LOOPBACK)
155 if (net_dev->type != ARPHRD_ETHER)
158 if (net_dev->addr_len != ETH_ALEN)
161 /* no batman over batman */
162 if (batadv_is_on_batman_iface(net_dev))
169 * batadv_is_wifi_netdev - check if the given net_device struct is a wifi
171 * @net_device: the device to check
173 * Return: true if the net device is a 802.11 wireless device, false otherwise.
175 bool batadv_is_wifi_netdev(struct net_device *net_device)
180 #ifdef CONFIG_WIRELESS_EXT
181 /* pre-cfg80211 drivers have to implement WEXT, so it is possible to
182 * check for wireless_handlers != NULL
184 if (net_device->wireless_handlers)
188 /* cfg80211 drivers have to set ieee80211_ptr */
189 if (net_device->ieee80211_ptr)
195 static struct batadv_hard_iface *
196 batadv_hardif_get_active(const struct net_device *soft_iface)
198 struct batadv_hard_iface *hard_iface;
201 list_for_each_entry_rcu(hard_iface, &batadv_hardif_list, list) {
202 if (hard_iface->soft_iface != soft_iface)
205 if (hard_iface->if_status == BATADV_IF_ACTIVE &&
206 kref_get_unless_zero(&hard_iface->refcount))
217 static void batadv_primary_if_update_addr(struct batadv_priv *bat_priv,
218 struct batadv_hard_iface *oldif)
220 struct batadv_hard_iface *primary_if;
222 primary_if = batadv_primary_if_get_selected(bat_priv);
226 batadv_dat_init_own_addr(bat_priv, primary_if);
227 batadv_bla_update_orig_address(bat_priv, primary_if, oldif);
230 batadv_hardif_put(primary_if);
233 static void batadv_primary_if_select(struct batadv_priv *bat_priv,
234 struct batadv_hard_iface *new_hard_iface)
236 struct batadv_hard_iface *curr_hard_iface;
241 kref_get(&new_hard_iface->refcount);
243 curr_hard_iface = rcu_dereference_protected(bat_priv->primary_if, 1);
244 rcu_assign_pointer(bat_priv->primary_if, new_hard_iface);
249 bat_priv->bat_algo_ops->bat_primary_iface_set(new_hard_iface);
250 batadv_primary_if_update_addr(bat_priv, curr_hard_iface);
254 batadv_hardif_put(curr_hard_iface);
258 batadv_hardif_is_iface_up(const struct batadv_hard_iface *hard_iface)
260 if (hard_iface->net_dev->flags & IFF_UP)
266 static void batadv_check_known_mac_addr(const struct net_device *net_dev)
268 const struct batadv_hard_iface *hard_iface;
271 list_for_each_entry_rcu(hard_iface, &batadv_hardif_list, list) {
272 if ((hard_iface->if_status != BATADV_IF_ACTIVE) &&
273 (hard_iface->if_status != BATADV_IF_TO_BE_ACTIVATED))
276 if (hard_iface->net_dev == net_dev)
279 if (!batadv_compare_eth(hard_iface->net_dev->dev_addr,
283 pr_warn("The newly added mac address (%pM) already exists on: %s\n",
284 net_dev->dev_addr, hard_iface->net_dev->name);
285 pr_warn("It is strongly recommended to keep mac addresses unique to avoid problems!\n");
291 * batadv_hardif_recalc_extra_skbroom() - Recalculate skbuff extra head/tailroom
292 * @soft_iface: netdev struct of the mesh interface
294 static void batadv_hardif_recalc_extra_skbroom(struct net_device *soft_iface)
296 const struct batadv_hard_iface *hard_iface;
297 unsigned short lower_header_len = ETH_HLEN;
298 unsigned short lower_headroom = 0;
299 unsigned short lower_tailroom = 0;
300 unsigned short needed_headroom;
303 list_for_each_entry_rcu(hard_iface, &batadv_hardif_list, list) {
304 if (hard_iface->if_status == BATADV_IF_NOT_IN_USE)
307 if (hard_iface->soft_iface != soft_iface)
310 lower_header_len = max_t(unsigned short, lower_header_len,
311 hard_iface->net_dev->hard_header_len);
313 lower_headroom = max_t(unsigned short, lower_headroom,
314 hard_iface->net_dev->needed_headroom);
316 lower_tailroom = max_t(unsigned short, lower_tailroom,
317 hard_iface->net_dev->needed_tailroom);
321 needed_headroom = lower_headroom + (lower_header_len - ETH_HLEN);
322 needed_headroom += batadv_max_header_len();
324 soft_iface->needed_headroom = needed_headroom;
325 soft_iface->needed_tailroom = lower_tailroom;
328 int batadv_hardif_min_mtu(struct net_device *soft_iface)
330 struct batadv_priv *bat_priv = netdev_priv(soft_iface);
331 const struct batadv_hard_iface *hard_iface;
332 int min_mtu = INT_MAX;
335 list_for_each_entry_rcu(hard_iface, &batadv_hardif_list, list) {
336 if ((hard_iface->if_status != BATADV_IF_ACTIVE) &&
337 (hard_iface->if_status != BATADV_IF_TO_BE_ACTIVATED))
340 if (hard_iface->soft_iface != soft_iface)
343 min_mtu = min_t(int, hard_iface->net_dev->mtu, min_mtu);
347 if (atomic_read(&bat_priv->fragmentation) == 0)
350 /* with fragmentation enabled the maximum size of internally generated
351 * packets such as translation table exchanges or tvlv containers, etc
352 * has to be calculated
354 min_mtu = min_t(int, min_mtu, BATADV_FRAG_MAX_FRAG_SIZE);
355 min_mtu -= sizeof(struct batadv_frag_packet);
356 min_mtu *= BATADV_FRAG_MAX_FRAGMENTS;
359 /* report to the other components the maximum amount of bytes that
360 * batman-adv can send over the wire (without considering the payload
361 * overhead). For example, this value is used by TT to compute the
362 * maximum local table table size
364 atomic_set(&bat_priv->packet_size_max, min_mtu);
366 /* the real soft-interface MTU is computed by removing the payload
367 * overhead from the maximum amount of bytes that was just computed.
369 * However batman-adv does not support MTUs bigger than ETH_DATA_LEN
371 return min_t(int, min_mtu - batadv_max_header_len(), ETH_DATA_LEN);
374 /* adjusts the MTU if a new interface with a smaller MTU appeared. */
375 void batadv_update_min_mtu(struct net_device *soft_iface)
377 soft_iface->mtu = batadv_hardif_min_mtu(soft_iface);
379 /* Check if the local translate table should be cleaned up to match a
380 * new (and smaller) MTU.
382 batadv_tt_local_resize_to_mtu(soft_iface);
386 batadv_hardif_activate_interface(struct batadv_hard_iface *hard_iface)
388 struct batadv_priv *bat_priv;
389 struct batadv_hard_iface *primary_if = NULL;
391 if (hard_iface->if_status != BATADV_IF_INACTIVE)
394 bat_priv = netdev_priv(hard_iface->soft_iface);
396 bat_priv->bat_algo_ops->bat_iface_update_mac(hard_iface);
397 hard_iface->if_status = BATADV_IF_TO_BE_ACTIVATED;
399 /* the first active interface becomes our primary interface or
400 * the next active interface after the old primary interface was removed
402 primary_if = batadv_primary_if_get_selected(bat_priv);
404 batadv_primary_if_select(bat_priv, hard_iface);
406 batadv_info(hard_iface->soft_iface, "Interface activated: %s\n",
407 hard_iface->net_dev->name);
409 batadv_update_min_mtu(hard_iface->soft_iface);
411 if (bat_priv->bat_algo_ops->bat_iface_activate)
412 bat_priv->bat_algo_ops->bat_iface_activate(hard_iface);
416 batadv_hardif_put(primary_if);
420 batadv_hardif_deactivate_interface(struct batadv_hard_iface *hard_iface)
422 if ((hard_iface->if_status != BATADV_IF_ACTIVE) &&
423 (hard_iface->if_status != BATADV_IF_TO_BE_ACTIVATED))
426 hard_iface->if_status = BATADV_IF_INACTIVE;
428 batadv_info(hard_iface->soft_iface, "Interface deactivated: %s\n",
429 hard_iface->net_dev->name);
431 batadv_update_min_mtu(hard_iface->soft_iface);
435 * batadv_master_del_slave - remove hard_iface from the current master interface
436 * @slave: the interface enslaved in another master
437 * @master: the master from which slave has to be removed
439 * Invoke ndo_del_slave on master passing slave as argument. In this way slave
440 * is free'd and master can correctly change its internal state.
442 * Return: 0 on success, a negative value representing the error otherwise
444 static int batadv_master_del_slave(struct batadv_hard_iface *slave,
445 struct net_device *master)
453 if (master->netdev_ops->ndo_del_slave)
454 ret = master->netdev_ops->ndo_del_slave(master, slave->net_dev);
459 int batadv_hardif_enable_interface(struct batadv_hard_iface *hard_iface,
460 struct net *net, const char *iface_name)
462 struct batadv_priv *bat_priv;
463 struct net_device *soft_iface, *master;
464 __be16 ethertype = htons(ETH_P_BATMAN);
465 int max_header_len = batadv_max_header_len();
468 if (hard_iface->if_status != BATADV_IF_NOT_IN_USE)
471 kref_get(&hard_iface->refcount);
473 soft_iface = dev_get_by_name(net, iface_name);
476 soft_iface = batadv_softif_create(net, iface_name);
483 /* dev_get_by_name() increases the reference counter for us */
484 dev_hold(soft_iface);
487 if (!batadv_softif_is_valid(soft_iface)) {
488 pr_err("Can't create batman mesh interface %s: already exists as regular interface\n",
494 /* check if the interface is enslaved in another virtual one and
495 * in that case unlink it first
497 master = netdev_master_upper_dev_get(hard_iface->net_dev);
498 ret = batadv_master_del_slave(hard_iface, master);
502 hard_iface->soft_iface = soft_iface;
503 bat_priv = netdev_priv(hard_iface->soft_iface);
505 ret = netdev_master_upper_dev_link(hard_iface->net_dev,
506 soft_iface, NULL, NULL);
510 ret = bat_priv->bat_algo_ops->bat_iface_enable(hard_iface);
514 hard_iface->if_num = bat_priv->num_ifaces;
515 bat_priv->num_ifaces++;
516 hard_iface->if_status = BATADV_IF_INACTIVE;
517 ret = batadv_orig_hash_add_if(hard_iface, bat_priv->num_ifaces);
519 bat_priv->bat_algo_ops->bat_iface_disable(hard_iface);
520 bat_priv->num_ifaces--;
521 hard_iface->if_status = BATADV_IF_NOT_IN_USE;
525 kref_get(&hard_iface->refcount);
526 hard_iface->batman_adv_ptype.type = ethertype;
527 hard_iface->batman_adv_ptype.func = batadv_batman_skb_recv;
528 hard_iface->batman_adv_ptype.dev = hard_iface->net_dev;
529 dev_add_pack(&hard_iface->batman_adv_ptype);
531 batadv_info(hard_iface->soft_iface, "Adding interface: %s\n",
532 hard_iface->net_dev->name);
534 if (atomic_read(&bat_priv->fragmentation) &&
535 hard_iface->net_dev->mtu < ETH_DATA_LEN + max_header_len)
536 batadv_info(hard_iface->soft_iface,
537 "The MTU of interface %s is too small (%i) to handle the transport of batman-adv packets. Packets going over this interface will be fragmented on layer2 which could impact the performance. Setting the MTU to %i would solve the problem.\n",
538 hard_iface->net_dev->name, hard_iface->net_dev->mtu,
539 ETH_DATA_LEN + max_header_len);
541 if (!atomic_read(&bat_priv->fragmentation) &&
542 hard_iface->net_dev->mtu < ETH_DATA_LEN + max_header_len)
543 batadv_info(hard_iface->soft_iface,
544 "The MTU of interface %s is too small (%i) to handle the transport of batman-adv packets. If you experience problems getting traffic through try increasing the MTU to %i.\n",
545 hard_iface->net_dev->name, hard_iface->net_dev->mtu,
546 ETH_DATA_LEN + max_header_len);
548 if (batadv_hardif_is_iface_up(hard_iface))
549 batadv_hardif_activate_interface(hard_iface);
551 batadv_err(hard_iface->soft_iface,
552 "Not using interface %s (retrying later): interface not active\n",
553 hard_iface->net_dev->name);
555 batadv_hardif_recalc_extra_skbroom(soft_iface);
561 netdev_upper_dev_unlink(hard_iface->net_dev, soft_iface);
563 hard_iface->soft_iface = NULL;
566 batadv_hardif_put(hard_iface);
570 void batadv_hardif_disable_interface(struct batadv_hard_iface *hard_iface,
571 enum batadv_hard_if_cleanup autodel)
573 struct batadv_priv *bat_priv = netdev_priv(hard_iface->soft_iface);
574 struct batadv_hard_iface *primary_if = NULL;
576 batadv_hardif_deactivate_interface(hard_iface);
578 if (hard_iface->if_status != BATADV_IF_INACTIVE)
581 batadv_info(hard_iface->soft_iface, "Removing interface: %s\n",
582 hard_iface->net_dev->name);
583 dev_remove_pack(&hard_iface->batman_adv_ptype);
584 batadv_hardif_put(hard_iface);
586 bat_priv->num_ifaces--;
587 batadv_orig_hash_del_if(hard_iface, bat_priv->num_ifaces);
589 primary_if = batadv_primary_if_get_selected(bat_priv);
590 if (hard_iface == primary_if) {
591 struct batadv_hard_iface *new_if;
593 new_if = batadv_hardif_get_active(hard_iface->soft_iface);
594 batadv_primary_if_select(bat_priv, new_if);
597 batadv_hardif_put(new_if);
600 bat_priv->bat_algo_ops->bat_iface_disable(hard_iface);
601 hard_iface->if_status = BATADV_IF_NOT_IN_USE;
603 /* delete all references to this hard_iface */
604 batadv_purge_orig_ref(bat_priv);
605 batadv_purge_outstanding_packets(bat_priv, hard_iface);
606 dev_put(hard_iface->soft_iface);
608 netdev_upper_dev_unlink(hard_iface->net_dev, hard_iface->soft_iface);
609 batadv_hardif_recalc_extra_skbroom(hard_iface->soft_iface);
611 /* nobody uses this interface anymore */
612 if (!bat_priv->num_ifaces) {
613 batadv_gw_check_client_stop(bat_priv);
615 if (autodel == BATADV_IF_CLEANUP_AUTO)
616 batadv_softif_destroy_sysfs(hard_iface->soft_iface);
619 hard_iface->soft_iface = NULL;
620 batadv_hardif_put(hard_iface);
624 batadv_hardif_put(primary_if);
628 * batadv_hardif_remove_interface_finish - cleans up the remains of a hardif
629 * @work: work queue item
631 * Free the parts of the hard interface which can not be removed under
632 * rtnl lock (to prevent deadlock situations).
634 static void batadv_hardif_remove_interface_finish(struct work_struct *work)
636 struct batadv_hard_iface *hard_iface;
638 hard_iface = container_of(work, struct batadv_hard_iface,
641 batadv_debugfs_del_hardif(hard_iface);
642 batadv_sysfs_del_hardif(&hard_iface->hardif_obj);
643 batadv_hardif_put(hard_iface);
646 static struct batadv_hard_iface *
647 batadv_hardif_add_interface(struct net_device *net_dev)
649 struct batadv_hard_iface *hard_iface;
654 if (!batadv_is_valid_iface(net_dev))
659 hard_iface = kzalloc(sizeof(*hard_iface), GFP_ATOMIC);
663 ret = batadv_sysfs_add_hardif(&hard_iface->hardif_obj, net_dev);
667 hard_iface->if_num = -1;
668 hard_iface->net_dev = net_dev;
669 hard_iface->soft_iface = NULL;
670 hard_iface->if_status = BATADV_IF_NOT_IN_USE;
672 ret = batadv_debugfs_add_hardif(hard_iface);
676 INIT_LIST_HEAD(&hard_iface->list);
677 INIT_HLIST_HEAD(&hard_iface->neigh_list);
678 INIT_WORK(&hard_iface->cleanup_work,
679 batadv_hardif_remove_interface_finish);
681 spin_lock_init(&hard_iface->neigh_list_lock);
683 hard_iface->num_bcasts = BATADV_NUM_BCASTS_DEFAULT;
684 if (batadv_is_wifi_netdev(net_dev))
685 hard_iface->num_bcasts = BATADV_NUM_BCASTS_WIRELESS;
687 batadv_v_hardif_init(hard_iface);
689 /* extra reference for return */
690 kref_init(&hard_iface->refcount);
691 kref_get(&hard_iface->refcount);
693 batadv_check_known_mac_addr(hard_iface->net_dev);
694 list_add_tail_rcu(&hard_iface->list, &batadv_hardif_list);
699 batadv_sysfs_del_hardif(&hard_iface->hardif_obj);
708 static void batadv_hardif_remove_interface(struct batadv_hard_iface *hard_iface)
712 /* first deactivate interface */
713 if (hard_iface->if_status != BATADV_IF_NOT_IN_USE)
714 batadv_hardif_disable_interface(hard_iface,
715 BATADV_IF_CLEANUP_AUTO);
717 if (hard_iface->if_status != BATADV_IF_NOT_IN_USE)
720 hard_iface->if_status = BATADV_IF_TO_BE_REMOVED;
721 queue_work(batadv_event_workqueue, &hard_iface->cleanup_work);
724 void batadv_hardif_remove_interfaces(void)
726 struct batadv_hard_iface *hard_iface, *hard_iface_tmp;
729 list_for_each_entry_safe(hard_iface, hard_iface_tmp,
730 &batadv_hardif_list, list) {
731 list_del_rcu(&hard_iface->list);
732 batadv_hardif_remove_interface(hard_iface);
737 static int batadv_hard_if_event(struct notifier_block *this,
738 unsigned long event, void *ptr)
740 struct net_device *net_dev = netdev_notifier_info_to_dev(ptr);
741 struct batadv_hard_iface *hard_iface;
742 struct batadv_hard_iface *primary_if = NULL;
743 struct batadv_priv *bat_priv;
745 if (batadv_softif_is_valid(net_dev) && event == NETDEV_REGISTER) {
746 batadv_sysfs_add_meshif(net_dev);
747 bat_priv = netdev_priv(net_dev);
748 batadv_softif_create_vlan(bat_priv, BATADV_NO_FLAGS);
752 hard_iface = batadv_hardif_get_by_netdev(net_dev);
753 if (!hard_iface && (event == NETDEV_REGISTER ||
754 event == NETDEV_POST_TYPE_CHANGE))
755 hard_iface = batadv_hardif_add_interface(net_dev);
762 batadv_hardif_activate_interface(hard_iface);
764 case NETDEV_GOING_DOWN:
766 batadv_hardif_deactivate_interface(hard_iface);
768 case NETDEV_UNREGISTER:
769 case NETDEV_PRE_TYPE_CHANGE:
770 list_del_rcu(&hard_iface->list);
772 batadv_hardif_remove_interface(hard_iface);
774 case NETDEV_CHANGEMTU:
775 if (hard_iface->soft_iface)
776 batadv_update_min_mtu(hard_iface->soft_iface);
778 case NETDEV_CHANGEADDR:
779 if (hard_iface->if_status == BATADV_IF_NOT_IN_USE)
782 batadv_check_known_mac_addr(hard_iface->net_dev);
784 bat_priv = netdev_priv(hard_iface->soft_iface);
785 bat_priv->bat_algo_ops->bat_iface_update_mac(hard_iface);
787 primary_if = batadv_primary_if_get_selected(bat_priv);
791 if (hard_iface == primary_if)
792 batadv_primary_if_update_addr(bat_priv, NULL);
799 batadv_hardif_put(hard_iface);
802 batadv_hardif_put(primary_if);
806 struct notifier_block batadv_hard_if_notifier = {
807 .notifier_call = batadv_hard_if_event,