2 * Copyright (c) 2007-2009 Bruce Simpson.
3 * Copyright (c) 1988 Stephen Deering.
4 * Copyright (c) 1992, 1993
5 * The Regents of the University of California. All rights reserved.
7 * This code is derived from software contributed to Berkeley by
8 * Stephen Deering of Stanford University.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 4. Neither the name of the University nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * @(#)igmp.c 8.1 (Berkeley) 7/19/93
38 * Internet Group Management Protocol (IGMP) routines.
39 * [RFC1112, RFC2236, RFC3376]
41 * Written by Steve Deering, Stanford, May 1988.
42 * Modified by Rosen Sharma, Stanford, Aug 1994.
43 * Modified by Bill Fenner, Xerox PARC, Feb 1995.
44 * Modified to fully comply to IGMPv2 by Bill Fenner, Oct 1995.
45 * Significantly rewritten for IGMPv3, VIMAGE, and SMP by Bruce Simpson.
47 * MULTICAST Revision: 3.5.1.4
50 #include <sys/cdefs.h>
51 __FBSDID("$FreeBSD$");
53 #include <sys/param.h>
54 #include <sys/systm.h>
55 #include <sys/module.h>
56 #include <sys/malloc.h>
58 #include <sys/socket.h>
59 #include <sys/protosw.h>
60 #include <sys/kernel.h>
61 #include <sys/sysctl.h>
63 #include <sys/condvar.h>
66 #include <net/if_var.h>
67 #include <net/netisr.h>
70 #include <netinet/in.h>
71 #include <netinet/in_var.h>
72 #include <netinet/in_systm.h>
73 #include <netinet/ip.h>
74 #include <netinet/ip_var.h>
75 #include <netinet/ip_options.h>
76 #include <netinet/igmp.h>
77 #include <netinet/igmp_var.h>
79 #include <machine/in_cksum.h>
81 #include <security/mac/mac_framework.h>
84 #define KTR_IGMPV3 KTR_INET
87 static struct igmp_ifsoftc *
88 igi_alloc_locked(struct ifnet *);
89 static void igi_delete_locked(const struct ifnet *);
90 static void igmp_dispatch_queue(struct mbufq *, int, const int);
91 static void igmp_fasttimo_vnet(void);
92 static void igmp_final_leave(struct in_multi *, struct igmp_ifsoftc *);
93 static int igmp_handle_state_change(struct in_multi *,
94 struct igmp_ifsoftc *);
95 static int igmp_initial_join(struct in_multi *, struct igmp_ifsoftc *);
96 static int igmp_input_v1_query(struct ifnet *, const struct ip *,
98 static int igmp_input_v2_query(struct ifnet *, const struct ip *,
100 static int igmp_input_v3_query(struct ifnet *, const struct ip *,
101 /*const*/ struct igmpv3 *);
102 static int igmp_input_v3_group_query(struct in_multi *,
103 struct igmp_ifsoftc *, int, /*const*/ struct igmpv3 *);
104 static int igmp_input_v1_report(struct ifnet *, /*const*/ struct ip *,
105 /*const*/ struct igmp *);
106 static int igmp_input_v2_report(struct ifnet *, /*const*/ struct ip *,
107 /*const*/ struct igmp *);
108 static void igmp_intr(struct mbuf *);
109 static int igmp_isgroupreported(const struct in_addr);
113 static char * igmp_rec_type_to_str(const int);
115 static void igmp_set_version(struct igmp_ifsoftc *, const int);
116 static void igmp_slowtimo_vnet(void);
117 static int igmp_v1v2_queue_report(struct in_multi *, const int);
118 static void igmp_v1v2_process_group_timer(struct in_multi *, const int);
119 static void igmp_v1v2_process_querier_timers(struct igmp_ifsoftc *);
120 static void igmp_v2_update_group(struct in_multi *, const int);
121 static void igmp_v3_cancel_link_timers(struct igmp_ifsoftc *);
122 static void igmp_v3_dispatch_general_query(struct igmp_ifsoftc *);
124 igmp_v3_encap_report(struct ifnet *, struct mbuf *);
125 static int igmp_v3_enqueue_group_record(struct mbufq *,
126 struct in_multi *, const int, const int, const int);
127 static int igmp_v3_enqueue_filter_change(struct mbufq *,
129 static void igmp_v3_process_group_timers(struct igmp_ifsoftc *,
130 struct mbufq *, struct mbufq *, struct in_multi *,
132 static int igmp_v3_merge_state_changes(struct in_multi *,
134 static void igmp_v3_suppress_group_record(struct in_multi *);
135 static int sysctl_igmp_default_version(SYSCTL_HANDLER_ARGS);
136 static int sysctl_igmp_gsr(SYSCTL_HANDLER_ARGS);
137 static int sysctl_igmp_ifinfo(SYSCTL_HANDLER_ARGS);
139 static const struct netisr_handler igmp_nh = {
141 .nh_handler = igmp_intr,
142 .nh_proto = NETISR_IGMP,
143 .nh_policy = NETISR_POLICY_SOURCE,
147 * System-wide globals.
149 * Unlocked access to these is OK, except for the global IGMP output
150 * queue. The IGMP subsystem lock ends up being system-wide for the moment,
151 * because all VIMAGEs have to share a global output queue, as netisrs
152 * themselves are not virtualized.
155 * * The permitted lock order is: IN_MULTI_LOCK, IGMP_LOCK, IF_ADDR_LOCK.
156 * Any may be taken independently; if any are held at the same
157 * time, the above lock order must be followed.
158 * * All output is delegated to the netisr.
159 * Now that Giant has been eliminated, the netisr may be inlined.
160 * * IN_MULTI_LOCK covers in_multi.
161 * * IGMP_LOCK covers igmp_ifsoftc and any global variables in this file,
162 * including the output queue.
163 * * IF_ADDR_LOCK covers if_multiaddrs, which is used for a variety of
164 * per-link state iterators.
165 * * igmp_ifsoftc is valid as long as PF_INET is attached to the interface,
166 * therefore it is not refcounted.
167 * We allow unlocked reads of igmp_ifsoftc when accessed via in_multi.
170 * * IGMP acquires its own reference every time an in_multi is passed to
171 * it and the group is being joined for the first time.
172 * * IGMP releases its reference(s) on in_multi in a deferred way,
173 * because the operations which process the release run as part of
174 * a loop whose control variables are directly affected by the release
175 * (that, and not recursing on the IF_ADDR_LOCK).
177 * VIMAGE: Each in_multi corresponds to an ifp, and each ifp corresponds
178 * to a vnet in ifp->if_vnet.
180 * SMPng: XXX We may potentially race operations on ifma_protospec.
181 * The problem is that we currently lack a clean way of taking the
182 * IF_ADDR_LOCK() between the ifnet and in layers w/o recursing,
183 * as anything which modifies ifma needs to be covered by that lock.
184 * So check for ifma_protospec being NULL before proceeding.
188 struct mbuf *m_raopt; /* Router Alert option */
189 static MALLOC_DEFINE(M_IGMP, "igmp", "igmp state");
192 * VIMAGE-wide globals.
194 * The IGMPv3 timers themselves need to run per-image, however,
195 * protosw timers run globally (see tcp).
196 * An ifnet can only be in one vimage at a time, and the loopback
197 * ifnet, loif, is itself virtualized.
198 * It would otherwise be possible to seriously hose IGMP state,
199 * and create inconsistencies in upstream multicast routing, if you have
200 * multiple VIMAGEs running on the same link joining different multicast
201 * groups, UNLESS the "primary IP address" is different. This is because
202 * IGMP for IPv4 does not force link-local addresses to be used for each
203 * node, unlike MLD for IPv6.
204 * Obviously the IGMPv3 per-interface state has per-vimage granularity
207 * FUTURE: Stop using IFP_TO_IA/INADDR_ANY, and use source address selection
208 * policy to control the address used by IGMP on the link.
210 static VNET_DEFINE(int, interface_timers_running); /* IGMPv3 general
212 static VNET_DEFINE(int, state_change_timers_running); /* IGMPv3 state-change
214 static VNET_DEFINE(int, current_state_timers_running); /* IGMPv1/v2 host
215 * report; IGMPv3 g/sg
218 #define V_interface_timers_running VNET(interface_timers_running)
219 #define V_state_change_timers_running VNET(state_change_timers_running)
220 #define V_current_state_timers_running VNET(current_state_timers_running)
222 static VNET_DEFINE(LIST_HEAD(, igmp_ifsoftc), igi_head);
223 static VNET_DEFINE(struct igmpstat, igmpstat) = {
224 .igps_version = IGPS_VERSION_3,
225 .igps_len = sizeof(struct igmpstat),
227 static VNET_DEFINE(struct timeval, igmp_gsrdelay) = {10, 0};
229 #define V_igi_head VNET(igi_head)
230 #define V_igmpstat VNET(igmpstat)
231 #define V_igmp_gsrdelay VNET(igmp_gsrdelay)
233 static VNET_DEFINE(int, igmp_recvifkludge) = 1;
234 static VNET_DEFINE(int, igmp_sendra) = 1;
235 static VNET_DEFINE(int, igmp_sendlocal) = 1;
236 static VNET_DEFINE(int, igmp_v1enable) = 1;
237 static VNET_DEFINE(int, igmp_v2enable) = 1;
238 static VNET_DEFINE(int, igmp_legacysupp);
239 static VNET_DEFINE(int, igmp_default_version) = IGMP_VERSION_3;
241 #define V_igmp_recvifkludge VNET(igmp_recvifkludge)
242 #define V_igmp_sendra VNET(igmp_sendra)
243 #define V_igmp_sendlocal VNET(igmp_sendlocal)
244 #define V_igmp_v1enable VNET(igmp_v1enable)
245 #define V_igmp_v2enable VNET(igmp_v2enable)
246 #define V_igmp_legacysupp VNET(igmp_legacysupp)
247 #define V_igmp_default_version VNET(igmp_default_version)
250 * Virtualized sysctls.
252 SYSCTL_STRUCT(_net_inet_igmp, IGMPCTL_STATS, stats, CTLFLAG_VNET | CTLFLAG_RW,
253 &VNET_NAME(igmpstat), igmpstat, "");
254 SYSCTL_INT(_net_inet_igmp, OID_AUTO, recvifkludge, CTLFLAG_VNET | CTLFLAG_RW,
255 &VNET_NAME(igmp_recvifkludge), 0,
256 "Rewrite IGMPv1/v2 reports from 0.0.0.0 to contain subnet address");
257 SYSCTL_INT(_net_inet_igmp, OID_AUTO, sendra, CTLFLAG_VNET | CTLFLAG_RW,
258 &VNET_NAME(igmp_sendra), 0,
259 "Send IP Router Alert option in IGMPv2/v3 messages");
260 SYSCTL_INT(_net_inet_igmp, OID_AUTO, sendlocal, CTLFLAG_VNET | CTLFLAG_RW,
261 &VNET_NAME(igmp_sendlocal), 0,
262 "Send IGMP membership reports for 224.0.0.0/24 groups");
263 SYSCTL_INT(_net_inet_igmp, OID_AUTO, v1enable, CTLFLAG_VNET | CTLFLAG_RW,
264 &VNET_NAME(igmp_v1enable), 0,
265 "Enable backwards compatibility with IGMPv1");
266 SYSCTL_INT(_net_inet_igmp, OID_AUTO, v2enable, CTLFLAG_VNET | CTLFLAG_RW,
267 &VNET_NAME(igmp_v2enable), 0,
268 "Enable backwards compatibility with IGMPv2");
269 SYSCTL_INT(_net_inet_igmp, OID_AUTO, legacysupp, CTLFLAG_VNET | CTLFLAG_RW,
270 &VNET_NAME(igmp_legacysupp), 0,
271 "Allow v1/v2 reports to suppress v3 group responses");
272 SYSCTL_PROC(_net_inet_igmp, OID_AUTO, default_version,
273 CTLFLAG_VNET | CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_MPSAFE,
274 &VNET_NAME(igmp_default_version), 0, sysctl_igmp_default_version, "I",
275 "Default version of IGMP to run on each interface");
276 SYSCTL_PROC(_net_inet_igmp, OID_AUTO, gsrdelay,
277 CTLFLAG_VNET | CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_MPSAFE,
278 &VNET_NAME(igmp_gsrdelay.tv_sec), 0, sysctl_igmp_gsr, "I",
279 "Rate limit for IGMPv3 Group-and-Source queries in seconds");
282 * Non-virtualized sysctls.
284 static SYSCTL_NODE(_net_inet_igmp, OID_AUTO, ifinfo,
285 CTLFLAG_RD | CTLFLAG_MPSAFE, sysctl_igmp_ifinfo,
286 "Per-interface IGMPv3 state");
289 igmp_save_context(struct mbuf *m, struct ifnet *ifp)
293 m->m_pkthdr.PH_loc.ptr = ifp->if_vnet;
295 m->m_pkthdr.flowid = ifp->if_index;
299 igmp_scrub_context(struct mbuf *m)
302 m->m_pkthdr.PH_loc.ptr = NULL;
303 m->m_pkthdr.flowid = 0;
307 static __inline char *
308 inet_ntoa_haddr(in_addr_t haddr)
312 ia.s_addr = htonl(haddr);
313 return (inet_ntoa(ia));
318 * Restore context from a queued IGMP output chain.
319 * Return saved ifindex.
321 * VIMAGE: The assertion is there to make sure that we
322 * actually called CURVNET_SET() with what's in the mbuf chain.
324 static __inline uint32_t
325 igmp_restore_context(struct mbuf *m)
329 #if defined(VIMAGE) && defined(INVARIANTS)
330 KASSERT(curvnet == (m->m_pkthdr.PH_loc.ptr),
331 ("%s: called when curvnet was not restored", __func__));
334 return (m->m_pkthdr.flowid);
338 * Retrieve or set default IGMP version.
340 * VIMAGE: Assume curvnet set by caller.
341 * SMPng: NOTE: Serialized by IGMP lock.
344 sysctl_igmp_default_version(SYSCTL_HANDLER_ARGS)
349 error = sysctl_wire_old_buffer(req, sizeof(int));
355 new = V_igmp_default_version;
357 error = sysctl_handle_int(oidp, &new, 0, req);
358 if (error || !req->newptr)
361 if (new < IGMP_VERSION_1 || new > IGMP_VERSION_3) {
366 CTR2(KTR_IGMPV3, "change igmp_default_version from %d to %d",
367 V_igmp_default_version, new);
369 V_igmp_default_version = new;
377 * Retrieve or set threshold between group-source queries in seconds.
379 * VIMAGE: Assume curvnet set by caller.
380 * SMPng: NOTE: Serialized by IGMP lock.
383 sysctl_igmp_gsr(SYSCTL_HANDLER_ARGS)
388 error = sysctl_wire_old_buffer(req, sizeof(int));
394 i = V_igmp_gsrdelay.tv_sec;
396 error = sysctl_handle_int(oidp, &i, 0, req);
397 if (error || !req->newptr)
400 if (i < -1 || i >= 60) {
405 CTR2(KTR_IGMPV3, "change igmp_gsrdelay from %d to %d",
406 V_igmp_gsrdelay.tv_sec, i);
407 V_igmp_gsrdelay.tv_sec = i;
415 * Expose struct igmp_ifsoftc to userland, keyed by ifindex.
416 * For use by ifmcstat(8).
418 * SMPng: NOTE: Does an unlocked ifindex space read.
419 * VIMAGE: Assume curvnet set by caller. The node handler itself
420 * is not directly virtualized.
423 sysctl_igmp_ifinfo(SYSCTL_HANDLER_ARGS)
429 struct igmp_ifsoftc *igi;
434 if (req->newptr != NULL)
440 error = sysctl_wire_old_buffer(req, sizeof(struct igmp_ifinfo));
447 if (name[0] <= 0 || name[0] > V_if_index) {
454 ifp = ifnet_byindex(name[0]);
458 LIST_FOREACH(igi, &V_igi_head, igi_link) {
459 if (ifp == igi->igi_ifp) {
460 struct igmp_ifinfo info;
462 info.igi_version = igi->igi_version;
463 info.igi_v1_timer = igi->igi_v1_timer;
464 info.igi_v2_timer = igi->igi_v2_timer;
465 info.igi_v3_timer = igi->igi_v3_timer;
466 info.igi_flags = igi->igi_flags;
467 info.igi_rv = igi->igi_rv;
468 info.igi_qi = igi->igi_qi;
469 info.igi_qri = igi->igi_qri;
470 info.igi_uri = igi->igi_uri;
471 error = SYSCTL_OUT(req, &info, sizeof(info));
483 * Dispatch an entire queue of pending packet chains
485 * VIMAGE: Assumes the vnet pointer has been set.
488 igmp_dispatch_queue(struct mbufq *mq, int limit, const int loop)
492 while ((m = mbufq_dequeue(mq)) != NULL) {
493 CTR3(KTR_IGMPV3, "%s: dispatch %p from %p", __func__, mq, m);
495 m->m_flags |= M_IGMP_LOOP;
496 netisr_dispatch(NETISR_IGMP, m);
503 * Filter outgoing IGMP report state by group.
505 * Reports are ALWAYS suppressed for ALL-HOSTS (224.0.0.1).
506 * If the net.inet.igmp.sendlocal sysctl is 0, then IGMP reports are
507 * disabled for all groups in the 224.0.0.0/24 link-local scope. However,
508 * this may break certain IGMP snooping switches which rely on the old
511 * Return zero if the given group is one for which IGMP reports
512 * should be suppressed, or non-zero if reports should be issued.
515 igmp_isgroupreported(const struct in_addr addr)
518 if (in_allhosts(addr) ||
519 ((!V_igmp_sendlocal && IN_LOCAL_GROUP(ntohl(addr.s_addr)))))
526 * Construct a Router Alert option to use in outgoing packets.
534 m = m_get(M_WAITOK, MT_DATA);
535 p = mtod(m, struct ipoption *);
536 p->ipopt_dst.s_addr = INADDR_ANY;
537 p->ipopt_list[0] = IPOPT_RA; /* Router Alert Option */
538 p->ipopt_list[1] = 0x04; /* 4 bytes long */
539 p->ipopt_list[2] = IPOPT_EOL; /* End of IP option list */
540 p->ipopt_list[3] = 0x00; /* pad byte */
541 m->m_len = sizeof(p->ipopt_dst) + p->ipopt_list[1];
547 * Attach IGMP when PF_INET is attached to an interface.
549 struct igmp_ifsoftc *
550 igmp_domifattach(struct ifnet *ifp)
552 struct igmp_ifsoftc *igi;
554 CTR3(KTR_IGMPV3, "%s: called for ifp %p(%s)",
555 __func__, ifp, ifp->if_xname);
559 igi = igi_alloc_locked(ifp);
560 if (!(ifp->if_flags & IFF_MULTICAST))
561 igi->igi_flags |= IGIF_SILENT;
569 * VIMAGE: assume curvnet set by caller.
571 static struct igmp_ifsoftc *
572 igi_alloc_locked(/*const*/ struct ifnet *ifp)
574 struct igmp_ifsoftc *igi;
578 igi = malloc(sizeof(struct igmp_ifsoftc), M_IGMP, M_NOWAIT|M_ZERO);
583 igi->igi_version = V_igmp_default_version;
585 igi->igi_rv = IGMP_RV_INIT;
586 igi->igi_qi = IGMP_QI_INIT;
587 igi->igi_qri = IGMP_QRI_INIT;
588 igi->igi_uri = IGMP_URI_INIT;
589 SLIST_INIT(&igi->igi_relinmhead);
590 mbufq_init(&igi->igi_gq, IGMP_MAX_RESPONSE_PACKETS);
592 LIST_INSERT_HEAD(&V_igi_head, igi, igi_link);
594 CTR2(KTR_IGMPV3, "allocate igmp_ifsoftc for ifp %p(%s)",
604 * NOTE: Some finalization tasks need to run before the protocol domain
605 * is detached, but also before the link layer does its cleanup.
607 * SMPNG: igmp_ifdetach() needs to take IF_ADDR_LOCK().
608 * XXX This is also bitten by unlocked ifma_protospec access.
611 igmp_ifdetach(struct ifnet *ifp)
613 struct igmp_ifsoftc *igi;
614 struct ifmultiaddr *ifma;
615 struct in_multi *inm, *tinm;
617 CTR3(KTR_IGMPV3, "%s: called for ifp %p(%s)", __func__, ifp,
622 igi = ((struct in_ifinfo *)ifp->if_afdata[AF_INET])->ii_igmp;
623 if (igi->igi_version == IGMP_VERSION_3) {
625 TAILQ_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link) {
626 if (ifma->ifma_addr->sa_family != AF_INET ||
627 ifma->ifma_protospec == NULL)
630 KASSERT(ifma->ifma_protospec != NULL,
631 ("%s: ifma_protospec is NULL", __func__));
633 inm = (struct in_multi *)ifma->ifma_protospec;
634 if (inm->inm_state == IGMP_LEAVING_MEMBER) {
635 SLIST_INSERT_HEAD(&igi->igi_relinmhead,
638 inm_clear_recorded(inm);
640 IF_ADDR_RUNLOCK(ifp);
642 * Free the in_multi reference(s) for this IGMP lifecycle.
644 SLIST_FOREACH_SAFE(inm, &igi->igi_relinmhead, inm_nrele,
646 SLIST_REMOVE_HEAD(&igi->igi_relinmhead, inm_nrele);
647 inm_release_locked(inm);
655 * Hook for domifdetach.
658 igmp_domifdetach(struct ifnet *ifp)
660 struct igmp_ifsoftc *igi;
662 CTR3(KTR_IGMPV3, "%s: called for ifp %p(%s)",
663 __func__, ifp, ifp->if_xname);
667 igi = ((struct in_ifinfo *)ifp->if_afdata[AF_INET])->ii_igmp;
668 igi_delete_locked(ifp);
674 igi_delete_locked(const struct ifnet *ifp)
676 struct igmp_ifsoftc *igi, *tigi;
678 CTR3(KTR_IGMPV3, "%s: freeing igmp_ifsoftc for ifp %p(%s)",
679 __func__, ifp, ifp->if_xname);
683 LIST_FOREACH_SAFE(igi, &V_igi_head, igi_link, tigi) {
684 if (igi->igi_ifp == ifp) {
686 * Free deferred General Query responses.
688 mbufq_drain(&igi->igi_gq);
690 LIST_REMOVE(igi, igi_link);
692 KASSERT(SLIST_EMPTY(&igi->igi_relinmhead),
693 ("%s: there are dangling in_multi references",
702 panic("%s: igmp_ifsoftc not found for ifp %p\n", __func__, ifp);
707 * Process a received IGMPv1 query.
708 * Return non-zero if the message should be dropped.
710 * VIMAGE: The curvnet pointer is derived from the input ifp.
713 igmp_input_v1_query(struct ifnet *ifp, const struct ip *ip,
714 const struct igmp *igmp)
716 struct ifmultiaddr *ifma;
717 struct igmp_ifsoftc *igi;
718 struct in_multi *inm;
721 * IGMPv1 Host Mmembership Queries SHOULD always be addressed to
722 * 224.0.0.1. They are always treated as General Queries.
723 * igmp_group is always ignored. Do not drop it as a userland
724 * daemon may wish to see it.
725 * XXX SMPng: unlocked increments in igmpstat assumed atomic.
727 if (!in_allhosts(ip->ip_dst) || !in_nullhost(igmp->igmp_group)) {
728 IGMPSTAT_INC(igps_rcv_badqueries);
731 IGMPSTAT_INC(igps_rcv_gen_queries);
736 igi = ((struct in_ifinfo *)ifp->if_afdata[AF_INET])->ii_igmp;
737 KASSERT(igi != NULL, ("%s: no igmp_ifsoftc for ifp %p", __func__, ifp));
739 if (igi->igi_flags & IGIF_LOOPBACK) {
740 CTR2(KTR_IGMPV3, "ignore v1 query on IGIF_LOOPBACK ifp %p(%s)",
746 * Switch to IGMPv1 host compatibility mode.
748 igmp_set_version(igi, IGMP_VERSION_1);
750 CTR2(KTR_IGMPV3, "process v1 query on ifp %p(%s)", ifp, ifp->if_xname);
753 * Start the timers in all of our group records
754 * for the interface on which the query arrived,
755 * except those which are already running.
758 TAILQ_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link) {
759 if (ifma->ifma_addr->sa_family != AF_INET ||
760 ifma->ifma_protospec == NULL)
762 inm = (struct in_multi *)ifma->ifma_protospec;
763 if (inm->inm_timer != 0)
765 switch (inm->inm_state) {
766 case IGMP_NOT_MEMBER:
767 case IGMP_SILENT_MEMBER:
769 case IGMP_G_QUERY_PENDING_MEMBER:
770 case IGMP_SG_QUERY_PENDING_MEMBER:
771 case IGMP_REPORTING_MEMBER:
772 case IGMP_IDLE_MEMBER:
773 case IGMP_LAZY_MEMBER:
774 case IGMP_SLEEPING_MEMBER:
775 case IGMP_AWAKENING_MEMBER:
776 inm->inm_state = IGMP_REPORTING_MEMBER;
777 inm->inm_timer = IGMP_RANDOM_DELAY(
778 IGMP_V1V2_MAX_RI * PR_FASTHZ);
779 V_current_state_timers_running = 1;
781 case IGMP_LEAVING_MEMBER:
785 IF_ADDR_RUNLOCK(ifp);
795 * Process a received IGMPv2 general or group-specific query.
798 igmp_input_v2_query(struct ifnet *ifp, const struct ip *ip,
799 const struct igmp *igmp)
801 struct ifmultiaddr *ifma;
802 struct igmp_ifsoftc *igi;
803 struct in_multi *inm;
804 int is_general_query;
807 is_general_query = 0;
810 * Validate address fields upfront.
811 * XXX SMPng: unlocked increments in igmpstat assumed atomic.
813 if (in_nullhost(igmp->igmp_group)) {
815 * IGMPv2 General Query.
816 * If this was not sent to the all-hosts group, ignore it.
818 if (!in_allhosts(ip->ip_dst))
820 IGMPSTAT_INC(igps_rcv_gen_queries);
821 is_general_query = 1;
823 /* IGMPv2 Group-Specific Query. */
824 IGMPSTAT_INC(igps_rcv_group_queries);
830 igi = ((struct in_ifinfo *)ifp->if_afdata[AF_INET])->ii_igmp;
831 KASSERT(igi != NULL, ("%s: no igmp_ifsoftc for ifp %p", __func__, ifp));
833 if (igi->igi_flags & IGIF_LOOPBACK) {
834 CTR2(KTR_IGMPV3, "ignore v2 query on IGIF_LOOPBACK ifp %p(%s)",
840 * Ignore v2 query if in v1 Compatibility Mode.
842 if (igi->igi_version == IGMP_VERSION_1)
845 igmp_set_version(igi, IGMP_VERSION_2);
847 timer = igmp->igmp_code * PR_FASTHZ / IGMP_TIMER_SCALE;
851 if (is_general_query) {
853 * For each reporting group joined on this
854 * interface, kick the report timer.
856 CTR2(KTR_IGMPV3, "process v2 general query on ifp %p(%s)",
859 TAILQ_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link) {
860 if (ifma->ifma_addr->sa_family != AF_INET ||
861 ifma->ifma_protospec == NULL)
863 inm = (struct in_multi *)ifma->ifma_protospec;
864 igmp_v2_update_group(inm, timer);
866 IF_ADDR_RUNLOCK(ifp);
869 * Group-specific IGMPv2 query, we need only
870 * look up the single group to process it.
872 inm = inm_lookup(ifp, igmp->igmp_group);
874 CTR3(KTR_IGMPV3, "process v2 query %s on ifp %p(%s)",
875 inet_ntoa(igmp->igmp_group), ifp, ifp->if_xname);
876 igmp_v2_update_group(inm, timer);
888 * Update the report timer on a group in response to an IGMPv2 query.
890 * If we are becoming the reporting member for this group, start the timer.
891 * If we already are the reporting member for this group, and timer is
892 * below the threshold, reset it.
894 * We may be updating the group for the first time since we switched
895 * to IGMPv3. If we are, then we must clear any recorded source lists,
896 * and transition to REPORTING state; the group timer is overloaded
897 * for group and group-source query responses.
899 * Unlike IGMPv3, the delay per group should be jittered
900 * to avoid bursts of IGMPv2 reports.
903 igmp_v2_update_group(struct in_multi *inm, const int timer)
906 CTR4(KTR_IGMPV3, "%s: %s/%s timer=%d", __func__,
907 inet_ntoa(inm->inm_addr), inm->inm_ifp->if_xname, timer);
909 IN_MULTI_LOCK_ASSERT();
911 switch (inm->inm_state) {
912 case IGMP_NOT_MEMBER:
913 case IGMP_SILENT_MEMBER:
915 case IGMP_REPORTING_MEMBER:
916 if (inm->inm_timer != 0 &&
917 inm->inm_timer <= timer) {
918 CTR1(KTR_IGMPV3, "%s: REPORTING and timer running, "
919 "skipping.", __func__);
923 case IGMP_SG_QUERY_PENDING_MEMBER:
924 case IGMP_G_QUERY_PENDING_MEMBER:
925 case IGMP_IDLE_MEMBER:
926 case IGMP_LAZY_MEMBER:
927 case IGMP_AWAKENING_MEMBER:
928 CTR1(KTR_IGMPV3, "%s: ->REPORTING", __func__);
929 inm->inm_state = IGMP_REPORTING_MEMBER;
930 inm->inm_timer = IGMP_RANDOM_DELAY(timer);
931 V_current_state_timers_running = 1;
933 case IGMP_SLEEPING_MEMBER:
934 CTR1(KTR_IGMPV3, "%s: ->AWAKENING", __func__);
935 inm->inm_state = IGMP_AWAKENING_MEMBER;
937 case IGMP_LEAVING_MEMBER:
943 * Process a received IGMPv3 general, group-specific or
944 * group-and-source-specific query.
945 * Assumes m has already been pulled up to the full IGMP message length.
946 * Return 0 if successful, otherwise an appropriate error code is returned.
949 igmp_input_v3_query(struct ifnet *ifp, const struct ip *ip,
950 /*const*/ struct igmpv3 *igmpv3)
952 struct igmp_ifsoftc *igi;
953 struct in_multi *inm;
954 int is_general_query;
955 uint32_t maxresp, nsrc, qqi;
959 is_general_query = 0;
961 CTR2(KTR_IGMPV3, "process v3 query on ifp %p(%s)", ifp, ifp->if_xname);
963 maxresp = igmpv3->igmp_code; /* in 1/10ths of a second */
964 if (maxresp >= 128) {
965 maxresp = IGMP_MANT(igmpv3->igmp_code) <<
966 (IGMP_EXP(igmpv3->igmp_code) + 3);
970 * Robustness must never be less than 2 for on-wire IGMPv3.
971 * FUTURE: Check if ifp has IGIF_LOOPBACK set, as we will make
972 * an exception for interfaces whose IGMPv3 state changes
973 * are redirected to loopback (e.g. MANET).
975 qrv = IGMP_QRV(igmpv3->igmp_misc);
977 CTR3(KTR_IGMPV3, "%s: clamping qrv %d to %d", __func__,
982 qqi = igmpv3->igmp_qqi;
984 qqi = IGMP_MANT(igmpv3->igmp_qqi) <<
985 (IGMP_EXP(igmpv3->igmp_qqi) + 3);
988 timer = maxresp * PR_FASTHZ / IGMP_TIMER_SCALE;
992 nsrc = ntohs(igmpv3->igmp_numsrc);
995 * Validate address fields and versions upfront before
996 * accepting v3 query.
997 * XXX SMPng: Unlocked access to igmpstat counters here.
999 if (in_nullhost(igmpv3->igmp_group)) {
1001 * IGMPv3 General Query.
1003 * General Queries SHOULD be directed to 224.0.0.1.
1004 * A general query with a source list has undefined
1005 * behaviour; discard it.
1007 IGMPSTAT_INC(igps_rcv_gen_queries);
1008 if (!in_allhosts(ip->ip_dst) || nsrc > 0) {
1009 IGMPSTAT_INC(igps_rcv_badqueries);
1012 is_general_query = 1;
1014 /* Group or group-source specific query. */
1016 IGMPSTAT_INC(igps_rcv_group_queries);
1018 IGMPSTAT_INC(igps_rcv_gsr_queries);
1024 igi = ((struct in_ifinfo *)ifp->if_afdata[AF_INET])->ii_igmp;
1025 KASSERT(igi != NULL, ("%s: no igmp_ifsoftc for ifp %p", __func__, ifp));
1027 if (igi->igi_flags & IGIF_LOOPBACK) {
1028 CTR2(KTR_IGMPV3, "ignore v3 query on IGIF_LOOPBACK ifp %p(%s)",
1029 ifp, ifp->if_xname);
1034 * Discard the v3 query if we're in Compatibility Mode.
1035 * The RFC is not obviously worded that hosts need to stay in
1036 * compatibility mode until the Old Version Querier Present
1039 if (igi->igi_version != IGMP_VERSION_3) {
1040 CTR3(KTR_IGMPV3, "ignore v3 query in v%d mode on ifp %p(%s)",
1041 igi->igi_version, ifp, ifp->if_xname);
1045 igmp_set_version(igi, IGMP_VERSION_3);
1048 igi->igi_qri = maxresp;
1050 CTR4(KTR_IGMPV3, "%s: qrv %d qi %d qri %d", __func__, qrv, qqi,
1053 if (is_general_query) {
1055 * Schedule a current-state report on this ifp for
1056 * all groups, possibly containing source lists.
1057 * If there is a pending General Query response
1058 * scheduled earlier than the selected delay, do
1059 * not schedule any other reports.
1060 * Otherwise, reset the interface timer.
1062 CTR2(KTR_IGMPV3, "process v3 general query on ifp %p(%s)",
1063 ifp, ifp->if_xname);
1064 if (igi->igi_v3_timer == 0 || igi->igi_v3_timer >= timer) {
1065 igi->igi_v3_timer = IGMP_RANDOM_DELAY(timer);
1066 V_interface_timers_running = 1;
1070 * Group-source-specific queries are throttled on
1071 * a per-group basis to defeat denial-of-service attempts.
1072 * Queries for groups we are not a member of on this
1073 * link are simply ignored.
1075 inm = inm_lookup(ifp, igmpv3->igmp_group);
1079 if (!ratecheck(&inm->inm_lastgsrtv,
1080 &V_igmp_gsrdelay)) {
1081 CTR1(KTR_IGMPV3, "%s: GS query throttled.",
1083 IGMPSTAT_INC(igps_drop_gsr_queries);
1087 CTR3(KTR_IGMPV3, "process v3 %s query on ifp %p(%s)",
1088 inet_ntoa(igmpv3->igmp_group), ifp, ifp->if_xname);
1090 * If there is a pending General Query response
1091 * scheduled sooner than the selected delay, no
1092 * further report need be scheduled.
1093 * Otherwise, prepare to respond to the
1094 * group-specific or group-and-source query.
1096 if (igi->igi_v3_timer == 0 || igi->igi_v3_timer >= timer)
1097 igmp_input_v3_group_query(inm, igi, timer, igmpv3);
1108 * Process a recieved IGMPv3 group-specific or group-and-source-specific
1110 * Return <0 if any error occured. Currently this is ignored.
1113 igmp_input_v3_group_query(struct in_multi *inm, struct igmp_ifsoftc *igi,
1114 int timer, /*const*/ struct igmpv3 *igmpv3)
1119 IN_MULTI_LOCK_ASSERT();
1124 switch (inm->inm_state) {
1125 case IGMP_NOT_MEMBER:
1126 case IGMP_SILENT_MEMBER:
1127 case IGMP_SLEEPING_MEMBER:
1128 case IGMP_LAZY_MEMBER:
1129 case IGMP_AWAKENING_MEMBER:
1130 case IGMP_IDLE_MEMBER:
1131 case IGMP_LEAVING_MEMBER:
1134 case IGMP_REPORTING_MEMBER:
1135 case IGMP_G_QUERY_PENDING_MEMBER:
1136 case IGMP_SG_QUERY_PENDING_MEMBER:
1140 nsrc = ntohs(igmpv3->igmp_numsrc);
1143 * Deal with group-specific queries upfront.
1144 * If any group query is already pending, purge any recorded
1145 * source-list state if it exists, and schedule a query response
1146 * for this group-specific query.
1149 if (inm->inm_state == IGMP_G_QUERY_PENDING_MEMBER ||
1150 inm->inm_state == IGMP_SG_QUERY_PENDING_MEMBER) {
1151 inm_clear_recorded(inm);
1152 timer = min(inm->inm_timer, timer);
1154 inm->inm_state = IGMP_G_QUERY_PENDING_MEMBER;
1155 inm->inm_timer = IGMP_RANDOM_DELAY(timer);
1156 V_current_state_timers_running = 1;
1161 * Deal with the case where a group-and-source-specific query has
1162 * been received but a group-specific query is already pending.
1164 if (inm->inm_state == IGMP_G_QUERY_PENDING_MEMBER) {
1165 timer = min(inm->inm_timer, timer);
1166 inm->inm_timer = IGMP_RANDOM_DELAY(timer);
1167 V_current_state_timers_running = 1;
1172 * Finally, deal with the case where a group-and-source-specific
1173 * query has been received, where a response to a previous g-s-r
1174 * query exists, or none exists.
1175 * In this case, we need to parse the source-list which the Querier
1176 * has provided us with and check if we have any source list filter
1177 * entries at T1 for these sources. If we do not, there is no need
1178 * schedule a report and the query may be dropped.
1179 * If we do, we must record them and schedule a current-state
1180 * report for those sources.
1181 * FIXME: Handling source lists larger than 1 mbuf requires that
1182 * we pass the mbuf chain pointer down to this function, and use
1183 * m_getptr() to walk the chain.
1185 if (inm->inm_nsrc > 0) {
1186 const struct in_addr *ap;
1189 ap = (const struct in_addr *)(igmpv3 + 1);
1191 for (i = 0; i < nsrc; i++, ap++) {
1192 retval = inm_record_source(inm, ap->s_addr);
1195 nrecorded += retval;
1197 if (nrecorded > 0) {
1199 "%s: schedule response to SG query", __func__);
1200 inm->inm_state = IGMP_SG_QUERY_PENDING_MEMBER;
1201 inm->inm_timer = IGMP_RANDOM_DELAY(timer);
1202 V_current_state_timers_running = 1;
1210 * Process a received IGMPv1 host membership report.
1212 * NOTE: 0.0.0.0 workaround breaks const correctness.
1215 igmp_input_v1_report(struct ifnet *ifp, /*const*/ struct ip *ip,
1216 /*const*/ struct igmp *igmp)
1218 struct in_ifaddr *ia;
1219 struct in_multi *inm;
1221 IGMPSTAT_INC(igps_rcv_reports);
1223 if (ifp->if_flags & IFF_LOOPBACK)
1226 if (!IN_MULTICAST(ntohl(igmp->igmp_group.s_addr)) ||
1227 !in_hosteq(igmp->igmp_group, ip->ip_dst)) {
1228 IGMPSTAT_INC(igps_rcv_badreports);
1233 * RFC 3376, Section 4.2.13, 9.2, 9.3:
1234 * Booting clients may use the source address 0.0.0.0. Some
1235 * IGMP daemons may not know how to use IP_RECVIF to determine
1236 * the interface upon which this message was received.
1237 * Replace 0.0.0.0 with the subnet address if told to do so.
1239 if (V_igmp_recvifkludge && in_nullhost(ip->ip_src)) {
1242 ip->ip_src.s_addr = htonl(ia->ia_subnet);
1243 ifa_free(&ia->ia_ifa);
1247 CTR3(KTR_IGMPV3, "process v1 report %s on ifp %p(%s)",
1248 inet_ntoa(igmp->igmp_group), ifp, ifp->if_xname);
1251 * IGMPv1 report suppression.
1252 * If we are a member of this group, and our membership should be
1253 * reported, stop our group timer and transition to the 'lazy' state.
1256 inm = inm_lookup(ifp, igmp->igmp_group);
1258 struct igmp_ifsoftc *igi;
1262 KASSERT(igi != NULL,
1263 ("%s: no igi for ifp %p", __func__, ifp));
1267 IGMPSTAT_INC(igps_rcv_ourreports);
1270 * If we are in IGMPv3 host mode, do not allow the
1271 * other host's IGMPv1 report to suppress our reports
1272 * unless explicitly configured to do so.
1274 if (igi->igi_version == IGMP_VERSION_3) {
1275 if (V_igmp_legacysupp)
1276 igmp_v3_suppress_group_record(inm);
1282 switch (inm->inm_state) {
1283 case IGMP_NOT_MEMBER:
1284 case IGMP_SILENT_MEMBER:
1286 case IGMP_IDLE_MEMBER:
1287 case IGMP_LAZY_MEMBER:
1288 case IGMP_AWAKENING_MEMBER:
1290 "report suppressed for %s on ifp %p(%s)",
1291 inet_ntoa(igmp->igmp_group), ifp, ifp->if_xname);
1292 case IGMP_SLEEPING_MEMBER:
1293 inm->inm_state = IGMP_SLEEPING_MEMBER;
1295 case IGMP_REPORTING_MEMBER:
1297 "report suppressed for %s on ifp %p(%s)",
1298 inet_ntoa(igmp->igmp_group), ifp, ifp->if_xname);
1299 if (igi->igi_version == IGMP_VERSION_1)
1300 inm->inm_state = IGMP_LAZY_MEMBER;
1301 else if (igi->igi_version == IGMP_VERSION_2)
1302 inm->inm_state = IGMP_SLEEPING_MEMBER;
1304 case IGMP_G_QUERY_PENDING_MEMBER:
1305 case IGMP_SG_QUERY_PENDING_MEMBER:
1306 case IGMP_LEAVING_MEMBER:
1318 * Process a received IGMPv2 host membership report.
1320 * NOTE: 0.0.0.0 workaround breaks const correctness.
1323 igmp_input_v2_report(struct ifnet *ifp, /*const*/ struct ip *ip,
1324 /*const*/ struct igmp *igmp)
1326 struct in_ifaddr *ia;
1327 struct in_multi *inm;
1330 * Make sure we don't hear our own membership report. Fast
1331 * leave requires knowing that we are the only member of a
1335 if (ia != NULL && in_hosteq(ip->ip_src, IA_SIN(ia)->sin_addr)) {
1336 ifa_free(&ia->ia_ifa);
1340 IGMPSTAT_INC(igps_rcv_reports);
1342 if (ifp->if_flags & IFF_LOOPBACK) {
1344 ifa_free(&ia->ia_ifa);
1348 if (!IN_MULTICAST(ntohl(igmp->igmp_group.s_addr)) ||
1349 !in_hosteq(igmp->igmp_group, ip->ip_dst)) {
1351 ifa_free(&ia->ia_ifa);
1352 IGMPSTAT_INC(igps_rcv_badreports);
1357 * RFC 3376, Section 4.2.13, 9.2, 9.3:
1358 * Booting clients may use the source address 0.0.0.0. Some
1359 * IGMP daemons may not know how to use IP_RECVIF to determine
1360 * the interface upon which this message was received.
1361 * Replace 0.0.0.0 with the subnet address if told to do so.
1363 if (V_igmp_recvifkludge && in_nullhost(ip->ip_src)) {
1365 ip->ip_src.s_addr = htonl(ia->ia_subnet);
1368 ifa_free(&ia->ia_ifa);
1370 CTR3(KTR_IGMPV3, "process v2 report %s on ifp %p(%s)",
1371 inet_ntoa(igmp->igmp_group), ifp, ifp->if_xname);
1374 * IGMPv2 report suppression.
1375 * If we are a member of this group, and our membership should be
1376 * reported, and our group timer is pending or about to be reset,
1377 * stop our group timer by transitioning to the 'lazy' state.
1380 inm = inm_lookup(ifp, igmp->igmp_group);
1382 struct igmp_ifsoftc *igi;
1385 KASSERT(igi != NULL, ("%s: no igi for ifp %p", __func__, ifp));
1387 IGMPSTAT_INC(igps_rcv_ourreports);
1390 * If we are in IGMPv3 host mode, do not allow the
1391 * other host's IGMPv1 report to suppress our reports
1392 * unless explicitly configured to do so.
1394 if (igi->igi_version == IGMP_VERSION_3) {
1395 if (V_igmp_legacysupp)
1396 igmp_v3_suppress_group_record(inm);
1402 switch (inm->inm_state) {
1403 case IGMP_NOT_MEMBER:
1404 case IGMP_SILENT_MEMBER:
1405 case IGMP_SLEEPING_MEMBER:
1407 case IGMP_REPORTING_MEMBER:
1408 case IGMP_IDLE_MEMBER:
1409 case IGMP_AWAKENING_MEMBER:
1411 "report suppressed for %s on ifp %p(%s)",
1412 inet_ntoa(igmp->igmp_group), ifp, ifp->if_xname);
1413 case IGMP_LAZY_MEMBER:
1414 inm->inm_state = IGMP_LAZY_MEMBER;
1416 case IGMP_G_QUERY_PENDING_MEMBER:
1417 case IGMP_SG_QUERY_PENDING_MEMBER:
1418 case IGMP_LEAVING_MEMBER:
1430 igmp_input(struct mbuf **mp, int *offp, int proto)
1441 CTR3(KTR_IGMPV3, "%s: called w/mbuf (%p,%d)", __func__, *mp, *offp);
1444 ifp = m->m_pkthdr.rcvif;
1447 IGMPSTAT_INC(igps_rcv_total);
1449 ip = mtod(m, struct ip *);
1451 igmplen = ntohs(ip->ip_len) - iphlen;
1456 if (igmplen < IGMP_MINLEN) {
1457 IGMPSTAT_INC(igps_rcv_tooshort);
1459 return (IPPROTO_DONE);
1463 * Always pullup to the minimum size for v1/v2 or v3
1464 * to amortize calls to m_pullup().
1467 if (igmplen >= IGMP_V3_QUERY_MINLEN)
1468 minlen += IGMP_V3_QUERY_MINLEN;
1470 minlen += IGMP_MINLEN;
1471 if ((!M_WRITABLE(m) || m->m_len < minlen) &&
1472 (m = m_pullup(m, minlen)) == 0) {
1473 IGMPSTAT_INC(igps_rcv_tooshort);
1474 return (IPPROTO_DONE);
1476 ip = mtod(m, struct ip *);
1479 * Validate checksum.
1481 m->m_data += iphlen;
1483 igmp = mtod(m, struct igmp *);
1484 if (in_cksum(m, igmplen)) {
1485 IGMPSTAT_INC(igps_rcv_badsum);
1487 return (IPPROTO_DONE);
1489 m->m_data -= iphlen;
1493 * IGMP control traffic is link-scope, and must have a TTL of 1.
1494 * DVMRP traffic (e.g. mrinfo, mtrace) is an exception;
1495 * probe packets may come from beyond the LAN.
1497 if (igmp->igmp_type != IGMP_DVMRP && ip->ip_ttl != 1) {
1498 IGMPSTAT_INC(igps_rcv_badttl);
1500 return (IPPROTO_DONE);
1503 switch (igmp->igmp_type) {
1504 case IGMP_HOST_MEMBERSHIP_QUERY:
1505 if (igmplen == IGMP_MINLEN) {
1506 if (igmp->igmp_code == 0)
1507 queryver = IGMP_VERSION_1;
1509 queryver = IGMP_VERSION_2;
1510 } else if (igmplen >= IGMP_V3_QUERY_MINLEN) {
1511 queryver = IGMP_VERSION_3;
1513 IGMPSTAT_INC(igps_rcv_tooshort);
1515 return (IPPROTO_DONE);
1519 case IGMP_VERSION_1:
1520 IGMPSTAT_INC(igps_rcv_v1v2_queries);
1521 if (!V_igmp_v1enable)
1523 if (igmp_input_v1_query(ifp, ip, igmp) != 0) {
1525 return (IPPROTO_DONE);
1529 case IGMP_VERSION_2:
1530 IGMPSTAT_INC(igps_rcv_v1v2_queries);
1531 if (!V_igmp_v2enable)
1533 if (igmp_input_v2_query(ifp, ip, igmp) != 0) {
1535 return (IPPROTO_DONE);
1539 case IGMP_VERSION_3: {
1540 struct igmpv3 *igmpv3;
1544 IGMPSTAT_INC(igps_rcv_v3_queries);
1545 igmpv3 = (struct igmpv3 *)igmp;
1547 * Validate length based on source count.
1549 nsrc = ntohs(igmpv3->igmp_numsrc);
1550 if (nsrc * sizeof(in_addr_t) >
1551 UINT16_MAX - iphlen - IGMP_V3_QUERY_MINLEN) {
1552 IGMPSTAT_INC(igps_rcv_tooshort);
1553 return (IPPROTO_DONE);
1556 * m_pullup() may modify m, so pullup in
1559 igmpv3len = iphlen + IGMP_V3_QUERY_MINLEN +
1560 sizeof(struct in_addr) * nsrc;
1561 if ((!M_WRITABLE(m) ||
1562 m->m_len < igmpv3len) &&
1563 (m = m_pullup(m, igmpv3len)) == NULL) {
1564 IGMPSTAT_INC(igps_rcv_tooshort);
1565 return (IPPROTO_DONE);
1567 igmpv3 = (struct igmpv3 *)(mtod(m, uint8_t *)
1569 if (igmp_input_v3_query(ifp, ip, igmpv3) != 0) {
1571 return (IPPROTO_DONE);
1578 case IGMP_v1_HOST_MEMBERSHIP_REPORT:
1579 if (!V_igmp_v1enable)
1581 if (igmp_input_v1_report(ifp, ip, igmp) != 0) {
1583 return (IPPROTO_DONE);
1587 case IGMP_v2_HOST_MEMBERSHIP_REPORT:
1588 if (!V_igmp_v2enable)
1590 if (!ip_checkrouteralert(m))
1591 IGMPSTAT_INC(igps_rcv_nora);
1592 if (igmp_input_v2_report(ifp, ip, igmp) != 0) {
1594 return (IPPROTO_DONE);
1598 case IGMP_v3_HOST_MEMBERSHIP_REPORT:
1600 * Hosts do not need to process IGMPv3 membership reports,
1601 * as report suppression is no longer required.
1603 if (!ip_checkrouteralert(m))
1604 IGMPSTAT_INC(igps_rcv_nora);
1612 * Pass all valid IGMP packets up to any process(es) listening on a
1616 return (rip_input(mp, offp, proto));
1621 * Fast timeout handler (global).
1622 * VIMAGE: Timeout handlers are expected to service all vimages.
1627 VNET_ITERATOR_DECL(vnet_iter);
1629 VNET_LIST_RLOCK_NOSLEEP();
1630 VNET_FOREACH(vnet_iter) {
1631 CURVNET_SET(vnet_iter);
1632 igmp_fasttimo_vnet();
1635 VNET_LIST_RUNLOCK_NOSLEEP();
1639 * Fast timeout handler (per-vnet).
1640 * Sends are shuffled off to a netisr to deal with Giant.
1642 * VIMAGE: Assume caller has set up our curvnet.
1645 igmp_fasttimo_vnet(void)
1647 struct mbufq scq; /* State-change packets */
1648 struct mbufq qrq; /* Query response packets */
1650 struct igmp_ifsoftc *igi;
1651 struct ifmultiaddr *ifma;
1652 struct in_multi *inm;
1653 int loop, uri_fasthz;
1659 * Quick check to see if any work needs to be done, in order to
1660 * minimize the overhead of fasttimo processing.
1661 * SMPng: XXX Unlocked reads.
1663 if (!V_current_state_timers_running &&
1664 !V_interface_timers_running &&
1665 !V_state_change_timers_running)
1672 * IGMPv3 General Query response timer processing.
1674 if (V_interface_timers_running) {
1675 CTR1(KTR_IGMPV3, "%s: interface timers running", __func__);
1677 V_interface_timers_running = 0;
1678 LIST_FOREACH(igi, &V_igi_head, igi_link) {
1679 if (igi->igi_v3_timer == 0) {
1681 } else if (--igi->igi_v3_timer == 0) {
1682 igmp_v3_dispatch_general_query(igi);
1684 V_interface_timers_running = 1;
1689 if (!V_current_state_timers_running &&
1690 !V_state_change_timers_running)
1693 V_current_state_timers_running = 0;
1694 V_state_change_timers_running = 0;
1696 CTR1(KTR_IGMPV3, "%s: state change timers running", __func__);
1699 * IGMPv1/v2/v3 host report and state-change timer processing.
1700 * Note: Processing a v3 group timer may remove a node.
1702 LIST_FOREACH(igi, &V_igi_head, igi_link) {
1705 if (igi->igi_version == IGMP_VERSION_3) {
1706 loop = (igi->igi_flags & IGIF_LOOPBACK) ? 1 : 0;
1707 uri_fasthz = IGMP_RANDOM_DELAY(igi->igi_uri *
1709 mbufq_init(&qrq, IGMP_MAX_G_GS_PACKETS);
1710 mbufq_init(&scq, IGMP_MAX_STATE_CHANGE_PACKETS);
1714 TAILQ_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link) {
1715 if (ifma->ifma_addr->sa_family != AF_INET ||
1716 ifma->ifma_protospec == NULL)
1718 inm = (struct in_multi *)ifma->ifma_protospec;
1719 switch (igi->igi_version) {
1720 case IGMP_VERSION_1:
1721 case IGMP_VERSION_2:
1722 igmp_v1v2_process_group_timer(inm,
1725 case IGMP_VERSION_3:
1726 igmp_v3_process_group_timers(igi, &qrq,
1727 &scq, inm, uri_fasthz);
1731 IF_ADDR_RUNLOCK(ifp);
1733 if (igi->igi_version == IGMP_VERSION_3) {
1734 struct in_multi *tinm;
1736 igmp_dispatch_queue(&qrq, 0, loop);
1737 igmp_dispatch_queue(&scq, 0, loop);
1740 * Free the in_multi reference(s) for this
1743 SLIST_FOREACH_SAFE(inm, &igi->igi_relinmhead,
1745 SLIST_REMOVE_HEAD(&igi->igi_relinmhead,
1747 inm_release_locked(inm);
1758 * Update host report group timer for IGMPv1/v2.
1759 * Will update the global pending timer flags.
1762 igmp_v1v2_process_group_timer(struct in_multi *inm, const int version)
1764 int report_timer_expired;
1766 IN_MULTI_LOCK_ASSERT();
1769 if (inm->inm_timer == 0) {
1770 report_timer_expired = 0;
1771 } else if (--inm->inm_timer == 0) {
1772 report_timer_expired = 1;
1774 V_current_state_timers_running = 1;
1778 switch (inm->inm_state) {
1779 case IGMP_NOT_MEMBER:
1780 case IGMP_SILENT_MEMBER:
1781 case IGMP_IDLE_MEMBER:
1782 case IGMP_LAZY_MEMBER:
1783 case IGMP_SLEEPING_MEMBER:
1784 case IGMP_AWAKENING_MEMBER:
1786 case IGMP_REPORTING_MEMBER:
1787 if (report_timer_expired) {
1788 inm->inm_state = IGMP_IDLE_MEMBER;
1789 (void)igmp_v1v2_queue_report(inm,
1790 (version == IGMP_VERSION_2) ?
1791 IGMP_v2_HOST_MEMBERSHIP_REPORT :
1792 IGMP_v1_HOST_MEMBERSHIP_REPORT);
1795 case IGMP_G_QUERY_PENDING_MEMBER:
1796 case IGMP_SG_QUERY_PENDING_MEMBER:
1797 case IGMP_LEAVING_MEMBER:
1803 * Update a group's timers for IGMPv3.
1804 * Will update the global pending timer flags.
1805 * Note: Unlocked read from igi.
1808 igmp_v3_process_group_timers(struct igmp_ifsoftc *igi,
1809 struct mbufq *qrq, struct mbufq *scq,
1810 struct in_multi *inm, const int uri_fasthz)
1812 int query_response_timer_expired;
1813 int state_change_retransmit_timer_expired;
1815 IN_MULTI_LOCK_ASSERT();
1818 query_response_timer_expired = 0;
1819 state_change_retransmit_timer_expired = 0;
1822 * During a transition from v1/v2 compatibility mode back to v3,
1823 * a group record in REPORTING state may still have its group
1824 * timer active. This is a no-op in this function; it is easier
1825 * to deal with it here than to complicate the slow-timeout path.
1827 if (inm->inm_timer == 0) {
1828 query_response_timer_expired = 0;
1829 } else if (--inm->inm_timer == 0) {
1830 query_response_timer_expired = 1;
1832 V_current_state_timers_running = 1;
1835 if (inm->inm_sctimer == 0) {
1836 state_change_retransmit_timer_expired = 0;
1837 } else if (--inm->inm_sctimer == 0) {
1838 state_change_retransmit_timer_expired = 1;
1840 V_state_change_timers_running = 1;
1843 /* We are in fasttimo, so be quick about it. */
1844 if (!state_change_retransmit_timer_expired &&
1845 !query_response_timer_expired)
1848 switch (inm->inm_state) {
1849 case IGMP_NOT_MEMBER:
1850 case IGMP_SILENT_MEMBER:
1851 case IGMP_SLEEPING_MEMBER:
1852 case IGMP_LAZY_MEMBER:
1853 case IGMP_AWAKENING_MEMBER:
1854 case IGMP_IDLE_MEMBER:
1856 case IGMP_G_QUERY_PENDING_MEMBER:
1857 case IGMP_SG_QUERY_PENDING_MEMBER:
1859 * Respond to a previously pending Group-Specific
1860 * or Group-and-Source-Specific query by enqueueing
1861 * the appropriate Current-State report for
1862 * immediate transmission.
1864 if (query_response_timer_expired) {
1867 retval = igmp_v3_enqueue_group_record(qrq, inm, 0, 1,
1868 (inm->inm_state == IGMP_SG_QUERY_PENDING_MEMBER));
1869 CTR2(KTR_IGMPV3, "%s: enqueue record = %d",
1871 inm->inm_state = IGMP_REPORTING_MEMBER;
1872 /* XXX Clear recorded sources for next time. */
1873 inm_clear_recorded(inm);
1876 case IGMP_REPORTING_MEMBER:
1877 case IGMP_LEAVING_MEMBER:
1878 if (state_change_retransmit_timer_expired) {
1880 * State-change retransmission timer fired.
1881 * If there are any further pending retransmissions,
1882 * set the global pending state-change flag, and
1885 if (--inm->inm_scrv > 0) {
1886 inm->inm_sctimer = uri_fasthz;
1887 V_state_change_timers_running = 1;
1890 * Retransmit the previously computed state-change
1891 * report. If there are no further pending
1892 * retransmissions, the mbuf queue will be consumed.
1893 * Update T0 state to T1 as we have now sent
1896 (void)igmp_v3_merge_state_changes(inm, scq);
1899 CTR3(KTR_IGMPV3, "%s: T1 -> T0 for %s/%s", __func__,
1900 inet_ntoa(inm->inm_addr), inm->inm_ifp->if_xname);
1903 * If we are leaving the group for good, make sure
1904 * we release IGMP's reference to it.
1905 * This release must be deferred using a SLIST,
1906 * as we are called from a loop which traverses
1907 * the in_ifmultiaddr TAILQ.
1909 if (inm->inm_state == IGMP_LEAVING_MEMBER &&
1910 inm->inm_scrv == 0) {
1911 inm->inm_state = IGMP_NOT_MEMBER;
1912 SLIST_INSERT_HEAD(&igi->igi_relinmhead,
1922 * Suppress a group's pending response to a group or source/group query.
1924 * Do NOT suppress state changes. This leads to IGMPv3 inconsistency.
1925 * Do NOT update ST1/ST0 as this operation merely suppresses
1926 * the currently pending group record.
1927 * Do NOT suppress the response to a general query. It is possible but
1928 * it would require adding another state or flag.
1931 igmp_v3_suppress_group_record(struct in_multi *inm)
1934 IN_MULTI_LOCK_ASSERT();
1936 KASSERT(inm->inm_igi->igi_version == IGMP_VERSION_3,
1937 ("%s: not IGMPv3 mode on link", __func__));
1939 if (inm->inm_state != IGMP_G_QUERY_PENDING_MEMBER ||
1940 inm->inm_state != IGMP_SG_QUERY_PENDING_MEMBER)
1943 if (inm->inm_state == IGMP_SG_QUERY_PENDING_MEMBER)
1944 inm_clear_recorded(inm);
1947 inm->inm_state = IGMP_REPORTING_MEMBER;
1951 * Switch to a different IGMP version on the given interface,
1952 * as per Section 7.2.1.
1955 igmp_set_version(struct igmp_ifsoftc *igi, const int version)
1957 int old_version_timer;
1961 CTR4(KTR_IGMPV3, "%s: switching to v%d on ifp %p(%s)", __func__,
1962 version, igi->igi_ifp, igi->igi_ifp->if_xname);
1964 if (version == IGMP_VERSION_1 || version == IGMP_VERSION_2) {
1966 * Compute the "Older Version Querier Present" timer as per
1969 old_version_timer = igi->igi_rv * igi->igi_qi + igi->igi_qri;
1970 old_version_timer *= PR_SLOWHZ;
1972 if (version == IGMP_VERSION_1) {
1973 igi->igi_v1_timer = old_version_timer;
1974 igi->igi_v2_timer = 0;
1975 } else if (version == IGMP_VERSION_2) {
1976 igi->igi_v1_timer = 0;
1977 igi->igi_v2_timer = old_version_timer;
1981 if (igi->igi_v1_timer == 0 && igi->igi_v2_timer > 0) {
1982 if (igi->igi_version != IGMP_VERSION_2) {
1983 igi->igi_version = IGMP_VERSION_2;
1984 igmp_v3_cancel_link_timers(igi);
1986 } else if (igi->igi_v1_timer > 0) {
1987 if (igi->igi_version != IGMP_VERSION_1) {
1988 igi->igi_version = IGMP_VERSION_1;
1989 igmp_v3_cancel_link_timers(igi);
1995 * Cancel pending IGMPv3 timers for the given link and all groups
1996 * joined on it; state-change, general-query, and group-query timers.
1998 * Only ever called on a transition from v3 to Compatibility mode. Kill
1999 * the timers stone dead (this may be expensive for large N groups), they
2000 * will be restarted if Compatibility Mode deems that they must be due to
2004 igmp_v3_cancel_link_timers(struct igmp_ifsoftc *igi)
2006 struct ifmultiaddr *ifma;
2008 struct in_multi *inm, *tinm;
2010 CTR3(KTR_IGMPV3, "%s: cancel v3 timers on ifp %p(%s)", __func__,
2011 igi->igi_ifp, igi->igi_ifp->if_xname);
2013 IN_MULTI_LOCK_ASSERT();
2017 * Stop the v3 General Query Response on this link stone dead.
2018 * If fasttimo is woken up due to V_interface_timers_running,
2019 * the flag will be cleared if there are no pending link timers.
2021 igi->igi_v3_timer = 0;
2024 * Now clear the current-state and state-change report timers
2025 * for all memberships scoped to this link.
2029 TAILQ_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link) {
2030 if (ifma->ifma_addr->sa_family != AF_INET ||
2031 ifma->ifma_protospec == NULL)
2033 inm = (struct in_multi *)ifma->ifma_protospec;
2034 switch (inm->inm_state) {
2035 case IGMP_NOT_MEMBER:
2036 case IGMP_SILENT_MEMBER:
2037 case IGMP_IDLE_MEMBER:
2038 case IGMP_LAZY_MEMBER:
2039 case IGMP_SLEEPING_MEMBER:
2040 case IGMP_AWAKENING_MEMBER:
2042 * These states are either not relevant in v3 mode,
2043 * or are unreported. Do nothing.
2046 case IGMP_LEAVING_MEMBER:
2048 * If we are leaving the group and switching to
2049 * compatibility mode, we need to release the final
2050 * reference held for issuing the INCLUDE {}, and
2051 * transition to REPORTING to ensure the host leave
2052 * message is sent upstream to the old querier --
2053 * transition to NOT would lose the leave and race.
2055 SLIST_INSERT_HEAD(&igi->igi_relinmhead, inm, inm_nrele);
2057 case IGMP_G_QUERY_PENDING_MEMBER:
2058 case IGMP_SG_QUERY_PENDING_MEMBER:
2059 inm_clear_recorded(inm);
2061 case IGMP_REPORTING_MEMBER:
2062 inm->inm_state = IGMP_REPORTING_MEMBER;
2066 * Always clear state-change and group report timers.
2067 * Free any pending IGMPv3 state-change records.
2069 inm->inm_sctimer = 0;
2071 mbufq_drain(&inm->inm_scq);
2073 IF_ADDR_RUNLOCK(ifp);
2074 SLIST_FOREACH_SAFE(inm, &igi->igi_relinmhead, inm_nrele, tinm) {
2075 SLIST_REMOVE_HEAD(&igi->igi_relinmhead, inm_nrele);
2076 inm_release_locked(inm);
2081 * Update the Older Version Querier Present timers for a link.
2082 * See Section 7.2.1 of RFC 3376.
2085 igmp_v1v2_process_querier_timers(struct igmp_ifsoftc *igi)
2090 if (igi->igi_v1_timer == 0 && igi->igi_v2_timer == 0) {
2092 * IGMPv1 and IGMPv2 Querier Present timers expired.
2096 if (igi->igi_version != IGMP_VERSION_3) {
2098 "%s: transition from v%d -> v%d on %p(%s)",
2099 __func__, igi->igi_version, IGMP_VERSION_3,
2100 igi->igi_ifp, igi->igi_ifp->if_xname);
2101 igi->igi_version = IGMP_VERSION_3;
2103 } else if (igi->igi_v1_timer == 0 && igi->igi_v2_timer > 0) {
2105 * IGMPv1 Querier Present timer expired,
2106 * IGMPv2 Querier Present timer running.
2107 * If IGMPv2 was disabled since last timeout,
2109 * If IGMPv2 is enabled, revert to IGMPv2.
2111 if (!V_igmp_v2enable) {
2113 "%s: transition from v%d -> v%d on %p(%s)",
2114 __func__, igi->igi_version, IGMP_VERSION_3,
2115 igi->igi_ifp, igi->igi_ifp->if_xname);
2116 igi->igi_v2_timer = 0;
2117 igi->igi_version = IGMP_VERSION_3;
2119 --igi->igi_v2_timer;
2120 if (igi->igi_version != IGMP_VERSION_2) {
2122 "%s: transition from v%d -> v%d on %p(%s)",
2123 __func__, igi->igi_version, IGMP_VERSION_2,
2124 igi->igi_ifp, igi->igi_ifp->if_xname);
2125 igi->igi_version = IGMP_VERSION_2;
2126 igmp_v3_cancel_link_timers(igi);
2129 } else if (igi->igi_v1_timer > 0) {
2131 * IGMPv1 Querier Present timer running.
2132 * Stop IGMPv2 timer if running.
2134 * If IGMPv1 was disabled since last timeout,
2136 * If IGMPv1 is enabled, reset IGMPv2 timer if running.
2138 if (!V_igmp_v1enable) {
2140 "%s: transition from v%d -> v%d on %p(%s)",
2141 __func__, igi->igi_version, IGMP_VERSION_3,
2142 igi->igi_ifp, igi->igi_ifp->if_xname);
2143 igi->igi_v1_timer = 0;
2144 igi->igi_version = IGMP_VERSION_3;
2146 --igi->igi_v1_timer;
2148 if (igi->igi_v2_timer > 0) {
2150 "%s: cancel v2 timer on %p(%s)",
2151 __func__, igi->igi_ifp, igi->igi_ifp->if_xname);
2152 igi->igi_v2_timer = 0;
2158 * Global slowtimo handler.
2159 * VIMAGE: Timeout handlers are expected to service all vimages.
2164 VNET_ITERATOR_DECL(vnet_iter);
2166 VNET_LIST_RLOCK_NOSLEEP();
2167 VNET_FOREACH(vnet_iter) {
2168 CURVNET_SET(vnet_iter);
2169 igmp_slowtimo_vnet();
2172 VNET_LIST_RUNLOCK_NOSLEEP();
2176 * Per-vnet slowtimo handler.
2179 igmp_slowtimo_vnet(void)
2181 struct igmp_ifsoftc *igi;
2185 LIST_FOREACH(igi, &V_igi_head, igi_link) {
2186 igmp_v1v2_process_querier_timers(igi);
2193 * Dispatch an IGMPv1/v2 host report or leave message.
2194 * These are always small enough to fit inside a single mbuf.
2197 igmp_v1v2_queue_report(struct in_multi *inm, const int type)
2204 IN_MULTI_LOCK_ASSERT();
2209 m = m_gethdr(M_NOWAIT, MT_DATA);
2212 M_ALIGN(m, sizeof(struct ip) + sizeof(struct igmp));
2214 m->m_pkthdr.len = sizeof(struct ip) + sizeof(struct igmp);
2216 m->m_data += sizeof(struct ip);
2217 m->m_len = sizeof(struct igmp);
2219 igmp = mtod(m, struct igmp *);
2220 igmp->igmp_type = type;
2221 igmp->igmp_code = 0;
2222 igmp->igmp_group = inm->inm_addr;
2223 igmp->igmp_cksum = 0;
2224 igmp->igmp_cksum = in_cksum(m, sizeof(struct igmp));
2226 m->m_data -= sizeof(struct ip);
2227 m->m_len += sizeof(struct ip);
2229 ip = mtod(m, struct ip *);
2231 ip->ip_len = htons(sizeof(struct ip) + sizeof(struct igmp));
2233 ip->ip_p = IPPROTO_IGMP;
2234 ip->ip_src.s_addr = INADDR_ANY;
2236 if (type == IGMP_HOST_LEAVE_MESSAGE)
2237 ip->ip_dst.s_addr = htonl(INADDR_ALLRTRS_GROUP);
2239 ip->ip_dst = inm->inm_addr;
2241 igmp_save_context(m, ifp);
2243 m->m_flags |= M_IGMPV2;
2244 if (inm->inm_igi->igi_flags & IGIF_LOOPBACK)
2245 m->m_flags |= M_IGMP_LOOP;
2247 CTR2(KTR_IGMPV3, "%s: netisr_dispatch(NETISR_IGMP, %p)", __func__, m);
2248 netisr_dispatch(NETISR_IGMP, m);
2254 * Process a state change from the upper layer for the given IPv4 group.
2256 * Each socket holds a reference on the in_multi in its own ip_moptions.
2257 * The socket layer will have made the necessary updates to.the group
2258 * state, it is now up to IGMP to issue a state change report if there
2259 * has been any change between T0 (when the last state-change was issued)
2262 * We use the IGMPv3 state machine at group level. The IGMP module
2263 * however makes the decision as to which IGMP protocol version to speak.
2264 * A state change *from* INCLUDE {} always means an initial join.
2265 * A state change *to* INCLUDE {} always means a final leave.
2267 * FUTURE: If IGIF_V3LITE is enabled for this interface, then we can
2268 * save ourselves a bunch of work; any exclusive mode groups need not
2269 * compute source filter lists.
2271 * VIMAGE: curvnet should have been set by caller, as this routine
2272 * is called from the socket option handlers.
2275 igmp_change_state(struct in_multi *inm)
2277 struct igmp_ifsoftc *igi;
2281 IN_MULTI_LOCK_ASSERT();
2286 * Try to detect if the upper layer just asked us to change state
2287 * for an interface which has now gone away.
2289 KASSERT(inm->inm_ifma != NULL, ("%s: no ifma", __func__));
2290 ifp = inm->inm_ifma->ifma_ifp;
2292 * Sanity check that netinet's notion of ifp is the
2295 KASSERT(inm->inm_ifp == ifp, ("%s: bad ifp", __func__));
2299 igi = ((struct in_ifinfo *)ifp->if_afdata[AF_INET])->ii_igmp;
2300 KASSERT(igi != NULL, ("%s: no igmp_ifsoftc for ifp %p", __func__, ifp));
2303 * If we detect a state transition to or from MCAST_UNDEFINED
2304 * for this group, then we are starting or finishing an IGMP
2305 * life cycle for this group.
2307 if (inm->inm_st[1].iss_fmode != inm->inm_st[0].iss_fmode) {
2308 CTR3(KTR_IGMPV3, "%s: inm transition %d -> %d", __func__,
2309 inm->inm_st[0].iss_fmode, inm->inm_st[1].iss_fmode);
2310 if (inm->inm_st[0].iss_fmode == MCAST_UNDEFINED) {
2311 CTR1(KTR_IGMPV3, "%s: initial join", __func__);
2312 error = igmp_initial_join(inm, igi);
2314 } else if (inm->inm_st[1].iss_fmode == MCAST_UNDEFINED) {
2315 CTR1(KTR_IGMPV3, "%s: final leave", __func__);
2316 igmp_final_leave(inm, igi);
2320 CTR1(KTR_IGMPV3, "%s: filter set change", __func__);
2323 error = igmp_handle_state_change(inm, igi);
2331 * Perform the initial join for an IGMP group.
2333 * When joining a group:
2334 * If the group should have its IGMP traffic suppressed, do nothing.
2335 * IGMPv1 starts sending IGMPv1 host membership reports.
2336 * IGMPv2 starts sending IGMPv2 host membership reports.
2337 * IGMPv3 will schedule an IGMPv3 state-change report containing the
2338 * initial state of the membership.
2341 igmp_initial_join(struct in_multi *inm, struct igmp_ifsoftc *igi)
2345 int error, retval, syncstates;
2347 CTR4(KTR_IGMPV3, "%s: initial join %s on ifp %p(%s)",
2348 __func__, inet_ntoa(inm->inm_addr), inm->inm_ifp,
2349 inm->inm_ifp->if_xname);
2356 IN_MULTI_LOCK_ASSERT();
2359 KASSERT(igi && igi->igi_ifp == ifp, ("%s: inconsistent ifp", __func__));
2362 * Groups joined on loopback or marked as 'not reported',
2363 * e.g. 224.0.0.1, enter the IGMP_SILENT_MEMBER state and
2364 * are never reported in any IGMP protocol exchanges.
2365 * All other groups enter the appropriate IGMP state machine
2366 * for the version in use on this link.
2367 * A link marked as IGIF_SILENT causes IGMP to be completely
2368 * disabled for the link.
2370 if ((ifp->if_flags & IFF_LOOPBACK) ||
2371 (igi->igi_flags & IGIF_SILENT) ||
2372 !igmp_isgroupreported(inm->inm_addr)) {
2374 "%s: not kicking state machine for silent group", __func__);
2375 inm->inm_state = IGMP_SILENT_MEMBER;
2379 * Deal with overlapping in_multi lifecycle.
2380 * If this group was LEAVING, then make sure
2381 * we drop the reference we picked up to keep the
2382 * group around for the final INCLUDE {} enqueue.
2384 if (igi->igi_version == IGMP_VERSION_3 &&
2385 inm->inm_state == IGMP_LEAVING_MEMBER)
2386 inm_release_locked(inm);
2388 inm->inm_state = IGMP_REPORTING_MEMBER;
2390 switch (igi->igi_version) {
2391 case IGMP_VERSION_1:
2392 case IGMP_VERSION_2:
2393 inm->inm_state = IGMP_IDLE_MEMBER;
2394 error = igmp_v1v2_queue_report(inm,
2395 (igi->igi_version == IGMP_VERSION_2) ?
2396 IGMP_v2_HOST_MEMBERSHIP_REPORT :
2397 IGMP_v1_HOST_MEMBERSHIP_REPORT);
2399 inm->inm_timer = IGMP_RANDOM_DELAY(
2400 IGMP_V1V2_MAX_RI * PR_FASTHZ);
2401 V_current_state_timers_running = 1;
2405 case IGMP_VERSION_3:
2407 * Defer update of T0 to T1, until the first copy
2408 * of the state change has been transmitted.
2413 * Immediately enqueue a State-Change Report for
2414 * this interface, freeing any previous reports.
2415 * Don't kick the timers if there is nothing to do,
2416 * or if an error occurred.
2420 retval = igmp_v3_enqueue_group_record(mq, inm, 1,
2422 CTR2(KTR_IGMPV3, "%s: enqueue record = %d",
2425 error = retval * -1;
2430 * Schedule transmission of pending state-change
2431 * report up to RV times for this link. The timer
2432 * will fire at the next igmp_fasttimo (~200ms),
2433 * giving us an opportunity to merge the reports.
2435 if (igi->igi_flags & IGIF_LOOPBACK) {
2438 KASSERT(igi->igi_rv > 1,
2439 ("%s: invalid robustness %d", __func__,
2441 inm->inm_scrv = igi->igi_rv;
2443 inm->inm_sctimer = 1;
2444 V_state_change_timers_running = 1;
2452 * Only update the T0 state if state change is atomic,
2453 * i.e. we don't need to wait for a timer to fire before we
2454 * can consider the state change to have been communicated.
2458 CTR3(KTR_IGMPV3, "%s: T1 -> T0 for %s/%s", __func__,
2459 inet_ntoa(inm->inm_addr), inm->inm_ifp->if_xname);
2466 * Issue an intermediate state change during the IGMP life-cycle.
2469 igmp_handle_state_change(struct in_multi *inm, struct igmp_ifsoftc *igi)
2474 CTR4(KTR_IGMPV3, "%s: state change for %s on ifp %p(%s)",
2475 __func__, inet_ntoa(inm->inm_addr), inm->inm_ifp,
2476 inm->inm_ifp->if_xname);
2480 IN_MULTI_LOCK_ASSERT();
2483 KASSERT(igi && igi->igi_ifp == ifp, ("%s: inconsistent ifp", __func__));
2485 if ((ifp->if_flags & IFF_LOOPBACK) ||
2486 (igi->igi_flags & IGIF_SILENT) ||
2487 !igmp_isgroupreported(inm->inm_addr) ||
2488 (igi->igi_version != IGMP_VERSION_3)) {
2489 if (!igmp_isgroupreported(inm->inm_addr)) {
2491 "%s: not kicking state machine for silent group", __func__);
2493 CTR1(KTR_IGMPV3, "%s: nothing to do", __func__);
2495 CTR3(KTR_IGMPV3, "%s: T1 -> T0 for %s/%s", __func__,
2496 inet_ntoa(inm->inm_addr), inm->inm_ifp->if_xname);
2500 mbufq_drain(&inm->inm_scq);
2502 retval = igmp_v3_enqueue_group_record(&inm->inm_scq, inm, 1, 0, 0);
2503 CTR2(KTR_IGMPV3, "%s: enqueue record = %d", __func__, retval);
2508 * If record(s) were enqueued, start the state-change
2509 * report timer for this group.
2511 inm->inm_scrv = ((igi->igi_flags & IGIF_LOOPBACK) ? 1 : igi->igi_rv);
2512 inm->inm_sctimer = 1;
2513 V_state_change_timers_running = 1;
2519 * Perform the final leave for an IGMP group.
2521 * When leaving a group:
2522 * IGMPv1 does nothing.
2523 * IGMPv2 sends a host leave message, if and only if we are the reporter.
2524 * IGMPv3 enqueues a state-change report containing a transition
2525 * to INCLUDE {} for immediate transmission.
2528 igmp_final_leave(struct in_multi *inm, struct igmp_ifsoftc *igi)
2534 CTR4(KTR_IGMPV3, "%s: final leave %s on ifp %p(%s)",
2535 __func__, inet_ntoa(inm->inm_addr), inm->inm_ifp,
2536 inm->inm_ifp->if_xname);
2538 IN_MULTI_LOCK_ASSERT();
2541 switch (inm->inm_state) {
2542 case IGMP_NOT_MEMBER:
2543 case IGMP_SILENT_MEMBER:
2544 case IGMP_LEAVING_MEMBER:
2545 /* Already leaving or left; do nothing. */
2547 "%s: not kicking state machine for silent group", __func__);
2549 case IGMP_REPORTING_MEMBER:
2550 case IGMP_IDLE_MEMBER:
2551 case IGMP_G_QUERY_PENDING_MEMBER:
2552 case IGMP_SG_QUERY_PENDING_MEMBER:
2553 if (igi->igi_version == IGMP_VERSION_2) {
2555 if (inm->inm_state == IGMP_G_QUERY_PENDING_MEMBER ||
2556 inm->inm_state == IGMP_SG_QUERY_PENDING_MEMBER)
2557 panic("%s: IGMPv3 state reached, not IGMPv3 mode",
2560 igmp_v1v2_queue_report(inm, IGMP_HOST_LEAVE_MESSAGE);
2561 inm->inm_state = IGMP_NOT_MEMBER;
2562 } else if (igi->igi_version == IGMP_VERSION_3) {
2564 * Stop group timer and all pending reports.
2565 * Immediately enqueue a state-change report
2566 * TO_IN {} to be sent on the next fast timeout,
2567 * giving us an opportunity to merge reports.
2569 mbufq_drain(&inm->inm_scq);
2571 if (igi->igi_flags & IGIF_LOOPBACK) {
2574 inm->inm_scrv = igi->igi_rv;
2576 CTR4(KTR_IGMPV3, "%s: Leaving %s/%s with %d "
2577 "pending retransmissions.", __func__,
2578 inet_ntoa(inm->inm_addr),
2579 inm->inm_ifp->if_xname, inm->inm_scrv);
2580 if (inm->inm_scrv == 0) {
2581 inm->inm_state = IGMP_NOT_MEMBER;
2582 inm->inm_sctimer = 0;
2586 inm_acquire_locked(inm);
2588 retval = igmp_v3_enqueue_group_record(
2589 &inm->inm_scq, inm, 1, 0, 0);
2590 KASSERT(retval != 0,
2591 ("%s: enqueue record = %d", __func__,
2594 inm->inm_state = IGMP_LEAVING_MEMBER;
2595 inm->inm_sctimer = 1;
2596 V_state_change_timers_running = 1;
2602 case IGMP_LAZY_MEMBER:
2603 case IGMP_SLEEPING_MEMBER:
2604 case IGMP_AWAKENING_MEMBER:
2605 /* Our reports are suppressed; do nothing. */
2611 CTR3(KTR_IGMPV3, "%s: T1 -> T0 for %s/%s", __func__,
2612 inet_ntoa(inm->inm_addr), inm->inm_ifp->if_xname);
2613 inm->inm_st[1].iss_fmode = MCAST_UNDEFINED;
2614 CTR3(KTR_IGMPV3, "%s: T1 now MCAST_UNDEFINED for %s/%s",
2615 __func__, inet_ntoa(inm->inm_addr), inm->inm_ifp->if_xname);
2620 * Enqueue an IGMPv3 group record to the given output queue.
2622 * XXX This function could do with having the allocation code
2623 * split out, and the multiple-tree-walks coalesced into a single
2624 * routine as has been done in igmp_v3_enqueue_filter_change().
2626 * If is_state_change is zero, a current-state record is appended.
2627 * If is_state_change is non-zero, a state-change report is appended.
2629 * If is_group_query is non-zero, an mbuf packet chain is allocated.
2630 * If is_group_query is zero, and if there is a packet with free space
2631 * at the tail of the queue, it will be appended to providing there
2632 * is enough free space.
2633 * Otherwise a new mbuf packet chain is allocated.
2635 * If is_source_query is non-zero, each source is checked to see if
2636 * it was recorded for a Group-Source query, and will be omitted if
2637 * it is not both in-mode and recorded.
2639 * The function will attempt to allocate leading space in the packet
2640 * for the IP/IGMP header to be prepended without fragmenting the chain.
2642 * If successful the size of all data appended to the queue is returned,
2643 * otherwise an error code less than zero is returned, or zero if
2644 * no record(s) were appended.
2647 igmp_v3_enqueue_group_record(struct mbufq *mq, struct in_multi *inm,
2648 const int is_state_change, const int is_group_query,
2649 const int is_source_query)
2651 struct igmp_grouprec ig;
2652 struct igmp_grouprec *pig;
2654 struct ip_msource *ims, *nims;
2655 struct mbuf *m0, *m, *md;
2656 int error, is_filter_list_change;
2657 int minrec0len, m0srcs, msrcs, nbytes, off;
2658 int record_has_sources;
2664 IN_MULTI_LOCK_ASSERT();
2668 is_filter_list_change = 0;
2675 record_has_sources = 1;
2677 type = IGMP_DO_NOTHING;
2678 mode = inm->inm_st[1].iss_fmode;
2681 * If we did not transition out of ASM mode during t0->t1,
2682 * and there are no source nodes to process, we can skip
2683 * the generation of source records.
2685 if (inm->inm_st[0].iss_asm > 0 && inm->inm_st[1].iss_asm > 0 &&
2687 record_has_sources = 0;
2689 if (is_state_change) {
2691 * Queue a state change record.
2692 * If the mode did not change, and there are non-ASM
2693 * listeners or source filters present,
2694 * we potentially need to issue two records for the group.
2695 * If we are transitioning to MCAST_UNDEFINED, we need
2696 * not send any sources.
2697 * If there are ASM listeners, and there was no filter
2698 * mode transition of any kind, do nothing.
2700 if (mode != inm->inm_st[0].iss_fmode) {
2701 if (mode == MCAST_EXCLUDE) {
2702 CTR1(KTR_IGMPV3, "%s: change to EXCLUDE",
2704 type = IGMP_CHANGE_TO_EXCLUDE_MODE;
2706 CTR1(KTR_IGMPV3, "%s: change to INCLUDE",
2708 type = IGMP_CHANGE_TO_INCLUDE_MODE;
2709 if (mode == MCAST_UNDEFINED)
2710 record_has_sources = 0;
2713 if (record_has_sources) {
2714 is_filter_list_change = 1;
2716 type = IGMP_DO_NOTHING;
2721 * Queue a current state record.
2723 if (mode == MCAST_EXCLUDE) {
2724 type = IGMP_MODE_IS_EXCLUDE;
2725 } else if (mode == MCAST_INCLUDE) {
2726 type = IGMP_MODE_IS_INCLUDE;
2727 KASSERT(inm->inm_st[1].iss_asm == 0,
2728 ("%s: inm %p is INCLUDE but ASM count is %d",
2729 __func__, inm, inm->inm_st[1].iss_asm));
2734 * Generate the filter list changes using a separate function.
2736 if (is_filter_list_change)
2737 return (igmp_v3_enqueue_filter_change(mq, inm));
2739 if (type == IGMP_DO_NOTHING) {
2740 CTR3(KTR_IGMPV3, "%s: nothing to do for %s/%s",
2741 __func__, inet_ntoa(inm->inm_addr),
2742 inm->inm_ifp->if_xname);
2747 * If any sources are present, we must be able to fit at least
2748 * one in the trailing space of the tail packet's mbuf,
2751 minrec0len = sizeof(struct igmp_grouprec);
2752 if (record_has_sources)
2753 minrec0len += sizeof(in_addr_t);
2755 CTR4(KTR_IGMPV3, "%s: queueing %s for %s/%s", __func__,
2756 igmp_rec_type_to_str(type), inet_ntoa(inm->inm_addr),
2757 inm->inm_ifp->if_xname);
2760 * Check if we have a packet in the tail of the queue for this
2761 * group into which the first group record for this group will fit.
2762 * Otherwise allocate a new packet.
2763 * Always allocate leading space for IP+RA_OPT+IGMP+REPORT.
2764 * Note: Group records for G/GSR query responses MUST be sent
2765 * in their own packet.
2767 m0 = mbufq_last(mq);
2768 if (!is_group_query &&
2770 (m0->m_pkthdr.PH_vt.vt_nrecs + 1 <= IGMP_V3_REPORT_MAXRECS) &&
2771 (m0->m_pkthdr.len + minrec0len) <
2772 (ifp->if_mtu - IGMP_LEADINGSPACE)) {
2773 m0srcs = (ifp->if_mtu - m0->m_pkthdr.len -
2774 sizeof(struct igmp_grouprec)) / sizeof(in_addr_t);
2776 CTR1(KTR_IGMPV3, "%s: use existing packet", __func__);
2778 if (mbufq_full(mq)) {
2779 CTR1(KTR_IGMPV3, "%s: outbound queue full", __func__);
2783 m0srcs = (ifp->if_mtu - IGMP_LEADINGSPACE -
2784 sizeof(struct igmp_grouprec)) / sizeof(in_addr_t);
2785 if (!is_state_change && !is_group_query) {
2786 m = m_getcl(M_NOWAIT, MT_DATA, M_PKTHDR);
2788 m->m_data += IGMP_LEADINGSPACE;
2791 m = m_gethdr(M_NOWAIT, MT_DATA);
2793 M_ALIGN(m, IGMP_LEADINGSPACE);
2798 igmp_save_context(m, ifp);
2800 CTR1(KTR_IGMPV3, "%s: allocated first packet", __func__);
2804 * Append group record.
2805 * If we have sources, we don't know how many yet.
2810 ig.ig_group = inm->inm_addr;
2811 if (!m_append(m, sizeof(struct igmp_grouprec), (void *)&ig)) {
2814 CTR1(KTR_IGMPV3, "%s: m_append() failed.", __func__);
2817 nbytes += sizeof(struct igmp_grouprec);
2820 * Append as many sources as will fit in the first packet.
2821 * If we are appending to a new packet, the chain allocation
2822 * may potentially use clusters; use m_getptr() in this case.
2823 * If we are appending to an existing packet, we need to obtain
2824 * a pointer to the group record after m_append(), in case a new
2825 * mbuf was allocated.
2826 * Only append sources which are in-mode at t1. If we are
2827 * transitioning to MCAST_UNDEFINED state on the group, do not
2828 * include source entries.
2829 * Only report recorded sources in our filter set when responding
2830 * to a group-source query.
2832 if (record_has_sources) {
2835 pig = (struct igmp_grouprec *)(mtod(md, uint8_t *) +
2836 md->m_len - nbytes);
2838 md = m_getptr(m, 0, &off);
2839 pig = (struct igmp_grouprec *)(mtod(md, uint8_t *) +
2843 RB_FOREACH_SAFE(ims, ip_msource_tree, &inm->inm_srcs, nims) {
2844 CTR2(KTR_IGMPV3, "%s: visit node %s", __func__,
2845 inet_ntoa_haddr(ims->ims_haddr));
2846 now = ims_get_mode(inm, ims, 1);
2847 CTR2(KTR_IGMPV3, "%s: node is %d", __func__, now);
2848 if ((now != mode) ||
2849 (now == mode && mode == MCAST_UNDEFINED)) {
2850 CTR1(KTR_IGMPV3, "%s: skip node", __func__);
2853 if (is_source_query && ims->ims_stp == 0) {
2854 CTR1(KTR_IGMPV3, "%s: skip unrecorded node",
2858 CTR1(KTR_IGMPV3, "%s: append node", __func__);
2859 naddr = htonl(ims->ims_haddr);
2860 if (!m_append(m, sizeof(in_addr_t), (void *)&naddr)) {
2863 CTR1(KTR_IGMPV3, "%s: m_append() failed.",
2867 nbytes += sizeof(in_addr_t);
2869 if (msrcs == m0srcs)
2872 CTR2(KTR_IGMPV3, "%s: msrcs is %d this packet", __func__,
2874 pig->ig_numsrc = htons(msrcs);
2875 nbytes += (msrcs * sizeof(in_addr_t));
2878 if (is_source_query && msrcs == 0) {
2879 CTR1(KTR_IGMPV3, "%s: no recorded sources to report", __func__);
2886 * We are good to go with first packet.
2889 CTR1(KTR_IGMPV3, "%s: enqueueing first packet", __func__);
2890 m->m_pkthdr.PH_vt.vt_nrecs = 1;
2891 mbufq_enqueue(mq, m);
2893 m->m_pkthdr.PH_vt.vt_nrecs++;
2896 * No further work needed if no source list in packet(s).
2898 if (!record_has_sources)
2902 * Whilst sources remain to be announced, we need to allocate
2903 * a new packet and fill out as many sources as will fit.
2904 * Always try for a cluster first.
2906 while (nims != NULL) {
2907 if (mbufq_full(mq)) {
2908 CTR1(KTR_IGMPV3, "%s: outbound queue full", __func__);
2911 m = m_getcl(M_NOWAIT, MT_DATA, M_PKTHDR);
2913 m->m_data += IGMP_LEADINGSPACE;
2915 m = m_gethdr(M_NOWAIT, MT_DATA);
2917 M_ALIGN(m, IGMP_LEADINGSPACE);
2921 igmp_save_context(m, ifp);
2922 md = m_getptr(m, 0, &off);
2923 pig = (struct igmp_grouprec *)(mtod(md, uint8_t *) + off);
2924 CTR1(KTR_IGMPV3, "%s: allocated next packet", __func__);
2926 if (!m_append(m, sizeof(struct igmp_grouprec), (void *)&ig)) {
2929 CTR1(KTR_IGMPV3, "%s: m_append() failed.", __func__);
2932 m->m_pkthdr.PH_vt.vt_nrecs = 1;
2933 nbytes += sizeof(struct igmp_grouprec);
2935 m0srcs = (ifp->if_mtu - IGMP_LEADINGSPACE -
2936 sizeof(struct igmp_grouprec)) / sizeof(in_addr_t);
2939 RB_FOREACH_FROM(ims, ip_msource_tree, nims) {
2940 CTR2(KTR_IGMPV3, "%s: visit node %s", __func__,
2941 inet_ntoa_haddr(ims->ims_haddr));
2942 now = ims_get_mode(inm, ims, 1);
2943 if ((now != mode) ||
2944 (now == mode && mode == MCAST_UNDEFINED)) {
2945 CTR1(KTR_IGMPV3, "%s: skip node", __func__);
2948 if (is_source_query && ims->ims_stp == 0) {
2949 CTR1(KTR_IGMPV3, "%s: skip unrecorded node",
2953 CTR1(KTR_IGMPV3, "%s: append node", __func__);
2954 naddr = htonl(ims->ims_haddr);
2955 if (!m_append(m, sizeof(in_addr_t), (void *)&naddr)) {
2958 CTR1(KTR_IGMPV3, "%s: m_append() failed.",
2963 if (msrcs == m0srcs)
2966 pig->ig_numsrc = htons(msrcs);
2967 nbytes += (msrcs * sizeof(in_addr_t));
2969 CTR1(KTR_IGMPV3, "%s: enqueueing next packet", __func__);
2970 mbufq_enqueue(mq, m);
2977 * Type used to mark record pass completion.
2978 * We exploit the fact we can cast to this easily from the
2979 * current filter modes on each ip_msource node.
2982 REC_NONE = 0x00, /* MCAST_UNDEFINED */
2983 REC_ALLOW = 0x01, /* MCAST_INCLUDE */
2984 REC_BLOCK = 0x02, /* MCAST_EXCLUDE */
2985 REC_FULL = REC_ALLOW | REC_BLOCK
2989 * Enqueue an IGMPv3 filter list change to the given output queue.
2991 * Source list filter state is held in an RB-tree. When the filter list
2992 * for a group is changed without changing its mode, we need to compute
2993 * the deltas between T0 and T1 for each source in the filter set,
2994 * and enqueue the appropriate ALLOW_NEW/BLOCK_OLD records.
2996 * As we may potentially queue two record types, and the entire R-B tree
2997 * needs to be walked at once, we break this out into its own function
2998 * so we can generate a tightly packed queue of packets.
3000 * XXX This could be written to only use one tree walk, although that makes
3001 * serializing into the mbuf chains a bit harder. For now we do two walks
3002 * which makes things easier on us, and it may or may not be harder on
3005 * If successful the size of all data appended to the queue is returned,
3006 * otherwise an error code less than zero is returned, or zero if
3007 * no record(s) were appended.
3010 igmp_v3_enqueue_filter_change(struct mbufq *mq, struct in_multi *inm)
3012 static const int MINRECLEN =
3013 sizeof(struct igmp_grouprec) + sizeof(in_addr_t);
3015 struct igmp_grouprec ig;
3016 struct igmp_grouprec *pig;
3017 struct ip_msource *ims, *nims;
3018 struct mbuf *m, *m0, *md;
3020 int m0srcs, nbytes, npbytes, off, rsrcs, schanged;
3022 uint8_t mode, now, then;
3023 rectype_t crt, drt, nrt;
3025 IN_MULTI_LOCK_ASSERT();
3027 if (inm->inm_nsrc == 0 ||
3028 (inm->inm_st[0].iss_asm > 0 && inm->inm_st[1].iss_asm > 0))
3031 ifp = inm->inm_ifp; /* interface */
3032 mode = inm->inm_st[1].iss_fmode; /* filter mode at t1 */
3033 crt = REC_NONE; /* current group record type */
3034 drt = REC_NONE; /* mask of completed group record types */
3035 nrt = REC_NONE; /* record type for current node */
3036 m0srcs = 0; /* # source which will fit in current mbuf chain */
3037 nbytes = 0; /* # of bytes appended to group's state-change queue */
3038 npbytes = 0; /* # of bytes appended this packet */
3039 rsrcs = 0; /* # sources encoded in current record */
3040 schanged = 0; /* # nodes encoded in overall filter change */
3041 nallow = 0; /* # of source entries in ALLOW_NEW */
3042 nblock = 0; /* # of source entries in BLOCK_OLD */
3043 nims = NULL; /* next tree node pointer */
3046 * For each possible filter record mode.
3047 * The first kind of source we encounter tells us which
3048 * is the first kind of record we start appending.
3049 * If a node transitioned to UNDEFINED at t1, its mode is treated
3050 * as the inverse of the group's filter mode.
3052 while (drt != REC_FULL) {
3054 m0 = mbufq_last(mq);
3056 (m0->m_pkthdr.PH_vt.vt_nrecs + 1 <=
3057 IGMP_V3_REPORT_MAXRECS) &&
3058 (m0->m_pkthdr.len + MINRECLEN) <
3059 (ifp->if_mtu - IGMP_LEADINGSPACE)) {
3061 m0srcs = (ifp->if_mtu - m0->m_pkthdr.len -
3062 sizeof(struct igmp_grouprec)) /
3065 "%s: use previous packet", __func__);
3067 m = m_getcl(M_NOWAIT, MT_DATA, M_PKTHDR);
3069 m->m_data += IGMP_LEADINGSPACE;
3071 m = m_gethdr(M_NOWAIT, MT_DATA);
3073 M_ALIGN(m, IGMP_LEADINGSPACE);
3077 "%s: m_get*() failed", __func__);
3080 m->m_pkthdr.PH_vt.vt_nrecs = 0;
3081 igmp_save_context(m, ifp);
3082 m0srcs = (ifp->if_mtu - IGMP_LEADINGSPACE -
3083 sizeof(struct igmp_grouprec)) /
3087 "%s: allocated new packet", __func__);
3090 * Append the IGMP group record header to the
3091 * current packet's data area.
3092 * Recalculate pointer to free space for next
3093 * group record, in case m_append() allocated
3094 * a new mbuf or cluster.
3096 memset(&ig, 0, sizeof(ig));
3097 ig.ig_group = inm->inm_addr;
3098 if (!m_append(m, sizeof(ig), (void *)&ig)) {
3102 "%s: m_append() failed", __func__);
3105 npbytes += sizeof(struct igmp_grouprec);
3107 /* new packet; offset in c hain */
3108 md = m_getptr(m, npbytes -
3109 sizeof(struct igmp_grouprec), &off);
3110 pig = (struct igmp_grouprec *)(mtod(md,
3113 /* current packet; offset from last append */
3115 pig = (struct igmp_grouprec *)(mtod(md,
3116 uint8_t *) + md->m_len -
3117 sizeof(struct igmp_grouprec));
3120 * Begin walking the tree for this record type
3121 * pass, or continue from where we left off
3122 * previously if we had to allocate a new packet.
3123 * Only report deltas in-mode at t1.
3124 * We need not report included sources as allowed
3125 * if we are in inclusive mode on the group,
3126 * however the converse is not true.
3130 nims = RB_MIN(ip_msource_tree, &inm->inm_srcs);
3131 RB_FOREACH_FROM(ims, ip_msource_tree, nims) {
3132 CTR2(KTR_IGMPV3, "%s: visit node %s",
3133 __func__, inet_ntoa_haddr(ims->ims_haddr));
3134 now = ims_get_mode(inm, ims, 1);
3135 then = ims_get_mode(inm, ims, 0);
3136 CTR3(KTR_IGMPV3, "%s: mode: t0 %d, t1 %d",
3137 __func__, then, now);
3140 "%s: skip unchanged", __func__);
3143 if (mode == MCAST_EXCLUDE &&
3144 now == MCAST_INCLUDE) {
3146 "%s: skip IN src on EX group",
3150 nrt = (rectype_t)now;
3151 if (nrt == REC_NONE)
3152 nrt = (rectype_t)(~mode & REC_FULL);
3153 if (schanged++ == 0) {
3155 } else if (crt != nrt)
3157 naddr = htonl(ims->ims_haddr);
3158 if (!m_append(m, sizeof(in_addr_t),
3163 "%s: m_append() failed", __func__);
3166 nallow += !!(crt == REC_ALLOW);
3167 nblock += !!(crt == REC_BLOCK);
3168 if (++rsrcs == m0srcs)
3172 * If we did not append any tree nodes on this
3173 * pass, back out of allocations.
3176 npbytes -= sizeof(struct igmp_grouprec);
3179 "%s: m_free(m)", __func__);
3183 "%s: m_adj(m, -ig)", __func__);
3184 m_adj(m, -((int)sizeof(
3185 struct igmp_grouprec)));
3189 npbytes += (rsrcs * sizeof(in_addr_t));
3190 if (crt == REC_ALLOW)
3191 pig->ig_type = IGMP_ALLOW_NEW_SOURCES;
3192 else if (crt == REC_BLOCK)
3193 pig->ig_type = IGMP_BLOCK_OLD_SOURCES;
3194 pig->ig_numsrc = htons(rsrcs);
3196 * Count the new group record, and enqueue this
3197 * packet if it wasn't already queued.
3199 m->m_pkthdr.PH_vt.vt_nrecs++;
3201 mbufq_enqueue(mq, m);
3203 } while (nims != NULL);
3205 crt = (~crt & REC_FULL);
3208 CTR3(KTR_IGMPV3, "%s: queued %d ALLOW_NEW, %d BLOCK_OLD", __func__,
3215 igmp_v3_merge_state_changes(struct in_multi *inm, struct mbufq *scq)
3218 struct mbuf *m; /* pending state-change */
3219 struct mbuf *m0; /* copy of pending state-change */
3220 struct mbuf *mt; /* last state-change in packet */
3221 int docopy, domerge;
3228 IN_MULTI_LOCK_ASSERT();
3232 * If there are further pending retransmissions, make a writable
3233 * copy of each queued state-change message before merging.
3235 if (inm->inm_scrv > 0)
3240 if (mbufq_first(gq) == NULL) {
3241 CTR2(KTR_IGMPV3, "%s: WARNING: queue for inm %p is empty",
3246 m = mbufq_first(gq);
3249 * Only merge the report into the current packet if
3250 * there is sufficient space to do so; an IGMPv3 report
3251 * packet may only contain 65,535 group records.
3252 * Always use a simple mbuf chain concatentation to do this,
3253 * as large state changes for single groups may have
3254 * allocated clusters.
3257 mt = mbufq_last(scq);
3259 recslen = m_length(m, NULL);
3261 if ((mt->m_pkthdr.PH_vt.vt_nrecs +
3262 m->m_pkthdr.PH_vt.vt_nrecs <=
3263 IGMP_V3_REPORT_MAXRECS) &&
3264 (mt->m_pkthdr.len + recslen <=
3265 (inm->inm_ifp->if_mtu - IGMP_LEADINGSPACE)))
3269 if (!domerge && mbufq_full(gq)) {
3271 "%s: outbound queue full, skipping whole packet %p",
3281 CTR2(KTR_IGMPV3, "%s: dequeueing %p", __func__, m);
3282 m0 = mbufq_dequeue(gq);
3285 CTR2(KTR_IGMPV3, "%s: copying %p", __func__, m);
3286 m0 = m_dup(m, M_NOWAIT);
3289 m0->m_nextpkt = NULL;
3294 CTR3(KTR_IGMPV3, "%s: queueing %p to scq %p)",
3296 mbufq_enqueue(scq, m0);
3298 struct mbuf *mtl; /* last mbuf of packet mt */
3300 CTR3(KTR_IGMPV3, "%s: merging %p with scq tail %p)",
3304 m0->m_flags &= ~M_PKTHDR;
3305 mt->m_pkthdr.len += recslen;
3306 mt->m_pkthdr.PH_vt.vt_nrecs +=
3307 m0->m_pkthdr.PH_vt.vt_nrecs;
3317 * Respond to a pending IGMPv3 General Query.
3320 igmp_v3_dispatch_general_query(struct igmp_ifsoftc *igi)
3322 struct ifmultiaddr *ifma;
3324 struct in_multi *inm;
3327 IN_MULTI_LOCK_ASSERT();
3330 KASSERT(igi->igi_version == IGMP_VERSION_3,
3331 ("%s: called when version %d", __func__, igi->igi_version));
3336 TAILQ_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link) {
3337 if (ifma->ifma_addr->sa_family != AF_INET ||
3338 ifma->ifma_protospec == NULL)
3341 inm = (struct in_multi *)ifma->ifma_protospec;
3342 KASSERT(ifp == inm->inm_ifp,
3343 ("%s: inconsistent ifp", __func__));
3345 switch (inm->inm_state) {
3346 case IGMP_NOT_MEMBER:
3347 case IGMP_SILENT_MEMBER:
3349 case IGMP_REPORTING_MEMBER:
3350 case IGMP_IDLE_MEMBER:
3351 case IGMP_LAZY_MEMBER:
3352 case IGMP_SLEEPING_MEMBER:
3353 case IGMP_AWAKENING_MEMBER:
3354 inm->inm_state = IGMP_REPORTING_MEMBER;
3355 retval = igmp_v3_enqueue_group_record(&igi->igi_gq,
3357 CTR2(KTR_IGMPV3, "%s: enqueue record = %d",
3360 case IGMP_G_QUERY_PENDING_MEMBER:
3361 case IGMP_SG_QUERY_PENDING_MEMBER:
3362 case IGMP_LEAVING_MEMBER:
3366 IF_ADDR_RUNLOCK(ifp);
3368 loop = (igi->igi_flags & IGIF_LOOPBACK) ? 1 : 0;
3369 igmp_dispatch_queue(&igi->igi_gq, IGMP_MAX_RESPONSE_BURST, loop);
3372 * Slew transmission of bursts over 500ms intervals.
3374 if (mbufq_first(&igi->igi_gq) != NULL) {
3375 igi->igi_v3_timer = 1 + IGMP_RANDOM_DELAY(
3376 IGMP_RESPONSE_BURST_INTERVAL);
3377 V_interface_timers_running = 1;
3382 * Transmit the next pending IGMP message in the output queue.
3384 * We get called from netisr_processqueue(). A mutex private to igmpoq
3385 * will be acquired and released around this routine.
3387 * VIMAGE: Needs to store/restore vnet pointer on a per-mbuf-chain basis.
3388 * MRT: Nothing needs to be done, as IGMP traffic is always local to
3389 * a link and uses a link-scope multicast address.
3392 igmp_intr(struct mbuf *m)
3394 struct ip_moptions imo;
3396 struct mbuf *ipopts, *m0;
3400 CTR2(KTR_IGMPV3, "%s: transmit %p", __func__, m);
3403 * Set VNET image pointer from enqueued mbuf chain
3404 * before doing anything else. Whilst we use interface
3405 * indexes to guard against interface detach, they are
3406 * unique to each VIMAGE and must be retrieved.
3408 CURVNET_SET((struct vnet *)(m->m_pkthdr.PH_loc.ptr));
3409 ifindex = igmp_restore_context(m);
3412 * Check if the ifnet still exists. This limits the scope of
3413 * any race in the absence of a global ifp lock for low cost
3414 * (an array lookup).
3416 ifp = ifnet_byindex(ifindex);
3418 CTR3(KTR_IGMPV3, "%s: dropped %p as ifindex %u went away.",
3419 __func__, m, ifindex);
3421 IPSTAT_INC(ips_noroute);
3425 ipopts = V_igmp_sendra ? m_raopt : NULL;
3427 imo.imo_multicast_ttl = 1;
3428 imo.imo_multicast_vif = -1;
3429 imo.imo_multicast_loop = (V_ip_mrouter != NULL);
3432 * If the user requested that IGMP traffic be explicitly
3433 * redirected to the loopback interface (e.g. they are running a
3434 * MANET interface and the routing protocol needs to see the
3435 * updates), handle this now.
3437 if (m->m_flags & M_IGMP_LOOP)
3438 imo.imo_multicast_ifp = V_loif;
3440 imo.imo_multicast_ifp = ifp;
3442 if (m->m_flags & M_IGMPV2) {
3445 m0 = igmp_v3_encap_report(ifp, m);
3447 CTR2(KTR_IGMPV3, "%s: dropped %p", __func__, m);
3449 IPSTAT_INC(ips_odropped);
3454 igmp_scrub_context(m0);
3456 m0->m_pkthdr.rcvif = V_loif;
3458 mac_netinet_igmp_send(ifp, m0);
3460 error = ip_output(m0, ipopts, NULL, 0, &imo, NULL);
3462 CTR3(KTR_IGMPV3, "%s: ip_output(%p) = %d", __func__, m0, error);
3466 IGMPSTAT_INC(igps_snd_reports);
3470 * We must restore the existing vnet pointer before
3471 * continuing as we are run from netisr context.
3477 * Encapsulate an IGMPv3 report.
3479 * The internal mbuf flag M_IGMPV3_HDR is used to indicate that the mbuf
3480 * chain has already had its IP/IGMPv3 header prepended. In this case
3481 * the function will not attempt to prepend; the lengths and checksums
3482 * will however be re-computed.
3484 * Returns a pointer to the new mbuf chain head, or NULL if the
3485 * allocation failed.
3487 static struct mbuf *
3488 igmp_v3_encap_report(struct ifnet *ifp, struct mbuf *m)
3490 struct igmp_report *igmp;
3492 int hdrlen, igmpreclen;
3494 KASSERT((m->m_flags & M_PKTHDR),
3495 ("%s: mbuf chain %p is !M_PKTHDR", __func__, m));
3497 igmpreclen = m_length(m, NULL);
3498 hdrlen = sizeof(struct ip) + sizeof(struct igmp_report);
3500 if (m->m_flags & M_IGMPV3_HDR) {
3501 igmpreclen -= hdrlen;
3503 M_PREPEND(m, hdrlen, M_NOWAIT);
3506 m->m_flags |= M_IGMPV3_HDR;
3509 CTR2(KTR_IGMPV3, "%s: igmpreclen is %d", __func__, igmpreclen);
3511 m->m_data += sizeof(struct ip);
3512 m->m_len -= sizeof(struct ip);
3514 igmp = mtod(m, struct igmp_report *);
3515 igmp->ir_type = IGMP_v3_HOST_MEMBERSHIP_REPORT;
3518 igmp->ir_numgrps = htons(m->m_pkthdr.PH_vt.vt_nrecs);
3520 igmp->ir_cksum = in_cksum(m, sizeof(struct igmp_report) + igmpreclen);
3521 m->m_pkthdr.PH_vt.vt_nrecs = 0;
3523 m->m_data -= sizeof(struct ip);
3524 m->m_len += sizeof(struct ip);
3526 ip = mtod(m, struct ip *);
3527 ip->ip_tos = IPTOS_PREC_INTERNETCONTROL;
3528 ip->ip_len = htons(hdrlen + igmpreclen);
3529 ip->ip_off = htons(IP_DF);
3530 ip->ip_p = IPPROTO_IGMP;
3533 ip->ip_src.s_addr = INADDR_ANY;
3535 if (m->m_flags & M_IGMP_LOOP) {
3536 struct in_ifaddr *ia;
3540 ip->ip_src = ia->ia_addr.sin_addr;
3541 ifa_free(&ia->ia_ifa);
3545 ip->ip_dst.s_addr = htonl(INADDR_ALLRPTS_GROUP);
3552 igmp_rec_type_to_str(const int type)
3556 case IGMP_CHANGE_TO_EXCLUDE_MODE:
3559 case IGMP_CHANGE_TO_INCLUDE_MODE:
3562 case IGMP_MODE_IS_EXCLUDE:
3565 case IGMP_MODE_IS_INCLUDE:
3568 case IGMP_ALLOW_NEW_SOURCES:
3571 case IGMP_BLOCK_OLD_SOURCES:
3582 igmp_init(void *unused __unused)
3585 CTR1(KTR_IGMPV3, "%s: initializing", __func__);
3589 m_raopt = igmp_ra_alloc();
3591 netisr_register(&igmp_nh);
3593 SYSINIT(igmp_init, SI_SUB_PSEUDO, SI_ORDER_MIDDLE, igmp_init, NULL);
3596 igmp_uninit(void *unused __unused)
3599 CTR1(KTR_IGMPV3, "%s: tearing down", __func__);
3601 netisr_unregister(&igmp_nh);
3606 IGMP_LOCK_DESTROY();
3608 SYSUNINIT(igmp_uninit, SI_SUB_PSEUDO, SI_ORDER_MIDDLE, igmp_uninit, NULL);
3611 vnet_igmp_init(const void *unused __unused)
3614 CTR1(KTR_IGMPV3, "%s: initializing", __func__);
3616 LIST_INIT(&V_igi_head);
3618 VNET_SYSINIT(vnet_igmp_init, SI_SUB_PSEUDO, SI_ORDER_ANY, vnet_igmp_init,
3622 vnet_igmp_uninit(const void *unused __unused)
3625 CTR1(KTR_IGMPV3, "%s: tearing down", __func__);
3627 KASSERT(LIST_EMPTY(&V_igi_head),
3628 ("%s: igi list not empty; ifnets not detached?", __func__));
3630 VNET_SYSUNINIT(vnet_igmp_uninit, SI_SUB_PSEUDO, SI_ORDER_ANY,
3631 vnet_igmp_uninit, NULL);
3634 igmp_modevent(module_t mod, int type, void *unused __unused)
3642 return (EOPNOTSUPP);
3647 static moduledata_t igmp_mod = {
3652 DECLARE_MODULE(igmp, igmp_mod, SI_SUB_PSEUDO, SI_ORDER_ANY);