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