xref: /freebsd/sys/netinet/igmp.h (revision 35a04710d7286aa9538917fd7f8e417dbee95b82)
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 /*
49  * IGMP packet format.
50  */
51 struct igmp {
52 	u_char		igmp_type;	/* version & type of IGMP message  */
53 	u_char		igmp_code;	/* subtype for routing msgs        */
54 	u_short		igmp_cksum;	/* IP-style checksum               */
55 	struct in_addr	igmp_group;	/* group address being reported    */
56 };					/*  (zero for queries)             */
57 
58 struct igmpv3 {
59 	u_char		igmp_type;	/* version & type of IGMP message  */
60 	u_char		igmp_code;	/* subtype for routing msgs        */
61 	u_short		igmp_cksum;	/* IP-style checksum               */
62 	struct in_addr	igmp_group;	/* group address being reported    */
63 					/*  (zero for queries)             */
64 	u_char		igmp_misc;	/* reserved/suppress/robustness    */
65 	u_char		igmp_qqi;	/* querier's query interval        */
66 	u_short		igmp_numsrc;	/* number of sources               */
67 	/*struct in_addr	igmp_sources[1];*/ /* source addresses */
68 };
69 
70 struct igmp_grouprec {
71 	u_char		ig_type;	/* record type */
72 	u_char		ig_datalen;	/* length of auxiliary data */
73 	u_short		ig_numsrc;	/* number of sources */
74 	struct in_addr	ig_group;	/* group address being reported */
75 	/*struct in_addr	ig_sources[1];*/ /* source addresses */
76 };
77 
78 struct igmp_report {
79 	u_char		ir_type;	/* record type */
80 	u_char		ir_rsv1;	/* reserved */
81 	u_short		ir_cksum;	/* checksum */
82 	u_short		ir_rsv2;	/* reserved */
83 	u_short		ir_numgrps;	/* number of group records */
84 	struct		igmp_grouprec ir_groups[1];	/* group records */
85 };
86 
87 #define IGMP_MINLEN			8
88 #define IGMP_HDRLEN			8
89 #define IGMP_GRPREC_HDRLEN		8
90 #define IGMP_PREPEND			0
91 
92 #if 0
93 #define IGMP_QRV(pigmp)			((pigmp)->igmp_misc & (0x07)) /* XXX */
94 #define IGMP_MAXSOURCES(len)		(((len) - 12) >> 2) /* XXX */
95 #endif
96 
97 /*
98  * Message types, including version number.
99  */
100 #define IGMP_MEMBERSHIP_QUERY		0x11	/* membership query         */
101 #define IGMP_V1_MEMBERSHIP_REPORT	0x12	/* Ver. 1 membership report */
102 #define IGMP_V2_MEMBERSHIP_REPORT	0x16	/* Ver. 2 membership report */
103 #define IGMP_V2_LEAVE_GROUP		0x17	/* Leave-group message	    */
104 
105 #define IGMP_DVMRP			0x13	/* DVMRP routing message    */
106 #define IGMP_PIM			0x14	/* PIM routing message	    */
107 
108 #define IGMP_MTRACE_RESP		0x1e  /* traceroute resp.(to sender)*/
109 #define IGMP_MTRACE			0x1f  /* mcast traceroute messages  */
110 
111 #define IGMP_V3_MEMBERSHIP_REPORT	0x22	/* Ver. 3 membership report */
112 
113 #define IGMP_MAX_HOST_REPORT_DELAY   10    /* max delay for response to     */
114 					   /*  query (in seconds) according */
115 					   /*  to RFC1112                   */
116 
117 
118 #define IGMP_TIMER_SCALE     10		/* denotes that the igmp code field */
119 					/* specifies time in 10th of seconds*/
120 
121 /*
122  * The following four defininitions are for backwards compatibility.
123  * They should be removed as soon as all applications are updated to
124  * use the new constant names.
125  */
126 #define IGMP_HOST_MEMBERSHIP_QUERY	IGMP_MEMBERSHIP_QUERY
127 #define IGMP_HOST_MEMBERSHIP_REPORT	IGMP_V1_MEMBERSHIP_REPORT
128 #define IGMP_HOST_NEW_MEMBERSHIP_REPORT	IGMP_V2_MEMBERSHIP_REPORT
129 #define IGMP_HOST_LEAVE_MESSAGE		IGMP_V2_LEAVE_GROUP
130 
131 #endif /* _NETINET_IGMP_H_ */
132