sys/netinet6/in6_mcast.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 2009 Bruce Simpson.
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. The name of the author may not be used to endorse or promote
  16  *    products derived from this software without specific prior written
  17  *    permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29  * SUCH DAMAGE.
  30  */
  31
  32 /*
  33  * IPv6 multicast socket, group, and socket option processing module.
  34  * Normative references: RFC 2292, RFC 3492, RFC 3542, RFC 3678, RFC 3810.
  35  */
  36
  37 #include <sys/cdefs.h>
  38 __FBSDID("$FreeBSD$");
  39
  40 #include "opt_inet6.h"
  41
  42 #include <sys/param.h>
  43 #include <sys/systm.h>
  44 #include <sys/kernel.h>
  45 #include <sys/ktr.h>
  46 #include <sys/malloc.h>
  47 #include <sys/mbuf.h>
  48 #include <sys/protosw.h>
  49 #include <sys/socket.h>
  50 #include <sys/socketvar.h>
  51 #include <sys/sysctl.h>
  52 #include <sys/priv.h>
  53 #include <sys/taskqueue.h>
  54 #include <sys/tree.h>
  55
  56 #include <net/if.h>
  57 #include <net/if_var.h>
  58 #include <net/if_dl.h>
  59 #include <net/route.h>
  60 #include <net/route/nhop.h>
  61 #include <net/vnet.h>
  62
  63 #include <netinet/in.h>
  64 #include <netinet/udp.h>
  65 #include <netinet/in_var.h>
  66 #include <netinet/ip_var.h>
  67 #include <netinet/udp_var.h>
  68 #include <netinet6/in6_fib.h>
  69 #include <netinet6/in6_var.h>
  70 #include <netinet/ip6.h>
  71 #include <netinet/icmp6.h>
  72 #include <netinet6/ip6_var.h>
  73 #include <netinet/in_pcb.h>
  74 #include <netinet/tcp_var.h>
  75 #include <netinet6/nd6.h>
  76 #include <netinet6/mld6_var.h>
  77 #include <netinet6/scope6_var.h>
  78
  79 #ifndef KTR_MLD
  80 #define KTR_MLD KTR_INET6
  81 #endif
  82
  83 #ifndef __SOCKUNION_DECLARED
  84 union sockunion {
  85         struct sockaddr_storage ss;
  86         struct sockaddr         sa;
  87         struct sockaddr_dl      sdl;
  88         struct sockaddr_in6     sin6;
  89 };
  90 typedef union sockunion sockunion_t;
  91 #define __SOCKUNION_DECLARED
  92 #endif /* __SOCKUNION_DECLARED */
  93
  94 static MALLOC_DEFINE(M_IN6MFILTER, "in6_mfilter",
  95     "IPv6 multicast PCB-layer source filter");
  96 MALLOC_DEFINE(M_IP6MADDR, "in6_multi", "IPv6 multicast group");
  97 static MALLOC_DEFINE(M_IP6MOPTS, "ip6_moptions", "IPv6 multicast options");
  98 static MALLOC_DEFINE(M_IP6MSOURCE, "ip6_msource",
  99     "IPv6 multicast MLD-layer source filter");
 100
 101 RB_GENERATE(ip6_msource_tree, ip6_msource, im6s_link, ip6_msource_cmp);
 102
 103 /*
 104  * Locking:
 105  * - Lock order is: Giant, IN6_MULTI_LOCK, INP_WLOCK,
 106  *   IN6_MULTI_LIST_LOCK, MLD_LOCK, IF_ADDR_LOCK.
 107  * - The IF_ADDR_LOCK is implicitly taken by in6m_lookup() earlier, however
 108  *   it can be taken by code in net/if.c also.
 109  * - ip6_moptions and in6_mfilter are covered by the INP_WLOCK.
 110  *
 111  * struct in6_multi is covered by IN6_MULTI_LOCK. There isn't strictly
 112  * any need for in6_multi itself to be virtualized -- it is bound to an ifp
 113  * anyway no matter what happens.
 114  */
 115 struct mtx in6_multi_list_mtx;
 116 MTX_SYSINIT(in6_multi_mtx, &in6_multi_list_mtx, "in6_multi_list_mtx", MTX_DEF);
 117
 118 struct mtx in6_multi_free_mtx;
 119 MTX_SYSINIT(in6_multi_free_mtx, &in6_multi_free_mtx, "in6_multi_free_mtx", MTX_DEF);
 120
 121 struct sx in6_multi_sx;
 122 SX_SYSINIT(in6_multi_sx, &in6_multi_sx, "in6_multi_sx");
 123
 124 static void     im6f_commit(struct in6_mfilter *);
 125 static int      im6f_get_source(struct in6_mfilter *imf,
 126                     const struct sockaddr_in6 *psin,
 127                     struct in6_msource **);
 128 static struct in6_msource *
 129                 im6f_graft(struct in6_mfilter *, const uint8_t,
 130                     const struct sockaddr_in6 *);
 131 static void     im6f_leave(struct in6_mfilter *);
 132 static int      im6f_prune(struct in6_mfilter *, const struct sockaddr_in6 *);
 133 static void     im6f_purge(struct in6_mfilter *);
 134 static void     im6f_rollback(struct in6_mfilter *);
 135 static void     im6f_reap(struct in6_mfilter *);
 136 static struct in6_mfilter *
 137                 im6o_match_group(const struct ip6_moptions *,
 138                     const struct ifnet *, const struct sockaddr *);
 139 static struct in6_msource *
 140                 im6o_match_source(struct in6_mfilter *, const struct sockaddr *);
 141 static void     im6s_merge(struct ip6_msource *ims,
 142                     const struct in6_msource *lims, const int rollback);
 143 static int      in6_getmulti(struct ifnet *, const struct in6_addr *,
 144                     struct in6_multi **);
 145 static int      in6_joingroup_locked(struct ifnet *, const struct in6_addr *,
 146                     struct in6_mfilter *, struct in6_multi **, int);
 147 static int      in6m_get_source(struct in6_multi *inm,
 148                     const struct in6_addr *addr, const int noalloc,
 149                     struct ip6_msource **pims);
 150 #ifdef KTR
 151 static int      in6m_is_ifp_detached(const struct in6_multi *);
 152 #endif
 153 static int      in6m_merge(struct in6_multi *, /*const*/ struct in6_mfilter *);
 154 static void     in6m_purge(struct in6_multi *);
 155 static void     in6m_reap(struct in6_multi *);
 156 static struct ip6_moptions *
 157                 in6p_findmoptions(struct inpcb *);
 158 static int      in6p_get_source_filters(struct inpcb *, struct sockopt *);
 159 static int      in6p_join_group(struct inpcb *, struct sockopt *);
 160 static int      in6p_leave_group(struct inpcb *, struct sockopt *);
 161 static struct ifnet *
 162                 in6p_lookup_mcast_ifp(const struct inpcb *,
 163                     const struct sockaddr_in6 *);
 164 static int      in6p_block_unblock_source(struct inpcb *, struct sockopt *);
 165 static int      in6p_set_multicast_if(struct inpcb *, struct sockopt *);
 166 static int      in6p_set_source_filters(struct inpcb *, struct sockopt *);
 167 static int      sysctl_ip6_mcast_filters(SYSCTL_HANDLER_ARGS);
 168
 169 SYSCTL_DECL(_net_inet6_ip6);    /* XXX Not in any common header. */
 170
 171 static SYSCTL_NODE(_net_inet6_ip6, OID_AUTO, mcast,
 172     CTLFLAG_RW | CTLFLAG_MPSAFE, 0,
 173     "IPv6 multicast");
 174
 175 static u_long in6_mcast_maxgrpsrc = IPV6_MAX_GROUP_SRC_FILTER;
 176 SYSCTL_ULONG(_net_inet6_ip6_mcast, OID_AUTO, maxgrpsrc,
 177     CTLFLAG_RWTUN, &in6_mcast_maxgrpsrc, 0,
 178     "Max source filters per group");
 179
 180 static u_long in6_mcast_maxsocksrc = IPV6_MAX_SOCK_SRC_FILTER;
 181 SYSCTL_ULONG(_net_inet6_ip6_mcast, OID_AUTO, maxsocksrc,
 182     CTLFLAG_RWTUN, &in6_mcast_maxsocksrc, 0,
 183     "Max source filters per socket");
 184
 185 /* TODO Virtualize this switch. */
 186 int in6_mcast_loop = IPV6_DEFAULT_MULTICAST_LOOP;
 187 SYSCTL_INT(_net_inet6_ip6_mcast, OID_AUTO, loop, CTLFLAG_RWTUN,
 188     &in6_mcast_loop, 0, "Loopback multicast datagrams by default");
 189
 190 static SYSCTL_NODE(_net_inet6_ip6_mcast, OID_AUTO, filters,
 191     CTLFLAG_RD | CTLFLAG_MPSAFE, sysctl_ip6_mcast_filters,
 192     "Per-interface stack-wide source filters");
 193
 194 #ifdef KTR
 195 /*
 196  * Inline function which wraps assertions for a valid ifp.
 197  * The ifnet layer will set the ifma's ifp pointer to NULL if the ifp
 198  * is detached.
 199  */
 200 static int __inline
 201 in6m_is_ifp_detached(const struct in6_multi *inm)
 202 {
 203         struct ifnet *ifp;
 204
 205         KASSERT(inm->in6m_ifma != NULL, ("%s: no ifma", __func__));
 206         ifp = inm->in6m_ifma->ifma_ifp;
 207         if (ifp != NULL) {
 208                 /*
 209                  * Sanity check that network-layer notion of ifp is the
 210                  * same as that of link-layer.
 211                  */
 212                 KASSERT(inm->in6m_ifp == ifp, ("%s: bad ifp", __func__));
 213         }
 214
 215         return (ifp == NULL);
 216 }
 217 #endif
 218
 219 /*
 220  * Initialize an in6_mfilter structure to a known state at t0, t1
 221  * with an empty source filter list.
 222  */
 223 static __inline void
 224 im6f_init(struct in6_mfilter *imf, const int st0, const int st1)
 225 {
 226         memset(imf, 0, sizeof(struct in6_mfilter));
 227         RB_INIT(&imf->im6f_sources);
 228         imf->im6f_st[0] = st0;
 229         imf->im6f_st[1] = st1;
 230 }
 231
 232 struct in6_mfilter *
 233 ip6_mfilter_alloc(const int mflags, const int st0, const int st1)
 234 {
 235         struct in6_mfilter *imf;
 236
 237         imf = malloc(sizeof(*imf), M_IN6MFILTER, mflags);
 238
 239         if (imf != NULL)
 240                 im6f_init(imf, st0, st1);
 241
 242         return (imf);
 243 }
 244
 245 void
 246 ip6_mfilter_free(struct in6_mfilter *imf)
 247 {
 248
 249         im6f_purge(imf);
 250         free(imf, M_IN6MFILTER);
 251 }
 252
 253 /*
 254  * Find an IPv6 multicast group entry for this ip6_moptions instance
 255  * which matches the specified group, and optionally an interface.
 256  * Return its index into the array, or -1 if not found.
 257  */
 258 static struct in6_mfilter *
 259 im6o_match_group(const struct ip6_moptions *imo, const struct ifnet *ifp,
 260     const struct sockaddr *group)
 261 {
 262         const struct sockaddr_in6 *gsin6;
 263         struct in6_mfilter *imf;
 264         struct in6_multi *inm;
 265
 266         gsin6 = (const struct sockaddr_in6 *)group;
 267
 268         IP6_MFILTER_FOREACH(imf, &imo->im6o_head) {
 269                 inm = imf->im6f_in6m;
 270                 if (inm == NULL)
 271                         continue;
 272                 if ((ifp == NULL || (inm->in6m_ifp == ifp)) &&
 273                     IN6_ARE_ADDR_EQUAL(&inm->in6m_addr,
 274                     &gsin6->sin6_addr)) {
 275                         break;
 276                 }
 277         }
 278         return (imf);
 279 }
 280
 281 /*
 282  * Find an IPv6 multicast source entry for this imo which matches
 283  * the given group index for this socket, and source address.
 284  *
 285  * XXX TODO: The scope ID, if present in src, is stripped before
 286  * any comparison. We SHOULD enforce scope/zone checks where the source
 287  * filter entry has a link scope.
 288  *
 289  * NOTE: This does not check if the entry is in-mode, merely if
 290  * it exists, which may not be the desired behaviour.
 291  */
 292 static struct in6_msource *
 293 im6o_match_source(struct in6_mfilter *imf, const struct sockaddr *src)
 294 {
 295         struct ip6_msource       find;
 296         struct ip6_msource      *ims;
 297         const sockunion_t       *psa;
 298
 299         KASSERT(src->sa_family == AF_INET6, ("%s: !AF_INET6", __func__));
 300
 301         psa = (const sockunion_t *)src;
 302         find.im6s_addr = psa->sin6.sin6_addr;
 303         in6_clearscope(&find.im6s_addr);                /* XXX */
 304         ims = RB_FIND(ip6_msource_tree, &imf->im6f_sources, &find);
 305
 306         return ((struct in6_msource *)ims);
 307 }
 308
 309 /*
 310  * Perform filtering for multicast datagrams on a socket by group and source.
 311  *
 312  * Returns 0 if a datagram should be allowed through, or various error codes
 313  * if the socket was not a member of the group, or the source was muted, etc.
 314  */
 315 int
 316 im6o_mc_filter(const struct ip6_moptions *imo, const struct ifnet *ifp,
 317     const struct sockaddr *group, const struct sockaddr *src)
 318 {
 319         struct in6_mfilter *imf;
 320         struct in6_msource *ims;
 321         int mode;
 322
 323         KASSERT(ifp != NULL, ("%s: null ifp", __func__));
 324
 325         imf = im6o_match_group(imo, ifp, group);
 326         if (imf == NULL)
 327                 return (MCAST_NOTGMEMBER);
 328
 329         /*
 330          * Check if the source was included in an (S,G) join.
 331          * Allow reception on exclusive memberships by default,
 332          * reject reception on inclusive memberships by default.
 333          * Exclude source only if an in-mode exclude filter exists.
 334          * Include source only if an in-mode include filter exists.
 335          * NOTE: We are comparing group state here at MLD t1 (now)
 336          * with socket-layer t0 (since last downcall).
 337          */
 338         mode = imf->im6f_st[1];
 339         ims = im6o_match_source(imf, src);
 340
 341         if ((ims == NULL && mode == MCAST_INCLUDE) ||
 342             (ims != NULL && ims->im6sl_st[0] != mode))
 343                 return (MCAST_NOTSMEMBER);
 344
 345         return (MCAST_PASS);
 346 }
 347
 348 /*
 349  * Find and return a reference to an in6_multi record for (ifp, group),
 350  * and bump its reference count.
 351  * If one does not exist, try to allocate it, and update link-layer multicast
 352  * filters on ifp to listen for group.
 353  * Assumes the IN6_MULTI lock is held across the call.
 354  * Return 0 if successful, otherwise return an appropriate error code.
 355  */
 356 static int
 357 in6_getmulti(struct ifnet *ifp, const struct in6_addr *group,
 358     struct in6_multi **pinm)
 359 {
 360         struct epoch_tracker     et;
 361         struct sockaddr_in6      gsin6;
 362         struct ifmultiaddr      *ifma;
 363         struct in6_multi        *inm;
 364         int                      error;
 365
 366         error = 0;
 367
 368         /*
 369          * XXX: Accesses to ifma_protospec must be covered by IF_ADDR_LOCK;
 370          * if_addmulti() takes this mutex itself, so we must drop and
 371          * re-acquire around the call.
 372          */
 373         IN6_MULTI_LOCK_ASSERT();
 374         IN6_MULTI_LIST_LOCK();
 375         IF_ADDR_WLOCK(ifp);
 376         NET_EPOCH_ENTER(et);
 377         inm = in6m_lookup_locked(ifp, group);
 378         NET_EPOCH_EXIT(et);
 379
 380         if (inm != NULL) {
 381                 /*
 382                  * If we already joined this group, just bump the
 383                  * refcount and return it.
 384                  */
 385                 KASSERT(inm->in6m_refcount >= 1,
 386                     ("%s: bad refcount %d", __func__, inm->in6m_refcount));
 387                 in6m_acquire_locked(inm);
 388                 *pinm = inm;
 389                 goto out_locked;
 390         }
 391
 392         memset(&gsin6, 0, sizeof(gsin6));
 393         gsin6.sin6_family = AF_INET6;
 394         gsin6.sin6_len = sizeof(struct sockaddr_in6);
 395         gsin6.sin6_addr = *group;
 396
 397         /*
 398          * Check if a link-layer group is already associated
 399          * with this network-layer group on the given ifnet.
 400          */
 401         IN6_MULTI_LIST_UNLOCK();
 402         IF_ADDR_WUNLOCK(ifp);
 403         error = if_addmulti(ifp, (struct sockaddr *)&gsin6, &ifma);
 404         if (error != 0)
 405                 return (error);
 406         IN6_MULTI_LIST_LOCK();
 407         IF_ADDR_WLOCK(ifp);
 408
 409         /*
 410          * If something other than netinet6 is occupying the link-layer
 411          * group, print a meaningful error message and back out of
 412          * the allocation.
 413          * Otherwise, bump the refcount on the existing network-layer
 414          * group association and return it.
 415          */
 416         if (ifma->ifma_protospec != NULL) {
 417                 inm = (struct in6_multi *)ifma->ifma_protospec;
 418 #ifdef INVARIANTS
 419                 KASSERT(ifma->ifma_addr != NULL, ("%s: no ifma_addr",
 420                     __func__));
 421                 KASSERT(ifma->ifma_addr->sa_family == AF_INET6,
 422                     ("%s: ifma not AF_INET6", __func__));
 423                 KASSERT(inm != NULL, ("%s: no ifma_protospec", __func__));
 424                 if (inm->in6m_ifma != ifma || inm->in6m_ifp != ifp ||
 425                     !IN6_ARE_ADDR_EQUAL(&inm->in6m_addr, group))
 426                         panic("%s: ifma %p is inconsistent with %p (%p)",
 427                             __func__, ifma, inm, group);
 428 #endif
 429                 in6m_acquire_locked(inm);
 430                 *pinm = inm;
 431                 goto out_locked;
 432         }
 433
 434         IF_ADDR_WLOCK_ASSERT(ifp);
 435
 436         /*
 437          * A new in6_multi record is needed; allocate and initialize it.
 438          * We DO NOT perform an MLD join as the in6_ layer may need to
 439          * push an initial source list down to MLD to support SSM.
 440          *
 441          * The initial source filter state is INCLUDE, {} as per the RFC.
 442          * Pending state-changes per group are subject to a bounds check.
 443          */
 444         inm = malloc(sizeof(*inm), M_IP6MADDR, M_NOWAIT | M_ZERO);
 445         if (inm == NULL) {
 446                 IN6_MULTI_LIST_UNLOCK();
 447                 IF_ADDR_WUNLOCK(ifp);
 448                 if_delmulti_ifma(ifma);
 449                 return (ENOMEM);
 450         }
 451         inm->in6m_addr = *group;
 452         inm->in6m_ifp = ifp;
 453         inm->in6m_mli = MLD_IFINFO(ifp);
 454         inm->in6m_ifma = ifma;
 455         inm->in6m_refcount = 1;
 456         inm->in6m_state = MLD_NOT_MEMBER;
 457         mbufq_init(&inm->in6m_scq, MLD_MAX_STATE_CHANGES);
 458
 459         inm->in6m_st[0].iss_fmode = MCAST_UNDEFINED;
 460         inm->in6m_st[1].iss_fmode = MCAST_UNDEFINED;
 461         RB_INIT(&inm->in6m_srcs);
 462
 463         ifma->ifma_protospec = inm;
 464         *pinm = inm;
 465
 466  out_locked:
 467         IN6_MULTI_LIST_UNLOCK();
 468         IF_ADDR_WUNLOCK(ifp);
 469         return (error);
 470 }
 471
 472 /*
 473  * Drop a reference to an in6_multi record.
 474  *
 475  * If the refcount drops to 0, free the in6_multi record and
 476  * delete the underlying link-layer membership.
 477  */
 478 static void
 479 in6m_release(struct in6_multi *inm)
 480 {
 481         struct ifmultiaddr *ifma;
 482         struct ifnet *ifp;
 483
 484         CTR2(KTR_MLD, "%s: refcount is %d", __func__, inm->in6m_refcount);
 485
 486         MPASS(inm->in6m_refcount == 0);
 487         CTR2(KTR_MLD, "%s: freeing inm %p", __func__, inm);
 488
 489         ifma = inm->in6m_ifma;
 490         ifp = inm->in6m_ifp;
 491         MPASS(ifma->ifma_llifma == NULL);
 492
 493         /* XXX this access is not covered by IF_ADDR_LOCK */
 494         CTR2(KTR_MLD, "%s: purging ifma %p", __func__, ifma);
 495         KASSERT(ifma->ifma_protospec == NULL,
 496             ("%s: ifma_protospec != NULL", __func__));
 497         if (ifp == NULL)
 498                 ifp = ifma->ifma_ifp;
 499
 500         if (ifp != NULL) {
 501                 CURVNET_SET(ifp->if_vnet);
 502                 in6m_purge(inm);
 503                 free(inm, M_IP6MADDR);
 504                 if_delmulti_ifma_flags(ifma, 1);
 505                 CURVNET_RESTORE();
 506                 if_rele(ifp);
 507         } else {
 508                 in6m_purge(inm);
 509                 free(inm, M_IP6MADDR);
 510                 if_delmulti_ifma_flags(ifma, 1);
 511         }
 512 }
 513
 514 /*
 515  * Interface detach can happen in a taskqueue thread context, so we must use a
 516  * dedicated thread to avoid deadlocks when draining in6m_release tasks.
 517  */
 518 TASKQUEUE_DEFINE_THREAD(in6m_free);
 519 static struct in6_multi_head in6m_free_list = SLIST_HEAD_INITIALIZER();
 520 static void in6m_release_task(void *arg __unused, int pending __unused);
 521 static struct task in6m_free_task = TASK_INITIALIZER(0, in6m_release_task, NULL);
 522
 523 void
 524 in6m_release_list_deferred(struct in6_multi_head *inmh)
 525 {
 526         if (SLIST_EMPTY(inmh))
 527                 return;
 528         mtx_lock(&in6_multi_free_mtx);
 529         SLIST_CONCAT(&in6m_free_list, inmh, in6_multi, in6m_nrele);
 530         mtx_unlock(&in6_multi_free_mtx);
 531         taskqueue_enqueue(taskqueue_in6m_free, &in6m_free_task);
 532 }
 533
 534 void
 535 in6m_release_wait(void *arg __unused)
 536 {
 537
 538         /*
 539          * Make sure all pending multicast addresses are freed before
 540          * the VNET or network device is destroyed:
 541          */
 542         taskqueue_drain_all(taskqueue_in6m_free);
 543 }
 544 #ifdef VIMAGE
 545 /* XXX-BZ FIXME, see D24914. */
 546 VNET_SYSUNINIT(in6m_release_wait, SI_SUB_PROTO_DOMAIN, SI_ORDER_FIRST, in6m_release_wait, NULL);
 547 #endif
 548
 549 void
 550 in6m_disconnect_locked(struct in6_multi_head *inmh, struct in6_multi *inm)
 551 {
 552         struct ifnet *ifp;
 553         struct ifaddr *ifa;
 554         struct in6_ifaddr *ifa6;
 555         struct in6_multi_mship *imm, *imm_tmp;
 556         struct ifmultiaddr *ifma, *ll_ifma;
 557
 558         IN6_MULTI_LIST_LOCK_ASSERT();
 559
 560         ifp = inm->in6m_ifp;
 561         if (ifp == NULL)
 562                 return;         /* already called */
 563
 564         inm->in6m_ifp = NULL;
 565         IF_ADDR_WLOCK_ASSERT(ifp);
 566         ifma = inm->in6m_ifma;
 567         if (ifma == NULL)
 568                 return;
 569
 570         if_ref(ifp);
 571         if (ifma->ifma_flags & IFMA_F_ENQUEUED) {
 572                 CK_STAILQ_REMOVE(&ifp->if_multiaddrs, ifma, ifmultiaddr, ifma_link);
 573                 ifma->ifma_flags &= ~IFMA_F_ENQUEUED;
 574         }
 575         MCDPRINTF("removed ifma: %p from %s\n", ifma, ifp->if_xname);
 576         if ((ll_ifma = ifma->ifma_llifma) != NULL) {
 577                 MPASS(ifma != ll_ifma);
 578                 ifma->ifma_llifma = NULL;
 579                 MPASS(ll_ifma->ifma_llifma == NULL);
 580                 MPASS(ll_ifma->ifma_ifp == ifp);
 581                 if (--ll_ifma->ifma_refcount == 0) {
 582                         if (ll_ifma->ifma_flags & IFMA_F_ENQUEUED) {
 583                                 CK_STAILQ_REMOVE(&ifp->if_multiaddrs, ll_ifma, ifmultiaddr, ifma_link);
 584                                 ll_ifma->ifma_flags &= ~IFMA_F_ENQUEUED;
 585                         }
 586                         MCDPRINTF("removed ll_ifma: %p from %s\n", ll_ifma, ifp->if_xname);
 587                         if_freemulti(ll_ifma);
 588                 }
 589         }
 590         CK_STAILQ_FOREACH(ifa, &ifp->if_addrhead, ifa_link) {
 591                 if (ifa->ifa_addr->sa_family != AF_INET6)
 592                         continue;
 593                 ifa6 = (void *)ifa;
 594                 LIST_FOREACH_SAFE(imm, &ifa6->ia6_memberships,
 595                     i6mm_chain, imm_tmp) {
 596                         if (inm == imm->i6mm_maddr) {
 597                                 LIST_REMOVE(imm, i6mm_chain);
 598                                 free(imm, M_IP6MADDR);
 599                                 in6m_rele_locked(inmh, inm);
 600                         }
 601                 }
 602         }
 603 }
 604
 605 static void
 606 in6m_release_task(void *arg __unused, int pending __unused)
 607 {
 608         struct in6_multi_head in6m_free_tmp;
 609         struct in6_multi *inm, *tinm;
 610
 611         SLIST_INIT(&in6m_free_tmp);
 612         mtx_lock(&in6_multi_free_mtx);
 613         SLIST_CONCAT(&in6m_free_tmp, &in6m_free_list, in6_multi, in6m_nrele);
 614         mtx_unlock(&in6_multi_free_mtx);
 615         IN6_MULTI_LOCK();
 616         SLIST_FOREACH_SAFE(inm, &in6m_free_tmp, in6m_nrele, tinm) {
 617                 SLIST_REMOVE_HEAD(&in6m_free_tmp, in6m_nrele);
 618                 in6m_release(inm);
 619         }
 620         IN6_MULTI_UNLOCK();
 621 }
 622
 623 /*
 624  * Clear recorded source entries for a group.
 625  * Used by the MLD code. Caller must hold the IN6_MULTI lock.
 626  * FIXME: Should reap.
 627  */
 628 void
 629 in6m_clear_recorded(struct in6_multi *inm)
 630 {
 631         struct ip6_msource      *ims;
 632
 633         IN6_MULTI_LIST_LOCK_ASSERT();
 634
 635         RB_FOREACH(ims, ip6_msource_tree, &inm->in6m_srcs) {
 636                 if (ims->im6s_stp) {
 637                         ims->im6s_stp = 0;
 638                         --inm->in6m_st[1].iss_rec;
 639                 }
 640         }
 641         KASSERT(inm->in6m_st[1].iss_rec == 0,
 642             ("%s: iss_rec %d not 0", __func__, inm->in6m_st[1].iss_rec));
 643 }
 644
 645 /*
 646  * Record a source as pending for a Source-Group MLDv2 query.
 647  * This lives here as it modifies the shared tree.
 648  *
 649  * inm is the group descriptor.
 650  * naddr is the address of the source to record in network-byte order.
 651  *
 652  * If the net.inet6.mld.sgalloc sysctl is non-zero, we will
 653  * lazy-allocate a source node in response to an SG query.
 654  * Otherwise, no allocation is performed. This saves some memory
 655  * with the trade-off that the source will not be reported to the
 656  * router if joined in the window between the query response and
 657  * the group actually being joined on the local host.
 658  *
 659  * VIMAGE: XXX: Currently the mld_sgalloc feature has been removed.
 660  * This turns off the allocation of a recorded source entry if
 661  * the group has not been joined.
 662  *
 663  * Return 0 if the source didn't exist or was already marked as recorded.
 664  * Return 1 if the source was marked as recorded by this function.
 665  * Return <0 if any error occurred (negated errno code).
 666  */
 667 int
 668 in6m_record_source(struct in6_multi *inm, const struct in6_addr *addr)
 669 {
 670         struct ip6_msource       find;
 671         struct ip6_msource      *ims, *nims;
 672
 673         IN6_MULTI_LIST_LOCK_ASSERT();
 674
 675         find.im6s_addr = *addr;
 676         ims = RB_FIND(ip6_msource_tree, &inm->in6m_srcs, &find);
 677         if (ims && ims->im6s_stp)
 678                 return (0);
 679         if (ims == NULL) {
 680                 if (inm->in6m_nsrc == in6_mcast_maxgrpsrc)
 681                         return (-ENOSPC);
 682                 nims = malloc(sizeof(struct ip6_msource), M_IP6MSOURCE,
 683                     M_NOWAIT | M_ZERO);
 684                 if (nims == NULL)
 685                         return (-ENOMEM);
 686                 nims->im6s_addr = find.im6s_addr;
 687                 RB_INSERT(ip6_msource_tree, &inm->in6m_srcs, nims);
 688                 ++inm->in6m_nsrc;
 689                 ims = nims;
 690         }
 691
 692         /*
 693          * Mark the source as recorded and update the recorded
 694          * source count.
 695          */
 696         ++ims->im6s_stp;
 697         ++inm->in6m_st[1].iss_rec;
 698
 699         return (1);
 700 }
 701
 702 /*
 703  * Return a pointer to an in6_msource owned by an in6_mfilter,
 704  * given its source address.
 705  * Lazy-allocate if needed. If this is a new entry its filter state is
 706  * undefined at t0.
 707  *
 708  * imf is the filter set being modified.
 709  * addr is the source address.
 710  *
 711  * SMPng: May be called with locks held; malloc must not block.
 712  */
 713 static int
 714 im6f_get_source(struct in6_mfilter *imf, const struct sockaddr_in6 *psin,
 715     struct in6_msource **plims)
 716 {
 717         struct ip6_msource       find;
 718         struct ip6_msource      *ims, *nims;
 719         struct in6_msource      *lims;
 720         int                      error;
 721
 722         error = 0;
 723         ims = NULL;
 724         lims = NULL;
 725
 726         find.im6s_addr = psin->sin6_addr;
 727         ims = RB_FIND(ip6_msource_tree, &imf->im6f_sources, &find);
 728         lims = (struct in6_msource *)ims;
 729         if (lims == NULL) {
 730                 if (imf->im6f_nsrc == in6_mcast_maxsocksrc)
 731                         return (ENOSPC);
 732                 nims = malloc(sizeof(struct in6_msource), M_IN6MFILTER,
 733                     M_NOWAIT | M_ZERO);
 734                 if (nims == NULL)
 735                         return (ENOMEM);
 736                 lims = (struct in6_msource *)nims;
 737                 lims->im6s_addr = find.im6s_addr;
 738                 lims->im6sl_st[0] = MCAST_UNDEFINED;
 739                 RB_INSERT(ip6_msource_tree, &imf->im6f_sources, nims);
 740                 ++imf->im6f_nsrc;
 741         }
 742
 743         *plims = lims;
 744
 745         return (error);
 746 }
 747
 748 /*
 749  * Graft a source entry into an existing socket-layer filter set,
 750  * maintaining any required invariants and checking allocations.
 751  *
 752  * The source is marked as being in the new filter mode at t1.
 753  *
 754  * Return the pointer to the new node, otherwise return NULL.
 755  */
 756 static struct in6_msource *
 757 im6f_graft(struct in6_mfilter *imf, const uint8_t st1,
 758     const struct sockaddr_in6 *psin)
 759 {
 760         struct ip6_msource      *nims;
 761         struct in6_msource      *lims;
 762
 763         nims = malloc(sizeof(struct in6_msource), M_IN6MFILTER,
 764             M_NOWAIT | M_ZERO);
 765         if (nims == NULL)
 766                 return (NULL);
 767         lims = (struct in6_msource *)nims;
 768         lims->im6s_addr = psin->sin6_addr;
 769         lims->im6sl_st[0] = MCAST_UNDEFINED;
 770         lims->im6sl_st[1] = st1;
 771         RB_INSERT(ip6_msource_tree, &imf->im6f_sources, nims);
 772         ++imf->im6f_nsrc;
 773
 774         return (lims);
 775 }
 776
 777 /*
 778  * Prune a source entry from an existing socket-layer filter set,
 779  * maintaining any required invariants and checking allocations.
 780  *
 781  * The source is marked as being left at t1, it is not freed.
 782  *
 783  * Return 0 if no error occurred, otherwise return an errno value.
 784  */
 785 static int
 786 im6f_prune(struct in6_mfilter *imf, const struct sockaddr_in6 *psin)
 787 {
 788         struct ip6_msource       find;
 789         struct ip6_msource      *ims;
 790         struct in6_msource      *lims;
 791
 792         find.im6s_addr = psin->sin6_addr;
 793         ims = RB_FIND(ip6_msource_tree, &imf->im6f_sources, &find);
 794         if (ims == NULL)
 795                 return (ENOENT);
 796         lims = (struct in6_msource *)ims;
 797         lims->im6sl_st[1] = MCAST_UNDEFINED;
 798         return (0);
 799 }
 800
 801 /*
 802  * Revert socket-layer filter set deltas at t1 to t0 state.
 803  */
 804 static void
 805 im6f_rollback(struct in6_mfilter *imf)
 806 {
 807         struct ip6_msource      *ims, *tims;
 808         struct in6_msource      *lims;
 809
 810         RB_FOREACH_SAFE(ims, ip6_msource_tree, &imf->im6f_sources, tims) {
 811                 lims = (struct in6_msource *)ims;
 812                 if (lims->im6sl_st[0] == lims->im6sl_st[1]) {
 813                         /* no change at t1 */
 814                         continue;
 815                 } else if (lims->im6sl_st[0] != MCAST_UNDEFINED) {
 816                         /* revert change to existing source at t1 */
 817                         lims->im6sl_st[1] = lims->im6sl_st[0];
 818                 } else {
 819                         /* revert source added t1 */
 820                         CTR2(KTR_MLD, "%s: free ims %p", __func__, ims);
 821                         RB_REMOVE(ip6_msource_tree, &imf->im6f_sources, ims);
 822                         free(ims, M_IN6MFILTER);
 823                         imf->im6f_nsrc--;
 824                 }
 825         }
 826         imf->im6f_st[1] = imf->im6f_st[0];
 827 }
 828
 829 /*
 830  * Mark socket-layer filter set as INCLUDE {} at t1.
 831  */
 832 static void
 833 im6f_leave(struct in6_mfilter *imf)
 834 {
 835         struct ip6_msource      *ims;
 836         struct in6_msource      *lims;
 837
 838         RB_FOREACH(ims, ip6_msource_tree, &imf->im6f_sources) {
 839                 lims = (struct in6_msource *)ims;
 840                 lims->im6sl_st[1] = MCAST_UNDEFINED;
 841         }
 842         imf->im6f_st[1] = MCAST_INCLUDE;
 843 }
 844
 845 /*
 846  * Mark socket-layer filter set deltas as committed.
 847  */
 848 static void
 849 im6f_commit(struct in6_mfilter *imf)
 850 {
 851         struct ip6_msource      *ims;
 852         struct in6_msource      *lims;
 853
 854         RB_FOREACH(ims, ip6_msource_tree, &imf->im6f_sources) {
 855                 lims = (struct in6_msource *)ims;
 856                 lims->im6sl_st[0] = lims->im6sl_st[1];
 857         }
 858         imf->im6f_st[0] = imf->im6f_st[1];
 859 }
 860
 861 /*
 862  * Reap unreferenced sources from socket-layer filter set.
 863  */
 864 static void
 865 im6f_reap(struct in6_mfilter *imf)
 866 {
 867         struct ip6_msource      *ims, *tims;
 868         struct in6_msource      *lims;
 869
 870         RB_FOREACH_SAFE(ims, ip6_msource_tree, &imf->im6f_sources, tims) {
 871                 lims = (struct in6_msource *)ims;
 872                 if ((lims->im6sl_st[0] == MCAST_UNDEFINED) &&
 873                     (lims->im6sl_st[1] == MCAST_UNDEFINED)) {
 874                         CTR2(KTR_MLD, "%s: free lims %p", __func__, ims);
 875                         RB_REMOVE(ip6_msource_tree, &imf->im6f_sources, ims);
 876                         free(ims, M_IN6MFILTER);
 877                         imf->im6f_nsrc--;
 878                 }
 879         }
 880 }
 881
 882 /*
 883  * Purge socket-layer filter set.
 884  */
 885 static void
 886 im6f_purge(struct in6_mfilter *imf)
 887 {
 888         struct ip6_msource      *ims, *tims;
 889
 890         RB_FOREACH_SAFE(ims, ip6_msource_tree, &imf->im6f_sources, tims) {
 891                 CTR2(KTR_MLD, "%s: free ims %p", __func__, ims);
 892                 RB_REMOVE(ip6_msource_tree, &imf->im6f_sources, ims);
 893                 free(ims, M_IN6MFILTER);
 894                 imf->im6f_nsrc--;
 895         }
 896         imf->im6f_st[0] = imf->im6f_st[1] = MCAST_UNDEFINED;
 897         KASSERT(RB_EMPTY(&imf->im6f_sources),
 898             ("%s: im6f_sources not empty", __func__));
 899 }
 900
 901 /*
 902  * Look up a source filter entry for a multicast group.
 903  *
 904  * inm is the group descriptor to work with.
 905  * addr is the IPv6 address to look up.
 906  * noalloc may be non-zero to suppress allocation of sources.
 907  * *pims will be set to the address of the retrieved or allocated source.
 908  *
 909  * SMPng: NOTE: may be called with locks held.
 910  * Return 0 if successful, otherwise return a non-zero error code.
 911  */
 912 static int
 913 in6m_get_source(struct in6_multi *inm, const struct in6_addr *addr,
 914     const int noalloc, struct ip6_msource **pims)
 915 {
 916         struct ip6_msource       find;
 917         struct ip6_msource      *ims, *nims;
 918 #ifdef KTR
 919         char                     ip6tbuf[INET6_ADDRSTRLEN];
 920 #endif
 921
 922         find.im6s_addr = *addr;
 923         ims = RB_FIND(ip6_msource_tree, &inm->in6m_srcs, &find);
 924         if (ims == NULL && !noalloc) {
 925                 if (inm->in6m_nsrc == in6_mcast_maxgrpsrc)
 926                         return (ENOSPC);
 927                 nims = malloc(sizeof(struct ip6_msource), M_IP6MSOURCE,
 928                     M_NOWAIT | M_ZERO);
 929                 if (nims == NULL)
 930                         return (ENOMEM);
 931                 nims->im6s_addr = *addr;
 932                 RB_INSERT(ip6_msource_tree, &inm->in6m_srcs, nims);
 933                 ++inm->in6m_nsrc;
 934                 ims = nims;
 935                 CTR3(KTR_MLD, "%s: allocated %s as %p", __func__,
 936                     ip6_sprintf(ip6tbuf, addr), ims);
 937         }
 938
 939         *pims = ims;
 940         return (0);
 941 }
 942
 943 /*
 944  * Merge socket-layer source into MLD-layer source.
 945  * If rollback is non-zero, perform the inverse of the merge.
 946  */
 947 static void
 948 im6s_merge(struct ip6_msource *ims, const struct in6_msource *lims,
 949     const int rollback)
 950 {
 951         int n = rollback ? -1 : 1;
 952 #ifdef KTR
 953         char ip6tbuf[INET6_ADDRSTRLEN];
 954
 955         ip6_sprintf(ip6tbuf, &lims->im6s_addr);
 956 #endif
 957
 958         if (lims->im6sl_st[0] == MCAST_EXCLUDE) {
 959                 CTR3(KTR_MLD, "%s: t1 ex -= %d on %s", __func__, n, ip6tbuf);
 960                 ims->im6s_st[1].ex -= n;
 961         } else if (lims->im6sl_st[0] == MCAST_INCLUDE) {
 962                 CTR3(KTR_MLD, "%s: t1 in -= %d on %s", __func__, n, ip6tbuf);
 963                 ims->im6s_st[1].in -= n;
 964         }
 965
 966         if (lims->im6sl_st[1] == MCAST_EXCLUDE) {
 967                 CTR3(KTR_MLD, "%s: t1 ex += %d on %s", __func__, n, ip6tbuf);
 968                 ims->im6s_st[1].ex += n;
 969         } else if (lims->im6sl_st[1] == MCAST_INCLUDE) {
 970                 CTR3(KTR_MLD, "%s: t1 in += %d on %s", __func__, n, ip6tbuf);
 971                 ims->im6s_st[1].in += n;
 972         }
 973 }
 974
 975 /*
 976  * Atomically update the global in6_multi state, when a membership's
 977  * filter list is being updated in any way.
 978  *
 979  * imf is the per-inpcb-membership group filter pointer.
 980  * A fake imf may be passed for in-kernel consumers.
 981  *
 982  * XXX This is a candidate for a set-symmetric-difference style loop
 983  * which would eliminate the repeated lookup from root of ims nodes,
 984  * as they share the same key space.
 985  *
 986  * If any error occurred this function will back out of refcounts
 987  * and return a non-zero value.
 988  */
 989 static int
 990 in6m_merge(struct in6_multi *inm, /*const*/ struct in6_mfilter *imf)
 991 {
 992         struct ip6_msource      *ims, *nims;
 993         struct in6_msource      *lims;
 994         int                      schanged, error;
 995         int                      nsrc0, nsrc1;
 996
 997         schanged = 0;
 998         error = 0;
 999         nsrc1 = nsrc0 = 0;
1000         IN6_MULTI_LIST_LOCK_ASSERT();
1001
1002         /*
1003          * Update the source filters first, as this may fail.
1004          * Maintain count of in-mode filters at t0, t1. These are
1005          * used to work out if we transition into ASM mode or not.
1006          * Maintain a count of source filters whose state was
1007          * actually modified by this operation.
1008          */
1009         RB_FOREACH(ims, ip6_msource_tree, &imf->im6f_sources) {
1010                 lims = (struct in6_msource *)ims;
1011                 if (lims->im6sl_st[0] == imf->im6f_st[0]) nsrc0++;
1012                 if (lims->im6sl_st[1] == imf->im6f_st[1]) nsrc1++;
1013                 if (lims->im6sl_st[0] == lims->im6sl_st[1]) continue;
1014                 error = in6m_get_source(inm, &lims->im6s_addr, 0, &nims);
1015                 ++schanged;
1016                 if (error)
1017                         break;
1018                 im6s_merge(nims, lims, 0);
1019         }
1020         if (error) {
1021                 struct ip6_msource *bims;
1022
1023                 RB_FOREACH_REVERSE_FROM(ims, ip6_msource_tree, nims) {
1024                         lims = (struct in6_msource *)ims;
1025                         if (lims->im6sl_st[0] == lims->im6sl_st[1])
1026                                 continue;
1027                         (void)in6m_get_source(inm, &lims->im6s_addr, 1, &bims);
1028                         if (bims == NULL)
1029                                 continue;
1030                         im6s_merge(bims, lims, 1);
1031                 }
1032                 goto out_reap;
1033         }
1034
1035         CTR3(KTR_MLD, "%s: imf filters in-mode: %d at t0, %d at t1",
1036             __func__, nsrc0, nsrc1);
1037
1038         /* Handle transition between INCLUDE {n} and INCLUDE {} on socket. */
1039         if (imf->im6f_st[0] == imf->im6f_st[1] &&
1040             imf->im6f_st[1] == MCAST_INCLUDE) {
1041                 if (nsrc1 == 0) {
1042                         CTR1(KTR_MLD, "%s: --in on inm at t1", __func__);
1043                         --inm->in6m_st[1].iss_in;
1044                 }
1045         }
1046
1047         /* Handle filter mode transition on socket. */
1048         if (imf->im6f_st[0] != imf->im6f_st[1]) {
1049                 CTR3(KTR_MLD, "%s: imf transition %d to %d",
1050                     __func__, imf->im6f_st[0], imf->im6f_st[1]);
1051
1052                 if (imf->im6f_st[0] == MCAST_EXCLUDE) {
1053                         CTR1(KTR_MLD, "%s: --ex on inm at t1", __func__);
1054                         --inm->in6m_st[1].iss_ex;
1055                 } else if (imf->im6f_st[0] == MCAST_INCLUDE) {
1056                         CTR1(KTR_MLD, "%s: --in on inm at t1", __func__);
1057                         --inm->in6m_st[1].iss_in;
1058                 }
1059
1060                 if (imf->im6f_st[1] == MCAST_EXCLUDE) {
1061                         CTR1(KTR_MLD, "%s: ex++ on inm at t1", __func__);
1062                         inm->in6m_st[1].iss_ex++;
1063                 } else if (imf->im6f_st[1] == MCAST_INCLUDE && nsrc1 > 0) {
1064                         CTR1(KTR_MLD, "%s: in++ on inm at t1", __func__);
1065                         inm->in6m_st[1].iss_in++;
1066                 }
1067         }
1068
1069         /*
1070          * Track inm filter state in terms of listener counts.
1071          * If there are any exclusive listeners, stack-wide
1072          * membership is exclusive.
1073          * Otherwise, if only inclusive listeners, stack-wide is inclusive.
1074          * If no listeners remain, state is undefined at t1,
1075          * and the MLD lifecycle for this group should finish.
1076          */
1077         if (inm->in6m_st[1].iss_ex > 0) {
1078                 CTR1(KTR_MLD, "%s: transition to EX", __func__);
1079                 inm->in6m_st[1].iss_fmode = MCAST_EXCLUDE;
1080         } else if (inm->in6m_st[1].iss_in > 0) {
1081                 CTR1(KTR_MLD, "%s: transition to IN", __func__);
1082                 inm->in6m_st[1].iss_fmode = MCAST_INCLUDE;
1083         } else {
1084                 CTR1(KTR_MLD, "%s: transition to UNDEF", __func__);
1085                 inm->in6m_st[1].iss_fmode = MCAST_UNDEFINED;
1086         }
1087
1088         /* Decrement ASM listener count on transition out of ASM mode. */
1089         if (imf->im6f_st[0] == MCAST_EXCLUDE && nsrc0 == 0) {
1090                 if ((imf->im6f_st[1] != MCAST_EXCLUDE) ||
1091                     (imf->im6f_st[1] == MCAST_EXCLUDE && nsrc1 > 0)) {
1092                         CTR1(KTR_MLD, "%s: --asm on inm at t1", __func__);
1093                         --inm->in6m_st[1].iss_asm;
1094                 }
1095         }
1096
1097         /* Increment ASM listener count on transition to ASM mode. */
1098         if (imf->im6f_st[1] == MCAST_EXCLUDE && nsrc1 == 0) {
1099                 CTR1(KTR_MLD, "%s: asm++ on inm at t1", __func__);
1100                 inm->in6m_st[1].iss_asm++;
1101         }
1102
1103         CTR3(KTR_MLD, "%s: merged imf %p to inm %p", __func__, imf, inm);
1104         in6m_print(inm);
1105
1106 out_reap:
1107         if (schanged > 0) {
1108                 CTR1(KTR_MLD, "%s: sources changed; reaping", __func__);
1109                 in6m_reap(inm);
1110         }
1111         return (error);
1112 }
1113
1114 /*
1115  * Mark an in6_multi's filter set deltas as committed.
1116  * Called by MLD after a state change has been enqueued.
1117  */
1118 void
1119 in6m_commit(struct in6_multi *inm)
1120 {
1121         struct ip6_msource      *ims;
1122
1123         CTR2(KTR_MLD, "%s: commit inm %p", __func__, inm);
1124         CTR1(KTR_MLD, "%s: pre commit:", __func__);
1125         in6m_print(inm);
1126
1127         RB_FOREACH(ims, ip6_msource_tree, &inm->in6m_srcs) {
1128                 ims->im6s_st[0] = ims->im6s_st[1];
1129         }
1130         inm->in6m_st[0] = inm->in6m_st[1];
1131 }
1132
1133 /*
1134  * Reap unreferenced nodes from an in6_multi's filter set.
1135  */
1136 static void
1137 in6m_reap(struct in6_multi *inm)
1138 {
1139         struct ip6_msource      *ims, *tims;
1140
1141         RB_FOREACH_SAFE(ims, ip6_msource_tree, &inm->in6m_srcs, tims) {
1142                 if (ims->im6s_st[0].ex > 0 || ims->im6s_st[0].in > 0 ||
1143                     ims->im6s_st[1].ex > 0 || ims->im6s_st[1].in > 0 ||
1144                     ims->im6s_stp != 0)
1145                         continue;
1146                 CTR2(KTR_MLD, "%s: free ims %p", __func__, ims);
1147                 RB_REMOVE(ip6_msource_tree, &inm->in6m_srcs, ims);
1148                 free(ims, M_IP6MSOURCE);
1149                 inm->in6m_nsrc--;
1150         }
1151 }
1152
1153 /*
1154  * Purge all source nodes from an in6_multi's filter set.
1155  */
1156 static void
1157 in6m_purge(struct in6_multi *inm)
1158 {
1159         struct ip6_msource      *ims, *tims;
1160
1161         RB_FOREACH_SAFE(ims, ip6_msource_tree, &inm->in6m_srcs, tims) {
1162                 CTR2(KTR_MLD, "%s: free ims %p", __func__, ims);
1163                 RB_REMOVE(ip6_msource_tree, &inm->in6m_srcs, ims);
1164                 free(ims, M_IP6MSOURCE);
1165                 inm->in6m_nsrc--;
1166         }
1167         /* Free state-change requests that might be queued. */
1168         mbufq_drain(&inm->in6m_scq);
1169 }
1170
1171 /*
1172  * Join a multicast address w/o sources.
1173  * KAME compatibility entry point.
1174  *
1175  * SMPng: Assume no mc locks held by caller.
1176  */
1177 int
1178 in6_joingroup(struct ifnet *ifp, const struct in6_addr *mcaddr,
1179     /*const*/ struct in6_mfilter *imf, struct in6_multi **pinm,
1180     const int delay)
1181 {
1182         int error;
1183
1184         IN6_MULTI_LOCK();
1185         error = in6_joingroup_locked(ifp, mcaddr, NULL, pinm, delay);
1186         IN6_MULTI_UNLOCK();
1187         return (error);
1188 }
1189
1190 /*
1191  * Join a multicast group; real entry point.
1192  *
1193  * Only preserves atomicity at inm level.
1194  * NOTE: imf argument cannot be const due to sys/tree.h limitations.
1195  *
1196  * If the MLD downcall fails, the group is not joined, and an error
1197  * code is returned.
1198  */
1199 static int
1200 in6_joingroup_locked(struct ifnet *ifp, const struct in6_addr *mcaddr,
1201     /*const*/ struct in6_mfilter *imf, struct in6_multi **pinm,
1202     const int delay)
1203 {
1204         struct in6_multi_head    inmh;
1205         struct in6_mfilter       timf;
1206         struct in6_multi        *inm;
1207         struct ifmultiaddr *ifma;
1208         int                      error;
1209 #ifdef KTR
1210         char                     ip6tbuf[INET6_ADDRSTRLEN];
1211 #endif
1212
1213         /*
1214          * Sanity: Check scope zone ID was set for ifp, if and
1215          * only if group is scoped to an interface.
1216          */
1217         KASSERT(IN6_IS_ADDR_MULTICAST(mcaddr),
1218             ("%s: not a multicast address", __func__));
1219         if (IN6_IS_ADDR_MC_LINKLOCAL(mcaddr) ||
1220             IN6_IS_ADDR_MC_INTFACELOCAL(mcaddr)) {
1221                 KASSERT(mcaddr->s6_addr16[1] != 0,
1222                     ("%s: scope zone ID not set", __func__));
1223         }
1224
1225         IN6_MULTI_LOCK_ASSERT();
1226         IN6_MULTI_LIST_UNLOCK_ASSERT();
1227
1228         CTR4(KTR_MLD, "%s: join %s on %p(%s))", __func__,
1229             ip6_sprintf(ip6tbuf, mcaddr), ifp, if_name(ifp));
1230
1231         error = 0;
1232         inm = NULL;
1233
1234         /*
1235          * If no imf was specified (i.e. kernel consumer),
1236          * fake one up and assume it is an ASM join.
1237          */
1238         if (imf == NULL) {
1239                 im6f_init(&timf, MCAST_UNDEFINED, MCAST_EXCLUDE);
1240                 imf = &timf;
1241         }
1242         error = in6_getmulti(ifp, mcaddr, &inm);
1243         if (error) {
1244                 CTR1(KTR_MLD, "%s: in6_getmulti() failure", __func__);
1245                 return (error);
1246         }
1247
1248         IN6_MULTI_LIST_LOCK();
1249         CTR1(KTR_MLD, "%s: merge inm state", __func__);
1250         error = in6m_merge(inm, imf);
1251         if (error) {
1252                 CTR1(KTR_MLD, "%s: failed to merge inm state", __func__);
1253                 goto out_in6m_release;
1254         }
1255
1256         CTR1(KTR_MLD, "%s: doing mld downcall", __func__);
1257         error = mld_change_state(inm, delay);
1258         if (error) {
1259                 CTR1(KTR_MLD, "%s: failed to update source", __func__);
1260                 goto out_in6m_release;
1261         }
1262
1263 out_in6m_release:
1264         SLIST_INIT(&inmh);
1265         if (error) {
1266                 struct epoch_tracker et;
1267
1268                 CTR2(KTR_MLD, "%s: dropping ref on %p", __func__, inm);
1269                 IF_ADDR_WLOCK(ifp);
1270                 NET_EPOCH_ENTER(et);
1271                 CK_STAILQ_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link) {
1272                         if (ifma->ifma_protospec == inm) {
1273                                 ifma->ifma_protospec = NULL;
1274                                 break;
1275                         }
1276                 }
1277                 in6m_disconnect_locked(&inmh, inm);
1278                 in6m_rele_locked(&inmh, inm);
1279                 NET_EPOCH_EXIT(et);
1280                 IF_ADDR_WUNLOCK(ifp);
1281         } else {
1282                 *pinm = inm;
1283         }
1284         IN6_MULTI_LIST_UNLOCK();
1285         in6m_release_list_deferred(&inmh);
1286         return (error);
1287 }
1288
1289 /*
1290  * Leave a multicast group; unlocked entry point.
1291  */
1292 int
1293 in6_leavegroup(struct in6_multi *inm, /*const*/ struct in6_mfilter *imf)
1294 {
1295         int error;
1296
1297         IN6_MULTI_LOCK();
1298         error = in6_leavegroup_locked(inm, imf);
1299         IN6_MULTI_UNLOCK();
1300         return (error);
1301 }
1302
1303 /*
1304  * Leave a multicast group; real entry point.
1305  * All source filters will be expunged.
1306  *
1307  * Only preserves atomicity at inm level.
1308  *
1309  * Holding the write lock for the INP which contains imf
1310  * is highly advisable. We can't assert for it as imf does not
1311  * contain a back-pointer to the owning inp.
1312  *
1313  * Note: This is not the same as in6m_release(*) as this function also
1314  * makes a state change downcall into MLD.
1315  */
1316 int
1317 in6_leavegroup_locked(struct in6_multi *inm, /*const*/ struct in6_mfilter *imf)
1318 {
1319         struct in6_multi_head    inmh;
1320         struct in6_mfilter       timf;
1321         struct ifnet *ifp;
1322         int                      error;
1323 #ifdef KTR
1324         char                     ip6tbuf[INET6_ADDRSTRLEN];
1325 #endif
1326
1327         error = 0;
1328
1329         IN6_MULTI_LOCK_ASSERT();
1330
1331         CTR5(KTR_MLD, "%s: leave inm %p, %s/%s, imf %p", __func__,
1332             inm, ip6_sprintf(ip6tbuf, &inm->in6m_addr),
1333             (in6m_is_ifp_detached(inm) ? "null" : if_name(inm->in6m_ifp)),
1334             imf);
1335
1336         /*
1337          * If no imf was specified (i.e. kernel consumer),
1338          * fake one up and assume it is an ASM join.
1339          */
1340         if (imf == NULL) {
1341                 im6f_init(&timf, MCAST_EXCLUDE, MCAST_UNDEFINED);
1342                 imf = &timf;
1343         }
1344
1345         /*
1346          * Begin state merge transaction at MLD layer.
1347          *
1348          * As this particular invocation should not cause any memory
1349          * to be allocated, and there is no opportunity to roll back
1350          * the transaction, it MUST NOT fail.
1351          */
1352
1353         ifp = inm->in6m_ifp;
1354         IN6_MULTI_LIST_LOCK();
1355         CTR1(KTR_MLD, "%s: merge inm state", __func__);
1356         error = in6m_merge(inm, imf);
1357         KASSERT(error == 0, ("%s: failed to merge inm state", __func__));
1358
1359         CTR1(KTR_MLD, "%s: doing mld downcall", __func__);
1360         error = 0;
1361         if (ifp)
1362                 error = mld_change_state(inm, 0);
1363         if (error)
1364                 CTR1(KTR_MLD, "%s: failed mld downcall", __func__);
1365
1366         CTR2(KTR_MLD, "%s: dropping ref on %p", __func__, inm);
1367         if (ifp)
1368                 IF_ADDR_WLOCK(ifp);
1369
1370         SLIST_INIT(&inmh);
1371         if (inm->in6m_refcount == 1)
1372                 in6m_disconnect_locked(&inmh, inm);
1373         in6m_rele_locked(&inmh, inm);
1374         if (ifp)
1375                 IF_ADDR_WUNLOCK(ifp);
1376         IN6_MULTI_LIST_UNLOCK();
1377         in6m_release_list_deferred(&inmh);
1378         return (error);
1379 }
1380
1381 /*
1382  * Block or unblock an ASM multicast source on an inpcb.
1383  * This implements the delta-based API described in RFC 3678.
1384  *
1385  * The delta-based API applies only to exclusive-mode memberships.
1386  * An MLD downcall will be performed.
1387  *
1388  * SMPng: NOTE: Must take Giant as a join may create a new ifma.
1389  *
1390  * Return 0 if successful, otherwise return an appropriate error code.
1391  */
1392 static int
1393 in6p_block_unblock_source(struct inpcb *inp, struct sockopt *sopt)
1394 {
1395         struct group_source_req          gsr;
1396         sockunion_t                     *gsa, *ssa;
1397         struct ifnet                    *ifp;
1398         struct in6_mfilter              *imf;
1399         struct ip6_moptions             *imo;
1400         struct in6_msource              *ims;
1401         struct in6_multi                        *inm;
1402         uint16_t                         fmode;
1403         int                              error, doblock;
1404 #ifdef KTR
1405         char                             ip6tbuf[INET6_ADDRSTRLEN];
1406 #endif
1407
1408         ifp = NULL;
1409         error = 0;
1410         doblock = 0;
1411
1412         memset(&gsr, 0, sizeof(struct group_source_req));
1413         gsa = (sockunion_t *)&gsr.gsr_group;
1414         ssa = (sockunion_t *)&gsr.gsr_source;
1415
1416         switch (sopt->sopt_name) {
1417         case MCAST_BLOCK_SOURCE:
1418         case MCAST_UNBLOCK_SOURCE:
1419                 error = sooptcopyin(sopt, &gsr,
1420                     sizeof(struct group_source_req),
1421                     sizeof(struct group_source_req));
1422                 if (error)
1423                         return (error);
1424
1425                 if (gsa->sin6.sin6_family != AF_INET6 ||
1426                     gsa->sin6.sin6_len != sizeof(struct sockaddr_in6))
1427                         return (EINVAL);
1428
1429                 if (ssa->sin6.sin6_family != AF_INET6 ||
1430                     ssa->sin6.sin6_len != sizeof(struct sockaddr_in6))
1431                         return (EINVAL);
1432
1433                 if (gsr.gsr_interface == 0 || V_if_index < gsr.gsr_interface)
1434                         return (EADDRNOTAVAIL);
1435
1436                 ifp = ifnet_byindex(gsr.gsr_interface);
1437
1438                 if (sopt->sopt_name == MCAST_BLOCK_SOURCE)
1439                         doblock = 1;
1440                 break;
1441
1442         default:
1443                 CTR2(KTR_MLD, "%s: unknown sopt_name %d",
1444                     __func__, sopt->sopt_name);
1445                 return (EOPNOTSUPP);
1446                 break;
1447         }
1448
1449         if (!IN6_IS_ADDR_MULTICAST(&gsa->sin6.sin6_addr))
1450                 return (EINVAL);
1451
1452         (void)in6_setscope(&gsa->sin6.sin6_addr, ifp, NULL);
1453
1454         /*
1455          * Check if we are actually a member of this group.
1456          */
1457         imo = in6p_findmoptions(inp);
1458         imf = im6o_match_group(imo, ifp, &gsa->sa);
1459         if (imf == NULL) {
1460                 error = EADDRNOTAVAIL;
1461                 goto out_in6p_locked;
1462         }
1463         inm = imf->im6f_in6m;
1464
1465         /*
1466          * Attempting to use the delta-based API on an
1467          * non exclusive-mode membership is an error.
1468          */
1469         fmode = imf->im6f_st[0];
1470         if (fmode != MCAST_EXCLUDE) {
1471                 error = EINVAL;
1472                 goto out_in6p_locked;
1473         }
1474
1475         /*
1476          * Deal with error cases up-front:
1477          *  Asked to block, but already blocked; or
1478          *  Asked to unblock, but nothing to unblock.
1479          * If adding a new block entry, allocate it.
1480          */
1481         ims = im6o_match_source(imf, &ssa->sa);
1482         if ((ims != NULL && doblock) || (ims == NULL && !doblock)) {
1483                 CTR3(KTR_MLD, "%s: source %s %spresent", __func__,
1484                     ip6_sprintf(ip6tbuf, &ssa->sin6.sin6_addr),
1485                     doblock ? "" : "not ");
1486                 error = EADDRNOTAVAIL;
1487                 goto out_in6p_locked;
1488         }
1489
1490         INP_WLOCK_ASSERT(inp);
1491
1492         /*
1493          * Begin state merge transaction at socket layer.
1494          */
1495         if (doblock) {
1496                 CTR2(KTR_MLD, "%s: %s source", __func__, "block");
1497                 ims = im6f_graft(imf, fmode, &ssa->sin6);
1498                 if (ims == NULL)
1499                         error = ENOMEM;
1500         } else {
1501                 CTR2(KTR_MLD, "%s: %s source", __func__, "allow");
1502                 error = im6f_prune(imf, &ssa->sin6);
1503         }
1504
1505         if (error) {
1506                 CTR1(KTR_MLD, "%s: merge imf state failed", __func__);
1507                 goto out_im6f_rollback;
1508         }
1509
1510         /*
1511          * Begin state merge transaction at MLD layer.
1512          */
1513         IN6_MULTI_LIST_LOCK();
1514         CTR1(KTR_MLD, "%s: merge inm state", __func__);
1515         error = in6m_merge(inm, imf);
1516         if (error)
1517                 CTR1(KTR_MLD, "%s: failed to merge inm state", __func__);
1518         else {
1519                 CTR1(KTR_MLD, "%s: doing mld downcall", __func__);
1520                 error = mld_change_state(inm, 0);
1521                 if (error)
1522                         CTR1(KTR_MLD, "%s: failed mld downcall", __func__);
1523         }
1524
1525         IN6_MULTI_LIST_UNLOCK();
1526
1527 out_im6f_rollback:
1528         if (error)
1529                 im6f_rollback(imf);
1530         else
1531                 im6f_commit(imf);
1532
1533         im6f_reap(imf);
1534
1535 out_in6p_locked:
1536         INP_WUNLOCK(inp);
1537         return (error);
1538 }
1539
1540 /*
1541  * Given an inpcb, return its multicast options structure pointer.  Accepts
1542  * an unlocked inpcb pointer, but will return it locked.  May sleep.
1543  *
1544  * SMPng: NOTE: Potentially calls malloc(M_WAITOK) with Giant held.
1545  * SMPng: NOTE: Returns with the INP write lock held.
1546  */
1547 static struct ip6_moptions *
1548 in6p_findmoptions(struct inpcb *inp)
1549 {
1550         struct ip6_moptions      *imo;
1551
1552         INP_WLOCK(inp);
1553         if (inp->in6p_moptions != NULL)
1554                 return (inp->in6p_moptions);
1555
1556         INP_WUNLOCK(inp);
1557
1558         imo = malloc(sizeof(*imo), M_IP6MOPTS, M_WAITOK);
1559
1560         imo->im6o_multicast_ifp = NULL;
1561         imo->im6o_multicast_hlim = V_ip6_defmcasthlim;
1562         imo->im6o_multicast_loop = in6_mcast_loop;
1563         STAILQ_INIT(&imo->im6o_head);
1564
1565         INP_WLOCK(inp);
1566         if (inp->in6p_moptions != NULL) {
1567                 free(imo, M_IP6MOPTS);
1568                 return (inp->in6p_moptions);
1569         }
1570         inp->in6p_moptions = imo;
1571         return (imo);
1572 }
1573
1574 /*
1575  * Discard the IPv6 multicast options (and source filters).
1576  *
1577  * SMPng: NOTE: assumes INP write lock is held.
1578  *
1579  * XXX can all be safely deferred to epoch_call
1580  *
1581  */
1582
1583 static void
1584 inp_gcmoptions(struct ip6_moptions *imo)
1585 {
1586         struct in6_mfilter *imf;
1587         struct in6_multi *inm;
1588         struct ifnet *ifp;
1589
1590         while ((imf = ip6_mfilter_first(&imo->im6o_head)) != NULL) {
1591                 ip6_mfilter_remove(&imo->im6o_head, imf);
1592
1593                 im6f_leave(imf);
1594                 if ((inm = imf->im6f_in6m) != NULL) {
1595                         if ((ifp = inm->in6m_ifp) != NULL) {
1596                                 CURVNET_SET(ifp->if_vnet);
1597                                 (void)in6_leavegroup(inm, imf);
1598                                 CURVNET_RESTORE();
1599                         } else {
1600                                 (void)in6_leavegroup(inm, imf);
1601                         }
1602                 }
1603                 ip6_mfilter_free(imf);
1604         }
1605         free(imo, M_IP6MOPTS);
1606 }
1607
1608 void
1609 ip6_freemoptions(struct ip6_moptions *imo)
1610 {
1611         if (imo == NULL)
1612                 return;
1613         inp_gcmoptions(imo);
1614 }
1615
1616 /*
1617  * Atomically get source filters on a socket for an IPv6 multicast group.
1618  * Called with INP lock held; returns with lock released.
1619  */
1620 static int
1621 in6p_get_source_filters(struct inpcb *inp, struct sockopt *sopt)
1622 {
1623         struct __msfilterreq     msfr;
1624         sockunion_t             *gsa;
1625         struct ifnet            *ifp;
1626         struct ip6_moptions     *imo;
1627         struct in6_mfilter      *imf;
1628         struct ip6_msource      *ims;
1629         struct in6_msource      *lims;
1630         struct sockaddr_in6     *psin;
1631         struct sockaddr_storage *ptss;
1632         struct sockaddr_storage *tss;
1633         int                      error;
1634         size_t                   nsrcs, ncsrcs;
1635
1636         INP_WLOCK_ASSERT(inp);
1637
1638         imo = inp->in6p_moptions;
1639         KASSERT(imo != NULL, ("%s: null ip6_moptions", __func__));
1640
1641         INP_WUNLOCK(inp);
1642
1643         error = sooptcopyin(sopt, &msfr, sizeof(struct __msfilterreq),
1644             sizeof(struct __msfilterreq));
1645         if (error)
1646                 return (error);
1647
1648         if (msfr.msfr_group.ss_family != AF_INET6 ||
1649             msfr.msfr_group.ss_len != sizeof(struct sockaddr_in6))
1650                 return (EINVAL);
1651
1652         gsa = (sockunion_t *)&msfr.msfr_group;
1653         if (!IN6_IS_ADDR_MULTICAST(&gsa->sin6.sin6_addr))
1654                 return (EINVAL);
1655
1656         if (msfr.msfr_ifindex == 0 || V_if_index < msfr.msfr_ifindex)
1657                 return (EADDRNOTAVAIL);
1658         ifp = ifnet_byindex(msfr.msfr_ifindex);
1659         if (ifp == NULL)
1660                 return (EADDRNOTAVAIL);
1661         (void)in6_setscope(&gsa->sin6.sin6_addr, ifp, NULL);
1662
1663         INP_WLOCK(inp);
1664
1665         /*
1666          * Lookup group on the socket.
1667          */
1668         imf = im6o_match_group(imo, ifp, &gsa->sa);
1669         if (imf == NULL) {
1670                 INP_WUNLOCK(inp);
1671                 return (EADDRNOTAVAIL);
1672         }
1673
1674         /*
1675          * Ignore memberships which are in limbo.
1676          */
1677         if (imf->im6f_st[1] == MCAST_UNDEFINED) {
1678                 INP_WUNLOCK(inp);
1679                 return (EAGAIN);
1680         }
1681         msfr.msfr_fmode = imf->im6f_st[1];
1682
1683         /*
1684          * If the user specified a buffer, copy out the source filter
1685          * entries to userland gracefully.
1686          * We only copy out the number of entries which userland
1687          * has asked for, but we always tell userland how big the
1688          * buffer really needs to be.
1689          */
1690         if (msfr.msfr_nsrcs > in6_mcast_maxsocksrc)
1691                 msfr.msfr_nsrcs = in6_mcast_maxsocksrc;
1692         tss = NULL;
1693         if (msfr.msfr_srcs != NULL && msfr.msfr_nsrcs > 0) {
1694                 tss = malloc(sizeof(struct sockaddr_storage) * msfr.msfr_nsrcs,
1695                     M_TEMP, M_NOWAIT | M_ZERO);
1696                 if (tss == NULL) {
1697                         INP_WUNLOCK(inp);
1698                         return (ENOBUFS);
1699                 }
1700         }
1701
1702         /*
1703          * Count number of sources in-mode at t0.
1704          * If buffer space exists and remains, copy out source entries.
1705          */
1706         nsrcs = msfr.msfr_nsrcs;
1707         ncsrcs = 0;
1708         ptss = tss;
1709         RB_FOREACH(ims, ip6_msource_tree, &imf->im6f_sources) {
1710                 lims = (struct in6_msource *)ims;
1711                 if (lims->im6sl_st[0] == MCAST_UNDEFINED ||
1712                     lims->im6sl_st[0] != imf->im6f_st[0])
1713                         continue;
1714                 ++ncsrcs;
1715                 if (tss != NULL && nsrcs > 0) {
1716                         psin = (struct sockaddr_in6 *)ptss;
1717                         psin->sin6_family = AF_INET6;
1718                         psin->sin6_len = sizeof(struct sockaddr_in6);
1719                         psin->sin6_addr = lims->im6s_addr;
1720                         psin->sin6_port = 0;
1721                         --nsrcs;
1722                         ++ptss;
1723                 }
1724         }
1725
1726         INP_WUNLOCK(inp);
1727
1728         if (tss != NULL) {
1729                 error = copyout(tss, msfr.msfr_srcs,
1730                     sizeof(struct sockaddr_storage) * msfr.msfr_nsrcs);
1731                 free(tss, M_TEMP);
1732                 if (error)
1733                         return (error);
1734         }
1735
1736         msfr.msfr_nsrcs = ncsrcs;
1737         error = sooptcopyout(sopt, &msfr, sizeof(struct __msfilterreq));
1738
1739         return (error);
1740 }
1741
1742 /*
1743  * Return the IP multicast options in response to user getsockopt().
1744  */
1745 int
1746 ip6_getmoptions(struct inpcb *inp, struct sockopt *sopt)
1747 {
1748         struct ip6_moptions     *im6o;
1749         int                      error;
1750         u_int                    optval;
1751
1752         INP_WLOCK(inp);
1753         im6o = inp->in6p_moptions;
1754         /*
1755          * If socket is neither of type SOCK_RAW or SOCK_DGRAM,
1756          * or is a divert socket, reject it.
1757          */
1758         if (inp->inp_socket->so_proto->pr_protocol == IPPROTO_DIVERT ||
1759             (inp->inp_socket->so_proto->pr_type != SOCK_RAW &&
1760             inp->inp_socket->so_proto->pr_type != SOCK_DGRAM)) {
1761                 INP_WUNLOCK(inp);
1762                 return (EOPNOTSUPP);
1763         }
1764
1765         error = 0;
1766         switch (sopt->sopt_name) {
1767         case IPV6_MULTICAST_IF:
1768                 if (im6o == NULL || im6o->im6o_multicast_ifp == NULL) {
1769                         optval = 0;
1770                 } else {
1771                         optval = im6o->im6o_multicast_ifp->if_index;
1772                 }
1773                 INP_WUNLOCK(inp);
1774                 error = sooptcopyout(sopt, &optval, sizeof(u_int));
1775                 break;
1776
1777         case IPV6_MULTICAST_HOPS:
1778                 if (im6o == NULL)
1779                         optval = V_ip6_defmcasthlim;
1780                 else
1781                         optval = im6o->im6o_multicast_hlim;
1782                 INP_WUNLOCK(inp);
1783                 error = sooptcopyout(sopt, &optval, sizeof(u_int));
1784                 break;
1785
1786         case IPV6_MULTICAST_LOOP:
1787                 if (im6o == NULL)
1788                         optval = in6_mcast_loop; /* XXX VIMAGE */
1789                 else
1790                         optval = im6o->im6o_multicast_loop;
1791                 INP_WUNLOCK(inp);
1792                 error = sooptcopyout(sopt, &optval, sizeof(u_int));
1793                 break;
1794
1795         case IPV6_MSFILTER:
1796                 if (im6o == NULL) {
1797                         error = EADDRNOTAVAIL;
1798                         INP_WUNLOCK(inp);
1799                 } else {
1800                         error = in6p_get_source_filters(inp, sopt);
1801                 }
1802                 break;
1803
1804         default:
1805                 INP_WUNLOCK(inp);
1806                 error = ENOPROTOOPT;
1807                 break;
1808         }
1809
1810         INP_UNLOCK_ASSERT(inp);
1811
1812         return (error);
1813 }
1814
1815 /*
1816  * Look up the ifnet to use for a multicast group membership,
1817  * given the address of an IPv6 group.
1818  *
1819  * This routine exists to support legacy IPv6 multicast applications.
1820  *
1821  * Use the socket's current FIB number for any required FIB lookup. Look up the
1822  * group address in the unicast FIB, and use its ifp; usually, this points to
1823  * the default next-hop.  If the FIB lookup fails, return NULL.
1824  *
1825  * FUTURE: Support multiple forwarding tables for IPv6.
1826  *
1827  * Returns NULL if no ifp could be found.
1828  */
1829 static struct ifnet *
1830 in6p_lookup_mcast_ifp(const struct inpcb *inp, const struct sockaddr_in6 *gsin6)
1831 {
1832         struct nhop_object      *nh;
1833         struct in6_addr         dst;
1834         uint32_t                scopeid;
1835         uint32_t                fibnum;
1836
1837         KASSERT(gsin6->sin6_family == AF_INET6,
1838             ("%s: not AF_INET6 group", __func__));
1839
1840         in6_splitscope(&gsin6->sin6_addr, &dst, &scopeid);
1841         fibnum = inp->inp_inc.inc_fibnum;
1842         nh = fib6_lookup(fibnum, &dst, scopeid, 0, 0);
1843
1844         return (nh ? nh->nh_ifp : NULL);
1845 }
1846
1847 /*
1848  * Join an IPv6 multicast group, possibly with a source.
1849  *
1850  * FIXME: The KAME use of the unspecified address (::)
1851  * to join *all* multicast groups is currently unsupported.
1852  */
1853 static int
1854 in6p_join_group(struct inpcb *inp, struct sockopt *sopt)
1855 {
1856         struct in6_multi_head            inmh;
1857         struct group_source_req          gsr;
1858         sockunion_t                     *gsa, *ssa;
1859         struct ifnet                    *ifp;
1860         struct in6_mfilter              *imf;
1861         struct ip6_moptions             *imo;
1862         struct in6_multi                *inm;
1863         struct in6_msource              *lims;
1864         int                              error, is_new;
1865
1866         SLIST_INIT(&inmh);
1867         ifp = NULL;
1868         lims = NULL;
1869         error = 0;
1870
1871         memset(&gsr, 0, sizeof(struct group_source_req));
1872         gsa = (sockunion_t *)&gsr.gsr_group;
1873         gsa->ss.ss_family = AF_UNSPEC;
1874         ssa = (sockunion_t *)&gsr.gsr_source;
1875         ssa->ss.ss_family = AF_UNSPEC;
1876
1877         /*
1878          * Chew everything into struct group_source_req.
1879          * Overwrite the port field if present, as the sockaddr
1880          * being copied in may be matched with a binary comparison.
1881          * Ignore passed-in scope ID.
1882          */
1883         switch (sopt->sopt_name) {
1884         case IPV6_JOIN_GROUP: {
1885                 struct ipv6_mreq mreq;
1886
1887                 error = sooptcopyin(sopt, &mreq, sizeof(struct ipv6_mreq),
1888                     sizeof(struct ipv6_mreq));
1889                 if (error)
1890                         return (error);
1891
1892                 gsa->sin6.sin6_family = AF_INET6;
1893                 gsa->sin6.sin6_len = sizeof(struct sockaddr_in6);
1894                 gsa->sin6.sin6_addr = mreq.ipv6mr_multiaddr;
1895
1896                 if (mreq.ipv6mr_interface == 0) {
1897                         ifp = in6p_lookup_mcast_ifp(inp, &gsa->sin6);
1898                 } else {
1899                         if (V_if_index < mreq.ipv6mr_interface)
1900                                 return (EADDRNOTAVAIL);
1901                         ifp = ifnet_byindex(mreq.ipv6mr_interface);
1902                 }
1903                 CTR3(KTR_MLD, "%s: ipv6mr_interface = %d, ifp = %p",
1904                     __func__, mreq.ipv6mr_interface, ifp);
1905         } break;
1906
1907         case MCAST_JOIN_GROUP:
1908         case MCAST_JOIN_SOURCE_GROUP:
1909                 if (sopt->sopt_name == MCAST_JOIN_GROUP) {
1910                         error = sooptcopyin(sopt, &gsr,
1911                             sizeof(struct group_req),
1912                             sizeof(struct group_req));
1913                 } else if (sopt->sopt_name == MCAST_JOIN_SOURCE_GROUP) {
1914                         error = sooptcopyin(sopt, &gsr,
1915                             sizeof(struct group_source_req),
1916                             sizeof(struct group_source_req));
1917                 }
1918                 if (error)
1919                         return (error);
1920
1921                 if (gsa->sin6.sin6_family != AF_INET6 ||
1922                     gsa->sin6.sin6_len != sizeof(struct sockaddr_in6))
1923                         return (EINVAL);
1924
1925                 if (sopt->sopt_name == MCAST_JOIN_SOURCE_GROUP) {
1926                         if (ssa->sin6.sin6_family != AF_INET6 ||
1927                             ssa->sin6.sin6_len != sizeof(struct sockaddr_in6))
1928                                 return (EINVAL);
1929                         if (IN6_IS_ADDR_MULTICAST(&ssa->sin6.sin6_addr))
1930                                 return (EINVAL);
1931                         /*
1932                          * TODO: Validate embedded scope ID in source
1933                          * list entry against passed-in ifp, if and only
1934                          * if source list filter entry is iface or node local.
1935                          */
1936                         in6_clearscope(&ssa->sin6.sin6_addr);
1937                         ssa->sin6.sin6_port = 0;
1938                         ssa->sin6.sin6_scope_id = 0;
1939                 }
1940
1941                 if (gsr.gsr_interface == 0 || V_if_index < gsr.gsr_interface)
1942                         return (EADDRNOTAVAIL);
1943                 ifp = ifnet_byindex(gsr.gsr_interface);
1944                 break;
1945
1946         default:
1947                 CTR2(KTR_MLD, "%s: unknown sopt_name %d",
1948                     __func__, sopt->sopt_name);
1949                 return (EOPNOTSUPP);
1950                 break;
1951         }
1952
1953         if (!IN6_IS_ADDR_MULTICAST(&gsa->sin6.sin6_addr))
1954                 return (EINVAL);
1955
1956         if (ifp == NULL || (ifp->if_flags & IFF_MULTICAST) == 0)
1957                 return (EADDRNOTAVAIL);
1958
1959         gsa->sin6.sin6_port = 0;
1960         gsa->sin6.sin6_scope_id = 0;
1961
1962         /*
1963          * Always set the scope zone ID on memberships created from userland.
1964          * Use the passed-in ifp to do this.
1965          * XXX The in6_setscope() return value is meaningless.
1966          * XXX SCOPE6_LOCK() is taken by in6_setscope().
1967          */
1968         (void)in6_setscope(&gsa->sin6.sin6_addr, ifp, NULL);
1969
1970         IN6_MULTI_LOCK();
1971
1972         /*
1973          * Find the membership in the membership list.
1974          */
1975         imo = in6p_findmoptions(inp);
1976         imf = im6o_match_group(imo, ifp, &gsa->sa);
1977         if (imf == NULL) {
1978                 is_new = 1;
1979                 inm = NULL;
1980
1981                 if (ip6_mfilter_count(&imo->im6o_head) >= IPV6_MAX_MEMBERSHIPS) {
1982                         error = ENOMEM;
1983                         goto out_in6p_locked;
1984                 }
1985         } else {
1986                 is_new = 0;
1987                 inm = imf->im6f_in6m;
1988
1989                 if (ssa->ss.ss_family != AF_UNSPEC) {
1990                         /*
1991                          * MCAST_JOIN_SOURCE_GROUP on an exclusive membership
1992                          * is an error. On an existing inclusive membership,
1993                          * it just adds the source to the filter list.
1994                          */
1995                         if (imf->im6f_st[1] != MCAST_INCLUDE) {
1996                                 error = EINVAL;
1997                                 goto out_in6p_locked;
1998                         }
1999                         /*
2000                          * Throw out duplicates.
2001                          *
2002                          * XXX FIXME: This makes a naive assumption that
2003                          * even if entries exist for *ssa in this imf,
2004                          * they will be rejected as dupes, even if they
2005                          * are not valid in the current mode (in-mode).
2006                          *
2007                          * in6_msource is transactioned just as for anything
2008                          * else in SSM -- but note naive use of in6m_graft()
2009                          * below for allocating new filter entries.
2010                          *
2011                          * This is only an issue if someone mixes the
2012                          * full-state SSM API with the delta-based API,
2013                          * which is discouraged in the relevant RFCs.
2014                          */
2015                         lims = im6o_match_source(imf, &ssa->sa);
2016                         if (lims != NULL /*&&
2017                             lims->im6sl_st[1] == MCAST_INCLUDE*/) {
2018                                 error = EADDRNOTAVAIL;
2019                                 goto out_in6p_locked;
2020                         }
2021                 } else {
2022                         /*
2023                          * MCAST_JOIN_GROUP alone, on any existing membership,
2024                          * is rejected, to stop the same inpcb tying up
2025                          * multiple refs to the in_multi.
2026                          * On an existing inclusive membership, this is also
2027                          * an error; if you want to change filter mode,
2028                          * you must use the userland API setsourcefilter().
2029                          * XXX We don't reject this for imf in UNDEFINED
2030                          * state at t1, because allocation of a filter
2031                          * is atomic with allocation of a membership.
2032                          */
2033                         error = EINVAL;
2034                         goto out_in6p_locked;
2035                 }
2036         }
2037
2038         /*
2039          * Begin state merge transaction at socket layer.
2040          */
2041         INP_WLOCK_ASSERT(inp);
2042
2043         /*
2044          * Graft new source into filter list for this inpcb's
2045          * membership of the group. The in6_multi may not have
2046          * been allocated yet if this is a new membership, however,
2047          * the in_mfilter slot will be allocated and must be initialized.
2048          *
2049          * Note: Grafting of exclusive mode filters doesn't happen
2050          * in this path.
2051          * XXX: Should check for non-NULL lims (node exists but may
2052          * not be in-mode) for interop with full-state API.
2053          */
2054         if (ssa->ss.ss_family != AF_UNSPEC) {
2055                 /* Membership starts in IN mode */
2056                 if (is_new) {
2057                         CTR1(KTR_MLD, "%s: new join w/source", __func__);
2058                         imf = ip6_mfilter_alloc(M_NOWAIT, MCAST_UNDEFINED, MCAST_INCLUDE);
2059                         if (imf == NULL) {
2060                                 error = ENOMEM;
2061                                 goto out_in6p_locked;
2062                         }
2063                 } else {
2064                         CTR2(KTR_MLD, "%s: %s source", __func__, "allow");
2065                 }
2066                 lims = im6f_graft(imf, MCAST_INCLUDE, &ssa->sin6);
2067                 if (lims == NULL) {
2068                         CTR1(KTR_MLD, "%s: merge imf state failed",
2069                             __func__);
2070                         error = ENOMEM;
2071                         goto out_in6p_locked;
2072                 }
2073         } else {
2074                 /* No address specified; Membership starts in EX mode */
2075                 if (is_new) {
2076                         CTR1(KTR_MLD, "%s: new join w/o source", __func__);
2077                         imf = ip6_mfilter_alloc(M_NOWAIT, MCAST_UNDEFINED, MCAST_EXCLUDE);
2078                         if (imf == NULL) {
2079                                 error = ENOMEM;
2080                                 goto out_in6p_locked;
2081                         }
2082                 }
2083         }
2084
2085         /*
2086          * Begin state merge transaction at MLD layer.
2087          */
2088         if (is_new) {
2089                 in_pcbref(inp);
2090                 INP_WUNLOCK(inp);
2091
2092                 error = in6_joingroup_locked(ifp, &gsa->sin6.sin6_addr, imf,
2093                     &imf->im6f_in6m, 0);
2094
2095                 INP_WLOCK(inp);
2096                 if (in_pcbrele_wlocked(inp)) {
2097                         error = ENXIO;
2098                         goto out_in6p_unlocked;
2099                 }
2100                 if (error) {
2101                         goto out_in6p_locked;
2102                 }
2103                 /*
2104                  * NOTE: Refcount from in6_joingroup_locked()
2105                  * is protecting membership.
2106                  */
2107                 ip6_mfilter_insert(&imo->im6o_head, imf);
2108         } else {
2109                 CTR1(KTR_MLD, "%s: merge inm state", __func__);
2110                 IN6_MULTI_LIST_LOCK();
2111                 error = in6m_merge(inm, imf);
2112                 if (error) {
2113                         CTR1(KTR_MLD, "%s: failed to merge inm state",
2114                             __func__);
2115                         IN6_MULTI_LIST_UNLOCK();
2116                         im6f_rollback(imf);
2117                         im6f_reap(imf);
2118                         goto out_in6p_locked;
2119                 }
2120                 CTR1(KTR_MLD, "%s: doing mld downcall", __func__);
2121                 error = mld_change_state(inm, 0);
2122                 IN6_MULTI_LIST_UNLOCK();
2123
2124                 if (error) {
2125                         CTR1(KTR_MLD, "%s: failed mld downcall",
2126                              __func__);
2127                         im6f_rollback(imf);
2128                         im6f_reap(imf);
2129                         goto out_in6p_locked;
2130                 }
2131         }
2132
2133         im6f_commit(imf);
2134         imf = NULL;
2135
2136 out_in6p_locked:
2137         INP_WUNLOCK(inp);
2138 out_in6p_unlocked:
2139         IN6_MULTI_UNLOCK();
2140
2141         if (is_new && imf) {
2142                 if (imf->im6f_in6m != NULL) {
2143                         struct in6_multi_head inmh;
2144
2145                         SLIST_INIT(&inmh);
2146                         SLIST_INSERT_HEAD(&inmh, imf->im6f_in6m, in6m_defer);
2147                         in6m_release_list_deferred(&inmh);
2148                 }
2149                 ip6_mfilter_free(imf);
2150         }
2151         return (error);
2152 }
2153
2154 /*
2155  * Leave an IPv6 multicast group on an inpcb, possibly with a source.
2156  */
2157 static int
2158 in6p_leave_group(struct inpcb *inp, struct sockopt *sopt)
2159 {
2160         struct ipv6_mreq                 mreq;
2161         struct group_source_req          gsr;
2162         sockunion_t                     *gsa, *ssa;
2163         struct ifnet                    *ifp;
2164         struct in6_mfilter              *imf;
2165         struct ip6_moptions             *imo;
2166         struct in6_msource              *ims;
2167         struct in6_multi                *inm;
2168         uint32_t                         ifindex;
2169         int                              error;
2170         bool                             is_final;
2171 #ifdef KTR
2172         char                             ip6tbuf[INET6_ADDRSTRLEN];
2173 #endif
2174
2175         ifp = NULL;
2176         ifindex = 0;
2177         error = 0;
2178         is_final = true;
2179
2180         memset(&gsr, 0, sizeof(struct group_source_req));
2181         gsa = (sockunion_t *)&gsr.gsr_group;
2182         gsa->ss.ss_family = AF_UNSPEC;
2183         ssa = (sockunion_t *)&gsr.gsr_source;
2184         ssa->ss.ss_family = AF_UNSPEC;
2185
2186         /*
2187          * Chew everything passed in up into a struct group_source_req
2188          * as that is easier to process.
2189          * Note: Any embedded scope ID in the multicast group passed
2190          * in by userland is ignored, the interface index is the recommended
2191          * mechanism to specify an interface; see below.
2192          */
2193         switch (sopt->sopt_name) {
2194         case IPV6_LEAVE_GROUP:
2195                 error = sooptcopyin(sopt, &mreq, sizeof(struct ipv6_mreq),
2196                     sizeof(struct ipv6_mreq));
2197                 if (error)
2198                         return (error);
2199                 gsa->sin6.sin6_family = AF_INET6;
2200                 gsa->sin6.sin6_len = sizeof(struct sockaddr_in6);
2201                 gsa->sin6.sin6_addr = mreq.ipv6mr_multiaddr;
2202                 gsa->sin6.sin6_port = 0;
2203                 gsa->sin6.sin6_scope_id = 0;
2204                 ifindex = mreq.ipv6mr_interface;
2205                 break;
2206
2207         case MCAST_LEAVE_GROUP:
2208         case MCAST_LEAVE_SOURCE_GROUP:
2209                 if (sopt->sopt_name == MCAST_LEAVE_GROUP) {
2210                         error = sooptcopyin(sopt, &gsr,
2211                             sizeof(struct group_req),
2212                             sizeof(struct group_req));
2213                 } else if (sopt->sopt_name == MCAST_LEAVE_SOURCE_GROUP) {
2214                         error = sooptcopyin(sopt, &gsr,
2215                             sizeof(struct group_source_req),
2216                             sizeof(struct group_source_req));
2217                 }
2218                 if (error)
2219                         return (error);
2220
2221                 if (gsa->sin6.sin6_family != AF_INET6 ||
2222                     gsa->sin6.sin6_len != sizeof(struct sockaddr_in6))
2223                         return (EINVAL);
2224                 if (sopt->sopt_name == MCAST_LEAVE_SOURCE_GROUP) {
2225                         if (ssa->sin6.sin6_family != AF_INET6 ||
2226                             ssa->sin6.sin6_len != sizeof(struct sockaddr_in6))
2227                                 return (EINVAL);
2228                         if (IN6_IS_ADDR_MULTICAST(&ssa->sin6.sin6_addr))
2229                                 return (EINVAL);
2230                         /*
2231                          * TODO: Validate embedded scope ID in source
2232                          * list entry against passed-in ifp, if and only
2233                          * if source list filter entry is iface or node local.
2234                          */
2235                         in6_clearscope(&ssa->sin6.sin6_addr);
2236                 }
2237                 gsa->sin6.sin6_port = 0;
2238                 gsa->sin6.sin6_scope_id = 0;
2239                 ifindex = gsr.gsr_interface;
2240                 break;
2241
2242         default:
2243                 CTR2(KTR_MLD, "%s: unknown sopt_name %d",
2244                     __func__, sopt->sopt_name);
2245                 return (EOPNOTSUPP);
2246                 break;
2247         }
2248
2249         if (!IN6_IS_ADDR_MULTICAST(&gsa->sin6.sin6_addr))
2250                 return (EINVAL);
2251
2252         /*
2253          * Validate interface index if provided. If no interface index
2254          * was provided separately, attempt to look the membership up
2255          * from the default scope as a last resort to disambiguate
2256          * the membership we are being asked to leave.
2257          * XXX SCOPE6 lock potentially taken here.
2258          */
2259         if (ifindex != 0) {
2260                 if (V_if_index < ifindex)
2261                         return (EADDRNOTAVAIL);
2262                 ifp = ifnet_byindex(ifindex);
2263                 if (ifp == NULL)
2264                         return (EADDRNOTAVAIL);
2265                 (void)in6_setscope(&gsa->sin6.sin6_addr, ifp, NULL);
2266         } else {
2267                 error = sa6_embedscope(&gsa->sin6, V_ip6_use_defzone);
2268                 if (error)
2269                         return (EADDRNOTAVAIL);
2270                 /*
2271                  * Some badly behaved applications don't pass an ifindex
2272                  * or a scope ID, which is an API violation. In this case,
2273                  * perform a lookup as per a v6 join.
2274                  *
2275                  * XXX For now, stomp on zone ID for the corner case.
2276                  * This is not the 'KAME way', but we need to see the ifp
2277                  * directly until such time as this implementation is
2278                  * refactored, assuming the scope IDs are the way to go.
2279                  */
2280                 ifindex = ntohs(gsa->sin6.sin6_addr.s6_addr16[1]);
2281                 if (ifindex == 0) {
2282                         CTR2(KTR_MLD, "%s: warning: no ifindex, looking up "
2283                             "ifp for group %s.", __func__,
2284                             ip6_sprintf(ip6tbuf, &gsa->sin6.sin6_addr));
2285                         ifp = in6p_lookup_mcast_ifp(inp, &gsa->sin6);
2286                 } else {
2287                         ifp = ifnet_byindex(ifindex);
2288                 }
2289                 if (ifp == NULL)
2290                         return (EADDRNOTAVAIL);
2291         }
2292
2293         CTR2(KTR_MLD, "%s: ifp = %p", __func__, ifp);
2294         KASSERT(ifp != NULL, ("%s: ifp did not resolve", __func__));
2295
2296         IN6_MULTI_LOCK();
2297
2298         /*
2299          * Find the membership in the membership list.
2300          */
2301         imo = in6p_findmoptions(inp);
2302         imf = im6o_match_group(imo, ifp, &gsa->sa);
2303         if (imf == NULL) {
2304                 error = EADDRNOTAVAIL;
2305                 goto out_in6p_locked;
2306         }
2307         inm = imf->im6f_in6m;
2308
2309         if (ssa->ss.ss_family != AF_UNSPEC)
2310                 is_final = false;
2311
2312         /*
2313          * Begin state merge transaction at socket layer.
2314          */
2315         INP_WLOCK_ASSERT(inp);
2316
2317         /*
2318          * If we were instructed only to leave a given source, do so.
2319          * MCAST_LEAVE_SOURCE_GROUP is only valid for inclusive memberships.
2320          */
2321         if (is_final) {
2322                 ip6_mfilter_remove(&imo->im6o_head, imf);
2323                 im6f_leave(imf);
2324
2325                 /*
2326                  * Give up the multicast address record to which
2327                  * the membership points.
2328                  */
2329                 (void)in6_leavegroup_locked(inm, imf);
2330         } else {
2331                 if (imf->im6f_st[0] == MCAST_EXCLUDE) {
2332                         error = EADDRNOTAVAIL;
2333                         goto out_in6p_locked;
2334                 }
2335                 ims = im6o_match_source(imf, &ssa->sa);
2336                 if (ims == NULL) {
2337                         CTR3(KTR_MLD, "%s: source %p %spresent", __func__,
2338                             ip6_sprintf(ip6tbuf, &ssa->sin6.sin6_addr),
2339                             "not ");
2340                         error = EADDRNOTAVAIL;
2341                         goto out_in6p_locked;
2342                 }
2343                 CTR2(KTR_MLD, "%s: %s source", __func__, "block");
2344                 error = im6f_prune(imf, &ssa->sin6);
2345                 if (error) {
2346                         CTR1(KTR_MLD, "%s: merge imf state failed",
2347                             __func__);
2348                         goto out_in6p_locked;
2349                 }
2350         }
2351
2352         /*
2353          * Begin state merge transaction at MLD layer.
2354          */
2355         if (!is_final) {
2356                 CTR1(KTR_MLD, "%s: merge inm state", __func__);
2357                 IN6_MULTI_LIST_LOCK();
2358                 error = in6m_merge(inm, imf);
2359                 if (error) {
2360                         CTR1(KTR_MLD, "%s: failed to merge inm state",
2361                             __func__);
2362                         IN6_MULTI_LIST_UNLOCK();
2363                         im6f_rollback(imf);
2364                         im6f_reap(imf);
2365                         goto out_in6p_locked;
2366                 }
2367
2368                 CTR1(KTR_MLD, "%s: doing mld downcall", __func__);
2369                 error = mld_change_state(inm, 0);
2370                 IN6_MULTI_LIST_UNLOCK();
2371                 if (error) {
2372                         CTR1(KTR_MLD, "%s: failed mld downcall",
2373                              __func__);
2374                         im6f_rollback(imf);
2375                         im6f_reap(imf);
2376                         goto out_in6p_locked;
2377                 }
2378         }
2379
2380         im6f_commit(imf);
2381         im6f_reap(imf);
2382
2383 out_in6p_locked:
2384         INP_WUNLOCK(inp);
2385
2386         if (is_final && imf)
2387                 ip6_mfilter_free(imf);
2388
2389         IN6_MULTI_UNLOCK();
2390         return (error);
2391 }
2392
2393 /*
2394  * Select the interface for transmitting IPv6 multicast datagrams.
2395  *
2396  * Either an instance of struct in6_addr or an instance of struct ipv6_mreqn
2397  * may be passed to this socket option. An address of in6addr_any or an
2398  * interface index of 0 is used to remove a previous selection.
2399  * When no interface is selected, one is chosen for every send.
2400  */
2401 static int
2402 in6p_set_multicast_if(struct inpcb *inp, struct sockopt *sopt)
2403 {
2404         struct ifnet            *ifp;
2405         struct ip6_moptions     *imo;
2406         u_int                    ifindex;
2407         int                      error;
2408
2409         if (sopt->sopt_valsize != sizeof(u_int))
2410                 return (EINVAL);
2411
2412         error = sooptcopyin(sopt, &ifindex, sizeof(u_int), sizeof(u_int));
2413         if (error)
2414                 return (error);
2415         if (V_if_index < ifindex)
2416                 return (EINVAL);
2417         if (ifindex == 0)
2418                 ifp = NULL;
2419         else {
2420                 ifp = ifnet_byindex(ifindex);
2421                 if (ifp == NULL)
2422                         return (EINVAL);
2423                 if ((ifp->if_flags & IFF_MULTICAST) == 0)
2424                         return (EADDRNOTAVAIL);
2425         }
2426         imo = in6p_findmoptions(inp);
2427         imo->im6o_multicast_ifp = ifp;
2428         INP_WUNLOCK(inp);
2429
2430         return (0);
2431 }
2432
2433 /*
2434  * Atomically set source filters on a socket for an IPv6 multicast group.
2435  *
2436  * SMPng: NOTE: Potentially calls malloc(M_WAITOK) with Giant held.
2437  */
2438 static int
2439 in6p_set_source_filters(struct inpcb *inp, struct sockopt *sopt)
2440 {
2441         struct __msfilterreq     msfr;
2442         sockunion_t             *gsa;
2443         struct ifnet            *ifp;
2444         struct in6_mfilter      *imf;
2445         struct ip6_moptions     *imo;
2446         struct in6_multi                *inm;
2447         int                      error;
2448
2449         error = sooptcopyin(sopt, &msfr, sizeof(struct __msfilterreq),
2450             sizeof(struct __msfilterreq));
2451         if (error)
2452                 return (error);
2453
2454         if (msfr.msfr_nsrcs > in6_mcast_maxsocksrc)
2455                 return (ENOBUFS);
2456
2457         if (msfr.msfr_fmode != MCAST_EXCLUDE &&
2458             msfr.msfr_fmode != MCAST_INCLUDE)
2459                 return (EINVAL);
2460
2461         if (msfr.msfr_group.ss_family != AF_INET6 ||
2462             msfr.msfr_group.ss_len != sizeof(struct sockaddr_in6))
2463                 return (EINVAL);
2464
2465         gsa = (sockunion_t *)&msfr.msfr_group;
2466         if (!IN6_IS_ADDR_MULTICAST(&gsa->sin6.sin6_addr))
2467                 return (EINVAL);
2468
2469         gsa->sin6.sin6_port = 0;        /* ignore port */
2470
2471         if (msfr.msfr_ifindex == 0 || V_if_index < msfr.msfr_ifindex)
2472                 return (EADDRNOTAVAIL);
2473         ifp = ifnet_byindex(msfr.msfr_ifindex);
2474         if (ifp == NULL)
2475                 return (EADDRNOTAVAIL);
2476         (void)in6_setscope(&gsa->sin6.sin6_addr, ifp, NULL);
2477
2478         /*
2479          * Take the INP write lock.
2480          * Check if this socket is a member of this group.
2481          */
2482         imo = in6p_findmoptions(inp);
2483         imf = im6o_match_group(imo, ifp, &gsa->sa);
2484         if (imf == NULL) {
2485                 error = EADDRNOTAVAIL;
2486                 goto out_in6p_locked;
2487         }
2488         inm = imf->im6f_in6m;
2489
2490         /*
2491          * Begin state merge transaction at socket layer.
2492          */
2493         INP_WLOCK_ASSERT(inp);
2494
2495         imf->im6f_st[1] = msfr.msfr_fmode;
2496
2497         /*
2498          * Apply any new source filters, if present.
2499          * Make a copy of the user-space source vector so
2500          * that we may copy them with a single copyin. This
2501          * allows us to deal with page faults up-front.
2502          */
2503         if (msfr.msfr_nsrcs > 0) {
2504                 struct in6_msource      *lims;
2505                 struct sockaddr_in6     *psin;
2506                 struct sockaddr_storage *kss, *pkss;
2507                 int                      i;
2508
2509                 INP_WUNLOCK(inp);
2510
2511                 CTR2(KTR_MLD, "%s: loading %lu source list entries",
2512                     __func__, (unsigned long)msfr.msfr_nsrcs);
2513                 kss = malloc(sizeof(struct sockaddr_storage) * msfr.msfr_nsrcs,
2514                     M_TEMP, M_WAITOK);
2515                 error = copyin(msfr.msfr_srcs, kss,
2516                     sizeof(struct sockaddr_storage) * msfr.msfr_nsrcs);
2517                 if (error) {
2518                         free(kss, M_TEMP);
2519                         return (error);
2520                 }
2521
2522                 INP_WLOCK(inp);
2523
2524                 /*
2525                  * Mark all source filters as UNDEFINED at t1.
2526                  * Restore new group filter mode, as im6f_leave()
2527                  * will set it to INCLUDE.
2528                  */
2529                 im6f_leave(imf);
2530                 imf->im6f_st[1] = msfr.msfr_fmode;
2531
2532                 /*
2533                  * Update socket layer filters at t1, lazy-allocating
2534                  * new entries. This saves a bunch of memory at the
2535                  * cost of one RB_FIND() per source entry; duplicate
2536                  * entries in the msfr_nsrcs vector are ignored.
2537                  * If we encounter an error, rollback transaction.
2538                  *
2539                  * XXX This too could be replaced with a set-symmetric
2540                  * difference like loop to avoid walking from root
2541                  * every time, as the key space is common.
2542                  */
2543                 for (i = 0, pkss = kss; i < msfr.msfr_nsrcs; i++, pkss++) {
2544                         psin = (struct sockaddr_in6 *)pkss;
2545                         if (psin->sin6_family != AF_INET6) {
2546                                 error = EAFNOSUPPORT;
2547                                 break;
2548                         }
2549                         if (psin->sin6_len != sizeof(struct sockaddr_in6)) {
2550                                 error = EINVAL;
2551                                 break;
2552                         }
2553                         if (IN6_IS_ADDR_MULTICAST(&psin->sin6_addr)) {
2554                                 error = EINVAL;
2555                                 break;
2556                         }
2557                         /*
2558                          * TODO: Validate embedded scope ID in source
2559                          * list entry against passed-in ifp, if and only
2560                          * if source list filter entry is iface or node local.
2561                          */
2562                         in6_clearscope(&psin->sin6_addr);
2563                         error = im6f_get_source(imf, psin, &lims);
2564                         if (error)
2565                                 break;
2566                         lims->im6sl_st[1] = imf->im6f_st[1];
2567                 }
2568                 free(kss, M_TEMP);
2569         }
2570
2571         if (error)
2572                 goto out_im6f_rollback;
2573
2574         INP_WLOCK_ASSERT(inp);
2575         IN6_MULTI_LIST_LOCK();
2576
2577         /*
2578          * Begin state merge transaction at MLD layer.
2579          */
2580         CTR1(KTR_MLD, "%s: merge inm state", __func__);
2581         error = in6m_merge(inm, imf);
2582         if (error)
2583                 CTR1(KTR_MLD, "%s: failed to merge inm state", __func__);
2584         else {
2585                 CTR1(KTR_MLD, "%s: doing mld downcall", __func__);
2586                 error = mld_change_state(inm, 0);
2587                 if (error)
2588                         CTR1(KTR_MLD, "%s: failed mld downcall", __func__);
2589         }
2590
2591         IN6_MULTI_LIST_UNLOCK();
2592
2593 out_im6f_rollback:
2594         if (error)
2595                 im6f_rollback(imf);
2596         else
2597                 im6f_commit(imf);
2598
2599         im6f_reap(imf);
2600
2601 out_in6p_locked:
2602         INP_WUNLOCK(inp);
2603         return (error);
2604 }
2605
2606 /*
2607  * Set the IP multicast options in response to user setsockopt().
2608  *
2609  * Many of the socket options handled in this function duplicate the
2610  * functionality of socket options in the regular unicast API. However,
2611  * it is not possible to merge the duplicate code, because the idempotence
2612  * of the IPv6 multicast part of the BSD Sockets API must be preserved;
2613  * the effects of these options must be treated as separate and distinct.
2614  *
2615  * SMPng: XXX: Unlocked read of inp_socket believed OK.
2616  */
2617 int
2618 ip6_setmoptions(struct inpcb *inp, struct sockopt *sopt)
2619 {
2620         struct ip6_moptions     *im6o;
2621         int                      error;
2622
2623         error = 0;
2624
2625         /*
2626          * If socket is neither of type SOCK_RAW or SOCK_DGRAM,
2627          * or is a divert socket, reject it.
2628          */
2629         if (inp->inp_socket->so_proto->pr_protocol == IPPROTO_DIVERT ||
2630             (inp->inp_socket->so_proto->pr_type != SOCK_RAW &&
2631              inp->inp_socket->so_proto->pr_type != SOCK_DGRAM))
2632                 return (EOPNOTSUPP);
2633
2634         switch (sopt->sopt_name) {
2635         case IPV6_MULTICAST_IF:
2636                 error = in6p_set_multicast_if(inp, sopt);
2637                 break;
2638
2639         case IPV6_MULTICAST_HOPS: {
2640                 int hlim;
2641
2642                 if (sopt->sopt_valsize != sizeof(int)) {
2643                         error = EINVAL;
2644                         break;
2645                 }
2646                 error = sooptcopyin(sopt, &hlim, sizeof(hlim), sizeof(int));
2647                 if (error)
2648                         break;
2649                 if (hlim < -1 || hlim > 255) {
2650                         error = EINVAL;
2651                         break;
2652                 } else if (hlim == -1) {
2653                         hlim = V_ip6_defmcasthlim;
2654                 }
2655                 im6o = in6p_findmoptions(inp);
2656                 im6o->im6o_multicast_hlim = hlim;
2657                 INP_WUNLOCK(inp);
2658                 break;
2659         }
2660
2661         case IPV6_MULTICAST_LOOP: {
2662                 u_int loop;
2663
2664                 /*
2665                  * Set the loopback flag for outgoing multicast packets.
2666                  * Must be zero or one.
2667                  */
2668                 if (sopt->sopt_valsize != sizeof(u_int)) {
2669                         error = EINVAL;
2670                         break;
2671                 }
2672                 error = sooptcopyin(sopt, &loop, sizeof(u_int), sizeof(u_int));
2673                 if (error)
2674                         break;
2675                 if (loop > 1) {
2676                         error = EINVAL;
2677                         break;
2678                 }
2679                 im6o = in6p_findmoptions(inp);
2680                 im6o->im6o_multicast_loop = loop;
2681                 INP_WUNLOCK(inp);
2682                 break;
2683         }
2684
2685         case IPV6_JOIN_GROUP:
2686         case MCAST_JOIN_GROUP:
2687         case MCAST_JOIN_SOURCE_GROUP:
2688                 error = in6p_join_group(inp, sopt);
2689                 break;
2690
2691         case IPV6_LEAVE_GROUP:
2692         case MCAST_LEAVE_GROUP:
2693         case MCAST_LEAVE_SOURCE_GROUP:
2694                 error = in6p_leave_group(inp, sopt);
2695                 break;
2696
2697         case MCAST_BLOCK_SOURCE:
2698         case MCAST_UNBLOCK_SOURCE:
2699                 error = in6p_block_unblock_source(inp, sopt);
2700                 break;
2701
2702         case IPV6_MSFILTER:
2703                 error = in6p_set_source_filters(inp, sopt);
2704                 break;
2705
2706         default:
2707                 error = EOPNOTSUPP;
2708                 break;
2709         }
2710
2711         INP_UNLOCK_ASSERT(inp);
2712
2713         return (error);
2714 }
2715
2716 /*
2717  * Expose MLD's multicast filter mode and source list(s) to userland,
2718  * keyed by (ifindex, group).
2719  * The filter mode is written out as a uint32_t, followed by
2720  * 0..n of struct in6_addr.
2721  * For use by ifmcstat(8).
2722  * SMPng: NOTE: unlocked read of ifindex space.
2723  */
2724 static int
2725 sysctl_ip6_mcast_filters(SYSCTL_HANDLER_ARGS)
2726 {
2727         struct in6_addr                  mcaddr;
2728         struct in6_addr                  src;
2729         struct epoch_tracker             et;
2730         struct ifnet                    *ifp;
2731         struct ifmultiaddr              *ifma;
2732         struct in6_multi                *inm;
2733         struct ip6_msource              *ims;
2734         int                             *name;
2735         int                              retval;
2736         u_int                            namelen;
2737         uint32_t                         fmode, ifindex;
2738 #ifdef KTR
2739         char                             ip6tbuf[INET6_ADDRSTRLEN];
2740 #endif
2741
2742         name = (int *)arg1;
2743         namelen = arg2;
2744
2745         if (req->newptr != NULL)
2746                 return (EPERM);
2747
2748         /* int: ifindex + 4 * 32 bits of IPv6 address */
2749         if (namelen != 5)
2750                 return (EINVAL);
2751
2752         ifindex = name[0];
2753         if (ifindex <= 0 || ifindex > V_if_index) {
2754                 CTR2(KTR_MLD, "%s: ifindex %u out of range",
2755                     __func__, ifindex);
2756                 return (ENOENT);
2757         }
2758
2759         memcpy(&mcaddr, &name[1], sizeof(struct in6_addr));
2760         if (!IN6_IS_ADDR_MULTICAST(&mcaddr)) {
2761                 CTR2(KTR_MLD, "%s: group %s is not multicast",
2762                     __func__, ip6_sprintf(ip6tbuf, &mcaddr));
2763                 return (EINVAL);
2764         }
2765
2766         NET_EPOCH_ENTER(et);
2767         ifp = ifnet_byindex(ifindex);
2768         if (ifp == NULL) {
2769                 NET_EPOCH_EXIT(et);
2770                 CTR2(KTR_MLD, "%s: no ifp for ifindex %u",
2771                     __func__, ifindex);
2772                 return (ENOENT);
2773         }
2774         /*
2775          * Internal MLD lookups require that scope/zone ID is set.
2776          */
2777         (void)in6_setscope(&mcaddr, ifp, NULL);
2778
2779         retval = sysctl_wire_old_buffer(req,
2780             sizeof(uint32_t) + (in6_mcast_maxgrpsrc * sizeof(struct in6_addr)));
2781         if (retval) {
2782                 NET_EPOCH_EXIT(et);
2783                 return (retval);
2784         }
2785
2786         IN6_MULTI_LOCK();
2787         IN6_MULTI_LIST_LOCK();
2788         CK_STAILQ_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link) {
2789                 inm = in6m_ifmultiaddr_get_inm(ifma);
2790                 if (inm == NULL)
2791                         continue;
2792                 if (!IN6_ARE_ADDR_EQUAL(&inm->in6m_addr, &mcaddr))
2793                         continue;
2794                 fmode = inm->in6m_st[1].iss_fmode;
2795                 retval = SYSCTL_OUT(req, &fmode, sizeof(uint32_t));
2796                 if (retval != 0)
2797                         break;
2798                 RB_FOREACH(ims, ip6_msource_tree, &inm->in6m_srcs) {
2799                         CTR2(KTR_MLD, "%s: visit node %p", __func__, ims);
2800                         /*
2801                          * Only copy-out sources which are in-mode.
2802                          */
2803                         if (fmode != im6s_get_mode(inm, ims, 1)) {
2804                                 CTR1(KTR_MLD, "%s: skip non-in-mode",
2805                                     __func__);
2806                                 continue;
2807                         }
2808                         src = ims->im6s_addr;
2809                         retval = SYSCTL_OUT(req, &src,
2810                             sizeof(struct in6_addr));
2811                         if (retval != 0)
2812                                 break;
2813                 }
2814         }
2815         IN6_MULTI_LIST_UNLOCK();
2816         IN6_MULTI_UNLOCK();
2817         NET_EPOCH_EXIT(et);
2818
2819         return (retval);
2820 }
2821
2822 #ifdef KTR
2823
2824 static const char *in6m_modestrs[] = { "un", "in", "ex" };
2825
2826 static const char *
2827 in6m_mode_str(const int mode)
2828 {
2829
2830         if (mode >= MCAST_UNDEFINED && mode <= MCAST_EXCLUDE)
2831                 return (in6m_modestrs[mode]);
2832         return ("??");
2833 }
2834
2835 static const char *in6m_statestrs[] = {
2836         "not-member",
2837         "silent",
2838         "idle",
2839         "lazy",
2840         "sleeping",
2841         "awakening",
2842         "query-pending",
2843         "sg-query-pending",
2844         "leaving"
2845 };
2846
2847 static const char *
2848 in6m_state_str(const int state)
2849 {
2850
2851         if (state >= MLD_NOT_MEMBER && state <= MLD_LEAVING_MEMBER)
2852                 return (in6m_statestrs[state]);
2853         return ("??");
2854 }
2855
2856 /*
2857  * Dump an in6_multi structure to the console.
2858  */
2859 void
2860 in6m_print(const struct in6_multi *inm)
2861 {
2862         int t;
2863         char ip6tbuf[INET6_ADDRSTRLEN];
2864
2865         if ((ktr_mask & KTR_MLD) == 0)
2866                 return;
2867
2868         printf("%s: --- begin in6m %p ---\n", __func__, inm);
2869         printf("addr %s ifp %p(%s) ifma %p\n",
2870             ip6_sprintf(ip6tbuf, &inm->in6m_addr),
2871             inm->in6m_ifp,
2872             if_name(inm->in6m_ifp),
2873             inm->in6m_ifma);
2874         printf("timer %u state %s refcount %u scq.len %u\n",
2875             inm->in6m_timer,
2876             in6m_state_str(inm->in6m_state),
2877             inm->in6m_refcount,
2878             mbufq_len(&inm->in6m_scq));
2879         printf("mli %p nsrc %lu sctimer %u scrv %u\n",
2880             inm->in6m_mli,
2881             inm->in6m_nsrc,
2882             inm->in6m_sctimer,
2883             inm->in6m_scrv);
2884         for (t = 0; t < 2; t++) {
2885                 printf("t%d: fmode %s asm %u ex %u in %u rec %u\n", t,
2886                     in6m_mode_str(inm->in6m_st[t].iss_fmode),
2887                     inm->in6m_st[t].iss_asm,
2888                     inm->in6m_st[t].iss_ex,
2889                     inm->in6m_st[t].iss_in,
2890                     inm->in6m_st[t].iss_rec);
2891         }
2892         printf("%s: --- end in6m %p ---\n", __func__, inm);
2893 }
2894
2895 #else /* !KTR */
2896
2897 void
2898 in6m_print(const struct in6_multi *inm)
2899 {
2900
2901 }
2902
2903 #endif /* KTR */