1 /*- 2 * SPDX-License-Identifier: BSD-3-Clause 3 * 4 * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project. 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 3. Neither the name of the project nor the names of its contributors 16 * may be used to endorse or promote products derived from this software 17 * without specific prior written permission. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 22 * ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE 23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29 * SUCH DAMAGE. 30 * 31 * $KAME: in6_var.h,v 1.56 2001/03/29 05:34:31 itojun Exp $ 32 */ 33 34 /*- 35 * Copyright (c) 1985, 1986, 1993 36 * The Regents of the University of California. All rights reserved. 37 * 38 * Redistribution and use in source and binary forms, with or without 39 * modification, are permitted provided that the following conditions 40 * are met: 41 * 1. Redistributions of source code must retain the above copyright 42 * notice, this list of conditions and the following disclaimer. 43 * 2. Redistributions in binary form must reproduce the above copyright 44 * notice, this list of conditions and the following disclaimer in the 45 * documentation and/or other materials provided with the distribution. 46 * 3. 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 * $FreeBSD$ 64 */ 65 66 #ifndef _NETINET6_IN6_VAR_H_ 67 #define _NETINET6_IN6_VAR_H_ 68 69 #include <sys/tree.h> 70 #include <sys/counter.h> 71 72 #ifdef _KERNEL 73 #include <sys/fnv_hash.h> 74 #include <sys/libkern.h> 75 #endif 76 77 /* 78 * Interface address, Internet version. One of these structures 79 * is allocated for each interface with an Internet address. 80 * The ifaddr structure contains the protocol-independent part 81 * of the structure and is assumed to be first. 82 */ 83 84 /* 85 * pltime/vltime are just for future reference (required to implements 2 86 * hour rule for hosts). they should never be modified by nd6_timeout or 87 * anywhere else. 88 * userland -> kernel: accept pltime/vltime 89 * kernel -> userland: throw up everything 90 * in kernel: modify preferred/expire only 91 */ 92 struct in6_addrlifetime { 93 time_t ia6t_expire; /* valid lifetime expiration time */ 94 time_t ia6t_preferred; /* preferred lifetime expiration time */ 95 u_int32_t ia6t_vltime; /* valid lifetime */ 96 u_int32_t ia6t_pltime; /* prefix lifetime */ 97 }; 98 99 struct nd_ifinfo; 100 struct scope6_id; 101 struct lltable; 102 struct mld_ifsoftc; 103 struct in6_multi; 104 105 struct in6_ifextra { 106 counter_u64_t *in6_ifstat; 107 counter_u64_t *icmp6_ifstat; 108 struct nd_ifinfo *nd_ifinfo; 109 struct scope6_id *scope6_id; 110 struct lltable *lltable; 111 struct mld_ifsoftc *mld_ifinfo; 112 }; 113 114 #define LLTABLE6(ifp) (((struct in6_ifextra *)(ifp)->if_afdata[AF_INET6])->lltable) 115 116 #ifdef _KERNEL 117 118 SLIST_HEAD(in6_multi_head, in6_multi); 119 MALLOC_DECLARE(M_IP6MADDR); 120 121 struct in6_ifaddr { 122 struct ifaddr ia_ifa; /* protocol-independent info */ 123 #define ia_ifp ia_ifa.ifa_ifp 124 #define ia_flags ia_ifa.ifa_flags 125 struct sockaddr_in6 ia_addr; /* interface address */ 126 struct sockaddr_in6 ia_net; /* network number of interface */ 127 struct sockaddr_in6 ia_dstaddr; /* space for destination addr */ 128 struct sockaddr_in6 ia_prefixmask; /* prefix mask */ 129 u_int32_t ia_plen; /* prefix length */ 130 CK_STAILQ_ENTRY(in6_ifaddr) ia_link; /* list of IPv6 addresses */ 131 int ia6_flags; 132 133 struct in6_addrlifetime ia6_lifetime; 134 time_t ia6_createtime; /* the creation time of this address, which is 135 * currently used for temporary addresses only. 136 */ 137 time_t ia6_updatetime; 138 139 /* back pointer to the ND prefix (for autoconfigured addresses only) */ 140 struct nd_prefix *ia6_ndpr; 141 142 /* multicast addresses joined from the kernel */ 143 LIST_HEAD(, in6_multi_mship) ia6_memberships; 144 /* entry in bucket of inet6 addresses */ 145 CK_LIST_ENTRY(in6_ifaddr) ia6_hash; 146 }; 147 148 /* List of in6_ifaddr's. */ 149 CK_STAILQ_HEAD(in6_ifaddrhead, in6_ifaddr); 150 CK_LIST_HEAD(in6_ifaddrlisthead, in6_ifaddr); 151 #endif /* _KERNEL */ 152 153 /* control structure to manage address selection policy */ 154 struct in6_addrpolicy { 155 struct sockaddr_in6 addr; /* prefix address */ 156 struct sockaddr_in6 addrmask; /* prefix mask */ 157 int preced; /* precedence */ 158 int label; /* matching label */ 159 u_quad_t use; /* statistics */ 160 }; 161 162 /* 163 * IPv6 interface statistics, as defined in RFC2465 Ipv6IfStatsEntry (p12). 164 */ 165 struct in6_ifstat { 166 uint64_t ifs6_in_receive; /* # of total input datagram */ 167 uint64_t ifs6_in_hdrerr; /* # of datagrams with invalid hdr */ 168 uint64_t ifs6_in_toobig; /* # of datagrams exceeded MTU */ 169 uint64_t ifs6_in_noroute; /* # of datagrams with no route */ 170 uint64_t ifs6_in_addrerr; /* # of datagrams with invalid dst */ 171 uint64_t ifs6_in_protounknown; /* # of datagrams with unknown proto */ 172 /* NOTE: increment on final dst if */ 173 uint64_t ifs6_in_truncated; /* # of truncated datagrams */ 174 uint64_t ifs6_in_discard; /* # of discarded datagrams */ 175 /* NOTE: fragment timeout is not here */ 176 uint64_t ifs6_in_deliver; /* # of datagrams delivered to ULP */ 177 /* NOTE: increment on final dst if */ 178 uint64_t ifs6_out_forward; /* # of datagrams forwarded */ 179 /* NOTE: increment on outgoing if */ 180 uint64_t ifs6_out_request; /* # of outgoing datagrams from ULP */ 181 /* NOTE: does not include forwrads */ 182 uint64_t ifs6_out_discard; /* # of discarded datagrams */ 183 uint64_t ifs6_out_fragok; /* # of datagrams fragmented */ 184 uint64_t ifs6_out_fragfail; /* # of datagrams failed on fragment */ 185 uint64_t ifs6_out_fragcreat; /* # of fragment datagrams */ 186 /* NOTE: this is # after fragment */ 187 uint64_t ifs6_reass_reqd; /* # of incoming fragmented packets */ 188 /* NOTE: increment on final dst if */ 189 uint64_t ifs6_reass_ok; /* # of reassembled packets */ 190 /* NOTE: this is # after reass */ 191 /* NOTE: increment on final dst if */ 192 uint64_t ifs6_reass_fail; /* # of reass failures */ 193 /* NOTE: may not be packet count */ 194 /* NOTE: increment on final dst if */ 195 uint64_t ifs6_in_mcast; /* # of inbound multicast datagrams */ 196 uint64_t ifs6_out_mcast; /* # of outbound multicast datagrams */ 197 }; 198 199 /* 200 * ICMPv6 interface statistics, as defined in RFC2466 Ipv6IfIcmpEntry. 201 * XXX: I'm not sure if this file is the right place for this structure... 202 */ 203 struct icmp6_ifstat { 204 /* 205 * Input statistics 206 */ 207 /* ipv6IfIcmpInMsgs, total # of input messages */ 208 uint64_t ifs6_in_msg; 209 /* ipv6IfIcmpInErrors, # of input error messages */ 210 uint64_t ifs6_in_error; 211 /* ipv6IfIcmpInDestUnreachs, # of input dest unreach errors */ 212 uint64_t ifs6_in_dstunreach; 213 /* ipv6IfIcmpInAdminProhibs, # of input administratively prohibited errs */ 214 uint64_t ifs6_in_adminprohib; 215 /* ipv6IfIcmpInTimeExcds, # of input time exceeded errors */ 216 uint64_t ifs6_in_timeexceed; 217 /* ipv6IfIcmpInParmProblems, # of input parameter problem errors */ 218 uint64_t ifs6_in_paramprob; 219 /* ipv6IfIcmpInPktTooBigs, # of input packet too big errors */ 220 uint64_t ifs6_in_pkttoobig; 221 /* ipv6IfIcmpInEchos, # of input echo requests */ 222 uint64_t ifs6_in_echo; 223 /* ipv6IfIcmpInEchoReplies, # of input echo replies */ 224 uint64_t ifs6_in_echoreply; 225 /* ipv6IfIcmpInRouterSolicits, # of input router solicitations */ 226 uint64_t ifs6_in_routersolicit; 227 /* ipv6IfIcmpInRouterAdvertisements, # of input router advertisements */ 228 uint64_t ifs6_in_routeradvert; 229 /* ipv6IfIcmpInNeighborSolicits, # of input neighbor solicitations */ 230 uint64_t ifs6_in_neighborsolicit; 231 /* ipv6IfIcmpInNeighborAdvertisements, # of input neighbor advertisements */ 232 uint64_t ifs6_in_neighboradvert; 233 /* ipv6IfIcmpInRedirects, # of input redirects */ 234 uint64_t ifs6_in_redirect; 235 /* ipv6IfIcmpInGroupMembQueries, # of input MLD queries */ 236 uint64_t ifs6_in_mldquery; 237 /* ipv6IfIcmpInGroupMembResponses, # of input MLD reports */ 238 uint64_t ifs6_in_mldreport; 239 /* ipv6IfIcmpInGroupMembReductions, # of input MLD done */ 240 uint64_t ifs6_in_mlddone; 241 242 /* 243 * Output statistics. We should solve unresolved routing problem... 244 */ 245 /* ipv6IfIcmpOutMsgs, total # of output messages */ 246 uint64_t ifs6_out_msg; 247 /* ipv6IfIcmpOutErrors, # of output error messages */ 248 uint64_t ifs6_out_error; 249 /* ipv6IfIcmpOutDestUnreachs, # of output dest unreach errors */ 250 uint64_t ifs6_out_dstunreach; 251 /* ipv6IfIcmpOutAdminProhibs, # of output administratively prohibited errs */ 252 uint64_t ifs6_out_adminprohib; 253 /* ipv6IfIcmpOutTimeExcds, # of output time exceeded errors */ 254 uint64_t ifs6_out_timeexceed; 255 /* ipv6IfIcmpOutParmProblems, # of output parameter problem errors */ 256 uint64_t ifs6_out_paramprob; 257 /* ipv6IfIcmpOutPktTooBigs, # of output packet too big errors */ 258 uint64_t ifs6_out_pkttoobig; 259 /* ipv6IfIcmpOutEchos, # of output echo requests */ 260 uint64_t ifs6_out_echo; 261 /* ipv6IfIcmpOutEchoReplies, # of output echo replies */ 262 uint64_t ifs6_out_echoreply; 263 /* ipv6IfIcmpOutRouterSolicits, # of output router solicitations */ 264 uint64_t ifs6_out_routersolicit; 265 /* ipv6IfIcmpOutRouterAdvertisements, # of output router advertisements */ 266 uint64_t ifs6_out_routeradvert; 267 /* ipv6IfIcmpOutNeighborSolicits, # of output neighbor solicitations */ 268 uint64_t ifs6_out_neighborsolicit; 269 /* ipv6IfIcmpOutNeighborAdvertisements, # of output neighbor advertisements */ 270 uint64_t ifs6_out_neighboradvert; 271 /* ipv6IfIcmpOutRedirects, # of output redirects */ 272 uint64_t ifs6_out_redirect; 273 /* ipv6IfIcmpOutGroupMembQueries, # of output MLD queries */ 274 uint64_t ifs6_out_mldquery; 275 /* ipv6IfIcmpOutGroupMembResponses, # of output MLD reports */ 276 uint64_t ifs6_out_mldreport; 277 /* ipv6IfIcmpOutGroupMembReductions, # of output MLD done */ 278 uint64_t ifs6_out_mlddone; 279 }; 280 281 struct in6_ifreq { 282 char ifr_name[IFNAMSIZ]; 283 union { 284 struct sockaddr_in6 ifru_addr; 285 struct sockaddr_in6 ifru_dstaddr; 286 int ifru_flags; 287 int ifru_flags6; 288 int ifru_metric; 289 caddr_t ifru_data; 290 struct in6_addrlifetime ifru_lifetime; 291 struct in6_ifstat ifru_stat; 292 struct icmp6_ifstat ifru_icmp6stat; 293 u_int32_t ifru_scope_id[16]; 294 } ifr_ifru; 295 }; 296 297 struct in6_aliasreq { 298 char ifra_name[IFNAMSIZ]; 299 struct sockaddr_in6 ifra_addr; 300 struct sockaddr_in6 ifra_dstaddr; 301 struct sockaddr_in6 ifra_prefixmask; 302 int ifra_flags; 303 struct in6_addrlifetime ifra_lifetime; 304 int ifra_vhid; 305 }; 306 307 /* pre-10.x compat */ 308 struct oin6_aliasreq { 309 char ifra_name[IFNAMSIZ]; 310 struct sockaddr_in6 ifra_addr; 311 struct sockaddr_in6 ifra_dstaddr; 312 struct sockaddr_in6 ifra_prefixmask; 313 int ifra_flags; 314 struct in6_addrlifetime ifra_lifetime; 315 }; 316 317 /* prefix type macro */ 318 #define IN6_PREFIX_ND 1 319 #define IN6_PREFIX_RR 2 320 321 /* 322 * prefix related flags passed between kernel(NDP related part) and 323 * user land command(ifconfig) and daemon(rtadvd). 324 */ 325 struct in6_prflags { 326 struct prf_ra { 327 u_char onlink : 1; 328 u_char autonomous : 1; 329 u_char reserved : 6; 330 } prf_ra; 331 u_char prf_reserved1; 332 u_short prf_reserved2; 333 /* want to put this on 4byte offset */ 334 struct prf_rr { 335 u_char decrvalid : 1; 336 u_char decrprefd : 1; 337 u_char reserved : 6; 338 } prf_rr; 339 u_char prf_reserved3; 340 u_short prf_reserved4; 341 }; 342 343 struct in6_prefixreq { 344 char ipr_name[IFNAMSIZ]; 345 u_char ipr_origin; 346 u_char ipr_plen; 347 u_int32_t ipr_vltime; 348 u_int32_t ipr_pltime; 349 struct in6_prflags ipr_flags; 350 struct sockaddr_in6 ipr_prefix; 351 }; 352 353 #define PR_ORIG_RA 0 354 #define PR_ORIG_RR 1 355 #define PR_ORIG_STATIC 2 356 #define PR_ORIG_KERNEL 3 357 358 #define ipr_raf_onlink ipr_flags.prf_ra.onlink 359 #define ipr_raf_auto ipr_flags.prf_ra.autonomous 360 361 #define ipr_statef_onlink ipr_flags.prf_state.onlink 362 363 #define ipr_rrf_decrvalid ipr_flags.prf_rr.decrvalid 364 #define ipr_rrf_decrprefd ipr_flags.prf_rr.decrprefd 365 366 struct in6_rrenumreq { 367 char irr_name[IFNAMSIZ]; 368 u_char irr_origin; 369 u_char irr_m_len; /* match len for matchprefix */ 370 u_char irr_m_minlen; /* minlen for matching prefix */ 371 u_char irr_m_maxlen; /* maxlen for matching prefix */ 372 u_char irr_u_uselen; /* uselen for adding prefix */ 373 u_char irr_u_keeplen; /* keeplen from matching prefix */ 374 struct irr_raflagmask { 375 u_char onlink : 1; 376 u_char autonomous : 1; 377 u_char reserved : 6; 378 } irr_raflagmask; 379 u_int32_t irr_vltime; 380 u_int32_t irr_pltime; 381 struct in6_prflags irr_flags; 382 struct sockaddr_in6 irr_matchprefix; 383 struct sockaddr_in6 irr_useprefix; 384 }; 385 386 #define irr_raf_mask_onlink irr_raflagmask.onlink 387 #define irr_raf_mask_auto irr_raflagmask.autonomous 388 #define irr_raf_mask_reserved irr_raflagmask.reserved 389 390 #define irr_raf_onlink irr_flags.prf_ra.onlink 391 #define irr_raf_auto irr_flags.prf_ra.autonomous 392 393 #define irr_statef_onlink irr_flags.prf_state.onlink 394 395 #define irr_rrf irr_flags.prf_rr 396 #define irr_rrf_decrvalid irr_flags.prf_rr.decrvalid 397 #define irr_rrf_decrprefd irr_flags.prf_rr.decrprefd 398 399 /* 400 * Given a pointer to an in6_ifaddr (ifaddr), 401 * return a pointer to the addr as a sockaddr_in6 402 */ 403 #define IA6_IN6(ia) (&((ia)->ia_addr.sin6_addr)) 404 #define IA6_DSTIN6(ia) (&((ia)->ia_dstaddr.sin6_addr)) 405 #define IA6_MASKIN6(ia) (&((ia)->ia_prefixmask.sin6_addr)) 406 #define IA6_SIN6(ia) (&((ia)->ia_addr)) 407 #define IA6_DSTSIN6(ia) (&((ia)->ia_dstaddr)) 408 #define IFA_IN6(x) (&((struct sockaddr_in6 *)((x)->ifa_addr))->sin6_addr) 409 #define IFA_DSTIN6(x) (&((struct sockaddr_in6 *)((x)->ifa_dstaddr))->sin6_addr) 410 411 #define IFPR_IN6(x) (&((struct sockaddr_in6 *)((x)->ifpr_prefix))->sin6_addr) 412 413 #ifdef _KERNEL 414 #define IN6_ARE_MASKED_ADDR_EQUAL(d, a, m) ( \ 415 (((d)->s6_addr32[0] ^ (a)->s6_addr32[0]) & (m)->s6_addr32[0]) == 0 && \ 416 (((d)->s6_addr32[1] ^ (a)->s6_addr32[1]) & (m)->s6_addr32[1]) == 0 && \ 417 (((d)->s6_addr32[2] ^ (a)->s6_addr32[2]) & (m)->s6_addr32[2]) == 0 && \ 418 (((d)->s6_addr32[3] ^ (a)->s6_addr32[3]) & (m)->s6_addr32[3]) == 0 ) 419 #define IN6_MASK_ADDR(a, m) do { \ 420 (a)->s6_addr32[0] &= (m)->s6_addr32[0]; \ 421 (a)->s6_addr32[1] &= (m)->s6_addr32[1]; \ 422 (a)->s6_addr32[2] &= (m)->s6_addr32[2]; \ 423 (a)->s6_addr32[3] &= (m)->s6_addr32[3]; \ 424 } while (0) 425 #endif 426 427 #define SIOCSIFADDR_IN6 _IOW('i', 12, struct in6_ifreq) 428 #define SIOCGIFADDR_IN6 _IOWR('i', 33, struct in6_ifreq) 429 430 #ifdef _KERNEL 431 /* 432 * SIOCSxxx ioctls should be unused (see comments in in6.c), but 433 * we do not shift numbers for binary compatibility. 434 */ 435 #define SIOCSIFDSTADDR_IN6 _IOW('i', 14, struct in6_ifreq) 436 #define SIOCSIFNETMASK_IN6 _IOW('i', 22, struct in6_ifreq) 437 #endif 438 439 #define SIOCGIFDSTADDR_IN6 _IOWR('i', 34, struct in6_ifreq) 440 #define SIOCGIFNETMASK_IN6 _IOWR('i', 37, struct in6_ifreq) 441 442 #define SIOCDIFADDR_IN6 _IOW('i', 25, struct in6_ifreq) 443 #define OSIOCAIFADDR_IN6 _IOW('i', 26, struct oin6_aliasreq) 444 #define SIOCAIFADDR_IN6 _IOW('i', 27, struct in6_aliasreq) 445 446 #define SIOCSIFPHYADDR_IN6 _IOW('i', 70, struct in6_aliasreq) 447 #define SIOCGIFPSRCADDR_IN6 _IOWR('i', 71, struct in6_ifreq) 448 #define SIOCGIFPDSTADDR_IN6 _IOWR('i', 72, struct in6_ifreq) 449 450 #define SIOCGIFAFLAG_IN6 _IOWR('i', 73, struct in6_ifreq) 451 452 #ifdef _KERNEL 453 #define OSIOCGIFINFO_IN6 _IOWR('i', 76, struct in6_ondireq) 454 #endif 455 #define SIOCGIFINFO_IN6 _IOWR('i', 108, struct in6_ndireq) 456 #define SIOCSIFINFO_IN6 _IOWR('i', 109, struct in6_ndireq) 457 #define SIOCSNDFLUSH_IN6 _IOWR('i', 77, struct in6_ifreq) 458 #define SIOCGNBRINFO_IN6 _IOWR('i', 78, struct in6_nbrinfo) 459 #define SIOCSPFXFLUSH_IN6 _IOWR('i', 79, struct in6_ifreq) 460 #define SIOCSRTRFLUSH_IN6 _IOWR('i', 80, struct in6_ifreq) 461 462 #define SIOCGIFALIFETIME_IN6 _IOWR('i', 81, struct in6_ifreq) 463 #define SIOCGIFSTAT_IN6 _IOWR('i', 83, struct in6_ifreq) 464 #define SIOCGIFSTAT_ICMP6 _IOWR('i', 84, struct in6_ifreq) 465 466 #define SIOCSDEFIFACE_IN6 _IOWR('i', 85, struct in6_ndifreq) 467 #define SIOCGDEFIFACE_IN6 _IOWR('i', 86, struct in6_ndifreq) 468 469 #define SIOCSIFINFO_FLAGS _IOWR('i', 87, struct in6_ndireq) /* XXX */ 470 471 #define SIOCSSCOPE6 _IOW('i', 88, struct in6_ifreq) 472 #define SIOCGSCOPE6 _IOWR('i', 89, struct in6_ifreq) 473 #define SIOCGSCOPE6DEF _IOWR('i', 90, struct in6_ifreq) 474 475 #define SIOCSIFPREFIX_IN6 _IOW('i', 100, struct in6_prefixreq) /* set */ 476 #define SIOCGIFPREFIX_IN6 _IOWR('i', 101, struct in6_prefixreq) /* get */ 477 #define SIOCDIFPREFIX_IN6 _IOW('i', 102, struct in6_prefixreq) /* del */ 478 #define SIOCAIFPREFIX_IN6 _IOW('i', 103, struct in6_rrenumreq) /* add */ 479 #define SIOCCIFPREFIX_IN6 _IOW('i', 104, \ 480 struct in6_rrenumreq) /* change */ 481 #define SIOCSGIFPREFIX_IN6 _IOW('i', 105, \ 482 struct in6_rrenumreq) /* set global */ 483 484 #define SIOCGETSGCNT_IN6 _IOWR('u', 106, \ 485 struct sioc_sg_req6) /* get s,g pkt cnt */ 486 #define SIOCGETMIFCNT_IN6 _IOWR('u', 107, \ 487 struct sioc_mif_req6) /* get pkt cnt per if */ 488 489 #define SIOCAADDRCTL_POLICY _IOW('u', 108, struct in6_addrpolicy) 490 #define SIOCDADDRCTL_POLICY _IOW('u', 109, struct in6_addrpolicy) 491 492 #define IN6_IFF_ANYCAST 0x01 /* anycast address */ 493 #define IN6_IFF_TENTATIVE 0x02 /* tentative address */ 494 #define IN6_IFF_DUPLICATED 0x04 /* DAD detected duplicate */ 495 #define IN6_IFF_DETACHED 0x08 /* may be detached from the link */ 496 #define IN6_IFF_DEPRECATED 0x10 /* deprecated address */ 497 #define IN6_IFF_NODAD 0x20 /* don't perform DAD on this address 498 * (obsolete) 499 */ 500 #define IN6_IFF_AUTOCONF 0x40 /* autoconfigurable address. */ 501 #define IN6_IFF_TEMPORARY 0x80 /* temporary (anonymous) address. */ 502 #define IN6_IFF_PREFER_SOURCE 0x0100 /* preferred address for SAS */ 503 504 /* do not input/output */ 505 #define IN6_IFF_NOTREADY (IN6_IFF_TENTATIVE|IN6_IFF_DUPLICATED) 506 507 #ifdef _KERNEL 508 #define IN6_ARE_SCOPE_CMP(a,b) ((a)-(b)) 509 #define IN6_ARE_SCOPE_EQUAL(a,b) ((a)==(b)) 510 #endif 511 512 #ifdef _KERNEL 513 VNET_DECLARE(struct in6_ifaddrhead, in6_ifaddrhead); 514 VNET_DECLARE(struct in6_ifaddrlisthead *, in6_ifaddrhashtbl); 515 VNET_DECLARE(u_long, in6_ifaddrhmask); 516 #define V_in6_ifaddrhead VNET(in6_ifaddrhead) 517 #define V_in6_ifaddrhashtbl VNET(in6_ifaddrhashtbl) 518 #define V_in6_ifaddrhmask VNET(in6_ifaddrhmask) 519 520 #define IN6ADDR_NHASH_LOG2 8 521 #define IN6ADDR_NHASH (1 << IN6ADDR_NHASH_LOG2) 522 #define IN6ADDR_HASHVAL(x) (in6_addrhash(x)) 523 #define IN6ADDR_HASH(x) \ 524 (&V_in6_ifaddrhashtbl[IN6ADDR_HASHVAL(x) & V_in6_ifaddrhmask]) 525 526 static __inline uint32_t 527 in6_addrhash(const struct in6_addr *in6) 528 { 529 uint32_t x; 530 531 x = in6->s6_addr32[0] ^ in6->s6_addr32[1] ^ in6->s6_addr32[2] ^ 532 in6->s6_addr32[3]; 533 return (fnv_32_buf(&x, sizeof(x), FNV1_32_INIT)); 534 } 535 536 extern struct rmlock in6_ifaddr_lock; 537 #define IN6_IFADDR_LOCK_ASSERT() rm_assert(&in6_ifaddr_lock, RA_LOCKED) 538 #define IN6_IFADDR_RLOCK(t) rm_rlock(&in6_ifaddr_lock, (t)) 539 #define IN6_IFADDR_RLOCK_ASSERT() rm_assert(&in6_ifaddr_lock, RA_RLOCKED) 540 #define IN6_IFADDR_RUNLOCK(t) rm_runlock(&in6_ifaddr_lock, (t)) 541 #define IN6_IFADDR_WLOCK() rm_wlock(&in6_ifaddr_lock) 542 #define IN6_IFADDR_WLOCK_ASSERT() rm_assert(&in6_ifaddr_lock, RA_WLOCKED) 543 #define IN6_IFADDR_WUNLOCK() rm_wunlock(&in6_ifaddr_lock) 544 545 #define in6_ifstat_inc(ifp, tag) \ 546 do { \ 547 if (ifp) \ 548 counter_u64_add(((struct in6_ifextra *) \ 549 ((ifp)->if_afdata[AF_INET6]))->in6_ifstat[ \ 550 offsetof(struct in6_ifstat, tag) / sizeof(uint64_t)], 1);\ 551 } while (/*CONSTCOND*/ 0) 552 553 extern u_char inet6ctlerrmap[]; 554 VNET_DECLARE(unsigned long, in6_maxmtu); 555 #define V_in6_maxmtu VNET(in6_maxmtu) 556 #endif /* _KERNEL */ 557 558 /* 559 * IPv6 multicast MLD-layer source entry. 560 */ 561 struct ip6_msource { 562 RB_ENTRY(ip6_msource) im6s_link; /* RB tree links */ 563 struct in6_addr im6s_addr; 564 struct im6s_st { 565 uint16_t ex; /* # of exclusive members */ 566 uint16_t in; /* # of inclusive members */ 567 } im6s_st[2]; /* state at t0, t1 */ 568 uint8_t im6s_stp; /* pending query */ 569 }; 570 RB_HEAD(ip6_msource_tree, ip6_msource); 571 572 /* 573 * IPv6 multicast PCB-layer source entry. 574 * 575 * NOTE: overlapping use of struct ip6_msource fields at start. 576 */ 577 struct in6_msource { 578 RB_ENTRY(ip6_msource) im6s_link; /* Common field */ 579 struct in6_addr im6s_addr; /* Common field */ 580 uint8_t im6sl_st[2]; /* state before/at commit */ 581 }; 582 583 #ifdef _KERNEL 584 /* 585 * IPv6 source tree comparison function. 586 * 587 * An ordered predicate is necessary; bcmp() is not documented to return 588 * an indication of order, memcmp() is, and is an ISO C99 requirement. 589 */ 590 static __inline int 591 ip6_msource_cmp(const struct ip6_msource *a, const struct ip6_msource *b) 592 { 593 594 return (memcmp(&a->im6s_addr, &b->im6s_addr, sizeof(struct in6_addr))); 595 } 596 RB_PROTOTYPE(ip6_msource_tree, ip6_msource, im6s_link, ip6_msource_cmp); 597 598 /* 599 * IPv6 multicast PCB-layer group filter descriptor. 600 */ 601 struct in6_mfilter { 602 struct ip6_msource_tree im6f_sources; /* source list for (S,G) */ 603 u_long im6f_nsrc; /* # of source entries */ 604 uint8_t im6f_st[2]; /* state before/at commit */ 605 struct in6_multi *im6f_in6m; /* associated multicast address */ 606 STAILQ_ENTRY(in6_mfilter) im6f_entry; /* list entry */ 607 }; 608 609 /* 610 * Helper types and functions for IPv4 multicast filters. 611 */ 612 STAILQ_HEAD(ip6_mfilter_head, in6_mfilter); 613 614 struct in6_mfilter *ip6_mfilter_alloc(int mflags, int st0, int st1); 615 void ip6_mfilter_free(struct in6_mfilter *); 616 617 static inline void 618 ip6_mfilter_init(struct ip6_mfilter_head *head) 619 { 620 621 STAILQ_INIT(head); 622 } 623 624 static inline struct in6_mfilter * 625 ip6_mfilter_first(const struct ip6_mfilter_head *head) 626 { 627 628 return (STAILQ_FIRST(head)); 629 } 630 631 static inline void 632 ip6_mfilter_insert(struct ip6_mfilter_head *head, struct in6_mfilter *imf) 633 { 634 635 STAILQ_INSERT_TAIL(head, imf, im6f_entry); 636 } 637 638 static inline void 639 ip6_mfilter_remove(struct ip6_mfilter_head *head, struct in6_mfilter *imf) 640 { 641 642 STAILQ_REMOVE(head, imf, in6_mfilter, im6f_entry); 643 } 644 645 #define IP6_MFILTER_FOREACH(imf, head) \ 646 STAILQ_FOREACH(imf, head, im6f_entry) 647 648 static inline size_t 649 ip6_mfilter_count(struct ip6_mfilter_head *head) 650 { 651 struct in6_mfilter *imf; 652 size_t num = 0; 653 654 STAILQ_FOREACH(imf, head, im6f_entry) 655 num++; 656 return (num); 657 } 658 659 /* 660 * Legacy KAME IPv6 multicast membership descriptor. 661 */ 662 struct in6_multi_mship { 663 struct in6_multi *i6mm_maddr; 664 LIST_ENTRY(in6_multi_mship) i6mm_chain; 665 }; 666 667 /* 668 * IPv6 group descriptor. 669 * 670 * For every entry on an ifnet's if_multiaddrs list which represents 671 * an IP multicast group, there is one of these structures. 672 * 673 * If any source filters are present, then a node will exist in the RB-tree 674 * to permit fast lookup by source whenever an operation takes place. 675 * This permits pre-order traversal when we issue reports. 676 * Source filter trees are kept separately from the socket layer to 677 * greatly simplify locking. 678 * 679 * When MLDv2 is active, in6m_timer is the response to group query timer. 680 * The state-change timer in6m_sctimer is separate; whenever state changes 681 * for the group the state change record is generated and transmitted, 682 * and kept if retransmissions are necessary. 683 * 684 * FUTURE: in6m_link is now only used when groups are being purged 685 * on a detaching ifnet. It could be demoted to a SLIST_ENTRY, but 686 * because it is at the very start of the struct, we can't do this 687 * w/o breaking the ABI for ifmcstat. 688 */ 689 struct in6_multi { 690 struct in6_addr in6m_addr; /* IPv6 multicast address */ 691 struct ifnet *in6m_ifp; /* back pointer to ifnet */ 692 struct ifmultiaddr *in6m_ifma; /* back pointer to ifmultiaddr */ 693 u_int in6m_refcount; /* reference count */ 694 u_int in6m_state; /* state of the membership */ 695 u_int in6m_timer; /* MLD6 listener report timer */ 696 697 /* New fields for MLDv2 follow. */ 698 struct mld_ifsoftc *in6m_mli; /* MLD info */ 699 SLIST_ENTRY(in6_multi) in6m_nrele; /* to-be-released by MLD */ 700 SLIST_ENTRY(in6_multi) in6m_defer; /* deferred MLDv1 */ 701 struct ip6_msource_tree in6m_srcs; /* tree of sources */ 702 u_long in6m_nsrc; /* # of tree entries */ 703 704 struct mbufq in6m_scq; /* queue of pending 705 * state-change packets */ 706 struct timeval in6m_lastgsrtv; /* last G-S-R query */ 707 uint16_t in6m_sctimer; /* state-change timer */ 708 uint16_t in6m_scrv; /* state-change rexmit count */ 709 710 /* 711 * SSM state counters which track state at T0 (the time the last 712 * state-change report's RV timer went to zero) and T1 713 * (time of pending report, i.e. now). 714 * Used for computing MLDv2 state-change reports. Several refcounts 715 * are maintained here to optimize for common use-cases. 716 */ 717 struct in6m_st { 718 uint16_t iss_fmode; /* MLD filter mode */ 719 uint16_t iss_asm; /* # of ASM listeners */ 720 uint16_t iss_ex; /* # of exclusive members */ 721 uint16_t iss_in; /* # of inclusive members */ 722 uint16_t iss_rec; /* # of recorded sources */ 723 } in6m_st[2]; /* state at t0, t1 */ 724 }; 725 726 void in6m_disconnect_locked(struct in6_multi_head *inmh, struct in6_multi *inm); 727 728 /* 729 * Helper function to derive the filter mode on a source entry 730 * from its internal counters. Predicates are: 731 * A source is only excluded if all listeners exclude it. 732 * A source is only included if no listeners exclude it, 733 * and at least one listener includes it. 734 * May be used by ifmcstat(8). 735 */ 736 static __inline uint8_t 737 im6s_get_mode(const struct in6_multi *inm, const struct ip6_msource *ims, 738 uint8_t t) 739 { 740 741 t = !!t; 742 if (inm->in6m_st[t].iss_ex > 0 && 743 inm->in6m_st[t].iss_ex == ims->im6s_st[t].ex) 744 return (MCAST_EXCLUDE); 745 else if (ims->im6s_st[t].in > 0 && ims->im6s_st[t].ex == 0) 746 return (MCAST_INCLUDE); 747 return (MCAST_UNDEFINED); 748 } 749 750 /* 751 * Lock macros for IPv6 layer multicast address lists. IPv6 lock goes 752 * before link layer multicast locks in the lock order. In most cases, 753 * consumers of IN_*_MULTI() macros should acquire the locks before 754 * calling them; users of the in_{add,del}multi() functions should not. 755 */ 756 extern struct mtx in6_multi_list_mtx; 757 extern struct sx in6_multi_sx; 758 759 #define IN6_MULTI_LIST_LOCK() mtx_lock(&in6_multi_list_mtx) 760 #define IN6_MULTI_LIST_UNLOCK() mtx_unlock(&in6_multi_list_mtx) 761 #define IN6_MULTI_LIST_LOCK_ASSERT() mtx_assert(&in6_multi_list_mtx, MA_OWNED) 762 #define IN6_MULTI_LIST_UNLOCK_ASSERT() mtx_assert(&in6_multi_list_mtx, MA_NOTOWNED) 763 764 #define IN6_MULTI_LOCK() sx_xlock(&in6_multi_sx) 765 #define IN6_MULTI_UNLOCK() sx_xunlock(&in6_multi_sx) 766 #define IN6_MULTI_LOCK_ASSERT() sx_assert(&in6_multi_sx, SA_XLOCKED) 767 #define IN6_MULTI_UNLOCK_ASSERT() sx_assert(&in6_multi_sx, SA_XUNLOCKED) 768 769 /* 770 * Get the in6_multi pointer from a ifmultiaddr. 771 * Returns NULL if ifmultiaddr is no longer valid. 772 */ 773 static __inline struct in6_multi * 774 in6m_ifmultiaddr_get_inm(struct ifmultiaddr *ifma) 775 { 776 777 NET_EPOCH_ASSERT(); 778 779 return ((ifma->ifma_addr->sa_family != AF_INET6 || 780 (ifma->ifma_flags & IFMA_F_ENQUEUED) == 0) ? NULL : 781 ifma->ifma_protospec); 782 } 783 784 /* 785 * Look up an in6_multi record for an IPv6 multicast address 786 * on the interface ifp. 787 * If no record found, return NULL. 788 * 789 * SMPng: The IN6_MULTI_LOCK and must be held and must be in network epoch. 790 */ 791 static __inline struct in6_multi * 792 in6m_lookup_locked(struct ifnet *ifp, const struct in6_addr *mcaddr) 793 { 794 struct ifmultiaddr *ifma; 795 struct in6_multi *inm; 796 797 CK_STAILQ_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link) { 798 inm = in6m_ifmultiaddr_get_inm(ifma); 799 if (inm == NULL) 800 continue; 801 if (IN6_ARE_ADDR_EQUAL(&inm->in6m_addr, mcaddr)) 802 return (inm); 803 } 804 return (NULL); 805 } 806 807 /* 808 * Wrapper for in6m_lookup_locked(). 809 * 810 * SMPng: Assumes network epoch entered and that IN6_MULTI_LOCK() isn't held. 811 */ 812 static __inline struct in6_multi * 813 in6m_lookup(struct ifnet *ifp, const struct in6_addr *mcaddr) 814 { 815 struct in6_multi *inm; 816 817 NET_EPOCH_ASSERT(); 818 819 IN6_MULTI_LIST_LOCK(); 820 inm = in6m_lookup_locked(ifp, mcaddr); 821 IN6_MULTI_LIST_UNLOCK(); 822 823 return (inm); 824 } 825 826 /* Acquire an in6_multi record. */ 827 static __inline void 828 in6m_acquire_locked(struct in6_multi *inm) 829 { 830 831 IN6_MULTI_LIST_LOCK_ASSERT(); 832 ++inm->in6m_refcount; 833 } 834 835 static __inline void 836 in6m_acquire(struct in6_multi *inm) 837 { 838 IN6_MULTI_LIST_LOCK(); 839 in6m_acquire_locked(inm); 840 IN6_MULTI_LIST_UNLOCK(); 841 } 842 843 static __inline void 844 in6m_rele_locked(struct in6_multi_head *inmh, struct in6_multi *inm) 845 { 846 KASSERT(inm->in6m_refcount > 0, ("refcount == %d inm: %p", inm->in6m_refcount, inm)); 847 IN6_MULTI_LIST_LOCK_ASSERT(); 848 849 if (--inm->in6m_refcount == 0) { 850 MPASS(inm->in6m_ifp == NULL); 851 inm->in6m_ifma->ifma_protospec = NULL; 852 MPASS(inm->in6m_ifma->ifma_llifma == NULL); 853 SLIST_INSERT_HEAD(inmh, inm, in6m_nrele); 854 } 855 } 856 857 struct ip6_moptions; 858 struct sockopt; 859 struct inpcbinfo; 860 struct rib_head; 861 862 /* Multicast KPIs. */ 863 int im6o_mc_filter(const struct ip6_moptions *, const struct ifnet *, 864 const struct sockaddr *, const struct sockaddr *); 865 int in6_joingroup(struct ifnet *, const struct in6_addr *, 866 struct in6_mfilter *, struct in6_multi **, int); 867 int in6_leavegroup(struct in6_multi *, struct in6_mfilter *); 868 int in6_leavegroup_locked(struct in6_multi *, struct in6_mfilter *); 869 void in6m_clear_recorded(struct in6_multi *); 870 void in6m_commit(struct in6_multi *); 871 void in6m_print(const struct in6_multi *); 872 int in6m_record_source(struct in6_multi *, const struct in6_addr *); 873 void in6m_release_list_deferred(struct in6_multi_head *); 874 void in6m_release_wait(void *); 875 void ip6_freemoptions(struct ip6_moptions *); 876 int ip6_getmoptions(struct inpcb *, struct sockopt *); 877 int ip6_setmoptions(struct inpcb *, struct sockopt *); 878 879 /* flags to in6_update_ifa */ 880 #define IN6_IFAUPDATE_DADDELAY 0x1 /* first time to configure an address */ 881 882 int in6_mask2len(struct in6_addr *, u_char *); 883 int in6_control(struct socket *, u_long, caddr_t, struct ifnet *, 884 struct thread *); 885 int in6_update_ifa(struct ifnet *, struct in6_aliasreq *, 886 struct in6_ifaddr *, int); 887 void in6_prepare_ifra(struct in6_aliasreq *, const struct in6_addr *, 888 const struct in6_addr *); 889 void in6_purgeaddr(struct ifaddr *); 890 int in6if_do_dad(struct ifnet *); 891 void in6_savemkludge(struct in6_ifaddr *); 892 void *in6_domifattach(struct ifnet *); 893 void in6_domifdetach(struct ifnet *, void *); 894 int in6_domifmtu(struct ifnet *); 895 struct rib_head *in6_inithead(uint32_t fibnum); 896 void in6_detachhead(struct rib_head *rh); 897 void in6_setmaxmtu(void); 898 int in6_if2idlen(struct ifnet *); 899 struct in6_ifaddr *in6ifa_ifpforlinklocal(struct ifnet *, int); 900 struct in6_ifaddr *in6ifa_ifpwithaddr(struct ifnet *, const struct in6_addr *); 901 struct in6_ifaddr *in6ifa_ifwithaddr(const struct in6_addr *, uint32_t); 902 struct in6_ifaddr *in6ifa_llaonifp(struct ifnet *); 903 int in6_addr2zoneid(struct ifnet *, struct in6_addr *, u_int32_t *); 904 int in6_matchlen(struct in6_addr *, struct in6_addr *); 905 int in6_are_prefix_equal(struct in6_addr *, struct in6_addr *, int); 906 void in6_prefixlen2mask(struct in6_addr *, int); 907 int in6_prefix_ioctl(struct socket *, u_long, caddr_t, 908 struct ifnet *); 909 int in6_prefix_add_ifid(int, struct in6_ifaddr *); 910 void in6_prefix_remove_ifid(int, struct in6_ifaddr *); 911 void in6_purgeprefix(struct ifnet *); 912 913 int in6_is_addr_deprecated(struct sockaddr_in6 *); 914 int in6_src_ioctl(u_long, caddr_t); 915 916 void in6_newaddrmsg(struct in6_ifaddr *, int); 917 /* 918 * Extended API for IPv6 FIB support. 919 */ 920 struct mbuf *ip6_tryforward(struct mbuf *); 921 #endif /* _KERNEL */ 922 923 #endif /* _NETINET6_IN6_VAR_H_ */ 924