2 * Copyright (c) 2000-2007 Apple Inc. All rights reserved.
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
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.
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
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
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
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.
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
28 /* Copyright (c) 1998, 1999 Apple Computer, Inc. All Rights Reserved */
29 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
31 * Copyright (c) 1982, 1986, 1990, 1993
32 * The Regents of the University of California. All rights reserved.
34 * Redistribution and use in source and binary forms, with or without
35 * modification, are permitted provided that the following conditions
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.
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
62 * @(#)socketvar.h 8.3 (Berkeley) 2/19/95
63 * $FreeBSD: src/sys/sys/socketvar.h,v 1.46.2.6 2001/08/31 13:45:49 jlemon Exp $
66 * NOTICE: This file was modified by SPARTA, Inc. in 2005 to introduce
67 * support for mandatory and extensible security protections. This notice
68 * is included in support of clause 2.2 (b) of the Apple Public License,
72 #ifndef _SYS_SOCKETVAR_H_
73 #define _SYS_SOCKETVAR_H_
75 #include <sys/appleapiopts.h>
76 #include <sys/queue.h> /* for TAILQ macros */
77 #include <sys/select.h> /* for struct selinfo */
78 #include <net/kext_net.h>
80 #include <sys/cdefs.h>
83 * Hacks to get around compiler complaints
86 struct socket_filter_entry
;
92 /* strings for sleep message: */
93 extern char netio
[], netcon
[], netcls
[];
94 #define SOCKET_CACHE_ON
95 #define SO_CACHE_FLUSH_INTERVAL 1 /* Seconds */
96 #define SO_CACHE_TIME_LIMIT (120/SO_CACHE_FLUSH_INTERVAL) /* Seconds */
97 #define SO_CACHE_MAX_FREE_BATCH 50
98 #define MAX_CACHED_SOCKETS 60000
102 * Kernel structure per socket.
103 * Contains send and receive buffer queues,
104 * handle on protocol and pointer to protocol
105 * private data and error information.
107 #endif /* KERNEL_PRIVATE */
109 typedef u_quad_t so_gen_t
;
111 #ifdef KERNEL_PRIVATE
113 /* We don't support BSD style socket filters */
114 struct accept_filter
;
118 int so_zone
; /* zone we were allocated from */
119 short so_type
; /* generic type, see socket.h */
120 short so_options
; /* from socket call, see socket.h */
121 short so_linger
; /* time to linger while closing */
122 short so_state
; /* internal state flags SS_*, below */
123 caddr_t so_pcb
; /* protocol control block */
124 struct protosw
*so_proto
; /* protocol handle */
126 * Variables for connection queueing.
127 * Socket where accepts occur is so_head in all subsidiary sockets.
128 * If so_head is 0, socket is not related to an accept.
129 * For head socket so_incomp queues partially completed connections,
130 * while so_comp is a queue of connections ready to be accepted.
131 * If a connection is aborted and it has so_head set, then
132 * it has to be pulled out of either so_incomp or so_comp.
133 * We allow connections to queue up based on current queue lengths
134 * and limit on number of queued connections for this socket.
136 struct socket
*so_head
; /* back pointer to accept socket */
137 TAILQ_HEAD(, socket
) so_incomp
; /* q of partially unaccepted conns */
138 TAILQ_HEAD(, socket
) so_comp
; /* q of complete unaccepted conns */
139 TAILQ_ENTRY(socket
) so_list
; /* list of unaccepted connections */
140 short so_qlen
; /* number of unaccepted connections */
141 short so_incqlen
; /* number of unaccepted incomplete
143 short so_qlimit
; /* max number queued connections */
144 short so_timeo
; /* connection timeout */
145 u_short so_error
; /* error affecting connection */
146 pid_t so_pgid
; /* pgid for signals */
147 u_long so_oobmark
; /* chars to oob mark */
149 /* We don't support AIO ops */
150 TAILQ_HEAD(, aiocblist
) so_aiojobq
; /* AIO ops waiting on socket */
153 * Variables for socket buffering.
156 u_long sb_cc
; /* actual chars in buffer */
157 u_long sb_hiwat
; /* max actual char count */
158 u_long sb_mbcnt
; /* chars of mbufs used */
159 u_long sb_mbmax
; /* max chars of mbufs to use */
160 u_long sb_ctl
; /* non-data chars in buffer */
161 u_long sb_lowat
; /* low water mark */
162 struct mbuf
*sb_mb
; /* the mbuf chain */
163 struct mbuf
*sb_mbtail
; /* the last mbuf in the chain */
164 struct mbuf
*sb_lastrecord
; /* first mbuf of last record */
166 struct socket
*sb_so
; /* socket back ptr for kexts */
168 struct selinfo sb_sel
; /* process selecting read/write */
169 short sb_flags
; /* flags, see below */
170 struct timeval sb_timeo
; /* timeout for read/write */
171 u_int sb_maxused
; /* max char count ever used in sockbuf */
172 void *reserved1
[4]; /* for future use */
174 #define SB_MAX (8192*1024) /* default for max chars in sockbuf */
175 #define SB_LOCK 0x01 /* lock on data queue */
176 #define SB_WANT 0x02 /* someone is waiting to lock */
177 #define SB_WAIT 0x04 /* someone is waiting for data/space */
178 #define SB_SEL 0x08 /* someone is selecting */
179 #define SB_ASYNC 0x10 /* ASYNC I/O, need signals */
180 #define SB_UPCALL 0x20 /* someone wants an upcall */
181 #define SB_NOINTR 0x40 /* operations not interruptible */
182 #define SB_KNOTE 0x100 /* kernel note attached */
183 #define SB_USRSIZE 0x200 /* user specified sbreserve */
185 #define SB_AIO 0x80 /* AIO operations queued */
187 #define SB_NOTIFY (SB_WAIT|SB_SEL|SB_ASYNC)
188 #define SB_DROP 0x400 /* does not accept any more data */
189 #define SB_UNIX 0x800 /* UNIX domain socket buffer */
190 #define SB_RECV 0x8000 /* this is rcv sb */
192 caddr_t so_tpcb
; /* Wisc. protocol control block - XXX unused? */
195 void (*so_upcall
)(struct socket
*so
, caddr_t arg
, int waitf
);
196 caddr_t so_upcallarg
; /* Arg for above */
197 uid_t so_uid
; /* who opened the socket */
198 /* NB: generation count must not be first; easiest to make it last. */
199 so_gen_t so_gencnt
; /* generation count */
201 void *so_emuldata
; /* private data for emulators */
203 struct accept_filter
*so_accept_filter
;
204 void *so_accept_filter_arg
; /* saved filter args */
205 char *so_accept_filter_str
; /* saved user args */
208 TAILQ_HEAD(, eventqelt
) so_evlist
;
209 int cached_in_sock_layer
; /* bundled with pcb/pcb.inp_ppcb? */
210 struct socket
*cache_next
;
211 struct socket
*cache_prev
;
212 u_long cache_timestamp
;
213 caddr_t so_saved_pcb
; /* Saved pcb when cacheing */
214 struct mbuf
*so_temp
; /* Holding area for outbound frags */
215 /* Plug-in support - make the socket interface overridable */
216 struct mbuf
*so_tail
;
217 struct socket_filter_entry
*so_filt
; /* NKE hook */
218 u_long so_flags
; /* Flags */
219 #define SOF_NOSIGPIPE 0x1
220 #define SOF_NOADDRAVAIL 0x2 /* EADDRNOTAVAIL if src addr is gone */
221 #define SOF_PCBCLEARING 0x4 /* pru_disconnect done; don't call pru_detach */
222 #define SOF_DEFUNCT 0x8 /* accepted socket marked as inactive */
223 #define SOF_CLOSEWAIT 0x10 /* blocked in close awaiting some events */
224 #define SOF_UPCALLINUSE 0x20 /* socket upcall is currently in progress */
225 #define SOF_REUSESHAREUID 0x40 /* Allows SO_REUSEADDR/SO_REUSEPORT for multiple so_uid */
226 #define SOF_MULTIPAGES 0x80 /* jumbo clusters may be used for sosend */
227 #define SOF_ABORTED 0x100 /* soabort was already called once on the socket */
228 #define SOF_OVERFLOW 0x200 /* socket was dropped as overflow of listen queue */
229 #ifdef __APPLE_API_PRIVATE
230 #define SOF_NOTIFYCONFLICT 0x400 /* notify that a bind was done on a port already in use */
232 #define SOF_UPCALLCLOSEWAIT 0x800 /* block on close until an upcall returns */
233 int so_usecount
; /* refcounting of socket use */;
235 u_int32_t so_filteruse
; /* usecount for the socket filters */
236 u_int32_t so_traffic_mgt_flags
; /* traffic_mgt socket config */
237 thread_t so_send_filt_thread
;
238 u_int32_t so_restrictions
;
240 /* for debug pruposes */
241 #define SO_LCKDBG_MAX 4 /* number of debug locking Link Registers recorded */
242 u_int32_t lock_lr
[SO_LCKDBG_MAX
]; /* locking calling history */
244 u_int32_t unlock_lr
[SO_LCKDBG_MAX
]; /* unlocking caller history */
246 void *reserved
; /* reserved for future use */
247 #endif /* __APPLE__ */
249 struct label
*so_label
; /* MAC label for socket */
250 struct label
*so_peerlabel
; /* cached MAC label for socket peer */
251 thread_t so_background_thread
; /* thread that marked this socket background */
253 #endif /* KERNEL_PRIVATE */
258 #define SS_NOFDREF 0x0001 /* no file table ref any more */
259 #define SS_ISCONNECTED 0x0002 /* socket connected to a peer */
260 #define SS_ISCONNECTING 0x0004 /* in process of connecting to peer */
261 #define SS_ISDISCONNECTING 0x0008 /* in process of disconnecting */
262 #define SS_CANTSENDMORE 0x0010 /* can't send more data to peer */
263 #define SS_CANTRCVMORE 0x0020 /* can't receive more data from peer */
264 #define SS_RCVATMARK 0x0040 /* at mark on input */
266 #define SS_PRIV 0x0080 /* privileged for broadcast, raw... */
267 #define SS_NBIO 0x0100 /* non-blocking ops */
268 #define SS_ASYNC 0x0200 /* async i/o notify */
269 #define SS_ISCONFIRMING 0x0400 /* deciding to accept connection req */
270 #define SS_INCOMP 0x0800 /* Unaccepted, incomplete connection */
271 #define SS_COMP 0x1000 /* unaccepted, complete connection */
272 #define SS_ISDISCONNECTED 0x2000 /* socket disconnected from peer */
273 #define SS_DRAINING 0x4000 /* close waiting for blocked system
276 #if defined(__LP64__)
277 #define _XSOCKET_PTR(x) u_int32_t
279 #define _XSOCKET_PTR(x) x
285 * Externalized form of struct socket used by the sysctl(3) interface.
288 u_int32_t xso_len
; /* length of this structure */
289 _XSOCKET_PTR(struct socket
*) xso_so
; /* makes a convenient handle */
294 _XSOCKET_PTR(caddr_t
) so_pcb
; /* another convenient handle */
303 u_int32_t so_oobmark
;
313 uid_t so_uid
; /* XXX */
318 #ifdef KERNEL_PRIVATE
320 * Macros for sockets and socket buffering.
323 #define sbtoso(sb) (sb->sb_so)
326 * Functions for sockets and socket buffering.
327 * These are macros on FreeBSD. On Darwin the
328 * implementation is in bsd/kern/uipc_socket2.c
332 int sb_notify(struct sockbuf
*sb
);
333 long sbspace(struct sockbuf
*sb
);
334 int sosendallatonce(struct socket
*so
);
335 int soreadable(struct socket
*so
);
336 int sowriteable(struct socket
*so
);
337 void sballoc(struct sockbuf
*sb
, struct mbuf
*m
);
338 void sbfree(struct sockbuf
*sb
, struct mbuf
*m
);
339 int sblock(struct sockbuf
*sb
, int wf
);
340 void sbunlock(struct sockbuf
*sb
, int locked
);
341 void sorwakeup(struct socket
*so
);
342 void sowwakeup(struct socket
*so
);
346 * Socket extension mechanism: control block hooks:
347 * This is the "head" of any control block for an extenstion
348 * Note: we separate intercept function dispatch vectors from
349 * the NFDescriptor to permit selective replacement during
350 * operation, e.g., to disable some functions.
353 struct kextcb
*e_next
; /* Next kext control block */
354 void *e_fcb
; /* Real filter control block */
355 struct NFDescriptor
*e_nfd
; /* NKE Descriptor */
356 /* Plug-in support - intercept functions */
357 struct sockif
*e_soif
; /* Socket functions */
358 struct sockutil
*e_sout
; /* Sockbuf utility functions */
360 #define EXT_NULL 0x0 /* STATE: Not in use */
361 #define sotokextcb(so) (so ? so->so_ext : 0)
365 #define SO_FILT_HINT_LOCKED 0x1
368 * Argument structure for sosetopt et seq. This is in the KERNEL
369 * section because it will never be visible to user code.
371 enum sopt_dir
{ SOPT_GET
, SOPT_SET
};
373 enum sopt_dir sopt_dir
; /* is this a get or a set? */
374 int sopt_level
; /* second arg of [gs]etsockopt */
375 int sopt_name
; /* third arg of [gs]etsockopt */
376 user_addr_t sopt_val
; /* fourth arg of [gs]etsockopt */
377 size_t sopt_valsize
; /* (almost) fifth arg of [gs]etsockopt */
378 struct proc
*sopt_p
; /* calling process or null if kernel */
383 SLIST_ENTRY(sf_buf
) free_list
; /* list of free buffer slots */
384 int refcnt
; /* reference count */
385 struct vm_page
*m
; /* currently mapped page */
386 vm_offset_t kva
; /* va of mapping */
390 #ifdef MALLOC_DECLARE
391 MALLOC_DECLARE(M_PCB
);
392 MALLOC_DECLARE(M_SONAME
);
395 extern int maxsockets
;
396 extern u_long sb_max
;
397 extern int socket_zone
;
398 extern so_gen_t so_gencnt
;
399 extern int socket_debug
;
400 extern int sosendjcl
;
401 extern int sosendjcl_ignore_capab
;
402 extern int somaxconn
;
413 #define SBLASTRECORDCHK(sb, s) \
414 if (socket_debug) sblastrecordchk(sb, s);
416 #define SBLASTMBUFCHK(sb, s) \
417 if (socket_debug) sblastmbufchk(sb, s);
419 #define SB_EMPTY_FIXUP(sb) { \
420 if ((sb)->sb_mb == NULL) { \
421 (sb)->sb_mbtail = NULL; \
422 (sb)->sb_lastrecord = NULL; \
427 * From uipc_socket and friends
431 extern void socketinit(void) __attribute__((section("__TEXT, initcode")));
434 extern struct sockaddr
*dup_sockaddr(struct sockaddr
*sa
, int canwait
);
435 extern int getsock(struct filedesc
*fdp
, int fd
, struct file
**fpp
);
436 extern int sockargs(struct mbuf
**mp
, user_addr_t data
, int buflen
, int type
);
438 extern int sbappend(struct sockbuf
*sb
, struct mbuf
*m
);
439 extern int sbappendstream(struct sockbuf
*sb
, struct mbuf
*m
);
440 extern int sbappendaddr(struct sockbuf
*sb
, struct sockaddr
*asa
,
441 struct mbuf
*m0
, struct mbuf
*control
, int *error_out
);
442 extern int sbappendcontrol(struct sockbuf
*sb
, struct mbuf
*m0
,
443 struct mbuf
*control
, int *error_out
);
444 extern int sbappendrecord(struct sockbuf
*sb
, struct mbuf
*m0
);
445 extern void sbcheck(struct sockbuf
*sb
);
446 extern void sblastmbufchk(struct sockbuf
*, const char *);
447 extern void sblastrecordchk(struct sockbuf
*, const char *);
448 extern struct mbuf
*sbcreatecontrol(caddr_t p
, int size
, int type
, int level
);
449 extern void sbdrop(struct sockbuf
*sb
, int len
);
450 extern void sbdroprecord(struct sockbuf
*sb
);
451 extern void sbflush(struct sockbuf
*sb
);
452 extern int sbinsertoob(struct sockbuf
*sb
, struct mbuf
*m0
);
453 extern void sbrelease(struct sockbuf
*sb
);
454 extern int sbreserve(struct sockbuf
*sb
, u_long cc
);
455 extern void sbtoxsockbuf(struct sockbuf
*sb
, struct xsockbuf
*xsb
);
456 extern int sbwait(struct sockbuf
*sb
);
457 extern int sb_lock(struct sockbuf
*sb
);
458 extern void sb_empty_assert(struct sockbuf
*, const char *);
460 extern int soabort(struct socket
*so
);
461 extern int soaccept(struct socket
*so
, struct sockaddr
**nam
);
462 extern int soacceptlock(struct socket
*so
, struct sockaddr
**nam
, int dolock
);
463 extern int soacceptfilter(struct socket
*so
);
464 extern struct socket
*soalloc(int waitok
, int dom
, int type
);
465 extern int sobind(struct socket
*so
, struct sockaddr
*nam
);
466 extern void socantrcvmore(struct socket
*so
);
467 extern void socantsendmore(struct socket
*so
);
468 extern int soclose(struct socket
*so
);
469 extern int soconnect(struct socket
*so
, struct sockaddr
*nam
);
470 extern int soconnectlock(struct socket
*so
, struct sockaddr
*nam
, int dolock
);
471 extern int soconnect2(struct socket
*so1
, struct socket
*so2
);
472 extern int socreate(int dom
, struct socket
**aso
, int type
, int proto
);
473 extern void sodealloc(struct socket
*so
);
474 extern int sodisconnect(struct socket
*so
);
475 extern int sodisconnectlocked(struct socket
*so
);
476 extern void sofree(struct socket
*so
);
477 extern void soreference(struct socket
*so
);
478 extern void sodereference(struct socket
*so
);
479 extern void somultipages(struct socket
*, boolean_t
);
480 extern int sogetopt(struct socket
*so
, struct sockopt
*sopt
);
481 extern void sohasoutofband(struct socket
*so
);
482 extern void soisconnected(struct socket
*so
);
483 extern void soisconnecting(struct socket
*so
);
484 extern void soisdisconnected(struct socket
*so
);
485 extern void soisdisconnecting(struct socket
*so
);
486 extern int solisten(struct socket
*so
, int backlog
);
487 extern struct socket
*sodropablereq(struct socket
*head
);
488 extern struct socket
*sonewconn(struct socket
*head
, int connstatus
,
489 const struct sockaddr
*from
);
490 extern int sooptcopyin(struct sockopt
*sopt
, void *data
, size_t len
,
492 extern int sooptcopyout(struct sockopt
*sopt
, void *data
, size_t len
);
493 extern int socket_lock(struct socket
*so
, int refcount
);
494 extern int socket_unlock(struct socket
*so
, int refcount
);
495 extern void sofreelastref(struct socket
*, int);
498 * XXX; prepare mbuf for (__FreeBSD__ < 3) routines.
499 * Used primarily in IPSec and IPv6 code.
501 extern int soopt_getm(struct sockopt
*sopt
, struct mbuf
**mp
);
502 extern int soopt_mcopyin(struct sockopt
*sopt
, struct mbuf
*m
);
503 extern int soopt_mcopyout(struct sockopt
*sopt
, struct mbuf
*m
);
505 extern int sopoll(struct socket
*so
, int events
, struct ucred
*cred
, void *wql
);
506 extern int soreceive(struct socket
*so
, struct sockaddr
**paddr
,
507 struct uio
*uio
, struct mbuf
**mp0
, struct mbuf
**controlp
, int *flagsp
);
508 extern int soreserve(struct socket
*so
, u_long sndcc
, u_long rcvcc
);
509 extern void sorflush(struct socket
*so
);
510 extern int sosend(struct socket
*so
, struct sockaddr
*addr
, struct uio
*uio
,
511 struct mbuf
*top
, struct mbuf
*control
, int flags
);
513 extern int sosetopt(struct socket
*so
, struct sockopt
*sopt
);
514 extern int soshutdown(struct socket
*so
, int how
);
515 extern int soshutdownlock(struct socket
*so
, int how
);
516 extern void sotoxsocket(struct socket
*so
, struct xsocket
*xso
);
517 extern void sowakeup(struct socket
*so
, struct sockbuf
*sb
);
518 extern int soioctl(struct socket
*so
, u_long cmd
, caddr_t data
, struct proc
*p
);
521 /* accept filter functions */
522 extern int accept_filt_add(struct accept_filter
*filt
);
523 extern int accept_filt_del(char *name
);
524 extern struct accept_filter
*accept_filt_get(char *name
);
525 #ifdef ACCEPT_FILTER_MOD
526 extern int accept_filt_generic_mod_event(module_t mod
, int event
, void *data
);
527 SYSCTL_DECL(_net_inet_accf
);
528 #endif /* ACCEPT_FILTER_MOD */
529 #endif /* !defined(__APPLE__) */
534 #endif /* KERNEL_PRIVATE */
536 #endif /* !_SYS_SOCKETVAR_H_ */