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
36#ifndef _NETINET_IGMP_H_
37#define _NETINET_IGMP_H_
38
39/*
40 * Internet Group Management Protocol (IGMP) definitions.
41 *
42 * Written by Steve Deering, Stanford, May 1988.
43 *
44 * MULTICAST Revision: 3.5.1.2
45 */
46
47/* Minimum length of any IGMP protocol message. */
48#define IGMP_MINLEN			8
49
50/*
51 * IGMPv1/v2 query and host report format.
52 */
53struct igmp {
54	u_char		igmp_type;	/* version & type of IGMP message  */
55	u_char		igmp_code;	/* subtype for routing msgs        */
56	u_short		igmp_cksum;	/* IP-style checksum               */
57	struct in_addr	igmp_group;	/* group address being reported    */
58};					/*  (zero for queries)             */
59
60/*
61 * IGMP v3 query format.
62 */
63struct igmpv3 {
64	u_char		igmp_type;	/* version & type of IGMP message  */
65	u_char		igmp_code;	/* subtype for routing msgs        */
66	u_short		igmp_cksum;	/* IP-style checksum               */
67	struct in_addr	igmp_group;	/* group address being reported    */
68					/*  (zero for queries)             */
69	u_char		igmp_misc;	/* reserved/suppress/robustness    */
70	u_char		igmp_qqi;	/* querier's query interval        */
71	u_short		igmp_numsrc;	/* number of sources               */
72	/*struct in_addr	igmp_sources[1];*/ /* source addresses */
73};
74#define IGMP_V3_QUERY_MINLEN		12
75#define IGMP_EXP(x)			(((x) >> 4) & 0x07)
76#define IGMP_MANT(x)			((x) & 0x0f)
77#define IGMP_QRESV(x)			(((x) >> 4) & 0x0f)
78#define IGMP_SFLAG(x)			(((x) >> 3) & 0x01)
79#define IGMP_QRV(x)			((x) & 0x07)
80
81struct igmp_grouprec {
82	u_char		ig_type;	/* record type */
83	u_char		ig_datalen;	/* length of auxiliary data */
84	u_short		ig_numsrc;	/* number of sources */
85	struct in_addr	ig_group;	/* group address being reported */
86	/*struct in_addr	ig_sources[1];*/ /* source addresses */
87};
88#define IGMP_GRPREC_HDRLEN		8
89
90/*
91 * IGMPv3 host membership report header.
92 */
93struct igmp_report {
94	u_char		ir_type;	/* IGMP_v3_HOST_MEMBERSHIP_REPORT */
95	u_char		ir_rsv1;	/* must be zero */
96	u_short		ir_cksum;	/* checksum */
97	u_short		ir_rsv2;	/* must be zero */
98	u_short		ir_numgrps;	/* number of group records */
99	/*struct	igmp_grouprec ir_groups[1];*/	/* group records */
100};
101#define IGMP_V3_REPORT_MINLEN		8
102#define IGMP_V3_REPORT_MAXRECS		65535
103
104/*
105 * Message types, including version number.
106 */
107#define IGMP_HOST_MEMBERSHIP_QUERY	0x11	/* membership query         */
108#define IGMP_v1_HOST_MEMBERSHIP_REPORT	0x12	/* Ver. 1 membership report */
109#define IGMP_DVMRP			0x13	/* DVMRP routing message    */
110#define IGMP_PIM			0x14	/* PIMv1 message (historic) */
111#define IGMP_v2_HOST_MEMBERSHIP_REPORT	0x16	/* Ver. 2 membership report */
112#define IGMP_HOST_LEAVE_MESSAGE		0x17	/* Leave-group message     */
113#define IGMP_MTRACE_REPLY		0x1e	/* mtrace(8) reply */
114#define IGMP_MTRACE_QUERY		0x1f	/* mtrace(8) probe */
115#define IGMP_v3_HOST_MEMBERSHIP_REPORT	0x22	/* Ver. 3 membership report */
116
117/*
118 * IGMPv3 report modes.
119 */
120#define IGMP_DO_NOTHING			0	/* don't send a record */
121#define IGMP_MODE_IS_INCLUDE		1	/* MODE_IN */
122#define IGMP_MODE_IS_EXCLUDE		2	/* MODE_EX */
123#define IGMP_CHANGE_TO_INCLUDE_MODE	3	/* TO_IN */
124#define IGMP_CHANGE_TO_EXCLUDE_MODE	4	/* TO_EX */
125#define IGMP_ALLOW_NEW_SOURCES		5	/* ALLOW_NEW */
126#define IGMP_BLOCK_OLD_SOURCES		6	/* BLOCK_OLD */
127
128/*
129 * IGMPv3 query types.
130 */
131#define IGMP_V3_GENERAL_QUERY		1
132#define IGMP_V3_GROUP_QUERY		2
133#define IGMP_V3_GROUP_SOURCE_QUERY	3
134
135/*
136 * Maximum report interval for IGMP v1/v2 host membership reports [RFC 1112]
137 */
138#define IGMP_V1V2_MAX_RI		10
139#define IGMP_MAX_HOST_REPORT_DELAY	IGMP_V1V2_MAX_RI
140
141/*
142 * IGMP_TIMER_SCALE denotes that the igmp code field specifies
143 * time in tenths of a second.
144 */
145#define IGMP_TIMER_SCALE		10
146
147#endif /* _NETINET_IGMP_H_ */
148