2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 2009 Bruce Simpson.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * 3. The name of the author may not be used to endorse or promote
15 * products derived from this software without specific prior written
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * $KAME: mld6.c,v 1.27 2001/04/04 05:17:30 itojun Exp $
34 * Copyright (c) 1988 Stephen Deering.
35 * Copyright (c) 1992, 1993
36 * The Regents of the University of California. All rights reserved.
38 * This code is derived from software contributed to Berkeley by
39 * Stephen Deering of Stanford University.
41 * Redistribution and use in source and binary forms, with or without
42 * modification, are permitted provided that the following conditions
44 * 1. Redistributions of source code must retain the above copyright
45 * notice, this list of conditions and the following disclaimer.
46 * 2. Redistributions in binary form must reproduce the above copyright
47 * notice, this list of conditions and the following disclaimer in the
48 * documentation and/or other materials provided with the distribution.
49 * 3. Neither the name of the University nor the names of its contributors
50 * may be used to endorse or promote products derived from this software
51 * without specific prior written permission.
53 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
54 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
55 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
56 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
57 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
58 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
59 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
60 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
61 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
62 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
65 * @(#)igmp.c 8.1 (Berkeley) 7/19/93
68 #include <sys/cdefs.h>
70 #include "opt_inet6.h"
72 #include <sys/param.h>
73 #include <sys/systm.h>
75 #include <sys/socket.h>
76 #include <sys/sysctl.h>
77 #include <sys/kernel.h>
78 #include <sys/callout.h>
79 #include <sys/malloc.h>
80 #include <sys/module.h>
84 #include <net/if_var.h>
85 #include <net/if_private.h>
86 #include <net/route.h>
89 #include <netinet/in.h>
90 #include <netinet/in_var.h>
91 #include <netinet6/in6_var.h>
92 #include <netinet/ip6.h>
93 #include <netinet6/ip6_var.h>
94 #include <netinet6/scope6_var.h>
95 #include <netinet/icmp6.h>
96 #include <netinet6/mld6.h>
97 #include <netinet6/mld6_var.h>
99 #include <security/mac/mac_framework.h>
102 #define KTR_MLD KTR_INET6
105 static void mli_delete_locked(struct ifnet *);
106 static void mld_dispatch_packet(struct mbuf *);
107 static void mld_dispatch_queue(struct mbufq *, int);
108 static void mld_final_leave(struct in6_multi *, struct mld_ifsoftc *);
109 static void mld_fasttimo_vnet(struct in6_multi_head *inmh);
110 static int mld_handle_state_change(struct in6_multi *,
111 struct mld_ifsoftc *);
112 static int mld_initial_join(struct in6_multi *, struct mld_ifsoftc *,
115 static char * mld_rec_type_to_str(const int);
117 static void mld_set_version(struct mld_ifsoftc *, const int);
118 static void mld_slowtimo_vnet(void);
119 static int mld_v1_input_query(struct ifnet *, const struct ip6_hdr *,
120 /*const*/ struct mld_hdr *);
121 static int mld_v1_input_report(struct ifnet *, const struct ip6_hdr *,
122 /*const*/ struct mld_hdr *);
123 static void mld_v1_process_group_timer(struct in6_multi_head *,
125 static void mld_v1_process_querier_timers(struct mld_ifsoftc *);
126 static int mld_v1_transmit_report(struct in6_multi *, const int);
127 static void mld_v1_update_group(struct in6_multi *, const int);
128 static void mld_v2_cancel_link_timers(struct mld_ifsoftc *);
129 static void mld_v2_dispatch_general_query(struct mld_ifsoftc *);
131 mld_v2_encap_report(struct ifnet *, struct mbuf *);
132 static int mld_v2_enqueue_filter_change(struct mbufq *,
134 static int mld_v2_enqueue_group_record(struct mbufq *,
135 struct in6_multi *, const int, const int, const int,
137 static int mld_v2_input_query(struct ifnet *, const struct ip6_hdr *,
138 struct mbuf *, struct mldv2_query *, const int, const int);
139 static int mld_v2_merge_state_changes(struct in6_multi *,
141 static void mld_v2_process_group_timers(struct in6_multi_head *,
142 struct mbufq *, struct mbufq *,
143 struct in6_multi *, const int);
144 static int mld_v2_process_group_query(struct in6_multi *,
145 struct mld_ifsoftc *mli, int, struct mbuf *,
146 struct mldv2_query *, const int);
147 static int sysctl_mld_gsr(SYSCTL_HANDLER_ARGS);
148 static int sysctl_mld_ifinfo(SYSCTL_HANDLER_ARGS);
151 * Normative references: RFC 2710, RFC 3590, RFC 3810.
154 * * The MLD subsystem lock ends up being system-wide for the moment,
155 * but could be per-VIMAGE later on.
156 * * The permitted lock order is: IN6_MULTI_LOCK, MLD_LOCK, IF_ADDR_LOCK.
157 * Any may be taken independently; if any are held at the same
158 * time, the above lock order must be followed.
159 * * IN6_MULTI_LOCK covers in_multi.
160 * * MLD_LOCK covers per-link state and any global variables in this file.
161 * * IF_ADDR_LOCK covers if_multiaddrs, which is used for a variety of
162 * per-link state iterators.
165 * A special case for IPv6 is the in6_setscope() routine. ip6_output()
166 * will not accept an ifp; it wants an embedded scope ID, unlike
167 * ip_output(), which happily takes the ifp given to it. The embedded
168 * scope ID is only used by MLD to select the outgoing interface.
170 * During interface attach and detach, MLD will take MLD_LOCK *after*
171 * the IF_AFDATA_LOCK.
172 * As in6_setscope() takes IF_AFDATA_LOCK then SCOPE_LOCK, we can't call
173 * it with MLD_LOCK held without triggering an LOR. A netisr with indirect
174 * dispatch could work around this, but we'd rather not do that, as it
175 * can introduce other races.
177 * As such, we exploit the fact that the scope ID is just the interface
178 * index, and embed it in the IPv6 destination address accordingly.
179 * This is potentially NOT VALID for MLDv1 reports, as they
180 * are always sent to the multicast group itself; as MLDv2
181 * reports are always sent to ff02::16, this is not an issue
182 * when MLDv2 is in use.
184 * This does not however eliminate the LOR when ip6_output() itself
185 * calls in6_setscope() internally whilst MLD_LOCK is held. This will
186 * trigger a LOR warning in WITNESS when the ifnet is detached.
188 * The right answer is probably to make IF_AFDATA_LOCK an rwlock, given
189 * how it's used across the network stack. Here we're simply exploiting
190 * the fact that MLD runs at a similar layer in the stack to scope6.c.
193 * * Each in6_multi corresponds to an ifp, and each ifp corresponds
194 * to a vnet in ifp->if_vnet.
196 static struct mtx mld_mtx;
197 static MALLOC_DEFINE(M_MLD, "mld", "mld state");
199 #define MLD_EMBEDSCOPE(pin6, zoneid) \
200 if (IN6_IS_SCOPE_LINKLOCAL(pin6) || \
201 IN6_IS_ADDR_MC_INTFACELOCAL(pin6)) \
202 (pin6)->s6_addr16[1] = htons((zoneid) & 0xFFFF) \
205 * VIMAGE-wide globals.
207 VNET_DEFINE_STATIC(struct timeval, mld_gsrdelay) = {10, 0};
208 VNET_DEFINE_STATIC(LIST_HEAD(, mld_ifsoftc), mli_head);
209 VNET_DEFINE_STATIC(int, interface_timers_running6);
210 VNET_DEFINE_STATIC(int, state_change_timers_running6);
211 VNET_DEFINE_STATIC(int, current_state_timers_running6);
213 #define V_mld_gsrdelay VNET(mld_gsrdelay)
214 #define V_mli_head VNET(mli_head)
215 #define V_interface_timers_running6 VNET(interface_timers_running6)
216 #define V_state_change_timers_running6 VNET(state_change_timers_running6)
217 #define V_current_state_timers_running6 VNET(current_state_timers_running6)
219 SYSCTL_DECL(_net_inet6); /* Note: Not in any common header. */
221 SYSCTL_NODE(_net_inet6, OID_AUTO, mld, CTLFLAG_RW | CTLFLAG_MPSAFE, 0,
222 "IPv6 Multicast Listener Discovery");
225 * Virtualized sysctls.
227 SYSCTL_PROC(_net_inet6_mld, OID_AUTO, gsrdelay,
228 CTLFLAG_VNET | CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_MPSAFE,
229 &VNET_NAME(mld_gsrdelay.tv_sec), 0, sysctl_mld_gsr, "I",
230 "Rate limit for MLDv2 Group-and-Source queries in seconds");
233 * Non-virtualized sysctls.
235 static SYSCTL_NODE(_net_inet6_mld, OID_AUTO, ifinfo,
236 CTLFLAG_RD | CTLFLAG_MPSAFE, sysctl_mld_ifinfo,
237 "Per-interface MLDv2 state");
239 static int mld_v1enable = 1;
240 SYSCTL_INT(_net_inet6_mld, OID_AUTO, v1enable, CTLFLAG_RWTUN,
241 &mld_v1enable, 0, "Enable fallback to MLDv1");
243 static int mld_v2enable = 1;
244 SYSCTL_INT(_net_inet6_mld, OID_AUTO, v2enable, CTLFLAG_RWTUN,
245 &mld_v2enable, 0, "Enable MLDv2");
247 static int mld_use_allow = 1;
248 SYSCTL_INT(_net_inet6_mld, OID_AUTO, use_allow, CTLFLAG_RWTUN,
249 &mld_use_allow, 0, "Use ALLOW/BLOCK for RFC 4604 SSM joins/leaves");
252 * Packed Router Alert option structure declaration.
257 struct ip6_opt_router ra;
261 * Router Alert hop-by-hop option header.
263 static struct mld_raopt mld_ra = {
265 .pad = { .ip6o_type = IP6OPT_PADN, 0 },
267 .ip6or_type = IP6OPT_ROUTER_ALERT,
268 .ip6or_len = IP6OPT_RTALERT_LEN - 2,
269 .ip6or_value[0] = ((IP6OPT_RTALERT_MLD >> 8) & 0xFF),
270 .ip6or_value[1] = (IP6OPT_RTALERT_MLD & 0xFF)
273 static struct ip6_pktopts mld_po;
276 mld_save_context(struct mbuf *m, struct ifnet *ifp)
280 m->m_pkthdr.PH_loc.ptr = ifp->if_vnet;
282 m->m_pkthdr.rcvif = ifp;
283 m->m_pkthdr.flowid = ifp->if_index;
287 mld_scrub_context(struct mbuf *m)
290 m->m_pkthdr.PH_loc.ptr = NULL;
291 m->m_pkthdr.flowid = 0;
295 * Restore context from a queued output chain.
296 * Return saved ifindex.
298 * VIMAGE: The assertion is there to make sure that we
299 * actually called CURVNET_SET() with what's in the mbuf chain.
301 static __inline uint32_t
302 mld_restore_context(struct mbuf *m)
305 #if defined(VIMAGE) && defined(INVARIANTS)
306 KASSERT(curvnet == m->m_pkthdr.PH_loc.ptr,
307 ("%s: called when curvnet was not restored: cuvnet %p m ptr %p",
308 __func__, curvnet, m->m_pkthdr.PH_loc.ptr));
310 return (m->m_pkthdr.flowid);
314 * Retrieve or set threshold between group-source queries in seconds.
316 * VIMAGE: Assume curvnet set by caller.
317 * SMPng: NOTE: Serialized by MLD lock.
320 sysctl_mld_gsr(SYSCTL_HANDLER_ARGS)
325 error = sysctl_wire_old_buffer(req, sizeof(int));
331 i = V_mld_gsrdelay.tv_sec;
333 error = sysctl_handle_int(oidp, &i, 0, req);
334 if (error || !req->newptr)
337 if (i < -1 || i >= 60) {
342 CTR2(KTR_MLD, "change mld_gsrdelay from %d to %d",
343 V_mld_gsrdelay.tv_sec, i);
344 V_mld_gsrdelay.tv_sec = i;
352 * Expose struct mld_ifsoftc to userland, keyed by ifindex.
353 * For use by ifmcstat(8).
355 * VIMAGE: Assume curvnet set by caller. The node handler itself
356 * is not directly virtualized.
359 sysctl_mld_ifinfo(SYSCTL_HANDLER_ARGS)
361 struct epoch_tracker et;
366 struct mld_ifsoftc *mli;
371 if (req->newptr != NULL)
377 error = sysctl_wire_old_buffer(req, sizeof(struct mld_ifinfo));
382 IN6_MULTI_LIST_LOCK();
387 ifp = ifnet_byindex(name[0]);
391 LIST_FOREACH(mli, &V_mli_head, mli_link) {
392 if (ifp == mli->mli_ifp) {
393 struct mld_ifinfo info;
395 info.mli_version = mli->mli_version;
396 info.mli_v1_timer = mli->mli_v1_timer;
397 info.mli_v2_timer = mli->mli_v2_timer;
398 info.mli_flags = mli->mli_flags;
399 info.mli_rv = mli->mli_rv;
400 info.mli_qi = mli->mli_qi;
401 info.mli_qri = mli->mli_qri;
402 info.mli_uri = mli->mli_uri;
403 error = SYSCTL_OUT(req, &info, sizeof(info));
411 IN6_MULTI_LIST_UNLOCK();
417 * Dispatch an entire queue of pending packet chains.
418 * VIMAGE: Assumes the vnet pointer has been set.
421 mld_dispatch_queue(struct mbufq *mq, int limit)
425 while ((m = mbufq_dequeue(mq)) != NULL) {
426 CTR3(KTR_MLD, "%s: dispatch %p from %p", __func__, mq, m);
427 mld_dispatch_packet(m);
434 * Filter outgoing MLD report state by group.
436 * Reports are ALWAYS suppressed for ALL-HOSTS (ff02::1)
437 * and node-local addresses. However, kernel and socket consumers
438 * always embed the KAME scope ID in the address provided, so strip it
439 * when performing comparison.
440 * Note: This is not the same as the *multicast* scope.
442 * Return zero if the given group is one for which MLD reports
443 * should be suppressed, or non-zero if reports should be issued.
446 mld_is_addr_reported(const struct in6_addr *addr)
449 KASSERT(IN6_IS_ADDR_MULTICAST(addr), ("%s: not multicast", __func__));
451 if (IPV6_ADDR_MC_SCOPE(addr) == IPV6_ADDR_SCOPE_NODELOCAL)
454 if (IPV6_ADDR_MC_SCOPE(addr) == IPV6_ADDR_SCOPE_LINKLOCAL) {
455 struct in6_addr tmp = *addr;
456 in6_clearscope(&tmp);
457 if (IN6_ARE_ADDR_EQUAL(&tmp, &in6addr_linklocal_allnodes))
465 * Attach MLD when PF_INET6 is attached to an interface. Assumes that the
466 * current VNET is set by the caller.
469 mld_domifattach(struct ifnet *ifp)
471 struct mld_ifsoftc *mli;
473 CTR3(KTR_MLD, "%s: called for ifp %p(%s)", __func__, ifp, if_name(ifp));
475 mli = malloc(sizeof(struct mld_ifsoftc), M_MLD, M_WAITOK | M_ZERO);
477 mli->mli_version = MLD_VERSION_2;
479 mli->mli_rv = MLD_RV_INIT;
480 mli->mli_qi = MLD_QI_INIT;
481 mli->mli_qri = MLD_QRI_INIT;
482 mli->mli_uri = MLD_URI_INIT;
483 mbufq_init(&mli->mli_gq, MLD_MAX_RESPONSE_PACKETS);
484 if ((ifp->if_flags & IFF_MULTICAST) == 0)
485 mli->mli_flags |= MLIF_SILENT;
487 mli->mli_flags |= MLIF_USEALLOW;
490 LIST_INSERT_HEAD(&V_mli_head, mli, mli_link);
499 * NOTE: Some finalization tasks need to run before the protocol domain
500 * is detached, but also before the link layer does its cleanup.
501 * Run before link-layer cleanup; cleanup groups, but do not free MLD state.
503 * SMPng: Caller must hold IN6_MULTI_LOCK().
504 * Must take IF_ADDR_LOCK() to cover if_multiaddrs iterator.
505 * XXX This routine is also bitten by unlocked ifma_protospec access.
508 mld_ifdetach(struct ifnet *ifp, struct in6_multi_head *inmh)
510 struct epoch_tracker et;
511 struct mld_ifsoftc *mli;
512 struct ifmultiaddr *ifma;
513 struct in6_multi *inm;
515 CTR3(KTR_MLD, "%s: called for ifp %p(%s)", __func__, ifp,
518 IN6_MULTI_LIST_LOCK_ASSERT();
521 mli = MLD_IFINFO(ifp);
524 * Extract list of in6_multi associated with the detaching ifp
525 * which the PF_INET6 layer is about to release.
528 CK_STAILQ_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link) {
529 inm = in6m_ifmultiaddr_get_inm(ifma);
532 in6m_disconnect_locked(inmh, inm);
534 if (mli->mli_version == MLD_VERSION_2) {
535 in6m_clear_recorded(inm);
538 * We need to release the final reference held
539 * for issuing the INCLUDE {}.
541 if (inm->in6m_state == MLD_LEAVING_MEMBER) {
542 inm->in6m_state = MLD_NOT_MEMBER;
543 in6m_rele_locked(inmh, inm);
548 IF_ADDR_WUNLOCK(ifp);
553 * Hook for domifdetach.
554 * Runs after link-layer cleanup; free MLD state.
556 * SMPng: Normally called with IF_AFDATA_LOCK held.
559 mld_domifdetach(struct ifnet *ifp)
562 CTR3(KTR_MLD, "%s: called for ifp %p(%s)",
563 __func__, ifp, if_name(ifp));
566 mli_delete_locked(ifp);
571 mli_delete_locked(struct ifnet *ifp)
573 struct mld_ifsoftc *mli, *tmli;
575 CTR3(KTR_MLD, "%s: freeing mld_ifsoftc for ifp %p(%s)",
576 __func__, ifp, if_name(ifp));
580 LIST_FOREACH_SAFE(mli, &V_mli_head, mli_link, tmli) {
581 if (mli->mli_ifp == ifp) {
583 * Free deferred General Query responses.
585 mbufq_drain(&mli->mli_gq);
587 LIST_REMOVE(mli, mli_link);
596 * Process a received MLDv1 general or address-specific query.
597 * Assumes that the query header has been pulled up to sizeof(mld_hdr).
599 * NOTE: Can't be fully const correct as we temporarily embed scope ID in
600 * mld_addr. This is OK as we own the mbuf chain.
603 mld_v1_input_query(struct ifnet *ifp, const struct ip6_hdr *ip6,
604 /*const*/ struct mld_hdr *mld)
606 struct ifmultiaddr *ifma;
607 struct mld_ifsoftc *mli;
608 struct in6_multi *inm;
609 int is_general_query;
612 char ip6tbuf[INET6_ADDRSTRLEN];
617 is_general_query = 0;
620 CTR3(KTR_MLD, "ignore v1 query %s on ifp %p(%s)",
621 ip6_sprintf(ip6tbuf, &mld->mld_addr),
627 * RFC3810 Section 6.2: MLD queries must originate from
628 * a router's link-local address.
630 if (!IN6_IS_SCOPE_LINKLOCAL(&ip6->ip6_src)) {
631 CTR3(KTR_MLD, "ignore v1 query src %s on ifp %p(%s)",
632 ip6_sprintf(ip6tbuf, &ip6->ip6_src),
638 * Do address field validation upfront before we accept
641 if (IN6_IS_ADDR_UNSPECIFIED(&mld->mld_addr)) {
643 * MLDv1 General Query.
644 * If this was not sent to the all-nodes group, ignore it.
649 in6_clearscope(&dst);
650 if (!IN6_ARE_ADDR_EQUAL(&dst, &in6addr_linklocal_allnodes))
652 is_general_query = 1;
655 * Embed scope ID of receiving interface in MLD query for
656 * lookup whilst we don't hold other locks.
658 in6_setscope(&mld->mld_addr, ifp, NULL);
661 IN6_MULTI_LIST_LOCK();
665 * Switch to MLDv1 host compatibility mode.
667 mli = MLD_IFINFO(ifp);
668 KASSERT(mli != NULL, ("%s: no mld_ifsoftc for ifp %p", __func__, ifp));
669 mld_set_version(mli, MLD_VERSION_1);
671 timer = (ntohs(mld->mld_maxdelay) * MLD_FASTHZ) / MLD_TIMER_SCALE;
675 if (is_general_query) {
677 * For each reporting group joined on this
678 * interface, kick the report timer.
680 CTR2(KTR_MLD, "process v1 general query on ifp %p(%s)",
682 CK_STAILQ_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link) {
683 inm = in6m_ifmultiaddr_get_inm(ifma);
686 mld_v1_update_group(inm, timer);
690 * MLDv1 Group-Specific Query.
691 * If this is a group-specific MLDv1 query, we need only
692 * look up the single group to process it.
694 inm = in6m_lookup_locked(ifp, &mld->mld_addr);
696 CTR3(KTR_MLD, "process v1 query %s on ifp %p(%s)",
697 ip6_sprintf(ip6tbuf, &mld->mld_addr),
699 mld_v1_update_group(inm, timer);
701 /* XXX Clear embedded scope ID as userland won't expect it. */
702 in6_clearscope(&mld->mld_addr);
706 IN6_MULTI_LIST_UNLOCK();
712 * Update the report timer on a group in response to an MLDv1 query.
714 * If we are becoming the reporting member for this group, start the timer.
715 * If we already are the reporting member for this group, and timer is
716 * below the threshold, reset it.
718 * We may be updating the group for the first time since we switched
719 * to MLDv2. If we are, then we must clear any recorded source lists,
720 * and transition to REPORTING state; the group timer is overloaded
721 * for group and group-source query responses.
723 * Unlike MLDv2, the delay per group should be jittered
724 * to avoid bursts of MLDv1 reports.
727 mld_v1_update_group(struct in6_multi *inm, const int timer)
730 char ip6tbuf[INET6_ADDRSTRLEN];
733 CTR4(KTR_MLD, "%s: %s/%s timer=%d", __func__,
734 ip6_sprintf(ip6tbuf, &inm->in6m_addr),
735 if_name(inm->in6m_ifp), timer);
737 IN6_MULTI_LIST_LOCK_ASSERT();
739 switch (inm->in6m_state) {
741 case MLD_SILENT_MEMBER:
743 case MLD_REPORTING_MEMBER:
744 if (inm->in6m_timer != 0 &&
745 inm->in6m_timer <= timer) {
746 CTR1(KTR_MLD, "%s: REPORTING and timer running, "
747 "skipping.", __func__);
751 case MLD_SG_QUERY_PENDING_MEMBER:
752 case MLD_G_QUERY_PENDING_MEMBER:
753 case MLD_IDLE_MEMBER:
754 case MLD_LAZY_MEMBER:
755 case MLD_AWAKENING_MEMBER:
756 CTR1(KTR_MLD, "%s: ->REPORTING", __func__);
757 inm->in6m_state = MLD_REPORTING_MEMBER;
758 inm->in6m_timer = MLD_RANDOM_DELAY(timer);
759 V_current_state_timers_running6 = 1;
761 case MLD_SLEEPING_MEMBER:
762 CTR1(KTR_MLD, "%s: ->AWAKENING", __func__);
763 inm->in6m_state = MLD_AWAKENING_MEMBER;
765 case MLD_LEAVING_MEMBER:
771 * Process a received MLDv2 general, group-specific or
772 * group-and-source-specific query.
774 * Assumes that mld points to a struct mldv2_query which is stored in
777 * Return 0 if successful, otherwise an appropriate error code is returned.
780 mld_v2_input_query(struct ifnet *ifp, const struct ip6_hdr *ip6,
781 struct mbuf *m, struct mldv2_query *mld, const int off, const int icmp6len)
783 struct mld_ifsoftc *mli;
784 struct in6_multi *inm;
785 uint32_t maxdelay, nsrc, qqi;
786 int is_general_query;
790 char ip6tbuf[INET6_ADDRSTRLEN];
796 CTR3(KTR_MLD, "ignore v2 query src %s on ifp %p(%s)",
797 ip6_sprintf(ip6tbuf, &ip6->ip6_src),
803 * RFC3810 Section 6.2: MLD queries must originate from
804 * a router's link-local address.
806 if (!IN6_IS_SCOPE_LINKLOCAL(&ip6->ip6_src)) {
807 CTR3(KTR_MLD, "ignore v1 query src %s on ifp %p(%s)",
808 ip6_sprintf(ip6tbuf, &ip6->ip6_src),
813 is_general_query = 0;
815 CTR2(KTR_MLD, "input v2 query on ifp %p(%s)", ifp, if_name(ifp));
817 maxdelay = ntohs(mld->mld_maxdelay); /* in 1/10ths of a second */
818 if (maxdelay >= 32768) {
819 maxdelay = (MLD_MRC_MANT(maxdelay) | 0x1000) <<
820 (MLD_MRC_EXP(maxdelay) + 3);
822 timer = (maxdelay * MLD_FASTHZ) / MLD_TIMER_SCALE;
826 qrv = MLD_QRV(mld->mld_misc);
828 CTR3(KTR_MLD, "%s: clamping qrv %d to %d", __func__,
835 qqi = MLD_QQIC_MANT(mld->mld_qqi) <<
836 (MLD_QQIC_EXP(mld->mld_qqi) + 3);
839 nsrc = ntohs(mld->mld_numsrc);
840 if (nsrc > MLD_MAX_GS_SOURCES)
842 if (icmp6len < sizeof(struct mldv2_query) +
843 (nsrc * sizeof(struct in6_addr)))
847 * Do further input validation upfront to avoid resetting timers
848 * should we need to discard this query.
850 if (IN6_IS_ADDR_UNSPECIFIED(&mld->mld_addr)) {
852 * A general query with a source list has undefined
853 * behaviour; discard it.
857 is_general_query = 1;
860 * Embed scope ID of receiving interface in MLD query for
861 * lookup whilst we don't hold other locks (due to KAME
862 * locking lameness). We own this mbuf chain just now.
864 in6_setscope(&mld->mld_addr, ifp, NULL);
867 IN6_MULTI_LIST_LOCK();
870 mli = MLD_IFINFO(ifp);
871 KASSERT(mli != NULL, ("%s: no mld_ifsoftc for ifp %p", __func__, ifp));
874 * Discard the v2 query if we're in Compatibility Mode.
875 * The RFC is pretty clear that hosts need to stay in MLDv1 mode
876 * until the Old Version Querier Present timer expires.
878 if (mli->mli_version != MLD_VERSION_2)
881 mld_set_version(mli, MLD_VERSION_2);
884 mli->mli_qri = maxdelay;
886 CTR4(KTR_MLD, "%s: qrv %d qi %d maxdelay %d", __func__, qrv, qqi,
889 if (is_general_query) {
891 * MLDv2 General Query.
893 * Schedule a current-state report on this ifp for
894 * all groups, possibly containing source lists.
896 * If there is a pending General Query response
897 * scheduled earlier than the selected delay, do
898 * not schedule any other reports.
899 * Otherwise, reset the interface timer.
901 CTR2(KTR_MLD, "process v2 general query on ifp %p(%s)",
903 if (mli->mli_v2_timer == 0 || mli->mli_v2_timer >= timer) {
904 mli->mli_v2_timer = MLD_RANDOM_DELAY(timer);
905 V_interface_timers_running6 = 1;
909 * MLDv2 Group-specific or Group-and-source-specific Query.
911 * Group-source-specific queries are throttled on
912 * a per-group basis to defeat denial-of-service attempts.
913 * Queries for groups we are not a member of on this
914 * link are simply ignored.
916 inm = in6m_lookup_locked(ifp, &mld->mld_addr);
920 if (!ratecheck(&inm->in6m_lastgsrtv,
922 CTR1(KTR_MLD, "%s: GS query throttled.",
927 CTR2(KTR_MLD, "process v2 group query on ifp %p(%s)",
930 * If there is a pending General Query response
931 * scheduled sooner than the selected delay, no
932 * further report need be scheduled.
933 * Otherwise, prepare to respond to the
934 * group-specific or group-and-source query.
936 if (mli->mli_v2_timer == 0 || mli->mli_v2_timer >= timer)
937 mld_v2_process_group_query(inm, mli, timer, m, mld, off);
939 /* XXX Clear embedded scope ID as userland won't expect it. */
940 in6_clearscope(&mld->mld_addr);
945 IN6_MULTI_LIST_UNLOCK();
951 * Process a received MLDv2 group-specific or group-and-source-specific
953 * Return <0 if any error occurred. Currently this is ignored.
956 mld_v2_process_group_query(struct in6_multi *inm, struct mld_ifsoftc *mli,
957 int timer, struct mbuf *m0, struct mldv2_query *mld, const int off)
962 IN6_MULTI_LIST_LOCK_ASSERT();
967 switch (inm->in6m_state) {
969 case MLD_SILENT_MEMBER:
970 case MLD_SLEEPING_MEMBER:
971 case MLD_LAZY_MEMBER:
972 case MLD_AWAKENING_MEMBER:
973 case MLD_IDLE_MEMBER:
974 case MLD_LEAVING_MEMBER:
977 case MLD_REPORTING_MEMBER:
978 case MLD_G_QUERY_PENDING_MEMBER:
979 case MLD_SG_QUERY_PENDING_MEMBER:
983 nsrc = ntohs(mld->mld_numsrc);
985 /* Length should be checked by calling function. */
986 KASSERT((m0->m_flags & M_PKTHDR) == 0 ||
987 m0->m_pkthdr.len >= off + sizeof(struct mldv2_query) +
988 nsrc * sizeof(struct in6_addr),
989 ("mldv2 packet is too short: (%d bytes < %zd bytes, m=%p)",
990 m0->m_pkthdr.len, off + sizeof(struct mldv2_query) +
991 nsrc * sizeof(struct in6_addr), m0));
994 * Deal with group-specific queries upfront.
995 * If any group query is already pending, purge any recorded
996 * source-list state if it exists, and schedule a query response
997 * for this group-specific query.
1000 if (inm->in6m_state == MLD_G_QUERY_PENDING_MEMBER ||
1001 inm->in6m_state == MLD_SG_QUERY_PENDING_MEMBER) {
1002 in6m_clear_recorded(inm);
1003 timer = min(inm->in6m_timer, timer);
1005 inm->in6m_state = MLD_G_QUERY_PENDING_MEMBER;
1006 inm->in6m_timer = MLD_RANDOM_DELAY(timer);
1007 V_current_state_timers_running6 = 1;
1012 * Deal with the case where a group-and-source-specific query has
1013 * been received but a group-specific query is already pending.
1015 if (inm->in6m_state == MLD_G_QUERY_PENDING_MEMBER) {
1016 timer = min(inm->in6m_timer, timer);
1017 inm->in6m_timer = MLD_RANDOM_DELAY(timer);
1018 V_current_state_timers_running6 = 1;
1023 * Finally, deal with the case where a group-and-source-specific
1024 * query has been received, where a response to a previous g-s-r
1025 * query exists, or none exists.
1026 * In this case, we need to parse the source-list which the Querier
1027 * has provided us with and check if we have any source list filter
1028 * entries at T1 for these sources. If we do not, there is no need
1029 * schedule a report and the query may be dropped.
1030 * If we do, we must record them and schedule a current-state
1031 * report for those sources.
1033 if (inm->in6m_nsrc > 0) {
1034 struct in6_addr srcaddr;
1038 soff = off + sizeof(struct mldv2_query);
1040 for (i = 0; i < nsrc; i++) {
1041 m_copydata(m0, soff, sizeof(struct in6_addr),
1043 retval = in6m_record_source(inm, &srcaddr);
1046 nrecorded += retval;
1047 soff += sizeof(struct in6_addr);
1049 if (nrecorded > 0) {
1051 "%s: schedule response to SG query", __func__);
1052 inm->in6m_state = MLD_SG_QUERY_PENDING_MEMBER;
1053 inm->in6m_timer = MLD_RANDOM_DELAY(timer);
1054 V_current_state_timers_running6 = 1;
1062 * Process a received MLDv1 host membership report.
1063 * Assumes mld points to mld_hdr in pulled up mbuf chain.
1065 * NOTE: Can't be fully const correct as we temporarily embed scope ID in
1066 * mld_addr. This is OK as we own the mbuf chain.
1069 mld_v1_input_report(struct ifnet *ifp, const struct ip6_hdr *ip6,
1070 /*const*/ struct mld_hdr *mld)
1072 struct in6_addr src, dst;
1073 struct in6_ifaddr *ia;
1074 struct in6_multi *inm;
1076 char ip6tbuf[INET6_ADDRSTRLEN];
1081 if (!mld_v1enable) {
1082 CTR3(KTR_MLD, "ignore v1 report %s on ifp %p(%s)",
1083 ip6_sprintf(ip6tbuf, &mld->mld_addr),
1088 if (ifp->if_flags & IFF_LOOPBACK)
1092 * MLDv1 reports must originate from a host's link-local address,
1093 * or the unspecified address (when booting).
1096 in6_clearscope(&src);
1097 if (!IN6_IS_SCOPE_LINKLOCAL(&src) && !IN6_IS_ADDR_UNSPECIFIED(&src)) {
1098 CTR3(KTR_MLD, "ignore v1 query src %s on ifp %p(%s)",
1099 ip6_sprintf(ip6tbuf, &ip6->ip6_src),
1105 * RFC2710 Section 4: MLDv1 reports must pertain to a multicast
1106 * group, and must be directed to the group itself.
1109 in6_clearscope(&dst);
1110 if (!IN6_IS_ADDR_MULTICAST(&mld->mld_addr) ||
1111 !IN6_ARE_ADDR_EQUAL(&mld->mld_addr, &dst)) {
1112 CTR3(KTR_MLD, "ignore v1 query dst %s on ifp %p(%s)",
1113 ip6_sprintf(ip6tbuf, &ip6->ip6_dst),
1119 * Make sure we don't hear our own membership report, as fast
1120 * leave requires knowing that we are the only member of a
1121 * group. Assume we used the link-local address if available,
1122 * otherwise look for ::.
1124 * XXX Note that scope ID comparison is needed for the address
1125 * returned by in6ifa_ifpforlinklocal(), but SHOULD NOT be
1126 * performed for the on-wire address.
1128 ia = in6ifa_ifpforlinklocal(ifp, IN6_IFF_NOTREADY|IN6_IFF_ANYCAST);
1129 if ((ia && IN6_ARE_ADDR_EQUAL(&ip6->ip6_src, IA6_IN6(ia))) ||
1130 (ia == NULL && IN6_IS_ADDR_UNSPECIFIED(&src))) {
1132 ifa_free(&ia->ia_ifa);
1136 ifa_free(&ia->ia_ifa);
1138 CTR3(KTR_MLD, "process v1 report %s on ifp %p(%s)",
1139 ip6_sprintf(ip6tbuf, &mld->mld_addr), ifp, if_name(ifp));
1142 * Embed scope ID of receiving interface in MLD query for lookup
1143 * whilst we don't hold other locks (due to KAME locking lameness).
1145 if (!IN6_IS_ADDR_UNSPECIFIED(&mld->mld_addr))
1146 in6_setscope(&mld->mld_addr, ifp, NULL);
1148 IN6_MULTI_LIST_LOCK();
1152 * MLDv1 report suppression.
1153 * If we are a member of this group, and our membership should be
1154 * reported, and our group timer is pending or about to be reset,
1155 * stop our group timer by transitioning to the 'lazy' state.
1157 inm = in6m_lookup_locked(ifp, &mld->mld_addr);
1159 struct mld_ifsoftc *mli;
1161 mli = inm->in6m_mli;
1162 KASSERT(mli != NULL,
1163 ("%s: no mli for ifp %p", __func__, ifp));
1166 * If we are in MLDv2 host mode, do not allow the
1167 * other host's MLDv1 report to suppress our reports.
1169 if (mli->mli_version == MLD_VERSION_2)
1172 inm->in6m_timer = 0;
1174 switch (inm->in6m_state) {
1175 case MLD_NOT_MEMBER:
1176 case MLD_SILENT_MEMBER:
1177 case MLD_SLEEPING_MEMBER:
1179 case MLD_REPORTING_MEMBER:
1180 case MLD_IDLE_MEMBER:
1181 case MLD_AWAKENING_MEMBER:
1183 "report suppressed for %s on ifp %p(%s)",
1184 ip6_sprintf(ip6tbuf, &mld->mld_addr),
1186 case MLD_LAZY_MEMBER:
1187 inm->in6m_state = MLD_LAZY_MEMBER;
1189 case MLD_G_QUERY_PENDING_MEMBER:
1190 case MLD_SG_QUERY_PENDING_MEMBER:
1191 case MLD_LEAVING_MEMBER:
1198 IN6_MULTI_LIST_UNLOCK();
1200 /* XXX Clear embedded scope ID as userland won't expect it. */
1201 in6_clearscope(&mld->mld_addr);
1209 * Assume query messages which fit in a single ICMPv6 message header
1210 * have been pulled up.
1211 * Assume that userland will want to see the message, even if it
1212 * otherwise fails kernel input validation; do not free it.
1213 * Pullup may however free the mbuf chain m if it fails.
1215 * Return IPPROTO_DONE if we freed m. Otherwise, return 0.
1218 mld_input(struct mbuf **mp, int off, int icmp6len)
1221 struct ip6_hdr *ip6;
1223 struct mld_hdr *mld;
1227 CTR3(KTR_MLD, "%s: called w/mbuf (%p,%d)", __func__, m, off);
1229 ifp = m->m_pkthdr.rcvif;
1231 /* Pullup to appropriate size. */
1232 if (m->m_len < off + sizeof(*mld)) {
1233 m = m_pullup(m, off + sizeof(*mld));
1235 ICMP6STAT_INC(icp6s_badlen);
1236 return (IPPROTO_DONE);
1239 mld = (struct mld_hdr *)(mtod(m, uint8_t *) + off);
1240 if (mld->mld_type == MLD_LISTENER_QUERY &&
1241 icmp6len >= sizeof(struct mldv2_query)) {
1242 mldlen = sizeof(struct mldv2_query);
1244 mldlen = sizeof(struct mld_hdr);
1246 if (m->m_len < off + mldlen) {
1247 m = m_pullup(m, off + mldlen);
1249 ICMP6STAT_INC(icp6s_badlen);
1250 return (IPPROTO_DONE);
1254 ip6 = mtod(m, struct ip6_hdr *);
1255 mld = (struct mld_hdr *)(mtod(m, uint8_t *) + off);
1258 * Userland needs to see all of this traffic for implementing
1259 * the endpoint discovery portion of multicast routing.
1261 switch (mld->mld_type) {
1262 case MLD_LISTENER_QUERY:
1263 icmp6_ifstat_inc(ifp, ifs6_in_mldquery);
1264 if (icmp6len == sizeof(struct mld_hdr)) {
1265 if (mld_v1_input_query(ifp, ip6, mld) != 0)
1267 } else if (icmp6len >= sizeof(struct mldv2_query)) {
1268 if (mld_v2_input_query(ifp, ip6, m,
1269 (struct mldv2_query *)mld, off, icmp6len) != 0)
1273 case MLD_LISTENER_REPORT:
1274 icmp6_ifstat_inc(ifp, ifs6_in_mldreport);
1275 if (mld_v1_input_report(ifp, ip6, mld) != 0)
1278 case MLDV2_LISTENER_REPORT:
1279 icmp6_ifstat_inc(ifp, ifs6_in_mldreport);
1281 case MLD_LISTENER_DONE:
1282 icmp6_ifstat_inc(ifp, ifs6_in_mlddone);
1292 * Fast timeout handler (global).
1293 * VIMAGE: Timeout handlers are expected to service all vimages.
1295 static struct callout mldfast_callout;
1297 mld_fasttimo(void *arg __unused)
1299 struct epoch_tracker et;
1300 struct in6_multi_head inmh;
1301 VNET_ITERATOR_DECL(vnet_iter);
1305 NET_EPOCH_ENTER(et);
1306 VNET_LIST_RLOCK_NOSLEEP();
1307 VNET_FOREACH(vnet_iter) {
1308 CURVNET_SET(vnet_iter);
1309 mld_fasttimo_vnet(&inmh);
1312 VNET_LIST_RUNLOCK_NOSLEEP();
1314 in6m_release_list_deferred(&inmh);
1316 callout_reset(&mldfast_callout, hz / MLD_FASTHZ, mld_fasttimo, NULL);
1320 * Fast timeout handler (per-vnet).
1322 * VIMAGE: Assume caller has set up our curvnet.
1325 mld_fasttimo_vnet(struct in6_multi_head *inmh)
1327 struct mbufq scq; /* State-change packets */
1328 struct mbufq qrq; /* Query response packets */
1330 struct mld_ifsoftc *mli;
1331 struct ifmultiaddr *ifma;
1332 struct in6_multi *inm;
1338 * Quick check to see if any work needs to be done, in order to
1339 * minimize the overhead of fasttimo processing.
1340 * SMPng: XXX Unlocked reads.
1342 if (!V_current_state_timers_running6 &&
1343 !V_interface_timers_running6 &&
1344 !V_state_change_timers_running6)
1347 IN6_MULTI_LIST_LOCK();
1351 * MLDv2 General Query response timer processing.
1353 if (V_interface_timers_running6) {
1354 CTR1(KTR_MLD, "%s: interface timers running", __func__);
1356 V_interface_timers_running6 = 0;
1357 LIST_FOREACH(mli, &V_mli_head, mli_link) {
1358 if (mli->mli_v2_timer == 0) {
1360 } else if (--mli->mli_v2_timer == 0) {
1361 mld_v2_dispatch_general_query(mli);
1363 V_interface_timers_running6 = 1;
1368 if (!V_current_state_timers_running6 &&
1369 !V_state_change_timers_running6)
1372 V_current_state_timers_running6 = 0;
1373 V_state_change_timers_running6 = 0;
1375 CTR1(KTR_MLD, "%s: state change timers running", __func__);
1378 * MLD host report and state-change timer processing.
1379 * Note: Processing a v2 group timer may remove a node.
1381 LIST_FOREACH(mli, &V_mli_head, mli_link) {
1384 if (mli->mli_version == MLD_VERSION_2) {
1385 uri_fasthz = MLD_RANDOM_DELAY(mli->mli_uri *
1387 mbufq_init(&qrq, MLD_MAX_G_GS_PACKETS);
1388 mbufq_init(&scq, MLD_MAX_STATE_CHANGE_PACKETS);
1392 CK_STAILQ_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link) {
1393 inm = in6m_ifmultiaddr_get_inm(ifma);
1396 switch (mli->mli_version) {
1398 mld_v1_process_group_timer(inmh, inm);
1401 mld_v2_process_group_timers(inmh, &qrq,
1402 &scq, inm, uri_fasthz);
1406 IF_ADDR_WUNLOCK(ifp);
1408 switch (mli->mli_version) {
1411 * Transmit reports for this lifecycle. This
1412 * is done while not holding IF_ADDR_LOCK
1413 * since this can call
1414 * in6ifa_ifpforlinklocal() which locks
1415 * IF_ADDR_LOCK internally as well as
1416 * ip6_output() to transmit a packet.
1418 while ((inm = SLIST_FIRST(inmh)) != NULL) {
1419 SLIST_REMOVE_HEAD(inmh, in6m_defer);
1420 (void)mld_v1_transmit_report(inm,
1421 MLD_LISTENER_REPORT);
1425 mld_dispatch_queue(&qrq, 0);
1426 mld_dispatch_queue(&scq, 0);
1433 IN6_MULTI_LIST_UNLOCK();
1437 * Update host report group timer.
1438 * Will update the global pending timer flags.
1441 mld_v1_process_group_timer(struct in6_multi_head *inmh, struct in6_multi *inm)
1443 int report_timer_expired;
1445 IN6_MULTI_LIST_LOCK_ASSERT();
1448 if (inm->in6m_timer == 0) {
1449 report_timer_expired = 0;
1450 } else if (--inm->in6m_timer == 0) {
1451 report_timer_expired = 1;
1453 V_current_state_timers_running6 = 1;
1457 switch (inm->in6m_state) {
1458 case MLD_NOT_MEMBER:
1459 case MLD_SILENT_MEMBER:
1460 case MLD_IDLE_MEMBER:
1461 case MLD_LAZY_MEMBER:
1462 case MLD_SLEEPING_MEMBER:
1463 case MLD_AWAKENING_MEMBER:
1465 case MLD_REPORTING_MEMBER:
1466 if (report_timer_expired) {
1467 inm->in6m_state = MLD_IDLE_MEMBER;
1468 SLIST_INSERT_HEAD(inmh, inm, in6m_defer);
1471 case MLD_G_QUERY_PENDING_MEMBER:
1472 case MLD_SG_QUERY_PENDING_MEMBER:
1473 case MLD_LEAVING_MEMBER:
1479 * Update a group's timers for MLDv2.
1480 * Will update the global pending timer flags.
1481 * Note: Unlocked read from mli.
1484 mld_v2_process_group_timers(struct in6_multi_head *inmh,
1485 struct mbufq *qrq, struct mbufq *scq,
1486 struct in6_multi *inm, const int uri_fasthz)
1488 int query_response_timer_expired;
1489 int state_change_retransmit_timer_expired;
1491 char ip6tbuf[INET6_ADDRSTRLEN];
1494 IN6_MULTI_LIST_LOCK_ASSERT();
1497 query_response_timer_expired = 0;
1498 state_change_retransmit_timer_expired = 0;
1501 * During a transition from compatibility mode back to MLDv2,
1502 * a group record in REPORTING state may still have its group
1503 * timer active. This is a no-op in this function; it is easier
1504 * to deal with it here than to complicate the slow-timeout path.
1506 if (inm->in6m_timer == 0) {
1507 query_response_timer_expired = 0;
1508 } else if (--inm->in6m_timer == 0) {
1509 query_response_timer_expired = 1;
1511 V_current_state_timers_running6 = 1;
1514 if (inm->in6m_sctimer == 0) {
1515 state_change_retransmit_timer_expired = 0;
1516 } else if (--inm->in6m_sctimer == 0) {
1517 state_change_retransmit_timer_expired = 1;
1519 V_state_change_timers_running6 = 1;
1522 /* We are in fasttimo, so be quick about it. */
1523 if (!state_change_retransmit_timer_expired &&
1524 !query_response_timer_expired)
1527 switch (inm->in6m_state) {
1528 case MLD_NOT_MEMBER:
1529 case MLD_SILENT_MEMBER:
1530 case MLD_SLEEPING_MEMBER:
1531 case MLD_LAZY_MEMBER:
1532 case MLD_AWAKENING_MEMBER:
1533 case MLD_IDLE_MEMBER:
1535 case MLD_G_QUERY_PENDING_MEMBER:
1536 case MLD_SG_QUERY_PENDING_MEMBER:
1538 * Respond to a previously pending Group-Specific
1539 * or Group-and-Source-Specific query by enqueueing
1540 * the appropriate Current-State report for
1541 * immediate transmission.
1543 if (query_response_timer_expired) {
1544 int retval __unused;
1546 retval = mld_v2_enqueue_group_record(qrq, inm, 0, 1,
1547 (inm->in6m_state == MLD_SG_QUERY_PENDING_MEMBER),
1549 CTR2(KTR_MLD, "%s: enqueue record = %d",
1551 inm->in6m_state = MLD_REPORTING_MEMBER;
1552 in6m_clear_recorded(inm);
1555 case MLD_REPORTING_MEMBER:
1556 case MLD_LEAVING_MEMBER:
1557 if (state_change_retransmit_timer_expired) {
1559 * State-change retransmission timer fired.
1560 * If there are any further pending retransmissions,
1561 * set the global pending state-change flag, and
1564 if (--inm->in6m_scrv > 0) {
1565 inm->in6m_sctimer = uri_fasthz;
1566 V_state_change_timers_running6 = 1;
1569 * Retransmit the previously computed state-change
1570 * report. If there are no further pending
1571 * retransmissions, the mbuf queue will be consumed.
1572 * Update T0 state to T1 as we have now sent
1575 (void)mld_v2_merge_state_changes(inm, scq);
1578 CTR3(KTR_MLD, "%s: T1 -> T0 for %s/%s", __func__,
1579 ip6_sprintf(ip6tbuf, &inm->in6m_addr),
1580 if_name(inm->in6m_ifp));
1583 * If we are leaving the group for good, make sure
1584 * we release MLD's reference to it.
1585 * This release must be deferred using a SLIST,
1586 * as we are called from a loop which traverses
1587 * the in_ifmultiaddr TAILQ.
1589 if (inm->in6m_state == MLD_LEAVING_MEMBER &&
1590 inm->in6m_scrv == 0) {
1591 inm->in6m_state = MLD_NOT_MEMBER;
1592 in6m_disconnect_locked(inmh, inm);
1593 in6m_rele_locked(inmh, inm);
1601 * Switch to a different version on the given interface,
1602 * as per Section 9.12.
1605 mld_set_version(struct mld_ifsoftc *mli, const int version)
1607 int old_version_timer;
1611 CTR4(KTR_MLD, "%s: switching to v%d on ifp %p(%s)", __func__,
1612 version, mli->mli_ifp, if_name(mli->mli_ifp));
1614 if (version == MLD_VERSION_1) {
1616 * Compute the "Older Version Querier Present" timer as per
1619 old_version_timer = (mli->mli_rv * mli->mli_qi) + mli->mli_qri;
1620 old_version_timer *= MLD_SLOWHZ;
1621 mli->mli_v1_timer = old_version_timer;
1624 if (mli->mli_v1_timer > 0 && mli->mli_version != MLD_VERSION_1) {
1625 mli->mli_version = MLD_VERSION_1;
1626 mld_v2_cancel_link_timers(mli);
1631 * Cancel pending MLDv2 timers for the given link and all groups
1632 * joined on it; state-change, general-query, and group-query timers.
1635 mld_v2_cancel_link_timers(struct mld_ifsoftc *mli)
1637 struct epoch_tracker et;
1638 struct in6_multi_head inmh;
1639 struct ifmultiaddr *ifma;
1641 struct in6_multi *inm;
1643 CTR3(KTR_MLD, "%s: cancel v2 timers on ifp %p(%s)", __func__,
1644 mli->mli_ifp, if_name(mli->mli_ifp));
1647 IN6_MULTI_LIST_LOCK_ASSERT();
1651 * Fast-track this potentially expensive operation
1652 * by checking all the global 'timer pending' flags.
1654 if (!V_interface_timers_running6 &&
1655 !V_state_change_timers_running6 &&
1656 !V_current_state_timers_running6)
1659 mli->mli_v2_timer = 0;
1664 NET_EPOCH_ENTER(et);
1665 CK_STAILQ_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link) {
1666 inm = in6m_ifmultiaddr_get_inm(ifma);
1669 switch (inm->in6m_state) {
1670 case MLD_NOT_MEMBER:
1671 case MLD_SILENT_MEMBER:
1672 case MLD_IDLE_MEMBER:
1673 case MLD_LAZY_MEMBER:
1674 case MLD_SLEEPING_MEMBER:
1675 case MLD_AWAKENING_MEMBER:
1677 case MLD_LEAVING_MEMBER:
1679 * If we are leaving the group and switching
1680 * version, we need to release the final
1681 * reference held for issuing the INCLUDE {}.
1683 if (inm->in6m_refcount == 1)
1684 in6m_disconnect_locked(&inmh, inm);
1685 in6m_rele_locked(&inmh, inm);
1687 case MLD_G_QUERY_PENDING_MEMBER:
1688 case MLD_SG_QUERY_PENDING_MEMBER:
1689 in6m_clear_recorded(inm);
1691 case MLD_REPORTING_MEMBER:
1692 inm->in6m_sctimer = 0;
1693 inm->in6m_timer = 0;
1694 inm->in6m_state = MLD_REPORTING_MEMBER;
1696 * Free any pending MLDv2 state-change records.
1698 mbufq_drain(&inm->in6m_scq);
1703 IF_ADDR_WUNLOCK(ifp);
1704 in6m_release_list_deferred(&inmh);
1708 * Global slowtimo handler.
1709 * VIMAGE: Timeout handlers are expected to service all vimages.
1711 static struct callout mldslow_callout;
1713 mld_slowtimo(void *arg __unused)
1715 VNET_ITERATOR_DECL(vnet_iter);
1717 VNET_LIST_RLOCK_NOSLEEP();
1718 VNET_FOREACH(vnet_iter) {
1719 CURVNET_SET(vnet_iter);
1720 mld_slowtimo_vnet();
1723 VNET_LIST_RUNLOCK_NOSLEEP();
1725 callout_reset(&mldslow_callout, hz / MLD_SLOWHZ, mld_slowtimo, NULL);
1729 * Per-vnet slowtimo handler.
1732 mld_slowtimo_vnet(void)
1734 struct mld_ifsoftc *mli;
1738 LIST_FOREACH(mli, &V_mli_head, mli_link) {
1739 mld_v1_process_querier_timers(mli);
1746 * Update the Older Version Querier Present timers for a link.
1747 * See Section 9.12 of RFC 3810.
1750 mld_v1_process_querier_timers(struct mld_ifsoftc *mli)
1755 if (mli->mli_version != MLD_VERSION_2 && --mli->mli_v1_timer == 0) {
1757 * MLDv1 Querier Present timer expired; revert to MLDv2.
1760 "%s: transition from v%d -> v%d on %p(%s)",
1761 __func__, mli->mli_version, MLD_VERSION_2,
1762 mli->mli_ifp, if_name(mli->mli_ifp));
1763 mli->mli_version = MLD_VERSION_2;
1768 * Transmit an MLDv1 report immediately.
1771 mld_v1_transmit_report(struct in6_multi *in6m, const int type)
1774 struct in6_ifaddr *ia;
1775 struct ip6_hdr *ip6;
1776 struct mbuf *mh, *md;
1777 struct mld_hdr *mld;
1780 IN6_MULTI_LIST_LOCK_ASSERT();
1783 ifp = in6m->in6m_ifp;
1784 /* in process of being freed */
1787 ia = in6ifa_ifpforlinklocal(ifp, IN6_IFF_NOTREADY|IN6_IFF_ANYCAST);
1788 /* ia may be NULL if link-local address is tentative. */
1790 mh = m_gethdr(M_NOWAIT, MT_DATA);
1793 ifa_free(&ia->ia_ifa);
1796 md = m_get(M_NOWAIT, MT_DATA);
1800 ifa_free(&ia->ia_ifa);
1806 * FUTURE: Consider increasing alignment by ETHER_HDR_LEN, so
1807 * that ether_output() does not need to allocate another mbuf
1808 * for the header in the most common case.
1810 M_ALIGN(mh, sizeof(struct ip6_hdr));
1811 mh->m_pkthdr.len = sizeof(struct ip6_hdr) + sizeof(struct mld_hdr);
1812 mh->m_len = sizeof(struct ip6_hdr);
1814 ip6 = mtod(mh, struct ip6_hdr *);
1816 ip6->ip6_vfc &= ~IPV6_VERSION_MASK;
1817 ip6->ip6_vfc |= IPV6_VERSION;
1818 ip6->ip6_nxt = IPPROTO_ICMPV6;
1819 ip6->ip6_src = ia ? ia->ia_addr.sin6_addr : in6addr_any;
1820 ip6->ip6_dst = in6m->in6m_addr;
1822 md->m_len = sizeof(struct mld_hdr);
1823 mld = mtod(md, struct mld_hdr *);
1824 mld->mld_type = type;
1827 mld->mld_maxdelay = 0;
1828 mld->mld_reserved = 0;
1829 mld->mld_addr = in6m->in6m_addr;
1830 in6_clearscope(&mld->mld_addr);
1831 mld->mld_cksum = in6_cksum(mh, IPPROTO_ICMPV6,
1832 sizeof(struct ip6_hdr), sizeof(struct mld_hdr));
1834 mld_save_context(mh, ifp);
1835 mh->m_flags |= M_MLDV1;
1837 mld_dispatch_packet(mh);
1840 ifa_free(&ia->ia_ifa);
1845 * Process a state change from the upper layer for the given IPv6 group.
1847 * Each socket holds a reference on the in_multi in its own ip_moptions.
1848 * The socket layer will have made the necessary updates to.the group
1849 * state, it is now up to MLD to issue a state change report if there
1850 * has been any change between T0 (when the last state-change was issued)
1853 * We use the MLDv2 state machine at group level. The MLd module
1854 * however makes the decision as to which MLD protocol version to speak.
1855 * A state change *from* INCLUDE {} always means an initial join.
1856 * A state change *to* INCLUDE {} always means a final leave.
1858 * If delay is non-zero, and the state change is an initial multicast
1859 * join, the state change report will be delayed by 'delay' ticks
1860 * in units of MLD_FASTHZ if MLDv1 is active on the link; otherwise
1861 * the initial MLDv2 state change report will be delayed by whichever
1862 * is sooner, a pending state-change timer or delay itself.
1864 * VIMAGE: curvnet should have been set by caller, as this routine
1865 * is called from the socket option handlers.
1868 mld_change_state(struct in6_multi *inm, const int delay)
1870 struct mld_ifsoftc *mli;
1874 IN6_MULTI_LIST_LOCK_ASSERT();
1879 * Check if the in6_multi has already been disconnected.
1881 if (inm->in6m_ifp == NULL) {
1882 CTR1(KTR_MLD, "%s: inm is disconnected", __func__);
1887 * Try to detect if the upper layer just asked us to change state
1888 * for an interface which has now gone away.
1890 KASSERT(inm->in6m_ifma != NULL, ("%s: no ifma", __func__));
1891 ifp = inm->in6m_ifma->ifma_ifp;
1895 * Sanity check that netinet6's notion of ifp is the
1898 KASSERT(inm->in6m_ifp == ifp, ("%s: bad ifp", __func__));
1901 mli = MLD_IFINFO(ifp);
1902 KASSERT(mli != NULL, ("%s: no mld_ifsoftc for ifp %p", __func__, ifp));
1905 * If we detect a state transition to or from MCAST_UNDEFINED
1906 * for this group, then we are starting or finishing an MLD
1907 * life cycle for this group.
1909 if (inm->in6m_st[1].iss_fmode != inm->in6m_st[0].iss_fmode) {
1910 CTR3(KTR_MLD, "%s: inm transition %d -> %d", __func__,
1911 inm->in6m_st[0].iss_fmode, inm->in6m_st[1].iss_fmode);
1912 if (inm->in6m_st[0].iss_fmode == MCAST_UNDEFINED) {
1913 CTR1(KTR_MLD, "%s: initial join", __func__);
1914 error = mld_initial_join(inm, mli, delay);
1916 } else if (inm->in6m_st[1].iss_fmode == MCAST_UNDEFINED) {
1917 CTR1(KTR_MLD, "%s: final leave", __func__);
1918 mld_final_leave(inm, mli);
1922 CTR1(KTR_MLD, "%s: filter set change", __func__);
1925 error = mld_handle_state_change(inm, mli);
1933 * Perform the initial join for an MLD group.
1935 * When joining a group:
1936 * If the group should have its MLD traffic suppressed, do nothing.
1937 * MLDv1 starts sending MLDv1 host membership reports.
1938 * MLDv2 will schedule an MLDv2 state-change report containing the
1939 * initial state of the membership.
1941 * If the delay argument is non-zero, then we must delay sending the
1942 * initial state change for delay ticks (in units of MLD_FASTHZ).
1945 mld_initial_join(struct in6_multi *inm, struct mld_ifsoftc *mli,
1948 struct epoch_tracker et;
1951 int error, retval, syncstates;
1954 char ip6tbuf[INET6_ADDRSTRLEN];
1957 CTR4(KTR_MLD, "%s: initial join %s on ifp %p(%s)",
1958 __func__, ip6_sprintf(ip6tbuf, &inm->in6m_addr),
1959 inm->in6m_ifp, if_name(inm->in6m_ifp));
1964 ifp = inm->in6m_ifp;
1966 IN6_MULTI_LIST_LOCK_ASSERT();
1969 KASSERT(mli && mli->mli_ifp == ifp, ("%s: inconsistent ifp", __func__));
1972 * Groups joined on loopback or marked as 'not reported',
1973 * enter the MLD_SILENT_MEMBER state and
1974 * are never reported in any protocol exchanges.
1975 * All other groups enter the appropriate state machine
1976 * for the version in use on this link.
1977 * A link marked as MLIF_SILENT causes MLD to be completely
1978 * disabled for the link.
1980 if ((ifp->if_flags & IFF_LOOPBACK) ||
1981 (mli->mli_flags & MLIF_SILENT) ||
1982 !mld_is_addr_reported(&inm->in6m_addr)) {
1984 "%s: not kicking state machine for silent group", __func__);
1985 inm->in6m_state = MLD_SILENT_MEMBER;
1986 inm->in6m_timer = 0;
1989 * Deal with overlapping in_multi lifecycle.
1990 * If this group was LEAVING, then make sure
1991 * we drop the reference we picked up to keep the
1992 * group around for the final INCLUDE {} enqueue.
1994 if (mli->mli_version == MLD_VERSION_2 &&
1995 inm->in6m_state == MLD_LEAVING_MEMBER) {
1996 inm->in6m_refcount--;
1997 MPASS(inm->in6m_refcount > 0);
1999 inm->in6m_state = MLD_REPORTING_MEMBER;
2001 switch (mli->mli_version) {
2004 * If a delay was provided, only use it if
2005 * it is greater than the delay normally
2006 * used for an MLDv1 state change report,
2007 * and delay sending the initial MLDv1 report
2008 * by not transitioning to the IDLE state.
2010 odelay = MLD_RANDOM_DELAY(MLD_V1_MAX_RI * MLD_FASTHZ);
2012 inm->in6m_timer = max(delay, odelay);
2013 V_current_state_timers_running6 = 1;
2015 inm->in6m_state = MLD_IDLE_MEMBER;
2016 NET_EPOCH_ENTER(et);
2017 error = mld_v1_transmit_report(inm,
2018 MLD_LISTENER_REPORT);
2021 inm->in6m_timer = odelay;
2022 V_current_state_timers_running6 = 1;
2029 * Defer update of T0 to T1, until the first copy
2030 * of the state change has been transmitted.
2035 * Immediately enqueue a State-Change Report for
2036 * this interface, freeing any previous reports.
2037 * Don't kick the timers if there is nothing to do,
2038 * or if an error occurred.
2040 mq = &inm->in6m_scq;
2042 retval = mld_v2_enqueue_group_record(mq, inm, 1,
2043 0, 0, (mli->mli_flags & MLIF_USEALLOW));
2044 CTR2(KTR_MLD, "%s: enqueue record = %d",
2047 error = retval * -1;
2052 * Schedule transmission of pending state-change
2053 * report up to RV times for this link. The timer
2054 * will fire at the next mld_fasttimo (~200ms),
2055 * giving us an opportunity to merge the reports.
2057 * If a delay was provided to this function, only
2058 * use this delay if sooner than the existing one.
2060 KASSERT(mli->mli_rv > 1,
2061 ("%s: invalid robustness %d", __func__,
2063 inm->in6m_scrv = mli->mli_rv;
2065 if (inm->in6m_sctimer > 1) {
2067 min(inm->in6m_sctimer, delay);
2069 inm->in6m_sctimer = delay;
2071 inm->in6m_sctimer = 1;
2072 V_state_change_timers_running6 = 1;
2080 * Only update the T0 state if state change is atomic,
2081 * i.e. we don't need to wait for a timer to fire before we
2082 * can consider the state change to have been communicated.
2086 CTR3(KTR_MLD, "%s: T1 -> T0 for %s/%s", __func__,
2087 ip6_sprintf(ip6tbuf, &inm->in6m_addr),
2088 if_name(inm->in6m_ifp));
2095 * Issue an intermediate state change during the life-cycle.
2098 mld_handle_state_change(struct in6_multi *inm, struct mld_ifsoftc *mli)
2103 char ip6tbuf[INET6_ADDRSTRLEN];
2106 CTR4(KTR_MLD, "%s: state change for %s on ifp %p(%s)",
2107 __func__, ip6_sprintf(ip6tbuf, &inm->in6m_addr),
2108 inm->in6m_ifp, if_name(inm->in6m_ifp));
2110 ifp = inm->in6m_ifp;
2112 IN6_MULTI_LIST_LOCK_ASSERT();
2115 KASSERT(mli && mli->mli_ifp == ifp,
2116 ("%s: inconsistent ifp", __func__));
2118 if ((ifp->if_flags & IFF_LOOPBACK) ||
2119 (mli->mli_flags & MLIF_SILENT) ||
2120 !mld_is_addr_reported(&inm->in6m_addr) ||
2121 (mli->mli_version != MLD_VERSION_2)) {
2122 if (!mld_is_addr_reported(&inm->in6m_addr)) {
2124 "%s: not kicking state machine for silent group", __func__);
2126 CTR1(KTR_MLD, "%s: nothing to do", __func__);
2128 CTR3(KTR_MLD, "%s: T1 -> T0 for %s/%s", __func__,
2129 ip6_sprintf(ip6tbuf, &inm->in6m_addr),
2130 if_name(inm->in6m_ifp));
2134 mbufq_drain(&inm->in6m_scq);
2136 retval = mld_v2_enqueue_group_record(&inm->in6m_scq, inm, 1, 0, 0,
2137 (mli->mli_flags & MLIF_USEALLOW));
2138 CTR2(KTR_MLD, "%s: enqueue record = %d", __func__, retval);
2143 * If record(s) were enqueued, start the state-change
2144 * report timer for this group.
2146 inm->in6m_scrv = mli->mli_rv;
2147 inm->in6m_sctimer = 1;
2148 V_state_change_timers_running6 = 1;
2154 * Perform the final leave for a multicast address.
2156 * When leaving a group:
2157 * MLDv1 sends a DONE message, if and only if we are the reporter.
2158 * MLDv2 enqueues a state-change report containing a transition
2159 * to INCLUDE {} for immediate transmission.
2162 mld_final_leave(struct in6_multi *inm, struct mld_ifsoftc *mli)
2164 struct epoch_tracker et;
2166 char ip6tbuf[INET6_ADDRSTRLEN];
2169 CTR4(KTR_MLD, "%s: final leave %s on ifp %p(%s)",
2170 __func__, ip6_sprintf(ip6tbuf, &inm->in6m_addr),
2171 inm->in6m_ifp, if_name(inm->in6m_ifp));
2173 IN6_MULTI_LIST_LOCK_ASSERT();
2176 switch (inm->in6m_state) {
2177 case MLD_NOT_MEMBER:
2178 case MLD_SILENT_MEMBER:
2179 case MLD_LEAVING_MEMBER:
2180 /* Already leaving or left; do nothing. */
2182 "%s: not kicking state machine for silent group", __func__);
2184 case MLD_REPORTING_MEMBER:
2185 case MLD_IDLE_MEMBER:
2186 case MLD_G_QUERY_PENDING_MEMBER:
2187 case MLD_SG_QUERY_PENDING_MEMBER:
2188 if (mli->mli_version == MLD_VERSION_1) {
2190 if (inm->in6m_state == MLD_G_QUERY_PENDING_MEMBER ||
2191 inm->in6m_state == MLD_SG_QUERY_PENDING_MEMBER)
2192 panic("%s: MLDv2 state reached, not MLDv2 mode",
2195 NET_EPOCH_ENTER(et);
2196 mld_v1_transmit_report(inm, MLD_LISTENER_DONE);
2198 inm->in6m_state = MLD_NOT_MEMBER;
2199 V_current_state_timers_running6 = 1;
2200 } else if (mli->mli_version == MLD_VERSION_2) {
2202 * Stop group timer and all pending reports.
2203 * Immediately enqueue a state-change report
2204 * TO_IN {} to be sent on the next fast timeout,
2205 * giving us an opportunity to merge reports.
2207 mbufq_drain(&inm->in6m_scq);
2208 inm->in6m_timer = 0;
2209 inm->in6m_scrv = mli->mli_rv;
2210 CTR4(KTR_MLD, "%s: Leaving %s/%s with %d "
2211 "pending retransmissions.", __func__,
2212 ip6_sprintf(ip6tbuf, &inm->in6m_addr),
2213 if_name(inm->in6m_ifp), inm->in6m_scrv);
2214 if (inm->in6m_scrv == 0) {
2215 inm->in6m_state = MLD_NOT_MEMBER;
2216 inm->in6m_sctimer = 0;
2218 int retval __diagused;
2220 in6m_acquire_locked(inm);
2222 retval = mld_v2_enqueue_group_record(
2223 &inm->in6m_scq, inm, 1, 0, 0,
2224 (mli->mli_flags & MLIF_USEALLOW));
2225 KASSERT(retval != 0,
2226 ("%s: enqueue record = %d", __func__,
2229 inm->in6m_state = MLD_LEAVING_MEMBER;
2230 inm->in6m_sctimer = 1;
2231 V_state_change_timers_running6 = 1;
2236 case MLD_LAZY_MEMBER:
2237 case MLD_SLEEPING_MEMBER:
2238 case MLD_AWAKENING_MEMBER:
2239 /* Our reports are suppressed; do nothing. */
2244 CTR3(KTR_MLD, "%s: T1 -> T0 for %s/%s", __func__,
2245 ip6_sprintf(ip6tbuf, &inm->in6m_addr),
2246 if_name(inm->in6m_ifp));
2247 inm->in6m_st[1].iss_fmode = MCAST_UNDEFINED;
2248 CTR3(KTR_MLD, "%s: T1 now MCAST_UNDEFINED for %p/%s",
2249 __func__, &inm->in6m_addr, if_name(inm->in6m_ifp));
2253 * Enqueue an MLDv2 group record to the given output queue.
2255 * If is_state_change is zero, a current-state record is appended.
2256 * If is_state_change is non-zero, a state-change report is appended.
2258 * If is_group_query is non-zero, an mbuf packet chain is allocated.
2259 * If is_group_query is zero, and if there is a packet with free space
2260 * at the tail of the queue, it will be appended to providing there
2261 * is enough free space.
2262 * Otherwise a new mbuf packet chain is allocated.
2264 * If is_source_query is non-zero, each source is checked to see if
2265 * it was recorded for a Group-Source query, and will be omitted if
2266 * it is not both in-mode and recorded.
2268 * If use_block_allow is non-zero, state change reports for initial join
2269 * and final leave, on an inclusive mode group with a source list, will be
2270 * rewritten to use the ALLOW_NEW and BLOCK_OLD record types, respectively.
2272 * The function will attempt to allocate leading space in the packet
2273 * for the IPv6+ICMP headers to be prepended without fragmenting the chain.
2275 * If successful the size of all data appended to the queue is returned,
2276 * otherwise an error code less than zero is returned, or zero if
2277 * no record(s) were appended.
2280 mld_v2_enqueue_group_record(struct mbufq *mq, struct in6_multi *inm,
2281 const int is_state_change, const int is_group_query,
2282 const int is_source_query, const int use_block_allow)
2284 struct mldv2_record mr;
2285 struct mldv2_record *pmr;
2287 struct ip6_msource *ims, *nims;
2288 struct mbuf *m0, *m, *md;
2289 int is_filter_list_change;
2290 int minrec0len, m0srcs, msrcs, nbytes, off;
2291 int record_has_sources;
2296 char ip6tbuf[INET6_ADDRSTRLEN];
2299 IN6_MULTI_LIST_LOCK_ASSERT();
2301 ifp = inm->in6m_ifp;
2302 is_filter_list_change = 0;
2309 record_has_sources = 1;
2311 type = MLD_DO_NOTHING;
2312 mode = inm->in6m_st[1].iss_fmode;
2315 * If we did not transition out of ASM mode during t0->t1,
2316 * and there are no source nodes to process, we can skip
2317 * the generation of source records.
2319 if (inm->in6m_st[0].iss_asm > 0 && inm->in6m_st[1].iss_asm > 0 &&
2320 inm->in6m_nsrc == 0)
2321 record_has_sources = 0;
2323 if (is_state_change) {
2325 * Queue a state change record.
2326 * If the mode did not change, and there are non-ASM
2327 * listeners or source filters present,
2328 * we potentially need to issue two records for the group.
2329 * If there are ASM listeners, and there was no filter
2330 * mode transition of any kind, do nothing.
2332 * If we are transitioning to MCAST_UNDEFINED, we need
2333 * not send any sources. A transition to/from this state is
2334 * considered inclusive with some special treatment.
2336 * If we are rewriting initial joins/leaves to use
2337 * ALLOW/BLOCK, and the group's membership is inclusive,
2338 * we need to send sources in all cases.
2340 if (mode != inm->in6m_st[0].iss_fmode) {
2341 if (mode == MCAST_EXCLUDE) {
2342 CTR1(KTR_MLD, "%s: change to EXCLUDE",
2344 type = MLD_CHANGE_TO_EXCLUDE_MODE;
2346 CTR1(KTR_MLD, "%s: change to INCLUDE",
2348 if (use_block_allow) {
2351 * Here we're interested in state
2352 * edges either direction between
2353 * MCAST_UNDEFINED and MCAST_INCLUDE.
2354 * Perhaps we should just check
2355 * the group state, rather than
2358 if (mode == MCAST_UNDEFINED) {
2359 type = MLD_BLOCK_OLD_SOURCES;
2361 type = MLD_ALLOW_NEW_SOURCES;
2364 type = MLD_CHANGE_TO_INCLUDE_MODE;
2365 if (mode == MCAST_UNDEFINED)
2366 record_has_sources = 0;
2370 if (record_has_sources) {
2371 is_filter_list_change = 1;
2373 type = MLD_DO_NOTHING;
2378 * Queue a current state record.
2380 if (mode == MCAST_EXCLUDE) {
2381 type = MLD_MODE_IS_EXCLUDE;
2382 } else if (mode == MCAST_INCLUDE) {
2383 type = MLD_MODE_IS_INCLUDE;
2384 KASSERT(inm->in6m_st[1].iss_asm == 0,
2385 ("%s: inm %p is INCLUDE but ASM count is %d",
2386 __func__, inm, inm->in6m_st[1].iss_asm));
2391 * Generate the filter list changes using a separate function.
2393 if (is_filter_list_change)
2394 return (mld_v2_enqueue_filter_change(mq, inm));
2396 if (type == MLD_DO_NOTHING) {
2397 CTR3(KTR_MLD, "%s: nothing to do for %s/%s",
2398 __func__, ip6_sprintf(ip6tbuf, &inm->in6m_addr),
2399 if_name(inm->in6m_ifp));
2404 * If any sources are present, we must be able to fit at least
2405 * one in the trailing space of the tail packet's mbuf,
2408 minrec0len = sizeof(struct mldv2_record);
2409 if (record_has_sources)
2410 minrec0len += sizeof(struct in6_addr);
2412 CTR4(KTR_MLD, "%s: queueing %s for %s/%s", __func__,
2413 mld_rec_type_to_str(type),
2414 ip6_sprintf(ip6tbuf, &inm->in6m_addr),
2415 if_name(inm->in6m_ifp));
2418 * Check if we have a packet in the tail of the queue for this
2419 * group into which the first group record for this group will fit.
2420 * Otherwise allocate a new packet.
2421 * Always allocate leading space for IP6+RA+ICMPV6+REPORT.
2422 * Note: Group records for G/GSR query responses MUST be sent
2423 * in their own packet.
2425 m0 = mbufq_last(mq);
2426 if (!is_group_query &&
2428 (m0->m_pkthdr.vt_nrecs + 1 <= MLD_V2_REPORT_MAXRECS) &&
2429 (m0->m_pkthdr.len + minrec0len) <
2430 (ifp->if_mtu - MLD_MTUSPACE)) {
2431 m0srcs = (ifp->if_mtu - m0->m_pkthdr.len -
2432 sizeof(struct mldv2_record)) /
2433 sizeof(struct in6_addr);
2435 CTR1(KTR_MLD, "%s: use existing packet", __func__);
2437 if (mbufq_full(mq)) {
2438 CTR1(KTR_MLD, "%s: outbound queue full", __func__);
2442 m0srcs = (ifp->if_mtu - MLD_MTUSPACE -
2443 sizeof(struct mldv2_record)) / sizeof(struct in6_addr);
2444 if (!is_state_change && !is_group_query)
2445 m = m_getcl(M_NOWAIT, MT_DATA, M_PKTHDR);
2447 m = m_gethdr(M_NOWAIT, MT_DATA);
2451 mld_save_context(m, ifp);
2453 CTR1(KTR_MLD, "%s: allocated first packet", __func__);
2457 * Append group record.
2458 * If we have sources, we don't know how many yet.
2463 mr.mr_addr = inm->in6m_addr;
2464 in6_clearscope(&mr.mr_addr);
2465 if (!m_append(m, sizeof(struct mldv2_record), (void *)&mr)) {
2468 CTR1(KTR_MLD, "%s: m_append() failed.", __func__);
2471 nbytes += sizeof(struct mldv2_record);
2474 * Append as many sources as will fit in the first packet.
2475 * If we are appending to a new packet, the chain allocation
2476 * may potentially use clusters; use m_getptr() in this case.
2477 * If we are appending to an existing packet, we need to obtain
2478 * a pointer to the group record after m_append(), in case a new
2479 * mbuf was allocated.
2481 * Only append sources which are in-mode at t1. If we are
2482 * transitioning to MCAST_UNDEFINED state on the group, and
2483 * use_block_allow is zero, do not include source entries.
2484 * Otherwise, we need to include this source in the report.
2486 * Only report recorded sources in our filter set when responding
2487 * to a group-source query.
2489 if (record_has_sources) {
2492 pmr = (struct mldv2_record *)(mtod(md, uint8_t *) +
2493 md->m_len - nbytes);
2495 md = m_getptr(m, 0, &off);
2496 pmr = (struct mldv2_record *)(mtod(md, uint8_t *) +
2500 RB_FOREACH_SAFE(ims, ip6_msource_tree, &inm->in6m_srcs,
2502 CTR2(KTR_MLD, "%s: visit node %s", __func__,
2503 ip6_sprintf(ip6tbuf, &ims->im6s_addr));
2504 now = im6s_get_mode(inm, ims, 1);
2505 CTR2(KTR_MLD, "%s: node is %d", __func__, now);
2506 if ((now != mode) ||
2508 (!use_block_allow && mode == MCAST_UNDEFINED))) {
2509 CTR1(KTR_MLD, "%s: skip node", __func__);
2512 if (is_source_query && ims->im6s_stp == 0) {
2513 CTR1(KTR_MLD, "%s: skip unrecorded node",
2517 CTR1(KTR_MLD, "%s: append node", __func__);
2518 if (!m_append(m, sizeof(struct in6_addr),
2519 (void *)&ims->im6s_addr)) {
2522 CTR1(KTR_MLD, "%s: m_append() failed.",
2526 nbytes += sizeof(struct in6_addr);
2528 if (msrcs == m0srcs)
2531 CTR2(KTR_MLD, "%s: msrcs is %d this packet", __func__,
2533 pmr->mr_numsrc = htons(msrcs);
2534 nbytes += (msrcs * sizeof(struct in6_addr));
2537 if (is_source_query && msrcs == 0) {
2538 CTR1(KTR_MLD, "%s: no recorded sources to report", __func__);
2545 * We are good to go with first packet.
2548 CTR1(KTR_MLD, "%s: enqueueing first packet", __func__);
2549 m->m_pkthdr.vt_nrecs = 1;
2550 mbufq_enqueue(mq, m);
2552 m->m_pkthdr.vt_nrecs++;
2555 * No further work needed if no source list in packet(s).
2557 if (!record_has_sources)
2561 * Whilst sources remain to be announced, we need to allocate
2562 * a new packet and fill out as many sources as will fit.
2563 * Always try for a cluster first.
2565 while (nims != NULL) {
2566 if (mbufq_full(mq)) {
2567 CTR1(KTR_MLD, "%s: outbound queue full", __func__);
2570 m = m_getcl(M_NOWAIT, MT_DATA, M_PKTHDR);
2572 m = m_gethdr(M_NOWAIT, MT_DATA);
2575 mld_save_context(m, ifp);
2576 md = m_getptr(m, 0, &off);
2577 pmr = (struct mldv2_record *)(mtod(md, uint8_t *) + off);
2578 CTR1(KTR_MLD, "%s: allocated next packet", __func__);
2580 if (!m_append(m, sizeof(struct mldv2_record), (void *)&mr)) {
2583 CTR1(KTR_MLD, "%s: m_append() failed.", __func__);
2586 m->m_pkthdr.vt_nrecs = 1;
2587 nbytes += sizeof(struct mldv2_record);
2589 m0srcs = (ifp->if_mtu - MLD_MTUSPACE -
2590 sizeof(struct mldv2_record)) / sizeof(struct in6_addr);
2593 RB_FOREACH_FROM(ims, ip6_msource_tree, nims) {
2594 CTR2(KTR_MLD, "%s: visit node %s",
2595 __func__, ip6_sprintf(ip6tbuf, &ims->im6s_addr));
2596 now = im6s_get_mode(inm, ims, 1);
2597 if ((now != mode) ||
2599 (!use_block_allow && mode == MCAST_UNDEFINED))) {
2600 CTR1(KTR_MLD, "%s: skip node", __func__);
2603 if (is_source_query && ims->im6s_stp == 0) {
2604 CTR1(KTR_MLD, "%s: skip unrecorded node",
2608 CTR1(KTR_MLD, "%s: append node", __func__);
2609 if (!m_append(m, sizeof(struct in6_addr),
2610 (void *)&ims->im6s_addr)) {
2613 CTR1(KTR_MLD, "%s: m_append() failed.",
2618 if (msrcs == m0srcs)
2621 pmr->mr_numsrc = htons(msrcs);
2622 nbytes += (msrcs * sizeof(struct in6_addr));
2624 CTR1(KTR_MLD, "%s: enqueueing next packet", __func__);
2625 mbufq_enqueue(mq, m);
2632 * Type used to mark record pass completion.
2633 * We exploit the fact we can cast to this easily from the
2634 * current filter modes on each ip_msource node.
2637 REC_NONE = 0x00, /* MCAST_UNDEFINED */
2638 REC_ALLOW = 0x01, /* MCAST_INCLUDE */
2639 REC_BLOCK = 0x02, /* MCAST_EXCLUDE */
2640 REC_FULL = REC_ALLOW | REC_BLOCK
2644 * Enqueue an MLDv2 filter list change to the given output queue.
2646 * Source list filter state is held in an RB-tree. When the filter list
2647 * for a group is changed without changing its mode, we need to compute
2648 * the deltas between T0 and T1 for each source in the filter set,
2649 * and enqueue the appropriate ALLOW_NEW/BLOCK_OLD records.
2651 * As we may potentially queue two record types, and the entire R-B tree
2652 * needs to be walked at once, we break this out into its own function
2653 * so we can generate a tightly packed queue of packets.
2655 * XXX This could be written to only use one tree walk, although that makes
2656 * serializing into the mbuf chains a bit harder. For now we do two walks
2657 * which makes things easier on us, and it may or may not be harder on
2660 * If successful the size of all data appended to the queue is returned,
2661 * otherwise an error code less than zero is returned, or zero if
2662 * no record(s) were appended.
2665 mld_v2_enqueue_filter_change(struct mbufq *mq, struct in6_multi *inm)
2667 static const int MINRECLEN =
2668 sizeof(struct mldv2_record) + sizeof(struct in6_addr);
2670 struct mldv2_record mr;
2671 struct mldv2_record *pmr;
2672 struct ip6_msource *ims, *nims;
2673 struct mbuf *m, *m0, *md;
2674 int m0srcs, nbytes, npbytes, off, rsrcs, schanged;
2675 uint8_t mode, now, then;
2676 rectype_t crt, drt, nrt;
2679 char ip6tbuf[INET6_ADDRSTRLEN];
2682 IN6_MULTI_LIST_LOCK_ASSERT();
2684 if (inm->in6m_nsrc == 0 ||
2685 (inm->in6m_st[0].iss_asm > 0 && inm->in6m_st[1].iss_asm > 0))
2688 ifp = inm->in6m_ifp; /* interface */
2689 mode = inm->in6m_st[1].iss_fmode; /* filter mode at t1 */
2690 crt = REC_NONE; /* current group record type */
2691 drt = REC_NONE; /* mask of completed group record types */
2692 nrt = REC_NONE; /* record type for current node */
2693 m0srcs = 0; /* # source which will fit in current mbuf chain */
2694 npbytes = 0; /* # of bytes appended this packet */
2695 nbytes = 0; /* # of bytes appended to group's state-change queue */
2696 rsrcs = 0; /* # sources encoded in current record */
2697 schanged = 0; /* # nodes encoded in overall filter change */
2699 nallow = 0; /* # of source entries in ALLOW_NEW */
2700 nblock = 0; /* # of source entries in BLOCK_OLD */
2702 nims = NULL; /* next tree node pointer */
2705 * For each possible filter record mode.
2706 * The first kind of source we encounter tells us which
2707 * is the first kind of record we start appending.
2708 * If a node transitioned to UNDEFINED at t1, its mode is treated
2709 * as the inverse of the group's filter mode.
2711 while (drt != REC_FULL) {
2713 m0 = mbufq_last(mq);
2715 (m0->m_pkthdr.vt_nrecs + 1 <=
2716 MLD_V2_REPORT_MAXRECS) &&
2717 (m0->m_pkthdr.len + MINRECLEN) <
2718 (ifp->if_mtu - MLD_MTUSPACE)) {
2720 m0srcs = (ifp->if_mtu - m0->m_pkthdr.len -
2721 sizeof(struct mldv2_record)) /
2722 sizeof(struct in6_addr);
2724 "%s: use previous packet", __func__);
2726 m = m_getcl(M_NOWAIT, MT_DATA, M_PKTHDR);
2728 m = m_gethdr(M_NOWAIT, MT_DATA);
2731 "%s: m_get*() failed", __func__);
2734 m->m_pkthdr.vt_nrecs = 0;
2735 mld_save_context(m, ifp);
2736 m0srcs = (ifp->if_mtu - MLD_MTUSPACE -
2737 sizeof(struct mldv2_record)) /
2738 sizeof(struct in6_addr);
2741 "%s: allocated new packet", __func__);
2744 * Append the MLD group record header to the
2745 * current packet's data area.
2746 * Recalculate pointer to free space for next
2747 * group record, in case m_append() allocated
2748 * a new mbuf or cluster.
2750 memset(&mr, 0, sizeof(mr));
2751 mr.mr_addr = inm->in6m_addr;
2752 in6_clearscope(&mr.mr_addr);
2753 if (!m_append(m, sizeof(mr), (void *)&mr)) {
2757 "%s: m_append() failed", __func__);
2760 npbytes += sizeof(struct mldv2_record);
2762 /* new packet; offset in chain */
2763 md = m_getptr(m, npbytes -
2764 sizeof(struct mldv2_record), &off);
2765 pmr = (struct mldv2_record *)(mtod(md,
2768 /* current packet; offset from last append */
2770 pmr = (struct mldv2_record *)(mtod(md,
2771 uint8_t *) + md->m_len -
2772 sizeof(struct mldv2_record));
2775 * Begin walking the tree for this record type
2776 * pass, or continue from where we left off
2777 * previously if we had to allocate a new packet.
2778 * Only report deltas in-mode at t1.
2779 * We need not report included sources as allowed
2780 * if we are in inclusive mode on the group,
2781 * however the converse is not true.
2785 nims = RB_MIN(ip6_msource_tree,
2788 RB_FOREACH_FROM(ims, ip6_msource_tree, nims) {
2789 CTR2(KTR_MLD, "%s: visit node %s", __func__,
2790 ip6_sprintf(ip6tbuf, &ims->im6s_addr));
2791 now = im6s_get_mode(inm, ims, 1);
2792 then = im6s_get_mode(inm, ims, 0);
2793 CTR3(KTR_MLD, "%s: mode: t0 %d, t1 %d",
2794 __func__, then, now);
2797 "%s: skip unchanged", __func__);
2800 if (mode == MCAST_EXCLUDE &&
2801 now == MCAST_INCLUDE) {
2803 "%s: skip IN src on EX group",
2807 nrt = (rectype_t)now;
2808 if (nrt == REC_NONE)
2809 nrt = (rectype_t)(~mode & REC_FULL);
2810 if (schanged++ == 0) {
2812 } else if (crt != nrt)
2814 if (!m_append(m, sizeof(struct in6_addr),
2815 (void *)&ims->im6s_addr)) {
2819 "%s: m_append() failed", __func__);
2823 nallow += !!(crt == REC_ALLOW);
2824 nblock += !!(crt == REC_BLOCK);
2826 if (++rsrcs == m0srcs)
2830 * If we did not append any tree nodes on this
2831 * pass, back out of allocations.
2834 npbytes -= sizeof(struct mldv2_record);
2837 "%s: m_free(m)", __func__);
2841 "%s: m_adj(m, -mr)", __func__);
2842 m_adj(m, -((int)sizeof(
2843 struct mldv2_record)));
2847 npbytes += (rsrcs * sizeof(struct in6_addr));
2848 if (crt == REC_ALLOW)
2849 pmr->mr_type = MLD_ALLOW_NEW_SOURCES;
2850 else if (crt == REC_BLOCK)
2851 pmr->mr_type = MLD_BLOCK_OLD_SOURCES;
2852 pmr->mr_numsrc = htons(rsrcs);
2854 * Count the new group record, and enqueue this
2855 * packet if it wasn't already queued.
2857 m->m_pkthdr.vt_nrecs++;
2859 mbufq_enqueue(mq, m);
2861 } while (nims != NULL);
2863 crt = (~crt & REC_FULL);
2866 CTR3(KTR_MLD, "%s: queued %d ALLOW_NEW, %d BLOCK_OLD", __func__,
2873 mld_v2_merge_state_changes(struct in6_multi *inm, struct mbufq *scq)
2876 struct mbuf *m; /* pending state-change */
2877 struct mbuf *m0; /* copy of pending state-change */
2878 struct mbuf *mt; /* last state-change in packet */
2879 int docopy, domerge;
2886 IN6_MULTI_LIST_LOCK_ASSERT();
2890 * If there are further pending retransmissions, make a writable
2891 * copy of each queued state-change message before merging.
2893 if (inm->in6m_scrv > 0)
2896 gq = &inm->in6m_scq;
2898 if (mbufq_first(gq) == NULL) {
2899 CTR2(KTR_MLD, "%s: WARNING: queue for inm %p is empty",
2904 m = mbufq_first(gq);
2907 * Only merge the report into the current packet if
2908 * there is sufficient space to do so; an MLDv2 report
2909 * packet may only contain 65,535 group records.
2910 * Always use a simple mbuf chain concatentation to do this,
2911 * as large state changes for single groups may have
2912 * allocated clusters.
2915 mt = mbufq_last(scq);
2917 recslen = m_length(m, NULL);
2919 if ((mt->m_pkthdr.vt_nrecs +
2920 m->m_pkthdr.vt_nrecs <=
2921 MLD_V2_REPORT_MAXRECS) &&
2922 (mt->m_pkthdr.len + recslen <=
2923 (inm->in6m_ifp->if_mtu - MLD_MTUSPACE)))
2927 if (!domerge && mbufq_full(gq)) {
2929 "%s: outbound queue full, skipping whole packet %p",
2939 CTR2(KTR_MLD, "%s: dequeueing %p", __func__, m);
2940 m0 = mbufq_dequeue(gq);
2943 CTR2(KTR_MLD, "%s: copying %p", __func__, m);
2944 m0 = m_dup(m, M_NOWAIT);
2947 m0->m_nextpkt = NULL;
2952 CTR3(KTR_MLD, "%s: queueing %p to scq %p)",
2954 mbufq_enqueue(scq, m0);
2956 struct mbuf *mtl; /* last mbuf of packet mt */
2958 CTR3(KTR_MLD, "%s: merging %p with ifscq tail %p)",
2962 m0->m_flags &= ~M_PKTHDR;
2963 mt->m_pkthdr.len += recslen;
2964 mt->m_pkthdr.vt_nrecs +=
2965 m0->m_pkthdr.vt_nrecs;
2975 * Respond to a pending MLDv2 General Query.
2978 mld_v2_dispatch_general_query(struct mld_ifsoftc *mli)
2980 struct ifmultiaddr *ifma;
2982 struct in6_multi *inm;
2983 int retval __unused;
2986 IN6_MULTI_LIST_LOCK_ASSERT();
2989 KASSERT(mli->mli_version == MLD_VERSION_2,
2990 ("%s: called when version %d", __func__, mli->mli_version));
2993 * Check that there are some packets queued. If so, send them first.
2994 * For large number of groups the reply to general query can take
2995 * many packets, we should finish sending them before starting of
2996 * queuing the new reply.
2998 if (mbufq_len(&mli->mli_gq) != 0)
3003 CK_STAILQ_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link) {
3004 inm = in6m_ifmultiaddr_get_inm(ifma);
3007 KASSERT(ifp == inm->in6m_ifp,
3008 ("%s: inconsistent ifp", __func__));
3010 switch (inm->in6m_state) {
3011 case MLD_NOT_MEMBER:
3012 case MLD_SILENT_MEMBER:
3014 case MLD_REPORTING_MEMBER:
3015 case MLD_IDLE_MEMBER:
3016 case MLD_LAZY_MEMBER:
3017 case MLD_SLEEPING_MEMBER:
3018 case MLD_AWAKENING_MEMBER:
3019 inm->in6m_state = MLD_REPORTING_MEMBER;
3020 retval = mld_v2_enqueue_group_record(&mli->mli_gq,
3022 CTR2(KTR_MLD, "%s: enqueue record = %d",
3025 case MLD_G_QUERY_PENDING_MEMBER:
3026 case MLD_SG_QUERY_PENDING_MEMBER:
3027 case MLD_LEAVING_MEMBER:
3033 mld_dispatch_queue(&mli->mli_gq, MLD_MAX_RESPONSE_BURST);
3036 * Slew transmission of bursts over 500ms intervals.
3038 if (mbufq_first(&mli->mli_gq) != NULL) {
3039 mli->mli_v2_timer = 1 + MLD_RANDOM_DELAY(
3040 MLD_RESPONSE_BURST_INTERVAL);
3041 V_interface_timers_running6 = 1;
3046 * Transmit the next pending message in the output queue.
3048 * VIMAGE: Needs to store/restore vnet pointer on a per-mbuf-chain basis.
3049 * MRT: Nothing needs to be done, as MLD traffic is always local to
3050 * a link and uses a link-scope multicast address.
3053 mld_dispatch_packet(struct mbuf *m)
3055 struct ip6_moptions im6o;
3060 struct ip6_hdr *ip6;
3061 struct mld_hdr *mld;
3067 CTR2(KTR_MLD, "%s: transmit %p", __func__, m);
3071 * Set VNET image pointer from enqueued mbuf chain
3072 * before doing anything else. Whilst we use interface
3073 * indexes to guard against interface detach, they are
3074 * unique to each VIMAGE and must be retrieved.
3076 ifindex = mld_restore_context(m);
3079 * Check if the ifnet still exists. This limits the scope of
3080 * any race in the absence of a global ifp lock for low cost
3081 * (an array lookup).
3083 ifp = ifnet_byindex(ifindex);
3085 CTR3(KTR_MLD, "%s: dropped %p as ifindex %u went away.",
3086 __func__, m, ifindex);
3088 IP6STAT_INC(ip6s_noroute);
3092 im6o.im6o_multicast_hlim = 1;
3093 im6o.im6o_multicast_loop = (V_ip6_mrouter != NULL);
3094 im6o.im6o_multicast_ifp = ifp;
3096 if (m->m_flags & M_MLDV1) {
3099 m0 = mld_v2_encap_report(ifp, m);
3101 CTR2(KTR_MLD, "%s: dropped %p", __func__, m);
3102 IP6STAT_INC(ip6s_odropped);
3107 mld_scrub_context(m0);
3109 m0->m_pkthdr.rcvif = V_loif;
3111 ip6 = mtod(m0, struct ip6_hdr *);
3113 (void)in6_setscope(&ip6->ip6_dst, ifp, NULL); /* XXX LOR */
3116 * XXX XXX Break some KPI rules to prevent an LOR which would
3117 * occur if we called in6_setscope() at transmission.
3118 * See comments at top of file.
3120 MLD_EMBEDSCOPE(&ip6->ip6_dst, ifp->if_index);
3124 * Retrieve the ICMPv6 type before handoff to ip6_output(),
3125 * so we can bump the stats.
3127 md = m_getptr(m0, sizeof(struct ip6_hdr), &off);
3128 mld = (struct mld_hdr *)(mtod(md, uint8_t *) + off);
3129 type = mld->mld_type;
3132 error = ip6_output(m0, &mld_po, NULL, IPV6_UNSPECSRC, &im6o,
3135 CTR3(KTR_MLD, "%s: ip6_output(%p) = %d", __func__, m0, error);
3138 ICMP6STAT_INC(icp6s_outhist[type]);
3140 icmp6_ifstat_inc(oifp, ifs6_out_msg);
3142 case MLD_LISTENER_REPORT:
3143 case MLDV2_LISTENER_REPORT:
3144 icmp6_ifstat_inc(oifp, ifs6_out_mldreport);
3146 case MLD_LISTENER_DONE:
3147 icmp6_ifstat_inc(oifp, ifs6_out_mlddone);
3156 * Encapsulate an MLDv2 report.
3158 * KAME IPv6 requires that hop-by-hop options be passed separately,
3159 * and that the IPv6 header be prepended in a separate mbuf.
3161 * Returns a pointer to the new mbuf chain head, or NULL if the
3162 * allocation failed.
3164 static struct mbuf *
3165 mld_v2_encap_report(struct ifnet *ifp, struct mbuf *m)
3168 struct mldv2_report *mld;
3169 struct ip6_hdr *ip6;
3170 struct in6_ifaddr *ia;
3173 KASSERT(ifp != NULL, ("%s: null ifp", __func__));
3174 KASSERT((m->m_flags & M_PKTHDR),
3175 ("%s: mbuf chain %p is !M_PKTHDR", __func__, m));
3178 * RFC3590: OK to send as :: or tentative during DAD.
3181 ia = in6ifa_ifpforlinklocal(ifp, IN6_IFF_NOTREADY|IN6_IFF_ANYCAST);
3183 CTR1(KTR_MLD, "%s: warning: ia is NULL", __func__);
3185 mh = m_gethdr(M_NOWAIT, MT_DATA);
3188 ifa_free(&ia->ia_ifa);
3192 M_ALIGN(mh, sizeof(struct ip6_hdr) + sizeof(struct mldv2_report));
3194 mldreclen = m_length(m, NULL);
3195 CTR2(KTR_MLD, "%s: mldreclen is %d", __func__, mldreclen);
3197 mh->m_len = sizeof(struct ip6_hdr) + sizeof(struct mldv2_report);
3198 mh->m_pkthdr.len = sizeof(struct ip6_hdr) +
3199 sizeof(struct mldv2_report) + mldreclen;
3201 ip6 = mtod(mh, struct ip6_hdr *);
3203 ip6->ip6_vfc &= ~IPV6_VERSION_MASK;
3204 ip6->ip6_vfc |= IPV6_VERSION;
3205 ip6->ip6_nxt = IPPROTO_ICMPV6;
3206 ip6->ip6_src = ia ? ia->ia_addr.sin6_addr : in6addr_any;
3208 ifa_free(&ia->ia_ifa);
3209 ip6->ip6_dst = in6addr_linklocal_allv2routers;
3210 /* scope ID will be set in netisr */
3212 mld = (struct mldv2_report *)(ip6 + 1);
3213 mld->mld_type = MLDV2_LISTENER_REPORT;
3216 mld->mld_v2_reserved = 0;
3217 mld->mld_v2_numrecs = htons(m->m_pkthdr.vt_nrecs);
3218 m->m_pkthdr.vt_nrecs = 0;
3221 mld->mld_cksum = in6_cksum(mh, IPPROTO_ICMPV6,
3222 sizeof(struct ip6_hdr), sizeof(struct mldv2_report) + mldreclen);
3228 mld_rec_type_to_str(const int type)
3232 case MLD_CHANGE_TO_EXCLUDE_MODE:
3235 case MLD_CHANGE_TO_INCLUDE_MODE:
3238 case MLD_MODE_IS_EXCLUDE:
3241 case MLD_MODE_IS_INCLUDE:
3244 case MLD_ALLOW_NEW_SOURCES:
3247 case MLD_BLOCK_OLD_SOURCES:
3258 mld_init(void *unused __unused)
3261 CTR1(KTR_MLD, "%s: initializing", __func__);
3264 ip6_initpktopts(&mld_po);
3265 mld_po.ip6po_hlim = 1;
3266 mld_po.ip6po_hbh = &mld_ra.hbh;
3267 mld_po.ip6po_prefer_tempaddr = IP6PO_TEMPADDR_NOTPREFER;
3268 mld_po.ip6po_flags = IP6PO_DONTFRAG;
3270 callout_init(&mldslow_callout, 1);
3271 callout_reset(&mldslow_callout, hz / MLD_SLOWHZ, mld_slowtimo, NULL);
3272 callout_init(&mldfast_callout, 1);
3273 callout_reset(&mldfast_callout, hz / MLD_FASTHZ, mld_fasttimo, NULL);
3275 SYSINIT(mld_init, SI_SUB_PROTO_MC, SI_ORDER_MIDDLE, mld_init, NULL);
3278 mld_uninit(void *unused __unused)
3281 CTR1(KTR_MLD, "%s: tearing down", __func__);
3282 callout_drain(&mldslow_callout);
3283 callout_drain(&mldfast_callout);
3286 SYSUNINIT(mld_uninit, SI_SUB_PROTO_MC, SI_ORDER_MIDDLE, mld_uninit, NULL);
3289 vnet_mld_init(const void *unused __unused)
3292 CTR1(KTR_MLD, "%s: initializing", __func__);
3294 LIST_INIT(&V_mli_head);
3296 VNET_SYSINIT(vnet_mld_init, SI_SUB_PROTO_MC, SI_ORDER_ANY, vnet_mld_init,
3300 vnet_mld_uninit(const void *unused __unused)
3303 /* This can happen if we shutdown the network stack. */
3304 CTR1(KTR_MLD, "%s: tearing down", __func__);
3306 VNET_SYSUNINIT(vnet_mld_uninit, SI_SUB_PROTO_MC, SI_ORDER_ANY, vnet_mld_uninit,
3310 mld_modevent(module_t mod, int type, void *unused __unused)
3318 return (EOPNOTSUPP);
3323 static moduledata_t mld_mod = {
3328 DECLARE_MODULE(mld, mld_mod, SI_SUB_PROTO_MC, SI_ORDER_ANY);