sys/netinet6/mld6.c

   1 /*-
   2  * Copyright (c) 2009 Bruce Simpson.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  * 3. The name of the author may not be used to endorse or promote
  13  *    products derived from this software without specific prior written
  14  *    permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  *
  28  *      $KAME: mld6.c,v 1.27 2001/04/04 05:17:30 itojun Exp $
  29  */
  30
  31 /*-
  32  * Copyright (c) 1988 Stephen Deering.
  33  * Copyright (c) 1992, 1993
  34  *      The Regents of the University of California.  All rights reserved.
  35  *
  36  * This code is derived from software contributed to Berkeley by
  37  * Stephen Deering of Stanford University.
  38  *
  39  * Redistribution and use in source and binary forms, with or without
  40  * modification, are permitted provided that the following conditions
  41  * are met:
  42  * 1. Redistributions of source code must retain the above copyright
  43  *    notice, this list of conditions and the following disclaimer.
  44  * 2. Redistributions in binary form must reproduce the above copyright
  45  *    notice, this list of conditions and the following disclaimer in the
  46  *    documentation and/or other materials provided with the distribution.
  47  * 4. Neither the name of the University nor the names of its contributors
  48  *    may be used to endorse or promote products derived from this software
  49  *    without specific prior written permission.
  50  *
  51  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  52  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  53  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  54  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  55  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  56  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  57  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  58  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  59  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  60  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  61  * SUCH DAMAGE.
  62  *
  63  *      @(#)igmp.c      8.1 (Berkeley) 7/19/93
  64  */
  65
  66 #include <sys/cdefs.h>
  67 __FBSDID("$FreeBSD$");
  68
  69 #include "opt_inet.h"
  70 #include "opt_inet6.h"
  71
  72 #include <sys/param.h>
  73 #include <sys/systm.h>
  74 #include <sys/mbuf.h>
  75 #include <sys/socket.h>
  76 #include <sys/protosw.h>
  77 #include <sys/sysctl.h>
  78 #include <sys/kernel.h>
  79 #include <sys/callout.h>
  80 #include <sys/malloc.h>
  81 #include <sys/module.h>
  82 #include <sys/ktr.h>
  83
  84 #include <net/if.h>
  85 #include <net/if_var.h>
  86 #include <net/route.h>
  87 #include <net/vnet.h>
  88
  89 #include <netinet/in.h>
  90 #include <netinet/in_var.h>
  91 #include <netinet6/in6_var.h>
  92 #include <netinet/ip6.h>
  93 #include <netinet6/ip6_var.h>
  94 #include <netinet6/scope6_var.h>
  95 #include <netinet/icmp6.h>
  96 #include <netinet6/mld6.h>
  97 #include <netinet6/mld6_var.h>
  98
  99 #include <security/mac/mac_framework.h>
 100
 101 #ifndef KTR_MLD
 102 #define KTR_MLD KTR_INET6
 103 #endif
 104
 105 static struct mld_ifsoftc *
 106                 mli_alloc_locked(struct ifnet *);
 107 static void     mli_delete_locked(const struct ifnet *);
 108 static void     mld_dispatch_packet(struct mbuf *);
 109 static void     mld_dispatch_queue(struct mbufq *, int);
 110 static void     mld_final_leave(struct in6_multi *, struct mld_ifsoftc *);
 111 static void     mld_fasttimo_vnet(void);
 112 static int      mld_handle_state_change(struct in6_multi *,
 113                     struct mld_ifsoftc *);
 114 static int      mld_initial_join(struct in6_multi *, struct mld_ifsoftc *,
 115                     const int);
 116 #ifdef KTR
 117 static char *   mld_rec_type_to_str(const int);
 118 #endif
 119 static void     mld_set_version(struct mld_ifsoftc *, const int);
 120 static void     mld_slowtimo_vnet(void);
 121 static int      mld_v1_input_query(struct ifnet *, const struct ip6_hdr *,
 122                     /*const*/ struct mld_hdr *);
 123 static int      mld_v1_input_report(struct ifnet *, const struct ip6_hdr *,
 124                     /*const*/ struct mld_hdr *);
 125 static void     mld_v1_process_group_timer(struct mld_ifsoftc *,
 126                     struct in6_multi *);
 127 static void     mld_v1_process_querier_timers(struct mld_ifsoftc *);
 128 static int      mld_v1_transmit_report(struct in6_multi *, const int);
 129 static void     mld_v1_update_group(struct in6_multi *, const int);
 130 static void     mld_v2_cancel_link_timers(struct mld_ifsoftc *);
 131 static void     mld_v2_dispatch_general_query(struct mld_ifsoftc *);
 132 static struct mbuf *
 133                 mld_v2_encap_report(struct ifnet *, struct mbuf *);
 134 static int      mld_v2_enqueue_filter_change(struct mbufq *,
 135                     struct in6_multi *);
 136 static int      mld_v2_enqueue_group_record(struct mbufq *,
 137                     struct in6_multi *, const int, const int, const int,
 138                     const int);
 139 static int      mld_v2_input_query(struct ifnet *, const struct ip6_hdr *,
 140                     struct mbuf *, struct mldv2_query *, const int, const int);
 141 static int      mld_v2_merge_state_changes(struct in6_multi *,
 142                     struct mbufq *);
 143 static void     mld_v2_process_group_timers(struct mld_ifsoftc *,
 144                     struct mbufq *, struct mbufq *,
 145                     struct in6_multi *, const int);
 146 static int      mld_v2_process_group_query(struct in6_multi *,
 147                     struct mld_ifsoftc *mli, int, struct mbuf *,
 148                     struct mldv2_query *, const int);
 149 static int      sysctl_mld_gsr(SYSCTL_HANDLER_ARGS);
 150 static int      sysctl_mld_ifinfo(SYSCTL_HANDLER_ARGS);
 151
 152 /*
 153  * Normative references: RFC 2710, RFC 3590, RFC 3810.
 154  *
 155  * Locking:
 156  *  * The MLD subsystem lock ends up being system-wide for the moment,
 157  *    but could be per-VIMAGE later on.
 158  *  * The permitted lock order is: IN6_MULTI_LOCK, MLD_LOCK, IF_ADDR_LOCK.
 159  *    Any may be taken independently; if any are held at the same
 160  *    time, the above lock order must be followed.
 161  *  * IN6_MULTI_LOCK covers in_multi.
 162  *  * MLD_LOCK covers per-link state and any global variables in this file.
 163  *  * IF_ADDR_LOCK covers if_multiaddrs, which is used for a variety of
 164  *    per-link state iterators.
 165  *
 166  *  XXX LOR PREVENTION
 167  *  A special case for IPv6 is the in6_setscope() routine. ip6_output()
 168  *  will not accept an ifp; it wants an embedded scope ID, unlike
 169  *  ip_output(), which happily takes the ifp given to it. The embedded
 170  *  scope ID is only used by MLD to select the outgoing interface.
 171  *
 172  *  During interface attach and detach, MLD will take MLD_LOCK *after*
 173  *  the IF_AFDATA_LOCK.
 174  *  As in6_setscope() takes IF_AFDATA_LOCK then SCOPE_LOCK, we can't call
 175  *  it with MLD_LOCK held without triggering an LOR. A netisr with indirect
 176  *  dispatch could work around this, but we'd rather not do that, as it
 177  *  can introduce other races.
 178  *
 179  *  As such, we exploit the fact that the scope ID is just the interface
 180  *  index, and embed it in the IPv6 destination address accordingly.
 181  *  This is potentially NOT VALID for MLDv1 reports, as they
 182  *  are always sent to the multicast group itself; as MLDv2
 183  *  reports are always sent to ff02::16, this is not an issue
 184  *  when MLDv2 is in use.
 185  *
 186  *  This does not however eliminate the LOR when ip6_output() itself
 187  *  calls in6_setscope() internally whilst MLD_LOCK is held. This will
 188  *  trigger a LOR warning in WITNESS when the ifnet is detached.
 189  *
 190  *  The right answer is probably to make IF_AFDATA_LOCK an rwlock, given
 191  *  how it's used across the network stack. Here we're simply exploiting
 192  *  the fact that MLD runs at a similar layer in the stack to scope6.c.
 193  *
 194  * VIMAGE:
 195  *  * Each in6_multi corresponds to an ifp, and each ifp corresponds
 196  *    to a vnet in ifp->if_vnet.
 197  */
 198 static struct mtx                mld_mtx;
 199 static MALLOC_DEFINE(M_MLD, "mld", "mld state");
 200
 201 #define MLD_EMBEDSCOPE(pin6, zoneid)                                    \
 202         if (IN6_IS_SCOPE_LINKLOCAL(pin6) ||                             \
 203             IN6_IS_ADDR_MC_INTFACELOCAL(pin6))                          \
 204                 (pin6)->s6_addr16[1] = htons((zoneid) & 0xFFFF)         \
 205
 206 /*
 207  * VIMAGE-wide globals.
 208  */
 209 static VNET_DEFINE(struct timeval, mld_gsrdelay) = {10, 0};
 210 static VNET_DEFINE(LIST_HEAD(, mld_ifsoftc), mli_head);
 211 static VNET_DEFINE(int, interface_timers_running6);
 212 static VNET_DEFINE(int, state_change_timers_running6);
 213 static VNET_DEFINE(int, current_state_timers_running6);
 214
 215 #define V_mld_gsrdelay                  VNET(mld_gsrdelay)
 216 #define V_mli_head                      VNET(mli_head)
 217 #define V_interface_timers_running6     VNET(interface_timers_running6)
 218 #define V_state_change_timers_running6  VNET(state_change_timers_running6)
 219 #define V_current_state_timers_running6 VNET(current_state_timers_running6)
 220
 221 SYSCTL_DECL(_net_inet6);        /* Note: Not in any common header. */
 222
 223 SYSCTL_NODE(_net_inet6, OID_AUTO, mld, CTLFLAG_RW, 0,
 224     "IPv6 Multicast Listener Discovery");
 225
 226 /*
 227  * Virtualized sysctls.
 228  */
 229 SYSCTL_PROC(_net_inet6_mld, OID_AUTO, gsrdelay,
 230     CTLFLAG_VNET | CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_MPSAFE,
 231     &VNET_NAME(mld_gsrdelay.tv_sec), 0, sysctl_mld_gsr, "I",
 232     "Rate limit for MLDv2 Group-and-Source queries in seconds");
 233
 234 /*
 235  * Non-virtualized sysctls.
 236  */
 237 static SYSCTL_NODE(_net_inet6_mld, OID_AUTO, ifinfo,
 238     CTLFLAG_RD | CTLFLAG_MPSAFE, sysctl_mld_ifinfo,
 239     "Per-interface MLDv2 state");
 240
 241 static int      mld_v1enable = 1;
 242 SYSCTL_INT(_net_inet6_mld, OID_AUTO, v1enable, CTLFLAG_RWTUN,
 243     &mld_v1enable, 0, "Enable fallback to MLDv1");
 244
 245 static int      mld_use_allow = 1;
 246 SYSCTL_INT(_net_inet6_mld, OID_AUTO, use_allow, CTLFLAG_RWTUN,
 247     &mld_use_allow, 0, "Use ALLOW/BLOCK for RFC 4604 SSM joins/leaves");
 248
 249 /*
 250  * Packed Router Alert option structure declaration.
 251  */
 252 struct mld_raopt {
 253         struct ip6_hbh          hbh;
 254         struct ip6_opt          pad;
 255         struct ip6_opt_router   ra;
 256 } __packed;
 257
 258 /*
 259  * Router Alert hop-by-hop option header.
 260  */
 261 static struct mld_raopt mld_ra = {
 262         .hbh = { 0, 0 },
 263         .pad = { .ip6o_type = IP6OPT_PADN, 0 },
 264         .ra = {
 265             .ip6or_type = IP6OPT_ROUTER_ALERT,
 266             .ip6or_len = IP6OPT_RTALERT_LEN - 2,
 267             .ip6or_value[0] = ((IP6OPT_RTALERT_MLD >> 8) & 0xFF),
 268             .ip6or_value[1] = (IP6OPT_RTALERT_MLD & 0xFF)
 269         }
 270 };
 271 static struct ip6_pktopts mld_po;
 272
 273 static __inline void
 274 mld_save_context(struct mbuf *m, struct ifnet *ifp)
 275 {
 276
 277 #ifdef VIMAGE
 278         m->m_pkthdr.PH_loc.ptr = ifp->if_vnet;
 279 #endif /* VIMAGE */
 280         m->m_pkthdr.flowid = ifp->if_index;
 281 }
 282
 283 static __inline void
 284 mld_scrub_context(struct mbuf *m)
 285 {
 286
 287         m->m_pkthdr.PH_loc.ptr = NULL;
 288         m->m_pkthdr.flowid = 0;
 289 }
 290
 291 /*
 292  * Restore context from a queued output chain.
 293  * Return saved ifindex.
 294  *
 295  * VIMAGE: The assertion is there to make sure that we
 296  * actually called CURVNET_SET() with what's in the mbuf chain.
 297  */
 298 static __inline uint32_t
 299 mld_restore_context(struct mbuf *m)
 300 {
 301
 302 #if defined(VIMAGE) && defined(INVARIANTS)
 303         KASSERT(curvnet == m->m_pkthdr.PH_loc.ptr,
 304             ("%s: called when curvnet was not restored: cuvnet %p m ptr %p",
 305             __func__, curvnet, m->m_pkthdr.PH_loc.ptr));
 306 #endif
 307         return (m->m_pkthdr.flowid);
 308 }
 309
 310 /*
 311  * Retrieve or set threshold between group-source queries in seconds.
 312  *
 313  * VIMAGE: Assume curvnet set by caller.
 314  * SMPng: NOTE: Serialized by MLD lock.
 315  */
 316 static int
 317 sysctl_mld_gsr(SYSCTL_HANDLER_ARGS)
 318 {
 319         int error;
 320         int i;
 321
 322         error = sysctl_wire_old_buffer(req, sizeof(int));
 323         if (error)
 324                 return (error);
 325
 326         MLD_LOCK();
 327
 328         i = V_mld_gsrdelay.tv_sec;
 329
 330         error = sysctl_handle_int(oidp, &i, 0, req);
 331         if (error || !req->newptr)
 332                 goto out_locked;
 333
 334         if (i < -1 || i >= 60) {
 335                 error = EINVAL;
 336                 goto out_locked;
 337         }
 338
 339         CTR2(KTR_MLD, "change mld_gsrdelay from %d to %d",
 340              V_mld_gsrdelay.tv_sec, i);
 341         V_mld_gsrdelay.tv_sec = i;
 342
 343 out_locked:
 344         MLD_UNLOCK();
 345         return (error);
 346 }
 347
 348 /*
 349  * Expose struct mld_ifsoftc to userland, keyed by ifindex.
 350  * For use by ifmcstat(8).
 351  *
 352  * SMPng: NOTE: Does an unlocked ifindex space read.
 353  * VIMAGE: Assume curvnet set by caller. The node handler itself
 354  * is not directly virtualized.
 355  */
 356 static int
 357 sysctl_mld_ifinfo(SYSCTL_HANDLER_ARGS)
 358 {
 359         int                     *name;
 360         int                      error;
 361         u_int                    namelen;
 362         struct ifnet            *ifp;
 363         struct mld_ifsoftc      *mli;
 364
 365         name = (int *)arg1;
 366         namelen = arg2;
 367
 368         if (req->newptr != NULL)
 369                 return (EPERM);
 370
 371         if (namelen != 1)
 372                 return (EINVAL);
 373
 374         error = sysctl_wire_old_buffer(req, sizeof(struct mld_ifinfo));
 375         if (error)
 376                 return (error);
 377
 378         IN6_MULTI_LOCK();
 379         MLD_LOCK();
 380
 381         if (name[0] <= 0 || name[0] > V_if_index) {
 382                 error = ENOENT;
 383                 goto out_locked;
 384         }
 385
 386         error = ENOENT;
 387
 388         ifp = ifnet_byindex(name[0]);
 389         if (ifp == NULL)
 390                 goto out_locked;
 391
 392         LIST_FOREACH(mli, &V_mli_head, mli_link) {
 393                 if (ifp == mli->mli_ifp) {
 394                         struct mld_ifinfo info;
 395
 396                         info.mli_version = mli->mli_version;
 397                         info.mli_v1_timer = mli->mli_v1_timer;
 398                         info.mli_v2_timer = mli->mli_v2_timer;
 399                         info.mli_flags = mli->mli_flags;
 400                         info.mli_rv = mli->mli_rv;
 401                         info.mli_qi = mli->mli_qi;
 402                         info.mli_qri = mli->mli_qri;
 403                         info.mli_uri = mli->mli_uri;
 404                         error = SYSCTL_OUT(req, &info, sizeof(info));
 405                         break;
 406                 }
 407         }
 408
 409 out_locked:
 410         MLD_UNLOCK();
 411         IN6_MULTI_UNLOCK();
 412         return (error);
 413 }
 414
 415 /*
 416  * Dispatch an entire queue of pending packet chains.
 417  * VIMAGE: Assumes the vnet pointer has been set.
 418  */
 419 static void
 420 mld_dispatch_queue(struct mbufq *mq, int limit)
 421 {
 422         struct mbuf *m;
 423
 424         while ((m = mbufq_dequeue(mq)) != NULL) {
 425                 CTR3(KTR_MLD, "%s: dispatch %p from %p", __func__, mq, m);
 426                 mld_dispatch_packet(m);
 427                 if (--limit == 0)
 428                         break;
 429         }
 430 }
 431
 432 /*
 433  * Filter outgoing MLD report state by group.
 434  *
 435  * Reports are ALWAYS suppressed for ALL-HOSTS (ff02::1)
 436  * and node-local addresses. However, kernel and socket consumers
 437  * always embed the KAME scope ID in the address provided, so strip it
 438  * when performing comparison.
 439  * Note: This is not the same as the *multicast* scope.
 440  *
 441  * Return zero if the given group is one for which MLD reports
 442  * should be suppressed, or non-zero if reports should be issued.
 443  */
 444 static __inline int
 445 mld_is_addr_reported(const struct in6_addr *addr)
 446 {
 447
 448         KASSERT(IN6_IS_ADDR_MULTICAST(addr), ("%s: not multicast", __func__));
 449
 450         if (IPV6_ADDR_MC_SCOPE(addr) == IPV6_ADDR_SCOPE_NODELOCAL)
 451                 return (0);
 452
 453         if (IPV6_ADDR_MC_SCOPE(addr) == IPV6_ADDR_SCOPE_LINKLOCAL) {
 454                 struct in6_addr tmp = *addr;
 455                 in6_clearscope(&tmp);
 456                 if (IN6_ARE_ADDR_EQUAL(&tmp, &in6addr_linklocal_allnodes))
 457                         return (0);
 458         }
 459
 460         return (1);
 461 }
 462
 463 /*
 464  * Attach MLD when PF_INET6 is attached to an interface.
 465  *
 466  * SMPng: Normally called with IF_AFDATA_LOCK held.
 467  */
 468 struct mld_ifsoftc *
 469 mld_domifattach(struct ifnet *ifp)
 470 {
 471         struct mld_ifsoftc *mli;
 472
 473         CTR3(KTR_MLD, "%s: called for ifp %p(%s)",
 474             __func__, ifp, if_name(ifp));
 475
 476         MLD_LOCK();
 477
 478         mli = mli_alloc_locked(ifp);
 479         if (!(ifp->if_flags & IFF_MULTICAST))
 480                 mli->mli_flags |= MLIF_SILENT;
 481         if (mld_use_allow)
 482                 mli->mli_flags |= MLIF_USEALLOW;
 483
 484         MLD_UNLOCK();
 485
 486         return (mli);
 487 }
 488
 489 /*
 490  * VIMAGE: assume curvnet set by caller.
 491  */
 492 static struct mld_ifsoftc *
 493 mli_alloc_locked(/*const*/ struct ifnet *ifp)
 494 {
 495         struct mld_ifsoftc *mli;
 496
 497         MLD_LOCK_ASSERT();
 498
 499         mli = malloc(sizeof(struct mld_ifsoftc), M_MLD, M_NOWAIT|M_ZERO);
 500         if (mli == NULL)
 501                 goto out;
 502
 503         mli->mli_ifp = ifp;
 504         mli->mli_version = MLD_VERSION_2;
 505         mli->mli_flags = 0;
 506         mli->mli_rv = MLD_RV_INIT;
 507         mli->mli_qi = MLD_QI_INIT;
 508         mli->mli_qri = MLD_QRI_INIT;
 509         mli->mli_uri = MLD_URI_INIT;
 510         SLIST_INIT(&mli->mli_relinmhead);
 511         mbufq_init(&mli->mli_gq, MLD_MAX_RESPONSE_PACKETS);
 512
 513         LIST_INSERT_HEAD(&V_mli_head, mli, mli_link);
 514
 515         CTR2(KTR_MLD, "allocate mld_ifsoftc for ifp %p(%s)",
 516              ifp, if_name(ifp));
 517
 518 out:
 519         return (mli);
 520 }
 521
 522 /*
 523  * Hook for ifdetach.
 524  *
 525  * NOTE: Some finalization tasks need to run before the protocol domain
 526  * is detached, but also before the link layer does its cleanup.
 527  * Run before link-layer cleanup; cleanup groups, but do not free MLD state.
 528  *
 529  * SMPng: Caller must hold IN6_MULTI_LOCK().
 530  * Must take IF_ADDR_LOCK() to cover if_multiaddrs iterator.
 531  * XXX This routine is also bitten by unlocked ifma_protospec access.
 532  */
 533 void
 534 mld_ifdetach(struct ifnet *ifp)
 535 {
 536         struct mld_ifsoftc      *mli;
 537         struct ifmultiaddr      *ifma;
 538         struct in6_multi        *inm, *tinm;
 539
 540         CTR3(KTR_MLD, "%s: called for ifp %p(%s)", __func__, ifp,
 541             if_name(ifp));
 542
 543         IN6_MULTI_LOCK_ASSERT();
 544         MLD_LOCK();
 545
 546         mli = MLD_IFINFO(ifp);
 547         if (mli->mli_version == MLD_VERSION_2) {
 548                 IF_ADDR_RLOCK(ifp);
 549                 TAILQ_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link) {
 550                         if (ifma->ifma_addr->sa_family != AF_INET6 ||
 551                             ifma->ifma_protospec == NULL)
 552                                 continue;
 553                         inm = (struct in6_multi *)ifma->ifma_protospec;
 554                         if (inm->in6m_state == MLD_LEAVING_MEMBER) {
 555                                 SLIST_INSERT_HEAD(&mli->mli_relinmhead,
 556                                     inm, in6m_nrele);
 557                         }
 558                         in6m_clear_recorded(inm);
 559                 }
 560                 IF_ADDR_RUNLOCK(ifp);
 561                 SLIST_FOREACH_SAFE(inm, &mli->mli_relinmhead, in6m_nrele,
 562                     tinm) {
 563                         SLIST_REMOVE_HEAD(&mli->mli_relinmhead, in6m_nrele);
 564                         in6m_release_locked(inm);
 565                 }
 566         }
 567
 568         MLD_UNLOCK();
 569 }
 570
 571 /*
 572  * Hook for domifdetach.
 573  * Runs after link-layer cleanup; free MLD state.
 574  *
 575  * SMPng: Normally called with IF_AFDATA_LOCK held.
 576  */
 577 void
 578 mld_domifdetach(struct ifnet *ifp)
 579 {
 580
 581         CTR3(KTR_MLD, "%s: called for ifp %p(%s)",
 582             __func__, ifp, if_name(ifp));
 583
 584         MLD_LOCK();
 585         mli_delete_locked(ifp);
 586         MLD_UNLOCK();
 587 }
 588
 589 static void
 590 mli_delete_locked(const struct ifnet *ifp)
 591 {
 592         struct mld_ifsoftc *mli, *tmli;
 593
 594         CTR3(KTR_MLD, "%s: freeing mld_ifsoftc for ifp %p(%s)",
 595             __func__, ifp, if_name(ifp));
 596
 597         MLD_LOCK_ASSERT();
 598
 599         LIST_FOREACH_SAFE(mli, &V_mli_head, mli_link, tmli) {
 600                 if (mli->mli_ifp == ifp) {
 601                         /*
 602                          * Free deferred General Query responses.
 603                          */
 604                         mbufq_drain(&mli->mli_gq);
 605
 606                         LIST_REMOVE(mli, mli_link);
 607
 608                         KASSERT(SLIST_EMPTY(&mli->mli_relinmhead),
 609                             ("%s: there are dangling in_multi references",
 610                             __func__));
 611
 612                         free(mli, M_MLD);
 613                         return;
 614                 }
 615         }
 616 }
 617
 618 /*
 619  * Process a received MLDv1 general or address-specific query.
 620  * Assumes that the query header has been pulled up to sizeof(mld_hdr).
 621  *
 622  * NOTE: Can't be fully const correct as we temporarily embed scope ID in
 623  * mld_addr. This is OK as we own the mbuf chain.
 624  */
 625 static int
 626 mld_v1_input_query(struct ifnet *ifp, const struct ip6_hdr *ip6,
 627     /*const*/ struct mld_hdr *mld)
 628 {
 629         struct ifmultiaddr      *ifma;
 630         struct mld_ifsoftc      *mli;
 631         struct in6_multi        *inm;
 632         int                      is_general_query;
 633         uint16_t                 timer;
 634 #ifdef KTR
 635         char                     ip6tbuf[INET6_ADDRSTRLEN];
 636 #endif
 637
 638         is_general_query = 0;
 639
 640         if (!mld_v1enable) {
 641                 CTR3(KTR_MLD, "ignore v1 query %s on ifp %p(%s)",
 642                     ip6_sprintf(ip6tbuf, &mld->mld_addr),
 643                     ifp, if_name(ifp));
 644                 return (0);
 645         }
 646
 647         /*
 648          * RFC3810 Section 6.2: MLD queries must originate from
 649          * a router's link-local address.
 650          */
 651         if (!IN6_IS_SCOPE_LINKLOCAL(&ip6->ip6_src)) {
 652                 CTR3(KTR_MLD, "ignore v1 query src %s on ifp %p(%s)",
 653                     ip6_sprintf(ip6tbuf, &ip6->ip6_src),
 654                     ifp, if_name(ifp));
 655                 return (0);
 656         }
 657
 658         /*
 659          * Do address field validation upfront before we accept
 660          * the query.
 661          */
 662         if (IN6_IS_ADDR_UNSPECIFIED(&mld->mld_addr)) {
 663                 /*
 664                  * MLDv1 General Query.
 665                  * If this was not sent to the all-nodes group, ignore it.
 666                  */
 667                 struct in6_addr          dst;
 668
 669                 dst = ip6->ip6_dst;
 670                 in6_clearscope(&dst);
 671                 if (!IN6_ARE_ADDR_EQUAL(&dst, &in6addr_linklocal_allnodes))
 672                         return (EINVAL);
 673                 is_general_query = 1;
 674         } else {
 675                 /*
 676                  * Embed scope ID of receiving interface in MLD query for
 677                  * lookup whilst we don't hold other locks.
 678                  */
 679                 in6_setscope(&mld->mld_addr, ifp, NULL);
 680         }
 681
 682         IN6_MULTI_LOCK();
 683         MLD_LOCK();
 684
 685         /*
 686          * Switch to MLDv1 host compatibility mode.
 687          */
 688         mli = MLD_IFINFO(ifp);
 689         KASSERT(mli != NULL, ("%s: no mld_ifsoftc for ifp %p", __func__, ifp));
 690         mld_set_version(mli, MLD_VERSION_1);
 691
 692         timer = (ntohs(mld->mld_maxdelay) * PR_FASTHZ) / MLD_TIMER_SCALE;
 693         if (timer == 0)
 694                 timer = 1;
 695
 696         IF_ADDR_RLOCK(ifp);
 697         if (is_general_query) {
 698                 /*
 699                  * For each reporting group joined on this
 700                  * interface, kick the report timer.
 701                  */
 702                 CTR2(KTR_MLD, "process v1 general query on ifp %p(%s)",
 703                     ifp, if_name(ifp));
 704                 TAILQ_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link) {
 705                         if (ifma->ifma_addr->sa_family != AF_INET6 ||
 706                             ifma->ifma_protospec == NULL)
 707                                 continue;
 708                         inm = (struct in6_multi *)ifma->ifma_protospec;
 709                         mld_v1_update_group(inm, timer);
 710                 }
 711         } else {
 712                 /*
 713                  * MLDv1 Group-Specific Query.
 714                  * If this is a group-specific MLDv1 query, we need only
 715                  * look up the single group to process it.
 716                  */
 717                 inm = in6m_lookup_locked(ifp, &mld->mld_addr);
 718                 if (inm != NULL) {
 719                         CTR3(KTR_MLD, "process v1 query %s on ifp %p(%s)",
 720                             ip6_sprintf(ip6tbuf, &mld->mld_addr),
 721                             ifp, if_name(ifp));
 722                         mld_v1_update_group(inm, timer);
 723                 }
 724                 /* XXX Clear embedded scope ID as userland won't expect it. */
 725                 in6_clearscope(&mld->mld_addr);
 726         }
 727
 728         IF_ADDR_RUNLOCK(ifp);
 729         MLD_UNLOCK();
 730         IN6_MULTI_UNLOCK();
 731
 732         return (0);
 733 }
 734
 735 /*
 736  * Update the report timer on a group in response to an MLDv1 query.
 737  *
 738  * If we are becoming the reporting member for this group, start the timer.
 739  * If we already are the reporting member for this group, and timer is
 740  * below the threshold, reset it.
 741  *
 742  * We may be updating the group for the first time since we switched
 743  * to MLDv2. If we are, then we must clear any recorded source lists,
 744  * and transition to REPORTING state; the group timer is overloaded
 745  * for group and group-source query responses.
 746  *
 747  * Unlike MLDv2, the delay per group should be jittered
 748  * to avoid bursts of MLDv1 reports.
 749  */
 750 static void
 751 mld_v1_update_group(struct in6_multi *inm, const int timer)
 752 {
 753 #ifdef KTR
 754         char                     ip6tbuf[INET6_ADDRSTRLEN];
 755 #endif
 756
 757         CTR4(KTR_MLD, "%s: %s/%s timer=%d", __func__,
 758             ip6_sprintf(ip6tbuf, &inm->in6m_addr),
 759             if_name(inm->in6m_ifp), timer);
 760
 761         IN6_MULTI_LOCK_ASSERT();
 762
 763         switch (inm->in6m_state) {
 764         case MLD_NOT_MEMBER:
 765         case MLD_SILENT_MEMBER:
 766                 break;
 767         case MLD_REPORTING_MEMBER:
 768                 if (inm->in6m_timer != 0 &&
 769                     inm->in6m_timer <= timer) {
 770                         CTR1(KTR_MLD, "%s: REPORTING and timer running, "
 771                             "skipping.", __func__);
 772                         break;
 773                 }
 774                 /* FALLTHROUGH */
 775         case MLD_SG_QUERY_PENDING_MEMBER:
 776         case MLD_G_QUERY_PENDING_MEMBER:
 777         case MLD_IDLE_MEMBER:
 778         case MLD_LAZY_MEMBER:
 779         case MLD_AWAKENING_MEMBER:
 780                 CTR1(KTR_MLD, "%s: ->REPORTING", __func__);
 781                 inm->in6m_state = MLD_REPORTING_MEMBER;
 782                 inm->in6m_timer = MLD_RANDOM_DELAY(timer);
 783                 V_current_state_timers_running6 = 1;
 784                 break;
 785         case MLD_SLEEPING_MEMBER:
 786                 CTR1(KTR_MLD, "%s: ->AWAKENING", __func__);
 787                 inm->in6m_state = MLD_AWAKENING_MEMBER;
 788                 break;
 789         case MLD_LEAVING_MEMBER:
 790                 break;
 791         }
 792 }
 793
 794 /*
 795  * Process a received MLDv2 general, group-specific or
 796  * group-and-source-specific query.
 797  *
 798  * Assumes that mld points to a struct mldv2_query which is stored in
 799  * contiguous memory.
 800  *
 801  * Return 0 if successful, otherwise an appropriate error code is returned.
 802  */
 803 static int
 804 mld_v2_input_query(struct ifnet *ifp, const struct ip6_hdr *ip6,
 805     struct mbuf *m, struct mldv2_query *mld, const int off, const int icmp6len)
 806 {
 807         struct mld_ifsoftc      *mli;
 808         struct in6_multi        *inm;
 809         uint32_t                 maxdelay, nsrc, qqi;
 810         int                      is_general_query;
 811         uint16_t                 timer;
 812         uint8_t                  qrv;
 813 #ifdef KTR
 814         char                     ip6tbuf[INET6_ADDRSTRLEN];
 815 #endif
 816
 817         is_general_query = 0;
 818
 819         /*
 820          * RFC3810 Section 6.2: MLD queries must originate from
 821          * a router's link-local address.
 822          */
 823         if (!IN6_IS_SCOPE_LINKLOCAL(&ip6->ip6_src)) {
 824                 CTR3(KTR_MLD, "ignore v1 query src %s on ifp %p(%s)",
 825                     ip6_sprintf(ip6tbuf, &ip6->ip6_src),
 826                     ifp, if_name(ifp));
 827                 return (0);
 828         }
 829
 830         CTR2(KTR_MLD, "input v2 query on ifp %p(%s)", ifp, if_name(ifp));
 831
 832         maxdelay = ntohs(mld->mld_maxdelay);    /* in 1/10ths of a second */
 833         if (maxdelay >= 32768) {
 834                 maxdelay = (MLD_MRC_MANT(maxdelay) | 0x1000) <<
 835                            (MLD_MRC_EXP(maxdelay) + 3);
 836         }
 837         timer = (maxdelay * PR_FASTHZ) / MLD_TIMER_SCALE;
 838         if (timer == 0)
 839                 timer = 1;
 840
 841         qrv = MLD_QRV(mld->mld_misc);
 842         if (qrv < 2) {
 843                 CTR3(KTR_MLD, "%s: clamping qrv %d to %d", __func__,
 844                     qrv, MLD_RV_INIT);
 845                 qrv = MLD_RV_INIT;
 846         }
 847
 848         qqi = mld->mld_qqi;
 849         if (qqi >= 128) {
 850                 qqi = MLD_QQIC_MANT(mld->mld_qqi) <<
 851                      (MLD_QQIC_EXP(mld->mld_qqi) + 3);
 852         }
 853
 854         nsrc = ntohs(mld->mld_numsrc);
 855         if (nsrc > MLD_MAX_GS_SOURCES)
 856                 return (EMSGSIZE);
 857         if (icmp6len < sizeof(struct mldv2_query) +
 858             (nsrc * sizeof(struct in6_addr)))
 859                 return (EMSGSIZE);
 860
 861         /*
 862          * Do further input validation upfront to avoid resetting timers
 863          * should we need to discard this query.
 864          */
 865         if (IN6_IS_ADDR_UNSPECIFIED(&mld->mld_addr)) {
 866                 /*
 867                  * A general query with a source list has undefined
 868                  * behaviour; discard it.
 869                  */
 870                 if (nsrc > 0)
 871                         return (EINVAL);
 872                 is_general_query = 1;
 873         } else {
 874                 /*
 875                  * Embed scope ID of receiving interface in MLD query for
 876                  * lookup whilst we don't hold other locks (due to KAME
 877                  * locking lameness). We own this mbuf chain just now.
 878                  */
 879                 in6_setscope(&mld->mld_addr, ifp, NULL);
 880         }
 881
 882         IN6_MULTI_LOCK();
 883         MLD_LOCK();
 884
 885         mli = MLD_IFINFO(ifp);
 886         KASSERT(mli != NULL, ("%s: no mld_ifsoftc for ifp %p", __func__, ifp));
 887
 888         /*
 889          * Discard the v2 query if we're in Compatibility Mode.
 890          * The RFC is pretty clear that hosts need to stay in MLDv1 mode
 891          * until the Old Version Querier Present timer expires.
 892          */
 893         if (mli->mli_version != MLD_VERSION_2)
 894                 goto out_locked;
 895
 896         mld_set_version(mli, MLD_VERSION_2);
 897         mli->mli_rv = qrv;
 898         mli->mli_qi = qqi;
 899         mli->mli_qri = maxdelay;
 900
 901         CTR4(KTR_MLD, "%s: qrv %d qi %d maxdelay %d", __func__, qrv, qqi,
 902             maxdelay);
 903
 904         if (is_general_query) {
 905                 /*
 906                  * MLDv2 General Query.
 907                  *
 908                  * Schedule a current-state report on this ifp for
 909                  * all groups, possibly containing source lists.
 910                  *
 911                  * If there is a pending General Query response
 912                  * scheduled earlier than the selected delay, do
 913                  * not schedule any other reports.
 914                  * Otherwise, reset the interface timer.
 915                  */
 916                 CTR2(KTR_MLD, "process v2 general query on ifp %p(%s)",
 917                     ifp, if_name(ifp));
 918                 if (mli->mli_v2_timer == 0 || mli->mli_v2_timer >= timer) {
 919                         mli->mli_v2_timer = MLD_RANDOM_DELAY(timer);
 920                         V_interface_timers_running6 = 1;
 921                 }
 922         } else {
 923                 /*
 924                  * MLDv2 Group-specific or Group-and-source-specific Query.
 925                  *
 926                  * Group-source-specific queries are throttled on
 927                  * a per-group basis to defeat denial-of-service attempts.
 928                  * Queries for groups we are not a member of on this
 929                  * link are simply ignored.
 930                  */
 931                 IF_ADDR_RLOCK(ifp);
 932                 inm = in6m_lookup_locked(ifp, &mld->mld_addr);
 933                 if (inm == NULL) {
 934                         IF_ADDR_RUNLOCK(ifp);
 935                         goto out_locked;
 936                 }
 937                 if (nsrc > 0) {
 938                         if (!ratecheck(&inm->in6m_lastgsrtv,
 939                             &V_mld_gsrdelay)) {
 940                                 CTR1(KTR_MLD, "%s: GS query throttled.",
 941                                     __func__);
 942                                 IF_ADDR_RUNLOCK(ifp);
 943                                 goto out_locked;
 944                         }
 945                 }
 946                 CTR2(KTR_MLD, "process v2 group query on ifp %p(%s)",
 947                      ifp, if_name(ifp));
 948                 /*
 949                  * If there is a pending General Query response
 950                  * scheduled sooner than the selected delay, no
 951                  * further report need be scheduled.
 952                  * Otherwise, prepare to respond to the
 953                  * group-specific or group-and-source query.
 954                  */
 955                 if (mli->mli_v2_timer == 0 || mli->mli_v2_timer >= timer)
 956                         mld_v2_process_group_query(inm, mli, timer, m, mld, off);
 957
 958                 /* XXX Clear embedded scope ID as userland won't expect it. */
 959                 in6_clearscope(&mld->mld_addr);
 960                 IF_ADDR_RUNLOCK(ifp);
 961         }
 962
 963 out_locked:
 964         MLD_UNLOCK();
 965         IN6_MULTI_UNLOCK();
 966
 967         return (0);
 968 }
 969
 970 /*
 971  * Process a received MLDv2 group-specific or group-and-source-specific
 972  * query.
 973  * Return <0 if any error occurred. Currently this is ignored.
 974  */
 975 static int
 976 mld_v2_process_group_query(struct in6_multi *inm, struct mld_ifsoftc *mli,
 977     int timer, struct mbuf *m0, struct mldv2_query *mld, const int off)
 978 {
 979         int                      retval;
 980         uint16_t                 nsrc;
 981
 982         IN6_MULTI_LOCK_ASSERT();
 983         MLD_LOCK_ASSERT();
 984
 985         retval = 0;
 986
 987         switch (inm->in6m_state) {
 988         case MLD_NOT_MEMBER:
 989         case MLD_SILENT_MEMBER:
 990         case MLD_SLEEPING_MEMBER:
 991         case MLD_LAZY_MEMBER:
 992         case MLD_AWAKENING_MEMBER:
 993         case MLD_IDLE_MEMBER:
 994         case MLD_LEAVING_MEMBER:
 995                 return (retval);
 996                 break;
 997         case MLD_REPORTING_MEMBER:
 998         case MLD_G_QUERY_PENDING_MEMBER:
 999         case MLD_SG_QUERY_PENDING_MEMBER:
1000                 break;
1001         }
1002
1003         nsrc = ntohs(mld->mld_numsrc);
1004
1005         /* Length should be checked by calling function. */
1006         KASSERT((m0->m_flags & M_PKTHDR) == 0 ||
1007             m0->m_pkthdr.len >= off + sizeof(struct mldv2_query) +
1008             nsrc * sizeof(struct in6_addr),
1009             ("mldv2 packet is too short: (%d bytes < %zd bytes, m=%p)",
1010             m0->m_pkthdr.len, off + sizeof(struct mldv2_query) +
1011             nsrc * sizeof(struct in6_addr), m0));
1012
1013
1014         /*
1015          * Deal with group-specific queries upfront.
1016          * If any group query is already pending, purge any recorded
1017          * source-list state if it exists, and schedule a query response
1018          * for this group-specific query.
1019          */
1020         if (nsrc == 0) {
1021                 if (inm->in6m_state == MLD_G_QUERY_PENDING_MEMBER ||
1022                     inm->in6m_state == MLD_SG_QUERY_PENDING_MEMBER) {
1023                         in6m_clear_recorded(inm);
1024                         timer = min(inm->in6m_timer, timer);
1025                 }
1026                 inm->in6m_state = MLD_G_QUERY_PENDING_MEMBER;
1027                 inm->in6m_timer = MLD_RANDOM_DELAY(timer);
1028                 V_current_state_timers_running6 = 1;
1029                 return (retval);
1030         }
1031
1032         /*
1033          * Deal with the case where a group-and-source-specific query has
1034          * been received but a group-specific query is already pending.
1035          */
1036         if (inm->in6m_state == MLD_G_QUERY_PENDING_MEMBER) {
1037                 timer = min(inm->in6m_timer, timer);
1038                 inm->in6m_timer = MLD_RANDOM_DELAY(timer);
1039                 V_current_state_timers_running6 = 1;
1040                 return (retval);
1041         }
1042
1043         /*
1044          * Finally, deal with the case where a group-and-source-specific
1045          * query has been received, where a response to a previous g-s-r
1046          * query exists, or none exists.
1047          * In this case, we need to parse the source-list which the Querier
1048          * has provided us with and check if we have any source list filter
1049          * entries at T1 for these sources. If we do not, there is no need
1050          * schedule a report and the query may be dropped.
1051          * If we do, we must record them and schedule a current-state
1052          * report for those sources.
1053          */
1054         if (inm->in6m_nsrc > 0) {
1055                 struct in6_addr          srcaddr;
1056                 int                      i, nrecorded;
1057                 int                      soff;
1058
1059                 soff = off + sizeof(struct mldv2_query);
1060                 nrecorded = 0;
1061                 for (i = 0; i < nsrc; i++) {
1062                         m_copydata(m0, soff, sizeof(struct in6_addr),
1063                             (caddr_t)&srcaddr);
1064                         retval = in6m_record_source(inm, &srcaddr);
1065                         if (retval < 0)
1066                                 break;
1067                         nrecorded += retval;
1068                         soff += sizeof(struct in6_addr);
1069                 }
1070                 if (nrecorded > 0) {
1071                         CTR1(KTR_MLD,
1072                             "%s: schedule response to SG query", __func__);
1073                         inm->in6m_state = MLD_SG_QUERY_PENDING_MEMBER;
1074                         inm->in6m_timer = MLD_RANDOM_DELAY(timer);
1075                         V_current_state_timers_running6 = 1;
1076                 }
1077         }
1078
1079         return (retval);
1080 }
1081
1082 /*
1083  * Process a received MLDv1 host membership report.
1084  * Assumes mld points to mld_hdr in pulled up mbuf chain.
1085  *
1086  * NOTE: Can't be fully const correct as we temporarily embed scope ID in
1087  * mld_addr. This is OK as we own the mbuf chain.
1088  */
1089 static int
1090 mld_v1_input_report(struct ifnet *ifp, const struct ip6_hdr *ip6,
1091     /*const*/ struct mld_hdr *mld)
1092 {
1093         struct in6_addr          src, dst;
1094         struct in6_ifaddr       *ia;
1095         struct in6_multi        *inm;
1096 #ifdef KTR
1097         char                     ip6tbuf[INET6_ADDRSTRLEN];
1098 #endif
1099
1100         if (!mld_v1enable) {
1101                 CTR3(KTR_MLD, "ignore v1 report %s on ifp %p(%s)",
1102                     ip6_sprintf(ip6tbuf, &mld->mld_addr),
1103                     ifp, if_name(ifp));
1104                 return (0);
1105         }
1106
1107         if (ifp->if_flags & IFF_LOOPBACK)
1108                 return (0);
1109
1110         /*
1111          * MLDv1 reports must originate from a host's link-local address,
1112          * or the unspecified address (when booting).
1113          */
1114         src = ip6->ip6_src;
1115         in6_clearscope(&src);
1116         if (!IN6_IS_SCOPE_LINKLOCAL(&src) && !IN6_IS_ADDR_UNSPECIFIED(&src)) {
1117                 CTR3(KTR_MLD, "ignore v1 query src %s on ifp %p(%s)",
1118                     ip6_sprintf(ip6tbuf, &ip6->ip6_src),
1119                     ifp, if_name(ifp));
1120                 return (EINVAL);
1121         }
1122
1123         /*
1124          * RFC2710 Section 4: MLDv1 reports must pertain to a multicast
1125          * group, and must be directed to the group itself.
1126          */
1127         dst = ip6->ip6_dst;
1128         in6_clearscope(&dst);
1129         if (!IN6_IS_ADDR_MULTICAST(&mld->mld_addr) ||
1130             !IN6_ARE_ADDR_EQUAL(&mld->mld_addr, &dst)) {
1131                 CTR3(KTR_MLD, "ignore v1 query dst %s on ifp %p(%s)",
1132                     ip6_sprintf(ip6tbuf, &ip6->ip6_dst),
1133                     ifp, if_name(ifp));
1134                 return (EINVAL);
1135         }
1136
1137         /*
1138          * Make sure we don't hear our own membership report, as fast
1139          * leave requires knowing that we are the only member of a
1140          * group. Assume we used the link-local address if available,
1141          * otherwise look for ::.
1142          *
1143          * XXX Note that scope ID comparison is needed for the address
1144          * returned by in6ifa_ifpforlinklocal(), but SHOULD NOT be
1145          * performed for the on-wire address.
1146          */
1147         ia = in6ifa_ifpforlinklocal(ifp, IN6_IFF_NOTREADY|IN6_IFF_ANYCAST);
1148         if ((ia && IN6_ARE_ADDR_EQUAL(&ip6->ip6_src, IA6_IN6(ia))) ||
1149             (ia == NULL && IN6_IS_ADDR_UNSPECIFIED(&src))) {
1150                 if (ia != NULL)
1151                         ifa_free(&ia->ia_ifa);
1152                 return (0);
1153         }
1154         if (ia != NULL)
1155                 ifa_free(&ia->ia_ifa);
1156
1157         CTR3(KTR_MLD, "process v1 report %s on ifp %p(%s)",
1158             ip6_sprintf(ip6tbuf, &mld->mld_addr), ifp, if_name(ifp));
1159
1160         /*
1161          * Embed scope ID of receiving interface in MLD query for lookup
1162          * whilst we don't hold other locks (due to KAME locking lameness).
1163          */
1164         if (!IN6_IS_ADDR_UNSPECIFIED(&mld->mld_addr))
1165                 in6_setscope(&mld->mld_addr, ifp, NULL);
1166
1167         IN6_MULTI_LOCK();
1168         MLD_LOCK();
1169         IF_ADDR_RLOCK(ifp);
1170
1171         /*
1172          * MLDv1 report suppression.
1173          * If we are a member of this group, and our membership should be
1174          * reported, and our group timer is pending or about to be reset,
1175          * stop our group timer by transitioning to the 'lazy' state.
1176          */
1177         inm = in6m_lookup_locked(ifp, &mld->mld_addr);
1178         if (inm != NULL) {
1179                 struct mld_ifsoftc *mli;
1180
1181                 mli = inm->in6m_mli;
1182                 KASSERT(mli != NULL,
1183                     ("%s: no mli for ifp %p", __func__, ifp));
1184
1185                 /*
1186                  * If we are in MLDv2 host mode, do not allow the
1187                  * other host's MLDv1 report to suppress our reports.
1188                  */
1189                 if (mli->mli_version == MLD_VERSION_2)
1190                         goto out_locked;
1191
1192                 inm->in6m_timer = 0;
1193
1194                 switch (inm->in6m_state) {
1195                 case MLD_NOT_MEMBER:
1196                 case MLD_SILENT_MEMBER:
1197                 case MLD_SLEEPING_MEMBER:
1198                         break;
1199                 case MLD_REPORTING_MEMBER:
1200                 case MLD_IDLE_MEMBER:
1201                 case MLD_AWAKENING_MEMBER:
1202                         CTR3(KTR_MLD,
1203                             "report suppressed for %s on ifp %p(%s)",
1204                             ip6_sprintf(ip6tbuf, &mld->mld_addr),
1205                             ifp, if_name(ifp));
1206                 case MLD_LAZY_MEMBER:
1207                         inm->in6m_state = MLD_LAZY_MEMBER;
1208                         break;
1209                 case MLD_G_QUERY_PENDING_MEMBER:
1210                 case MLD_SG_QUERY_PENDING_MEMBER:
1211                 case MLD_LEAVING_MEMBER:
1212                         break;
1213                 }
1214         }
1215
1216 out_locked:
1217         IF_ADDR_RUNLOCK(ifp);
1218         MLD_UNLOCK();
1219         IN6_MULTI_UNLOCK();
1220
1221         /* XXX Clear embedded scope ID as userland won't expect it. */
1222         in6_clearscope(&mld->mld_addr);
1223
1224         return (0);
1225 }
1226
1227 /*
1228  * MLD input path.
1229  *
1230  * Assume query messages which fit in a single ICMPv6 message header
1231  * have been pulled up.
1232  * Assume that userland will want to see the message, even if it
1233  * otherwise fails kernel input validation; do not free it.
1234  * Pullup may however free the mbuf chain m if it fails.
1235  *
1236  * Return IPPROTO_DONE if we freed m. Otherwise, return 0.
1237  */
1238 int
1239 mld_input(struct mbuf *m, int off, int icmp6len)
1240 {
1241         struct ifnet    *ifp;
1242         struct ip6_hdr  *ip6;
1243         struct mld_hdr  *mld;
1244         int              mldlen;
1245
1246         CTR3(KTR_MLD, "%s: called w/mbuf (%p,%d)", __func__, m, off);
1247
1248         ifp = m->m_pkthdr.rcvif;
1249
1250         ip6 = mtod(m, struct ip6_hdr *);
1251
1252         /* Pullup to appropriate size. */
1253         mld = (struct mld_hdr *)(mtod(m, uint8_t *) + off);
1254         if (mld->mld_type == MLD_LISTENER_QUERY &&
1255             icmp6len >= sizeof(struct mldv2_query)) {
1256                 mldlen = sizeof(struct mldv2_query);
1257         } else {
1258                 mldlen = sizeof(struct mld_hdr);
1259         }
1260         IP6_EXTHDR_GET(mld, struct mld_hdr *, m, off, mldlen);
1261         if (mld == NULL) {
1262                 ICMP6STAT_INC(icp6s_badlen);
1263                 return (IPPROTO_DONE);
1264         }
1265
1266         /*
1267          * Userland needs to see all of this traffic for implementing
1268          * the endpoint discovery portion of multicast routing.
1269          */
1270         switch (mld->mld_type) {
1271         case MLD_LISTENER_QUERY:
1272                 icmp6_ifstat_inc(ifp, ifs6_in_mldquery);
1273                 if (icmp6len == sizeof(struct mld_hdr)) {
1274                         if (mld_v1_input_query(ifp, ip6, mld) != 0)
1275                                 return (0);
1276                 } else if (icmp6len >= sizeof(struct mldv2_query)) {
1277                         if (mld_v2_input_query(ifp, ip6, m,
1278                             (struct mldv2_query *)mld, off, icmp6len) != 0)
1279                                 return (0);
1280                 }
1281                 break;
1282         case MLD_LISTENER_REPORT:
1283                 icmp6_ifstat_inc(ifp, ifs6_in_mldreport);
1284                 if (mld_v1_input_report(ifp, ip6, mld) != 0)
1285                         return (0);
1286                 break;
1287         case MLDV2_LISTENER_REPORT:
1288                 icmp6_ifstat_inc(ifp, ifs6_in_mldreport);
1289                 break;
1290         case MLD_LISTENER_DONE:
1291                 icmp6_ifstat_inc(ifp, ifs6_in_mlddone);
1292                 break;
1293         default:
1294                 break;
1295         }
1296
1297         return (0);
1298 }
1299
1300 /*
1301  * Fast timeout handler (global).
1302  * VIMAGE: Timeout handlers are expected to service all vimages.
1303  */
1304 void
1305 mld_fasttimo(void)
1306 {
1307         VNET_ITERATOR_DECL(vnet_iter);
1308
1309         VNET_LIST_RLOCK_NOSLEEP();
1310         VNET_FOREACH(vnet_iter) {
1311                 CURVNET_SET(vnet_iter);
1312                 mld_fasttimo_vnet();
1313                 CURVNET_RESTORE();
1314         }
1315         VNET_LIST_RUNLOCK_NOSLEEP();
1316 }
1317
1318 /*
1319  * Fast timeout handler (per-vnet).
1320  *
1321  * VIMAGE: Assume caller has set up our curvnet.
1322  */
1323 static void
1324 mld_fasttimo_vnet(void)
1325 {
1326         struct mbufq             scq;   /* State-change packets */
1327         struct mbufq             qrq;   /* Query response packets */
1328         struct ifnet            *ifp;
1329         struct mld_ifsoftc      *mli;
1330         struct ifmultiaddr      *ifma;
1331         struct in6_multi        *inm, *tinm;
1332         int                      uri_fasthz;
1333
1334         uri_fasthz = 0;
1335
1336         /*
1337          * Quick check to see if any work needs to be done, in order to
1338          * minimize the overhead of fasttimo processing.
1339          * SMPng: XXX Unlocked reads.
1340          */
1341         if (!V_current_state_timers_running6 &&
1342             !V_interface_timers_running6 &&
1343             !V_state_change_timers_running6)
1344                 return;
1345
1346         IN6_MULTI_LOCK();
1347         MLD_LOCK();
1348
1349         /*
1350          * MLDv2 General Query response timer processing.
1351          */
1352         if (V_interface_timers_running6) {
1353                 CTR1(KTR_MLD, "%s: interface timers running", __func__);
1354
1355                 V_interface_timers_running6 = 0;
1356                 LIST_FOREACH(mli, &V_mli_head, mli_link) {
1357                         if (mli->mli_v2_timer == 0) {
1358                                 /* Do nothing. */
1359                         } else if (--mli->mli_v2_timer == 0) {
1360                                 mld_v2_dispatch_general_query(mli);
1361                         } else {
1362                                 V_interface_timers_running6 = 1;
1363                         }
1364                 }
1365         }
1366
1367         if (!V_current_state_timers_running6 &&
1368             !V_state_change_timers_running6)
1369                 goto out_locked;
1370
1371         V_current_state_timers_running6 = 0;
1372         V_state_change_timers_running6 = 0;
1373
1374         CTR1(KTR_MLD, "%s: state change timers running", __func__);
1375
1376         /*
1377          * MLD host report and state-change timer processing.
1378          * Note: Processing a v2 group timer may remove a node.
1379          */
1380         LIST_FOREACH(mli, &V_mli_head, mli_link) {
1381                 ifp = mli->mli_ifp;
1382
1383                 if (mli->mli_version == MLD_VERSION_2) {
1384                         uri_fasthz = MLD_RANDOM_DELAY(mli->mli_uri *
1385                             PR_FASTHZ);
1386                         mbufq_init(&qrq, MLD_MAX_G_GS_PACKETS);
1387                         mbufq_init(&scq, MLD_MAX_STATE_CHANGE_PACKETS);
1388                 }
1389
1390                 IF_ADDR_RLOCK(ifp);
1391                 TAILQ_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link) {
1392                         if (ifma->ifma_addr->sa_family != AF_INET6 ||
1393                             ifma->ifma_protospec == NULL)
1394                                 continue;
1395                         inm = (struct in6_multi *)ifma->ifma_protospec;
1396                         switch (mli->mli_version) {
1397                         case MLD_VERSION_1:
1398                                 mld_v1_process_group_timer(mli, inm);
1399                                 break;
1400                         case MLD_VERSION_2:
1401                                 mld_v2_process_group_timers(mli, &qrq,
1402                                     &scq, inm, uri_fasthz);
1403                                 break;
1404                         }
1405                 }
1406                 IF_ADDR_RUNLOCK(ifp);
1407
1408                 switch (mli->mli_version) {
1409                 case MLD_VERSION_1:
1410                         /*
1411                          * Transmit reports for this lifecycle.  This
1412                          * is done while not holding IF_ADDR_LOCK
1413                          * since this can call
1414                          * in6ifa_ifpforlinklocal() which locks
1415                          * IF_ADDR_LOCK internally as well as
1416                          * ip6_output() to transmit a packet.
1417                          */
1418                         SLIST_FOREACH_SAFE(inm, &mli->mli_relinmhead,
1419                             in6m_nrele, tinm) {
1420                                 SLIST_REMOVE_HEAD(&mli->mli_relinmhead,
1421                                     in6m_nrele);
1422                                 (void)mld_v1_transmit_report(inm,
1423                                     MLD_LISTENER_REPORT);
1424                         }
1425                         break;
1426                 case MLD_VERSION_2:
1427                         mld_dispatch_queue(&qrq, 0);
1428                         mld_dispatch_queue(&scq, 0);
1429
1430                         /*
1431                          * Free the in_multi reference(s) for
1432                          * this lifecycle.
1433                          */
1434                         SLIST_FOREACH_SAFE(inm, &mli->mli_relinmhead,
1435                             in6m_nrele, tinm) {
1436                                 SLIST_REMOVE_HEAD(&mli->mli_relinmhead,
1437                                     in6m_nrele);
1438                                 in6m_release_locked(inm);
1439                         }
1440                         break;
1441                 }
1442         }
1443
1444 out_locked:
1445         MLD_UNLOCK();
1446         IN6_MULTI_UNLOCK();
1447 }
1448
1449 /*
1450  * Update host report group timer.
1451  * Will update the global pending timer flags.
1452  */
1453 static void
1454 mld_v1_process_group_timer(struct mld_ifsoftc *mli, struct in6_multi *inm)
1455 {
1456         int report_timer_expired;
1457
1458         IN6_MULTI_LOCK_ASSERT();
1459         MLD_LOCK_ASSERT();
1460
1461         if (inm->in6m_timer == 0) {
1462                 report_timer_expired = 0;
1463         } else if (--inm->in6m_timer == 0) {
1464                 report_timer_expired = 1;
1465         } else {
1466                 V_current_state_timers_running6 = 1;
1467                 return;
1468         }
1469
1470         switch (inm->in6m_state) {
1471         case MLD_NOT_MEMBER:
1472         case MLD_SILENT_MEMBER:
1473         case MLD_IDLE_MEMBER:
1474         case MLD_LAZY_MEMBER:
1475         case MLD_SLEEPING_MEMBER:
1476         case MLD_AWAKENING_MEMBER:
1477                 break;
1478         case MLD_REPORTING_MEMBER:
1479                 if (report_timer_expired) {
1480                         inm->in6m_state = MLD_IDLE_MEMBER;
1481                         SLIST_INSERT_HEAD(&mli->mli_relinmhead, inm,
1482                             in6m_nrele);
1483                 }
1484                 break;
1485         case MLD_G_QUERY_PENDING_MEMBER:
1486         case MLD_SG_QUERY_PENDING_MEMBER:
1487         case MLD_LEAVING_MEMBER:
1488                 break;
1489         }
1490 }
1491
1492 /*
1493  * Update a group's timers for MLDv2.
1494  * Will update the global pending timer flags.
1495  * Note: Unlocked read from mli.
1496  */
1497 static void
1498 mld_v2_process_group_timers(struct mld_ifsoftc *mli,
1499     struct mbufq *qrq, struct mbufq *scq,
1500     struct in6_multi *inm, const int uri_fasthz)
1501 {
1502         int query_response_timer_expired;
1503         int state_change_retransmit_timer_expired;
1504 #ifdef KTR
1505         char ip6tbuf[INET6_ADDRSTRLEN];
1506 #endif
1507
1508         IN6_MULTI_LOCK_ASSERT();
1509         MLD_LOCK_ASSERT();
1510
1511         query_response_timer_expired = 0;
1512         state_change_retransmit_timer_expired = 0;
1513
1514         /*
1515          * During a transition from compatibility mode back to MLDv2,
1516          * a group record in REPORTING state may still have its group
1517          * timer active. This is a no-op in this function; it is easier
1518          * to deal with it here than to complicate the slow-timeout path.
1519          */
1520         if (inm->in6m_timer == 0) {
1521                 query_response_timer_expired = 0;
1522         } else if (--inm->in6m_timer == 0) {
1523                 query_response_timer_expired = 1;
1524         } else {
1525                 V_current_state_timers_running6 = 1;
1526         }
1527
1528         if (inm->in6m_sctimer == 0) {
1529                 state_change_retransmit_timer_expired = 0;
1530         } else if (--inm->in6m_sctimer == 0) {
1531                 state_change_retransmit_timer_expired = 1;
1532         } else {
1533                 V_state_change_timers_running6 = 1;
1534         }
1535
1536         /* We are in fasttimo, so be quick about it. */
1537         if (!state_change_retransmit_timer_expired &&
1538             !query_response_timer_expired)
1539                 return;
1540
1541         switch (inm->in6m_state) {
1542         case MLD_NOT_MEMBER:
1543         case MLD_SILENT_MEMBER:
1544         case MLD_SLEEPING_MEMBER:
1545         case MLD_LAZY_MEMBER:
1546         case MLD_AWAKENING_MEMBER:
1547         case MLD_IDLE_MEMBER:
1548                 break;
1549         case MLD_G_QUERY_PENDING_MEMBER:
1550         case MLD_SG_QUERY_PENDING_MEMBER:
1551                 /*
1552                  * Respond to a previously pending Group-Specific
1553                  * or Group-and-Source-Specific query by enqueueing
1554                  * the appropriate Current-State report for
1555                  * immediate transmission.
1556                  */
1557                 if (query_response_timer_expired) {
1558                         int retval;
1559
1560                         retval = mld_v2_enqueue_group_record(qrq, inm, 0, 1,
1561                             (inm->in6m_state == MLD_SG_QUERY_PENDING_MEMBER),
1562                             0);
1563                         CTR2(KTR_MLD, "%s: enqueue record = %d",
1564                             __func__, retval);
1565                         inm->in6m_state = MLD_REPORTING_MEMBER;
1566                         in6m_clear_recorded(inm);
1567                 }
1568                 /* FALLTHROUGH */
1569         case MLD_REPORTING_MEMBER:
1570         case MLD_LEAVING_MEMBER:
1571                 if (state_change_retransmit_timer_expired) {
1572                         /*
1573                          * State-change retransmission timer fired.
1574                          * If there are any further pending retransmissions,
1575                          * set the global pending state-change flag, and
1576                          * reset the timer.
1577                          */
1578                         if (--inm->in6m_scrv > 0) {
1579                                 inm->in6m_sctimer = uri_fasthz;
1580                                 V_state_change_timers_running6 = 1;
1581                         }
1582                         /*
1583                          * Retransmit the previously computed state-change
1584                          * report. If there are no further pending
1585                          * retransmissions, the mbuf queue will be consumed.
1586                          * Update T0 state to T1 as we have now sent
1587                          * a state-change.
1588                          */
1589                         (void)mld_v2_merge_state_changes(inm, scq);
1590
1591                         in6m_commit(inm);
1592                         CTR3(KTR_MLD, "%s: T1 -> T0 for %s/%s", __func__,
1593                             ip6_sprintf(ip6tbuf, &inm->in6m_addr),
1594                             if_name(inm->in6m_ifp));
1595
1596                         /*
1597                          * If we are leaving the group for good, make sure
1598                          * we release MLD's reference to it.
1599                          * This release must be deferred using a SLIST,
1600                          * as we are called from a loop which traverses
1601                          * the in_ifmultiaddr TAILQ.
1602                          */
1603                         if (inm->in6m_state == MLD_LEAVING_MEMBER &&
1604                             inm->in6m_scrv == 0) {
1605                                 inm->in6m_state = MLD_NOT_MEMBER;
1606                                 SLIST_INSERT_HEAD(&mli->mli_relinmhead,
1607                                     inm, in6m_nrele);
1608                         }
1609                 }
1610                 break;
1611         }
1612 }
1613
1614 /*
1615  * Switch to a different version on the given interface,
1616  * as per Section 9.12.
1617  */
1618 static void
1619 mld_set_version(struct mld_ifsoftc *mli, const int version)
1620 {
1621         int old_version_timer;
1622
1623         MLD_LOCK_ASSERT();
1624
1625         CTR4(KTR_MLD, "%s: switching to v%d on ifp %p(%s)", __func__,
1626             version, mli->mli_ifp, if_name(mli->mli_ifp));
1627
1628         if (version == MLD_VERSION_1) {
1629                 /*
1630                  * Compute the "Older Version Querier Present" timer as per
1631                  * Section 9.12.
1632                  */
1633                 old_version_timer = (mli->mli_rv * mli->mli_qi) + mli->mli_qri;
1634                 old_version_timer *= PR_SLOWHZ;
1635                 mli->mli_v1_timer = old_version_timer;
1636         }
1637
1638         if (mli->mli_v1_timer > 0 && mli->mli_version != MLD_VERSION_1) {
1639                 mli->mli_version = MLD_VERSION_1;
1640                 mld_v2_cancel_link_timers(mli);
1641         }
1642 }
1643
1644 /*
1645  * Cancel pending MLDv2 timers for the given link and all groups
1646  * joined on it; state-change, general-query, and group-query timers.
1647  */
1648 static void
1649 mld_v2_cancel_link_timers(struct mld_ifsoftc *mli)
1650 {
1651         struct ifmultiaddr      *ifma;
1652         struct ifnet            *ifp;
1653         struct in6_multi        *inm, *tinm;
1654
1655         CTR3(KTR_MLD, "%s: cancel v2 timers on ifp %p(%s)", __func__,
1656             mli->mli_ifp, if_name(mli->mli_ifp));
1657
1658         IN6_MULTI_LOCK_ASSERT();
1659         MLD_LOCK_ASSERT();
1660
1661         /*
1662          * Fast-track this potentially expensive operation
1663          * by checking all the global 'timer pending' flags.
1664          */
1665         if (!V_interface_timers_running6 &&
1666             !V_state_change_timers_running6 &&
1667             !V_current_state_timers_running6)
1668                 return;
1669
1670         mli->mli_v2_timer = 0;
1671
1672         ifp = mli->mli_ifp;
1673
1674         IF_ADDR_RLOCK(ifp);
1675         TAILQ_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link) {
1676                 if (ifma->ifma_addr->sa_family != AF_INET6)
1677                         continue;
1678                 inm = (struct in6_multi *)ifma->ifma_protospec;
1679                 switch (inm->in6m_state) {
1680                 case MLD_NOT_MEMBER:
1681                 case MLD_SILENT_MEMBER:
1682                 case MLD_IDLE_MEMBER:
1683                 case MLD_LAZY_MEMBER:
1684                 case MLD_SLEEPING_MEMBER:
1685                 case MLD_AWAKENING_MEMBER:
1686                         break;
1687                 case MLD_LEAVING_MEMBER:
1688                         /*
1689                          * If we are leaving the group and switching
1690                          * version, we need to release the final
1691                          * reference held for issuing the INCLUDE {}.
1692                          */
1693                         SLIST_INSERT_HEAD(&mli->mli_relinmhead, inm,
1694                             in6m_nrele);
1695                         /* FALLTHROUGH */
1696                 case MLD_G_QUERY_PENDING_MEMBER:
1697                 case MLD_SG_QUERY_PENDING_MEMBER:
1698                         in6m_clear_recorded(inm);
1699                         /* FALLTHROUGH */
1700                 case MLD_REPORTING_MEMBER:
1701                         inm->in6m_sctimer = 0;
1702                         inm->in6m_timer = 0;
1703                         inm->in6m_state = MLD_REPORTING_MEMBER;
1704                         /*
1705                          * Free any pending MLDv2 state-change records.
1706                          */
1707                         mbufq_drain(&inm->in6m_scq);
1708                         break;
1709                 }
1710         }
1711         IF_ADDR_RUNLOCK(ifp);
1712         SLIST_FOREACH_SAFE(inm, &mli->mli_relinmhead, in6m_nrele, tinm) {
1713                 SLIST_REMOVE_HEAD(&mli->mli_relinmhead, in6m_nrele);
1714                 in6m_release_locked(inm);
1715         }
1716 }
1717
1718 /*
1719  * Global slowtimo handler.
1720  * VIMAGE: Timeout handlers are expected to service all vimages.
1721  */
1722 void
1723 mld_slowtimo(void)
1724 {
1725         VNET_ITERATOR_DECL(vnet_iter);
1726
1727         VNET_LIST_RLOCK_NOSLEEP();
1728         VNET_FOREACH(vnet_iter) {
1729                 CURVNET_SET(vnet_iter);
1730                 mld_slowtimo_vnet();
1731                 CURVNET_RESTORE();
1732         }
1733         VNET_LIST_RUNLOCK_NOSLEEP();
1734 }
1735
1736 /*
1737  * Per-vnet slowtimo handler.
1738  */
1739 static void
1740 mld_slowtimo_vnet(void)
1741 {
1742         struct mld_ifsoftc *mli;
1743
1744         MLD_LOCK();
1745
1746         LIST_FOREACH(mli, &V_mli_head, mli_link) {
1747                 mld_v1_process_querier_timers(mli);
1748         }
1749
1750         MLD_UNLOCK();
1751 }
1752
1753 /*
1754  * Update the Older Version Querier Present timers for a link.
1755  * See Section 9.12 of RFC 3810.
1756  */
1757 static void
1758 mld_v1_process_querier_timers(struct mld_ifsoftc *mli)
1759 {
1760
1761         MLD_LOCK_ASSERT();
1762
1763         if (mli->mli_version != MLD_VERSION_2 && --mli->mli_v1_timer == 0) {
1764                 /*
1765                  * MLDv1 Querier Present timer expired; revert to MLDv2.
1766                  */
1767                 CTR5(KTR_MLD,
1768                     "%s: transition from v%d -> v%d on %p(%s)",
1769                     __func__, mli->mli_version, MLD_VERSION_2,
1770                     mli->mli_ifp, if_name(mli->mli_ifp));
1771                 mli->mli_version = MLD_VERSION_2;
1772         }
1773 }
1774
1775 /*
1776  * Transmit an MLDv1 report immediately.
1777  */
1778 static int
1779 mld_v1_transmit_report(struct in6_multi *in6m, const int type)
1780 {
1781         struct ifnet            *ifp;
1782         struct in6_ifaddr       *ia;
1783         struct ip6_hdr          *ip6;
1784         struct mbuf             *mh, *md;
1785         struct mld_hdr          *mld;
1786
1787         IN6_MULTI_LOCK_ASSERT();
1788         MLD_LOCK_ASSERT();
1789
1790         ifp = in6m->in6m_ifp;
1791         ia = in6ifa_ifpforlinklocal(ifp, IN6_IFF_NOTREADY|IN6_IFF_ANYCAST);
1792         /* ia may be NULL if link-local address is tentative. */
1793
1794         mh = m_gethdr(M_NOWAIT, MT_DATA);
1795         if (mh == NULL) {
1796                 if (ia != NULL)
1797                         ifa_free(&ia->ia_ifa);
1798                 return (ENOMEM);
1799         }
1800         md = m_get(M_NOWAIT, MT_DATA);
1801         if (md == NULL) {
1802                 m_free(mh);
1803                 if (ia != NULL)
1804                         ifa_free(&ia->ia_ifa);
1805                 return (ENOMEM);
1806         }
1807         mh->m_next = md;
1808
1809         /*
1810          * FUTURE: Consider increasing alignment by ETHER_HDR_LEN, so
1811          * that ether_output() does not need to allocate another mbuf
1812          * for the header in the most common case.
1813          */
1814         M_ALIGN(mh, sizeof(struct ip6_hdr));
1815         mh->m_pkthdr.len = sizeof(struct ip6_hdr) + sizeof(struct mld_hdr);
1816         mh->m_len = sizeof(struct ip6_hdr);
1817
1818         ip6 = mtod(mh, struct ip6_hdr *);
1819         ip6->ip6_flow = 0;
1820         ip6->ip6_vfc &= ~IPV6_VERSION_MASK;
1821         ip6->ip6_vfc |= IPV6_VERSION;
1822         ip6->ip6_nxt = IPPROTO_ICMPV6;
1823         ip6->ip6_src = ia ? ia->ia_addr.sin6_addr : in6addr_any;
1824         ip6->ip6_dst = in6m->in6m_addr;
1825
1826         md->m_len = sizeof(struct mld_hdr);
1827         mld = mtod(md, struct mld_hdr *);
1828         mld->mld_type = type;
1829         mld->mld_code = 0;
1830         mld->mld_cksum = 0;
1831         mld->mld_maxdelay = 0;
1832         mld->mld_reserved = 0;
1833         mld->mld_addr = in6m->in6m_addr;
1834         in6_clearscope(&mld->mld_addr);
1835         mld->mld_cksum = in6_cksum(mh, IPPROTO_ICMPV6,
1836             sizeof(struct ip6_hdr), sizeof(struct mld_hdr));
1837
1838         mld_save_context(mh, ifp);
1839         mh->m_flags |= M_MLDV1;
1840
1841         mld_dispatch_packet(mh);
1842
1843         if (ia != NULL)
1844                 ifa_free(&ia->ia_ifa);
1845         return (0);
1846 }
1847
1848 /*
1849  * Process a state change from the upper layer for the given IPv6 group.
1850  *
1851  * Each socket holds a reference on the in_multi in its own ip_moptions.
1852  * The socket layer will have made the necessary updates to.the group
1853  * state, it is now up to MLD to issue a state change report if there
1854  * has been any change between T0 (when the last state-change was issued)
1855  * and T1 (now).
1856  *
1857  * We use the MLDv2 state machine at group level. The MLd module
1858  * however makes the decision as to which MLD protocol version to speak.
1859  * A state change *from* INCLUDE {} always means an initial join.
1860  * A state change *to* INCLUDE {} always means a final leave.
1861  *
1862  * If delay is non-zero, and the state change is an initial multicast
1863  * join, the state change report will be delayed by 'delay' ticks
1864  * in units of PR_FASTHZ if MLDv1 is active on the link; otherwise
1865  * the initial MLDv2 state change report will be delayed by whichever
1866  * is sooner, a pending state-change timer or delay itself.
1867  *
1868  * VIMAGE: curvnet should have been set by caller, as this routine
1869  * is called from the socket option handlers.
1870  */
1871 int
1872 mld_change_state(struct in6_multi *inm, const int delay)
1873 {
1874         struct mld_ifsoftc *mli;
1875         struct ifnet *ifp;
1876         int error;
1877
1878         IN6_MULTI_LOCK_ASSERT();
1879
1880         error = 0;
1881
1882         /*
1883          * Try to detect if the upper layer just asked us to change state
1884          * for an interface which has now gone away.
1885          */
1886         KASSERT(inm->in6m_ifma != NULL, ("%s: no ifma", __func__));
1887         ifp = inm->in6m_ifma->ifma_ifp;
1888         if (ifp != NULL) {
1889                 /*
1890                  * Sanity check that netinet6's notion of ifp is the
1891                  * same as net's.
1892                  */
1893                 KASSERT(inm->in6m_ifp == ifp, ("%s: bad ifp", __func__));
1894         }
1895
1896         MLD_LOCK();
1897
1898         mli = MLD_IFINFO(ifp);
1899         KASSERT(mli != NULL, ("%s: no mld_ifsoftc for ifp %p", __func__, ifp));
1900
1901         /*
1902          * If we detect a state transition to or from MCAST_UNDEFINED
1903          * for this group, then we are starting or finishing an MLD
1904          * life cycle for this group.
1905          */
1906         if (inm->in6m_st[1].iss_fmode != inm->in6m_st[0].iss_fmode) {
1907                 CTR3(KTR_MLD, "%s: inm transition %d -> %d", __func__,
1908                     inm->in6m_st[0].iss_fmode, inm->in6m_st[1].iss_fmode);
1909                 if (inm->in6m_st[0].iss_fmode == MCAST_UNDEFINED) {
1910                         CTR1(KTR_MLD, "%s: initial join", __func__);
1911                         error = mld_initial_join(inm, mli, delay);
1912                         goto out_locked;
1913                 } else if (inm->in6m_st[1].iss_fmode == MCAST_UNDEFINED) {
1914                         CTR1(KTR_MLD, "%s: final leave", __func__);
1915                         mld_final_leave(inm, mli);
1916                         goto out_locked;
1917                 }
1918         } else {
1919                 CTR1(KTR_MLD, "%s: filter set change", __func__);
1920         }
1921
1922         error = mld_handle_state_change(inm, mli);
1923
1924 out_locked:
1925         MLD_UNLOCK();
1926         return (error);
1927 }
1928
1929 /*
1930  * Perform the initial join for an MLD group.
1931  *
1932  * When joining a group:
1933  *  If the group should have its MLD traffic suppressed, do nothing.
1934  *  MLDv1 starts sending MLDv1 host membership reports.
1935  *  MLDv2 will schedule an MLDv2 state-change report containing the
1936  *  initial state of the membership.
1937  *
1938  * If the delay argument is non-zero, then we must delay sending the
1939  * initial state change for delay ticks (in units of PR_FASTHZ).
1940  */
1941 static int
1942 mld_initial_join(struct in6_multi *inm, struct mld_ifsoftc *mli,
1943     const int delay)
1944 {
1945         struct ifnet            *ifp;
1946         struct mbufq            *mq;
1947         int                      error, retval, syncstates;
1948         int                      odelay;
1949 #ifdef KTR
1950         char                     ip6tbuf[INET6_ADDRSTRLEN];
1951 #endif
1952
1953         CTR4(KTR_MLD, "%s: initial join %s on ifp %p(%s)",
1954             __func__, ip6_sprintf(ip6tbuf, &inm->in6m_addr),
1955             inm->in6m_ifp, if_name(inm->in6m_ifp));
1956
1957         error = 0;
1958         syncstates = 1;
1959
1960         ifp = inm->in6m_ifp;
1961
1962         IN6_MULTI_LOCK_ASSERT();
1963         MLD_LOCK_ASSERT();
1964
1965         KASSERT(mli && mli->mli_ifp == ifp, ("%s: inconsistent ifp", __func__));
1966
1967         /*
1968          * Groups joined on loopback or marked as 'not reported',
1969          * enter the MLD_SILENT_MEMBER state and
1970          * are never reported in any protocol exchanges.
1971          * All other groups enter the appropriate state machine
1972          * for the version in use on this link.
1973          * A link marked as MLIF_SILENT causes MLD to be completely
1974          * disabled for the link.
1975          */
1976         if ((ifp->if_flags & IFF_LOOPBACK) ||
1977             (mli->mli_flags & MLIF_SILENT) ||
1978             !mld_is_addr_reported(&inm->in6m_addr)) {
1979                 CTR1(KTR_MLD,
1980 "%s: not kicking state machine for silent group", __func__);
1981                 inm->in6m_state = MLD_SILENT_MEMBER;
1982                 inm->in6m_timer = 0;
1983         } else {
1984                 /*
1985                  * Deal with overlapping in_multi lifecycle.
1986                  * If this group was LEAVING, then make sure
1987                  * we drop the reference we picked up to keep the
1988                  * group around for the final INCLUDE {} enqueue.
1989                  */
1990                 if (mli->mli_version == MLD_VERSION_2 &&
1991                     inm->in6m_state == MLD_LEAVING_MEMBER)
1992                         in6m_release_locked(inm);
1993
1994                 inm->in6m_state = MLD_REPORTING_MEMBER;
1995
1996                 switch (mli->mli_version) {
1997                 case MLD_VERSION_1:
1998                         /*
1999                          * If a delay was provided, only use it if
2000                          * it is greater than the delay normally
2001                          * used for an MLDv1 state change report,
2002                          * and delay sending the initial MLDv1 report
2003                          * by not transitioning to the IDLE state.
2004                          */
2005                         odelay = MLD_RANDOM_DELAY(MLD_V1_MAX_RI * PR_FASTHZ);
2006                         if (delay) {
2007                                 inm->in6m_timer = max(delay, odelay);
2008                                 V_current_state_timers_running6 = 1;
2009                         } else {
2010                                 inm->in6m_state = MLD_IDLE_MEMBER;
2011                                 error = mld_v1_transmit_report(inm,
2012                                      MLD_LISTENER_REPORT);
2013                                 if (error == 0) {
2014                                         inm->in6m_timer = odelay;
2015                                         V_current_state_timers_running6 = 1;
2016                                 }
2017                         }
2018                         break;
2019
2020                 case MLD_VERSION_2:
2021                         /*
2022                          * Defer update of T0 to T1, until the first copy
2023                          * of the state change has been transmitted.
2024                          */
2025                         syncstates = 0;
2026
2027                         /*
2028                          * Immediately enqueue a State-Change Report for
2029                          * this interface, freeing any previous reports.
2030                          * Don't kick the timers if there is nothing to do,
2031                          * or if an error occurred.
2032                          */
2033                         mq = &inm->in6m_scq;
2034                         mbufq_drain(mq);
2035                         retval = mld_v2_enqueue_group_record(mq, inm, 1,
2036                             0, 0, (mli->mli_flags & MLIF_USEALLOW));
2037                         CTR2(KTR_MLD, "%s: enqueue record = %d",
2038                             __func__, retval);
2039                         if (retval <= 0) {
2040                                 error = retval * -1;
2041                                 break;
2042                         }
2043
2044                         /*
2045                          * Schedule transmission of pending state-change
2046                          * report up to RV times for this link. The timer
2047                          * will fire at the next mld_fasttimo (~200ms),
2048                          * giving us an opportunity to merge the reports.
2049                          *
2050                          * If a delay was provided to this function, only
2051                          * use this delay if sooner than the existing one.
2052                          */
2053                         KASSERT(mli->mli_rv > 1,
2054                            ("%s: invalid robustness %d", __func__,
2055                             mli->mli_rv));
2056                         inm->in6m_scrv = mli->mli_rv;
2057                         if (delay) {
2058                                 if (inm->in6m_sctimer > 1) {
2059                                         inm->in6m_sctimer =
2060                                             min(inm->in6m_sctimer, delay);
2061                                 } else
2062                                         inm->in6m_sctimer = delay;
2063                         } else
2064                                 inm->in6m_sctimer = 1;
2065                         V_state_change_timers_running6 = 1;
2066
2067                         error = 0;
2068                         break;
2069                 }
2070         }
2071
2072         /*
2073          * Only update the T0 state if state change is atomic,
2074          * i.e. we don't need to wait for a timer to fire before we
2075          * can consider the state change to have been communicated.
2076          */
2077         if (syncstates) {
2078                 in6m_commit(inm);
2079                 CTR3(KTR_MLD, "%s: T1 -> T0 for %s/%s", __func__,
2080                     ip6_sprintf(ip6tbuf, &inm->in6m_addr),
2081                     if_name(inm->in6m_ifp));
2082         }
2083
2084         return (error);
2085 }
2086
2087 /*
2088  * Issue an intermediate state change during the life-cycle.
2089  */
2090 static int
2091 mld_handle_state_change(struct in6_multi *inm, struct mld_ifsoftc *mli)
2092 {
2093         struct ifnet            *ifp;
2094         int                      retval;
2095 #ifdef KTR
2096         char                     ip6tbuf[INET6_ADDRSTRLEN];
2097 #endif
2098
2099         CTR4(KTR_MLD, "%s: state change for %s on ifp %p(%s)",
2100             __func__, ip6_sprintf(ip6tbuf, &inm->in6m_addr),
2101             inm->in6m_ifp, if_name(inm->in6m_ifp));
2102
2103         ifp = inm->in6m_ifp;
2104
2105         IN6_MULTI_LOCK_ASSERT();
2106         MLD_LOCK_ASSERT();
2107
2108         KASSERT(mli && mli->mli_ifp == ifp,
2109             ("%s: inconsistent ifp", __func__));
2110
2111         if ((ifp->if_flags & IFF_LOOPBACK) ||
2112             (mli->mli_flags & MLIF_SILENT) ||
2113             !mld_is_addr_reported(&inm->in6m_addr) ||
2114             (mli->mli_version != MLD_VERSION_2)) {
2115                 if (!mld_is_addr_reported(&inm->in6m_addr)) {
2116                         CTR1(KTR_MLD,
2117 "%s: not kicking state machine for silent group", __func__);
2118                 }
2119                 CTR1(KTR_MLD, "%s: nothing to do", __func__);
2120                 in6m_commit(inm);
2121                 CTR3(KTR_MLD, "%s: T1 -> T0 for %s/%s", __func__,
2122                     ip6_sprintf(ip6tbuf, &inm->in6m_addr),
2123                     if_name(inm->in6m_ifp));
2124                 return (0);
2125         }
2126
2127         mbufq_drain(&inm->in6m_scq);
2128
2129         retval = mld_v2_enqueue_group_record(&inm->in6m_scq, inm, 1, 0, 0,
2130             (mli->mli_flags & MLIF_USEALLOW));
2131         CTR2(KTR_MLD, "%s: enqueue record = %d", __func__, retval);
2132         if (retval <= 0)
2133                 return (-retval);
2134
2135         /*
2136          * If record(s) were enqueued, start the state-change
2137          * report timer for this group.
2138          */
2139         inm->in6m_scrv = mli->mli_rv;
2140         inm->in6m_sctimer = 1;
2141         V_state_change_timers_running6 = 1;
2142
2143         return (0);
2144 }
2145
2146 /*
2147  * Perform the final leave for a multicast address.
2148  *
2149  * When leaving a group:
2150  *  MLDv1 sends a DONE message, if and only if we are the reporter.
2151  *  MLDv2 enqueues a state-change report containing a transition
2152  *  to INCLUDE {} for immediate transmission.
2153  */
2154 static void
2155 mld_final_leave(struct in6_multi *inm, struct mld_ifsoftc *mli)
2156 {
2157         int syncstates;
2158 #ifdef KTR
2159         char ip6tbuf[INET6_ADDRSTRLEN];
2160 #endif
2161
2162         syncstates = 1;
2163
2164         CTR4(KTR_MLD, "%s: final leave %s on ifp %p(%s)",
2165             __func__, ip6_sprintf(ip6tbuf, &inm->in6m_addr),
2166             inm->in6m_ifp, if_name(inm->in6m_ifp));
2167
2168         IN6_MULTI_LOCK_ASSERT();
2169         MLD_LOCK_ASSERT();
2170
2171         switch (inm->in6m_state) {
2172         case MLD_NOT_MEMBER:
2173         case MLD_SILENT_MEMBER:
2174         case MLD_LEAVING_MEMBER:
2175                 /* Already leaving or left; do nothing. */
2176                 CTR1(KTR_MLD,
2177 "%s: not kicking state machine for silent group", __func__);
2178                 break;
2179         case MLD_REPORTING_MEMBER:
2180         case MLD_IDLE_MEMBER:
2181         case MLD_G_QUERY_PENDING_MEMBER:
2182         case MLD_SG_QUERY_PENDING_MEMBER:
2183                 if (mli->mli_version == MLD_VERSION_1) {
2184 #ifdef INVARIANTS
2185                         if (inm->in6m_state == MLD_G_QUERY_PENDING_MEMBER ||
2186                             inm->in6m_state == MLD_SG_QUERY_PENDING_MEMBER)
2187                         panic("%s: MLDv2 state reached, not MLDv2 mode",
2188                              __func__);
2189 #endif
2190                         mld_v1_transmit_report(inm, MLD_LISTENER_DONE);
2191                         inm->in6m_state = MLD_NOT_MEMBER;
2192                         V_current_state_timers_running6 = 1;
2193                 } else if (mli->mli_version == MLD_VERSION_2) {
2194                         /*
2195                          * Stop group timer and all pending reports.
2196                          * Immediately enqueue a state-change report
2197                          * TO_IN {} to be sent on the next fast timeout,
2198                          * giving us an opportunity to merge reports.
2199                          */
2200                         mbufq_drain(&inm->in6m_scq);
2201                         inm->in6m_timer = 0;
2202                         inm->in6m_scrv = mli->mli_rv;
2203                         CTR4(KTR_MLD, "%s: Leaving %s/%s with %d "
2204                             "pending retransmissions.", __func__,
2205                             ip6_sprintf(ip6tbuf, &inm->in6m_addr),
2206                             if_name(inm->in6m_ifp), inm->in6m_scrv);
2207                         if (inm->in6m_scrv == 0) {
2208                                 inm->in6m_state = MLD_NOT_MEMBER;
2209                                 inm->in6m_sctimer = 0;
2210                         } else {
2211                                 int retval;
2212
2213                                 in6m_acquire_locked(inm);
2214
2215                                 retval = mld_v2_enqueue_group_record(
2216                                     &inm->in6m_scq, inm, 1, 0, 0,
2217                                     (mli->mli_flags & MLIF_USEALLOW));
2218                                 KASSERT(retval != 0,
2219                                     ("%s: enqueue record = %d", __func__,
2220                                      retval));
2221
2222                                 inm->in6m_state = MLD_LEAVING_MEMBER;
2223                                 inm->in6m_sctimer = 1;
2224                                 V_state_change_timers_running6 = 1;
2225                                 syncstates = 0;
2226                         }
2227                         break;
2228                 }
2229                 break;
2230         case MLD_LAZY_MEMBER:
2231         case MLD_SLEEPING_MEMBER:
2232         case MLD_AWAKENING_MEMBER:
2233                 /* Our reports are suppressed; do nothing. */
2234                 break;
2235         }
2236
2237         if (syncstates) {
2238                 in6m_commit(inm);
2239                 CTR3(KTR_MLD, "%s: T1 -> T0 for %s/%s", __func__,
2240                     ip6_sprintf(ip6tbuf, &inm->in6m_addr),
2241                     if_name(inm->in6m_ifp));
2242                 inm->in6m_st[1].iss_fmode = MCAST_UNDEFINED;
2243                 CTR3(KTR_MLD, "%s: T1 now MCAST_UNDEFINED for %p/%s",
2244                     __func__, &inm->in6m_addr, if_name(inm->in6m_ifp));
2245         }
2246 }
2247
2248 /*
2249  * Enqueue an MLDv2 group record to the given output queue.
2250  *
2251  * If is_state_change is zero, a current-state record is appended.
2252  * If is_state_change is non-zero, a state-change report is appended.
2253  *
2254  * If is_group_query is non-zero, an mbuf packet chain is allocated.
2255  * If is_group_query is zero, and if there is a packet with free space
2256  * at the tail of the queue, it will be appended to providing there
2257  * is enough free space.
2258  * Otherwise a new mbuf packet chain is allocated.
2259  *
2260  * If is_source_query is non-zero, each source is checked to see if
2261  * it was recorded for a Group-Source query, and will be omitted if
2262  * it is not both in-mode and recorded.
2263  *
2264  * If use_block_allow is non-zero, state change reports for initial join
2265  * and final leave, on an inclusive mode group with a source list, will be
2266  * rewritten to use the ALLOW_NEW and BLOCK_OLD record types, respectively.
2267  *
2268  * The function will attempt to allocate leading space in the packet
2269  * for the IPv6+ICMP headers to be prepended without fragmenting the chain.
2270  *
2271  * If successful the size of all data appended to the queue is returned,
2272  * otherwise an error code less than zero is returned, or zero if
2273  * no record(s) were appended.
2274  */
2275 static int
2276 mld_v2_enqueue_group_record(struct mbufq *mq, struct in6_multi *inm,
2277     const int is_state_change, const int is_group_query,
2278     const int is_source_query, const int use_block_allow)
2279 {
2280         struct mldv2_record      mr;
2281         struct mldv2_record     *pmr;
2282         struct ifnet            *ifp;
2283         struct ip6_msource      *ims, *nims;
2284         struct mbuf             *m0, *m, *md;
2285         int                      error, is_filter_list_change;
2286         int                      minrec0len, m0srcs, msrcs, nbytes, off;
2287         int                      record_has_sources;
2288         int                      now;
2289         int                      type;
2290         uint8_t                  mode;
2291 #ifdef KTR
2292         char                     ip6tbuf[INET6_ADDRSTRLEN];
2293 #endif
2294
2295         IN6_MULTI_LOCK_ASSERT();
2296
2297         error = 0;
2298         ifp = inm->in6m_ifp;
2299         is_filter_list_change = 0;
2300         m = NULL;
2301         m0 = NULL;
2302         m0srcs = 0;
2303         msrcs = 0;
2304         nbytes = 0;
2305         nims = NULL;
2306         record_has_sources = 1;
2307         pmr = NULL;
2308         type = MLD_DO_NOTHING;
2309         mode = inm->in6m_st[1].iss_fmode;
2310
2311         /*
2312          * If we did not transition out of ASM mode during t0->t1,
2313          * and there are no source nodes to process, we can skip
2314          * the generation of source records.
2315          */
2316         if (inm->in6m_st[0].iss_asm > 0 && inm->in6m_st[1].iss_asm > 0 &&
2317             inm->in6m_nsrc == 0)
2318                 record_has_sources = 0;
2319
2320         if (is_state_change) {
2321                 /*
2322                  * Queue a state change record.
2323                  * If the mode did not change, and there are non-ASM
2324                  * listeners or source filters present,
2325                  * we potentially need to issue two records for the group.
2326                  * If there are ASM listeners, and there was no filter
2327                  * mode transition of any kind, do nothing.
2328                  *
2329                  * If we are transitioning to MCAST_UNDEFINED, we need
2330                  * not send any sources. A transition to/from this state is
2331                  * considered inclusive with some special treatment.
2332                  *
2333                  * If we are rewriting initial joins/leaves to use
2334                  * ALLOW/BLOCK, and the group's membership is inclusive,
2335                  * we need to send sources in all cases.
2336                  */
2337                 if (mode != inm->in6m_st[0].iss_fmode) {
2338                         if (mode == MCAST_EXCLUDE) {
2339                                 CTR1(KTR_MLD, "%s: change to EXCLUDE",
2340                                     __func__);
2341                                 type = MLD_CHANGE_TO_EXCLUDE_MODE;
2342                         } else {
2343                                 CTR1(KTR_MLD, "%s: change to INCLUDE",
2344                                     __func__);
2345                                 if (use_block_allow) {
2346                                         /*
2347                                          * XXX
2348                                          * Here we're interested in state
2349                                          * edges either direction between
2350                                          * MCAST_UNDEFINED and MCAST_INCLUDE.
2351                                          * Perhaps we should just check
2352                                          * the group state, rather than
2353                                          * the filter mode.
2354                                          */
2355                                         if (mode == MCAST_UNDEFINED) {
2356                                                 type = MLD_BLOCK_OLD_SOURCES;
2357                                         } else {
2358                                                 type = MLD_ALLOW_NEW_SOURCES;
2359                                         }
2360                                 } else {
2361                                         type = MLD_CHANGE_TO_INCLUDE_MODE;
2362                                         if (mode == MCAST_UNDEFINED)
2363                                                 record_has_sources = 0;
2364                                 }
2365                         }
2366                 } else {
2367                         if (record_has_sources) {
2368                                 is_filter_list_change = 1;
2369                         } else {
2370                                 type = MLD_DO_NOTHING;
2371                         }
2372                 }
2373         } else {
2374                 /*
2375                  * Queue a current state record.
2376                  */
2377                 if (mode == MCAST_EXCLUDE) {
2378                         type = MLD_MODE_IS_EXCLUDE;
2379                 } else if (mode == MCAST_INCLUDE) {
2380                         type = MLD_MODE_IS_INCLUDE;
2381                         KASSERT(inm->in6m_st[1].iss_asm == 0,
2382                             ("%s: inm %p is INCLUDE but ASM count is %d",
2383                              __func__, inm, inm->in6m_st[1].iss_asm));
2384                 }
2385         }
2386
2387         /*
2388          * Generate the filter list changes using a separate function.
2389          */
2390         if (is_filter_list_change)
2391                 return (mld_v2_enqueue_filter_change(mq, inm));
2392
2393         if (type == MLD_DO_NOTHING) {
2394                 CTR3(KTR_MLD, "%s: nothing to do for %s/%s",
2395                     __func__, ip6_sprintf(ip6tbuf, &inm->in6m_addr),
2396                     if_name(inm->in6m_ifp));
2397                 return (0);
2398         }
2399
2400         /*
2401          * If any sources are present, we must be able to fit at least
2402          * one in the trailing space of the tail packet's mbuf,
2403          * ideally more.
2404          */
2405         minrec0len = sizeof(struct mldv2_record);
2406         if (record_has_sources)
2407                 minrec0len += sizeof(struct in6_addr);
2408
2409         CTR4(KTR_MLD, "%s: queueing %s for %s/%s", __func__,
2410             mld_rec_type_to_str(type),
2411             ip6_sprintf(ip6tbuf, &inm->in6m_addr),
2412             if_name(inm->in6m_ifp));
2413
2414         /*
2415          * Check if we have a packet in the tail of the queue for this
2416          * group into which the first group record for this group will fit.
2417          * Otherwise allocate a new packet.
2418          * Always allocate leading space for IP6+RA+ICMPV6+REPORT.
2419          * Note: Group records for G/GSR query responses MUST be sent
2420          * in their own packet.
2421          */
2422         m0 = mbufq_last(mq);
2423         if (!is_group_query &&
2424             m0 != NULL &&
2425             (m0->m_pkthdr.PH_vt.vt_nrecs + 1 <= MLD_V2_REPORT_MAXRECS) &&
2426             (m0->m_pkthdr.len + minrec0len) <
2427              (ifp->if_mtu - MLD_MTUSPACE)) {
2428                 m0srcs = (ifp->if_mtu - m0->m_pkthdr.len -
2429                             sizeof(struct mldv2_record)) /
2430                             sizeof(struct in6_addr);
2431                 m = m0;
2432                 CTR1(KTR_MLD, "%s: use existing packet", __func__);
2433         } else {
2434                 if (mbufq_full(mq)) {
2435                         CTR1(KTR_MLD, "%s: outbound queue full", __func__);
2436                         return (-ENOMEM);
2437                 }
2438                 m = NULL;
2439                 m0srcs = (ifp->if_mtu - MLD_MTUSPACE -
2440                     sizeof(struct mldv2_record)) / sizeof(struct in6_addr);
2441                 if (!is_state_change && !is_group_query)
2442                         m = m_getcl(M_NOWAIT, MT_DATA, M_PKTHDR);
2443                 if (m == NULL)
2444                         m = m_gethdr(M_NOWAIT, MT_DATA);
2445                 if (m == NULL)
2446                         return (-ENOMEM);
2447
2448                 mld_save_context(m, ifp);
2449
2450                 CTR1(KTR_MLD, "%s: allocated first packet", __func__);
2451         }
2452
2453         /*
2454          * Append group record.
2455          * If we have sources, we don't know how many yet.
2456          */
2457         mr.mr_type = type;
2458         mr.mr_datalen = 0;
2459         mr.mr_numsrc = 0;
2460         mr.mr_addr = inm->in6m_addr;
2461         in6_clearscope(&mr.mr_addr);
2462         if (!m_append(m, sizeof(struct mldv2_record), (void *)&mr)) {
2463                 if (m != m0)
2464                         m_freem(m);
2465                 CTR1(KTR_MLD, "%s: m_append() failed.", __func__);
2466                 return (-ENOMEM);
2467         }
2468         nbytes += sizeof(struct mldv2_record);
2469
2470         /*
2471          * Append as many sources as will fit in the first packet.
2472          * If we are appending to a new packet, the chain allocation
2473          * may potentially use clusters; use m_getptr() in this case.
2474          * If we are appending to an existing packet, we need to obtain
2475          * a pointer to the group record after m_append(), in case a new
2476          * mbuf was allocated.
2477          *
2478          * Only append sources which are in-mode at t1. If we are
2479          * transitioning to MCAST_UNDEFINED state on the group, and
2480          * use_block_allow is zero, do not include source entries.
2481          * Otherwise, we need to include this source in the report.
2482          *
2483          * Only report recorded sources in our filter set when responding
2484          * to a group-source query.
2485          */
2486         if (record_has_sources) {
2487                 if (m == m0) {
2488                         md = m_last(m);
2489                         pmr = (struct mldv2_record *)(mtod(md, uint8_t *) +
2490                             md->m_len - nbytes);
2491                 } else {
2492                         md = m_getptr(m, 0, &off);
2493                         pmr = (struct mldv2_record *)(mtod(md, uint8_t *) +
2494                             off);
2495                 }
2496                 msrcs = 0;
2497                 RB_FOREACH_SAFE(ims, ip6_msource_tree, &inm->in6m_srcs,
2498                     nims) {
2499                         CTR2(KTR_MLD, "%s: visit node %s", __func__,
2500                             ip6_sprintf(ip6tbuf, &ims->im6s_addr));
2501                         now = im6s_get_mode(inm, ims, 1);
2502                         CTR2(KTR_MLD, "%s: node is %d", __func__, now);
2503                         if ((now != mode) ||
2504                             (now == mode &&
2505                              (!use_block_allow && mode == MCAST_UNDEFINED))) {
2506                                 CTR1(KTR_MLD, "%s: skip node", __func__);
2507                                 continue;
2508                         }
2509                         if (is_source_query && ims->im6s_stp == 0) {
2510                                 CTR1(KTR_MLD, "%s: skip unrecorded node",
2511                                     __func__);
2512                                 continue;
2513                         }
2514                         CTR1(KTR_MLD, "%s: append node", __func__);
2515                         if (!m_append(m, sizeof(struct in6_addr),
2516                             (void *)&ims->im6s_addr)) {
2517                                 if (m != m0)
2518                                         m_freem(m);
2519                                 CTR1(KTR_MLD, "%s: m_append() failed.",
2520                                     __func__);
2521                                 return (-ENOMEM);
2522                         }
2523                         nbytes += sizeof(struct in6_addr);
2524                         ++msrcs;
2525                         if (msrcs == m0srcs)
2526                                 break;
2527                 }
2528                 CTR2(KTR_MLD, "%s: msrcs is %d this packet", __func__,
2529                     msrcs);
2530                 pmr->mr_numsrc = htons(msrcs);
2531                 nbytes += (msrcs * sizeof(struct in6_addr));
2532         }
2533
2534         if (is_source_query && msrcs == 0) {
2535                 CTR1(KTR_MLD, "%s: no recorded sources to report", __func__);
2536                 if (m != m0)
2537                         m_freem(m);
2538                 return (0);
2539         }
2540
2541         /*
2542          * We are good to go with first packet.
2543          */
2544         if (m != m0) {
2545                 CTR1(KTR_MLD, "%s: enqueueing first packet", __func__);
2546                 m->m_pkthdr.PH_vt.vt_nrecs = 1;
2547                 mbufq_enqueue(mq, m);
2548         } else
2549                 m->m_pkthdr.PH_vt.vt_nrecs++;
2550
2551         /*
2552          * No further work needed if no source list in packet(s).
2553          */
2554         if (!record_has_sources)
2555                 return (nbytes);
2556
2557         /*
2558          * Whilst sources remain to be announced, we need to allocate
2559          * a new packet and fill out as many sources as will fit.
2560          * Always try for a cluster first.
2561          */
2562         while (nims != NULL) {
2563                 if (mbufq_full(mq)) {
2564                         CTR1(KTR_MLD, "%s: outbound queue full", __func__);
2565                         return (-ENOMEM);
2566                 }
2567                 m = m_getcl(M_NOWAIT, MT_DATA, M_PKTHDR);
2568                 if (m == NULL)
2569                         m = m_gethdr(M_NOWAIT, MT_DATA);
2570                 if (m == NULL)
2571                         return (-ENOMEM);
2572                 mld_save_context(m, ifp);
2573                 md = m_getptr(m, 0, &off);
2574                 pmr = (struct mldv2_record *)(mtod(md, uint8_t *) + off);
2575                 CTR1(KTR_MLD, "%s: allocated next packet", __func__);
2576
2577                 if (!m_append(m, sizeof(struct mldv2_record), (void *)&mr)) {
2578                         if (m != m0)
2579                                 m_freem(m);
2580                         CTR1(KTR_MLD, "%s: m_append() failed.", __func__);
2581                         return (-ENOMEM);
2582                 }
2583                 m->m_pkthdr.PH_vt.vt_nrecs = 1;
2584                 nbytes += sizeof(struct mldv2_record);
2585
2586                 m0srcs = (ifp->if_mtu - MLD_MTUSPACE -
2587                     sizeof(struct mldv2_record)) / sizeof(struct in6_addr);
2588
2589                 msrcs = 0;
2590                 RB_FOREACH_FROM(ims, ip6_msource_tree, nims) {
2591                         CTR2(KTR_MLD, "%s: visit node %s",
2592                             __func__, ip6_sprintf(ip6tbuf, &ims->im6s_addr));
2593                         now = im6s_get_mode(inm, ims, 1);
2594                         if ((now != mode) ||
2595                             (now == mode &&
2596                              (!use_block_allow && mode == MCAST_UNDEFINED))) {
2597                                 CTR1(KTR_MLD, "%s: skip node", __func__);
2598                                 continue;
2599                         }
2600                         if (is_source_query && ims->im6s_stp == 0) {
2601                                 CTR1(KTR_MLD, "%s: skip unrecorded node",
2602                                     __func__);
2603                                 continue;
2604                         }
2605                         CTR1(KTR_MLD, "%s: append node", __func__);
2606                         if (!m_append(m, sizeof(struct in6_addr),
2607                             (void *)&ims->im6s_addr)) {
2608                                 if (m != m0)
2609                                         m_freem(m);
2610                                 CTR1(KTR_MLD, "%s: m_append() failed.",
2611                                     __func__);
2612                                 return (-ENOMEM);
2613                         }
2614                         ++msrcs;
2615                         if (msrcs == m0srcs)
2616                                 break;
2617                 }
2618                 pmr->mr_numsrc = htons(msrcs);
2619                 nbytes += (msrcs * sizeof(struct in6_addr));
2620
2621                 CTR1(KTR_MLD, "%s: enqueueing next packet", __func__);
2622                 mbufq_enqueue(mq, m);
2623         }
2624
2625         return (nbytes);
2626 }
2627
2628 /*
2629  * Type used to mark record pass completion.
2630  * We exploit the fact we can cast to this easily from the
2631  * current filter modes on each ip_msource node.
2632  */
2633 typedef enum {
2634         REC_NONE = 0x00,        /* MCAST_UNDEFINED */
2635         REC_ALLOW = 0x01,       /* MCAST_INCLUDE */
2636         REC_BLOCK = 0x02,       /* MCAST_EXCLUDE */
2637         REC_FULL = REC_ALLOW | REC_BLOCK
2638 } rectype_t;
2639
2640 /*
2641  * Enqueue an MLDv2 filter list change to the given output queue.
2642  *
2643  * Source list filter state is held in an RB-tree. When the filter list
2644  * for a group is changed without changing its mode, we need to compute
2645  * the deltas between T0 and T1 for each source in the filter set,
2646  * and enqueue the appropriate ALLOW_NEW/BLOCK_OLD records.
2647  *
2648  * As we may potentially queue two record types, and the entire R-B tree
2649  * needs to be walked at once, we break this out into its own function
2650  * so we can generate a tightly packed queue of packets.
2651  *
2652  * XXX This could be written to only use one tree walk, although that makes
2653  * serializing into the mbuf chains a bit harder. For now we do two walks
2654  * which makes things easier on us, and it may or may not be harder on
2655  * the L2 cache.
2656  *
2657  * If successful the size of all data appended to the queue is returned,
2658  * otherwise an error code less than zero is returned, or zero if
2659  * no record(s) were appended.
2660  */
2661 static int
2662 mld_v2_enqueue_filter_change(struct mbufq *mq, struct in6_multi *inm)
2663 {
2664         static const int MINRECLEN =
2665             sizeof(struct mldv2_record) + sizeof(struct in6_addr);
2666         struct ifnet            *ifp;
2667         struct mldv2_record      mr;
2668         struct mldv2_record     *pmr;
2669         struct ip6_msource      *ims, *nims;
2670         struct mbuf             *m, *m0, *md;
2671         int                      m0srcs, nbytes, npbytes, off, rsrcs, schanged;
2672         int                      nallow, nblock;
2673         uint8_t                  mode, now, then;
2674         rectype_t                crt, drt, nrt;
2675 #ifdef KTR
2676         char                     ip6tbuf[INET6_ADDRSTRLEN];
2677 #endif
2678
2679         IN6_MULTI_LOCK_ASSERT();
2680
2681         if (inm->in6m_nsrc == 0 ||
2682             (inm->in6m_st[0].iss_asm > 0 && inm->in6m_st[1].iss_asm > 0))
2683                 return (0);
2684
2685         ifp = inm->in6m_ifp;                    /* interface */
2686         mode = inm->in6m_st[1].iss_fmode;       /* filter mode at t1 */
2687         crt = REC_NONE; /* current group record type */
2688         drt = REC_NONE; /* mask of completed group record types */
2689         nrt = REC_NONE; /* record type for current node */
2690         m0srcs = 0;     /* # source which will fit in current mbuf chain */
2691         npbytes = 0;    /* # of bytes appended this packet */
2692         nbytes = 0;     /* # of bytes appended to group's state-change queue */
2693         rsrcs = 0;      /* # sources encoded in current record */
2694         schanged = 0;   /* # nodes encoded in overall filter change */
2695         nallow = 0;     /* # of source entries in ALLOW_NEW */
2696         nblock = 0;     /* # of source entries in BLOCK_OLD */
2697         nims = NULL;    /* next tree node pointer */
2698
2699         /*
2700          * For each possible filter record mode.
2701          * The first kind of source we encounter tells us which
2702          * is the first kind of record we start appending.
2703          * If a node transitioned to UNDEFINED at t1, its mode is treated
2704          * as the inverse of the group's filter mode.
2705          */
2706         while (drt != REC_FULL) {
2707                 do {
2708                         m0 = mbufq_last(mq);
2709                         if (m0 != NULL &&
2710                             (m0->m_pkthdr.PH_vt.vt_nrecs + 1 <=
2711                              MLD_V2_REPORT_MAXRECS) &&
2712                             (m0->m_pkthdr.len + MINRECLEN) <
2713                              (ifp->if_mtu - MLD_MTUSPACE)) {
2714                                 m = m0;
2715                                 m0srcs = (ifp->if_mtu - m0->m_pkthdr.len -
2716                                             sizeof(struct mldv2_record)) /
2717                                             sizeof(struct in6_addr);
2718                                 CTR1(KTR_MLD,
2719                                     "%s: use previous packet", __func__);
2720                         } else {
2721                                 m = m_getcl(M_NOWAIT, MT_DATA, M_PKTHDR);
2722                                 if (m == NULL)
2723                                         m = m_gethdr(M_NOWAIT, MT_DATA);
2724                                 if (m == NULL) {
2725                                         CTR1(KTR_MLD,
2726                                             "%s: m_get*() failed", __func__);
2727                                         return (-ENOMEM);
2728                                 }
2729                                 m->m_pkthdr.PH_vt.vt_nrecs = 0;
2730                                 mld_save_context(m, ifp);
2731                                 m0srcs = (ifp->if_mtu - MLD_MTUSPACE -
2732                                     sizeof(struct mldv2_record)) /
2733                                     sizeof(struct in6_addr);
2734                                 npbytes = 0;
2735                                 CTR1(KTR_MLD,
2736                                     "%s: allocated new packet", __func__);
2737                         }
2738                         /*
2739                          * Append the MLD group record header to the
2740                          * current packet's data area.
2741                          * Recalculate pointer to free space for next
2742                          * group record, in case m_append() allocated
2743                          * a new mbuf or cluster.
2744                          */
2745                         memset(&mr, 0, sizeof(mr));
2746                         mr.mr_addr = inm->in6m_addr;
2747                         in6_clearscope(&mr.mr_addr);
2748                         if (!m_append(m, sizeof(mr), (void *)&mr)) {
2749                                 if (m != m0)
2750                                         m_freem(m);
2751                                 CTR1(KTR_MLD,
2752                                     "%s: m_append() failed", __func__);
2753                                 return (-ENOMEM);
2754                         }
2755                         npbytes += sizeof(struct mldv2_record);
2756                         if (m != m0) {
2757                                 /* new packet; offset in chain */
2758                                 md = m_getptr(m, npbytes -
2759                                     sizeof(struct mldv2_record), &off);
2760                                 pmr = (struct mldv2_record *)(mtod(md,
2761                                     uint8_t *) + off);
2762                         } else {
2763                                 /* current packet; offset from last append */
2764                                 md = m_last(m);
2765                                 pmr = (struct mldv2_record *)(mtod(md,
2766                                     uint8_t *) + md->m_len -
2767                                     sizeof(struct mldv2_record));
2768                         }
2769                         /*
2770                          * Begin walking the tree for this record type
2771                          * pass, or continue from where we left off
2772                          * previously if we had to allocate a new packet.
2773                          * Only report deltas in-mode at t1.
2774                          * We need not report included sources as allowed
2775                          * if we are in inclusive mode on the group,
2776                          * however the converse is not true.
2777                          */
2778                         rsrcs = 0;
2779                         if (nims == NULL) {
2780                                 nims = RB_MIN(ip6_msource_tree,
2781                                     &inm->in6m_srcs);
2782                         }
2783                         RB_FOREACH_FROM(ims, ip6_msource_tree, nims) {
2784                                 CTR2(KTR_MLD, "%s: visit node %s", __func__,
2785                                     ip6_sprintf(ip6tbuf, &ims->im6s_addr));
2786                                 now = im6s_get_mode(inm, ims, 1);
2787                                 then = im6s_get_mode(inm, ims, 0);
2788                                 CTR3(KTR_MLD, "%s: mode: t0 %d, t1 %d",
2789                                     __func__, then, now);
2790                                 if (now == then) {
2791                                         CTR1(KTR_MLD,
2792                                             "%s: skip unchanged", __func__);
2793                                         continue;
2794                                 }
2795                                 if (mode == MCAST_EXCLUDE &&
2796                                     now == MCAST_INCLUDE) {
2797                                         CTR1(KTR_MLD,
2798                                             "%s: skip IN src on EX group",
2799                                             __func__);
2800                                         continue;
2801                                 }
2802                                 nrt = (rectype_t)now;
2803                                 if (nrt == REC_NONE)
2804                                         nrt = (rectype_t)(~mode & REC_FULL);
2805                                 if (schanged++ == 0) {
2806                                         crt = nrt;
2807                                 } else if (crt != nrt)
2808                                         continue;
2809                                 if (!m_append(m, sizeof(struct in6_addr),
2810                                     (void *)&ims->im6s_addr)) {
2811                                         if (m != m0)
2812                                                 m_freem(m);
2813                                         CTR1(KTR_MLD,
2814                                             "%s: m_append() failed", __func__);
2815                                         return (-ENOMEM);
2816                                 }
2817                                 nallow += !!(crt == REC_ALLOW);
2818                                 nblock += !!(crt == REC_BLOCK);
2819                                 if (++rsrcs == m0srcs)
2820                                         break;
2821                         }
2822                         /*
2823                          * If we did not append any tree nodes on this
2824                          * pass, back out of allocations.
2825                          */
2826                         if (rsrcs == 0) {
2827                                 npbytes -= sizeof(struct mldv2_record);
2828                                 if (m != m0) {
2829                                         CTR1(KTR_MLD,
2830                                             "%s: m_free(m)", __func__);
2831                                         m_freem(m);
2832                                 } else {
2833                                         CTR1(KTR_MLD,
2834                                             "%s: m_adj(m, -mr)", __func__);
2835                                         m_adj(m, -((int)sizeof(
2836                                             struct mldv2_record)));
2837                                 }
2838                                 continue;
2839                         }
2840                         npbytes += (rsrcs * sizeof(struct in6_addr));
2841                         if (crt == REC_ALLOW)
2842                                 pmr->mr_type = MLD_ALLOW_NEW_SOURCES;
2843                         else if (crt == REC_BLOCK)
2844                                 pmr->mr_type = MLD_BLOCK_OLD_SOURCES;
2845                         pmr->mr_numsrc = htons(rsrcs);
2846                         /*
2847                          * Count the new group record, and enqueue this
2848                          * packet if it wasn't already queued.
2849                          */
2850                         m->m_pkthdr.PH_vt.vt_nrecs++;
2851                         if (m != m0)
2852                                 mbufq_enqueue(mq, m);
2853                         nbytes += npbytes;
2854                 } while (nims != NULL);
2855                 drt |= crt;
2856                 crt = (~crt & REC_FULL);
2857         }
2858
2859         CTR3(KTR_MLD, "%s: queued %d ALLOW_NEW, %d BLOCK_OLD", __func__,
2860             nallow, nblock);
2861
2862         return (nbytes);
2863 }
2864
2865 static int
2866 mld_v2_merge_state_changes(struct in6_multi *inm, struct mbufq *scq)
2867 {
2868         struct mbufq    *gq;
2869         struct mbuf     *m;             /* pending state-change */
2870         struct mbuf     *m0;            /* copy of pending state-change */
2871         struct mbuf     *mt;            /* last state-change in packet */
2872         int              docopy, domerge;
2873         u_int            recslen;
2874
2875         docopy = 0;
2876         domerge = 0;
2877         recslen = 0;
2878
2879         IN6_MULTI_LOCK_ASSERT();
2880         MLD_LOCK_ASSERT();
2881
2882         /*
2883          * If there are further pending retransmissions, make a writable
2884          * copy of each queued state-change message before merging.
2885          */
2886         if (inm->in6m_scrv > 0)
2887                 docopy = 1;
2888
2889         gq = &inm->in6m_scq;
2890 #ifdef KTR
2891         if (mbufq_first(gq) == NULL) {
2892                 CTR2(KTR_MLD, "%s: WARNING: queue for inm %p is empty",
2893                     __func__, inm);
2894         }
2895 #endif
2896
2897         m = mbufq_first(gq);
2898         while (m != NULL) {
2899                 /*
2900                  * Only merge the report into the current packet if
2901                  * there is sufficient space to do so; an MLDv2 report
2902                  * packet may only contain 65,535 group records.
2903                  * Always use a simple mbuf chain concatentation to do this,
2904                  * as large state changes for single groups may have
2905                  * allocated clusters.
2906                  */
2907                 domerge = 0;
2908                 mt = mbufq_last(scq);
2909                 if (mt != NULL) {
2910                         recslen = m_length(m, NULL);
2911
2912                         if ((mt->m_pkthdr.PH_vt.vt_nrecs +
2913                             m->m_pkthdr.PH_vt.vt_nrecs <=
2914                             MLD_V2_REPORT_MAXRECS) &&
2915                             (mt->m_pkthdr.len + recslen <=
2916                             (inm->in6m_ifp->if_mtu - MLD_MTUSPACE)))
2917                                 domerge = 1;
2918                 }
2919
2920                 if (!domerge && mbufq_full(gq)) {
2921                         CTR2(KTR_MLD,
2922                             "%s: outbound queue full, skipping whole packet %p",
2923                             __func__, m);
2924                         mt = m->m_nextpkt;
2925                         if (!docopy)
2926                                 m_freem(m);
2927                         m = mt;
2928                         continue;
2929                 }
2930
2931                 if (!docopy) {
2932                         CTR2(KTR_MLD, "%s: dequeueing %p", __func__, m);
2933                         m0 = mbufq_dequeue(gq);
2934                         m = m0->m_nextpkt;
2935                 } else {
2936                         CTR2(KTR_MLD, "%s: copying %p", __func__, m);
2937                         m0 = m_dup(m, M_NOWAIT);
2938                         if (m0 == NULL)
2939                                 return (ENOMEM);
2940                         m0->m_nextpkt = NULL;
2941                         m = m->m_nextpkt;
2942                 }
2943
2944                 if (!domerge) {
2945                         CTR3(KTR_MLD, "%s: queueing %p to scq %p)",
2946                             __func__, m0, scq);
2947                         mbufq_enqueue(scq, m0);
2948                 } else {
2949                         struct mbuf *mtl;       /* last mbuf of packet mt */
2950
2951                         CTR3(KTR_MLD, "%s: merging %p with ifscq tail %p)",
2952                             __func__, m0, mt);
2953
2954                         mtl = m_last(mt);
2955                         m0->m_flags &= ~M_PKTHDR;
2956                         mt->m_pkthdr.len += recslen;
2957                         mt->m_pkthdr.PH_vt.vt_nrecs +=
2958                             m0->m_pkthdr.PH_vt.vt_nrecs;
2959
2960                         mtl->m_next = m0;
2961                 }
2962         }
2963
2964         return (0);
2965 }
2966
2967 /*
2968  * Respond to a pending MLDv2 General Query.
2969  */
2970 static void
2971 mld_v2_dispatch_general_query(struct mld_ifsoftc *mli)
2972 {
2973         struct ifmultiaddr      *ifma;
2974         struct ifnet            *ifp;
2975         struct in6_multi        *inm;
2976         int                      retval;
2977
2978         IN6_MULTI_LOCK_ASSERT();
2979         MLD_LOCK_ASSERT();
2980
2981         KASSERT(mli->mli_version == MLD_VERSION_2,
2982             ("%s: called when version %d", __func__, mli->mli_version));
2983
2984         /*
2985          * Check that there are some packets queued. If so, send them first.
2986          * For large number of groups the reply to general query can take
2987          * many packets, we should finish sending them before starting of
2988          * queuing the new reply.
2989          */
2990         if (mbufq_len(&mli->mli_gq) != 0)
2991                 goto send;
2992
2993         ifp = mli->mli_ifp;
2994
2995         IF_ADDR_RLOCK(ifp);
2996         TAILQ_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link) {
2997                 if (ifma->ifma_addr->sa_family != AF_INET6 ||
2998                     ifma->ifma_protospec == NULL)
2999                         continue;
3000
3001                 inm = (struct in6_multi *)ifma->ifma_protospec;
3002                 KASSERT(ifp == inm->in6m_ifp,
3003                     ("%s: inconsistent ifp", __func__));
3004
3005                 switch (inm->in6m_state) {
3006                 case MLD_NOT_MEMBER:
3007                 case MLD_SILENT_MEMBER:
3008                         break;
3009                 case MLD_REPORTING_MEMBER:
3010                 case MLD_IDLE_MEMBER:
3011                 case MLD_LAZY_MEMBER:
3012                 case MLD_SLEEPING_MEMBER:
3013                 case MLD_AWAKENING_MEMBER:
3014                         inm->in6m_state = MLD_REPORTING_MEMBER;
3015                         retval = mld_v2_enqueue_group_record(&mli->mli_gq,
3016                             inm, 0, 0, 0, 0);
3017                         CTR2(KTR_MLD, "%s: enqueue record = %d",
3018                             __func__, retval);
3019                         break;
3020                 case MLD_G_QUERY_PENDING_MEMBER:
3021                 case MLD_SG_QUERY_PENDING_MEMBER:
3022                 case MLD_LEAVING_MEMBER:
3023                         break;
3024                 }
3025         }
3026         IF_ADDR_RUNLOCK(ifp);
3027
3028 send:
3029         mld_dispatch_queue(&mli->mli_gq, MLD_MAX_RESPONSE_BURST);
3030
3031         /*
3032          * Slew transmission of bursts over 500ms intervals.
3033          */
3034         if (mbufq_first(&mli->mli_gq) != NULL) {
3035                 mli->mli_v2_timer = 1 + MLD_RANDOM_DELAY(
3036                     MLD_RESPONSE_BURST_INTERVAL);
3037                 V_interface_timers_running6 = 1;
3038         }
3039 }
3040
3041 /*
3042  * Transmit the next pending message in the output queue.
3043  *
3044  * VIMAGE: Needs to store/restore vnet pointer on a per-mbuf-chain basis.
3045  * MRT: Nothing needs to be done, as MLD traffic is always local to
3046  * a link and uses a link-scope multicast address.
3047  */
3048 static void
3049 mld_dispatch_packet(struct mbuf *m)
3050 {
3051         struct ip6_moptions      im6o;
3052         struct ifnet            *ifp;
3053         struct ifnet            *oifp;
3054         struct mbuf             *m0;
3055         struct mbuf             *md;
3056         struct ip6_hdr          *ip6;
3057         struct mld_hdr          *mld;
3058         int                      error;
3059         int                      off;
3060         int                      type;
3061         uint32_t                 ifindex;
3062
3063         CTR2(KTR_MLD, "%s: transmit %p", __func__, m);
3064
3065         /*
3066          * Set VNET image pointer from enqueued mbuf chain
3067          * before doing anything else. Whilst we use interface
3068          * indexes to guard against interface detach, they are
3069          * unique to each VIMAGE and must be retrieved.
3070          */
3071         ifindex = mld_restore_context(m);
3072
3073         /*
3074          * Check if the ifnet still exists. This limits the scope of
3075          * any race in the absence of a global ifp lock for low cost
3076          * (an array lookup).
3077          */
3078         ifp = ifnet_byindex(ifindex);
3079         if (ifp == NULL) {
3080                 CTR3(KTR_MLD, "%s: dropped %p as ifindex %u went away.",
3081                     __func__, m, ifindex);
3082                 m_freem(m);
3083                 IP6STAT_INC(ip6s_noroute);
3084                 goto out;
3085         }
3086
3087         im6o.im6o_multicast_hlim  = 1;
3088         im6o.im6o_multicast_loop = (V_ip6_mrouter != NULL);
3089         im6o.im6o_multicast_ifp = ifp;
3090
3091         if (m->m_flags & M_MLDV1) {
3092                 m0 = m;
3093         } else {
3094                 m0 = mld_v2_encap_report(ifp, m);
3095                 if (m0 == NULL) {
3096                         CTR2(KTR_MLD, "%s: dropped %p", __func__, m);
3097                         IP6STAT_INC(ip6s_odropped);
3098                         goto out;
3099                 }
3100         }
3101
3102         mld_scrub_context(m0);
3103         m_clrprotoflags(m);
3104         m0->m_pkthdr.rcvif = V_loif;
3105
3106         ip6 = mtod(m0, struct ip6_hdr *);
3107 #if 0
3108         (void)in6_setscope(&ip6->ip6_dst, ifp, NULL);   /* XXX LOR */
3109 #else
3110         /*
3111          * XXX XXX Break some KPI rules to prevent an LOR which would
3112          * occur if we called in6_setscope() at transmission.
3113          * See comments at top of file.
3114          */
3115         MLD_EMBEDSCOPE(&ip6->ip6_dst, ifp->if_index);
3116 #endif
3117
3118         /*
3119          * Retrieve the ICMPv6 type before handoff to ip6_output(),
3120          * so we can bump the stats.
3121          */
3122         md = m_getptr(m0, sizeof(struct ip6_hdr), &off);
3123         mld = (struct mld_hdr *)(mtod(md, uint8_t *) + off);
3124         type = mld->mld_type;
3125
3126         error = ip6_output(m0, &mld_po, NULL, IPV6_UNSPECSRC, &im6o,
3127             &oifp, NULL);
3128         if (error) {
3129                 CTR3(KTR_MLD, "%s: ip6_output(%p) = %d", __func__, m0, error);
3130                 goto out;
3131         }
3132         ICMP6STAT_INC(icp6s_outhist[type]);
3133         if (oifp != NULL) {
3134                 icmp6_ifstat_inc(oifp, ifs6_out_msg);
3135                 switch (type) {
3136                 case MLD_LISTENER_REPORT:
3137                 case MLDV2_LISTENER_REPORT:
3138                         icmp6_ifstat_inc(oifp, ifs6_out_mldreport);
3139                         break;
3140                 case MLD_LISTENER_DONE:
3141                         icmp6_ifstat_inc(oifp, ifs6_out_mlddone);
3142                         break;
3143                 }
3144         }
3145 out:
3146         return;
3147 }
3148
3149 /*
3150  * Encapsulate an MLDv2 report.
3151  *
3152  * KAME IPv6 requires that hop-by-hop options be passed separately,
3153  * and that the IPv6 header be prepended in a separate mbuf.
3154  *
3155  * Returns a pointer to the new mbuf chain head, or NULL if the
3156  * allocation failed.
3157  */
3158 static struct mbuf *
3159 mld_v2_encap_report(struct ifnet *ifp, struct mbuf *m)
3160 {
3161         struct mbuf             *mh;
3162         struct mldv2_report     *mld;
3163         struct ip6_hdr          *ip6;
3164         struct in6_ifaddr       *ia;
3165         int                      mldreclen;
3166
3167         KASSERT(ifp != NULL, ("%s: null ifp", __func__));
3168         KASSERT((m->m_flags & M_PKTHDR),
3169             ("%s: mbuf chain %p is !M_PKTHDR", __func__, m));
3170
3171         /*
3172          * RFC3590: OK to send as :: or tentative during DAD.
3173          */
3174         ia = in6ifa_ifpforlinklocal(ifp, IN6_IFF_NOTREADY|IN6_IFF_ANYCAST);
3175         if (ia == NULL)
3176                 CTR1(KTR_MLD, "%s: warning: ia is NULL", __func__);
3177
3178         mh = m_gethdr(M_NOWAIT, MT_DATA);
3179         if (mh == NULL) {
3180                 if (ia != NULL)
3181                         ifa_free(&ia->ia_ifa);
3182                 m_freem(m);
3183                 return (NULL);
3184         }
3185         M_ALIGN(mh, sizeof(struct ip6_hdr) + sizeof(struct mldv2_report));
3186
3187         mldreclen = m_length(m, NULL);
3188         CTR2(KTR_MLD, "%s: mldreclen is %d", __func__, mldreclen);
3189
3190         mh->m_len = sizeof(struct ip6_hdr) + sizeof(struct mldv2_report);
3191         mh->m_pkthdr.len = sizeof(struct ip6_hdr) +
3192             sizeof(struct mldv2_report) + mldreclen;
3193
3194         ip6 = mtod(mh, struct ip6_hdr *);
3195         ip6->ip6_flow = 0;
3196         ip6->ip6_vfc &= ~IPV6_VERSION_MASK;
3197         ip6->ip6_vfc |= IPV6_VERSION;
3198         ip6->ip6_nxt = IPPROTO_ICMPV6;
3199         ip6->ip6_src = ia ? ia->ia_addr.sin6_addr : in6addr_any;
3200         if (ia != NULL)
3201                 ifa_free(&ia->ia_ifa);
3202         ip6->ip6_dst = in6addr_linklocal_allv2routers;
3203         /* scope ID will be set in netisr */
3204
3205         mld = (struct mldv2_report *)(ip6 + 1);
3206         mld->mld_type = MLDV2_LISTENER_REPORT;
3207         mld->mld_code = 0;
3208         mld->mld_cksum = 0;
3209         mld->mld_v2_reserved = 0;
3210         mld->mld_v2_numrecs = htons(m->m_pkthdr.PH_vt.vt_nrecs);
3211         m->m_pkthdr.PH_vt.vt_nrecs = 0;
3212
3213         mh->m_next = m;
3214         mld->mld_cksum = in6_cksum(mh, IPPROTO_ICMPV6,
3215             sizeof(struct ip6_hdr), sizeof(struct mldv2_report) + mldreclen);
3216         return (mh);
3217 }
3218
3219 #ifdef KTR
3220 static char *
3221 mld_rec_type_to_str(const int type)
3222 {
3223
3224         switch (type) {
3225                 case MLD_CHANGE_TO_EXCLUDE_MODE:
3226                         return "TO_EX";
3227                         break;
3228                 case MLD_CHANGE_TO_INCLUDE_MODE:
3229                         return "TO_IN";
3230                         break;
3231                 case MLD_MODE_IS_EXCLUDE:
3232                         return "MODE_EX";
3233                         break;
3234                 case MLD_MODE_IS_INCLUDE:
3235                         return "MODE_IN";
3236                         break;
3237                 case MLD_ALLOW_NEW_SOURCES:
3238                         return "ALLOW_NEW";
3239                         break;
3240                 case MLD_BLOCK_OLD_SOURCES:
3241                         return "BLOCK_OLD";
3242                         break;
3243                 default:
3244                         break;
3245         }
3246         return "unknown";
3247 }
3248 #endif
3249
3250 static void
3251 mld_init(void *unused __unused)
3252 {
3253
3254         CTR1(KTR_MLD, "%s: initializing", __func__);
3255         MLD_LOCK_INIT();
3256
3257         ip6_initpktopts(&mld_po);
3258         mld_po.ip6po_hlim = 1;
3259         mld_po.ip6po_hbh = &mld_ra.hbh;
3260         mld_po.ip6po_prefer_tempaddr = IP6PO_TEMPADDR_NOTPREFER;
3261         mld_po.ip6po_flags = IP6PO_DONTFRAG;
3262 }
3263 SYSINIT(mld_init, SI_SUB_PROTO_MC, SI_ORDER_MIDDLE, mld_init, NULL);
3264
3265 static void
3266 mld_uninit(void *unused __unused)
3267 {
3268
3269         CTR1(KTR_MLD, "%s: tearing down", __func__);
3270         MLD_LOCK_DESTROY();
3271 }
3272 SYSUNINIT(mld_uninit, SI_SUB_PROTO_MC, SI_ORDER_MIDDLE, mld_uninit, NULL);
3273
3274 static void
3275 vnet_mld_init(const void *unused __unused)
3276 {
3277
3278         CTR1(KTR_MLD, "%s: initializing", __func__);
3279
3280         LIST_INIT(&V_mli_head);
3281 }
3282 VNET_SYSINIT(vnet_mld_init, SI_SUB_PROTO_MC, SI_ORDER_ANY, vnet_mld_init,
3283     NULL);
3284
3285 static void
3286 vnet_mld_uninit(const void *unused __unused)
3287 {
3288
3289         /* This can happen if we shutdown the network stack. */
3290         CTR1(KTR_MLD, "%s: tearing down", __func__);
3291 }
3292 VNET_SYSUNINIT(vnet_mld_uninit, SI_SUB_PROTO_MC, SI_ORDER_ANY, vnet_mld_uninit,
3293     NULL);
3294
3295 static int
3296 mld_modevent(module_t mod, int type, void *unused __unused)
3297 {
3298
3299     switch (type) {
3300     case MOD_LOAD:
3301     case MOD_UNLOAD:
3302         break;
3303     default:
3304         return (EOPNOTSUPP);
3305     }
3306     return (0);
3307 }
3308
3309 static moduledata_t mld_mod = {
3310     "mld",
3311     mld_modevent,
3312     0
3313 };
3314 DECLARE_MODULE(mld, mld_mod, SI_SUB_PROTO_MC, SI_ORDER_ANY);