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