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 unsigned int batadv_hardif_generation;
78 static int (*batadv_rx_handler[256])(struct sk_buff *skb,
79 struct batadv_hard_iface *recv_if);
81 unsigned char batadv_broadcast_addr[] = {0xff, 0xff, 0xff, 0xff, 0xff, 0xff};
83 struct workqueue_struct *batadv_event_workqueue;
85 static void batadv_recv_handler_init(void);
87 static int __init batadv_init(void)
91 ret = batadv_tt_cache_init();
95 INIT_LIST_HEAD(&batadv_hardif_list);
98 batadv_recv_handler_init();
103 batadv_tp_meter_init();
105 batadv_event_workqueue = create_singlethread_workqueue("bat_events");
106 if (!batadv_event_workqueue)
109 batadv_socket_init();
110 batadv_debugfs_init();
112 register_netdevice_notifier(&batadv_hard_if_notifier);
113 rtnl_link_register(&batadv_link_ops);
114 batadv_netlink_register();
116 pr_info("B.A.T.M.A.N. advanced %s (compatibility version %i) loaded\n",
117 BATADV_SOURCE_VERSION, BATADV_COMPAT_VERSION);
122 batadv_tt_cache_destroy();
127 static void __exit batadv_exit(void)
129 batadv_debugfs_destroy();
130 batadv_netlink_unregister();
131 rtnl_link_unregister(&batadv_link_ops);
132 unregister_netdevice_notifier(&batadv_hard_if_notifier);
133 batadv_hardif_remove_interfaces();
135 flush_workqueue(batadv_event_workqueue);
136 destroy_workqueue(batadv_event_workqueue);
137 batadv_event_workqueue = NULL;
141 batadv_tt_cache_destroy();
145 * batadv_mesh_init() - Initialize soft interface
146 * @soft_iface: netdev struct of the soft interface
148 * Return: 0 on success or negative error number in case of failure
150 int batadv_mesh_init(struct net_device *soft_iface)
152 struct batadv_priv *bat_priv = netdev_priv(soft_iface);
155 spin_lock_init(&bat_priv->forw_bat_list_lock);
156 spin_lock_init(&bat_priv->forw_bcast_list_lock);
157 spin_lock_init(&bat_priv->tt.changes_list_lock);
158 spin_lock_init(&bat_priv->tt.req_list_lock);
159 spin_lock_init(&bat_priv->tt.roam_list_lock);
160 spin_lock_init(&bat_priv->tt.last_changeset_lock);
161 spin_lock_init(&bat_priv->tt.commit_lock);
162 spin_lock_init(&bat_priv->gw.list_lock);
163 #ifdef CONFIG_BATMAN_ADV_MCAST
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 bat_priv->gw.generation = 0;
192 ret = batadv_v_mesh_init(bat_priv);
196 ret = batadv_originator_init(bat_priv);
200 ret = batadv_tt_init(bat_priv);
204 ret = batadv_bla_init(bat_priv);
208 ret = batadv_dat_init(bat_priv);
212 ret = batadv_nc_mesh_init(bat_priv);
216 batadv_gw_init(bat_priv);
217 batadv_mcast_init(bat_priv);
219 atomic_set(&bat_priv->gw.reselect, 0);
220 atomic_set(&bat_priv->mesh_state, BATADV_MESH_ACTIVE);
225 batadv_mesh_free(soft_iface);
230 * batadv_mesh_free() - Deinitialize soft interface
231 * @soft_iface: netdev struct of the soft interface
233 void batadv_mesh_free(struct net_device *soft_iface)
235 struct batadv_priv *bat_priv = netdev_priv(soft_iface);
237 atomic_set(&bat_priv->mesh_state, BATADV_MESH_DEACTIVATING);
239 batadv_purge_outstanding_packets(bat_priv, NULL);
241 batadv_gw_node_free(bat_priv);
243 batadv_v_mesh_free(bat_priv);
244 batadv_nc_mesh_free(bat_priv);
245 batadv_dat_free(bat_priv);
246 batadv_bla_free(bat_priv);
248 batadv_mcast_free(bat_priv);
250 /* Free the TT and the originator tables only after having terminated
251 * all the other depending components which may use these structures for
254 batadv_tt_free(bat_priv);
256 /* Since the originator table clean up routine is accessing the TT
257 * tables as well, it has to be invoked after the TT tables have been
258 * freed and marked as empty. This ensures that no cleanup RCU callbacks
259 * accessing the TT data are scheduled for later execution.
261 batadv_originator_free(bat_priv);
263 batadv_gw_free(bat_priv);
265 free_percpu(bat_priv->bat_counters);
266 bat_priv->bat_counters = NULL;
268 atomic_set(&bat_priv->mesh_state, BATADV_MESH_INACTIVE);
272 * batadv_is_my_mac() - check if the given mac address belongs to any of the
273 * real interfaces in the current mesh
274 * @bat_priv: the bat priv with all the soft interface information
275 * @addr: the address to check
277 * Return: 'true' if the mac address was found, false otherwise.
279 bool batadv_is_my_mac(struct batadv_priv *bat_priv, const u8 *addr)
281 const struct batadv_hard_iface *hard_iface;
282 bool is_my_mac = false;
285 list_for_each_entry_rcu(hard_iface, &batadv_hardif_list, list) {
286 if (hard_iface->if_status != BATADV_IF_ACTIVE)
289 if (hard_iface->soft_iface != bat_priv->soft_iface)
292 if (batadv_compare_eth(hard_iface->net_dev->dev_addr, addr)) {
301 #ifdef CONFIG_BATMAN_ADV_DEBUGFS
303 * batadv_seq_print_text_primary_if_get() - called from debugfs table printing
304 * function that requires the primary interface
305 * @seq: debugfs table seq_file struct
307 * Return: primary interface if found or NULL otherwise.
309 struct batadv_hard_iface *
310 batadv_seq_print_text_primary_if_get(struct seq_file *seq)
312 struct net_device *net_dev = (struct net_device *)seq->private;
313 struct batadv_priv *bat_priv = netdev_priv(net_dev);
314 struct batadv_hard_iface *primary_if;
316 primary_if = batadv_primary_if_get_selected(bat_priv);
320 "BATMAN mesh %s disabled - please specify interfaces to enable it\n",
325 if (primary_if->if_status == BATADV_IF_ACTIVE)
329 "BATMAN mesh %s disabled - primary interface not active\n",
331 batadv_hardif_put(primary_if);
340 * batadv_max_header_len() - calculate maximum encapsulation overhead for a
343 * Return: the maximum encapsulation overhead in bytes.
345 int batadv_max_header_len(void)
349 header_len = max_t(int, header_len,
350 sizeof(struct batadv_unicast_packet));
351 header_len = max_t(int, header_len,
352 sizeof(struct batadv_unicast_4addr_packet));
353 header_len = max_t(int, header_len,
354 sizeof(struct batadv_bcast_packet));
356 #ifdef CONFIG_BATMAN_ADV_NC
357 header_len = max_t(int, header_len,
358 sizeof(struct batadv_coded_packet));
361 return header_len + ETH_HLEN;
365 * batadv_skb_set_priority() - sets skb priority according to packet content
366 * @skb: the packet to be sent
367 * @offset: offset to the packet content
369 * This function sets a value between 256 and 263 (802.1d priority), which
370 * can be interpreted by the cfg80211 or other drivers.
372 void batadv_skb_set_priority(struct sk_buff *skb, int offset)
374 struct iphdr ip_hdr_tmp, *ip_hdr;
375 struct ipv6hdr ip6_hdr_tmp, *ip6_hdr;
376 struct ethhdr ethhdr_tmp, *ethhdr;
377 struct vlan_ethhdr *vhdr, vhdr_tmp;
380 /* already set, do nothing */
381 if (skb->priority >= 256 && skb->priority <= 263)
384 ethhdr = skb_header_pointer(skb, offset, sizeof(*ethhdr), ðhdr_tmp);
388 switch (ethhdr->h_proto) {
389 case htons(ETH_P_8021Q):
390 vhdr = skb_header_pointer(skb, offset + sizeof(*vhdr),
391 sizeof(*vhdr), &vhdr_tmp);
394 prio = ntohs(vhdr->h_vlan_TCI) & VLAN_PRIO_MASK;
395 prio = prio >> VLAN_PRIO_SHIFT;
397 case htons(ETH_P_IP):
398 ip_hdr = skb_header_pointer(skb, offset + sizeof(*ethhdr),
399 sizeof(*ip_hdr), &ip_hdr_tmp);
402 prio = (ipv4_get_dsfield(ip_hdr) & 0xfc) >> 5;
404 case htons(ETH_P_IPV6):
405 ip6_hdr = skb_header_pointer(skb, offset + sizeof(*ethhdr),
406 sizeof(*ip6_hdr), &ip6_hdr_tmp);
409 prio = (ipv6_get_dsfield(ip6_hdr) & 0xfc) >> 5;
415 skb->priority = prio + 256;
418 static int batadv_recv_unhandled_packet(struct sk_buff *skb,
419 struct batadv_hard_iface *recv_if)
426 /* incoming packets with the batman ethertype received on any active hard
431 * batadv_batman_skb_recv() - Handle incoming message from an hard interface
432 * @skb: the received packet
433 * @dev: the net device that the packet was received on
434 * @ptype: packet type of incoming packet (ETH_P_BATMAN)
435 * @orig_dev: the original receive net device (e.g. bonded device)
437 * Return: NET_RX_SUCCESS on success or NET_RX_DROP in case of failure
439 int batadv_batman_skb_recv(struct sk_buff *skb, struct net_device *dev,
440 struct packet_type *ptype,
441 struct net_device *orig_dev)
443 struct batadv_priv *bat_priv;
444 struct batadv_ogm_packet *batadv_ogm_packet;
445 struct batadv_hard_iface *hard_iface;
448 hard_iface = container_of(ptype, struct batadv_hard_iface,
451 /* Prevent processing a packet received on an interface which is getting
452 * shut down otherwise the packet may trigger de-reference errors
453 * further down in the receive path.
455 if (!kref_get_unless_zero(&hard_iface->refcount))
458 skb = skb_share_check(skb, GFP_ATOMIC);
460 /* skb was released by skb_share_check() */
464 /* packet should hold at least type and version */
465 if (unlikely(!pskb_may_pull(skb, 2)))
468 /* expect a valid ethernet header here. */
469 if (unlikely(skb->mac_len != ETH_HLEN || !skb_mac_header(skb)))
472 if (!hard_iface->soft_iface)
475 bat_priv = netdev_priv(hard_iface->soft_iface);
477 if (atomic_read(&bat_priv->mesh_state) != BATADV_MESH_ACTIVE)
480 /* discard frames on not active interfaces */
481 if (hard_iface->if_status != BATADV_IF_ACTIVE)
484 batadv_ogm_packet = (struct batadv_ogm_packet *)skb->data;
486 if (batadv_ogm_packet->version != BATADV_COMPAT_VERSION) {
487 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
488 "Drop packet: incompatible batman version (%i)\n",
489 batadv_ogm_packet->version);
493 /* reset control block to avoid left overs from previous users */
494 memset(skb->cb, 0, sizeof(struct batadv_skb_cb));
496 idx = batadv_ogm_packet->packet_type;
497 (*batadv_rx_handler[idx])(skb, hard_iface);
499 batadv_hardif_put(hard_iface);
501 /* return NET_RX_SUCCESS in any case as we
502 * most probably dropped the packet for
503 * routing-logical reasons.
505 return NET_RX_SUCCESS;
510 batadv_hardif_put(hard_iface);
515 static void batadv_recv_handler_init(void)
519 for (i = 0; i < ARRAY_SIZE(batadv_rx_handler); i++)
520 batadv_rx_handler[i] = batadv_recv_unhandled_packet;
522 for (i = BATADV_UNICAST_MIN; i <= BATADV_UNICAST_MAX; i++)
523 batadv_rx_handler[i] = batadv_recv_unhandled_unicast_packet;
525 /* compile time checks for sizes */
526 BUILD_BUG_ON(sizeof(struct batadv_bla_claim_dst) != 6);
527 BUILD_BUG_ON(sizeof(struct batadv_ogm_packet) != 24);
528 BUILD_BUG_ON(sizeof(struct batadv_icmp_header) != 20);
529 BUILD_BUG_ON(sizeof(struct batadv_icmp_packet) != 20);
530 BUILD_BUG_ON(sizeof(struct batadv_icmp_packet_rr) != 116);
531 BUILD_BUG_ON(sizeof(struct batadv_unicast_packet) != 10);
532 BUILD_BUG_ON(sizeof(struct batadv_unicast_4addr_packet) != 18);
533 BUILD_BUG_ON(sizeof(struct batadv_frag_packet) != 20);
534 BUILD_BUG_ON(sizeof(struct batadv_bcast_packet) != 14);
535 BUILD_BUG_ON(sizeof(struct batadv_coded_packet) != 46);
536 BUILD_BUG_ON(sizeof(struct batadv_unicast_tvlv_packet) != 20);
537 BUILD_BUG_ON(sizeof(struct batadv_tvlv_hdr) != 4);
538 BUILD_BUG_ON(sizeof(struct batadv_tvlv_gateway_data) != 8);
539 BUILD_BUG_ON(sizeof(struct batadv_tvlv_tt_vlan_data) != 8);
540 BUILD_BUG_ON(sizeof(struct batadv_tvlv_tt_change) != 12);
541 BUILD_BUG_ON(sizeof(struct batadv_tvlv_roam_adv) != 8);
543 i = FIELD_SIZEOF(struct sk_buff, cb);
544 BUILD_BUG_ON(sizeof(struct batadv_skb_cb) > i);
546 /* broadcast packet */
547 batadv_rx_handler[BATADV_BCAST] = batadv_recv_bcast_packet;
549 /* unicast packets ... */
550 /* unicast with 4 addresses packet */
551 batadv_rx_handler[BATADV_UNICAST_4ADDR] = batadv_recv_unicast_packet;
553 batadv_rx_handler[BATADV_UNICAST] = batadv_recv_unicast_packet;
554 /* unicast tvlv packet */
555 batadv_rx_handler[BATADV_UNICAST_TVLV] = batadv_recv_unicast_tvlv;
556 /* batman icmp packet */
557 batadv_rx_handler[BATADV_ICMP] = batadv_recv_icmp_packet;
558 /* Fragmented packets */
559 batadv_rx_handler[BATADV_UNICAST_FRAG] = batadv_recv_frag_packet;
563 * batadv_recv_handler_register() - Register handler for batman-adv packet type
564 * @packet_type: batadv_packettype which should be handled
565 * @recv_handler: receive handler for the packet type
567 * Return: 0 on success or negative error number in case of failure
570 batadv_recv_handler_register(u8 packet_type,
571 int (*recv_handler)(struct sk_buff *,
572 struct batadv_hard_iface *))
574 int (*curr)(struct sk_buff *skb,
575 struct batadv_hard_iface *recv_if);
576 curr = batadv_rx_handler[packet_type];
578 if (curr != batadv_recv_unhandled_packet &&
579 curr != batadv_recv_unhandled_unicast_packet)
582 batadv_rx_handler[packet_type] = recv_handler;
587 * batadv_recv_handler_unregister() - Unregister handler for packet type
588 * @packet_type: batadv_packettype which should no longer be handled
590 void batadv_recv_handler_unregister(u8 packet_type)
592 batadv_rx_handler[packet_type] = batadv_recv_unhandled_packet;
596 * batadv_skb_crc32() - calculate CRC32 of the whole packet and skip bytes in
598 * @skb: skb pointing to fragmented socket buffers
599 * @payload_ptr: Pointer to position inside the head buffer of the skb
600 * marking the start of the data to be CRC'ed
602 * payload_ptr must always point to an address in the skb head buffer and not to
605 * Return: big endian crc32c of the checksummed data
607 __be32 batadv_skb_crc32(struct sk_buff *skb, u8 *payload_ptr)
611 unsigned int to = skb->len;
612 struct skb_seq_state st;
615 unsigned int consumed = 0;
617 from = (unsigned int)(payload_ptr - skb->data);
619 skb_prepare_seq_read(skb, from, to, &st);
620 while ((len = skb_seq_read(consumed, &data, &st)) != 0) {
621 crc = crc32c(crc, data, len);
629 * batadv_get_vid() - extract the VLAN identifier from skb if any
630 * @skb: the buffer containing the packet
631 * @header_len: length of the batman header preceding the ethernet header
633 * Return: VID with the BATADV_VLAN_HAS_TAG flag when the packet embedded in the
634 * skb is vlan tagged. Otherwise BATADV_NO_FLAGS.
636 unsigned short batadv_get_vid(struct sk_buff *skb, size_t header_len)
638 struct ethhdr *ethhdr = (struct ethhdr *)(skb->data + header_len);
639 struct vlan_ethhdr *vhdr;
642 if (ethhdr->h_proto != htons(ETH_P_8021Q))
643 return BATADV_NO_FLAGS;
645 if (!pskb_may_pull(skb, header_len + VLAN_ETH_HLEN))
646 return BATADV_NO_FLAGS;
648 vhdr = (struct vlan_ethhdr *)(skb->data + header_len);
649 vid = ntohs(vhdr->h_vlan_TCI) & VLAN_VID_MASK;
650 vid |= BATADV_VLAN_HAS_TAG;
656 * batadv_vlan_ap_isola_get() - return AP isolation status for the given vlan
657 * @bat_priv: the bat priv with all the soft interface information
658 * @vid: the VLAN identifier for which the AP isolation attributed as to be
661 * Return: true if AP isolation is on for the VLAN idenfied by vid, false
664 bool batadv_vlan_ap_isola_get(struct batadv_priv *bat_priv, unsigned short vid)
666 bool ap_isolation_enabled = false;
667 struct batadv_softif_vlan *vlan;
669 /* if the AP isolation is requested on a VLAN, then check for its
670 * setting in the proper VLAN private data structure
672 vlan = batadv_softif_vlan_get(bat_priv, vid);
674 ap_isolation_enabled = atomic_read(&vlan->ap_isolation);
675 batadv_softif_vlan_put(vlan);
678 return ap_isolation_enabled;
681 module_init(batadv_init);
682 module_exit(batadv_exit);
684 MODULE_LICENSE("GPL");
686 MODULE_AUTHOR(BATADV_DRIVER_AUTHOR);
687 MODULE_DESCRIPTION(BATADV_DRIVER_DESC);
688 MODULE_SUPPORTED_DEVICE(BATADV_DRIVER_DEVICE);
689 MODULE_VERSION(BATADV_SOURCE_VERSION);
690 MODULE_ALIAS_RTNL_LINK("batadv");
691 MODULE_ALIAS_GENL_FAMILY(BATADV_NL_NAME);