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