Once we distribute socket protocol processing requests to different
[dragonfly.git] / sys / sys / protosw.h
CommitLineData
984263bc
MD
1/*-
2 * Copyright (c) 1982, 1986, 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 * @(#)protosw.h 8.1 (Berkeley) 6/2/93
34 * $FreeBSD: src/sys/sys/protosw.h,v 1.28.2.2 2001/07/03 11:02:01 ume Exp $
e4700d00 35 * $DragonFly: src/sys/sys/protosw.h,v 1.6 2004/03/05 16:57:16 hsu Exp $
984263bc
MD
36 */
37
38#ifndef _SYS_PROTOSW_H_
39#define _SYS_PROTOSW_H_
40
41/* Forward declare these structures referenced from prototypes below. */
42struct mbuf;
dadab5e9 43struct thread;
984263bc
MD
44struct sockaddr;
45struct socket;
46struct sockopt;
47
48/*#ifdef _KERNEL*/
49/*
50 * Protocol switch table.
51 *
52 * Each protocol has a handle initializing one of these structures,
53 * which is used for protocol-protocol and system-protocol communication.
54 *
55 * A protocol is called through the pr_init entry before any other.
56 * Thereafter it is called every 200ms through the pr_fasttimo entry and
57 * every 500ms through the pr_slowtimo for timer based actions.
58 * The system will call the pr_drain entry if it is low on space and
59 * this should throw away any non-critical data.
60 *
61 * Protocols pass data between themselves as chains of mbufs using
62 * the pr_input and pr_output hooks. Pr_input passes data up (towards
63 * the users) and pr_output passes it down (towards the interfaces); control
64 * information passes up and down on pr_ctlinput and pr_ctloutput.
65 * The protocol is responsible for the space occupied by any the
66 * arguments to these entries and must dispose it.
67 *
68 * In retrospect, it would be a lot nicer to use an interface
69 * similar to the vnode VOP interface.
70 */
71struct protosw {
72 short pr_type; /* socket type used for */
73 struct domain *pr_domain; /* domain protocol a member of */
74 short pr_protocol; /* protocol number */
75 short pr_flags; /* see below */
76/* protocol-protocol hooks */
005f09fe 77 void (*pr_input) (struct mbuf *, int);
984263bc 78 /* input to protocol (from below) */
005f09fe 79 int (*pr_output) (struct mbuf *, struct socket *);
984263bc 80 /* output to protocol (from above) */
b153f746 81 void (*pr_ctlinput)(int, struct sockaddr *, void *);
984263bc 82 /* control input (from below) */
b153f746 83 int (*pr_ctloutput)(struct socket *, struct sockopt *);
984263bc
MD
84 /* control output (from above) */
85/* user-protocol hook */
86 void *pr_ousrreq;
87/* utility hooks */
b153f746
RG
88 void (*pr_init) (void); /* initialization hook */
89 void (*pr_fasttimo) (void);
984263bc 90 /* fast timeout (200ms) */
b153f746 91 void (*pr_slowtimo) (void);
984263bc 92 /* slow timeout (500ms) */
b153f746 93 void (*pr_drain) (void);
984263bc
MD
94 /* flush any excess space possible */
95 struct pr_usrreqs *pr_usrreqs; /* supersedes pr_usrreq() */
96};
97/*#endif*/
98
99#define PR_SLOWHZ 2 /* 2 slow timeouts per second */
100#define PR_FASTHZ 5 /* 5 fast timeouts per second */
101
102/*
103 * Values for pr_flags.
104 * PR_ADDR requires PR_ATOMIC;
105 * PR_ADDR and PR_CONNREQUIRED are mutually exclusive.
106 * PR_IMPLOPCL means that the protocol allows sendto without prior connect,
107 * and the protocol understands the MSG_EOF flag. The first property is
108 * is only relevant if PR_CONNREQUIRED is set (otherwise sendto is allowed
109 * anyhow).
110 */
111#define PR_ATOMIC 0x01 /* exchange atomic messages only */
112#define PR_ADDR 0x02 /* addresses given with messages */
113#define PR_CONNREQUIRED 0x04 /* connection required by protocol */
114#define PR_WANTRCVD 0x08 /* want PRU_RCVD calls */
115#define PR_RIGHTS 0x10 /* passes capabilities */
116#define PR_IMPLOPCL 0x20 /* implied open/close */
117#define PR_LASTHDR 0x40 /* enforce ipsec policy; last header */
118
119/*
120 * The arguments to usrreq are:
121 * (*protosw[].pr_usrreq)(up, req, m, nam, opt);
122 * where up is a (struct socket *), req is one of these requests,
123 * m is a optional mbuf chain containing a message,
124 * nam is an optional mbuf chain containing an address,
125 * and opt is a pointer to a socketopt structure or nil.
126 * The protocol is responsible for disposal of the mbuf chain m,
127 * the caller is responsible for any space held by nam and opt.
128 * A non-zero return from usrreq gives an
129 * UNIX error number which should be passed to higher level software.
130 */
131#define PRU_ATTACH 0 /* attach protocol to up */
132#define PRU_DETACH 1 /* detach protocol from up */
133#define PRU_BIND 2 /* bind socket to address */
134#define PRU_LISTEN 3 /* listen for connection */
135#define PRU_CONNECT 4 /* establish connection to peer */
136#define PRU_ACCEPT 5 /* accept connection from peer */
137#define PRU_DISCONNECT 6 /* disconnect from peer */
138#define PRU_SHUTDOWN 7 /* won't send any more data */
139#define PRU_RCVD 8 /* have taken data; more room now */
140#define PRU_SEND 9 /* send this data */
141#define PRU_ABORT 10 /* abort (fast DISCONNECT, DETATCH) */
142#define PRU_CONTROL 11 /* control operations on protocol */
143#define PRU_SENSE 12 /* return status into m */
144#define PRU_RCVOOB 13 /* retrieve out of band data */
145#define PRU_SENDOOB 14 /* send out of band data */
146#define PRU_SOCKADDR 15 /* fetch socket's address */
147#define PRU_PEERADDR 16 /* fetch peer's address */
148#define PRU_CONNECT2 17 /* connect two sockets */
149/* begin for protocols internal use */
150#define PRU_FASTTIMO 18 /* 200ms timeout */
151#define PRU_SLOWTIMO 19 /* 500ms timeout */
152#define PRU_PROTORCV 20 /* receive from below */
153#define PRU_PROTOSEND 21 /* send to below */
154/* end for protocol's internal use */
155#define PRU_SEND_EOF 22 /* send and close */
156#define PRU_NREQ 22
157
158#ifdef PRUREQUESTS
159char *prurequests[] = {
160 "ATTACH", "DETACH", "BIND", "LISTEN",
161 "CONNECT", "ACCEPT", "DISCONNECT", "SHUTDOWN",
162 "RCVD", "SEND", "ABORT", "CONTROL",
163 "SENSE", "RCVOOB", "SENDOOB", "SOCKADDR",
164 "PEERADDR", "CONNECT2", "FASTTIMO", "SLOWTIMO",
165 "PROTORCV", "PROTOSEND",
166 "SEND_EOF",
167};
168#endif
169
170#ifdef _KERNEL /* users shouldn't see this decl */
171
172struct ifnet;
173struct stat;
174struct ucred;
175struct uio;
176
e4700d00
JH
177struct pru_attach_info {
178 struct rlimit *sb_rlimit;
179 struct ucred *p_ucred;
180 struct vnode *fd_rdir;
181};
182
984263bc
MD
183/*
184 * If the ordering here looks odd, that's because it's alphabetical.
185 * Having this structure separated out from the main protoswitch is allegedly
186 * a big (12 cycles per call) lose on high-end CPUs. We will eventually
187 * migrate this stuff back into the main structure.
188 */
189struct pr_usrreqs {
b153f746
RG
190 int (*pru_abort) (struct socket *so);
191 int (*pru_accept) (struct socket *so, struct sockaddr **nam);
192 int (*pru_attach) (struct socket *so, int proto,
e4700d00 193 struct pru_attach_info *ai);
b153f746
RG
194 int (*pru_bind) (struct socket *so, struct sockaddr *nam,
195 struct thread *td);
196 int (*pru_connect) (struct socket *so, struct sockaddr *nam,
197 struct thread *td);
198 int (*pru_connect2) (struct socket *so1, struct socket *so2);
199 int (*pru_control) (struct socket *so, u_long cmd, caddr_t data,
200 struct ifnet *ifp, struct thread *td);
201 int (*pru_detach) (struct socket *so);
202 int (*pru_disconnect) (struct socket *so);
203 int (*pru_listen) (struct socket *so, struct thread *td);
204 int (*pru_peeraddr) (struct socket *so,
205 struct sockaddr **nam);
206 int (*pru_rcvd) (struct socket *so, int flags);
207 int (*pru_rcvoob) (struct socket *so, struct mbuf *m,
208 int flags);
209 int (*pru_send) (struct socket *so, int flags, struct mbuf *m,
984263bc 210 struct sockaddr *addr, struct mbuf *control,
b153f746 211 struct thread *td);
984263bc
MD
212#define PRUS_OOB 0x1
213#define PRUS_EOF 0x2
214#define PRUS_MORETOCOME 0x4
b153f746
RG
215 int (*pru_sense) (struct socket *so, struct stat *sb);
216 int (*pru_shutdown) (struct socket *so);
217 int (*pru_sockaddr) (struct socket *so,
218 struct sockaddr **nam);
984263bc
MD
219
220 /*
221 * These three added later, so they are out of order. They are used
222 * for shortcutting (fast path input/output) in some protocols.
223 * XXX - that's a lie, they are not implemented yet
224 * Rather than calling sosend() etc. directly, calls are made
225 * through these entry points. For protocols which still use
226 * the generic code, these just point to those routines.
227 */
b153f746 228 int (*pru_sosend) (struct socket *so, struct sockaddr *addr,
984263bc
MD
229 struct uio *uio, struct mbuf *top,
230 struct mbuf *control, int flags,
b153f746
RG
231 struct thread *td);
232 int (*pru_soreceive) (struct socket *so,
984263bc
MD
233 struct sockaddr **paddr,
234 struct uio *uio, struct mbuf **mp0,
b153f746
RG
235 struct mbuf **controlp, int *flagsp);
236 int (*pru_sopoll) (struct socket *so, int events,
237 struct ucred *cred, struct thread *td);
984263bc
MD
238};
239
b153f746
RG
240int pru_accept_notsupp (struct socket *so, struct sockaddr **nam);
241int pru_connect_notsupp (struct socket *so, struct sockaddr *nam,
242 struct thread *td);
243int pru_connect2_notsupp (struct socket *so1, struct socket *so2);
244int pru_control_notsupp (struct socket *so, u_long cmd, caddr_t data,
245 struct ifnet *ifp, struct thread *td);
246int pru_listen_notsupp (struct socket *so, struct thread *td);
247int pru_rcvd_notsupp (struct socket *so, int flags);
248int pru_rcvoob_notsupp (struct socket *so, struct mbuf *m, int flags);
249int pru_sense_null (struct socket *so, struct stat *sb);
984263bc
MD
250
251#endif /* _KERNEL */
252
253/*
254 * The arguments to the ctlinput routine are
255 * (*protosw[].pr_ctlinput)(cmd, sa, arg);
256 * where cmd is one of the commands below, sa is a pointer to a sockaddr,
257 * and arg is a `void *' argument used within a protocol family.
258 */
259#define PRC_IFDOWN 0 /* interface transition */
260#define PRC_ROUTEDEAD 1 /* select new route if possible ??? */
261#define PRC_IFUP 2 /* interface has come back up */
262#define PRC_QUENCH2 3 /* DEC congestion bit says slow down */
263#define PRC_QUENCH 4 /* some one said to slow down */
264#define PRC_MSGSIZE 5 /* message size forced drop */
265#define PRC_HOSTDEAD 6 /* host appears to be down */
266#define PRC_HOSTUNREACH 7 /* deprecated (use PRC_UNREACH_HOST) */
267#define PRC_UNREACH_NET 8 /* no route to network */
268#define PRC_UNREACH_HOST 9 /* no route to host */
269#define PRC_UNREACH_PROTOCOL 10 /* dst says bad protocol */
270#define PRC_UNREACH_PORT 11 /* bad port # */
271/* was PRC_UNREACH_NEEDFRAG 12 (use PRC_MSGSIZE) */
272#define PRC_UNREACH_SRCFAIL 13 /* source route failed */
273#define PRC_REDIRECT_NET 14 /* net routing redirect */
274#define PRC_REDIRECT_HOST 15 /* host routing redirect */
275#define PRC_REDIRECT_TOSNET 16 /* redirect for type of service & net */
276#define PRC_REDIRECT_TOSHOST 17 /* redirect for tos & host */
277#define PRC_TIMXCEED_INTRANS 18 /* packet lifetime expired in transit */
278#define PRC_TIMXCEED_REASS 19 /* lifetime expired on reass q */
279#define PRC_PARAMPROB 20 /* header incorrect */
280#define PRC_UNREACH_ADMIN_PROHIB 21 /* packet administrativly prohibited */
281
282#define PRC_NCMDS 22
283
284#define PRC_IS_REDIRECT(cmd) \
285 ((cmd) >= PRC_REDIRECT_NET && (cmd) <= PRC_REDIRECT_TOSHOST)
286
287#ifdef PRCREQUESTS
288char *prcrequests[] = {
289 "IFDOWN", "ROUTEDEAD", "IFUP", "DEC-BIT-QUENCH2",
290 "QUENCH", "MSGSIZE", "HOSTDEAD", "#7",
291 "NET-UNREACH", "HOST-UNREACH", "PROTO-UNREACH", "PORT-UNREACH",
292 "#12", "SRCFAIL-UNREACH", "NET-REDIRECT", "HOST-REDIRECT",
293 "TOSNET-REDIRECT", "TOSHOST-REDIRECT", "TX-INTRANS", "TX-REASS",
294 "PARAMPROB", "ADMIN-UNREACH"
295};
296#endif
297
298/*
299 * The arguments to ctloutput are:
300 * (*protosw[].pr_ctloutput)(req, so, level, optname, optval, p);
301 * req is one of the actions listed below, so is a (struct socket *),
302 * level is an indication of which protocol layer the option is intended.
303 * optname is a protocol dependent socket option request,
304 * optval is a pointer to a mbuf-chain pointer, for value-return results.
305 * The protocol is responsible for disposal of the mbuf chain *optval
306 * if supplied,
307 * the caller is responsible for any space held by *optval, when returned.
308 * A non-zero return from usrreq gives an
309 * UNIX error number which should be passed to higher level software.
310 */
311#define PRCO_GETOPT 0
312#define PRCO_SETOPT 1
313
314#define PRCO_NCMDS 2
315
316#ifdef PRCOREQUESTS
317char *prcorequests[] = {
318 "GETOPT", "SETOPT",
319};
320#endif
321
322#ifdef _KERNEL
b153f746
RG
323void pfctlinput (int, struct sockaddr *);
324void pfctlinput2 (int, struct sockaddr *, void *);
325struct protosw *pffindproto (int family, int protocol, int type);
326struct protosw *pffindtype (int family, int type);
984263bc
MD
327#endif
328
329#endif