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