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;
1055 /* Increment ASM listener count on transition to ASM mode. */
1056 if (imf->imf_st[1] == MCAST_EXCLUDE && nsrc1 == 0) {
1057 CTR1(KTR_IGMPV3, "%s: asm++ on inm at t1", __func__);
1058 inm->inm_st[1].iss_asm++;
1061 CTR3(KTR_IGMPV3, "%s: merged imf %p to inm %p", __func__, imf, inm);
1066 CTR1(KTR_IGMPV3, "%s: sources changed; reaping", __func__);
1073 * Mark an in_multi's filter set deltas as committed.
1074 * Called by IGMP after a state change has been enqueued.
1077 inm_commit(struct in_multi *inm)
1079 struct ip_msource *ims;
1081 CTR2(KTR_IGMPV3, "%s: commit inm %p", __func__, inm);
1082 CTR1(KTR_IGMPV3, "%s: pre commit:", __func__);
1085 RB_FOREACH(ims, ip_msource_tree, &inm->inm_srcs) {
1086 ims->ims_st[0] = ims->ims_st[1];
1088 inm->inm_st[0] = inm->inm_st[1];
1092 * Reap unreferenced nodes from an in_multi's filter set.
1095 inm_reap(struct in_multi *inm)
1097 struct ip_msource *ims, *tims;
1099 RB_FOREACH_SAFE(ims, ip_msource_tree, &inm->inm_srcs, tims) {
1100 if (ims->ims_st[0].ex > 0 || ims->ims_st[0].in > 0 ||
1101 ims->ims_st[1].ex > 0 || ims->ims_st[1].in > 0 ||
1104 CTR2(KTR_IGMPV3, "%s: free ims %p", __func__, ims);
1105 RB_REMOVE(ip_msource_tree, &inm->inm_srcs, ims);
1106 free(ims, M_IPMSOURCE);
1112 * Purge all source nodes from an in_multi's filter set.
1115 inm_purge(struct in_multi *inm)
1117 struct ip_msource *ims, *tims;
1119 RB_FOREACH_SAFE(ims, ip_msource_tree, &inm->inm_srcs, tims) {
1120 CTR2(KTR_IGMPV3, "%s: free ims %p", __func__, ims);
1121 RB_REMOVE(ip_msource_tree, &inm->inm_srcs, ims);
1122 free(ims, M_IPMSOURCE);
1128 * Join a multicast group; unlocked entry point.
1130 * SMPng: XXX: in_joingroup() is called from in_control() when Giant
1131 * is not held. Fortunately, ifp is unlikely to have been detached
1132 * at this point, so we assume it's OK to recurse.
1135 in_joingroup(struct ifnet *ifp, const struct in_addr *gina,
1136 /*const*/ struct in_mfilter *imf, struct in_multi **pinm)
1141 error = in_joingroup_locked(ifp, gina, imf, pinm);
1148 * Join a multicast group; real entry point.
1150 * Only preserves atomicity at inm level.
1151 * NOTE: imf argument cannot be const due to sys/tree.h limitations.
1153 * If the IGMP downcall fails, the group is not joined, and an error
1157 in_joingroup_locked(struct ifnet *ifp, const struct in_addr *gina,
1158 /*const*/ struct in_mfilter *imf, struct in_multi **pinm)
1160 struct in_mfilter timf;
1161 struct in_multi *inm;
1164 IN_MULTI_LOCK_ASSERT();
1166 CTR4(KTR_IGMPV3, "%s: join 0x%08x on %p(%s))", __func__,
1167 ntohl(gina->s_addr), ifp, ifp->if_xname);
1173 * If no imf was specified (i.e. kernel consumer),
1174 * fake one up and assume it is an ASM join.
1177 imf_init(&timf, MCAST_UNDEFINED, MCAST_EXCLUDE);
1181 error = in_getmulti(ifp, gina, &inm);
1183 CTR1(KTR_IGMPV3, "%s: in_getmulti() failure", __func__);
1187 CTR1(KTR_IGMPV3, "%s: merge inm state", __func__);
1188 error = inm_merge(inm, imf);
1190 CTR1(KTR_IGMPV3, "%s: failed to merge inm state", __func__);
1191 goto out_inm_release;
1194 CTR1(KTR_IGMPV3, "%s: doing igmp downcall", __func__);
1195 error = igmp_change_state(inm);
1197 CTR1(KTR_IGMPV3, "%s: failed to update source", __func__);
1198 goto out_inm_release;
1203 CTR2(KTR_IGMPV3, "%s: dropping ref on %p", __func__, inm);
1204 inm_release_locked(inm);
1213 * Leave a multicast group; unlocked entry point.
1216 in_leavegroup(struct in_multi *inm, /*const*/ struct in_mfilter *imf)
1221 error = in_leavegroup_locked(inm, imf);
1228 * Leave a multicast group; real entry point.
1229 * All source filters will be expunged.
1231 * Only preserves atomicity at inm level.
1233 * Holding the write lock for the INP which contains imf
1234 * is highly advisable. We can't assert for it as imf does not
1235 * contain a back-pointer to the owning inp.
1237 * Note: This is not the same as inm_release(*) as this function also
1238 * makes a state change downcall into IGMP.
1241 in_leavegroup_locked(struct in_multi *inm, /*const*/ struct in_mfilter *imf)
1243 struct in_mfilter timf;
1248 IN_MULTI_LOCK_ASSERT();
1250 CTR5(KTR_IGMPV3, "%s: leave inm %p, 0x%08x/%s, imf %p", __func__,
1251 inm, ntohl(inm->inm_addr.s_addr),
1252 (inm_is_ifp_detached(inm) ? "null" : inm->inm_ifp->if_xname),
1256 * If no imf was specified (i.e. kernel consumer),
1257 * fake one up and assume it is an ASM join.
1260 imf_init(&timf, MCAST_EXCLUDE, MCAST_UNDEFINED);
1265 * Begin state merge transaction at IGMP layer.
1267 * As this particular invocation should not cause any memory
1268 * to be allocated, and there is no opportunity to roll back
1269 * the transaction, it MUST NOT fail.
1271 CTR1(KTR_IGMPV3, "%s: merge inm state", __func__);
1272 error = inm_merge(inm, imf);
1273 KASSERT(error == 0, ("%s: failed to merge inm state", __func__));
1275 CTR1(KTR_IGMPV3, "%s: doing igmp downcall", __func__);
1276 CURVNET_SET(inm->inm_ifp->if_vnet);
1277 error = igmp_change_state(inm);
1280 CTR1(KTR_IGMPV3, "%s: failed igmp downcall", __func__);
1282 CTR2(KTR_IGMPV3, "%s: dropping ref on %p", __func__, inm);
1283 inm_release_locked(inm);
1288 /*#ifndef BURN_BRIDGES*/
1290 * Join an IPv4 multicast group in (*,G) exclusive mode.
1291 * The group must be a 224.0.0.0/24 link-scope group.
1292 * This KPI is for legacy kernel consumers only.
1295 in_addmulti(struct in_addr *ap, struct ifnet *ifp)
1297 struct in_multi *pinm;
1300 char addrbuf[INET_ADDRSTRLEN];
1303 KASSERT(IN_LOCAL_GROUP(ntohl(ap->s_addr)),
1304 ("%s: %s not in 224.0.0.0/24", __func__,
1305 inet_ntoa_r(*ap, addrbuf)));
1307 error = in_joingroup(ifp, ap, NULL, &pinm);
1315 * Leave an IPv4 multicast group, assumed to be in exclusive (*,G) mode.
1316 * This KPI is for legacy kernel consumers only.
1319 in_delmulti(struct in_multi *inm)
1322 (void)in_leavegroup(inm, NULL);
1327 * Block or unblock an ASM multicast source on an inpcb.
1328 * This implements the delta-based API described in RFC 3678.
1330 * The delta-based API applies only to exclusive-mode memberships.
1331 * An IGMP downcall will be performed.
1333 * SMPng: NOTE: Must take Giant as a join may create a new ifma.
1335 * Return 0 if successful, otherwise return an appropriate error code.
1338 inp_block_unblock_source(struct inpcb *inp, struct sockopt *sopt)
1340 struct group_source_req gsr;
1341 sockunion_t *gsa, *ssa;
1343 struct in_mfilter *imf;
1344 struct ip_moptions *imo;
1345 struct in_msource *ims;
1346 struct in_multi *inm;
1355 memset(&gsr, 0, sizeof(struct group_source_req));
1356 gsa = (sockunion_t *)&gsr.gsr_group;
1357 ssa = (sockunion_t *)&gsr.gsr_source;
1359 switch (sopt->sopt_name) {
1360 case IP_BLOCK_SOURCE:
1361 case IP_UNBLOCK_SOURCE: {
1362 struct ip_mreq_source mreqs;
1364 error = sooptcopyin(sopt, &mreqs,
1365 sizeof(struct ip_mreq_source),
1366 sizeof(struct ip_mreq_source));
1370 gsa->sin.sin_family = AF_INET;
1371 gsa->sin.sin_len = sizeof(struct sockaddr_in);
1372 gsa->sin.sin_addr = mreqs.imr_multiaddr;
1374 ssa->sin.sin_family = AF_INET;
1375 ssa->sin.sin_len = sizeof(struct sockaddr_in);
1376 ssa->sin.sin_addr = mreqs.imr_sourceaddr;
1378 if (!in_nullhost(mreqs.imr_interface))
1379 INADDR_TO_IFP(mreqs.imr_interface, ifp);
1381 if (sopt->sopt_name == IP_BLOCK_SOURCE)
1384 CTR3(KTR_IGMPV3, "%s: imr_interface = 0x%08x, ifp = %p",
1385 __func__, ntohl(mreqs.imr_interface.s_addr), ifp);
1389 case MCAST_BLOCK_SOURCE:
1390 case MCAST_UNBLOCK_SOURCE:
1391 error = sooptcopyin(sopt, &gsr,
1392 sizeof(struct group_source_req),
1393 sizeof(struct group_source_req));
1397 if (gsa->sin.sin_family != AF_INET ||
1398 gsa->sin.sin_len != sizeof(struct sockaddr_in))
1401 if (ssa->sin.sin_family != AF_INET ||
1402 ssa->sin.sin_len != sizeof(struct sockaddr_in))
1405 if (gsr.gsr_interface == 0 || V_if_index < gsr.gsr_interface)
1406 return (EADDRNOTAVAIL);
1408 ifp = ifnet_byindex(gsr.gsr_interface);
1410 if (sopt->sopt_name == MCAST_BLOCK_SOURCE)
1415 CTR2(KTR_IGMPV3, "%s: unknown sopt_name %d",
1416 __func__, sopt->sopt_name);
1417 return (EOPNOTSUPP);
1421 if (!IN_MULTICAST(ntohl(gsa->sin.sin_addr.s_addr)))
1425 * Check if we are actually a member of this group.
1427 imo = inp_findmoptions(inp);
1428 idx = imo_match_group(imo, ifp, &gsa->sa);
1429 if (idx == -1 || imo->imo_mfilters == NULL) {
1430 error = EADDRNOTAVAIL;
1431 goto out_inp_locked;
1434 KASSERT(imo->imo_mfilters != NULL,
1435 ("%s: imo_mfilters not allocated", __func__));
1436 imf = &imo->imo_mfilters[idx];
1437 inm = imo->imo_membership[idx];
1440 * Attempting to use the delta-based API on an
1441 * non exclusive-mode membership is an error.
1443 fmode = imf->imf_st[0];
1444 if (fmode != MCAST_EXCLUDE) {
1446 goto out_inp_locked;
1450 * Deal with error cases up-front:
1451 * Asked to block, but already blocked; or
1452 * Asked to unblock, but nothing to unblock.
1453 * If adding a new block entry, allocate it.
1455 ims = imo_match_source(imo, idx, &ssa->sa);
1456 if ((ims != NULL && doblock) || (ims == NULL && !doblock)) {
1457 CTR3(KTR_IGMPV3, "%s: source 0x%08x %spresent", __func__,
1458 ntohl(ssa->sin.sin_addr.s_addr), doblock ? "" : "not ");
1459 error = EADDRNOTAVAIL;
1460 goto out_inp_locked;
1463 INP_WLOCK_ASSERT(inp);
1466 * Begin state merge transaction at socket layer.
1469 CTR2(KTR_IGMPV3, "%s: %s source", __func__, "block");
1470 ims = imf_graft(imf, fmode, &ssa->sin);
1474 CTR2(KTR_IGMPV3, "%s: %s source", __func__, "allow");
1475 error = imf_prune(imf, &ssa->sin);
1479 CTR1(KTR_IGMPV3, "%s: merge imf state failed", __func__);
1480 goto out_imf_rollback;
1484 * Begin state merge transaction at IGMP layer.
1488 CTR1(KTR_IGMPV3, "%s: merge inm state", __func__);
1489 error = inm_merge(inm, imf);
1491 CTR1(KTR_IGMPV3, "%s: failed to merge inm state", __func__);
1492 goto out_in_multi_locked;
1495 CTR1(KTR_IGMPV3, "%s: doing igmp downcall", __func__);
1496 error = igmp_change_state(inm);
1498 CTR1(KTR_IGMPV3, "%s: failed igmp downcall", __func__);
1500 out_in_multi_locked:
1518 * Given an inpcb, return its multicast options structure pointer. Accepts
1519 * an unlocked inpcb pointer, but will return it locked. May sleep.
1521 * SMPng: NOTE: Potentially calls malloc(M_WAITOK) with Giant held.
1522 * SMPng: NOTE: Returns with the INP write lock held.
1524 static struct ip_moptions *
1525 inp_findmoptions(struct inpcb *inp)
1527 struct ip_moptions *imo;
1528 struct in_multi **immp;
1529 struct in_mfilter *imfp;
1533 if (inp->inp_moptions != NULL)
1534 return (inp->inp_moptions);
1538 imo = malloc(sizeof(*imo), M_IPMOPTS, M_WAITOK);
1539 immp = malloc(sizeof(*immp) * IP_MIN_MEMBERSHIPS, M_IPMOPTS,
1541 imfp = malloc(sizeof(struct in_mfilter) * IP_MIN_MEMBERSHIPS,
1542 M_INMFILTER, M_WAITOK);
1544 imo->imo_multicast_ifp = NULL;
1545 imo->imo_multicast_addr.s_addr = INADDR_ANY;
1546 imo->imo_multicast_vif = -1;
1547 imo->imo_multicast_ttl = IP_DEFAULT_MULTICAST_TTL;
1548 imo->imo_multicast_loop = in_mcast_loop;
1549 imo->imo_num_memberships = 0;
1550 imo->imo_max_memberships = IP_MIN_MEMBERSHIPS;
1551 imo->imo_membership = immp;
1553 /* Initialize per-group source filters. */
1554 for (idx = 0; idx < IP_MIN_MEMBERSHIPS; idx++)
1555 imf_init(&imfp[idx], MCAST_UNDEFINED, MCAST_EXCLUDE);
1556 imo->imo_mfilters = imfp;
1559 if (inp->inp_moptions != NULL) {
1560 free(imfp, M_INMFILTER);
1561 free(immp, M_IPMOPTS);
1562 free(imo, M_IPMOPTS);
1563 return (inp->inp_moptions);
1565 inp->inp_moptions = imo;
1570 * Discard the IP multicast options (and source filters). To minimize
1571 * the amount of work done while holding locks such as the INP's
1572 * pcbinfo lock (which is used in the receive path), the free
1573 * operation is performed asynchronously in a separate task.
1575 * SMPng: NOTE: assumes INP write lock is held.
1578 inp_freemoptions(struct ip_moptions *imo)
1581 KASSERT(imo != NULL, ("%s: ip_moptions is NULL", __func__));
1583 STAILQ_INSERT_TAIL(&imo_gc_list, imo, imo_link);
1585 taskqueue_enqueue(taskqueue_thread, &imo_gc_task);
1589 inp_freemoptions_internal(struct ip_moptions *imo)
1591 struct in_mfilter *imf;
1592 size_t idx, nmships;
1594 nmships = imo->imo_num_memberships;
1595 for (idx = 0; idx < nmships; ++idx) {
1596 imf = imo->imo_mfilters ? &imo->imo_mfilters[idx] : NULL;
1599 (void)in_leavegroup(imo->imo_membership[idx], imf);
1604 if (imo->imo_mfilters)
1605 free(imo->imo_mfilters, M_INMFILTER);
1606 free(imo->imo_membership, M_IPMOPTS);
1607 free(imo, M_IPMOPTS);
1611 inp_gcmoptions(void *context, int pending)
1613 struct ip_moptions *imo;
1616 while (!STAILQ_EMPTY(&imo_gc_list)) {
1617 imo = STAILQ_FIRST(&imo_gc_list);
1618 STAILQ_REMOVE_HEAD(&imo_gc_list, imo_link);
1620 inp_freemoptions_internal(imo);
1627 * Atomically get source filters on a socket for an IPv4 multicast group.
1628 * Called with INP lock held; returns with lock released.
1631 inp_get_source_filters(struct inpcb *inp, struct sockopt *sopt)
1633 struct __msfilterreq msfr;
1636 struct ip_moptions *imo;
1637 struct in_mfilter *imf;
1638 struct ip_msource *ims;
1639 struct in_msource *lims;
1640 struct sockaddr_in *psin;
1641 struct sockaddr_storage *ptss;
1642 struct sockaddr_storage *tss;
1644 size_t idx, nsrcs, ncsrcs;
1646 INP_WLOCK_ASSERT(inp);
1648 imo = inp->inp_moptions;
1649 KASSERT(imo != NULL, ("%s: null ip_moptions", __func__));
1653 error = sooptcopyin(sopt, &msfr, sizeof(struct __msfilterreq),
1654 sizeof(struct __msfilterreq));
1658 if (msfr.msfr_ifindex == 0 || V_if_index < msfr.msfr_ifindex)
1661 ifp = ifnet_byindex(msfr.msfr_ifindex);
1668 * Lookup group on the socket.
1670 gsa = (sockunion_t *)&msfr.msfr_group;
1671 idx = imo_match_group(imo, ifp, &gsa->sa);
1672 if (idx == -1 || imo->imo_mfilters == NULL) {
1674 return (EADDRNOTAVAIL);
1676 imf = &imo->imo_mfilters[idx];
1679 * Ignore memberships which are in limbo.
1681 if (imf->imf_st[1] == MCAST_UNDEFINED) {
1685 msfr.msfr_fmode = imf->imf_st[1];
1688 * If the user specified a buffer, copy out the source filter
1689 * entries to userland gracefully.
1690 * We only copy out the number of entries which userland
1691 * has asked for, but we always tell userland how big the
1692 * buffer really needs to be.
1694 if (msfr.msfr_nsrcs > in_mcast_maxsocksrc)
1695 msfr.msfr_nsrcs = in_mcast_maxsocksrc;
1697 if (msfr.msfr_srcs != NULL && msfr.msfr_nsrcs > 0) {
1698 tss = malloc(sizeof(struct sockaddr_storage) * msfr.msfr_nsrcs,
1699 M_TEMP, M_NOWAIT | M_ZERO);
1707 * Count number of sources in-mode at t0.
1708 * If buffer space exists and remains, copy out source entries.
1710 nsrcs = msfr.msfr_nsrcs;
1713 RB_FOREACH(ims, ip_msource_tree, &imf->imf_sources) {
1714 lims = (struct in_msource *)ims;
1715 if (lims->imsl_st[0] == MCAST_UNDEFINED ||
1716 lims->imsl_st[0] != imf->imf_st[0])
1719 if (tss != NULL && nsrcs > 0) {
1720 psin = (struct sockaddr_in *)ptss;
1721 psin->sin_family = AF_INET;
1722 psin->sin_len = sizeof(struct sockaddr_in);
1723 psin->sin_addr.s_addr = htonl(lims->ims_haddr);
1733 error = copyout(tss, msfr.msfr_srcs,
1734 sizeof(struct sockaddr_storage) * msfr.msfr_nsrcs);
1740 msfr.msfr_nsrcs = ncsrcs;
1741 error = sooptcopyout(sopt, &msfr, sizeof(struct __msfilterreq));
1747 * Return the IP multicast options in response to user getsockopt().
1750 inp_getmoptions(struct inpcb *inp, struct sockopt *sopt)
1752 struct rm_priotracker in_ifa_tracker;
1753 struct ip_mreqn mreqn;
1754 struct ip_moptions *imo;
1756 struct in_ifaddr *ia;
1761 imo = inp->inp_moptions;
1763 * If socket is neither of type SOCK_RAW or SOCK_DGRAM,
1764 * or is a divert socket, reject it.
1766 if (inp->inp_socket->so_proto->pr_protocol == IPPROTO_DIVERT ||
1767 (inp->inp_socket->so_proto->pr_type != SOCK_RAW &&
1768 inp->inp_socket->so_proto->pr_type != SOCK_DGRAM)) {
1770 return (EOPNOTSUPP);
1774 switch (sopt->sopt_name) {
1775 case IP_MULTICAST_VIF:
1777 optval = imo->imo_multicast_vif;
1781 error = sooptcopyout(sopt, &optval, sizeof(int));
1784 case IP_MULTICAST_IF:
1785 memset(&mreqn, 0, sizeof(struct ip_mreqn));
1787 ifp = imo->imo_multicast_ifp;
1788 if (!in_nullhost(imo->imo_multicast_addr)) {
1789 mreqn.imr_address = imo->imo_multicast_addr;
1790 } else if (ifp != NULL) {
1791 mreqn.imr_ifindex = ifp->if_index;
1792 IFP_TO_IA(ifp, ia, &in_ifa_tracker);
1795 IA_SIN(ia)->sin_addr;
1796 ifa_free(&ia->ia_ifa);
1801 if (sopt->sopt_valsize == sizeof(struct ip_mreqn)) {
1802 error = sooptcopyout(sopt, &mreqn,
1803 sizeof(struct ip_mreqn));
1805 error = sooptcopyout(sopt, &mreqn.imr_address,
1806 sizeof(struct in_addr));
1810 case IP_MULTICAST_TTL:
1812 optval = coptval = IP_DEFAULT_MULTICAST_TTL;
1814 optval = coptval = imo->imo_multicast_ttl;
1816 if (sopt->sopt_valsize == sizeof(u_char))
1817 error = sooptcopyout(sopt, &coptval, sizeof(u_char));
1819 error = sooptcopyout(sopt, &optval, sizeof(int));
1822 case IP_MULTICAST_LOOP:
1824 optval = coptval = IP_DEFAULT_MULTICAST_LOOP;
1826 optval = coptval = imo->imo_multicast_loop;
1828 if (sopt->sopt_valsize == sizeof(u_char))
1829 error = sooptcopyout(sopt, &coptval, sizeof(u_char));
1831 error = sooptcopyout(sopt, &optval, sizeof(int));
1836 error = EADDRNOTAVAIL;
1839 error = inp_get_source_filters(inp, sopt);
1845 error = ENOPROTOOPT;
1849 INP_UNLOCK_ASSERT(inp);
1855 * Look up the ifnet to use for a multicast group membership,
1856 * given the IPv4 address of an interface, and the IPv4 group address.
1858 * This routine exists to support legacy multicast applications
1859 * which do not understand that multicast memberships are scoped to
1860 * specific physical links in the networking stack, or which need
1861 * to join link-scope groups before IPv4 addresses are configured.
1863 * If inp is non-NULL, use this socket's current FIB number for any
1864 * required FIB lookup.
1865 * If ina is INADDR_ANY, look up the group address in the unicast FIB,
1866 * and use its ifp; usually, this points to the default next-hop.
1868 * If the FIB lookup fails, attempt to use the first non-loopback
1869 * interface with multicast capability in the system as a
1870 * last resort. The legacy IPv4 ASM API requires that we do
1871 * this in order to allow groups to be joined when the routing
1872 * table has not yet been populated during boot.
1874 * Returns NULL if no ifp could be found.
1876 * SMPng: TODO: Acquire the appropriate locks for INADDR_TO_IFP.
1877 * FUTURE: Implement IPv4 source-address selection.
1879 static struct ifnet *
1880 inp_lookup_mcast_ifp(const struct inpcb *inp,
1881 const struct sockaddr_in *gsin, const struct in_addr ina)
1883 struct rm_priotracker in_ifa_tracker;
1885 struct nhop4_basic nh4;
1888 KASSERT(gsin->sin_family == AF_INET, ("%s: not AF_INET", __func__));
1889 KASSERT(IN_MULTICAST(ntohl(gsin->sin_addr.s_addr)),
1890 ("%s: not multicast", __func__));
1893 if (!in_nullhost(ina)) {
1894 INADDR_TO_IFP(ina, ifp);
1896 fibnum = inp ? inp->inp_inc.inc_fibnum : 0;
1897 if (fib4_lookup_nh_basic(fibnum, gsin->sin_addr, 0, 0, &nh4)==0)
1900 struct in_ifaddr *ia;
1904 IN_IFADDR_RLOCK(&in_ifa_tracker);
1905 TAILQ_FOREACH(ia, &V_in_ifaddrhead, ia_link) {
1907 if (!(mifp->if_flags & IFF_LOOPBACK) &&
1908 (mifp->if_flags & IFF_MULTICAST)) {
1913 IN_IFADDR_RUNLOCK(&in_ifa_tracker);
1921 * Join an IPv4 multicast group, possibly with a source.
1924 inp_join_group(struct inpcb *inp, struct sockopt *sopt)
1926 struct group_source_req gsr;
1927 sockunion_t *gsa, *ssa;
1929 struct in_mfilter *imf;
1930 struct ip_moptions *imo;
1931 struct in_multi *inm;
1932 struct in_msource *lims;
1942 memset(&gsr, 0, sizeof(struct group_source_req));
1943 gsa = (sockunion_t *)&gsr.gsr_group;
1944 gsa->ss.ss_family = AF_UNSPEC;
1945 ssa = (sockunion_t *)&gsr.gsr_source;
1946 ssa->ss.ss_family = AF_UNSPEC;
1948 switch (sopt->sopt_name) {
1949 case IP_ADD_MEMBERSHIP:
1950 case IP_ADD_SOURCE_MEMBERSHIP: {
1951 struct ip_mreq_source mreqs;
1953 if (sopt->sopt_name == IP_ADD_MEMBERSHIP) {
1954 error = sooptcopyin(sopt, &mreqs,
1955 sizeof(struct ip_mreq),
1956 sizeof(struct ip_mreq));
1958 * Do argument switcharoo from ip_mreq into
1959 * ip_mreq_source to avoid using two instances.
1961 mreqs.imr_interface = mreqs.imr_sourceaddr;
1962 mreqs.imr_sourceaddr.s_addr = INADDR_ANY;
1963 } else if (sopt->sopt_name == IP_ADD_SOURCE_MEMBERSHIP) {
1964 error = sooptcopyin(sopt, &mreqs,
1965 sizeof(struct ip_mreq_source),
1966 sizeof(struct ip_mreq_source));
1971 gsa->sin.sin_family = AF_INET;
1972 gsa->sin.sin_len = sizeof(struct sockaddr_in);
1973 gsa->sin.sin_addr = mreqs.imr_multiaddr;
1975 if (sopt->sopt_name == IP_ADD_SOURCE_MEMBERSHIP) {
1976 ssa->sin.sin_family = AF_INET;
1977 ssa->sin.sin_len = sizeof(struct sockaddr_in);
1978 ssa->sin.sin_addr = mreqs.imr_sourceaddr;
1981 if (!IN_MULTICAST(ntohl(gsa->sin.sin_addr.s_addr)))
1984 ifp = inp_lookup_mcast_ifp(inp, &gsa->sin,
1985 mreqs.imr_interface);
1986 CTR3(KTR_IGMPV3, "%s: imr_interface = 0x%08x, ifp = %p",
1987 __func__, ntohl(mreqs.imr_interface.s_addr), ifp);
1991 case MCAST_JOIN_GROUP:
1992 case MCAST_JOIN_SOURCE_GROUP:
1993 if (sopt->sopt_name == MCAST_JOIN_GROUP) {
1994 error = sooptcopyin(sopt, &gsr,
1995 sizeof(struct group_req),
1996 sizeof(struct group_req));
1997 } else if (sopt->sopt_name == MCAST_JOIN_SOURCE_GROUP) {
1998 error = sooptcopyin(sopt, &gsr,
1999 sizeof(struct group_source_req),
2000 sizeof(struct group_source_req));
2005 if (gsa->sin.sin_family != AF_INET ||
2006 gsa->sin.sin_len != sizeof(struct sockaddr_in))
2010 * Overwrite the port field if present, as the sockaddr
2011 * being copied in may be matched with a binary comparison.
2013 gsa->sin.sin_port = 0;
2014 if (sopt->sopt_name == MCAST_JOIN_SOURCE_GROUP) {
2015 if (ssa->sin.sin_family != AF_INET ||
2016 ssa->sin.sin_len != sizeof(struct sockaddr_in))
2018 ssa->sin.sin_port = 0;
2021 if (!IN_MULTICAST(ntohl(gsa->sin.sin_addr.s_addr)))
2024 if (gsr.gsr_interface == 0 || V_if_index < gsr.gsr_interface)
2025 return (EADDRNOTAVAIL);
2026 ifp = ifnet_byindex(gsr.gsr_interface);
2030 CTR2(KTR_IGMPV3, "%s: unknown sopt_name %d",
2031 __func__, sopt->sopt_name);
2032 return (EOPNOTSUPP);
2036 if (ifp == NULL || (ifp->if_flags & IFF_MULTICAST) == 0)
2037 return (EADDRNOTAVAIL);
2039 imo = inp_findmoptions(inp);
2040 idx = imo_match_group(imo, ifp, &gsa->sa);
2044 inm = imo->imo_membership[idx];
2045 imf = &imo->imo_mfilters[idx];
2046 if (ssa->ss.ss_family != AF_UNSPEC) {
2048 * MCAST_JOIN_SOURCE_GROUP on an exclusive membership
2049 * is an error. On an existing inclusive membership,
2050 * it just adds the source to the filter list.
2052 if (imf->imf_st[1] != MCAST_INCLUDE) {
2054 goto out_inp_locked;
2057 * Throw out duplicates.
2059 * XXX FIXME: This makes a naive assumption that
2060 * even if entries exist for *ssa in this imf,
2061 * they will be rejected as dupes, even if they
2062 * are not valid in the current mode (in-mode).
2064 * in_msource is transactioned just as for anything
2065 * else in SSM -- but note naive use of inm_graft()
2066 * below for allocating new filter entries.
2068 * This is only an issue if someone mixes the
2069 * full-state SSM API with the delta-based API,
2070 * which is discouraged in the relevant RFCs.
2072 lims = imo_match_source(imo, idx, &ssa->sa);
2073 if (lims != NULL /*&&
2074 lims->imsl_st[1] == MCAST_INCLUDE*/) {
2075 error = EADDRNOTAVAIL;
2076 goto out_inp_locked;
2080 * MCAST_JOIN_GROUP on an existing exclusive
2081 * membership is an error; return EADDRINUSE
2082 * to preserve 4.4BSD API idempotence, and
2083 * avoid tedious detour to code below.
2084 * NOTE: This is bending RFC 3678 a bit.
2086 * On an existing inclusive membership, this is also
2087 * an error; if you want to change filter mode,
2088 * you must use the userland API setsourcefilter().
2089 * XXX We don't reject this for imf in UNDEFINED
2090 * state at t1, because allocation of a filter
2091 * is atomic with allocation of a membership.
2094 if (imf->imf_st[1] == MCAST_EXCLUDE)
2096 goto out_inp_locked;
2101 * Begin state merge transaction at socket layer.
2103 INP_WLOCK_ASSERT(inp);
2106 if (imo->imo_num_memberships == imo->imo_max_memberships) {
2107 error = imo_grow(imo);
2109 goto out_inp_locked;
2112 * Allocate the new slot upfront so we can deal with
2113 * grafting the new source filter in same code path
2114 * as for join-source on existing membership.
2116 idx = imo->imo_num_memberships;
2117 imo->imo_membership[idx] = NULL;
2118 imo->imo_num_memberships++;
2119 KASSERT(imo->imo_mfilters != NULL,
2120 ("%s: imf_mfilters vector was not allocated", __func__));
2121 imf = &imo->imo_mfilters[idx];
2122 KASSERT(RB_EMPTY(&imf->imf_sources),
2123 ("%s: imf_sources not empty", __func__));
2127 * Graft new source into filter list for this inpcb's
2128 * membership of the group. The in_multi may not have
2129 * been allocated yet if this is a new membership, however,
2130 * the in_mfilter slot will be allocated and must be initialized.
2132 * Note: Grafting of exclusive mode filters doesn't happen
2134 * XXX: Should check for non-NULL lims (node exists but may
2135 * not be in-mode) for interop with full-state API.
2137 if (ssa->ss.ss_family != AF_UNSPEC) {
2138 /* Membership starts in IN mode */
2140 CTR1(KTR_IGMPV3, "%s: new join w/source", __func__);
2141 imf_init(imf, MCAST_UNDEFINED, MCAST_INCLUDE);
2143 CTR2(KTR_IGMPV3, "%s: %s source", __func__, "allow");
2145 lims = imf_graft(imf, MCAST_INCLUDE, &ssa->sin);
2147 CTR1(KTR_IGMPV3, "%s: merge imf state failed",
2153 /* No address specified; Membership starts in EX mode */
2155 CTR1(KTR_IGMPV3, "%s: new join w/o source", __func__);
2156 imf_init(imf, MCAST_UNDEFINED, MCAST_EXCLUDE);
2161 * Begin state merge transaction at IGMP layer.
2166 error = in_joingroup_locked(ifp, &gsa->sin.sin_addr, imf,
2169 CTR1(KTR_IGMPV3, "%s: in_joingroup_locked failed",
2174 imo->imo_membership[idx] = inm;
2176 CTR1(KTR_IGMPV3, "%s: merge inm state", __func__);
2177 error = inm_merge(inm, imf);
2179 CTR1(KTR_IGMPV3, "%s: failed to merge inm state",
2181 goto out_in_multi_locked;
2183 CTR1(KTR_IGMPV3, "%s: doing igmp downcall", __func__);
2184 error = igmp_change_state(inm);
2186 CTR1(KTR_IGMPV3, "%s: failed igmp downcall",
2188 goto out_in_multi_locked;
2192 out_in_multi_locked:
2196 INP_WLOCK_ASSERT(inp);
2208 if (error && is_new) {
2209 imo->imo_membership[idx] = NULL;
2210 --imo->imo_num_memberships;
2219 * Leave an IPv4 multicast group on an inpcb, possibly with a source.
2222 inp_leave_group(struct inpcb *inp, struct sockopt *sopt)
2224 struct group_source_req gsr;
2225 struct ip_mreq_source mreqs;
2226 sockunion_t *gsa, *ssa;
2228 struct in_mfilter *imf;
2229 struct ip_moptions *imo;
2230 struct in_msource *ims;
2231 struct in_multi *inm;
2233 int error, is_final;
2239 memset(&gsr, 0, sizeof(struct group_source_req));
2240 gsa = (sockunion_t *)&gsr.gsr_group;
2241 gsa->ss.ss_family = AF_UNSPEC;
2242 ssa = (sockunion_t *)&gsr.gsr_source;
2243 ssa->ss.ss_family = AF_UNSPEC;
2245 switch (sopt->sopt_name) {
2246 case IP_DROP_MEMBERSHIP:
2247 case IP_DROP_SOURCE_MEMBERSHIP:
2248 if (sopt->sopt_name == IP_DROP_MEMBERSHIP) {
2249 error = sooptcopyin(sopt, &mreqs,
2250 sizeof(struct ip_mreq),
2251 sizeof(struct ip_mreq));
2253 * Swap interface and sourceaddr arguments,
2254 * as ip_mreq and ip_mreq_source are laid
2257 mreqs.imr_interface = mreqs.imr_sourceaddr;
2258 mreqs.imr_sourceaddr.s_addr = INADDR_ANY;
2259 } else if (sopt->sopt_name == IP_DROP_SOURCE_MEMBERSHIP) {
2260 error = sooptcopyin(sopt, &mreqs,
2261 sizeof(struct ip_mreq_source),
2262 sizeof(struct ip_mreq_source));
2267 gsa->sin.sin_family = AF_INET;
2268 gsa->sin.sin_len = sizeof(struct sockaddr_in);
2269 gsa->sin.sin_addr = mreqs.imr_multiaddr;
2271 if (sopt->sopt_name == IP_DROP_SOURCE_MEMBERSHIP) {
2272 ssa->sin.sin_family = AF_INET;
2273 ssa->sin.sin_len = sizeof(struct sockaddr_in);
2274 ssa->sin.sin_addr = mreqs.imr_sourceaddr;
2278 * Attempt to look up hinted ifp from interface address.
2279 * Fallthrough with null ifp iff lookup fails, to
2280 * preserve 4.4BSD mcast API idempotence.
2281 * XXX NOTE WELL: The RFC 3678 API is preferred because
2282 * using an IPv4 address as a key is racy.
2284 if (!in_nullhost(mreqs.imr_interface))
2285 INADDR_TO_IFP(mreqs.imr_interface, ifp);
2287 CTR3(KTR_IGMPV3, "%s: imr_interface = 0x%08x, ifp = %p",
2288 __func__, ntohl(mreqs.imr_interface.s_addr), ifp);
2292 case MCAST_LEAVE_GROUP:
2293 case MCAST_LEAVE_SOURCE_GROUP:
2294 if (sopt->sopt_name == MCAST_LEAVE_GROUP) {
2295 error = sooptcopyin(sopt, &gsr,
2296 sizeof(struct group_req),
2297 sizeof(struct group_req));
2298 } else if (sopt->sopt_name == MCAST_LEAVE_SOURCE_GROUP) {
2299 error = sooptcopyin(sopt, &gsr,
2300 sizeof(struct group_source_req),
2301 sizeof(struct group_source_req));
2306 if (gsa->sin.sin_family != AF_INET ||
2307 gsa->sin.sin_len != sizeof(struct sockaddr_in))
2310 if (sopt->sopt_name == MCAST_LEAVE_SOURCE_GROUP) {
2311 if (ssa->sin.sin_family != AF_INET ||
2312 ssa->sin.sin_len != sizeof(struct sockaddr_in))
2316 if (gsr.gsr_interface == 0 || V_if_index < gsr.gsr_interface)
2317 return (EADDRNOTAVAIL);
2319 ifp = ifnet_byindex(gsr.gsr_interface);
2322 return (EADDRNOTAVAIL);
2326 CTR2(KTR_IGMPV3, "%s: unknown sopt_name %d",
2327 __func__, sopt->sopt_name);
2328 return (EOPNOTSUPP);
2332 if (!IN_MULTICAST(ntohl(gsa->sin.sin_addr.s_addr)))
2336 * Find the membership in the membership array.
2338 imo = inp_findmoptions(inp);
2339 idx = imo_match_group(imo, ifp, &gsa->sa);
2341 error = EADDRNOTAVAIL;
2342 goto out_inp_locked;
2344 inm = imo->imo_membership[idx];
2345 imf = &imo->imo_mfilters[idx];
2347 if (ssa->ss.ss_family != AF_UNSPEC)
2351 * Begin state merge transaction at socket layer.
2353 INP_WLOCK_ASSERT(inp);
2356 * If we were instructed only to leave a given source, do so.
2357 * MCAST_LEAVE_SOURCE_GROUP is only valid for inclusive memberships.
2362 if (imf->imf_st[0] == MCAST_EXCLUDE) {
2363 error = EADDRNOTAVAIL;
2364 goto out_inp_locked;
2366 ims = imo_match_source(imo, idx, &ssa->sa);
2368 CTR3(KTR_IGMPV3, "%s: source 0x%08x %spresent",
2369 __func__, ntohl(ssa->sin.sin_addr.s_addr), "not ");
2370 error = EADDRNOTAVAIL;
2371 goto out_inp_locked;
2373 CTR2(KTR_IGMPV3, "%s: %s source", __func__, "block");
2374 error = imf_prune(imf, &ssa->sin);
2376 CTR1(KTR_IGMPV3, "%s: merge imf state failed",
2378 goto out_inp_locked;
2383 * Begin state merge transaction at IGMP layer.
2389 * Give up the multicast address record to which
2390 * the membership points.
2392 (void)in_leavegroup_locked(inm, imf);
2394 CTR1(KTR_IGMPV3, "%s: merge inm state", __func__);
2395 error = inm_merge(inm, imf);
2397 CTR1(KTR_IGMPV3, "%s: failed to merge inm state",
2399 goto out_in_multi_locked;
2402 CTR1(KTR_IGMPV3, "%s: doing igmp downcall", __func__);
2403 error = igmp_change_state(inm);
2405 CTR1(KTR_IGMPV3, "%s: failed igmp downcall",
2410 out_in_multi_locked:
2422 /* Remove the gap in the membership and filter array. */
2423 for (++idx; idx < imo->imo_num_memberships; ++idx) {
2424 imo->imo_membership[idx-1] = imo->imo_membership[idx];
2425 imo->imo_mfilters[idx-1] = imo->imo_mfilters[idx];
2427 imo->imo_num_memberships--;
2436 * Select the interface for transmitting IPv4 multicast datagrams.
2438 * Either an instance of struct in_addr or an instance of struct ip_mreqn
2439 * may be passed to this socket option. An address of INADDR_ANY or an
2440 * interface index of 0 is used to remove a previous selection.
2441 * When no interface is selected, one is chosen for every send.
2444 inp_set_multicast_if(struct inpcb *inp, struct sockopt *sopt)
2446 struct in_addr addr;
2447 struct ip_mreqn mreqn;
2449 struct ip_moptions *imo;
2452 if (sopt->sopt_valsize == sizeof(struct ip_mreqn)) {
2454 * An interface index was specified using the
2455 * Linux-derived ip_mreqn structure.
2457 error = sooptcopyin(sopt, &mreqn, sizeof(struct ip_mreqn),
2458 sizeof(struct ip_mreqn));
2462 if (mreqn.imr_ifindex < 0 || V_if_index < mreqn.imr_ifindex)
2465 if (mreqn.imr_ifindex == 0) {
2468 ifp = ifnet_byindex(mreqn.imr_ifindex);
2470 return (EADDRNOTAVAIL);
2474 * An interface was specified by IPv4 address.
2475 * This is the traditional BSD usage.
2477 error = sooptcopyin(sopt, &addr, sizeof(struct in_addr),
2478 sizeof(struct in_addr));
2481 if (in_nullhost(addr)) {
2484 INADDR_TO_IFP(addr, ifp);
2486 return (EADDRNOTAVAIL);
2488 CTR3(KTR_IGMPV3, "%s: ifp = %p, addr = 0x%08x", __func__, ifp,
2489 ntohl(addr.s_addr));
2492 /* Reject interfaces which do not support multicast. */
2493 if (ifp != NULL && (ifp->if_flags & IFF_MULTICAST) == 0)
2494 return (EOPNOTSUPP);
2496 imo = inp_findmoptions(inp);
2497 imo->imo_multicast_ifp = ifp;
2498 imo->imo_multicast_addr.s_addr = INADDR_ANY;
2505 * Atomically set source filters on a socket for an IPv4 multicast group.
2507 * SMPng: NOTE: Potentially calls malloc(M_WAITOK) with Giant held.
2510 inp_set_source_filters(struct inpcb *inp, struct sockopt *sopt)
2512 struct __msfilterreq msfr;
2515 struct in_mfilter *imf;
2516 struct ip_moptions *imo;
2517 struct in_multi *inm;
2521 error = sooptcopyin(sopt, &msfr, sizeof(struct __msfilterreq),
2522 sizeof(struct __msfilterreq));
2526 if (msfr.msfr_nsrcs > in_mcast_maxsocksrc)
2529 if ((msfr.msfr_fmode != MCAST_EXCLUDE &&
2530 msfr.msfr_fmode != MCAST_INCLUDE))
2533 if (msfr.msfr_group.ss_family != AF_INET ||
2534 msfr.msfr_group.ss_len != sizeof(struct sockaddr_in))
2537 gsa = (sockunion_t *)&msfr.msfr_group;
2538 if (!IN_MULTICAST(ntohl(gsa->sin.sin_addr.s_addr)))
2541 gsa->sin.sin_port = 0; /* ignore port */
2543 if (msfr.msfr_ifindex == 0 || V_if_index < msfr.msfr_ifindex)
2544 return (EADDRNOTAVAIL);
2546 ifp = ifnet_byindex(msfr.msfr_ifindex);
2548 return (EADDRNOTAVAIL);
2551 * Take the INP write lock.
2552 * Check if this socket is a member of this group.
2554 imo = inp_findmoptions(inp);
2555 idx = imo_match_group(imo, ifp, &gsa->sa);
2556 if (idx == -1 || imo->imo_mfilters == NULL) {
2557 error = EADDRNOTAVAIL;
2558 goto out_inp_locked;
2560 inm = imo->imo_membership[idx];
2561 imf = &imo->imo_mfilters[idx];
2564 * Begin state merge transaction at socket layer.
2566 INP_WLOCK_ASSERT(inp);
2568 imf->imf_st[1] = msfr.msfr_fmode;
2571 * Apply any new source filters, if present.
2572 * Make a copy of the user-space source vector so
2573 * that we may copy them with a single copyin. This
2574 * allows us to deal with page faults up-front.
2576 if (msfr.msfr_nsrcs > 0) {
2577 struct in_msource *lims;
2578 struct sockaddr_in *psin;
2579 struct sockaddr_storage *kss, *pkss;
2584 CTR2(KTR_IGMPV3, "%s: loading %lu source list entries",
2585 __func__, (unsigned long)msfr.msfr_nsrcs);
2586 kss = malloc(sizeof(struct sockaddr_storage) * msfr.msfr_nsrcs,
2588 error = copyin(msfr.msfr_srcs, kss,
2589 sizeof(struct sockaddr_storage) * msfr.msfr_nsrcs);
2598 * Mark all source filters as UNDEFINED at t1.
2599 * Restore new group filter mode, as imf_leave()
2600 * will set it to INCLUDE.
2603 imf->imf_st[1] = msfr.msfr_fmode;
2606 * Update socket layer filters at t1, lazy-allocating
2607 * new entries. This saves a bunch of memory at the
2608 * cost of one RB_FIND() per source entry; duplicate
2609 * entries in the msfr_nsrcs vector are ignored.
2610 * If we encounter an error, rollback transaction.
2612 * XXX This too could be replaced with a set-symmetric
2613 * difference like loop to avoid walking from root
2614 * every time, as the key space is common.
2616 for (i = 0, pkss = kss; i < msfr.msfr_nsrcs; i++, pkss++) {
2617 psin = (struct sockaddr_in *)pkss;
2618 if (psin->sin_family != AF_INET) {
2619 error = EAFNOSUPPORT;
2622 if (psin->sin_len != sizeof(struct sockaddr_in)) {
2626 error = imf_get_source(imf, psin, &lims);
2629 lims->imsl_st[1] = imf->imf_st[1];
2635 goto out_imf_rollback;
2637 INP_WLOCK_ASSERT(inp);
2641 * Begin state merge transaction at IGMP layer.
2643 CTR1(KTR_IGMPV3, "%s: merge inm state", __func__);
2644 error = inm_merge(inm, imf);
2646 CTR1(KTR_IGMPV3, "%s: failed to merge inm state", __func__);
2647 goto out_in_multi_locked;
2650 CTR1(KTR_IGMPV3, "%s: doing igmp downcall", __func__);
2651 error = igmp_change_state(inm);
2653 CTR1(KTR_IGMPV3, "%s: failed igmp downcall", __func__);
2655 out_in_multi_locked:
2673 * Set the IP multicast options in response to user setsockopt().
2675 * Many of the socket options handled in this function duplicate the
2676 * functionality of socket options in the regular unicast API. However,
2677 * it is not possible to merge the duplicate code, because the idempotence
2678 * of the IPv4 multicast part of the BSD Sockets API must be preserved;
2679 * the effects of these options must be treated as separate and distinct.
2681 * SMPng: XXX: Unlocked read of inp_socket believed OK.
2682 * FUTURE: The IP_MULTICAST_VIF option may be eliminated if MROUTING
2683 * is refactored to no longer use vifs.
2686 inp_setmoptions(struct inpcb *inp, struct sockopt *sopt)
2688 struct ip_moptions *imo;
2694 * If socket is neither of type SOCK_RAW or SOCK_DGRAM,
2695 * or is a divert socket, reject it.
2697 if (inp->inp_socket->so_proto->pr_protocol == IPPROTO_DIVERT ||
2698 (inp->inp_socket->so_proto->pr_type != SOCK_RAW &&
2699 inp->inp_socket->so_proto->pr_type != SOCK_DGRAM))
2700 return (EOPNOTSUPP);
2702 switch (sopt->sopt_name) {
2703 case IP_MULTICAST_VIF: {
2706 * Select a multicast VIF for transmission.
2707 * Only useful if multicast forwarding is active.
2709 if (legal_vif_num == NULL) {
2713 error = sooptcopyin(sopt, &vifi, sizeof(int), sizeof(int));
2716 if (!legal_vif_num(vifi) && (vifi != -1)) {
2720 imo = inp_findmoptions(inp);
2721 imo->imo_multicast_vif = vifi;
2726 case IP_MULTICAST_IF:
2727 error = inp_set_multicast_if(inp, sopt);
2730 case IP_MULTICAST_TTL: {
2734 * Set the IP time-to-live for outgoing multicast packets.
2735 * The original multicast API required a char argument,
2736 * which is inconsistent with the rest of the socket API.
2737 * We allow either a char or an int.
2739 if (sopt->sopt_valsize == sizeof(u_char)) {
2740 error = sooptcopyin(sopt, &ttl, sizeof(u_char),
2747 error = sooptcopyin(sopt, &ittl, sizeof(u_int),
2757 imo = inp_findmoptions(inp);
2758 imo->imo_multicast_ttl = ttl;
2763 case IP_MULTICAST_LOOP: {
2767 * Set the loopback flag for outgoing multicast packets.
2768 * Must be zero or one. The original multicast API required a
2769 * char argument, which is inconsistent with the rest
2770 * of the socket API. We allow either a char or an int.
2772 if (sopt->sopt_valsize == sizeof(u_char)) {
2773 error = sooptcopyin(sopt, &loop, sizeof(u_char),
2780 error = sooptcopyin(sopt, &iloop, sizeof(u_int),
2784 loop = (u_char)iloop;
2786 imo = inp_findmoptions(inp);
2787 imo->imo_multicast_loop = !!loop;
2792 case IP_ADD_MEMBERSHIP:
2793 case IP_ADD_SOURCE_MEMBERSHIP:
2794 case MCAST_JOIN_GROUP:
2795 case MCAST_JOIN_SOURCE_GROUP:
2796 error = inp_join_group(inp, sopt);
2799 case IP_DROP_MEMBERSHIP:
2800 case IP_DROP_SOURCE_MEMBERSHIP:
2801 case MCAST_LEAVE_GROUP:
2802 case MCAST_LEAVE_SOURCE_GROUP:
2803 error = inp_leave_group(inp, sopt);
2806 case IP_BLOCK_SOURCE:
2807 case IP_UNBLOCK_SOURCE:
2808 case MCAST_BLOCK_SOURCE:
2809 case MCAST_UNBLOCK_SOURCE:
2810 error = inp_block_unblock_source(inp, sopt);
2814 error = inp_set_source_filters(inp, sopt);
2822 INP_UNLOCK_ASSERT(inp);
2828 * Expose IGMP's multicast filter mode and source list(s) to userland,
2829 * keyed by (ifindex, group).
2830 * The filter mode is written out as a uint32_t, followed by
2831 * 0..n of struct in_addr.
2832 * For use by ifmcstat(8).
2833 * SMPng: NOTE: unlocked read of ifindex space.
2836 sysctl_ip_mcast_filters(SYSCTL_HANDLER_ARGS)
2838 struct in_addr src, group;
2840 struct ifmultiaddr *ifma;
2841 struct in_multi *inm;
2842 struct ip_msource *ims;
2846 uint32_t fmode, ifindex;
2851 if (req->newptr != NULL)
2858 if (ifindex <= 0 || ifindex > V_if_index) {
2859 CTR2(KTR_IGMPV3, "%s: ifindex %u out of range",
2864 group.s_addr = name[1];
2865 if (!IN_MULTICAST(ntohl(group.s_addr))) {
2866 CTR2(KTR_IGMPV3, "%s: group 0x%08x is not multicast",
2867 __func__, ntohl(group.s_addr));
2871 ifp = ifnet_byindex(ifindex);
2873 CTR2(KTR_IGMPV3, "%s: no ifp for ifindex %u",
2878 retval = sysctl_wire_old_buffer(req,
2879 sizeof(uint32_t) + (in_mcast_maxgrpsrc * sizeof(struct in_addr)));
2886 TAILQ_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link) {
2887 if (ifma->ifma_addr->sa_family != AF_INET ||
2888 ifma->ifma_protospec == NULL)
2890 inm = (struct in_multi *)ifma->ifma_protospec;
2891 if (!in_hosteq(inm->inm_addr, group))
2893 fmode = inm->inm_st[1].iss_fmode;
2894 retval = SYSCTL_OUT(req, &fmode, sizeof(uint32_t));
2897 RB_FOREACH(ims, ip_msource_tree, &inm->inm_srcs) {
2898 CTR2(KTR_IGMPV3, "%s: visit node 0x%08x", __func__,
2901 * Only copy-out sources which are in-mode.
2903 if (fmode != ims_get_mode(inm, ims, 1)) {
2904 CTR1(KTR_IGMPV3, "%s: skip non-in-mode",
2908 src.s_addr = htonl(ims->ims_haddr);
2909 retval = SYSCTL_OUT(req, &src, sizeof(struct in_addr));
2914 IF_ADDR_RUNLOCK(ifp);
2921 #if defined(KTR) && (KTR_COMPILE & KTR_IGMPV3)
2923 static const char *inm_modestrs[] = { "un", "in", "ex" };
2926 inm_mode_str(const int mode)
2929 if (mode >= MCAST_UNDEFINED && mode <= MCAST_EXCLUDE)
2930 return (inm_modestrs[mode]);
2934 static const char *inm_statestrs[] = {
2947 inm_state_str(const int state)
2950 if (state >= IGMP_NOT_MEMBER && state <= IGMP_LEAVING_MEMBER)
2951 return (inm_statestrs[state]);
2956 * Dump an in_multi structure to the console.
2959 inm_print(const struct in_multi *inm)
2962 char addrbuf[INET_ADDRSTRLEN];
2964 if ((ktr_mask & KTR_IGMPV3) == 0)
2967 printf("%s: --- begin inm %p ---\n", __func__, inm);
2968 printf("addr %s ifp %p(%s) ifma %p\n",
2969 inet_ntoa_r(inm->inm_addr, addrbuf),
2971 inm->inm_ifp->if_xname,
2973 printf("timer %u state %s refcount %u scq.len %u\n",
2975 inm_state_str(inm->inm_state),
2977 inm->inm_scq.mq_len);
2978 printf("igi %p nsrc %lu sctimer %u scrv %u\n",
2983 for (t = 0; t < 2; t++) {
2984 printf("t%d: fmode %s asm %u ex %u in %u rec %u\n", t,
2985 inm_mode_str(inm->inm_st[t].iss_fmode),
2986 inm->inm_st[t].iss_asm,
2987 inm->inm_st[t].iss_ex,
2988 inm->inm_st[t].iss_in,
2989 inm->inm_st[t].iss_rec);
2991 printf("%s: --- end inm %p ---\n", __func__, inm);
2994 #else /* !KTR || !(KTR_COMPILE & KTR_IGMPV3) */
2997 inm_print(const struct in_multi *inm)
3002 #endif /* KTR && (KTR_COMPILE & KTR_IGMPV3) */
3004 RB_GENERATE(ip_msource_tree, ip_msource, ims_link, ip_msource_cmp);