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