proc->thread stage 4: rework the VFS and DEVICE subsystems to take thread
[dragonfly.git] / sys / netinet / in_pcb.h
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: src/sys/netinet/in_pcb.h,v 1.32.2.7 2003/01/24 05:11:34 sam Exp $
35  * $DragonFly: src/sys/netinet/in_pcb.h,v 1.3 2003/06/25 03:56:04 dillon Exp $
36  */
37
38 #ifndef _NETINET_IN_PCB_H_
39 #define _NETINET_IN_PCB_H_
40
41 #include <sys/queue.h>
42
43 #include <net/route.h>
44
45 #define in6pcb          inpcb   /* for KAME src sync over BSD*'s */
46 #define in6p_sp         inp_sp  /* for KAME src sync over BSD*'s */
47 struct inpcbpolicy;
48
49 /*
50  * Common structure pcb for internet protocol implementation.
51  * Here are stored pointers to local and foreign host table
52  * entries, local and foreign socket numbers, and pointers
53  * up (to a socket structure) and down (to a protocol-specific)
54  * control block.
55  */
56 LIST_HEAD(inpcbhead, inpcb);
57 LIST_HEAD(inpcbporthead, inpcbport);
58 typedef u_quad_t        inp_gen_t;
59
60 /*
61  * PCB with AF_INET6 null bind'ed laddr can receive AF_INET input packet.
62  * So, AF_INET6 null laddr is also used as AF_INET null laddr,
63  * by utilize following structure. (At last, same as INRIA)
64  */
65 struct in_addr_4in6 {
66         u_int32_t       ia46_pad32[3];
67         struct  in_addr ia46_addr4;
68 };
69
70 /*
71  * NOTE: ipv6 addrs should be 64-bit aligned, per RFC 2553.
72  * in_conninfo has some extra padding to accomplish this.
73  */
74 struct in_endpoints {
75         u_int16_t       ie_fport;               /* foreign port */
76         u_int16_t       ie_lport;               /* local port */
77         /* protocol dependent part, local and foreign addr */
78         union {
79                 /* foreign host table entry */
80                 struct  in_addr_4in6 ie46_foreign;
81                 struct  in6_addr ie6_foreign;
82         } ie_dependfaddr;
83         union {
84                 /* local host table entry */
85                 struct  in_addr_4in6 ie46_local;
86                 struct  in6_addr ie6_local;
87         } ie_dependladdr;
88 #define ie_faddr        ie_dependfaddr.ie46_foreign.ia46_addr4
89 #define ie_laddr        ie_dependladdr.ie46_local.ia46_addr4
90 #define ie6_faddr       ie_dependfaddr.ie6_foreign
91 #define ie6_laddr       ie_dependladdr.ie6_local
92 };
93
94 /*
95  * XXX
96  * At some point struct route should possibly change to:
97  *   struct rtentry *rt
98  *   struct in_endpoints *ie; 
99  */
100 struct in_conninfo {
101         u_int8_t        inc_flags;
102         u_int8_t        inc_len;
103         u_int16_t       inc_pad;        /* XXX alignment for in_endpoints */
104         /* protocol dependent part; cached route */
105         struct  in_endpoints inc_ie;
106         union {
107                 /* placeholder for routing entry */
108                 struct  route inc4_route;
109                 struct  route_in6 inc6_route;
110         } inc_dependroute;
111 };
112 #define inc_isipv6      inc_flags       /* temp compatability */
113 #define inc_fport       inc_ie.ie_fport
114 #define inc_lport       inc_ie.ie_lport
115 #define inc_faddr       inc_ie.ie_faddr
116 #define inc_laddr       inc_ie.ie_laddr
117 #define inc_route       inc_dependroute.inc4_route
118 #define inc6_faddr      inc_ie.ie6_faddr
119 #define inc6_laddr      inc_ie.ie6_laddr
120 #define inc6_route      inc_dependroute.inc6_route
121
122 /*
123  * NB: the zone allocator is type-stable EXCEPT FOR THE FIRST TWO LONGS
124  * of the structure.  Therefore, it is important that the members in
125  * that position not contain any information which is required to be
126  * stable.
127  */
128 struct  icmp6_filter;
129
130 struct inpcb {
131         LIST_ENTRY(inpcb) inp_hash; /* hash list */
132         LIST_ENTRY(inpcb) inp_list; /* list for all PCBs of this proto */
133         u_int32_t       inp_flow;
134
135         /* local and foreign ports, local and foreign addr */
136         struct  in_conninfo inp_inc;
137
138         caddr_t inp_ppcb;               /* pointer to per-protocol pcb */
139         struct  inpcbinfo *inp_pcbinfo; /* PCB list info */
140         struct  socket *inp_socket;     /* back pointer to socket */
141                                         /* list for this PCB's local port */
142         int     inp_flags;              /* generic IP/datagram flags */
143
144         struct  inpcbpolicy *inp_sp; /* for IPSEC */
145         u_char  inp_vflag;
146 #define INP_IPV4        0x1
147 #define INP_IPV6        0x2
148         u_char  inp_ip_ttl;             /* time to live proto */
149         u_char  inp_ip_p;               /* protocol proto */
150
151         /* protocol dependent part; options */
152         struct {
153                 u_char  inp4_ip_tos;            /* type of service proto */
154                 struct  mbuf *inp4_options;     /* IP options */
155                 struct  ip_moptions *inp4_moptions; /* IP multicast options */
156         } inp_depend4;
157 #define inp_fport       inp_inc.inc_fport
158 #define inp_lport       inp_inc.inc_lport
159 #define inp_faddr       inp_inc.inc_faddr
160 #define inp_laddr       inp_inc.inc_laddr
161 #define inp_route       inp_inc.inc_route
162 #define inp_ip_tos      inp_depend4.inp4_ip_tos
163 #define inp_options     inp_depend4.inp4_options
164 #define inp_moptions    inp_depend4.inp4_moptions
165         struct {
166                 /* IP options */
167                 struct  mbuf *inp6_options;
168                 /* IP6 options for outgoing packets */
169                 struct  ip6_pktopts *inp6_outputopts;
170                 /* IP multicast options */
171                 struct  ip6_moptions *inp6_moptions;
172                 /* ICMPv6 code type filter */
173                 struct  icmp6_filter *inp6_icmp6filt;
174                 /* IPV6_CHECKSUM setsockopt */
175                 int     inp6_cksum;
176                 u_short inp6_ifindex;
177                 short   inp6_hops;
178                 u_int8_t        inp6_hlim;
179         } inp_depend6;
180         LIST_ENTRY(inpcb) inp_portlist;
181         struct  inpcbport *inp_phd;     /* head of this list */
182         inp_gen_t       inp_gencnt;     /* generation count of this instance */
183 #define in6p_faddr      inp_inc.inc6_faddr
184 #define in6p_laddr      inp_inc.inc6_laddr
185 #define in6p_route      inp_inc.inc6_route
186 #define in6p_ip6_hlim   inp_depend6.inp6_hlim
187 #define in6p_hops       inp_depend6.inp6_hops   /* default hop limit */
188 #define in6p_ip6_nxt    inp_ip_p
189 #define in6p_flowinfo   inp_flow
190 #define in6p_vflag      inp_vflag
191 #define in6p_options    inp_depend6.inp6_options
192 #define in6p_outputopts inp_depend6.inp6_outputopts
193 #define in6p_moptions   inp_depend6.inp6_moptions
194 #define in6p_icmp6filt  inp_depend6.inp6_icmp6filt
195 #define in6p_cksum      inp_depend6.inp6_cksum
196 #define inp6_ifindex    inp_depend6.inp6_ifindex
197 #define in6p_flags      inp_flags  /* for KAME src sync over BSD*'s */
198 #define in6p_socket     inp_socket  /* for KAME src sync over BSD*'s */
199 #define in6p_lport      inp_lport  /* for KAME src sync over BSD*'s */
200 #define in6p_fport      inp_fport  /* for KAME src sync over BSD*'s */
201 #define in6p_ppcb       inp_ppcb  /* for KAME src sync over BSD*'s */
202 };
203 /*
204  * The range of the generation count, as used in this implementation,
205  * is 9e19.  We would have to create 300 billion connections per
206  * second for this number to roll over in a year.  This seems sufficiently
207  * unlikely that we simply don't concern ourselves with that possibility.
208  */
209
210 /*
211  * Interface exported to userland by various protocols which use
212  * inpcbs.  Hack alert -- only define if struct xsocket is in scope.
213  */
214 #ifdef _SYS_SOCKETVAR_H_
215 struct  xinpcb {
216         size_t  xi_len;         /* length of this structure */
217         struct  inpcb xi_inp;
218         struct  xsocket xi_socket;
219         u_quad_t        xi_alignment_hack;
220 };
221
222 struct  xinpgen {
223         size_t  xig_len;        /* length of this structure */
224         u_int   xig_count;      /* number of PCBs at this time */
225         inp_gen_t xig_gen;      /* generation count at this time */
226         so_gen_t xig_sogen;     /* socket generation count at this time */
227 };
228 #endif /* _SYS_SOCKETVAR_H_ */
229
230 struct inpcbport {
231         LIST_ENTRY(inpcbport) phd_hash;
232         struct inpcbhead phd_pcblist;
233         u_short phd_port;
234 };
235
236 struct inpcbinfo {              /* XXX documentation, prefixes */
237         struct  inpcbhead *hashbase;
238         u_long  hashmask;
239         struct  inpcbporthead *porthashbase;
240         u_long  porthashmask;
241         struct  inpcbhead *listhead;
242         u_short lastport;
243         u_short lastlow;
244         u_short lasthi;
245         struct  vm_zone *ipi_zone; /* zone to allocate pcbs from */
246         u_int   ipi_count;      /* number of pcbs in this list */
247         u_quad_t ipi_gencnt;    /* current generation count */
248 };
249
250 #define INP_PCBHASH(faddr, lport, fport, mask) \
251         (((faddr) ^ ((faddr) >> 16) ^ ntohs((lport) ^ (fport))) & (mask))
252 #define INP_PCBPORTHASH(lport, mask) \
253         (ntohs((lport)) & (mask))
254
255 /* flags in inp_flags: */
256 #define INP_RECVOPTS            0x01    /* receive incoming IP options */
257 #define INP_RECVRETOPTS         0x02    /* receive IP options for reply */
258 #define INP_RECVDSTADDR         0x04    /* receive IP dst address */
259 #define INP_HDRINCL             0x08    /* user supplies entire IP header */
260 #define INP_HIGHPORT            0x10    /* user wants "high" port binding */
261 #define INP_LOWPORT             0x20    /* user wants "low" port binding */
262 #define INP_ANONPORT            0x40    /* port chosen for user */
263 #define INP_RECVIF              0x80    /* receive incoming interface */
264 #define INP_MTUDISC             0x100   /* user can do MTU discovery */
265 #define INP_FAITH               0x200   /* accept FAITH'ed connections */
266
267 #define IN6P_IPV6_V6ONLY        0x008000 /* restrict AF_INET6 socket for v6 */
268
269 #define IN6P_PKTINFO            0x010000 /* receive IP6 dst and I/F */
270 #define IN6P_HOPLIMIT           0x020000 /* receive hoplimit */
271 #define IN6P_HOPOPTS            0x040000 /* receive hop-by-hop options */
272 #define IN6P_DSTOPTS            0x080000 /* receive dst options after rthdr */
273 #define IN6P_RTHDR              0x100000 /* receive routing header */
274 #define IN6P_RTHDRDSTOPTS       0x200000 /* receive dstoptions before rthdr */
275 #define IN6P_AUTOFLOWLABEL      0x800000 /* attach flowlabel automatically */
276
277 #define INP_CONTROLOPTS         (INP_RECVOPTS|INP_RECVRETOPTS|INP_RECVDSTADDR|\
278                                         INP_RECVIF|\
279                                  IN6P_PKTINFO|IN6P_HOPLIMIT|IN6P_HOPOPTS|\
280                                  IN6P_DSTOPTS|IN6P_RTHDR|IN6P_RTHDRDSTOPTS|\
281                                  IN6P_AUTOFLOWLABEL)
282 #define INP_UNMAPPABLEOPTS      (IN6P_HOPOPTS|IN6P_DSTOPTS|IN6P_RTHDR|\
283                                  IN6P_AUTOFLOWLABEL)
284
285  /* for KAME src sync over BSD*'s */
286 #define IN6P_HIGHPORT           INP_HIGHPORT
287 #define IN6P_LOWPORT            INP_LOWPORT
288 #define IN6P_ANONPORT           INP_ANONPORT
289 #define IN6P_RECVIF             INP_RECVIF
290 #define IN6P_MTUDISC            INP_MTUDISC
291 #define IN6P_FAITH              INP_FAITH
292 #define IN6P_CONTROLOPTS INP_CONTROLOPTS
293         /*
294          * socket AF version is {newer than,or include}
295          * actual datagram AF version
296          */
297
298 #define INPLOOKUP_WILDCARD      1
299 #define sotoinpcb(so)   ((struct inpcb *)(so)->so_pcb)
300 #define sotoin6pcb(so)  sotoinpcb(so) /* for KAME src sync over BSD*'s */
301
302 #define INP_SOCKAF(so) so->so_proto->pr_domain->dom_family
303
304 #define INP_CHECK_SOCKAF(so, af)        (INP_SOCKAF(so) == af)
305
306 #ifdef _KERNEL
307 extern int      ipport_lowfirstauto;
308 extern int      ipport_lowlastauto;
309 extern int      ipport_firstauto;
310 extern int      ipport_lastauto;
311 extern int      ipport_hifirstauto;
312 extern int      ipport_hilastauto;
313
314 void    in_pcbpurgeif0 __P((struct inpcb *, struct ifnet *));
315 void    in_losing __P((struct inpcb *));
316 void    in_rtchange __P((struct inpcb *, int));
317 int     in_pcballoc __P((struct socket *, struct inpcbinfo *, struct thread *));
318 int     in_pcbbind __P((struct inpcb *, struct sockaddr *, struct thread *));
319 int     in_pcbconnect __P((struct inpcb *, struct sockaddr *, struct thread *));
320 void    in_pcbdetach __P((struct inpcb *));
321 void    in_pcbdisconnect __P((struct inpcb *));
322 int     in_pcbinshash __P((struct inpcb *));
323 int     in_pcbladdr __P((struct inpcb *, struct sockaddr *,
324             struct sockaddr_in **));
325 struct inpcb *
326         in_pcblookup_local __P((struct inpcbinfo *,
327             struct in_addr, u_int, int));
328 struct inpcb *
329         in_pcblookup_hash __P((struct inpcbinfo *,
330                                struct in_addr, u_int, struct in_addr, u_int,
331                                int, struct ifnet *));
332 void    in_pcbnotifyall __P((struct inpcbhead *, struct in_addr,
333             int, void (*)(struct inpcb *, int)));
334 void    in_pcbrehash __P((struct inpcb *));
335 int     in_setpeeraddr __P((struct socket *so, struct sockaddr **nam));
336 int     in_setsockaddr __P((struct socket *so, struct sockaddr **nam));
337 void    in_pcbremlists __P((struct inpcb *inp));
338 int     prison_xinpcb __P((struct thread *p, struct inpcb *inp));
339 #endif /* _KERNEL */
340
341 #endif /* !_NETINET_IN_PCB_H_ */