[apple/xnu.git] / bsd / netinet / igmp.h

/*
 * Copyright (c) 2010 Apple, Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 * 
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
/*
 * Copyright (c) 1988 Stephen Deering.
 * Copyright (c) 1992, 1993
 *	The Regents of the University of California.  All rights reserved.
 *
 * This code is derived from software contributed to Berkeley by
 * Stephen Deering of Stanford University.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *	@(#)igmp.h	8.1 (Berkeley) 6/10/93
 * $FreeBSD: src/sys/netinet/igmp.h,v 1.10 1999/08/28 00:49:15 peter Exp $
 */

#ifndef _NETINET_IGMP_H_
#define _NETINET_IGMP_H_
#include <sys/appleapiopts.h>

/*
 * Internet Group Management Protocol (IGMP) definitions.
 *
 * Written by Steve Deering, Stanford, May 1988.
 *
 * MULTICAST Revision: 3.5.1.2
 */

/* Minimum length of any IGMP protocol message. */
#define IGMP_MINLEN			8

/*
 * IGMPv1/v2 query and host report format.
 */
struct igmp {
	u_char		igmp_type;	/* version & type of IGMP message  */
	u_char		igmp_code;	/* subtype for routing msgs        */
	u_short		igmp_cksum;	/* IP-style checksum               */
	struct in_addr	igmp_group;	/* group address being reported    */
};					/*  (zero for queries)             */

/*
 * IGMP v3 query format.
 */
struct igmpv3 {
	u_char		igmp_type;	/* version & type of IGMP message  */
	u_char		igmp_code;	/* subtype for routing msgs        */
	u_short		igmp_cksum;	/* IP-style checksum               */
	struct in_addr	igmp_group;	/* group address being reported    */
					/*  (zero for queries)             */
	u_char		igmp_misc;	/* reserved/suppress/robustness    */
	u_char		igmp_qqi;	/* querier's query interval        */
	u_short		igmp_numsrc;	/* number of sources               */
	/*struct in_addr	igmp_sources[1];*/ /* source addresses */
};
#define IGMP_V3_QUERY_MINLEN		12
#define IGMP_EXP(x)			(((x) >> 4) & 0x07)
#define IGMP_MANT(x)			((x) & 0x0f)
#define IGMP_QRESV(x)			(((x) >> 4) & 0x0f)
#define IGMP_SFLAG(x)			(((x) >> 3) & 0x01)
#define IGMP_QRV(x)			((x) & 0x07)

struct igmp_grouprec {
	u_char		ig_type;	/* record type */
	u_char		ig_datalen;	/* length of auxiliary data */
	u_short		ig_numsrc;	/* number of sources */
	struct in_addr	ig_group;	/* group address being reported */
	/*struct in_addr	ig_sources[1];*/ /* source addresses */
};
#define IGMP_GRPREC_HDRLEN		8

/*
 * IGMPv3 host membership report header.
 */
struct igmp_report {
	u_char		ir_type;	/* IGMP_v3_HOST_MEMBERSHIP_REPORT */
	u_char		ir_rsv1;	/* must be zero */
	u_short		ir_cksum;	/* checksum */
	u_short		ir_rsv2;	/* must be zero */
	u_short		ir_numgrps;	/* number of group records */
	/*struct	igmp_grouprec ir_groups[1];*/	/* group records */
};
#define IGMP_V3_REPORT_MINLEN		8
#define IGMP_V3_REPORT_MAXRECS		65535

/*
 * Message types, including version number.
 */
#define IGMP_HOST_MEMBERSHIP_QUERY	0x11	/* membership query         */
#define IGMP_v1_HOST_MEMBERSHIP_REPORT	0x12	/* Ver. 1 membership report */
#define IGMP_DVMRP			0x13	/* DVMRP routing message    */
#define IGMP_PIM			0x14	/* PIMv1 message (historic) */
#define IGMP_v2_HOST_MEMBERSHIP_REPORT	0x16	/* Ver. 2 membership report */
#define IGMP_HOST_LEAVE_MESSAGE		0x17	/* Leave-group message     */
#define IGMP_MTRACE_REPLY		0x1e	/* mtrace(8) reply */
#define IGMP_MTRACE_QUERY		0x1f	/* mtrace(8) probe */
#define IGMP_v3_HOST_MEMBERSHIP_REPORT	0x22	/* Ver. 3 membership report */

/*
 * IGMPv3 report modes.
 */
#define IGMP_DO_NOTHING			0	/* don't send a record */
#define IGMP_MODE_IS_INCLUDE		1	/* MODE_IN */
#define IGMP_MODE_IS_EXCLUDE		2	/* MODE_EX */
#define IGMP_CHANGE_TO_INCLUDE_MODE	3	/* TO_IN */
#define IGMP_CHANGE_TO_EXCLUDE_MODE	4	/* TO_EX */
#define IGMP_ALLOW_NEW_SOURCES		5	/* ALLOW_NEW */
#define IGMP_BLOCK_OLD_SOURCES		6	/* BLOCK_OLD */

/*
 * IGMPv3 query types.
 */
#define IGMP_V3_GENERAL_QUERY		1
#define IGMP_V3_GROUP_QUERY		2
#define IGMP_V3_GROUP_SOURCE_QUERY	3

/*
 * Maximum report interval for IGMP v1/v2 host membership reports [RFC 1112]
 */
#define IGMP_V1V2_MAX_RI		10
#define IGMP_MAX_HOST_REPORT_DELAY	IGMP_V1V2_MAX_RI

/*
 * IGMP_TIMER_SCALE denotes that the igmp code field specifies
 * time in tenths of a second.
 */
#define IGMP_TIMER_SCALE		10

#endif /* _NETINET_IGMP_H_ */
Commit	Line	Data
1c79356b	1	/*
6d2010ae	2	* Copyright (c) 2010 Apple, Inc. All rights reserved.
5d5c5d0d	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	5	*
2d21ac55 A	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.
8f6c56a5	14	*
2d21ac55 A	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
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	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.
8f6c56a5	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b A	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
9bccf70c	65	* $FreeBSD: src/sys/netinet/igmp.h,v 1.10 1999/08/28 00:49:15 peter Exp $
1c79356b A	66	*/
	67
	68	#ifndef _NETINET_IGMP_H_
	69	#define _NETINET_IGMP_H_
9bccf70c	70	#include <sys/appleapiopts.h>
1c79356b A	71
	72	/*
	73	* Internet Group Management Protocol (IGMP) definitions.
	74	*
	75	* Written by Steve Deering, Stanford, May 1988.
	76	*
	77	* MULTICAST Revision: 3.5.1.2
	78	*/
	79
6d2010ae A	80	/* Minimum length of any IGMP protocol message. */
	81	#define IGMP_MINLEN 8
	82
1c79356b	83	/*
6d2010ae	84	* IGMPv1/v2 query and host report format.
1c79356b A	85	*/
	86	struct igmp {
	87	u_char igmp_type; /* version & type of IGMP message */
	88	u_char igmp_code; /* subtype for routing msgs */
	89	u_short igmp_cksum; /* IP-style checksum */
	90	struct in_addr igmp_group; /* group address being reported */
	91	}; /* (zero for queries) */
	92
6d2010ae A	93	/*
	94	* IGMP v3 query format.
	95	*/
	96	struct igmpv3 {
	97	u_char igmp_type; /* version & type of IGMP message */
	98	u_char igmp_code; /* subtype for routing msgs */
	99	u_short igmp_cksum; /* IP-style checksum */
	100	struct in_addr igmp_group; /* group address being reported */
	101	/* (zero for queries) */
	102	u_char igmp_misc; /* reserved/suppress/robustness */
	103	u_char igmp_qqi; /* querier's query interval */
	104	u_short igmp_numsrc; /* number of sources */
	105	/struct in_addr igmp_sources[1];/ /* source addresses */
	106	};
	107	#define IGMP_V3_QUERY_MINLEN 12
	108	#define IGMP_EXP(x) (((x) >> 4) & 0x07)
	109	#define IGMP_MANT(x) ((x) & 0x0f)
	110	#define IGMP_QRESV(x) (((x) >> 4) & 0x0f)
	111	#define IGMP_SFLAG(x) (((x) >> 3) & 0x01)
	112	#define IGMP_QRV(x) ((x) & 0x07)
	113
	114	struct igmp_grouprec {
	115	u_char ig_type; /* record type */
	116	u_char ig_datalen; /* length of auxiliary data */
	117	u_short ig_numsrc; /* number of sources */
	118	struct in_addr ig_group; /* group address being reported */
	119	/struct in_addr ig_sources[1];/ /* source addresses */
	120	};
	121	#define IGMP_GRPREC_HDRLEN 8
1c79356b A	122
1c79356b A	123	/*
6d2010ae	124	* IGMPv3 host membership report header.
1c79356b	125	*/
6d2010ae A	126	struct igmp_report {
	127	u_char ir_type; /* IGMP_v3_HOST_MEMBERSHIP_REPORT */
	128	u_char ir_rsv1; /* must be zero */
	129	u_short ir_cksum; /* checksum */
	130	u_short ir_rsv2; /* must be zero */
	131	u_short ir_numgrps; /* number of group records */
	132	/struct igmp_grouprec ir_groups[1];/ /* group records */
	133	};
	134	#define IGMP_V3_REPORT_MINLEN 8
	135	#define IGMP_V3_REPORT_MAXRECS 65535
1c79356b	136
6d2010ae A	137	/*
	138	* Message types, including version number.
	139	*/
	140	#define IGMP_HOST_MEMBERSHIP_QUERY 0x11 /* membership query */
	141	#define IGMP_v1_HOST_MEMBERSHIP_REPORT 0x12 /* Ver. 1 membership report */
1c79356b	142	#define IGMP_DVMRP 0x13 /* DVMRP routing message */
6d2010ae A	143	#define IGMP_PIM 0x14 /* PIMv1 message (historic) */
	144	#define IGMP_v2_HOST_MEMBERSHIP_REPORT 0x16 /* Ver. 2 membership report */
	145	#define IGMP_HOST_LEAVE_MESSAGE 0x17 /* Leave-group message */
	146	#define IGMP_MTRACE_REPLY 0x1e /* mtrace(8) reply */
	147	#define IGMP_MTRACE_QUERY 0x1f /* mtrace(8) probe */
	148	#define IGMP_v3_HOST_MEMBERSHIP_REPORT 0x22 /* Ver. 3 membership report */
1c79356b	149
6d2010ae A	150	/*
	151	* IGMPv3 report modes.
	152	*/
	153	#define IGMP_DO_NOTHING 0 /* don't send a record */
	154	#define IGMP_MODE_IS_INCLUDE 1 /* MODE_IN */
	155	#define IGMP_MODE_IS_EXCLUDE 2 /* MODE_EX */
	156	#define IGMP_CHANGE_TO_INCLUDE_MODE 3 /* TO_IN */
	157	#define IGMP_CHANGE_TO_EXCLUDE_MODE 4 /* TO_EX */
	158	#define IGMP_ALLOW_NEW_SOURCES 5 /* ALLOW_NEW */
	159	#define IGMP_BLOCK_OLD_SOURCES 6 /* BLOCK_OLD */
1c79356b	160
6d2010ae A	161	/*
	162	* IGMPv3 query types.
	163	*/
	164	#define IGMP_V3_GENERAL_QUERY 1
	165	#define IGMP_V3_GROUP_QUERY 2
	166	#define IGMP_V3_GROUP_SOURCE_QUERY 3
1c79356b	167
6d2010ae A	168	/*
	169	* Maximum report interval for IGMP v1/v2 host membership reports [RFC 1112]
	170	*/
	171	#define IGMP_V1V2_MAX_RI 10
	172	#define IGMP_MAX_HOST_REPORT_DELAY IGMP_V1V2_MAX_RI
1c79356b A	173
1c79356b A	174	/*
6d2010ae A	175	* IGMP_TIMER_SCALE denotes that the igmp code field specifies
6d2010ae A	176	* time in tenths of a second.
1c79356b	177	*/
6d2010ae	178	#define IGMP_TIMER_SCALE 10
1c79356b A	179
1c79356b A	180	#endif /* _NETINET_IGMP_H_ */