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 "bridge_loop_avoidance.h"
38 #include "network-coding.h"
41 static int batadv_get_settings(struct net_device *dev, struct ethtool_cmd *cmd);
42 static void batadv_get_drvinfo(struct net_device *dev,
43 struct ethtool_drvinfo *info);
44 static u32 batadv_get_msglevel(struct net_device *dev);
45 static void batadv_set_msglevel(struct net_device *dev, u32 value);
46 static u32 batadv_get_link(struct net_device *dev);
47 static void batadv_get_strings(struct net_device *dev, u32 stringset, u8 *data);
48 static void batadv_get_ethtool_stats(struct net_device *dev,
49 struct ethtool_stats *stats, u64 *data);
50 static int batadv_get_sset_count(struct net_device *dev, int stringset);
52 static const struct ethtool_ops batadv_ethtool_ops = {
53 .get_settings = batadv_get_settings,
54 .get_drvinfo = batadv_get_drvinfo,
55 .get_msglevel = batadv_get_msglevel,
56 .set_msglevel = batadv_set_msglevel,
57 .get_link = batadv_get_link,
58 .get_strings = batadv_get_strings,
59 .get_ethtool_stats = batadv_get_ethtool_stats,
60 .get_sset_count = batadv_get_sset_count,
63 int batadv_skb_head_push(struct sk_buff *skb, unsigned int len)
67 /* TODO: We must check if we can release all references to non-payload
68 * data using skb_header_release in our skbs to allow skb_cow_header to
69 * work optimally. This means that those skbs are not allowed to read
70 * or write any data which is before the current position of skb->data
71 * after that call and thus allow other skbs with the same data buffer
72 * to write freely in that area.
74 result = skb_cow_head(skb, len);
82 static int batadv_interface_open(struct net_device *dev)
84 netif_start_queue(dev);
88 static int batadv_interface_release(struct net_device *dev)
90 netif_stop_queue(dev);
94 static struct net_device_stats *batadv_interface_stats(struct net_device *dev)
96 struct batadv_priv *bat_priv = netdev_priv(dev);
97 struct net_device_stats *stats = &bat_priv->stats;
99 stats->tx_packets = batadv_sum_counter(bat_priv, BATADV_CNT_TX);
100 stats->tx_bytes = batadv_sum_counter(bat_priv, BATADV_CNT_TX_BYTES);
101 stats->tx_dropped = batadv_sum_counter(bat_priv, BATADV_CNT_TX_DROPPED);
102 stats->rx_packets = batadv_sum_counter(bat_priv, BATADV_CNT_RX);
103 stats->rx_bytes = batadv_sum_counter(bat_priv, BATADV_CNT_RX_BYTES);
107 static int batadv_interface_set_mac_addr(struct net_device *dev, void *p)
109 struct batadv_priv *bat_priv = netdev_priv(dev);
110 struct sockaddr *addr = p;
111 uint8_t old_addr[ETH_ALEN];
113 if (!is_valid_ether_addr(addr->sa_data))
114 return -EADDRNOTAVAIL;
116 memcpy(old_addr, dev->dev_addr, ETH_ALEN);
117 memcpy(dev->dev_addr, addr->sa_data, ETH_ALEN);
119 /* only modify transtable if it has been initialized before */
120 if (atomic_read(&bat_priv->mesh_state) == BATADV_MESH_ACTIVE) {
121 batadv_tt_local_remove(bat_priv, old_addr,
122 "mac address changed", false);
123 batadv_tt_local_add(dev, addr->sa_data, BATADV_NULL_IFINDEX);
129 static int batadv_interface_change_mtu(struct net_device *dev, int new_mtu)
132 if ((new_mtu < 68) || (new_mtu > batadv_hardif_min_mtu(dev)))
140 static int batadv_interface_tx(struct sk_buff *skb,
141 struct net_device *soft_iface)
143 struct ethhdr *ethhdr = (struct ethhdr *)skb->data;
144 struct batadv_priv *bat_priv = netdev_priv(soft_iface);
145 struct batadv_hard_iface *primary_if = NULL;
146 struct batadv_bcast_packet *bcast_packet;
147 struct vlan_ethhdr *vhdr;
148 __be16 ethertype = __constant_htons(ETH_P_BATMAN);
149 static const uint8_t stp_addr[ETH_ALEN] = {0x01, 0x80, 0xC2, 0x00,
151 static const uint8_t ectp_addr[ETH_ALEN] = {0xCF, 0x00, 0x00, 0x00,
153 unsigned int header_len = 0;
154 int data_len = skb->len, ret;
155 unsigned short vid __maybe_unused = BATADV_NO_FLAGS;
156 bool do_bcast = false;
158 unsigned long brd_delay = 1;
160 if (atomic_read(&bat_priv->mesh_state) != BATADV_MESH_ACTIVE)
163 soft_iface->trans_start = jiffies;
165 switch (ntohs(ethhdr->h_proto)) {
167 vhdr = (struct vlan_ethhdr *)skb->data;
168 vid = ntohs(vhdr->h_vlan_TCI) & VLAN_VID_MASK;
169 vid |= BATADV_VLAN_HAS_TAG;
171 if (vhdr->h_vlan_encapsulated_proto != ethertype)
179 if (batadv_bla_tx(bat_priv, skb, vid))
182 /* skb->data might have been reallocated by batadv_bla_tx() */
183 ethhdr = (struct ethhdr *)skb->data;
185 /* Register the client MAC in the transtable */
186 if (!is_multicast_ether_addr(ethhdr->h_source))
187 batadv_tt_local_add(soft_iface, ethhdr->h_source, skb->skb_iif);
189 /* don't accept stp packets. STP does not help in meshes.
190 * better use the bridge loop avoidance ...
192 * The same goes for ECTP sent at least by some Cisco Switches,
193 * it might confuse the mesh when used with bridge loop avoidance.
195 if (batadv_compare_eth(ethhdr->h_dest, stp_addr))
198 if (batadv_compare_eth(ethhdr->h_dest, ectp_addr))
201 if (is_multicast_ether_addr(ethhdr->h_dest)) {
204 switch (atomic_read(&bat_priv->gw_mode)) {
205 case BATADV_GW_MODE_SERVER:
206 /* gateway servers should not send dhcp
207 * requests into the mesh
209 ret = batadv_gw_is_dhcp_target(skb, &header_len);
213 case BATADV_GW_MODE_CLIENT:
214 /* gateway clients should send dhcp requests
215 * via unicast to their gateway
217 ret = batadv_gw_is_dhcp_target(skb, &header_len);
221 case BATADV_GW_MODE_OFF:
226 /* reminder: ethhdr might have become unusable from here on
227 * (batadv_gw_is_dhcp_target() might have reallocated skb data)
231 batadv_skb_set_priority(skb, 0);
233 /* ethernet packet should be broadcasted */
235 primary_if = batadv_primary_if_get_selected(bat_priv);
239 /* in case of ARP request, we do not immediately broadcasti the
240 * packet, instead we first wait for DAT to try to retrieve the
243 if (batadv_dat_snoop_outgoing_arp_request(bat_priv, skb))
244 brd_delay = msecs_to_jiffies(ARP_REQ_DELAY);
246 if (batadv_skb_head_push(skb, sizeof(*bcast_packet)) < 0)
249 bcast_packet = (struct batadv_bcast_packet *)skb->data;
250 bcast_packet->header.version = BATADV_COMPAT_VERSION;
251 bcast_packet->header.ttl = BATADV_TTL;
253 /* batman packet type: broadcast */
254 bcast_packet->header.packet_type = BATADV_BCAST;
255 bcast_packet->reserved = 0;
257 /* hw address of first interface is the orig mac because only
258 * this mac is known throughout the mesh
260 memcpy(bcast_packet->orig,
261 primary_if->net_dev->dev_addr, ETH_ALEN);
263 /* set broadcast sequence number */
264 seqno = atomic_inc_return(&bat_priv->bcast_seqno);
265 bcast_packet->seqno = htonl(seqno);
267 batadv_add_bcast_packet_to_list(bat_priv, skb, brd_delay);
269 /* a copy is stored in the bcast list, therefore removing
276 if (atomic_read(&bat_priv->gw_mode) != BATADV_GW_MODE_OFF) {
277 ret = batadv_gw_out_of_range(bat_priv, skb);
282 if (batadv_dat_snoop_outgoing_arp_request(bat_priv, skb))
285 batadv_dat_snoop_outgoing_arp_reply(bat_priv, skb);
287 ret = batadv_send_skb_unicast(bat_priv, skb);
292 batadv_inc_counter(bat_priv, BATADV_CNT_TX);
293 batadv_add_counter(bat_priv, BATADV_CNT_TX_BYTES, data_len);
299 batadv_inc_counter(bat_priv, BATADV_CNT_TX_DROPPED);
302 batadv_hardif_free_ref(primary_if);
306 void batadv_interface_rx(struct net_device *soft_iface,
307 struct sk_buff *skb, struct batadv_hard_iface *recv_if,
308 int hdr_size, struct batadv_orig_node *orig_node)
310 struct batadv_priv *bat_priv = netdev_priv(soft_iface);
311 struct ethhdr *ethhdr;
312 struct vlan_ethhdr *vhdr;
313 struct batadv_header *batadv_header = (struct batadv_header *)skb->data;
314 unsigned short vid __maybe_unused = BATADV_NO_FLAGS;
315 __be16 ethertype = __constant_htons(ETH_P_BATMAN);
318 is_bcast = (batadv_header->packet_type == BATADV_BCAST);
320 /* check if enough space is available for pulling, and pull */
321 if (!pskb_may_pull(skb, hdr_size))
324 skb_pull_rcsum(skb, hdr_size);
325 skb_reset_mac_header(skb);
327 ethhdr = eth_hdr(skb);
329 switch (ntohs(ethhdr->h_proto)) {
331 vhdr = (struct vlan_ethhdr *)skb->data;
332 vid = ntohs(vhdr->h_vlan_TCI) & VLAN_VID_MASK;
333 vid |= BATADV_VLAN_HAS_TAG;
335 if (vhdr->h_vlan_encapsulated_proto != ethertype)
343 /* skb->dev & skb->pkt_type are set here */
344 if (unlikely(!pskb_may_pull(skb, ETH_HLEN)))
346 skb->protocol = eth_type_trans(skb, soft_iface);
348 /* should not be necessary anymore as we use skb_pull_rcsum()
349 * TODO: please verify this and remove this TODO
350 * -- Dec 21st 2009, Simon Wunderlich
353 /* skb->ip_summed = CHECKSUM_UNNECESSARY; */
355 batadv_inc_counter(bat_priv, BATADV_CNT_RX);
356 batadv_add_counter(bat_priv, BATADV_CNT_RX_BYTES,
357 skb->len + ETH_HLEN);
359 soft_iface->last_rx = jiffies;
361 /* Let the bridge loop avoidance check the packet. If will
362 * not handle it, we can safely push it up.
364 if (batadv_bla_rx(bat_priv, skb, vid, is_bcast))
368 batadv_tt_add_temporary_global_entry(bat_priv, orig_node,
371 if (batadv_is_ap_isolated(bat_priv, ethhdr->h_source, ethhdr->h_dest))
383 /* batman-adv network devices have devices nesting below it and are a special
384 * "super class" of normal network devices; split their locks off into a
385 * separate class since they always nest.
387 static struct lock_class_key batadv_netdev_xmit_lock_key;
388 static struct lock_class_key batadv_netdev_addr_lock_key;
391 * batadv_set_lockdep_class_one - Set lockdep class for a single tx queue
392 * @dev: device which owns the tx queue
393 * @txq: tx queue to modify
394 * @_unused: always NULL
396 static void batadv_set_lockdep_class_one(struct net_device *dev,
397 struct netdev_queue *txq,
400 lockdep_set_class(&txq->_xmit_lock, &batadv_netdev_xmit_lock_key);
404 * batadv_set_lockdep_class - Set txq and addr_list lockdep class
405 * @dev: network device to modify
407 static void batadv_set_lockdep_class(struct net_device *dev)
409 lockdep_set_class(&dev->addr_list_lock, &batadv_netdev_addr_lock_key);
410 netdev_for_each_tx_queue(dev, batadv_set_lockdep_class_one, NULL);
414 * batadv_softif_destroy_finish - cleans up the remains of a softif
415 * @work: work queue item
417 * Free the parts of the soft interface which can not be removed under
418 * rtnl lock (to prevent deadlock situations).
420 static void batadv_softif_destroy_finish(struct work_struct *work)
422 struct batadv_priv *bat_priv;
423 struct net_device *soft_iface;
425 bat_priv = container_of(work, struct batadv_priv,
427 soft_iface = bat_priv->soft_iface;
429 batadv_sysfs_del_meshif(soft_iface);
432 unregister_netdevice(soft_iface);
437 * batadv_softif_init_late - late stage initialization of soft interface
438 * @dev: registered network device to modify
440 * Returns error code on failures
442 static int batadv_softif_init_late(struct net_device *dev)
444 struct batadv_priv *bat_priv;
446 size_t cnt_len = sizeof(uint64_t) * BATADV_CNT_NUM;
448 batadv_set_lockdep_class(dev);
450 bat_priv = netdev_priv(dev);
451 bat_priv->soft_iface = dev;
452 INIT_WORK(&bat_priv->cleanup_work, batadv_softif_destroy_finish);
454 /* batadv_interface_stats() needs to be available as soon as
455 * register_netdevice() has been called
457 bat_priv->bat_counters = __alloc_percpu(cnt_len, __alignof__(uint64_t));
458 if (!bat_priv->bat_counters)
461 atomic_set(&bat_priv->aggregated_ogms, 1);
462 atomic_set(&bat_priv->bonding, 0);
463 #ifdef CONFIG_BATMAN_ADV_BLA
464 atomic_set(&bat_priv->bridge_loop_avoidance, 0);
466 #ifdef CONFIG_BATMAN_ADV_DAT
467 atomic_set(&bat_priv->distributed_arp_table, 1);
469 atomic_set(&bat_priv->ap_isolation, 0);
470 atomic_set(&bat_priv->gw_mode, BATADV_GW_MODE_OFF);
471 atomic_set(&bat_priv->gw_sel_class, 20);
472 atomic_set(&bat_priv->gw.bandwidth_down, 100);
473 atomic_set(&bat_priv->gw.bandwidth_up, 20);
474 atomic_set(&bat_priv->orig_interval, 1000);
475 atomic_set(&bat_priv->hop_penalty, 30);
476 #ifdef CONFIG_BATMAN_ADV_DEBUG
477 atomic_set(&bat_priv->log_level, 0);
479 atomic_set(&bat_priv->fragmentation, 1);
480 atomic_set(&bat_priv->bcast_queue_left, BATADV_BCAST_QUEUE_LEN);
481 atomic_set(&bat_priv->batman_queue_left, BATADV_BATMAN_QUEUE_LEN);
483 atomic_set(&bat_priv->mesh_state, BATADV_MESH_INACTIVE);
484 atomic_set(&bat_priv->bcast_seqno, 1);
485 atomic_set(&bat_priv->tt.vn, 0);
486 atomic_set(&bat_priv->tt.local_changes, 0);
487 atomic_set(&bat_priv->tt.ogm_append_cnt, 0);
488 #ifdef CONFIG_BATMAN_ADV_BLA
489 atomic_set(&bat_priv->bla.num_requests, 0);
491 bat_priv->tt.last_changeset = NULL;
492 bat_priv->tt.last_changeset_len = 0;
494 bat_priv->primary_if = NULL;
495 bat_priv->num_ifaces = 0;
497 batadv_nc_init_bat_priv(bat_priv);
499 ret = batadv_algo_select(bat_priv, batadv_routing_algo);
501 goto free_bat_counters;
503 ret = batadv_debugfs_add_meshif(dev);
505 goto free_bat_counters;
507 ret = batadv_mesh_init(dev);
514 batadv_debugfs_del_meshif(dev);
516 free_percpu(bat_priv->bat_counters);
517 bat_priv->bat_counters = NULL;
523 * batadv_softif_slave_add - Add a slave interface to a batadv_soft_interface
524 * @dev: batadv_soft_interface used as master interface
525 * @slave_dev: net_device which should become the slave interface
527 * Return 0 if successful or error otherwise.
529 static int batadv_softif_slave_add(struct net_device *dev,
530 struct net_device *slave_dev)
532 struct batadv_hard_iface *hard_iface;
535 hard_iface = batadv_hardif_get_by_netdev(slave_dev);
536 if (!hard_iface || hard_iface->soft_iface != NULL)
539 ret = batadv_hardif_enable_interface(hard_iface, dev->name);
543 batadv_hardif_free_ref(hard_iface);
548 * batadv_softif_slave_del - Delete a slave iface from a batadv_soft_interface
549 * @dev: batadv_soft_interface used as master interface
550 * @slave_dev: net_device which should be removed from the master interface
552 * Return 0 if successful or error otherwise.
554 static int batadv_softif_slave_del(struct net_device *dev,
555 struct net_device *slave_dev)
557 struct batadv_hard_iface *hard_iface;
560 hard_iface = batadv_hardif_get_by_netdev(slave_dev);
562 if (!hard_iface || hard_iface->soft_iface != dev)
565 batadv_hardif_disable_interface(hard_iface, BATADV_IF_CLEANUP_KEEP);
570 batadv_hardif_free_ref(hard_iface);
574 static const struct net_device_ops batadv_netdev_ops = {
575 .ndo_init = batadv_softif_init_late,
576 .ndo_open = batadv_interface_open,
577 .ndo_stop = batadv_interface_release,
578 .ndo_get_stats = batadv_interface_stats,
579 .ndo_set_mac_address = batadv_interface_set_mac_addr,
580 .ndo_change_mtu = batadv_interface_change_mtu,
581 .ndo_start_xmit = batadv_interface_tx,
582 .ndo_validate_addr = eth_validate_addr,
583 .ndo_add_slave = batadv_softif_slave_add,
584 .ndo_del_slave = batadv_softif_slave_del,
588 * batadv_softif_free - Deconstructor of batadv_soft_interface
589 * @dev: Device to cleanup and remove
591 static void batadv_softif_free(struct net_device *dev)
593 batadv_debugfs_del_meshif(dev);
594 batadv_mesh_free(dev);
596 /* some scheduled RCU callbacks need the bat_priv struct to accomplish
597 * their tasks. Wait for them all to be finished before freeing the
598 * netdev and its private data (bat_priv)
606 * batadv_softif_init_early - early stage initialization of soft interface
607 * @dev: registered network device to modify
609 static void batadv_softif_init_early(struct net_device *dev)
611 struct batadv_priv *priv = netdev_priv(dev);
615 dev->netdev_ops = &batadv_netdev_ops;
616 dev->destructor = batadv_softif_free;
617 dev->tx_queue_len = 0;
619 /* can't call min_mtu, because the needed variables
620 * have not been initialized yet
622 dev->mtu = ETH_DATA_LEN;
623 /* reserve more space in the skbuff for our header */
624 dev->hard_header_len = BATADV_HEADER_LEN;
626 /* generate random address */
627 eth_hw_addr_random(dev);
629 SET_ETHTOOL_OPS(dev, &batadv_ethtool_ops);
631 memset(priv, 0, sizeof(*priv));
634 struct net_device *batadv_softif_create(const char *name)
636 struct net_device *soft_iface;
639 soft_iface = alloc_netdev(sizeof(struct batadv_priv), name,
640 batadv_softif_init_early);
644 soft_iface->rtnl_link_ops = &batadv_link_ops;
646 ret = register_netdevice(soft_iface);
648 pr_err("Unable to register the batman interface '%s': %i\n",
650 free_netdev(soft_iface);
658 * batadv_softif_destroy_sysfs - deletion of batadv_soft_interface via sysfs
659 * @soft_iface: the to-be-removed batman-adv interface
661 void batadv_softif_destroy_sysfs(struct net_device *soft_iface)
663 struct batadv_priv *bat_priv = netdev_priv(soft_iface);
665 queue_work(batadv_event_workqueue, &bat_priv->cleanup_work);
669 * batadv_softif_destroy_netlink - deletion of batadv_soft_interface via netlink
670 * @soft_iface: the to-be-removed batman-adv interface
671 * @head: list pointer
673 static void batadv_softif_destroy_netlink(struct net_device *soft_iface,
674 struct list_head *head)
676 struct batadv_hard_iface *hard_iface;
678 list_for_each_entry(hard_iface, &batadv_hardif_list, list) {
679 if (hard_iface->soft_iface == soft_iface)
680 batadv_hardif_disable_interface(hard_iface,
681 BATADV_IF_CLEANUP_KEEP);
684 batadv_sysfs_del_meshif(soft_iface);
685 unregister_netdevice_queue(soft_iface, head);
688 int batadv_softif_is_valid(const struct net_device *net_dev)
690 if (net_dev->netdev_ops->ndo_start_xmit == batadv_interface_tx)
696 struct rtnl_link_ops batadv_link_ops __read_mostly = {
698 .priv_size = sizeof(struct batadv_priv),
699 .setup = batadv_softif_init_early,
700 .dellink = batadv_softif_destroy_netlink,
704 static int batadv_get_settings(struct net_device *dev, struct ethtool_cmd *cmd)
707 cmd->advertising = 0;
708 ethtool_cmd_speed_set(cmd, SPEED_10);
709 cmd->duplex = DUPLEX_FULL;
711 cmd->phy_address = 0;
712 cmd->transceiver = XCVR_INTERNAL;
713 cmd->autoneg = AUTONEG_DISABLE;
720 static void batadv_get_drvinfo(struct net_device *dev,
721 struct ethtool_drvinfo *info)
723 strlcpy(info->driver, "B.A.T.M.A.N. advanced", sizeof(info->driver));
724 strlcpy(info->version, BATADV_SOURCE_VERSION, sizeof(info->version));
725 strlcpy(info->fw_version, "N/A", sizeof(info->fw_version));
726 strlcpy(info->bus_info, "batman", sizeof(info->bus_info));
729 static u32 batadv_get_msglevel(struct net_device *dev)
734 static void batadv_set_msglevel(struct net_device *dev, u32 value)
738 static u32 batadv_get_link(struct net_device *dev)
743 /* Inspired by drivers/net/ethernet/dlink/sundance.c:1702
744 * Declare each description string in struct.name[] to get fixed sized buffer
745 * and compile time checking for strings longer than ETH_GSTRING_LEN.
747 static const struct {
748 const char name[ETH_GSTRING_LEN];
749 } batadv_counters_strings[] = {
764 { "frag_fwd_bytes" },
767 { "tt_response_tx" },
768 { "tt_response_rx" },
769 { "tt_roam_adv_tx" },
770 { "tt_roam_adv_rx" },
771 #ifdef CONFIG_BATMAN_ADV_DAT
776 { "dat_cached_reply_tx" },
778 #ifdef CONFIG_BATMAN_ADV_NC
782 { "nc_recode_bytes" },
785 { "nc_decode_bytes" },
786 { "nc_decode_failed" },
791 static void batadv_get_strings(struct net_device *dev, uint32_t stringset,
794 if (stringset == ETH_SS_STATS)
795 memcpy(data, batadv_counters_strings,
796 sizeof(batadv_counters_strings));
799 static void batadv_get_ethtool_stats(struct net_device *dev,
800 struct ethtool_stats *stats,
803 struct batadv_priv *bat_priv = netdev_priv(dev);
806 for (i = 0; i < BATADV_CNT_NUM; i++)
807 data[i] = batadv_sum_counter(bat_priv, i);
810 static int batadv_get_sset_count(struct net_device *dev, int stringset)
812 if (stringset == ETH_SS_STATS)
813 return BATADV_CNT_NUM;