1/*
2 * Copyright (c) 2010 Apple, Inc. All rights reserved.
3 *
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5 *
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
14 *
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
17 *
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
25 *
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27 */
28/*
29 * Copyright (c) 1988 Stephen Deering.
30 * Copyright (c) 1992, 1993
31 * The Regents of the University of California. All rights reserved.
32 *
33 * This code is derived from software contributed to Berkeley by
34 * Stephen Deering of Stanford University.
35 *
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions
38 * are met:
39 * 1. Redistributions of source code must retain the above copyright
40 * notice, this list of conditions and the following disclaimer.
41 * 2. Redistributions in binary form must reproduce the above copyright
42 * notice, this list of conditions and the following disclaimer in the
43 * documentation and/or other materials provided with the distribution.
44 * 3. All advertising materials mentioning features or use of this software
45 * must display the following acknowledgement:
46 * This product includes software developed by the University of
47 * California, Berkeley and its contributors.
48 * 4. Neither the name of the University nor the names of its contributors
49 * may be used to endorse or promote products derived from this software
50 * without specific prior written permission.
51 *
52 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
53 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
54 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
55 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
56 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
57 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
58 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
59 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
60 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
61 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
62 * SUCH DAMAGE.
63 *
64 * @(#)igmp.h 8.1 (Berkeley) 6/10/93
65 * $FreeBSD: src/sys/netinet/igmp.h,v 1.10 1999/08/28 00:49:15 peter Exp $
66 */
67
68#ifndef _NETINET_IGMP_H_
69#define _NETINET_IGMP_H_
70#include <sys/appleapiopts.h>
71
72#include <netinet/in.h>
73#include <sys/types.h>
74
75/*
76 * Internet Group Management Protocol (IGMP) definitions.
77 *
78 * Written by Steve Deering, Stanford, May 1988.
79 *
80 * MULTICAST Revision: 3.5.1.2
81 */
82
83/* Minimum length of any IGMP protocol message. */
84#define IGMP_MINLEN 8
85
86/*
87 * IGMPv1/v2 query and host report format.
88 */
89struct igmp {
90 u_char igmp_type; /* version & type of IGMP message */
91 u_char igmp_code; /* subtype for routing msgs */
92 u_short igmp_cksum; /* IP-style checksum */
93 struct in_addr igmp_group; /* group address being reported */
94}; /* (zero for queries) */
95
96/*
97 * IGMP v3 query format.
98 */
99struct igmpv3 {
100 u_char igmp_type; /* version & type of IGMP message */
101 u_char igmp_code; /* subtype for routing msgs */
102 u_short igmp_cksum; /* IP-style checksum */
103 struct in_addr igmp_group; /* group address being reported */
104 /* (zero for queries) */
105 u_char igmp_misc; /* reserved/suppress/robustness */
106 u_char igmp_qqi; /* querier's query interval */
107 u_short igmp_numsrc; /* number of sources */
108 /*struct in_addr igmp_sources[1];*/ /* source addresses */
109};
110#define IGMP_V3_QUERY_MINLEN 12
111#define IGMP_V3_QUERY_MAX_SRCS 366 /* From RFC 3376, section 4.1.8 */
112#define IGMP_EXP(x) (((x) >> 4) & 0x07)
113#define IGMP_MANT(x) ((x) & 0x0f)
114#define IGMP_QRESV(x) (((x) >> 4) & 0x0f)
115#define IGMP_SFLAG(x) (((x) >> 3) & 0x01)
116#define IGMP_QRV(x) ((x) & 0x07)
117
118struct igmp_grouprec {
119 u_char ig_type; /* record type */
120 u_char ig_datalen; /* length of auxiliary data */
121 u_short ig_numsrc; /* number of sources */
122 struct in_addr ig_group; /* group address being reported */
123 /*struct in_addr ig_sources[1];*/ /* source addresses */
124};
125#define IGMP_GRPREC_HDRLEN 8
126
127/*
128 * IGMPv3 host membership report header.
129 */
130struct igmp_report {
131 u_char ir_type; /* IGMP_v3_HOST_MEMBERSHIP_REPORT */
132 u_char ir_rsv1; /* must be zero */
133 u_short ir_cksum; /* checksum */
134 u_short ir_rsv2; /* must be zero */
135 u_short ir_numgrps; /* number of group records */
136 /*struct igmp_grouprec ir_groups[1];*/ /* group records */
137};
138#define IGMP_V3_REPORT_MINLEN 8
139#define IGMP_V3_REPORT_MAXRECS 65535
140
141/*
142 * Message types, including version number.
143 */
144#define IGMP_HOST_MEMBERSHIP_QUERY 0x11 /* membership query */
145#define IGMP_v1_HOST_MEMBERSHIP_REPORT 0x12 /* Ver. 1 membership report */
146#define IGMP_DVMRP 0x13 /* DVMRP routing message */
147#define IGMP_PIM 0x14 /* PIMv1 message (historic) */
148#define IGMP_v2_HOST_MEMBERSHIP_REPORT 0x16 /* Ver. 2 membership report */
149#define IGMP_HOST_LEAVE_MESSAGE 0x17 /* Leave-group message */
150#define IGMP_MTRACE_REPLY 0x1e /* mtrace(8) reply */
151#define IGMP_MTRACE_QUERY 0x1f /* mtrace(8) probe */
152#define IGMP_v3_HOST_MEMBERSHIP_REPORT 0x22 /* Ver. 3 membership report */
153
154/*
155 * IGMPv3 report modes.
156 */
157#define IGMP_DO_NOTHING 0 /* don't send a record */
158#define IGMP_MODE_IS_INCLUDE 1 /* MODE_IN */
159#define IGMP_MODE_IS_EXCLUDE 2 /* MODE_EX */
160#define IGMP_CHANGE_TO_INCLUDE_MODE 3 /* TO_IN */
161#define IGMP_CHANGE_TO_EXCLUDE_MODE 4 /* TO_EX */
162#define IGMP_ALLOW_NEW_SOURCES 5 /* ALLOW_NEW */
163#define IGMP_BLOCK_OLD_SOURCES 6 /* BLOCK_OLD */
164
165/*
166 * IGMPv3 query types.
167 */
168#define IGMP_V3_GENERAL_QUERY 1
169#define IGMP_V3_GROUP_QUERY 2
170#define IGMP_V3_GROUP_SOURCE_QUERY 3
171
172/*
173 * Maximum report interval for IGMP v1/v2 host membership reports [RFC 1112]
174 */
175#define IGMP_V1V2_MAX_RI 10
176#define IGMP_MAX_HOST_REPORT_DELAY IGMP_V1V2_MAX_RI
177
178/*
179 * IGMP_TIMER_SCALE denotes that the igmp code field specifies
180 * time in tenths of a second.
181 */
182#define IGMP_TIMER_SCALE 10
183
184#endif /* _NETINET_IGMP_H_ */
185