FreeBSD/Linux Kernel Cross Reference
sys/sys/protosw.h
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 * 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.
16 *
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
27 * SUCH DAMAGE.
28 *
29 * @(#)protosw.h 8.1 (Berkeley) 6/2/93
30 * $FreeBSD: releng/6.1/sys/sys/protosw.h 158179 2006-04-30 16:44:43Z cvs2svn $
31 */
32
33 #ifndef _SYS_PROTOSW_H_
34 #define _SYS_PROTOSW_H_
35
36 /* Forward declare these structures referenced from prototypes below. */
37 struct mbuf;
38 struct thread;
39 struct sockaddr;
40 struct socket;
41 struct sockopt;
42
43 /*#ifdef _KERNEL*/
44 /*
45 * Protocol switch table.
46 *
47 * Each protocol has a handle initializing one of these structures,
48 * which is used for protocol-protocol and system-protocol communication.
49 *
50 * A protocol is called through the pr_init entry before any other.
51 * Thereafter it is called every 200ms through the pr_fasttimo entry and
52 * every 500ms through the pr_slowtimo for timer based actions.
53 * The system will call the pr_drain entry if it is low on space and
54 * this should throw away any non-critical data.
55 *
56 * Protocols pass data between themselves as chains of mbufs using
57 * the pr_input and pr_output hooks. Pr_input passes data up (towards
58 * the users) and pr_output passes it down (towards the interfaces); control
59 * information passes up and down on pr_ctlinput and pr_ctloutput.
60 * The protocol is responsible for the space occupied by any the
61 * arguments to these entries and must dispose it.
62 *
63 * In retrospect, it would be a lot nicer to use an interface
64 * similar to the vnode VOP interface.
65 */
66 /* USE THESE FOR YOUR PROTOTYPES ! */
67 typedef void pr_input_t (struct mbuf *, int);
68 typedef int pr_input6_t (struct mbuf **, int*, int); /* XXX FIX THIS */
69 typedef void pr_in_input_t (struct mbuf *, int, int); /* XXX FIX THIS */
70 typedef int pr_output_t (struct mbuf *, struct socket *);
71 typedef int pr_in_output_t (struct mbuf *, struct socket *, struct sockaddr *);
72 typedef void pr_ctlinput_t (int, struct sockaddr *, void *);
73 typedef int pr_ctloutput_t (struct socket *, struct sockopt *);
74 typedef void pr_init_t (void);
75 typedef void pr_fasttimo_t (void);
76 typedef void pr_slowtimo_t (void);
77 typedef void pr_drain_t (void);
78
79 typedef int pr_usrreq_t(struct socket *, int, struct mbuf *,
80 struct mbuf *, struct mbuf *, struct thread *);
81
82 struct protosw {
83 short pr_type; /* socket type used for */
84 struct domain *pr_domain; /* domain protocol a member of */
85 short pr_protocol; /* protocol number */
86 short pr_flags; /* see below */
87 /* protocol-protocol hooks */
88 pr_input_t *pr_input; /* input to protocol (from below) */
89 pr_output_t *pr_output; /* output to protocol (from above) */
90 pr_ctlinput_t *pr_ctlinput; /* control input (from below) */
91 pr_ctloutput_t *pr_ctloutput; /* control output (from above) */
92 /* user-protocol hook */
93 pr_usrreq_t *pr_ousrreq;
94 /* utility hooks */
95 pr_init_t *pr_init;
96 pr_fasttimo_t *pr_fasttimo; /* fast timeout (200ms) */
97 pr_slowtimo_t *pr_slowtimo; /* slow timeout (500ms) */
98 pr_drain_t *pr_drain; /* flush any excess space possible */
99
100 struct pr_usrreqs *pr_usrreqs; /* supersedes pr_usrreq() */
101 };
102 /*#endif*/
103
104 #define PR_SLOWHZ 2 /* 2 slow timeouts per second */
105 #define PR_FASTHZ 5 /* 5 fast timeouts per second */
106
107 /*
108 * This number should be defined again within each protocol family to avoid
109 * confusion.
110 */
111 #define PROTO_SPACER 32767 /* spacer for loadable protocols */
112
113 /*
114 * Values for pr_flags.
115 * PR_ADDR requires PR_ATOMIC;
116 * PR_ADDR and PR_CONNREQUIRED are mutually exclusive.
117 * PR_IMPLOPCL means that the protocol allows sendto without prior connect,
118 * and the protocol understands the MSG_EOF flag. The first property is
119 * is only relevant if PR_CONNREQUIRED is set (otherwise sendto is allowed
120 * anyhow).
121 */
122 #define PR_ATOMIC 0x01 /* exchange atomic messages only */
123 #define PR_ADDR 0x02 /* addresses given with messages */
124 #define PR_CONNREQUIRED 0x04 /* connection required by protocol */
125 #define PR_WANTRCVD 0x08 /* want PRU_RCVD calls */
126 #define PR_RIGHTS 0x10 /* passes capabilities */
127 #define PR_IMPLOPCL 0x20 /* implied open/close */
128 #define PR_LASTHDR 0x40 /* enforce ipsec policy; last header */
129
130 /*
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 an 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.
141 */
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 /* begin for protocols internal use */
161 #define PRU_FASTTIMO 18 /* 200ms timeout */
162 #define PRU_SLOWTIMO 19 /* 500ms timeout */
163 #define PRU_PROTORCV 20 /* receive from below */
164 #define PRU_PROTOSEND 21 /* send to below */
165 /* end for protocol's internal use */
166 #define PRU_SEND_EOF 22 /* send and close */
167 #define PRU_NREQ 22
168
169 #ifdef PRUREQUESTS
170 const char *prurequests[] = {
171 "ATTACH", "DETACH", "BIND", "LISTEN",
172 "CONNECT", "ACCEPT", "DISCONNECT", "SHUTDOWN",
173 "RCVD", "SEND", "ABORT", "CONTROL",
174 "SENSE", "RCVOOB", "SENDOOB", "SOCKADDR",
175 "PEERADDR", "CONNECT2", "FASTTIMO", "SLOWTIMO",
176 "PROTORCV", "PROTOSEND",
177 "SEND_EOF",
178 };
179 #endif
180
181 #ifdef _KERNEL /* users shouldn't see this decl */
182
183 struct ifnet;
184 struct stat;
185 struct ucred;
186 struct uio;
187
188 /*
189 * If the ordering here looks odd, that's because it's alphabetical.
190 * Having this structure separated out from the main protoswitch is allegedly
191 * a big (12 cycles per call) lose on high-end CPUs. We will eventually
192 * migrate this stuff back into the main structure.
193 *
194 * Some fields initialized to defaults if they are NULL.
195 * See uipc_domain.c:net_init_domain()
196 */
197 struct pr_usrreqs {
198 double __Break_the_struct_layout_for_now;
199 int (*pru_abort)(struct socket *so);
200 int (*pru_accept)(struct socket *so, struct sockaddr **nam);
201 int (*pru_attach)(struct socket *so, int proto, struct thread *td);
202 int (*pru_bind)(struct socket *so, struct sockaddr *nam,
203 struct thread *td);
204 int (*pru_connect)(struct socket *so, struct sockaddr *nam,
205 struct thread *td);
206 int (*pru_connect2)(struct socket *so1, struct socket *so2);
207 int (*pru_control)(struct socket *so, u_long cmd, caddr_t data,
208 struct ifnet *ifp, struct thread *td);
209 int (*pru_detach)(struct socket *so);
210 int (*pru_disconnect)(struct socket *so);
211 int (*pru_listen)(struct socket *so, struct thread *td);
212 int (*pru_peeraddr)(struct socket *so, struct sockaddr **nam);
213 int (*pru_rcvd)(struct socket *so, int flags);
214 int (*pru_rcvoob)(struct socket *so, struct mbuf *m, int flags);
215 int (*pru_send)(struct socket *so, int flags, struct mbuf *m,
216 struct sockaddr *addr, struct mbuf *control,
217 struct thread *td);
218 #define PRUS_OOB 0x1
219 #define PRUS_EOF 0x2
220 #define PRUS_MORETOCOME 0x4
221 int (*pru_sense)(struct socket *so, struct stat *sb);
222 int (*pru_shutdown)(struct socket *so);
223 int (*pru_sockaddr)(struct socket *so, struct sockaddr **nam);
224
225 /*
226 * These three added later, so they are out of order. They are used
227 * for shortcutting (fast path input/output) in some protocols.
228 * XXX - that's a lie, they are not implemented yet
229 * Rather than calling sosend() etc. directly, calls are made
230 * through these entry points. For protocols which still use
231 * the generic code, these just point to those routines.
232 */
233 int (*pru_sosend)(struct socket *so, struct sockaddr *addr,
234 struct uio *uio, struct mbuf *top, struct mbuf *control,
235 int flags, struct thread *td);
236 int (*pru_soreceive)(struct socket *so, struct sockaddr **paddr,
237 struct uio *uio, struct mbuf **mp0, struct mbuf **controlp,
238 int *flagsp);
239 int (*pru_sopoll)(struct socket *so, int events,
240 struct ucred *cred, struct thread *td);
241 void (*pru_sosetlabel)(struct socket *so);
242 };
243
244 /*
245 * The dummy protocol specific user requests function pointer array is
246 * initialized to the functions below. All functions return EOPNOTSUPP.
247 */
248 extern struct pr_usrreqs nousrreqs;
249
250 int pru_abort_notsupp(struct socket *so);
251 int pru_accept_notsupp(struct socket *so, struct sockaddr **nam);
252 int pru_attach_notsupp(struct socket *so, int proto, struct thread *td);
253 int pru_bind_notsupp(struct socket *so, struct sockaddr *nam,
254 struct thread *td);
255 int pru_connect_notsupp(struct socket *so, struct sockaddr *nam,
256 struct thread *td);
257 int pru_connect2_notsupp(struct socket *so1, struct socket *so2);
258 int pru_control_notsupp(struct socket *so, u_long cmd, caddr_t data,
259 struct ifnet *ifp, struct thread *td);
260 int pru_detach_notsupp(struct socket *so);
261 int pru_disconnect_notsupp(struct socket *so);
262 int pru_listen_notsupp(struct socket *so, struct thread *td);
263 int pru_peeraddr_notsupp(struct socket *so, struct sockaddr **nam);
264 int pru_rcvd_notsupp(struct socket *so, int flags);
265 int pru_rcvoob_notsupp(struct socket *so, struct mbuf *m, int flags);
266 int pru_send_notsupp(struct socket *so, int flags, struct mbuf *m,
267 struct sockaddr *addr, struct mbuf *control, struct thread *td);
268 int pru_sense_null(struct socket *so, struct stat *sb);
269 int pru_shutdown_notsupp(struct socket *so);
270 int pru_sockaddr_notsupp(struct socket *so, struct sockaddr **nam);
271 int pru_sosend_notsupp(struct socket *so, struct sockaddr *addr,
272 struct uio *uio, struct mbuf *top, struct mbuf *control, int flags,
273 struct thread *td);
274 int pru_soreceive_notsupp(struct socket *so, struct sockaddr **paddr,
275 struct uio *uio, struct mbuf **mp0, struct mbuf **controlp,
276 int *flagsp);
277 int pru_sopoll_notsupp(struct socket *so, int events, struct ucred *cred,
278 struct thread *td);
279 void pru_sosetlabel_null(struct socket *so);
280
281 #endif /* _KERNEL */
282
283 /*
284 * The arguments to the ctlinput routine are
285 * (*protosw[].pr_ctlinput)(cmd, sa, arg);
286 * where cmd is one of the commands below, sa is a pointer to a sockaddr,
287 * and arg is a `void *' argument used within a protocol family.
288 */
289 #define PRC_IFDOWN 0 /* interface transition */
290 #define PRC_ROUTEDEAD 1 /* select new route if possible ??? */
291 #define PRC_IFUP 2 /* interface has come back up */
292 #define PRC_QUENCH2 3 /* DEC congestion bit says slow down */
293 #define PRC_QUENCH 4 /* some one said to slow down */
294 #define PRC_MSGSIZE 5 /* message size forced drop */
295 #define PRC_HOSTDEAD 6 /* host appears to be down */
296 #define PRC_HOSTUNREACH 7 /* deprecated (use PRC_UNREACH_HOST) */
297 #define PRC_UNREACH_NET 8 /* no route to network */
298 #define PRC_UNREACH_HOST 9 /* no route to host */
299 #define PRC_UNREACH_PROTOCOL 10 /* dst says bad protocol */
300 #define PRC_UNREACH_PORT 11 /* bad port # */
301 /* was PRC_UNREACH_NEEDFRAG 12 (use PRC_MSGSIZE) */
302 #define PRC_UNREACH_SRCFAIL 13 /* source route failed */
303 #define PRC_REDIRECT_NET 14 /* net routing redirect */
304 #define PRC_REDIRECT_HOST 15 /* host routing redirect */
305 #define PRC_REDIRECT_TOSNET 16 /* redirect for type of service & net */
306 #define PRC_REDIRECT_TOSHOST 17 /* redirect for tos & host */
307 #define PRC_TIMXCEED_INTRANS 18 /* packet lifetime expired in transit */
308 #define PRC_TIMXCEED_REASS 19 /* lifetime expired on reass q */
309 #define PRC_PARAMPROB 20 /* header incorrect */
310 #define PRC_UNREACH_ADMIN_PROHIB 21 /* packet administrativly prohibited */
311
312 #define PRC_NCMDS 22
313
314 #define PRC_IS_REDIRECT(cmd) \
315 ((cmd) >= PRC_REDIRECT_NET && (cmd) <= PRC_REDIRECT_TOSHOST)
316
317 #ifdef PRCREQUESTS
318 char *prcrequests[] = {
319 "IFDOWN", "ROUTEDEAD", "IFUP", "DEC-BIT-QUENCH2",
320 "QUENCH", "MSGSIZE", "HOSTDEAD", "#7",
321 "NET-UNREACH", "HOST-UNREACH", "PROTO-UNREACH", "PORT-UNREACH",
322 "#12", "SRCFAIL-UNREACH", "NET-REDIRECT", "HOST-REDIRECT",
323 "TOSNET-REDIRECT", "TOSHOST-REDIRECT", "TX-INTRANS", "TX-REASS",
324 "PARAMPROB", "ADMIN-UNREACH"
325 };
326 #endif
327
328 /*
329 * The arguments to ctloutput are:
330 * (*protosw[].pr_ctloutput)(req, so, level, optname, optval, p);
331 * req is one of the actions listed below, so is a (struct socket *),
332 * level is an indication of which protocol layer the option is intended.
333 * optname is a protocol dependent socket option request,
334 * optval is a pointer to a mbuf-chain pointer, for value-return results.
335 * The protocol is responsible for disposal of the mbuf chain *optval
336 * if supplied,
337 * the caller is responsible for any space held by *optval, when returned.
338 * A non-zero return from usrreq gives an
339 * UNIX error number which should be passed to higher level software.
340 */
341 #define PRCO_GETOPT 0
342 #define PRCO_SETOPT 1
343
344 #define PRCO_NCMDS 2
345
346 #ifdef PRCOREQUESTS
347 char *prcorequests[] = {
348 "GETOPT", "SETOPT",
349 };
350 #endif
351
352 #ifdef _KERNEL
353 void pfctlinput(int, struct sockaddr *);
354 void pfctlinput2(int, struct sockaddr *, void *);
355 struct protosw *pffindproto(int family, int protocol, int type);
356 struct protosw *pffindtype(int family, int type);
357 int pf_proto_register(int family, struct protosw *npr);
358 int pf_proto_unregister(int family, int protocol, int type);
359 #endif
360
361 #endif
Cache object: 77a13dea46dda8e09d81716cd8dc67d2
|