1c398230bSWarner Losh /*- 2df8bae1dSRodney W. Grimes * Copyright (c) 1982, 1986, 1990, 1993 3a5654bb2SRobert Watson * The Regents of the University of California. 4a5654bb2SRobert Watson * All rights reserved. 5df8bae1dSRodney W. Grimes * 6df8bae1dSRodney W. Grimes * Redistribution and use in source and binary forms, with or without 7df8bae1dSRodney W. Grimes * modification, are permitted provided that the following conditions 8df8bae1dSRodney W. Grimes * are met: 9df8bae1dSRodney W. Grimes * 1. Redistributions of source code must retain the above copyright 10df8bae1dSRodney W. Grimes * notice, this list of conditions and the following disclaimer. 11df8bae1dSRodney W. Grimes * 2. Redistributions in binary form must reproduce the above copyright 12df8bae1dSRodney W. Grimes * notice, this list of conditions and the following disclaimer in the 13df8bae1dSRodney W. Grimes * documentation and/or other materials provided with the distribution. 14df8bae1dSRodney W. Grimes * 4. Neither the name of the University nor the names of its contributors 15df8bae1dSRodney W. Grimes * may be used to endorse or promote products derived from this software 16df8bae1dSRodney W. Grimes * without specific prior written permission. 17df8bae1dSRodney W. Grimes * 18df8bae1dSRodney W. Grimes * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 19df8bae1dSRodney W. Grimes * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20df8bae1dSRodney W. Grimes * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21df8bae1dSRodney W. Grimes * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 22df8bae1dSRodney W. Grimes * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23df8bae1dSRodney W. Grimes * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24df8bae1dSRodney W. Grimes * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25df8bae1dSRodney W. Grimes * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 26df8bae1dSRodney W. Grimes * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 27df8bae1dSRodney W. Grimes * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28df8bae1dSRodney W. Grimes * SUCH DAMAGE. 29df8bae1dSRodney W. Grimes * 30df8bae1dSRodney W. Grimes * @(#)in_pcb.h 8.1 (Berkeley) 6/10/93 31c3aac50fSPeter Wemm * $FreeBSD$ 32df8bae1dSRodney W. Grimes */ 33df8bae1dSRodney W. Grimes 34707f139eSPaul Richards #ifndef _NETINET_IN_PCB_H_ 35707f139eSPaul Richards #define _NETINET_IN_PCB_H_ 36707f139eSPaul Richards 37f1844d4cSBruce Evans #include <sys/queue.h> 3840545cf5SBruce Evans #include <sys/_lock.h> 3940545cf5SBruce Evans #include <sys/_mutex.h> 408501a69cSRobert Watson #include <sys/_rwlock.h> 41f1844d4cSBruce Evans 428501a69cSRobert Watson #ifdef _KERNEL 438501a69cSRobert Watson #include <sys/rwlock.h> 44eddfbb76SRobert Watson #include <net/vnet.h> 459bcd427bSRobert Watson #include <vm/uma.h> 468501a69cSRobert Watson #endif 478501a69cSRobert Watson 4882cd038dSYoshinobu Inoue #define in6pcb inpcb /* for KAME src sync over BSD*'s */ 4982cd038dSYoshinobu Inoue #define in6p_sp inp_sp /* for KAME src sync over BSD*'s */ 50b9234fafSSam Leffler struct inpcbpolicy; 5182cd038dSYoshinobu Inoue 52df8bae1dSRodney W. Grimes /* 53fc18af96SRobert Watson * struct inpcb is the common protocol control block structure used in most 54fc18af96SRobert Watson * IP transport protocols. 55712fc218SRobert Watson * 56712fc218SRobert Watson * Pointers to local and foreign host table entries, local and foreign socket 57712fc218SRobert Watson * numbers, and pointers up (to a socket structure) and down (to a 58712fc218SRobert Watson * protocol-specific control block) are stored here. 59df8bae1dSRodney W. Grimes */ 60e3975643SJake Burkholder LIST_HEAD(inpcbhead, inpcb); 61e3975643SJake Burkholder LIST_HEAD(inpcbporthead, inpcbport); 6298271db4SGarrett Wollman typedef u_quad_t inp_gen_t; 6315bd2b43SDavid Greenman 643d4d47f3SGarrett Wollman /* 6582cd038dSYoshinobu Inoue * PCB with AF_INET6 null bind'ed laddr can receive AF_INET input packet. 66712fc218SRobert Watson * So, AF_INET6 null laddr is also used as AF_INET null laddr, by utilizing 67712fc218SRobert Watson * the following structure. 6882cd038dSYoshinobu Inoue */ 6982cd038dSYoshinobu Inoue struct in_addr_4in6 { 7082cd038dSYoshinobu Inoue u_int32_t ia46_pad32[3]; 7182cd038dSYoshinobu Inoue struct in_addr ia46_addr4; 7282cd038dSYoshinobu Inoue }; 7382cd038dSYoshinobu Inoue 7482cd038dSYoshinobu Inoue /* 75712fc218SRobert Watson * NOTE: ipv6 addrs should be 64-bit aligned, per RFC 2553. in_conninfo has 76712fc218SRobert Watson * some extra padding to accomplish this. 77be2ac88cSJonathan Lemon */ 78be2ac88cSJonathan Lemon struct in_endpoints { 79be2ac88cSJonathan Lemon u_int16_t ie_fport; /* foreign port */ 80be2ac88cSJonathan Lemon u_int16_t ie_lport; /* local port */ 81be2ac88cSJonathan Lemon /* protocol dependent part, local and foreign addr */ 82be2ac88cSJonathan Lemon union { 83be2ac88cSJonathan Lemon /* foreign host table entry */ 84be2ac88cSJonathan Lemon struct in_addr_4in6 ie46_foreign; 85be2ac88cSJonathan Lemon struct in6_addr ie6_foreign; 86be2ac88cSJonathan Lemon } ie_dependfaddr; 87be2ac88cSJonathan Lemon union { 88be2ac88cSJonathan Lemon /* local host table entry */ 89be2ac88cSJonathan Lemon struct in_addr_4in6 ie46_local; 90be2ac88cSJonathan Lemon struct in6_addr ie6_local; 91be2ac88cSJonathan Lemon } ie_dependladdr; 92a5654bb2SRobert Watson }; 93be2ac88cSJonathan Lemon #define ie_faddr ie_dependfaddr.ie46_foreign.ia46_addr4 94be2ac88cSJonathan Lemon #define ie_laddr ie_dependladdr.ie46_local.ia46_addr4 95be2ac88cSJonathan Lemon #define ie6_faddr ie_dependfaddr.ie6_foreign 96be2ac88cSJonathan Lemon #define ie6_laddr ie_dependladdr.ie6_local 97be2ac88cSJonathan Lemon 98be2ac88cSJonathan Lemon /* 99712fc218SRobert Watson * XXX The defines for inc_* are hacks and should be changed to direct 100712fc218SRobert Watson * references. 101be2ac88cSJonathan Lemon */ 102be2ac88cSJonathan Lemon struct in_conninfo { 103be2ac88cSJonathan Lemon u_int8_t inc_flags; 104be2ac88cSJonathan Lemon u_int8_t inc_len; 1058b07e49aSJulian Elischer u_int16_t inc_fibnum; /* XXX was pad, 16 bits is plenty */ 10697d8d152SAndre Oppermann /* protocol dependent part */ 107be2ac88cSJonathan Lemon struct in_endpoints inc_ie; 108be2ac88cSJonathan Lemon }; 109dcdb4371SBjoern A. Zeeb 110dcdb4371SBjoern A. Zeeb /* 111dcdb4371SBjoern A. Zeeb * Flags for inc_flags. 112dcdb4371SBjoern A. Zeeb */ 113dcdb4371SBjoern A. Zeeb #define INC_ISIPV6 0x01 114dcdb4371SBjoern A. Zeeb 115be2ac88cSJonathan Lemon #define inc_isipv6 inc_flags /* temp compatability */ 116be2ac88cSJonathan Lemon #define inc_fport inc_ie.ie_fport 117be2ac88cSJonathan Lemon #define inc_lport inc_ie.ie_lport 118be2ac88cSJonathan Lemon #define inc_faddr inc_ie.ie_faddr 119be2ac88cSJonathan Lemon #define inc_laddr inc_ie.ie_laddr 120be2ac88cSJonathan Lemon #define inc6_faddr inc_ie.ie6_faddr 121be2ac88cSJonathan Lemon #define inc6_laddr inc_ie.ie6_laddr 122be2ac88cSJonathan Lemon 12382cd038dSYoshinobu Inoue struct icmp6_filter; 12482cd038dSYoshinobu Inoue 1257b709f8aSRobert Watson /*- 1267b709f8aSRobert Watson * struct inpcb captures the network layer state for TCP, UDP, and raw IPv4 1277b709f8aSRobert Watson * and IPv6 sockets. In the case of TCP, further per-connection state is 1287b709f8aSRobert Watson * hung off of inp_ppcb most of the time. Almost all fields of struct inpcb 1297b709f8aSRobert Watson * are static after creation or protected by a per-inpcb rwlock, inp_lock. A 1307b709f8aSRobert Watson * few fields also require the global pcbinfo lock for the inpcb to be held, 1317b709f8aSRobert Watson * when modified, such as the global connection lists and hashes, as well as 1327b709f8aSRobert Watson * binding information (which affects which hash a connection is on). This 1337b709f8aSRobert Watson * model means that connections can be looked up without holding the 1347b709f8aSRobert Watson * per-connection lock, which is important for performance when attempting to 1357b709f8aSRobert Watson * find the connection for a packet given its IP and port tuple. Writing to 1367b709f8aSRobert Watson * these fields that write locks be held on both the inpcb and global locks. 1377b709f8aSRobert Watson * 1387b709f8aSRobert Watson * Key: 1397b709f8aSRobert Watson * (c) - Constant after initialization 1407b709f8aSRobert Watson * (i) - Protected by the inpcb lock 1417b709f8aSRobert Watson * (p) - Protected by the pcbinfo lock for the inpcb 1427b709f8aSRobert Watson * (s) - Protected by another subsystem's locks 1437b709f8aSRobert Watson * (x) - Undefined locking 1447b709f8aSRobert Watson * 1457b709f8aSRobert Watson * A few other notes: 1467b709f8aSRobert Watson * 1477b709f8aSRobert Watson * When a read lock is held, stability of the field is guaranteed; to write 1487b709f8aSRobert Watson * to a field, a write lock must generally be held. 1497b709f8aSRobert Watson * 1507b709f8aSRobert Watson * netinet/netinet6-layer code should not assume that the inp_socket pointer 1517b709f8aSRobert Watson * is safe to dereference without inp_lock being held, even for protocols 1527b709f8aSRobert Watson * other than TCP (where the inpcb persists during TIMEWAIT even after the 1537b709f8aSRobert Watson * socket has been freed), or there may be close(2)-related races. 1547b709f8aSRobert Watson * 1557b709f8aSRobert Watson * The inp_vflag field is overloaded, and would otherwise ideally be (c). 1567b709f8aSRobert Watson */ 157df8bae1dSRodney W. Grimes struct inpcb { 1587b709f8aSRobert Watson LIST_ENTRY(inpcb) inp_hash; /* (i/p) hash list */ 1597b709f8aSRobert Watson LIST_ENTRY(inpcb) inp_list; /* (i/p) list for all PCBs for proto */ 1607b709f8aSRobert Watson void *inp_ppcb; /* (i) pointer to per-protocol pcb */ 1617b709f8aSRobert Watson struct inpcbinfo *inp_pcbinfo; /* (c) PCB list info */ 1627b709f8aSRobert Watson struct socket *inp_socket; /* (i) back pointer to socket */ 16386d02c5cSBjoern A. Zeeb struct ucred *inp_cred; /* (c) cache of socket cred */ 1647b709f8aSRobert Watson u_int32_t inp_flow; /* (i) IPv6 flow information */ 1657b709f8aSRobert Watson int inp_flags; /* (i) generic IP/datagram flags */ 166773b573aSKip Macy int inp_flags2; /* (i) generic IP/datagram flags #2*/ 1677b709f8aSRobert Watson u_char inp_vflag; /* (i) IP version flag (v4/v6) */ 1687b709f8aSRobert Watson u_char inp_ip_ttl; /* (i) time to live proto */ 1697b709f8aSRobert Watson u_char inp_ip_p; /* (c) protocol proto */ 1707b709f8aSRobert Watson u_char inp_ip_minttl; /* (i) minimum TTL or drop */ 17180cb9f21SKip Macy uint32_t inp_flowid; /* (x) flow id / queue id */ 17228696211SRobert Watson u_int inp_refcount; /* (i) refcount */ 1739d2eb78bSRobert Watson void *inp_pspare[4]; /* (x) rtentry / general use */ 1749d2eb78bSRobert Watson u_int inp_ispare[4]; /* general use */ 1752de2af32SKip Macy 1762de2af32SKip Macy /* Local and foreign ports, local and foreign addr. */ 177a5654bb2SRobert Watson struct in_conninfo inp_inc; /* (i/p) list for PCB's local port */ 1782de2af32SKip Macy 179a5654bb2SRobert Watson /* MAC and IPSEC policy information. */ 1807b709f8aSRobert Watson struct label *inp_label; /* (i) MAC label */ 1817b709f8aSRobert Watson struct inpcbpolicy *inp_sp; /* (s) for IPSEC */ 18282cd038dSYoshinobu Inoue 183712fc218SRobert Watson /* Protocol-dependent part; options. */ 18482cd038dSYoshinobu Inoue struct { 1857b709f8aSRobert Watson u_char inp4_ip_tos; /* (i) type of service proto */ 1867b709f8aSRobert Watson struct mbuf *inp4_options; /* (i) IP options */ 187a5654bb2SRobert Watson struct ip_moptions *inp4_moptions; /* (i) IP mcast options */ 18882cd038dSYoshinobu Inoue } inp_depend4; 18982cd038dSYoshinobu Inoue struct { 1907b709f8aSRobert Watson /* (i) IP options */ 19182cd038dSYoshinobu Inoue struct mbuf *inp6_options; 1927b709f8aSRobert Watson /* (i) IP6 options for outgoing packets */ 19382cd038dSYoshinobu Inoue struct ip6_pktopts *inp6_outputopts; 1947b709f8aSRobert Watson /* (i) IP multicast options */ 19582cd038dSYoshinobu Inoue struct ip6_moptions *inp6_moptions; 1967b709f8aSRobert Watson /* (i) ICMPv6 code type filter */ 19782cd038dSYoshinobu Inoue struct icmp6_filter *inp6_icmp6filt; 1987b709f8aSRobert Watson /* (i) IPV6_CHECKSUM setsockopt */ 19982cd038dSYoshinobu Inoue int inp6_cksum; 20082cd038dSYoshinobu Inoue short inp6_hops; 20182cd038dSYoshinobu Inoue } inp_depend6; 2027b709f8aSRobert Watson LIST_ENTRY(inpcb) inp_portlist; /* (i/p) */ 2037b709f8aSRobert Watson struct inpcbport *inp_phd; /* (i/p) head of this list */ 204d915b280SStephan Uphoff #define inp_zero_size offsetof(struct inpcb, inp_gencnt) 205a5654bb2SRobert Watson inp_gen_t inp_gencnt; /* (c) generation count */ 206114f15c6SKip Macy struct llentry *inp_lle; /* cached L2 information */ 207114f15c6SKip Macy struct rtentry *inp_rt; /* cached L3 information */ 2088501a69cSRobert Watson struct rwlock inp_lock; 209a5654bb2SRobert Watson }; 210a5654bb2SRobert Watson #define inp_fport inp_inc.inc_fport 211a5654bb2SRobert Watson #define inp_lport inp_inc.inc_lport 212a5654bb2SRobert Watson #define inp_faddr inp_inc.inc_faddr 213a5654bb2SRobert Watson #define inp_laddr inp_inc.inc_laddr 214a5654bb2SRobert Watson #define inp_ip_tos inp_depend4.inp4_ip_tos 215a5654bb2SRobert Watson #define inp_options inp_depend4.inp4_options 216a5654bb2SRobert Watson #define inp_moptions inp_depend4.inp4_moptions 217f76fcf6dSJeffrey Hsu 218be2ac88cSJonathan Lemon #define in6p_faddr inp_inc.inc6_faddr 219be2ac88cSJonathan Lemon #define in6p_laddr inp_inc.inc6_laddr 22082cd038dSYoshinobu Inoue #define in6p_hops inp_depend6.inp6_hops /* default hop limit */ 22182cd038dSYoshinobu Inoue #define in6p_flowinfo inp_flow 22282cd038dSYoshinobu Inoue #define in6p_options inp_depend6.inp6_options 22382cd038dSYoshinobu Inoue #define in6p_outputopts inp_depend6.inp6_outputopts 22482cd038dSYoshinobu Inoue #define in6p_moptions inp_depend6.inp6_moptions 22582cd038dSYoshinobu Inoue #define in6p_icmp6filt inp_depend6.inp6_icmp6filt 22682cd038dSYoshinobu Inoue #define in6p_cksum inp_depend6.inp6_cksum 227a5654bb2SRobert Watson 228f6dfe47aSMarko Zec #define inp_vnet inp_pcbinfo->ipi_vnet 229f6dfe47aSMarko Zec 2303d4d47f3SGarrett Wollman /* 231712fc218SRobert Watson * The range of the generation count, as used in this implementation, is 9e19. 232712fc218SRobert Watson * We would have to create 300 billion connections per second for this number 233712fc218SRobert Watson * to roll over in a year. This seems sufficiently unlikely that we simply 234712fc218SRobert Watson * don't concern ourselves with that possibility. 2353d4d47f3SGarrett Wollman */ 236c3229e05SDavid Greenman 23798271db4SGarrett Wollman /* 238712fc218SRobert Watson * Interface exported to userland by various protocols which use inpcbs. Hack 239712fc218SRobert Watson * alert -- only define if struct xsocket is in scope. 24098271db4SGarrett Wollman */ 24198271db4SGarrett Wollman #ifdef _SYS_SOCKETVAR_H_ 24298271db4SGarrett Wollman struct xinpcb { 24398271db4SGarrett Wollman size_t xi_len; /* length of this structure */ 24498271db4SGarrett Wollman struct inpcb xi_inp; 24598271db4SGarrett Wollman struct xsocket xi_socket; 24698271db4SGarrett Wollman u_quad_t xi_alignment_hack; 24798271db4SGarrett Wollman }; 24898271db4SGarrett Wollman 24998271db4SGarrett Wollman struct xinpgen { 25098271db4SGarrett Wollman size_t xig_len; /* length of this structure */ 25198271db4SGarrett Wollman u_int xig_count; /* number of PCBs at this time */ 25298271db4SGarrett Wollman inp_gen_t xig_gen; /* generation count at this time */ 25398271db4SGarrett Wollman so_gen_t xig_sogen; /* socket generation count at this time */ 25498271db4SGarrett Wollman }; 25598271db4SGarrett Wollman #endif /* _SYS_SOCKETVAR_H_ */ 25698271db4SGarrett Wollman 257c3229e05SDavid Greenman struct inpcbport { 258e3975643SJake Burkholder LIST_ENTRY(inpcbport) phd_hash; 259c3229e05SDavid Greenman struct inpcbhead phd_pcblist; 260c3229e05SDavid Greenman u_short phd_port; 261df8bae1dSRodney W. Grimes }; 262df8bae1dSRodney W. Grimes 263712fc218SRobert Watson /* 264712fc218SRobert Watson * Global data structure for each high-level protocol (UDP, TCP, ...) in both 265712fc218SRobert Watson * IPv4 and IPv6. Holds inpcb lists and information for managing them. 266712fc218SRobert Watson */ 267712fc218SRobert Watson struct inpcbinfo { 268712fc218SRobert Watson /* 269712fc218SRobert Watson * Global list of inpcbs on the protocol. 270712fc218SRobert Watson */ 271712fc218SRobert Watson struct inpcbhead *ipi_listhead; 272712fc218SRobert Watson u_int ipi_count; 273712fc218SRobert Watson 274712fc218SRobert Watson /* 275712fc218SRobert Watson * Global hash of inpcbs, hashed by local and foreign addresses and 276712fc218SRobert Watson * port numbers. 277712fc218SRobert Watson */ 278712fc218SRobert Watson struct inpcbhead *ipi_hashbase; 279712fc218SRobert Watson u_long ipi_hashmask; 280712fc218SRobert Watson 281712fc218SRobert Watson /* 282712fc218SRobert Watson * Global hash of inpcbs, hashed by only local port number. 283712fc218SRobert Watson */ 284712fc218SRobert Watson struct inpcbporthead *ipi_porthashbase; 285712fc218SRobert Watson u_long ipi_porthashmask; 286712fc218SRobert Watson 287712fc218SRobert Watson /* 288712fc218SRobert Watson * Fields associated with port lookup and allocation. 289712fc218SRobert Watson */ 290712fc218SRobert Watson u_short ipi_lastport; 291712fc218SRobert Watson u_short ipi_lastlow; 292712fc218SRobert Watson u_short ipi_lasthi; 293712fc218SRobert Watson 294712fc218SRobert Watson /* 295712fc218SRobert Watson * UMA zone from which inpcbs are allocated for this protocol. 296712fc218SRobert Watson */ 297712fc218SRobert Watson struct uma_zone *ipi_zone; 298712fc218SRobert Watson 299712fc218SRobert Watson /* 300712fc218SRobert Watson * Generation count--incremented each time a connection is allocated 301712fc218SRobert Watson * or freed. 302712fc218SRobert Watson */ 303712fc218SRobert Watson u_quad_t ipi_gencnt; 3048501a69cSRobert Watson struct rwlock ipi_lock; 3052de2af32SKip Macy 3062de2af32SKip Macy /* 307f6dfe47aSMarko Zec * Pointer to network stack instance 308f6dfe47aSMarko Zec */ 309f6dfe47aSMarko Zec struct vnet *ipi_vnet; 310f6dfe47aSMarko Zec 311f6dfe47aSMarko Zec /* 312f6dfe47aSMarko Zec * general use 2 3132de2af32SKip Macy */ 3142de2af32SKip Macy void *ipi_pspare[2]; 31515bd2b43SDavid Greenman }; 31615bd2b43SDavid Greenman 3175bd311a5SSam Leffler #define INP_LOCK_INIT(inp, d, t) \ 3188501a69cSRobert Watson rw_init_flags(&(inp)->inp_lock, (t), RW_RECURSE | RW_DUPOK) 3198501a69cSRobert Watson #define INP_LOCK_DESTROY(inp) rw_destroy(&(inp)->inp_lock) 3208501a69cSRobert Watson #define INP_RLOCK(inp) rw_rlock(&(inp)->inp_lock) 3218501a69cSRobert Watson #define INP_WLOCK(inp) rw_wlock(&(inp)->inp_lock) 32243cc0bc1SRobert Watson #define INP_TRY_RLOCK(inp) rw_try_rlock(&(inp)->inp_lock) 32343cc0bc1SRobert Watson #define INP_TRY_WLOCK(inp) rw_try_wlock(&(inp)->inp_lock) 3248501a69cSRobert Watson #define INP_RUNLOCK(inp) rw_runlock(&(inp)->inp_lock) 3258501a69cSRobert Watson #define INP_WUNLOCK(inp) rw_wunlock(&(inp)->inp_lock) 32682c33e73SKip Macy #define INP_TRY_UPGRADE(inp) rw_try_upgrade(&(inp)->inp_lock) 32782c33e73SKip Macy #define INP_DOWNGRADE(inp) rw_downgrade(&(inp)->inp_lock) 32882c33e73SKip Macy #define INP_WLOCKED(inp) rw_wowned(&(inp)->inp_lock) 3298501a69cSRobert Watson #define INP_LOCK_ASSERT(inp) rw_assert(&(inp)->inp_lock, RA_LOCKED) 3308501a69cSRobert Watson #define INP_RLOCK_ASSERT(inp) rw_assert(&(inp)->inp_lock, RA_RLOCKED) 3318501a69cSRobert Watson #define INP_WLOCK_ASSERT(inp) rw_assert(&(inp)->inp_lock, RA_WLOCKED) 3328501a69cSRobert Watson #define INP_UNLOCK_ASSERT(inp) rw_assert(&(inp)->inp_lock, RA_UNLOCKED) 333f76fcf6dSJeffrey Hsu 334e79dd20dSKip Macy #ifdef _KERNEL 3353d585327SKip Macy /* 3363d585327SKip Macy * These locking functions are for inpcb consumers outside of sys/netinet, 3373d585327SKip Macy * more specifically, they were added for the benefit of TOE drivers. The 3383d585327SKip Macy * macros are reserved for use by the stack. 3393d585327SKip Macy */ 3403d585327SKip Macy void inp_wlock(struct inpcb *); 3413d585327SKip Macy void inp_wunlock(struct inpcb *); 3423d585327SKip Macy void inp_rlock(struct inpcb *); 3433d585327SKip Macy void inp_runlock(struct inpcb *); 3443d585327SKip Macy 3453d585327SKip Macy #ifdef INVARIANTS 346e79dd20dSKip Macy void inp_lock_assert(struct inpcb *); 347e79dd20dSKip Macy void inp_unlock_assert(struct inpcb *); 3483d585327SKip Macy #else 3493d585327SKip Macy static __inline void 350e79dd20dSKip Macy inp_lock_assert(struct inpcb *inp __unused) 3513d585327SKip Macy { 3523d585327SKip Macy } 3533d585327SKip Macy 3543d585327SKip Macy static __inline void 355e79dd20dSKip Macy inp_unlock_assert(struct inpcb *inp __unused) 3563d585327SKip Macy { 3573d585327SKip Macy } 358e79dd20dSKip Macy 3593d585327SKip Macy #endif 3609378e437SKip Macy 3619378e437SKip Macy void inp_apply_all(void (*func)(struct inpcb *, void *), void *arg); 3629378e437SKip Macy int inp_ip_tos_get(const struct inpcb *inp); 3639378e437SKip Macy void inp_ip_tos_set(struct inpcb *inp, int val); 3649d29c635SKip Macy struct socket * 3659d29c635SKip Macy inp_inpcbtosocket(struct inpcb *inp); 3669d29c635SKip Macy struct tcpcb * 3679d29c635SKip Macy inp_inpcbtotcpcb(struct inpcb *inp); 368df9cf830STai-hwa Liang void inp_4tuple_get(struct inpcb *inp, uint32_t *laddr, uint16_t *lp, 3699d29c635SKip Macy uint32_t *faddr, uint16_t *fp); 3709378e437SKip Macy 371e79dd20dSKip Macy #endif /* _KERNEL */ 3723d585327SKip Macy 373f76fcf6dSJeffrey Hsu #define INP_INFO_LOCK_INIT(ipi, d) \ 3748501a69cSRobert Watson rw_init_flags(&(ipi)->ipi_lock, (d), RW_RECURSE) 3758501a69cSRobert Watson #define INP_INFO_LOCK_DESTROY(ipi) rw_destroy(&(ipi)->ipi_lock) 3768501a69cSRobert Watson #define INP_INFO_RLOCK(ipi) rw_rlock(&(ipi)->ipi_lock) 3778501a69cSRobert Watson #define INP_INFO_WLOCK(ipi) rw_wlock(&(ipi)->ipi_lock) 37843cc0bc1SRobert Watson #define INP_INFO_TRY_RLOCK(ipi) rw_try_rlock(&(ipi)->ipi_lock) 37943cc0bc1SRobert Watson #define INP_INFO_TRY_WLOCK(ipi) rw_try_wlock(&(ipi)->ipi_lock) 38066f80e90SRobert Watson #define INP_INFO_TRY_UPGRADE(ipi) rw_try_upgrade(&(ipi)->ipi_lock) 3818501a69cSRobert Watson #define INP_INFO_RUNLOCK(ipi) rw_runlock(&(ipi)->ipi_lock) 3828501a69cSRobert Watson #define INP_INFO_WUNLOCK(ipi) rw_wunlock(&(ipi)->ipi_lock) 3838501a69cSRobert Watson #define INP_INFO_LOCK_ASSERT(ipi) rw_assert(&(ipi)->ipi_lock, RA_LOCKED) 3848501a69cSRobert Watson #define INP_INFO_RLOCK_ASSERT(ipi) rw_assert(&(ipi)->ipi_lock, RA_RLOCKED) 3858501a69cSRobert Watson #define INP_INFO_WLOCK_ASSERT(ipi) rw_assert(&(ipi)->ipi_lock, RA_WLOCKED) 3868501a69cSRobert Watson #define INP_INFO_UNLOCK_ASSERT(ipi) rw_assert(&(ipi)->ipi_lock, RA_UNLOCKED) 387f76fcf6dSJeffrey Hsu 388ddd79a97SDavid Greenman #define INP_PCBHASH(faddr, lport, fport, mask) \ 389c3229e05SDavid Greenman (((faddr) ^ ((faddr) >> 16) ^ ntohs((lport) ^ (fport))) & (mask)) 390c3229e05SDavid Greenman #define INP_PCBPORTHASH(lport, mask) \ 391c3229e05SDavid Greenman (ntohs((lport)) & (mask)) 392ddd79a97SDavid Greenman 393a5654bb2SRobert Watson /* 394773b573aSKip Macy * Flags for inp_vflags -- historically version flags only 395a5654bb2SRobert Watson */ 396a5654bb2SRobert Watson #define INP_IPV4 0x1 397a5654bb2SRobert Watson #define INP_IPV6 0x2 398a5654bb2SRobert Watson #define INP_IPV6PROTO 0x4 /* opened under IPv6 protocol */ 399a5654bb2SRobert Watson 400a5654bb2SRobert Watson /* 401773b573aSKip Macy * Flags for inp_flags. 402a5654bb2SRobert Watson */ 403ad71fe3cSRobert Watson #define INP_RECVOPTS 0x00000001 /* receive incoming IP options */ 404ad71fe3cSRobert Watson #define INP_RECVRETOPTS 0x00000002 /* receive IP options for reply */ 405ad71fe3cSRobert Watson #define INP_RECVDSTADDR 0x00000004 /* receive IP dst address */ 406ad71fe3cSRobert Watson #define INP_HDRINCL 0x00000008 /* user supplies entire IP header */ 407ad71fe3cSRobert Watson #define INP_HIGHPORT 0x00000010 /* user wants "high" port binding */ 408ad71fe3cSRobert Watson #define INP_LOWPORT 0x00000020 /* user wants "low" port binding */ 409ad71fe3cSRobert Watson #define INP_ANONPORT 0x00000040 /* port chosen for user */ 410ad71fe3cSRobert Watson #define INP_RECVIF 0x00000080 /* receive incoming interface */ 411ad71fe3cSRobert Watson #define INP_MTUDISC 0x00000100 /* user can do MTU discovery */ 412ad71fe3cSRobert Watson #define INP_FAITH 0x00000200 /* accept FAITH'ed connections */ 413ad71fe3cSRobert Watson #define INP_RECVTTL 0x00000400 /* receive incoming IP TTL */ 414ad71fe3cSRobert Watson #define INP_DONTFRAG 0x00000800 /* don't fragment packet */ 415f44270e7SPawel Jakub Dawidek #define INP_BINDANY 0x00001000 /* allow bind to any address */ 416ad71fe3cSRobert Watson #define INP_INHASHLIST 0x00002000 /* in_pcbinshash() has been called */ 417ad71fe3cSRobert Watson #define IN6P_IPV6_V6ONLY 0x00008000 /* restrict AF_INET6 socket for v6 */ 418ad71fe3cSRobert Watson #define IN6P_PKTINFO 0x00010000 /* receive IP6 dst and I/F */ 419ad71fe3cSRobert Watson #define IN6P_HOPLIMIT 0x00020000 /* receive hoplimit */ 420ad71fe3cSRobert Watson #define IN6P_HOPOPTS 0x00040000 /* receive hop-by-hop options */ 421ad71fe3cSRobert Watson #define IN6P_DSTOPTS 0x00080000 /* receive dst options after rthdr */ 422ad71fe3cSRobert Watson #define IN6P_RTHDR 0x00100000 /* receive routing header */ 423ad71fe3cSRobert Watson #define IN6P_RTHDRDSTOPTS 0x00200000 /* receive dstoptions before rthdr */ 424ad71fe3cSRobert Watson #define IN6P_TCLASS 0x00400000 /* receive traffic class value */ 425ad71fe3cSRobert Watson #define IN6P_AUTOFLOWLABEL 0x00800000 /* attach flowlabel automatically */ 426ad71fe3cSRobert Watson #define INP_TIMEWAIT 0x01000000 /* in TIMEWAIT, ppcb is tcptw */ 427ad71fe3cSRobert Watson #define INP_ONESBCAST 0x02000000 /* send all-ones broadcast */ 428ad71fe3cSRobert Watson #define INP_DROPPED 0x04000000 /* protocol drop flag */ 429ad71fe3cSRobert Watson #define INP_SOCKREF 0x08000000 /* strong socket reference */ 43080cb9f21SKip Macy #define INP_SW_FLOWID 0x10000000 /* software generated flow id */ 43180cb9f21SKip Macy #define INP_HW_FLOWID 0x20000000 /* hardware generated flow id */ 432f95d4633SHajimu UMEMOTO #define IN6P_RFC2292 0x40000000 /* used RFC2292 API on the socket */ 433f95d4633SHajimu UMEMOTO #define IN6P_MTU 0x80000000 /* receive path MTU */ 43433841545SHajimu UMEMOTO 43582c23ebaSBill Fenner #define INP_CONTROLOPTS (INP_RECVOPTS|INP_RECVRETOPTS|INP_RECVDSTADDR|\ 4364957466bSMatthew N. Dodd INP_RECVIF|INP_RECVTTL|\ 43733841545SHajimu UMEMOTO IN6P_PKTINFO|IN6P_HOPLIMIT|IN6P_HOPOPTS|\ 43833841545SHajimu UMEMOTO IN6P_DSTOPTS|IN6P_RTHDR|IN6P_RTHDRDSTOPTS|\ 439f95d4633SHajimu UMEMOTO IN6P_TCLASS|IN6P_AUTOFLOWLABEL|IN6P_RFC2292|\ 440f95d4633SHajimu UMEMOTO IN6P_MTU) 44182cd038dSYoshinobu Inoue 442773b573aSKip Macy /* 443773b573aSKip Macy * Flags for inp_flags2. 444773b573aSKip Macy */ 4458b12a7c2SKip Macy #define INP_LLE_VALID 0x00000001 /* cached lle is valid */ 4468b12a7c2SKip Macy #define INP_RT_VALID 0x00000002 /* cached rtentry is valid */ 447773b573aSKip Macy 448df8bae1dSRodney W. Grimes #define INPLOOKUP_WILDCARD 1 449df8bae1dSRodney W. Grimes #define sotoinpcb(so) ((struct inpcb *)(so)->so_pcb) 45082cd038dSYoshinobu Inoue #define sotoin6pcb(so) sotoinpcb(so) /* for KAME src sync over BSD*'s */ 45182cd038dSYoshinobu Inoue 45282cd038dSYoshinobu Inoue #define INP_SOCKAF(so) so->so_proto->pr_domain->dom_family 45382cd038dSYoshinobu Inoue 45482cd038dSYoshinobu Inoue #define INP_CHECK_SOCKAF(so, af) (INP_SOCKAF(so) == af) 455df8bae1dSRodney W. Grimes 456664a31e4SPeter Wemm #ifdef _KERNEL 457eddfbb76SRobert Watson VNET_DECLARE(int, ipport_reservedhigh); 458eddfbb76SRobert Watson VNET_DECLARE(int, ipport_reservedlow); 459eddfbb76SRobert Watson VNET_DECLARE(int, ipport_lowfirstauto); 460eddfbb76SRobert Watson VNET_DECLARE(int, ipport_lowlastauto); 461eddfbb76SRobert Watson VNET_DECLARE(int, ipport_firstauto); 462eddfbb76SRobert Watson VNET_DECLARE(int, ipport_lastauto); 463eddfbb76SRobert Watson VNET_DECLARE(int, ipport_hifirstauto); 464eddfbb76SRobert Watson VNET_DECLARE(int, ipport_hilastauto); 465eddfbb76SRobert Watson VNET_DECLARE(int, ipport_randomized); 466eddfbb76SRobert Watson VNET_DECLARE(int, ipport_randomcps); 467eddfbb76SRobert Watson VNET_DECLARE(int, ipport_randomtime); 468eddfbb76SRobert Watson VNET_DECLARE(int, ipport_stoprandom); 469eddfbb76SRobert Watson VNET_DECLARE(int, ipport_tcpallocs); 470eddfbb76SRobert Watson 4711e77c105SRobert Watson #define V_ipport_reservedhigh VNET(ipport_reservedhigh) 4721e77c105SRobert Watson #define V_ipport_reservedlow VNET(ipport_reservedlow) 4731e77c105SRobert Watson #define V_ipport_lowfirstauto VNET(ipport_lowfirstauto) 4741e77c105SRobert Watson #define V_ipport_lowlastauto VNET(ipport_lowlastauto) 4751e77c105SRobert Watson #define V_ipport_firstauto VNET(ipport_firstauto) 4761e77c105SRobert Watson #define V_ipport_lastauto VNET(ipport_lastauto) 4771e77c105SRobert Watson #define V_ipport_hifirstauto VNET(ipport_hifirstauto) 4781e77c105SRobert Watson #define V_ipport_hilastauto VNET(ipport_hilastauto) 4791e77c105SRobert Watson #define V_ipport_randomized VNET(ipport_randomized) 4801e77c105SRobert Watson #define V_ipport_randomcps VNET(ipport_randomcps) 4811e77c105SRobert Watson #define V_ipport_randomtime VNET(ipport_randomtime) 4821e77c105SRobert Watson #define V_ipport_stoprandom VNET(ipport_stoprandom) 4831e77c105SRobert Watson #define V_ipport_tcpallocs VNET(ipport_tcpallocs) 484eddfbb76SRobert Watson 4855f311da2SMike Silbersack extern struct callout ipport_tick_callout; 48682cd038dSYoshinobu Inoue 4879bcd427bSRobert Watson void in_pcbinfo_destroy(struct inpcbinfo *); 4889bcd427bSRobert Watson void in_pcbinfo_init(struct inpcbinfo *, const char *, struct inpcbhead *, 4899bcd427bSRobert Watson int, int, char *, uma_init, uma_fini, uint32_t); 4909bcd427bSRobert Watson 491f76fcf6dSJeffrey Hsu void in_pcbpurgeif0(struct inpcbinfo *, struct ifnet *); 492d915b280SStephan Uphoff int in_pcballoc(struct socket *, struct inpcbinfo *); 493b0330ed9SPawel Jakub Dawidek int in_pcbbind(struct inpcb *, struct sockaddr *, struct ucred *); 4944b932371SIan Dowse int in_pcbbind_setup(struct inpcb *, struct sockaddr *, in_addr_t *, 495b0330ed9SPawel Jakub Dawidek u_short *, struct ucred *); 496b0330ed9SPawel Jakub Dawidek int in_pcbconnect(struct inpcb *, struct sockaddr *, struct ucred *); 4975200e00eSIan Dowse int in_pcbconnect_setup(struct inpcb *, struct sockaddr *, in_addr_t *, 4985200e00eSIan Dowse u_short *, in_addr_t *, u_short *, struct inpcb **, 499b0330ed9SPawel Jakub Dawidek struct ucred *); 5004d77a549SAlfred Perlstein void in_pcbdetach(struct inpcb *); 5014d77a549SAlfred Perlstein void in_pcbdisconnect(struct inpcb *); 50210702a28SRobert Watson void in_pcbdrop(struct inpcb *); 5034c7c478dSRobert Watson void in_pcbfree(struct inpcb *); 5044d77a549SAlfred Perlstein int in_pcbinshash(struct inpcb *); 505df8bae1dSRodney W. Grimes struct inpcb * 5064d77a549SAlfred Perlstein in_pcblookup_local(struct inpcbinfo *, 507078b7042SBjoern A. Zeeb struct in_addr, u_short, int, struct ucred *); 50815bd2b43SDavid Greenman struct inpcb * 509c1cd65baSBruce Evans in_pcblookup_hash(struct inpcbinfo *, struct in_addr, u_int, 510c1cd65baSBruce Evans struct in_addr, u_int, int, struct ifnet *); 511f76fcf6dSJeffrey Hsu void in_pcbnotifyall(struct inpcbinfo *pcbinfo, struct in_addr, 5123ce144eaSJeffrey Hsu int, struct inpcb *(*)(struct inpcb *, int)); 51328696211SRobert Watson void in_pcbref(struct inpcb *); 5144d77a549SAlfred Perlstein void in_pcbrehash(struct inpcb *); 51528696211SRobert Watson int in_pcbrele(struct inpcb *); 516a557af22SRobert Watson void in_pcbsetsolabel(struct socket *so); 51754d642bbSRobert Watson int in_getpeeraddr(struct socket *so, struct sockaddr **nam); 51854d642bbSRobert Watson int in_getsockaddr(struct socket *so, struct sockaddr **nam); 51926ef6ac4SDon Lewis struct sockaddr * 52026ef6ac4SDon Lewis in_sockaddr(in_port_t port, struct in_addr *addr); 521a557af22SRobert Watson void in_pcbsosetlabel(struct socket *so); 5225f311da2SMike Silbersack void ipport_tick(void *xtp); 523664a31e4SPeter Wemm #endif /* _KERNEL */ 5243d4d47f3SGarrett Wollman 5258781d8e9SBruce Evans #endif /* !_NETINET_IN_PCB_H_ */ 526