1 /*- 2 * SPDX-License-Identifier: BSD-3-Clause 3 * 4 * Copyright (c) 1982, 1986, 1990, 1993 5 * The Regents of the University of California. 6 * Copyright (c) 2010-2011 Juniper Networks, Inc. 7 * All rights reserved. 8 * 9 * Portions of this software were developed by Robert N. M. Watson under 10 * contract to Juniper Networks, Inc. 11 * 12 * Redistribution and use in source and binary forms, with or without 13 * modification, are permitted provided that the following conditions 14 * are met: 15 * 1. Redistributions of source code must retain the above copyright 16 * notice, this list of conditions and the following disclaimer. 17 * 2. Redistributions in binary form must reproduce the above copyright 18 * notice, this list of conditions and the following disclaimer in the 19 * documentation and/or other materials provided with the distribution. 20 * 3. Neither the name of the University nor the names of its contributors 21 * may be used to endorse or promote products derived from this software 22 * without specific prior written permission. 23 * 24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 34 * SUCH DAMAGE. 35 */ 36 37 #ifndef _NETINET_IN_PCB_H_ 38 #define _NETINET_IN_PCB_H_ 39 40 /* 41 * PCB with AF_INET6 null bind'ed laddr can receive AF_INET input packet. 42 * So, AF_INET6 null laddr is also used as AF_INET null laddr, by utilizing 43 * the following structure. This requires padding always be zeroed out, 44 * which is done right after inpcb allocation and stays through its lifetime. 45 */ 46 struct in_addr_4in6 { 47 uint32_t ia46_pad32[3]; 48 struct in_addr ia46_addr4; 49 }; 50 51 union in_dependaddr { 52 struct in_addr_4in6 id46_addr; 53 struct in6_addr id6_addr; 54 }; 55 56 /* 57 * NOTE: ipv6 addrs should be 64-bit aligned, per RFC 2553. in_conninfo has 58 * some extra padding to accomplish this. 59 * NOTE 2: tcp_syncache.c uses first 5 32-bit words, which identify fport, 60 * lport, faddr to generate hash, so these fields shouldn't be moved. 61 */ 62 struct in_endpoints { 63 uint16_t ie_fport; /* foreign port */ 64 uint16_t ie_lport; /* local port */ 65 /* protocol dependent part, local and foreign addr */ 66 union in_dependaddr ie_dependfaddr; /* foreign host table entry */ 67 union in_dependaddr ie_dependladdr; /* local host table entry */ 68 #define ie_faddr ie_dependfaddr.id46_addr.ia46_addr4 69 #define ie_laddr ie_dependladdr.id46_addr.ia46_addr4 70 #define ie6_faddr ie_dependfaddr.id6_addr 71 #define ie6_laddr ie_dependladdr.id6_addr 72 uint32_t ie6_zoneid; /* scope zone id */ 73 }; 74 75 /* 76 * XXX The defines for inc_* are hacks and should be changed to direct 77 * references. 78 */ 79 struct in_conninfo { 80 uint8_t inc_flags; 81 uint8_t inc_len; 82 uint16_t inc_fibnum; /* XXX was pad, 16 bits is plenty */ 83 /* protocol dependent part */ 84 struct in_endpoints inc_ie; 85 }; 86 87 /* 88 * Flags for inc_flags. 89 */ 90 #define INC_ISIPV6 0x01 91 #define INC_IPV6MINMTU 0x02 92 93 #define inc_fport inc_ie.ie_fport 94 #define inc_lport inc_ie.ie_lport 95 #define inc_faddr inc_ie.ie_faddr 96 #define inc_laddr inc_ie.ie_laddr 97 #define inc6_faddr inc_ie.ie6_faddr 98 #define inc6_laddr inc_ie.ie6_laddr 99 #define inc6_zoneid inc_ie.ie6_zoneid 100 101 #define inp_fport inp_inc.inc_fport 102 #define inp_lport inp_inc.inc_lport 103 #define inp_faddr inp_inc.inc_faddr 104 #define inp_laddr inp_inc.inc_laddr 105 106 #define in6p_faddr inp_inc.inc6_faddr 107 #define in6p_laddr inp_inc.inc6_laddr 108 #define in6p_zoneid inp_inc.inc6_zoneid 109 110 #ifdef _SYS_SOCKETVAR_H_ /* XXX: requires xsocket to be known */ 111 /* 112 * Interface exported to userland by various protocols which use inpcbs. Hack 113 * alert -- only define if struct xsocket is in scope. 114 * Fields prefixed with "xi_" are unique to this structure, and the rest 115 * match fields in the struct inpcb, to ease coding and porting. 116 * 117 * Legend: 118 * (s) - used by userland utilities in src 119 * (p) - used by utilities in ports 120 * (3) - is known to be used by third party software not in ports 121 * (n) - no known usage 122 */ 123 typedef uint64_t inp_gen_t; /* compat */ 124 struct xinpcb { 125 ksize_t xi_len; /* length of this structure */ 126 struct xsocket xi_socket; /* (s,p) */ 127 struct in_conninfo inp_inc; /* (s,p) */ 128 uint64_t inp_gencnt; /* (s,p) */ 129 int64_t inp_spare64[5]; 130 uint32_t inp_flow; /* (s) */ 131 uint32_t inp_flowid; /* (s) */ 132 uint32_t inp_flowtype; /* (s) */ 133 int32_t inp_flags; /* (s,p) */ 134 int32_t inp_flags2; /* (s) */ 135 uint32_t inp_unused; 136 int32_t in6p_cksum; /* (n) */ 137 int32_t inp_spare32[4]; 138 uint16_t in6p_hops; /* (n) */ 139 uint8_t inp_ip_tos; /* (n) */ 140 int8_t pad8; 141 uint8_t inp_vflag; /* (s,p) */ 142 uint8_t inp_ip_ttl; /* (n) */ 143 uint8_t inp_ip_p; /* (n) */ 144 uint8_t inp_ip_minttl; /* (n) */ 145 int8_t inp_spare8[4]; 146 } __aligned(8); 147 148 struct xinpgen { 149 ksize_t xig_len; /* length of this structure */ 150 u_int xig_count; /* number of PCBs at this time */ 151 uint32_t _xig_spare32; 152 uint64_t xig_gen; /* generation count at this time */ 153 so_gen_t xig_sogen; /* socket generation count this time */ 154 uint64_t _xig_spare64[4]; 155 } __aligned(8); 156 #endif /* _SYS_SOCKETVAR_H_ */ 157 158 /* 159 * Flags for inp_vflags -- historically version flags only 160 */ 161 #define INP_IPV4 0x1 162 #define INP_IPV6 0x2 163 #define INP_IPV6PROTO 0x4 /* opened under IPv6 protocol */ 164 165 /* inp_vflags description for use with printf(9) %b identifier. */ 166 #define INP_VFLAGS_BITS "\20\1INP_IPV4\2INP_IPV6\3INP_IPV6PROTO" 167 168 /* 169 * Flags for inp_flags. 170 */ 171 #define INP_RECVOPTS 0x00000001 /* receive incoming IP options */ 172 #define INP_RECVRETOPTS 0x00000002 /* receive IP options for reply */ 173 #define INP_RECVDSTADDR 0x00000004 /* receive IP dst address */ 174 #define INP_HDRINCL 0x00000008 /* user supplies entire IP header */ 175 #define INP_HIGHPORT 0x00000010 /* user wants "high" port binding */ 176 #define INP_LOWPORT 0x00000020 /* user wants "low" port binding */ 177 #define INP_ANONPORT 0x00000040 /* read by netstat(1) */ 178 #define INP_RECVIF 0x00000080 /* receive incoming interface */ 179 #define INP_MTUDISC 0x00000100 /* user can do MTU discovery */ 180 /* INP_FREED 0x00000200 private to in_pcb.c */ 181 #define INP_RECVTTL 0x00000400 /* receive incoming IP TTL */ 182 #define INP_DONTFRAG 0x00000800 /* don't fragment packet */ 183 #define INP_BINDANY 0x00001000 /* allow bind to any address */ 184 #define INP_INHASHLIST 0x00002000 /* in_pcbinshash() has been called */ 185 #define INP_RECVTOS 0x00004000 /* receive incoming IP TOS */ 186 #define IN6P_IPV6_V6ONLY 0x00008000 /* restrict AF_INET6 socket for v6 */ 187 #define IN6P_PKTINFO 0x00010000 /* receive IP6 dst and I/F */ 188 #define IN6P_HOPLIMIT 0x00020000 /* receive hoplimit */ 189 #define IN6P_HOPOPTS 0x00040000 /* receive hop-by-hop options */ 190 #define IN6P_DSTOPTS 0x00080000 /* receive dst options after rthdr */ 191 #define IN6P_RTHDR 0x00100000 /* receive routing header */ 192 #define IN6P_RTHDRDSTOPTS 0x00200000 /* receive dstoptions before rthdr */ 193 #define IN6P_TCLASS 0x00400000 /* receive traffic class value */ 194 #define IN6P_AUTOFLOWLABEL 0x00800000 /* attach flowlabel automatically */ 195 /* INP_INLBGROUP 0x01000000 private to in_pcb.c */ 196 #define INP_ONESBCAST 0x02000000 /* send all-ones broadcast */ 197 #define INP_DROPPED 0x04000000 /* protocol drop flag */ 198 #define INP_SOCKREF 0x08000000 /* strong socket reference */ 199 #define INP_RESERVED_0 0x10000000 /* reserved field */ 200 #define INP_BOUNDFIB 0x20000000 /* Bound to a specific FIB. */ 201 #define IN6P_RFC2292 0x40000000 /* used RFC2292 API on the socket */ 202 #define IN6P_MTU 0x80000000 /* receive path MTU */ 203 204 #define INP_CONTROLOPTS (INP_RECVOPTS|INP_RECVRETOPTS|INP_RECVDSTADDR|\ 205 INP_RECVIF|INP_RECVTTL|INP_RECVTOS|\ 206 IN6P_PKTINFO|IN6P_HOPLIMIT|IN6P_HOPOPTS|\ 207 IN6P_DSTOPTS|IN6P_RTHDR|IN6P_RTHDRDSTOPTS|\ 208 IN6P_TCLASS|IN6P_AUTOFLOWLABEL|IN6P_RFC2292|\ 209 IN6P_MTU) 210 211 /* inp_flags description for use with printf(9) %b identifier. */ 212 #define INP_FLAGS_BITS "\20" \ 213 "\1INP_RECVOPTS\2INP_RECVRETOPTS\3INP_RECVDSTADDR\4INP_HDRINCL" \ 214 "\5INP_HIGHPORT\6INP_LOWPORT\7INP_ANONPORT\10INP_RECVIF" \ 215 "\11INP_MTUDISC\12INP_FREED\13INP_RECVTTL\14INP_DONTFRAG" \ 216 "\15INP_BINDANY\16INP_INHASHLIST\17INP_RECVTOS\20IN6P_IPV6_V6ONLY" \ 217 "\21IN6P_PKTINFO\22IN6P_HOPLIMIT\23IN6P_HOPOPTS\24IN6P_DSTOPTS" \ 218 "\25IN6P_RTHDR\26IN6P_RTHDRDSTOPTS\27IN6P_TCLASS\30IN6P_AUTOFLOWLABEL" \ 219 "\31INP_INLBGROUP\32INP_ONESBCAST\33INP_DROPPED\34INP_SOCKREF" \ 220 "\35INP_RESERVED_0\36INP_BOUNDFIB\37IN6P_RFC2292\40IN6P_MTU" 221 222 /* 223 * Flags for inp_flags2. 224 */ 225 /* 0x00000001 */ 226 /* 0x00000002 */ 227 /* 0x00000004 */ 228 /* 0x00000008 */ 229 /* 0x00000010 */ 230 /* 0x00000020 */ 231 /* 0x00000040 */ 232 /* 0x00000080 */ 233 #define INP_RECVFLOWID 0x00000100 /* populate recv datagram with flow info */ 234 #define INP_RECVRSSBUCKETID 0x00000200 /* populate recv datagram with bucket id */ 235 #define INP_RATE_LIMIT_CHANGED 0x00000400 /* rate limit needs attention */ 236 #define INP_ORIGDSTADDR 0x00000800 /* receive IP dst address/port */ 237 /* 0x00001000 */ 238 /* 0x00002000 */ 239 /* 0x00004000 */ 240 /* 0x00008000 */ 241 /* 0x00010000 */ 242 #define INP_2PCP_SET 0x00020000 /* If the Eth PCP should be set explicitly */ 243 #define INP_2PCP_BIT0 0x00040000 /* Eth PCP Bit 0 */ 244 #define INP_2PCP_BIT1 0x00080000 /* Eth PCP Bit 1 */ 245 #define INP_2PCP_BIT2 0x00100000 /* Eth PCP Bit 2 */ 246 #define INP_2PCP_BASE INP_2PCP_BIT0 247 #define INP_2PCP_MASK (INP_2PCP_BIT0 | INP_2PCP_BIT1 | INP_2PCP_BIT2) 248 #define INP_2PCP_SHIFT 18 /* shift PCP field in/out of inp_flags2 */ 249 250 /* inp_flags2 description for use with printf(9) %b identifier. */ 251 #define INP_FLAGS2_BITS "\20" \ 252 "\11INP_RECVFLOWID\12INP_RECVRSSBUCKETID" \ 253 "\13INP_RATE_LIMIT_CHANGED\14INP_ORIGDSTADDR" \ 254 "\22INP_2PCP_SET\23INP_2PCP_BIT0\24INP_2PCP_BIT1" \ 255 "\25INP_2PCP_BIT2" 256 257 struct sockopt_parameters { 258 struct in_conninfo sop_inc; 259 uint64_t sop_id; 260 int sop_level; 261 int sop_optname; 262 char sop_optval[]; 263 }; 264 265 #ifdef _SYS_KTLS_H_ 266 struct xktls_session { 267 uint32_t tsz; /* total sz of elm, next elm is at this+tsz */ 268 uint32_t fsz; /* size of the struct up to keys */ 269 uint64_t inp_gencnt; 270 kvaddr_t so_pcb; 271 struct in_conninfo coninf; 272 u_short rx_vlan_id; 273 struct xktls_session_onedir rcv; 274 struct xktls_session_onedir snd; 275 /* 276 * Next are 277 * - keydata for rcv, first cipher of length rcv.cipher_key_len, then 278 * authentication of length rcv.auth_key_len; 279 * - driver data (string) of length rcv.drv_st_len, if the rcv session is 280 * offloaded to ifnet rcv.ifnet; 281 * - keydata for snd, first cipher of length snd.cipher_key_len, then 282 * authentication of length snd.auth_key_len; 283 * - driver data (string) of length snd.drv_st_len, if the snd session is 284 * offloaded to ifnet snd.ifnet; 285 */ 286 }; 287 #endif /* _SYS_KTLS_H_ */ 288 289 #ifdef _KERNEL 290 /* 291 * No user visible declarations below. 292 */ 293 #include <sys/queue.h> 294 #include <sys/epoch.h> 295 #include <sys/lock.h> 296 #include <sys/mutex.h> 297 #include <sys/rwlock.h> 298 #include <sys/_smr.h> 299 #include <net/route.h> 300 #include <sys/proc.h> 301 #include <sys/sysctl.h> 302 #include <net/vnet.h> 303 #include <vm/uma.h> 304 #include <sys/ck.h> 305 306 /* 307 * struct inpcb is the common protocol control block structure used in most 308 * IP transport protocols. 309 * 310 * Pointers to local and foreign host table entries, local and foreign socket 311 * numbers, and pointers up (to a socket structure) and down (to a 312 * protocol-specific control block) are stored here. 313 */ 314 CK_LIST_HEAD(inpcbhead, inpcb); 315 CK_LIST_HEAD(inpcblbgrouphead, inpcblbgroup); 316 317 /* 318 * struct inpcb captures the network layer state for TCP, UDP, and raw IPv4 and 319 * IPv6 sockets. In the case of TCP and UDP, further per-connection state is 320 * located in a larger protocol specific structure that embeds inpcb in it. 321 * Almost all fields of struct inpcb are static after creation or protected by 322 * a per-inpcb rwlock, inp_lock. 323 * 324 * A inpcb database is indexed by addresses/ports hash as well as list of 325 * all pcbs that belong to a certain proto. Database lookups or list traversals 326 * are be performed inside SMR section. Once desired PCB is found its own 327 * lock is to be obtained and SMR section exited. 328 * 329 * Key: 330 * (c) - Constant after initialization 331 * (e) - Protected by the SMR section 332 * (i) - Protected by the inpcb lock 333 * (p) - Protected by the pcbinfo lock for the inpcb 334 * (h) - Protected by the pcbhash lock for the inpcb 335 * (s) - Protected by another subsystem's locks 336 * (x) - Undefined locking 337 * 338 * A few other notes: 339 * 340 * When a read lock is held, stability of the field is guaranteed; to write 341 * to a field, a write lock must generally be held. 342 * 343 * netinet/netinet6-layer code should not assume that the inp_socket pointer 344 * is safe to dereference without inp_lock being held, there may be 345 * close(2)-related races. 346 * 347 * The inp_vflag field is overloaded, and would otherwise ideally be (c). 348 */ 349 struct icmp6_filter; 350 struct inpcbpolicy; 351 struct m_snd_tag; 352 struct inpcb { 353 /* Cache line #1 (amd64) */ 354 union { 355 CK_LIST_ENTRY(inpcb) inp_hash_exact; /* hash table linkage */ 356 LIST_ENTRY(inpcb) inp_lbgroup_list; /* lb group list */ 357 }; 358 CK_LIST_ENTRY(inpcb) inp_hash_wild; /* hash table linkage */ 359 struct rwlock inp_lock; 360 /* Cache line #2 (amd64) */ 361 #define inp_start_zero inp_refcount 362 #define inp_zero_size (sizeof(struct inpcb) - \ 363 offsetof(struct inpcb, inp_start_zero)) 364 u_int inp_refcount; /* (i) refcount */ 365 int inp_flags; /* (i) generic IP/datagram flags */ 366 int inp_flags2; /* (i) generic IP/datagram flags #2*/ 367 uint8_t inp_numa_domain; /* numa domain */ 368 struct socket *inp_socket; /* (i) back pointer to socket */ 369 struct inpcbinfo *inp_pcbinfo; /* (c) PCB list info */ 370 struct ucred *inp_cred; /* (c) cache of socket cred */ 371 u_int32_t inp_flow; /* (i) IPv6 flow information */ 372 u_char inp_vflag; /* (i) IP version flag (v4/v6) */ 373 u_char inp_ip_ttl; /* (i) time to live proto */ 374 u_char inp_ip_p; /* (c) protocol proto */ 375 u_char inp_ip_minttl; /* (i) minimum TTL or drop */ 376 uint32_t inp_flowid; /* (x) flow id / queue id */ 377 smr_seq_t inp_smr; /* (i) sequence number at disconnect */ 378 struct m_snd_tag *inp_snd_tag; /* (i) send tag for outgoing mbufs */ 379 uint32_t inp_flowtype; /* (x) M_HASHTYPE value */ 380 381 /* Local and foreign ports, local and foreign addr. */ 382 struct in_conninfo inp_inc; /* (i,h) list for PCB's local port */ 383 384 /* MAC and IPSEC policy information. */ 385 struct label *inp_label; /* (i) MAC label */ 386 struct inpcbpolicy *inp_sp; /* (s) for IPSEC */ 387 388 /* Protocol-dependent part; options. */ 389 struct { 390 u_char inp_ip_tos; /* (i) type of service proto */ 391 struct mbuf *inp_options; /* (i) IP options */ 392 struct ip_moptions *inp_moptions; /* (i) mcast options */ 393 }; 394 struct { 395 /* (i) IP options */ 396 struct mbuf *in6p_options; 397 /* (i) IP6 options for outgoing packets */ 398 struct ip6_pktopts *in6p_outputopts; 399 /* (i) IP multicast options */ 400 struct ip6_moptions *in6p_moptions; 401 /* (i) ICMPv6 code type filter */ 402 struct icmp6_filter *in6p_icmp6filt; 403 /* (i) IPV6_CHECKSUM setsockopt */ 404 int in6p_cksum; 405 short in6p_hops; 406 }; 407 CK_LIST_ENTRY(inpcb) inp_portlist; /* (r:e/w:h) port list */ 408 uint64_t inp_gencnt; /* (c) generation count */ 409 void *spare_ptr; /* Spare pointer. */ 410 rt_gen_t inp_rt_cookie; /* generation for route entry */ 411 union { /* cached L3 information */ 412 struct route inp_route; 413 struct route_in6 inp_route6; 414 }; 415 CK_LIST_ENTRY(inpcb) inp_list; /* (r:e/w:p) all PCBs for proto */ 416 }; 417 418 #define inp_vnet inp_pcbinfo->ipi_vnet 419 420 /* 421 * Per-VNET pcb database for each high-level protocol (UDP, TCP, ...) in both 422 * IPv4 and IPv6. 423 * 424 * The pcbs are protected with SMR section and thus all lists in inpcbinfo 425 * are CK-lists. Locking is required to insert a pcb into database. Two 426 * locks are provided: one for the hash and one for the global list of pcbs, 427 * as well as overall count and generation count. 428 * 429 * Locking key: 430 * 431 * (c) Constant or nearly constant after initialisation 432 * (e) Protected by SMR section 433 * (g) Locked by ipi_lock 434 * (h) Locked by ipi_hash_lock 435 */ 436 struct inpcbinfo { 437 /* 438 * Global lock protecting inpcb list modification 439 */ 440 struct mtx ipi_lock; 441 struct inpcbhead ipi_listhead; /* (r:e/w:g) */ 442 u_int ipi_count; /* (g) */ 443 444 /* 445 * Generation count -- incremented each time a connection is allocated 446 * or freed. 447 */ 448 u_quad_t ipi_gencnt; /* (g) */ 449 450 /* 451 * Fields associated with port lookup and allocation. 452 */ 453 u_short ipi_lastport; /* (h) */ 454 u_short ipi_lastlow; /* (h) */ 455 u_short ipi_lasthi; /* (h) */ 456 457 /* 458 * UMA zone from which inpcbs are allocated for this protocol. 459 */ 460 uma_zone_t ipi_zone; /* (c) */ 461 uma_zone_t ipi_portzone; /* (c) */ 462 smr_t ipi_smr; /* (c) */ 463 464 /* 465 * Global hash of inpcbs, hashed by local and foreign addresses and 466 * port numbers. The "exact" hash holds PCBs connected to a foreign 467 * address, and "wild" holds the rest. 468 */ 469 struct mtx ipi_hash_lock; 470 struct inpcbhead *ipi_hash_exact; /* (r:e/w:h) */ 471 struct inpcbhead *ipi_hash_wild; /* (r:e/w:h) */ 472 u_long ipi_hashmask; /* (c) */ 473 474 /* 475 * Global hash of inpcbs, hashed by only local port number. 476 */ 477 struct inpcbhead *ipi_porthashbase; /* (h) */ 478 u_long ipi_porthashmask; /* (h) */ 479 480 /* 481 * Load balance groups used for the SO_REUSEPORT_LB option, 482 * hashed by local port. 483 */ 484 struct inpcblbgrouphead *ipi_lbgrouphashbase; /* (r:e/w:h) */ 485 u_long ipi_lbgrouphashmask; /* (h) */ 486 487 /* 488 * Pointer to network stack instance 489 */ 490 struct vnet *ipi_vnet; /* (c) */ 491 }; 492 493 /* 494 * Global allocation storage for each high-level protocol (UDP, TCP, ...). 495 * Each corresponding per-VNET inpcbinfo points into this one. 496 */ 497 struct inpcbstorage { 498 uma_zone_t ips_zone; 499 uma_init ips_pcbinit; 500 size_t ips_size; 501 const char * ips_zone_name; 502 const char * ips_infolock_name; 503 const char * ips_hashlock_name; 504 }; 505 506 #define INPCBSTORAGE_DEFINE(prot, ppcb, lname, zname, iname, hname) \ 507 static int \ 508 prot##_inpcb_init(void *mem, int size __unused, int flags __unused) \ 509 { \ 510 struct inpcb *inp = mem; \ 511 \ 512 rw_init_flags(&inp->inp_lock, lname, RW_RECURSE | RW_DUPOK); \ 513 return (0); \ 514 } \ 515 static struct inpcbstorage prot = { \ 516 .ips_size = sizeof(struct ppcb), \ 517 .ips_pcbinit = prot##_inpcb_init, \ 518 .ips_zone_name = zname, \ 519 .ips_infolock_name = iname, \ 520 .ips_hashlock_name = hname, \ 521 }; \ 522 SYSINIT(prot##_inpcbstorage_init, SI_SUB_PROTO_DOMAIN, \ 523 SI_ORDER_SECOND, in_pcbstorage_init, &prot); \ 524 SYSUNINIT(prot##_inpcbstorage_uninit, SI_SUB_PROTO_DOMAIN, \ 525 SI_ORDER_SECOND, in_pcbstorage_destroy, &prot) 526 527 #define INP_LOCK_DESTROY(inp) rw_destroy(&(inp)->inp_lock) 528 #define INP_RLOCK(inp) rw_rlock(&(inp)->inp_lock) 529 #define INP_WLOCK(inp) rw_wlock(&(inp)->inp_lock) 530 #define INP_TRY_RLOCK(inp) rw_try_rlock(&(inp)->inp_lock) 531 #define INP_TRY_WLOCK(inp) rw_try_wlock(&(inp)->inp_lock) 532 #define INP_RUNLOCK(inp) rw_runlock(&(inp)->inp_lock) 533 #define INP_WUNLOCK(inp) rw_wunlock(&(inp)->inp_lock) 534 #define INP_UNLOCK(inp) rw_unlock(&(inp)->inp_lock) 535 #define INP_TRY_UPGRADE(inp) rw_try_upgrade(&(inp)->inp_lock) 536 #define INP_DOWNGRADE(inp) rw_downgrade(&(inp)->inp_lock) 537 #define INP_WLOCKED(inp) rw_wowned(&(inp)->inp_lock) 538 #define INP_LOCK_ASSERT(inp) rw_assert(&(inp)->inp_lock, RA_LOCKED) 539 #define INP_RLOCK_ASSERT(inp) rw_assert(&(inp)->inp_lock, RA_RLOCKED) 540 #define INP_WLOCK_ASSERT(inp) rw_assert(&(inp)->inp_lock, RA_WLOCKED) 541 #define INP_UNLOCK_ASSERT(inp) rw_assert(&(inp)->inp_lock, RA_UNLOCKED) 542 543 /* 544 * These locking functions are for inpcb consumers outside of sys/netinet, 545 * more specifically, they were added for the benefit of TOE drivers. The 546 * macros are reserved for use by the stack. 547 */ 548 void inp_wlock(struct inpcb *); 549 void inp_wunlock(struct inpcb *); 550 void inp_rlock(struct inpcb *); 551 void inp_runlock(struct inpcb *); 552 553 #ifdef INVARIANT_SUPPORT 554 void inp_lock_assert(struct inpcb *); 555 void inp_unlock_assert(struct inpcb *); 556 #else 557 #define inp_lock_assert(inp) do {} while (0) 558 #define inp_unlock_assert(inp) do {} while (0) 559 #endif 560 561 void inp_apply_all(struct inpcbinfo *, void (*func)(struct inpcb *, void *), 562 void *arg); 563 struct socket * 564 inp_inpcbtosocket(struct inpcb *inp); 565 void inp_4tuple_get(struct inpcb *inp, uint32_t *laddr, uint16_t *lp, 566 uint32_t *faddr, uint16_t *fp); 567 568 #define INP_INFO_WLOCK(ipi) mtx_lock(&(ipi)->ipi_lock) 569 #define INP_INFO_WLOCKED(ipi) mtx_owned(&(ipi)->ipi_lock) 570 #define INP_INFO_WUNLOCK(ipi) mtx_unlock(&(ipi)->ipi_lock) 571 #define INP_INFO_LOCK_ASSERT(ipi) MPASS(SMR_ENTERED((ipi)->ipi_smr) || \ 572 mtx_owned(&(ipi)->ipi_lock)) 573 #define INP_INFO_WLOCK_ASSERT(ipi) mtx_assert(&(ipi)->ipi_lock, MA_OWNED) 574 #define INP_INFO_WUNLOCK_ASSERT(ipi) \ 575 mtx_assert(&(ipi)->ipi_lock, MA_NOTOWNED) 576 577 #define INP_HASH_WLOCK(ipi) mtx_lock(&(ipi)->ipi_hash_lock) 578 #define INP_HASH_WUNLOCK(ipi) mtx_unlock(&(ipi)->ipi_hash_lock) 579 #define INP_HASH_LOCK_ASSERT(ipi) MPASS(SMR_ENTERED((ipi)->ipi_smr) || \ 580 mtx_owned(&(ipi)->ipi_hash_lock)) 581 #define INP_HASH_WLOCK_ASSERT(ipi) mtx_assert(&(ipi)->ipi_hash_lock, \ 582 MA_OWNED) 583 584 /* 585 * Wildcard matching hash is not just a microoptimisation! The hash for 586 * wildcard IPv4 and wildcard IPv6 must be the same, otherwise AF_INET6 587 * wildcard bound pcb won't be able to receive AF_INET connections, while: 588 * jenkins_hash(&zeroes, 1, s) != jenkins_hash(&zeroes, 4, s) 589 * See also comment above struct in_addr_4in6. 590 */ 591 #define IN_ADDR_JHASH32(addr) \ 592 ((addr)->s_addr == INADDR_ANY ? V_in_pcbhashseed : \ 593 jenkins_hash32((&(addr)->s_addr), 1, V_in_pcbhashseed)) 594 #define IN6_ADDR_JHASH32(addr) \ 595 (memcmp((addr), &in6addr_any, sizeof(in6addr_any)) == 0 ? \ 596 V_in_pcbhashseed : \ 597 jenkins_hash32((addr)->__u6_addr.__u6_addr32, \ 598 nitems((addr)->__u6_addr.__u6_addr32), V_in_pcbhashseed)) 599 600 #define INP_PCBHASH(faddr, lport, fport, mask) \ 601 ((IN_ADDR_JHASH32(faddr) ^ ntohs((lport) ^ (fport))) & (mask)) 602 #define INP6_PCBHASH(faddr, lport, fport, mask) \ 603 ((IN6_ADDR_JHASH32(faddr) ^ ntohs((lport) ^ (fport))) & (mask)) 604 605 #define INP_PCBHASH_WILD(lport, mask) \ 606 ((V_in_pcbhashseed ^ ntohs(lport)) & (mask)) 607 608 #define INP_PCBLBGROUP_PKTHASH(faddr, lport, fport) \ 609 (IN_ADDR_JHASH32(faddr) ^ ntohs((lport) ^ (fport))) 610 #define INP6_PCBLBGROUP_PKTHASH(faddr, lport, fport) \ 611 (IN6_ADDR_JHASH32(faddr) ^ ntohs((lport) ^ (fport))) 612 613 #define INP_PCBPORTHASH(lport, mask) (ntohs((lport)) & (mask)) 614 615 /* 616 * Flags passed to in_pcblookup*(), inp_smr_lock() and inp_next(). 617 */ 618 typedef enum { 619 INPLOOKUP_WILDCARD = 0x00000001, /* Allow wildcard sockets. */ 620 INPLOOKUP_RLOCKPCB = 0x00000002, /* Return inpcb read-locked. */ 621 INPLOOKUP_WLOCKPCB = 0x00000004, /* Return inpcb write-locked. */ 622 INPLOOKUP_FIB = 0x00000008, /* inp must be from same FIB. */ 623 } inp_lookup_t; 624 625 #define INPLOOKUP_MASK (INPLOOKUP_WILDCARD | INPLOOKUP_RLOCKPCB | \ 626 INPLOOKUP_WLOCKPCB | INPLOOKUP_FIB) 627 #define INPLOOKUP_LOCKMASK (INPLOOKUP_RLOCKPCB | INPLOOKUP_WLOCKPCB) 628 629 #define sotoinpcb(so) ((struct inpcb *)(so)->so_pcb) 630 631 #define INP_SOCKAF(so) so->so_proto->pr_domain->dom_family 632 633 #define INP_CHECK_SOCKAF(so, af) (INP_SOCKAF(so) == af) 634 635 VNET_DECLARE(int, ipport_reservedhigh); 636 VNET_DECLARE(int, ipport_reservedlow); 637 VNET_DECLARE(int, ipport_lowfirstauto); 638 VNET_DECLARE(int, ipport_lowlastauto); 639 VNET_DECLARE(int, ipport_firstauto); 640 VNET_DECLARE(int, ipport_lastauto); 641 VNET_DECLARE(int, ipport_hifirstauto); 642 VNET_DECLARE(int, ipport_hilastauto); 643 VNET_DECLARE(int, ipport_randomized); 644 645 #define V_ipport_reservedhigh VNET(ipport_reservedhigh) 646 #define V_ipport_reservedlow VNET(ipport_reservedlow) 647 #define V_ipport_lowfirstauto VNET(ipport_lowfirstauto) 648 #define V_ipport_lowlastauto VNET(ipport_lowlastauto) 649 #define V_ipport_firstauto VNET(ipport_firstauto) 650 #define V_ipport_lastauto VNET(ipport_lastauto) 651 #define V_ipport_hifirstauto VNET(ipport_hifirstauto) 652 #define V_ipport_hilastauto VNET(ipport_hilastauto) 653 #define V_ipport_randomized VNET(ipport_randomized) 654 655 void in_pcbinfo_init(struct inpcbinfo *, struct inpcbstorage *, 656 u_int, u_int); 657 void in_pcbinfo_destroy(struct inpcbinfo *); 658 void in_pcbstorage_init(void *); 659 void in_pcbstorage_destroy(void *); 660 661 void in_pcbpurgeif0(struct inpcbinfo *, struct ifnet *); 662 int in_pcballoc(struct socket *, struct inpcbinfo *); 663 #define INPBIND_FIB 0x0001 /* bind to the PCB's FIB only */ 664 int in_pcbbind(struct inpcb *, struct sockaddr_in *, int, struct ucred *); 665 int in_pcbbind_setup(struct inpcb *, struct sockaddr_in *, in_addr_t *, 666 u_short *, int, struct ucred *); 667 int in_pcbconnect(struct inpcb *, struct sockaddr_in *, struct ucred *); 668 void in_pcbdisconnect(struct inpcb *); 669 void in_pcbdrop(struct inpcb *); 670 void in_pcbfree(struct inpcb *); 671 int in_pcbladdr(const struct inpcb *, struct in_addr *, struct in_addr *, 672 struct ucred *); 673 int in_pcblbgroup_numa(struct inpcb *, int arg); 674 void in_pcblisten(struct inpcb *); 675 struct inpcb * 676 in_pcblookup(struct inpcbinfo *, struct in_addr, u_int, 677 struct in_addr, u_int, int, struct ifnet *); 678 struct inpcb * 679 in_pcblookup_mbuf(struct inpcbinfo *, struct in_addr, u_int, 680 struct in_addr, u_int, int, struct ifnet *, struct mbuf *); 681 void in_pcbref(struct inpcb *); 682 bool in_pcbrele(struct inpcb *, inp_lookup_t); 683 bool in_pcbrele_rlocked(struct inpcb *); 684 bool in_pcbrele_wlocked(struct inpcb *); 685 bool in_pcbrele_rlock(struct inpcb *inp); 686 #ifdef _SYS_SOCKETVAR_H_ 687 void in_pcbtoxinpcb(const struct inpcb *, struct xinpcb *); 688 int sysctl_setsockopt(SYSCTL_HANDLER_ARGS, struct inpcbinfo *pcbinfo, 689 int (*ctloutput_set)(struct inpcb *, struct sockopt *)); 690 #endif 691 692 typedef bool inp_match_t(const struct inpcb *, void *); 693 struct inpcb_iterator { 694 const struct inpcbinfo *ipi; 695 struct inpcb *inp; 696 inp_match_t *match; 697 void *ctx; 698 int hash; 699 #define INP_ALL_LIST -1 700 const inp_lookup_t lock; 701 }; 702 703 /* Note: sparse initializers guarantee .inp = NULL. */ 704 #define INP_ITERATOR(_ipi, _lock, _match, _ctx) \ 705 { \ 706 .ipi = (_ipi), \ 707 .lock = (_lock), \ 708 .hash = INP_ALL_LIST, \ 709 .match = (_match), \ 710 .ctx = (_ctx), \ 711 } 712 #define INP_ALL_ITERATOR(_ipi, _lock) \ 713 { \ 714 .ipi = (_ipi), \ 715 .lock = (_lock), \ 716 .hash = INP_ALL_LIST, \ 717 } 718 719 struct inpcb *inp_next(struct inpcb_iterator *); 720 void in_losing(struct inpcb *); 721 void in_pcbsetsolabel(struct socket *so); 722 int in_getpeeraddr(struct socket *, struct sockaddr *sa); 723 int in_getsockaddr(struct socket *, struct sockaddr *sa); 724 void in_pcbsosetlabel(struct socket *so); 725 #ifdef RATELIMIT 726 int 727 in_pcboutput_txrtlmt_locked(struct inpcb *, struct ifnet *, 728 struct mbuf *, uint32_t); 729 int in_pcbattach_txrtlmt(struct inpcb *, struct ifnet *, uint32_t, uint32_t, 730 uint32_t, struct m_snd_tag **); 731 void in_pcbdetach_txrtlmt(struct inpcb *); 732 void in_pcbdetach_tag(struct m_snd_tag *); 733 int in_pcbmodify_txrtlmt(struct inpcb *, uint32_t); 734 int in_pcbquery_txrtlmt(struct inpcb *, uint32_t *); 735 int in_pcbquery_txrlevel(struct inpcb *, uint32_t *); 736 void in_pcboutput_txrtlmt(struct inpcb *, struct ifnet *, struct mbuf *); 737 void in_pcboutput_eagain(struct inpcb *); 738 #endif 739 #ifdef DDB 740 void db_print_inpcb(struct inpcb *, const char *, int); 741 #endif 742 #endif /* _KERNEL */ 743 744 #endif /* !_NETINET_IN_PCB_H_ */ 745