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 * 3. All advertising materials mentioning features or use of this software 14 * must display the following acknowledgement: 15 * This product includes software developed by the University of 16 * California, Berkeley and its contributors. 17 * 4. Neither the name of the University nor the names of its contributors 18 * may be used to endorse or promote products derived from this software 19 * without specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31 * SUCH DAMAGE. 32 * 33 * @(#)in_pcb.h 8.1 (Berkeley) 6/10/93 34 * $FreeBSD$ 35 */ 36 37 #ifndef _NETINET_IN_PCB_H_ 38 #define _NETINET_IN_PCB_H_ 39 40 #include <sys/queue.h> 41 #include <sys/_lock.h> 42 #include <sys/_mutex.h> 43 44 #include <net/route.h> 45 46 #define in6pcb inpcb /* for KAME src sync over BSD*'s */ 47 #define in6p_sp inp_sp /* for KAME src sync over BSD*'s */ 48 struct inpcbpolicy; 49 50 /* 51 * Common structure pcb for internet protocol implementation. 52 * Here are stored pointers to local and foreign host table 53 * entries, local and foreign socket numbers, and pointers 54 * up (to a socket structure) and down (to a protocol-specific) 55 * control block. 56 */ 57 LIST_HEAD(inpcbhead, inpcb); 58 LIST_HEAD(inpcbporthead, inpcbport); 59 typedef u_quad_t inp_gen_t; 60 61 /* 62 * PCB with AF_INET6 null bind'ed laddr can receive AF_INET input packet. 63 * So, AF_INET6 null laddr is also used as AF_INET null laddr, 64 * by utilize following structure. (At last, same as INRIA) 65 */ 66 struct in_addr_4in6 { 67 u_int32_t ia46_pad32[3]; 68 struct in_addr ia46_addr4; 69 }; 70 71 /* 72 * NOTE: ipv6 addrs should be 64-bit aligned, per RFC 2553. 73 * in_conninfo has some extra padding to accomplish this. 74 */ 75 struct in_endpoints { 76 u_int16_t ie_fport; /* foreign port */ 77 u_int16_t ie_lport; /* local port */ 78 /* protocol dependent part, local and foreign addr */ 79 union { 80 /* foreign host table entry */ 81 struct in_addr_4in6 ie46_foreign; 82 struct in6_addr ie6_foreign; 83 } ie_dependfaddr; 84 union { 85 /* local host table entry */ 86 struct in_addr_4in6 ie46_local; 87 struct in6_addr ie6_local; 88 } ie_dependladdr; 89 #define ie_faddr ie_dependfaddr.ie46_foreign.ia46_addr4 90 #define ie_laddr ie_dependladdr.ie46_local.ia46_addr4 91 #define ie6_faddr ie_dependfaddr.ie6_foreign 92 #define ie6_laddr ie_dependladdr.ie6_local 93 }; 94 95 /* 96 * XXX 97 * the defines for inc_* are hacks and should be changed to direct references 98 */ 99 struct in_conninfo { 100 u_int8_t inc_flags; 101 u_int8_t inc_len; 102 u_int16_t inc_pad; /* XXX alignment for in_endpoints */ 103 /* protocol dependent part */ 104 struct in_endpoints inc_ie; 105 }; 106 #define inc_isipv6 inc_flags /* temp compatability */ 107 #define inc_fport inc_ie.ie_fport 108 #define inc_lport inc_ie.ie_lport 109 #define inc_faddr inc_ie.ie_faddr 110 #define inc_laddr inc_ie.ie_laddr 111 #define inc6_faddr inc_ie.ie6_faddr 112 #define inc6_laddr inc_ie.ie6_laddr 113 114 struct icmp6_filter; 115 116 struct inpcb { 117 LIST_ENTRY(inpcb) inp_hash; /* hash list */ 118 LIST_ENTRY(inpcb) inp_list; /* list for all PCBs of this proto */ 119 u_int32_t inp_flow; 120 121 /* local and foreign ports, local and foreign addr */ 122 struct in_conninfo inp_inc; 123 124 caddr_t inp_ppcb; /* pointer to per-protocol pcb */ 125 struct inpcbinfo *inp_pcbinfo; /* PCB list info */ 126 struct socket *inp_socket; /* back pointer to socket */ 127 /* list for this PCB's local port */ 128 struct label *inp_label; /* MAC label */ 129 int inp_flags; /* generic IP/datagram flags */ 130 131 struct inpcbpolicy *inp_sp; /* for IPSEC */ 132 u_char inp_vflag; /* IP version flag (v4/v6) */ 133 #define INP_IPV4 0x1 134 #define INP_IPV6 0x2 135 #define INP_IPV6PROTO 0x4 /* opened under IPv6 protocol */ 136 #define INP_TIMEWAIT 0x8 /* .. probably doesn't go here */ 137 #define INP_ONESBCAST 0x10 /* send all-ones broadcast */ 138 u_char inp_ip_ttl; /* time to live proto */ 139 u_char inp_ip_p; /* protocol proto */ 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 u_short inp6_ifindex; 166 short inp6_hops; 167 } inp_depend6; 168 LIST_ENTRY(inpcb) inp_portlist; 169 struct inpcbport *inp_phd; /* head of this list */ 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_ip6_hlim inp_depend6.inp6_hlim 176 #define in6p_hops inp_depend6.inp6_hops /* default hop limit */ 177 #define in6p_ip6_nxt inp_ip_p 178 #define in6p_flowinfo inp_flow 179 #define in6p_vflag inp_vflag 180 #define in6p_options inp_depend6.inp6_options 181 #define in6p_outputopts inp_depend6.inp6_outputopts 182 #define in6p_moptions inp_depend6.inp6_moptions 183 #define in6p_icmp6filt inp_depend6.inp6_icmp6filt 184 #define in6p_cksum inp_depend6.inp6_cksum 185 #define inp6_ifindex inp_depend6.inp6_ifindex 186 #define in6p_flags inp_flags /* for KAME src sync over BSD*'s */ 187 #define in6p_socket inp_socket /* for KAME src sync over BSD*'s */ 188 #define in6p_lport inp_lport /* for KAME src sync over BSD*'s */ 189 #define in6p_fport inp_fport /* for KAME src sync over BSD*'s */ 190 #define in6p_ppcb inp_ppcb /* for KAME src sync over BSD*'s */ 191 }; 192 /* 193 * The range of the generation count, as used in this implementation, 194 * is 9e19. We would have to create 300 billion connections per 195 * second for this number to roll over in a year. This seems sufficiently 196 * unlikely that we simply don't concern ourselves with that possibility. 197 */ 198 199 /* 200 * Interface exported to userland by various protocols which use 201 * inpcbs. Hack alert -- only define if struct xsocket is in scope. 202 */ 203 #ifdef _SYS_SOCKETVAR_H_ 204 struct xinpcb { 205 size_t xi_len; /* length of this structure */ 206 struct inpcb xi_inp; 207 struct xsocket xi_socket; 208 u_quad_t xi_alignment_hack; 209 }; 210 211 struct xinpgen { 212 size_t xig_len; /* length of this structure */ 213 u_int xig_count; /* number of PCBs at this time */ 214 inp_gen_t xig_gen; /* generation count at this time */ 215 so_gen_t xig_sogen; /* socket generation count at this time */ 216 }; 217 #endif /* _SYS_SOCKETVAR_H_ */ 218 219 struct inpcbport { 220 LIST_ENTRY(inpcbport) phd_hash; 221 struct inpcbhead phd_pcblist; 222 u_short phd_port; 223 }; 224 225 struct inpcbinfo { /* XXX documentation, prefixes */ 226 struct inpcbhead *hashbase; 227 u_long hashmask; 228 struct inpcbporthead *porthashbase; 229 u_long porthashmask; 230 struct inpcbhead *listhead; 231 u_short lastport; 232 u_short lastlow; 233 u_short lasthi; 234 struct uma_zone *ipi_zone; /* zone to allocate pcbs from */ 235 u_int ipi_count; /* number of pcbs in this list */ 236 u_quad_t ipi_gencnt; /* current generation count */ 237 struct mtx ipi_mtx; 238 }; 239 240 /* 241 * NB: We cannot enable assertions when IPv6 is configured as 242 * this code is shared by both IPv4 and IPv6 and IPv6 is 243 * not properly locked. 244 */ 245 #define INP_LOCK_INIT(inp, d, t) \ 246 mtx_init(&(inp)->inp_mtx, (d), (t), MTX_DEF | MTX_RECURSE | MTX_DUPOK) 247 #define INP_LOCK_DESTROY(inp) mtx_destroy(&(inp)->inp_mtx) 248 #define INP_LOCK(inp) mtx_lock(&(inp)->inp_mtx) 249 #define INP_UNLOCK(inp) mtx_unlock(&(inp)->inp_mtx) 250 #ifndef INET6 251 #define INP_LOCK_ASSERT(inp) mtx_assert(&(inp)->inp_mtx, MA_OWNED) 252 #else 253 #define INP_LOCK_ASSERT(inp) 254 #endif 255 256 #define INP_INFO_LOCK_INIT(ipi, d) \ 257 mtx_init(&(ipi)->ipi_mtx, (d), NULL, MTX_DEF | MTX_RECURSE) 258 #define INP_INFO_RLOCK(ipi) mtx_lock(&(ipi)->ipi_mtx) 259 #define INP_INFO_WLOCK(ipi) mtx_lock(&(ipi)->ipi_mtx) 260 #define INP_INFO_RUNLOCK(ipi) mtx_unlock(&(ipi)->ipi_mtx) 261 #define INP_INFO_WUNLOCK(ipi) mtx_unlock(&(ipi)->ipi_mtx) 262 #ifndef INET6 263 #define INP_INFO_RLOCK_ASSERT(ipi) mtx_assert(&(ipi)->ipi_mtx, MA_OWNED) 264 #define INP_INFO_WLOCK_ASSERT(ipi) mtx_assert(&(ipi)->ipi_mtx, MA_OWNED) 265 #else 266 #define INP_INFO_RLOCK_ASSERT(ipi) 267 #define INP_INFO_WLOCK_ASSERT(ipi) 268 #endif 269 270 #define INP_PCBHASH(faddr, lport, fport, mask) \ 271 (((faddr) ^ ((faddr) >> 16) ^ ntohs((lport) ^ (fport))) & (mask)) 272 #define INP_PCBPORTHASH(lport, mask) \ 273 (ntohs((lport)) & (mask)) 274 275 /* flags in inp_flags: */ 276 #define INP_RECVOPTS 0x01 /* receive incoming IP options */ 277 #define INP_RECVRETOPTS 0x02 /* receive IP options for reply */ 278 #define INP_RECVDSTADDR 0x04 /* receive IP dst address */ 279 #define INP_HDRINCL 0x08 /* user supplies entire IP header */ 280 #define INP_HIGHPORT 0x10 /* user wants "high" port binding */ 281 #define INP_LOWPORT 0x20 /* user wants "low" port binding */ 282 #define INP_ANONPORT 0x40 /* port chosen for user */ 283 #define INP_RECVIF 0x80 /* receive incoming interface */ 284 #define INP_MTUDISC 0x100 /* user can do MTU discovery */ 285 #define INP_FAITH 0x200 /* accept FAITH'ed connections */ 286 #define INP_RECVTTL 0x400 /* receive incoming IP TTL */ 287 288 #define IN6P_IPV6_V6ONLY 0x008000 /* restrict AF_INET6 socket for v6 */ 289 290 #define IN6P_PKTINFO 0x010000 /* receive IP6 dst and I/F */ 291 #define IN6P_HOPLIMIT 0x020000 /* receive hoplimit */ 292 #define IN6P_HOPOPTS 0x040000 /* receive hop-by-hop options */ 293 #define IN6P_DSTOPTS 0x080000 /* receive dst options after rthdr */ 294 #define IN6P_RTHDR 0x100000 /* receive routing header */ 295 #define IN6P_RTHDRDSTOPTS 0x200000 /* receive dstoptions before rthdr */ 296 #define IN6P_TCLASS 0x400000 /* receive traffic class value */ 297 #define IN6P_AUTOFLOWLABEL 0x800000 /* attach flowlabel automatically */ 298 #define IN6P_RFC2292 0x40000000 /* used RFC2292 API on the socket */ 299 #define IN6P_MTU 0x80000000 /* receive path MTU */ 300 301 #define INP_CONTROLOPTS (INP_RECVOPTS|INP_RECVRETOPTS|INP_RECVDSTADDR|\ 302 INP_RECVIF|INP_RECVTTL|\ 303 IN6P_PKTINFO|IN6P_HOPLIMIT|IN6P_HOPOPTS|\ 304 IN6P_DSTOPTS|IN6P_RTHDR|IN6P_RTHDRDSTOPTS|\ 305 IN6P_TCLASS|IN6P_AUTOFLOWLABEL|IN6P_RFC2292|\ 306 IN6P_MTU) 307 #define INP_UNMAPPABLEOPTS (IN6P_HOPOPTS|IN6P_DSTOPTS|IN6P_RTHDR|\ 308 IN6P_TCLASS|IN6P_AUTOFLOWLABEL) 309 310 /* for KAME src sync over BSD*'s */ 311 #define IN6P_HIGHPORT INP_HIGHPORT 312 #define IN6P_LOWPORT INP_LOWPORT 313 #define IN6P_ANONPORT INP_ANONPORT 314 #define IN6P_RECVIF INP_RECVIF 315 #define IN6P_MTUDISC INP_MTUDISC 316 #define IN6P_FAITH INP_FAITH 317 #define IN6P_CONTROLOPTS INP_CONTROLOPTS 318 /* 319 * socket AF version is {newer than,or include} 320 * actual datagram AF version 321 */ 322 323 #define INPLOOKUP_WILDCARD 1 324 #define sotoinpcb(so) ((struct inpcb *)(so)->so_pcb) 325 #define sotoin6pcb(so) sotoinpcb(so) /* for KAME src sync over BSD*'s */ 326 327 #define INP_SOCKAF(so) so->so_proto->pr_domain->dom_family 328 329 #define INP_CHECK_SOCKAF(so, af) (INP_SOCKAF(so) == af) 330 331 #ifdef _KERNEL 332 extern int ipport_lowfirstauto; 333 extern int ipport_lowlastauto; 334 extern int ipport_firstauto; 335 extern int ipport_lastauto; 336 extern int ipport_hifirstauto; 337 extern int ipport_hilastauto; 338 339 void in_pcbpurgeif0(struct inpcbinfo *, struct ifnet *); 340 int in_pcballoc(struct socket *, struct inpcbinfo *, struct thread *, 341 const char *); 342 int in_pcbbind(struct inpcb *, struct sockaddr *, struct thread *); 343 int in_pcbbind_setup(struct inpcb *, struct sockaddr *, in_addr_t *, 344 u_short *, struct thread *); 345 int in_pcbconnect(struct inpcb *, struct sockaddr *, struct thread *); 346 int in_pcbconnect_setup(struct inpcb *, struct sockaddr *, in_addr_t *, 347 u_short *, in_addr_t *, u_short *, struct inpcb **, 348 struct thread *); 349 void in_pcbdetach(struct inpcb *); 350 void in_pcbdisconnect(struct inpcb *); 351 int in_pcbinshash(struct inpcb *); 352 struct inpcb * 353 in_pcblookup_local(struct inpcbinfo *, 354 struct in_addr, u_int, int); 355 struct inpcb * 356 in_pcblookup_hash(struct inpcbinfo *, struct in_addr, u_int, 357 struct in_addr, u_int, int, struct ifnet *); 358 void in_pcbnotifyall(struct inpcbinfo *pcbinfo, struct in_addr, 359 int, struct inpcb *(*)(struct inpcb *, int)); 360 void in_pcbrehash(struct inpcb *); 361 void in_pcbsetsolabel(struct socket *so); 362 int in_setpeeraddr(struct socket *so, struct sockaddr **nam, struct inpcbinfo *pcbinfo); 363 int in_setsockaddr(struct socket *so, struct sockaddr **nam, struct inpcbinfo *pcbinfo);; 364 struct sockaddr * 365 in_sockaddr(in_port_t port, struct in_addr *addr); 366 void in_pcbsosetlabel(struct socket *so); 367 void in_pcbremlists(struct inpcb *inp); 368 int prison_xinpcb(struct thread *td, struct inpcb *inp); 369 #endif /* _KERNEL */ 370 371 #endif /* !_NETINET_IN_PCB_H_ */ 372