2 * Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
4 * @APPLE_LICENSE_HEADER_START@
6 * Copyright (c) 1999-2003 Apple Computer, Inc. All Rights Reserved.
8 * This file contains Original Code and/or Modifications of Original Code
9 * as defined in and that are subject to the Apple Public Source License
10 * Version 2.0 (the 'License'). You may not use this file except in
11 * compliance with the License. Please obtain a copy of the License at
12 * http://www.opensource.apple.com/apsl/ and read it before using this
15 * The Original Code and all software distributed under the License are
16 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
17 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
18 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
20 * Please see the License for the specific language governing rights and
21 * limitations under the License.
23 * @APPLE_LICENSE_HEADER_END@
25 /* Copyright (c) 1998, 1999 Apple Computer, Inc. All Rights Reserved */
26 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
28 * Copyright (c) 1982, 1985, 1986, 1988, 1993, 1994
29 * The Regents of the University of California. All rights reserved.
31 * Redistribution and use in source and binary forms, with or without
32 * modification, are permitted provided that the following conditions
34 * 1. Redistributions of source code must retain the above copyright
35 * notice, this list of conditions and the following disclaimer.
36 * 2. Redistributions in binary form must reproduce the above copyright
37 * notice, this list of conditions and the following disclaimer in the
38 * documentation and/or other materials provided with the distribution.
39 * 3. All advertising materials mentioning features or use of this software
40 * must display the following acknowledgement:
41 * This product includes software developed by the University of
42 * California, Berkeley and its contributors.
43 * 4. Neither the name of the University nor the names of its contributors
44 * may be used to endorse or promote products derived from this software
45 * without specific prior written permission.
47 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
48 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
49 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
50 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
51 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
52 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
53 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
54 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
55 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
56 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
59 * @(#)socket.h 8.4 (Berkeley) 2/21/94
60 * $FreeBSD: src/sys/sys/socket.h,v 1.39.2.7 2001/07/03 11:02:01 ume Exp $
63 #ifndef _SYS_SOCKET_H_
64 #define _SYS_SOCKET_H_
67 #include <machine/ansi.h>
69 #define _NO_NAMESPACE_POLLUTION
70 #include <machine/param.h>
71 #undef _NO_NAMESPACE_POLLUTION
74 * Definitions related to sockets: types, address families, options.
80 typedef u_char sa_family_t
;
81 #ifdef _BSD_SOCKLEN_T_
82 typedef _BSD_SOCKLEN_T_ socklen_t
;
83 #undef _BSD_SOCKLEN_T_
89 #define SOCK_STREAM 1 /* stream socket */
90 #define SOCK_DGRAM 2 /* datagram socket */
91 #define SOCK_RAW 3 /* raw-protocol interface */
92 #define SOCK_RDM 4 /* reliably-delivered message */
93 #define SOCK_SEQPACKET 5 /* sequenced packet stream */
96 * Option flags per-socket.
98 #define SO_DEBUG 0x0001 /* turn on debugging info recording */
99 #define SO_ACCEPTCONN 0x0002 /* socket has had listen() */
100 #define SO_REUSEADDR 0x0004 /* allow local address reuse */
101 #define SO_KEEPALIVE 0x0008 /* keep connections alive */
102 #define SO_DONTROUTE 0x0010 /* just use interface addresses */
103 #define SO_BROADCAST 0x0020 /* permit sending of broadcast msgs */
104 #define SO_USELOOPBACK 0x0040 /* bypass hardware when possible */
105 #define SO_LINGER 0x0080 /* linger on close if data present */
106 #define SO_OOBINLINE 0x0100 /* leave received OOB data in line */
107 #define SO_REUSEPORT 0x0200 /* allow local address & port reuse */
108 #define SO_TIMESTAMP 0x0400 /* timestamp received dgram traffic */
110 #define SO_ACCEPTFILTER 0x1000 /* there is an accept filter */
112 #define SO_DONTTRUNC 0x2000 /* APPLE: Retain unread data */
114 #define SO_WANTMORE 0x4000 /* APPLE: Give hint when more data ready */
115 #define SO_WANTOOBFLAG 0x8000 /* APPLE: Want OOB in MSG_FLAG on receive */
119 * Additional options, not kept in so_options.
121 #define SO_SNDBUF 0x1001 /* send buffer size */
122 #define SO_RCVBUF 0x1002 /* receive buffer size */
123 #define SO_SNDLOWAT 0x1003 /* send low-water mark */
124 #define SO_RCVLOWAT 0x1004 /* receive low-water mark */
125 #define SO_SNDTIMEO 0x1005 /* send timeout */
126 #define SO_RCVTIMEO 0x1006 /* receive timeout */
127 #define SO_ERROR 0x1007 /* get error status and clear */
128 #define SO_TYPE 0x1008 /* get socket type */
129 /*efine SO_PRIVSTATE 0x1009 get/deny privileged state */
131 #define SO_NREAD 0x1020 /* APPLE: get 1st-packet byte count */
132 #define SO_NKE 0x1021 /* APPLE: Install socket-level NKE */
133 #define SO_NOSIGPIPE 0x1022 /* APPLE: No SIGPIPE on EPIPE */
136 * Structure used for manipulating linger option.
139 int l_onoff
; /* option on/off */
140 int l_linger
; /* linger time */
144 struct accept_filter_arg
{
151 * Level number for (get/set)sockopt() to apply to socket itself.
153 #define SOL_SOCKET 0xffff /* options for socket level */
158 #define AF_UNSPEC 0 /* unspecified */
159 #define AF_LOCAL 1 /* local to host (pipes) */
160 #define AF_UNIX AF_LOCAL /* backward compatibility */
161 #define AF_INET 2 /* internetwork: UDP, TCP, etc. */
162 #define AF_IMPLINK 3 /* arpanet imp addresses */
163 #define AF_PUP 4 /* pup protocols: e.g. BSP */
164 #define AF_CHAOS 5 /* mit CHAOS protocols */
165 #define AF_NS 6 /* XEROX NS protocols */
166 #define AF_ISO 7 /* ISO protocols */
167 #define AF_OSI AF_ISO
168 #define AF_ECMA 8 /* European computer manufacturers */
169 #define AF_DATAKIT 9 /* datakit protocols */
170 #define AF_CCITT 10 /* CCITT protocols, X.25 etc */
171 #define AF_SNA 11 /* IBM SNA */
172 #define AF_DECnet 12 /* DECnet */
173 #define AF_DLI 13 /* DEC Direct data link interface */
174 #define AF_LAT 14 /* LAT */
175 #define AF_HYLINK 15 /* NSC Hyperchannel */
176 #define AF_APPLETALK 16 /* Apple Talk */
177 #define AF_ROUTE 17 /* Internal Routing Protocol */
178 #define AF_LINK 18 /* Link layer interface */
179 #define pseudo_AF_XTP 19 /* eXpress Transfer Protocol (no AF) */
180 #define AF_COIP 20 /* connection-oriented IP, aka ST II */
181 #define AF_CNT 21 /* Computer Network Technology */
182 #define pseudo_AF_RTIP 22 /* Help Identify RTIP packets */
183 #define AF_IPX 23 /* Novell Internet Protocol */
184 #define AF_SIP 24 /* Simple Internet Protocol */
185 #define pseudo_AF_PIP 25 /* Help Identify PIP packets */
187 /*define pseudo_AF_BLUE 26 Identify packets for Blue Box - Not used */
188 #define AF_NDRV 27 /* Network Driver 'raw' access */
190 #define AF_ISDN 28 /* Integrated Services Digital Network*/
191 #define AF_E164 AF_ISDN /* CCITT E.164 recommendation */
192 #define pseudo_AF_KEY 29 /* Internal key-management function */
193 #define AF_INET6 30 /* IPv6 */
194 #define AF_NATM 31 /* native ATM access */
196 #define AF_SYSTEM 32 /* Kernel event messages */
197 #define AF_NETBIOS 33 /* NetBIOS */
198 #define AF_PPP 34 /* PPP communication protocol */
200 #define AF_ATM 30 /* ATM */
202 #define pseudo_AF_HDRCMPLT 35 /* Used by BPF to not rewrite headers
203 * in interface output routine
206 #define AF_NETGRAPH 32 /* Netgraph sockets */
211 * Structure used by kernel to store most
215 u_char sa_len
; /* total length */
216 u_char sa_family
; /* address family */
217 char sa_data
[14]; /* actually longer; address value */
219 #define SOCK_MAXADDRLEN 255 /* longest possible addresses */
222 * Structure used by kernel to pass protocol
223 * information in raw sockets.
226 u_short sp_family
; /* address family */
227 u_short sp_protocol
; /* protocol */
231 * RFC 2553: protocol-independent placeholder for socket addresses
233 #define _SS_MAXSIZE 128
234 #define _SS_ALIGNSIZE (sizeof(int64_t))
235 #define _SS_PAD1SIZE (_SS_ALIGNSIZE - sizeof(u_char) - sizeof(sa_family_t))
236 #define _SS_PAD2SIZE (_SS_MAXSIZE - sizeof(u_char) - sizeof(sa_family_t) - \
237 _SS_PAD1SIZE - _SS_ALIGNSIZE)
239 struct sockaddr_storage
{
240 u_char ss_len
; /* address length */
241 sa_family_t ss_family
; /* address family */
242 char __ss_pad1
[_SS_PAD1SIZE
];
243 int64_t __ss_align
; /* force desired structure storage alignment */
244 char __ss_pad2
[_SS_PAD2SIZE
];
248 * Protocol families, same as address families for now.
250 #define PF_UNSPEC AF_UNSPEC
251 #define PF_LOCAL AF_LOCAL
252 #define PF_UNIX PF_LOCAL /* backward compatibility */
253 #define PF_INET AF_INET
254 #define PF_IMPLINK AF_IMPLINK
255 #define PF_PUP AF_PUP
256 #define PF_CHAOS AF_CHAOS
258 #define PF_ISO AF_ISO
259 #define PF_OSI AF_ISO
260 #define PF_ECMA AF_ECMA
261 #define PF_DATAKIT AF_DATAKIT
262 #define PF_CCITT AF_CCITT
263 #define PF_SNA AF_SNA
264 #define PF_DECnet AF_DECnet
265 #define PF_DLI AF_DLI
266 #define PF_LAT AF_LAT
267 #define PF_HYLINK AF_HYLINK
268 #define PF_APPLETALK AF_APPLETALK
269 #define PF_ROUTE AF_ROUTE
270 #define PF_LINK AF_LINK
271 #define PF_XTP pseudo_AF_XTP /* really just proto family, no AF */
272 #define PF_COIP AF_COIP
273 #define PF_CNT AF_CNT
274 #define PF_SIP AF_SIP
275 #define PF_IPX AF_IPX /* same format as AF_NS */
276 #define PF_RTIP pseudo_AF_RTIP /* same format as AF_INET */
277 #define PF_PIP pseudo_AF_PIP
279 #define PF_NDRV AF_NDRV
281 #define PF_ISDN AF_ISDN
282 #define PF_KEY pseudo_AF_KEY
283 #define PF_INET6 AF_INET6
284 #define PF_NATM AF_NATM
286 #define PF_SYSTEM AF_SYSTEM
287 #define PF_NETBIOS AF_NETBIOS
288 #define PF_PPP AF_PPP
290 #define PF_ATM AF_ATM
291 #define PF_NETGRAPH AF_NETGRAPH
294 #define PF_MAX AF_MAX
297 * Definitions for network related sysctl, CTL_NET.
299 * Second level is protocol family.
300 * Third level is protocol number.
302 * Further levels are defined by the individual families below.
304 #define NET_MAXID AF_MAX
306 #define CTL_NET_NAMES { \
308 { "local", CTLTYPE_NODE }, \
309 { "inet", CTLTYPE_NODE }, \
310 { "implink", CTLTYPE_NODE }, \
311 { "pup", CTLTYPE_NODE }, \
312 { "chaos", CTLTYPE_NODE }, \
313 { "xerox_ns", CTLTYPE_NODE }, \
314 { "iso", CTLTYPE_NODE }, \
315 { "emca", CTLTYPE_NODE }, \
316 { "datakit", CTLTYPE_NODE }, \
317 { "ccitt", CTLTYPE_NODE }, \
318 { "ibm_sna", CTLTYPE_NODE }, \
319 { "decnet", CTLTYPE_NODE }, \
320 { "dec_dli", CTLTYPE_NODE }, \
321 { "lat", CTLTYPE_NODE }, \
322 { "hylink", CTLTYPE_NODE }, \
323 { "appletalk", CTLTYPE_NODE }, \
324 { "route", CTLTYPE_NODE }, \
325 { "link_layer", CTLTYPE_NODE }, \
326 { "xtp", CTLTYPE_NODE }, \
327 { "coip", CTLTYPE_NODE }, \
328 { "cnt", CTLTYPE_NODE }, \
329 { "rtip", CTLTYPE_NODE }, \
330 { "ipx", CTLTYPE_NODE }, \
331 { "sip", CTLTYPE_NODE }, \
332 { "pip", CTLTYPE_NODE }, \
334 { "ndrv", CTLTYPE_NODE }, \
335 { "isdn", CTLTYPE_NODE }, \
336 { "key", CTLTYPE_NODE }, \
337 { "inet6", CTLTYPE_NODE }, \
338 { "natm", CTLTYPE_NODE }, \
339 { "sys", CTLTYPE_NODE }, \
340 { "netbios", CTLTYPE_NODE }, \
341 { "ppp", CTLTYPE_NODE }, \
342 { "hdrcomplete", CTLTYPE_NODE }, \
346 * PF_ROUTE - Routing table
348 * Three additional levels are defined:
349 * Fourth: address family, 0 is wildcard
350 * Fifth: type of info, defined below
351 * Sixth: flag(s) to mask with for NET_RT_FLAGS
353 #define NET_RT_DUMP 1 /* dump; may limit to a.f. */
354 #define NET_RT_FLAGS 2 /* by flags, e.g. RESOLVING */
355 #define NET_RT_IFLIST 3 /* survey interface list */
356 #define NET_RT_MAXID 4
358 #define CTL_NET_RT_NAMES { \
360 { "dump", CTLTYPE_STRUCT }, \
361 { "flags", CTLTYPE_STRUCT }, \
362 { "iflist", CTLTYPE_STRUCT }, \
366 * Maximum queue length specifiable by listen.
368 #define SOMAXCONN 128
371 * Message header for recvmsg and sendmsg calls.
372 * Used value-result for recvmsg, value only for sendmsg.
375 caddr_t msg_name
; /* optional address */
376 u_int msg_namelen
; /* size of address */
377 struct iovec
*msg_iov
; /* scatter/gather array */
378 u_int msg_iovlen
; /* # elements in msg_iov */
379 caddr_t msg_control
; /* ancillary data, see below */
380 u_int msg_controllen
; /* ancillary data buffer len */
381 int msg_flags
; /* flags on received message */
384 #define MSG_OOB 0x1 /* process out-of-band data */
385 #define MSG_PEEK 0x2 /* peek at incoming message */
386 #define MSG_DONTROUTE 0x4 /* send without using routing tables */
387 #define MSG_EOR 0x8 /* data completes record */
388 #define MSG_TRUNC 0x10 /* data discarded before delivery */
389 #define MSG_CTRUNC 0x20 /* control data lost before delivery */
390 #define MSG_WAITALL 0x40 /* wait for full request or error */
391 #define MSG_DONTWAIT 0x80 /* this message should be nonblocking */
392 #define MSG_EOF 0x100 /* data completes connection */
394 #define MSG_FLUSH 0x400 /* Start of 'hold' seq; dump so_temp */
395 #define MSG_HOLD 0x800 /* Hold frag in so_temp */
396 #define MSG_SEND 0x1000 /* Send the packet in so_temp */
397 #define MSG_HAVEMORE 0x2000 /* Data ready to be read */
398 #define MSG_RCVMORE 0x4000 /* Data remains in current pkt */
400 #define MSG_COMPAT 0x8000 /* used in sendit() */
403 * Header for ancillary data objects in msg_control buffer.
404 * Used for additional information with/about a datagram
405 * not expressible by flags. The format is a sequence
406 * of message elements headed by cmsghdr structures.
409 u_int cmsg_len
; /* data byte count, including hdr */
410 int cmsg_level
; /* originating protocol */
411 int cmsg_type
; /* protocol-specific type */
412 /* followed by u_char cmsg_data[]; */
417 * While we may have more groups than this, the cmsgcred struct must
418 * be able to fit in an mbuf, and NGROUPS_MAX is too large to allow
421 #define CMGROUP_MAX 16
424 * Credentials structure, used to verify the identity of a peer
425 * process that has sent us a message. This is allocated by the
426 * peer process but filled in by the kernel. This prevents the
427 * peer from lying about its identity. (Note that cmcred_groups[0]
428 * is the effective GID.)
431 pid_t cmcred_pid
; /* PID of sending process */
432 uid_t cmcred_uid
; /* real UID of sending process */
433 uid_t cmcred_euid
; /* effective UID of sending process */
434 gid_t cmcred_gid
; /* real GID of sending process */
435 short cmcred_ngroups
; /* number or groups */
436 gid_t cmcred_groups
[CMGROUP_MAX
]; /* groups */
440 /* given pointer to struct cmsghdr, return pointer to data */
441 #define CMSG_DATA(cmsg) ((u_char *)(cmsg) + \
442 ALIGN(sizeof(struct cmsghdr)))
444 /* given pointer to struct cmsghdr, return pointer to next cmsghdr */
445 #define CMSG_NXTHDR(mhdr, cmsg) \
446 (((caddr_t)(cmsg) + ALIGN((cmsg)->cmsg_len) + \
447 ALIGN(sizeof(struct cmsghdr)) > \
448 (caddr_t)(mhdr)->msg_control + (mhdr)->msg_controllen) ? \
449 (struct cmsghdr *)NULL : \
450 (struct cmsghdr *)((caddr_t)(cmsg) + ALIGN((cmsg)->cmsg_len)))
452 #define CMSG_FIRSTHDR(mhdr) ((struct cmsghdr *)(mhdr)->msg_control)
454 /* RFC 2292 additions */
456 #define CMSG_SPACE(l) (ALIGN(sizeof(struct cmsghdr)) + ALIGN(l))
457 #define CMSG_LEN(l) (ALIGN(sizeof(struct cmsghdr)) + (l))
460 #define CMSG_ALIGN(n) ALIGN(n)
463 /* "Socket"-level control message types: */
464 #define SCM_RIGHTS 0x01 /* access rights (array of int) */
465 #define SCM_TIMESTAMP 0x02 /* timestamp (struct timeval) */
466 #define SCM_CREDS 0x03 /* process creds (struct cmsgcred) */
469 * 4.3 compat sockaddr, move to compat file later
472 u_short sa_family
; /* address family */
473 char sa_data
[14]; /* up to 14 bytes of direct address */
477 * 4.3-compat message header (move to compat file later).
480 caddr_t msg_name
; /* optional address */
481 int msg_namelen
; /* size of address */
482 struct iovec
*msg_iov
; /* scatter/gather array */
483 int msg_iovlen
; /* # elements in msg_iov */
484 caddr_t msg_accrights
; /* access rights sent/received */
485 int msg_accrightslen
;
489 * howto arguments for shutdown(2), specified by Posix.1g.
491 #define SHUT_RD 0 /* shut down the reading side */
492 #define SHUT_WR 1 /* shut down the writing side */
493 #define SHUT_RDWR 2 /* shut down both sides */
497 * sendfile(2) header/trailer struct
500 struct iovec
*headers
; /* pointer to an array of header struct iovec's */
501 int hdr_cnt
; /* number of header iovec's */
502 struct iovec
*trailers
; /* pointer to an array of trailer struct iovec's */
503 int trl_cnt
; /* number of trailer iovec's */
509 #include <sys/cdefs.h>
512 int accept
__P((int, struct sockaddr
*, int *));
513 int bind
__P((int, const struct sockaddr
*, int));
514 int connect
__P((int, const struct sockaddr
*, int));
515 int getpeername
__P((int, struct sockaddr
*, int *));
516 int getsockname
__P((int, struct sockaddr
*, int *));
517 int getsockopt
__P((int, int, int, void *, int *));
518 int listen
__P((int, int));
519 ssize_t recv
__P((int, void *, size_t, int));
520 ssize_t recvfrom
__P((int, void *, size_t, int, struct sockaddr
*, int *));
521 ssize_t recvmsg
__P((int, struct msghdr
*, int));
522 ssize_t send
__P((int, const void *, size_t, int));
523 ssize_t sendto
__P((int, const void *,
524 size_t, int, const struct sockaddr
*, int));
525 ssize_t sendmsg
__P((int, const struct msghdr
*, int));
527 int sendfile
__P((int, int, off_t
, size_t, struct sf_hdtr
*, off_t
*, int));
529 int setsockopt
__P((int, int, int, const void *, int));
530 int shutdown
__P((int, int));
531 int socket
__P((int, int, int));
532 int socketpair
__P((int, int, int, int *));
534 void pfctlinput
__P((int, struct sockaddr
*));
539 #endif /* !_SYS_SOCKET_H_ */