1 // SPDX-License-Identifier: GPL-2.0
2 /* Copyright (C) 2007-2020 B.A.T.M.A.N. contributors:
4 * Marek Lindner, Simon Wunderlich
9 #include <linux/atomic.h>
10 #include <linux/build_bug.h>
11 #include <linux/byteorder/generic.h>
12 #include <linux/crc32c.h>
13 #include <linux/device.h>
14 #include <linux/errno.h>
15 #include <linux/genetlink.h>
16 #include <linux/gfp.h>
17 #include <linux/if_ether.h>
18 #include <linux/if_vlan.h>
19 #include <linux/init.h>
21 #include <linux/ipv6.h>
22 #include <linux/kernel.h>
23 #include <linux/kobject.h>
24 #include <linux/kref.h>
25 #include <linux/list.h>
26 #include <linux/module.h>
27 #include <linux/netdevice.h>
28 #include <linux/printk.h>
29 #include <linux/rculist.h>
30 #include <linux/rcupdate.h>
31 #include <linux/seq_file.h>
32 #include <linux/skbuff.h>
33 #include <linux/slab.h>
34 #include <linux/spinlock.h>
35 #include <linux/stddef.h>
36 #include <linux/string.h>
37 #include <linux/workqueue.h>
38 #include <net/dsfield.h>
39 #include <net/rtnetlink.h>
40 #include <uapi/linux/batadv_packet.h>
41 #include <uapi/linux/batman_adv.h>
44 #include "bat_iv_ogm.h"
46 #include "bridge_loop_avoidance.h"
48 #include "distributed-arp-table.h"
49 #include "gateway_client.h"
50 #include "gateway_common.h"
51 #include "hard-interface.h"
52 #include "icmp_socket.h"
54 #include "multicast.h"
56 #include "network-coding.h"
57 #include "originator.h"
60 #include "soft-interface.h"
62 #include "translation-table.h"
64 /* List manipulations on hardif_list have to be rtnl_lock()'ed,
65 * list traversals just rcu-locked
67 struct list_head batadv_hardif_list;
68 unsigned int batadv_hardif_generation;
69 static int (*batadv_rx_handler[256])(struct sk_buff *skb,
70 struct batadv_hard_iface *recv_if);
72 unsigned char batadv_broadcast_addr[] = {0xff, 0xff, 0xff, 0xff, 0xff, 0xff};
74 struct workqueue_struct *batadv_event_workqueue;
76 static void batadv_recv_handler_init(void);
78 #define BATADV_UEV_TYPE_VAR "BATTYPE="
79 #define BATADV_UEV_ACTION_VAR "BATACTION="
80 #define BATADV_UEV_DATA_VAR "BATDATA="
82 static char *batadv_uev_action_str[] = {
89 static char *batadv_uev_type_str[] = {
94 static int __init batadv_init(void)
98 ret = batadv_tt_cache_init();
102 INIT_LIST_HEAD(&batadv_hardif_list);
105 batadv_recv_handler_init();
110 batadv_tp_meter_init();
112 batadv_event_workqueue = create_singlethread_workqueue("bat_events");
113 if (!batadv_event_workqueue)
116 batadv_socket_init();
117 batadv_debugfs_init();
119 register_netdevice_notifier(&batadv_hard_if_notifier);
120 rtnl_link_register(&batadv_link_ops);
121 batadv_netlink_register();
123 pr_info("B.A.T.M.A.N. advanced %s (compatibility version %i) loaded\n",
124 BATADV_SOURCE_VERSION, BATADV_COMPAT_VERSION);
129 batadv_tt_cache_destroy();
134 static void __exit batadv_exit(void)
136 batadv_debugfs_destroy();
137 batadv_netlink_unregister();
138 rtnl_link_unregister(&batadv_link_ops);
139 unregister_netdevice_notifier(&batadv_hard_if_notifier);
141 flush_workqueue(batadv_event_workqueue);
142 destroy_workqueue(batadv_event_workqueue);
143 batadv_event_workqueue = NULL;
147 batadv_tt_cache_destroy();
151 * batadv_mesh_init() - Initialize soft interface
152 * @soft_iface: netdev struct of the soft interface
154 * Return: 0 on success or negative error number in case of failure
156 int batadv_mesh_init(struct net_device *soft_iface)
158 struct batadv_priv *bat_priv = netdev_priv(soft_iface);
161 spin_lock_init(&bat_priv->forw_bat_list_lock);
162 spin_lock_init(&bat_priv->forw_bcast_list_lock);
163 spin_lock_init(&bat_priv->tt.changes_list_lock);
164 spin_lock_init(&bat_priv->tt.req_list_lock);
165 spin_lock_init(&bat_priv->tt.roam_list_lock);
166 spin_lock_init(&bat_priv->tt.last_changeset_lock);
167 spin_lock_init(&bat_priv->tt.commit_lock);
168 spin_lock_init(&bat_priv->gw.list_lock);
169 #ifdef CONFIG_BATMAN_ADV_MCAST
170 spin_lock_init(&bat_priv->mcast.mla_lock);
171 spin_lock_init(&bat_priv->mcast.want_lists_lock);
173 spin_lock_init(&bat_priv->tvlv.container_list_lock);
174 spin_lock_init(&bat_priv->tvlv.handler_list_lock);
175 spin_lock_init(&bat_priv->softif_vlan_list_lock);
176 spin_lock_init(&bat_priv->tp_list_lock);
178 INIT_HLIST_HEAD(&bat_priv->forw_bat_list);
179 INIT_HLIST_HEAD(&bat_priv->forw_bcast_list);
180 INIT_HLIST_HEAD(&bat_priv->gw.gateway_list);
181 #ifdef CONFIG_BATMAN_ADV_MCAST
182 INIT_HLIST_HEAD(&bat_priv->mcast.want_all_unsnoopables_list);
183 INIT_HLIST_HEAD(&bat_priv->mcast.want_all_ipv4_list);
184 INIT_HLIST_HEAD(&bat_priv->mcast.want_all_ipv6_list);
186 INIT_LIST_HEAD(&bat_priv->tt.changes_list);
187 INIT_HLIST_HEAD(&bat_priv->tt.req_list);
188 INIT_LIST_HEAD(&bat_priv->tt.roam_list);
189 #ifdef CONFIG_BATMAN_ADV_MCAST
190 INIT_HLIST_HEAD(&bat_priv->mcast.mla_list);
192 INIT_HLIST_HEAD(&bat_priv->tvlv.container_list);
193 INIT_HLIST_HEAD(&bat_priv->tvlv.handler_list);
194 INIT_HLIST_HEAD(&bat_priv->softif_vlan_list);
195 INIT_HLIST_HEAD(&bat_priv->tp_list);
197 bat_priv->gw.generation = 0;
199 ret = batadv_v_mesh_init(bat_priv);
203 ret = batadv_originator_init(bat_priv);
207 ret = batadv_tt_init(bat_priv);
211 ret = batadv_bla_init(bat_priv);
215 ret = batadv_dat_init(bat_priv);
219 ret = batadv_nc_mesh_init(bat_priv);
223 batadv_gw_init(bat_priv);
224 batadv_mcast_init(bat_priv);
226 atomic_set(&bat_priv->gw.reselect, 0);
227 atomic_set(&bat_priv->mesh_state, BATADV_MESH_ACTIVE);
232 batadv_mesh_free(soft_iface);
237 * batadv_mesh_free() - Deinitialize soft interface
238 * @soft_iface: netdev struct of the soft interface
240 void batadv_mesh_free(struct net_device *soft_iface)
242 struct batadv_priv *bat_priv = netdev_priv(soft_iface);
244 atomic_set(&bat_priv->mesh_state, BATADV_MESH_DEACTIVATING);
246 batadv_purge_outstanding_packets(bat_priv, NULL);
248 batadv_gw_node_free(bat_priv);
250 batadv_v_mesh_free(bat_priv);
251 batadv_nc_mesh_free(bat_priv);
252 batadv_dat_free(bat_priv);
253 batadv_bla_free(bat_priv);
255 batadv_mcast_free(bat_priv);
257 /* Free the TT and the originator tables only after having terminated
258 * all the other depending components which may use these structures for
261 batadv_tt_free(bat_priv);
263 /* Since the originator table clean up routine is accessing the TT
264 * tables as well, it has to be invoked after the TT tables have been
265 * freed and marked as empty. This ensures that no cleanup RCU callbacks
266 * accessing the TT data are scheduled for later execution.
268 batadv_originator_free(bat_priv);
270 batadv_gw_free(bat_priv);
272 free_percpu(bat_priv->bat_counters);
273 bat_priv->bat_counters = NULL;
275 atomic_set(&bat_priv->mesh_state, BATADV_MESH_INACTIVE);
279 * batadv_is_my_mac() - check if the given mac address belongs to any of the
280 * real interfaces in the current mesh
281 * @bat_priv: the bat priv with all the soft interface information
282 * @addr: the address to check
284 * Return: 'true' if the mac address was found, false otherwise.
286 bool batadv_is_my_mac(struct batadv_priv *bat_priv, const u8 *addr)
288 const struct batadv_hard_iface *hard_iface;
289 bool is_my_mac = false;
292 list_for_each_entry_rcu(hard_iface, &batadv_hardif_list, list) {
293 if (hard_iface->if_status != BATADV_IF_ACTIVE)
296 if (hard_iface->soft_iface != bat_priv->soft_iface)
299 if (batadv_compare_eth(hard_iface->net_dev->dev_addr, addr)) {
308 #ifdef CONFIG_BATMAN_ADV_DEBUGFS
310 * batadv_seq_print_text_primary_if_get() - called from debugfs table printing
311 * function that requires the primary interface
312 * @seq: debugfs table seq_file struct
314 * Return: primary interface if found or NULL otherwise.
316 struct batadv_hard_iface *
317 batadv_seq_print_text_primary_if_get(struct seq_file *seq)
319 struct net_device *net_dev = (struct net_device *)seq->private;
320 struct batadv_priv *bat_priv = netdev_priv(net_dev);
321 struct batadv_hard_iface *primary_if;
323 primary_if = batadv_primary_if_get_selected(bat_priv);
327 "BATMAN mesh %s disabled - please specify interfaces to enable it\n",
332 if (primary_if->if_status == BATADV_IF_ACTIVE)
336 "BATMAN mesh %s disabled - primary interface not active\n",
338 batadv_hardif_put(primary_if);
347 * batadv_max_header_len() - calculate maximum encapsulation overhead for a
350 * Return: the maximum encapsulation overhead in bytes.
352 int batadv_max_header_len(void)
356 header_len = max_t(int, header_len,
357 sizeof(struct batadv_unicast_packet));
358 header_len = max_t(int, header_len,
359 sizeof(struct batadv_unicast_4addr_packet));
360 header_len = max_t(int, header_len,
361 sizeof(struct batadv_bcast_packet));
363 #ifdef CONFIG_BATMAN_ADV_NC
364 header_len = max_t(int, header_len,
365 sizeof(struct batadv_coded_packet));
368 return header_len + ETH_HLEN;
372 * batadv_skb_set_priority() - sets skb priority according to packet content
373 * @skb: the packet to be sent
374 * @offset: offset to the packet content
376 * This function sets a value between 256 and 263 (802.1d priority), which
377 * can be interpreted by the cfg80211 or other drivers.
379 void batadv_skb_set_priority(struct sk_buff *skb, int offset)
381 struct iphdr ip_hdr_tmp, *ip_hdr;
382 struct ipv6hdr ip6_hdr_tmp, *ip6_hdr;
383 struct ethhdr ethhdr_tmp, *ethhdr;
384 struct vlan_ethhdr *vhdr, vhdr_tmp;
387 /* already set, do nothing */
388 if (skb->priority >= 256 && skb->priority <= 263)
391 ethhdr = skb_header_pointer(skb, offset, sizeof(*ethhdr), ðhdr_tmp);
395 switch (ethhdr->h_proto) {
396 case htons(ETH_P_8021Q):
397 vhdr = skb_header_pointer(skb, offset + sizeof(*vhdr),
398 sizeof(*vhdr), &vhdr_tmp);
401 prio = ntohs(vhdr->h_vlan_TCI) & VLAN_PRIO_MASK;
402 prio = prio >> VLAN_PRIO_SHIFT;
404 case htons(ETH_P_IP):
405 ip_hdr = skb_header_pointer(skb, offset + sizeof(*ethhdr),
406 sizeof(*ip_hdr), &ip_hdr_tmp);
409 prio = (ipv4_get_dsfield(ip_hdr) & 0xfc) >> 5;
411 case htons(ETH_P_IPV6):
412 ip6_hdr = skb_header_pointer(skb, offset + sizeof(*ethhdr),
413 sizeof(*ip6_hdr), &ip6_hdr_tmp);
416 prio = (ipv6_get_dsfield(ip6_hdr) & 0xfc) >> 5;
422 skb->priority = prio + 256;
425 static int batadv_recv_unhandled_packet(struct sk_buff *skb,
426 struct batadv_hard_iface *recv_if)
433 /* incoming packets with the batman ethertype received on any active hard
438 * batadv_batman_skb_recv() - Handle incoming message from an hard interface
439 * @skb: the received packet
440 * @dev: the net device that the packet was received on
441 * @ptype: packet type of incoming packet (ETH_P_BATMAN)
442 * @orig_dev: the original receive net device (e.g. bonded device)
444 * Return: NET_RX_SUCCESS on success or NET_RX_DROP in case of failure
446 int batadv_batman_skb_recv(struct sk_buff *skb, struct net_device *dev,
447 struct packet_type *ptype,
448 struct net_device *orig_dev)
450 struct batadv_priv *bat_priv;
451 struct batadv_ogm_packet *batadv_ogm_packet;
452 struct batadv_hard_iface *hard_iface;
455 hard_iface = container_of(ptype, struct batadv_hard_iface,
458 /* Prevent processing a packet received on an interface which is getting
459 * shut down otherwise the packet may trigger de-reference errors
460 * further down in the receive path.
462 if (!kref_get_unless_zero(&hard_iface->refcount))
465 skb = skb_share_check(skb, GFP_ATOMIC);
467 /* skb was released by skb_share_check() */
471 /* packet should hold at least type and version */
472 if (unlikely(!pskb_may_pull(skb, 2)))
475 /* expect a valid ethernet header here. */
476 if (unlikely(skb->mac_len != ETH_HLEN || !skb_mac_header(skb)))
479 if (!hard_iface->soft_iface)
482 bat_priv = netdev_priv(hard_iface->soft_iface);
484 if (atomic_read(&bat_priv->mesh_state) != BATADV_MESH_ACTIVE)
487 /* discard frames on not active interfaces */
488 if (hard_iface->if_status != BATADV_IF_ACTIVE)
491 batadv_ogm_packet = (struct batadv_ogm_packet *)skb->data;
493 if (batadv_ogm_packet->version != BATADV_COMPAT_VERSION) {
494 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
495 "Drop packet: incompatible batman version (%i)\n",
496 batadv_ogm_packet->version);
500 /* reset control block to avoid left overs from previous users */
501 memset(skb->cb, 0, sizeof(struct batadv_skb_cb));
503 idx = batadv_ogm_packet->packet_type;
504 (*batadv_rx_handler[idx])(skb, hard_iface);
506 batadv_hardif_put(hard_iface);
508 /* return NET_RX_SUCCESS in any case as we
509 * most probably dropped the packet for
510 * routing-logical reasons.
512 return NET_RX_SUCCESS;
517 batadv_hardif_put(hard_iface);
522 static void batadv_recv_handler_init(void)
526 for (i = 0; i < ARRAY_SIZE(batadv_rx_handler); i++)
527 batadv_rx_handler[i] = batadv_recv_unhandled_packet;
529 for (i = BATADV_UNICAST_MIN; i <= BATADV_UNICAST_MAX; i++)
530 batadv_rx_handler[i] = batadv_recv_unhandled_unicast_packet;
532 /* compile time checks for sizes */
533 BUILD_BUG_ON(sizeof(struct batadv_bla_claim_dst) != 6);
534 BUILD_BUG_ON(sizeof(struct batadv_ogm_packet) != 24);
535 BUILD_BUG_ON(sizeof(struct batadv_icmp_header) != 20);
536 BUILD_BUG_ON(sizeof(struct batadv_icmp_packet) != 20);
537 BUILD_BUG_ON(sizeof(struct batadv_icmp_packet_rr) != 116);
538 BUILD_BUG_ON(sizeof(struct batadv_unicast_packet) != 10);
539 BUILD_BUG_ON(sizeof(struct batadv_unicast_4addr_packet) != 18);
540 BUILD_BUG_ON(sizeof(struct batadv_frag_packet) != 20);
541 BUILD_BUG_ON(sizeof(struct batadv_bcast_packet) != 14);
542 BUILD_BUG_ON(sizeof(struct batadv_coded_packet) != 46);
543 BUILD_BUG_ON(sizeof(struct batadv_unicast_tvlv_packet) != 20);
544 BUILD_BUG_ON(sizeof(struct batadv_tvlv_hdr) != 4);
545 BUILD_BUG_ON(sizeof(struct batadv_tvlv_gateway_data) != 8);
546 BUILD_BUG_ON(sizeof(struct batadv_tvlv_tt_vlan_data) != 8);
547 BUILD_BUG_ON(sizeof(struct batadv_tvlv_tt_change) != 12);
548 BUILD_BUG_ON(sizeof(struct batadv_tvlv_roam_adv) != 8);
550 i = sizeof_field(struct sk_buff, cb);
551 BUILD_BUG_ON(sizeof(struct batadv_skb_cb) > i);
553 /* broadcast packet */
554 batadv_rx_handler[BATADV_BCAST] = batadv_recv_bcast_packet;
556 /* unicast packets ... */
557 /* unicast with 4 addresses packet */
558 batadv_rx_handler[BATADV_UNICAST_4ADDR] = batadv_recv_unicast_packet;
560 batadv_rx_handler[BATADV_UNICAST] = batadv_recv_unicast_packet;
561 /* unicast tvlv packet */
562 batadv_rx_handler[BATADV_UNICAST_TVLV] = batadv_recv_unicast_tvlv;
563 /* batman icmp packet */
564 batadv_rx_handler[BATADV_ICMP] = batadv_recv_icmp_packet;
565 /* Fragmented packets */
566 batadv_rx_handler[BATADV_UNICAST_FRAG] = batadv_recv_frag_packet;
570 * batadv_recv_handler_register() - Register handler for batman-adv packet type
571 * @packet_type: batadv_packettype which should be handled
572 * @recv_handler: receive handler for the packet type
574 * Return: 0 on success or negative error number in case of failure
577 batadv_recv_handler_register(u8 packet_type,
578 int (*recv_handler)(struct sk_buff *,
579 struct batadv_hard_iface *))
581 int (*curr)(struct sk_buff *skb,
582 struct batadv_hard_iface *recv_if);
583 curr = batadv_rx_handler[packet_type];
585 if (curr != batadv_recv_unhandled_packet &&
586 curr != batadv_recv_unhandled_unicast_packet)
589 batadv_rx_handler[packet_type] = recv_handler;
594 * batadv_recv_handler_unregister() - Unregister handler for packet type
595 * @packet_type: batadv_packettype which should no longer be handled
597 void batadv_recv_handler_unregister(u8 packet_type)
599 batadv_rx_handler[packet_type] = batadv_recv_unhandled_packet;
603 * batadv_skb_crc32() - calculate CRC32 of the whole packet and skip bytes in
605 * @skb: skb pointing to fragmented socket buffers
606 * @payload_ptr: Pointer to position inside the head buffer of the skb
607 * marking the start of the data to be CRC'ed
609 * payload_ptr must always point to an address in the skb head buffer and not to
612 * Return: big endian crc32c of the checksummed data
614 __be32 batadv_skb_crc32(struct sk_buff *skb, u8 *payload_ptr)
618 unsigned int to = skb->len;
619 struct skb_seq_state st;
622 unsigned int consumed = 0;
624 from = (unsigned int)(payload_ptr - skb->data);
626 skb_prepare_seq_read(skb, from, to, &st);
627 while ((len = skb_seq_read(consumed, &data, &st)) != 0) {
628 crc = crc32c(crc, data, len);
636 * batadv_get_vid() - extract the VLAN identifier from skb if any
637 * @skb: the buffer containing the packet
638 * @header_len: length of the batman header preceding the ethernet header
640 * Return: VID with the BATADV_VLAN_HAS_TAG flag when the packet embedded in the
641 * skb is vlan tagged. Otherwise BATADV_NO_FLAGS.
643 unsigned short batadv_get_vid(struct sk_buff *skb, size_t header_len)
645 struct ethhdr *ethhdr = (struct ethhdr *)(skb->data + header_len);
646 struct vlan_ethhdr *vhdr;
649 if (ethhdr->h_proto != htons(ETH_P_8021Q))
650 return BATADV_NO_FLAGS;
652 if (!pskb_may_pull(skb, header_len + VLAN_ETH_HLEN))
653 return BATADV_NO_FLAGS;
655 vhdr = (struct vlan_ethhdr *)(skb->data + header_len);
656 vid = ntohs(vhdr->h_vlan_TCI) & VLAN_VID_MASK;
657 vid |= BATADV_VLAN_HAS_TAG;
663 * batadv_vlan_ap_isola_get() - return AP isolation status for the given vlan
664 * @bat_priv: the bat priv with all the soft interface information
665 * @vid: the VLAN identifier for which the AP isolation attributed as to be
668 * Return: true if AP isolation is on for the VLAN identified by vid, false
671 bool batadv_vlan_ap_isola_get(struct batadv_priv *bat_priv, unsigned short vid)
673 bool ap_isolation_enabled = false;
674 struct batadv_softif_vlan *vlan;
676 /* if the AP isolation is requested on a VLAN, then check for its
677 * setting in the proper VLAN private data structure
679 vlan = batadv_softif_vlan_get(bat_priv, vid);
681 ap_isolation_enabled = atomic_read(&vlan->ap_isolation);
682 batadv_softif_vlan_put(vlan);
685 return ap_isolation_enabled;
689 * batadv_throw_uevent() - Send an uevent with batman-adv specific env data
690 * @bat_priv: the bat priv with all the soft interface information
691 * @type: subsystem type of event. Stored in uevent's BATTYPE
692 * @action: action type of event. Stored in uevent's BATACTION
693 * @data: string with additional information to the event (ignored for
694 * BATADV_UEV_DEL). Stored in uevent's BATDATA
696 * Return: 0 on success or negative error number in case of failure
698 int batadv_throw_uevent(struct batadv_priv *bat_priv, enum batadv_uev_type type,
699 enum batadv_uev_action action, const char *data)
702 struct kobject *bat_kobj;
703 char *uevent_env[4] = { NULL, NULL, NULL, NULL };
705 bat_kobj = &bat_priv->soft_iface->dev.kobj;
707 uevent_env[0] = kasprintf(GFP_ATOMIC,
708 "%s%s", BATADV_UEV_TYPE_VAR,
709 batadv_uev_type_str[type]);
713 uevent_env[1] = kasprintf(GFP_ATOMIC,
714 "%s%s", BATADV_UEV_ACTION_VAR,
715 batadv_uev_action_str[action]);
719 /* If the event is DEL, ignore the data field */
720 if (action != BATADV_UEV_DEL) {
721 uevent_env[2] = kasprintf(GFP_ATOMIC,
722 "%s%s", BATADV_UEV_DATA_VAR, data);
727 ret = kobject_uevent_env(bat_kobj, KOBJ_CHANGE, uevent_env);
729 kfree(uevent_env[0]);
730 kfree(uevent_env[1]);
731 kfree(uevent_env[2]);
734 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
735 "Impossible to send uevent for (%s,%s,%s) event (err: %d)\n",
736 batadv_uev_type_str[type],
737 batadv_uev_action_str[action],
738 (action == BATADV_UEV_DEL ? "NULL" : data), ret);
742 module_init(batadv_init);
743 module_exit(batadv_exit);
745 MODULE_LICENSE("GPL");
747 MODULE_AUTHOR(BATADV_DRIVER_AUTHOR);
748 MODULE_DESCRIPTION(BATADV_DRIVER_DESC);
749 MODULE_SUPPORTED_DEVICE(BATADV_DRIVER_DEVICE);
750 MODULE_VERSION(BATADV_SOURCE_VERSION);
751 MODULE_ALIAS_RTNL_LINK("batadv");
752 MODULE_ALIAS_GENL_FAMILY(BATADV_NL_NAME);