2 * Copyright (c) 1982, 1986, 1990, 1993
3 * The Regents of the University of California. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
29 * @(#)in_pcb.h 8.1 (Berkeley) 6/10/93
33 #ifndef _NETINET_IN_PCB_H_
34 #define _NETINET_IN_PCB_H_
36 #include <sys/queue.h>
37 #include <sys/_lock.h>
38 #include <sys/_mutex.h>
40 #include <net/route.h>
42 #define in6pcb inpcb /* for KAME src sync over BSD*'s */
43 #define in6p_sp inp_sp /* for KAME src sync over BSD*'s */
47 * Common structure pcb for internet protocol implementation.
48 * Here are stored pointers to local and foreign host table
49 * entries, local and foreign socket numbers, and pointers
50 * up (to a socket structure) and down (to a protocol-specific)
53 LIST_HEAD(inpcbhead, inpcb);
54 LIST_HEAD(inpcbporthead, inpcbport);
55 typedef u_quad_t inp_gen_t;
58 * PCB with AF_INET6 null bind'ed laddr can receive AF_INET input packet.
59 * So, AF_INET6 null laddr is also used as AF_INET null laddr,
60 * by utilize following structure. (At last, same as INRIA)
63 u_int32_t ia46_pad32[3];
64 struct in_addr ia46_addr4;
68 * NOTE: ipv6 addrs should be 64-bit aligned, per RFC 2553.
69 * in_conninfo has some extra padding to accomplish this.
72 u_int16_t ie_fport; /* foreign port */
73 u_int16_t ie_lport; /* local port */
74 /* protocol dependent part, local and foreign addr */
76 /* foreign host table entry */
77 struct in_addr_4in6 ie46_foreign;
78 struct in6_addr ie6_foreign;
81 /* local host table entry */
82 struct in_addr_4in6 ie46_local;
83 struct in6_addr ie6_local;
85 #define ie_faddr ie_dependfaddr.ie46_foreign.ia46_addr4
86 #define ie_laddr ie_dependladdr.ie46_local.ia46_addr4
87 #define ie6_faddr ie_dependfaddr.ie6_foreign
88 #define ie6_laddr ie_dependladdr.ie6_local
93 * the defines for inc_* are hacks and should be changed to direct references
98 u_int16_t inc_pad; /* XXX alignment for in_endpoints */
99 /* protocol dependent part */
100 struct in_endpoints inc_ie;
102 #define inc_isipv6 inc_flags /* temp compatability */
103 #define inc_fport inc_ie.ie_fport
104 #define inc_lport inc_ie.ie_lport
105 #define inc_faddr inc_ie.ie_faddr
106 #define inc_laddr inc_ie.ie_laddr
107 #define inc6_faddr inc_ie.ie6_faddr
108 #define inc6_laddr inc_ie.ie6_laddr
113 LIST_ENTRY(inpcb) inp_hash; /* hash list */
114 LIST_ENTRY(inpcb) inp_list; /* list for all PCBs of this proto */
117 /* local and foreign ports, local and foreign addr */
118 struct in_conninfo inp_inc;
120 void *inp_ppcb; /* pointer to per-protocol pcb */
121 struct inpcbinfo *inp_pcbinfo; /* PCB list info */
122 struct socket *inp_socket; /* back pointer to socket */
123 /* list for this PCB's local port */
124 struct label *inp_label; /* MAC label */
125 int inp_flags; /* generic IP/datagram flags */
127 struct inpcbpolicy *inp_sp; /* for IPSEC */
128 u_char inp_vflag; /* IP version flag (v4/v6) */
131 #define INP_IPV6PROTO 0x4 /* opened under IPv6 protocol */
132 #define INP_TIMEWAIT 0x8 /* .. probably doesn't go here */
133 #define INP_ONESBCAST 0x10 /* send all-ones broadcast */
134 #define INP_DROPPED 0x20 /* protocol drop flag */
135 #define INP_SOCKREF 0x40 /* strong socket reference */
136 u_char inp_ip_ttl; /* time to live proto */
137 u_char inp_ip_p; /* protocol proto */
138 u_char inp_ip_minttl; /* minimum TTL or drop */
140 /* protocol dependent part; options */
142 u_char inp4_ip_tos; /* type of service proto */
143 struct mbuf *inp4_options; /* IP options */
144 struct ip_moptions *inp4_moptions; /* IP multicast options */
146 #define inp_fport inp_inc.inc_fport
147 #define inp_lport inp_inc.inc_lport
148 #define inp_faddr inp_inc.inc_faddr
149 #define inp_laddr inp_inc.inc_laddr
150 #define inp_ip_tos inp_depend4.inp4_ip_tos
151 #define inp_options inp_depend4.inp4_options
152 #define inp_moptions inp_depend4.inp4_moptions
155 struct mbuf *inp6_options;
156 /* IP6 options for outgoing packets */
157 struct ip6_pktopts *inp6_outputopts;
158 /* IP multicast options */
159 struct ip6_moptions *inp6_moptions;
160 /* ICMPv6 code type filter */
161 struct icmp6_filter *inp6_icmp6filt;
162 /* IPV6_CHECKSUM setsockopt */
164 u_short inp6_ifindex;
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 */
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 */
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.
200 * Interface exported to userland by various protocols which use
201 * inpcbs. Hack alert -- only define if struct xsocket is in scope.
203 #ifdef _SYS_SOCKETVAR_H_
205 size_t xi_len; /* length of this structure */
207 struct xsocket xi_socket;
208 u_quad_t xi_alignment_hack;
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 */
217 #endif /* _SYS_SOCKETVAR_H_ */
220 LIST_ENTRY(inpcbport) phd_hash;
221 struct inpcbhead phd_pcblist;
225 struct inpcbinfo { /* XXX documentation, prefixes */
226 struct inpcbhead *hashbase;
228 struct inpcbporthead *porthashbase;
230 struct inpcbhead *listhead;
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 */
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.
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 #define INP_LOCK_ASSERT(inp) do { \
251 mtx_assert(&(inp)->inp_mtx, MA_OWNED); \
252 NET_ASSERT_GIANT(); \
254 #define INP_UNLOCK_ASSERT(inp) mtx_assert(&(inp)->inp_mtx, MA_NOTOWNED)
256 #define INP_INFO_LOCK_INIT(ipi, d) \
257 mtx_init(&(ipi)->ipi_mtx, (d), NULL, MTX_DEF | MTX_RECURSE)
258 #define INP_INFO_LOCK_DESTROY(ipi) mtx_destroy(&(ipi)->ipi_mtx)
259 #define INP_INFO_RLOCK(ipi) mtx_lock(&(ipi)->ipi_mtx)
260 #define INP_INFO_WLOCK(ipi) mtx_lock(&(ipi)->ipi_mtx)
261 #define INP_INFO_RUNLOCK(ipi) mtx_unlock(&(ipi)->ipi_mtx)
262 #define INP_INFO_WUNLOCK(ipi) mtx_unlock(&(ipi)->ipi_mtx)
263 #define INP_INFO_RLOCK_ASSERT(ipi) do { \
264 mtx_assert(&(ipi)->ipi_mtx, MA_OWNED); \
265 NET_ASSERT_GIANT(); \
267 #define INP_INFO_WLOCK_ASSERT(ipi) do { \
268 mtx_assert(&(ipi)->ipi_mtx, MA_OWNED); \
269 NET_ASSERT_GIANT(); \
272 #define INP_PCBHASH(faddr, lport, fport, mask) \
273 (((faddr) ^ ((faddr) >> 16) ^ ntohs((lport) ^ (fport))) & (mask))
274 #define INP_PCBPORTHASH(lport, mask) \
275 (ntohs((lport)) & (mask))
277 /* flags in inp_flags: */
278 #define INP_RECVOPTS 0x01 /* receive incoming IP options */
279 #define INP_RECVRETOPTS 0x02 /* receive IP options for reply */
280 #define INP_RECVDSTADDR 0x04 /* receive IP dst address */
281 #define INP_HDRINCL 0x08 /* user supplies entire IP header */
282 #define INP_HIGHPORT 0x10 /* user wants "high" port binding */
283 #define INP_LOWPORT 0x20 /* user wants "low" port binding */
284 #define INP_ANONPORT 0x40 /* port chosen for user */
285 #define INP_RECVIF 0x80 /* receive incoming interface */
286 #define INP_MTUDISC 0x100 /* user can do MTU discovery */
287 #define INP_FAITH 0x200 /* accept FAITH'ed connections */
288 #define INP_RECVTTL 0x400 /* receive incoming IP TTL */
289 #define INP_DONTFRAG 0x800 /* don't fragment packet */
291 #define IN6P_IPV6_V6ONLY 0x008000 /* restrict AF_INET6 socket for v6 */
293 #define IN6P_PKTINFO 0x010000 /* receive IP6 dst and I/F */
294 #define IN6P_HOPLIMIT 0x020000 /* receive hoplimit */
295 #define IN6P_HOPOPTS 0x040000 /* receive hop-by-hop options */
296 #define IN6P_DSTOPTS 0x080000 /* receive dst options after rthdr */
297 #define IN6P_RTHDR 0x100000 /* receive routing header */
298 #define IN6P_RTHDRDSTOPTS 0x200000 /* receive dstoptions before rthdr */
299 #define IN6P_TCLASS 0x400000 /* receive traffic class value */
300 #define IN6P_AUTOFLOWLABEL 0x800000 /* attach flowlabel automatically */
301 #define IN6P_RFC2292 0x40000000 /* used RFC2292 API on the socket */
302 #define IN6P_MTU 0x80000000 /* receive path MTU */
304 #define INP_CONTROLOPTS (INP_RECVOPTS|INP_RECVRETOPTS|INP_RECVDSTADDR|\
305 INP_RECVIF|INP_RECVTTL|\
306 IN6P_PKTINFO|IN6P_HOPLIMIT|IN6P_HOPOPTS|\
307 IN6P_DSTOPTS|IN6P_RTHDR|IN6P_RTHDRDSTOPTS|\
308 IN6P_TCLASS|IN6P_AUTOFLOWLABEL|IN6P_RFC2292|\
310 #define INP_UNMAPPABLEOPTS (IN6P_HOPOPTS|IN6P_DSTOPTS|IN6P_RTHDR|\
311 IN6P_TCLASS|IN6P_AUTOFLOWLABEL)
313 /* for KAME src sync over BSD*'s */
314 #define IN6P_HIGHPORT INP_HIGHPORT
315 #define IN6P_LOWPORT INP_LOWPORT
316 #define IN6P_ANONPORT INP_ANONPORT
317 #define IN6P_RECVIF INP_RECVIF
318 #define IN6P_MTUDISC INP_MTUDISC
319 #define IN6P_FAITH INP_FAITH
320 #define IN6P_CONTROLOPTS INP_CONTROLOPTS
322 * socket AF version is {newer than,or include}
323 * actual datagram AF version
326 #define INPLOOKUP_WILDCARD 1
327 #define sotoinpcb(so) ((struct inpcb *)(so)->so_pcb)
328 #define sotoin6pcb(so) sotoinpcb(so) /* for KAME src sync over BSD*'s */
330 #define INP_SOCKAF(so) so->so_proto->pr_domain->dom_family
332 #define INP_CHECK_SOCKAF(so, af) (INP_SOCKAF(so) == af)
335 extern int ipport_reservedhigh;
336 extern int ipport_reservedlow;
337 extern int ipport_lowfirstauto;
338 extern int ipport_lowlastauto;
339 extern int ipport_firstauto;
340 extern int ipport_lastauto;
341 extern int ipport_hifirstauto;
342 extern int ipport_hilastauto;
343 extern struct callout ipport_tick_callout;
345 void in_pcbpurgeif0(struct inpcbinfo *, struct ifnet *);
346 int in_pcballoc(struct socket *, struct inpcbinfo *);
347 int in_pcbbind(struct inpcb *, struct sockaddr *, struct ucred *);
348 int in_pcbbind_setup(struct inpcb *, struct sockaddr *, in_addr_t *,
349 u_short *, struct ucred *);
350 int in_pcbconnect(struct inpcb *, struct sockaddr *, struct ucred *);
351 int in_pcbconnect_setup(struct inpcb *, struct sockaddr *, in_addr_t *,
352 u_short *, in_addr_t *, u_short *, struct inpcb **,
354 void in_pcbdetach(struct inpcb *);
355 void in_pcbdisconnect(struct inpcb *);
356 void in_pcbdrop(struct inpcb *);
357 void in_pcbfree(struct inpcb *);
358 int in_pcbinshash(struct inpcb *);
360 in_pcblookup_local(struct inpcbinfo *,
361 struct in_addr, u_int, int);
363 in_pcblookup_hash(struct inpcbinfo *, struct in_addr, u_int,
364 struct in_addr, u_int, int, struct ifnet *);
365 void in_pcbnotifyall(struct inpcbinfo *pcbinfo, struct in_addr,
366 int, struct inpcb *(*)(struct inpcb *, int));
367 void in_pcbrehash(struct inpcb *);
368 void in_pcbsetsolabel(struct socket *so);
369 int in_setpeeraddr(struct socket *so, struct sockaddr **nam, struct inpcbinfo *pcbinfo);
370 int in_setsockaddr(struct socket *so, struct sockaddr **nam, struct inpcbinfo *pcbinfo);
372 in_sockaddr(in_port_t port, struct in_addr *addr);
373 void in_pcbsosetlabel(struct socket *so);
374 void in_pcbremlists(struct inpcb *inp);
375 void ipport_tick(void *xtp);
378 #endif /* !_NETINET_IN_PCB_H_ */