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 /* Register the client MAC in the transtable */
184 if (!is_multicast_ether_addr(ethhdr->h_source))
185 batadv_tt_local_add(soft_iface, ethhdr->h_source, skb->skb_iif);
187 /* don't accept stp packets. STP does not help in meshes.
188 * better use the bridge loop avoidance ...
190 * The same goes for ECTP sent at least by some Cisco Switches,
191 * it might confuse the mesh when used with bridge loop avoidance.
193 if (batadv_compare_eth(ethhdr->h_dest, stp_addr))
196 if (batadv_compare_eth(ethhdr->h_dest, ectp_addr))
199 if (is_multicast_ether_addr(ethhdr->h_dest)) {
202 switch (atomic_read(&bat_priv->gw_mode)) {
203 case BATADV_GW_MODE_SERVER:
204 /* gateway servers should not send dhcp
205 * requests into the mesh
207 ret = batadv_gw_is_dhcp_target(skb, &header_len);
211 case BATADV_GW_MODE_CLIENT:
212 /* gateway clients should send dhcp requests
213 * via unicast to their gateway
215 ret = batadv_gw_is_dhcp_target(skb, &header_len);
219 case BATADV_GW_MODE_OFF:
225 /* ethernet packet should be broadcasted */
227 primary_if = batadv_primary_if_get_selected(bat_priv);
231 /* in case of ARP request, we do not immediately broadcasti the
232 * packet, instead we first wait for DAT to try to retrieve the
235 if (batadv_dat_snoop_outgoing_arp_request(bat_priv, skb))
236 brd_delay = msecs_to_jiffies(ARP_REQ_DELAY);
238 if (batadv_skb_head_push(skb, sizeof(*bcast_packet)) < 0)
241 bcast_packet = (struct batadv_bcast_packet *)skb->data;
242 bcast_packet->header.version = BATADV_COMPAT_VERSION;
243 bcast_packet->header.ttl = BATADV_TTL;
245 /* batman packet type: broadcast */
246 bcast_packet->header.packet_type = BATADV_BCAST;
247 bcast_packet->reserved = 0;
249 /* hw address of first interface is the orig mac because only
250 * this mac is known throughout the mesh
252 memcpy(bcast_packet->orig,
253 primary_if->net_dev->dev_addr, ETH_ALEN);
255 /* set broadcast sequence number */
256 seqno = atomic_inc_return(&bat_priv->bcast_seqno);
257 bcast_packet->seqno = htonl(seqno);
259 batadv_add_bcast_packet_to_list(bat_priv, skb, brd_delay);
261 /* a copy is stored in the bcast list, therefore removing
268 if (atomic_read(&bat_priv->gw_mode) != BATADV_GW_MODE_OFF) {
269 ret = batadv_gw_out_of_range(bat_priv, skb, ethhdr);
274 if (batadv_dat_snoop_outgoing_arp_request(bat_priv, skb))
277 batadv_dat_snoop_outgoing_arp_reply(bat_priv, skb);
279 ret = batadv_unicast_send_skb(bat_priv, skb);
284 batadv_inc_counter(bat_priv, BATADV_CNT_TX);
285 batadv_add_counter(bat_priv, BATADV_CNT_TX_BYTES, data_len);
291 batadv_inc_counter(bat_priv, BATADV_CNT_TX_DROPPED);
294 batadv_hardif_free_ref(primary_if);
298 void batadv_interface_rx(struct net_device *soft_iface,
299 struct sk_buff *skb, struct batadv_hard_iface *recv_if,
300 int hdr_size, struct batadv_orig_node *orig_node)
302 struct batadv_priv *bat_priv = netdev_priv(soft_iface);
303 struct ethhdr *ethhdr;
304 struct vlan_ethhdr *vhdr;
305 struct batadv_header *batadv_header = (struct batadv_header *)skb->data;
306 unsigned short vid __maybe_unused = BATADV_NO_FLAGS;
307 __be16 ethertype = __constant_htons(ETH_P_BATMAN);
310 is_bcast = (batadv_header->packet_type == BATADV_BCAST);
312 /* check if enough space is available for pulling, and pull */
313 if (!pskb_may_pull(skb, hdr_size))
316 skb_pull_rcsum(skb, hdr_size);
317 skb_reset_mac_header(skb);
319 ethhdr = eth_hdr(skb);
321 switch (ntohs(ethhdr->h_proto)) {
323 vhdr = (struct vlan_ethhdr *)skb->data;
324 vid = ntohs(vhdr->h_vlan_TCI) & VLAN_VID_MASK;
326 if (vhdr->h_vlan_encapsulated_proto != ethertype)
334 /* skb->dev & skb->pkt_type are set here */
335 if (unlikely(!pskb_may_pull(skb, ETH_HLEN)))
337 skb->protocol = eth_type_trans(skb, soft_iface);
339 /* should not be necessary anymore as we use skb_pull_rcsum()
340 * TODO: please verify this and remove this TODO
341 * -- Dec 21st 2009, Simon Wunderlich
344 /* skb->ip_summed = CHECKSUM_UNNECESSARY; */
346 batadv_inc_counter(bat_priv, BATADV_CNT_RX);
347 batadv_add_counter(bat_priv, BATADV_CNT_RX_BYTES,
348 skb->len + ETH_HLEN);
350 soft_iface->last_rx = jiffies;
352 /* Let the bridge loop avoidance check the packet. If will
353 * not handle it, we can safely push it up.
355 if (batadv_bla_rx(bat_priv, skb, vid, is_bcast))
359 batadv_tt_add_temporary_global_entry(bat_priv, orig_node,
362 if (batadv_is_ap_isolated(bat_priv, ethhdr->h_source, ethhdr->h_dest))
374 /* batman-adv network devices have devices nesting below it and are a special
375 * "super class" of normal network devices; split their locks off into a
376 * separate class since they always nest.
378 static struct lock_class_key batadv_netdev_xmit_lock_key;
379 static struct lock_class_key batadv_netdev_addr_lock_key;
382 * batadv_set_lockdep_class_one - Set lockdep class for a single tx queue
383 * @dev: device which owns the tx queue
384 * @txq: tx queue to modify
385 * @_unused: always NULL
387 static void batadv_set_lockdep_class_one(struct net_device *dev,
388 struct netdev_queue *txq,
391 lockdep_set_class(&txq->_xmit_lock, &batadv_netdev_xmit_lock_key);
395 * batadv_set_lockdep_class - Set txq and addr_list lockdep class
396 * @dev: network device to modify
398 static void batadv_set_lockdep_class(struct net_device *dev)
400 lockdep_set_class(&dev->addr_list_lock, &batadv_netdev_addr_lock_key);
401 netdev_for_each_tx_queue(dev, batadv_set_lockdep_class_one, NULL);
405 * batadv_softif_destroy_finish - cleans up the remains of a softif
406 * @work: work queue item
408 * Free the parts of the soft interface which can not be removed under
409 * rtnl lock (to prevent deadlock situations).
411 static void batadv_softif_destroy_finish(struct work_struct *work)
413 struct batadv_priv *bat_priv;
414 struct net_device *soft_iface;
416 bat_priv = container_of(work, struct batadv_priv,
418 soft_iface = bat_priv->soft_iface;
420 batadv_sysfs_del_meshif(soft_iface);
423 unregister_netdevice(soft_iface);
428 * batadv_softif_init_late - late stage initialization of soft interface
429 * @dev: registered network device to modify
431 * Returns error code on failures
433 static int batadv_softif_init_late(struct net_device *dev)
435 struct batadv_priv *bat_priv;
437 size_t cnt_len = sizeof(uint64_t) * BATADV_CNT_NUM;
439 batadv_set_lockdep_class(dev);
441 bat_priv = netdev_priv(dev);
442 bat_priv->soft_iface = dev;
443 INIT_WORK(&bat_priv->cleanup_work, batadv_softif_destroy_finish);
445 /* batadv_interface_stats() needs to be available as soon as
446 * register_netdevice() has been called
448 bat_priv->bat_counters = __alloc_percpu(cnt_len, __alignof__(uint64_t));
449 if (!bat_priv->bat_counters)
452 atomic_set(&bat_priv->aggregated_ogms, 1);
453 atomic_set(&bat_priv->bonding, 0);
454 #ifdef CONFIG_BATMAN_ADV_BLA
455 atomic_set(&bat_priv->bridge_loop_avoidance, 0);
457 #ifdef CONFIG_BATMAN_ADV_DAT
458 atomic_set(&bat_priv->distributed_arp_table, 1);
460 atomic_set(&bat_priv->ap_isolation, 0);
461 atomic_set(&bat_priv->vis_mode, BATADV_VIS_TYPE_CLIENT_UPDATE);
462 atomic_set(&bat_priv->gw_mode, BATADV_GW_MODE_OFF);
463 atomic_set(&bat_priv->gw_sel_class, 20);
464 atomic_set(&bat_priv->gw_bandwidth, 41);
465 atomic_set(&bat_priv->orig_interval, 1000);
466 atomic_set(&bat_priv->hop_penalty, 30);
467 #ifdef CONFIG_BATMAN_ADV_DEBUG
468 atomic_set(&bat_priv->log_level, 0);
470 atomic_set(&bat_priv->fragmentation, 1);
471 atomic_set(&bat_priv->bcast_queue_left, BATADV_BCAST_QUEUE_LEN);
472 atomic_set(&bat_priv->batman_queue_left, BATADV_BATMAN_QUEUE_LEN);
474 atomic_set(&bat_priv->mesh_state, BATADV_MESH_INACTIVE);
475 atomic_set(&bat_priv->bcast_seqno, 1);
476 atomic_set(&bat_priv->tt.vn, 0);
477 atomic_set(&bat_priv->tt.local_changes, 0);
478 atomic_set(&bat_priv->tt.ogm_append_cnt, 0);
479 #ifdef CONFIG_BATMAN_ADV_BLA
480 atomic_set(&bat_priv->bla.num_requests, 0);
482 bat_priv->tt.last_changeset = NULL;
483 bat_priv->tt.last_changeset_len = 0;
485 bat_priv->primary_if = NULL;
486 bat_priv->num_ifaces = 0;
488 batadv_nc_init_bat_priv(bat_priv);
490 ret = batadv_algo_select(bat_priv, batadv_routing_algo);
492 goto free_bat_counters;
494 ret = batadv_debugfs_add_meshif(dev);
496 goto free_bat_counters;
498 ret = batadv_mesh_init(dev);
505 batadv_debugfs_del_meshif(dev);
507 free_percpu(bat_priv->bat_counters);
508 bat_priv->bat_counters = NULL;
514 * batadv_softif_slave_add - Add a slave interface to a batadv_soft_interface
515 * @dev: batadv_soft_interface used as master interface
516 * @slave_dev: net_device which should become the slave interface
518 * Return 0 if successful or error otherwise.
520 static int batadv_softif_slave_add(struct net_device *dev,
521 struct net_device *slave_dev)
523 struct batadv_hard_iface *hard_iface;
526 hard_iface = batadv_hardif_get_by_netdev(slave_dev);
527 if (!hard_iface || hard_iface->soft_iface != NULL)
530 ret = batadv_hardif_enable_interface(hard_iface, dev->name);
534 batadv_hardif_free_ref(hard_iface);
539 * batadv_softif_slave_del - Delete a slave iface from a batadv_soft_interface
540 * @dev: batadv_soft_interface used as master interface
541 * @slave_dev: net_device which should be removed from the master interface
543 * Return 0 if successful or error otherwise.
545 static int batadv_softif_slave_del(struct net_device *dev,
546 struct net_device *slave_dev)
548 struct batadv_hard_iface *hard_iface;
551 hard_iface = batadv_hardif_get_by_netdev(slave_dev);
553 if (!hard_iface || hard_iface->soft_iface != dev)
556 batadv_hardif_disable_interface(hard_iface, BATADV_IF_CLEANUP_KEEP);
561 batadv_hardif_free_ref(hard_iface);
565 static const struct net_device_ops batadv_netdev_ops = {
566 .ndo_init = batadv_softif_init_late,
567 .ndo_open = batadv_interface_open,
568 .ndo_stop = batadv_interface_release,
569 .ndo_get_stats = batadv_interface_stats,
570 .ndo_set_mac_address = batadv_interface_set_mac_addr,
571 .ndo_change_mtu = batadv_interface_change_mtu,
572 .ndo_start_xmit = batadv_interface_tx,
573 .ndo_validate_addr = eth_validate_addr,
574 .ndo_add_slave = batadv_softif_slave_add,
575 .ndo_del_slave = batadv_softif_slave_del,
579 * batadv_softif_free - Deconstructor of batadv_soft_interface
580 * @dev: Device to cleanup and remove
582 static void batadv_softif_free(struct net_device *dev)
584 batadv_debugfs_del_meshif(dev);
585 batadv_mesh_free(dev);
587 /* some scheduled RCU callbacks need the bat_priv struct to accomplish
588 * their tasks. Wait for them all to be finished before freeing the
589 * netdev and its private data (bat_priv)
597 * batadv_softif_init_early - early stage initialization of soft interface
598 * @dev: registered network device to modify
600 static void batadv_softif_init_early(struct net_device *dev)
602 struct batadv_priv *priv = netdev_priv(dev);
606 dev->netdev_ops = &batadv_netdev_ops;
607 dev->destructor = batadv_softif_free;
608 dev->tx_queue_len = 0;
610 /* can't call min_mtu, because the needed variables
611 * have not been initialized yet
613 dev->mtu = ETH_DATA_LEN;
614 /* reserve more space in the skbuff for our header */
615 dev->hard_header_len = BATADV_HEADER_LEN;
617 /* generate random address */
618 eth_hw_addr_random(dev);
620 SET_ETHTOOL_OPS(dev, &batadv_ethtool_ops);
622 memset(priv, 0, sizeof(*priv));
625 struct net_device *batadv_softif_create(const char *name)
627 struct net_device *soft_iface;
630 soft_iface = alloc_netdev(sizeof(struct batadv_priv), name,
631 batadv_softif_init_early);
635 soft_iface->rtnl_link_ops = &batadv_link_ops;
637 ret = register_netdevice(soft_iface);
639 pr_err("Unable to register the batman interface '%s': %i\n",
641 free_netdev(soft_iface);
649 * batadv_softif_destroy_sysfs - deletion of batadv_soft_interface via sysfs
650 * @soft_iface: the to-be-removed batman-adv interface
652 void batadv_softif_destroy_sysfs(struct net_device *soft_iface)
654 struct batadv_priv *bat_priv = netdev_priv(soft_iface);
656 queue_work(batadv_event_workqueue, &bat_priv->cleanup_work);
660 * batadv_softif_destroy_netlink - deletion of batadv_soft_interface via netlink
661 * @soft_iface: the to-be-removed batman-adv interface
662 * @head: list pointer
664 static void batadv_softif_destroy_netlink(struct net_device *soft_iface,
665 struct list_head *head)
667 struct batadv_hard_iface *hard_iface;
669 list_for_each_entry(hard_iface, &batadv_hardif_list, list) {
670 if (hard_iface->soft_iface == soft_iface)
671 batadv_hardif_disable_interface(hard_iface,
672 BATADV_IF_CLEANUP_KEEP);
675 batadv_sysfs_del_meshif(soft_iface);
676 unregister_netdevice_queue(soft_iface, head);
679 int batadv_softif_is_valid(const struct net_device *net_dev)
681 if (net_dev->netdev_ops->ndo_start_xmit == batadv_interface_tx)
687 struct rtnl_link_ops batadv_link_ops __read_mostly = {
689 .priv_size = sizeof(struct batadv_priv),
690 .setup = batadv_softif_init_early,
691 .dellink = batadv_softif_destroy_netlink,
695 static int batadv_get_settings(struct net_device *dev, struct ethtool_cmd *cmd)
698 cmd->advertising = 0;
699 ethtool_cmd_speed_set(cmd, SPEED_10);
700 cmd->duplex = DUPLEX_FULL;
702 cmd->phy_address = 0;
703 cmd->transceiver = XCVR_INTERNAL;
704 cmd->autoneg = AUTONEG_DISABLE;
711 static void batadv_get_drvinfo(struct net_device *dev,
712 struct ethtool_drvinfo *info)
714 strlcpy(info->driver, "B.A.T.M.A.N. advanced", sizeof(info->driver));
715 strlcpy(info->version, BATADV_SOURCE_VERSION, sizeof(info->version));
716 strlcpy(info->fw_version, "N/A", sizeof(info->fw_version));
717 strlcpy(info->bus_info, "batman", sizeof(info->bus_info));
720 static u32 batadv_get_msglevel(struct net_device *dev)
725 static void batadv_set_msglevel(struct net_device *dev, u32 value)
729 static u32 batadv_get_link(struct net_device *dev)
734 /* Inspired by drivers/net/ethernet/dlink/sundance.c:1702
735 * Declare each description string in struct.name[] to get fixed sized buffer
736 * and compile time checking for strings longer than ETH_GSTRING_LEN.
738 static const struct {
739 const char name[ETH_GSTRING_LEN];
740 } batadv_counters_strings[] = {
754 { "tt_response_tx" },
755 { "tt_response_rx" },
756 { "tt_roam_adv_tx" },
757 { "tt_roam_adv_rx" },
758 #ifdef CONFIG_BATMAN_ADV_DAT
763 { "dat_cached_reply_tx" },
765 #ifdef CONFIG_BATMAN_ADV_NC
769 { "nc_recode_bytes" },
772 { "nc_decode_bytes" },
773 { "nc_decode_failed" },
778 static void batadv_get_strings(struct net_device *dev, uint32_t stringset,
781 if (stringset == ETH_SS_STATS)
782 memcpy(data, batadv_counters_strings,
783 sizeof(batadv_counters_strings));
786 static void batadv_get_ethtool_stats(struct net_device *dev,
787 struct ethtool_stats *stats,
790 struct batadv_priv *bat_priv = netdev_priv(dev);
793 for (i = 0; i < BATADV_CNT_NUM; i++)
794 data[i] = batadv_sum_counter(bat_priv, i);
797 static int batadv_get_sset_count(struct net_device *dev, int stringset)
799 if (stringset == ETH_SS_STATS)
800 return BATADV_CNT_NUM;