in_pcb.h revision 281161
1/*- 2 * Copyright (c) 1982, 1986, 1990, 1993 3 * The Regents of the University of California. 4 * Copyright (c) 2010-2011 Juniper Networks, Inc. 5 * All rights reserved. 6 * 7 * Portions of this software were developed by Robert N. M. Watson under 8 * contract to Juniper Networks, Inc. 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in the 17 * documentation and/or other materials provided with the distribution. 18 * 4. Neither the name of the University nor the names of its contributors 19 * may be used to endorse or promote products derived from this software 20 * without specific prior written permission. 21 * 22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32 * SUCH DAMAGE. 33 * 34 * @(#)in_pcb.h 8.1 (Berkeley) 6/10/93 35 * $FreeBSD: stable/10/sys/netinet/in_pcb.h 281161 2015-04-06 18:40:50Z hiren $ 36 */ 37 38#ifndef _NETINET_IN_PCB_H_ 39#define _NETINET_IN_PCB_H_ 40 41#include <sys/queue.h> 42#include <sys/_lock.h> 43#include <sys/_mutex.h> 44#include <sys/_rwlock.h> 45 46#ifdef _KERNEL 47#include <sys/lock.h> 48#include <sys/rwlock.h> 49#include <net/vnet.h> 50#include <vm/uma.h> 51#endif 52 53#define in6pcb inpcb /* for KAME src sync over BSD*'s */ 54#define in6p_sp inp_sp /* for KAME src sync over BSD*'s */ 55struct inpcbpolicy; 56 57/* 58 * struct inpcb is the common protocol control block structure used in most 59 * IP transport protocols. 60 * 61 * Pointers to local and foreign host table entries, local and foreign socket 62 * numbers, and pointers up (to a socket structure) and down (to a 63 * protocol-specific control block) are stored here. 64 */ 65LIST_HEAD(inpcbhead, inpcb); 66LIST_HEAD(inpcbporthead, inpcbport); 67typedef u_quad_t inp_gen_t; 68 69/* 70 * PCB with AF_INET6 null bind'ed laddr can receive AF_INET input packet. 71 * So, AF_INET6 null laddr is also used as AF_INET null laddr, by utilizing 72 * the following structure. 73 */ 74struct in_addr_4in6 { 75 u_int32_t ia46_pad32[3]; 76 struct in_addr ia46_addr4; 77}; 78 79/* 80 * NOTE: ipv6 addrs should be 64-bit aligned, per RFC 2553. in_conninfo has 81 * some extra padding to accomplish this. 82 */ 83struct in_endpoints { 84 u_int16_t ie_fport; /* foreign port */ 85 u_int16_t ie_lport; /* local port */ 86 /* protocol dependent part, local and foreign addr */ 87 union { 88 /* foreign host table entry */ 89 struct in_addr_4in6 ie46_foreign; 90 struct in6_addr ie6_foreign; 91 } ie_dependfaddr; 92 union { 93 /* local host table entry */ 94 struct in_addr_4in6 ie46_local; 95 struct in6_addr ie6_local; 96 } ie_dependladdr; 97}; 98#define ie_faddr ie_dependfaddr.ie46_foreign.ia46_addr4 99#define ie_laddr ie_dependladdr.ie46_local.ia46_addr4 100#define ie6_faddr ie_dependfaddr.ie6_foreign 101#define ie6_laddr ie_dependladdr.ie6_local 102 103/* 104 * XXX The defines for inc_* are hacks and should be changed to direct 105 * references. 106 */ 107struct in_conninfo { 108 u_int8_t inc_flags; 109 u_int8_t inc_len; 110 u_int16_t inc_fibnum; /* XXX was pad, 16 bits is plenty */ 111 /* protocol dependent part */ 112 struct in_endpoints inc_ie; 113}; 114 115/* 116 * Flags for inc_flags. 117 */ 118#define INC_ISIPV6 0x01 119 120#define inc_isipv6 inc_flags /* temp compatability */ 121#define inc_fport inc_ie.ie_fport 122#define inc_lport inc_ie.ie_lport 123#define inc_faddr inc_ie.ie_faddr 124#define inc_laddr inc_ie.ie_laddr 125#define inc6_faddr inc_ie.ie6_faddr 126#define inc6_laddr inc_ie.ie6_laddr 127 128struct icmp6_filter; 129 130/*- 131 * struct inpcb captures the network layer state for TCP, UDP, and raw IPv4 132 * and IPv6 sockets. In the case of TCP, further per-connection state is 133 * hung off of inp_ppcb most of the time. Almost all fields of struct inpcb 134 * are static after creation or protected by a per-inpcb rwlock, inp_lock. A 135 * few fields also require the global pcbinfo lock for the inpcb to be held, 136 * when modified, such as the global connection lists and hashes, as well as 137 * binding information (which affects which hash a connection is on). This 138 * model means that connections can be looked up without holding the 139 * per-connection lock, which is important for performance when attempting to 140 * find the connection for a packet given its IP and port tuple. Writing to 141 * these fields that write locks be held on both the inpcb and global locks. 142 * 143 * Key: 144 * (c) - Constant after initialization 145 * (g) - Protected by the pcbgroup lock 146 * (i) - Protected by the inpcb lock 147 * (p) - Protected by the pcbinfo lock for the inpcb 148 * (s) - Protected by another subsystem's locks 149 * (x) - Undefined locking 150 * 151 * A few other notes: 152 * 153 * When a read lock is held, stability of the field is guaranteed; to write 154 * to a field, a write lock must generally be held. 155 * 156 * netinet/netinet6-layer code should not assume that the inp_socket pointer 157 * is safe to dereference without inp_lock being held, even for protocols 158 * other than TCP (where the inpcb persists during TIMEWAIT even after the 159 * socket has been freed), or there may be close(2)-related races. 160 * 161 * The inp_vflag field is overloaded, and would otherwise ideally be (c). 162 */ 163struct inpcb { 164 LIST_ENTRY(inpcb) inp_hash; /* (i/p) hash list */ 165 LIST_ENTRY(inpcb) inp_pcbgrouphash; /* (g/i) hash list */ 166 LIST_ENTRY(inpcb) inp_list; /* (i/p) list for all PCBs for proto */ 167 void *inp_ppcb; /* (i) pointer to per-protocol pcb */ 168 struct inpcbinfo *inp_pcbinfo; /* (c) PCB list info */ 169 struct inpcbgroup *inp_pcbgroup; /* (g/i) PCB group list */ 170 LIST_ENTRY(inpcb) inp_pcbgroup_wild; /* (g/i/p) group wildcard entry */ 171 struct socket *inp_socket; /* (i) back pointer to socket */ 172 struct ucred *inp_cred; /* (c) cache of socket cred */ 173 u_int32_t inp_flow; /* (i) IPv6 flow information */ 174 int inp_flags; /* (i) generic IP/datagram flags */ 175 int inp_flags2; /* (i) generic IP/datagram flags #2*/ 176 u_char inp_vflag; /* (i) IP version flag (v4/v6) */ 177 u_char inp_ip_ttl; /* (i) time to live proto */ 178 u_char inp_ip_p; /* (c) protocol proto */ 179 u_char inp_ip_minttl; /* (i) minimum TTL or drop */ 180 uint32_t inp_flowid; /* (x) flow id / queue id */ 181 u_int inp_refcount; /* (i) refcount */ 182 void *inp_pspare[5]; /* (x) route caching / general use */ 183 uint32_t inp_flowtype; /* (x) M_HASHTYPE value */ 184 u_int inp_ispare[5]; /* (x) route caching / user cookie / 185 * general use */ 186 187 /* Local and foreign ports, local and foreign addr. */ 188 struct in_conninfo inp_inc; /* (i/p) list for PCB's local port */ 189 190 /* MAC and IPSEC policy information. */ 191 struct label *inp_label; /* (i) MAC label */ 192 struct inpcbpolicy *inp_sp; /* (s) for IPSEC */ 193 194 /* Protocol-dependent part; options. */ 195 struct { 196 u_char inp4_ip_tos; /* (i) type of service proto */ 197 struct mbuf *inp4_options; /* (i) IP options */ 198 struct ip_moptions *inp4_moptions; /* (i) IP mcast options */ 199 } inp_depend4; 200 struct { 201 /* (i) IP options */ 202 struct mbuf *inp6_options; 203 /* (i) IP6 options for outgoing packets */ 204 struct ip6_pktopts *inp6_outputopts; 205 /* (i) IP multicast options */ 206 struct ip6_moptions *inp6_moptions; 207 /* (i) ICMPv6 code type filter */ 208 struct icmp6_filter *inp6_icmp6filt; 209 /* (i) IPV6_CHECKSUM setsockopt */ 210 int inp6_cksum; 211 short inp6_hops; 212 } inp_depend6; 213 LIST_ENTRY(inpcb) inp_portlist; /* (i/p) */ 214 struct inpcbport *inp_phd; /* (i/p) head of this list */ 215#define inp_zero_size offsetof(struct inpcb, inp_gencnt) 216 inp_gen_t inp_gencnt; /* (c) generation count */ 217 struct llentry *inp_lle; /* cached L2 information */ 218 struct rtentry *inp_rt; /* cached L3 information */ 219 struct rwlock inp_lock; 220}; 221#define inp_fport inp_inc.inc_fport 222#define inp_lport inp_inc.inc_lport 223#define inp_faddr inp_inc.inc_faddr 224#define inp_laddr inp_inc.inc_laddr 225#define inp_ip_tos inp_depend4.inp4_ip_tos 226#define inp_options inp_depend4.inp4_options 227#define inp_moptions inp_depend4.inp4_moptions 228 229#define in6p_faddr inp_inc.inc6_faddr 230#define in6p_laddr inp_inc.inc6_laddr 231#define in6p_hops inp_depend6.inp6_hops /* default hop limit */ 232#define in6p_flowinfo inp_flow 233#define in6p_options inp_depend6.inp6_options 234#define in6p_outputopts inp_depend6.inp6_outputopts 235#define in6p_moptions inp_depend6.inp6_moptions 236#define in6p_icmp6filt inp_depend6.inp6_icmp6filt 237#define in6p_cksum inp_depend6.inp6_cksum 238 239#define inp_vnet inp_pcbinfo->ipi_vnet 240 241/* 242 * The range of the generation count, as used in this implementation, is 9e19. 243 * We would have to create 300 billion connections per second for this number 244 * to roll over in a year. This seems sufficiently unlikely that we simply 245 * don't concern ourselves with that possibility. 246 */ 247 248/* 249 * Interface exported to userland by various protocols which use inpcbs. Hack 250 * alert -- only define if struct xsocket is in scope. 251 */ 252#ifdef _SYS_SOCKETVAR_H_ 253struct xinpcb { 254 size_t xi_len; /* length of this structure */ 255 struct inpcb xi_inp; 256 struct xsocket xi_socket; 257 u_quad_t xi_alignment_hack; 258}; 259 260struct xinpgen { 261 size_t xig_len; /* length of this structure */ 262 u_int xig_count; /* number of PCBs at this time */ 263 inp_gen_t xig_gen; /* generation count at this time */ 264 so_gen_t xig_sogen; /* socket generation count at this time */ 265}; 266#endif /* _SYS_SOCKETVAR_H_ */ 267 268struct inpcbport { 269 LIST_ENTRY(inpcbport) phd_hash; 270 struct inpcbhead phd_pcblist; 271 u_short phd_port; 272}; 273 274/*- 275 * Global data structure for each high-level protocol (UDP, TCP, ...) in both 276 * IPv4 and IPv6. Holds inpcb lists and information for managing them. 277 * 278 * Each pcbinfo is protected by two locks: ipi_lock and ipi_hash_lock, 279 * the former covering mutable global fields (such as the global pcb list), 280 * and the latter covering the hashed lookup tables. The lock order is: 281 * 282 * ipi_lock (before) inpcb locks (before) {ipi_hash_lock, pcbgroup locks} 283 * 284 * Locking key: 285 * 286 * (c) Constant or nearly constant after initialisation 287 * (g) Locked by ipi_lock 288 * (h) Read using either ipi_hash_lock or inpcb lock; write requires both 289 * (p) Protected by one or more pcbgroup locks 290 * (x) Synchronisation properties poorly defined 291 */ 292struct inpcbinfo { 293 /* 294 * Global lock protecting global inpcb list, inpcb count, etc. 295 */ 296 struct rwlock ipi_lock; 297 298 /* 299 * Global list of inpcbs on the protocol. 300 */ 301 struct inpcbhead *ipi_listhead; /* (g) */ 302 u_int ipi_count; /* (g) */ 303 304 /* 305 * Generation count -- incremented each time a connection is allocated 306 * or freed. 307 */ 308 u_quad_t ipi_gencnt; /* (g) */ 309 310 /* 311 * Fields associated with port lookup and allocation. 312 */ 313 u_short ipi_lastport; /* (x) */ 314 u_short ipi_lastlow; /* (x) */ 315 u_short ipi_lasthi; /* (x) */ 316 317 /* 318 * UMA zone from which inpcbs are allocated for this protocol. 319 */ 320 struct uma_zone *ipi_zone; /* (c) */ 321 322 /* 323 * Connection groups associated with this protocol. These fields are 324 * constant, but pcbgroup structures themselves are protected by 325 * per-pcbgroup locks. 326 */ 327 struct inpcbgroup *ipi_pcbgroups; /* (c) */ 328 u_int ipi_npcbgroups; /* (c) */ 329 u_int ipi_hashfields; /* (c) */ 330 331 /* 332 * Global lock protecting non-pcbgroup hash lookup tables. 333 */ 334 struct rwlock ipi_hash_lock; 335 336 /* 337 * Global hash of inpcbs, hashed by local and foreign addresses and 338 * port numbers. 339 */ 340 struct inpcbhead *ipi_hashbase; /* (h) */ 341 u_long ipi_hashmask; /* (h) */ 342 343 /* 344 * Global hash of inpcbs, hashed by only local port number. 345 */ 346 struct inpcbporthead *ipi_porthashbase; /* (h) */ 347 u_long ipi_porthashmask; /* (h) */ 348 349 /* 350 * List of wildcard inpcbs for use with pcbgroups. In the past, was 351 * per-pcbgroup but is now global. All pcbgroup locks must be held 352 * to modify the list, so any is sufficient to read it. 353 */ 354 struct inpcbhead *ipi_wildbase; /* (p) */ 355 u_long ipi_wildmask; /* (p) */ 356 357 /* 358 * Pointer to network stack instance 359 */ 360 struct vnet *ipi_vnet; /* (c) */ 361 362 /* 363 * general use 2 364 */ 365 void *ipi_pspare[2]; 366}; 367 368#ifdef _KERNEL 369/* 370 * Connection groups hold sets of connections that have similar CPU/thread 371 * affinity. Each connection belongs to exactly one connection group. 372 */ 373struct inpcbgroup { 374 /* 375 * Per-connection group hash of inpcbs, hashed by local and foreign 376 * addresses and port numbers. 377 */ 378 struct inpcbhead *ipg_hashbase; /* (c) */ 379 u_long ipg_hashmask; /* (c) */ 380 381 /* 382 * Notional affinity of this pcbgroup. 383 */ 384 u_int ipg_cpu; /* (p) */ 385 386 /* 387 * Per-connection group lock, not to be confused with ipi_lock. 388 * Protects the hash table hung off the group, but also the global 389 * wildcard list in inpcbinfo. 390 */ 391 struct mtx ipg_lock; 392} __aligned(CACHE_LINE_SIZE); 393 394#define INP_LOCK_INIT(inp, d, t) \ 395 rw_init_flags(&(inp)->inp_lock, (t), RW_RECURSE | RW_DUPOK) 396#define INP_LOCK_DESTROY(inp) rw_destroy(&(inp)->inp_lock) 397#define INP_RLOCK(inp) rw_rlock(&(inp)->inp_lock) 398#define INP_WLOCK(inp) rw_wlock(&(inp)->inp_lock) 399#define INP_TRY_RLOCK(inp) rw_try_rlock(&(inp)->inp_lock) 400#define INP_TRY_WLOCK(inp) rw_try_wlock(&(inp)->inp_lock) 401#define INP_RUNLOCK(inp) rw_runlock(&(inp)->inp_lock) 402#define INP_WUNLOCK(inp) rw_wunlock(&(inp)->inp_lock) 403#define INP_TRY_UPGRADE(inp) rw_try_upgrade(&(inp)->inp_lock) 404#define INP_DOWNGRADE(inp) rw_downgrade(&(inp)->inp_lock) 405#define INP_WLOCKED(inp) rw_wowned(&(inp)->inp_lock) 406#define INP_LOCK_ASSERT(inp) rw_assert(&(inp)->inp_lock, RA_LOCKED) 407#define INP_RLOCK_ASSERT(inp) rw_assert(&(inp)->inp_lock, RA_RLOCKED) 408#define INP_WLOCK_ASSERT(inp) rw_assert(&(inp)->inp_lock, RA_WLOCKED) 409#define INP_UNLOCK_ASSERT(inp) rw_assert(&(inp)->inp_lock, RA_UNLOCKED) 410 411/* 412 * These locking functions are for inpcb consumers outside of sys/netinet, 413 * more specifically, they were added for the benefit of TOE drivers. The 414 * macros are reserved for use by the stack. 415 */ 416void inp_wlock(struct inpcb *); 417void inp_wunlock(struct inpcb *); 418void inp_rlock(struct inpcb *); 419void inp_runlock(struct inpcb *); 420 421#ifdef INVARIANTS 422void inp_lock_assert(struct inpcb *); 423void inp_unlock_assert(struct inpcb *); 424#else 425static __inline void 426inp_lock_assert(struct inpcb *inp __unused) 427{ 428} 429 430static __inline void 431inp_unlock_assert(struct inpcb *inp __unused) 432{ 433} 434 435#endif 436 437void inp_apply_all(void (*func)(struct inpcb *, void *), void *arg); 438int inp_ip_tos_get(const struct inpcb *inp); 439void inp_ip_tos_set(struct inpcb *inp, int val); 440struct socket * 441 inp_inpcbtosocket(struct inpcb *inp); 442struct tcpcb * 443 inp_inpcbtotcpcb(struct inpcb *inp); 444void inp_4tuple_get(struct inpcb *inp, uint32_t *laddr, uint16_t *lp, 445 uint32_t *faddr, uint16_t *fp); 446short inp_so_options(const struct inpcb *inp); 447 448#endif /* _KERNEL */ 449 450#define INP_INFO_LOCK_INIT(ipi, d) \ 451 rw_init_flags(&(ipi)->ipi_lock, (d), RW_RECURSE) 452#define INP_INFO_LOCK_DESTROY(ipi) rw_destroy(&(ipi)->ipi_lock) 453#define INP_INFO_RLOCK(ipi) rw_rlock(&(ipi)->ipi_lock) 454#define INP_INFO_WLOCK(ipi) rw_wlock(&(ipi)->ipi_lock) 455#define INP_INFO_TRY_RLOCK(ipi) rw_try_rlock(&(ipi)->ipi_lock) 456#define INP_INFO_TRY_WLOCK(ipi) rw_try_wlock(&(ipi)->ipi_lock) 457#define INP_INFO_TRY_UPGRADE(ipi) rw_try_upgrade(&(ipi)->ipi_lock) 458#define INP_INFO_RUNLOCK(ipi) rw_runlock(&(ipi)->ipi_lock) 459#define INP_INFO_WUNLOCK(ipi) rw_wunlock(&(ipi)->ipi_lock) 460#define INP_INFO_LOCK_ASSERT(ipi) rw_assert(&(ipi)->ipi_lock, RA_LOCKED) 461#define INP_INFO_RLOCK_ASSERT(ipi) rw_assert(&(ipi)->ipi_lock, RA_RLOCKED) 462#define INP_INFO_WLOCK_ASSERT(ipi) rw_assert(&(ipi)->ipi_lock, RA_WLOCKED) 463#define INP_INFO_UNLOCK_ASSERT(ipi) rw_assert(&(ipi)->ipi_lock, RA_UNLOCKED) 464 465#define INP_HASH_LOCK_INIT(ipi, d) \ 466 rw_init_flags(&(ipi)->ipi_hash_lock, (d), 0) 467#define INP_HASH_LOCK_DESTROY(ipi) rw_destroy(&(ipi)->ipi_hash_lock) 468#define INP_HASH_RLOCK(ipi) rw_rlock(&(ipi)->ipi_hash_lock) 469#define INP_HASH_WLOCK(ipi) rw_wlock(&(ipi)->ipi_hash_lock) 470#define INP_HASH_RUNLOCK(ipi) rw_runlock(&(ipi)->ipi_hash_lock) 471#define INP_HASH_WUNLOCK(ipi) rw_wunlock(&(ipi)->ipi_hash_lock) 472#define INP_HASH_LOCK_ASSERT(ipi) rw_assert(&(ipi)->ipi_hash_lock, \ 473 RA_LOCKED) 474#define INP_HASH_WLOCK_ASSERT(ipi) rw_assert(&(ipi)->ipi_hash_lock, \ 475 RA_WLOCKED) 476 477#define INP_GROUP_LOCK_INIT(ipg, d) mtx_init(&(ipg)->ipg_lock, (d), NULL, \ 478 MTX_DEF | MTX_DUPOK) 479#define INP_GROUP_LOCK_DESTROY(ipg) mtx_destroy(&(ipg)->ipg_lock) 480 481#define INP_GROUP_LOCK(ipg) mtx_lock(&(ipg)->ipg_lock) 482#define INP_GROUP_LOCK_ASSERT(ipg) mtx_assert(&(ipg)->ipg_lock, MA_OWNED) 483#define INP_GROUP_UNLOCK(ipg) mtx_unlock(&(ipg)->ipg_lock) 484 485#define INP_PCBHASH(faddr, lport, fport, mask) \ 486 (((faddr) ^ ((faddr) >> 16) ^ ntohs((lport) ^ (fport))) & (mask)) 487#define INP_PCBPORTHASH(lport, mask) \ 488 (ntohs((lport)) & (mask)) 489 490/* 491 * Flags for inp_vflags -- historically version flags only 492 */ 493#define INP_IPV4 0x1 494#define INP_IPV6 0x2 495#define INP_IPV6PROTO 0x4 /* opened under IPv6 protocol */ 496 497/* 498 * Flags for inp_flags. 499 */ 500#define INP_RECVOPTS 0x00000001 /* receive incoming IP options */ 501#define INP_RECVRETOPTS 0x00000002 /* receive IP options for reply */ 502#define INP_RECVDSTADDR 0x00000004 /* receive IP dst address */ 503#define INP_HDRINCL 0x00000008 /* user supplies entire IP header */ 504#define INP_HIGHPORT 0x00000010 /* user wants "high" port binding */ 505#define INP_LOWPORT 0x00000020 /* user wants "low" port binding */ 506#define INP_ANONPORT 0x00000040 /* port chosen for user */ 507#define INP_RECVIF 0x00000080 /* receive incoming interface */ 508#define INP_MTUDISC 0x00000100 /* user can do MTU discovery */ 509#define INP_FAITH 0x00000200 /* accept FAITH'ed connections */ 510#define INP_RECVTTL 0x00000400 /* receive incoming IP TTL */ 511#define INP_DONTFRAG 0x00000800 /* don't fragment packet */ 512#define INP_BINDANY 0x00001000 /* allow bind to any address */ 513#define INP_INHASHLIST 0x00002000 /* in_pcbinshash() has been called */ 514#define INP_RECVTOS 0x00004000 /* receive incoming IP TOS */ 515#define IN6P_IPV6_V6ONLY 0x00008000 /* restrict AF_INET6 socket for v6 */ 516#define IN6P_PKTINFO 0x00010000 /* receive IP6 dst and I/F */ 517#define IN6P_HOPLIMIT 0x00020000 /* receive hoplimit */ 518#define IN6P_HOPOPTS 0x00040000 /* receive hop-by-hop options */ 519#define IN6P_DSTOPTS 0x00080000 /* receive dst options after rthdr */ 520#define IN6P_RTHDR 0x00100000 /* receive routing header */ 521#define IN6P_RTHDRDSTOPTS 0x00200000 /* receive dstoptions before rthdr */ 522#define IN6P_TCLASS 0x00400000 /* receive traffic class value */ 523#define IN6P_AUTOFLOWLABEL 0x00800000 /* attach flowlabel automatically */ 524#define INP_TIMEWAIT 0x01000000 /* in TIMEWAIT, ppcb is tcptw */ 525#define INP_ONESBCAST 0x02000000 /* send all-ones broadcast */ 526#define INP_DROPPED 0x04000000 /* protocol drop flag */ 527#define INP_SOCKREF 0x08000000 /* strong socket reference */ 528#define INP_SW_FLOWID 0x10000000 /* software generated flow id */ 529#define INP_HW_FLOWID 0x20000000 /* hardware generated flow id */ 530#define IN6P_RFC2292 0x40000000 /* used RFC2292 API on the socket */ 531#define IN6P_MTU 0x80000000 /* receive path MTU */ 532 533#define INP_CONTROLOPTS (INP_RECVOPTS|INP_RECVRETOPTS|INP_RECVDSTADDR|\ 534 INP_RECVIF|INP_RECVTTL|INP_RECVTOS|\ 535 IN6P_PKTINFO|IN6P_HOPLIMIT|IN6P_HOPOPTS|\ 536 IN6P_DSTOPTS|IN6P_RTHDR|IN6P_RTHDRDSTOPTS|\ 537 IN6P_TCLASS|IN6P_AUTOFLOWLABEL|IN6P_RFC2292|\ 538 IN6P_MTU) 539 540/* 541 * Flags for inp_flags2. 542 */ 543#define INP_LLE_VALID 0x00000001 /* cached lle is valid */ 544#define INP_RT_VALID 0x00000002 /* cached rtentry is valid */ 545#define INP_PCBGROUPWILD 0x00000004 /* in pcbgroup wildcard list */ 546#define INP_REUSEPORT 0x00000008 /* SO_REUSEPORT option is set */ 547#define INP_FREED 0x00000010 /* inp itself is not valid */ 548#define INP_REUSEADDR 0x00000020 /* SO_REUSEADDR option is set */ 549 550/* 551 * Flags passed to in_pcblookup*() functions. 552 */ 553#define INPLOOKUP_WILDCARD 0x00000001 /* Allow wildcard sockets. */ 554#define INPLOOKUP_RLOCKPCB 0x00000002 /* Return inpcb read-locked. */ 555#define INPLOOKUP_WLOCKPCB 0x00000004 /* Return inpcb write-locked. */ 556 557#define INPLOOKUP_MASK (INPLOOKUP_WILDCARD | INPLOOKUP_RLOCKPCB | \ 558 INPLOOKUP_WLOCKPCB) 559 560#define sotoinpcb(so) ((struct inpcb *)(so)->so_pcb) 561#define sotoin6pcb(so) sotoinpcb(so) /* for KAME src sync over BSD*'s */ 562 563#define INP_SOCKAF(so) so->so_proto->pr_domain->dom_family 564 565#define INP_CHECK_SOCKAF(so, af) (INP_SOCKAF(so) == af) 566 567/* 568 * Constants for pcbinfo.ipi_hashfields. 569 */ 570#define IPI_HASHFIELDS_NONE 0 571#define IPI_HASHFIELDS_2TUPLE 1 572#define IPI_HASHFIELDS_4TUPLE 2 573 574#ifdef _KERNEL 575VNET_DECLARE(int, ipport_reservedhigh); 576VNET_DECLARE(int, ipport_reservedlow); 577VNET_DECLARE(int, ipport_lowfirstauto); 578VNET_DECLARE(int, ipport_lowlastauto); 579VNET_DECLARE(int, ipport_firstauto); 580VNET_DECLARE(int, ipport_lastauto); 581VNET_DECLARE(int, ipport_hifirstauto); 582VNET_DECLARE(int, ipport_hilastauto); 583VNET_DECLARE(int, ipport_randomized); 584VNET_DECLARE(int, ipport_randomcps); 585VNET_DECLARE(int, ipport_randomtime); 586VNET_DECLARE(int, ipport_stoprandom); 587VNET_DECLARE(int, ipport_tcpallocs); 588 589#define V_ipport_reservedhigh VNET(ipport_reservedhigh) 590#define V_ipport_reservedlow VNET(ipport_reservedlow) 591#define V_ipport_lowfirstauto VNET(ipport_lowfirstauto) 592#define V_ipport_lowlastauto VNET(ipport_lowlastauto) 593#define V_ipport_firstauto VNET(ipport_firstauto) 594#define V_ipport_lastauto VNET(ipport_lastauto) 595#define V_ipport_hifirstauto VNET(ipport_hifirstauto) 596#define V_ipport_hilastauto VNET(ipport_hilastauto) 597#define V_ipport_randomized VNET(ipport_randomized) 598#define V_ipport_randomcps VNET(ipport_randomcps) 599#define V_ipport_randomtime VNET(ipport_randomtime) 600#define V_ipport_stoprandom VNET(ipport_stoprandom) 601#define V_ipport_tcpallocs VNET(ipport_tcpallocs) 602 603void in_pcbinfo_destroy(struct inpcbinfo *); 604void in_pcbinfo_init(struct inpcbinfo *, const char *, struct inpcbhead *, 605 int, int, char *, uma_init, uma_fini, uint32_t, u_int); 606 607struct inpcbgroup * 608 in_pcbgroup_byhash(struct inpcbinfo *, u_int, uint32_t); 609struct inpcbgroup * 610 in_pcbgroup_byinpcb(struct inpcb *); 611struct inpcbgroup * 612 in_pcbgroup_bytuple(struct inpcbinfo *, struct in_addr, u_short, 613 struct in_addr, u_short); 614void in_pcbgroup_destroy(struct inpcbinfo *); 615int in_pcbgroup_enabled(struct inpcbinfo *); 616void in_pcbgroup_init(struct inpcbinfo *, u_int, int); 617void in_pcbgroup_remove(struct inpcb *); 618void in_pcbgroup_update(struct inpcb *); 619void in_pcbgroup_update_mbuf(struct inpcb *, struct mbuf *); 620 621void in_pcbpurgeif0(struct inpcbinfo *, struct ifnet *); 622int in_pcballoc(struct socket *, struct inpcbinfo *); 623int in_pcbbind(struct inpcb *, struct sockaddr *, struct ucred *); 624int in_pcb_lport(struct inpcb *, struct in_addr *, u_short *, 625 struct ucred *, int); 626int in_pcbbind_setup(struct inpcb *, struct sockaddr *, in_addr_t *, 627 u_short *, struct ucred *); 628int in_pcbconnect(struct inpcb *, struct sockaddr *, struct ucred *); 629int in_pcbconnect_mbuf(struct inpcb *, struct sockaddr *, struct ucred *, 630 struct mbuf *); 631int in_pcbconnect_setup(struct inpcb *, struct sockaddr *, in_addr_t *, 632 u_short *, in_addr_t *, u_short *, struct inpcb **, 633 struct ucred *); 634void in_pcbdetach(struct inpcb *); 635void in_pcbdisconnect(struct inpcb *); 636void in_pcbdrop(struct inpcb *); 637void in_pcbfree(struct inpcb *); 638int in_pcbinshash(struct inpcb *); 639int in_pcbinshash_nopcbgroup(struct inpcb *); 640int in_pcbladdr(struct inpcb *, struct in_addr *, struct in_addr *, 641 struct ucred *); 642struct inpcb * 643 in_pcblookup_local(struct inpcbinfo *, 644 struct in_addr, u_short, int, struct ucred *); 645struct inpcb * 646 in_pcblookup(struct inpcbinfo *, struct in_addr, u_int, 647 struct in_addr, u_int, int, struct ifnet *); 648struct inpcb * 649 in_pcblookup_mbuf(struct inpcbinfo *, struct in_addr, u_int, 650 struct in_addr, u_int, int, struct ifnet *, struct mbuf *); 651void in_pcbnotifyall(struct inpcbinfo *pcbinfo, struct in_addr, 652 int, struct inpcb *(*)(struct inpcb *, int)); 653void in_pcbref(struct inpcb *); 654void in_pcbrehash(struct inpcb *); 655void in_pcbrehash_mbuf(struct inpcb *, struct mbuf *); 656int in_pcbrele(struct inpcb *); 657int in_pcbrele_rlocked(struct inpcb *); 658int in_pcbrele_wlocked(struct inpcb *); 659void in_pcbsetsolabel(struct socket *so); 660int in_getpeeraddr(struct socket *so, struct sockaddr **nam); 661int in_getsockaddr(struct socket *so, struct sockaddr **nam); 662struct sockaddr * 663 in_sockaddr(in_port_t port, struct in_addr *addr); 664void in_pcbsosetlabel(struct socket *so); 665#endif /* _KERNEL */ 666 667#endif /* !_NETINET_IN_PCB_H_ */ 668