2 * Copyright (c) 2007-2009 Bruce Simpson.
3 * Copyright (c) 2005 Robert N. M. Watson.
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
32 * IPv4 multicast socket, group, and socket option processing module.
35 #include <sys/cdefs.h>
36 __FBSDID("$FreeBSD$");
38 #include <sys/param.h>
39 #include <sys/systm.h>
40 #include <sys/kernel.h>
42 #include <sys/malloc.h>
44 #include <sys/protosw.h>
45 #include <sys/rmlock.h>
46 #include <sys/socket.h>
47 #include <sys/socketvar.h>
48 #include <sys/protosw.h>
49 #include <sys/sysctl.h>
51 #include <sys/taskqueue.h>
55 #include <net/if_var.h>
56 #include <net/if_dl.h>
57 #include <net/route.h>
60 #include <netinet/in.h>
61 #include <netinet/in_systm.h>
62 #include <netinet/in_fib.h>
63 #include <netinet/in_pcb.h>
64 #include <netinet/in_var.h>
65 #include <netinet/ip_var.h>
66 #include <netinet/igmp_var.h>
69 #define KTR_IGMPV3 KTR_INET
72 #ifndef __SOCKUNION_DECLARED
74 struct sockaddr_storage ss;
76 struct sockaddr_dl sdl;
77 struct sockaddr_in sin;
79 typedef union sockunion sockunion_t;
80 #define __SOCKUNION_DECLARED
81 #endif /* __SOCKUNION_DECLARED */
83 static MALLOC_DEFINE(M_INMFILTER, "in_mfilter",
84 "IPv4 multicast PCB-layer source filter");
85 static MALLOC_DEFINE(M_IPMADDR, "in_multi", "IPv4 multicast group");
86 static MALLOC_DEFINE(M_IPMOPTS, "ip_moptions", "IPv4 multicast options");
87 static MALLOC_DEFINE(M_IPMSOURCE, "ip_msource",
88 "IPv4 multicast IGMP-layer source filter");
92 * - Lock order is: Giant, INP_WLOCK, IN_MULTI_LOCK, IGMP_LOCK, IF_ADDR_LOCK.
93 * - The IF_ADDR_LOCK is implicitly taken by inm_lookup() earlier, however
94 * it can be taken by code in net/if.c also.
95 * - ip_moptions and in_mfilter are covered by the INP_WLOCK.
97 * struct in_multi is covered by IN_MULTI_LOCK. There isn't strictly
98 * any need for in_multi itself to be virtualized -- it is bound to an ifp
99 * anyway no matter what happens.
101 struct mtx in_multi_mtx;
102 MTX_SYSINIT(in_multi_mtx, &in_multi_mtx, "in_multi_mtx", MTX_DEF);
105 * Functions with non-static linkage defined in this file should be
106 * declared in in_var.h:
111 * in_joingroup_locked()
113 * in_leavegroup_locked()
119 * XXX: Both carp and pf need to use the legacy (*,G) KPIs in_addmulti()
122 static void imf_commit(struct in_mfilter *);
123 static int imf_get_source(struct in_mfilter *imf,
124 const struct sockaddr_in *psin,
125 struct in_msource **);
126 static struct in_msource *
127 imf_graft(struct in_mfilter *, const uint8_t,
128 const struct sockaddr_in *);
129 static void imf_leave(struct in_mfilter *);
130 static int imf_prune(struct in_mfilter *, const struct sockaddr_in *);
131 static void imf_purge(struct in_mfilter *);
132 static void imf_rollback(struct in_mfilter *);
133 static void imf_reap(struct in_mfilter *);
134 static int imo_grow(struct ip_moptions *);
135 static size_t imo_match_group(const struct ip_moptions *,
136 const struct ifnet *, const struct sockaddr *);
137 static struct in_msource *
138 imo_match_source(const struct ip_moptions *, const size_t,
139 const struct sockaddr *);
140 static void ims_merge(struct ip_msource *ims,
141 const struct in_msource *lims, const int rollback);
142 static int in_getmulti(struct ifnet *, const struct in_addr *,
144 static int inm_get_source(struct in_multi *inm, const in_addr_t haddr,
145 const int noalloc, struct ip_msource **pims);
147 static int inm_is_ifp_detached(const struct in_multi *);
149 static int inm_merge(struct in_multi *, /*const*/ struct in_mfilter *);
150 static void inm_purge(struct in_multi *);
151 static void inm_reap(struct in_multi *);
152 static struct ip_moptions *
153 inp_findmoptions(struct inpcb *);
154 static void inp_freemoptions_internal(struct ip_moptions *);
155 static void inp_gcmoptions(void *, int);
156 static int inp_get_source_filters(struct inpcb *, struct sockopt *);
157 static int inp_join_group(struct inpcb *, struct sockopt *);
158 static int inp_leave_group(struct inpcb *, struct sockopt *);
159 static struct ifnet *
160 inp_lookup_mcast_ifp(const struct inpcb *,
161 const struct sockaddr_in *, const struct in_addr);
162 static int inp_block_unblock_source(struct inpcb *, struct sockopt *);
163 static int inp_set_multicast_if(struct inpcb *, struct sockopt *);
164 static int inp_set_source_filters(struct inpcb *, struct sockopt *);
165 static int sysctl_ip_mcast_filters(SYSCTL_HANDLER_ARGS);
167 static SYSCTL_NODE(_net_inet_ip, OID_AUTO, mcast, CTLFLAG_RW, 0,
170 static u_long in_mcast_maxgrpsrc = IP_MAX_GROUP_SRC_FILTER;
171 SYSCTL_ULONG(_net_inet_ip_mcast, OID_AUTO, maxgrpsrc,
172 CTLFLAG_RWTUN, &in_mcast_maxgrpsrc, 0,
173 "Max source filters per group");
175 static u_long in_mcast_maxsocksrc = IP_MAX_SOCK_SRC_FILTER;
176 SYSCTL_ULONG(_net_inet_ip_mcast, OID_AUTO, maxsocksrc,
177 CTLFLAG_RWTUN, &in_mcast_maxsocksrc, 0,
178 "Max source filters per socket");
180 int in_mcast_loop = IP_DEFAULT_MULTICAST_LOOP;
181 SYSCTL_INT(_net_inet_ip_mcast, OID_AUTO, loop, CTLFLAG_RWTUN,
182 &in_mcast_loop, 0, "Loopback multicast datagrams by default");
184 static SYSCTL_NODE(_net_inet_ip_mcast, OID_AUTO, filters,
185 CTLFLAG_RD | CTLFLAG_MPSAFE, sysctl_ip_mcast_filters,
186 "Per-interface stack-wide source filters");
188 static STAILQ_HEAD(, ip_moptions) imo_gc_list =
189 STAILQ_HEAD_INITIALIZER(imo_gc_list);
190 static struct task imo_gc_task = TASK_INITIALIZER(0, inp_gcmoptions, NULL);
194 * Inline function which wraps assertions for a valid ifp.
195 * The ifnet layer will set the ifma's ifp pointer to NULL if the ifp
199 inm_is_ifp_detached(const struct in_multi *inm)
203 KASSERT(inm->inm_ifma != NULL, ("%s: no ifma", __func__));
204 ifp = inm->inm_ifma->ifma_ifp;
207 * Sanity check that netinet's notion of ifp is the
210 KASSERT(inm->inm_ifp == ifp, ("%s: bad ifp", __func__));
213 return (ifp == NULL);
218 * Initialize an in_mfilter structure to a known state at t0, t1
219 * with an empty source filter list.
222 imf_init(struct in_mfilter *imf, const int st0, const int st1)
224 memset(imf, 0, sizeof(struct in_mfilter));
225 RB_INIT(&imf->imf_sources);
226 imf->imf_st[0] = st0;
227 imf->imf_st[1] = st1;
231 * Function for looking up an in_multi record for an IPv4 multicast address
232 * on a given interface. ifp must be valid. If no record found, return NULL.
233 * The IN_MULTI_LOCK and IF_ADDR_LOCK on ifp must be held.
236 inm_lookup_locked(struct ifnet *ifp, const struct in_addr ina)
238 struct ifmultiaddr *ifma;
239 struct in_multi *inm;
241 IN_MULTI_LOCK_ASSERT();
242 IF_ADDR_LOCK_ASSERT(ifp);
245 TAILQ_FOREACH(ifma, &((ifp)->if_multiaddrs), ifma_link) {
246 if (ifma->ifma_addr->sa_family == AF_INET) {
247 inm = (struct in_multi *)ifma->ifma_protospec;
248 if (inm->inm_addr.s_addr == ina.s_addr)
257 * Wrapper for inm_lookup_locked().
258 * The IF_ADDR_LOCK will be taken on ifp and released on return.
261 inm_lookup(struct ifnet *ifp, const struct in_addr ina)
263 struct in_multi *inm;
265 IN_MULTI_LOCK_ASSERT();
267 inm = inm_lookup_locked(ifp, ina);
268 IF_ADDR_RUNLOCK(ifp);
274 * Resize the ip_moptions vector to the next power-of-two minus 1.
275 * May be called with locks held; do not sleep.
278 imo_grow(struct ip_moptions *imo)
280 struct in_multi **nmships;
281 struct in_multi **omships;
282 struct in_mfilter *nmfilters;
283 struct in_mfilter *omfilters;
290 omships = imo->imo_membership;
291 omfilters = imo->imo_mfilters;
292 oldmax = imo->imo_max_memberships;
293 newmax = ((oldmax + 1) * 2) - 1;
295 if (newmax <= IP_MAX_MEMBERSHIPS) {
296 nmships = (struct in_multi **)realloc(omships,
297 sizeof(struct in_multi *) * newmax, M_IPMOPTS, M_NOWAIT);
298 nmfilters = (struct in_mfilter *)realloc(omfilters,
299 sizeof(struct in_mfilter) * newmax, M_INMFILTER, M_NOWAIT);
300 if (nmships != NULL && nmfilters != NULL) {
301 /* Initialize newly allocated source filter heads. */
302 for (idx = oldmax; idx < newmax; idx++) {
303 imf_init(&nmfilters[idx], MCAST_UNDEFINED,
306 imo->imo_max_memberships = newmax;
307 imo->imo_membership = nmships;
308 imo->imo_mfilters = nmfilters;
312 if (nmships == NULL || nmfilters == NULL) {
314 free(nmships, M_IPMOPTS);
315 if (nmfilters != NULL)
316 free(nmfilters, M_INMFILTER);
317 return (ETOOMANYREFS);
324 * Find an IPv4 multicast group entry for this ip_moptions instance
325 * which matches the specified group, and optionally an interface.
326 * Return its index into the array, or -1 if not found.
329 imo_match_group(const struct ip_moptions *imo, const struct ifnet *ifp,
330 const struct sockaddr *group)
332 const struct sockaddr_in *gsin;
333 struct in_multi **pinm;
337 gsin = (const struct sockaddr_in *)group;
339 /* The imo_membership array may be lazy allocated. */
340 if (imo->imo_membership == NULL || imo->imo_num_memberships == 0)
343 nmships = imo->imo_num_memberships;
344 pinm = &imo->imo_membership[0];
345 for (idx = 0; idx < nmships; idx++, pinm++) {
348 if ((ifp == NULL || ((*pinm)->inm_ifp == ifp)) &&
349 in_hosteq((*pinm)->inm_addr, gsin->sin_addr)) {
360 * Find an IPv4 multicast source entry for this imo which matches
361 * the given group index for this socket, and source address.
363 * NOTE: This does not check if the entry is in-mode, merely if
364 * it exists, which may not be the desired behaviour.
366 static struct in_msource *
367 imo_match_source(const struct ip_moptions *imo, const size_t gidx,
368 const struct sockaddr *src)
370 struct ip_msource find;
371 struct in_mfilter *imf;
372 struct ip_msource *ims;
373 const sockunion_t *psa;
375 KASSERT(src->sa_family == AF_INET, ("%s: !AF_INET", __func__));
376 KASSERT(gidx != -1 && gidx < imo->imo_num_memberships,
377 ("%s: invalid index %d\n", __func__, (int)gidx));
379 /* The imo_mfilters array may be lazy allocated. */
380 if (imo->imo_mfilters == NULL)
382 imf = &imo->imo_mfilters[gidx];
384 /* Source trees are keyed in host byte order. */
385 psa = (const sockunion_t *)src;
386 find.ims_haddr = ntohl(psa->sin.sin_addr.s_addr);
387 ims = RB_FIND(ip_msource_tree, &imf->imf_sources, &find);
389 return ((struct in_msource *)ims);
393 * Perform filtering for multicast datagrams on a socket by group and source.
395 * Returns 0 if a datagram should be allowed through, or various error codes
396 * if the socket was not a member of the group, or the source was muted, etc.
399 imo_multi_filter(const struct ip_moptions *imo, const struct ifnet *ifp,
400 const struct sockaddr *group, const struct sockaddr *src)
403 struct in_msource *ims;
406 KASSERT(ifp != NULL, ("%s: null ifp", __func__));
408 gidx = imo_match_group(imo, ifp, group);
410 return (MCAST_NOTGMEMBER);
413 * Check if the source was included in an (S,G) join.
414 * Allow reception on exclusive memberships by default,
415 * reject reception on inclusive memberships by default.
416 * Exclude source only if an in-mode exclude filter exists.
417 * Include source only if an in-mode include filter exists.
418 * NOTE: We are comparing group state here at IGMP t1 (now)
419 * with socket-layer t0 (since last downcall).
421 mode = imo->imo_mfilters[gidx].imf_st[1];
422 ims = imo_match_source(imo, gidx, src);
424 if ((ims == NULL && mode == MCAST_INCLUDE) ||
425 (ims != NULL && ims->imsl_st[0] != mode))
426 return (MCAST_NOTSMEMBER);
432 * Find and return a reference to an in_multi record for (ifp, group),
433 * and bump its reference count.
434 * If one does not exist, try to allocate it, and update link-layer multicast
435 * filters on ifp to listen for group.
436 * Assumes the IN_MULTI lock is held across the call.
437 * Return 0 if successful, otherwise return an appropriate error code.
440 in_getmulti(struct ifnet *ifp, const struct in_addr *group,
441 struct in_multi **pinm)
443 struct sockaddr_in gsin;
444 struct ifmultiaddr *ifma;
445 struct in_ifinfo *ii;
446 struct in_multi *inm;
449 IN_MULTI_LOCK_ASSERT();
451 ii = (struct in_ifinfo *)ifp->if_afdata[AF_INET];
453 inm = inm_lookup(ifp, *group);
456 * If we already joined this group, just bump the
457 * refcount and return it.
459 KASSERT(inm->inm_refcount >= 1,
460 ("%s: bad refcount %d", __func__, inm->inm_refcount));
466 memset(&gsin, 0, sizeof(gsin));
467 gsin.sin_family = AF_INET;
468 gsin.sin_len = sizeof(struct sockaddr_in);
469 gsin.sin_addr = *group;
472 * Check if a link-layer group is already associated
473 * with this network-layer group on the given ifnet.
475 error = if_addmulti(ifp, (struct sockaddr *)&gsin, &ifma);
479 /* XXX ifma_protospec must be covered by IF_ADDR_LOCK */
483 * If something other than netinet is occupying the link-layer
484 * group, print a meaningful error message and back out of
486 * Otherwise, bump the refcount on the existing network-layer
487 * group association and return it.
489 if (ifma->ifma_protospec != NULL) {
490 inm = (struct in_multi *)ifma->ifma_protospec;
492 KASSERT(ifma->ifma_addr != NULL, ("%s: no ifma_addr",
494 KASSERT(ifma->ifma_addr->sa_family == AF_INET,
495 ("%s: ifma not AF_INET", __func__));
496 KASSERT(inm != NULL, ("%s: no ifma_protospec", __func__));
497 if (inm->inm_ifma != ifma || inm->inm_ifp != ifp ||
498 !in_hosteq(inm->inm_addr, *group)) {
499 char addrbuf[INET_ADDRSTRLEN];
501 panic("%s: ifma %p is inconsistent with %p (%s)",
502 __func__, ifma, inm, inet_ntoa_r(*group, addrbuf));
507 IF_ADDR_WUNLOCK(ifp);
511 IF_ADDR_WLOCK_ASSERT(ifp);
514 * A new in_multi record is needed; allocate and initialize it.
515 * We DO NOT perform an IGMP join as the in_ layer may need to
516 * push an initial source list down to IGMP to support SSM.
518 * The initial source filter state is INCLUDE, {} as per the RFC.
520 inm = malloc(sizeof(*inm), M_IPMADDR, M_NOWAIT | M_ZERO);
522 IF_ADDR_WUNLOCK(ifp);
523 if_delmulti_ifma(ifma);
526 inm->inm_addr = *group;
528 inm->inm_igi = ii->ii_igmp;
529 inm->inm_ifma = ifma;
530 inm->inm_refcount = 1;
531 inm->inm_state = IGMP_NOT_MEMBER;
532 mbufq_init(&inm->inm_scq, IGMP_MAX_STATE_CHANGES);
533 inm->inm_st[0].iss_fmode = MCAST_UNDEFINED;
534 inm->inm_st[1].iss_fmode = MCAST_UNDEFINED;
535 RB_INIT(&inm->inm_srcs);
537 ifma->ifma_protospec = inm;
541 IF_ADDR_WUNLOCK(ifp);
546 * Drop a reference to an in_multi record.
548 * If the refcount drops to 0, free the in_multi record and
549 * delete the underlying link-layer membership.
552 inm_release_locked(struct in_multi *inm)
554 struct ifmultiaddr *ifma;
556 IN_MULTI_LOCK_ASSERT();
558 CTR2(KTR_IGMPV3, "%s: refcount is %d", __func__, inm->inm_refcount);
560 if (--inm->inm_refcount > 0) {
561 CTR2(KTR_IGMPV3, "%s: refcount is now %d", __func__,
566 CTR2(KTR_IGMPV3, "%s: freeing inm %p", __func__, inm);
568 ifma = inm->inm_ifma;
570 /* XXX this access is not covered by IF_ADDR_LOCK */
571 CTR2(KTR_IGMPV3, "%s: purging ifma %p", __func__, ifma);
572 KASSERT(ifma->ifma_protospec == inm,
573 ("%s: ifma_protospec != inm", __func__));
574 ifma->ifma_protospec = NULL;
578 free(inm, M_IPMADDR);
580 if_delmulti_ifma(ifma);
584 * Clear recorded source entries for a group.
585 * Used by the IGMP code. Caller must hold the IN_MULTI lock.
586 * FIXME: Should reap.
589 inm_clear_recorded(struct in_multi *inm)
591 struct ip_msource *ims;
593 IN_MULTI_LOCK_ASSERT();
595 RB_FOREACH(ims, ip_msource_tree, &inm->inm_srcs) {
598 --inm->inm_st[1].iss_rec;
601 KASSERT(inm->inm_st[1].iss_rec == 0,
602 ("%s: iss_rec %d not 0", __func__, inm->inm_st[1].iss_rec));
606 * Record a source as pending for a Source-Group IGMPv3 query.
607 * This lives here as it modifies the shared tree.
609 * inm is the group descriptor.
610 * naddr is the address of the source to record in network-byte order.
612 * If the net.inet.igmp.sgalloc sysctl is non-zero, we will
613 * lazy-allocate a source node in response to an SG query.
614 * Otherwise, no allocation is performed. This saves some memory
615 * with the trade-off that the source will not be reported to the
616 * router if joined in the window between the query response and
617 * the group actually being joined on the local host.
619 * VIMAGE: XXX: Currently the igmp_sgalloc feature has been removed.
620 * This turns off the allocation of a recorded source entry if
621 * the group has not been joined.
623 * Return 0 if the source didn't exist or was already marked as recorded.
624 * Return 1 if the source was marked as recorded by this function.
625 * Return <0 if any error occurred (negated errno code).
628 inm_record_source(struct in_multi *inm, const in_addr_t naddr)
630 struct ip_msource find;
631 struct ip_msource *ims, *nims;
633 IN_MULTI_LOCK_ASSERT();
635 find.ims_haddr = ntohl(naddr);
636 ims = RB_FIND(ip_msource_tree, &inm->inm_srcs, &find);
637 if (ims && ims->ims_stp)
640 if (inm->inm_nsrc == in_mcast_maxgrpsrc)
642 nims = malloc(sizeof(struct ip_msource), M_IPMSOURCE,
646 nims->ims_haddr = find.ims_haddr;
647 RB_INSERT(ip_msource_tree, &inm->inm_srcs, nims);
653 * Mark the source as recorded and update the recorded
657 ++inm->inm_st[1].iss_rec;
663 * Return a pointer to an in_msource owned by an in_mfilter,
664 * given its source address.
665 * Lazy-allocate if needed. If this is a new entry its filter state is
668 * imf is the filter set being modified.
669 * haddr is the source address in *host* byte-order.
671 * SMPng: May be called with locks held; malloc must not block.
674 imf_get_source(struct in_mfilter *imf, const struct sockaddr_in *psin,
675 struct in_msource **plims)
677 struct ip_msource find;
678 struct ip_msource *ims, *nims;
679 struct in_msource *lims;
686 /* key is host byte order */
687 find.ims_haddr = ntohl(psin->sin_addr.s_addr);
688 ims = RB_FIND(ip_msource_tree, &imf->imf_sources, &find);
689 lims = (struct in_msource *)ims;
691 if (imf->imf_nsrc == in_mcast_maxsocksrc)
693 nims = malloc(sizeof(struct in_msource), M_INMFILTER,
697 lims = (struct in_msource *)nims;
698 lims->ims_haddr = find.ims_haddr;
699 lims->imsl_st[0] = MCAST_UNDEFINED;
700 RB_INSERT(ip_msource_tree, &imf->imf_sources, nims);
710 * Graft a source entry into an existing socket-layer filter set,
711 * maintaining any required invariants and checking allocations.
713 * The source is marked as being in the new filter mode at t1.
715 * Return the pointer to the new node, otherwise return NULL.
717 static struct in_msource *
718 imf_graft(struct in_mfilter *imf, const uint8_t st1,
719 const struct sockaddr_in *psin)
721 struct ip_msource *nims;
722 struct in_msource *lims;
724 nims = malloc(sizeof(struct in_msource), M_INMFILTER,
728 lims = (struct in_msource *)nims;
729 lims->ims_haddr = ntohl(psin->sin_addr.s_addr);
730 lims->imsl_st[0] = MCAST_UNDEFINED;
731 lims->imsl_st[1] = st1;
732 RB_INSERT(ip_msource_tree, &imf->imf_sources, nims);
739 * Prune a source entry from an existing socket-layer filter set,
740 * maintaining any required invariants and checking allocations.
742 * The source is marked as being left at t1, it is not freed.
744 * Return 0 if no error occurred, otherwise return an errno value.
747 imf_prune(struct in_mfilter *imf, const struct sockaddr_in *psin)
749 struct ip_msource find;
750 struct ip_msource *ims;
751 struct in_msource *lims;
753 /* key is host byte order */
754 find.ims_haddr = ntohl(psin->sin_addr.s_addr);
755 ims = RB_FIND(ip_msource_tree, &imf->imf_sources, &find);
758 lims = (struct in_msource *)ims;
759 lims->imsl_st[1] = MCAST_UNDEFINED;
764 * Revert socket-layer filter set deltas at t1 to t0 state.
767 imf_rollback(struct in_mfilter *imf)
769 struct ip_msource *ims, *tims;
770 struct in_msource *lims;
772 RB_FOREACH_SAFE(ims, ip_msource_tree, &imf->imf_sources, tims) {
773 lims = (struct in_msource *)ims;
774 if (lims->imsl_st[0] == lims->imsl_st[1]) {
775 /* no change at t1 */
777 } else if (lims->imsl_st[0] != MCAST_UNDEFINED) {
778 /* revert change to existing source at t1 */
779 lims->imsl_st[1] = lims->imsl_st[0];
781 /* revert source added t1 */
782 CTR2(KTR_IGMPV3, "%s: free ims %p", __func__, ims);
783 RB_REMOVE(ip_msource_tree, &imf->imf_sources, ims);
784 free(ims, M_INMFILTER);
788 imf->imf_st[1] = imf->imf_st[0];
792 * Mark socket-layer filter set as INCLUDE {} at t1.
795 imf_leave(struct in_mfilter *imf)
797 struct ip_msource *ims;
798 struct in_msource *lims;
800 RB_FOREACH(ims, ip_msource_tree, &imf->imf_sources) {
801 lims = (struct in_msource *)ims;
802 lims->imsl_st[1] = MCAST_UNDEFINED;
804 imf->imf_st[1] = MCAST_INCLUDE;
808 * Mark socket-layer filter set deltas as committed.
811 imf_commit(struct in_mfilter *imf)
813 struct ip_msource *ims;
814 struct in_msource *lims;
816 RB_FOREACH(ims, ip_msource_tree, &imf->imf_sources) {
817 lims = (struct in_msource *)ims;
818 lims->imsl_st[0] = lims->imsl_st[1];
820 imf->imf_st[0] = imf->imf_st[1];
824 * Reap unreferenced sources from socket-layer filter set.
827 imf_reap(struct in_mfilter *imf)
829 struct ip_msource *ims, *tims;
830 struct in_msource *lims;
832 RB_FOREACH_SAFE(ims, ip_msource_tree, &imf->imf_sources, tims) {
833 lims = (struct in_msource *)ims;
834 if ((lims->imsl_st[0] == MCAST_UNDEFINED) &&
835 (lims->imsl_st[1] == MCAST_UNDEFINED)) {
836 CTR2(KTR_IGMPV3, "%s: free lims %p", __func__, ims);
837 RB_REMOVE(ip_msource_tree, &imf->imf_sources, ims);
838 free(ims, M_INMFILTER);
845 * Purge socket-layer filter set.
848 imf_purge(struct in_mfilter *imf)
850 struct ip_msource *ims, *tims;
852 RB_FOREACH_SAFE(ims, ip_msource_tree, &imf->imf_sources, tims) {
853 CTR2(KTR_IGMPV3, "%s: free ims %p", __func__, ims);
854 RB_REMOVE(ip_msource_tree, &imf->imf_sources, ims);
855 free(ims, M_INMFILTER);
858 imf->imf_st[0] = imf->imf_st[1] = MCAST_UNDEFINED;
859 KASSERT(RB_EMPTY(&imf->imf_sources),
860 ("%s: imf_sources not empty", __func__));
864 * Look up a source filter entry for a multicast group.
866 * inm is the group descriptor to work with.
867 * haddr is the host-byte-order IPv4 address to look up.
868 * noalloc may be non-zero to suppress allocation of sources.
869 * *pims will be set to the address of the retrieved or allocated source.
871 * SMPng: NOTE: may be called with locks held.
872 * Return 0 if successful, otherwise return a non-zero error code.
875 inm_get_source(struct in_multi *inm, const in_addr_t haddr,
876 const int noalloc, struct ip_msource **pims)
878 struct ip_msource find;
879 struct ip_msource *ims, *nims;
881 find.ims_haddr = haddr;
882 ims = RB_FIND(ip_msource_tree, &inm->inm_srcs, &find);
883 if (ims == NULL && !noalloc) {
884 if (inm->inm_nsrc == in_mcast_maxgrpsrc)
886 nims = malloc(sizeof(struct ip_msource), M_IPMSOURCE,
890 nims->ims_haddr = haddr;
891 RB_INSERT(ip_msource_tree, &inm->inm_srcs, nims);
895 CTR3(KTR_IGMPV3, "%s: allocated 0x%08x as %p", __func__,
905 * Merge socket-layer source into IGMP-layer source.
906 * If rollback is non-zero, perform the inverse of the merge.
909 ims_merge(struct ip_msource *ims, const struct in_msource *lims,
912 int n = rollback ? -1 : 1;
914 if (lims->imsl_st[0] == MCAST_EXCLUDE) {
915 CTR3(KTR_IGMPV3, "%s: t1 ex -= %d on 0x%08x",
916 __func__, n, ims->ims_haddr);
917 ims->ims_st[1].ex -= n;
918 } else if (lims->imsl_st[0] == MCAST_INCLUDE) {
919 CTR3(KTR_IGMPV3, "%s: t1 in -= %d on 0x%08x",
920 __func__, n, ims->ims_haddr);
921 ims->ims_st[1].in -= n;
924 if (lims->imsl_st[1] == MCAST_EXCLUDE) {
925 CTR3(KTR_IGMPV3, "%s: t1 ex += %d on 0x%08x",
926 __func__, n, ims->ims_haddr);
927 ims->ims_st[1].ex += n;
928 } else if (lims->imsl_st[1] == MCAST_INCLUDE) {
929 CTR3(KTR_IGMPV3, "%s: t1 in += %d on 0x%08x",
930 __func__, n, ims->ims_haddr);
931 ims->ims_st[1].in += n;
936 * Atomically update the global in_multi state, when a membership's
937 * filter list is being updated in any way.
939 * imf is the per-inpcb-membership group filter pointer.
940 * A fake imf may be passed for in-kernel consumers.
942 * XXX This is a candidate for a set-symmetric-difference style loop
943 * which would eliminate the repeated lookup from root of ims nodes,
944 * as they share the same key space.
946 * If any error occurred this function will back out of refcounts
947 * and return a non-zero value.
950 inm_merge(struct in_multi *inm, /*const*/ struct in_mfilter *imf)
952 struct ip_msource *ims, *nims;
953 struct in_msource *lims;
962 * Update the source filters first, as this may fail.
963 * Maintain count of in-mode filters at t0, t1. These are
964 * used to work out if we transition into ASM mode or not.
965 * Maintain a count of source filters whose state was
966 * actually modified by this operation.
968 RB_FOREACH(ims, ip_msource_tree, &imf->imf_sources) {
969 lims = (struct in_msource *)ims;
970 if (lims->imsl_st[0] == imf->imf_st[0]) nsrc0++;
971 if (lims->imsl_st[1] == imf->imf_st[1]) nsrc1++;
972 if (lims->imsl_st[0] == lims->imsl_st[1]) continue;
973 error = inm_get_source(inm, lims->ims_haddr, 0, &nims);
977 ims_merge(nims, lims, 0);
980 struct ip_msource *bims;
982 RB_FOREACH_REVERSE_FROM(ims, ip_msource_tree, nims) {
983 lims = (struct in_msource *)ims;
984 if (lims->imsl_st[0] == lims->imsl_st[1])
986 (void)inm_get_source(inm, lims->ims_haddr, 1, &bims);
989 ims_merge(bims, lims, 1);
994 CTR3(KTR_IGMPV3, "%s: imf filters in-mode: %d at t0, %d at t1",
995 __func__, nsrc0, nsrc1);
997 /* Handle transition between INCLUDE {n} and INCLUDE {} on socket. */
998 if (imf->imf_st[0] == imf->imf_st[1] &&
999 imf->imf_st[1] == MCAST_INCLUDE) {
1001 CTR1(KTR_IGMPV3, "%s: --in on inm at t1", __func__);
1002 --inm->inm_st[1].iss_in;
1006 /* Handle filter mode transition on socket. */
1007 if (imf->imf_st[0] != imf->imf_st[1]) {
1008 CTR3(KTR_IGMPV3, "%s: imf transition %d to %d",
1009 __func__, imf->imf_st[0], imf->imf_st[1]);
1011 if (imf->imf_st[0] == MCAST_EXCLUDE) {
1012 CTR1(KTR_IGMPV3, "%s: --ex on inm at t1", __func__);
1013 --inm->inm_st[1].iss_ex;
1014 } else if (imf->imf_st[0] == MCAST_INCLUDE) {
1015 CTR1(KTR_IGMPV3, "%s: --in on inm at t1", __func__);
1016 --inm->inm_st[1].iss_in;
1019 if (imf->imf_st[1] == MCAST_EXCLUDE) {
1020 CTR1(KTR_IGMPV3, "%s: ex++ on inm at t1", __func__);
1021 inm->inm_st[1].iss_ex++;
1022 } else if (imf->imf_st[1] == MCAST_INCLUDE && nsrc1 > 0) {
1023 CTR1(KTR_IGMPV3, "%s: in++ on inm at t1", __func__);
1024 inm->inm_st[1].iss_in++;
1029 * Track inm filter state in terms of listener counts.
1030 * If there are any exclusive listeners, stack-wide
1031 * membership is exclusive.
1032 * Otherwise, if only inclusive listeners, stack-wide is inclusive.
1033 * If no listeners remain, state is undefined at t1,
1034 * and the IGMP lifecycle for this group should finish.
1036 if (inm->inm_st[1].iss_ex > 0) {
1037 CTR1(KTR_IGMPV3, "%s: transition to EX", __func__);
1038 inm->inm_st[1].iss_fmode = MCAST_EXCLUDE;
1039 } else if (inm->inm_st[1].iss_in > 0) {
1040 CTR1(KTR_IGMPV3, "%s: transition to IN", __func__);
1041 inm->inm_st[1].iss_fmode = MCAST_INCLUDE;
1043 CTR1(KTR_IGMPV3, "%s: transition to UNDEF", __func__);
1044 inm->inm_st[1].iss_fmode = MCAST_UNDEFINED;
1047 /* Decrement ASM listener count on transition out of ASM mode. */
1048 if (imf->imf_st[0] == MCAST_EXCLUDE && nsrc0 == 0) {
1049 if ((imf->imf_st[1] != MCAST_EXCLUDE) ||
1050 (imf->imf_st[1] == MCAST_EXCLUDE && nsrc1 > 0)) {
1051 CTR1(KTR_IGMPV3, "%s: --asm on inm at t1", __func__);
1052 --inm->inm_st[1].iss_asm;
1056 /* Increment ASM listener count on transition to ASM mode. */
1057 if (imf->imf_st[1] == MCAST_EXCLUDE && nsrc1 == 0) {
1058 CTR1(KTR_IGMPV3, "%s: asm++ on inm at t1", __func__);
1059 inm->inm_st[1].iss_asm++;
1062 CTR3(KTR_IGMPV3, "%s: merged imf %p to inm %p", __func__, imf, inm);
1067 CTR1(KTR_IGMPV3, "%s: sources changed; reaping", __func__);
1074 * Mark an in_multi's filter set deltas as committed.
1075 * Called by IGMP after a state change has been enqueued.
1078 inm_commit(struct in_multi *inm)
1080 struct ip_msource *ims;
1082 CTR2(KTR_IGMPV3, "%s: commit inm %p", __func__, inm);
1083 CTR1(KTR_IGMPV3, "%s: pre commit:", __func__);
1086 RB_FOREACH(ims, ip_msource_tree, &inm->inm_srcs) {
1087 ims->ims_st[0] = ims->ims_st[1];
1089 inm->inm_st[0] = inm->inm_st[1];
1093 * Reap unreferenced nodes from an in_multi's filter set.
1096 inm_reap(struct in_multi *inm)
1098 struct ip_msource *ims, *tims;
1100 RB_FOREACH_SAFE(ims, ip_msource_tree, &inm->inm_srcs, tims) {
1101 if (ims->ims_st[0].ex > 0 || ims->ims_st[0].in > 0 ||
1102 ims->ims_st[1].ex > 0 || ims->ims_st[1].in > 0 ||
1105 CTR2(KTR_IGMPV3, "%s: free ims %p", __func__, ims);
1106 RB_REMOVE(ip_msource_tree, &inm->inm_srcs, ims);
1107 free(ims, M_IPMSOURCE);
1113 * Purge all source nodes from an in_multi's filter set.
1116 inm_purge(struct in_multi *inm)
1118 struct ip_msource *ims, *tims;
1120 RB_FOREACH_SAFE(ims, ip_msource_tree, &inm->inm_srcs, tims) {
1121 CTR2(KTR_IGMPV3, "%s: free ims %p", __func__, ims);
1122 RB_REMOVE(ip_msource_tree, &inm->inm_srcs, ims);
1123 free(ims, M_IPMSOURCE);
1129 * Join a multicast group; unlocked entry point.
1131 * SMPng: XXX: in_joingroup() is called from in_control() when Giant
1132 * is not held. Fortunately, ifp is unlikely to have been detached
1133 * at this point, so we assume it's OK to recurse.
1136 in_joingroup(struct ifnet *ifp, const struct in_addr *gina,
1137 /*const*/ struct in_mfilter *imf, struct in_multi **pinm)
1142 error = in_joingroup_locked(ifp, gina, imf, pinm);
1149 * Join a multicast group; real entry point.
1151 * Only preserves atomicity at inm level.
1152 * NOTE: imf argument cannot be const due to sys/tree.h limitations.
1154 * If the IGMP downcall fails, the group is not joined, and an error
1158 in_joingroup_locked(struct ifnet *ifp, const struct in_addr *gina,
1159 /*const*/ struct in_mfilter *imf, struct in_multi **pinm)
1161 struct in_mfilter timf;
1162 struct in_multi *inm;
1165 IN_MULTI_LOCK_ASSERT();
1167 CTR4(KTR_IGMPV3, "%s: join 0x%08x on %p(%s))", __func__,
1168 ntohl(gina->s_addr), ifp, ifp->if_xname);
1174 * If no imf was specified (i.e. kernel consumer),
1175 * fake one up and assume it is an ASM join.
1178 imf_init(&timf, MCAST_UNDEFINED, MCAST_EXCLUDE);
1182 error = in_getmulti(ifp, gina, &inm);
1184 CTR1(KTR_IGMPV3, "%s: in_getmulti() failure", __func__);
1188 CTR1(KTR_IGMPV3, "%s: merge inm state", __func__);
1189 error = inm_merge(inm, imf);
1191 CTR1(KTR_IGMPV3, "%s: failed to merge inm state", __func__);
1192 goto out_inm_release;
1195 CTR1(KTR_IGMPV3, "%s: doing igmp downcall", __func__);
1196 error = igmp_change_state(inm);
1198 CTR1(KTR_IGMPV3, "%s: failed to update source", __func__);
1199 goto out_inm_release;
1204 CTR2(KTR_IGMPV3, "%s: dropping ref on %p", __func__, inm);
1205 inm_release_locked(inm);
1214 * Leave a multicast group; unlocked entry point.
1217 in_leavegroup(struct in_multi *inm, /*const*/ struct in_mfilter *imf)
1222 error = in_leavegroup_locked(inm, imf);
1229 * Leave a multicast group; real entry point.
1230 * All source filters will be expunged.
1232 * Only preserves atomicity at inm level.
1234 * Holding the write lock for the INP which contains imf
1235 * is highly advisable. We can't assert for it as imf does not
1236 * contain a back-pointer to the owning inp.
1238 * Note: This is not the same as inm_release(*) as this function also
1239 * makes a state change downcall into IGMP.
1242 in_leavegroup_locked(struct in_multi *inm, /*const*/ struct in_mfilter *imf)
1244 struct in_mfilter timf;
1249 IN_MULTI_LOCK_ASSERT();
1251 CTR5(KTR_IGMPV3, "%s: leave inm %p, 0x%08x/%s, imf %p", __func__,
1252 inm, ntohl(inm->inm_addr.s_addr),
1253 (inm_is_ifp_detached(inm) ? "null" : inm->inm_ifp->if_xname),
1257 * If no imf was specified (i.e. kernel consumer),
1258 * fake one up and assume it is an ASM join.
1261 imf_init(&timf, MCAST_EXCLUDE, MCAST_UNDEFINED);
1266 * Begin state merge transaction at IGMP layer.
1268 * As this particular invocation should not cause any memory
1269 * to be allocated, and there is no opportunity to roll back
1270 * the transaction, it MUST NOT fail.
1272 CTR1(KTR_IGMPV3, "%s: merge inm state", __func__);
1273 error = inm_merge(inm, imf);
1274 KASSERT(error == 0, ("%s: failed to merge inm state", __func__));
1276 CTR1(KTR_IGMPV3, "%s: doing igmp downcall", __func__);
1277 CURVNET_SET(inm->inm_ifp->if_vnet);
1278 error = igmp_change_state(inm);
1281 CTR1(KTR_IGMPV3, "%s: failed igmp downcall", __func__);
1283 CTR2(KTR_IGMPV3, "%s: dropping ref on %p", __func__, inm);
1284 inm_release_locked(inm);
1289 /*#ifndef BURN_BRIDGES*/
1291 * Join an IPv4 multicast group in (*,G) exclusive mode.
1292 * The group must be a 224.0.0.0/24 link-scope group.
1293 * This KPI is for legacy kernel consumers only.
1296 in_addmulti(struct in_addr *ap, struct ifnet *ifp)
1298 struct in_multi *pinm;
1301 char addrbuf[INET_ADDRSTRLEN];
1304 KASSERT(IN_LOCAL_GROUP(ntohl(ap->s_addr)),
1305 ("%s: %s not in 224.0.0.0/24", __func__,
1306 inet_ntoa_r(*ap, addrbuf)));
1308 error = in_joingroup(ifp, ap, NULL, &pinm);
1316 * Leave an IPv4 multicast group, assumed to be in exclusive (*,G) mode.
1317 * This KPI is for legacy kernel consumers only.
1320 in_delmulti(struct in_multi *inm)
1323 (void)in_leavegroup(inm, NULL);
1328 * Block or unblock an ASM multicast source on an inpcb.
1329 * This implements the delta-based API described in RFC 3678.
1331 * The delta-based API applies only to exclusive-mode memberships.
1332 * An IGMP downcall will be performed.
1334 * SMPng: NOTE: Must take Giant as a join may create a new ifma.
1336 * Return 0 if successful, otherwise return an appropriate error code.
1339 inp_block_unblock_source(struct inpcb *inp, struct sockopt *sopt)
1341 struct group_source_req gsr;
1342 struct rm_priotracker in_ifa_tracker;
1343 sockunion_t *gsa, *ssa;
1345 struct in_mfilter *imf;
1346 struct ip_moptions *imo;
1347 struct in_msource *ims;
1348 struct in_multi *inm;
1357 memset(&gsr, 0, sizeof(struct group_source_req));
1358 gsa = (sockunion_t *)&gsr.gsr_group;
1359 ssa = (sockunion_t *)&gsr.gsr_source;
1361 switch (sopt->sopt_name) {
1362 case IP_BLOCK_SOURCE:
1363 case IP_UNBLOCK_SOURCE: {
1364 struct ip_mreq_source mreqs;
1366 error = sooptcopyin(sopt, &mreqs,
1367 sizeof(struct ip_mreq_source),
1368 sizeof(struct ip_mreq_source));
1372 gsa->sin.sin_family = AF_INET;
1373 gsa->sin.sin_len = sizeof(struct sockaddr_in);
1374 gsa->sin.sin_addr = mreqs.imr_multiaddr;
1376 ssa->sin.sin_family = AF_INET;
1377 ssa->sin.sin_len = sizeof(struct sockaddr_in);
1378 ssa->sin.sin_addr = mreqs.imr_sourceaddr;
1380 if (!in_nullhost(mreqs.imr_interface)) {
1381 IN_IFADDR_RLOCK(&in_ifa_tracker);
1382 INADDR_TO_IFP(mreqs.imr_interface, ifp);
1383 IN_IFADDR_RUNLOCK(&in_ifa_tracker);
1385 if (sopt->sopt_name == IP_BLOCK_SOURCE)
1388 CTR3(KTR_IGMPV3, "%s: imr_interface = 0x%08x, ifp = %p",
1389 __func__, ntohl(mreqs.imr_interface.s_addr), ifp);
1393 case MCAST_BLOCK_SOURCE:
1394 case MCAST_UNBLOCK_SOURCE:
1395 error = sooptcopyin(sopt, &gsr,
1396 sizeof(struct group_source_req),
1397 sizeof(struct group_source_req));
1401 if (gsa->sin.sin_family != AF_INET ||
1402 gsa->sin.sin_len != sizeof(struct sockaddr_in))
1405 if (ssa->sin.sin_family != AF_INET ||
1406 ssa->sin.sin_len != sizeof(struct sockaddr_in))
1409 if (gsr.gsr_interface == 0 || V_if_index < gsr.gsr_interface)
1410 return (EADDRNOTAVAIL);
1412 ifp = ifnet_byindex(gsr.gsr_interface);
1414 if (sopt->sopt_name == MCAST_BLOCK_SOURCE)
1419 CTR2(KTR_IGMPV3, "%s: unknown sopt_name %d",
1420 __func__, sopt->sopt_name);
1421 return (EOPNOTSUPP);
1425 if (!IN_MULTICAST(ntohl(gsa->sin.sin_addr.s_addr)))
1429 * Check if we are actually a member of this group.
1431 imo = inp_findmoptions(inp);
1432 idx = imo_match_group(imo, ifp, &gsa->sa);
1433 if (idx == -1 || imo->imo_mfilters == NULL) {
1434 error = EADDRNOTAVAIL;
1435 goto out_inp_locked;
1438 KASSERT(imo->imo_mfilters != NULL,
1439 ("%s: imo_mfilters not allocated", __func__));
1440 imf = &imo->imo_mfilters[idx];
1441 inm = imo->imo_membership[idx];
1444 * Attempting to use the delta-based API on an
1445 * non exclusive-mode membership is an error.
1447 fmode = imf->imf_st[0];
1448 if (fmode != MCAST_EXCLUDE) {
1450 goto out_inp_locked;
1454 * Deal with error cases up-front:
1455 * Asked to block, but already blocked; or
1456 * Asked to unblock, but nothing to unblock.
1457 * If adding a new block entry, allocate it.
1459 ims = imo_match_source(imo, idx, &ssa->sa);
1460 if ((ims != NULL && doblock) || (ims == NULL && !doblock)) {
1461 CTR3(KTR_IGMPV3, "%s: source 0x%08x %spresent", __func__,
1462 ntohl(ssa->sin.sin_addr.s_addr), doblock ? "" : "not ");
1463 error = EADDRNOTAVAIL;
1464 goto out_inp_locked;
1467 INP_WLOCK_ASSERT(inp);
1470 * Begin state merge transaction at socket layer.
1473 CTR2(KTR_IGMPV3, "%s: %s source", __func__, "block");
1474 ims = imf_graft(imf, fmode, &ssa->sin);
1478 CTR2(KTR_IGMPV3, "%s: %s source", __func__, "allow");
1479 error = imf_prune(imf, &ssa->sin);
1483 CTR1(KTR_IGMPV3, "%s: merge imf state failed", __func__);
1484 goto out_imf_rollback;
1488 * Begin state merge transaction at IGMP layer.
1492 CTR1(KTR_IGMPV3, "%s: merge inm state", __func__);
1493 error = inm_merge(inm, imf);
1495 CTR1(KTR_IGMPV3, "%s: failed to merge inm state", __func__);
1496 goto out_in_multi_locked;
1499 CTR1(KTR_IGMPV3, "%s: doing igmp downcall", __func__);
1500 error = igmp_change_state(inm);
1502 CTR1(KTR_IGMPV3, "%s: failed igmp downcall", __func__);
1504 out_in_multi_locked:
1522 * Given an inpcb, return its multicast options structure pointer. Accepts
1523 * an unlocked inpcb pointer, but will return it locked. May sleep.
1525 * SMPng: NOTE: Potentially calls malloc(M_WAITOK) with Giant held.
1526 * SMPng: NOTE: Returns with the INP write lock held.
1528 static struct ip_moptions *
1529 inp_findmoptions(struct inpcb *inp)
1531 struct ip_moptions *imo;
1532 struct in_multi **immp;
1533 struct in_mfilter *imfp;
1537 if (inp->inp_moptions != NULL)
1538 return (inp->inp_moptions);
1542 imo = malloc(sizeof(*imo), M_IPMOPTS, M_WAITOK);
1543 immp = malloc(sizeof(*immp) * IP_MIN_MEMBERSHIPS, M_IPMOPTS,
1545 imfp = malloc(sizeof(struct in_mfilter) * IP_MIN_MEMBERSHIPS,
1546 M_INMFILTER, M_WAITOK);
1548 imo->imo_multicast_ifp = NULL;
1549 imo->imo_multicast_addr.s_addr = INADDR_ANY;
1550 imo->imo_multicast_vif = -1;
1551 imo->imo_multicast_ttl = IP_DEFAULT_MULTICAST_TTL;
1552 imo->imo_multicast_loop = in_mcast_loop;
1553 imo->imo_num_memberships = 0;
1554 imo->imo_max_memberships = IP_MIN_MEMBERSHIPS;
1555 imo->imo_membership = immp;
1557 /* Initialize per-group source filters. */
1558 for (idx = 0; idx < IP_MIN_MEMBERSHIPS; idx++)
1559 imf_init(&imfp[idx], MCAST_UNDEFINED, MCAST_EXCLUDE);
1560 imo->imo_mfilters = imfp;
1563 if (inp->inp_moptions != NULL) {
1564 free(imfp, M_INMFILTER);
1565 free(immp, M_IPMOPTS);
1566 free(imo, M_IPMOPTS);
1567 return (inp->inp_moptions);
1569 inp->inp_moptions = imo;
1574 * Discard the IP multicast options (and source filters). To minimize
1575 * the amount of work done while holding locks such as the INP's
1576 * pcbinfo lock (which is used in the receive path), the free
1577 * operation is performed asynchronously in a separate task.
1579 * SMPng: NOTE: assumes INP write lock is held.
1582 inp_freemoptions(struct ip_moptions *imo)
1585 KASSERT(imo != NULL, ("%s: ip_moptions is NULL", __func__));
1587 STAILQ_INSERT_TAIL(&imo_gc_list, imo, imo_link);
1589 taskqueue_enqueue(taskqueue_thread, &imo_gc_task);
1593 inp_freemoptions_internal(struct ip_moptions *imo)
1595 struct in_mfilter *imf;
1596 size_t idx, nmships;
1598 nmships = imo->imo_num_memberships;
1599 for (idx = 0; idx < nmships; ++idx) {
1600 imf = imo->imo_mfilters ? &imo->imo_mfilters[idx] : NULL;
1603 (void)in_leavegroup(imo->imo_membership[idx], imf);
1608 if (imo->imo_mfilters)
1609 free(imo->imo_mfilters, M_INMFILTER);
1610 free(imo->imo_membership, M_IPMOPTS);
1611 free(imo, M_IPMOPTS);
1615 inp_gcmoptions(void *context, int pending)
1617 struct ip_moptions *imo;
1620 while (!STAILQ_EMPTY(&imo_gc_list)) {
1621 imo = STAILQ_FIRST(&imo_gc_list);
1622 STAILQ_REMOVE_HEAD(&imo_gc_list, imo_link);
1624 inp_freemoptions_internal(imo);
1631 * Atomically get source filters on a socket for an IPv4 multicast group.
1632 * Called with INP lock held; returns with lock released.
1635 inp_get_source_filters(struct inpcb *inp, struct sockopt *sopt)
1637 struct __msfilterreq msfr;
1640 struct ip_moptions *imo;
1641 struct in_mfilter *imf;
1642 struct ip_msource *ims;
1643 struct in_msource *lims;
1644 struct sockaddr_in *psin;
1645 struct sockaddr_storage *ptss;
1646 struct sockaddr_storage *tss;
1648 size_t idx, nsrcs, ncsrcs;
1650 INP_WLOCK_ASSERT(inp);
1652 imo = inp->inp_moptions;
1653 KASSERT(imo != NULL, ("%s: null ip_moptions", __func__));
1657 error = sooptcopyin(sopt, &msfr, sizeof(struct __msfilterreq),
1658 sizeof(struct __msfilterreq));
1662 if (msfr.msfr_ifindex == 0 || V_if_index < msfr.msfr_ifindex)
1665 ifp = ifnet_byindex(msfr.msfr_ifindex);
1672 * Lookup group on the socket.
1674 gsa = (sockunion_t *)&msfr.msfr_group;
1675 idx = imo_match_group(imo, ifp, &gsa->sa);
1676 if (idx == -1 || imo->imo_mfilters == NULL) {
1678 return (EADDRNOTAVAIL);
1680 imf = &imo->imo_mfilters[idx];
1683 * Ignore memberships which are in limbo.
1685 if (imf->imf_st[1] == MCAST_UNDEFINED) {
1689 msfr.msfr_fmode = imf->imf_st[1];
1692 * If the user specified a buffer, copy out the source filter
1693 * entries to userland gracefully.
1694 * We only copy out the number of entries which userland
1695 * has asked for, but we always tell userland how big the
1696 * buffer really needs to be.
1698 if (msfr.msfr_nsrcs > in_mcast_maxsocksrc)
1699 msfr.msfr_nsrcs = in_mcast_maxsocksrc;
1701 if (msfr.msfr_srcs != NULL && msfr.msfr_nsrcs > 0) {
1702 tss = malloc(sizeof(struct sockaddr_storage) * msfr.msfr_nsrcs,
1703 M_TEMP, M_NOWAIT | M_ZERO);
1711 * Count number of sources in-mode at t0.
1712 * If buffer space exists and remains, copy out source entries.
1714 nsrcs = msfr.msfr_nsrcs;
1717 RB_FOREACH(ims, ip_msource_tree, &imf->imf_sources) {
1718 lims = (struct in_msource *)ims;
1719 if (lims->imsl_st[0] == MCAST_UNDEFINED ||
1720 lims->imsl_st[0] != imf->imf_st[0])
1723 if (tss != NULL && nsrcs > 0) {
1724 psin = (struct sockaddr_in *)ptss;
1725 psin->sin_family = AF_INET;
1726 psin->sin_len = sizeof(struct sockaddr_in);
1727 psin->sin_addr.s_addr = htonl(lims->ims_haddr);
1737 error = copyout(tss, msfr.msfr_srcs,
1738 sizeof(struct sockaddr_storage) * msfr.msfr_nsrcs);
1744 msfr.msfr_nsrcs = ncsrcs;
1745 error = sooptcopyout(sopt, &msfr, sizeof(struct __msfilterreq));
1751 * Return the IP multicast options in response to user getsockopt().
1754 inp_getmoptions(struct inpcb *inp, struct sockopt *sopt)
1756 struct rm_priotracker in_ifa_tracker;
1757 struct ip_mreqn mreqn;
1758 struct ip_moptions *imo;
1760 struct in_ifaddr *ia;
1765 imo = inp->inp_moptions;
1767 * If socket is neither of type SOCK_RAW or SOCK_DGRAM,
1768 * or is a divert socket, reject it.
1770 if (inp->inp_socket->so_proto->pr_protocol == IPPROTO_DIVERT ||
1771 (inp->inp_socket->so_proto->pr_type != SOCK_RAW &&
1772 inp->inp_socket->so_proto->pr_type != SOCK_DGRAM)) {
1774 return (EOPNOTSUPP);
1778 switch (sopt->sopt_name) {
1779 case IP_MULTICAST_VIF:
1781 optval = imo->imo_multicast_vif;
1785 error = sooptcopyout(sopt, &optval, sizeof(int));
1788 case IP_MULTICAST_IF:
1789 memset(&mreqn, 0, sizeof(struct ip_mreqn));
1791 ifp = imo->imo_multicast_ifp;
1792 if (!in_nullhost(imo->imo_multicast_addr)) {
1793 mreqn.imr_address = imo->imo_multicast_addr;
1794 } else if (ifp != NULL) {
1795 mreqn.imr_ifindex = ifp->if_index;
1796 IFP_TO_IA(ifp, ia, &in_ifa_tracker);
1799 IA_SIN(ia)->sin_addr;
1800 ifa_free(&ia->ia_ifa);
1805 if (sopt->sopt_valsize == sizeof(struct ip_mreqn)) {
1806 error = sooptcopyout(sopt, &mreqn,
1807 sizeof(struct ip_mreqn));
1809 error = sooptcopyout(sopt, &mreqn.imr_address,
1810 sizeof(struct in_addr));
1814 case IP_MULTICAST_TTL:
1816 optval = coptval = IP_DEFAULT_MULTICAST_TTL;
1818 optval = coptval = imo->imo_multicast_ttl;
1820 if (sopt->sopt_valsize == sizeof(u_char))
1821 error = sooptcopyout(sopt, &coptval, sizeof(u_char));
1823 error = sooptcopyout(sopt, &optval, sizeof(int));
1826 case IP_MULTICAST_LOOP:
1828 optval = coptval = IP_DEFAULT_MULTICAST_LOOP;
1830 optval = coptval = imo->imo_multicast_loop;
1832 if (sopt->sopt_valsize == sizeof(u_char))
1833 error = sooptcopyout(sopt, &coptval, sizeof(u_char));
1835 error = sooptcopyout(sopt, &optval, sizeof(int));
1840 error = EADDRNOTAVAIL;
1843 error = inp_get_source_filters(inp, sopt);
1849 error = ENOPROTOOPT;
1853 INP_UNLOCK_ASSERT(inp);
1859 * Look up the ifnet to use for a multicast group membership,
1860 * given the IPv4 address of an interface, and the IPv4 group address.
1862 * This routine exists to support legacy multicast applications
1863 * which do not understand that multicast memberships are scoped to
1864 * specific physical links in the networking stack, or which need
1865 * to join link-scope groups before IPv4 addresses are configured.
1867 * If inp is non-NULL, use this socket's current FIB number for any
1868 * required FIB lookup.
1869 * If ina is INADDR_ANY, look up the group address in the unicast FIB,
1870 * and use its ifp; usually, this points to the default next-hop.
1872 * If the FIB lookup fails, attempt to use the first non-loopback
1873 * interface with multicast capability in the system as a
1874 * last resort. The legacy IPv4 ASM API requires that we do
1875 * this in order to allow groups to be joined when the routing
1876 * table has not yet been populated during boot.
1878 * Returns NULL if no ifp could be found.
1880 * FUTURE: Implement IPv4 source-address selection.
1882 static struct ifnet *
1883 inp_lookup_mcast_ifp(const struct inpcb *inp,
1884 const struct sockaddr_in *gsin, const struct in_addr ina)
1886 struct rm_priotracker in_ifa_tracker;
1888 struct nhop4_basic nh4;
1891 KASSERT(gsin->sin_family == AF_INET, ("%s: not AF_INET", __func__));
1892 KASSERT(IN_MULTICAST(ntohl(gsin->sin_addr.s_addr)),
1893 ("%s: not multicast", __func__));
1896 if (!in_nullhost(ina)) {
1897 IN_IFADDR_RLOCK(&in_ifa_tracker);
1898 INADDR_TO_IFP(ina, ifp);
1899 IN_IFADDR_RUNLOCK(&in_ifa_tracker);
1901 fibnum = inp ? inp->inp_inc.inc_fibnum : 0;
1902 if (fib4_lookup_nh_basic(fibnum, gsin->sin_addr, 0, 0, &nh4)==0)
1905 struct in_ifaddr *ia;
1909 IN_IFADDR_RLOCK(&in_ifa_tracker);
1910 TAILQ_FOREACH(ia, &V_in_ifaddrhead, ia_link) {
1912 if (!(mifp->if_flags & IFF_LOOPBACK) &&
1913 (mifp->if_flags & IFF_MULTICAST)) {
1918 IN_IFADDR_RUNLOCK(&in_ifa_tracker);
1926 * Join an IPv4 multicast group, possibly with a source.
1929 inp_join_group(struct inpcb *inp, struct sockopt *sopt)
1931 struct group_source_req gsr;
1932 sockunion_t *gsa, *ssa;
1934 struct in_mfilter *imf;
1935 struct ip_moptions *imo;
1936 struct in_multi *inm;
1937 struct in_msource *lims;
1947 memset(&gsr, 0, sizeof(struct group_source_req));
1948 gsa = (sockunion_t *)&gsr.gsr_group;
1949 gsa->ss.ss_family = AF_UNSPEC;
1950 ssa = (sockunion_t *)&gsr.gsr_source;
1951 ssa->ss.ss_family = AF_UNSPEC;
1953 switch (sopt->sopt_name) {
1954 case IP_ADD_MEMBERSHIP:
1955 case IP_ADD_SOURCE_MEMBERSHIP: {
1956 struct ip_mreq_source mreqs;
1958 if (sopt->sopt_name == IP_ADD_MEMBERSHIP) {
1959 error = sooptcopyin(sopt, &mreqs,
1960 sizeof(struct ip_mreq),
1961 sizeof(struct ip_mreq));
1963 * Do argument switcharoo from ip_mreq into
1964 * ip_mreq_source to avoid using two instances.
1966 mreqs.imr_interface = mreqs.imr_sourceaddr;
1967 mreqs.imr_sourceaddr.s_addr = INADDR_ANY;
1968 } else if (sopt->sopt_name == IP_ADD_SOURCE_MEMBERSHIP) {
1969 error = sooptcopyin(sopt, &mreqs,
1970 sizeof(struct ip_mreq_source),
1971 sizeof(struct ip_mreq_source));
1976 gsa->sin.sin_family = AF_INET;
1977 gsa->sin.sin_len = sizeof(struct sockaddr_in);
1978 gsa->sin.sin_addr = mreqs.imr_multiaddr;
1980 if (sopt->sopt_name == IP_ADD_SOURCE_MEMBERSHIP) {
1981 ssa->sin.sin_family = AF_INET;
1982 ssa->sin.sin_len = sizeof(struct sockaddr_in);
1983 ssa->sin.sin_addr = mreqs.imr_sourceaddr;
1986 if (!IN_MULTICAST(ntohl(gsa->sin.sin_addr.s_addr)))
1989 ifp = inp_lookup_mcast_ifp(inp, &gsa->sin,
1990 mreqs.imr_interface);
1991 CTR3(KTR_IGMPV3, "%s: imr_interface = 0x%08x, ifp = %p",
1992 __func__, ntohl(mreqs.imr_interface.s_addr), ifp);
1996 case MCAST_JOIN_GROUP:
1997 case MCAST_JOIN_SOURCE_GROUP:
1998 if (sopt->sopt_name == MCAST_JOIN_GROUP) {
1999 error = sooptcopyin(sopt, &gsr,
2000 sizeof(struct group_req),
2001 sizeof(struct group_req));
2002 } else if (sopt->sopt_name == MCAST_JOIN_SOURCE_GROUP) {
2003 error = sooptcopyin(sopt, &gsr,
2004 sizeof(struct group_source_req),
2005 sizeof(struct group_source_req));
2010 if (gsa->sin.sin_family != AF_INET ||
2011 gsa->sin.sin_len != sizeof(struct sockaddr_in))
2015 * Overwrite the port field if present, as the sockaddr
2016 * being copied in may be matched with a binary comparison.
2018 gsa->sin.sin_port = 0;
2019 if (sopt->sopt_name == MCAST_JOIN_SOURCE_GROUP) {
2020 if (ssa->sin.sin_family != AF_INET ||
2021 ssa->sin.sin_len != sizeof(struct sockaddr_in))
2023 ssa->sin.sin_port = 0;
2026 if (!IN_MULTICAST(ntohl(gsa->sin.sin_addr.s_addr)))
2029 if (gsr.gsr_interface == 0 || V_if_index < gsr.gsr_interface)
2030 return (EADDRNOTAVAIL);
2031 ifp = ifnet_byindex(gsr.gsr_interface);
2035 CTR2(KTR_IGMPV3, "%s: unknown sopt_name %d",
2036 __func__, sopt->sopt_name);
2037 return (EOPNOTSUPP);
2041 if (ifp == NULL || (ifp->if_flags & IFF_MULTICAST) == 0)
2042 return (EADDRNOTAVAIL);
2044 imo = inp_findmoptions(inp);
2045 idx = imo_match_group(imo, ifp, &gsa->sa);
2049 inm = imo->imo_membership[idx];
2050 imf = &imo->imo_mfilters[idx];
2051 if (ssa->ss.ss_family != AF_UNSPEC) {
2053 * MCAST_JOIN_SOURCE_GROUP on an exclusive membership
2054 * is an error. On an existing inclusive membership,
2055 * it just adds the source to the filter list.
2057 if (imf->imf_st[1] != MCAST_INCLUDE) {
2059 goto out_inp_locked;
2062 * Throw out duplicates.
2064 * XXX FIXME: This makes a naive assumption that
2065 * even if entries exist for *ssa in this imf,
2066 * they will be rejected as dupes, even if they
2067 * are not valid in the current mode (in-mode).
2069 * in_msource is transactioned just as for anything
2070 * else in SSM -- but note naive use of inm_graft()
2071 * below for allocating new filter entries.
2073 * This is only an issue if someone mixes the
2074 * full-state SSM API with the delta-based API,
2075 * which is discouraged in the relevant RFCs.
2077 lims = imo_match_source(imo, idx, &ssa->sa);
2078 if (lims != NULL /*&&
2079 lims->imsl_st[1] == MCAST_INCLUDE*/) {
2080 error = EADDRNOTAVAIL;
2081 goto out_inp_locked;
2085 * MCAST_JOIN_GROUP on an existing exclusive
2086 * membership is an error; return EADDRINUSE
2087 * to preserve 4.4BSD API idempotence, and
2088 * avoid tedious detour to code below.
2089 * NOTE: This is bending RFC 3678 a bit.
2091 * On an existing inclusive membership, this is also
2092 * an error; if you want to change filter mode,
2093 * you must use the userland API setsourcefilter().
2094 * XXX We don't reject this for imf in UNDEFINED
2095 * state at t1, because allocation of a filter
2096 * is atomic with allocation of a membership.
2099 if (imf->imf_st[1] == MCAST_EXCLUDE)
2101 goto out_inp_locked;
2106 * Begin state merge transaction at socket layer.
2108 INP_WLOCK_ASSERT(inp);
2111 if (imo->imo_num_memberships == imo->imo_max_memberships) {
2112 error = imo_grow(imo);
2114 goto out_inp_locked;
2117 * Allocate the new slot upfront so we can deal with
2118 * grafting the new source filter in same code path
2119 * as for join-source on existing membership.
2121 idx = imo->imo_num_memberships;
2122 imo->imo_membership[idx] = NULL;
2123 imo->imo_num_memberships++;
2124 KASSERT(imo->imo_mfilters != NULL,
2125 ("%s: imf_mfilters vector was not allocated", __func__));
2126 imf = &imo->imo_mfilters[idx];
2127 KASSERT(RB_EMPTY(&imf->imf_sources),
2128 ("%s: imf_sources not empty", __func__));
2132 * Graft new source into filter list for this inpcb's
2133 * membership of the group. The in_multi may not have
2134 * been allocated yet if this is a new membership, however,
2135 * the in_mfilter slot will be allocated and must be initialized.
2137 * Note: Grafting of exclusive mode filters doesn't happen
2139 * XXX: Should check for non-NULL lims (node exists but may
2140 * not be in-mode) for interop with full-state API.
2142 if (ssa->ss.ss_family != AF_UNSPEC) {
2143 /* Membership starts in IN mode */
2145 CTR1(KTR_IGMPV3, "%s: new join w/source", __func__);
2146 imf_init(imf, MCAST_UNDEFINED, MCAST_INCLUDE);
2148 CTR2(KTR_IGMPV3, "%s: %s source", __func__, "allow");
2150 lims = imf_graft(imf, MCAST_INCLUDE, &ssa->sin);
2152 CTR1(KTR_IGMPV3, "%s: merge imf state failed",
2158 /* No address specified; Membership starts in EX mode */
2160 CTR1(KTR_IGMPV3, "%s: new join w/o source", __func__);
2161 imf_init(imf, MCAST_UNDEFINED, MCAST_EXCLUDE);
2166 * Begin state merge transaction at IGMP layer.
2171 error = in_joingroup_locked(ifp, &gsa->sin.sin_addr, imf,
2174 CTR1(KTR_IGMPV3, "%s: in_joingroup_locked failed",
2179 imo->imo_membership[idx] = inm;
2181 CTR1(KTR_IGMPV3, "%s: merge inm state", __func__);
2182 error = inm_merge(inm, imf);
2184 CTR1(KTR_IGMPV3, "%s: failed to merge inm state",
2186 goto out_in_multi_locked;
2188 CTR1(KTR_IGMPV3, "%s: doing igmp downcall", __func__);
2189 error = igmp_change_state(inm);
2191 CTR1(KTR_IGMPV3, "%s: failed igmp downcall",
2193 goto out_in_multi_locked;
2197 out_in_multi_locked:
2201 INP_WLOCK_ASSERT(inp);
2213 if (error && is_new) {
2214 imo->imo_membership[idx] = NULL;
2215 --imo->imo_num_memberships;
2224 * Leave an IPv4 multicast group on an inpcb, possibly with a source.
2227 inp_leave_group(struct inpcb *inp, struct sockopt *sopt)
2229 struct group_source_req gsr;
2230 struct ip_mreq_source mreqs;
2231 struct rm_priotracker in_ifa_tracker;
2232 sockunion_t *gsa, *ssa;
2234 struct in_mfilter *imf;
2235 struct ip_moptions *imo;
2236 struct in_msource *ims;
2237 struct in_multi *inm;
2239 int error, is_final;
2245 memset(&gsr, 0, sizeof(struct group_source_req));
2246 gsa = (sockunion_t *)&gsr.gsr_group;
2247 gsa->ss.ss_family = AF_UNSPEC;
2248 ssa = (sockunion_t *)&gsr.gsr_source;
2249 ssa->ss.ss_family = AF_UNSPEC;
2251 switch (sopt->sopt_name) {
2252 case IP_DROP_MEMBERSHIP:
2253 case IP_DROP_SOURCE_MEMBERSHIP:
2254 if (sopt->sopt_name == IP_DROP_MEMBERSHIP) {
2255 error = sooptcopyin(sopt, &mreqs,
2256 sizeof(struct ip_mreq),
2257 sizeof(struct ip_mreq));
2259 * Swap interface and sourceaddr arguments,
2260 * as ip_mreq and ip_mreq_source are laid
2263 mreqs.imr_interface = mreqs.imr_sourceaddr;
2264 mreqs.imr_sourceaddr.s_addr = INADDR_ANY;
2265 } else if (sopt->sopt_name == IP_DROP_SOURCE_MEMBERSHIP) {
2266 error = sooptcopyin(sopt, &mreqs,
2267 sizeof(struct ip_mreq_source),
2268 sizeof(struct ip_mreq_source));
2273 gsa->sin.sin_family = AF_INET;
2274 gsa->sin.sin_len = sizeof(struct sockaddr_in);
2275 gsa->sin.sin_addr = mreqs.imr_multiaddr;
2277 if (sopt->sopt_name == IP_DROP_SOURCE_MEMBERSHIP) {
2278 ssa->sin.sin_family = AF_INET;
2279 ssa->sin.sin_len = sizeof(struct sockaddr_in);
2280 ssa->sin.sin_addr = mreqs.imr_sourceaddr;
2284 * Attempt to look up hinted ifp from interface address.
2285 * Fallthrough with null ifp iff lookup fails, to
2286 * preserve 4.4BSD mcast API idempotence.
2287 * XXX NOTE WELL: The RFC 3678 API is preferred because
2288 * using an IPv4 address as a key is racy.
2290 if (!in_nullhost(mreqs.imr_interface)) {
2291 IN_IFADDR_RLOCK(&in_ifa_tracker);
2292 INADDR_TO_IFP(mreqs.imr_interface, ifp);
2293 IN_IFADDR_RUNLOCK(&in_ifa_tracker);
2295 CTR3(KTR_IGMPV3, "%s: imr_interface = 0x%08x, ifp = %p",
2296 __func__, ntohl(mreqs.imr_interface.s_addr), ifp);
2300 case MCAST_LEAVE_GROUP:
2301 case MCAST_LEAVE_SOURCE_GROUP:
2302 if (sopt->sopt_name == MCAST_LEAVE_GROUP) {
2303 error = sooptcopyin(sopt, &gsr,
2304 sizeof(struct group_req),
2305 sizeof(struct group_req));
2306 } else if (sopt->sopt_name == MCAST_LEAVE_SOURCE_GROUP) {
2307 error = sooptcopyin(sopt, &gsr,
2308 sizeof(struct group_source_req),
2309 sizeof(struct group_source_req));
2314 if (gsa->sin.sin_family != AF_INET ||
2315 gsa->sin.sin_len != sizeof(struct sockaddr_in))
2318 if (sopt->sopt_name == MCAST_LEAVE_SOURCE_GROUP) {
2319 if (ssa->sin.sin_family != AF_INET ||
2320 ssa->sin.sin_len != sizeof(struct sockaddr_in))
2324 if (gsr.gsr_interface == 0 || V_if_index < gsr.gsr_interface)
2325 return (EADDRNOTAVAIL);
2327 ifp = ifnet_byindex(gsr.gsr_interface);
2330 return (EADDRNOTAVAIL);
2334 CTR2(KTR_IGMPV3, "%s: unknown sopt_name %d",
2335 __func__, sopt->sopt_name);
2336 return (EOPNOTSUPP);
2340 if (!IN_MULTICAST(ntohl(gsa->sin.sin_addr.s_addr)))
2344 * Find the membership in the membership array.
2346 imo = inp_findmoptions(inp);
2347 idx = imo_match_group(imo, ifp, &gsa->sa);
2349 error = EADDRNOTAVAIL;
2350 goto out_inp_locked;
2352 inm = imo->imo_membership[idx];
2353 imf = &imo->imo_mfilters[idx];
2355 if (ssa->ss.ss_family != AF_UNSPEC)
2359 * Begin state merge transaction at socket layer.
2361 INP_WLOCK_ASSERT(inp);
2364 * If we were instructed only to leave a given source, do so.
2365 * MCAST_LEAVE_SOURCE_GROUP is only valid for inclusive memberships.
2370 if (imf->imf_st[0] == MCAST_EXCLUDE) {
2371 error = EADDRNOTAVAIL;
2372 goto out_inp_locked;
2374 ims = imo_match_source(imo, idx, &ssa->sa);
2376 CTR3(KTR_IGMPV3, "%s: source 0x%08x %spresent",
2377 __func__, ntohl(ssa->sin.sin_addr.s_addr), "not ");
2378 error = EADDRNOTAVAIL;
2379 goto out_inp_locked;
2381 CTR2(KTR_IGMPV3, "%s: %s source", __func__, "block");
2382 error = imf_prune(imf, &ssa->sin);
2384 CTR1(KTR_IGMPV3, "%s: merge imf state failed",
2386 goto out_inp_locked;
2391 * Begin state merge transaction at IGMP layer.
2397 * Give up the multicast address record to which
2398 * the membership points.
2400 (void)in_leavegroup_locked(inm, imf);
2402 CTR1(KTR_IGMPV3, "%s: merge inm state", __func__);
2403 error = inm_merge(inm, imf);
2405 CTR1(KTR_IGMPV3, "%s: failed to merge inm state",
2407 goto out_in_multi_locked;
2410 CTR1(KTR_IGMPV3, "%s: doing igmp downcall", __func__);
2411 error = igmp_change_state(inm);
2413 CTR1(KTR_IGMPV3, "%s: failed igmp downcall",
2418 out_in_multi_locked:
2430 /* Remove the gap in the membership and filter array. */
2431 KASSERT(RB_EMPTY(&imf->imf_sources),
2432 ("%s: imf_sources not empty", __func__));
2433 for (++idx; idx < imo->imo_num_memberships; ++idx) {
2434 imo->imo_membership[idx - 1] = imo->imo_membership[idx];
2435 imo->imo_mfilters[idx - 1] = imo->imo_mfilters[idx];
2437 imf_init(&imo->imo_mfilters[idx - 1], MCAST_UNDEFINED,
2439 imo->imo_num_memberships--;
2448 * Select the interface for transmitting IPv4 multicast datagrams.
2450 * Either an instance of struct in_addr or an instance of struct ip_mreqn
2451 * may be passed to this socket option. An address of INADDR_ANY or an
2452 * interface index of 0 is used to remove a previous selection.
2453 * When no interface is selected, one is chosen for every send.
2456 inp_set_multicast_if(struct inpcb *inp, struct sockopt *sopt)
2458 struct rm_priotracker in_ifa_tracker;
2459 struct in_addr addr;
2460 struct ip_mreqn mreqn;
2462 struct ip_moptions *imo;
2465 if (sopt->sopt_valsize == sizeof(struct ip_mreqn)) {
2467 * An interface index was specified using the
2468 * Linux-derived ip_mreqn structure.
2470 error = sooptcopyin(sopt, &mreqn, sizeof(struct ip_mreqn),
2471 sizeof(struct ip_mreqn));
2475 if (mreqn.imr_ifindex < 0 || V_if_index < mreqn.imr_ifindex)
2478 if (mreqn.imr_ifindex == 0) {
2481 ifp = ifnet_byindex(mreqn.imr_ifindex);
2483 return (EADDRNOTAVAIL);
2487 * An interface was specified by IPv4 address.
2488 * This is the traditional BSD usage.
2490 error = sooptcopyin(sopt, &addr, sizeof(struct in_addr),
2491 sizeof(struct in_addr));
2494 if (in_nullhost(addr)) {
2497 IN_IFADDR_RLOCK(&in_ifa_tracker);
2498 INADDR_TO_IFP(addr, ifp);
2499 IN_IFADDR_RUNLOCK(&in_ifa_tracker);
2501 return (EADDRNOTAVAIL);
2503 CTR3(KTR_IGMPV3, "%s: ifp = %p, addr = 0x%08x", __func__, ifp,
2504 ntohl(addr.s_addr));
2507 /* Reject interfaces which do not support multicast. */
2508 if (ifp != NULL && (ifp->if_flags & IFF_MULTICAST) == 0)
2509 return (EOPNOTSUPP);
2511 imo = inp_findmoptions(inp);
2512 imo->imo_multicast_ifp = ifp;
2513 imo->imo_multicast_addr.s_addr = INADDR_ANY;
2520 * Atomically set source filters on a socket for an IPv4 multicast group.
2522 * SMPng: NOTE: Potentially calls malloc(M_WAITOK) with Giant held.
2525 inp_set_source_filters(struct inpcb *inp, struct sockopt *sopt)
2527 struct __msfilterreq msfr;
2530 struct in_mfilter *imf;
2531 struct ip_moptions *imo;
2532 struct in_multi *inm;
2536 error = sooptcopyin(sopt, &msfr, sizeof(struct __msfilterreq),
2537 sizeof(struct __msfilterreq));
2541 if (msfr.msfr_nsrcs > in_mcast_maxsocksrc)
2544 if ((msfr.msfr_fmode != MCAST_EXCLUDE &&
2545 msfr.msfr_fmode != MCAST_INCLUDE))
2548 if (msfr.msfr_group.ss_family != AF_INET ||
2549 msfr.msfr_group.ss_len != sizeof(struct sockaddr_in))
2552 gsa = (sockunion_t *)&msfr.msfr_group;
2553 if (!IN_MULTICAST(ntohl(gsa->sin.sin_addr.s_addr)))
2556 gsa->sin.sin_port = 0; /* ignore port */
2558 if (msfr.msfr_ifindex == 0 || V_if_index < msfr.msfr_ifindex)
2559 return (EADDRNOTAVAIL);
2561 ifp = ifnet_byindex(msfr.msfr_ifindex);
2563 return (EADDRNOTAVAIL);
2566 * Take the INP write lock.
2567 * Check if this socket is a member of this group.
2569 imo = inp_findmoptions(inp);
2570 idx = imo_match_group(imo, ifp, &gsa->sa);
2571 if (idx == -1 || imo->imo_mfilters == NULL) {
2572 error = EADDRNOTAVAIL;
2573 goto out_inp_locked;
2575 inm = imo->imo_membership[idx];
2576 imf = &imo->imo_mfilters[idx];
2579 * Begin state merge transaction at socket layer.
2581 INP_WLOCK_ASSERT(inp);
2583 imf->imf_st[1] = msfr.msfr_fmode;
2586 * Apply any new source filters, if present.
2587 * Make a copy of the user-space source vector so
2588 * that we may copy them with a single copyin. This
2589 * allows us to deal with page faults up-front.
2591 if (msfr.msfr_nsrcs > 0) {
2592 struct in_msource *lims;
2593 struct sockaddr_in *psin;
2594 struct sockaddr_storage *kss, *pkss;
2599 CTR2(KTR_IGMPV3, "%s: loading %lu source list entries",
2600 __func__, (unsigned long)msfr.msfr_nsrcs);
2601 kss = malloc(sizeof(struct sockaddr_storage) * msfr.msfr_nsrcs,
2603 error = copyin(msfr.msfr_srcs, kss,
2604 sizeof(struct sockaddr_storage) * msfr.msfr_nsrcs);
2613 * Mark all source filters as UNDEFINED at t1.
2614 * Restore new group filter mode, as imf_leave()
2615 * will set it to INCLUDE.
2618 imf->imf_st[1] = msfr.msfr_fmode;
2621 * Update socket layer filters at t1, lazy-allocating
2622 * new entries. This saves a bunch of memory at the
2623 * cost of one RB_FIND() per source entry; duplicate
2624 * entries in the msfr_nsrcs vector are ignored.
2625 * If we encounter an error, rollback transaction.
2627 * XXX This too could be replaced with a set-symmetric
2628 * difference like loop to avoid walking from root
2629 * every time, as the key space is common.
2631 for (i = 0, pkss = kss; i < msfr.msfr_nsrcs; i++, pkss++) {
2632 psin = (struct sockaddr_in *)pkss;
2633 if (psin->sin_family != AF_INET) {
2634 error = EAFNOSUPPORT;
2637 if (psin->sin_len != sizeof(struct sockaddr_in)) {
2641 error = imf_get_source(imf, psin, &lims);
2644 lims->imsl_st[1] = imf->imf_st[1];
2650 goto out_imf_rollback;
2652 INP_WLOCK_ASSERT(inp);
2656 * Begin state merge transaction at IGMP layer.
2658 CTR1(KTR_IGMPV3, "%s: merge inm state", __func__);
2659 error = inm_merge(inm, imf);
2661 CTR1(KTR_IGMPV3, "%s: failed to merge inm state", __func__);
2662 goto out_in_multi_locked;
2665 CTR1(KTR_IGMPV3, "%s: doing igmp downcall", __func__);
2666 error = igmp_change_state(inm);
2668 CTR1(KTR_IGMPV3, "%s: failed igmp downcall", __func__);
2670 out_in_multi_locked:
2688 * Set the IP multicast options in response to user setsockopt().
2690 * Many of the socket options handled in this function duplicate the
2691 * functionality of socket options in the regular unicast API. However,
2692 * it is not possible to merge the duplicate code, because the idempotence
2693 * of the IPv4 multicast part of the BSD Sockets API must be preserved;
2694 * the effects of these options must be treated as separate and distinct.
2696 * SMPng: XXX: Unlocked read of inp_socket believed OK.
2697 * FUTURE: The IP_MULTICAST_VIF option may be eliminated if MROUTING
2698 * is refactored to no longer use vifs.
2701 inp_setmoptions(struct inpcb *inp, struct sockopt *sopt)
2703 struct ip_moptions *imo;
2709 * If socket is neither of type SOCK_RAW or SOCK_DGRAM,
2710 * or is a divert socket, reject it.
2712 if (inp->inp_socket->so_proto->pr_protocol == IPPROTO_DIVERT ||
2713 (inp->inp_socket->so_proto->pr_type != SOCK_RAW &&
2714 inp->inp_socket->so_proto->pr_type != SOCK_DGRAM))
2715 return (EOPNOTSUPP);
2717 switch (sopt->sopt_name) {
2718 case IP_MULTICAST_VIF: {
2721 * Select a multicast VIF for transmission.
2722 * Only useful if multicast forwarding is active.
2724 if (legal_vif_num == NULL) {
2728 error = sooptcopyin(sopt, &vifi, sizeof(int), sizeof(int));
2731 if (!legal_vif_num(vifi) && (vifi != -1)) {
2735 imo = inp_findmoptions(inp);
2736 imo->imo_multicast_vif = vifi;
2741 case IP_MULTICAST_IF:
2742 error = inp_set_multicast_if(inp, sopt);
2745 case IP_MULTICAST_TTL: {
2749 * Set the IP time-to-live for outgoing multicast packets.
2750 * The original multicast API required a char argument,
2751 * which is inconsistent with the rest of the socket API.
2752 * We allow either a char or an int.
2754 if (sopt->sopt_valsize == sizeof(u_char)) {
2755 error = sooptcopyin(sopt, &ttl, sizeof(u_char),
2762 error = sooptcopyin(sopt, &ittl, sizeof(u_int),
2772 imo = inp_findmoptions(inp);
2773 imo->imo_multicast_ttl = ttl;
2778 case IP_MULTICAST_LOOP: {
2782 * Set the loopback flag for outgoing multicast packets.
2783 * Must be zero or one. The original multicast API required a
2784 * char argument, which is inconsistent with the rest
2785 * of the socket API. We allow either a char or an int.
2787 if (sopt->sopt_valsize == sizeof(u_char)) {
2788 error = sooptcopyin(sopt, &loop, sizeof(u_char),
2795 error = sooptcopyin(sopt, &iloop, sizeof(u_int),
2799 loop = (u_char)iloop;
2801 imo = inp_findmoptions(inp);
2802 imo->imo_multicast_loop = !!loop;
2807 case IP_ADD_MEMBERSHIP:
2808 case IP_ADD_SOURCE_MEMBERSHIP:
2809 case MCAST_JOIN_GROUP:
2810 case MCAST_JOIN_SOURCE_GROUP:
2811 error = inp_join_group(inp, sopt);
2814 case IP_DROP_MEMBERSHIP:
2815 case IP_DROP_SOURCE_MEMBERSHIP:
2816 case MCAST_LEAVE_GROUP:
2817 case MCAST_LEAVE_SOURCE_GROUP:
2818 error = inp_leave_group(inp, sopt);
2821 case IP_BLOCK_SOURCE:
2822 case IP_UNBLOCK_SOURCE:
2823 case MCAST_BLOCK_SOURCE:
2824 case MCAST_UNBLOCK_SOURCE:
2825 error = inp_block_unblock_source(inp, sopt);
2829 error = inp_set_source_filters(inp, sopt);
2837 INP_UNLOCK_ASSERT(inp);
2843 * Expose IGMP's multicast filter mode and source list(s) to userland,
2844 * keyed by (ifindex, group).
2845 * The filter mode is written out as a uint32_t, followed by
2846 * 0..n of struct in_addr.
2847 * For use by ifmcstat(8).
2848 * SMPng: NOTE: unlocked read of ifindex space.
2851 sysctl_ip_mcast_filters(SYSCTL_HANDLER_ARGS)
2853 struct in_addr src, group;
2855 struct ifmultiaddr *ifma;
2856 struct in_multi *inm;
2857 struct ip_msource *ims;
2861 uint32_t fmode, ifindex;
2866 if (req->newptr != NULL)
2873 if (ifindex <= 0 || ifindex > V_if_index) {
2874 CTR2(KTR_IGMPV3, "%s: ifindex %u out of range",
2879 group.s_addr = name[1];
2880 if (!IN_MULTICAST(ntohl(group.s_addr))) {
2881 CTR2(KTR_IGMPV3, "%s: group 0x%08x is not multicast",
2882 __func__, ntohl(group.s_addr));
2886 ifp = ifnet_byindex(ifindex);
2888 CTR2(KTR_IGMPV3, "%s: no ifp for ifindex %u",
2893 retval = sysctl_wire_old_buffer(req,
2894 sizeof(uint32_t) + (in_mcast_maxgrpsrc * sizeof(struct in_addr)));
2901 TAILQ_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link) {
2902 if (ifma->ifma_addr->sa_family != AF_INET ||
2903 ifma->ifma_protospec == NULL)
2905 inm = (struct in_multi *)ifma->ifma_protospec;
2906 if (!in_hosteq(inm->inm_addr, group))
2908 fmode = inm->inm_st[1].iss_fmode;
2909 retval = SYSCTL_OUT(req, &fmode, sizeof(uint32_t));
2912 RB_FOREACH(ims, ip_msource_tree, &inm->inm_srcs) {
2913 CTR2(KTR_IGMPV3, "%s: visit node 0x%08x", __func__,
2916 * Only copy-out sources which are in-mode.
2918 if (fmode != ims_get_mode(inm, ims, 1)) {
2919 CTR1(KTR_IGMPV3, "%s: skip non-in-mode",
2923 src.s_addr = htonl(ims->ims_haddr);
2924 retval = SYSCTL_OUT(req, &src, sizeof(struct in_addr));
2929 IF_ADDR_RUNLOCK(ifp);
2936 #if defined(KTR) && (KTR_COMPILE & KTR_IGMPV3)
2938 static const char *inm_modestrs[] = {
2939 [MCAST_UNDEFINED] = "un",
2940 [MCAST_INCLUDE] = "in",
2941 [MCAST_EXCLUDE] = "ex",
2943 _Static_assert(MCAST_UNDEFINED == 0 &&
2944 MCAST_EXCLUDE + 1 == nitems(inm_modestrs),
2945 "inm_modestrs: no longer matches #defines");
2948 inm_mode_str(const int mode)
2951 if (mode >= MCAST_UNDEFINED && mode <= MCAST_EXCLUDE)
2952 return (inm_modestrs[mode]);
2956 static const char *inm_statestrs[] = {
2957 [IGMP_NOT_MEMBER] = "not-member",
2958 [IGMP_SILENT_MEMBER] = "silent",
2959 [IGMP_REPORTING_MEMBER] = "reporting",
2960 [IGMP_IDLE_MEMBER] = "idle",
2961 [IGMP_LAZY_MEMBER] = "lazy",
2962 [IGMP_SLEEPING_MEMBER] = "sleeping",
2963 [IGMP_AWAKENING_MEMBER] = "awakening",
2964 [IGMP_G_QUERY_PENDING_MEMBER] = "query-pending",
2965 [IGMP_SG_QUERY_PENDING_MEMBER] = "sg-query-pending",
2966 [IGMP_LEAVING_MEMBER] = "leaving",
2968 _Static_assert(IGMP_NOT_MEMBER == 0 &&
2969 IGMP_LEAVING_MEMBER + 1 == nitems(inm_statestrs),
2970 "inm_statetrs: no longer matches #defines");
2973 inm_state_str(const int state)
2976 if (state >= IGMP_NOT_MEMBER && state <= IGMP_LEAVING_MEMBER)
2977 return (inm_statestrs[state]);
2982 * Dump an in_multi structure to the console.
2985 inm_print(const struct in_multi *inm)
2988 char addrbuf[INET_ADDRSTRLEN];
2990 if ((ktr_mask & KTR_IGMPV3) == 0)
2993 printf("%s: --- begin inm %p ---\n", __func__, inm);
2994 printf("addr %s ifp %p(%s) ifma %p\n",
2995 inet_ntoa_r(inm->inm_addr, addrbuf),
2997 inm->inm_ifp->if_xname,
2999 printf("timer %u state %s refcount %u scq.len %u\n",
3001 inm_state_str(inm->inm_state),
3003 inm->inm_scq.mq_len);
3004 printf("igi %p nsrc %lu sctimer %u scrv %u\n",
3009 for (t = 0; t < 2; t++) {
3010 printf("t%d: fmode %s asm %u ex %u in %u rec %u\n", t,
3011 inm_mode_str(inm->inm_st[t].iss_fmode),
3012 inm->inm_st[t].iss_asm,
3013 inm->inm_st[t].iss_ex,
3014 inm->inm_st[t].iss_in,
3015 inm->inm_st[t].iss_rec);
3017 printf("%s: --- end inm %p ---\n", __func__, inm);
3020 #else /* !KTR || !(KTR_COMPILE & KTR_IGMPV3) */
3023 inm_print(const struct in_multi *inm)
3028 #endif /* KTR && (KTR_COMPILE & KTR_IGMPV3) */
3030 RB_GENERATE(ip_msource_tree, ip_msource, ims_link, ip_msource_cmp);