xref: /xnu-10002.61.3/bsd/netinet6/mld6.h (revision 0f4c859e951fba394238ab619495c4e1d54d0f34)
1 /*
2  * Copyright (c) 2010 Apple Computer, 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) 2009 Bruce Simpson.
30  *
31  * Redistribution and use in source and binary forms, with or without
32  * modification, are permitted provided that the following conditions
33  * are met:
34  * 1. Redistributions of source code must retain the above copyright
35  *    notice, this list of conditions and the following disclaimer.
36  * 2. Redistributions in binary form must reproduce the above copyright
37  *    notice, this list of conditions and the following disclaimer in the
38  *    documentation and/or other materials provided with the distribution.
39  * 3. The name of the author may not be used to endorse or promote
40  *    products derived from this software without specific prior written
41  *    permission.
42  *
43  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
44  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
45  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
46  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
47  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
48  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
49  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
50  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
51  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
52  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
53  * SUCH DAMAGE.
54  *
55  * $FreeBSD$
56  */
57 
58 #ifndef _NETINET6_MLD6_H_
59 #define _NETINET6_MLD6_H_
60 
61 /*
62  * Multicast Listener Discovery (MLD) definitions.
63  */
64 
65 /* Minimum length of any MLD protocol message. */
66 #define MLD_MINLEN      sizeof(struct icmp6_hdr)
67 
68 /*
69  * MLD v2 query format.
70  * See <netinet/icmp6.h> for struct mld_hdr
71  * (MLDv1 query and host report format).
72  */
73 struct mldv2_query {
74 	struct icmp6_hdr        mld_icmp6_hdr;  /* ICMPv6 header */
75 	struct in6_addr         mld_addr;       /* address being queried */
76 	uint8_t         mld_misc;       /* reserved/suppress/robustness   */
77 	uint8_t         mld_qqi;        /* querier's query interval       */
78 	uint16_t        mld_numsrc;     /* number of sources              */
79 	/* followed by 1..numsrc source addresses */
80 } __attribute__((__packed__));
81 #define MLD_V2_QUERY_MINLEN             sizeof(struct mldv2_query)
82 #define MLD_MRC_EXP(x)                  ((ntohs((x)) >> 12) & 0x0007)
83 #define MLD_MRC_MANT(x)                 (ntohs((x)) & 0x0fff)
84 #define MLD_QQIC_EXP(x)                 (((x) >> 4) & 0x07)
85 #define MLD_QQIC_MANT(x)                ((x) & 0x0f)
86 #define MLD_QRESV(x)                    (((x) >> 4) & 0x0f)
87 #define MLD_SFLAG(x)                    (((x) >> 3) & 0x01)
88 #define MLD_QRV(x)                      ((x) & 0x07)
89 
90 /*
91  * MLDv2 host membership report header.
92  * mld_type: MLDV2_LISTENER_REPORT
93  */
94 struct mldv2_report {
95 	struct icmp6_hdr        mld_icmp6_hdr;
96 	/* followed by 1..numgrps records */
97 } __attribute__((__packed__));
98 /* overlaid on struct icmp6_hdr. */
99 #define mld_numrecs     mld_icmp6_hdr.icmp6_data16[1]
100 
101 struct mldv2_record {
102 	uint8_t                 mr_type;        /* record type */
103 	uint8_t                 mr_datalen;     /* length of auxiliary data */
104 	uint16_t                mr_numsrc;      /* number of sources */
105 	struct in6_addr         mr_addr;        /* address being reported */
106 	/* followed by 1..numsrc source addresses */
107 } __attribute__((__packed__));
108 #define MLD_V2_REPORT_MAXRECS           65535
109 
110 /*
111  * MLDv2 report modes.
112  */
113 #define MLD_DO_NOTHING                  0       /* don't send a record */
114 #define MLD_MODE_IS_INCLUDE             1       /* MODE_IN */
115 #define MLD_MODE_IS_EXCLUDE             2       /* MODE_EX */
116 #define MLD_CHANGE_TO_INCLUDE_MODE      3       /* TO_IN */
117 #define MLD_CHANGE_TO_EXCLUDE_MODE      4       /* TO_EX */
118 #define MLD_ALLOW_NEW_SOURCES           5       /* ALLOW_NEW */
119 #define MLD_BLOCK_OLD_SOURCES           6       /* BLOCK_OLD */
120 
121 /*
122  * MLDv2 query types.
123  */
124 #define MLD_V2_GENERAL_QUERY            1
125 #define MLD_V2_GROUP_QUERY              2
126 #define MLD_V2_GROUP_SOURCE_QUERY       3
127 
128 /*
129  * Maximum report interval for MLDv1 host membership reports.
130  */
131 #define MLD_V1_MAX_RI                   10
132 
133 /*
134  * MLD_TIMER_SCALE denotes that the MLD code field specifies
135  * time in milliseconds.
136  */
137 #define MLD_TIMER_SCALE                 1000
138 
139 #endif /* _NETINET6_MLD6_H_ */
140