in6_var.h revision 1.2 1 /*
2 * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. Neither the name of the project nor the names of its contributors
14 * may be used to endorse or promote products derived from this software
15 * without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 */
29
30 /*
31 * Copyright (c) 1985, 1986, 1993
32 * The Regents of the University of California. All rights reserved.
33 *
34 * Redistribution and use in source and binary forms, with or without
35 * modification, are permitted provided that the following conditions
36 * are met:
37 * 1. Redistributions of source code must retain the above copyright
38 * notice, this list of conditions and the following disclaimer.
39 * 2. Redistributions in binary form must reproduce the above copyright
40 * notice, this list of conditions and the following disclaimer in the
41 * documentation and/or other materials provided with the distribution.
42 * 3. All advertising materials mentioning features or use of this software
43 * must display the following acknowledgement:
44 * This product includes software developed by the University of
45 * California, Berkeley and its contributors.
46 * 4. Neither the name of the University nor the names of its contributors
47 * may be used to endorse or promote products derived from this software
48 * without specific prior written permission.
49 *
50 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
51 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
52 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
53 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
54 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
55 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
56 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
57 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
58 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
59 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
60 * SUCH DAMAGE.
61 *
62 * @(#)in_var.h 8.1 (Berkeley) 6/10/93
63 */
64
65 #ifndef _NETINET6_IN6_VAR_H_
66 #define _NETINET6_IN6_VAR_H_
67
68 /*
69 * Interface address, Internet version. One of these structures
70 * is allocated for each interface with an Internet address.
71 * The ifaddr structure contains the protocol-independent part
72 * of the structure and is assumed to be first.
73 */
74
75 /*
76 * pltime/vltime are just for future reference (required to implements 2
77 * hour rule for hosts). they should never be modified by nd6_timeout or
78 * anywhere else.
79 * userland -> kernel: accept pltime/vltime
80 * kernel -> userland: throuw up everything
81 * in kernel: modify preferred/expire only
82 */
83 struct in6_addrlifetime {
84 time_t ia6t_expire; /* valid lifetime expiration time */
85 time_t ia6t_preferred; /* preferred lifetime expiration time */
86 u_int32_t ia6t_vltime; /* valid lifetime */
87 u_int32_t ia6t_pltime; /* prefix lifetime */
88 };
89
90 struct in6_ifaddr {
91 struct ifaddr ia_ifa; /* protocol-independent info */
92 #define ia_ifp ia_ifa.ifa_ifp
93 #define ia_flags ia_ifa.ifa_flags
94 struct sockaddr_in6 ia_addr; /* interface address */
95 struct sockaddr_in6 ia_net; /* network number of interface */
96 struct sockaddr_in6 ia_dstaddr; /* space for destination addr */
97 struct sockaddr_in6 ia_prefixmask; /* prefix mask */
98 u_long ia_plen; /* prefix length */
99 struct in6_ifaddr *ia_next; /* next in6 list of IP6 addresses */
100 LIST_HEAD(in6_multihead, in6_multi) ia6_multiaddrs;
101 /* list of multicast addresses */
102 int ia6_flags;
103
104 struct in6_addrlifetime ia6_lifetime; /* NULL = infty */
105 };
106
107 struct in6_ifreq {
108 char ifr_name[IFNAMSIZ];
109 union {
110 struct sockaddr_in6 ifru_addr;
111 struct sockaddr_in6 ifru_dstaddr;
112 short ifru_flags;
113 int ifru_flags6;
114 int ifru_metric;
115 caddr_t ifru_data;
116 struct in6_addrlifetime ifru_lifetime;
117 } ifr_ifru;
118 };
119
120 struct in6_aliasreq {
121 char ifra_name[IFNAMSIZ];
122 struct sockaddr_in6 ifra_addr;
123 struct sockaddr_in6 ifra_dstaddr;
124 struct sockaddr_in6 ifra_prefixmask;
125 int ifra_flags;
126 struct in6_addrlifetime ifra_lifetime;
127 };
128
129 /*
130 * prefix related flags passed between kernel(NDP related part) and
131 * user land command(ifconfig) and daemon(rtadvd).
132 */
133 struct in6_prflags {
134 struct prf_ra {
135 u_char onlink : 1;
136 u_char autonomous : 1;
137 u_char reserved : 6;
138 } prf_ra;
139 u_char prf_reserved1;
140 u_short prf_reserved2;
141 /* want to put this on 4byte offset */
142 struct prf_rr {
143 u_char decrvalid : 1;
144 u_char decrprefd : 1;
145 u_char reserved : 6;
146 } prf_rr;
147 u_char prf_reserved3;
148 u_short prf_reserved4;
149 };
150
151 struct in6_prefixreq {
152 char ipr_name[IFNAMSIZ];
153 u_char ipr_origin;
154 u_char ipr_plen;
155 u_long ipr_vltime;
156 u_long ipr_pltime;
157 struct in6_prflags ipr_flags;
158 struct sockaddr_in6 ipr_prefix;
159 };
160
161 #define PR_ORIG_RA 0
162 #define PR_ORIG_RR 1
163 #define PR_ORIG_STATIC 2
164
165 #define ipr_raf_onlink ipr_flags.prf_ra.onlink
166 #define ipr_raf_auto ipr_flags.prf_ra.autonomous
167
168 #define ipr_statef_onlink ipr_flags.prf_state.onlink
169
170 #define ipr_rrf_decrvalid ipr_flags.prf_rr.decrvalid
171 #define ipr_rrf_decrprefd ipr_flags.prf_rr.decrprefd
172
173 struct in6_rrenumreq {
174 char irr_name[IFNAMSIZ];
175 u_char irr_origin;
176 u_char irr_m_len; /* match len for matchprefix */
177 u_char irr_m_minlen; /* minlen for matching prefix */
178 u_char irr_m_maxlen; /* maxlen for matching prefix */
179 u_char irr_u_uselen; /* uselen for adding prefix */
180 u_char irr_u_keeplen; /* keeplen from matching prefix */
181 struct irr_raflagmask {
182 u_char onlink : 1;
183 u_char autonomous : 1;
184 u_char reserved : 6;
185 } irr_raflagmask;
186 u_long irr_vltime;
187 u_long irr_pltime;
188 struct in6_prflags irr_flags;
189 struct sockaddr_in6 irr_matchprefix;
190 struct sockaddr_in6 irr_useprefix;
191 };
192
193 #define irr_raf_mask_onlink irr_raflagmask.onlink
194 #define irr_raf_mask_auto irr_raflagmask.autonomous
195 #define irr_raf_mask_reserved irr_raflagmask.reserved
196
197 #define irr_raf_onlink irr_flags.prf_ra.onlink
198 #define irr_raf_auto irr_flags.prf_ra.autonomous
199
200 #define irr_statef_onlink irr_flags.prf_state.onlink
201
202 #define irr_rrf irr_flags.prf_rr
203 #define irr_rrf_decrvalid irr_flags.prf_rr.decrvalid
204 #define irr_rrf_decrprefd irr_flags.prf_rr.decrprefd
205
206 /*
207 * Given a pointer to an in6_ifaddr (ifaddr),
208 * return a pointer to the addr as a sockaddr_in6
209 */
210 #define IA6_IN6(ia) (&(((struct in6_ifaddr *)(ia))->ia_addr.sin6_addr))
211 #define IA6_DSTIN6(ia) (&(((struct in6_ifaddr *)(ia))->ia_dstaddr.sin6_addr))
212 #define IA6_MASKIN6(ia) (&(((struct in6_ifaddr *)(ia))->ia_prefixmask.sin6_addr))
213 #define IA6_SIN6(ia) (&(((struct in6_ifaddr *)(ia))->ia_addr))
214 #define IA6_DSTSIN6(ia) (&(((struct in6_ifaddr *)(ia))->ia_dstaddr))
215 #define IFA_IN6(x) (((struct sockaddr_in6 *)((x)->ifa_addr))->sin6_addr)
216
217 #define IFPR_IN6(x) (((struct sockaddr_in6 *)((x)->ifpr_prefix))->sin6_addr)
218
219 #define IN6_ARE_MASKED_ADDR_EQUAL(d, a, m) ( \
220 (((d)->s6_addr32[0] ^ (a)->s6_addr32[0]) & (m)->s6_addr32[0]) == 0 && \
221 (((d)->s6_addr32[1] ^ (a)->s6_addr32[1]) & (m)->s6_addr32[1]) == 0 && \
222 (((d)->s6_addr32[2] ^ (a)->s6_addr32[2]) & (m)->s6_addr32[2]) == 0 && \
223 (((d)->s6_addr32[3] ^ (a)->s6_addr32[3]) & (m)->s6_addr32[3]) == 0 )
224
225 #define SIOCSIFADDR_IN6 _IOW('i', 12, struct in6_ifreq)
226 #define SIOCGIFADDR_IN6 _IOWR('i', 33, struct in6_ifreq)
227 #define SIOCSIFDSTADDR_IN6 _IOW('i', 14, struct in6_ifreq)
228 #define SIOCGIFDSTADDR_IN6 _IOWR('i', 34, struct in6_ifreq)
229 #define SIOCSIFNETMASK_IN6 _IOW('i', 22, struct in6_ifreq)
230 #define SIOCGIFNETMASK_IN6 _IOWR('i', 37, struct in6_ifreq)
231
232 #define SIOCDIFADDR_IN6 _IOW('i', 25, struct in6_ifreq)
233 #define SIOCAIFADDR_IN6 _IOW('i', 26, struct in6_aliasreq)
234
235 #define SIOCSIFPHYADDR_IN6 _IOW('i', 70, struct in6_aliasreq)
236 #define SIOCGIFPSRCADDR_IN6 _IOWR('i', 71, struct in6_ifreq)
237 #define SIOCGIFPDSTADDR_IN6 _IOWR('i', 72, struct in6_ifreq)
238
239 #define SIOCGIFAFLAG_IN6 _IOWR('i', 73, struct in6_ifreq)
240
241 #define SIOCGDRLST_IN6 _IOWR('i', 74, struct in6_drlist)
242 #define SIOCGPRLST_IN6 _IOWR('i', 75, struct in6_prlist)
243 #define SIOCGIFINFO_IN6 _IOWR('i', 76, struct in6_ndireq)
244 #define SIOCSNDFLUSH_IN6 _IOWR('i', 77, struct in6_ifreq)
245 #define SIOCGNBRINFO_IN6 _IOWR('i', 78, struct in6_nbrinfo)
246 #define SIOCSPFXFLUSH_IN6 _IOWR('i', 79, struct in6_ifreq)
247 #define SIOCSRTRFLUSH_IN6 _IOWR('i', 80, struct in6_ifreq)
248
249 #define SIOCGIFALIFETIME_IN6 _IOWR('i', 81, struct in6_ifreq)
250 #define SIOCSIFALIFETIME_IN6 _IOWR('i', 82, struct in6_ifreq)
251
252 #define SIOCSIFPREFIX_IN6 _IOW('i', 100, struct in6_prefixreq) /* set */
253 #define SIOCGIFPREFIX_IN6 _IOWR('i', 101, struct in6_prefixreq) /* get */
254 #define SIOCDIFPREFIX_IN6 _IOW('i', 102, struct in6_prefixreq) /* del */
255 #define SIOCAIFPREFIX_IN6 _IOW('i', 103, struct in6_rrenumreq) /* add */
256 #define SIOCCIFPREFIX_IN6 _IOW('i', 104, \
257 struct in6_rrenumreq) /* change */
258 #define SIOCSGIFPREFIX_IN6 _IOW('i', 105, \
259 struct in6_rrenumreq) /* set global */
260
261 #define SIOCGETSGCNT_IN6 _IOWR('u', 106, \
262 struct sioc_sg_req6) /* get s,g pkt cnt */
263 #define SIOCGETMIFCNT_IN6 _IOWR('u', 107, \
264 struct sioc_mif_req6) /* get pkt cnt per if */
265
266 #define IN6_IFF_ANYCAST 0x01 /* anycast address */
267 #define IN6_IFF_TENTATIVE 0x02 /* tentative address */
268 #define IN6_IFF_DUPLICATED 0x04 /* DAD detected duplicate */
269 #define IN6_IFF_DETACHED 0x08 /* may be detached from the link */
270 #define IN6_IFF_DEPRECATED 0x10 /* deprecated address */
271
272 /* do not input/output */
273 #define IN6_IFF_NOTREADY (IN6_IFF_TENTATIVE|IN6_IFF_DUPLICATED)
274
275 #ifdef _KERNEL
276 extern struct in6_ifaddr *in6_ifaddr;
277 extern struct ifqueue ip6intrq; /* IP6 packet input queue */
278 extern struct in6_addr zeroin6_addr;
279 extern u_char inet6ctlerrmap[];
280 extern unsigned long in6_maxmtu;
281 #if defined(__FreeBSD__) && __FreeBSD__ >= 3
282 #ifdef MALLOC_DECLARE
283 MALLOC_DECLARE(M_IPMADDR);
284 #endif /* MALLOC_DECLARE */
285 #endif
286
287 /*
288 * Macro for finding the internet address structure (in6_ifaddr) corresponding
289 * to a given interface (ifnet structure).
290 */
291 #define IFP_TO_IA6(ifp, ia) \
292 /* struct ifnet *ifp; */ \
293 /* struct in6_ifaddr *ia; */ \
294 { \
295 struct ifaddr *ifa; \
296 for (ifa = (ifp)->if_addrlist.tqh_first; ifa; ifa = ifa->ifa_list.tqe_next) { \
297 if (!ifa->ifa_addr) \
298 continue; \
299 if (ifa->ifa_addr->sa_family == AF_INET6) \
300 break; \
301 } \
302 (ia) = (struct in6_ifaddr *)ifa; \
303 }
304 #endif /* _KERNEL */
305
306 /*
307 * Multi-cast membership entry. One for each group/ifp that a PCB
308 * belongs to.
309 */
310 struct in6_multi_mship {
311 struct in6_multi *i6mm_maddr; /* Multicast address pointer */
312 LIST_ENTRY(in6_multi_mship) i6mm_chain; /* multicast options chain */
313 };
314
315 struct in6_multi {
316 LIST_ENTRY(in6_multi) in6m_entry; /* list glue */
317 struct in6_addr in6m_addr; /* IP6 multicast address */
318 struct ifnet *in6m_ifp; /* back pointer to ifnet */
319 struct in6_ifaddr *in6m_ia; /* back pointer to in6_ifaddr */
320 u_int in6m_refcount; /* # membership claims by sockets */
321 u_int in6m_state; /* state of the membership */
322 u_int in6m_timer; /* MLD6 listener report timer */
323 };
324
325 #ifdef _KERNEL
326 /*
327 * Structure used by macros below to remember position when stepping through
328 * all of eht in6_multi records.
329 */
330 struct in6_multistep {
331 struct in6_ifaddr *i_ia;
332 struct in6_multi *i_in6m;
333 };
334
335 /*
336 * Macros for looking up the in6_multi record for a given IP6 multicast
337 * address on a given interface. If no matching record is found, "in6m"
338 * returns NLL.
339 */
340
341 #define IN6_LOOKUP_MULTI(addr, ifp, in6m) \
342 /* struct in6_addr addr; */ \
343 /* struct ifnet *ifp; */ \
344 /* struct in6_multi *in6m; */ \
345 { \
346 register struct in6_ifaddr *ia; \
347 \
348 IFP_TO_IA6((ifp), ia); \
349 if (ia == NULL) \
350 (in6m) = NULL; \
351 else \
352 for ((in6m) = ia->ia6_multiaddrs.lh_first; \
353 (in6m) != NULL && \
354 !IN6_ARE_ADDR_EQUAL(&(in6m)->in6m_addr, &(addr)); \
355 (in6m) = in6m->in6m_entry.le_next) \
356 continue; \
357 }
358
359 /*
360 * Macro to step through all of the in6_multi records, one at a time.
361 * The current position is remembered in "step", which the caller must
362 * provide. IN6_FIRST_MULTI(), below, must be called to initialize "step"
363 * and get the first record. Both macros return a NULL "in6m" when there
364 * are no remaining records.
365 */
366 #define IN6_NEXT_MULTI(step, in6m) \
367 /* struct in6_multistep step; */ \
368 /* struct in6_multi *in6m; */ \
369 { \
370 if (((in6m) = (step).i_in6m) != NULL) \
371 (step).i_in6m = (in6m)->in6m_entry.le_next; \
372 else \
373 while ((step).i_ia != NULL) { \
374 (in6m) = (step).i_ia->ia6_multiaddrs.lh_first; \
375 (step).i_ia = (step).i_ia->ia_next; \
376 if ((in6m) != NULL) { \
377 (step).i_in6m = (in6m)->in6m_entry.le_next; \
378 break; \
379 } \
380 } \
381 }
382
383 #define IN6_FIRST_MULTI(step, in6m) \
384 /* struct in6_multistep step; */ \
385 /* struct in6_multi *in6m */ \
386 { \
387 (step).i_ia = in6_ifaddr; \
388 (step).i_in6m = NULL; \
389 IN6_NEXT_MULTI((step), (in6m)); \
390 }
391
392 int in6_ifinit __P((struct ifnet *,
393 struct in6_ifaddr *, struct sockaddr_in6 *, int));
394 struct in6_multi *in6_addmulti __P((struct in6_addr *, struct ifnet *,
395 int *));
396 void in6_delmulti __P((struct in6_multi *));
397 void in6_ifscrub __P((struct ifnet *, struct in6_ifaddr *));
398 extern int in6_mask2len __P((struct in6_addr *));
399 extern void in6_len2mask __P((struct in6_addr *, int));
400 #if defined(__NetBSD__) || (defined(__FreeBSD__) && __FreeBSD__ >= 3)
401 int in6_control __P((struct socket *,
402 u_long, caddr_t, struct ifnet *, struct proc *));
403 #else
404 int in6_control __P((struct socket *, u_long, caddr_t, struct ifnet *));
405 #endif
406 void in6_savemkludge __P((struct in6_ifaddr *));
407 void in6_setmaxmtu __P((void));
408 void in6_restoremkludge __P((struct in6_ifaddr *, struct ifnet *));
409 struct in6_ifaddr *in6ifa_ifpforlinklocal __P((struct ifnet *));
410 struct in6_ifaddr *in6ifa_ifpwithaddr __P((struct ifnet *,
411 struct in6_addr *));
412 char *ip6_sprintf __P((struct in6_addr *));
413 int in6_matchlen __P((struct in6_addr *, struct in6_addr *));
414 int in6_prefix_ioctl __P((u_long cmd, caddr_t data, struct ifnet *ifp));
415 #endif /* _KERNEL */
416
417 #endif /* _NETINET6_IN6_VAR_H_ */
418