1/* Copyright (C) 2007-2014 B.A.T.M.A.N. contributors:
2 *
3 * Marek Lindner, Simon Wunderlich
4 *
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.
8 *
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.
13 *
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/>.
16 */
17
18#include "main.h"
19#include "soft-interface.h"
20#include "hard-interface.h"
21#include "distributed-arp-table.h"
22#include "routing.h"
23#include "send.h"
24#include "debugfs.h"
25#include "translation-table.h"
26#include "hash.h"
27#include "gateway_common.h"
28#include "gateway_client.h"
29#include "sysfs.h"
30#include "originator.h"
31#include <linux/slab.h>
32#include <linux/ethtool.h>
33#include <linux/etherdevice.h>
34#include <linux/if_vlan.h>
35#include "multicast.h"
36#include "bridge_loop_avoidance.h"
37#include "network-coding.h"
38
39static int batadv_get_settings(struct net_device *dev, struct ethtool_cmd *cmd);
40static void batadv_get_drvinfo(struct net_device *dev,
41			       struct ethtool_drvinfo *info);
42static u32 batadv_get_msglevel(struct net_device *dev);
43static void batadv_set_msglevel(struct net_device *dev, u32 value);
44static u32 batadv_get_link(struct net_device *dev);
45static void batadv_get_strings(struct net_device *dev, u32 stringset, u8 *data);
46static void batadv_get_ethtool_stats(struct net_device *dev,
47				     struct ethtool_stats *stats, u64 *data);
48static int batadv_get_sset_count(struct net_device *dev, int stringset);
49
50static const struct ethtool_ops batadv_ethtool_ops = {
51	.get_settings = batadv_get_settings,
52	.get_drvinfo = batadv_get_drvinfo,
53	.get_msglevel = batadv_get_msglevel,
54	.set_msglevel = batadv_set_msglevel,
55	.get_link = batadv_get_link,
56	.get_strings = batadv_get_strings,
57	.get_ethtool_stats = batadv_get_ethtool_stats,
58	.get_sset_count = batadv_get_sset_count,
59};
60
61int batadv_skb_head_push(struct sk_buff *skb, unsigned int len)
62{
63	int result;
64
65	/* TODO: We must check if we can release all references to non-payload
66	 * data using skb_header_release in our skbs to allow skb_cow_header to
67	 * work optimally. This means that those skbs are not allowed to read
68	 * or write any data which is before the current position of skb->data
69	 * after that call and thus allow other skbs with the same data buffer
70	 * to write freely in that area.
71	 */
72	result = skb_cow_head(skb, len);
73	if (result < 0)
74		return result;
75
76	skb_push(skb, len);
77	return 0;
78}
79
80static int batadv_interface_open(struct net_device *dev)
81{
82	netif_start_queue(dev);
83	return 0;
84}
85
86static int batadv_interface_release(struct net_device *dev)
87{
88	netif_stop_queue(dev);
89	return 0;
90}
91
92static struct net_device_stats *batadv_interface_stats(struct net_device *dev)
93{
94	struct batadv_priv *bat_priv = netdev_priv(dev);
95	struct net_device_stats *stats = &bat_priv->stats;
96
97	stats->tx_packets = batadv_sum_counter(bat_priv, BATADV_CNT_TX);
98	stats->tx_bytes = batadv_sum_counter(bat_priv, BATADV_CNT_TX_BYTES);
99	stats->tx_dropped = batadv_sum_counter(bat_priv, BATADV_CNT_TX_DROPPED);
100	stats->rx_packets = batadv_sum_counter(bat_priv, BATADV_CNT_RX);
101	stats->rx_bytes = batadv_sum_counter(bat_priv, BATADV_CNT_RX_BYTES);
102	return stats;
103}
104
105static int batadv_interface_set_mac_addr(struct net_device *dev, void *p)
106{
107	struct batadv_priv *bat_priv = netdev_priv(dev);
108	struct sockaddr *addr = p;
109	uint8_t old_addr[ETH_ALEN];
110
111	if (!is_valid_ether_addr(addr->sa_data))
112		return -EADDRNOTAVAIL;
113
114	ether_addr_copy(old_addr, dev->dev_addr);
115	ether_addr_copy(dev->dev_addr, addr->sa_data);
116
117	/* only modify transtable if it has been initialized before */
118	if (atomic_read(&bat_priv->mesh_state) == BATADV_MESH_ACTIVE) {
119		batadv_tt_local_remove(bat_priv, old_addr, BATADV_NO_FLAGS,
120				       "mac address changed", false);
121		batadv_tt_local_add(dev, addr->sa_data, BATADV_NO_FLAGS,
122				    BATADV_NULL_IFINDEX, BATADV_NO_MARK);
123	}
124
125	return 0;
126}
127
128static int batadv_interface_change_mtu(struct net_device *dev, int new_mtu)
129{
130	/* check ranges */
131	if ((new_mtu < 68) || (new_mtu > batadv_hardif_min_mtu(dev)))
132		return -EINVAL;
133
134	dev->mtu = new_mtu;
135
136	return 0;
137}
138
139/**
140 * batadv_interface_set_rx_mode - set the rx mode of a device
141 * @dev: registered network device to modify
142 *
143 * We do not actually need to set any rx filters for the virtual batman
144 * soft interface. However a dummy handler enables a user to set static
145 * multicast listeners for instance.
146 */
147static void batadv_interface_set_rx_mode(struct net_device *dev)
148{
149}
150
151static int batadv_interface_tx(struct sk_buff *skb,
152			       struct net_device *soft_iface)
153{
154	struct ethhdr *ethhdr;
155	struct batadv_priv *bat_priv = netdev_priv(soft_iface);
156	struct batadv_hard_iface *primary_if = NULL;
157	struct batadv_bcast_packet *bcast_packet;
158	__be16 ethertype = htons(ETH_P_BATMAN);
159	static const uint8_t stp_addr[ETH_ALEN] = {0x01, 0x80, 0xC2, 0x00,
160						   0x00, 0x00};
161	static const uint8_t ectp_addr[ETH_ALEN] = {0xCF, 0x00, 0x00, 0x00,
162						    0x00, 0x00};
163	enum batadv_dhcp_recipient dhcp_rcp = BATADV_DHCP_NO;
164	uint8_t *dst_hint = NULL, chaddr[ETH_ALEN];
165	struct vlan_ethhdr *vhdr;
166	unsigned int header_len = 0;
167	int data_len = skb->len, ret;
168	unsigned long brd_delay = 1;
169	bool do_bcast = false, client_added;
170	unsigned short vid;
171	uint32_t seqno;
172	int gw_mode;
173	enum batadv_forw_mode forw_mode;
174	struct batadv_orig_node *mcast_single_orig = NULL;
175	int network_offset = ETH_HLEN;
176
177	if (atomic_read(&bat_priv->mesh_state) != BATADV_MESH_ACTIVE)
178		goto dropped;
179
180	soft_iface->trans_start = jiffies;
181	vid = batadv_get_vid(skb, 0);
182	ethhdr = eth_hdr(skb);
183
184	switch (ntohs(ethhdr->h_proto)) {
185	case ETH_P_8021Q:
186		vhdr = vlan_eth_hdr(skb);
187
188		if (vhdr->h_vlan_encapsulated_proto != ethertype) {
189			network_offset += VLAN_HLEN;
190			break;
191		}
192
193		/* fall through */
194	case ETH_P_BATMAN:
195		goto dropped;
196	}
197
198	skb_set_network_header(skb, network_offset);
199
200	if (batadv_bla_tx(bat_priv, skb, vid))
201		goto dropped;
202
203	/* skb->data might have been reallocated by batadv_bla_tx() */
204	ethhdr = eth_hdr(skb);
205
206	/* Register the client MAC in the transtable */
207	if (!is_multicast_ether_addr(ethhdr->h_source)) {
208		client_added = batadv_tt_local_add(soft_iface, ethhdr->h_source,
209						   vid, skb->skb_iif,
210						   skb->mark);
211		if (!client_added)
212			goto dropped;
213	}
214
215	/* don't accept stp packets. STP does not help in meshes.
216	 * better use the bridge loop avoidance ...
217	 *
218	 * The same goes for ECTP sent at least by some Cisco Switches,
219	 * it might confuse the mesh when used with bridge loop avoidance.
220	 */
221	if (batadv_compare_eth(ethhdr->h_dest, stp_addr))
222		goto dropped;
223
224	if (batadv_compare_eth(ethhdr->h_dest, ectp_addr))
225		goto dropped;
226
227	gw_mode = atomic_read(&bat_priv->gw_mode);
228	if (is_multicast_ether_addr(ethhdr->h_dest)) {
229		/* if gw mode is off, broadcast every packet */
230		if (gw_mode == BATADV_GW_MODE_OFF) {
231			do_bcast = true;
232			goto send;
233		}
234
235		dhcp_rcp = batadv_gw_dhcp_recipient_get(skb, &header_len,
236							chaddr);
237		/* skb->data may have been modified by
238		 * batadv_gw_dhcp_recipient_get()
239		 */
240		ethhdr = eth_hdr(skb);
241		/* if gw_mode is on, broadcast any non-DHCP message.
242		 * All the DHCP packets are going to be sent as unicast
243		 */
244		if (dhcp_rcp == BATADV_DHCP_NO) {
245			do_bcast = true;
246			goto send;
247		}
248
249		if (dhcp_rcp == BATADV_DHCP_TO_CLIENT)
250			dst_hint = chaddr;
251		else if ((gw_mode == BATADV_GW_MODE_SERVER) &&
252			 (dhcp_rcp == BATADV_DHCP_TO_SERVER))
253			/* gateways should not forward any DHCP message if
254			 * directed to a DHCP server
255			 */
256			goto dropped;
257
258send:
259		if (do_bcast && !is_broadcast_ether_addr(ethhdr->h_dest)) {
260			forw_mode = batadv_mcast_forw_mode(bat_priv, skb,
261							   &mcast_single_orig);
262			if (forw_mode == BATADV_FORW_NONE)
263				goto dropped;
264
265			if (forw_mode == BATADV_FORW_SINGLE)
266				do_bcast = false;
267		}
268	}
269
270	batadv_skb_set_priority(skb, 0);
271
272	/* ethernet packet should be broadcasted */
273	if (do_bcast) {
274		primary_if = batadv_primary_if_get_selected(bat_priv);
275		if (!primary_if)
276			goto dropped;
277
278		/* in case of ARP request, we do not immediately broadcasti the
279		 * packet, instead we first wait for DAT to try to retrieve the
280		 * correct ARP entry
281		 */
282		if (batadv_dat_snoop_outgoing_arp_request(bat_priv, skb))
283			brd_delay = msecs_to_jiffies(ARP_REQ_DELAY);
284
285		if (batadv_skb_head_push(skb, sizeof(*bcast_packet)) < 0)
286			goto dropped;
287
288		bcast_packet = (struct batadv_bcast_packet *)skb->data;
289		bcast_packet->version = BATADV_COMPAT_VERSION;
290		bcast_packet->ttl = BATADV_TTL;
291
292		/* batman packet type: broadcast */
293		bcast_packet->packet_type = BATADV_BCAST;
294		bcast_packet->reserved = 0;
295
296		/* hw address of first interface is the orig mac because only
297		 * this mac is known throughout the mesh
298		 */
299		ether_addr_copy(bcast_packet->orig,
300				primary_if->net_dev->dev_addr);
301
302		/* set broadcast sequence number */
303		seqno = atomic_inc_return(&bat_priv->bcast_seqno);
304		bcast_packet->seqno = htonl(seqno);
305
306		batadv_add_bcast_packet_to_list(bat_priv, skb, brd_delay);
307
308		/* a copy is stored in the bcast list, therefore removing
309		 * the original skb.
310		 */
311		kfree_skb(skb);
312
313	/* unicast packet */
314	} else {
315		/* DHCP packets going to a server will use the GW feature */
316		if (dhcp_rcp == BATADV_DHCP_TO_SERVER) {
317			ret = batadv_gw_out_of_range(bat_priv, skb);
318			if (ret)
319				goto dropped;
320			ret = batadv_send_skb_via_gw(bat_priv, skb, vid);
321		} else if (mcast_single_orig) {
322			ret = batadv_send_skb_unicast(bat_priv, skb,
323						      BATADV_UNICAST, 0,
324						      mcast_single_orig, vid);
325		} else {
326			if (batadv_dat_snoop_outgoing_arp_request(bat_priv,
327								  skb))
328				goto dropped;
329
330			batadv_dat_snoop_outgoing_arp_reply(bat_priv, skb);
331
332			ret = batadv_send_skb_via_tt(bat_priv, skb, dst_hint,
333						     vid);
334		}
335		if (ret == NET_XMIT_DROP)
336			goto dropped_freed;
337	}
338
339	batadv_inc_counter(bat_priv, BATADV_CNT_TX);
340	batadv_add_counter(bat_priv, BATADV_CNT_TX_BYTES, data_len);
341	goto end;
342
343dropped:
344	kfree_skb(skb);
345dropped_freed:
346	batadv_inc_counter(bat_priv, BATADV_CNT_TX_DROPPED);
347end:
348	if (primary_if)
349		batadv_hardif_free_ref(primary_if);
350	return NETDEV_TX_OK;
351}
352
353void batadv_interface_rx(struct net_device *soft_iface,
354			 struct sk_buff *skb, struct batadv_hard_iface *recv_if,
355			 int hdr_size, struct batadv_orig_node *orig_node)
356{
357	struct batadv_bcast_packet *batadv_bcast_packet;
358	struct batadv_priv *bat_priv = netdev_priv(soft_iface);
359	__be16 ethertype = htons(ETH_P_BATMAN);
360	struct vlan_ethhdr *vhdr;
361	struct ethhdr *ethhdr;
362	unsigned short vid;
363	bool is_bcast;
364
365	batadv_bcast_packet = (struct batadv_bcast_packet *)skb->data;
366	is_bcast = (batadv_bcast_packet->packet_type == BATADV_BCAST);
367
368	/* check if enough space is available for pulling, and pull */
369	if (!pskb_may_pull(skb, hdr_size))
370		goto dropped;
371
372	skb_pull_rcsum(skb, hdr_size);
373	skb_reset_mac_header(skb);
374
375	/* clean the netfilter state now that the batman-adv header has been
376	 * removed
377	 */
378	nf_reset(skb);
379
380	vid = batadv_get_vid(skb, 0);
381	ethhdr = eth_hdr(skb);
382
383	switch (ntohs(ethhdr->h_proto)) {
384	case ETH_P_8021Q:
385		vhdr = (struct vlan_ethhdr *)skb->data;
386
387		if (vhdr->h_vlan_encapsulated_proto != ethertype)
388			break;
389
390		/* fall through */
391	case ETH_P_BATMAN:
392		goto dropped;
393	}
394
395	/* skb->dev & skb->pkt_type are set here */
396	if (unlikely(!pskb_may_pull(skb, ETH_HLEN)))
397		goto dropped;
398	skb->protocol = eth_type_trans(skb, soft_iface);
399
400	/* should not be necessary anymore as we use skb_pull_rcsum()
401	 * TODO: please verify this and remove this TODO
402	 * -- Dec 21st 2009, Simon Wunderlich
403	 */
404
405	/* skb->ip_summed = CHECKSUM_UNNECESSARY; */
406
407	batadv_inc_counter(bat_priv, BATADV_CNT_RX);
408	batadv_add_counter(bat_priv, BATADV_CNT_RX_BYTES,
409			   skb->len + ETH_HLEN);
410
411	soft_iface->last_rx = jiffies;
412
413	/* Let the bridge loop avoidance check the packet. If will
414	 * not handle it, we can safely push it up.
415	 */
416	if (batadv_bla_rx(bat_priv, skb, vid, is_bcast))
417		goto out;
418
419	if (orig_node)
420		batadv_tt_add_temporary_global_entry(bat_priv, orig_node,
421						     ethhdr->h_source, vid);
422
423	if (is_multicast_ether_addr(ethhdr->h_dest)) {
424		/* set the mark on broadcast packets if AP isolation is ON and
425		 * the packet is coming from an "isolated" client
426		 */
427		if (batadv_vlan_ap_isola_get(bat_priv, vid) &&
428		    batadv_tt_global_is_isolated(bat_priv, ethhdr->h_source,
429						 vid)) {
430			/* save bits in skb->mark not covered by the mask and
431			 * apply the mark on the rest
432			 */
433			skb->mark &= ~bat_priv->isolation_mark_mask;
434			skb->mark |= bat_priv->isolation_mark;
435		}
436	} else if (batadv_is_ap_isolated(bat_priv, ethhdr->h_source,
437					 ethhdr->h_dest, vid)) {
438		goto dropped;
439	}
440
441	netif_rx(skb);
442	goto out;
443
444dropped:
445	kfree_skb(skb);
446out:
447	return;
448}
449
450/**
451 * batadv_softif_vlan_free_ref - decrease the vlan object refcounter and
452 *  possibly free it
453 * @softif_vlan: the vlan object to release
454 */
455void batadv_softif_vlan_free_ref(struct batadv_softif_vlan *vlan)
456{
457	if (!vlan)
458		return;
459
460	if (atomic_dec_and_test(&vlan->refcount)) {
461		spin_lock_bh(&vlan->bat_priv->softif_vlan_list_lock);
462		hlist_del_rcu(&vlan->list);
463		spin_unlock_bh(&vlan->bat_priv->softif_vlan_list_lock);
464
465		kfree_rcu(vlan, rcu);
466	}
467}
468
469/**
470 * batadv_softif_vlan_get - get the vlan object for a specific vid
471 * @bat_priv: the bat priv with all the soft interface information
472 * @vid: the identifier of the vlan object to retrieve
473 *
474 * Returns the private data of the vlan matching the vid passed as argument or
475 * NULL otherwise. The refcounter of the returned object is incremented by 1.
476 */
477struct batadv_softif_vlan *batadv_softif_vlan_get(struct batadv_priv *bat_priv,
478						  unsigned short vid)
479{
480	struct batadv_softif_vlan *vlan_tmp, *vlan = NULL;
481
482	rcu_read_lock();
483	hlist_for_each_entry_rcu(vlan_tmp, &bat_priv->softif_vlan_list, list) {
484		if (vlan_tmp->vid != vid)
485			continue;
486
487		if (!atomic_inc_not_zero(&vlan_tmp->refcount))
488			continue;
489
490		vlan = vlan_tmp;
491		break;
492	}
493	rcu_read_unlock();
494
495	return vlan;
496}
497
498/**
499 * batadv_create_vlan - allocate the needed resources for a new vlan
500 * @bat_priv: the bat priv with all the soft interface information
501 * @vid: the VLAN identifier
502 *
503 * Returns 0 on success, a negative error otherwise.
504 */
505int batadv_softif_create_vlan(struct batadv_priv *bat_priv, unsigned short vid)
506{
507	struct batadv_softif_vlan *vlan;
508	int err;
509
510	vlan = batadv_softif_vlan_get(bat_priv, vid);
511	if (vlan) {
512		batadv_softif_vlan_free_ref(vlan);
513		return -EEXIST;
514	}
515
516	vlan = kzalloc(sizeof(*vlan), GFP_ATOMIC);
517	if (!vlan)
518		return -ENOMEM;
519
520	vlan->bat_priv = bat_priv;
521	vlan->vid = vid;
522	atomic_set(&vlan->refcount, 1);
523
524	atomic_set(&vlan->ap_isolation, 0);
525
526	err = batadv_sysfs_add_vlan(bat_priv->soft_iface, vlan);
527	if (err) {
528		kfree(vlan);
529		return err;
530	}
531
532	spin_lock_bh(&bat_priv->softif_vlan_list_lock);
533	hlist_add_head_rcu(&vlan->list, &bat_priv->softif_vlan_list);
534	spin_unlock_bh(&bat_priv->softif_vlan_list_lock);
535
536	/* add a new TT local entry. This one will be marked with the NOPURGE
537	 * flag
538	 */
539	batadv_tt_local_add(bat_priv->soft_iface,
540			    bat_priv->soft_iface->dev_addr, vid,
541			    BATADV_NULL_IFINDEX, BATADV_NO_MARK);
542
543	return 0;
544}
545
546/**
547 * batadv_softif_destroy_vlan - remove and destroy a softif_vlan object
548 * @bat_priv: the bat priv with all the soft interface information
549 * @vlan: the object to remove
550 */
551static void batadv_softif_destroy_vlan(struct batadv_priv *bat_priv,
552				       struct batadv_softif_vlan *vlan)
553{
554	/* explicitly remove the associated TT local entry because it is marked
555	 * with the NOPURGE flag
556	 */
557	batadv_tt_local_remove(bat_priv, bat_priv->soft_iface->dev_addr,
558			       vlan->vid, "vlan interface destroyed", false);
559
560	batadv_sysfs_del_vlan(bat_priv, vlan);
561	batadv_softif_vlan_free_ref(vlan);
562}
563
564/**
565 * batadv_interface_add_vid - ndo_add_vid API implementation
566 * @dev: the netdev of the mesh interface
567 * @vid: identifier of the new vlan
568 *
569 * Set up all the internal structures for handling the new vlan on top of the
570 * mesh interface
571 *
572 * Returns 0 on success or a negative error code in case of failure.
573 */
574static int batadv_interface_add_vid(struct net_device *dev, __be16 proto,
575				    unsigned short vid)
576{
577	struct batadv_priv *bat_priv = netdev_priv(dev);
578	struct batadv_softif_vlan *vlan;
579	int ret;
580
581	/* only 802.1Q vlans are supported.
582	 * batman-adv does not know how to handle other types
583	 */
584	if (proto != htons(ETH_P_8021Q))
585		return -EINVAL;
586
587	vid |= BATADV_VLAN_HAS_TAG;
588
589	/* if a new vlan is getting created and it already exists, it means that
590	 * it was not deleted yet. batadv_softif_vlan_get() increases the
591	 * refcount in order to revive the object.
592	 *
593	 * if it does not exist then create it.
594	 */
595	vlan = batadv_softif_vlan_get(bat_priv, vid);
596	if (!vlan)
597		return batadv_softif_create_vlan(bat_priv, vid);
598
599	/* recreate the sysfs object if it was already destroyed (and it should
600	 * be since we received a kill_vid() for this vlan
601	 */
602	if (!vlan->kobj) {
603		ret = batadv_sysfs_add_vlan(bat_priv->soft_iface, vlan);
604		if (ret) {
605			batadv_softif_vlan_free_ref(vlan);
606			return ret;
607		}
608	}
609
610	/* add a new TT local entry. This one will be marked with the NOPURGE
611	 * flag. This must be added again, even if the vlan object already
612	 * exists, because the entry was deleted by kill_vid()
613	 */
614	batadv_tt_local_add(bat_priv->soft_iface,
615			    bat_priv->soft_iface->dev_addr, vid,
616			    BATADV_NULL_IFINDEX, BATADV_NO_MARK);
617
618	return 0;
619}
620
621/**
622 * batadv_interface_kill_vid - ndo_kill_vid API implementation
623 * @dev: the netdev of the mesh interface
624 * @vid: identifier of the deleted vlan
625 *
626 * Destroy all the internal structures used to handle the vlan identified by vid
627 * on top of the mesh interface
628 *
629 * Returns 0 on success, -EINVAL if the specified prototype is not ETH_P_8021Q
630 * or -ENOENT if the specified vlan id wasn't registered.
631 */
632static int batadv_interface_kill_vid(struct net_device *dev, __be16 proto,
633				     unsigned short vid)
634{
635	struct batadv_priv *bat_priv = netdev_priv(dev);
636	struct batadv_softif_vlan *vlan;
637
638	/* only 802.1Q vlans are supported. batman-adv does not know how to
639	 * handle other types
640	 */
641	if (proto != htons(ETH_P_8021Q))
642		return -EINVAL;
643
644	vlan = batadv_softif_vlan_get(bat_priv, vid | BATADV_VLAN_HAS_TAG);
645	if (!vlan)
646		return -ENOENT;
647
648	batadv_softif_destroy_vlan(bat_priv, vlan);
649
650	/* finally free the vlan object */
651	batadv_softif_vlan_free_ref(vlan);
652
653	return 0;
654}
655
656/* batman-adv network devices have devices nesting below it and are a special
657 * "super class" of normal network devices; split their locks off into a
658 * separate class since they always nest.
659 */
660static struct lock_class_key batadv_netdev_xmit_lock_key;
661static struct lock_class_key batadv_netdev_addr_lock_key;
662
663/**
664 * batadv_set_lockdep_class_one - Set lockdep class for a single tx queue
665 * @dev: device which owns the tx queue
666 * @txq: tx queue to modify
667 * @_unused: always NULL
668 */
669static void batadv_set_lockdep_class_one(struct net_device *dev,
670					 struct netdev_queue *txq,
671					 void *_unused)
672{
673	lockdep_set_class(&txq->_xmit_lock, &batadv_netdev_xmit_lock_key);
674}
675
676/**
677 * batadv_set_lockdep_class - Set txq and addr_list lockdep class
678 * @dev: network device to modify
679 */
680static void batadv_set_lockdep_class(struct net_device *dev)
681{
682	lockdep_set_class(&dev->addr_list_lock, &batadv_netdev_addr_lock_key);
683	netdev_for_each_tx_queue(dev, batadv_set_lockdep_class_one, NULL);
684}
685
686/**
687 * batadv_softif_destroy_finish - cleans up the remains of a softif
688 * @work: work queue item
689 *
690 * Free the parts of the soft interface which can not be removed under
691 * rtnl lock (to prevent deadlock situations).
692 */
693static void batadv_softif_destroy_finish(struct work_struct *work)
694{
695	struct batadv_softif_vlan *vlan;
696	struct batadv_priv *bat_priv;
697	struct net_device *soft_iface;
698
699	bat_priv = container_of(work, struct batadv_priv,
700				cleanup_work);
701	soft_iface = bat_priv->soft_iface;
702
703	/* destroy the "untagged" VLAN */
704	vlan = batadv_softif_vlan_get(bat_priv, BATADV_NO_FLAGS);
705	if (vlan) {
706		batadv_softif_destroy_vlan(bat_priv, vlan);
707		batadv_softif_vlan_free_ref(vlan);
708	}
709
710	batadv_sysfs_del_meshif(soft_iface);
711	unregister_netdev(soft_iface);
712}
713
714/**
715 * batadv_softif_init_late - late stage initialization of soft interface
716 * @dev: registered network device to modify
717 *
718 * Returns error code on failures
719 */
720static int batadv_softif_init_late(struct net_device *dev)
721{
722	struct batadv_priv *bat_priv;
723	uint32_t random_seqno;
724	int ret;
725	size_t cnt_len = sizeof(uint64_t) * BATADV_CNT_NUM;
726
727	batadv_set_lockdep_class(dev);
728
729	bat_priv = netdev_priv(dev);
730	bat_priv->soft_iface = dev;
731	INIT_WORK(&bat_priv->cleanup_work, batadv_softif_destroy_finish);
732
733	/* batadv_interface_stats() needs to be available as soon as
734	 * register_netdevice() has been called
735	 */
736	bat_priv->bat_counters = __alloc_percpu(cnt_len, __alignof__(uint64_t));
737	if (!bat_priv->bat_counters)
738		return -ENOMEM;
739
740	atomic_set(&bat_priv->aggregated_ogms, 1);
741	atomic_set(&bat_priv->bonding, 0);
742#ifdef CONFIG_BATMAN_ADV_BLA
743	atomic_set(&bat_priv->bridge_loop_avoidance, 0);
744#endif
745#ifdef CONFIG_BATMAN_ADV_DAT
746	atomic_set(&bat_priv->distributed_arp_table, 1);
747#endif
748#ifdef CONFIG_BATMAN_ADV_MCAST
749	bat_priv->mcast.flags = BATADV_NO_FLAGS;
750	atomic_set(&bat_priv->multicast_mode, 1);
751	atomic_set(&bat_priv->mcast.num_disabled, 0);
752	atomic_set(&bat_priv->mcast.num_want_all_unsnoopables, 0);
753	atomic_set(&bat_priv->mcast.num_want_all_ipv4, 0);
754	atomic_set(&bat_priv->mcast.num_want_all_ipv6, 0);
755#endif
756	atomic_set(&bat_priv->gw_mode, BATADV_GW_MODE_OFF);
757	atomic_set(&bat_priv->gw_sel_class, 20);
758	atomic_set(&bat_priv->gw.bandwidth_down, 100);
759	atomic_set(&bat_priv->gw.bandwidth_up, 20);
760	atomic_set(&bat_priv->orig_interval, 1000);
761	atomic_set(&bat_priv->hop_penalty, 30);
762#ifdef CONFIG_BATMAN_ADV_DEBUG
763	atomic_set(&bat_priv->log_level, 0);
764#endif
765	atomic_set(&bat_priv->fragmentation, 1);
766	atomic_set(&bat_priv->packet_size_max, ETH_DATA_LEN);
767	atomic_set(&bat_priv->bcast_queue_left, BATADV_BCAST_QUEUE_LEN);
768	atomic_set(&bat_priv->batman_queue_left, BATADV_BATMAN_QUEUE_LEN);
769
770	atomic_set(&bat_priv->mesh_state, BATADV_MESH_INACTIVE);
771	atomic_set(&bat_priv->bcast_seqno, 1);
772	atomic_set(&bat_priv->tt.vn, 0);
773	atomic_set(&bat_priv->tt.local_changes, 0);
774	atomic_set(&bat_priv->tt.ogm_append_cnt, 0);
775#ifdef CONFIG_BATMAN_ADV_BLA
776	atomic_set(&bat_priv->bla.num_requests, 0);
777#endif
778	bat_priv->tt.last_changeset = NULL;
779	bat_priv->tt.last_changeset_len = 0;
780	bat_priv->isolation_mark = 0;
781	bat_priv->isolation_mark_mask = 0;
782
783	/* randomize initial seqno to avoid collision */
784	get_random_bytes(&random_seqno, sizeof(random_seqno));
785	atomic_set(&bat_priv->frag_seqno, random_seqno);
786
787	bat_priv->primary_if = NULL;
788	bat_priv->num_ifaces = 0;
789
790	batadv_nc_init_bat_priv(bat_priv);
791
792	ret = batadv_algo_select(bat_priv, batadv_routing_algo);
793	if (ret < 0)
794		goto free_bat_counters;
795
796	ret = batadv_debugfs_add_meshif(dev);
797	if (ret < 0)
798		goto free_bat_counters;
799
800	ret = batadv_mesh_init(dev);
801	if (ret < 0)
802		goto unreg_debugfs;
803
804	return 0;
805
806unreg_debugfs:
807	batadv_debugfs_del_meshif(dev);
808free_bat_counters:
809	free_percpu(bat_priv->bat_counters);
810	bat_priv->bat_counters = NULL;
811
812	return ret;
813}
814
815/**
816 * batadv_softif_slave_add - Add a slave interface to a batadv_soft_interface
817 * @dev: batadv_soft_interface used as master interface
818 * @slave_dev: net_device which should become the slave interface
819 *
820 * Return 0 if successful or error otherwise.
821 */
822static int batadv_softif_slave_add(struct net_device *dev,
823				   struct net_device *slave_dev)
824{
825	struct batadv_hard_iface *hard_iface;
826	int ret = -EINVAL;
827
828	hard_iface = batadv_hardif_get_by_netdev(slave_dev);
829	if (!hard_iface || hard_iface->soft_iface != NULL)
830		goto out;
831
832	ret = batadv_hardif_enable_interface(hard_iface, dev->name);
833
834out:
835	if (hard_iface)
836		batadv_hardif_free_ref(hard_iface);
837	return ret;
838}
839
840/**
841 * batadv_softif_slave_del - Delete a slave iface from a batadv_soft_interface
842 * @dev: batadv_soft_interface used as master interface
843 * @slave_dev: net_device which should be removed from the master interface
844 *
845 * Return 0 if successful or error otherwise.
846 */
847static int batadv_softif_slave_del(struct net_device *dev,
848				   struct net_device *slave_dev)
849{
850	struct batadv_hard_iface *hard_iface;
851	int ret = -EINVAL;
852
853	hard_iface = batadv_hardif_get_by_netdev(slave_dev);
854
855	if (!hard_iface || hard_iface->soft_iface != dev)
856		goto out;
857
858	batadv_hardif_disable_interface(hard_iface, BATADV_IF_CLEANUP_KEEP);
859	ret = 0;
860
861out:
862	if (hard_iface)
863		batadv_hardif_free_ref(hard_iface);
864	return ret;
865}
866
867static const struct net_device_ops batadv_netdev_ops = {
868	.ndo_init = batadv_softif_init_late,
869	.ndo_open = batadv_interface_open,
870	.ndo_stop = batadv_interface_release,
871	.ndo_get_stats = batadv_interface_stats,
872	.ndo_vlan_rx_add_vid = batadv_interface_add_vid,
873	.ndo_vlan_rx_kill_vid = batadv_interface_kill_vid,
874	.ndo_set_mac_address = batadv_interface_set_mac_addr,
875	.ndo_change_mtu = batadv_interface_change_mtu,
876	.ndo_set_rx_mode = batadv_interface_set_rx_mode,
877	.ndo_start_xmit = batadv_interface_tx,
878	.ndo_validate_addr = eth_validate_addr,
879	.ndo_add_slave = batadv_softif_slave_add,
880	.ndo_del_slave = batadv_softif_slave_del,
881};
882
883/**
884 * batadv_softif_free - Deconstructor of batadv_soft_interface
885 * @dev: Device to cleanup and remove
886 */
887static void batadv_softif_free(struct net_device *dev)
888{
889	batadv_debugfs_del_meshif(dev);
890	batadv_mesh_free(dev);
891
892	/* some scheduled RCU callbacks need the bat_priv struct to accomplish
893	 * their tasks. Wait for them all to be finished before freeing the
894	 * netdev and its private data (bat_priv)
895	 */
896	rcu_barrier();
897
898	free_netdev(dev);
899}
900
901/**
902 * batadv_softif_init_early - early stage initialization of soft interface
903 * @dev: registered network device to modify
904 */
905static void batadv_softif_init_early(struct net_device *dev)
906{
907	struct batadv_priv *priv = netdev_priv(dev);
908
909	ether_setup(dev);
910
911	dev->netdev_ops = &batadv_netdev_ops;
912	dev->destructor = batadv_softif_free;
913	dev->features |= NETIF_F_HW_VLAN_CTAG_FILTER;
914	dev->tx_queue_len = 0;
915
916	/* can't call min_mtu, because the needed variables
917	 * have not been initialized yet
918	 */
919	dev->mtu = ETH_DATA_LEN;
920	/* reserve more space in the skbuff for our header */
921	dev->hard_header_len = batadv_max_header_len();
922
923	/* generate random address */
924	eth_hw_addr_random(dev);
925
926	dev->ethtool_ops = &batadv_ethtool_ops;
927
928	memset(priv, 0, sizeof(*priv));
929}
930
931struct net_device *batadv_softif_create(const char *name)
932{
933	struct net_device *soft_iface;
934	int ret;
935
936	soft_iface = alloc_netdev(sizeof(struct batadv_priv), name,
937				  NET_NAME_UNKNOWN, batadv_softif_init_early);
938	if (!soft_iface)
939		return NULL;
940
941	soft_iface->rtnl_link_ops = &batadv_link_ops;
942
943	ret = register_netdevice(soft_iface);
944	if (ret < 0) {
945		pr_err("Unable to register the batman interface '%s': %i\n",
946		       name, ret);
947		free_netdev(soft_iface);
948		return NULL;
949	}
950
951	return soft_iface;
952}
953
954/**
955 * batadv_softif_destroy_sysfs - deletion of batadv_soft_interface via sysfs
956 * @soft_iface: the to-be-removed batman-adv interface
957 */
958void batadv_softif_destroy_sysfs(struct net_device *soft_iface)
959{
960	struct batadv_priv *bat_priv = netdev_priv(soft_iface);
961
962	queue_work(batadv_event_workqueue, &bat_priv->cleanup_work);
963}
964
965/**
966 * batadv_softif_destroy_netlink - deletion of batadv_soft_interface via netlink
967 * @soft_iface: the to-be-removed batman-adv interface
968 * @head: list pointer
969 */
970static void batadv_softif_destroy_netlink(struct net_device *soft_iface,
971					  struct list_head *head)
972{
973	struct batadv_hard_iface *hard_iface;
974
975	list_for_each_entry(hard_iface, &batadv_hardif_list, list) {
976		if (hard_iface->soft_iface == soft_iface)
977			batadv_hardif_disable_interface(hard_iface,
978							BATADV_IF_CLEANUP_KEEP);
979	}
980
981	batadv_sysfs_del_meshif(soft_iface);
982	unregister_netdevice_queue(soft_iface, head);
983}
984
985int batadv_softif_is_valid(const struct net_device *net_dev)
986{
987	if (net_dev->netdev_ops->ndo_start_xmit == batadv_interface_tx)
988		return 1;
989
990	return 0;
991}
992
993struct rtnl_link_ops batadv_link_ops __read_mostly = {
994	.kind		= "batadv",
995	.priv_size	= sizeof(struct batadv_priv),
996	.setup		= batadv_softif_init_early,
997	.dellink	= batadv_softif_destroy_netlink,
998};
999
1000/* ethtool */
1001static int batadv_get_settings(struct net_device *dev, struct ethtool_cmd *cmd)
1002{
1003	cmd->supported = 0;
1004	cmd->advertising = 0;
1005	ethtool_cmd_speed_set(cmd, SPEED_10);
1006	cmd->duplex = DUPLEX_FULL;
1007	cmd->port = PORT_TP;
1008	cmd->phy_address = 0;
1009	cmd->transceiver = XCVR_INTERNAL;
1010	cmd->autoneg = AUTONEG_DISABLE;
1011	cmd->maxtxpkt = 0;
1012	cmd->maxrxpkt = 0;
1013
1014	return 0;
1015}
1016
1017static void batadv_get_drvinfo(struct net_device *dev,
1018			       struct ethtool_drvinfo *info)
1019{
1020	strlcpy(info->driver, "B.A.T.M.A.N. advanced", sizeof(info->driver));
1021	strlcpy(info->version, BATADV_SOURCE_VERSION, sizeof(info->version));
1022	strlcpy(info->fw_version, "N/A", sizeof(info->fw_version));
1023	strlcpy(info->bus_info, "batman", sizeof(info->bus_info));
1024}
1025
1026static u32 batadv_get_msglevel(struct net_device *dev)
1027{
1028	return -EOPNOTSUPP;
1029}
1030
1031static void batadv_set_msglevel(struct net_device *dev, u32 value)
1032{
1033}
1034
1035static u32 batadv_get_link(struct net_device *dev)
1036{
1037	return 1;
1038}
1039
1040/* Inspired by drivers/net/ethernet/dlink/sundance.c:1702
1041 * Declare each description string in struct.name[] to get fixed sized buffer
1042 * and compile time checking for strings longer than ETH_GSTRING_LEN.
1043 */
1044static const struct {
1045	const char name[ETH_GSTRING_LEN];
1046} batadv_counters_strings[] = {
1047	{ "tx" },
1048	{ "tx_bytes" },
1049	{ "tx_dropped" },
1050	{ "rx" },
1051	{ "rx_bytes" },
1052	{ "forward" },
1053	{ "forward_bytes" },
1054	{ "mgmt_tx" },
1055	{ "mgmt_tx_bytes" },
1056	{ "mgmt_rx" },
1057	{ "mgmt_rx_bytes" },
1058	{ "frag_tx" },
1059	{ "frag_tx_bytes" },
1060	{ "frag_rx" },
1061	{ "frag_rx_bytes" },
1062	{ "frag_fwd" },
1063	{ "frag_fwd_bytes" },
1064	{ "tt_request_tx" },
1065	{ "tt_request_rx" },
1066	{ "tt_response_tx" },
1067	{ "tt_response_rx" },
1068	{ "tt_roam_adv_tx" },
1069	{ "tt_roam_adv_rx" },
1070#ifdef CONFIG_BATMAN_ADV_DAT
1071	{ "dat_get_tx" },
1072	{ "dat_get_rx" },
1073	{ "dat_put_tx" },
1074	{ "dat_put_rx" },
1075	{ "dat_cached_reply_tx" },
1076#endif
1077#ifdef CONFIG_BATMAN_ADV_NC
1078	{ "nc_code" },
1079	{ "nc_code_bytes" },
1080	{ "nc_recode" },
1081	{ "nc_recode_bytes" },
1082	{ "nc_buffer" },
1083	{ "nc_decode" },
1084	{ "nc_decode_bytes" },
1085	{ "nc_decode_failed" },
1086	{ "nc_sniffed" },
1087#endif
1088};
1089
1090static void batadv_get_strings(struct net_device *dev, uint32_t stringset,
1091			       uint8_t *data)
1092{
1093	if (stringset == ETH_SS_STATS)
1094		memcpy(data, batadv_counters_strings,
1095		       sizeof(batadv_counters_strings));
1096}
1097
1098static void batadv_get_ethtool_stats(struct net_device *dev,
1099				     struct ethtool_stats *stats,
1100				     uint64_t *data)
1101{
1102	struct batadv_priv *bat_priv = netdev_priv(dev);
1103	int i;
1104
1105	for (i = 0; i < BATADV_CNT_NUM; i++)
1106		data[i] = batadv_sum_counter(bat_priv, i);
1107}
1108
1109static int batadv_get_sset_count(struct net_device *dev, int stringset)
1110{
1111	if (stringset == ETH_SS_STATS)
1112		return BATADV_CNT_NUM;
1113
1114	return -EOPNOTSUPP;
1115}
1116