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