]> git.saurik.com Git - apple/xnu.git/blame - bsd/sys/protosw.h
xnu-1228.12.14.tar.gz
[apple/xnu.git] / bsd / sys / protosw.h
CommitLineData
1c79356b 1/*
2d21ac55 2 * Copyright (c) 2000-2006 Apple Computer, Inc. All rights reserved.
5d5c5d0d 3 *
2d21ac55 4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b 5 *
2d21ac55
A
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
8f6c56a5 14 *
2d21ac55
A
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
17 *
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
8f6c56a5
A
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55
A
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
8f6c56a5 25 *
2d21ac55 26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b
A
27 */
28/* Copyright (c) 1998, 1999 Apple Computer, Inc. All Rights Reserved */
29/* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
30/*
31 * Copyright (c) 1982, 1986, 1993
32 * The Regents of the University of California. All rights reserved.
33 *
34 * Redistribution and use in source and binary forms, with or without
35 * modification, are permitted provided that the following conditions
36 * are met:
37 * 1. Redistributions of source code must retain the above copyright
38 * notice, this list of conditions and the following disclaimer.
39 * 2. Redistributions in binary form must reproduce the above copyright
40 * notice, this list of conditions and the following disclaimer in the
41 * documentation and/or other materials provided with the distribution.
42 * 3. All advertising materials mentioning features or use of this software
43 * must display the following acknowledgement:
44 * This product includes software developed by the University of
45 * California, Berkeley and its contributors.
46 * 4. Neither the name of the University nor the names of its contributors
47 * may be used to endorse or promote products derived from this software
48 * without specific prior written permission.
49 *
50 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
51 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
52 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
53 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
54 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
55 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
56 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
57 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
58 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
59 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
60 * SUCH DAMAGE.
61 *
62 * @(#)protosw.h 8.1 (Berkeley) 6/2/93
9bccf70c 63 * $FreeBSD: src/sys/sys/protosw.h,v 1.28.2.2 2001/07/03 11:02:01 ume Exp $
1c79356b
A
64 */
65
9bccf70c
A
66#ifndef _SYS_PROTOSW_H_
67#define _SYS_PROTOSW_H_
68
91447636
A
69#include <sys/appleapiopts.h>
70#include <sys/cdefs.h>
71
72#define PR_SLOWHZ 2 /* 2 slow timeouts per second */
73#define PR_FASTHZ 5 /* 5 fast timeouts per second */
74
75#ifdef PRIVATE
76
9bccf70c
A
77/* Forward declare these structures referenced from prototypes below. */
78struct mbuf;
79struct proc;
80struct sockaddr;
81struct socket;
82struct sockopt;
91447636 83struct socket_filter;
9bccf70c
A
84
85/*#ifdef _KERNEL*/
1c79356b
A
86/*
87 * Protocol switch table.
88 *
89 * Each protocol has a handle initializing one of these structures,
90 * which is used for protocol-protocol and system-protocol communication.
91 *
92 * A protocol is called through the pr_init entry before any other.
93 * Thereafter it is called every 200ms through the pr_fasttimo entry and
94 * every 500ms through the pr_slowtimo for timer based actions.
95 * The system will call the pr_drain entry if it is low on space and
96 * this should throw away any non-critical data.
97 *
98 * Protocols pass data between themselves as chains of mbufs using
99 * the pr_input and pr_output hooks. Pr_input passes data up (towards
9bccf70c 100 * the users) and pr_output passes it down (towards the interfaces); control
1c79356b
A
101 * information passes up and down on pr_ctlinput and pr_ctloutput.
102 * The protocol is responsible for the space occupied by any the
103 * arguments to these entries and must dispose it.
104 *
105 * The userreq routine interfaces protocols to the system and is
106 * described below.
107 */
108
1c79356b
A
109#include <sys/socketvar.h>
110#include <sys/queue.h>
91447636
A
111#ifdef KERNEL
112#include <kern/locks.h>
113#endif /* KERNEL */
114
0c530ab8 115#pragma pack(4)
1c79356b
A
116
117struct protosw {
118 short pr_type; /* socket type used for */
119 struct domain *pr_domain; /* domain protocol a member of */
120 short pr_protocol; /* protocol number */
121 unsigned int pr_flags; /* see below */
122/* protocol-protocol hooks */
91447636 123 void (*pr_input)(struct mbuf *, int len);
1c79356b 124 /* input to protocol (from below) */
91447636 125 int (*pr_output)(struct mbuf *m, struct socket *so);
1c79356b 126 /* output to protocol (from above) */
91447636 127 void (*pr_ctlinput)(int, struct sockaddr *, void *);
1c79356b 128 /* control input (from below) */
91447636 129 int (*pr_ctloutput)(struct socket *, struct sockopt *);
1c79356b
A
130 /* control output (from above) */
131/* user-protocol hook */
132 void *pr_ousrreq;
133/* utility hooks */
91447636
A
134 void (*pr_init)(void); /* initialization hook */
135 void (*pr_fasttimo)(void);
1c79356b 136 /* fast timeout (200ms) */
91447636 137 void (*pr_slowtimo)(void);
1c79356b 138 /* slow timeout (500ms) */
91447636 139 void (*pr_drain)(void);
1c79356b 140 /* flush any excess space possible */
9bccf70c 141#if __APPLE__
91447636
A
142 int (*pr_sysctl)(int *, u_int, void *, size_t *, void *, size_t);
143 /* sysctl for protocol */
9bccf70c 144#endif
1c79356b 145 struct pr_usrreqs *pr_usrreqs; /* supersedes pr_usrreq() */
91447636
A
146#if __APPLE__
147 int (*pr_lock) (struct socket *so, int locktype, int debug); /* lock function for protocol */
148 int (*pr_unlock) (struct socket *so, int locktype, int debug); /* unlock for protocol */
149#ifdef _KERN_LOCKS_H_
150 lck_mtx_t * (*pr_getlock) (struct socket *so, int locktype);
151#else
152 void * (*pr_getlock) (struct socket *so, int locktype);
153#endif
154#endif
9bccf70c 155#if __APPLE__
1c79356b 156/* Implant hooks */
91447636 157 TAILQ_HEAD(, socket_filter) pr_filter_head;
1c79356b 158 struct protosw *pr_next; /* Chain for domain */
91447636 159 u_long reserved[1]; /* Padding for future use */
9bccf70c 160#endif
1c79356b
A
161};
162
0c530ab8 163#pragma pack()
1c79356b
A
164
165/*
166 * Values for pr_flags.
167 * PR_ADDR requires PR_ATOMIC;
168 * PR_ADDR and PR_CONNREQUIRED are mutually exclusive.
9bccf70c
A
169 * PR_IMPLOPCL means that the protocol allows sendto without prior connect,
170 * and the protocol understands the MSG_EOF flag. The first property is
171 * is only relevant if PR_CONNREQUIRED is set (otherwise sendto is allowed
172 * anyhow).
1c79356b 173 */
91447636
A
174#define PR_ATOMIC 0x01 /* exchange atomic messages only */
175#define PR_ADDR 0x02 /* addresses given with messages */
1c79356b 176#define PR_CONNREQUIRED 0x04 /* connection required by protocol */
91447636
A
177#define PR_WANTRCVD 0x08 /* want PRU_RCVD calls */
178#define PR_RIGHTS 0x10 /* passes capabilities */
179#define PR_IMPLOPCL 0x20 /* implied open/close */
180#define PR_LASTHDR 0x40 /* enforce ipsec policy; last header */
181#define PR_PROTOLOCK 0x80 /* protocol takes care of it's own locking */
182#define PR_PCBLOCK 0x100 /* protocol supports per pcb finer grain locking */
183#define PR_DISPOSE 0x200 /* protocol requires late lists disposal */
1c79356b
A
184
185/*
186 * The arguments to usrreq are:
187 * (*protosw[].pr_usrreq)(up, req, m, nam, opt);
188 * where up is a (struct socket *), req is one of these requests,
189 * m is a optional mbuf chain containing a message,
190 * nam is an optional mbuf chain containing an address,
191 * and opt is a pointer to a socketopt structure or nil.
192 * The protocol is responsible for disposal of the mbuf chain m,
193 * the caller is responsible for any space held by nam and opt.
194 * A non-zero return from usrreq gives an
195 * UNIX error number which should be passed to higher level software.
196 */
197#define PRU_ATTACH 0 /* attach protocol to up */
198#define PRU_DETACH 1 /* detach protocol from up */
199#define PRU_BIND 2 /* bind socket to address */
200#define PRU_LISTEN 3 /* listen for connection */
201#define PRU_CONNECT 4 /* establish connection to peer */
202#define PRU_ACCEPT 5 /* accept connection from peer */
203#define PRU_DISCONNECT 6 /* disconnect from peer */
204#define PRU_SHUTDOWN 7 /* won't send any more data */
205#define PRU_RCVD 8 /* have taken data; more room now */
206#define PRU_SEND 9 /* send this data */
207#define PRU_ABORT 10 /* abort (fast DISCONNECT, DETATCH) */
208#define PRU_CONTROL 11 /* control operations on protocol */
209#define PRU_SENSE 12 /* return status into m */
210#define PRU_RCVOOB 13 /* retrieve out of band data */
211#define PRU_SENDOOB 14 /* send out of band data */
212#define PRU_SOCKADDR 15 /* fetch socket's address */
213#define PRU_PEERADDR 16 /* fetch peer's address */
214#define PRU_CONNECT2 17 /* connect two sockets */
215/* begin for protocols internal use */
216#define PRU_FASTTIMO 18 /* 200ms timeout */
217#define PRU_SLOWTIMO 19 /* 500ms timeout */
218#define PRU_PROTORCV 20 /* receive from below */
219#define PRU_PROTOSEND 21 /* send to below */
220/* end for protocol's internal use */
221#define PRU_SEND_EOF 22 /* send and close */
222#define PRU_NREQ 22
223
224#ifdef PRUREQUESTS
225char *prurequests[] = {
226 "ATTACH", "DETACH", "BIND", "LISTEN",
227 "CONNECT", "ACCEPT", "DISCONNECT", "SHUTDOWN",
228 "RCVD", "SEND", "ABORT", "CONTROL",
229 "SENSE", "RCVOOB", "SENDOOB", "SOCKADDR",
230 "PEERADDR", "CONNECT2", "FASTTIMO", "SLOWTIMO",
231 "PROTORCV", "PROTOSEND",
232 "SEND_EOF",
233};
234#endif
235
236#ifdef KERNEL /* users shouldn't see this decl */
237
238struct ifnet;
239struct stat;
240struct ucred;
241struct uio;
242
243/*
244 * If the ordering here looks odd, that's because it's alphabetical.
245 * Having this structure separated out from the main protoswitch is allegedly
246 * a big (12 cycles per call) lose on high-end CPUs. We will eventually
247 * migrate this stuff back into the main structure.
248 */
249struct pr_usrreqs {
91447636
A
250 int (*pru_abort)(struct socket *so);
251 int (*pru_accept)(struct socket *so, struct sockaddr **nam);
252 int (*pru_attach)(struct socket *so, int proto, struct proc *p);
253 int (*pru_bind)(struct socket *so, struct sockaddr *nam,
254 struct proc *p);
255 int (*pru_connect)(struct socket *so, struct sockaddr *nam,
256 struct proc *p);
257 int (*pru_connect2)(struct socket *so1, struct socket *so2);
258 int (*pru_control)(struct socket *so, u_long cmd, caddr_t data,
259 struct ifnet *ifp, struct proc *p);
260 int (*pru_detach)(struct socket *so);
261 int (*pru_disconnect)(struct socket *so);
262 int (*pru_listen)(struct socket *so, struct proc *p);
263 int (*pru_peeraddr)(struct socket *so, struct sockaddr **nam);
264 int (*pru_rcvd)(struct socket *so, int flags);
265 int (*pru_rcvoob)(struct socket *so, struct mbuf *m, int flags);
266 int (*pru_send)(struct socket *so, int flags, struct mbuf *m,
1c79356b 267 struct sockaddr *addr, struct mbuf *control,
91447636 268 struct proc *p);
1c79356b
A
269#define PRUS_OOB 0x1
270#define PRUS_EOF 0x2
271#define PRUS_MORETOCOME 0x4
2d21ac55 272 int (*pru_sense)(struct socket *so, void *sb, int isstat64);
91447636
A
273 int (*pru_shutdown)(struct socket *so);
274 int (*pru_sockaddr)(struct socket *so, struct sockaddr **nam);
1c79356b
A
275
276 /*
277 * These three added later, so they are out of order. They are used
278 * for shortcutting (fast path input/output) in some protocols.
279 * XXX - that's a lie, they are not implemented yet
280 * Rather than calling sosend() etc. directly, calls are made
281 * through these entry points. For protocols which still use
282 * the generic code, these just point to those routines.
283 */
91447636 284 int (*pru_sosend)(struct socket *so, struct sockaddr *addr,
1c79356b 285 struct uio *uio, struct mbuf *top,
91447636
A
286 struct mbuf *control, int flags);
287 int (*pru_soreceive)(struct socket *so,
1c79356b
A
288 struct sockaddr **paddr,
289 struct uio *uio, struct mbuf **mp0,
91447636
A
290 struct mbuf **controlp, int *flagsp);
291 int (*pru_sopoll)(struct socket *so, int events,
292 struct ucred *cred, void *);
1c79356b
A
293};
294
91447636
A
295__BEGIN_DECLS
296
1c79356b
A
297extern int pru_abort_notsupp(struct socket *so);
298extern int pru_accept_notsupp(struct socket *so, struct sockaddr **nam);
299extern int pru_attach_notsupp(struct socket *so, int proto,
300 struct proc *p);
301extern int pru_bind_notsupp(struct socket *so, struct sockaddr *nam,
302 struct proc *p);
303extern int pru_connect_notsupp(struct socket *so, struct sockaddr *nam,
304 struct proc *p);
305extern int pru_connect2_notsupp(struct socket *so1, struct socket *so2);
306extern int pru_control_notsupp(struct socket *so, u_long cmd, caddr_t data,
307 struct ifnet *ifp, struct proc *p);
308extern int pru_detach_notsupp(struct socket *so);
309extern int pru_disconnect_notsupp(struct socket *so);
310extern int pru_listen_notsupp(struct socket *so, struct proc *p);
311extern int pru_peeraddr_notsupp(struct socket *so,
312 struct sockaddr **nam);
313extern int pru_rcvd_notsupp(struct socket *so, int flags);
314extern int pru_rcvoob_notsupp(struct socket *so, struct mbuf *m,
315 int flags);
316extern int pru_send_notsupp(struct socket *so, int flags, struct mbuf *m,
317 struct sockaddr *addr, struct mbuf *control,
318 struct proc *p);
2d21ac55 319extern int pru_sense_null(struct socket *so, void * sb, int isstat64);
1c79356b
A
320extern int pru_shutdown_notsupp(struct socket *so);
321extern int pru_sockaddr_notsupp(struct socket *so,
322 struct sockaddr **nam);
323extern int pru_sosend_notsupp(struct socket *so, struct sockaddr *addr,
324 struct uio *uio, struct mbuf *top,
325 struct mbuf *control, int flags);
326extern int pru_soreceive_notsupp(struct socket *so,
327 struct sockaddr **paddr,
328 struct uio *uio, struct mbuf **mp0,
329 struct mbuf **controlp, int *flagsp);
330extern int pru_sopoll_notsupp(struct socket *so, int events,
91447636 331 struct ucred *cred, void *);
1c79356b 332
91447636 333__END_DECLS
1c79356b
A
334
335#endif /* KERNEL */
336
337/*
338 * The arguments to the ctlinput routine are
339 * (*protosw[].pr_ctlinput)(cmd, sa, arg);
340 * where cmd is one of the commands below, sa is a pointer to a sockaddr,
341 * and arg is a `void *' argument used within a protocol family.
342 */
343#define PRC_IFDOWN 0 /* interface transition */
344#define PRC_ROUTEDEAD 1 /* select new route if possible ??? */
345#define PRC_IFUP 2 /* interface has come back up */
346#define PRC_QUENCH2 3 /* DEC congestion bit says slow down */
347#define PRC_QUENCH 4 /* some one said to slow down */
348#define PRC_MSGSIZE 5 /* message size forced drop */
349#define PRC_HOSTDEAD 6 /* host appears to be down */
350#define PRC_HOSTUNREACH 7 /* deprecated (use PRC_UNREACH_HOST) */
351#define PRC_UNREACH_NET 8 /* no route to network */
352#define PRC_UNREACH_HOST 9 /* no route to host */
353#define PRC_UNREACH_PROTOCOL 10 /* dst says bad protocol */
354#define PRC_UNREACH_PORT 11 /* bad port # */
355/* was PRC_UNREACH_NEEDFRAG 12 (use PRC_MSGSIZE) */
356#define PRC_UNREACH_SRCFAIL 13 /* source route failed */
357#define PRC_REDIRECT_NET 14 /* net routing redirect */
358#define PRC_REDIRECT_HOST 15 /* host routing redirect */
359#define PRC_REDIRECT_TOSNET 16 /* redirect for type of service & net */
360#define PRC_REDIRECT_TOSHOST 17 /* redirect for tos & host */
361#define PRC_TIMXCEED_INTRANS 18 /* packet lifetime expired in transit */
362#define PRC_TIMXCEED_REASS 19 /* lifetime expired on reass q */
363#define PRC_PARAMPROB 20 /* header incorrect */
9bccf70c 364#define PRC_UNREACH_ADMIN_PROHIB 21 /* packet administrativly prohibited */
1c79356b 365
9bccf70c 366#define PRC_NCMDS 22
1c79356b
A
367
368#define PRC_IS_REDIRECT(cmd) \
369 ((cmd) >= PRC_REDIRECT_NET && (cmd) <= PRC_REDIRECT_TOSHOST)
370
371#ifdef PRCREQUESTS
372char *prcrequests[] = {
373 "IFDOWN", "ROUTEDEAD", "IFUP", "DEC-BIT-QUENCH2",
374 "QUENCH", "MSGSIZE", "HOSTDEAD", "#7",
375 "NET-UNREACH", "HOST-UNREACH", "PROTO-UNREACH", "PORT-UNREACH",
376 "#12", "SRCFAIL-UNREACH", "NET-REDIRECT", "HOST-REDIRECT",
377 "TOSNET-REDIRECT", "TOSHOST-REDIRECT", "TX-INTRANS", "TX-REASS",
9bccf70c 378 "PARAMPROB", "ADMIN-UNREACH"
1c79356b
A
379};
380#endif
381
382/*
383 * The arguments to ctloutput are:
384 * (*protosw[].pr_ctloutput)(req, so, level, optname, optval, p);
385 * req is one of the actions listed below, so is a (struct socket *),
386 * level is an indication of which protocol layer the option is intended.
387 * optname is a protocol dependent socket option request,
388 * optval is a pointer to a mbuf-chain pointer, for value-return results.
389 * The protocol is responsible for disposal of the mbuf chain *optval
390 * if supplied,
391 * the caller is responsible for any space held by *optval, when returned.
392 * A non-zero return from usrreq gives an
393 * UNIX error number which should be passed to higher level software.
394 */
395#define PRCO_GETOPT 0
396#define PRCO_SETOPT 1
397
398#define PRCO_NCMDS 2
399
400#ifdef PRCOREQUESTS
401char *prcorequests[] = {
402 "GETOPT", "SETOPT",
403};
404#endif
405
406#ifdef KERNEL
91447636
A
407
408__BEGIN_DECLS
2d21ac55 409void domaininit(void);
91447636
A
410
411void pfctlinput(int, struct sockaddr *);
412void pfctlinput2(int, struct sockaddr *, void *);
413struct protosw *pffindproto(int family, int protocol, int type);
414struct protosw *pffindproto_locked(int family, int protocol, int type);
415struct protosw *pffindtype(int family, int type);
1c79356b
A
416
417extern int net_add_proto(struct protosw *, struct domain *);
418extern int net_del_proto(int, int, struct domain *);
419
91447636
A
420__END_DECLS
421
1c79356b
A
422/* Temp hack to link static domains together */
423
424#define LINK_PROTOS(psw) \
425static void link_ ## psw ## _protos() \
426{ \
427 int i; \
428 \
429 for (i=0; i < ((sizeof(psw)/sizeof(psw[0])) - 1); i++) \
430 psw[i].pr_next = &psw[i + 1]; \
431}
432
433#endif
91447636
A
434
435#endif /* PRIVATE */
1c79356b 436#endif /* !_SYS_PROTOSW_H_ */