1 /* Copyright (C) 2007-2017 B.A.T.M.A.N. contributors:
3 * Marek Lindner, Simon Wunderlich
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.
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.
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/>.
20 #include <linux/atomic.h>
21 #include <linux/bug.h>
22 #include <linux/byteorder/generic.h>
23 #include <linux/crc32c.h>
24 #include <linux/errno.h>
26 #include <linux/genetlink.h>
27 #include <linux/if_ether.h>
28 #include <linux/if_vlan.h>
29 #include <linux/init.h>
31 #include <linux/ipv6.h>
32 #include <linux/kernel.h>
33 #include <linux/kref.h>
34 #include <linux/list.h>
35 #include <linux/module.h>
36 #include <linux/netdevice.h>
37 #include <linux/printk.h>
38 #include <linux/rculist.h>
39 #include <linux/rcupdate.h>
40 #include <linux/seq_file.h>
41 #include <linux/skbuff.h>
42 #include <linux/spinlock.h>
43 #include <linux/stddef.h>
44 #include <linux/string.h>
45 #include <linux/workqueue.h>
46 #include <net/dsfield.h>
47 #include <net/rtnetlink.h>
48 #include <uapi/linux/batman_adv.h>
51 #include "bat_iv_ogm.h"
53 #include "bridge_loop_avoidance.h"
55 #include "distributed-arp-table.h"
56 #include "gateway_client.h"
57 #include "gateway_common.h"
58 #include "hard-interface.h"
59 #include "icmp_socket.h"
61 #include "multicast.h"
63 #include "network-coding.h"
64 #include "originator.h"
68 #include "soft-interface.h"
70 #include "translation-table.h"
72 /* List manipulations on hardif_list have to be rtnl_lock()'ed,
73 * list traversals just rcu-locked
75 struct list_head batadv_hardif_list;
76 static int (*batadv_rx_handler[256])(struct sk_buff *,
77 struct batadv_hard_iface *);
79 unsigned char batadv_broadcast_addr[] = {0xff, 0xff, 0xff, 0xff, 0xff, 0xff};
81 struct workqueue_struct *batadv_event_workqueue;
83 static void batadv_recv_handler_init(void);
85 static int __init batadv_init(void)
89 ret = batadv_tt_cache_init();
93 INIT_LIST_HEAD(&batadv_hardif_list);
96 batadv_recv_handler_init();
101 batadv_tp_meter_init();
103 batadv_event_workqueue = create_singlethread_workqueue("bat_events");
104 if (!batadv_event_workqueue)
107 batadv_socket_init();
108 batadv_debugfs_init();
110 register_netdevice_notifier(&batadv_hard_if_notifier);
111 rtnl_link_register(&batadv_link_ops);
112 batadv_netlink_register();
114 pr_info("B.A.T.M.A.N. advanced %s (compatibility version %i) loaded\n",
115 BATADV_SOURCE_VERSION, BATADV_COMPAT_VERSION);
120 batadv_tt_cache_destroy();
125 static void __exit batadv_exit(void)
127 batadv_debugfs_destroy();
128 batadv_netlink_unregister();
129 rtnl_link_unregister(&batadv_link_ops);
130 unregister_netdevice_notifier(&batadv_hard_if_notifier);
131 batadv_hardif_remove_interfaces();
133 flush_workqueue(batadv_event_workqueue);
134 destroy_workqueue(batadv_event_workqueue);
135 batadv_event_workqueue = NULL;
139 batadv_tt_cache_destroy();
142 int batadv_mesh_init(struct net_device *soft_iface)
144 struct batadv_priv *bat_priv = netdev_priv(soft_iface);
147 spin_lock_init(&bat_priv->forw_bat_list_lock);
148 spin_lock_init(&bat_priv->forw_bcast_list_lock);
149 spin_lock_init(&bat_priv->tt.changes_list_lock);
150 spin_lock_init(&bat_priv->tt.req_list_lock);
151 spin_lock_init(&bat_priv->tt.roam_list_lock);
152 spin_lock_init(&bat_priv->tt.last_changeset_lock);
153 spin_lock_init(&bat_priv->tt.commit_lock);
154 spin_lock_init(&bat_priv->gw.list_lock);
155 #ifdef CONFIG_BATMAN_ADV_MCAST
156 spin_lock_init(&bat_priv->mcast.mla_lock);
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_originator_init(bat_priv);
185 atomic_set(&bat_priv->mesh_state, BATADV_MESH_DEACTIVATING);
189 ret = batadv_tt_init(bat_priv);
191 atomic_set(&bat_priv->mesh_state, BATADV_MESH_DEACTIVATING);
195 ret = batadv_v_mesh_init(bat_priv);
197 atomic_set(&bat_priv->mesh_state, BATADV_MESH_DEACTIVATING);
201 ret = batadv_bla_init(bat_priv);
203 atomic_set(&bat_priv->mesh_state, BATADV_MESH_DEACTIVATING);
207 ret = batadv_dat_init(bat_priv);
209 atomic_set(&bat_priv->mesh_state, BATADV_MESH_DEACTIVATING);
213 ret = batadv_nc_mesh_init(bat_priv);
215 atomic_set(&bat_priv->mesh_state, BATADV_MESH_DEACTIVATING);
219 batadv_gw_init(bat_priv);
220 batadv_mcast_init(bat_priv);
222 atomic_set(&bat_priv->gw.reselect, 0);
223 atomic_set(&bat_priv->mesh_state, BATADV_MESH_ACTIVE);
228 batadv_dat_free(bat_priv);
230 batadv_bla_free(bat_priv);
232 batadv_v_mesh_free(bat_priv);
234 batadv_tt_free(bat_priv);
236 batadv_originator_free(bat_priv);
238 batadv_purge_outstanding_packets(bat_priv, NULL);
239 atomic_set(&bat_priv->mesh_state, BATADV_MESH_INACTIVE);
244 void batadv_mesh_free(struct net_device *soft_iface)
246 struct batadv_priv *bat_priv = netdev_priv(soft_iface);
248 atomic_set(&bat_priv->mesh_state, BATADV_MESH_DEACTIVATING);
250 batadv_purge_outstanding_packets(bat_priv, NULL);
252 batadv_gw_node_free(bat_priv);
254 batadv_v_mesh_free(bat_priv);
255 batadv_nc_mesh_free(bat_priv);
256 batadv_dat_free(bat_priv);
257 batadv_bla_free(bat_priv);
259 batadv_mcast_free(bat_priv);
261 /* Free the TT and the originator tables only after having terminated
262 * all the other depending components which may use these structures for
265 batadv_tt_free(bat_priv);
267 /* Since the originator table clean up routine is accessing the TT
268 * tables as well, it has to be invoked after the TT tables have been
269 * freed and marked as empty. This ensures that no cleanup RCU callbacks
270 * accessing the TT data are scheduled for later execution.
272 batadv_originator_free(bat_priv);
274 batadv_gw_free(bat_priv);
276 free_percpu(bat_priv->bat_counters);
277 bat_priv->bat_counters = NULL;
279 atomic_set(&bat_priv->mesh_state, BATADV_MESH_INACTIVE);
283 * batadv_is_my_mac - check if the given mac address belongs to any of the real
284 * interfaces in the current mesh
285 * @bat_priv: the bat priv with all the soft interface information
286 * @addr: the address to check
288 * Return: 'true' if the mac address was found, false otherwise.
290 bool batadv_is_my_mac(struct batadv_priv *bat_priv, const u8 *addr)
292 const struct batadv_hard_iface *hard_iface;
293 bool is_my_mac = false;
296 list_for_each_entry_rcu(hard_iface, &batadv_hardif_list, list) {
297 if (hard_iface->if_status != BATADV_IF_ACTIVE)
300 if (hard_iface->soft_iface != bat_priv->soft_iface)
303 if (batadv_compare_eth(hard_iface->net_dev->dev_addr, addr)) {
312 #ifdef CONFIG_BATMAN_ADV_DEBUGFS
314 * batadv_seq_print_text_primary_if_get - called from debugfs table printing
315 * function that requires the primary interface
316 * @seq: debugfs table seq_file struct
318 * Return: primary interface if found or NULL otherwise.
320 struct batadv_hard_iface *
321 batadv_seq_print_text_primary_if_get(struct seq_file *seq)
323 struct net_device *net_dev = (struct net_device *)seq->private;
324 struct batadv_priv *bat_priv = netdev_priv(net_dev);
325 struct batadv_hard_iface *primary_if;
327 primary_if = batadv_primary_if_get_selected(bat_priv);
331 "BATMAN mesh %s disabled - please specify interfaces to enable it\n",
336 if (primary_if->if_status == BATADV_IF_ACTIVE)
340 "BATMAN mesh %s disabled - primary interface not active\n",
342 batadv_hardif_put(primary_if);
351 * batadv_max_header_len - calculate maximum encapsulation overhead for a
354 * Return: the maximum encapsulation overhead in bytes.
356 int batadv_max_header_len(void)
360 header_len = max_t(int, header_len,
361 sizeof(struct batadv_unicast_packet));
362 header_len = max_t(int, header_len,
363 sizeof(struct batadv_unicast_4addr_packet));
364 header_len = max_t(int, header_len,
365 sizeof(struct batadv_bcast_packet));
367 #ifdef CONFIG_BATMAN_ADV_NC
368 header_len = max_t(int, header_len,
369 sizeof(struct batadv_coded_packet));
372 return header_len + ETH_HLEN;
376 * batadv_skb_set_priority - sets skb priority according to packet content
377 * @skb: the packet to be sent
378 * @offset: offset to the packet content
380 * This function sets a value between 256 and 263 (802.1d priority), which
381 * can be interpreted by the cfg80211 or other drivers.
383 void batadv_skb_set_priority(struct sk_buff *skb, int offset)
385 struct iphdr ip_hdr_tmp, *ip_hdr;
386 struct ipv6hdr ip6_hdr_tmp, *ip6_hdr;
387 struct ethhdr ethhdr_tmp, *ethhdr;
388 struct vlan_ethhdr *vhdr, vhdr_tmp;
391 /* already set, do nothing */
392 if (skb->priority >= 256 && skb->priority <= 263)
395 ethhdr = skb_header_pointer(skb, offset, sizeof(*ethhdr), ðhdr_tmp);
399 switch (ethhdr->h_proto) {
400 case htons(ETH_P_8021Q):
401 vhdr = skb_header_pointer(skb, offset + sizeof(*vhdr),
402 sizeof(*vhdr), &vhdr_tmp);
405 prio = ntohs(vhdr->h_vlan_TCI) & VLAN_PRIO_MASK;
406 prio = prio >> VLAN_PRIO_SHIFT;
408 case htons(ETH_P_IP):
409 ip_hdr = skb_header_pointer(skb, offset + sizeof(*ethhdr),
410 sizeof(*ip_hdr), &ip_hdr_tmp);
413 prio = (ipv4_get_dsfield(ip_hdr) & 0xfc) >> 5;
415 case htons(ETH_P_IPV6):
416 ip6_hdr = skb_header_pointer(skb, offset + sizeof(*ethhdr),
417 sizeof(*ip6_hdr), &ip6_hdr_tmp);
420 prio = (ipv6_get_dsfield(ip6_hdr) & 0xfc) >> 5;
426 skb->priority = prio + 256;
429 static int batadv_recv_unhandled_packet(struct sk_buff *skb,
430 struct batadv_hard_iface *recv_if)
437 /* incoming packets with the batman ethertype received on any active hard
440 int batadv_batman_skb_recv(struct sk_buff *skb, struct net_device *dev,
441 struct packet_type *ptype,
442 struct net_device *orig_dev)
444 struct batadv_priv *bat_priv;
445 struct batadv_ogm_packet *batadv_ogm_packet;
446 struct batadv_hard_iface *hard_iface;
449 hard_iface = container_of(ptype, struct batadv_hard_iface,
452 /* Prevent processing a packet received on an interface which is getting
453 * shut down otherwise the packet may trigger de-reference errors
454 * further down in the receive path.
456 if (!kref_get_unless_zero(&hard_iface->refcount))
459 skb = skb_share_check(skb, GFP_ATOMIC);
461 /* skb was released by skb_share_check() */
465 /* packet should hold at least type and version */
466 if (unlikely(!pskb_may_pull(skb, 2)))
469 /* expect a valid ethernet header here. */
470 if (unlikely(skb->mac_len != ETH_HLEN || !skb_mac_header(skb)))
473 if (!hard_iface->soft_iface)
476 bat_priv = netdev_priv(hard_iface->soft_iface);
478 if (atomic_read(&bat_priv->mesh_state) != BATADV_MESH_ACTIVE)
481 /* discard frames on not active interfaces */
482 if (hard_iface->if_status != BATADV_IF_ACTIVE)
485 batadv_ogm_packet = (struct batadv_ogm_packet *)skb->data;
487 if (batadv_ogm_packet->version != BATADV_COMPAT_VERSION) {
488 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
489 "Drop packet: incompatible batman version (%i)\n",
490 batadv_ogm_packet->version);
494 /* reset control block to avoid left overs from previous users */
495 memset(skb->cb, 0, sizeof(struct batadv_skb_cb));
497 idx = batadv_ogm_packet->packet_type;
498 (*batadv_rx_handler[idx])(skb, hard_iface);
500 batadv_hardif_put(hard_iface);
502 /* return NET_RX_SUCCESS in any case as we
503 * most probably dropped the packet for
504 * routing-logical reasons.
506 return NET_RX_SUCCESS;
511 batadv_hardif_put(hard_iface);
516 static void batadv_recv_handler_init(void)
520 for (i = 0; i < ARRAY_SIZE(batadv_rx_handler); i++)
521 batadv_rx_handler[i] = batadv_recv_unhandled_packet;
523 for (i = BATADV_UNICAST_MIN; i <= BATADV_UNICAST_MAX; i++)
524 batadv_rx_handler[i] = batadv_recv_unhandled_unicast_packet;
526 /* compile time checks for sizes */
527 BUILD_BUG_ON(sizeof(struct batadv_bla_claim_dst) != 6);
528 BUILD_BUG_ON(sizeof(struct batadv_ogm_packet) != 24);
529 BUILD_BUG_ON(sizeof(struct batadv_icmp_header) != 20);
530 BUILD_BUG_ON(sizeof(struct batadv_icmp_packet) != 20);
531 BUILD_BUG_ON(sizeof(struct batadv_icmp_packet_rr) != 116);
532 BUILD_BUG_ON(sizeof(struct batadv_unicast_packet) != 10);
533 BUILD_BUG_ON(sizeof(struct batadv_unicast_4addr_packet) != 18);
534 BUILD_BUG_ON(sizeof(struct batadv_frag_packet) != 20);
535 BUILD_BUG_ON(sizeof(struct batadv_bcast_packet) != 14);
536 BUILD_BUG_ON(sizeof(struct batadv_coded_packet) != 46);
537 BUILD_BUG_ON(sizeof(struct batadv_unicast_tvlv_packet) != 20);
538 BUILD_BUG_ON(sizeof(struct batadv_tvlv_hdr) != 4);
539 BUILD_BUG_ON(sizeof(struct batadv_tvlv_gateway_data) != 8);
540 BUILD_BUG_ON(sizeof(struct batadv_tvlv_tt_vlan_data) != 8);
541 BUILD_BUG_ON(sizeof(struct batadv_tvlv_tt_change) != 12);
542 BUILD_BUG_ON(sizeof(struct batadv_tvlv_roam_adv) != 8);
544 i = FIELD_SIZEOF(struct sk_buff, cb);
545 BUILD_BUG_ON(sizeof(struct batadv_skb_cb) > i);
547 /* broadcast packet */
548 batadv_rx_handler[BATADV_BCAST] = batadv_recv_bcast_packet;
550 /* unicast packets ... */
551 /* unicast with 4 addresses packet */
552 batadv_rx_handler[BATADV_UNICAST_4ADDR] = batadv_recv_unicast_packet;
554 batadv_rx_handler[BATADV_UNICAST] = batadv_recv_unicast_packet;
555 /* unicast tvlv packet */
556 batadv_rx_handler[BATADV_UNICAST_TVLV] = batadv_recv_unicast_tvlv;
557 /* batman icmp packet */
558 batadv_rx_handler[BATADV_ICMP] = batadv_recv_icmp_packet;
559 /* Fragmented packets */
560 batadv_rx_handler[BATADV_UNICAST_FRAG] = batadv_recv_frag_packet;
564 batadv_recv_handler_register(u8 packet_type,
565 int (*recv_handler)(struct sk_buff *,
566 struct batadv_hard_iface *))
568 int (*curr)(struct sk_buff *,
569 struct batadv_hard_iface *);
570 curr = batadv_rx_handler[packet_type];
572 if ((curr != batadv_recv_unhandled_packet) &&
573 (curr != batadv_recv_unhandled_unicast_packet))
576 batadv_rx_handler[packet_type] = recv_handler;
580 void batadv_recv_handler_unregister(u8 packet_type)
582 batadv_rx_handler[packet_type] = batadv_recv_unhandled_packet;
586 * batadv_skb_crc32 - calculate CRC32 of the whole packet and skip bytes in
588 * @skb: skb pointing to fragmented socket buffers
589 * @payload_ptr: Pointer to position inside the head buffer of the skb
590 * marking the start of the data to be CRC'ed
592 * payload_ptr must always point to an address in the skb head buffer and not to
595 * Return: big endian crc32c of the checksummed data
597 __be32 batadv_skb_crc32(struct sk_buff *skb, u8 *payload_ptr)
601 unsigned int to = skb->len;
602 struct skb_seq_state st;
605 unsigned int consumed = 0;
607 from = (unsigned int)(payload_ptr - skb->data);
609 skb_prepare_seq_read(skb, from, to, &st);
610 while ((len = skb_seq_read(consumed, &data, &st)) != 0) {
611 crc = crc32c(crc, data, len);
619 * batadv_get_vid - extract the VLAN identifier from skb if any
620 * @skb: the buffer containing the packet
621 * @header_len: length of the batman header preceding the ethernet header
623 * Return: VID with the BATADV_VLAN_HAS_TAG flag when the packet embedded in the
624 * skb is vlan tagged. Otherwise BATADV_NO_FLAGS.
626 unsigned short batadv_get_vid(struct sk_buff *skb, size_t header_len)
628 struct ethhdr *ethhdr = (struct ethhdr *)(skb->data + header_len);
629 struct vlan_ethhdr *vhdr;
632 if (ethhdr->h_proto != htons(ETH_P_8021Q))
633 return BATADV_NO_FLAGS;
635 if (!pskb_may_pull(skb, header_len + VLAN_ETH_HLEN))
636 return BATADV_NO_FLAGS;
638 vhdr = (struct vlan_ethhdr *)(skb->data + header_len);
639 vid = ntohs(vhdr->h_vlan_TCI) & VLAN_VID_MASK;
640 vid |= BATADV_VLAN_HAS_TAG;
646 * batadv_vlan_ap_isola_get - return the AP isolation status for the given vlan
647 * @bat_priv: the bat priv with all the soft interface information
648 * @vid: the VLAN identifier for which the AP isolation attributed as to be
651 * Return: true if AP isolation is on for the VLAN idenfied by vid, false
654 bool batadv_vlan_ap_isola_get(struct batadv_priv *bat_priv, unsigned short vid)
656 bool ap_isolation_enabled = false;
657 struct batadv_softif_vlan *vlan;
659 /* if the AP isolation is requested on a VLAN, then check for its
660 * setting in the proper VLAN private data structure
662 vlan = batadv_softif_vlan_get(bat_priv, vid);
664 ap_isolation_enabled = atomic_read(&vlan->ap_isolation);
665 batadv_softif_vlan_put(vlan);
668 return ap_isolation_enabled;
671 module_init(batadv_init);
672 module_exit(batadv_exit);
674 MODULE_LICENSE("GPL");
676 MODULE_AUTHOR(BATADV_DRIVER_AUTHOR);
677 MODULE_DESCRIPTION(BATADV_DRIVER_DESC);
678 MODULE_SUPPORTED_DEVICE(BATADV_DRIVER_DEVICE);
679 MODULE_VERSION(BATADV_SOURCE_VERSION);
680 MODULE_ALIAS_RTNL_LINK("batadv");
681 MODULE_ALIAS_GENL_FAMILY(BATADV_NL_NAME);