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