2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 2009 Bruce Simpson.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * 3. The name of the author may not be used to endorse or promote
15 * products derived from this software without specific prior written
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 #ifndef _NETINET6_MLD6_VAR_H_
33 #define _NETINET6_MLD6_VAR_H_
36 * Multicast Listener Discovery (MLD)
37 * implementation-specific definitions.
41 * MLD per-group states.
43 #define MLD_NOT_MEMBER 0 /* Can garbage collect group */
44 #define MLD_SILENT_MEMBER 1 /* Do not perform MLD for group */
45 #define MLD_REPORTING_MEMBER 2 /* MLDv1 we are reporter */
46 #define MLD_IDLE_MEMBER 3 /* MLDv1 we reported last */
47 #define MLD_LAZY_MEMBER 4 /* MLDv1 other member reporting */
48 #define MLD_SLEEPING_MEMBER 5 /* MLDv1 start query response */
49 #define MLD_AWAKENING_MEMBER 6 /* MLDv1 group timer will start */
50 #define MLD_G_QUERY_PENDING_MEMBER 7 /* MLDv2 group query pending */
51 #define MLD_SG_QUERY_PENDING_MEMBER 8 /* MLDv2 source query pending */
52 #define MLD_LEAVING_MEMBER 9 /* MLDv2 dying gasp (pending last */
53 /* retransmission of INCLUDE {}) */
58 #define MLD_VERSION_NONE 0 /* Invalid */
59 #define MLD_VERSION_1 1
60 #define MLD_VERSION_2 2 /* Default */
63 * MLDv2 protocol control variables.
65 #define MLD_RV_INIT 2 /* Robustness Variable */
69 #define MLD_QI_INIT 125 /* Query Interval (s) */
71 #define MLD_QI_MAX 255
73 #define MLD_QRI_INIT 10 /* Query Response Interval (s) */
75 #define MLD_QRI_MAX 255
77 #define MLD_URI_INIT 3 /* Unsolicited Report Interval (s) */
79 #define MLD_URI_MAX 10
81 #define MLD_MAX_GS_SOURCES 256 /* # of sources in rx GS query */
82 #define MLD_MAX_G_GS_PACKETS 8 /* # of packets to answer G/GS */
83 #define MLD_MAX_STATE_CHANGE_PACKETS 8 /* # of packets per state change */
84 #define MLD_MAX_RESPONSE_PACKETS 16 /* # of packets for general query */
85 #define MLD_MAX_RESPONSE_BURST 4 /* # of responses to send at once */
86 #define MLD_RESPONSE_BURST_INTERVAL (PR_FASTHZ / 2) /* 500ms */
89 * MLD-specific mbuf flags.
91 #define M_MLDV1 M_PROTO1 /* Packet is MLDv1 */
92 #define M_GROUPREC M_PROTO3 /* mbuf chain is a group record */
95 * Leading space for MLDv2 reports inside MTU.
97 * NOTE: This differs from IGMPv3 significantly. KAME IPv6 requires
98 * that a fully formed mbuf chain *without* the Router Alert option
99 * is passed to ip6_output(), however we must account for it in the
100 * MTU if we need to split an MLDv2 report into several packets.
102 * We now put the MLDv2 report header in the initial mbuf containing
105 #define MLD_MTUSPACE (sizeof(struct ip6_hdr) + sizeof(struct mld_raopt) + \
106 sizeof(struct icmp6_hdr))
109 * Structure returned by net.inet6.mld.ifinfo.
112 uint32_t mli_version; /* MLDv1 Host Compatibility Mode */
113 uint32_t mli_v1_timer; /* MLDv1 Querier Present timer (s) */
114 uint32_t mli_v2_timer; /* MLDv2 General Query (interface) timer (s)*/
115 uint32_t mli_flags; /* MLD per-interface flags */
116 #define MLIF_SILENT 0x00000001 /* Do not use MLD on this ifp */
117 #define MLIF_USEALLOW 0x00000002 /* Use ALLOW/BLOCK for joins/leaves */
118 uint32_t mli_rv; /* MLDv2 Robustness Variable */
119 uint32_t mli_qi; /* MLDv2 Query Interval (s) */
120 uint32_t mli_qri; /* MLDv2 Query Response Interval (s) */
121 uint32_t mli_uri; /* MLDv2 Unsolicited Report Interval (s) */
126 * Per-link MLD state.
129 LIST_ENTRY(mld_ifsoftc) mli_link;
130 struct ifnet *mli_ifp; /* interface this instance belongs to */
131 uint32_t mli_version; /* MLDv1 Host Compatibility Mode */
132 uint32_t mli_v1_timer; /* MLDv1 Querier Present timer (s) */
133 uint32_t mli_v2_timer; /* MLDv2 General Query (interface) timer (s)*/
134 uint32_t mli_flags; /* MLD per-interface flags */
135 uint32_t mli_rv; /* MLDv2 Robustness Variable */
136 uint32_t mli_qi; /* MLDv2 Query Interval (s) */
137 uint32_t mli_qri; /* MLDv2 Query Response Interval (s) */
138 uint32_t mli_uri; /* MLDv2 Unsolicited Report Interval (s) */
139 struct mbufq mli_gq; /* queue of general query responses */
142 #define MLD_RANDOM_DELAY(X) (arc4random() % (X) + 1)
143 #define MLD_MAX_STATE_CHANGES 24 /* Max pending changes per group */
146 * Subsystem lock macros.
147 * The MLD lock is only taken with MLD. Currently it is system-wide.
148 * VIMAGE: The lock could be pushed to per-VIMAGE granularity in future.
150 #define MLD_LOCK_INIT() mtx_init(&mld_mtx, "mld_mtx", NULL, MTX_DEF)
151 #define MLD_LOCK_DESTROY() mtx_destroy(&mld_mtx)
152 #define MLD_LOCK() mtx_lock(&mld_mtx)
153 #define MLD_LOCK_ASSERT() mtx_assert(&mld_mtx, MA_OWNED)
154 #define MLD_UNLOCK() mtx_unlock(&mld_mtx)
155 #define MLD_UNLOCK_ASSERT() mtx_assert(&mld_mtx, MA_NOTOWNED)
158 * Per-link MLD context.
160 #define MLD_IFINFO(ifp) \
161 (((struct in6_ifextra *)(ifp)->if_afdata[AF_INET6])->mld_ifinfo)
163 struct in6_multi_head;
164 int mld_change_state(struct in6_multi *, const int);
166 mld_domifattach(struct ifnet *);
167 void mld_domifdetach(struct ifnet *);
168 void mld_fasttimo(void);
169 void mld_ifdetach(struct ifnet *, struct in6_multi_head *);
170 int mld_input(struct mbuf **, int, int);
171 void mld_slowtimo(void);
174 SYSCTL_DECL(_net_inet6_mld);
179 #endif /* _NETINET6_MLD6_VAR_H_ */