1 // SPDX-License-Identifier: GPL-2.0
2 /* Copyright (C) 2007-2017 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/batman_adv.h>
52 #include "bat_iv_ogm.h"
54 #include "bridge_loop_avoidance.h"
56 #include "distributed-arp-table.h"
57 #include "gateway_client.h"
58 #include "gateway_common.h"
59 #include "hard-interface.h"
60 #include "icmp_socket.h"
62 #include "multicast.h"
64 #include "network-coding.h"
65 #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();
143 int batadv_mesh_init(struct net_device
*soft_iface
)
145 struct batadv_priv
*bat_priv
= netdev_priv(soft_iface
);
148 spin_lock_init(&bat_priv
->forw_bat_list_lock
);
149 spin_lock_init(&bat_priv
->forw_bcast_list_lock
);
150 spin_lock_init(&bat_priv
->tt
.changes_list_lock
);
151 spin_lock_init(&bat_priv
->tt
.req_list_lock
);
152 spin_lock_init(&bat_priv
->tt
.roam_list_lock
);
153 spin_lock_init(&bat_priv
->tt
.last_changeset_lock
);
154 spin_lock_init(&bat_priv
->tt
.commit_lock
);
155 spin_lock_init(&bat_priv
->gw
.list_lock
);
156 #ifdef CONFIG_BATMAN_ADV_MCAST
157 spin_lock_init(&bat_priv
->mcast
.want_lists_lock
);
159 spin_lock_init(&bat_priv
->tvlv
.container_list_lock
);
160 spin_lock_init(&bat_priv
->tvlv
.handler_list_lock
);
161 spin_lock_init(&bat_priv
->softif_vlan_list_lock
);
162 spin_lock_init(&bat_priv
->tp_list_lock
);
164 INIT_HLIST_HEAD(&bat_priv
->forw_bat_list
);
165 INIT_HLIST_HEAD(&bat_priv
->forw_bcast_list
);
166 INIT_HLIST_HEAD(&bat_priv
->gw
.gateway_list
);
167 #ifdef CONFIG_BATMAN_ADV_MCAST
168 INIT_HLIST_HEAD(&bat_priv
->mcast
.want_all_unsnoopables_list
);
169 INIT_HLIST_HEAD(&bat_priv
->mcast
.want_all_ipv4_list
);
170 INIT_HLIST_HEAD(&bat_priv
->mcast
.want_all_ipv6_list
);
172 INIT_LIST_HEAD(&bat_priv
->tt
.changes_list
);
173 INIT_HLIST_HEAD(&bat_priv
->tt
.req_list
);
174 INIT_LIST_HEAD(&bat_priv
->tt
.roam_list
);
175 #ifdef CONFIG_BATMAN_ADV_MCAST
176 INIT_HLIST_HEAD(&bat_priv
->mcast
.mla_list
);
178 INIT_HLIST_HEAD(&bat_priv
->tvlv
.container_list
);
179 INIT_HLIST_HEAD(&bat_priv
->tvlv
.handler_list
);
180 INIT_HLIST_HEAD(&bat_priv
->softif_vlan_list
);
181 INIT_HLIST_HEAD(&bat_priv
->tp_list
);
183 ret
= batadv_v_mesh_init(bat_priv
);
187 ret
= batadv_originator_init(bat_priv
);
191 ret
= batadv_tt_init(bat_priv
);
195 ret
= batadv_bla_init(bat_priv
);
199 ret
= batadv_dat_init(bat_priv
);
203 ret
= batadv_nc_mesh_init(bat_priv
);
207 batadv_gw_init(bat_priv
);
208 batadv_mcast_init(bat_priv
);
210 atomic_set(&bat_priv
->gw
.reselect
, 0);
211 atomic_set(&bat_priv
->mesh_state
, BATADV_MESH_ACTIVE
);
216 batadv_mesh_free(soft_iface
);
220 void batadv_mesh_free(struct net_device
*soft_iface
)
222 struct batadv_priv
*bat_priv
= netdev_priv(soft_iface
);
224 atomic_set(&bat_priv
->mesh_state
, BATADV_MESH_DEACTIVATING
);
226 batadv_purge_outstanding_packets(bat_priv
, NULL
);
228 batadv_gw_node_free(bat_priv
);
230 batadv_v_mesh_free(bat_priv
);
231 batadv_nc_mesh_free(bat_priv
);
232 batadv_dat_free(bat_priv
);
233 batadv_bla_free(bat_priv
);
235 batadv_mcast_free(bat_priv
);
237 /* Free the TT and the originator tables only after having terminated
238 * all the other depending components which may use these structures for
241 batadv_tt_free(bat_priv
);
243 /* Since the originator table clean up routine is accessing the TT
244 * tables as well, it has to be invoked after the TT tables have been
245 * freed and marked as empty. This ensures that no cleanup RCU callbacks
246 * accessing the TT data are scheduled for later execution.
248 batadv_originator_free(bat_priv
);
250 batadv_gw_free(bat_priv
);
252 free_percpu(bat_priv
->bat_counters
);
253 bat_priv
->bat_counters
= NULL
;
255 atomic_set(&bat_priv
->mesh_state
, BATADV_MESH_INACTIVE
);
259 * batadv_is_my_mac() - check if the given mac address belongs to any of the
260 * real interfaces in the current mesh
261 * @bat_priv: the bat priv with all the soft interface information
262 * @addr: the address to check
264 * Return: 'true' if the mac address was found, false otherwise.
266 bool batadv_is_my_mac(struct batadv_priv
*bat_priv
, const u8
*addr
)
268 const struct batadv_hard_iface
*hard_iface
;
269 bool is_my_mac
= false;
272 list_for_each_entry_rcu(hard_iface
, &batadv_hardif_list
, list
) {
273 if (hard_iface
->if_status
!= BATADV_IF_ACTIVE
)
276 if (hard_iface
->soft_iface
!= bat_priv
->soft_iface
)
279 if (batadv_compare_eth(hard_iface
->net_dev
->dev_addr
, addr
)) {
288 #ifdef CONFIG_BATMAN_ADV_DEBUGFS
290 * batadv_seq_print_text_primary_if_get() - called from debugfs table printing
291 * function that requires the primary interface
292 * @seq: debugfs table seq_file struct
294 * Return: primary interface if found or NULL otherwise.
296 struct batadv_hard_iface
*
297 batadv_seq_print_text_primary_if_get(struct seq_file
*seq
)
299 struct net_device
*net_dev
= (struct net_device
*)seq
->private;
300 struct batadv_priv
*bat_priv
= netdev_priv(net_dev
);
301 struct batadv_hard_iface
*primary_if
;
303 primary_if
= batadv_primary_if_get_selected(bat_priv
);
307 "BATMAN mesh %s disabled - please specify interfaces to enable it\n",
312 if (primary_if
->if_status
== BATADV_IF_ACTIVE
)
316 "BATMAN mesh %s disabled - primary interface not active\n",
318 batadv_hardif_put(primary_if
);
327 * batadv_max_header_len() - calculate maximum encapsulation overhead for a
330 * Return: the maximum encapsulation overhead in bytes.
332 int batadv_max_header_len(void)
336 header_len
= max_t(int, header_len
,
337 sizeof(struct batadv_unicast_packet
));
338 header_len
= max_t(int, header_len
,
339 sizeof(struct batadv_unicast_4addr_packet
));
340 header_len
= max_t(int, header_len
,
341 sizeof(struct batadv_bcast_packet
));
343 #ifdef CONFIG_BATMAN_ADV_NC
344 header_len
= max_t(int, header_len
,
345 sizeof(struct batadv_coded_packet
));
348 return header_len
+ ETH_HLEN
;
352 * batadv_skb_set_priority() - sets skb priority according to packet content
353 * @skb: the packet to be sent
354 * @offset: offset to the packet content
356 * This function sets a value between 256 and 263 (802.1d priority), which
357 * can be interpreted by the cfg80211 or other drivers.
359 void batadv_skb_set_priority(struct sk_buff
*skb
, int offset
)
361 struct iphdr ip_hdr_tmp
, *ip_hdr
;
362 struct ipv6hdr ip6_hdr_tmp
, *ip6_hdr
;
363 struct ethhdr ethhdr_tmp
, *ethhdr
;
364 struct vlan_ethhdr
*vhdr
, vhdr_tmp
;
367 /* already set, do nothing */
368 if (skb
->priority
>= 256 && skb
->priority
<= 263)
371 ethhdr
= skb_header_pointer(skb
, offset
, sizeof(*ethhdr
), ðhdr_tmp
);
375 switch (ethhdr
->h_proto
) {
376 case htons(ETH_P_8021Q
):
377 vhdr
= skb_header_pointer(skb
, offset
+ sizeof(*vhdr
),
378 sizeof(*vhdr
), &vhdr_tmp
);
381 prio
= ntohs(vhdr
->h_vlan_TCI
) & VLAN_PRIO_MASK
;
382 prio
= prio
>> VLAN_PRIO_SHIFT
;
384 case htons(ETH_P_IP
):
385 ip_hdr
= skb_header_pointer(skb
, offset
+ sizeof(*ethhdr
),
386 sizeof(*ip_hdr
), &ip_hdr_tmp
);
389 prio
= (ipv4_get_dsfield(ip_hdr
) & 0xfc) >> 5;
391 case htons(ETH_P_IPV6
):
392 ip6_hdr
= skb_header_pointer(skb
, offset
+ sizeof(*ethhdr
),
393 sizeof(*ip6_hdr
), &ip6_hdr_tmp
);
396 prio
= (ipv6_get_dsfield(ip6_hdr
) & 0xfc) >> 5;
402 skb
->priority
= prio
+ 256;
405 static int batadv_recv_unhandled_packet(struct sk_buff
*skb
,
406 struct batadv_hard_iface
*recv_if
)
413 /* incoming packets with the batman ethertype received on any active hard
416 int batadv_batman_skb_recv(struct sk_buff
*skb
, struct net_device
*dev
,
417 struct packet_type
*ptype
,
418 struct net_device
*orig_dev
)
420 struct batadv_priv
*bat_priv
;
421 struct batadv_ogm_packet
*batadv_ogm_packet
;
422 struct batadv_hard_iface
*hard_iface
;
425 hard_iface
= container_of(ptype
, struct batadv_hard_iface
,
428 /* Prevent processing a packet received on an interface which is getting
429 * shut down otherwise the packet may trigger de-reference errors
430 * further down in the receive path.
432 if (!kref_get_unless_zero(&hard_iface
->refcount
))
435 skb
= skb_share_check(skb
, GFP_ATOMIC
);
437 /* skb was released by skb_share_check() */
441 /* packet should hold at least type and version */
442 if (unlikely(!pskb_may_pull(skb
, 2)))
445 /* expect a valid ethernet header here. */
446 if (unlikely(skb
->mac_len
!= ETH_HLEN
|| !skb_mac_header(skb
)))
449 if (!hard_iface
->soft_iface
)
452 bat_priv
= netdev_priv(hard_iface
->soft_iface
);
454 if (atomic_read(&bat_priv
->mesh_state
) != BATADV_MESH_ACTIVE
)
457 /* discard frames on not active interfaces */
458 if (hard_iface
->if_status
!= BATADV_IF_ACTIVE
)
461 batadv_ogm_packet
= (struct batadv_ogm_packet
*)skb
->data
;
463 if (batadv_ogm_packet
->version
!= BATADV_COMPAT_VERSION
) {
464 batadv_dbg(BATADV_DBG_BATMAN
, bat_priv
,
465 "Drop packet: incompatible batman version (%i)\n",
466 batadv_ogm_packet
->version
);
470 /* reset control block to avoid left overs from previous users */
471 memset(skb
->cb
, 0, sizeof(struct batadv_skb_cb
));
473 idx
= batadv_ogm_packet
->packet_type
;
474 (*batadv_rx_handler
[idx
])(skb
, hard_iface
);
476 batadv_hardif_put(hard_iface
);
478 /* return NET_RX_SUCCESS in any case as we
479 * most probably dropped the packet for
480 * routing-logical reasons.
482 return NET_RX_SUCCESS
;
487 batadv_hardif_put(hard_iface
);
492 static void batadv_recv_handler_init(void)
496 for (i
= 0; i
< ARRAY_SIZE(batadv_rx_handler
); i
++)
497 batadv_rx_handler
[i
] = batadv_recv_unhandled_packet
;
499 for (i
= BATADV_UNICAST_MIN
; i
<= BATADV_UNICAST_MAX
; i
++)
500 batadv_rx_handler
[i
] = batadv_recv_unhandled_unicast_packet
;
502 /* compile time checks for sizes */
503 BUILD_BUG_ON(sizeof(struct batadv_bla_claim_dst
) != 6);
504 BUILD_BUG_ON(sizeof(struct batadv_ogm_packet
) != 24);
505 BUILD_BUG_ON(sizeof(struct batadv_icmp_header
) != 20);
506 BUILD_BUG_ON(sizeof(struct batadv_icmp_packet
) != 20);
507 BUILD_BUG_ON(sizeof(struct batadv_icmp_packet_rr
) != 116);
508 BUILD_BUG_ON(sizeof(struct batadv_unicast_packet
) != 10);
509 BUILD_BUG_ON(sizeof(struct batadv_unicast_4addr_packet
) != 18);
510 BUILD_BUG_ON(sizeof(struct batadv_frag_packet
) != 20);
511 BUILD_BUG_ON(sizeof(struct batadv_bcast_packet
) != 14);
512 BUILD_BUG_ON(sizeof(struct batadv_coded_packet
) != 46);
513 BUILD_BUG_ON(sizeof(struct batadv_unicast_tvlv_packet
) != 20);
514 BUILD_BUG_ON(sizeof(struct batadv_tvlv_hdr
) != 4);
515 BUILD_BUG_ON(sizeof(struct batadv_tvlv_gateway_data
) != 8);
516 BUILD_BUG_ON(sizeof(struct batadv_tvlv_tt_vlan_data
) != 8);
517 BUILD_BUG_ON(sizeof(struct batadv_tvlv_tt_change
) != 12);
518 BUILD_BUG_ON(sizeof(struct batadv_tvlv_roam_adv
) != 8);
520 i
= FIELD_SIZEOF(struct sk_buff
, cb
);
521 BUILD_BUG_ON(sizeof(struct batadv_skb_cb
) > i
);
523 /* broadcast packet */
524 batadv_rx_handler
[BATADV_BCAST
] = batadv_recv_bcast_packet
;
526 /* unicast packets ... */
527 /* unicast with 4 addresses packet */
528 batadv_rx_handler
[BATADV_UNICAST_4ADDR
] = batadv_recv_unicast_packet
;
530 batadv_rx_handler
[BATADV_UNICAST
] = batadv_recv_unicast_packet
;
531 /* unicast tvlv packet */
532 batadv_rx_handler
[BATADV_UNICAST_TVLV
] = batadv_recv_unicast_tvlv
;
533 /* batman icmp packet */
534 batadv_rx_handler
[BATADV_ICMP
] = batadv_recv_icmp_packet
;
535 /* Fragmented packets */
536 batadv_rx_handler
[BATADV_UNICAST_FRAG
] = batadv_recv_frag_packet
;
540 batadv_recv_handler_register(u8 packet_type
,
541 int (*recv_handler
)(struct sk_buff
*,
542 struct batadv_hard_iface
*))
544 int (*curr
)(struct sk_buff
*skb
,
545 struct batadv_hard_iface
*recv_if
);
546 curr
= batadv_rx_handler
[packet_type
];
548 if (curr
!= batadv_recv_unhandled_packet
&&
549 curr
!= batadv_recv_unhandled_unicast_packet
)
552 batadv_rx_handler
[packet_type
] = recv_handler
;
556 void batadv_recv_handler_unregister(u8 packet_type
)
558 batadv_rx_handler
[packet_type
] = batadv_recv_unhandled_packet
;
562 * batadv_skb_crc32() - calculate CRC32 of the whole packet and skip bytes in
564 * @skb: skb pointing to fragmented socket buffers
565 * @payload_ptr: Pointer to position inside the head buffer of the skb
566 * marking the start of the data to be CRC'ed
568 * payload_ptr must always point to an address in the skb head buffer and not to
571 * Return: big endian crc32c of the checksummed data
573 __be32
batadv_skb_crc32(struct sk_buff
*skb
, u8
*payload_ptr
)
577 unsigned int to
= skb
->len
;
578 struct skb_seq_state st
;
581 unsigned int consumed
= 0;
583 from
= (unsigned int)(payload_ptr
- skb
->data
);
585 skb_prepare_seq_read(skb
, from
, to
, &st
);
586 while ((len
= skb_seq_read(consumed
, &data
, &st
)) != 0) {
587 crc
= crc32c(crc
, data
, len
);
595 * batadv_get_vid() - extract the VLAN identifier from skb if any
596 * @skb: the buffer containing the packet
597 * @header_len: length of the batman header preceding the ethernet header
599 * Return: VID with the BATADV_VLAN_HAS_TAG flag when the packet embedded in the
600 * skb is vlan tagged. Otherwise BATADV_NO_FLAGS.
602 unsigned short batadv_get_vid(struct sk_buff
*skb
, size_t header_len
)
604 struct ethhdr
*ethhdr
= (struct ethhdr
*)(skb
->data
+ header_len
);
605 struct vlan_ethhdr
*vhdr
;
608 if (ethhdr
->h_proto
!= htons(ETH_P_8021Q
))
609 return BATADV_NO_FLAGS
;
611 if (!pskb_may_pull(skb
, header_len
+ VLAN_ETH_HLEN
))
612 return BATADV_NO_FLAGS
;
614 vhdr
= (struct vlan_ethhdr
*)(skb
->data
+ header_len
);
615 vid
= ntohs(vhdr
->h_vlan_TCI
) & VLAN_VID_MASK
;
616 vid
|= BATADV_VLAN_HAS_TAG
;
622 * batadv_vlan_ap_isola_get() - return AP isolation status for the given vlan
623 * @bat_priv: the bat priv with all the soft interface information
624 * @vid: the VLAN identifier for which the AP isolation attributed as to be
627 * Return: true if AP isolation is on for the VLAN idenfied by vid, false
630 bool batadv_vlan_ap_isola_get(struct batadv_priv
*bat_priv
, unsigned short vid
)
632 bool ap_isolation_enabled
= false;
633 struct batadv_softif_vlan
*vlan
;
635 /* if the AP isolation is requested on a VLAN, then check for its
636 * setting in the proper VLAN private data structure
638 vlan
= batadv_softif_vlan_get(bat_priv
, vid
);
640 ap_isolation_enabled
= atomic_read(&vlan
->ap_isolation
);
641 batadv_softif_vlan_put(vlan
);
644 return ap_isolation_enabled
;
647 module_init(batadv_init
);
648 module_exit(batadv_exit
);
650 MODULE_LICENSE("GPL");
652 MODULE_AUTHOR(BATADV_DRIVER_AUTHOR
);
653 MODULE_DESCRIPTION(BATADV_DRIVER_DESC
);
654 MODULE_SUPPORTED_DEVICE(BATADV_DRIVER_DEVICE
);
655 MODULE_VERSION(BATADV_SOURCE_VERSION
);
656 MODULE_ALIAS_RTNL_LINK("batadv");
657 MODULE_ALIAS_GENL_FAMILY(BATADV_NL_NAME
);