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