1 /* Copyright (C) 2007-2013 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, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
21 #include "soft-interface.h"
22 #include "hard-interface.h"
23 #include "distributed-arp-table.h"
27 #include "translation-table.h"
29 #include "gateway_common.h"
30 #include "gateway_client.h"
32 #include "originator.h"
33 #include <linux/slab.h>
34 #include <linux/ethtool.h>
35 #include <linux/etherdevice.h>
36 #include <linux/if_vlan.h>
37 #include <linux/if_ether.h>
39 #include "bridge_loop_avoidance.h"
40 #include "network-coding.h"
43 static int batadv_get_settings(struct net_device *dev, struct ethtool_cmd *cmd);
44 static void batadv_get_drvinfo(struct net_device *dev,
45 struct ethtool_drvinfo *info);
46 static u32 batadv_get_msglevel(struct net_device *dev);
47 static void batadv_set_msglevel(struct net_device *dev, u32 value);
48 static u32 batadv_get_link(struct net_device *dev);
49 static void batadv_get_strings(struct net_device *dev, u32 stringset, u8 *data);
50 static void batadv_get_ethtool_stats(struct net_device *dev,
51 struct ethtool_stats *stats, u64 *data);
52 static int batadv_get_sset_count(struct net_device *dev, int stringset);
54 static const struct ethtool_ops batadv_ethtool_ops = {
55 .get_settings = batadv_get_settings,
56 .get_drvinfo = batadv_get_drvinfo,
57 .get_msglevel = batadv_get_msglevel,
58 .set_msglevel = batadv_set_msglevel,
59 .get_link = batadv_get_link,
60 .get_strings = batadv_get_strings,
61 .get_ethtool_stats = batadv_get_ethtool_stats,
62 .get_sset_count = batadv_get_sset_count,
65 int batadv_skb_head_push(struct sk_buff *skb, unsigned int len)
69 /* TODO: We must check if we can release all references to non-payload
70 * data using skb_header_release in our skbs to allow skb_cow_header to
71 * work optimally. This means that those skbs are not allowed to read
72 * or write any data which is before the current position of skb->data
73 * after that call and thus allow other skbs with the same data buffer
74 * to write freely in that area.
76 result = skb_cow_head(skb, len);
84 static int batadv_interface_open(struct net_device *dev)
86 netif_start_queue(dev);
90 static int batadv_interface_release(struct net_device *dev)
92 netif_stop_queue(dev);
96 static struct net_device_stats *batadv_interface_stats(struct net_device *dev)
98 struct batadv_priv *bat_priv = netdev_priv(dev);
99 struct net_device_stats *stats = &bat_priv->stats;
101 stats->tx_packets = batadv_sum_counter(bat_priv, BATADV_CNT_TX);
102 stats->tx_bytes = batadv_sum_counter(bat_priv, BATADV_CNT_TX_BYTES);
103 stats->tx_dropped = batadv_sum_counter(bat_priv, BATADV_CNT_TX_DROPPED);
104 stats->rx_packets = batadv_sum_counter(bat_priv, BATADV_CNT_RX);
105 stats->rx_bytes = batadv_sum_counter(bat_priv, BATADV_CNT_RX_BYTES);
109 static int batadv_interface_set_mac_addr(struct net_device *dev, void *p)
111 struct batadv_priv *bat_priv = netdev_priv(dev);
112 struct sockaddr *addr = p;
113 uint8_t old_addr[ETH_ALEN];
115 if (!is_valid_ether_addr(addr->sa_data))
116 return -EADDRNOTAVAIL;
118 memcpy(old_addr, dev->dev_addr, ETH_ALEN);
119 memcpy(dev->dev_addr, addr->sa_data, ETH_ALEN);
121 /* only modify transtable if it has been initialized before */
122 if (atomic_read(&bat_priv->mesh_state) == BATADV_MESH_ACTIVE) {
123 batadv_tt_local_remove(bat_priv, old_addr,
124 "mac address changed", false);
125 batadv_tt_local_add(dev, addr->sa_data, BATADV_NULL_IFINDEX);
131 static int batadv_interface_change_mtu(struct net_device *dev, int new_mtu)
134 if ((new_mtu < 68) || (new_mtu > batadv_hardif_min_mtu(dev)))
142 static int batadv_interface_tx(struct sk_buff *skb,
143 struct net_device *soft_iface)
145 struct ethhdr *ethhdr = (struct ethhdr *)skb->data;
146 struct batadv_priv *bat_priv = netdev_priv(soft_iface);
147 struct batadv_hard_iface *primary_if = NULL;
148 struct batadv_bcast_packet *bcast_packet;
149 struct vlan_ethhdr *vhdr;
150 __be16 ethertype = __constant_htons(ETH_P_BATMAN);
151 static const uint8_t stp_addr[ETH_ALEN] = {0x01, 0x80, 0xC2, 0x00,
153 static const uint8_t ectp_addr[ETH_ALEN] = {0xCF, 0x00, 0x00, 0x00,
155 unsigned int header_len = 0;
156 int data_len = skb->len, ret;
157 unsigned short vid __maybe_unused = BATADV_NO_FLAGS;
158 bool do_bcast = false;
160 unsigned long brd_delay = 1;
162 if (atomic_read(&bat_priv->mesh_state) != BATADV_MESH_ACTIVE)
165 soft_iface->trans_start = jiffies;
167 switch (ntohs(ethhdr->h_proto)) {
169 vhdr = (struct vlan_ethhdr *)skb->data;
170 vid = ntohs(vhdr->h_vlan_TCI) & VLAN_VID_MASK;
172 if (vhdr->h_vlan_encapsulated_proto != ethertype)
180 if (batadv_bla_tx(bat_priv, skb, vid))
183 /* skb->data might have been reallocated by batadv_bla_tx() */
184 ethhdr = (struct ethhdr *)skb->data;
186 /* Register the client MAC in the transtable */
187 if (!is_multicast_ether_addr(ethhdr->h_source))
188 batadv_tt_local_add(soft_iface, ethhdr->h_source, skb->skb_iif);
190 /* don't accept stp packets. STP does not help in meshes.
191 * better use the bridge loop avoidance ...
193 * The same goes for ECTP sent at least by some Cisco Switches,
194 * it might confuse the mesh when used with bridge loop avoidance.
196 if (batadv_compare_eth(ethhdr->h_dest, stp_addr))
199 if (batadv_compare_eth(ethhdr->h_dest, ectp_addr))
202 if (is_multicast_ether_addr(ethhdr->h_dest)) {
205 switch (atomic_read(&bat_priv->gw_mode)) {
206 case BATADV_GW_MODE_SERVER:
207 /* gateway servers should not send dhcp
208 * requests into the mesh
210 ret = batadv_gw_is_dhcp_target(skb, &header_len);
214 case BATADV_GW_MODE_CLIENT:
215 /* gateway clients should send dhcp requests
216 * via unicast to their gateway
218 ret = batadv_gw_is_dhcp_target(skb, &header_len);
222 case BATADV_GW_MODE_OFF:
227 /* reminder: ethhdr might have become unusable from here on
228 * (batadv_gw_is_dhcp_target() might have reallocated skb data)
232 /* ethernet packet should be broadcasted */
234 primary_if = batadv_primary_if_get_selected(bat_priv);
238 /* in case of ARP request, we do not immediately broadcasti the
239 * packet, instead we first wait for DAT to try to retrieve the
242 if (batadv_dat_snoop_outgoing_arp_request(bat_priv, skb))
243 brd_delay = msecs_to_jiffies(ARP_REQ_DELAY);
245 if (batadv_skb_head_push(skb, sizeof(*bcast_packet)) < 0)
248 bcast_packet = (struct batadv_bcast_packet *)skb->data;
249 bcast_packet->header.version = BATADV_COMPAT_VERSION;
250 bcast_packet->header.ttl = BATADV_TTL;
252 /* batman packet type: broadcast */
253 bcast_packet->header.packet_type = BATADV_BCAST;
254 bcast_packet->reserved = 0;
256 /* hw address of first interface is the orig mac because only
257 * this mac is known throughout the mesh
259 memcpy(bcast_packet->orig,
260 primary_if->net_dev->dev_addr, ETH_ALEN);
262 /* set broadcast sequence number */
263 seqno = atomic_inc_return(&bat_priv->bcast_seqno);
264 bcast_packet->seqno = htonl(seqno);
266 batadv_add_bcast_packet_to_list(bat_priv, skb, brd_delay);
268 /* a copy is stored in the bcast list, therefore removing
275 if (atomic_read(&bat_priv->gw_mode) != BATADV_GW_MODE_OFF) {
276 ret = batadv_gw_out_of_range(bat_priv, skb);
281 if (batadv_dat_snoop_outgoing_arp_request(bat_priv, skb))
284 batadv_dat_snoop_outgoing_arp_reply(bat_priv, skb);
286 ret = batadv_unicast_send_skb(bat_priv, skb);
291 batadv_inc_counter(bat_priv, BATADV_CNT_TX);
292 batadv_add_counter(bat_priv, BATADV_CNT_TX_BYTES, data_len);
298 batadv_inc_counter(bat_priv, BATADV_CNT_TX_DROPPED);
301 batadv_hardif_free_ref(primary_if);
305 void batadv_interface_rx(struct net_device *soft_iface,
306 struct sk_buff *skb, struct batadv_hard_iface *recv_if,
307 int hdr_size, struct batadv_orig_node *orig_node)
309 struct batadv_priv *bat_priv = netdev_priv(soft_iface);
310 struct ethhdr *ethhdr;
311 struct vlan_ethhdr *vhdr;
312 struct batadv_header *batadv_header = (struct batadv_header *)skb->data;
313 unsigned short vid __maybe_unused = BATADV_NO_FLAGS;
314 __be16 ethertype = __constant_htons(ETH_P_BATMAN);
317 is_bcast = (batadv_header->packet_type == BATADV_BCAST);
319 /* check if enough space is available for pulling, and pull */
320 if (!pskb_may_pull(skb, hdr_size))
323 skb_pull_rcsum(skb, hdr_size);
324 skb_reset_mac_header(skb);
326 ethhdr = eth_hdr(skb);
328 switch (ntohs(ethhdr->h_proto)) {
330 vhdr = (struct vlan_ethhdr *)skb->data;
331 vid = ntohs(vhdr->h_vlan_TCI) & VLAN_VID_MASK;
333 if (vhdr->h_vlan_encapsulated_proto != ethertype)
341 /* skb->dev & skb->pkt_type are set here */
342 if (unlikely(!pskb_may_pull(skb, ETH_HLEN)))
344 skb->protocol = eth_type_trans(skb, soft_iface);
346 /* should not be necessary anymore as we use skb_pull_rcsum()
347 * TODO: please verify this and remove this TODO
348 * -- Dec 21st 2009, Simon Wunderlich
351 /* skb->ip_summed = CHECKSUM_UNNECESSARY; */
353 batadv_inc_counter(bat_priv, BATADV_CNT_RX);
354 batadv_add_counter(bat_priv, BATADV_CNT_RX_BYTES,
355 skb->len + ETH_HLEN);
357 soft_iface->last_rx = jiffies;
359 /* Let the bridge loop avoidance check the packet. If will
360 * not handle it, we can safely push it up.
362 if (batadv_bla_rx(bat_priv, skb, vid, is_bcast))
366 batadv_tt_add_temporary_global_entry(bat_priv, orig_node,
369 if (batadv_is_ap_isolated(bat_priv, ethhdr->h_source, ethhdr->h_dest))
381 /* batman-adv network devices have devices nesting below it and are a special
382 * "super class" of normal network devices; split their locks off into a
383 * separate class since they always nest.
385 static struct lock_class_key batadv_netdev_xmit_lock_key;
386 static struct lock_class_key batadv_netdev_addr_lock_key;
389 * batadv_set_lockdep_class_one - Set lockdep class for a single tx queue
390 * @dev: device which owns the tx queue
391 * @txq: tx queue to modify
392 * @_unused: always NULL
394 static void batadv_set_lockdep_class_one(struct net_device *dev,
395 struct netdev_queue *txq,
398 lockdep_set_class(&txq->_xmit_lock, &batadv_netdev_xmit_lock_key);
402 * batadv_set_lockdep_class - Set txq and addr_list lockdep class
403 * @dev: network device to modify
405 static void batadv_set_lockdep_class(struct net_device *dev)
407 lockdep_set_class(&dev->addr_list_lock, &batadv_netdev_addr_lock_key);
408 netdev_for_each_tx_queue(dev, batadv_set_lockdep_class_one, NULL);
412 * batadv_softif_destroy_finish - cleans up the remains of a softif
413 * @work: work queue item
415 * Free the parts of the soft interface which can not be removed under
416 * rtnl lock (to prevent deadlock situations).
418 static void batadv_softif_destroy_finish(struct work_struct *work)
420 struct batadv_priv *bat_priv;
421 struct net_device *soft_iface;
423 bat_priv = container_of(work, struct batadv_priv,
425 soft_iface = bat_priv->soft_iface;
427 batadv_sysfs_del_meshif(soft_iface);
430 unregister_netdevice(soft_iface);
435 * batadv_softif_init_late - late stage initialization of soft interface
436 * @dev: registered network device to modify
438 * Returns error code on failures
440 static int batadv_softif_init_late(struct net_device *dev)
442 struct batadv_priv *bat_priv;
444 size_t cnt_len = sizeof(uint64_t) * BATADV_CNT_NUM;
446 batadv_set_lockdep_class(dev);
448 bat_priv = netdev_priv(dev);
449 bat_priv->soft_iface = dev;
450 INIT_WORK(&bat_priv->cleanup_work, batadv_softif_destroy_finish);
452 /* batadv_interface_stats() needs to be available as soon as
453 * register_netdevice() has been called
455 bat_priv->bat_counters = __alloc_percpu(cnt_len, __alignof__(uint64_t));
456 if (!bat_priv->bat_counters)
459 atomic_set(&bat_priv->aggregated_ogms, 1);
460 atomic_set(&bat_priv->bonding, 0);
461 #ifdef CONFIG_BATMAN_ADV_BLA
462 atomic_set(&bat_priv->bridge_loop_avoidance, 0);
464 #ifdef CONFIG_BATMAN_ADV_DAT
465 atomic_set(&bat_priv->distributed_arp_table, 1);
467 atomic_set(&bat_priv->ap_isolation, 0);
468 atomic_set(&bat_priv->vis_mode, BATADV_VIS_TYPE_CLIENT_UPDATE);
469 atomic_set(&bat_priv->gw_mode, BATADV_GW_MODE_OFF);
470 atomic_set(&bat_priv->gw_sel_class, 20);
471 atomic_set(&bat_priv->gw_bandwidth, 41);
472 atomic_set(&bat_priv->orig_interval, 1000);
473 atomic_set(&bat_priv->hop_penalty, 30);
474 #ifdef CONFIG_BATMAN_ADV_DEBUG
475 atomic_set(&bat_priv->log_level, 0);
477 atomic_set(&bat_priv->fragmentation, 1);
478 atomic_set(&bat_priv->bcast_queue_left, BATADV_BCAST_QUEUE_LEN);
479 atomic_set(&bat_priv->batman_queue_left, BATADV_BATMAN_QUEUE_LEN);
481 atomic_set(&bat_priv->mesh_state, BATADV_MESH_INACTIVE);
482 atomic_set(&bat_priv->bcast_seqno, 1);
483 atomic_set(&bat_priv->tt.vn, 0);
484 atomic_set(&bat_priv->tt.local_changes, 0);
485 atomic_set(&bat_priv->tt.ogm_append_cnt, 0);
486 #ifdef CONFIG_BATMAN_ADV_BLA
487 atomic_set(&bat_priv->bla.num_requests, 0);
489 bat_priv->tt.last_changeset = NULL;
490 bat_priv->tt.last_changeset_len = 0;
492 bat_priv->primary_if = NULL;
493 bat_priv->num_ifaces = 0;
495 batadv_nc_init_bat_priv(bat_priv);
497 ret = batadv_algo_select(bat_priv, batadv_routing_algo);
499 goto free_bat_counters;
501 ret = batadv_debugfs_add_meshif(dev);
503 goto free_bat_counters;
505 ret = batadv_mesh_init(dev);
512 batadv_debugfs_del_meshif(dev);
514 free_percpu(bat_priv->bat_counters);
515 bat_priv->bat_counters = NULL;
521 * batadv_softif_slave_add - Add a slave interface to a batadv_soft_interface
522 * @dev: batadv_soft_interface used as master interface
523 * @slave_dev: net_device which should become the slave interface
525 * Return 0 if successful or error otherwise.
527 static int batadv_softif_slave_add(struct net_device *dev,
528 struct net_device *slave_dev)
530 struct batadv_hard_iface *hard_iface;
533 hard_iface = batadv_hardif_get_by_netdev(slave_dev);
534 if (!hard_iface || hard_iface->soft_iface != NULL)
537 ret = batadv_hardif_enable_interface(hard_iface, dev->name);
541 batadv_hardif_free_ref(hard_iface);
546 * batadv_softif_slave_del - Delete a slave iface from a batadv_soft_interface
547 * @dev: batadv_soft_interface used as master interface
548 * @slave_dev: net_device which should be removed from the master interface
550 * Return 0 if successful or error otherwise.
552 static int batadv_softif_slave_del(struct net_device *dev,
553 struct net_device *slave_dev)
555 struct batadv_hard_iface *hard_iface;
558 hard_iface = batadv_hardif_get_by_netdev(slave_dev);
560 if (!hard_iface || hard_iface->soft_iface != dev)
563 batadv_hardif_disable_interface(hard_iface, BATADV_IF_CLEANUP_KEEP);
568 batadv_hardif_free_ref(hard_iface);
572 static const struct net_device_ops batadv_netdev_ops = {
573 .ndo_init = batadv_softif_init_late,
574 .ndo_open = batadv_interface_open,
575 .ndo_stop = batadv_interface_release,
576 .ndo_get_stats = batadv_interface_stats,
577 .ndo_set_mac_address = batadv_interface_set_mac_addr,
578 .ndo_change_mtu = batadv_interface_change_mtu,
579 .ndo_start_xmit = batadv_interface_tx,
580 .ndo_validate_addr = eth_validate_addr,
581 .ndo_add_slave = batadv_softif_slave_add,
582 .ndo_del_slave = batadv_softif_slave_del,
586 * batadv_softif_free - Deconstructor of batadv_soft_interface
587 * @dev: Device to cleanup and remove
589 static void batadv_softif_free(struct net_device *dev)
591 batadv_debugfs_del_meshif(dev);
592 batadv_mesh_free(dev);
594 /* some scheduled RCU callbacks need the bat_priv struct to accomplish
595 * their tasks. Wait for them all to be finished before freeing the
596 * netdev and its private data (bat_priv)
604 * batadv_softif_init_early - early stage initialization of soft interface
605 * @dev: registered network device to modify
607 static void batadv_softif_init_early(struct net_device *dev)
609 struct batadv_priv *priv = netdev_priv(dev);
613 dev->netdev_ops = &batadv_netdev_ops;
614 dev->destructor = batadv_softif_free;
615 dev->tx_queue_len = 0;
617 /* can't call min_mtu, because the needed variables
618 * have not been initialized yet
620 dev->mtu = ETH_DATA_LEN;
621 /* reserve more space in the skbuff for our header */
622 dev->hard_header_len = BATADV_HEADER_LEN;
624 /* generate random address */
625 eth_hw_addr_random(dev);
627 SET_ETHTOOL_OPS(dev, &batadv_ethtool_ops);
629 memset(priv, 0, sizeof(*priv));
632 struct net_device *batadv_softif_create(const char *name)
634 struct net_device *soft_iface;
637 soft_iface = alloc_netdev(sizeof(struct batadv_priv), name,
638 batadv_softif_init_early);
642 soft_iface->rtnl_link_ops = &batadv_link_ops;
644 ret = register_netdevice(soft_iface);
646 pr_err("Unable to register the batman interface '%s': %i\n",
648 free_netdev(soft_iface);
656 * batadv_softif_destroy_sysfs - deletion of batadv_soft_interface via sysfs
657 * @soft_iface: the to-be-removed batman-adv interface
659 void batadv_softif_destroy_sysfs(struct net_device *soft_iface)
661 struct batadv_priv *bat_priv = netdev_priv(soft_iface);
663 queue_work(batadv_event_workqueue, &bat_priv->cleanup_work);
667 * batadv_softif_destroy_netlink - deletion of batadv_soft_interface via netlink
668 * @soft_iface: the to-be-removed batman-adv interface
669 * @head: list pointer
671 static void batadv_softif_destroy_netlink(struct net_device *soft_iface,
672 struct list_head *head)
674 struct batadv_hard_iface *hard_iface;
676 list_for_each_entry(hard_iface, &batadv_hardif_list, list) {
677 if (hard_iface->soft_iface == soft_iface)
678 batadv_hardif_disable_interface(hard_iface,
679 BATADV_IF_CLEANUP_KEEP);
682 batadv_sysfs_del_meshif(soft_iface);
683 unregister_netdevice_queue(soft_iface, head);
686 int batadv_softif_is_valid(const struct net_device *net_dev)
688 if (net_dev->netdev_ops->ndo_start_xmit == batadv_interface_tx)
694 struct rtnl_link_ops batadv_link_ops __read_mostly = {
696 .priv_size = sizeof(struct batadv_priv),
697 .setup = batadv_softif_init_early,
698 .dellink = batadv_softif_destroy_netlink,
702 static int batadv_get_settings(struct net_device *dev, struct ethtool_cmd *cmd)
705 cmd->advertising = 0;
706 ethtool_cmd_speed_set(cmd, SPEED_10);
707 cmd->duplex = DUPLEX_FULL;
709 cmd->phy_address = 0;
710 cmd->transceiver = XCVR_INTERNAL;
711 cmd->autoneg = AUTONEG_DISABLE;
718 static void batadv_get_drvinfo(struct net_device *dev,
719 struct ethtool_drvinfo *info)
721 strlcpy(info->driver, "B.A.T.M.A.N. advanced", sizeof(info->driver));
722 strlcpy(info->version, BATADV_SOURCE_VERSION, sizeof(info->version));
723 strlcpy(info->fw_version, "N/A", sizeof(info->fw_version));
724 strlcpy(info->bus_info, "batman", sizeof(info->bus_info));
727 static u32 batadv_get_msglevel(struct net_device *dev)
732 static void batadv_set_msglevel(struct net_device *dev, u32 value)
736 static u32 batadv_get_link(struct net_device *dev)
741 /* Inspired by drivers/net/ethernet/dlink/sundance.c:1702
742 * Declare each description string in struct.name[] to get fixed sized buffer
743 * and compile time checking for strings longer than ETH_GSTRING_LEN.
745 static const struct {
746 const char name[ETH_GSTRING_LEN];
747 } batadv_counters_strings[] = {
761 { "tt_response_tx" },
762 { "tt_response_rx" },
763 { "tt_roam_adv_tx" },
764 { "tt_roam_adv_rx" },
765 #ifdef CONFIG_BATMAN_ADV_DAT
770 { "dat_cached_reply_tx" },
772 #ifdef CONFIG_BATMAN_ADV_NC
776 { "nc_recode_bytes" },
779 { "nc_decode_bytes" },
780 { "nc_decode_failed" },
785 static void batadv_get_strings(struct net_device *dev, uint32_t stringset,
788 if (stringset == ETH_SS_STATS)
789 memcpy(data, batadv_counters_strings,
790 sizeof(batadv_counters_strings));
793 static void batadv_get_ethtool_stats(struct net_device *dev,
794 struct ethtool_stats *stats,
797 struct batadv_priv *bat_priv = netdev_priv(dev);
800 for (i = 0; i < BATADV_CNT_NUM; i++)
801 data[i] = batadv_sum_counter(bat_priv, i);
804 static int batadv_get_sset_count(struct net_device *dev, int stringset)
806 if (stringset == ETH_SS_STATS)
807 return BATADV_CNT_NUM;