sys/netinet/igmp.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 2007-2009 Bruce Simpson.
   5  * Copyright (c) 1988 Stephen Deering.
   6  * Copyright (c) 1992, 1993
   7  *      The Regents of the University of California.  All rights reserved.
   8  *
   9  * This code is derived from software contributed to Berkeley by
  10  * Stephen Deering of Stanford University.
  11  *
  12  * Redistribution and use in source and binary forms, with or without
  13  * modification, are permitted provided that the following conditions
  14  * are met:
  15  * 1. Redistributions of source code must retain the above copyright
  16  *    notice, this list of conditions and the following disclaimer.
  17  * 2. Redistributions in binary form must reproduce the above copyright
  18  *    notice, this list of conditions and the following disclaimer in the
  19  *    documentation and/or other materials provided with the distribution.
  20  * 3. Neither the name of the University nor the names of its contributors
  21  *    may be used to endorse or promote products derived from this software
  22  *    without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34  * SUCH DAMAGE.
  35  *
  36  *      @(#)igmp.c      8.1 (Berkeley) 7/19/93
  37  */
  38
  39 /*
  40  * Internet Group Management Protocol (IGMP) routines.
  41  * [RFC1112, RFC2236, RFC3376]
  42  *
  43  * Written by Steve Deering, Stanford, May 1988.
  44  * Modified by Rosen Sharma, Stanford, Aug 1994.
  45  * Modified by Bill Fenner, Xerox PARC, Feb 1995.
  46  * Modified to fully comply to IGMPv2 by Bill Fenner, Oct 1995.
  47  * Significantly rewritten for IGMPv3, VIMAGE, and SMP by Bruce Simpson.
  48  *
  49  * MULTICAST Revision: 3.5.1.4
  50  */
  51
  52 #include <sys/cdefs.h>
  53 __FBSDID("$FreeBSD$");
  54
  55 #include "opt_ddb.h"
  56
  57 #include <sys/param.h>
  58 #include <sys/systm.h>
  59 #include <sys/module.h>
  60 #include <sys/malloc.h>
  61 #include <sys/mbuf.h>
  62 #include <sys/socket.h>
  63 #include <sys/protosw.h>
  64 #include <sys/kernel.h>
  65 #include <sys/lock.h>
  66 #include <sys/rmlock.h>
  67 #include <sys/sysctl.h>
  68 #include <sys/ktr.h>
  69 #include <sys/condvar.h>
  70
  71 #ifdef DDB
  72 #include <ddb/ddb.h>
  73 #endif
  74
  75 #include <net/if.h>
  76 #include <net/if_var.h>
  77 #include <net/netisr.h>
  78 #include <net/vnet.h>
  79
  80 #include <netinet/in.h>
  81 #include <netinet/in_var.h>
  82 #include <netinet/in_systm.h>
  83 #include <netinet/ip.h>
  84 #include <netinet/ip_var.h>
  85 #include <netinet/ip_options.h>
  86 #include <netinet/igmp.h>
  87 #include <netinet/igmp_var.h>
  88
  89 #include <machine/in_cksum.h>
  90
  91 #include <security/mac/mac_framework.h>
  92
  93 #ifndef KTR_IGMPV3
  94 #define KTR_IGMPV3 KTR_INET
  95 #endif
  96
  97 static struct igmp_ifsoftc *
  98                 igi_alloc_locked(struct ifnet *);
  99 static void     igi_delete_locked(const struct ifnet *);
 100 static void     igmp_dispatch_queue(struct mbufq *, int, const int);
 101 static void     igmp_fasttimo_vnet(void);
 102 static void     igmp_final_leave(struct in_multi *, struct igmp_ifsoftc *);
 103 static int      igmp_handle_state_change(struct in_multi *,
 104                     struct igmp_ifsoftc *);
 105 static int      igmp_initial_join(struct in_multi *, struct igmp_ifsoftc *);
 106 static int      igmp_input_v1_query(struct ifnet *, const struct ip *,
 107                     const struct igmp *);
 108 static int      igmp_input_v2_query(struct ifnet *, const struct ip *,
 109                     const struct igmp *);
 110 static int      igmp_input_v3_query(struct ifnet *, const struct ip *,
 111                     /*const*/ struct igmpv3 *);
 112 static int      igmp_input_v3_group_query(struct in_multi *,
 113                     struct igmp_ifsoftc *, int, /*const*/ struct igmpv3 *);
 114 static int      igmp_input_v1_report(struct ifnet *, /*const*/ struct ip *,
 115                     /*const*/ struct igmp *);
 116 static int      igmp_input_v2_report(struct ifnet *, /*const*/ struct ip *,
 117                     /*const*/ struct igmp *);
 118 static void     igmp_intr(struct mbuf *);
 119 static int      igmp_isgroupreported(const struct in_addr);
 120 static struct mbuf *
 121                 igmp_ra_alloc(void);
 122 #ifdef KTR
 123 static char *   igmp_rec_type_to_str(const int);
 124 #endif
 125 static void     igmp_set_version(struct igmp_ifsoftc *, const int);
 126 static void     igmp_slowtimo_vnet(void);
 127 static int      igmp_v1v2_queue_report(struct in_multi *, const int);
 128 static void     igmp_v1v2_process_group_timer(struct in_multi *, const int);
 129 static void     igmp_v1v2_process_querier_timers(struct igmp_ifsoftc *);
 130 static void     igmp_v2_update_group(struct in_multi *, const int);
 131 static void     igmp_v3_cancel_link_timers(struct igmp_ifsoftc *);
 132 static void     igmp_v3_dispatch_general_query(struct igmp_ifsoftc *);
 133 static struct mbuf *
 134                 igmp_v3_encap_report(struct ifnet *, struct mbuf *);
 135 static int      igmp_v3_enqueue_group_record(struct mbufq *,
 136                     struct in_multi *, const int, const int, const int);
 137 static int      igmp_v3_enqueue_filter_change(struct mbufq *,
 138                     struct in_multi *);
 139 static void     igmp_v3_process_group_timers(struct in_multi_head *,
 140                     struct mbufq *, struct mbufq *, struct in_multi *,
 141                     const int);
 142 static int      igmp_v3_merge_state_changes(struct in_multi *,
 143                     struct mbufq *);
 144 static void     igmp_v3_suppress_group_record(struct in_multi *);
 145 static int      sysctl_igmp_default_version(SYSCTL_HANDLER_ARGS);
 146 static int      sysctl_igmp_gsr(SYSCTL_HANDLER_ARGS);
 147 static int      sysctl_igmp_ifinfo(SYSCTL_HANDLER_ARGS);
 148 static int      sysctl_igmp_stat(SYSCTL_HANDLER_ARGS);
 149
 150 static const struct netisr_handler igmp_nh = {
 151         .nh_name = "igmp",
 152         .nh_handler = igmp_intr,
 153         .nh_proto = NETISR_IGMP,
 154         .nh_policy = NETISR_POLICY_SOURCE,
 155 };
 156
 157 /*
 158  * System-wide globals.
 159  *
 160  * Unlocked access to these is OK, except for the global IGMP output
 161  * queue. The IGMP subsystem lock ends up being system-wide for the moment,
 162  * because all VIMAGEs have to share a global output queue, as netisrs
 163  * themselves are not virtualized.
 164  *
 165  * Locking:
 166  *  * The permitted lock order is: IN_MULTI_LIST_LOCK, IGMP_LOCK, IF_ADDR_LOCK.
 167  *    Any may be taken independently; if any are held at the same
 168  *    time, the above lock order must be followed.
 169  *  * All output is delegated to the netisr.
 170  *    Now that Giant has been eliminated, the netisr may be inlined.
 171  *  * IN_MULTI_LIST_LOCK covers in_multi.
 172  *  * IGMP_LOCK covers igmp_ifsoftc and any global variables in this file,
 173  *    including the output queue.
 174  *  * IF_ADDR_LOCK covers if_multiaddrs, which is used for a variety of
 175  *    per-link state iterators.
 176  *  * igmp_ifsoftc is valid as long as PF_INET is attached to the interface,
 177  *    therefore it is not refcounted.
 178  *    We allow unlocked reads of igmp_ifsoftc when accessed via in_multi.
 179  *
 180  * Reference counting
 181  *  * IGMP acquires its own reference every time an in_multi is passed to
 182  *    it and the group is being joined for the first time.
 183  *  * IGMP releases its reference(s) on in_multi in a deferred way,
 184  *    because the operations which process the release run as part of
 185  *    a loop whose control variables are directly affected by the release
 186  *    (that, and not recursing on the IF_ADDR_LOCK).
 187  *
 188  * VIMAGE: Each in_multi corresponds to an ifp, and each ifp corresponds
 189  * to a vnet in ifp->if_vnet.
 190  *
 191  * SMPng: XXX We may potentially race operations on ifma_protospec.
 192  * The problem is that we currently lack a clean way of taking the
 193  * IF_ADDR_LOCK() between the ifnet and in layers w/o recursing,
 194  * as anything which modifies ifma needs to be covered by that lock.
 195  * So check for ifma_protospec being NULL before proceeding.
 196  */
 197 struct mtx               igmp_mtx;
 198
 199 struct mbuf             *m_raopt;                /* Router Alert option */
 200 static MALLOC_DEFINE(M_IGMP, "igmp", "igmp state");
 201
 202 /*
 203  * VIMAGE-wide globals.
 204  *
 205  * The IGMPv3 timers themselves need to run per-image, however,
 206  * protosw timers run globally (see tcp).
 207  * An ifnet can only be in one vimage at a time, and the loopback
 208  * ifnet, loif, is itself virtualized.
 209  * It would otherwise be possible to seriously hose IGMP state,
 210  * and create inconsistencies in upstream multicast routing, if you have
 211  * multiple VIMAGEs running on the same link joining different multicast
 212  * groups, UNLESS the "primary IP address" is different. This is because
 213  * IGMP for IPv4 does not force link-local addresses to be used for each
 214  * node, unlike MLD for IPv6.
 215  * Obviously the IGMPv3 per-interface state has per-vimage granularity
 216  * also as a result.
 217  *
 218  * FUTURE: Stop using IFP_TO_IA/INADDR_ANY, and use source address selection
 219  * policy to control the address used by IGMP on the link.
 220  */
 221 VNET_DEFINE_STATIC(int, interface_timers_running);      /* IGMPv3 general
 222                                                          * query response */
 223 VNET_DEFINE_STATIC(int, state_change_timers_running);   /* IGMPv3 state-change
 224                                                          * retransmit */
 225 VNET_DEFINE_STATIC(int, current_state_timers_running);  /* IGMPv1/v2 host
 226                                                          * report; IGMPv3 g/sg
 227                                                          * query response */
 228
 229 #define V_interface_timers_running      VNET(interface_timers_running)
 230 #define V_state_change_timers_running   VNET(state_change_timers_running)
 231 #define V_current_state_timers_running  VNET(current_state_timers_running)
 232
 233 VNET_DEFINE_STATIC(LIST_HEAD(, igmp_ifsoftc), igi_head) =
 234     LIST_HEAD_INITIALIZER(igi_head);
 235 VNET_DEFINE_STATIC(struct igmpstat, igmpstat) = {
 236         .igps_version = IGPS_VERSION_3,
 237         .igps_len = sizeof(struct igmpstat),
 238 };
 239 VNET_DEFINE_STATIC(struct timeval, igmp_gsrdelay) = {10, 0};
 240
 241 #define V_igi_head                      VNET(igi_head)
 242 #define V_igmpstat                      VNET(igmpstat)
 243 #define V_igmp_gsrdelay                 VNET(igmp_gsrdelay)
 244
 245 VNET_DEFINE_STATIC(int, igmp_recvifkludge) = 1;
 246 VNET_DEFINE_STATIC(int, igmp_sendra) = 1;
 247 VNET_DEFINE_STATIC(int, igmp_sendlocal) = 1;
 248 VNET_DEFINE_STATIC(int, igmp_v1enable) = 1;
 249 VNET_DEFINE_STATIC(int, igmp_v2enable) = 1;
 250 VNET_DEFINE_STATIC(int, igmp_legacysupp);
 251 VNET_DEFINE_STATIC(int, igmp_default_version) = IGMP_VERSION_3;
 252
 253 #define V_igmp_recvifkludge             VNET(igmp_recvifkludge)
 254 #define V_igmp_sendra                   VNET(igmp_sendra)
 255 #define V_igmp_sendlocal                VNET(igmp_sendlocal)
 256 #define V_igmp_v1enable                 VNET(igmp_v1enable)
 257 #define V_igmp_v2enable                 VNET(igmp_v2enable)
 258 #define V_igmp_legacysupp               VNET(igmp_legacysupp)
 259 #define V_igmp_default_version          VNET(igmp_default_version)
 260
 261 /*
 262  * Virtualized sysctls.
 263  */
 264 SYSCTL_PROC(_net_inet_igmp, IGMPCTL_STATS, stats,
 265     CTLFLAG_VNET | CTLTYPE_STRUCT | CTLFLAG_RW | CTLFLAG_MPSAFE,
 266     &VNET_NAME(igmpstat), 0, sysctl_igmp_stat, "S,igmpstat", "");
 267 SYSCTL_INT(_net_inet_igmp, OID_AUTO, recvifkludge, CTLFLAG_VNET | CTLFLAG_RW,
 268     &VNET_NAME(igmp_recvifkludge), 0,
 269     "Rewrite IGMPv1/v2 reports from 0.0.0.0 to contain subnet address");
 270 SYSCTL_INT(_net_inet_igmp, OID_AUTO, sendra, CTLFLAG_VNET | CTLFLAG_RW,
 271     &VNET_NAME(igmp_sendra), 0,
 272     "Send IP Router Alert option in IGMPv2/v3 messages");
 273 SYSCTL_INT(_net_inet_igmp, OID_AUTO, sendlocal, CTLFLAG_VNET | CTLFLAG_RW,
 274     &VNET_NAME(igmp_sendlocal), 0,
 275     "Send IGMP membership reports for 224.0.0.0/24 groups");
 276 SYSCTL_INT(_net_inet_igmp, OID_AUTO, v1enable, CTLFLAG_VNET | CTLFLAG_RW,
 277     &VNET_NAME(igmp_v1enable), 0,
 278     "Enable backwards compatibility with IGMPv1");
 279 SYSCTL_INT(_net_inet_igmp, OID_AUTO, v2enable, CTLFLAG_VNET | CTLFLAG_RW,
 280     &VNET_NAME(igmp_v2enable), 0,
 281     "Enable backwards compatibility with IGMPv2");
 282 SYSCTL_INT(_net_inet_igmp, OID_AUTO, legacysupp, CTLFLAG_VNET | CTLFLAG_RW,
 283     &VNET_NAME(igmp_legacysupp), 0,
 284     "Allow v1/v2 reports to suppress v3 group responses");
 285 SYSCTL_PROC(_net_inet_igmp, OID_AUTO, default_version,
 286     CTLFLAG_VNET | CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_MPSAFE,
 287     &VNET_NAME(igmp_default_version), 0, sysctl_igmp_default_version, "I",
 288     "Default version of IGMP to run on each interface");
 289 SYSCTL_PROC(_net_inet_igmp, OID_AUTO, gsrdelay,
 290     CTLFLAG_VNET | CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_MPSAFE,
 291     &VNET_NAME(igmp_gsrdelay.tv_sec), 0, sysctl_igmp_gsr, "I",
 292     "Rate limit for IGMPv3 Group-and-Source queries in seconds");
 293
 294 /*
 295  * Non-virtualized sysctls.
 296  */
 297 static SYSCTL_NODE(_net_inet_igmp, OID_AUTO, ifinfo,
 298     CTLFLAG_RD | CTLFLAG_MPSAFE, sysctl_igmp_ifinfo,
 299     "Per-interface IGMPv3 state");
 300
 301 static __inline void
 302 igmp_save_context(struct mbuf *m, struct ifnet *ifp)
 303 {
 304
 305 #ifdef VIMAGE
 306         m->m_pkthdr.PH_loc.ptr = ifp->if_vnet;
 307 #endif /* VIMAGE */
 308         m->m_pkthdr.rcvif = ifp;
 309         m->m_pkthdr.flowid = ifp->if_index;
 310 }
 311
 312 static __inline void
 313 igmp_scrub_context(struct mbuf *m)
 314 {
 315
 316         m->m_pkthdr.PH_loc.ptr = NULL;
 317         m->m_pkthdr.flowid = 0;
 318 }
 319
 320 /*
 321  * Restore context from a queued IGMP output chain.
 322  * Return saved ifindex.
 323  *
 324  * VIMAGE: The assertion is there to make sure that we
 325  * actually called CURVNET_SET() with what's in the mbuf chain.
 326  */
 327 static __inline uint32_t
 328 igmp_restore_context(struct mbuf *m)
 329 {
 330
 331 #ifdef notyet
 332 #if defined(VIMAGE) && defined(INVARIANTS)
 333         KASSERT(curvnet == (m->m_pkthdr.PH_loc.ptr),
 334             ("%s: called when curvnet was not restored", __func__));
 335 #endif
 336 #endif
 337         return (m->m_pkthdr.flowid);
 338 }
 339
 340 /*
 341  * IGMP statistics.
 342  */
 343 static int
 344 sysctl_igmp_stat(SYSCTL_HANDLER_ARGS)
 345 {
 346         struct igmpstat igps0;
 347         int error;
 348         char *p;
 349
 350         error = sysctl_wire_old_buffer(req, sizeof(V_igmpstat));
 351         if (error)
 352                 return (error);
 353
 354         if (req->oldptr != NULL) {
 355                 if (req->oldlen < sizeof(V_igmpstat))
 356                         error = ENOMEM;
 357                 else
 358                         error = SYSCTL_OUT(req, &V_igmpstat,
 359                             sizeof(V_igmpstat));
 360         } else
 361                 req->validlen = sizeof(V_igmpstat);
 362         if (error)
 363                 goto out;
 364         if (req->newptr != NULL) {
 365                 if (req->newlen < sizeof(V_igmpstat))
 366                         error = ENOMEM;
 367                 else
 368                         error = SYSCTL_IN(req, &igps0,
 369                             sizeof(igps0));
 370                 if (error)
 371                         goto out;
 372                 /*
 373                  * igps0 must be "all zero".
 374                  */
 375                 p = (char *)&igps0;
 376                 while (*p == '\0' && p < (char *)&igps0 + sizeof(igps0))
 377                         p++;
 378                 if (p != (char *)&igps0 + sizeof(igps0)) {
 379                         error = EINVAL;
 380                         goto out;
 381                 }
 382                 /*
 383                  * Avoid overwrite of the version and length field.
 384                  */
 385                 igps0.igps_version = V_igmpstat.igps_version;
 386                 igps0.igps_len = V_igmpstat.igps_len;
 387                 bcopy(&igps0, &V_igmpstat, sizeof(V_igmpstat));
 388         }
 389 out:
 390         return (error);
 391 }
 392
 393 /*
 394  * Retrieve or set default IGMP version.
 395  *
 396  * VIMAGE: Assume curvnet set by caller.
 397  * SMPng: NOTE: Serialized by IGMP lock.
 398  */
 399 static int
 400 sysctl_igmp_default_version(SYSCTL_HANDLER_ARGS)
 401 {
 402         int      error;
 403         int      new;
 404
 405         error = sysctl_wire_old_buffer(req, sizeof(int));
 406         if (error)
 407                 return (error);
 408
 409         IGMP_LOCK();
 410
 411         new = V_igmp_default_version;
 412
 413         error = sysctl_handle_int(oidp, &new, 0, req);
 414         if (error || !req->newptr)
 415                 goto out_locked;
 416
 417         if (new < IGMP_VERSION_1 || new > IGMP_VERSION_3) {
 418                 error = EINVAL;
 419                 goto out_locked;
 420         }
 421
 422         CTR2(KTR_IGMPV3, "change igmp_default_version from %d to %d",
 423              V_igmp_default_version, new);
 424
 425         V_igmp_default_version = new;
 426
 427 out_locked:
 428         IGMP_UNLOCK();
 429         return (error);
 430 }
 431
 432 /*
 433  * Retrieve or set threshold between group-source queries in seconds.
 434  *
 435  * VIMAGE: Assume curvnet set by caller.
 436  * SMPng: NOTE: Serialized by IGMP lock.
 437  */
 438 static int
 439 sysctl_igmp_gsr(SYSCTL_HANDLER_ARGS)
 440 {
 441         int error;
 442         int i;
 443
 444         error = sysctl_wire_old_buffer(req, sizeof(int));
 445         if (error)
 446                 return (error);
 447
 448         IGMP_LOCK();
 449
 450         i = V_igmp_gsrdelay.tv_sec;
 451
 452         error = sysctl_handle_int(oidp, &i, 0, req);
 453         if (error || !req->newptr)
 454                 goto out_locked;
 455
 456         if (i < -1 || i >= 60) {
 457                 error = EINVAL;
 458                 goto out_locked;
 459         }
 460
 461         CTR2(KTR_IGMPV3, "change igmp_gsrdelay from %d to %d",
 462              V_igmp_gsrdelay.tv_sec, i);
 463         V_igmp_gsrdelay.tv_sec = i;
 464
 465 out_locked:
 466         IGMP_UNLOCK();
 467         return (error);
 468 }
 469
 470 /*
 471  * Expose struct igmp_ifsoftc to userland, keyed by ifindex.
 472  * For use by ifmcstat(8).
 473  *
 474  * SMPng: NOTE: Does an unlocked ifindex space read.
 475  * VIMAGE: Assume curvnet set by caller. The node handler itself
 476  * is not directly virtualized.
 477  */
 478 static int
 479 sysctl_igmp_ifinfo(SYSCTL_HANDLER_ARGS)
 480 {
 481         int                     *name;
 482         int                      error;
 483         u_int                    namelen;
 484         struct ifnet            *ifp;
 485         struct igmp_ifsoftc     *igi;
 486
 487         name = (int *)arg1;
 488         namelen = arg2;
 489
 490         if (req->newptr != NULL)
 491                 return (EPERM);
 492
 493         if (namelen != 1)
 494                 return (EINVAL);
 495
 496         error = sysctl_wire_old_buffer(req, sizeof(struct igmp_ifinfo));
 497         if (error)
 498                 return (error);
 499
 500         IN_MULTI_LIST_LOCK();
 501         IGMP_LOCK();
 502
 503         if (name[0] <= 0 || name[0] > V_if_index) {
 504                 error = ENOENT;
 505                 goto out_locked;
 506         }
 507
 508         error = ENOENT;
 509
 510         ifp = ifnet_byindex(name[0]);
 511         if (ifp == NULL)
 512                 goto out_locked;
 513
 514         LIST_FOREACH(igi, &V_igi_head, igi_link) {
 515                 if (ifp == igi->igi_ifp) {
 516                         struct igmp_ifinfo info;
 517
 518                         info.igi_version = igi->igi_version;
 519                         info.igi_v1_timer = igi->igi_v1_timer;
 520                         info.igi_v2_timer = igi->igi_v2_timer;
 521                         info.igi_v3_timer = igi->igi_v3_timer;
 522                         info.igi_flags = igi->igi_flags;
 523                         info.igi_rv = igi->igi_rv;
 524                         info.igi_qi = igi->igi_qi;
 525                         info.igi_qri = igi->igi_qri;
 526                         info.igi_uri = igi->igi_uri;
 527                         error = SYSCTL_OUT(req, &info, sizeof(info));
 528                         break;
 529                 }
 530         }
 531
 532 out_locked:
 533         IGMP_UNLOCK();
 534         IN_MULTI_LIST_UNLOCK();
 535         return (error);
 536 }
 537
 538 /*
 539  * Dispatch an entire queue of pending packet chains
 540  * using the netisr.
 541  * VIMAGE: Assumes the vnet pointer has been set.
 542  */
 543 static void
 544 igmp_dispatch_queue(struct mbufq *mq, int limit, const int loop)
 545 {
 546         struct epoch_tracker et;
 547         struct mbuf *m;
 548
 549         NET_EPOCH_ENTER(et);
 550         while ((m = mbufq_dequeue(mq)) != NULL) {
 551                 CTR3(KTR_IGMPV3, "%s: dispatch %p from %p", __func__, mq, m);
 552                 if (loop)
 553                         m->m_flags |= M_IGMP_LOOP;
 554                 netisr_dispatch(NETISR_IGMP, m);
 555                 if (--limit == 0)
 556                         break;
 557         }
 558         NET_EPOCH_EXIT(et);
 559 }
 560
 561 /*
 562  * Filter outgoing IGMP report state by group.
 563  *
 564  * Reports are ALWAYS suppressed for ALL-HOSTS (224.0.0.1).
 565  * If the net.inet.igmp.sendlocal sysctl is 0, then IGMP reports are
 566  * disabled for all groups in the 224.0.0.0/24 link-local scope. However,
 567  * this may break certain IGMP snooping switches which rely on the old
 568  * report behaviour.
 569  *
 570  * Return zero if the given group is one for which IGMP reports
 571  * should be suppressed, or non-zero if reports should be issued.
 572  */
 573 static __inline int
 574 igmp_isgroupreported(const struct in_addr addr)
 575 {
 576
 577         if (in_allhosts(addr) ||
 578             ((!V_igmp_sendlocal && IN_LOCAL_GROUP(ntohl(addr.s_addr)))))
 579                 return (0);
 580
 581         return (1);
 582 }
 583
 584 /*
 585  * Construct a Router Alert option to use in outgoing packets.
 586  */
 587 static struct mbuf *
 588 igmp_ra_alloc(void)
 589 {
 590         struct mbuf     *m;
 591         struct ipoption *p;
 592
 593         m = m_get(M_WAITOK, MT_DATA);
 594         p = mtod(m, struct ipoption *);
 595         p->ipopt_dst.s_addr = INADDR_ANY;
 596         p->ipopt_list[0] = (char)IPOPT_RA;      /* Router Alert Option */
 597         p->ipopt_list[1] = 0x04;                /* 4 bytes long */
 598         p->ipopt_list[2] = IPOPT_EOL;           /* End of IP option list */
 599         p->ipopt_list[3] = 0x00;                /* pad byte */
 600         m->m_len = sizeof(p->ipopt_dst) + p->ipopt_list[1];
 601
 602         return (m);
 603 }
 604
 605 /*
 606  * Attach IGMP when PF_INET is attached to an interface.
 607  */
 608 struct igmp_ifsoftc *
 609 igmp_domifattach(struct ifnet *ifp)
 610 {
 611         struct igmp_ifsoftc *igi;
 612
 613         CTR3(KTR_IGMPV3, "%s: called for ifp %p(%s)",
 614             __func__, ifp, ifp->if_xname);
 615
 616         IGMP_LOCK();
 617
 618         igi = igi_alloc_locked(ifp);
 619         if (!(ifp->if_flags & IFF_MULTICAST))
 620                 igi->igi_flags |= IGIF_SILENT;
 621
 622         IGMP_UNLOCK();
 623
 624         return (igi);
 625 }
 626
 627 /*
 628  * VIMAGE: assume curvnet set by caller.
 629  */
 630 static struct igmp_ifsoftc *
 631 igi_alloc_locked(/*const*/ struct ifnet *ifp)
 632 {
 633         struct igmp_ifsoftc *igi;
 634
 635         IGMP_LOCK_ASSERT();
 636
 637         igi = malloc(sizeof(struct igmp_ifsoftc), M_IGMP, M_NOWAIT|M_ZERO);
 638         if (igi == NULL)
 639                 goto out;
 640
 641         igi->igi_ifp = ifp;
 642         igi->igi_version = V_igmp_default_version;
 643         igi->igi_flags = 0;
 644         igi->igi_rv = IGMP_RV_INIT;
 645         igi->igi_qi = IGMP_QI_INIT;
 646         igi->igi_qri = IGMP_QRI_INIT;
 647         igi->igi_uri = IGMP_URI_INIT;
 648         mbufq_init(&igi->igi_gq, IGMP_MAX_RESPONSE_PACKETS);
 649
 650         LIST_INSERT_HEAD(&V_igi_head, igi, igi_link);
 651
 652         CTR2(KTR_IGMPV3, "allocate igmp_ifsoftc for ifp %p(%s)",
 653              ifp, ifp->if_xname);
 654
 655 out:
 656         return (igi);
 657 }
 658
 659 /*
 660  * Hook for ifdetach.
 661  *
 662  * NOTE: Some finalization tasks need to run before the protocol domain
 663  * is detached, but also before the link layer does its cleanup.
 664  *
 665  * SMPNG: igmp_ifdetach() needs to take IF_ADDR_LOCK().
 666  * XXX This is also bitten by unlocked ifma_protospec access.
 667  */
 668 void
 669 igmp_ifdetach(struct ifnet *ifp)
 670 {
 671         struct igmp_ifsoftc     *igi;
 672         struct ifmultiaddr      *ifma, *next;
 673         struct in_multi         *inm;
 674         struct in_multi_head inm_free_tmp;
 675         CTR3(KTR_IGMPV3, "%s: called for ifp %p(%s)", __func__, ifp,
 676             ifp->if_xname);
 677
 678         SLIST_INIT(&inm_free_tmp);
 679         IGMP_LOCK();
 680
 681         igi = ((struct in_ifinfo *)ifp->if_afdata[AF_INET])->ii_igmp;
 682         if (igi->igi_version == IGMP_VERSION_3) {
 683                 IF_ADDR_WLOCK(ifp);
 684         restart:
 685                 CK_STAILQ_FOREACH_SAFE(ifma, &ifp->if_multiaddrs, ifma_link, next) {
 686                         if (ifma->ifma_addr->sa_family != AF_INET ||
 687                             ifma->ifma_protospec == NULL)
 688                                 continue;
 689                         inm = (struct in_multi *)ifma->ifma_protospec;
 690                         if (inm->inm_state == IGMP_LEAVING_MEMBER)
 691                                 inm_rele_locked(&inm_free_tmp, inm);
 692                         inm_clear_recorded(inm);
 693                         if (__predict_false(ifma_restart)) {
 694                                 ifma_restart = false;
 695                                 goto restart;
 696                         }
 697                 }
 698                 IF_ADDR_WUNLOCK(ifp);
 699                 inm_release_list_deferred(&inm_free_tmp);
 700         }
 701         IGMP_UNLOCK();
 702
 703 }
 704
 705 /*
 706  * Hook for domifdetach.
 707  */
 708 void
 709 igmp_domifdetach(struct ifnet *ifp)
 710 {
 711
 712         CTR3(KTR_IGMPV3, "%s: called for ifp %p(%s)",
 713             __func__, ifp, ifp->if_xname);
 714
 715         IGMP_LOCK();
 716         igi_delete_locked(ifp);
 717         IGMP_UNLOCK();
 718 }
 719
 720 static void
 721 igi_delete_locked(const struct ifnet *ifp)
 722 {
 723         struct igmp_ifsoftc *igi, *tigi;
 724
 725         CTR3(KTR_IGMPV3, "%s: freeing igmp_ifsoftc for ifp %p(%s)",
 726             __func__, ifp, ifp->if_xname);
 727
 728         IGMP_LOCK_ASSERT();
 729
 730         LIST_FOREACH_SAFE(igi, &V_igi_head, igi_link, tigi) {
 731                 if (igi->igi_ifp == ifp) {
 732                         /*
 733                          * Free deferred General Query responses.
 734                          */
 735                         mbufq_drain(&igi->igi_gq);
 736
 737                         LIST_REMOVE(igi, igi_link);
 738                         free(igi, M_IGMP);
 739                         return;
 740                 }
 741         }
 742 }
 743
 744 /*
 745  * Process a received IGMPv1 query.
 746  * Return non-zero if the message should be dropped.
 747  *
 748  * VIMAGE: The curvnet pointer is derived from the input ifp.
 749  */
 750 static int
 751 igmp_input_v1_query(struct ifnet *ifp, const struct ip *ip,
 752     const struct igmp *igmp)
 753 {
 754         struct ifmultiaddr      *ifma;
 755         struct igmp_ifsoftc     *igi;
 756         struct in_multi         *inm;
 757
 758         NET_EPOCH_ASSERT();
 759
 760         /*
 761          * IGMPv1 Host Mmembership Queries SHOULD always be addressed to
 762          * 224.0.0.1. They are always treated as General Queries.
 763          * igmp_group is always ignored. Do not drop it as a userland
 764          * daemon may wish to see it.
 765          * XXX SMPng: unlocked increments in igmpstat assumed atomic.
 766          */
 767         if (!in_allhosts(ip->ip_dst) || !in_nullhost(igmp->igmp_group)) {
 768                 IGMPSTAT_INC(igps_rcv_badqueries);
 769                 return (0);
 770         }
 771         IGMPSTAT_INC(igps_rcv_gen_queries);
 772
 773         IN_MULTI_LIST_LOCK();
 774         IGMP_LOCK();
 775
 776         igi = ((struct in_ifinfo *)ifp->if_afdata[AF_INET])->ii_igmp;
 777         KASSERT(igi != NULL, ("%s: no igmp_ifsoftc for ifp %p", __func__, ifp));
 778
 779         if (igi->igi_flags & IGIF_LOOPBACK) {
 780                 CTR2(KTR_IGMPV3, "ignore v1 query on IGIF_LOOPBACK ifp %p(%s)",
 781                     ifp, ifp->if_xname);
 782                 goto out_locked;
 783         }
 784
 785         /*
 786          * Switch to IGMPv1 host compatibility mode.
 787          */
 788         igmp_set_version(igi, IGMP_VERSION_1);
 789
 790         CTR2(KTR_IGMPV3, "process v1 query on ifp %p(%s)", ifp, ifp->if_xname);
 791
 792         /*
 793          * Start the timers in all of our group records
 794          * for the interface on which the query arrived,
 795          * except those which are already running.
 796          */
 797         CK_STAILQ_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link) {
 798                 if (ifma->ifma_addr->sa_family != AF_INET ||
 799                     ifma->ifma_protospec == NULL)
 800                         continue;
 801                 inm = (struct in_multi *)ifma->ifma_protospec;
 802                 if (inm->inm_timer != 0)
 803                         continue;
 804                 switch (inm->inm_state) {
 805                 case IGMP_NOT_MEMBER:
 806                 case IGMP_SILENT_MEMBER:
 807                         break;
 808                 case IGMP_G_QUERY_PENDING_MEMBER:
 809                 case IGMP_SG_QUERY_PENDING_MEMBER:
 810                 case IGMP_REPORTING_MEMBER:
 811                 case IGMP_IDLE_MEMBER:
 812                 case IGMP_LAZY_MEMBER:
 813                 case IGMP_SLEEPING_MEMBER:
 814                 case IGMP_AWAKENING_MEMBER:
 815                         inm->inm_state = IGMP_REPORTING_MEMBER;
 816                         inm->inm_timer = IGMP_RANDOM_DELAY(
 817                             IGMP_V1V2_MAX_RI * PR_FASTHZ);
 818                         V_current_state_timers_running = 1;
 819                         break;
 820                 case IGMP_LEAVING_MEMBER:
 821                         break;
 822                 }
 823         }
 824
 825 out_locked:
 826         IGMP_UNLOCK();
 827         IN_MULTI_LIST_UNLOCK();
 828
 829         return (0);
 830 }
 831
 832 /*
 833  * Process a received IGMPv2 general or group-specific query.
 834  */
 835 static int
 836 igmp_input_v2_query(struct ifnet *ifp, const struct ip *ip,
 837     const struct igmp *igmp)
 838 {
 839         struct ifmultiaddr      *ifma;
 840         struct igmp_ifsoftc     *igi;
 841         struct in_multi         *inm;
 842         int                      is_general_query;
 843         uint16_t                 timer;
 844
 845         NET_EPOCH_ASSERT();
 846
 847         is_general_query = 0;
 848
 849         /*
 850          * Validate address fields upfront.
 851          * XXX SMPng: unlocked increments in igmpstat assumed atomic.
 852          */
 853         if (in_nullhost(igmp->igmp_group)) {
 854                 /*
 855                  * IGMPv2 General Query.
 856                  * If this was not sent to the all-hosts group, ignore it.
 857                  */
 858                 if (!in_allhosts(ip->ip_dst))
 859                         return (0);
 860                 IGMPSTAT_INC(igps_rcv_gen_queries);
 861                 is_general_query = 1;
 862         } else {
 863                 /* IGMPv2 Group-Specific Query. */
 864                 IGMPSTAT_INC(igps_rcv_group_queries);
 865         }
 866
 867         IN_MULTI_LIST_LOCK();
 868         IGMP_LOCK();
 869
 870         igi = ((struct in_ifinfo *)ifp->if_afdata[AF_INET])->ii_igmp;
 871         KASSERT(igi != NULL, ("%s: no igmp_ifsoftc for ifp %p", __func__, ifp));
 872
 873         if (igi->igi_flags & IGIF_LOOPBACK) {
 874                 CTR2(KTR_IGMPV3, "ignore v2 query on IGIF_LOOPBACK ifp %p(%s)",
 875                     ifp, ifp->if_xname);
 876                 goto out_locked;
 877         }
 878
 879         /*
 880          * Ignore v2 query if in v1 Compatibility Mode.
 881          */
 882         if (igi->igi_version == IGMP_VERSION_1)
 883                 goto out_locked;
 884
 885         igmp_set_version(igi, IGMP_VERSION_2);
 886
 887         timer = igmp->igmp_code * PR_FASTHZ / IGMP_TIMER_SCALE;
 888         if (timer == 0)
 889                 timer = 1;
 890
 891         if (is_general_query) {
 892                 /*
 893                  * For each reporting group joined on this
 894                  * interface, kick the report timer.
 895                  */
 896                 CTR2(KTR_IGMPV3, "process v2 general query on ifp %p(%s)",
 897                     ifp, ifp->if_xname);
 898                 CK_STAILQ_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link) {
 899                         if (ifma->ifma_addr->sa_family != AF_INET ||
 900                             ifma->ifma_protospec == NULL)
 901                                 continue;
 902                         inm = (struct in_multi *)ifma->ifma_protospec;
 903                         igmp_v2_update_group(inm, timer);
 904                 }
 905         } else {
 906                 /*
 907                  * Group-specific IGMPv2 query, we need only
 908                  * look up the single group to process it.
 909                  */
 910                 inm = inm_lookup(ifp, igmp->igmp_group);
 911                 if (inm != NULL) {
 912                         CTR3(KTR_IGMPV3,
 913                             "process v2 query 0x%08x on ifp %p(%s)",
 914                             ntohl(igmp->igmp_group.s_addr), ifp, ifp->if_xname);
 915                         igmp_v2_update_group(inm, timer);
 916                 }
 917         }
 918
 919 out_locked:
 920         IGMP_UNLOCK();
 921         IN_MULTI_LIST_UNLOCK();
 922
 923         return (0);
 924 }
 925
 926 /*
 927  * Update the report timer on a group in response to an IGMPv2 query.
 928  *
 929  * If we are becoming the reporting member for this group, start the timer.
 930  * If we already are the reporting member for this group, and timer is
 931  * below the threshold, reset it.
 932  *
 933  * We may be updating the group for the first time since we switched
 934  * to IGMPv3. If we are, then we must clear any recorded source lists,
 935  * and transition to REPORTING state; the group timer is overloaded
 936  * for group and group-source query responses.
 937  *
 938  * Unlike IGMPv3, the delay per group should be jittered
 939  * to avoid bursts of IGMPv2 reports.
 940  */
 941 static void
 942 igmp_v2_update_group(struct in_multi *inm, const int timer)
 943 {
 944
 945         CTR4(KTR_IGMPV3, "0x%08x: %s/%s timer=%d", __func__,
 946             ntohl(inm->inm_addr.s_addr), inm->inm_ifp->if_xname, timer);
 947
 948         IN_MULTI_LIST_LOCK_ASSERT();
 949
 950         switch (inm->inm_state) {
 951         case IGMP_NOT_MEMBER:
 952         case IGMP_SILENT_MEMBER:
 953                 break;
 954         case IGMP_REPORTING_MEMBER:
 955                 if (inm->inm_timer != 0 &&
 956                     inm->inm_timer <= timer) {
 957                         CTR1(KTR_IGMPV3, "%s: REPORTING and timer running, "
 958                             "skipping.", __func__);
 959                         break;
 960                 }
 961                 /* FALLTHROUGH */
 962         case IGMP_SG_QUERY_PENDING_MEMBER:
 963         case IGMP_G_QUERY_PENDING_MEMBER:
 964         case IGMP_IDLE_MEMBER:
 965         case IGMP_LAZY_MEMBER:
 966         case IGMP_AWAKENING_MEMBER:
 967                 CTR1(KTR_IGMPV3, "%s: ->REPORTING", __func__);
 968                 inm->inm_state = IGMP_REPORTING_MEMBER;
 969                 inm->inm_timer = IGMP_RANDOM_DELAY(timer);
 970                 V_current_state_timers_running = 1;
 971                 break;
 972         case IGMP_SLEEPING_MEMBER:
 973                 CTR1(KTR_IGMPV3, "%s: ->AWAKENING", __func__);
 974                 inm->inm_state = IGMP_AWAKENING_MEMBER;
 975                 break;
 976         case IGMP_LEAVING_MEMBER:
 977                 break;
 978         }
 979 }
 980
 981 /*
 982  * Process a received IGMPv3 general, group-specific or
 983  * group-and-source-specific query.
 984  * Assumes m has already been pulled up to the full IGMP message length.
 985  * Return 0 if successful, otherwise an appropriate error code is returned.
 986  */
 987 static int
 988 igmp_input_v3_query(struct ifnet *ifp, const struct ip *ip,
 989     /*const*/ struct igmpv3 *igmpv3)
 990 {
 991         struct igmp_ifsoftc     *igi;
 992         struct in_multi         *inm;
 993         int                      is_general_query;
 994         uint32_t                 maxresp, nsrc, qqi;
 995         uint16_t                 timer;
 996         uint8_t                  qrv;
 997
 998         is_general_query = 0;
 999
1000         CTR2(KTR_IGMPV3, "process v3 query on ifp %p(%s)", ifp, ifp->if_xname);
1001
1002         maxresp = igmpv3->igmp_code;    /* in 1/10ths of a second */
1003         if (maxresp >= 128) {
1004                 maxresp = IGMP_MANT(igmpv3->igmp_code) <<
1005                           (IGMP_EXP(igmpv3->igmp_code) + 3);
1006         }
1007
1008         /*
1009          * Robustness must never be less than 2 for on-wire IGMPv3.
1010          * FUTURE: Check if ifp has IGIF_LOOPBACK set, as we will make
1011          * an exception for interfaces whose IGMPv3 state changes
1012          * are redirected to loopback (e.g. MANET).
1013          */
1014         qrv = IGMP_QRV(igmpv3->igmp_misc);
1015         if (qrv < 2) {
1016                 CTR3(KTR_IGMPV3, "%s: clamping qrv %d to %d", __func__,
1017                     qrv, IGMP_RV_INIT);
1018                 qrv = IGMP_RV_INIT;
1019         }
1020
1021         qqi = igmpv3->igmp_qqi;
1022         if (qqi >= 128) {
1023                 qqi = IGMP_MANT(igmpv3->igmp_qqi) <<
1024                      (IGMP_EXP(igmpv3->igmp_qqi) + 3);
1025         }
1026
1027         timer = maxresp * PR_FASTHZ / IGMP_TIMER_SCALE;
1028         if (timer == 0)
1029                 timer = 1;
1030
1031         nsrc = ntohs(igmpv3->igmp_numsrc);
1032
1033         /*
1034          * Validate address fields and versions upfront before
1035          * accepting v3 query.
1036          * XXX SMPng: Unlocked access to igmpstat counters here.
1037          */
1038         if (in_nullhost(igmpv3->igmp_group)) {
1039                 /*
1040                  * IGMPv3 General Query.
1041                  *
1042                  * General Queries SHOULD be directed to 224.0.0.1.
1043                  * A general query with a source list has undefined
1044                  * behaviour; discard it.
1045                  */
1046                 IGMPSTAT_INC(igps_rcv_gen_queries);
1047                 if (!in_allhosts(ip->ip_dst) || nsrc > 0) {
1048                         IGMPSTAT_INC(igps_rcv_badqueries);
1049                         return (0);
1050                 }
1051                 is_general_query = 1;
1052         } else {
1053                 /* Group or group-source specific query. */
1054                 if (nsrc == 0)
1055                         IGMPSTAT_INC(igps_rcv_group_queries);
1056                 else
1057                         IGMPSTAT_INC(igps_rcv_gsr_queries);
1058         }
1059
1060         IN_MULTI_LIST_LOCK();
1061         IGMP_LOCK();
1062
1063         igi = ((struct in_ifinfo *)ifp->if_afdata[AF_INET])->ii_igmp;
1064         KASSERT(igi != NULL, ("%s: no igmp_ifsoftc for ifp %p", __func__, ifp));
1065
1066         if (igi->igi_flags & IGIF_LOOPBACK) {
1067                 CTR2(KTR_IGMPV3, "ignore v3 query on IGIF_LOOPBACK ifp %p(%s)",
1068                     ifp, ifp->if_xname);
1069                 goto out_locked;
1070         }
1071
1072         /*
1073          * Discard the v3 query if we're in Compatibility Mode.
1074          * The RFC is not obviously worded that hosts need to stay in
1075          * compatibility mode until the Old Version Querier Present
1076          * timer expires.
1077          */
1078         if (igi->igi_version != IGMP_VERSION_3) {
1079                 CTR3(KTR_IGMPV3, "ignore v3 query in v%d mode on ifp %p(%s)",
1080                     igi->igi_version, ifp, ifp->if_xname);
1081                 goto out_locked;
1082         }
1083
1084         igmp_set_version(igi, IGMP_VERSION_3);
1085         igi->igi_rv = qrv;
1086         igi->igi_qi = qqi;
1087         igi->igi_qri = maxresp;
1088
1089         CTR4(KTR_IGMPV3, "%s: qrv %d qi %d qri %d", __func__, qrv, qqi,
1090             maxresp);
1091
1092         if (is_general_query) {
1093                 /*
1094                  * Schedule a current-state report on this ifp for
1095                  * all groups, possibly containing source lists.
1096                  * If there is a pending General Query response
1097                  * scheduled earlier than the selected delay, do
1098                  * not schedule any other reports.
1099                  * Otherwise, reset the interface timer.
1100                  */
1101                 CTR2(KTR_IGMPV3, "process v3 general query on ifp %p(%s)",
1102                     ifp, ifp->if_xname);
1103                 if (igi->igi_v3_timer == 0 || igi->igi_v3_timer >= timer) {
1104                         igi->igi_v3_timer = IGMP_RANDOM_DELAY(timer);
1105                         V_interface_timers_running = 1;
1106                 }
1107         } else {
1108                 /*
1109                  * Group-source-specific queries are throttled on
1110                  * a per-group basis to defeat denial-of-service attempts.
1111                  * Queries for groups we are not a member of on this
1112                  * link are simply ignored.
1113                  */
1114                 inm = inm_lookup(ifp, igmpv3->igmp_group);
1115                 if (inm == NULL)
1116                         goto out_locked;
1117                 if (nsrc > 0) {
1118                         if (!ratecheck(&inm->inm_lastgsrtv,
1119                             &V_igmp_gsrdelay)) {
1120                                 CTR1(KTR_IGMPV3, "%s: GS query throttled.",
1121                                     __func__);
1122                                 IGMPSTAT_INC(igps_drop_gsr_queries);
1123                                 goto out_locked;
1124                         }
1125                 }
1126                 CTR3(KTR_IGMPV3, "process v3 0x%08x query on ifp %p(%s)",
1127                      ntohl(igmpv3->igmp_group.s_addr), ifp, ifp->if_xname);
1128                 /*
1129                  * If there is a pending General Query response
1130                  * scheduled sooner than the selected delay, no
1131                  * further report need be scheduled.
1132                  * Otherwise, prepare to respond to the
1133                  * group-specific or group-and-source query.
1134                  */
1135                 if (igi->igi_v3_timer == 0 || igi->igi_v3_timer >= timer)
1136                         igmp_input_v3_group_query(inm, igi, timer, igmpv3);
1137         }
1138
1139 out_locked:
1140         IGMP_UNLOCK();
1141         IN_MULTI_LIST_UNLOCK();
1142
1143         return (0);
1144 }
1145
1146 /*
1147  * Process a received IGMPv3 group-specific or group-and-source-specific
1148  * query.
1149  * Return <0 if any error occurred. Currently this is ignored.
1150  */
1151 static int
1152 igmp_input_v3_group_query(struct in_multi *inm, struct igmp_ifsoftc *igi,
1153     int timer, /*const*/ struct igmpv3 *igmpv3)
1154 {
1155         int                      retval;
1156         uint16_t                 nsrc;
1157
1158         IN_MULTI_LIST_LOCK_ASSERT();
1159         IGMP_LOCK_ASSERT();
1160
1161         retval = 0;
1162
1163         switch (inm->inm_state) {
1164         case IGMP_NOT_MEMBER:
1165         case IGMP_SILENT_MEMBER:
1166         case IGMP_SLEEPING_MEMBER:
1167         case IGMP_LAZY_MEMBER:
1168         case IGMP_AWAKENING_MEMBER:
1169         case IGMP_IDLE_MEMBER:
1170         case IGMP_LEAVING_MEMBER:
1171                 return (retval);
1172                 break;
1173         case IGMP_REPORTING_MEMBER:
1174         case IGMP_G_QUERY_PENDING_MEMBER:
1175         case IGMP_SG_QUERY_PENDING_MEMBER:
1176                 break;
1177         }
1178
1179         nsrc = ntohs(igmpv3->igmp_numsrc);
1180
1181         /*
1182          * Deal with group-specific queries upfront.
1183          * If any group query is already pending, purge any recorded
1184          * source-list state if it exists, and schedule a query response
1185          * for this group-specific query.
1186          */
1187         if (nsrc == 0) {
1188                 if (inm->inm_state == IGMP_G_QUERY_PENDING_MEMBER ||
1189                     inm->inm_state == IGMP_SG_QUERY_PENDING_MEMBER) {
1190                         inm_clear_recorded(inm);
1191                         timer = min(inm->inm_timer, timer);
1192                 }
1193                 inm->inm_state = IGMP_G_QUERY_PENDING_MEMBER;
1194                 inm->inm_timer = IGMP_RANDOM_DELAY(timer);
1195                 V_current_state_timers_running = 1;
1196                 return (retval);
1197         }
1198
1199         /*
1200          * Deal with the case where a group-and-source-specific query has
1201          * been received but a group-specific query is already pending.
1202          */
1203         if (inm->inm_state == IGMP_G_QUERY_PENDING_MEMBER) {
1204                 timer = min(inm->inm_timer, timer);
1205                 inm->inm_timer = IGMP_RANDOM_DELAY(timer);
1206                 V_current_state_timers_running = 1;
1207                 return (retval);
1208         }
1209
1210         /*
1211          * Finally, deal with the case where a group-and-source-specific
1212          * query has been received, where a response to a previous g-s-r
1213          * query exists, or none exists.
1214          * In this case, we need to parse the source-list which the Querier
1215          * has provided us with and check if we have any source list filter
1216          * entries at T1 for these sources. If we do not, there is no need
1217          * schedule a report and the query may be dropped.
1218          * If we do, we must record them and schedule a current-state
1219          * report for those sources.
1220          * FIXME: Handling source lists larger than 1 mbuf requires that
1221          * we pass the mbuf chain pointer down to this function, and use
1222          * m_getptr() to walk the chain.
1223          */
1224         if (inm->inm_nsrc > 0) {
1225                 const struct in_addr    *ap;
1226                 int                      i, nrecorded;
1227
1228                 ap = (const struct in_addr *)(igmpv3 + 1);
1229                 nrecorded = 0;
1230                 for (i = 0; i < nsrc; i++, ap++) {
1231                         retval = inm_record_source(inm, ap->s_addr);
1232                         if (retval < 0)
1233                                 break;
1234                         nrecorded += retval;
1235                 }
1236                 if (nrecorded > 0) {
1237                         CTR1(KTR_IGMPV3,
1238                             "%s: schedule response to SG query", __func__);
1239                         inm->inm_state = IGMP_SG_QUERY_PENDING_MEMBER;
1240                         inm->inm_timer = IGMP_RANDOM_DELAY(timer);
1241                         V_current_state_timers_running = 1;
1242                 }
1243         }
1244
1245         return (retval);
1246 }
1247
1248 /*
1249  * Process a received IGMPv1 host membership report.
1250  *
1251  * NOTE: 0.0.0.0 workaround breaks const correctness.
1252  */
1253 static int
1254 igmp_input_v1_report(struct ifnet *ifp, /*const*/ struct ip *ip,
1255     /*const*/ struct igmp *igmp)
1256 {
1257         struct rm_priotracker in_ifa_tracker;
1258         struct in_ifaddr *ia;
1259         struct in_multi *inm;
1260
1261         IGMPSTAT_INC(igps_rcv_reports);
1262
1263         if (ifp->if_flags & IFF_LOOPBACK)
1264                 return (0);
1265
1266         if (!IN_MULTICAST(ntohl(igmp->igmp_group.s_addr)) ||
1267             !in_hosteq(igmp->igmp_group, ip->ip_dst)) {
1268                 IGMPSTAT_INC(igps_rcv_badreports);
1269                 return (EINVAL);
1270         }
1271
1272         /*
1273          * RFC 3376, Section 4.2.13, 9.2, 9.3:
1274          * Booting clients may use the source address 0.0.0.0. Some
1275          * IGMP daemons may not know how to use IP_RECVIF to determine
1276          * the interface upon which this message was received.
1277          * Replace 0.0.0.0 with the subnet address if told to do so.
1278          */
1279         if (V_igmp_recvifkludge && in_nullhost(ip->ip_src)) {
1280                 IFP_TO_IA(ifp, ia, &in_ifa_tracker);
1281                 if (ia != NULL)
1282                         ip->ip_src.s_addr = htonl(ia->ia_subnet);
1283         }
1284
1285         CTR3(KTR_IGMPV3, "process v1 report 0x%08x on ifp %p(%s)",
1286              ntohl(igmp->igmp_group.s_addr), ifp, ifp->if_xname);
1287
1288         /*
1289          * IGMPv1 report suppression.
1290          * If we are a member of this group, and our membership should be
1291          * reported, stop our group timer and transition to the 'lazy' state.
1292          */
1293         IN_MULTI_LIST_LOCK();
1294         inm = inm_lookup(ifp, igmp->igmp_group);
1295         if (inm != NULL) {
1296                 struct igmp_ifsoftc *igi;
1297
1298                 igi = inm->inm_igi;
1299                 if (igi == NULL) {
1300                         KASSERT(igi != NULL,
1301                             ("%s: no igi for ifp %p", __func__, ifp));
1302                         goto out_locked;
1303                 }
1304
1305                 IGMPSTAT_INC(igps_rcv_ourreports);
1306
1307                 /*
1308                  * If we are in IGMPv3 host mode, do not allow the
1309                  * other host's IGMPv1 report to suppress our reports
1310                  * unless explicitly configured to do so.
1311                  */
1312                 if (igi->igi_version == IGMP_VERSION_3) {
1313                         if (V_igmp_legacysupp)
1314                                 igmp_v3_suppress_group_record(inm);
1315                         goto out_locked;
1316                 }
1317
1318                 inm->inm_timer = 0;
1319
1320                 switch (inm->inm_state) {
1321                 case IGMP_NOT_MEMBER:
1322                 case IGMP_SILENT_MEMBER:
1323                         break;
1324                 case IGMP_IDLE_MEMBER:
1325                 case IGMP_LAZY_MEMBER:
1326                 case IGMP_AWAKENING_MEMBER:
1327                         CTR3(KTR_IGMPV3,
1328                             "report suppressed for 0x%08x on ifp %p(%s)",
1329                             ntohl(igmp->igmp_group.s_addr), ifp,
1330                             ifp->if_xname);
1331                 case IGMP_SLEEPING_MEMBER:
1332                         inm->inm_state = IGMP_SLEEPING_MEMBER;
1333                         break;
1334                 case IGMP_REPORTING_MEMBER:
1335                         CTR3(KTR_IGMPV3,
1336                             "report suppressed for 0x%08x on ifp %p(%s)",
1337                             ntohl(igmp->igmp_group.s_addr), ifp,
1338                             ifp->if_xname);
1339                         if (igi->igi_version == IGMP_VERSION_1)
1340                                 inm->inm_state = IGMP_LAZY_MEMBER;
1341                         else if (igi->igi_version == IGMP_VERSION_2)
1342                                 inm->inm_state = IGMP_SLEEPING_MEMBER;
1343                         break;
1344                 case IGMP_G_QUERY_PENDING_MEMBER:
1345                 case IGMP_SG_QUERY_PENDING_MEMBER:
1346                 case IGMP_LEAVING_MEMBER:
1347                         break;
1348                 }
1349         }
1350
1351 out_locked:
1352         IN_MULTI_LIST_UNLOCK();
1353
1354         return (0);
1355 }
1356
1357 /*
1358  * Process a received IGMPv2 host membership report.
1359  *
1360  * NOTE: 0.0.0.0 workaround breaks const correctness.
1361  */
1362 static int
1363 igmp_input_v2_report(struct ifnet *ifp, /*const*/ struct ip *ip,
1364     /*const*/ struct igmp *igmp)
1365 {
1366         struct rm_priotracker in_ifa_tracker;
1367         struct in_ifaddr *ia;
1368         struct in_multi *inm;
1369
1370         /*
1371          * Make sure we don't hear our own membership report.  Fast
1372          * leave requires knowing that we are the only member of a
1373          * group.
1374          */
1375         IFP_TO_IA(ifp, ia, &in_ifa_tracker);
1376         if (ia != NULL && in_hosteq(ip->ip_src, IA_SIN(ia)->sin_addr)) {
1377                 return (0);
1378         }
1379
1380         IGMPSTAT_INC(igps_rcv_reports);
1381
1382         if (ifp->if_flags & IFF_LOOPBACK) {
1383                 return (0);
1384         }
1385
1386         if (!IN_MULTICAST(ntohl(igmp->igmp_group.s_addr)) ||
1387             !in_hosteq(igmp->igmp_group, ip->ip_dst)) {
1388                 IGMPSTAT_INC(igps_rcv_badreports);
1389                 return (EINVAL);
1390         }
1391
1392         /*
1393          * RFC 3376, Section 4.2.13, 9.2, 9.3:
1394          * Booting clients may use the source address 0.0.0.0. Some
1395          * IGMP daemons may not know how to use IP_RECVIF to determine
1396          * the interface upon which this message was received.
1397          * Replace 0.0.0.0 with the subnet address if told to do so.
1398          */
1399         if (V_igmp_recvifkludge && in_nullhost(ip->ip_src)) {
1400                 if (ia != NULL)
1401                         ip->ip_src.s_addr = htonl(ia->ia_subnet);
1402         }
1403
1404         CTR3(KTR_IGMPV3, "process v2 report 0x%08x on ifp %p(%s)",
1405              ntohl(igmp->igmp_group.s_addr), ifp, ifp->if_xname);
1406
1407         /*
1408          * IGMPv2 report suppression.
1409          * If we are a member of this group, and our membership should be
1410          * reported, and our group timer is pending or about to be reset,
1411          * stop our group timer by transitioning to the 'lazy' state.
1412          */
1413         IN_MULTI_LIST_LOCK();
1414         inm = inm_lookup(ifp, igmp->igmp_group);
1415         if (inm != NULL) {
1416                 struct igmp_ifsoftc *igi;
1417
1418                 igi = inm->inm_igi;
1419                 KASSERT(igi != NULL, ("%s: no igi for ifp %p", __func__, ifp));
1420
1421                 IGMPSTAT_INC(igps_rcv_ourreports);
1422
1423                 /*
1424                  * If we are in IGMPv3 host mode, do not allow the
1425                  * other host's IGMPv1 report to suppress our reports
1426                  * unless explicitly configured to do so.
1427                  */
1428                 if (igi->igi_version == IGMP_VERSION_3) {
1429                         if (V_igmp_legacysupp)
1430                                 igmp_v3_suppress_group_record(inm);
1431                         goto out_locked;
1432                 }
1433
1434                 inm->inm_timer = 0;
1435
1436                 switch (inm->inm_state) {
1437                 case IGMP_NOT_MEMBER:
1438                 case IGMP_SILENT_MEMBER:
1439                 case IGMP_SLEEPING_MEMBER:
1440                         break;
1441                 case IGMP_REPORTING_MEMBER:
1442                 case IGMP_IDLE_MEMBER:
1443                 case IGMP_AWAKENING_MEMBER:
1444                         CTR3(KTR_IGMPV3,
1445                             "report suppressed for 0x%08x on ifp %p(%s)",
1446                             ntohl(igmp->igmp_group.s_addr), ifp, ifp->if_xname);
1447                 case IGMP_LAZY_MEMBER:
1448                         inm->inm_state = IGMP_LAZY_MEMBER;
1449                         break;
1450                 case IGMP_G_QUERY_PENDING_MEMBER:
1451                 case IGMP_SG_QUERY_PENDING_MEMBER:
1452                 case IGMP_LEAVING_MEMBER:
1453                         break;
1454                 }
1455         }
1456
1457 out_locked:
1458         IN_MULTI_LIST_UNLOCK();
1459
1460         return (0);
1461 }
1462
1463 int
1464 igmp_input(struct mbuf **mp, int *offp, int proto)
1465 {
1466         int iphlen;
1467         struct ifnet *ifp;
1468         struct igmp *igmp;
1469         struct ip *ip;
1470         struct mbuf *m;
1471         int igmplen;
1472         int minlen;
1473         int queryver;
1474
1475         CTR3(KTR_IGMPV3, "%s: called w/mbuf (%p,%d)", __func__, *mp, *offp);
1476
1477         m = *mp;
1478         ifp = m->m_pkthdr.rcvif;
1479         *mp = NULL;
1480
1481         IGMPSTAT_INC(igps_rcv_total);
1482
1483         ip = mtod(m, struct ip *);
1484         iphlen = *offp;
1485         igmplen = ntohs(ip->ip_len) - iphlen;
1486
1487         /*
1488          * Validate lengths.
1489          */
1490         if (igmplen < IGMP_MINLEN) {
1491                 IGMPSTAT_INC(igps_rcv_tooshort);
1492                 m_freem(m);
1493                 return (IPPROTO_DONE);
1494         }
1495
1496         /*
1497          * Always pullup to the minimum size for v1/v2 or v3
1498          * to amortize calls to m_pullup().
1499          */
1500         minlen = iphlen;
1501         if (igmplen >= IGMP_V3_QUERY_MINLEN)
1502                 minlen += IGMP_V3_QUERY_MINLEN;
1503         else
1504                 minlen += IGMP_MINLEN;
1505         if ((!M_WRITABLE(m) || m->m_len < minlen) &&
1506             (m = m_pullup(m, minlen)) == NULL) {
1507                 IGMPSTAT_INC(igps_rcv_tooshort);
1508                 return (IPPROTO_DONE);
1509         }
1510         ip = mtod(m, struct ip *);
1511
1512         /*
1513          * Validate checksum.
1514          */
1515         m->m_data += iphlen;
1516         m->m_len -= iphlen;
1517         igmp = mtod(m, struct igmp *);
1518         if (in_cksum(m, igmplen)) {
1519                 IGMPSTAT_INC(igps_rcv_badsum);
1520                 m_freem(m);
1521                 return (IPPROTO_DONE);
1522         }
1523         m->m_data -= iphlen;
1524         m->m_len += iphlen;
1525
1526         /*
1527          * IGMP control traffic is link-scope, and must have a TTL of 1.
1528          * DVMRP traffic (e.g. mrinfo, mtrace) is an exception;
1529          * probe packets may come from beyond the LAN.
1530          */
1531         if (igmp->igmp_type != IGMP_DVMRP && ip->ip_ttl != 1) {
1532                 IGMPSTAT_INC(igps_rcv_badttl);
1533                 m_freem(m);
1534                 return (IPPROTO_DONE);
1535         }
1536
1537         switch (igmp->igmp_type) {
1538         case IGMP_HOST_MEMBERSHIP_QUERY:
1539                 if (igmplen == IGMP_MINLEN) {
1540                         if (igmp->igmp_code == 0)
1541                                 queryver = IGMP_VERSION_1;
1542                         else
1543                                 queryver = IGMP_VERSION_2;
1544                 } else if (igmplen >= IGMP_V3_QUERY_MINLEN) {
1545                         queryver = IGMP_VERSION_3;
1546                 } else {
1547                         IGMPSTAT_INC(igps_rcv_tooshort);
1548                         m_freem(m);
1549                         return (IPPROTO_DONE);
1550                 }
1551
1552                 switch (queryver) {
1553                 case IGMP_VERSION_1:
1554                         IGMPSTAT_INC(igps_rcv_v1v2_queries);
1555                         if (!V_igmp_v1enable)
1556                                 break;
1557                         if (igmp_input_v1_query(ifp, ip, igmp) != 0) {
1558                                 m_freem(m);
1559                                 return (IPPROTO_DONE);
1560                         }
1561                         break;
1562
1563                 case IGMP_VERSION_2:
1564                         IGMPSTAT_INC(igps_rcv_v1v2_queries);
1565                         if (!V_igmp_v2enable)
1566                                 break;
1567                         if (igmp_input_v2_query(ifp, ip, igmp) != 0) {
1568                                 m_freem(m);
1569                                 return (IPPROTO_DONE);
1570                         }
1571                         break;
1572
1573                 case IGMP_VERSION_3: {
1574                                 struct igmpv3 *igmpv3;
1575                                 uint16_t igmpv3len;
1576                                 uint16_t nsrc;
1577
1578                                 IGMPSTAT_INC(igps_rcv_v3_queries);
1579                                 igmpv3 = (struct igmpv3 *)igmp;
1580                                 /*
1581                                  * Validate length based on source count.
1582                                  */
1583                                 nsrc = ntohs(igmpv3->igmp_numsrc);
1584                                 if (nsrc * sizeof(in_addr_t) >
1585                                     UINT16_MAX - iphlen - IGMP_V3_QUERY_MINLEN) {
1586                                         IGMPSTAT_INC(igps_rcv_tooshort);
1587                                         return (IPPROTO_DONE);
1588                                 }
1589                                 /*
1590                                  * m_pullup() may modify m, so pullup in
1591                                  * this scope.
1592                                  */
1593                                 igmpv3len = iphlen + IGMP_V3_QUERY_MINLEN +
1594                                    sizeof(struct in_addr) * nsrc;
1595                                 if ((!M_WRITABLE(m) ||
1596                                      m->m_len < igmpv3len) &&
1597                                     (m = m_pullup(m, igmpv3len)) == NULL) {
1598                                         IGMPSTAT_INC(igps_rcv_tooshort);
1599                                         return (IPPROTO_DONE);
1600                                 }
1601                                 igmpv3 = (struct igmpv3 *)(mtod(m, uint8_t *)
1602                                     + iphlen);
1603                                 if (igmp_input_v3_query(ifp, ip, igmpv3) != 0) {
1604                                         m_freem(m);
1605                                         return (IPPROTO_DONE);
1606                                 }
1607                         }
1608                         break;
1609                 }
1610                 break;
1611
1612         case IGMP_v1_HOST_MEMBERSHIP_REPORT:
1613                 if (!V_igmp_v1enable)
1614                         break;
1615                 if (igmp_input_v1_report(ifp, ip, igmp) != 0) {
1616                         m_freem(m);
1617                         return (IPPROTO_DONE);
1618                 }
1619                 break;
1620
1621         case IGMP_v2_HOST_MEMBERSHIP_REPORT:
1622                 if (!V_igmp_v2enable)
1623                         break;
1624                 if (!ip_checkrouteralert(m))
1625                         IGMPSTAT_INC(igps_rcv_nora);
1626                 if (igmp_input_v2_report(ifp, ip, igmp) != 0) {
1627                         m_freem(m);
1628                         return (IPPROTO_DONE);
1629                 }
1630                 break;
1631
1632         case IGMP_v3_HOST_MEMBERSHIP_REPORT:
1633                 /*
1634                  * Hosts do not need to process IGMPv3 membership reports,
1635                  * as report suppression is no longer required.
1636                  */
1637                 if (!ip_checkrouteralert(m))
1638                         IGMPSTAT_INC(igps_rcv_nora);
1639                 break;
1640
1641         default:
1642                 break;
1643         }
1644
1645         /*
1646          * Pass all valid IGMP packets up to any process(es) listening on a
1647          * raw IGMP socket.
1648          */
1649         *mp = m;
1650         return (rip_input(mp, offp, proto));
1651 }
1652
1653
1654 /*
1655  * Fast timeout handler (global).
1656  * VIMAGE: Timeout handlers are expected to service all vimages.
1657  */
1658 void
1659 igmp_fasttimo(void)
1660 {
1661         VNET_ITERATOR_DECL(vnet_iter);
1662
1663         VNET_LIST_RLOCK_NOSLEEP();
1664         VNET_FOREACH(vnet_iter) {
1665                 CURVNET_SET(vnet_iter);
1666                 igmp_fasttimo_vnet();
1667                 CURVNET_RESTORE();
1668         }
1669         VNET_LIST_RUNLOCK_NOSLEEP();
1670 }
1671
1672 /*
1673  * Fast timeout handler (per-vnet).
1674  * Sends are shuffled off to a netisr to deal with Giant.
1675  *
1676  * VIMAGE: Assume caller has set up our curvnet.
1677  */
1678 static void
1679 igmp_fasttimo_vnet(void)
1680 {
1681         struct mbufq             scq;   /* State-change packets */
1682         struct mbufq             qrq;   /* Query response packets */
1683         struct ifnet            *ifp;
1684         struct igmp_ifsoftc     *igi;
1685         struct ifmultiaddr      *ifma, *next;
1686         struct in_multi         *inm;
1687         struct in_multi_head inm_free_tmp;
1688         int                      loop, uri_fasthz;
1689
1690         loop = 0;
1691         uri_fasthz = 0;
1692
1693         /*
1694          * Quick check to see if any work needs to be done, in order to
1695          * minimize the overhead of fasttimo processing.
1696          * SMPng: XXX Unlocked reads.
1697          */
1698         if (!V_current_state_timers_running &&
1699             !V_interface_timers_running &&
1700             !V_state_change_timers_running)
1701                 return;
1702
1703         SLIST_INIT(&inm_free_tmp);
1704         IN_MULTI_LIST_LOCK();
1705         IGMP_LOCK();
1706
1707         /*
1708          * IGMPv3 General Query response timer processing.
1709          */
1710         if (V_interface_timers_running) {
1711                 CTR1(KTR_IGMPV3, "%s: interface timers running", __func__);
1712
1713                 V_interface_timers_running = 0;
1714                 LIST_FOREACH(igi, &V_igi_head, igi_link) {
1715                         if (igi->igi_v3_timer == 0) {
1716                                 /* Do nothing. */
1717                         } else if (--igi->igi_v3_timer == 0) {
1718                                 igmp_v3_dispatch_general_query(igi);
1719                         } else {
1720                                 V_interface_timers_running = 1;
1721                         }
1722                 }
1723         }
1724
1725         if (!V_current_state_timers_running &&
1726             !V_state_change_timers_running)
1727                 goto out_locked;
1728
1729         V_current_state_timers_running = 0;
1730         V_state_change_timers_running = 0;
1731
1732         CTR1(KTR_IGMPV3, "%s: state change timers running", __func__);
1733
1734         /*
1735          * IGMPv1/v2/v3 host report and state-change timer processing.
1736          * Note: Processing a v3 group timer may remove a node.
1737          */
1738         LIST_FOREACH(igi, &V_igi_head, igi_link) {
1739                 ifp = igi->igi_ifp;
1740
1741                 if (igi->igi_version == IGMP_VERSION_3) {
1742                         loop = (igi->igi_flags & IGIF_LOOPBACK) ? 1 : 0;
1743                         uri_fasthz = IGMP_RANDOM_DELAY(igi->igi_uri *
1744                             PR_FASTHZ);
1745                         mbufq_init(&qrq, IGMP_MAX_G_GS_PACKETS);
1746                         mbufq_init(&scq, IGMP_MAX_STATE_CHANGE_PACKETS);
1747                 }
1748
1749                 IF_ADDR_WLOCK(ifp);
1750         restart:
1751                 CK_STAILQ_FOREACH_SAFE(ifma, &ifp->if_multiaddrs, ifma_link, next) {
1752                         if (ifma->ifma_addr->sa_family != AF_INET ||
1753                             ifma->ifma_protospec == NULL)
1754                                 continue;
1755                         inm = (struct in_multi *)ifma->ifma_protospec;
1756                         switch (igi->igi_version) {
1757                         case IGMP_VERSION_1:
1758                         case IGMP_VERSION_2:
1759                                 igmp_v1v2_process_group_timer(inm,
1760                                     igi->igi_version);
1761                                 break;
1762                         case IGMP_VERSION_3:
1763                                 igmp_v3_process_group_timers(&inm_free_tmp, &qrq,
1764                                     &scq, inm, uri_fasthz);
1765                                 break;
1766                         }
1767                         if (__predict_false(ifma_restart)) {
1768                                 ifma_restart = false;
1769                                 goto restart;
1770                         }
1771                 }
1772                 IF_ADDR_WUNLOCK(ifp);
1773
1774                 if (igi->igi_version == IGMP_VERSION_3) {
1775                         igmp_dispatch_queue(&qrq, 0, loop);
1776                         igmp_dispatch_queue(&scq, 0, loop);
1777
1778                         /*
1779                          * Free the in_multi reference(s) for this
1780                          * IGMP lifecycle.
1781                          */
1782                         inm_release_list_deferred(&inm_free_tmp);
1783                 }
1784         }
1785
1786 out_locked:
1787         IGMP_UNLOCK();
1788         IN_MULTI_LIST_UNLOCK();
1789 }
1790
1791 /*
1792  * Update host report group timer for IGMPv1/v2.
1793  * Will update the global pending timer flags.
1794  */
1795 static void
1796 igmp_v1v2_process_group_timer(struct in_multi *inm, const int version)
1797 {
1798         int report_timer_expired;
1799
1800         IN_MULTI_LIST_LOCK_ASSERT();
1801         IGMP_LOCK_ASSERT();
1802
1803         if (inm->inm_timer == 0) {
1804                 report_timer_expired = 0;
1805         } else if (--inm->inm_timer == 0) {
1806                 report_timer_expired = 1;
1807         } else {
1808                 V_current_state_timers_running = 1;
1809                 return;
1810         }
1811
1812         switch (inm->inm_state) {
1813         case IGMP_NOT_MEMBER:
1814         case IGMP_SILENT_MEMBER:
1815         case IGMP_IDLE_MEMBER:
1816         case IGMP_LAZY_MEMBER:
1817         case IGMP_SLEEPING_MEMBER:
1818         case IGMP_AWAKENING_MEMBER:
1819                 break;
1820         case IGMP_REPORTING_MEMBER:
1821                 if (report_timer_expired) {
1822                         inm->inm_state = IGMP_IDLE_MEMBER;
1823                         (void)igmp_v1v2_queue_report(inm,
1824                             (version == IGMP_VERSION_2) ?
1825                              IGMP_v2_HOST_MEMBERSHIP_REPORT :
1826                              IGMP_v1_HOST_MEMBERSHIP_REPORT);
1827                 }
1828                 break;
1829         case IGMP_G_QUERY_PENDING_MEMBER:
1830         case IGMP_SG_QUERY_PENDING_MEMBER:
1831         case IGMP_LEAVING_MEMBER:
1832                 break;
1833         }
1834 }
1835
1836 /*
1837  * Update a group's timers for IGMPv3.
1838  * Will update the global pending timer flags.
1839  * Note: Unlocked read from igi.
1840  */
1841 static void
1842 igmp_v3_process_group_timers(struct in_multi_head *inmh,
1843     struct mbufq *qrq, struct mbufq *scq,
1844     struct in_multi *inm, const int uri_fasthz)
1845 {
1846         int query_response_timer_expired;
1847         int state_change_retransmit_timer_expired;
1848
1849         IN_MULTI_LIST_LOCK_ASSERT();
1850         IGMP_LOCK_ASSERT();
1851
1852         query_response_timer_expired = 0;
1853         state_change_retransmit_timer_expired = 0;
1854
1855         /*
1856          * During a transition from v1/v2 compatibility mode back to v3,
1857          * a group record in REPORTING state may still have its group
1858          * timer active. This is a no-op in this function; it is easier
1859          * to deal with it here than to complicate the slow-timeout path.
1860          */
1861         if (inm->inm_timer == 0) {
1862                 query_response_timer_expired = 0;
1863         } else if (--inm->inm_timer == 0) {
1864                 query_response_timer_expired = 1;
1865         } else {
1866                 V_current_state_timers_running = 1;
1867         }
1868
1869         if (inm->inm_sctimer == 0) {
1870                 state_change_retransmit_timer_expired = 0;
1871         } else if (--inm->inm_sctimer == 0) {
1872                 state_change_retransmit_timer_expired = 1;
1873         } else {
1874                 V_state_change_timers_running = 1;
1875         }
1876
1877         /* We are in fasttimo, so be quick about it. */
1878         if (!state_change_retransmit_timer_expired &&
1879             !query_response_timer_expired)
1880                 return;
1881
1882         switch (inm->inm_state) {
1883         case IGMP_NOT_MEMBER:
1884         case IGMP_SILENT_MEMBER:
1885         case IGMP_SLEEPING_MEMBER:
1886         case IGMP_LAZY_MEMBER:
1887         case IGMP_AWAKENING_MEMBER:
1888         case IGMP_IDLE_MEMBER:
1889                 break;
1890         case IGMP_G_QUERY_PENDING_MEMBER:
1891         case IGMP_SG_QUERY_PENDING_MEMBER:
1892                 /*
1893                  * Respond to a previously pending Group-Specific
1894                  * or Group-and-Source-Specific query by enqueueing
1895                  * the appropriate Current-State report for
1896                  * immediate transmission.
1897                  */
1898                 if (query_response_timer_expired) {
1899                         int retval __unused;
1900
1901                         retval = igmp_v3_enqueue_group_record(qrq, inm, 0, 1,
1902                             (inm->inm_state == IGMP_SG_QUERY_PENDING_MEMBER));
1903                         CTR2(KTR_IGMPV3, "%s: enqueue record = %d",
1904                             __func__, retval);
1905                         inm->inm_state = IGMP_REPORTING_MEMBER;
1906                         /* XXX Clear recorded sources for next time. */
1907                         inm_clear_recorded(inm);
1908                 }
1909                 /* FALLTHROUGH */
1910         case IGMP_REPORTING_MEMBER:
1911         case IGMP_LEAVING_MEMBER:
1912                 if (state_change_retransmit_timer_expired) {
1913                         /*
1914                          * State-change retransmission timer fired.
1915                          * If there are any further pending retransmissions,
1916                          * set the global pending state-change flag, and
1917                          * reset the timer.
1918                          */
1919                         if (--inm->inm_scrv > 0) {
1920                                 inm->inm_sctimer = uri_fasthz;
1921                                 V_state_change_timers_running = 1;
1922                         }
1923                         /*
1924                          * Retransmit the previously computed state-change
1925                          * report. If there are no further pending
1926                          * retransmissions, the mbuf queue will be consumed.
1927                          * Update T0 state to T1 as we have now sent
1928                          * a state-change.
1929                          */
1930                         (void)igmp_v3_merge_state_changes(inm, scq);
1931
1932                         inm_commit(inm);
1933                         CTR3(KTR_IGMPV3, "%s: T1 -> T0 for 0x%08x/%s", __func__,
1934                             ntohl(inm->inm_addr.s_addr),
1935                             inm->inm_ifp->if_xname);
1936
1937                         /*
1938                          * If we are leaving the group for good, make sure
1939                          * we release IGMP's reference to it.
1940                          * This release must be deferred using a SLIST,
1941                          * as we are called from a loop which traverses
1942                          * the in_ifmultiaddr TAILQ.
1943                          */
1944                         if (inm->inm_state == IGMP_LEAVING_MEMBER &&
1945                             inm->inm_scrv == 0) {
1946                                 inm->inm_state = IGMP_NOT_MEMBER;
1947                                 inm_rele_locked(inmh, inm);
1948                         }
1949                 }
1950                 break;
1951         }
1952 }
1953
1954
1955 /*
1956  * Suppress a group's pending response to a group or source/group query.
1957  *
1958  * Do NOT suppress state changes. This leads to IGMPv3 inconsistency.
1959  * Do NOT update ST1/ST0 as this operation merely suppresses
1960  * the currently pending group record.
1961  * Do NOT suppress the response to a general query. It is possible but
1962  * it would require adding another state or flag.
1963  */
1964 static void
1965 igmp_v3_suppress_group_record(struct in_multi *inm)
1966 {
1967
1968         IN_MULTI_LIST_LOCK_ASSERT();
1969
1970         KASSERT(inm->inm_igi->igi_version == IGMP_VERSION_3,
1971                 ("%s: not IGMPv3 mode on link", __func__));
1972
1973         if (inm->inm_state != IGMP_G_QUERY_PENDING_MEMBER ||
1974             inm->inm_state != IGMP_SG_QUERY_PENDING_MEMBER)
1975                 return;
1976
1977         if (inm->inm_state == IGMP_SG_QUERY_PENDING_MEMBER)
1978                 inm_clear_recorded(inm);
1979
1980         inm->inm_timer = 0;
1981         inm->inm_state = IGMP_REPORTING_MEMBER;
1982 }
1983
1984 /*
1985  * Switch to a different IGMP version on the given interface,
1986  * as per Section 7.2.1.
1987  */
1988 static void
1989 igmp_set_version(struct igmp_ifsoftc *igi, const int version)
1990 {
1991         int old_version_timer;
1992
1993         IGMP_LOCK_ASSERT();
1994
1995         CTR4(KTR_IGMPV3, "%s: switching to v%d on ifp %p(%s)", __func__,
1996             version, igi->igi_ifp, igi->igi_ifp->if_xname);
1997
1998         if (version == IGMP_VERSION_1 || version == IGMP_VERSION_2) {
1999                 /*
2000                  * Compute the "Older Version Querier Present" timer as per
2001                  * Section 8.12.
2002                  */
2003                 old_version_timer = igi->igi_rv * igi->igi_qi + igi->igi_qri;
2004                 old_version_timer *= PR_SLOWHZ;
2005
2006                 if (version == IGMP_VERSION_1) {
2007                         igi->igi_v1_timer = old_version_timer;
2008                         igi->igi_v2_timer = 0;
2009                 } else if (version == IGMP_VERSION_2) {
2010                         igi->igi_v1_timer = 0;
2011                         igi->igi_v2_timer = old_version_timer;
2012                 }
2013         }
2014
2015         if (igi->igi_v1_timer == 0 && igi->igi_v2_timer > 0) {
2016                 if (igi->igi_version != IGMP_VERSION_2) {
2017                         igi->igi_version = IGMP_VERSION_2;
2018                         igmp_v3_cancel_link_timers(igi);
2019                 }
2020         } else if (igi->igi_v1_timer > 0) {
2021                 if (igi->igi_version != IGMP_VERSION_1) {
2022                         igi->igi_version = IGMP_VERSION_1;
2023                         igmp_v3_cancel_link_timers(igi);
2024                 }
2025         }
2026 }
2027
2028 /*
2029  * Cancel pending IGMPv3 timers for the given link and all groups
2030  * joined on it; state-change, general-query, and group-query timers.
2031  *
2032  * Only ever called on a transition from v3 to Compatibility mode. Kill
2033  * the timers stone dead (this may be expensive for large N groups), they
2034  * will be restarted if Compatibility Mode deems that they must be due to
2035  * query processing.
2036  */
2037 static void
2038 igmp_v3_cancel_link_timers(struct igmp_ifsoftc *igi)
2039 {
2040         struct ifmultiaddr      *ifma, *ifmatmp;
2041         struct ifnet            *ifp;
2042         struct in_multi         *inm;
2043         struct in_multi_head inm_free_tmp;
2044
2045         CTR3(KTR_IGMPV3, "%s: cancel v3 timers on ifp %p(%s)", __func__,
2046             igi->igi_ifp, igi->igi_ifp->if_xname);
2047
2048         IN_MULTI_LIST_LOCK_ASSERT();
2049         IGMP_LOCK_ASSERT();
2050         NET_EPOCH_ASSERT();
2051
2052         SLIST_INIT(&inm_free_tmp);
2053
2054         /*
2055          * Stop the v3 General Query Response on this link stone dead.
2056          * If fasttimo is woken up due to V_interface_timers_running,
2057          * the flag will be cleared if there are no pending link timers.
2058          */
2059         igi->igi_v3_timer = 0;
2060
2061         /*
2062          * Now clear the current-state and state-change report timers
2063          * for all memberships scoped to this link.
2064          */
2065         ifp = igi->igi_ifp;
2066         IF_ADDR_WLOCK(ifp);
2067         CK_STAILQ_FOREACH_SAFE(ifma, &ifp->if_multiaddrs, ifma_link, ifmatmp) {
2068                 if (ifma->ifma_addr->sa_family != AF_INET ||
2069                     ifma->ifma_protospec == NULL)
2070                         continue;
2071                 inm = (struct in_multi *)ifma->ifma_protospec;
2072                 switch (inm->inm_state) {
2073                 case IGMP_NOT_MEMBER:
2074                 case IGMP_SILENT_MEMBER:
2075                 case IGMP_IDLE_MEMBER:
2076                 case IGMP_LAZY_MEMBER:
2077                 case IGMP_SLEEPING_MEMBER:
2078                 case IGMP_AWAKENING_MEMBER:
2079                         /*
2080                          * These states are either not relevant in v3 mode,
2081                          * or are unreported. Do nothing.
2082                          */
2083                         break;
2084                 case IGMP_LEAVING_MEMBER:
2085                         /*
2086                          * If we are leaving the group and switching to
2087                          * compatibility mode, we need to release the final
2088                          * reference held for issuing the INCLUDE {}, and
2089                          * transition to REPORTING to ensure the host leave
2090                          * message is sent upstream to the old querier --
2091                          * transition to NOT would lose the leave and race.
2092                          */
2093                         inm_rele_locked(&inm_free_tmp, inm);
2094                         /* FALLTHROUGH */
2095                 case IGMP_G_QUERY_PENDING_MEMBER:
2096                 case IGMP_SG_QUERY_PENDING_MEMBER:
2097                         inm_clear_recorded(inm);
2098                         /* FALLTHROUGH */
2099                 case IGMP_REPORTING_MEMBER:
2100                         inm->inm_state = IGMP_REPORTING_MEMBER;
2101                         break;
2102                 }
2103                 /*
2104                  * Always clear state-change and group report timers.
2105                  * Free any pending IGMPv3 state-change records.
2106                  */
2107                 inm->inm_sctimer = 0;
2108                 inm->inm_timer = 0;
2109                 mbufq_drain(&inm->inm_scq);
2110         }
2111         IF_ADDR_WUNLOCK(ifp);
2112
2113         inm_release_list_deferred(&inm_free_tmp);
2114 }
2115
2116 /*
2117  * Update the Older Version Querier Present timers for a link.
2118  * See Section 7.2.1 of RFC 3376.
2119  */
2120 static void
2121 igmp_v1v2_process_querier_timers(struct igmp_ifsoftc *igi)
2122 {
2123
2124         IGMP_LOCK_ASSERT();
2125
2126         if (igi->igi_v1_timer == 0 && igi->igi_v2_timer == 0) {
2127                 /*
2128                  * IGMPv1 and IGMPv2 Querier Present timers expired.
2129                  *
2130                  * Revert to IGMPv3.
2131                  */
2132                 if (igi->igi_version != IGMP_VERSION_3) {
2133                         CTR5(KTR_IGMPV3,
2134                             "%s: transition from v%d -> v%d on %p(%s)",
2135                             __func__, igi->igi_version, IGMP_VERSION_3,
2136                             igi->igi_ifp, igi->igi_ifp->if_xname);
2137                         igi->igi_version = IGMP_VERSION_3;
2138                 }
2139         } else if (igi->igi_v1_timer == 0 && igi->igi_v2_timer > 0) {
2140                 /*
2141                  * IGMPv1 Querier Present timer expired,
2142                  * IGMPv2 Querier Present timer running.
2143                  * If IGMPv2 was disabled since last timeout,
2144                  * revert to IGMPv3.
2145                  * If IGMPv2 is enabled, revert to IGMPv2.
2146                  */
2147                 if (!V_igmp_v2enable) {
2148                         CTR5(KTR_IGMPV3,
2149                             "%s: transition from v%d -> v%d on %p(%s)",
2150                             __func__, igi->igi_version, IGMP_VERSION_3,
2151                             igi->igi_ifp, igi->igi_ifp->if_xname);
2152                         igi->igi_v2_timer = 0;
2153                         igi->igi_version = IGMP_VERSION_3;
2154                 } else {
2155                         --igi->igi_v2_timer;
2156                         if (igi->igi_version != IGMP_VERSION_2) {
2157                                 CTR5(KTR_IGMPV3,
2158                                     "%s: transition from v%d -> v%d on %p(%s)",
2159                                     __func__, igi->igi_version, IGMP_VERSION_2,
2160                                     igi->igi_ifp, igi->igi_ifp->if_xname);
2161                                 igi->igi_version = IGMP_VERSION_2;
2162                                 igmp_v3_cancel_link_timers(igi);
2163                         }
2164                 }
2165         } else if (igi->igi_v1_timer > 0) {
2166                 /*
2167                  * IGMPv1 Querier Present timer running.
2168                  * Stop IGMPv2 timer if running.
2169                  *
2170                  * If IGMPv1 was disabled since last timeout,
2171                  * revert to IGMPv3.
2172                  * If IGMPv1 is enabled, reset IGMPv2 timer if running.
2173                  */
2174                 if (!V_igmp_v1enable) {
2175                         CTR5(KTR_IGMPV3,
2176                             "%s: transition from v%d -> v%d on %p(%s)",
2177                             __func__, igi->igi_version, IGMP_VERSION_3,
2178                             igi->igi_ifp, igi->igi_ifp->if_xname);
2179                         igi->igi_v1_timer = 0;
2180                         igi->igi_version = IGMP_VERSION_3;
2181                 } else {
2182                         --igi->igi_v1_timer;
2183                 }
2184                 if (igi->igi_v2_timer > 0) {
2185                         CTR3(KTR_IGMPV3,
2186                             "%s: cancel v2 timer on %p(%s)",
2187                             __func__, igi->igi_ifp, igi->igi_ifp->if_xname);
2188                         igi->igi_v2_timer = 0;
2189                 }
2190         }
2191 }
2192
2193 /*
2194  * Global slowtimo handler.
2195  * VIMAGE: Timeout handlers are expected to service all vimages.
2196  */
2197 void
2198 igmp_slowtimo(void)
2199 {
2200         VNET_ITERATOR_DECL(vnet_iter);
2201
2202         VNET_LIST_RLOCK_NOSLEEP();
2203         VNET_FOREACH(vnet_iter) {
2204                 CURVNET_SET(vnet_iter);
2205                 igmp_slowtimo_vnet();
2206                 CURVNET_RESTORE();
2207         }
2208         VNET_LIST_RUNLOCK_NOSLEEP();
2209 }
2210
2211 /*
2212  * Per-vnet slowtimo handler.
2213  */
2214 static void
2215 igmp_slowtimo_vnet(void)
2216 {
2217         struct igmp_ifsoftc *igi;
2218
2219         IGMP_LOCK();
2220
2221         LIST_FOREACH(igi, &V_igi_head, igi_link) {
2222                 igmp_v1v2_process_querier_timers(igi);
2223         }
2224
2225         IGMP_UNLOCK();
2226 }
2227
2228 /*
2229  * Dispatch an IGMPv1/v2 host report or leave message.
2230  * These are always small enough to fit inside a single mbuf.
2231  */
2232 static int
2233 igmp_v1v2_queue_report(struct in_multi *inm, const int type)
2234 {
2235         struct epoch_tracker    et;
2236         struct ifnet            *ifp;
2237         struct igmp             *igmp;
2238         struct ip               *ip;
2239         struct mbuf             *m;
2240
2241         IN_MULTI_LIST_LOCK_ASSERT();
2242         IGMP_LOCK_ASSERT();
2243
2244         ifp = inm->inm_ifp;
2245
2246         m = m_gethdr(M_NOWAIT, MT_DATA);
2247         if (m == NULL)
2248                 return (ENOMEM);
2249         M_ALIGN(m, sizeof(struct ip) + sizeof(struct igmp));
2250
2251         m->m_pkthdr.len = sizeof(struct ip) + sizeof(struct igmp);
2252
2253         m->m_data += sizeof(struct ip);
2254         m->m_len = sizeof(struct igmp);
2255
2256         igmp = mtod(m, struct igmp *);
2257         igmp->igmp_type = type;
2258         igmp->igmp_code = 0;
2259         igmp->igmp_group = inm->inm_addr;
2260         igmp->igmp_cksum = 0;
2261         igmp->igmp_cksum = in_cksum(m, sizeof(struct igmp));
2262
2263         m->m_data -= sizeof(struct ip);
2264         m->m_len += sizeof(struct ip);
2265
2266         ip = mtod(m, struct ip *);
2267         ip->ip_tos = 0;
2268         ip->ip_len = htons(sizeof(struct ip) + sizeof(struct igmp));
2269         ip->ip_off = 0;
2270         ip->ip_p = IPPROTO_IGMP;
2271         ip->ip_src.s_addr = INADDR_ANY;
2272
2273         if (type == IGMP_HOST_LEAVE_MESSAGE)
2274                 ip->ip_dst.s_addr = htonl(INADDR_ALLRTRS_GROUP);
2275         else
2276                 ip->ip_dst = inm->inm_addr;
2277
2278         igmp_save_context(m, ifp);
2279
2280         m->m_flags |= M_IGMPV2;
2281         if (inm->inm_igi->igi_flags & IGIF_LOOPBACK)
2282                 m->m_flags |= M_IGMP_LOOP;
2283
2284         CTR2(KTR_IGMPV3, "%s: netisr_dispatch(NETISR_IGMP, %p)", __func__, m);
2285         NET_EPOCH_ENTER(et);
2286         netisr_dispatch(NETISR_IGMP, m);
2287         NET_EPOCH_EXIT(et);
2288
2289         return (0);
2290 }
2291
2292 /*
2293  * Process a state change from the upper layer for the given IPv4 group.
2294  *
2295  * Each socket holds a reference on the in_multi in its own ip_moptions.
2296  * The socket layer will have made the necessary updates to.the group
2297  * state, it is now up to IGMP to issue a state change report if there
2298  * has been any change between T0 (when the last state-change was issued)
2299  * and T1 (now).
2300  *
2301  * We use the IGMPv3 state machine at group level. The IGMP module
2302  * however makes the decision as to which IGMP protocol version to speak.
2303  * A state change *from* INCLUDE {} always means an initial join.
2304  * A state change *to* INCLUDE {} always means a final leave.
2305  *
2306  * FUTURE: If IGIF_V3LITE is enabled for this interface, then we can
2307  * save ourselves a bunch of work; any exclusive mode groups need not
2308  * compute source filter lists.
2309  *
2310  * VIMAGE: curvnet should have been set by caller, as this routine
2311  * is called from the socket option handlers.
2312  */
2313 int
2314 igmp_change_state(struct in_multi *inm)
2315 {
2316         struct igmp_ifsoftc *igi;
2317         struct ifnet *ifp;
2318         int error;
2319
2320         error = 0;
2321         IN_MULTI_LOCK_ASSERT();
2322         /*
2323          * Try to detect if the upper layer just asked us to change state
2324          * for an interface which has now gone away.
2325          */
2326         KASSERT(inm->inm_ifma != NULL, ("%s: no ifma", __func__));
2327         ifp = inm->inm_ifma->ifma_ifp;
2328         /*
2329          * Sanity check that netinet's notion of ifp is the
2330          * same as net's.
2331          */
2332         KASSERT(inm->inm_ifp == ifp, ("%s: bad ifp", __func__));
2333
2334         IGMP_LOCK();
2335
2336         igi = ((struct in_ifinfo *)ifp->if_afdata[AF_INET])->ii_igmp;
2337         KASSERT(igi != NULL, ("%s: no igmp_ifsoftc for ifp %p", __func__, ifp));
2338
2339         /*
2340          * If we detect a state transition to or from MCAST_UNDEFINED
2341          * for this group, then we are starting or finishing an IGMP
2342          * life cycle for this group.
2343          */
2344         if (inm->inm_st[1].iss_fmode != inm->inm_st[0].iss_fmode) {
2345                 CTR3(KTR_IGMPV3, "%s: inm transition %d -> %d", __func__,
2346                     inm->inm_st[0].iss_fmode, inm->inm_st[1].iss_fmode);
2347                 if (inm->inm_st[0].iss_fmode == MCAST_UNDEFINED) {
2348                         CTR1(KTR_IGMPV3, "%s: initial join", __func__);
2349                         error = igmp_initial_join(inm, igi);
2350                         goto out_locked;
2351                 } else if (inm->inm_st[1].iss_fmode == MCAST_UNDEFINED) {
2352                         CTR1(KTR_IGMPV3, "%s: final leave", __func__);
2353                         igmp_final_leave(inm, igi);
2354                         goto out_locked;
2355                 }
2356         } else {
2357                 CTR1(KTR_IGMPV3, "%s: filter set change", __func__);
2358         }
2359
2360         error = igmp_handle_state_change(inm, igi);
2361
2362 out_locked:
2363         IGMP_UNLOCK();
2364         return (error);
2365 }
2366
2367 /*
2368  * Perform the initial join for an IGMP group.
2369  *
2370  * When joining a group:
2371  *  If the group should have its IGMP traffic suppressed, do nothing.
2372  *  IGMPv1 starts sending IGMPv1 host membership reports.
2373  *  IGMPv2 starts sending IGMPv2 host membership reports.
2374  *  IGMPv3 will schedule an IGMPv3 state-change report containing the
2375  *  initial state of the membership.
2376  */
2377 static int
2378 igmp_initial_join(struct in_multi *inm, struct igmp_ifsoftc *igi)
2379 {
2380         struct ifnet            *ifp;
2381         struct mbufq            *mq;
2382         int                      error, retval, syncstates;
2383
2384         CTR4(KTR_IGMPV3, "%s: initial join 0x%08x on ifp %p(%s)", __func__,
2385             ntohl(inm->inm_addr.s_addr), inm->inm_ifp, inm->inm_ifp->if_xname);
2386
2387         error = 0;
2388         syncstates = 1;
2389
2390         ifp = inm->inm_ifp;
2391
2392         IN_MULTI_LOCK_ASSERT();
2393         IGMP_LOCK_ASSERT();
2394
2395         KASSERT(igi && igi->igi_ifp == ifp, ("%s: inconsistent ifp", __func__));
2396
2397         /*
2398          * Groups joined on loopback or marked as 'not reported',
2399          * e.g. 224.0.0.1, enter the IGMP_SILENT_MEMBER state and
2400          * are never reported in any IGMP protocol exchanges.
2401          * All other groups enter the appropriate IGMP state machine
2402          * for the version in use on this link.
2403          * A link marked as IGIF_SILENT causes IGMP to be completely
2404          * disabled for the link.
2405          */
2406         if ((ifp->if_flags & IFF_LOOPBACK) ||
2407             (igi->igi_flags & IGIF_SILENT) ||
2408             !igmp_isgroupreported(inm->inm_addr)) {
2409                 CTR1(KTR_IGMPV3,
2410 "%s: not kicking state machine for silent group", __func__);
2411                 inm->inm_state = IGMP_SILENT_MEMBER;
2412                 inm->inm_timer = 0;
2413         } else {
2414                 /*
2415                  * Deal with overlapping in_multi lifecycle.
2416                  * If this group was LEAVING, then make sure
2417                  * we drop the reference we picked up to keep the
2418                  * group around for the final INCLUDE {} enqueue.
2419                  */
2420                 if (igi->igi_version == IGMP_VERSION_3 &&
2421                     inm->inm_state == IGMP_LEAVING_MEMBER) {
2422                         MPASS(inm->inm_refcount > 1);
2423                         inm_rele_locked(NULL, inm);
2424                 }
2425                 inm->inm_state = IGMP_REPORTING_MEMBER;
2426
2427                 switch (igi->igi_version) {
2428                 case IGMP_VERSION_1:
2429                 case IGMP_VERSION_2:
2430                         inm->inm_state = IGMP_IDLE_MEMBER;
2431                         error = igmp_v1v2_queue_report(inm,
2432                             (igi->igi_version == IGMP_VERSION_2) ?
2433                              IGMP_v2_HOST_MEMBERSHIP_REPORT :
2434                              IGMP_v1_HOST_MEMBERSHIP_REPORT);
2435                         if (error == 0) {
2436                                 inm->inm_timer = IGMP_RANDOM_DELAY(
2437                                     IGMP_V1V2_MAX_RI * PR_FASTHZ);
2438                                 V_current_state_timers_running = 1;
2439                         }
2440                         break;
2441
2442                 case IGMP_VERSION_3:
2443                         /*
2444                          * Defer update of T0 to T1, until the first copy
2445                          * of the state change has been transmitted.
2446                          */
2447                         syncstates = 0;
2448
2449                         /*
2450                          * Immediately enqueue a State-Change Report for
2451                          * this interface, freeing any previous reports.
2452                          * Don't kick the timers if there is nothing to do,
2453                          * or if an error occurred.
2454                          */
2455                         mq = &inm->inm_scq;
2456                         mbufq_drain(mq);
2457                         retval = igmp_v3_enqueue_group_record(mq, inm, 1,
2458                             0, 0);
2459                         CTR2(KTR_IGMPV3, "%s: enqueue record = %d",
2460                             __func__, retval);
2461                         if (retval <= 0) {
2462                                 error = retval * -1;
2463                                 break;
2464                         }
2465
2466                         /*
2467                          * Schedule transmission of pending state-change
2468                          * report up to RV times for this link. The timer
2469                          * will fire at the next igmp_fasttimo (~200ms),
2470                          * giving us an opportunity to merge the reports.
2471                          */
2472                         if (igi->igi_flags & IGIF_LOOPBACK) {
2473                                 inm->inm_scrv = 1;
2474                         } else {
2475                                 KASSERT(igi->igi_rv > 1,
2476                                    ("%s: invalid robustness %d", __func__,
2477                                     igi->igi_rv));
2478                                 inm->inm_scrv = igi->igi_rv;
2479                         }
2480                         inm->inm_sctimer = 1;
2481                         V_state_change_timers_running = 1;
2482
2483                         error = 0;
2484                         break;
2485                 }
2486         }
2487
2488         /*
2489          * Only update the T0 state if state change is atomic,
2490          * i.e. we don't need to wait for a timer to fire before we
2491          * can consider the state change to have been communicated.
2492          */
2493         if (syncstates) {
2494                 inm_commit(inm);
2495                 CTR3(KTR_IGMPV3, "%s: T1 -> T0 for 0x%08x/%s", __func__,
2496                     ntohl(inm->inm_addr.s_addr), inm->inm_ifp->if_xname);
2497         }
2498
2499         return (error);
2500 }
2501
2502 /*
2503  * Issue an intermediate state change during the IGMP life-cycle.
2504  */
2505 static int
2506 igmp_handle_state_change(struct in_multi *inm, struct igmp_ifsoftc *igi)
2507 {
2508         struct ifnet            *ifp;
2509         int                      retval;
2510
2511         CTR4(KTR_IGMPV3, "%s: state change for 0x%08x on ifp %p(%s)", __func__,
2512             ntohl(inm->inm_addr.s_addr), inm->inm_ifp, inm->inm_ifp->if_xname);
2513
2514         ifp = inm->inm_ifp;
2515
2516         IN_MULTI_LIST_LOCK_ASSERT();
2517         IGMP_LOCK_ASSERT();
2518
2519         KASSERT(igi && igi->igi_ifp == ifp, ("%s: inconsistent ifp", __func__));
2520
2521         if ((ifp->if_flags & IFF_LOOPBACK) ||
2522             (igi->igi_flags & IGIF_SILENT) ||
2523             !igmp_isgroupreported(inm->inm_addr) ||
2524             (igi->igi_version != IGMP_VERSION_3)) {
2525                 if (!igmp_isgroupreported(inm->inm_addr)) {
2526                         CTR1(KTR_IGMPV3,
2527 "%s: not kicking state machine for silent group", __func__);
2528                 }
2529                 CTR1(KTR_IGMPV3, "%s: nothing to do", __func__);
2530                 inm_commit(inm);
2531                 CTR3(KTR_IGMPV3, "%s: T1 -> T0 for 0x%08x/%s", __func__,
2532                     ntohl(inm->inm_addr.s_addr), inm->inm_ifp->if_xname);
2533                 return (0);
2534         }
2535
2536         mbufq_drain(&inm->inm_scq);
2537
2538         retval = igmp_v3_enqueue_group_record(&inm->inm_scq, inm, 1, 0, 0);
2539         CTR2(KTR_IGMPV3, "%s: enqueue record = %d", __func__, retval);
2540         if (retval <= 0)
2541                 return (-retval);
2542
2543         /*
2544          * If record(s) were enqueued, start the state-change
2545          * report timer for this group.
2546          */
2547         inm->inm_scrv = ((igi->igi_flags & IGIF_LOOPBACK) ? 1 : igi->igi_rv);
2548         inm->inm_sctimer = 1;
2549         V_state_change_timers_running = 1;
2550
2551         return (0);
2552 }
2553
2554 /*
2555  * Perform the final leave for an IGMP group.
2556  *
2557  * When leaving a group:
2558  *  IGMPv1 does nothing.
2559  *  IGMPv2 sends a host leave message, if and only if we are the reporter.
2560  *  IGMPv3 enqueues a state-change report containing a transition
2561  *  to INCLUDE {} for immediate transmission.
2562  */
2563 static void
2564 igmp_final_leave(struct in_multi *inm, struct igmp_ifsoftc *igi)
2565 {
2566         int syncstates;
2567
2568         syncstates = 1;
2569
2570         CTR4(KTR_IGMPV3, "%s: final leave 0x%08x on ifp %p(%s)",
2571             __func__, ntohl(inm->inm_addr.s_addr), inm->inm_ifp,
2572             inm->inm_ifp->if_xname);
2573
2574         IN_MULTI_LIST_LOCK_ASSERT();
2575         IGMP_LOCK_ASSERT();
2576
2577         switch (inm->inm_state) {
2578         case IGMP_NOT_MEMBER:
2579         case IGMP_SILENT_MEMBER:
2580         case IGMP_LEAVING_MEMBER:
2581                 /* Already leaving or left; do nothing. */
2582                 CTR1(KTR_IGMPV3,
2583 "%s: not kicking state machine for silent group", __func__);
2584                 break;
2585         case IGMP_REPORTING_MEMBER:
2586         case IGMP_IDLE_MEMBER:
2587         case IGMP_G_QUERY_PENDING_MEMBER:
2588         case IGMP_SG_QUERY_PENDING_MEMBER:
2589                 if (igi->igi_version == IGMP_VERSION_2) {
2590 #ifdef INVARIANTS
2591                         if (inm->inm_state == IGMP_G_QUERY_PENDING_MEMBER ||
2592                             inm->inm_state == IGMP_SG_QUERY_PENDING_MEMBER)
2593                         panic("%s: IGMPv3 state reached, not IGMPv3 mode",
2594                              __func__);
2595 #endif
2596                         igmp_v1v2_queue_report(inm, IGMP_HOST_LEAVE_MESSAGE);
2597                         inm->inm_state = IGMP_NOT_MEMBER;
2598                 } else if (igi->igi_version == IGMP_VERSION_3) {
2599                         /*
2600                          * Stop group timer and all pending reports.
2601                          * Immediately enqueue a state-change report
2602                          * TO_IN {} to be sent on the next fast timeout,
2603                          * giving us an opportunity to merge reports.
2604                          */
2605                         mbufq_drain(&inm->inm_scq);
2606                         inm->inm_timer = 0;
2607                         if (igi->igi_flags & IGIF_LOOPBACK) {
2608                                 inm->inm_scrv = 1;
2609                         } else {
2610                                 inm->inm_scrv = igi->igi_rv;
2611                         }
2612                         CTR4(KTR_IGMPV3, "%s: Leaving 0x%08x/%s with %d "
2613                             "pending retransmissions.", __func__,
2614                             ntohl(inm->inm_addr.s_addr),
2615                             inm->inm_ifp->if_xname, inm->inm_scrv);
2616                         if (inm->inm_scrv == 0) {
2617                                 inm->inm_state = IGMP_NOT_MEMBER;
2618                                 inm->inm_sctimer = 0;
2619                         } else {
2620                                 int retval __unused;
2621
2622                                 inm_acquire_locked(inm);
2623
2624                                 retval = igmp_v3_enqueue_group_record(
2625                                     &inm->inm_scq, inm, 1, 0, 0);
2626                                 KASSERT(retval != 0,
2627                                     ("%s: enqueue record = %d", __func__,
2628                                      retval));
2629
2630                                 inm->inm_state = IGMP_LEAVING_MEMBER;
2631                                 inm->inm_sctimer = 1;
2632                                 V_state_change_timers_running = 1;
2633                                 syncstates = 0;
2634                         }
2635                         break;
2636                 }
2637                 break;
2638         case IGMP_LAZY_MEMBER:
2639         case IGMP_SLEEPING_MEMBER:
2640         case IGMP_AWAKENING_MEMBER:
2641                 /* Our reports are suppressed; do nothing. */
2642                 break;
2643         }
2644
2645         if (syncstates) {
2646                 inm_commit(inm);
2647                 CTR3(KTR_IGMPV3, "%s: T1 -> T0 for 0x%08x/%s", __func__,
2648                     ntohl(inm->inm_addr.s_addr), inm->inm_ifp->if_xname);
2649                 inm->inm_st[1].iss_fmode = MCAST_UNDEFINED;
2650                 CTR3(KTR_IGMPV3, "%s: T1 now MCAST_UNDEFINED for 0x%08x/%s",
2651                     __func__, ntohl(inm->inm_addr.s_addr),
2652                     inm->inm_ifp->if_xname);
2653         }
2654 }
2655
2656 /*
2657  * Enqueue an IGMPv3 group record to the given output queue.
2658  *
2659  * XXX This function could do with having the allocation code
2660  * split out, and the multiple-tree-walks coalesced into a single
2661  * routine as has been done in igmp_v3_enqueue_filter_change().
2662  *
2663  * If is_state_change is zero, a current-state record is appended.
2664  * If is_state_change is non-zero, a state-change report is appended.
2665  *
2666  * If is_group_query is non-zero, an mbuf packet chain is allocated.
2667  * If is_group_query is zero, and if there is a packet with free space
2668  * at the tail of the queue, it will be appended to providing there
2669  * is enough free space.
2670  * Otherwise a new mbuf packet chain is allocated.
2671  *
2672  * If is_source_query is non-zero, each source is checked to see if
2673  * it was recorded for a Group-Source query, and will be omitted if
2674  * it is not both in-mode and recorded.
2675  *
2676  * The function will attempt to allocate leading space in the packet
2677  * for the IP/IGMP header to be prepended without fragmenting the chain.
2678  *
2679  * If successful the size of all data appended to the queue is returned,
2680  * otherwise an error code less than zero is returned, or zero if
2681  * no record(s) were appended.
2682  */
2683 static int
2684 igmp_v3_enqueue_group_record(struct mbufq *mq, struct in_multi *inm,
2685     const int is_state_change, const int is_group_query,
2686     const int is_source_query)
2687 {
2688         struct igmp_grouprec     ig;
2689         struct igmp_grouprec    *pig;
2690         struct ifnet            *ifp;
2691         struct ip_msource       *ims, *nims;
2692         struct mbuf             *m0, *m, *md;
2693         int                      is_filter_list_change;
2694         int                      minrec0len, m0srcs, msrcs, nbytes, off;
2695         int                      record_has_sources;
2696         int                      now;
2697         int                      type;
2698         in_addr_t                naddr;
2699         uint8_t                  mode;
2700
2701         IN_MULTI_LIST_LOCK_ASSERT();
2702
2703         ifp = inm->inm_ifp;
2704         is_filter_list_change = 0;
2705         m = NULL;
2706         m0 = NULL;
2707         m0srcs = 0;
2708         msrcs = 0;
2709         nbytes = 0;
2710         nims = NULL;
2711         record_has_sources = 1;
2712         pig = NULL;
2713         type = IGMP_DO_NOTHING;
2714         mode = inm->inm_st[1].iss_fmode;
2715
2716         /*
2717          * If we did not transition out of ASM mode during t0->t1,
2718          * and there are no source nodes to process, we can skip
2719          * the generation of source records.
2720          */
2721         if (inm->inm_st[0].iss_asm > 0 && inm->inm_st[1].iss_asm > 0 &&
2722             inm->inm_nsrc == 0)
2723                 record_has_sources = 0;
2724
2725         if (is_state_change) {
2726                 /*
2727                  * Queue a state change record.
2728                  * If the mode did not change, and there are non-ASM
2729                  * listeners or source filters present,
2730                  * we potentially need to issue two records for the group.
2731                  * If we are transitioning to MCAST_UNDEFINED, we need
2732                  * not send any sources.
2733                  * If there are ASM listeners, and there was no filter
2734                  * mode transition of any kind, do nothing.
2735                  */
2736                 if (mode != inm->inm_st[0].iss_fmode) {
2737                         if (mode == MCAST_EXCLUDE) {
2738                                 CTR1(KTR_IGMPV3, "%s: change to EXCLUDE",
2739                                     __func__);
2740                                 type = IGMP_CHANGE_TO_EXCLUDE_MODE;
2741                         } else {
2742                                 CTR1(KTR_IGMPV3, "%s: change to INCLUDE",
2743                                     __func__);
2744                                 type = IGMP_CHANGE_TO_INCLUDE_MODE;
2745                                 if (mode == MCAST_UNDEFINED)
2746                                         record_has_sources = 0;
2747                         }
2748                 } else {
2749                         if (record_has_sources) {
2750                                 is_filter_list_change = 1;
2751                         } else {
2752                                 type = IGMP_DO_NOTHING;
2753                         }
2754                 }
2755         } else {
2756                 /*
2757                  * Queue a current state record.
2758                  */
2759                 if (mode == MCAST_EXCLUDE) {
2760                         type = IGMP_MODE_IS_EXCLUDE;
2761                 } else if (mode == MCAST_INCLUDE) {
2762                         type = IGMP_MODE_IS_INCLUDE;
2763                         KASSERT(inm->inm_st[1].iss_asm == 0,
2764                             ("%s: inm %p is INCLUDE but ASM count is %d",
2765                              __func__, inm, inm->inm_st[1].iss_asm));
2766                 }
2767         }
2768
2769         /*
2770          * Generate the filter list changes using a separate function.
2771          */
2772         if (is_filter_list_change)
2773                 return (igmp_v3_enqueue_filter_change(mq, inm));
2774
2775         if (type == IGMP_DO_NOTHING) {
2776                 CTR3(KTR_IGMPV3, "%s: nothing to do for 0x%08x/%s", __func__,
2777                     ntohl(inm->inm_addr.s_addr), inm->inm_ifp->if_xname);
2778                 return (0);
2779         }
2780
2781         /*
2782          * If any sources are present, we must be able to fit at least
2783          * one in the trailing space of the tail packet's mbuf,
2784          * ideally more.
2785          */
2786         minrec0len = sizeof(struct igmp_grouprec);
2787         if (record_has_sources)
2788                 minrec0len += sizeof(in_addr_t);
2789
2790         CTR4(KTR_IGMPV3, "%s: queueing %s for 0x%08x/%s", __func__,
2791             igmp_rec_type_to_str(type), ntohl(inm->inm_addr.s_addr),
2792             inm->inm_ifp->if_xname);
2793
2794         /*
2795          * Check if we have a packet in the tail of the queue for this
2796          * group into which the first group record for this group will fit.
2797          * Otherwise allocate a new packet.
2798          * Always allocate leading space for IP+RA_OPT+IGMP+REPORT.
2799          * Note: Group records for G/GSR query responses MUST be sent
2800          * in their own packet.
2801          */
2802         m0 = mbufq_last(mq);
2803         if (!is_group_query &&
2804             m0 != NULL &&
2805             (m0->m_pkthdr.PH_vt.vt_nrecs + 1 <= IGMP_V3_REPORT_MAXRECS) &&
2806             (m0->m_pkthdr.len + minrec0len) <
2807              (ifp->if_mtu - IGMP_LEADINGSPACE)) {
2808                 m0srcs = (ifp->if_mtu - m0->m_pkthdr.len -
2809                             sizeof(struct igmp_grouprec)) / sizeof(in_addr_t);
2810                 m = m0;
2811                 CTR1(KTR_IGMPV3, "%s: use existing packet", __func__);
2812         } else {
2813                 if (mbufq_full(mq)) {
2814                         CTR1(KTR_IGMPV3, "%s: outbound queue full", __func__);
2815                         return (-ENOMEM);
2816                 }
2817                 m = NULL;
2818                 m0srcs = (ifp->if_mtu - IGMP_LEADINGSPACE -
2819                     sizeof(struct igmp_grouprec)) / sizeof(in_addr_t);
2820                 if (!is_state_change && !is_group_query) {
2821                         m = m_getcl(M_NOWAIT, MT_DATA, M_PKTHDR);
2822                         if (m)
2823                                 m->m_data += IGMP_LEADINGSPACE;
2824                 }
2825                 if (m == NULL) {
2826                         m = m_gethdr(M_NOWAIT, MT_DATA);
2827                         if (m)
2828                                 M_ALIGN(m, IGMP_LEADINGSPACE);
2829                 }
2830                 if (m == NULL)
2831                         return (-ENOMEM);
2832
2833                 igmp_save_context(m, ifp);
2834
2835                 CTR1(KTR_IGMPV3, "%s: allocated first packet", __func__);
2836         }
2837
2838         /*
2839          * Append group record.
2840          * If we have sources, we don't know how many yet.
2841          */
2842         ig.ig_type = type;
2843         ig.ig_datalen = 0;
2844         ig.ig_numsrc = 0;
2845         ig.ig_group = inm->inm_addr;
2846         if (!m_append(m, sizeof(struct igmp_grouprec), (void *)&ig)) {
2847                 if (m != m0)
2848                         m_freem(m);
2849                 CTR1(KTR_IGMPV3, "%s: m_append() failed.", __func__);
2850                 return (-ENOMEM);
2851         }
2852         nbytes += sizeof(struct igmp_grouprec);
2853
2854         /*
2855          * Append as many sources as will fit in the first packet.
2856          * If we are appending to a new packet, the chain allocation
2857          * may potentially use clusters; use m_getptr() in this case.
2858          * If we are appending to an existing packet, we need to obtain
2859          * a pointer to the group record after m_append(), in case a new
2860          * mbuf was allocated.
2861          * Only append sources which are in-mode at t1. If we are
2862          * transitioning to MCAST_UNDEFINED state on the group, do not
2863          * include source entries.
2864          * Only report recorded sources in our filter set when responding
2865          * to a group-source query.
2866          */
2867         if (record_has_sources) {
2868                 if (m == m0) {
2869                         md = m_last(m);
2870                         pig = (struct igmp_grouprec *)(mtod(md, uint8_t *) +
2871                             md->m_len - nbytes);
2872                 } else {
2873                         md = m_getptr(m, 0, &off);
2874                         pig = (struct igmp_grouprec *)(mtod(md, uint8_t *) +
2875                             off);
2876                 }
2877                 msrcs = 0;
2878                 RB_FOREACH_SAFE(ims, ip_msource_tree, &inm->inm_srcs, nims) {
2879                         CTR2(KTR_IGMPV3, "%s: visit node 0x%08x", __func__,
2880                             ims->ims_haddr);
2881                         now = ims_get_mode(inm, ims, 1);
2882                         CTR2(KTR_IGMPV3, "%s: node is %d", __func__, now);
2883                         if ((now != mode) ||
2884                             (now == mode && mode == MCAST_UNDEFINED)) {
2885                                 CTR1(KTR_IGMPV3, "%s: skip node", __func__);
2886                                 continue;
2887                         }
2888                         if (is_source_query && ims->ims_stp == 0) {
2889                                 CTR1(KTR_IGMPV3, "%s: skip unrecorded node",
2890                                     __func__);
2891                                 continue;
2892                         }
2893                         CTR1(KTR_IGMPV3, "%s: append node", __func__);
2894                         naddr = htonl(ims->ims_haddr);
2895                         if (!m_append(m, sizeof(in_addr_t), (void *)&naddr)) {
2896                                 if (m != m0)
2897                                         m_freem(m);
2898                                 CTR1(KTR_IGMPV3, "%s: m_append() failed.",
2899                                     __func__);
2900                                 return (-ENOMEM);
2901                         }
2902                         nbytes += sizeof(in_addr_t);
2903                         ++msrcs;
2904                         if (msrcs == m0srcs)
2905                                 break;
2906                 }
2907                 CTR2(KTR_IGMPV3, "%s: msrcs is %d this packet", __func__,
2908                     msrcs);
2909                 pig->ig_numsrc = htons(msrcs);
2910                 nbytes += (msrcs * sizeof(in_addr_t));
2911         }
2912
2913         if (is_source_query && msrcs == 0) {
2914                 CTR1(KTR_IGMPV3, "%s: no recorded sources to report", __func__);
2915                 if (m != m0)
2916                         m_freem(m);
2917                 return (0);
2918         }
2919
2920         /*
2921          * We are good to go with first packet.
2922          */
2923         if (m != m0) {
2924                 CTR1(KTR_IGMPV3, "%s: enqueueing first packet", __func__);
2925                 m->m_pkthdr.PH_vt.vt_nrecs = 1;
2926                 mbufq_enqueue(mq, m);
2927         } else
2928                 m->m_pkthdr.PH_vt.vt_nrecs++;
2929
2930         /*
2931          * No further work needed if no source list in packet(s).
2932          */
2933         if (!record_has_sources)
2934                 return (nbytes);
2935
2936         /*
2937          * Whilst sources remain to be announced, we need to allocate
2938          * a new packet and fill out as many sources as will fit.
2939          * Always try for a cluster first.
2940          */
2941         while (nims != NULL) {
2942                 if (mbufq_full(mq)) {
2943                         CTR1(KTR_IGMPV3, "%s: outbound queue full", __func__);
2944                         return (-ENOMEM);
2945                 }
2946                 m = m_getcl(M_NOWAIT, MT_DATA, M_PKTHDR);
2947                 if (m)
2948                         m->m_data += IGMP_LEADINGSPACE;
2949                 if (m == NULL) {
2950                         m = m_gethdr(M_NOWAIT, MT_DATA);
2951                         if (m)
2952                                 M_ALIGN(m, IGMP_LEADINGSPACE);
2953                 }
2954                 if (m == NULL)
2955                         return (-ENOMEM);
2956                 igmp_save_context(m, ifp);
2957                 md = m_getptr(m, 0, &off);
2958                 pig = (struct igmp_grouprec *)(mtod(md, uint8_t *) + off);
2959                 CTR1(KTR_IGMPV3, "%s: allocated next packet", __func__);
2960
2961                 if (!m_append(m, sizeof(struct igmp_grouprec), (void *)&ig)) {
2962                         if (m != m0)
2963                                 m_freem(m);
2964                         CTR1(KTR_IGMPV3, "%s: m_append() failed.", __func__);
2965                         return (-ENOMEM);
2966                 }
2967                 m->m_pkthdr.PH_vt.vt_nrecs = 1;
2968                 nbytes += sizeof(struct igmp_grouprec);
2969
2970                 m0srcs = (ifp->if_mtu - IGMP_LEADINGSPACE -
2971                     sizeof(struct igmp_grouprec)) / sizeof(in_addr_t);
2972
2973                 msrcs = 0;
2974                 RB_FOREACH_FROM(ims, ip_msource_tree, nims) {
2975                         CTR2(KTR_IGMPV3, "%s: visit node 0x%08x", __func__,
2976                             ims->ims_haddr);
2977                         now = ims_get_mode(inm, ims, 1);
2978                         if ((now != mode) ||
2979                             (now == mode && mode == MCAST_UNDEFINED)) {
2980                                 CTR1(KTR_IGMPV3, "%s: skip node", __func__);
2981                                 continue;
2982                         }
2983                         if (is_source_query && ims->ims_stp == 0) {
2984                                 CTR1(KTR_IGMPV3, "%s: skip unrecorded node",
2985                                     __func__);
2986                                 continue;
2987                         }
2988                         CTR1(KTR_IGMPV3, "%s: append node", __func__);
2989                         naddr = htonl(ims->ims_haddr);
2990                         if (!m_append(m, sizeof(in_addr_t), (void *)&naddr)) {
2991                                 if (m != m0)
2992                                         m_freem(m);
2993                                 CTR1(KTR_IGMPV3, "%s: m_append() failed.",
2994                                     __func__);
2995                                 return (-ENOMEM);
2996                         }
2997                         ++msrcs;
2998                         if (msrcs == m0srcs)
2999                                 break;
3000                 }
3001                 pig->ig_numsrc = htons(msrcs);
3002                 nbytes += (msrcs * sizeof(in_addr_t));
3003
3004                 CTR1(KTR_IGMPV3, "%s: enqueueing next packet", __func__);
3005                 mbufq_enqueue(mq, m);
3006         }
3007
3008         return (nbytes);
3009 }
3010
3011 /*
3012  * Type used to mark record pass completion.
3013  * We exploit the fact we can cast to this easily from the
3014  * current filter modes on each ip_msource node.
3015  */
3016 typedef enum {
3017         REC_NONE = 0x00,        /* MCAST_UNDEFINED */
3018         REC_ALLOW = 0x01,       /* MCAST_INCLUDE */
3019         REC_BLOCK = 0x02,       /* MCAST_EXCLUDE */
3020         REC_FULL = REC_ALLOW | REC_BLOCK
3021 } rectype_t;
3022
3023 /*
3024  * Enqueue an IGMPv3 filter list change to the given output queue.
3025  *
3026  * Source list filter state is held in an RB-tree. When the filter list
3027  * for a group is changed without changing its mode, we need to compute
3028  * the deltas between T0 and T1 for each source in the filter set,
3029  * and enqueue the appropriate ALLOW_NEW/BLOCK_OLD records.
3030  *
3031  * As we may potentially queue two record types, and the entire R-B tree
3032  * needs to be walked at once, we break this out into its own function
3033  * so we can generate a tightly packed queue of packets.
3034  *
3035  * XXX This could be written to only use one tree walk, although that makes
3036  * serializing into the mbuf chains a bit harder. For now we do two walks
3037  * which makes things easier on us, and it may or may not be harder on
3038  * the L2 cache.
3039  *
3040  * If successful the size of all data appended to the queue is returned,
3041  * otherwise an error code less than zero is returned, or zero if
3042  * no record(s) were appended.
3043  */
3044 static int
3045 igmp_v3_enqueue_filter_change(struct mbufq *mq, struct in_multi *inm)
3046 {
3047         static const int MINRECLEN =
3048             sizeof(struct igmp_grouprec) + sizeof(in_addr_t);
3049         struct ifnet            *ifp;
3050         struct igmp_grouprec     ig;
3051         struct igmp_grouprec    *pig;
3052         struct ip_msource       *ims, *nims;
3053         struct mbuf             *m, *m0, *md;
3054         in_addr_t                naddr;
3055         int                      m0srcs, nbytes, npbytes, off, rsrcs, schanged;
3056         int                      nallow, nblock;
3057         uint8_t                  mode, now, then;
3058         rectype_t                crt, drt, nrt;
3059
3060         IN_MULTI_LIST_LOCK_ASSERT();
3061
3062         if (inm->inm_nsrc == 0 ||
3063             (inm->inm_st[0].iss_asm > 0 && inm->inm_st[1].iss_asm > 0))
3064                 return (0);
3065
3066         ifp = inm->inm_ifp;                     /* interface */
3067         mode = inm->inm_st[1].iss_fmode;        /* filter mode at t1 */
3068         crt = REC_NONE; /* current group record type */
3069         drt = REC_NONE; /* mask of completed group record types */
3070         nrt = REC_NONE; /* record type for current node */
3071         m0srcs = 0;     /* # source which will fit in current mbuf chain */
3072         nbytes = 0;     /* # of bytes appended to group's state-change queue */
3073         npbytes = 0;    /* # of bytes appended this packet */
3074         rsrcs = 0;      /* # sources encoded in current record */
3075         schanged = 0;   /* # nodes encoded in overall filter change */
3076         nallow = 0;     /* # of source entries in ALLOW_NEW */
3077         nblock = 0;     /* # of source entries in BLOCK_OLD */
3078         nims = NULL;    /* next tree node pointer */
3079
3080         /*
3081          * For each possible filter record mode.
3082          * The first kind of source we encounter tells us which
3083          * is the first kind of record we start appending.
3084          * If a node transitioned to UNDEFINED at t1, its mode is treated
3085          * as the inverse of the group's filter mode.
3086          */
3087         while (drt != REC_FULL) {
3088                 do {
3089                         m0 = mbufq_last(mq);
3090                         if (m0 != NULL &&
3091                             (m0->m_pkthdr.PH_vt.vt_nrecs + 1 <=
3092                              IGMP_V3_REPORT_MAXRECS) &&
3093                             (m0->m_pkthdr.len + MINRECLEN) <
3094                              (ifp->if_mtu - IGMP_LEADINGSPACE)) {
3095                                 m = m0;
3096                                 m0srcs = (ifp->if_mtu - m0->m_pkthdr.len -
3097                                             sizeof(struct igmp_grouprec)) /
3098                                     sizeof(in_addr_t);
3099                                 CTR1(KTR_IGMPV3,
3100                                     "%s: use previous packet", __func__);
3101                         } else {
3102                                 m = m_getcl(M_NOWAIT, MT_DATA, M_PKTHDR);
3103                                 if (m)
3104                                         m->m_data += IGMP_LEADINGSPACE;
3105                                 if (m == NULL) {
3106                                         m = m_gethdr(M_NOWAIT, MT_DATA);
3107                                         if (m)
3108                                                 M_ALIGN(m, IGMP_LEADINGSPACE);
3109                                 }
3110                                 if (m == NULL) {
3111                                         CTR1(KTR_IGMPV3,
3112                                             "%s: m_get*() failed", __func__);
3113                                         return (-ENOMEM);
3114                                 }
3115                                 m->m_pkthdr.PH_vt.vt_nrecs = 0;
3116                                 igmp_save_context(m, ifp);
3117                                 m0srcs = (ifp->if_mtu - IGMP_LEADINGSPACE -
3118                                     sizeof(struct igmp_grouprec)) /
3119                                     sizeof(in_addr_t);
3120                                 npbytes = 0;
3121                                 CTR1(KTR_IGMPV3,
3122                                     "%s: allocated new packet", __func__);
3123                         }
3124                         /*
3125                          * Append the IGMP group record header to the
3126                          * current packet's data area.
3127                          * Recalculate pointer to free space for next
3128                          * group record, in case m_append() allocated
3129                          * a new mbuf or cluster.
3130                          */
3131                         memset(&ig, 0, sizeof(ig));
3132                         ig.ig_group = inm->inm_addr;
3133                         if (!m_append(m, sizeof(ig), (void *)&ig)) {
3134                                 if (m != m0)
3135                                         m_freem(m);
3136                                 CTR1(KTR_IGMPV3,
3137                                     "%s: m_append() failed", __func__);
3138                                 return (-ENOMEM);
3139                         }
3140                         npbytes += sizeof(struct igmp_grouprec);
3141                         if (m != m0) {
3142                                 /* new packet; offset in c hain */
3143                                 md = m_getptr(m, npbytes -
3144                                     sizeof(struct igmp_grouprec), &off);
3145                                 pig = (struct igmp_grouprec *)(mtod(md,
3146                                     uint8_t *) + off);
3147                         } else {
3148                                 /* current packet; offset from last append */
3149                                 md = m_last(m);
3150                                 pig = (struct igmp_grouprec *)(mtod(md,
3151                                     uint8_t *) + md->m_len -
3152                                     sizeof(struct igmp_grouprec));
3153                         }
3154                         /*
3155                          * Begin walking the tree for this record type
3156                          * pass, or continue from where we left off
3157                          * previously if we had to allocate a new packet.
3158                          * Only report deltas in-mode at t1.
3159                          * We need not report included sources as allowed
3160                          * if we are in inclusive mode on the group,
3161                          * however the converse is not true.
3162                          */
3163                         rsrcs = 0;
3164                         if (nims == NULL)
3165                                 nims = RB_MIN(ip_msource_tree, &inm->inm_srcs);
3166                         RB_FOREACH_FROM(ims, ip_msource_tree, nims) {
3167                                 CTR2(KTR_IGMPV3, "%s: visit node 0x%08x",
3168                                     __func__, ims->ims_haddr);
3169                                 now = ims_get_mode(inm, ims, 1);
3170                                 then = ims_get_mode(inm, ims, 0);
3171                                 CTR3(KTR_IGMPV3, "%s: mode: t0 %d, t1 %d",
3172                                     __func__, then, now);
3173                                 if (now == then) {
3174                                         CTR1(KTR_IGMPV3,
3175                                             "%s: skip unchanged", __func__);
3176                                         continue;
3177                                 }
3178                                 if (mode == MCAST_EXCLUDE &&
3179                                     now == MCAST_INCLUDE) {
3180                                         CTR1(KTR_IGMPV3,
3181                                             "%s: skip IN src on EX group",
3182                                             __func__);
3183                                         continue;
3184                                 }
3185                                 nrt = (rectype_t)now;
3186                                 if (nrt == REC_NONE)
3187                                         nrt = (rectype_t)(~mode & REC_FULL);
3188                                 if (schanged++ == 0) {
3189                                         crt = nrt;
3190                                 } else if (crt != nrt)
3191                                         continue;
3192                                 naddr = htonl(ims->ims_haddr);
3193                                 if (!m_append(m, sizeof(in_addr_t),
3194                                     (void *)&naddr)) {
3195                                         if (m != m0)
3196                                                 m_freem(m);
3197                                         CTR1(KTR_IGMPV3,
3198                                             "%s: m_append() failed", __func__);
3199                                         return (-ENOMEM);
3200                                 }
3201                                 nallow += !!(crt == REC_ALLOW);
3202                                 nblock += !!(crt == REC_BLOCK);
3203                                 if (++rsrcs == m0srcs)
3204                                         break;
3205                         }
3206                         /*
3207                          * If we did not append any tree nodes on this
3208                          * pass, back out of allocations.
3209                          */
3210                         if (rsrcs == 0) {
3211                                 npbytes -= sizeof(struct igmp_grouprec);
3212                                 if (m != m0) {
3213                                         CTR1(KTR_IGMPV3,
3214                                             "%s: m_free(m)", __func__);
3215                                         m_freem(m);
3216                                 } else {
3217                                         CTR1(KTR_IGMPV3,
3218                                             "%s: m_adj(m, -ig)", __func__);
3219                                         m_adj(m, -((int)sizeof(
3220                                             struct igmp_grouprec)));
3221                                 }
3222                                 continue;
3223                         }
3224                         npbytes += (rsrcs * sizeof(in_addr_t));
3225                         if (crt == REC_ALLOW)
3226                                 pig->ig_type = IGMP_ALLOW_NEW_SOURCES;
3227                         else if (crt == REC_BLOCK)
3228                                 pig->ig_type = IGMP_BLOCK_OLD_SOURCES;
3229                         pig->ig_numsrc = htons(rsrcs);
3230                         /*
3231                          * Count the new group record, and enqueue this
3232                          * packet if it wasn't already queued.
3233                          */
3234                         m->m_pkthdr.PH_vt.vt_nrecs++;
3235                         if (m != m0)
3236                                 mbufq_enqueue(mq, m);
3237                         nbytes += npbytes;
3238                 } while (nims != NULL);
3239                 drt |= crt;
3240                 crt = (~crt & REC_FULL);
3241         }
3242
3243         CTR3(KTR_IGMPV3, "%s: queued %d ALLOW_NEW, %d BLOCK_OLD", __func__,
3244             nallow, nblock);
3245
3246         return (nbytes);
3247 }
3248
3249 static int
3250 igmp_v3_merge_state_changes(struct in_multi *inm, struct mbufq *scq)
3251 {
3252         struct mbufq    *gq;
3253         struct mbuf     *m;             /* pending state-change */
3254         struct mbuf     *m0;            /* copy of pending state-change */
3255         struct mbuf     *mt;            /* last state-change in packet */
3256         int              docopy, domerge;
3257         u_int            recslen;
3258
3259         docopy = 0;
3260         domerge = 0;
3261         recslen = 0;
3262
3263         IN_MULTI_LIST_LOCK_ASSERT();
3264         IGMP_LOCK_ASSERT();
3265
3266         /*
3267          * If there are further pending retransmissions, make a writable
3268          * copy of each queued state-change message before merging.
3269          */
3270         if (inm->inm_scrv > 0)
3271                 docopy = 1;
3272
3273         gq = &inm->inm_scq;
3274 #ifdef KTR
3275         if (mbufq_first(gq) == NULL) {
3276                 CTR2(KTR_IGMPV3, "%s: WARNING: queue for inm %p is empty",
3277                     __func__, inm);
3278         }
3279 #endif
3280
3281         m = mbufq_first(gq);
3282         while (m != NULL) {
3283                 /*
3284                  * Only merge the report into the current packet if
3285                  * there is sufficient space to do so; an IGMPv3 report
3286                  * packet may only contain 65,535 group records.
3287                  * Always use a simple mbuf chain concatentation to do this,
3288                  * as large state changes for single groups may have
3289                  * allocated clusters.
3290                  */
3291                 domerge = 0;
3292                 mt = mbufq_last(scq);
3293                 if (mt != NULL) {
3294                         recslen = m_length(m, NULL);
3295
3296                         if ((mt->m_pkthdr.PH_vt.vt_nrecs +
3297                             m->m_pkthdr.PH_vt.vt_nrecs <=
3298                             IGMP_V3_REPORT_MAXRECS) &&
3299                             (mt->m_pkthdr.len + recslen <=
3300                             (inm->inm_ifp->if_mtu - IGMP_LEADINGSPACE)))
3301                                 domerge = 1;
3302                 }
3303
3304                 if (!domerge && mbufq_full(gq)) {
3305                         CTR2(KTR_IGMPV3,
3306                             "%s: outbound queue full, skipping whole packet %p",
3307                             __func__, m);
3308                         mt = m->m_nextpkt;
3309                         if (!docopy)
3310                                 m_freem(m);
3311                         m = mt;
3312                         continue;
3313                 }
3314
3315                 if (!docopy) {
3316                         CTR2(KTR_IGMPV3, "%s: dequeueing %p", __func__, m);
3317                         m0 = mbufq_dequeue(gq);
3318                         m = m0->m_nextpkt;
3319                 } else {
3320                         CTR2(KTR_IGMPV3, "%s: copying %p", __func__, m);
3321                         m0 = m_dup(m, M_NOWAIT);
3322                         if (m0 == NULL)
3323                                 return (ENOMEM);
3324                         m0->m_nextpkt = NULL;
3325                         m = m->m_nextpkt;
3326                 }
3327
3328                 if (!domerge) {
3329                         CTR3(KTR_IGMPV3, "%s: queueing %p to scq %p)",
3330                             __func__, m0, scq);
3331                         mbufq_enqueue(scq, m0);
3332                 } else {
3333                         struct mbuf *mtl;       /* last mbuf of packet mt */
3334
3335                         CTR3(KTR_IGMPV3, "%s: merging %p with scq tail %p)",
3336                             __func__, m0, mt);
3337
3338                         mtl = m_last(mt);
3339                         m0->m_flags &= ~M_PKTHDR;
3340                         mt->m_pkthdr.len += recslen;
3341                         mt->m_pkthdr.PH_vt.vt_nrecs +=
3342                             m0->m_pkthdr.PH_vt.vt_nrecs;
3343
3344                         mtl->m_next = m0;
3345                 }
3346         }
3347
3348         return (0);
3349 }
3350
3351 /*
3352  * Respond to a pending IGMPv3 General Query.
3353  */
3354 static void
3355 igmp_v3_dispatch_general_query(struct igmp_ifsoftc *igi)
3356 {
3357         struct ifmultiaddr      *ifma;
3358         struct ifnet            *ifp;
3359         struct in_multi         *inm;
3360         int                      retval __unused, loop;
3361
3362         IN_MULTI_LIST_LOCK_ASSERT();
3363         IGMP_LOCK_ASSERT();
3364         NET_EPOCH_ASSERT();
3365
3366         KASSERT(igi->igi_version == IGMP_VERSION_3,
3367             ("%s: called when version %d", __func__, igi->igi_version));
3368
3369         /*
3370          * Check that there are some packets queued. If so, send them first.
3371          * For large number of groups the reply to general query can take
3372          * many packets, we should finish sending them before starting of
3373          * queuing the new reply.
3374          */
3375         if (mbufq_len(&igi->igi_gq) != 0)
3376                 goto send;
3377
3378         ifp = igi->igi_ifp;
3379
3380         CK_STAILQ_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link) {
3381                 if (ifma->ifma_addr->sa_family != AF_INET ||
3382                     ifma->ifma_protospec == NULL)
3383                         continue;
3384
3385                 inm = (struct in_multi *)ifma->ifma_protospec;
3386                 KASSERT(ifp == inm->inm_ifp,
3387                     ("%s: inconsistent ifp", __func__));
3388
3389                 switch (inm->inm_state) {
3390                 case IGMP_NOT_MEMBER:
3391                 case IGMP_SILENT_MEMBER:
3392                         break;
3393                 case IGMP_REPORTING_MEMBER:
3394                 case IGMP_IDLE_MEMBER:
3395                 case IGMP_LAZY_MEMBER:
3396                 case IGMP_SLEEPING_MEMBER:
3397                 case IGMP_AWAKENING_MEMBER:
3398                         inm->inm_state = IGMP_REPORTING_MEMBER;
3399                         retval = igmp_v3_enqueue_group_record(&igi->igi_gq,
3400                             inm, 0, 0, 0);
3401                         CTR2(KTR_IGMPV3, "%s: enqueue record = %d",
3402                             __func__, retval);
3403                         break;
3404                 case IGMP_G_QUERY_PENDING_MEMBER:
3405                 case IGMP_SG_QUERY_PENDING_MEMBER:
3406                 case IGMP_LEAVING_MEMBER:
3407                         break;
3408                 }
3409         }
3410
3411 send:
3412         loop = (igi->igi_flags & IGIF_LOOPBACK) ? 1 : 0;
3413         igmp_dispatch_queue(&igi->igi_gq, IGMP_MAX_RESPONSE_BURST, loop);
3414
3415         /*
3416          * Slew transmission of bursts over 500ms intervals.
3417          */
3418         if (mbufq_first(&igi->igi_gq) != NULL) {
3419                 igi->igi_v3_timer = 1 + IGMP_RANDOM_DELAY(
3420                     IGMP_RESPONSE_BURST_INTERVAL);
3421                 V_interface_timers_running = 1;
3422         }
3423 }
3424
3425 /*
3426  * Transmit the next pending IGMP message in the output queue.
3427  *
3428  * We get called from netisr_processqueue(). A mutex private to igmpoq
3429  * will be acquired and released around this routine.
3430  *
3431  * VIMAGE: Needs to store/restore vnet pointer on a per-mbuf-chain basis.
3432  * MRT: Nothing needs to be done, as IGMP traffic is always local to
3433  * a link and uses a link-scope multicast address.
3434  */
3435 static void
3436 igmp_intr(struct mbuf *m)
3437 {
3438         struct ip_moptions       imo;
3439         struct ifnet            *ifp;
3440         struct mbuf             *ipopts, *m0;
3441         int                      error;
3442         uint32_t                 ifindex;
3443
3444         CTR2(KTR_IGMPV3, "%s: transmit %p", __func__, m);
3445
3446         /*
3447          * Set VNET image pointer from enqueued mbuf chain
3448          * before doing anything else. Whilst we use interface
3449          * indexes to guard against interface detach, they are
3450          * unique to each VIMAGE and must be retrieved.
3451          */
3452         CURVNET_SET((struct vnet *)(m->m_pkthdr.PH_loc.ptr));
3453         ifindex = igmp_restore_context(m);
3454
3455         /*
3456          * Check if the ifnet still exists. This limits the scope of
3457          * any race in the absence of a global ifp lock for low cost
3458          * (an array lookup).
3459          */
3460         ifp = ifnet_byindex(ifindex);
3461         if (ifp == NULL) {
3462                 CTR3(KTR_IGMPV3, "%s: dropped %p as ifindex %u went away.",
3463                     __func__, m, ifindex);
3464                 m_freem(m);
3465                 IPSTAT_INC(ips_noroute);
3466                 goto out;
3467         }
3468
3469         ipopts = V_igmp_sendra ? m_raopt : NULL;
3470
3471         imo.imo_multicast_ttl  = 1;
3472         imo.imo_multicast_vif  = -1;
3473         imo.imo_multicast_loop = (V_ip_mrouter != NULL);
3474
3475         /*
3476          * If the user requested that IGMP traffic be explicitly
3477          * redirected to the loopback interface (e.g. they are running a
3478          * MANET interface and the routing protocol needs to see the
3479          * updates), handle this now.
3480          */
3481         if (m->m_flags & M_IGMP_LOOP)
3482                 imo.imo_multicast_ifp = V_loif;
3483         else
3484                 imo.imo_multicast_ifp = ifp;
3485
3486         if (m->m_flags & M_IGMPV2) {
3487                 m0 = m;
3488         } else {
3489                 m0 = igmp_v3_encap_report(ifp, m);
3490                 if (m0 == NULL) {
3491                         CTR2(KTR_IGMPV3, "%s: dropped %p", __func__, m);
3492                         m_freem(m);
3493                         IPSTAT_INC(ips_odropped);
3494                         goto out;
3495                 }
3496         }
3497
3498         igmp_scrub_context(m0);
3499         m_clrprotoflags(m);
3500         m0->m_pkthdr.rcvif = V_loif;
3501 #ifdef MAC
3502         mac_netinet_igmp_send(ifp, m0);
3503 #endif
3504         error = ip_output(m0, ipopts, NULL, 0, &imo, NULL);
3505         if (error) {
3506                 CTR3(KTR_IGMPV3, "%s: ip_output(%p) = %d", __func__, m0, error);
3507                 goto out;
3508         }
3509
3510         IGMPSTAT_INC(igps_snd_reports);
3511
3512 out:
3513         /*
3514          * We must restore the existing vnet pointer before
3515          * continuing as we are run from netisr context.
3516          */
3517         CURVNET_RESTORE();
3518 }
3519
3520 /*
3521  * Encapsulate an IGMPv3 report.
3522  *
3523  * The internal mbuf flag M_IGMPV3_HDR is used to indicate that the mbuf
3524  * chain has already had its IP/IGMPv3 header prepended. In this case
3525  * the function will not attempt to prepend; the lengths and checksums
3526  * will however be re-computed.
3527  *
3528  * Returns a pointer to the new mbuf chain head, or NULL if the
3529  * allocation failed.
3530  */
3531 static struct mbuf *
3532 igmp_v3_encap_report(struct ifnet *ifp, struct mbuf *m)
3533 {
3534         struct rm_priotracker   in_ifa_tracker;
3535         struct igmp_report      *igmp;
3536         struct ip               *ip;
3537         int                      hdrlen, igmpreclen;
3538
3539         KASSERT((m->m_flags & M_PKTHDR),
3540             ("%s: mbuf chain %p is !M_PKTHDR", __func__, m));
3541
3542         igmpreclen = m_length(m, NULL);
3543         hdrlen = sizeof(struct ip) + sizeof(struct igmp_report);
3544
3545         if (m->m_flags & M_IGMPV3_HDR) {
3546                 igmpreclen -= hdrlen;
3547         } else {
3548                 M_PREPEND(m, hdrlen, M_NOWAIT);
3549                 if (m == NULL)
3550                         return (NULL);
3551                 m->m_flags |= M_IGMPV3_HDR;
3552         }
3553
3554         CTR2(KTR_IGMPV3, "%s: igmpreclen is %d", __func__, igmpreclen);
3555
3556         m->m_data += sizeof(struct ip);
3557         m->m_len -= sizeof(struct ip);
3558
3559         igmp = mtod(m, struct igmp_report *);
3560         igmp->ir_type = IGMP_v3_HOST_MEMBERSHIP_REPORT;
3561         igmp->ir_rsv1 = 0;
3562         igmp->ir_rsv2 = 0;
3563         igmp->ir_numgrps = htons(m->m_pkthdr.PH_vt.vt_nrecs);
3564         igmp->ir_cksum = 0;
3565         igmp->ir_cksum = in_cksum(m, sizeof(struct igmp_report) + igmpreclen);
3566         m->m_pkthdr.PH_vt.vt_nrecs = 0;
3567
3568         m->m_data -= sizeof(struct ip);
3569         m->m_len += sizeof(struct ip);
3570
3571         ip = mtod(m, struct ip *);
3572         ip->ip_tos = IPTOS_PREC_INTERNETCONTROL;
3573         ip->ip_len = htons(hdrlen + igmpreclen);
3574         ip->ip_off = htons(IP_DF);
3575         ip->ip_p = IPPROTO_IGMP;
3576         ip->ip_sum = 0;
3577
3578         ip->ip_src.s_addr = INADDR_ANY;
3579
3580         if (m->m_flags & M_IGMP_LOOP) {
3581                 struct in_ifaddr *ia;
3582
3583                 IFP_TO_IA(ifp, ia, &in_ifa_tracker);
3584                 if (ia != NULL)
3585                         ip->ip_src = ia->ia_addr.sin_addr;
3586         }
3587
3588         ip->ip_dst.s_addr = htonl(INADDR_ALLRPTS_GROUP);
3589
3590         return (m);
3591 }
3592
3593 #ifdef KTR
3594 static char *
3595 igmp_rec_type_to_str(const int type)
3596 {
3597
3598         switch (type) {
3599                 case IGMP_CHANGE_TO_EXCLUDE_MODE:
3600                         return "TO_EX";
3601                         break;
3602                 case IGMP_CHANGE_TO_INCLUDE_MODE:
3603                         return "TO_IN";
3604                         break;
3605                 case IGMP_MODE_IS_EXCLUDE:
3606                         return "MODE_EX";
3607                         break;
3608                 case IGMP_MODE_IS_INCLUDE:
3609                         return "MODE_IN";
3610                         break;
3611                 case IGMP_ALLOW_NEW_SOURCES:
3612                         return "ALLOW_NEW";
3613                         break;
3614                 case IGMP_BLOCK_OLD_SOURCES:
3615                         return "BLOCK_OLD";
3616                         break;
3617                 default:
3618                         break;
3619         }
3620         return "unknown";
3621 }
3622 #endif
3623
3624 #ifdef VIMAGE
3625 static void
3626 vnet_igmp_init(const void *unused __unused)
3627 {
3628
3629         netisr_register_vnet(&igmp_nh);
3630 }
3631 VNET_SYSINIT(vnet_igmp_init, SI_SUB_PROTO_MC, SI_ORDER_ANY,
3632     vnet_igmp_init, NULL);
3633
3634 static void
3635 vnet_igmp_uninit(const void *unused __unused)
3636 {
3637
3638         /* This can happen when we shutdown the entire network stack. */
3639         CTR1(KTR_IGMPV3, "%s: tearing down", __func__);
3640
3641         netisr_unregister_vnet(&igmp_nh);
3642 }
3643 VNET_SYSUNINIT(vnet_igmp_uninit, SI_SUB_PROTO_MC, SI_ORDER_ANY,
3644     vnet_igmp_uninit, NULL);
3645 #endif
3646
3647 #ifdef DDB
3648 DB_SHOW_COMMAND(igi_list, db_show_igi_list)
3649 {
3650         struct igmp_ifsoftc *igi, *tigi;
3651         LIST_HEAD(_igi_list, igmp_ifsoftc) *igi_head;
3652
3653         if (!have_addr) {
3654                 db_printf("usage: show igi_list <addr>\n");
3655                 return;
3656         }
3657         igi_head = (struct _igi_list *)addr;
3658
3659         LIST_FOREACH_SAFE(igi, igi_head, igi_link, tigi) {
3660                 db_printf("igmp_ifsoftc %p:\n", igi);
3661                 db_printf("    ifp %p\n", igi->igi_ifp);
3662                 db_printf("    version %u\n", igi->igi_version);
3663                 db_printf("    v1_timer %u\n", igi->igi_v1_timer);
3664                 db_printf("    v2_timer %u\n", igi->igi_v2_timer);
3665                 db_printf("    v3_timer %u\n", igi->igi_v3_timer);
3666                 db_printf("    flags %#x\n", igi->igi_flags);
3667                 db_printf("    rv %u\n", igi->igi_rv);
3668                 db_printf("    qi %u\n", igi->igi_qi);
3669                 db_printf("    qri %u\n", igi->igi_qri);
3670                 db_printf("    uri %u\n", igi->igi_uri);
3671                 /* struct mbufq    igi_gq; */
3672                 db_printf("\n");
3673         }
3674 }
3675 #endif
3676
3677 static int
3678 igmp_modevent(module_t mod, int type, void *unused __unused)
3679 {
3680
3681         switch (type) {
3682         case MOD_LOAD:
3683                 CTR1(KTR_IGMPV3, "%s: initializing", __func__);
3684                 IGMP_LOCK_INIT();
3685                 m_raopt = igmp_ra_alloc();
3686                 netisr_register(&igmp_nh);
3687                 break;
3688         case MOD_UNLOAD:
3689                 CTR1(KTR_IGMPV3, "%s: tearing down", __func__);
3690                 netisr_unregister(&igmp_nh);
3691                 m_free(m_raopt);
3692                 m_raopt = NULL;
3693                 IGMP_LOCK_DESTROY();
3694                 break;
3695         default:
3696                 return (EOPNOTSUPP);
3697         }
3698         return (0);
3699 }
3700
3701 static moduledata_t igmp_mod = {
3702     "igmp",
3703     igmp_modevent,
3704     0
3705 };
3706 DECLARE_MODULE(igmp, igmp_mod, SI_SUB_PROTO_MC, SI_ORDER_MIDDLE);