2 * Copyright (c) 1982, 1986, 1990, 1993
3 * The Regents of the University of California.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * 4. Neither the name of the University nor the names of its contributors
15 * may be used to endorse or promote products derived from this software
16 * without specific prior written permission.
18 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * @(#)in_pcb.h 8.1 (Berkeley) 6/10/93
34 #ifndef _NETINET_IN_PCB_H_
35 #define _NETINET_IN_PCB_H_
37 #include <sys/queue.h>
38 #include <sys/_lock.h>
39 #include <sys/_mutex.h>
40 #include <sys/_rwlock.h>
42 #include <net/route.h>
45 #include <sys/rwlock.h>
48 #define in6pcb inpcb /* for KAME src sync over BSD*'s */
49 #define in6p_sp inp_sp /* for KAME src sync over BSD*'s */
53 * struct inpcb is the common protocol control block structure used in most
54 * IP transport protocols.
56 * Pointers to local and foreign host table entries, local and foreign socket
57 * numbers, and pointers up (to a socket structure) and down (to a
58 * protocol-specific control block) are stored here.
60 LIST_HEAD(inpcbhead, inpcb);
61 LIST_HEAD(inpcbporthead, inpcbport);
62 typedef u_quad_t inp_gen_t;
65 * PCB with AF_INET6 null bind'ed laddr can receive AF_INET input packet.
66 * So, AF_INET6 null laddr is also used as AF_INET null laddr, by utilizing
67 * the following structure.
70 u_int32_t ia46_pad32[3];
71 struct in_addr ia46_addr4;
75 * NOTE: ipv6 addrs should be 64-bit aligned, per RFC 2553. in_conninfo has
76 * some extra padding to accomplish this.
79 u_int16_t ie_fport; /* foreign port */
80 u_int16_t ie_lport; /* local port */
81 /* protocol dependent part, local and foreign addr */
83 /* foreign host table entry */
84 struct in_addr_4in6 ie46_foreign;
85 struct in6_addr ie6_foreign;
88 /* local host table entry */
89 struct in_addr_4in6 ie46_local;
90 struct in6_addr ie6_local;
93 #define ie_faddr ie_dependfaddr.ie46_foreign.ia46_addr4
94 #define ie_laddr ie_dependladdr.ie46_local.ia46_addr4
95 #define ie6_faddr ie_dependfaddr.ie6_foreign
96 #define ie6_laddr ie_dependladdr.ie6_local
99 * XXX The defines for inc_* are hacks and should be changed to direct
105 u_int16_t inc_fibnum; /* XXX was pad, 16 bits is plenty */
106 /* protocol dependent part */
107 struct in_endpoints inc_ie;
111 * Flags for inc_flags.
113 #define INC_ISIPV6 0x01
115 #define inc_isipv6 inc_flags /* temp compatability */
116 #define inc_fport inc_ie.ie_fport
117 #define inc_lport inc_ie.ie_lport
118 #define inc_faddr inc_ie.ie_faddr
119 #define inc_laddr inc_ie.ie_laddr
120 #define inc6_faddr inc_ie.ie6_faddr
121 #define inc6_laddr inc_ie.ie6_laddr
126 * struct inpcb captures the network layer state for TCP, UDP, and raw IPv4
127 * and IPv6 sockets. In the case of TCP, further per-connection state is
128 * hung off of inp_ppcb most of the time. Almost all fields of struct inpcb
129 * are static after creation or protected by a per-inpcb rwlock, inp_lock. A
130 * few fields also require the global pcbinfo lock for the inpcb to be held,
131 * when modified, such as the global connection lists and hashes, as well as
132 * binding information (which affects which hash a connection is on). This
133 * model means that connections can be looked up without holding the
134 * per-connection lock, which is important for performance when attempting to
135 * find the connection for a packet given its IP and port tuple. Writing to
136 * these fields that write locks be held on both the inpcb and global locks.
139 * (c) - Constant after initialization
140 * (i) - Protected by the inpcb lock
141 * (p) - Protected by the pcbinfo lock for the inpcb
142 * (s) - Protected by another subsystem's locks
143 * (x) - Undefined locking
147 * When a read lock is held, stability of the field is guaranteed; to write
148 * to a field, a write lock must generally be held.
150 * netinet/netinet6-layer code should not assume that the inp_socket pointer
151 * is safe to dereference without inp_lock being held, even for protocols
152 * other than TCP (where the inpcb persists during TIMEWAIT even after the
153 * socket has been freed), or there may be close(2)-related races.
155 * The inp_vflag field is overloaded, and would otherwise ideally be (c).
158 LIST_ENTRY(inpcb) inp_hash; /* (i/p) hash list */
159 LIST_ENTRY(inpcb) inp_list; /* (i/p) list for all PCBs for proto */
160 void *inp_ppcb; /* (i) pointer to per-protocol pcb */
161 struct inpcbinfo *inp_pcbinfo; /* (c) PCB list info */
162 struct socket *inp_socket; /* (i) back pointer to socket */
163 struct ucred *inp_cred; /* (c) cache of socket cred */
164 u_int32_t inp_flow; /* (i) IPv6 flow information */
165 int inp_flags; /* (i) generic IP/datagram flags */
166 int inp_flags2; /* (i) generic IP/datagram flags #2*/
167 u_char inp_vflag; /* (i) IP version flag (v4/v6) */
168 u_char inp_ip_ttl; /* (i) time to live proto */
169 u_char inp_ip_p; /* (c) protocol proto */
170 u_char inp_ip_minttl; /* (i) minimum TTL or drop */
171 uint32_t inp_flowid; /* (x) flow id / queue id */
172 u_int inp_refcount; /* (i) refcount */
173 struct llentry *inp_lle; /* cached L2 information */
174 struct rtentry *inp_rt; /* cached L3 information */
176 /* Local and foreign ports, local and foreign addr. */
177 struct in_conninfo inp_inc; /* (i/p) list for PCB's local port */
179 /* MAC and IPSEC policy information. */
180 struct label *inp_label; /* (i) MAC label */
181 struct inpcbpolicy *inp_sp; /* (s) for IPSEC */
183 /* Protocol-dependent part; options. */
185 u_char inp4_ip_tos; /* (i) type of service proto */
186 struct mbuf *inp4_options; /* (i) IP options */
187 struct ip_moptions *inp4_moptions; /* (i) IP mcast options */
191 struct mbuf *inp6_options;
192 /* (i) IP6 options for outgoing packets */
193 struct ip6_pktopts *inp6_outputopts;
194 /* (i) IP multicast options */
195 struct ip6_moptions *inp6_moptions;
196 /* (i) ICMPv6 code type filter */
197 struct icmp6_filter *inp6_icmp6filt;
198 /* (i) IPV6_CHECKSUM setsockopt */
202 LIST_ENTRY(inpcb) inp_portlist; /* (i/p) */
203 struct inpcbport *inp_phd; /* (i/p) head of this list */
204 #define inp_zero_size offsetof(struct inpcb, inp_gencnt)
205 inp_gen_t inp_gencnt; /* (c) generation count */
206 struct rwlock inp_lock;
208 #define inp_fport inp_inc.inc_fport
209 #define inp_lport inp_inc.inc_lport
210 #define inp_faddr inp_inc.inc_faddr
211 #define inp_laddr inp_inc.inc_laddr
212 #define inp_ip_tos inp_depend4.inp4_ip_tos
213 #define inp_options inp_depend4.inp4_options
214 #define inp_moptions inp_depend4.inp4_moptions
216 #define in6p_faddr inp_inc.inc6_faddr
217 #define in6p_laddr inp_inc.inc6_laddr
218 #define in6p_hops inp_depend6.inp6_hops /* default hop limit */
219 #define in6p_flowinfo inp_flow
220 #define in6p_options inp_depend6.inp6_options
221 #define in6p_outputopts inp_depend6.inp6_outputopts
222 #define in6p_moptions inp_depend6.inp6_moptions
223 #define in6p_icmp6filt inp_depend6.inp6_icmp6filt
224 #define in6p_cksum inp_depend6.inp6_cksum
227 * The range of the generation count, as used in this implementation, is 9e19.
228 * We would have to create 300 billion connections per second for this number
229 * to roll over in a year. This seems sufficiently unlikely that we simply
230 * don't concern ourselves with that possibility.
234 * Interface exported to userland by various protocols which use inpcbs. Hack
235 * alert -- only define if struct xsocket is in scope.
237 #ifdef _SYS_SOCKETVAR_H_
239 size_t xi_len; /* length of this structure */
241 struct xsocket xi_socket;
242 u_quad_t xi_alignment_hack;
246 size_t xig_len; /* length of this structure */
247 u_int xig_count; /* number of PCBs at this time */
248 inp_gen_t xig_gen; /* generation count at this time */
249 so_gen_t xig_sogen; /* socket generation count at this time */
251 #endif /* _SYS_SOCKETVAR_H_ */
254 LIST_ENTRY(inpcbport) phd_hash;
255 struct inpcbhead phd_pcblist;
260 * Global data structure for each high-level protocol (UDP, TCP, ...) in both
261 * IPv4 and IPv6. Holds inpcb lists and information for managing them.
265 * Global list of inpcbs on the protocol.
267 struct inpcbhead *ipi_listhead;
271 * Global hash of inpcbs, hashed by local and foreign addresses and
274 struct inpcbhead *ipi_hashbase;
278 * Global hash of inpcbs, hashed by only local port number.
280 struct inpcbporthead *ipi_porthashbase;
281 u_long ipi_porthashmask;
284 * Fields associated with port lookup and allocation.
286 u_short ipi_lastport;
291 * UMA zone from which inpcbs are allocated for this protocol.
293 struct uma_zone *ipi_zone;
296 * Generation count--incremented each time a connection is allocated
300 struct rwlock ipi_lock;
309 #define INP_LOCK_INIT(inp, d, t) \
310 rw_init_flags(&(inp)->inp_lock, (t), RW_RECURSE | RW_DUPOK)
311 #define INP_LOCK_DESTROY(inp) rw_destroy(&(inp)->inp_lock)
312 #define INP_RLOCK(inp) rw_rlock(&(inp)->inp_lock)
313 #define INP_WLOCK(inp) rw_wlock(&(inp)->inp_lock)
314 #define INP_TRY_RLOCK(inp) rw_try_rlock(&(inp)->inp_lock)
315 #define INP_TRY_WLOCK(inp) rw_try_wlock(&(inp)->inp_lock)
316 #define INP_RUNLOCK(inp) rw_runlock(&(inp)->inp_lock)
317 #define INP_WUNLOCK(inp) rw_wunlock(&(inp)->inp_lock)
318 #define INP_TRY_UPGRADE(inp) rw_try_upgrade(&(inp)->inp_lock)
319 #define INP_DOWNGRADE(inp) rw_downgrade(&(inp)->inp_lock)
320 #define INP_WLOCKED(inp) rw_wowned(&(inp)->inp_lock)
321 #define INP_LOCK_ASSERT(inp) rw_assert(&(inp)->inp_lock, RA_LOCKED)
322 #define INP_RLOCK_ASSERT(inp) rw_assert(&(inp)->inp_lock, RA_RLOCKED)
323 #define INP_WLOCK_ASSERT(inp) rw_assert(&(inp)->inp_lock, RA_WLOCKED)
324 #define INP_UNLOCK_ASSERT(inp) rw_assert(&(inp)->inp_lock, RA_UNLOCKED)
328 * These locking functions are for inpcb consumers outside of sys/netinet,
329 * more specifically, they were added for the benefit of TOE drivers. The
330 * macros are reserved for use by the stack.
332 void inp_wlock(struct inpcb *);
333 void inp_wunlock(struct inpcb *);
334 void inp_rlock(struct inpcb *);
335 void inp_runlock(struct inpcb *);
338 void inp_lock_assert(struct inpcb *);
339 void inp_unlock_assert(struct inpcb *);
342 inp_lock_assert(struct inpcb *inp __unused)
347 inp_unlock_assert(struct inpcb *inp __unused)
353 void inp_apply_all(void (*func)(struct inpcb *, void *), void *arg);
354 int inp_ip_tos_get(const struct inpcb *inp);
355 void inp_ip_tos_set(struct inpcb *inp, int val);
357 inp_inpcbtosocket(struct inpcb *inp);
359 inp_inpcbtotcpcb(struct inpcb *inp);
360 void inp_4tuple_get(struct inpcb *inp, uint32_t *laddr, uint16_t *lp,
361 uint32_t *faddr, uint16_t *fp);
365 #define INP_INFO_LOCK_INIT(ipi, d) \
366 rw_init_flags(&(ipi)->ipi_lock, (d), RW_RECURSE)
367 #define INP_INFO_LOCK_DESTROY(ipi) rw_destroy(&(ipi)->ipi_lock)
368 #define INP_INFO_RLOCK(ipi) rw_rlock(&(ipi)->ipi_lock)
369 #define INP_INFO_WLOCK(ipi) rw_wlock(&(ipi)->ipi_lock)
370 #define INP_INFO_TRY_RLOCK(ipi) rw_try_rlock(&(ipi)->ipi_lock)
371 #define INP_INFO_TRY_WLOCK(ipi) rw_try_wlock(&(ipi)->ipi_lock)
372 #define INP_INFO_RUNLOCK(ipi) rw_runlock(&(ipi)->ipi_lock)
373 #define INP_INFO_WUNLOCK(ipi) rw_wunlock(&(ipi)->ipi_lock)
374 #define INP_INFO_LOCK_ASSERT(ipi) rw_assert(&(ipi)->ipi_lock, RA_LOCKED)
375 #define INP_INFO_RLOCK_ASSERT(ipi) rw_assert(&(ipi)->ipi_lock, RA_RLOCKED)
376 #define INP_INFO_WLOCK_ASSERT(ipi) rw_assert(&(ipi)->ipi_lock, RA_WLOCKED)
377 #define INP_INFO_UNLOCK_ASSERT(ipi) rw_assert(&(ipi)->ipi_lock, RA_UNLOCKED)
379 #define INP_PCBHASH(faddr, lport, fport, mask) \
380 (((faddr) ^ ((faddr) >> 16) ^ ntohs((lport) ^ (fport))) & (mask))
381 #define INP_PCBPORTHASH(lport, mask) \
382 (ntohs((lport)) & (mask))
385 * Flags for inp_vflags -- historically version flags only
389 #define INP_IPV6PROTO 0x4 /* opened under IPv6 protocol */
392 * Flags for inp_flags.
394 #define INP_RECVOPTS 0x00000001 /* receive incoming IP options */
395 #define INP_RECVRETOPTS 0x00000002 /* receive IP options for reply */
396 #define INP_RECVDSTADDR 0x00000004 /* receive IP dst address */
397 #define INP_HDRINCL 0x00000008 /* user supplies entire IP header */
398 #define INP_HIGHPORT 0x00000010 /* user wants "high" port binding */
399 #define INP_LOWPORT 0x00000020 /* user wants "low" port binding */
400 #define INP_ANONPORT 0x00000040 /* port chosen for user */
401 #define INP_RECVIF 0x00000080 /* receive incoming interface */
402 #define INP_MTUDISC 0x00000100 /* user can do MTU discovery */
403 #define INP_FAITH 0x00000200 /* accept FAITH'ed connections */
404 #define INP_RECVTTL 0x00000400 /* receive incoming IP TTL */
405 #define INP_DONTFRAG 0x00000800 /* don't fragment packet */
406 #define INP_NONLOCALOK 0x00001000 /* Allow bind to spoof any address */
407 /* - requires options IP_NONLOCALBIND */
408 #define INP_INHASHLIST 0x00002000 /* in_pcbinshash() has been called */
409 #define IN6P_IPV6_V6ONLY 0x00008000 /* restrict AF_INET6 socket for v6 */
410 #define IN6P_PKTINFO 0x00010000 /* receive IP6 dst and I/F */
411 #define IN6P_HOPLIMIT 0x00020000 /* receive hoplimit */
412 #define IN6P_HOPOPTS 0x00040000 /* receive hop-by-hop options */
413 #define IN6P_DSTOPTS 0x00080000 /* receive dst options after rthdr */
414 #define IN6P_RTHDR 0x00100000 /* receive routing header */
415 #define IN6P_RTHDRDSTOPTS 0x00200000 /* receive dstoptions before rthdr */
416 #define IN6P_TCLASS 0x00400000 /* receive traffic class value */
417 #define IN6P_AUTOFLOWLABEL 0x00800000 /* attach flowlabel automatically */
418 #define INP_TIMEWAIT 0x01000000 /* in TIMEWAIT, ppcb is tcptw */
419 #define INP_ONESBCAST 0x02000000 /* send all-ones broadcast */
420 #define INP_DROPPED 0x04000000 /* protocol drop flag */
421 #define INP_SOCKREF 0x08000000 /* strong socket reference */
422 #define INP_SW_FLOWID 0x10000000 /* software generated flow id */
423 #define INP_HW_FLOWID 0x20000000 /* hardware generated flow id */
424 #define IN6P_RFC2292 0x40000000 /* used RFC2292 API on the socket */
425 #define IN6P_MTU 0x80000000 /* receive path MTU */
427 #define INP_CONTROLOPTS (INP_RECVOPTS|INP_RECVRETOPTS|INP_RECVDSTADDR|\
428 INP_RECVIF|INP_RECVTTL|\
429 IN6P_PKTINFO|IN6P_HOPLIMIT|IN6P_HOPOPTS|\
430 IN6P_DSTOPTS|IN6P_RTHDR|IN6P_RTHDRDSTOPTS|\
431 IN6P_TCLASS|IN6P_AUTOFLOWLABEL|IN6P_RFC2292|\
435 * Flags for inp_flags2.
437 #define INP_LLE_VALID 0x00000001 /* cached lle is valid */
438 #define INP_RT_VALID 0x00000002 /* cached rtentry is valid */
440 #define INPLOOKUP_WILDCARD 1
441 #define sotoinpcb(so) ((struct inpcb *)(so)->so_pcb)
442 #define sotoin6pcb(so) sotoinpcb(so) /* for KAME src sync over BSD*'s */
444 #define INP_SOCKAF(so) so->so_proto->pr_domain->dom_family
446 #define INP_CHECK_SOCKAF(so, af) (INP_SOCKAF(so) == af)
449 #ifdef VIMAGE_GLOBALS
450 extern int ipport_reservedhigh;
451 extern int ipport_reservedlow;
452 extern int ipport_lowfirstauto;
453 extern int ipport_lowlastauto;
454 extern int ipport_firstauto;
455 extern int ipport_lastauto;
456 extern int ipport_hifirstauto;
457 extern int ipport_hilastauto;
458 extern int ipport_randomized;
459 extern int ipport_randomcps;
460 extern int ipport_randomtime;
461 extern int ipport_stoprandom;
462 extern int ipport_tcpallocs;
464 extern struct callout ipport_tick_callout;
466 void in_pcbpurgeif0(struct inpcbinfo *, struct ifnet *);
467 int in_pcballoc(struct socket *, struct inpcbinfo *);
468 int in_pcbbind(struct inpcb *, struct sockaddr *, struct ucred *);
469 int in_pcbbind_setup(struct inpcb *, struct sockaddr *, in_addr_t *,
470 u_short *, struct ucred *);
471 int in_pcbconnect(struct inpcb *, struct sockaddr *, struct ucred *);
472 int in_pcbconnect_setup(struct inpcb *, struct sockaddr *, in_addr_t *,
473 u_short *, in_addr_t *, u_short *, struct inpcb **,
475 void in_pcbdetach(struct inpcb *);
476 void in_pcbdisconnect(struct inpcb *);
477 void in_pcbdrop(struct inpcb *);
478 void in_pcbfree(struct inpcb *);
479 int in_pcbinshash(struct inpcb *);
481 in_pcblookup_local(struct inpcbinfo *,
482 struct in_addr, u_short, int, struct ucred *);
484 in_pcblookup_hash(struct inpcbinfo *, struct in_addr, u_int,
485 struct in_addr, u_int, int, struct ifnet *);
486 void in_pcbnotifyall(struct inpcbinfo *pcbinfo, struct in_addr,
487 int, struct inpcb *(*)(struct inpcb *, int));
488 void in_pcbref(struct inpcb *);
489 void in_pcbrehash(struct inpcb *);
490 int in_pcbrele(struct inpcb *);
491 void in_pcbsetsolabel(struct socket *so);
492 int in_getpeeraddr(struct socket *so, struct sockaddr **nam);
493 int in_getsockaddr(struct socket *so, struct sockaddr **nam);
495 in_sockaddr(in_port_t port, struct in_addr *addr);
496 void in_pcbsosetlabel(struct socket *so);
497 void in_pcbremlists(struct inpcb *inp);
498 void ipport_tick(void *xtp);
501 * Debugging routines compiled in when DDB is present.
503 void db_print_inpcb(struct inpcb *inp, const char *name, int indent);
507 #endif /* !_NETINET_IN_PCB_H_ */