1 /*- 2 * Copyright (c) 1982, 1986, 1990, 1993 3 * The Regents of the University of California. All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 4. Neither the name of the University nor the names of its contributors 14 * may be used to endorse or promote products derived from this software 15 * without specific prior written permission. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27 * SUCH DAMAGE. 28 * 29 * @(#)in_pcb.h 8.1 (Berkeley) 6/10/93 30 * $FreeBSD$ 31 */ 32 33 #ifndef _NETINET_IN_PCB_H_ 34 #define _NETINET_IN_PCB_H_ 35 36 #include <sys/queue.h> 37 #include <sys/_lock.h> 38 #include <sys/_mutex.h> 39 40 #include <net/route.h> 41 42 #define in6pcb inpcb /* for KAME src sync over BSD*'s */ 43 #define in6p_sp inp_sp /* for KAME src sync over BSD*'s */ 44 struct inpcbpolicy; 45 46 /* 47 * Struct inpcb is the ommon structure pcb for the Internet Protocol 48 * implementation. 49 * 50 * Pointers to local and foreign host table entries, local and foreign socket 51 * numbers, and pointers up (to a socket structure) and down (to a 52 * protocol-specific control block) are stored here. 53 */ 54 LIST_HEAD(inpcbhead, inpcb); 55 LIST_HEAD(inpcbporthead, inpcbport); 56 typedef u_quad_t inp_gen_t; 57 58 /* 59 * PCB with AF_INET6 null bind'ed laddr can receive AF_INET input packet. 60 * So, AF_INET6 null laddr is also used as AF_INET null laddr, by utilizing 61 * the following structure. 62 */ 63 struct in_addr_4in6 { 64 u_int32_t ia46_pad32[3]; 65 struct in_addr ia46_addr4; 66 }; 67 68 /* 69 * NOTE: ipv6 addrs should be 64-bit aligned, per RFC 2553. in_conninfo has 70 * some extra padding to accomplish this. 71 */ 72 struct in_endpoints { 73 u_int16_t ie_fport; /* foreign port */ 74 u_int16_t ie_lport; /* local port */ 75 /* protocol dependent part, local and foreign addr */ 76 union { 77 /* foreign host table entry */ 78 struct in_addr_4in6 ie46_foreign; 79 struct in6_addr ie6_foreign; 80 } ie_dependfaddr; 81 union { 82 /* local host table entry */ 83 struct in_addr_4in6 ie46_local; 84 struct in6_addr ie6_local; 85 } ie_dependladdr; 86 #define ie_faddr ie_dependfaddr.ie46_foreign.ia46_addr4 87 #define ie_laddr ie_dependladdr.ie46_local.ia46_addr4 88 #define ie6_faddr ie_dependfaddr.ie6_foreign 89 #define ie6_laddr ie_dependladdr.ie6_local 90 }; 91 92 /* 93 * XXX The defines for inc_* are hacks and should be changed to direct 94 * references. 95 */ 96 struct in_conninfo { 97 u_int8_t inc_flags; 98 u_int8_t inc_len; 99 u_int16_t inc_pad; /* XXX alignment for in_endpoints */ 100 /* protocol dependent part */ 101 struct in_endpoints inc_ie; 102 }; 103 #define inc_isipv6 inc_flags /* temp compatability */ 104 #define inc_fport inc_ie.ie_fport 105 #define inc_lport inc_ie.ie_lport 106 #define inc_faddr inc_ie.ie_faddr 107 #define inc_laddr inc_ie.ie_laddr 108 #define inc6_faddr inc_ie.ie6_faddr 109 #define inc6_laddr inc_ie.ie6_laddr 110 111 struct icmp6_filter; 112 113 struct inpcb { 114 LIST_ENTRY(inpcb) inp_hash; /* hash list */ 115 LIST_ENTRY(inpcb) inp_list; /* list for all PCBs of this proto */ 116 u_int32_t inp_flow; 117 118 /* Local and foreign ports, local and foreign addr. */ 119 struct in_conninfo inp_inc; 120 121 void *inp_ppcb; /* pointer to per-protocol pcb */ 122 struct inpcbinfo *inp_pcbinfo; /* PCB list info */ 123 struct socket *inp_socket; /* back pointer to socket */ 124 /* list for this PCB's local port */ 125 struct label *inp_label; /* MAC label */ 126 int inp_flags; /* generic IP/datagram flags */ 127 128 struct inpcbpolicy *inp_sp; /* for IPSEC */ 129 u_char inp_vflag; /* IP version flag (v4/v6) */ 130 #define INP_IPV4 0x1 131 #define INP_IPV6 0x2 132 #define INP_IPV6PROTO 0x4 /* opened under IPv6 protocol */ 133 #define INP_TIMEWAIT 0x8 /* .. probably doesn't go here */ 134 #define INP_ONESBCAST 0x10 /* send all-ones broadcast */ 135 #define INP_DROPPED 0x20 /* protocol drop flag */ 136 #define INP_SOCKREF 0x40 /* strong socket reference */ 137 u_char inp_ip_ttl; /* time to live proto */ 138 u_char inp_ip_p; /* protocol proto */ 139 u_char inp_ip_minttl; /* minimum TTL or drop */ 140 141 /* Protocol-dependent part; options. */ 142 struct { 143 u_char inp4_ip_tos; /* type of service proto */ 144 struct mbuf *inp4_options; /* IP options */ 145 struct ip_moptions *inp4_moptions; /* IP multicast options */ 146 } inp_depend4; 147 #define inp_fport inp_inc.inc_fport 148 #define inp_lport inp_inc.inc_lport 149 #define inp_faddr inp_inc.inc_faddr 150 #define inp_laddr inp_inc.inc_laddr 151 #define inp_ip_tos inp_depend4.inp4_ip_tos 152 #define inp_options inp_depend4.inp4_options 153 #define inp_moptions inp_depend4.inp4_moptions 154 struct { 155 /* IP options */ 156 struct mbuf *inp6_options; 157 /* IP6 options for outgoing packets */ 158 struct ip6_pktopts *inp6_outputopts; 159 /* IP multicast options */ 160 struct ip6_moptions *inp6_moptions; 161 /* ICMPv6 code type filter */ 162 struct icmp6_filter *inp6_icmp6filt; 163 /* IPV6_CHECKSUM setsockopt */ 164 int inp6_cksum; 165 short inp6_hops; 166 } inp_depend6; 167 LIST_ENTRY(inpcb) inp_portlist; 168 struct inpcbport *inp_phd; /* head of this list */ 169 #define inp_zero_size offsetof(struct inpcb, inp_gencnt) 170 inp_gen_t inp_gencnt; /* generation count of this instance */ 171 struct mtx inp_mtx; 172 173 #define in6p_faddr inp_inc.inc6_faddr 174 #define in6p_laddr inp_inc.inc6_laddr 175 #define in6p_hops inp_depend6.inp6_hops /* default hop limit */ 176 #define in6p_ip6_nxt inp_ip_p 177 #define in6p_flowinfo inp_flow 178 #define in6p_vflag inp_vflag 179 #define in6p_options inp_depend6.inp6_options 180 #define in6p_outputopts inp_depend6.inp6_outputopts 181 #define in6p_moptions inp_depend6.inp6_moptions 182 #define in6p_icmp6filt inp_depend6.inp6_icmp6filt 183 #define in6p_cksum inp_depend6.inp6_cksum 184 #define in6p_flags inp_flags /* for KAME src sync over BSD*'s */ 185 #define in6p_socket inp_socket /* for KAME src sync over BSD*'s */ 186 #define in6p_lport inp_lport /* for KAME src sync over BSD*'s */ 187 #define in6p_fport inp_fport /* for KAME src sync over BSD*'s */ 188 #define in6p_ppcb inp_ppcb /* for KAME src sync over BSD*'s */ 189 }; 190 /* 191 * The range of the generation count, as used in this implementation, is 9e19. 192 * We would have to create 300 billion connections per second for this number 193 * to roll over in a year. This seems sufficiently unlikely that we simply 194 * don't concern ourselves with that possibility. 195 */ 196 197 /* 198 * Interface exported to userland by various protocols which use inpcbs. Hack 199 * alert -- only define if struct xsocket is in scope. 200 */ 201 #ifdef _SYS_SOCKETVAR_H_ 202 struct xinpcb { 203 size_t xi_len; /* length of this structure */ 204 struct inpcb xi_inp; 205 struct xsocket xi_socket; 206 u_quad_t xi_alignment_hack; 207 }; 208 209 struct xinpgen { 210 size_t xig_len; /* length of this structure */ 211 u_int xig_count; /* number of PCBs at this time */ 212 inp_gen_t xig_gen; /* generation count at this time */ 213 so_gen_t xig_sogen; /* socket generation count at this time */ 214 }; 215 #endif /* _SYS_SOCKETVAR_H_ */ 216 217 struct inpcbport { 218 LIST_ENTRY(inpcbport) phd_hash; 219 struct inpcbhead phd_pcblist; 220 u_short phd_port; 221 }; 222 223 /* 224 * Global data structure for each high-level protocol (UDP, TCP, ...) in both 225 * IPv4 and IPv6. Holds inpcb lists and information for managing them. 226 */ 227 struct inpcbinfo { 228 /* 229 * Global list of inpcbs on the protocol. 230 */ 231 struct inpcbhead *ipi_listhead; 232 u_int ipi_count; 233 234 /* 235 * Global hash of inpcbs, hashed by local and foreign addresses and 236 * port numbers. 237 */ 238 struct inpcbhead *ipi_hashbase; 239 u_long ipi_hashmask; 240 241 /* 242 * Global hash of inpcbs, hashed by only local port number. 243 */ 244 struct inpcbporthead *ipi_porthashbase; 245 u_long ipi_porthashmask; 246 247 /* 248 * Fields associated with port lookup and allocation. 249 */ 250 u_short ipi_lastport; 251 u_short ipi_lastlow; 252 u_short ipi_lasthi; 253 254 /* 255 * UMA zone from which inpcbs are allocated for this protocol. 256 */ 257 struct uma_zone *ipi_zone; 258 259 /* 260 * Generation count--incremented each time a connection is allocated 261 * or freed. 262 */ 263 u_quad_t ipi_gencnt; 264 struct mtx ipi_mtx; 265 }; 266 267 #define INP_LOCK_INIT(inp, d, t) \ 268 mtx_init(&(inp)->inp_mtx, (d), (t), MTX_DEF | MTX_RECURSE | MTX_DUPOK) 269 #define INP_LOCK_DESTROY(inp) mtx_destroy(&(inp)->inp_mtx) 270 #define INP_LOCK(inp) mtx_lock(&(inp)->inp_mtx) 271 #define INP_UNLOCK(inp) mtx_unlock(&(inp)->inp_mtx) 272 #define INP_LOCK_ASSERT(inp) mtx_assert(&(inp)->inp_mtx, MA_OWNED) 273 #define INP_UNLOCK_ASSERT(inp) mtx_assert(&(inp)->inp_mtx, MA_NOTOWNED) 274 275 #define INP_INFO_LOCK_INIT(ipi, d) \ 276 mtx_init(&(ipi)->ipi_mtx, (d), NULL, MTX_DEF | MTX_RECURSE) 277 #define INP_INFO_LOCK_DESTROY(ipi) mtx_destroy(&(ipi)->ipi_mtx) 278 #define INP_INFO_RLOCK(ipi) mtx_lock(&(ipi)->ipi_mtx) 279 #define INP_INFO_WLOCK(ipi) mtx_lock(&(ipi)->ipi_mtx) 280 #define INP_INFO_RUNLOCK(ipi) mtx_unlock(&(ipi)->ipi_mtx) 281 #define INP_INFO_WUNLOCK(ipi) mtx_unlock(&(ipi)->ipi_mtx) 282 #define INP_INFO_RLOCK_ASSERT(ipi) mtx_assert(&(ipi)->ipi_mtx, MA_OWNED) 283 #define INP_INFO_WLOCK_ASSERT(ipi) mtx_assert(&(ipi)->ipi_mtx, MA_OWNED) 284 #define INP_INFO_UNLOCK_ASSERT(ipi) mtx_assert(&(ipi)->ipi_mtx, MA_NOTOWNED) 285 286 #define INP_PCBHASH(faddr, lport, fport, mask) \ 287 (((faddr) ^ ((faddr) >> 16) ^ ntohs((lport) ^ (fport))) & (mask)) 288 #define INP_PCBPORTHASH(lport, mask) \ 289 (ntohs((lport)) & (mask)) 290 291 /* flags in inp_flags: */ 292 #define INP_RECVOPTS 0x01 /* receive incoming IP options */ 293 #define INP_RECVRETOPTS 0x02 /* receive IP options for reply */ 294 #define INP_RECVDSTADDR 0x04 /* receive IP dst address */ 295 #define INP_HDRINCL 0x08 /* user supplies entire IP header */ 296 #define INP_HIGHPORT 0x10 /* user wants "high" port binding */ 297 #define INP_LOWPORT 0x20 /* user wants "low" port binding */ 298 #define INP_ANONPORT 0x40 /* port chosen for user */ 299 #define INP_RECVIF 0x80 /* receive incoming interface */ 300 #define INP_MTUDISC 0x100 /* user can do MTU discovery */ 301 #define INP_FAITH 0x200 /* accept FAITH'ed connections */ 302 #define INP_RECVTTL 0x400 /* receive incoming IP TTL */ 303 #define INP_DONTFRAG 0x800 /* don't fragment packet */ 304 305 #define IN6P_IPV6_V6ONLY 0x008000 /* restrict AF_INET6 socket for v6 */ 306 307 #define IN6P_PKTINFO 0x010000 /* receive IP6 dst and I/F */ 308 #define IN6P_HOPLIMIT 0x020000 /* receive hoplimit */ 309 #define IN6P_HOPOPTS 0x040000 /* receive hop-by-hop options */ 310 #define IN6P_DSTOPTS 0x080000 /* receive dst options after rthdr */ 311 #define IN6P_RTHDR 0x100000 /* receive routing header */ 312 #define IN6P_RTHDRDSTOPTS 0x200000 /* receive dstoptions before rthdr */ 313 #define IN6P_TCLASS 0x400000 /* receive traffic class value */ 314 #define IN6P_AUTOFLOWLABEL 0x800000 /* attach flowlabel automatically */ 315 #define IN6P_RFC2292 0x40000000 /* used RFC2292 API on the socket */ 316 #define IN6P_MTU 0x80000000 /* receive path MTU */ 317 318 #define INP_CONTROLOPTS (INP_RECVOPTS|INP_RECVRETOPTS|INP_RECVDSTADDR|\ 319 INP_RECVIF|INP_RECVTTL|\ 320 IN6P_PKTINFO|IN6P_HOPLIMIT|IN6P_HOPOPTS|\ 321 IN6P_DSTOPTS|IN6P_RTHDR|IN6P_RTHDRDSTOPTS|\ 322 IN6P_TCLASS|IN6P_AUTOFLOWLABEL|IN6P_RFC2292|\ 323 IN6P_MTU) 324 #define INP_UNMAPPABLEOPTS (IN6P_HOPOPTS|IN6P_DSTOPTS|IN6P_RTHDR|\ 325 IN6P_TCLASS|IN6P_AUTOFLOWLABEL) 326 327 /* for KAME src sync over BSD*'s */ 328 #define IN6P_HIGHPORT INP_HIGHPORT 329 #define IN6P_LOWPORT INP_LOWPORT 330 #define IN6P_ANONPORT INP_ANONPORT 331 #define IN6P_RECVIF INP_RECVIF 332 #define IN6P_MTUDISC INP_MTUDISC 333 #define IN6P_FAITH INP_FAITH 334 #define IN6P_CONTROLOPTS INP_CONTROLOPTS 335 /* 336 * socket AF version is {newer than,or include} 337 * actual datagram AF version 338 */ 339 340 #define INPLOOKUP_WILDCARD 1 341 #define sotoinpcb(so) ((struct inpcb *)(so)->so_pcb) 342 #define sotoin6pcb(so) sotoinpcb(so) /* for KAME src sync over BSD*'s */ 343 344 #define INP_SOCKAF(so) so->so_proto->pr_domain->dom_family 345 346 #define INP_CHECK_SOCKAF(so, af) (INP_SOCKAF(so) == af) 347 348 #ifdef _KERNEL 349 extern int ipport_reservedhigh; 350 extern int ipport_reservedlow; 351 extern int ipport_lowfirstauto; 352 extern int ipport_lowlastauto; 353 extern int ipport_firstauto; 354 extern int ipport_lastauto; 355 extern int ipport_hifirstauto; 356 extern int ipport_hilastauto; 357 extern struct callout ipport_tick_callout; 358 359 void in_pcbpurgeif0(struct inpcbinfo *, struct ifnet *); 360 int in_pcballoc(struct socket *, struct inpcbinfo *); 361 int in_pcbbind(struct inpcb *, struct sockaddr *, struct ucred *); 362 int in_pcbbind_setup(struct inpcb *, struct sockaddr *, in_addr_t *, 363 u_short *, struct ucred *); 364 int in_pcbconnect(struct inpcb *, struct sockaddr *, struct ucred *); 365 int in_pcbconnect_setup(struct inpcb *, struct sockaddr *, in_addr_t *, 366 u_short *, in_addr_t *, u_short *, struct inpcb **, 367 struct ucred *); 368 void in_pcbdetach(struct inpcb *); 369 void in_pcbdisconnect(struct inpcb *); 370 void in_pcbdrop(struct inpcb *); 371 void in_pcbfree(struct inpcb *); 372 int in_pcbinshash(struct inpcb *); 373 struct inpcb * 374 in_pcblookup_local(struct inpcbinfo *, 375 struct in_addr, u_int, int); 376 struct inpcb * 377 in_pcblookup_hash(struct inpcbinfo *, struct in_addr, u_int, 378 struct in_addr, u_int, int, struct ifnet *); 379 void in_pcbnotifyall(struct inpcbinfo *pcbinfo, struct in_addr, 380 int, struct inpcb *(*)(struct inpcb *, int)); 381 void in_pcbrehash(struct inpcb *); 382 void in_pcbsetsolabel(struct socket *so); 383 int in_getpeeraddr(struct socket *so, struct sockaddr **nam); 384 int in_getsockaddr(struct socket *so, struct sockaddr **nam); 385 struct sockaddr * 386 in_sockaddr(in_port_t port, struct in_addr *addr); 387 void in_pcbsosetlabel(struct socket *so); 388 void in_pcbremlists(struct inpcb *inp); 389 void ipport_tick(void *xtp); 390 391 /* 392 * Debugging routines compiled in when DDB is present. 393 */ 394 void db_print_inpcb(struct inpcb *inp, const char *name, int indent); 395 396 #endif /* _KERNEL */ 397 398 #endif /* !_NETINET_IN_PCB_H_ */ 399