1/*- 2 * SPDX-License-Identifier: BSD-3-Clause 3 * 4 * Copyright (c) 1988 Stephen Deering. 5 * Copyright (c) 1992, 1993 6 * The Regents of the University of California. All rights reserved. 7 * 8 * This code is derived from software contributed to Berkeley by 9 * Stephen Deering of Stanford University. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions and the following disclaimer. 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in the 18 * documentation and/or other materials provided with the distribution. 19 * 3. Neither the name of the University nor the names of its contributors 20 * may be used to endorse or promote products derived from this software 21 * without specific prior written permission. 22 * 23 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 26 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 33 * SUCH DAMAGE. 34 * 35 * from: @(#)igmp_var.h 8.1 (Berkeley) 7/19/93 36 * $FreeBSD$ 37 */ 38 39#ifndef _NETINET_IGMP_VAR_H_ 40#define _NETINET_IGMP_VAR_H_ 41 42/* 43 * Internet Group Management Protocol (IGMP), 44 * implementation-specific definitions. 45 * 46 * Written by Steve Deering, Stanford, May 1988. 47 * 48 * MULTICAST Revision: 3.5.1.3 49 */ 50 51/* 52 * IGMPv3 protocol statistics. 53 */ 54struct igmpstat { 55 /* 56 * Structure header (to insulate ABI changes). 57 * XXX: unset inside the kernel, exported via sysctl_igmp_stat(). 58 */ 59 uint32_t igps_version; /* version of this structure */ 60 uint32_t igps_len; /* length of this structure */ 61 /* 62 * Message statistics. 63 */ 64 uint64_t igps_rcv_total; /* total IGMP messages received */ 65 uint64_t igps_rcv_tooshort; /* received with too few bytes */ 66 uint64_t igps_rcv_badttl; /* received with ttl other than 1 */ 67 uint64_t igps_rcv_badsum; /* received with bad checksum */ 68 /* 69 * Query statistics. 70 */ 71 uint64_t igps_rcv_v1v2_queries; /* received IGMPv1/IGMPv2 queries */ 72 uint64_t igps_rcv_v3_queries; /* received IGMPv3 queries */ 73 uint64_t igps_rcv_badqueries; /* received invalid queries */ 74 uint64_t igps_rcv_gen_queries; /* received general queries */ 75 uint64_t igps_rcv_group_queries;/* received group queries */ 76 uint64_t igps_rcv_gsr_queries; /* received group-source queries */ 77 uint64_t igps_drop_gsr_queries; /* dropped group-source queries */ 78 /* 79 * Report statistics. 80 */ 81 uint64_t igps_rcv_reports; /* received membership reports */ 82 uint64_t igps_rcv_badreports; /* received invalid reports */ 83 uint64_t igps_rcv_ourreports; /* received reports for our groups */ 84 uint64_t igps_rcv_nora; /* received w/o Router Alert option */ 85 uint64_t igps_snd_reports; /* sent membership reports */ 86 /* 87 * Padding for future additions. 88 */ 89 uint64_t __igps_pad[4]; 90}; 91#define IGPS_VERSION_3 3 /* as of FreeBSD 8.x */ 92#define IGPS_VERSION3_LEN 168 93#ifdef CTASSERT 94CTASSERT(sizeof(struct igmpstat) == IGPS_VERSION3_LEN); 95#endif 96 97/* 98 * Identifiers for IGMP sysctl nodes 99 */ 100#define IGMPCTL_STATS 1 /* statistics (read-only) */ 101 102#define IGMP_RANDOM_DELAY(X) (random() % (X) + 1) 103#define IGMP_MAX_STATE_CHANGES 24 /* Max pending changes per group */ 104 105/* 106 * IGMP per-group states. 107 */ 108#define IGMP_NOT_MEMBER 0 /* Can garbage collect in_multi */ 109#define IGMP_SILENT_MEMBER 1 /* Do not perform IGMP for group */ 110#define IGMP_REPORTING_MEMBER 2 /* IGMPv1/2/3 we are reporter */ 111#define IGMP_IDLE_MEMBER 3 /* IGMPv1/2 we reported last */ 112#define IGMP_LAZY_MEMBER 4 /* IGMPv1/2 other member reporting */ 113#define IGMP_SLEEPING_MEMBER 5 /* IGMPv1/2 start query response */ 114#define IGMP_AWAKENING_MEMBER 6 /* IGMPv1/2 group timer will start */ 115#define IGMP_G_QUERY_PENDING_MEMBER 7 /* IGMPv3 group query pending */ 116#define IGMP_SG_QUERY_PENDING_MEMBER 8 /* IGMPv3 source query pending */ 117#define IGMP_LEAVING_MEMBER 9 /* IGMPv3 dying gasp (pending last */ 118 /* retransmission of INCLUDE {}) */ 119 120/* 121 * IGMP version tag. 122 */ 123#define IGMP_VERSION_NONE 0 /* Invalid */ 124#define IGMP_VERSION_1 1 125#define IGMP_VERSION_2 2 126#define IGMP_VERSION_3 3 /* Default */ 127 128/* 129 * IGMPv3 protocol control variables. 130 */ 131#define IGMP_RV_INIT 2 /* Robustness Variable */ 132#define IGMP_RV_MIN 1 133#define IGMP_RV_MAX 7 134 135#define IGMP_QI_INIT 125 /* Query Interval (s) */ 136#define IGMP_QI_MIN 1 137#define IGMP_QI_MAX 255 138 139#define IGMP_QRI_INIT 10 /* Query Response Interval (s) */ 140#define IGMP_QRI_MIN 1 141#define IGMP_QRI_MAX 255 142 143#define IGMP_URI_INIT 3 /* Unsolicited Report Interval (s) */ 144#define IGMP_URI_MIN 0 145#define IGMP_URI_MAX 10 146 147#define IGMP_MAX_G_GS_PACKETS 8 /* # of packets to answer G/GS */ 148#define IGMP_MAX_STATE_CHANGE_PACKETS 8 /* # of packets per state change */ 149#define IGMP_MAX_RESPONSE_PACKETS 16 /* # of packets for general query */ 150#define IGMP_MAX_RESPONSE_BURST 4 /* # of responses to send at once */ 151#define IGMP_RESPONSE_BURST_INTERVAL (PR_FASTHZ / 2) /* 500ms */ 152 153/* 154 * IGMP-specific mbuf flags. 155 */ 156#define M_IGMPV2 M_PROTO1 /* Packet is IGMPv2 */ 157#define M_IGMPV3_HDR M_PROTO2 /* Packet has IGMPv3 headers */ 158#define M_GROUPREC M_PROTO3 /* mbuf chain is a group record */ 159#define M_IGMP_LOOP M_PROTO4 /* transmit on loif, not real ifp */ 160 161/* 162 * Default amount of leading space for IGMPv3 to allocate at the 163 * beginning of its mbuf packet chains, to avoid fragmentation and 164 * unnecessary allocation of leading mbufs. 165 */ 166#define RAOPT_LEN 4 /* Length of IP Router Alert option */ 167#define IGMP_LEADINGSPACE \ 168 (sizeof(struct ip) + RAOPT_LEN + sizeof(struct igmp_report)) 169 170/* 171 * Structure returned by net.inet.igmp.ifinfo sysctl. 172 */ 173struct igmp_ifinfo { 174 uint32_t igi_version; /* IGMPv3 Host Compatibility Mode */ 175 uint32_t igi_v1_timer; /* IGMPv1 Querier Present timer (s) */ 176 uint32_t igi_v2_timer; /* IGMPv2 Querier Present timer (s) */ 177 uint32_t igi_v3_timer; /* IGMPv3 General Query (interface) timer (s)*/ 178 uint32_t igi_flags; /* IGMP per-interface flags */ 179#define IGIF_SILENT 0x00000001 /* Do not use IGMP on this ifp */ 180#define IGIF_LOOPBACK 0x00000002 /* Send IGMP reports to loopback */ 181 uint32_t igi_rv; /* IGMPv3 Robustness Variable */ 182 uint32_t igi_qi; /* IGMPv3 Query Interval (s) */ 183 uint32_t igi_qri; /* IGMPv3 Query Response Interval (s) */ 184 uint32_t igi_uri; /* IGMPv3 Unsolicited Report Interval (s) */ 185}; 186 187#ifdef _KERNEL 188#include <sys/counter.h> 189 190VNET_PCPUSTAT_DECLARE(struct igmpstat, igmpstat); 191#define IGMPSTAT_ADD(name, val) \ 192 VNET_PCPUSTAT_ADD(struct igmpstat, igmpstat, name, (val)) 193#define IGMPSTAT_INC(name) IGMPSTAT_ADD(name, 1) 194 195/* 196 * Subsystem lock macros. 197 * The IGMP lock is only taken with IGMP. Currently it is system-wide. 198 * VIMAGE: The lock could be pushed to per-VIMAGE granularity in future. 199 */ 200#define IGMP_LOCK_INIT() mtx_init(&igmp_mtx, "igmp_mtx", NULL, MTX_DEF) 201#define IGMP_LOCK_DESTROY() mtx_destroy(&igmp_mtx) 202#define IGMP_LOCK() mtx_lock(&igmp_mtx) 203#define IGMP_LOCK_ASSERT() mtx_assert(&igmp_mtx, MA_OWNED) 204#define IGMP_UNLOCK() mtx_unlock(&igmp_mtx) 205#define IGMP_UNLOCK_ASSERT() mtx_assert(&igmp_mtx, MA_NOTOWNED) 206 207/* 208 * Per-interface IGMP router version information. 209 */ 210struct igmp_ifsoftc { 211 LIST_ENTRY(igmp_ifsoftc) igi_link; 212 struct ifnet *igi_ifp; /* pointer back to interface */ 213 uint32_t igi_version; /* IGMPv3 Host Compatibility Mode */ 214 uint32_t igi_v1_timer; /* IGMPv1 Querier Present timer (s) */ 215 uint32_t igi_v2_timer; /* IGMPv2 Querier Present timer (s) */ 216 uint32_t igi_v3_timer; /* IGMPv3 General Query (interface) timer (s)*/ 217 uint32_t igi_flags; /* IGMP per-interface flags */ 218 uint32_t igi_rv; /* IGMPv3 Robustness Variable */ 219 uint32_t igi_qi; /* IGMPv3 Query Interval (s) */ 220 uint32_t igi_qri; /* IGMPv3 Query Response Interval (s) */ 221 uint32_t igi_uri; /* IGMPv3 Unsolicited Report Interval (s) */ 222 struct mbufq igi_gq; /* general query responses queue */ 223}; 224 225int igmp_change_state(struct in_multi *); 226void igmp_fasttimo(void); 227struct igmp_ifsoftc * 228 igmp_domifattach(struct ifnet *); 229void igmp_domifdetach(struct ifnet *); 230void igmp_ifdetach(struct ifnet *); 231int igmp_input(struct mbuf **, int *, int); 232void igmp_slowtimo(void); 233 234SYSCTL_DECL(_net_inet_igmp); 235 236#endif /* _KERNEL */ 237#endif 238