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