1 /* Copyright (C) 2007-2016 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/if_ether.h>
27 #include <linux/if_vlan.h>
28 #include <linux/init.h>
30 #include <linux/ipv6.h>
31 #include <linux/kernel.h>
32 #include <linux/kref.h>
33 #include <linux/list.h>
34 #include <linux/lockdep.h>
35 #include <linux/module.h>
36 #include <linux/moduleparam.h>
37 #include <linux/netdevice.h>
38 #include <linux/pkt_sched.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/slab.h>
44 #include <linux/spinlock.h>
45 #include <linux/stddef.h>
46 #include <linux/string.h>
47 #include <linux/workqueue.h>
48 #include <net/dsfield.h>
49 #include <net/rtnetlink.h>
52 #include "bridge_loop_avoidance.h"
54 #include "distributed-arp-table.h"
55 #include "gateway_client.h"
56 #include "gateway_common.h"
57 #include "hard-interface.h"
58 #include "icmp_socket.h"
59 #include "multicast.h"
60 #include "network-coding.h"
61 #include "originator.h"
65 #include "soft-interface.h"
66 #include "translation-table.h"
68 /* List manipulations on hardif_list have to be rtnl_lock()'ed,
69 * list traversals just rcu-locked
71 struct list_head batadv_hardif_list;
72 static int (*batadv_rx_handler[256])(struct sk_buff *,
73 struct batadv_hard_iface *);
74 char batadv_routing_algo[20] = "BATMAN_IV";
75 static struct hlist_head batadv_algo_list;
77 unsigned char batadv_broadcast_addr[] = {0xff, 0xff, 0xff, 0xff, 0xff, 0xff};
79 struct workqueue_struct *batadv_event_workqueue;
81 static void batadv_recv_handler_init(void);
83 static int __init batadv_init(void)
85 INIT_LIST_HEAD(&batadv_hardif_list);
86 INIT_HLIST_HEAD(&batadv_algo_list);
88 batadv_recv_handler_init();
94 batadv_event_workqueue = create_singlethread_workqueue("bat_events");
96 if (!batadv_event_workqueue)
100 batadv_debugfs_init();
102 register_netdevice_notifier(&batadv_hard_if_notifier);
103 rtnl_link_register(&batadv_link_ops);
105 pr_info("B.A.T.M.A.N. advanced %s (compatibility version %i) loaded\n",
106 BATADV_SOURCE_VERSION, BATADV_COMPAT_VERSION);
111 static void __exit batadv_exit(void)
113 batadv_debugfs_destroy();
114 rtnl_link_unregister(&batadv_link_ops);
115 unregister_netdevice_notifier(&batadv_hard_if_notifier);
116 batadv_hardif_remove_interfaces();
118 flush_workqueue(batadv_event_workqueue);
119 destroy_workqueue(batadv_event_workqueue);
120 batadv_event_workqueue = NULL;
125 int batadv_mesh_init(struct net_device *soft_iface)
127 struct batadv_priv *bat_priv = netdev_priv(soft_iface);
130 spin_lock_init(&bat_priv->forw_bat_list_lock);
131 spin_lock_init(&bat_priv->forw_bcast_list_lock);
132 spin_lock_init(&bat_priv->tt.changes_list_lock);
133 spin_lock_init(&bat_priv->tt.req_list_lock);
134 spin_lock_init(&bat_priv->tt.roam_list_lock);
135 spin_lock_init(&bat_priv->tt.last_changeset_lock);
136 spin_lock_init(&bat_priv->tt.commit_lock);
137 spin_lock_init(&bat_priv->gw.list_lock);
138 #ifdef CONFIG_BATMAN_ADV_MCAST
139 spin_lock_init(&bat_priv->mcast.want_lists_lock);
141 spin_lock_init(&bat_priv->tvlv.container_list_lock);
142 spin_lock_init(&bat_priv->tvlv.handler_list_lock);
143 spin_lock_init(&bat_priv->softif_vlan_list_lock);
145 INIT_HLIST_HEAD(&bat_priv->forw_bat_list);
146 INIT_HLIST_HEAD(&bat_priv->forw_bcast_list);
147 INIT_HLIST_HEAD(&bat_priv->gw.list);
148 #ifdef CONFIG_BATMAN_ADV_MCAST
149 INIT_HLIST_HEAD(&bat_priv->mcast.want_all_unsnoopables_list);
150 INIT_HLIST_HEAD(&bat_priv->mcast.want_all_ipv4_list);
151 INIT_HLIST_HEAD(&bat_priv->mcast.want_all_ipv6_list);
153 INIT_LIST_HEAD(&bat_priv->tt.changes_list);
154 INIT_HLIST_HEAD(&bat_priv->tt.req_list);
155 INIT_LIST_HEAD(&bat_priv->tt.roam_list);
156 #ifdef CONFIG_BATMAN_ADV_MCAST
157 INIT_HLIST_HEAD(&bat_priv->mcast.mla_list);
159 INIT_HLIST_HEAD(&bat_priv->tvlv.container_list);
160 INIT_HLIST_HEAD(&bat_priv->tvlv.handler_list);
161 INIT_HLIST_HEAD(&bat_priv->softif_vlan_list);
163 ret = batadv_v_mesh_init(bat_priv);
167 ret = batadv_originator_init(bat_priv);
171 ret = batadv_tt_init(bat_priv);
175 ret = batadv_bla_init(bat_priv);
179 ret = batadv_dat_init(bat_priv);
183 ret = batadv_nc_mesh_init(bat_priv);
187 batadv_gw_init(bat_priv);
188 batadv_mcast_init(bat_priv);
190 atomic_set(&bat_priv->gw.reselect, 0);
191 atomic_set(&bat_priv->mesh_state, BATADV_MESH_ACTIVE);
196 batadv_mesh_free(soft_iface);
200 void batadv_mesh_free(struct net_device *soft_iface)
202 struct batadv_priv *bat_priv = netdev_priv(soft_iface);
204 atomic_set(&bat_priv->mesh_state, BATADV_MESH_DEACTIVATING);
206 batadv_purge_outstanding_packets(bat_priv, NULL);
208 batadv_gw_node_free(bat_priv);
210 batadv_v_mesh_free(bat_priv);
211 batadv_nc_mesh_free(bat_priv);
212 batadv_dat_free(bat_priv);
213 batadv_bla_free(bat_priv);
215 batadv_mcast_free(bat_priv);
217 /* Free the TT and the originator tables only after having terminated
218 * all the other depending components which may use these structures for
221 batadv_tt_free(bat_priv);
223 /* Since the originator table clean up routine is accessing the TT
224 * tables as well, it has to be invoked after the TT tables have been
225 * freed and marked as empty. This ensures that no cleanup RCU callbacks
226 * accessing the TT data are scheduled for later execution.
228 batadv_originator_free(bat_priv);
230 batadv_gw_free(bat_priv);
232 free_percpu(bat_priv->bat_counters);
233 bat_priv->bat_counters = NULL;
235 atomic_set(&bat_priv->mesh_state, BATADV_MESH_INACTIVE);
239 * batadv_is_my_mac - check if the given mac address belongs to any of the real
240 * interfaces in the current mesh
241 * @bat_priv: the bat priv with all the soft interface information
242 * @addr: the address to check
244 * Return: 'true' if the mac address was found, false otherwise.
246 bool batadv_is_my_mac(struct batadv_priv *bat_priv, const u8 *addr)
248 const struct batadv_hard_iface *hard_iface;
249 bool is_my_mac = false;
252 list_for_each_entry_rcu(hard_iface, &batadv_hardif_list, list) {
253 if (hard_iface->if_status != BATADV_IF_ACTIVE)
256 if (hard_iface->soft_iface != bat_priv->soft_iface)
259 if (batadv_compare_eth(hard_iface->net_dev->dev_addr, addr)) {
269 * batadv_seq_print_text_primary_if_get - called from debugfs table printing
270 * function that requires the primary interface
271 * @seq: debugfs table seq_file struct
273 * Return: primary interface if found or NULL otherwise.
275 struct batadv_hard_iface *
276 batadv_seq_print_text_primary_if_get(struct seq_file *seq)
278 struct net_device *net_dev = (struct net_device *)seq->private;
279 struct batadv_priv *bat_priv = netdev_priv(net_dev);
280 struct batadv_hard_iface *primary_if;
282 primary_if = batadv_primary_if_get_selected(bat_priv);
286 "BATMAN mesh %s disabled - please specify interfaces to enable it\n",
291 if (primary_if->if_status == BATADV_IF_ACTIVE)
295 "BATMAN mesh %s disabled - primary interface not active\n",
297 batadv_hardif_put(primary_if);
305 * batadv_max_header_len - calculate maximum encapsulation overhead for a
308 * Return: the maximum encapsulation overhead in bytes.
310 int batadv_max_header_len(void)
314 header_len = max_t(int, header_len,
315 sizeof(struct batadv_unicast_packet));
316 header_len = max_t(int, header_len,
317 sizeof(struct batadv_unicast_4addr_packet));
318 header_len = max_t(int, header_len,
319 sizeof(struct batadv_bcast_packet));
321 #ifdef CONFIG_BATMAN_ADV_NC
322 header_len = max_t(int, header_len,
323 sizeof(struct batadv_coded_packet));
326 return header_len + ETH_HLEN;
330 * batadv_skb_set_priority - sets skb priority according to packet content
331 * @skb: the packet to be sent
332 * @offset: offset to the packet content
334 * This function sets a value between 256 and 263 (802.1d priority), which
335 * can be interpreted by the cfg80211 or other drivers.
337 void batadv_skb_set_priority(struct sk_buff *skb, int offset)
339 struct iphdr ip_hdr_tmp, *ip_hdr;
340 struct ipv6hdr ip6_hdr_tmp, *ip6_hdr;
341 struct ethhdr ethhdr_tmp, *ethhdr;
342 struct vlan_ethhdr *vhdr, vhdr_tmp;
345 /* already set, do nothing */
346 if (skb->priority >= 256 && skb->priority <= 263)
349 ethhdr = skb_header_pointer(skb, offset, sizeof(*ethhdr), ðhdr_tmp);
353 switch (ethhdr->h_proto) {
354 case htons(ETH_P_8021Q):
355 vhdr = skb_header_pointer(skb, offset + sizeof(*vhdr),
356 sizeof(*vhdr), &vhdr_tmp);
359 prio = ntohs(vhdr->h_vlan_TCI) & VLAN_PRIO_MASK;
360 prio = prio >> VLAN_PRIO_SHIFT;
362 case htons(ETH_P_IP):
363 ip_hdr = skb_header_pointer(skb, offset + sizeof(*ethhdr),
364 sizeof(*ip_hdr), &ip_hdr_tmp);
367 prio = (ipv4_get_dsfield(ip_hdr) & 0xfc) >> 5;
369 case htons(ETH_P_IPV6):
370 ip6_hdr = skb_header_pointer(skb, offset + sizeof(*ethhdr),
371 sizeof(*ip6_hdr), &ip6_hdr_tmp);
374 prio = (ipv6_get_dsfield(ip6_hdr) & 0xfc) >> 5;
380 skb->priority = prio + 256;
383 static int batadv_recv_unhandled_packet(struct sk_buff *skb,
384 struct batadv_hard_iface *recv_if)
389 /* incoming packets with the batman ethertype received on any active hard
392 int batadv_batman_skb_recv(struct sk_buff *skb, struct net_device *dev,
393 struct packet_type *ptype,
394 struct net_device *orig_dev)
396 struct batadv_priv *bat_priv;
397 struct batadv_ogm_packet *batadv_ogm_packet;
398 struct batadv_hard_iface *hard_iface;
402 hard_iface = container_of(ptype, struct batadv_hard_iface,
405 /* Prevent processing a packet received on an interface which is getting
406 * shut down otherwise the packet may trigger de-reference errors
407 * further down in the receive path.
409 if (!kref_get_unless_zero(&hard_iface->refcount))
412 skb = skb_share_check(skb, GFP_ATOMIC);
414 /* skb was released by skb_share_check() */
418 /* packet should hold at least type and version */
419 if (unlikely(!pskb_may_pull(skb, 2)))
422 /* expect a valid ethernet header here. */
423 if (unlikely(skb->mac_len != ETH_HLEN || !skb_mac_header(skb)))
426 if (!hard_iface->soft_iface)
429 bat_priv = netdev_priv(hard_iface->soft_iface);
431 if (atomic_read(&bat_priv->mesh_state) != BATADV_MESH_ACTIVE)
434 /* discard frames on not active interfaces */
435 if (hard_iface->if_status != BATADV_IF_ACTIVE)
438 batadv_ogm_packet = (struct batadv_ogm_packet *)skb->data;
440 if (batadv_ogm_packet->version != BATADV_COMPAT_VERSION) {
441 batadv_dbg(BATADV_DBG_BATMAN, bat_priv,
442 "Drop packet: incompatible batman version (%i)\n",
443 batadv_ogm_packet->version);
447 /* reset control block to avoid left overs from previous users */
448 memset(skb->cb, 0, sizeof(struct batadv_skb_cb));
450 /* all receive handlers return whether they received or reused
451 * the supplied skb. if not, we have to free the skb.
453 idx = batadv_ogm_packet->packet_type;
454 ret = (*batadv_rx_handler[idx])(skb, hard_iface);
456 if (ret == NET_RX_DROP)
459 batadv_hardif_put(hard_iface);
461 /* return NET_RX_SUCCESS in any case as we
462 * most probably dropped the packet for
463 * routing-logical reasons.
465 return NET_RX_SUCCESS;
470 batadv_hardif_put(hard_iface);
475 static void batadv_recv_handler_init(void)
479 for (i = 0; i < ARRAY_SIZE(batadv_rx_handler); i++)
480 batadv_rx_handler[i] = batadv_recv_unhandled_packet;
482 for (i = BATADV_UNICAST_MIN; i <= BATADV_UNICAST_MAX; i++)
483 batadv_rx_handler[i] = batadv_recv_unhandled_unicast_packet;
485 /* compile time checks for sizes */
486 BUILD_BUG_ON(sizeof(struct batadv_bla_claim_dst) != 6);
487 BUILD_BUG_ON(sizeof(struct batadv_ogm_packet) != 24);
488 BUILD_BUG_ON(sizeof(struct batadv_icmp_header) != 20);
489 BUILD_BUG_ON(sizeof(struct batadv_icmp_packet) != 20);
490 BUILD_BUG_ON(sizeof(struct batadv_icmp_packet_rr) != 116);
491 BUILD_BUG_ON(sizeof(struct batadv_unicast_packet) != 10);
492 BUILD_BUG_ON(sizeof(struct batadv_unicast_4addr_packet) != 18);
493 BUILD_BUG_ON(sizeof(struct batadv_frag_packet) != 20);
494 BUILD_BUG_ON(sizeof(struct batadv_bcast_packet) != 14);
495 BUILD_BUG_ON(sizeof(struct batadv_coded_packet) != 46);
496 BUILD_BUG_ON(sizeof(struct batadv_unicast_tvlv_packet) != 20);
497 BUILD_BUG_ON(sizeof(struct batadv_tvlv_hdr) != 4);
498 BUILD_BUG_ON(sizeof(struct batadv_tvlv_gateway_data) != 8);
499 BUILD_BUG_ON(sizeof(struct batadv_tvlv_tt_vlan_data) != 8);
500 BUILD_BUG_ON(sizeof(struct batadv_tvlv_tt_change) != 12);
501 BUILD_BUG_ON(sizeof(struct batadv_tvlv_roam_adv) != 8);
503 /* broadcast packet */
504 batadv_rx_handler[BATADV_BCAST] = batadv_recv_bcast_packet;
506 /* unicast packets ... */
507 /* unicast with 4 addresses packet */
508 batadv_rx_handler[BATADV_UNICAST_4ADDR] = batadv_recv_unicast_packet;
510 batadv_rx_handler[BATADV_UNICAST] = batadv_recv_unicast_packet;
511 /* unicast tvlv packet */
512 batadv_rx_handler[BATADV_UNICAST_TVLV] = batadv_recv_unicast_tvlv;
513 /* batman icmp packet */
514 batadv_rx_handler[BATADV_ICMP] = batadv_recv_icmp_packet;
515 /* Fragmented packets */
516 batadv_rx_handler[BATADV_UNICAST_FRAG] = batadv_recv_frag_packet;
520 batadv_recv_handler_register(u8 packet_type,
521 int (*recv_handler)(struct sk_buff *,
522 struct batadv_hard_iface *))
524 int (*curr)(struct sk_buff *,
525 struct batadv_hard_iface *);
526 curr = batadv_rx_handler[packet_type];
528 if ((curr != batadv_recv_unhandled_packet) &&
529 (curr != batadv_recv_unhandled_unicast_packet))
532 batadv_rx_handler[packet_type] = recv_handler;
536 void batadv_recv_handler_unregister(u8 packet_type)
538 batadv_rx_handler[packet_type] = batadv_recv_unhandled_packet;
541 static struct batadv_algo_ops *batadv_algo_get(char *name)
543 struct batadv_algo_ops *bat_algo_ops = NULL, *bat_algo_ops_tmp;
545 hlist_for_each_entry(bat_algo_ops_tmp, &batadv_algo_list, list) {
546 if (strcmp(bat_algo_ops_tmp->name, name) != 0)
549 bat_algo_ops = bat_algo_ops_tmp;
556 int batadv_algo_register(struct batadv_algo_ops *bat_algo_ops)
558 struct batadv_algo_ops *bat_algo_ops_tmp;
560 bat_algo_ops_tmp = batadv_algo_get(bat_algo_ops->name);
561 if (bat_algo_ops_tmp) {
562 pr_info("Trying to register already registered routing algorithm: %s\n",
567 /* all algorithms must implement all ops (for now) */
568 if (!bat_algo_ops->bat_iface_enable ||
569 !bat_algo_ops->bat_iface_disable ||
570 !bat_algo_ops->bat_iface_update_mac ||
571 !bat_algo_ops->bat_primary_iface_set ||
572 !bat_algo_ops->bat_ogm_schedule ||
573 !bat_algo_ops->bat_ogm_emit ||
574 !bat_algo_ops->bat_neigh_cmp ||
575 !bat_algo_ops->bat_neigh_is_similar_or_better) {
576 pr_info("Routing algo '%s' does not implement required ops\n",
581 INIT_HLIST_NODE(&bat_algo_ops->list);
582 hlist_add_head(&bat_algo_ops->list, &batadv_algo_list);
587 int batadv_algo_select(struct batadv_priv *bat_priv, char *name)
589 struct batadv_algo_ops *bat_algo_ops;
591 bat_algo_ops = batadv_algo_get(name);
595 bat_priv->bat_algo_ops = bat_algo_ops;
600 int batadv_algo_seq_print_text(struct seq_file *seq, void *offset)
602 struct batadv_algo_ops *bat_algo_ops;
604 seq_puts(seq, "Available routing algorithms:\n");
606 hlist_for_each_entry(bat_algo_ops, &batadv_algo_list, list) {
607 seq_printf(seq, " * %s\n", bat_algo_ops->name);
614 * batadv_skb_crc32 - calculate CRC32 of the whole packet and skip bytes in
616 * @skb: skb pointing to fragmented socket buffers
617 * @payload_ptr: Pointer to position inside the head buffer of the skb
618 * marking the start of the data to be CRC'ed
620 * payload_ptr must always point to an address in the skb head buffer and not to
623 * Return: big endian crc32c of the checksummed data
625 __be32 batadv_skb_crc32(struct sk_buff *skb, u8 *payload_ptr)
629 unsigned int to = skb->len;
630 struct skb_seq_state st;
633 unsigned int consumed = 0;
635 from = (unsigned int)(payload_ptr - skb->data);
637 skb_prepare_seq_read(skb, from, to, &st);
638 while ((len = skb_seq_read(consumed, &data, &st)) != 0) {
639 crc = crc32c(crc, data, len);
647 * batadv_tvlv_handler_release - release tvlv handler from lists and queue for
648 * free after rcu grace period
649 * @ref: kref pointer of the tvlv
651 static void batadv_tvlv_handler_release(struct kref *ref)
653 struct batadv_tvlv_handler *tvlv_handler;
655 tvlv_handler = container_of(ref, struct batadv_tvlv_handler, refcount);
656 kfree_rcu(tvlv_handler, rcu);
660 * batadv_tvlv_handler_put - decrement the tvlv container refcounter and
661 * possibly release it
662 * @tvlv_handler: the tvlv handler to free
664 static void batadv_tvlv_handler_put(struct batadv_tvlv_handler *tvlv_handler)
666 kref_put(&tvlv_handler->refcount, batadv_tvlv_handler_release);
670 * batadv_tvlv_handler_get - retrieve tvlv handler from the tvlv handler list
671 * based on the provided type and version (both need to match)
672 * @bat_priv: the bat priv with all the soft interface information
673 * @type: tvlv handler type to look for
674 * @version: tvlv handler version to look for
676 * Return: tvlv handler if found or NULL otherwise.
678 static struct batadv_tvlv_handler *
679 batadv_tvlv_handler_get(struct batadv_priv *bat_priv, u8 type, u8 version)
681 struct batadv_tvlv_handler *tvlv_handler_tmp, *tvlv_handler = NULL;
684 hlist_for_each_entry_rcu(tvlv_handler_tmp,
685 &bat_priv->tvlv.handler_list, list) {
686 if (tvlv_handler_tmp->type != type)
689 if (tvlv_handler_tmp->version != version)
692 if (!kref_get_unless_zero(&tvlv_handler_tmp->refcount))
695 tvlv_handler = tvlv_handler_tmp;
704 * batadv_tvlv_container_release - release tvlv from lists and free
705 * @ref: kref pointer of the tvlv
707 static void batadv_tvlv_container_release(struct kref *ref)
709 struct batadv_tvlv_container *tvlv;
711 tvlv = container_of(ref, struct batadv_tvlv_container, refcount);
716 * batadv_tvlv_container_put - decrement the tvlv container refcounter and
717 * possibly release it
718 * @tvlv: the tvlv container to free
720 static void batadv_tvlv_container_put(struct batadv_tvlv_container *tvlv)
722 kref_put(&tvlv->refcount, batadv_tvlv_container_release);
726 * batadv_tvlv_container_get - retrieve tvlv container from the tvlv container
727 * list based on the provided type and version (both need to match)
728 * @bat_priv: the bat priv with all the soft interface information
729 * @type: tvlv container type to look for
730 * @version: tvlv container version to look for
732 * Has to be called with the appropriate locks being acquired
733 * (tvlv.container_list_lock).
735 * Return: tvlv container if found or NULL otherwise.
737 static struct batadv_tvlv_container *
738 batadv_tvlv_container_get(struct batadv_priv *bat_priv, u8 type, u8 version)
740 struct batadv_tvlv_container *tvlv_tmp, *tvlv = NULL;
742 lockdep_assert_held(&bat_priv->tvlv.container_list_lock);
744 hlist_for_each_entry(tvlv_tmp, &bat_priv->tvlv.container_list, list) {
745 if (tvlv_tmp->tvlv_hdr.type != type)
748 if (tvlv_tmp->tvlv_hdr.version != version)
751 kref_get(&tvlv_tmp->refcount);
760 * batadv_tvlv_container_list_size - calculate the size of the tvlv container
762 * @bat_priv: the bat priv with all the soft interface information
764 * Has to be called with the appropriate locks being acquired
765 * (tvlv.container_list_lock).
767 * Return: size of all currently registered tvlv containers in bytes.
769 static u16 batadv_tvlv_container_list_size(struct batadv_priv *bat_priv)
771 struct batadv_tvlv_container *tvlv;
774 lockdep_assert_held(&bat_priv->tvlv.container_list_lock);
776 hlist_for_each_entry(tvlv, &bat_priv->tvlv.container_list, list) {
777 tvlv_len += sizeof(struct batadv_tvlv_hdr);
778 tvlv_len += ntohs(tvlv->tvlv_hdr.len);
785 * batadv_tvlv_container_remove - remove tvlv container from the tvlv container
787 * @bat_priv: the bat priv with all the soft interface information
788 * @tvlv: the to be removed tvlv container
790 * Has to be called with the appropriate locks being acquired
791 * (tvlv.container_list_lock).
793 static void batadv_tvlv_container_remove(struct batadv_priv *bat_priv,
794 struct batadv_tvlv_container *tvlv)
796 lockdep_assert_held(&bat_priv->tvlv.container_list_lock);
801 hlist_del(&tvlv->list);
803 /* first call to decrement the counter, second call to free */
804 batadv_tvlv_container_put(tvlv);
805 batadv_tvlv_container_put(tvlv);
809 * batadv_tvlv_container_unregister - unregister tvlv container based on the
810 * provided type and version (both need to match)
811 * @bat_priv: the bat priv with all the soft interface information
812 * @type: tvlv container type to unregister
813 * @version: tvlv container type to unregister
815 void batadv_tvlv_container_unregister(struct batadv_priv *bat_priv,
818 struct batadv_tvlv_container *tvlv;
820 spin_lock_bh(&bat_priv->tvlv.container_list_lock);
821 tvlv = batadv_tvlv_container_get(bat_priv, type, version);
822 batadv_tvlv_container_remove(bat_priv, tvlv);
823 spin_unlock_bh(&bat_priv->tvlv.container_list_lock);
827 * batadv_tvlv_container_register - register tvlv type, version and content
828 * to be propagated with each (primary interface) OGM
829 * @bat_priv: the bat priv with all the soft interface information
830 * @type: tvlv container type
831 * @version: tvlv container version
832 * @tvlv_value: tvlv container content
833 * @tvlv_value_len: tvlv container content length
835 * If a container of the same type and version was already registered the new
836 * content is going to replace the old one.
838 void batadv_tvlv_container_register(struct batadv_priv *bat_priv,
840 void *tvlv_value, u16 tvlv_value_len)
842 struct batadv_tvlv_container *tvlv_old, *tvlv_new;
847 tvlv_new = kzalloc(sizeof(*tvlv_new) + tvlv_value_len, GFP_ATOMIC);
851 tvlv_new->tvlv_hdr.version = version;
852 tvlv_new->tvlv_hdr.type = type;
853 tvlv_new->tvlv_hdr.len = htons(tvlv_value_len);
855 memcpy(tvlv_new + 1, tvlv_value, ntohs(tvlv_new->tvlv_hdr.len));
856 INIT_HLIST_NODE(&tvlv_new->list);
857 kref_init(&tvlv_new->refcount);
859 spin_lock_bh(&bat_priv->tvlv.container_list_lock);
860 tvlv_old = batadv_tvlv_container_get(bat_priv, type, version);
861 batadv_tvlv_container_remove(bat_priv, tvlv_old);
862 hlist_add_head(&tvlv_new->list, &bat_priv->tvlv.container_list);
863 spin_unlock_bh(&bat_priv->tvlv.container_list_lock);
867 * batadv_tvlv_realloc_packet_buff - reallocate packet buffer to accommodate
868 * requested packet size
869 * @packet_buff: packet buffer
870 * @packet_buff_len: packet buffer size
871 * @min_packet_len: requested packet minimum size
872 * @additional_packet_len: requested additional packet size on top of minimum
875 * Return: true of the packet buffer could be changed to the requested size,
878 static bool batadv_tvlv_realloc_packet_buff(unsigned char **packet_buff,
879 int *packet_buff_len,
881 int additional_packet_len)
883 unsigned char *new_buff;
885 new_buff = kmalloc(min_packet_len + additional_packet_len, GFP_ATOMIC);
887 /* keep old buffer if kmalloc should fail */
891 memcpy(new_buff, *packet_buff, min_packet_len);
893 *packet_buff = new_buff;
894 *packet_buff_len = min_packet_len + additional_packet_len;
900 * batadv_tvlv_container_ogm_append - append tvlv container content to given
902 * @bat_priv: the bat priv with all the soft interface information
903 * @packet_buff: ogm packet buffer
904 * @packet_buff_len: ogm packet buffer size including ogm header and tvlv
906 * @packet_min_len: ogm header size to be preserved for the OGM itself
908 * The ogm packet might be enlarged or shrunk depending on the current size
909 * and the size of the to-be-appended tvlv containers.
911 * Return: size of all appended tvlv containers in bytes.
913 u16 batadv_tvlv_container_ogm_append(struct batadv_priv *bat_priv,
914 unsigned char **packet_buff,
915 int *packet_buff_len, int packet_min_len)
917 struct batadv_tvlv_container *tvlv;
918 struct batadv_tvlv_hdr *tvlv_hdr;
923 spin_lock_bh(&bat_priv->tvlv.container_list_lock);
924 tvlv_value_len = batadv_tvlv_container_list_size(bat_priv);
926 ret = batadv_tvlv_realloc_packet_buff(packet_buff, packet_buff_len,
927 packet_min_len, tvlv_value_len);
935 tvlv_value = (*packet_buff) + packet_min_len;
937 hlist_for_each_entry(tvlv, &bat_priv->tvlv.container_list, list) {
938 tvlv_hdr = tvlv_value;
939 tvlv_hdr->type = tvlv->tvlv_hdr.type;
940 tvlv_hdr->version = tvlv->tvlv_hdr.version;
941 tvlv_hdr->len = tvlv->tvlv_hdr.len;
942 tvlv_value = tvlv_hdr + 1;
943 memcpy(tvlv_value, tvlv + 1, ntohs(tvlv->tvlv_hdr.len));
944 tvlv_value = (u8 *)tvlv_value + ntohs(tvlv->tvlv_hdr.len);
948 spin_unlock_bh(&bat_priv->tvlv.container_list_lock);
949 return tvlv_value_len;
953 * batadv_tvlv_call_handler - parse the given tvlv buffer to call the
954 * appropriate handlers
955 * @bat_priv: the bat priv with all the soft interface information
956 * @tvlv_handler: tvlv callback function handling the tvlv content
957 * @ogm_source: flag indicating whether the tvlv is an ogm or a unicast packet
958 * @orig_node: orig node emitting the ogm packet
959 * @src: source mac address of the unicast packet
960 * @dst: destination mac address of the unicast packet
961 * @tvlv_value: tvlv content
962 * @tvlv_value_len: tvlv content length
964 * Return: success if handler was not found or the return value of the handler
967 static int batadv_tvlv_call_handler(struct batadv_priv *bat_priv,
968 struct batadv_tvlv_handler *tvlv_handler,
970 struct batadv_orig_node *orig_node,
972 void *tvlv_value, u16 tvlv_value_len)
975 return NET_RX_SUCCESS;
978 if (!tvlv_handler->ogm_handler)
979 return NET_RX_SUCCESS;
982 return NET_RX_SUCCESS;
984 tvlv_handler->ogm_handler(bat_priv, orig_node,
986 tvlv_value, tvlv_value_len);
987 tvlv_handler->flags |= BATADV_TVLV_HANDLER_OGM_CALLED;
990 return NET_RX_SUCCESS;
993 return NET_RX_SUCCESS;
995 if (!tvlv_handler->unicast_handler)
996 return NET_RX_SUCCESS;
998 return tvlv_handler->unicast_handler(bat_priv, src,
1003 return NET_RX_SUCCESS;
1007 * batadv_tvlv_containers_process - parse the given tvlv buffer to call the
1008 * appropriate handlers
1009 * @bat_priv: the bat priv with all the soft interface information
1010 * @ogm_source: flag indicating whether the tvlv is an ogm or a unicast packet
1011 * @orig_node: orig node emitting the ogm packet
1012 * @src: source mac address of the unicast packet
1013 * @dst: destination mac address of the unicast packet
1014 * @tvlv_value: tvlv content
1015 * @tvlv_value_len: tvlv content length
1017 * Return: success when processing an OGM or the return value of all called
1018 * handler callbacks.
1020 int batadv_tvlv_containers_process(struct batadv_priv *bat_priv,
1022 struct batadv_orig_node *orig_node,
1024 void *tvlv_value, u16 tvlv_value_len)
1026 struct batadv_tvlv_handler *tvlv_handler;
1027 struct batadv_tvlv_hdr *tvlv_hdr;
1028 u16 tvlv_value_cont_len;
1029 u8 cifnotfound = BATADV_TVLV_HANDLER_OGM_CIFNOTFND;
1030 int ret = NET_RX_SUCCESS;
1032 while (tvlv_value_len >= sizeof(*tvlv_hdr)) {
1033 tvlv_hdr = tvlv_value;
1034 tvlv_value_cont_len = ntohs(tvlv_hdr->len);
1035 tvlv_value = tvlv_hdr + 1;
1036 tvlv_value_len -= sizeof(*tvlv_hdr);
1038 if (tvlv_value_cont_len > tvlv_value_len)
1041 tvlv_handler = batadv_tvlv_handler_get(bat_priv,
1045 ret |= batadv_tvlv_call_handler(bat_priv, tvlv_handler,
1046 ogm_source, orig_node,
1047 src, dst, tvlv_value,
1048 tvlv_value_cont_len);
1050 batadv_tvlv_handler_put(tvlv_handler);
1051 tvlv_value = (u8 *)tvlv_value + tvlv_value_cont_len;
1052 tvlv_value_len -= tvlv_value_cont_len;
1059 hlist_for_each_entry_rcu(tvlv_handler,
1060 &bat_priv->tvlv.handler_list, list) {
1061 if ((tvlv_handler->flags & BATADV_TVLV_HANDLER_OGM_CIFNOTFND) &&
1062 !(tvlv_handler->flags & BATADV_TVLV_HANDLER_OGM_CALLED))
1063 tvlv_handler->ogm_handler(bat_priv, orig_node,
1064 cifnotfound, NULL, 0);
1066 tvlv_handler->flags &= ~BATADV_TVLV_HANDLER_OGM_CALLED;
1070 return NET_RX_SUCCESS;
1074 * batadv_tvlv_ogm_receive - process an incoming ogm and call the appropriate
1076 * @bat_priv: the bat priv with all the soft interface information
1077 * @batadv_ogm_packet: ogm packet containing the tvlv containers
1078 * @orig_node: orig node emitting the ogm packet
1080 void batadv_tvlv_ogm_receive(struct batadv_priv *bat_priv,
1081 struct batadv_ogm_packet *batadv_ogm_packet,
1082 struct batadv_orig_node *orig_node)
1087 if (!batadv_ogm_packet)
1090 tvlv_value_len = ntohs(batadv_ogm_packet->tvlv_len);
1091 if (!tvlv_value_len)
1094 tvlv_value = batadv_ogm_packet + 1;
1096 batadv_tvlv_containers_process(bat_priv, true, orig_node, NULL, NULL,
1097 tvlv_value, tvlv_value_len);
1101 * batadv_tvlv_handler_register - register tvlv handler based on the provided
1102 * type and version (both need to match) for ogm tvlv payload and/or unicast
1104 * @bat_priv: the bat priv with all the soft interface information
1105 * @optr: ogm tvlv handler callback function. This function receives the orig
1106 * node, flags and the tvlv content as argument to process.
1107 * @uptr: unicast tvlv handler callback function. This function receives the
1108 * source & destination of the unicast packet as well as the tvlv content
1110 * @type: tvlv handler type to be registered
1111 * @version: tvlv handler version to be registered
1112 * @flags: flags to enable or disable TVLV API behavior
1114 void batadv_tvlv_handler_register(struct batadv_priv *bat_priv,
1115 void (*optr)(struct batadv_priv *bat_priv,
1116 struct batadv_orig_node *orig,
1119 u16 tvlv_value_len),
1120 int (*uptr)(struct batadv_priv *bat_priv,
1123 u16 tvlv_value_len),
1124 u8 type, u8 version, u8 flags)
1126 struct batadv_tvlv_handler *tvlv_handler;
1128 tvlv_handler = batadv_tvlv_handler_get(bat_priv, type, version);
1130 batadv_tvlv_handler_put(tvlv_handler);
1134 tvlv_handler = kzalloc(sizeof(*tvlv_handler), GFP_ATOMIC);
1138 tvlv_handler->ogm_handler = optr;
1139 tvlv_handler->unicast_handler = uptr;
1140 tvlv_handler->type = type;
1141 tvlv_handler->version = version;
1142 tvlv_handler->flags = flags;
1143 kref_init(&tvlv_handler->refcount);
1144 INIT_HLIST_NODE(&tvlv_handler->list);
1146 spin_lock_bh(&bat_priv->tvlv.handler_list_lock);
1147 hlist_add_head_rcu(&tvlv_handler->list, &bat_priv->tvlv.handler_list);
1148 spin_unlock_bh(&bat_priv->tvlv.handler_list_lock);
1152 * batadv_tvlv_handler_unregister - unregister tvlv handler based on the
1153 * provided type and version (both need to match)
1154 * @bat_priv: the bat priv with all the soft interface information
1155 * @type: tvlv handler type to be unregistered
1156 * @version: tvlv handler version to be unregistered
1158 void batadv_tvlv_handler_unregister(struct batadv_priv *bat_priv,
1159 u8 type, u8 version)
1161 struct batadv_tvlv_handler *tvlv_handler;
1163 tvlv_handler = batadv_tvlv_handler_get(bat_priv, type, version);
1167 batadv_tvlv_handler_put(tvlv_handler);
1168 spin_lock_bh(&bat_priv->tvlv.handler_list_lock);
1169 hlist_del_rcu(&tvlv_handler->list);
1170 spin_unlock_bh(&bat_priv->tvlv.handler_list_lock);
1171 batadv_tvlv_handler_put(tvlv_handler);
1175 * batadv_tvlv_unicast_send - send a unicast packet with tvlv payload to the
1177 * @bat_priv: the bat priv with all the soft interface information
1178 * @src: source mac address of the unicast packet
1179 * @dst: destination mac address of the unicast packet
1181 * @version: tvlv version
1182 * @tvlv_value: tvlv content
1183 * @tvlv_value_len: tvlv content length
1185 void batadv_tvlv_unicast_send(struct batadv_priv *bat_priv, u8 *src,
1186 u8 *dst, u8 type, u8 version,
1187 void *tvlv_value, u16 tvlv_value_len)
1189 struct batadv_unicast_tvlv_packet *unicast_tvlv_packet;
1190 struct batadv_tvlv_hdr *tvlv_hdr;
1191 struct batadv_orig_node *orig_node;
1192 struct sk_buff *skb;
1193 unsigned char *tvlv_buff;
1194 unsigned int tvlv_len;
1195 ssize_t hdr_len = sizeof(*unicast_tvlv_packet);
1197 orig_node = batadv_orig_hash_find(bat_priv, dst);
1201 tvlv_len = sizeof(*tvlv_hdr) + tvlv_value_len;
1203 skb = netdev_alloc_skb_ip_align(NULL, ETH_HLEN + hdr_len + tvlv_len);
1207 skb->priority = TC_PRIO_CONTROL;
1208 skb_reserve(skb, ETH_HLEN);
1209 tvlv_buff = skb_put(skb, sizeof(*unicast_tvlv_packet) + tvlv_len);
1210 unicast_tvlv_packet = (struct batadv_unicast_tvlv_packet *)tvlv_buff;
1211 unicast_tvlv_packet->packet_type = BATADV_UNICAST_TVLV;
1212 unicast_tvlv_packet->version = BATADV_COMPAT_VERSION;
1213 unicast_tvlv_packet->ttl = BATADV_TTL;
1214 unicast_tvlv_packet->reserved = 0;
1215 unicast_tvlv_packet->tvlv_len = htons(tvlv_len);
1216 unicast_tvlv_packet->align = 0;
1217 ether_addr_copy(unicast_tvlv_packet->src, src);
1218 ether_addr_copy(unicast_tvlv_packet->dst, dst);
1220 tvlv_buff = (unsigned char *)(unicast_tvlv_packet + 1);
1221 tvlv_hdr = (struct batadv_tvlv_hdr *)tvlv_buff;
1222 tvlv_hdr->version = version;
1223 tvlv_hdr->type = type;
1224 tvlv_hdr->len = htons(tvlv_value_len);
1225 tvlv_buff += sizeof(*tvlv_hdr);
1226 memcpy(tvlv_buff, tvlv_value, tvlv_value_len);
1228 if (batadv_send_skb_to_orig(skb, orig_node, NULL) == NET_XMIT_DROP)
1231 batadv_orig_node_put(orig_node);
1235 * batadv_get_vid - extract the VLAN identifier from skb if any
1236 * @skb: the buffer containing the packet
1237 * @header_len: length of the batman header preceding the ethernet header
1239 * Return: VID with the BATADV_VLAN_HAS_TAG flag when the packet embedded in the
1240 * skb is vlan tagged. Otherwise BATADV_NO_FLAGS.
1242 unsigned short batadv_get_vid(struct sk_buff *skb, size_t header_len)
1244 struct ethhdr *ethhdr = (struct ethhdr *)(skb->data + header_len);
1245 struct vlan_ethhdr *vhdr;
1248 if (ethhdr->h_proto != htons(ETH_P_8021Q))
1249 return BATADV_NO_FLAGS;
1251 if (!pskb_may_pull(skb, header_len + VLAN_ETH_HLEN))
1252 return BATADV_NO_FLAGS;
1254 vhdr = (struct vlan_ethhdr *)(skb->data + header_len);
1255 vid = ntohs(vhdr->h_vlan_TCI) & VLAN_VID_MASK;
1256 vid |= BATADV_VLAN_HAS_TAG;
1262 * batadv_vlan_ap_isola_get - return the AP isolation status for the given vlan
1263 * @bat_priv: the bat priv with all the soft interface information
1264 * @vid: the VLAN identifier for which the AP isolation attributed as to be
1267 * Return: true if AP isolation is on for the VLAN idenfied by vid, false
1270 bool batadv_vlan_ap_isola_get(struct batadv_priv *bat_priv, unsigned short vid)
1272 bool ap_isolation_enabled = false;
1273 struct batadv_softif_vlan *vlan;
1275 /* if the AP isolation is requested on a VLAN, then check for its
1276 * setting in the proper VLAN private data structure
1278 vlan = batadv_softif_vlan_get(bat_priv, vid);
1280 ap_isolation_enabled = atomic_read(&vlan->ap_isolation);
1281 batadv_softif_vlan_put(vlan);
1284 return ap_isolation_enabled;
1287 static int batadv_param_set_ra(const char *val, const struct kernel_param *kp)
1289 struct batadv_algo_ops *bat_algo_ops;
1290 char *algo_name = (char *)val;
1291 size_t name_len = strlen(algo_name);
1293 if (name_len > 0 && algo_name[name_len - 1] == '\n')
1294 algo_name[name_len - 1] = '\0';
1296 bat_algo_ops = batadv_algo_get(algo_name);
1297 if (!bat_algo_ops) {
1298 pr_err("Routing algorithm '%s' is not supported\n", algo_name);
1302 return param_set_copystring(algo_name, kp);
1305 static const struct kernel_param_ops batadv_param_ops_ra = {
1306 .set = batadv_param_set_ra,
1307 .get = param_get_string,
1310 static struct kparam_string batadv_param_string_ra = {
1311 .maxlen = sizeof(batadv_routing_algo),
1312 .string = batadv_routing_algo,
1315 module_param_cb(routing_algo, &batadv_param_ops_ra, &batadv_param_string_ra,
1317 module_init(batadv_init);
1318 module_exit(batadv_exit);
1320 MODULE_LICENSE("GPL");
1322 MODULE_AUTHOR(BATADV_DRIVER_AUTHOR);
1323 MODULE_DESCRIPTION(BATADV_DRIVER_DESC);
1324 MODULE_SUPPORTED_DEVICE(BATADV_DRIVER_DEVICE);
1325 MODULE_VERSION(BATADV_SOURCE_VERSION);