1 /* Copyright (C) 2014-2016 B.A.T.M.A.N. contributors:
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/>.
18 #include "multicast.h"
21 #include <linux/atomic.h>
22 #include <linux/bitops.h>
23 #include <linux/bug.h>
24 #include <linux/byteorder/generic.h>
25 #include <linux/errno.h>
26 #include <linux/etherdevice.h>
28 #include <linux/icmpv6.h>
29 #include <linux/if_bridge.h>
30 #include <linux/if_ether.h>
31 #include <linux/igmp.h>
33 #include <linux/in6.h>
35 #include <linux/ipv6.h>
36 #include <linux/kernel.h>
37 #include <linux/kref.h>
38 #include <linux/list.h>
39 #include <linux/lockdep.h>
40 #include <linux/netdevice.h>
41 #include <linux/printk.h>
42 #include <linux/rculist.h>
43 #include <linux/rcupdate.h>
44 #include <linux/seq_file.h>
45 #include <linux/skbuff.h>
46 #include <linux/slab.h>
47 #include <linux/spinlock.h>
48 #include <linux/stddef.h>
49 #include <linux/string.h>
50 #include <linux/types.h>
51 #include <net/addrconf.h>
52 #include <net/if_inet6.h>
56 #include "hard-interface.h"
59 #include "translation-table.h"
63 * batadv_mcast_get_bridge - get the bridge on top of the softif if it exists
64 * @soft_iface: netdev struct of the mesh interface
66 * If the given soft interface has a bridge on top then the refcount
67 * of the according net device is increased.
69 * Return: NULL if no such bridge exists. Otherwise the net device of the
72 static struct net_device
*batadv_mcast_get_bridge(struct net_device
*soft_iface
)
74 struct net_device
*upper
= soft_iface
;
78 upper
= netdev_master_upper_dev_get_rcu(upper
);
79 } while (upper
&& !(upper
->priv_flags
& IFF_EBRIDGE
));
89 * batadv_mcast_mla_softif_get - get softif multicast listeners
90 * @dev: the device to collect multicast addresses from
91 * @mcast_list: a list to put found addresses into
93 * Collects multicast addresses of multicast listeners residing
94 * on this kernel on the given soft interface, dev, in
95 * the given mcast_list. In general, multicast listeners provided by
96 * your multicast receiving applications run directly on this node.
98 * If there is a bridge interface on top of dev, collects from that one
99 * instead. Just like with IP addresses and routes, multicast listeners
100 * will(/should) register to the bridge interface instead of an
103 * Return: -ENOMEM on memory allocation error or the number of
104 * items added to the mcast_list otherwise.
106 static int batadv_mcast_mla_softif_get(struct net_device
*dev
,
107 struct hlist_head
*mcast_list
)
109 struct net_device
*bridge
= batadv_mcast_get_bridge(dev
);
110 struct netdev_hw_addr
*mc_list_entry
;
111 struct batadv_hw_addr
*new;
114 netif_addr_lock_bh(bridge
? bridge
: dev
);
115 netdev_for_each_mc_addr(mc_list_entry
, bridge
? bridge
: dev
) {
116 new = kmalloc(sizeof(*new), GFP_ATOMIC
);
122 ether_addr_copy(new->addr
, mc_list_entry
->addr
);
123 hlist_add_head(&new->list
, mcast_list
);
126 netif_addr_unlock_bh(bridge
? bridge
: dev
);
135 * batadv_mcast_mla_is_duplicate - check whether an address is in a list
136 * @mcast_addr: the multicast address to check
137 * @mcast_list: the list with multicast addresses to search in
139 * Return: true if the given address is already in the given list.
140 * Otherwise returns false.
142 static bool batadv_mcast_mla_is_duplicate(u8
*mcast_addr
,
143 struct hlist_head
*mcast_list
)
145 struct batadv_hw_addr
*mcast_entry
;
147 hlist_for_each_entry(mcast_entry
, mcast_list
, list
)
148 if (batadv_compare_eth(mcast_entry
->addr
, mcast_addr
))
155 * batadv_mcast_mla_br_addr_cpy - copy a bridge multicast address
156 * @dst: destination to write to - a multicast MAC address
157 * @src: source to read from - a multicast IP address
159 * Converts a given multicast IPv4/IPv6 address from a bridge
160 * to its matching multicast MAC address and copies it into the given
161 * destination buffer.
163 * Caller needs to make sure the destination buffer can hold
164 * at least ETH_ALEN bytes.
166 static void batadv_mcast_mla_br_addr_cpy(char *dst
, const struct br_ip
*src
)
168 if (src
->proto
== htons(ETH_P_IP
))
169 ip_eth_mc_map(src
->u
.ip4
, dst
);
170 #if IS_ENABLED(CONFIG_IPV6)
171 else if (src
->proto
== htons(ETH_P_IPV6
))
172 ipv6_eth_mc_map(&src
->u
.ip6
, dst
);
179 * batadv_mcast_mla_bridge_get - get bridged-in multicast listeners
180 * @dev: a bridge slave whose bridge to collect multicast addresses from
181 * @mcast_list: a list to put found addresses into
183 * Collects multicast addresses of multicast listeners residing
184 * on foreign, non-mesh devices which we gave access to our mesh via
185 * a bridge on top of the given soft interface, dev, in the given
188 * Return: -ENOMEM on memory allocation error or the number of
189 * items added to the mcast_list otherwise.
191 static int batadv_mcast_mla_bridge_get(struct net_device
*dev
,
192 struct hlist_head
*mcast_list
)
194 struct list_head bridge_mcast_list
= LIST_HEAD_INIT(bridge_mcast_list
);
195 struct br_ip_list
*br_ip_entry
, *tmp
;
196 struct batadv_hw_addr
*new;
197 u8 mcast_addr
[ETH_ALEN
];
200 /* we don't need to detect these devices/listeners, the IGMP/MLD
201 * snooping code of the Linux bridge already does that for us
203 ret
= br_multicast_list_adjacent(dev
, &bridge_mcast_list
);
207 list_for_each_entry(br_ip_entry
, &bridge_mcast_list
, list
) {
208 batadv_mcast_mla_br_addr_cpy(mcast_addr
, &br_ip_entry
->addr
);
209 if (batadv_mcast_mla_is_duplicate(mcast_addr
, mcast_list
))
212 new = kmalloc(sizeof(*new), GFP_ATOMIC
);
218 ether_addr_copy(new->addr
, mcast_addr
);
219 hlist_add_head(&new->list
, mcast_list
);
223 list_for_each_entry_safe(br_ip_entry
, tmp
, &bridge_mcast_list
, list
) {
224 list_del(&br_ip_entry
->list
);
232 * batadv_mcast_mla_list_free - free a list of multicast addresses
233 * @bat_priv: the bat priv with all the soft interface information
234 * @mcast_list: the list to free
236 * Removes and frees all items in the given mcast_list.
238 static void batadv_mcast_mla_list_free(struct batadv_priv
*bat_priv
,
239 struct hlist_head
*mcast_list
)
241 struct batadv_hw_addr
*mcast_entry
;
242 struct hlist_node
*tmp
;
244 lockdep_assert_held(&bat_priv
->tt
.commit_lock
);
246 hlist_for_each_entry_safe(mcast_entry
, tmp
, mcast_list
, list
) {
247 hlist_del(&mcast_entry
->list
);
253 * batadv_mcast_mla_tt_retract - clean up multicast listener announcements
254 * @bat_priv: the bat priv with all the soft interface information
255 * @mcast_list: a list of addresses which should _not_ be removed
257 * Retracts the announcement of any multicast listener from the
258 * translation table except the ones listed in the given mcast_list.
260 * If mcast_list is NULL then all are retracted.
262 static void batadv_mcast_mla_tt_retract(struct batadv_priv
*bat_priv
,
263 struct hlist_head
*mcast_list
)
265 struct batadv_hw_addr
*mcast_entry
;
266 struct hlist_node
*tmp
;
268 lockdep_assert_held(&bat_priv
->tt
.commit_lock
);
270 hlist_for_each_entry_safe(mcast_entry
, tmp
, &bat_priv
->mcast
.mla_list
,
273 batadv_mcast_mla_is_duplicate(mcast_entry
->addr
,
277 batadv_tt_local_remove(bat_priv
, mcast_entry
->addr
,
279 "mcast TT outdated", false);
281 hlist_del(&mcast_entry
->list
);
287 * batadv_mcast_mla_tt_add - add multicast listener announcements
288 * @bat_priv: the bat priv with all the soft interface information
289 * @mcast_list: a list of addresses which are going to get added
291 * Adds multicast listener announcements from the given mcast_list to the
292 * translation table if they have not been added yet.
294 static void batadv_mcast_mla_tt_add(struct batadv_priv
*bat_priv
,
295 struct hlist_head
*mcast_list
)
297 struct batadv_hw_addr
*mcast_entry
;
298 struct hlist_node
*tmp
;
300 lockdep_assert_held(&bat_priv
->tt
.commit_lock
);
305 hlist_for_each_entry_safe(mcast_entry
, tmp
, mcast_list
, list
) {
306 if (batadv_mcast_mla_is_duplicate(mcast_entry
->addr
,
307 &bat_priv
->mcast
.mla_list
))
310 if (!batadv_tt_local_add(bat_priv
->soft_iface
,
311 mcast_entry
->addr
, BATADV_NO_FLAGS
,
312 BATADV_NULL_IFINDEX
, BATADV_NO_MARK
))
315 hlist_del(&mcast_entry
->list
);
316 hlist_add_head(&mcast_entry
->list
, &bat_priv
->mcast
.mla_list
);
321 * batadv_mcast_has_bridge - check whether the soft-iface is bridged
322 * @bat_priv: the bat priv with all the soft interface information
324 * Checks whether there is a bridge on top of our soft interface.
326 * Return: true if there is a bridge, false otherwise.
328 static bool batadv_mcast_has_bridge(struct batadv_priv
*bat_priv
)
330 struct net_device
*upper
= bat_priv
->soft_iface
;
334 upper
= netdev_master_upper_dev_get_rcu(upper
);
335 } while (upper
&& !(upper
->priv_flags
& IFF_EBRIDGE
));
342 * batadv_mcast_querier_log - debug output regarding the querier status on link
343 * @bat_priv: the bat priv with all the soft interface information
344 * @str_proto: a string for the querier protocol (e.g. "IGMP" or "MLD")
345 * @old_state: the previous querier state on our link
346 * @new_state: the new querier state on our link
348 * Outputs debug messages to the logging facility with log level 'mcast'
349 * regarding changes to the querier status on the link which are relevant
350 * to our multicast optimizations.
352 * Usually this is about whether a querier appeared or vanished in
353 * our mesh or whether the querier is in the suboptimal position of being
354 * behind our local bridge segment: Snooping switches will directly
355 * forward listener reports to the querier, therefore batman-adv and
356 * the bridge will potentially not see these listeners - the querier is
357 * potentially shadowing listeners from us then.
359 * This is only interesting for nodes with a bridge on top of their
363 batadv_mcast_querier_log(struct batadv_priv
*bat_priv
, char *str_proto
,
364 struct batadv_mcast_querier_state
*old_state
,
365 struct batadv_mcast_querier_state
*new_state
)
367 if (!old_state
->exists
&& new_state
->exists
)
368 batadv_info(bat_priv
->soft_iface
, "%s Querier appeared\n",
370 else if (old_state
->exists
&& !new_state
->exists
)
371 batadv_info(bat_priv
->soft_iface
,
372 "%s Querier disappeared - multicast optimizations disabled\n",
374 else if (!bat_priv
->mcast
.bridged
&& !new_state
->exists
)
375 batadv_info(bat_priv
->soft_iface
,
376 "No %s Querier present - multicast optimizations disabled\n",
379 if (new_state
->exists
) {
380 if ((!old_state
->shadowing
&& new_state
->shadowing
) ||
381 (!old_state
->exists
&& new_state
->shadowing
))
382 batadv_dbg(BATADV_DBG_MCAST
, bat_priv
,
383 "%s Querier is behind our bridged segment: Might shadow listeners\n",
385 else if (old_state
->shadowing
&& !new_state
->shadowing
)
386 batadv_dbg(BATADV_DBG_MCAST
, bat_priv
,
387 "%s Querier is not behind our bridged segment\n",
393 * batadv_mcast_bridge_log - debug output for topology changes in bridged setups
394 * @bat_priv: the bat priv with all the soft interface information
395 * @bridged: a flag about whether the soft interface is currently bridged or not
396 * @querier_ipv4: (maybe) new status of a potential, selected IGMP querier
397 * @querier_ipv6: (maybe) new status of a potential, selected MLD querier
399 * If no bridges are ever used on this node, then this function does nothing.
401 * Otherwise this function outputs debug information to the 'mcast' log level
402 * which might be relevant to our multicast optimizations.
404 * More precisely, it outputs information when a bridge interface is added or
405 * removed from a soft interface. And when a bridge is present, it further
406 * outputs information about the querier state which is relevant for the
407 * multicast flags this node is going to set.
410 batadv_mcast_bridge_log(struct batadv_priv
*bat_priv
, bool bridged
,
411 struct batadv_mcast_querier_state
*querier_ipv4
,
412 struct batadv_mcast_querier_state
*querier_ipv6
)
414 if (!bat_priv
->mcast
.bridged
&& bridged
)
415 batadv_dbg(BATADV_DBG_MCAST
, bat_priv
,
416 "Bridge added: Setting Unsnoopables(U)-flag\n");
417 else if (bat_priv
->mcast
.bridged
&& !bridged
)
418 batadv_dbg(BATADV_DBG_MCAST
, bat_priv
,
419 "Bridge removed: Unsetting Unsnoopables(U)-flag\n");
422 batadv_mcast_querier_log(bat_priv
, "IGMP",
423 &bat_priv
->mcast
.querier_ipv4
,
425 batadv_mcast_querier_log(bat_priv
, "MLD",
426 &bat_priv
->mcast
.querier_ipv6
,
432 * batadv_mcast_flags_logs - output debug information about mcast flag changes
433 * @bat_priv: the bat priv with all the soft interface information
434 * @flags: flags indicating the new multicast state
436 * Whenever the multicast flags this nodes announces changes (@mcast_flags vs.
437 * bat_priv->mcast.flags), this notifies userspace via the 'mcast' log level.
439 static void batadv_mcast_flags_log(struct batadv_priv
*bat_priv
, u8 flags
)
441 u8 old_flags
= bat_priv
->mcast
.flags
;
442 char str_old_flags
[] = "[...]";
444 sprintf(str_old_flags
, "[%c%c%c]",
445 (old_flags
& BATADV_MCAST_WANT_ALL_UNSNOOPABLES
) ? 'U' : '.',
446 (old_flags
& BATADV_MCAST_WANT_ALL_IPV4
) ? '4' : '.',
447 (old_flags
& BATADV_MCAST_WANT_ALL_IPV6
) ? '6' : '.');
449 batadv_dbg(BATADV_DBG_MCAST
, bat_priv
,
450 "Changing multicast flags from '%s' to '[%c%c%c]'\n",
451 bat_priv
->mcast
.enabled
? str_old_flags
: "<undefined>",
452 (flags
& BATADV_MCAST_WANT_ALL_UNSNOOPABLES
) ? 'U' : '.',
453 (flags
& BATADV_MCAST_WANT_ALL_IPV4
) ? '4' : '.',
454 (flags
& BATADV_MCAST_WANT_ALL_IPV6
) ? '6' : '.');
458 * batadv_mcast_mla_tvlv_update - update multicast tvlv
459 * @bat_priv: the bat priv with all the soft interface information
461 * Updates the own multicast tvlv with our current multicast related settings,
462 * capabilities and inabilities.
464 * Return: false if we want all IPv4 && IPv6 multicast traffic and true
467 static bool batadv_mcast_mla_tvlv_update(struct batadv_priv
*bat_priv
)
469 struct batadv_tvlv_mcast_data mcast_data
;
470 struct batadv_mcast_querier_state querier4
= {false, false};
471 struct batadv_mcast_querier_state querier6
= {false, false};
472 struct net_device
*dev
= bat_priv
->soft_iface
;
475 mcast_data
.flags
= BATADV_NO_FLAGS
;
476 memset(mcast_data
.reserved
, 0, sizeof(mcast_data
.reserved
));
478 bridged
= batadv_mcast_has_bridge(bat_priv
);
482 #if !IS_ENABLED(CONFIG_BRIDGE_IGMP_SNOOPING)
483 pr_warn_once("No bridge IGMP snooping compiled - multicast optimizations disabled\n");
486 querier4
.exists
= br_multicast_has_querier_anywhere(dev
, ETH_P_IP
);
487 querier4
.shadowing
= br_multicast_has_querier_adjacent(dev
, ETH_P_IP
);
489 querier6
.exists
= br_multicast_has_querier_anywhere(dev
, ETH_P_IPV6
);
490 querier6
.shadowing
= br_multicast_has_querier_adjacent(dev
, ETH_P_IPV6
);
492 mcast_data
.flags
|= BATADV_MCAST_WANT_ALL_UNSNOOPABLES
;
494 /* 1) If no querier exists at all, then multicast listeners on
495 * our local TT clients behind the bridge will keep silent.
496 * 2) If the selected querier is on one of our local TT clients,
497 * behind the bridge, then this querier might shadow multicast
498 * listeners on our local TT clients, behind this bridge.
500 * In both cases, we will signalize other batman nodes that
501 * we need all multicast traffic of the according protocol.
503 if (!querier4
.exists
|| querier4
.shadowing
)
504 mcast_data
.flags
|= BATADV_MCAST_WANT_ALL_IPV4
;
506 if (!querier6
.exists
|| querier6
.shadowing
)
507 mcast_data
.flags
|= BATADV_MCAST_WANT_ALL_IPV6
;
510 batadv_mcast_bridge_log(bat_priv
, bridged
, &querier4
, &querier6
);
512 bat_priv
->mcast
.querier_ipv4
.exists
= querier4
.exists
;
513 bat_priv
->mcast
.querier_ipv4
.shadowing
= querier4
.shadowing
;
515 bat_priv
->mcast
.querier_ipv6
.exists
= querier6
.exists
;
516 bat_priv
->mcast
.querier_ipv6
.shadowing
= querier6
.shadowing
;
518 bat_priv
->mcast
.bridged
= bridged
;
520 if (!bat_priv
->mcast
.enabled
||
521 mcast_data
.flags
!= bat_priv
->mcast
.flags
) {
522 batadv_mcast_flags_log(bat_priv
, mcast_data
.flags
);
523 batadv_tvlv_container_register(bat_priv
, BATADV_TVLV_MCAST
, 2,
524 &mcast_data
, sizeof(mcast_data
));
525 bat_priv
->mcast
.flags
= mcast_data
.flags
;
526 bat_priv
->mcast
.enabled
= true;
529 return !(mcast_data
.flags
&
530 (BATADV_MCAST_WANT_ALL_IPV4
+ BATADV_MCAST_WANT_ALL_IPV6
));
534 * batadv_mcast_mla_update - update the own MLAs
535 * @bat_priv: the bat priv with all the soft interface information
537 * Updates the own multicast listener announcements in the translation
538 * table as well as the own, announced multicast tvlv container.
540 void batadv_mcast_mla_update(struct batadv_priv
*bat_priv
)
542 struct net_device
*soft_iface
= bat_priv
->soft_iface
;
543 struct hlist_head mcast_list
= HLIST_HEAD_INIT
;
546 if (!batadv_mcast_mla_tvlv_update(bat_priv
))
549 ret
= batadv_mcast_mla_softif_get(soft_iface
, &mcast_list
);
553 ret
= batadv_mcast_mla_bridge_get(soft_iface
, &mcast_list
);
558 batadv_mcast_mla_tt_retract(bat_priv
, &mcast_list
);
559 batadv_mcast_mla_tt_add(bat_priv
, &mcast_list
);
562 batadv_mcast_mla_list_free(bat_priv
, &mcast_list
);
566 * batadv_mcast_is_report_ipv4 - check for IGMP reports
567 * @skb: the ethernet frame destined for the mesh
569 * This call might reallocate skb data.
571 * Checks whether the given frame is a valid IGMP report.
573 * Return: If so then true, otherwise false.
575 static bool batadv_mcast_is_report_ipv4(struct sk_buff
*skb
)
577 if (ip_mc_check_igmp(skb
, NULL
) < 0)
580 switch (igmp_hdr(skb
)->type
) {
581 case IGMP_HOST_MEMBERSHIP_REPORT
:
582 case IGMPV2_HOST_MEMBERSHIP_REPORT
:
583 case IGMPV3_HOST_MEMBERSHIP_REPORT
:
591 * batadv_mcast_forw_mode_check_ipv4 - check for optimized forwarding potential
592 * @bat_priv: the bat priv with all the soft interface information
593 * @skb: the IPv4 packet to check
594 * @is_unsnoopable: stores whether the destination is snoopable
596 * Checks whether the given IPv4 packet has the potential to be forwarded with a
597 * mode more optimal than classic flooding.
599 * Return: If so then 0. Otherwise -EINVAL or -ENOMEM in case of memory
600 * allocation failure.
602 static int batadv_mcast_forw_mode_check_ipv4(struct batadv_priv
*bat_priv
,
604 bool *is_unsnoopable
)
608 /* We might fail due to out-of-memory -> drop it */
609 if (!pskb_may_pull(skb
, sizeof(struct ethhdr
) + sizeof(*iphdr
)))
612 if (batadv_mcast_is_report_ipv4(skb
))
617 /* TODO: Implement Multicast Router Discovery (RFC4286),
618 * then allow scope > link local, too
620 if (!ipv4_is_local_multicast(iphdr
->daddr
))
623 /* link-local multicast listeners behind a bridge are
624 * not snoopable (see RFC4541, section 2.1.2.2)
626 *is_unsnoopable
= true;
631 #if IS_ENABLED(CONFIG_IPV6)
633 * batadv_mcast_is_report_ipv6 - check for MLD reports
634 * @skb: the ethernet frame destined for the mesh
636 * This call might reallocate skb data.
638 * Checks whether the given frame is a valid MLD report.
640 * Return: If so then true, otherwise false.
642 static bool batadv_mcast_is_report_ipv6(struct sk_buff
*skb
)
644 if (ipv6_mc_check_mld(skb
, NULL
) < 0)
647 switch (icmp6_hdr(skb
)->icmp6_type
) {
648 case ICMPV6_MGM_REPORT
:
649 case ICMPV6_MLD2_REPORT
:
657 * batadv_mcast_forw_mode_check_ipv6 - check for optimized forwarding potential
658 * @bat_priv: the bat priv with all the soft interface information
659 * @skb: the IPv6 packet to check
660 * @is_unsnoopable: stores whether the destination is snoopable
662 * Checks whether the given IPv6 packet has the potential to be forwarded with a
663 * mode more optimal than classic flooding.
665 * Return: If so then 0. Otherwise -EINVAL is or -ENOMEM if we are out of memory
667 static int batadv_mcast_forw_mode_check_ipv6(struct batadv_priv
*bat_priv
,
669 bool *is_unsnoopable
)
671 struct ipv6hdr
*ip6hdr
;
673 /* We might fail due to out-of-memory -> drop it */
674 if (!pskb_may_pull(skb
, sizeof(struct ethhdr
) + sizeof(*ip6hdr
)))
677 if (batadv_mcast_is_report_ipv6(skb
))
680 ip6hdr
= ipv6_hdr(skb
);
682 /* TODO: Implement Multicast Router Discovery (RFC4286),
683 * then allow scope > link local, too
685 if (IPV6_ADDR_MC_SCOPE(&ip6hdr
->daddr
) != IPV6_ADDR_SCOPE_LINKLOCAL
)
688 /* link-local-all-nodes multicast listeners behind a bridge are
689 * not snoopable (see RFC4541, section 3, paragraph 3)
691 if (ipv6_addr_is_ll_all_nodes(&ip6hdr
->daddr
))
692 *is_unsnoopable
= true;
699 * batadv_mcast_forw_mode_check - check for optimized forwarding potential
700 * @bat_priv: the bat priv with all the soft interface information
701 * @skb: the multicast frame to check
702 * @is_unsnoopable: stores whether the destination is snoopable
704 * Checks whether the given multicast ethernet frame has the potential to be
705 * forwarded with a mode more optimal than classic flooding.
707 * Return: If so then 0. Otherwise -EINVAL is or -ENOMEM if we are out of memory
709 static int batadv_mcast_forw_mode_check(struct batadv_priv
*bat_priv
,
711 bool *is_unsnoopable
)
713 struct ethhdr
*ethhdr
= eth_hdr(skb
);
715 if (!atomic_read(&bat_priv
->multicast_mode
))
718 if (atomic_read(&bat_priv
->mcast
.num_disabled
))
721 switch (ntohs(ethhdr
->h_proto
)) {
723 return batadv_mcast_forw_mode_check_ipv4(bat_priv
, skb
,
725 #if IS_ENABLED(CONFIG_IPV6)
727 return batadv_mcast_forw_mode_check_ipv6(bat_priv
, skb
,
736 * batadv_mcast_forw_want_all_ip_count - count nodes with unspecific mcast
738 * @bat_priv: the bat priv with all the soft interface information
739 * @ethhdr: ethernet header of a packet
741 * Return: the number of nodes which want all IPv4 multicast traffic if the
742 * given ethhdr is from an IPv4 packet or the number of nodes which want all
743 * IPv6 traffic if it matches an IPv6 packet.
745 static int batadv_mcast_forw_want_all_ip_count(struct batadv_priv
*bat_priv
,
746 struct ethhdr
*ethhdr
)
748 switch (ntohs(ethhdr
->h_proto
)) {
750 return atomic_read(&bat_priv
->mcast
.num_want_all_ipv4
);
752 return atomic_read(&bat_priv
->mcast
.num_want_all_ipv6
);
754 /* we shouldn't be here... */
760 * batadv_mcast_forw_tt_node_get - get a multicast tt node
761 * @bat_priv: the bat priv with all the soft interface information
762 * @ethhdr: the ether header containing the multicast destination
764 * Return: an orig_node matching the multicast address provided by ethhdr
765 * via a translation table lookup. This increases the returned nodes refcount.
767 static struct batadv_orig_node
*
768 batadv_mcast_forw_tt_node_get(struct batadv_priv
*bat_priv
,
769 struct ethhdr
*ethhdr
)
771 return batadv_transtable_search(bat_priv
, ethhdr
->h_source
,
772 ethhdr
->h_dest
, BATADV_NO_FLAGS
);
776 * batadv_mcast_forw_ipv4_node_get - get a node with an ipv4 flag
777 * @bat_priv: the bat priv with all the soft interface information
779 * Return: an orig_node which has the BATADV_MCAST_WANT_ALL_IPV4 flag set and
780 * increases its refcount.
782 static struct batadv_orig_node
*
783 batadv_mcast_forw_ipv4_node_get(struct batadv_priv
*bat_priv
)
785 struct batadv_orig_node
*tmp_orig_node
, *orig_node
= NULL
;
788 hlist_for_each_entry_rcu(tmp_orig_node
,
789 &bat_priv
->mcast
.want_all_ipv4_list
,
790 mcast_want_all_ipv4_node
) {
791 if (!kref_get_unless_zero(&tmp_orig_node
->refcount
))
794 orig_node
= tmp_orig_node
;
803 * batadv_mcast_forw_ipv6_node_get - get a node with an ipv6 flag
804 * @bat_priv: the bat priv with all the soft interface information
806 * Return: an orig_node which has the BATADV_MCAST_WANT_ALL_IPV6 flag set
807 * and increases its refcount.
809 static struct batadv_orig_node
*
810 batadv_mcast_forw_ipv6_node_get(struct batadv_priv
*bat_priv
)
812 struct batadv_orig_node
*tmp_orig_node
, *orig_node
= NULL
;
815 hlist_for_each_entry_rcu(tmp_orig_node
,
816 &bat_priv
->mcast
.want_all_ipv6_list
,
817 mcast_want_all_ipv6_node
) {
818 if (!kref_get_unless_zero(&tmp_orig_node
->refcount
))
821 orig_node
= tmp_orig_node
;
830 * batadv_mcast_forw_ip_node_get - get a node with an ipv4/ipv6 flag
831 * @bat_priv: the bat priv with all the soft interface information
832 * @ethhdr: an ethernet header to determine the protocol family from
834 * Return: an orig_node which has the BATADV_MCAST_WANT_ALL_IPV4 or
835 * BATADV_MCAST_WANT_ALL_IPV6 flag, depending on the provided ethhdr, set and
836 * increases its refcount.
838 static struct batadv_orig_node
*
839 batadv_mcast_forw_ip_node_get(struct batadv_priv
*bat_priv
,
840 struct ethhdr
*ethhdr
)
842 switch (ntohs(ethhdr
->h_proto
)) {
844 return batadv_mcast_forw_ipv4_node_get(bat_priv
);
846 return batadv_mcast_forw_ipv6_node_get(bat_priv
);
848 /* we shouldn't be here... */
854 * batadv_mcast_forw_unsnoop_node_get - get a node with an unsnoopable flag
855 * @bat_priv: the bat priv with all the soft interface information
857 * Return: an orig_node which has the BATADV_MCAST_WANT_ALL_UNSNOOPABLES flag
858 * set and increases its refcount.
860 static struct batadv_orig_node
*
861 batadv_mcast_forw_unsnoop_node_get(struct batadv_priv
*bat_priv
)
863 struct batadv_orig_node
*tmp_orig_node
, *orig_node
= NULL
;
866 hlist_for_each_entry_rcu(tmp_orig_node
,
867 &bat_priv
->mcast
.want_all_unsnoopables_list
,
868 mcast_want_all_unsnoopables_node
) {
869 if (!kref_get_unless_zero(&tmp_orig_node
->refcount
))
872 orig_node
= tmp_orig_node
;
881 * batadv_mcast_forw_mode - check on how to forward a multicast packet
882 * @bat_priv: the bat priv with all the soft interface information
883 * @skb: The multicast packet to check
884 * @orig: an originator to be set to forward the skb to
886 * Return: the forwarding mode as enum batadv_forw_mode and in case of
887 * BATADV_FORW_SINGLE set the orig to the single originator the skb
888 * should be forwarded to.
890 enum batadv_forw_mode
891 batadv_mcast_forw_mode(struct batadv_priv
*bat_priv
, struct sk_buff
*skb
,
892 struct batadv_orig_node
**orig
)
894 int ret
, tt_count
, ip_count
, unsnoop_count
, total_count
;
895 bool is_unsnoopable
= false;
896 struct ethhdr
*ethhdr
;
898 ret
= batadv_mcast_forw_mode_check(bat_priv
, skb
, &is_unsnoopable
);
900 return BATADV_FORW_NONE
;
902 return BATADV_FORW_ALL
;
904 ethhdr
= eth_hdr(skb
);
906 tt_count
= batadv_tt_global_hash_count(bat_priv
, ethhdr
->h_dest
,
908 ip_count
= batadv_mcast_forw_want_all_ip_count(bat_priv
, ethhdr
);
909 unsnoop_count
= !is_unsnoopable
? 0 :
910 atomic_read(&bat_priv
->mcast
.num_want_all_unsnoopables
);
912 total_count
= tt_count
+ ip_count
+ unsnoop_count
;
914 switch (total_count
) {
917 *orig
= batadv_mcast_forw_tt_node_get(bat_priv
, ethhdr
);
919 *orig
= batadv_mcast_forw_ip_node_get(bat_priv
, ethhdr
);
920 else if (unsnoop_count
)
921 *orig
= batadv_mcast_forw_unsnoop_node_get(bat_priv
);
924 return BATADV_FORW_SINGLE
;
928 return BATADV_FORW_NONE
;
930 return BATADV_FORW_ALL
;
935 * batadv_mcast_want_unsnoop_update - update unsnoop counter and list
936 * @bat_priv: the bat priv with all the soft interface information
937 * @orig: the orig_node which multicast state might have changed of
938 * @mcast_flags: flags indicating the new multicast state
940 * If the BATADV_MCAST_WANT_ALL_UNSNOOPABLES flag of this originator,
941 * orig, has toggled then this method updates counter and list accordingly.
943 * Caller needs to hold orig->mcast_handler_lock.
945 static void batadv_mcast_want_unsnoop_update(struct batadv_priv
*bat_priv
,
946 struct batadv_orig_node
*orig
,
949 struct hlist_node
*node
= &orig
->mcast_want_all_unsnoopables_node
;
950 struct hlist_head
*head
= &bat_priv
->mcast
.want_all_unsnoopables_list
;
952 lockdep_assert_held(&orig
->mcast_handler_lock
);
954 /* switched from flag unset to set */
955 if (mcast_flags
& BATADV_MCAST_WANT_ALL_UNSNOOPABLES
&&
956 !(orig
->mcast_flags
& BATADV_MCAST_WANT_ALL_UNSNOOPABLES
)) {
957 atomic_inc(&bat_priv
->mcast
.num_want_all_unsnoopables
);
959 spin_lock_bh(&bat_priv
->mcast
.want_lists_lock
);
960 /* flag checks above + mcast_handler_lock prevents this */
961 WARN_ON(!hlist_unhashed(node
));
963 hlist_add_head_rcu(node
, head
);
964 spin_unlock_bh(&bat_priv
->mcast
.want_lists_lock
);
965 /* switched from flag set to unset */
966 } else if (!(mcast_flags
& BATADV_MCAST_WANT_ALL_UNSNOOPABLES
) &&
967 orig
->mcast_flags
& BATADV_MCAST_WANT_ALL_UNSNOOPABLES
) {
968 atomic_dec(&bat_priv
->mcast
.num_want_all_unsnoopables
);
970 spin_lock_bh(&bat_priv
->mcast
.want_lists_lock
);
971 /* flag checks above + mcast_handler_lock prevents this */
972 WARN_ON(hlist_unhashed(node
));
974 hlist_del_init_rcu(node
);
975 spin_unlock_bh(&bat_priv
->mcast
.want_lists_lock
);
980 * batadv_mcast_want_ipv4_update - update want-all-ipv4 counter and list
981 * @bat_priv: the bat priv with all the soft interface information
982 * @orig: the orig_node which multicast state might have changed of
983 * @mcast_flags: flags indicating the new multicast state
985 * If the BATADV_MCAST_WANT_ALL_IPV4 flag of this originator, orig, has
986 * toggled then this method updates counter and list accordingly.
988 * Caller needs to hold orig->mcast_handler_lock.
990 static void batadv_mcast_want_ipv4_update(struct batadv_priv
*bat_priv
,
991 struct batadv_orig_node
*orig
,
994 struct hlist_node
*node
= &orig
->mcast_want_all_ipv4_node
;
995 struct hlist_head
*head
= &bat_priv
->mcast
.want_all_ipv4_list
;
997 lockdep_assert_held(&orig
->mcast_handler_lock
);
999 /* switched from flag unset to set */
1000 if (mcast_flags
& BATADV_MCAST_WANT_ALL_IPV4
&&
1001 !(orig
->mcast_flags
& BATADV_MCAST_WANT_ALL_IPV4
)) {
1002 atomic_inc(&bat_priv
->mcast
.num_want_all_ipv4
);
1004 spin_lock_bh(&bat_priv
->mcast
.want_lists_lock
);
1005 /* flag checks above + mcast_handler_lock prevents this */
1006 WARN_ON(!hlist_unhashed(node
));
1008 hlist_add_head_rcu(node
, head
);
1009 spin_unlock_bh(&bat_priv
->mcast
.want_lists_lock
);
1010 /* switched from flag set to unset */
1011 } else if (!(mcast_flags
& BATADV_MCAST_WANT_ALL_IPV4
) &&
1012 orig
->mcast_flags
& BATADV_MCAST_WANT_ALL_IPV4
) {
1013 atomic_dec(&bat_priv
->mcast
.num_want_all_ipv4
);
1015 spin_lock_bh(&bat_priv
->mcast
.want_lists_lock
);
1016 /* flag checks above + mcast_handler_lock prevents this */
1017 WARN_ON(hlist_unhashed(node
));
1019 hlist_del_init_rcu(node
);
1020 spin_unlock_bh(&bat_priv
->mcast
.want_lists_lock
);
1025 * batadv_mcast_want_ipv6_update - update want-all-ipv6 counter and list
1026 * @bat_priv: the bat priv with all the soft interface information
1027 * @orig: the orig_node which multicast state might have changed of
1028 * @mcast_flags: flags indicating the new multicast state
1030 * If the BATADV_MCAST_WANT_ALL_IPV6 flag of this originator, orig, has
1031 * toggled then this method updates counter and list accordingly.
1033 * Caller needs to hold orig->mcast_handler_lock.
1035 static void batadv_mcast_want_ipv6_update(struct batadv_priv
*bat_priv
,
1036 struct batadv_orig_node
*orig
,
1039 struct hlist_node
*node
= &orig
->mcast_want_all_ipv6_node
;
1040 struct hlist_head
*head
= &bat_priv
->mcast
.want_all_ipv6_list
;
1042 lockdep_assert_held(&orig
->mcast_handler_lock
);
1044 /* switched from flag unset to set */
1045 if (mcast_flags
& BATADV_MCAST_WANT_ALL_IPV6
&&
1046 !(orig
->mcast_flags
& BATADV_MCAST_WANT_ALL_IPV6
)) {
1047 atomic_inc(&bat_priv
->mcast
.num_want_all_ipv6
);
1049 spin_lock_bh(&bat_priv
->mcast
.want_lists_lock
);
1050 /* flag checks above + mcast_handler_lock prevents this */
1051 WARN_ON(!hlist_unhashed(node
));
1053 hlist_add_head_rcu(node
, head
);
1054 spin_unlock_bh(&bat_priv
->mcast
.want_lists_lock
);
1055 /* switched from flag set to unset */
1056 } else if (!(mcast_flags
& BATADV_MCAST_WANT_ALL_IPV6
) &&
1057 orig
->mcast_flags
& BATADV_MCAST_WANT_ALL_IPV6
) {
1058 atomic_dec(&bat_priv
->mcast
.num_want_all_ipv6
);
1060 spin_lock_bh(&bat_priv
->mcast
.want_lists_lock
);
1061 /* flag checks above + mcast_handler_lock prevents this */
1062 WARN_ON(hlist_unhashed(node
));
1064 hlist_del_init_rcu(node
);
1065 spin_unlock_bh(&bat_priv
->mcast
.want_lists_lock
);
1070 * batadv_mcast_tvlv_ogm_handler - process incoming multicast tvlv container
1071 * @bat_priv: the bat priv with all the soft interface information
1072 * @orig: the orig_node of the ogm
1073 * @flags: flags indicating the tvlv state (see batadv_tvlv_handler_flags)
1074 * @tvlv_value: tvlv buffer containing the multicast data
1075 * @tvlv_value_len: tvlv buffer length
1077 static void batadv_mcast_tvlv_ogm_handler(struct batadv_priv
*bat_priv
,
1078 struct batadv_orig_node
*orig
,
1083 bool orig_mcast_enabled
= !(flags
& BATADV_TVLV_HANDLER_OGM_CIFNOTFND
);
1084 u8 mcast_flags
= BATADV_NO_FLAGS
;
1085 bool orig_initialized
;
1087 if (orig_mcast_enabled
&& tvlv_value
&&
1088 (tvlv_value_len
>= sizeof(mcast_flags
)))
1089 mcast_flags
= *(u8
*)tvlv_value
;
1091 spin_lock_bh(&orig
->mcast_handler_lock
);
1092 orig_initialized
= test_bit(BATADV_ORIG_CAPA_HAS_MCAST
,
1093 &orig
->capa_initialized
);
1095 /* If mcast support is turned on decrease the disabled mcast node
1096 * counter only if we had increased it for this node before. If this
1097 * is a completely new orig_node no need to decrease the counter.
1099 if (orig_mcast_enabled
&&
1100 !test_bit(BATADV_ORIG_CAPA_HAS_MCAST
, &orig
->capabilities
)) {
1101 if (orig_initialized
)
1102 atomic_dec(&bat_priv
->mcast
.num_disabled
);
1103 set_bit(BATADV_ORIG_CAPA_HAS_MCAST
, &orig
->capabilities
);
1104 /* If mcast support is being switched off or if this is an initial
1105 * OGM without mcast support then increase the disabled mcast
1108 } else if (!orig_mcast_enabled
&&
1109 (test_bit(BATADV_ORIG_CAPA_HAS_MCAST
, &orig
->capabilities
) ||
1110 !orig_initialized
)) {
1111 atomic_inc(&bat_priv
->mcast
.num_disabled
);
1112 clear_bit(BATADV_ORIG_CAPA_HAS_MCAST
, &orig
->capabilities
);
1115 set_bit(BATADV_ORIG_CAPA_HAS_MCAST
, &orig
->capa_initialized
);
1117 batadv_mcast_want_unsnoop_update(bat_priv
, orig
, mcast_flags
);
1118 batadv_mcast_want_ipv4_update(bat_priv
, orig
, mcast_flags
);
1119 batadv_mcast_want_ipv6_update(bat_priv
, orig
, mcast_flags
);
1121 orig
->mcast_flags
= mcast_flags
;
1122 spin_unlock_bh(&orig
->mcast_handler_lock
);
1126 * batadv_mcast_init - initialize the multicast optimizations structures
1127 * @bat_priv: the bat priv with all the soft interface information
1129 void batadv_mcast_init(struct batadv_priv
*bat_priv
)
1131 batadv_tvlv_handler_register(bat_priv
, batadv_mcast_tvlv_ogm_handler
,
1132 NULL
, BATADV_TVLV_MCAST
, 2,
1133 BATADV_TVLV_HANDLER_OGM_CIFNOTFND
);
1137 * batadv_mcast_flags_print_header - print own mcast flags to debugfs table
1138 * @bat_priv: the bat priv with all the soft interface information
1139 * @seq: debugfs table seq_file struct
1141 * Prints our own multicast flags including a more specific reason why
1142 * they are set, that is prints the bridge and querier state too, to
1143 * the debugfs table specified via @seq.
1145 static void batadv_mcast_flags_print_header(struct batadv_priv
*bat_priv
,
1146 struct seq_file
*seq
)
1148 u8 flags
= bat_priv
->mcast
.flags
;
1149 char querier4
, querier6
, shadowing4
, shadowing6
;
1150 bool bridged
= bat_priv
->mcast
.bridged
;
1153 querier4
= bat_priv
->mcast
.querier_ipv4
.exists
? '.' : '4';
1154 querier6
= bat_priv
->mcast
.querier_ipv6
.exists
? '.' : '6';
1155 shadowing4
= bat_priv
->mcast
.querier_ipv4
.shadowing
? '4' : '.';
1156 shadowing6
= bat_priv
->mcast
.querier_ipv6
.shadowing
? '6' : '.';
1164 seq_printf(seq
, "Multicast flags (own flags: [%c%c%c])\n",
1165 (flags
& BATADV_MCAST_WANT_ALL_UNSNOOPABLES
) ? 'U' : '.',
1166 (flags
& BATADV_MCAST_WANT_ALL_IPV4
) ? '4' : '.',
1167 (flags
& BATADV_MCAST_WANT_ALL_IPV6
) ? '6' : '.');
1168 seq_printf(seq
, "* Bridged [U]\t\t\t\t%c\n", bridged
? 'U' : '.');
1169 seq_printf(seq
, "* No IGMP/MLD Querier [4/6]:\t\t%c/%c\n",
1170 querier4
, querier6
);
1171 seq_printf(seq
, "* Shadowing IGMP/MLD Querier [4/6]:\t%c/%c\n",
1172 shadowing4
, shadowing6
);
1173 seq_puts(seq
, "-------------------------------------------\n");
1174 seq_printf(seq
, " %-10s %s\n", "Originator", "Flags");
1178 * batadv_mcast_flags_seq_print_text - print the mcast flags of other nodes
1179 * @seq: seq file to print on
1182 * This prints a table of (primary) originators and their according
1183 * multicast flags, including (in the header) our own.
1187 int batadv_mcast_flags_seq_print_text(struct seq_file
*seq
, void *offset
)
1189 struct net_device
*net_dev
= (struct net_device
*)seq
->private;
1190 struct batadv_priv
*bat_priv
= netdev_priv(net_dev
);
1191 struct batadv_hard_iface
*primary_if
;
1192 struct batadv_hashtable
*hash
= bat_priv
->orig_hash
;
1193 struct batadv_orig_node
*orig_node
;
1194 struct hlist_head
*head
;
1198 primary_if
= batadv_seq_print_text_primary_if_get(seq
);
1202 batadv_mcast_flags_print_header(bat_priv
, seq
);
1204 for (i
= 0; i
< hash
->size
; i
++) {
1205 head
= &hash
->table
[i
];
1208 hlist_for_each_entry_rcu(orig_node
, head
, hash_entry
) {
1209 if (!test_bit(BATADV_ORIG_CAPA_HAS_MCAST
,
1210 &orig_node
->capa_initialized
))
1213 if (!test_bit(BATADV_ORIG_CAPA_HAS_MCAST
,
1214 &orig_node
->capabilities
)) {
1215 seq_printf(seq
, "%pM -\n", orig_node
->orig
);
1219 flags
= orig_node
->mcast_flags
;
1221 seq_printf(seq
, "%pM [%c%c%c]\n", orig_node
->orig
,
1222 (flags
& BATADV_MCAST_WANT_ALL_UNSNOOPABLES
)
1224 (flags
& BATADV_MCAST_WANT_ALL_IPV4
)
1226 (flags
& BATADV_MCAST_WANT_ALL_IPV6
)
1232 batadv_hardif_put(primary_if
);
1238 * batadv_mcast_free - free the multicast optimizations structures
1239 * @bat_priv: the bat priv with all the soft interface information
1241 void batadv_mcast_free(struct batadv_priv
*bat_priv
)
1243 batadv_tvlv_container_unregister(bat_priv
, BATADV_TVLV_MCAST
, 2);
1244 batadv_tvlv_handler_unregister(bat_priv
, BATADV_TVLV_MCAST
, 2);
1246 spin_lock_bh(&bat_priv
->tt
.commit_lock
);
1247 batadv_mcast_mla_tt_retract(bat_priv
, NULL
);
1248 spin_unlock_bh(&bat_priv
->tt
.commit_lock
);
1252 * batadv_mcast_purge_orig - reset originator global mcast state modifications
1253 * @orig: the originator which is going to get purged
1255 void batadv_mcast_purge_orig(struct batadv_orig_node
*orig
)
1257 struct batadv_priv
*bat_priv
= orig
->bat_priv
;
1259 spin_lock_bh(&orig
->mcast_handler_lock
);
1261 if (!test_bit(BATADV_ORIG_CAPA_HAS_MCAST
, &orig
->capabilities
) &&
1262 test_bit(BATADV_ORIG_CAPA_HAS_MCAST
, &orig
->capa_initialized
))
1263 atomic_dec(&bat_priv
->mcast
.num_disabled
);
1265 batadv_mcast_want_unsnoop_update(bat_priv
, orig
, BATADV_NO_FLAGS
);
1266 batadv_mcast_want_ipv4_update(bat_priv
, orig
, BATADV_NO_FLAGS
);
1267 batadv_mcast_want_ipv6_update(bat_priv
, orig
, BATADV_NO_FLAGS
);
1269 spin_unlock_bh(&orig
->mcast_handler_lock
);