1 // SPDX-License-Identifier: GPL-2.0
2 /* Copyright (C) 2007-2018 B.A.T.M.A.N. contributors:
4 * Marek Lindner, Simon Wunderlich
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of version 2 of the GNU General Public
8 * License as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, see <http://www.gnu.org/licenses/>.
21 #include <linux/atomic.h>
22 #include <linux/build_bug.h>
23 #include <linux/byteorder/generic.h>
24 #include <linux/crc32c.h>
25 #include <linux/errno.h>
26 #include <linux/genetlink.h>
27 #include <linux/gfp.h>
28 #include <linux/if_ether.h>
29 #include <linux/if_vlan.h>
30 #include <linux/init.h>
32 #include <linux/ipv6.h>
33 #include <linux/kernel.h>
34 #include <linux/kref.h>
35 #include <linux/list.h>
36 #include <linux/module.h>
37 #include <linux/netdevice.h>
38 #include <linux/printk.h>
39 #include <linux/rculist.h>
40 #include <linux/rcupdate.h>
41 #include <linux/seq_file.h>
42 #include <linux/skbuff.h>
43 #include <linux/spinlock.h>
44 #include <linux/stddef.h>
45 #include <linux/string.h>
46 #include <linux/workqueue.h>
47 #include <net/dsfield.h>
48 #include <net/rtnetlink.h>
49 #include <uapi/linux/batadv_packet.h>
50 #include <uapi/linux/batman_adv.h>
53 #include "bat_iv_ogm.h"
55 #include "bridge_loop_avoidance.h"
57 #include "distributed-arp-table.h"
58 #include "gateway_client.h"
59 #include "gateway_common.h"
60 #include "hard-interface.h"
61 #include "icmp_socket.h"
63 #include "multicast.h"
65 #include "network-coding.h"
66 #include "originator.h"
69 #include "soft-interface.h"
71 #include "translation-table.h"
73 /* List manipulations on hardif_list have to be rtnl_lock()'ed,
74 * list traversals just rcu-locked
76 struct list_head batadv_hardif_list;
77 static int (*batadv_rx_handler[256])(struct sk_buff *skb,
78 struct batadv_hard_iface *recv_if);
80 unsigned char batadv_broadcast_addr[] = {0xff, 0xff, 0xff, 0xff, 0xff, 0xff};
82 struct workqueue_struct *batadv_event_workqueue;
84 static void batadv_recv_handler_init(void);
86 static int __init batadv_init(void)
90 ret = batadv_tt_cache_init();
94 INIT_LIST_HEAD(&batadv_hardif_list);
97 batadv_recv_handler_init();
102 batadv_tp_meter_init();
104 batadv_event_workqueue = create_singlethread_workqueue("bat_events");
105 if (!batadv_event_workqueue)
108 batadv_socket_init();
109 batadv_debugfs_init();
111 register_netdevice_notifier(&batadv_hard_if_notifier);
112 rtnl_link_register(&batadv_link_ops);
113 batadv_netlink_register();
115 pr_info("B.A.T.M.A.N. advanced %s (compatibility version %i) loaded\n",
116 BATADV_SOURCE_VERSION, BATADV_COMPAT_VERSION);
121 batadv_tt_cache_destroy();
126 static void __exit batadv_exit(void)
128 batadv_debugfs_destroy();
129 batadv_netlink_unregister();
130 rtnl_link_unregister(&batadv_link_ops);
131 unregister_netdevice_notifier(&batadv_hard_if_notifier);
132 batadv_hardif_remove_interfaces();
134 flush_workqueue(batadv_event_workqueue);
135 destroy_workqueue(batadv_event_workqueue);
136 batadv_event_workqueue = NULL;
140 batadv_tt_cache_destroy();
144 * batadv_mesh_init() - Initialize soft interface
145 * @soft_iface: netdev struct of the soft interface
147 * Return: 0 on success or negative error number in case of failure
149 int batadv_mesh_init(struct net_device *soft_iface)
151 struct batadv_priv *bat_priv = netdev_priv(soft_iface);
154 spin_lock_init(&bat_priv->forw_bat_list_lock);
155 spin_lock_init(&bat_priv->forw_bcast_list_lock);
156 spin_lock_init(&bat_priv->tt.changes_list_lock);
157 spin_lock_init(&bat_priv->tt.req_list_lock);
158 spin_lock_init(&bat_priv->tt.roam_list_lock);
159 spin_lock_init(&bat_priv->tt.last_changeset_lock);
160 spin_lock_init(&bat_priv->tt.commit_lock);
161 spin_lock_init(&bat_priv->gw.list_lock);
162 #ifdef CONFIG_BATMAN_ADV_MCAST
163 spin_lock_init(&bat_priv->mcast.mla_lock);
164 spin_lock_init(&bat_priv->mcast.want_lists_lock);
166 spin_lock_init(&bat_priv->tvlv.container_list_lock);
167 spin_lock_init(&bat_priv->tvlv.handler_list_lock);
168 spin_lock_init(&bat_priv->softif_vlan_list_lock);
169 spin_lock_init(&bat_priv->tp_list_lock);
171 INIT_HLIST_HEAD(&bat_priv->forw_bat_list);
172 INIT_HLIST_HEAD(&bat_priv->forw_bcast_list);
173 INIT_HLIST_HEAD(&bat_priv->gw.gateway_list);
174 #ifdef CONFIG_BATMAN_ADV_MCAST
175 INIT_HLIST_HEAD(&bat_priv->mcast.want_all_unsnoopables_list);
176 INIT_HLIST_HEAD(&bat_priv->mcast.want_all_ipv4_list);
177 INIT_HLIST_HEAD(&bat_priv->mcast.want_all_ipv6_list);
179 INIT_LIST_HEAD(&bat_priv->tt.changes_list);
180 INIT_HLIST_HEAD(&bat_priv->tt.req_list);
181 INIT_LIST_HEAD(&bat_priv->tt.roam_list);
182 #ifdef CONFIG_BATMAN_ADV_MCAST
183 INIT_HLIST_HEAD(&bat_priv->mcast.mla_list);
185 INIT_HLIST_HEAD(&bat_priv->tvlv.container_list);
186 INIT_HLIST_HEAD(&bat_priv->tvlv.handler_list);
187 INIT_HLIST_HEAD(&bat_priv->softif_vlan_list);
188 INIT_HLIST_HEAD(&bat_priv->tp_list);
190 ret = batadv_originator_init(bat_priv);
192 atomic_set(&bat_priv->mesh_state, BATADV_MESH_DEACTIVATING);
196 ret = batadv_tt_init(bat_priv);
198 atomic_set(&bat_priv->mesh_state, BATADV_MESH_DEACTIVATING);
202 ret = batadv_v_mesh_init(bat_priv);
204 atomic_set(&bat_priv->mesh_state, BATADV_MESH_DEACTIVATING);
208 ret = batadv_bla_init(bat_priv);
210 atomic_set(&bat_priv->mesh_state, BATADV_MESH_DEACTIVATING);
214 ret = batadv_dat_init(bat_priv);
216 atomic_set(&bat_priv->mesh_state, BATADV_MESH_DEACTIVATING);
220 ret = batadv_nc_mesh_init(bat_priv);
222 atomic_set(&bat_priv->mesh_state, BATADV_MESH_DEACTIVATING);
226 batadv_gw_init(bat_priv);
227 batadv_mcast_init(bat_priv);
229 atomic_set(&bat_priv->gw.reselect, 0);
230 atomic_set(&bat_priv->mesh_state, BATADV_MESH_ACTIVE);
235 batadv_dat_free(bat_priv);
237 batadv_bla_free(bat_priv);
239 batadv_v_mesh_free(bat_priv);
241 batadv_tt_free(bat_priv);
243 batadv_originator_free(bat_priv);
245 batadv_purge_outstanding_packets(bat_priv, NULL);
246 atomic_set(&bat_priv->mesh_state, BATADV_MESH_INACTIVE);
252 * batadv_mesh_free() - Deinitialize soft interface
253 * @soft_iface: netdev struct of the soft interface
255 void batadv_mesh_free(struct net_device *soft_iface)
257 struct batadv_priv *bat_priv = netdev_priv(soft_iface);
259 atomic_set(&bat_priv->mesh_state, BATADV_MESH_DEACTIVATING);
261 batadv_purge_outstanding_packets(bat_priv, NULL);
263 batadv_gw_node_free(bat_priv);
265 batadv_v_mesh_free(bat_priv);
266 batadv_nc_mesh_free(bat_priv);
267 batadv_dat_free(bat_priv);
268 batadv_bla_free(bat_priv);
270 batadv_mcast_free(bat_priv);
272 /* Free the TT and the originator tables only after having terminated
273 * all the other depending components which may use these structures for
276 batadv_tt_free(bat_priv);
278 /* Since the originator table clean up routine is accessing the TT
279 * tables as well, it has to be invoked after the TT tables have been
280 * freed and marked as empty. This ensures that no cleanup RCU callbacks
281 * accessing the TT data are scheduled for later execution.
283 batadv_originator_free(bat_priv);
285 batadv_gw_free(bat_priv);
287 free_percpu(bat_priv->bat_counters);
288 bat_priv->bat_counters = NULL;
290 atomic_set(&bat_priv->mesh_state, BATADV_MESH_INACTIVE);
294 * batadv_is_my_mac() - check if the given mac address belongs to any of the
295 * real interfaces in the current mesh
296 * @bat_priv: the bat priv with all the soft interface information
297 * @addr: the address to check
299 * Return: 'true' if the mac address was found, false otherwise.
301 bool batadv_is_my_mac(struct batadv_priv *bat_priv, const u8 *addr)
303 const struct batadv_hard_iface *hard_iface;
304 bool is_my_mac = false;
307 list_for_each_entry_rcu(hard_iface, &batadv_hardif_list, list) {
308 if (hard_iface->if_status != BATADV_IF_ACTIVE)
311 if (hard_iface->soft_iface != bat_priv->soft_iface)
314 if (batadv_compare_eth(hard_iface->net_dev->dev_addr, addr)) {
323 #ifdef CONFIG_BATMAN_ADV_DEBUGFS
325 * batadv_seq_print_text_primary_if_get() - called from debugfs table printing
326 * function that requires the primary interface
327 * @seq: debugfs table seq_file struct
329 * Return: primary interface if found or NULL otherwise.
331 struct batadv_hard_iface *
332 batadv_seq_print_text_primary_if_get(struct seq_file *seq)
334 struct net_device *net_dev = (struct net_device *)seq->private;
335 struct batadv_priv *bat_priv = netdev_priv(net_dev);
336 struct batadv_hard_iface *primary_if;
338 primary_if = batadv_primary_if_get_selected(bat_priv);
342 "BATMAN mesh %s disabled - please specify interfaces to enable it\n",
347 if (primary_if->if_status == BATADV_IF_ACTIVE)
351 "BATMAN mesh %s disabled - primary interface not active\n",
353 batadv_hardif_put(primary_if);
362 * batadv_max_header_len() - calculate maximum encapsulation overhead for a
365 * Return: the maximum encapsulation overhead in bytes.
367 int batadv_max_header_len(void)
371 header_len = max_t(int, header_len,
372 sizeof(struct batadv_unicast_packet));
373 header_len = max_t(int, header_len,
374 sizeof(struct batadv_unicast_4addr_packet));
375 header_len = max_t(int, header_len,
376 sizeof(struct batadv_bcast_packet));
378 #ifdef CONFIG_BATMAN_ADV_NC
379 header_len = max_t(int, header_len,
380 sizeof(struct batadv_coded_packet));
383 return header_len + ETH_HLEN;
387 * batadv_skb_set_priority() - sets skb priority according to packet content
388 * @skb: the packet to be sent
389 * @offset: offset to the packet content
391 * This function sets a value between 256 and 263 (802.1d priority), which
392 * can be interpreted by the cfg80211 or other drivers.
394 void batadv_skb_set_priority(struct sk_buff *skb, int offset)
396 struct iphdr ip_hdr_tmp, *ip_hdr;
397 struct ipv6hdr ip6_hdr_tmp, *ip6_hdr;
398 struct ethhdr ethhdr_tmp, *ethhdr;
399 struct vlan_ethhdr *vhdr, vhdr_tmp;
402 /* already set, do nothing */
403 if (skb->priority >= 256 && skb->priority <= 263)
406 ethhdr = skb_header_pointer(skb, offset, sizeof(*ethhdr), ðhdr_tmp);
410 switch (ethhdr->h_proto) {
411 case htons(ETH_P_8021Q):
412 vhdr = skb_header_pointer(skb, offset + sizeof(*vhdr),
413 sizeof(*vhdr), &vhdr_tmp);
416 prio = ntohs(vhdr->h_vlan_TCI) & VLAN_PRIO_MASK;
417 prio = prio >> VLAN_PRIO_SHIFT;
419 case htons(ETH_P_IP):
420 ip_hdr = skb_header_pointer(skb, offset + sizeof(*ethhdr),
421 sizeof(*ip_hdr), &ip_hdr_tmp);
424 prio = (ipv4_get_dsfield(ip_hdr) & 0xfc) >> 5;
426 case htons(ETH_P_IPV6):
427 ip6_hdr = skb_header_pointer(skb, offset + sizeof(*ethhdr),
428 sizeof(*ip6_hdr), &ip6_hdr_tmp);
431 prio = (ipv6_get_dsfield(ip6_hdr) & 0xfc) >> 5;
437 skb->priority = prio + 256;
440 static int batadv_recv_unhandled_packet(struct sk_buff *skb,
441 struct batadv_hard_iface *recv_if)
448 /* incoming packets with the batman ethertype received on any active hard
453 * batadv_batman_skb_recv() - Handle incoming message from an hard interface
454 * @skb: the received packet
455 * @dev: the net device that the packet was received on
456 * @ptype: packet type of incoming packet (ETH_P_BATMAN)
457 * @orig_dev: the original receive net device (e.g. bonded device)
459 * Return: NET_RX_SUCCESS on success or NET_RX_DROP in case of failure
461 int batadv_batman_skb_recv(struct sk_buff *skb, struct net_device *dev,
462 struct packet_type *ptype,
463 struct net_device *orig_dev)
465 struct batadv_priv *bat_priv;
466 struct batadv_ogm_packet *batadv_ogm_packet;
467 struct batadv_hard_iface *hard_iface;
470 hard_iface = container_of(ptype, struct batadv_hard_iface,
473 /* Prevent processing a packet received on an interface which is getting
474 * shut down otherwise the packet may trigger de-reference errors
475 * further down in the receive path.
477 if (!kref_get_unless_zero(&hard_iface->refcount))
480 skb = skb_share_check(skb, GFP_ATOMIC);
482 /* skb was released by skb_share_check() */
486 /* packet should hold at least type and version */
487 if (unlikely(!pskb_may_pull(skb, 2)))
490 /* expect a valid ethernet header here. */
491 if (unlikely(skb->mac_len != ETH_HLEN || !skb_mac_header(skb)))
494 if (!hard_iface->soft_iface)
497 bat_priv = netdev_priv(hard_iface->soft_iface);
499 if (atomic_read(&bat_priv->mesh_state) != BATADV_MESH_ACTIVE)
502 /* discard frames on not active interfaces */
503 if (hard_iface->if_status != BATADV_IF_ACTIVE)
506 batadv_ogm_packet = (struct batadv_ogm_packet *)skb->data;
508 if (batadv_ogm_packet->version != BATADV_COMPAT_VERSION) {
509 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
510 "Drop packet: incompatible batman version (%i)\n",
511 batadv_ogm_packet->version);
515 /* reset control block to avoid left overs from previous users */
516 memset(skb->cb, 0, sizeof(struct batadv_skb_cb));
518 idx = batadv_ogm_packet->packet_type;
519 (*batadv_rx_handler[idx])(skb, hard_iface);
521 batadv_hardif_put(hard_iface);
523 /* return NET_RX_SUCCESS in any case as we
524 * most probably dropped the packet for
525 * routing-logical reasons.
527 return NET_RX_SUCCESS;
532 batadv_hardif_put(hard_iface);
537 static void batadv_recv_handler_init(void)
541 for (i = 0; i < ARRAY_SIZE(batadv_rx_handler); i++)
542 batadv_rx_handler[i] = batadv_recv_unhandled_packet;
544 for (i = BATADV_UNICAST_MIN; i <= BATADV_UNICAST_MAX; i++)
545 batadv_rx_handler[i] = batadv_recv_unhandled_unicast_packet;
547 /* compile time checks for sizes */
548 BUILD_BUG_ON(sizeof(struct batadv_bla_claim_dst) != 6);
549 BUILD_BUG_ON(sizeof(struct batadv_ogm_packet) != 24);
550 BUILD_BUG_ON(sizeof(struct batadv_icmp_header) != 20);
551 BUILD_BUG_ON(sizeof(struct batadv_icmp_packet) != 20);
552 BUILD_BUG_ON(sizeof(struct batadv_icmp_packet_rr) != 116);
553 BUILD_BUG_ON(sizeof(struct batadv_unicast_packet) != 10);
554 BUILD_BUG_ON(sizeof(struct batadv_unicast_4addr_packet) != 18);
555 BUILD_BUG_ON(sizeof(struct batadv_frag_packet) != 20);
556 BUILD_BUG_ON(sizeof(struct batadv_bcast_packet) != 14);
557 BUILD_BUG_ON(sizeof(struct batadv_coded_packet) != 46);
558 BUILD_BUG_ON(sizeof(struct batadv_unicast_tvlv_packet) != 20);
559 BUILD_BUG_ON(sizeof(struct batadv_tvlv_hdr) != 4);
560 BUILD_BUG_ON(sizeof(struct batadv_tvlv_gateway_data) != 8);
561 BUILD_BUG_ON(sizeof(struct batadv_tvlv_tt_vlan_data) != 8);
562 BUILD_BUG_ON(sizeof(struct batadv_tvlv_tt_change) != 12);
563 BUILD_BUG_ON(sizeof(struct batadv_tvlv_roam_adv) != 8);
565 i = FIELD_SIZEOF(struct sk_buff, cb);
566 BUILD_BUG_ON(sizeof(struct batadv_skb_cb) > i);
568 /* broadcast packet */
569 batadv_rx_handler[BATADV_BCAST] = batadv_recv_bcast_packet;
571 /* unicast packets ... */
572 /* unicast with 4 addresses packet */
573 batadv_rx_handler[BATADV_UNICAST_4ADDR] = batadv_recv_unicast_packet;
575 batadv_rx_handler[BATADV_UNICAST] = batadv_recv_unicast_packet;
576 /* unicast tvlv packet */
577 batadv_rx_handler[BATADV_UNICAST_TVLV] = batadv_recv_unicast_tvlv;
578 /* batman icmp packet */
579 batadv_rx_handler[BATADV_ICMP] = batadv_recv_icmp_packet;
580 /* Fragmented packets */
581 batadv_rx_handler[BATADV_UNICAST_FRAG] = batadv_recv_frag_packet;
585 * batadv_recv_handler_register() - Register handler for batman-adv packet type
586 * @packet_type: batadv_packettype which should be handled
587 * @recv_handler: receive handler for the packet type
589 * Return: 0 on success or negative error number in case of failure
592 batadv_recv_handler_register(u8 packet_type,
593 int (*recv_handler)(struct sk_buff *,
594 struct batadv_hard_iface *))
596 int (*curr)(struct sk_buff *skb,
597 struct batadv_hard_iface *recv_if);
598 curr = batadv_rx_handler[packet_type];
600 if (curr != batadv_recv_unhandled_packet &&
601 curr != batadv_recv_unhandled_unicast_packet)
604 batadv_rx_handler[packet_type] = recv_handler;
609 * batadv_recv_handler_unregister() - Unregister handler for packet type
610 * @packet_type: batadv_packettype which should no longer be handled
612 void batadv_recv_handler_unregister(u8 packet_type)
614 batadv_rx_handler[packet_type] = batadv_recv_unhandled_packet;
618 * batadv_skb_crc32() - calculate CRC32 of the whole packet and skip bytes in
620 * @skb: skb pointing to fragmented socket buffers
621 * @payload_ptr: Pointer to position inside the head buffer of the skb
622 * marking the start of the data to be CRC'ed
624 * payload_ptr must always point to an address in the skb head buffer and not to
627 * Return: big endian crc32c of the checksummed data
629 __be32 batadv_skb_crc32(struct sk_buff *skb, u8 *payload_ptr)
633 unsigned int to = skb->len;
634 struct skb_seq_state st;
637 unsigned int consumed = 0;
639 from = (unsigned int)(payload_ptr - skb->data);
641 skb_prepare_seq_read(skb, from, to, &st);
642 while ((len = skb_seq_read(consumed, &data, &st)) != 0) {
643 crc = crc32c(crc, data, len);
651 * batadv_get_vid() - extract the VLAN identifier from skb if any
652 * @skb: the buffer containing the packet
653 * @header_len: length of the batman header preceding the ethernet header
655 * Return: VID with the BATADV_VLAN_HAS_TAG flag when the packet embedded in the
656 * skb is vlan tagged. Otherwise BATADV_NO_FLAGS.
658 unsigned short batadv_get_vid(struct sk_buff *skb, size_t header_len)
660 struct ethhdr *ethhdr = (struct ethhdr *)(skb->data + header_len);
661 struct vlan_ethhdr *vhdr;
664 if (ethhdr->h_proto != htons(ETH_P_8021Q))
665 return BATADV_NO_FLAGS;
667 if (!pskb_may_pull(skb, header_len + VLAN_ETH_HLEN))
668 return BATADV_NO_FLAGS;
670 vhdr = (struct vlan_ethhdr *)(skb->data + header_len);
671 vid = ntohs(vhdr->h_vlan_TCI) & VLAN_VID_MASK;
672 vid |= BATADV_VLAN_HAS_TAG;
678 * batadv_vlan_ap_isola_get() - return AP isolation status for the given vlan
679 * @bat_priv: the bat priv with all the soft interface information
680 * @vid: the VLAN identifier for which the AP isolation attributed as to be
683 * Return: true if AP isolation is on for the VLAN idenfied by vid, false
686 bool batadv_vlan_ap_isola_get(struct batadv_priv *bat_priv, unsigned short vid)
688 bool ap_isolation_enabled = false;
689 struct batadv_softif_vlan *vlan;
691 /* if the AP isolation is requested on a VLAN, then check for its
692 * setting in the proper VLAN private data structure
694 vlan = batadv_softif_vlan_get(bat_priv, vid);
696 ap_isolation_enabled = atomic_read(&vlan->ap_isolation);
697 batadv_softif_vlan_put(vlan);
700 return ap_isolation_enabled;
703 module_init(batadv_init);
704 module_exit(batadv_exit);
706 MODULE_LICENSE("GPL");
708 MODULE_AUTHOR(BATADV_DRIVER_AUTHOR);
709 MODULE_DESCRIPTION(BATADV_DRIVER_DESC);
710 MODULE_SUPPORTED_DEVICE(BATADV_DRIVER_DEVICE);
711 MODULE_VERSION(BATADV_SOURCE_VERSION);
712 MODULE_ALIAS_RTNL_LINK("batadv");
713 MODULE_ALIAS_GENL_FAMILY(BATADV_NL_NAME);