2 * Copyright (c) 1982, 1985, 1986, 1988, 1993, 1994
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 * @(#)socket.h 8.4 (Berkeley) 2/21/94
34 * $FreeBSD: src/sys/sys/socket.h,v 1.39.2.7 2001/07/03 11:02:01 ume Exp $
37 #ifndef _SYS_SOCKET_H_
38 #define _SYS_SOCKET_H_
40 #include <sys/_iovec.h>
43 #include <sys/types.h>
45 #include <machine/stdint.h>
47 #define _NO_NAMESPACE_POLLUTION
48 #include <machine/param.h>
49 #undef _NO_NAMESPACE_POLLUTION
52 * Definitions related to sockets: types, address families, options.
58 typedef __uint8_t sa_family_t;
60 #ifndef _SOCKLEN_T_DECLARED
61 #define _SOCKLEN_T_DECLARED
62 typedef __socklen_t socklen_t;
69 #define SOCK_STREAM 1 /* stream socket */
70 #define SOCK_DGRAM 2 /* datagram socket */
71 #define SOCK_RAW 3 /* raw-protocol interface */
72 #define SOCK_RDM 4 /* reliably-delivered message */
73 #define SOCK_SEQPACKET 5 /* sequenced packet stream */
76 * Option flags per-socket.
78 #define SO_DEBUG 0x0001 /* turn on debugging info recording */
79 #define SO_ACCEPTCONN 0x0002 /* socket has had listen() */
80 #define SO_REUSEADDR 0x0004 /* allow local address reuse */
81 #define SO_KEEPALIVE 0x0008 /* keep connections alive */
82 #define SO_DONTROUTE 0x0010 /* just use interface addresses */
83 #define SO_BROADCAST 0x0020 /* permit sending of broadcast msgs */
84 #define SO_USELOOPBACK 0x0040 /* bypass hardware when possible */
85 #define SO_LINGER 0x0080 /* linger on close if data present */
86 #define SO_OOBINLINE 0x0100 /* leave received OOB data in line */
87 #define SO_REUSEPORT 0x0200 /* allow local address & port reuse */
88 #define SO_TIMESTAMP 0x0400 /* timestamp received dgram traffic */
89 #define SO_NOSIGPIPE 0x0800 /* no SIGPIPE from EPIPE */
90 #define SO_ACCEPTFILTER 0x1000 /* there is an accept filter */
93 * Additional options, not kept in so_options.
95 #define SO_SNDBUF 0x1001 /* send buffer size */
96 #define SO_RCVBUF 0x1002 /* receive buffer size */
97 #define SO_SNDLOWAT 0x1003 /* send low-water mark */
98 #define SO_RCVLOWAT 0x1004 /* receive low-water mark */
99 #define SO_SNDTIMEO 0x1005 /* send timeout */
100 #define SO_RCVTIMEO 0x1006 /* receive timeout */
101 #define SO_ERROR 0x1007 /* get error status and clear */
102 #define SO_TYPE 0x1008 /* get socket type */
103 /* 0x1009 reserved for FreeBSD compat */
104 #define SO_SNDSPACE 0x100a /* get appr. send buffer free space */
105 /* 0x1010 ~ 0x102f reserved for FreeBSD compat */
106 #define SO_CPUHINT 0x1030 /* get socket's owner cpuid hint */
109 * Structure used for manipulating linger option.
112 int l_onoff; /* option on/off */
113 int l_linger; /* linger time */
116 struct accept_filter_arg {
122 * Level number for (get/set)sockopt() to apply to socket itself.
124 #define SOL_SOCKET 0xffff /* options for socket level */
129 #define AF_UNSPEC 0 /* unspecified */
130 #define AF_LOCAL 1 /* local to host (pipes, portals) */
131 #define AF_UNIX AF_LOCAL /* backward compatibility */
132 #define AF_INET 2 /* internetwork: UDP, TCP, etc. */
133 #define AF_IMPLINK 3 /* arpanet imp addresses */
134 #define AF_PUP 4 /* pup protocols: e.g. BSP */
135 #define AF_CHAOS 5 /* mit CHAOS protocols */
136 #define AF_NETBIOS 6 /* SMB protocols */
137 #define AF_ISO 7 /* ISO protocols */
138 #define AF_OSI AF_ISO
139 #define AF_ECMA 8 /* European computer manufacturers */
140 #define AF_DATAKIT 9 /* datakit protocols */
141 #define AF_CCITT 10 /* CCITT protocols, X.25 etc */
142 #define AF_SNA 11 /* IBM SNA */
143 #define AF_DECnet 12 /* DECnet */
144 #define AF_DLI 13 /* DEC Direct data link interface */
145 #define AF_LAT 14 /* LAT */
146 #define AF_HYLINK 15 /* NSC Hyperchannel */
147 #define AF_APPLETALK 16 /* Apple Talk */
148 #define AF_ROUTE 17 /* Internal Routing Protocol */
149 #define AF_LINK 18 /* Link layer interface */
150 #define pseudo_AF_XTP 19 /* eXpress Transfer Protocol (no AF) */
151 #define AF_COIP 20 /* connection-oriented IP, aka ST II */
152 #define AF_CNT 21 /* Computer Network Technology */
153 #define pseudo_AF_RTIP 22 /* Help Identify RTIP packets */
154 #define AF_IPX 23 /* Novell Internet Protocol */
155 #define AF_SIP 24 /* Simple Internet Protocol */
156 #define pseudo_AF_PIP 25 /* Help Identify PIP packets */
157 #define AF_ISDN 26 /* Integrated Services Digital Network*/
158 #define AF_E164 AF_ISDN /* CCITT E.164 recommendation */
159 #define pseudo_AF_KEY 27 /* Internal key-management function */
160 #define AF_INET6 28 /* IPv6 */
161 #define AF_NATM 29 /* native ATM access */
162 #define AF_ATM 30 /* ATM */
163 #define pseudo_AF_HDRCMPLT 31 /* Used by BPF to not rewrite headers
164 * in interface output routine
166 #define AF_NETGRAPH 32 /* Netgraph sockets */
167 #define AF_BLUETOOTH 33 /* Bluetooth */
168 #define AF_MPLS 34 /* Multi-Protocol Label Switching */
169 #define AF_IEEE80211 35 /* IEEE 802.11 protocol */
174 * Structure used by kernel to store most
178 __uint8_t sa_len; /* total length */
179 sa_family_t sa_family; /* address family */
180 char sa_data[14]; /* actually longer; address value */
182 #define SOCK_MAXADDRLEN 255 /* longest possible addresses */
186 #ifndef _SYS_LIBKERN_H_
187 #include <sys/libkern.h> /* for bcmp() */
190 static __inline boolean_t
191 sa_equal(const struct sockaddr *a1, const struct sockaddr *a2)
193 return (bcmp(a1, a2, a1->sa_len) == 0);
198 * Structure used by kernel to pass protocol
199 * information in raw sockets.
202 __uint16_t sp_family; /* address family */
203 __uint16_t sp_protocol; /* protocol */
207 * RFC 2553: protocol-independent placeholder for socket addresses
209 #define _SS_MAXSIZE 128
210 #define _SS_ALIGNSIZE (sizeof(int64_t))
211 #define _SS_PAD1SIZE (_SS_ALIGNSIZE - sizeof(unsigned char) - sizeof(sa_family_t))
212 #define _SS_PAD2SIZE (_SS_MAXSIZE - sizeof(unsigned char) - sizeof(sa_family_t) - \
213 _SS_PAD1SIZE - _SS_ALIGNSIZE)
215 struct sockaddr_storage {
216 __uint8_t ss_len; /* address length */
217 sa_family_t ss_family; /* address family */
218 char __ss_pad1[_SS_PAD1SIZE];
219 __int64_t __ss_align; /* force desired structure storage alignment */
220 char __ss_pad2[_SS_PAD2SIZE];
224 * Protocol families, same as address families for now.
226 #define PF_UNSPEC AF_UNSPEC
227 #define PF_LOCAL AF_LOCAL
228 #define PF_UNIX PF_LOCAL /* backward compatibility */
229 #define PF_INET AF_INET
230 #define PF_IMPLINK AF_IMPLINK
231 #define PF_PUP AF_PUP
232 #define PF_CHAOS AF_CHAOS
233 #define PF_NETBIOS AF_NETBIOS
234 #define PF_ISO AF_ISO
235 #define PF_OSI AF_ISO
236 #define PF_ECMA AF_ECMA
237 #define PF_DATAKIT AF_DATAKIT
238 #define PF_CCITT AF_CCITT
239 #define PF_SNA AF_SNA
240 #define PF_DECnet AF_DECnet
241 #define PF_DLI AF_DLI
242 #define PF_LAT AF_LAT
243 #define PF_HYLINK AF_HYLINK
244 #define PF_APPLETALK AF_APPLETALK
245 #define PF_ROUTE AF_ROUTE
246 #define PF_LINK AF_LINK
247 #define PF_XTP pseudo_AF_XTP /* really just proto family, no AF */
248 #define PF_COIP AF_COIP
249 #define PF_CNT AF_CNT
250 #define PF_SIP AF_SIP
251 #define PF_IPX AF_IPX /* same format as AF_NS */
252 #define PF_RTIP pseudo_AF_RTIP /* same format as AF_INET */
253 #define PF_PIP pseudo_AF_PIP
254 #define PF_ISDN AF_ISDN
255 #define PF_KEY pseudo_AF_KEY
256 #define PF_INET6 AF_INET6
257 #define PF_NATM AF_NATM
258 #define PF_ATM AF_ATM
259 #define PF_NETGRAPH AF_NETGRAPH
260 #define PF_BLUETOOTH AF_BLUETOOTH
262 #define PF_MAX AF_MAX
265 * Definitions for network related sysctl, CTL_NET.
267 * Second level is protocol family.
268 * Third level is protocol number.
270 * Further levels are defined by the individual families below.
272 #define NET_MAXID AF_MAX
274 #define CTL_NET_NAMES { \
276 { "unix", CTLTYPE_NODE }, \
277 { "inet", CTLTYPE_NODE }, \
278 { "implink", CTLTYPE_NODE }, \
279 { "pup", CTLTYPE_NODE }, \
280 { "chaos", CTLTYPE_NODE }, \
281 { "xerox_ns", CTLTYPE_NODE }, \
282 { "iso", CTLTYPE_NODE }, \
283 { "emca", CTLTYPE_NODE }, \
284 { "datakit", CTLTYPE_NODE }, \
285 { "ccitt", CTLTYPE_NODE }, \
286 { "ibm_sna", CTLTYPE_NODE }, \
287 { "decnet", CTLTYPE_NODE }, \
288 { "dec_dli", CTLTYPE_NODE }, \
289 { "lat", CTLTYPE_NODE }, \
290 { "hylink", CTLTYPE_NODE }, \
291 { "appletalk", CTLTYPE_NODE }, \
292 { "route", CTLTYPE_NODE }, \
293 { "link_layer", CTLTYPE_NODE }, \
294 { "xtp", CTLTYPE_NODE }, \
295 { "coip", CTLTYPE_NODE }, \
296 { "cnt", CTLTYPE_NODE }, \
297 { "rtip", CTLTYPE_NODE }, \
298 { "ipx", CTLTYPE_NODE }, \
299 { "sip", CTLTYPE_NODE }, \
300 { "pip", CTLTYPE_NODE }, \
301 { "isdn", CTLTYPE_NODE }, \
302 { "key", CTLTYPE_NODE }, \
303 { "inet6", CTLTYPE_NODE }, \
304 { "natm", CTLTYPE_NODE }, \
305 { "atm", CTLTYPE_NODE }, \
306 { "hdrcomplete", CTLTYPE_NODE }, \
307 { "netgraph", CTLTYPE_NODE }, \
308 { "bluetooth", CTLTYPE_NODE}, \
312 * PF_ROUTE - Routing table
314 * Three additional levels are defined:
315 * Fourth: address family, 0 is wildcard
316 * Fifth: type of info, defined below
317 * Sixth: flag(s) to mask with for NET_RT_FLAGS
319 #define NET_RT_DUMP 1 /* dump; may limit to a.f. */
320 #define NET_RT_FLAGS 2 /* by flags, e.g. RESOLVING */
321 #define NET_RT_IFLIST 3 /* survey interface list */
322 #define NET_RT_MAXID 4
324 #define CTL_NET_RT_NAMES { \
326 { "dump", CTLTYPE_STRUCT }, \
327 { "flags", CTLTYPE_STRUCT }, \
328 { "iflist", CTLTYPE_STRUCT }, \
332 * Maximum queue length specifiable by listen.
334 #define SOMAXCONN 128
337 * Maximum setsockopt buffer size
339 #define SOMAXOPT_SIZE 65536
342 * Message header for recvmsg and sendmsg calls.
343 * Used value-result for recvmsg, value only for sendmsg.
346 void *msg_name; /* optional address */
347 socklen_t msg_namelen; /* size of address */
348 struct iovec *msg_iov; /* scatter/gather array */
349 int msg_iovlen; /* # elements in msg_iov */
350 void *msg_control; /* ancillary data, see below */
351 socklen_t msg_controllen; /* ancillary data buffer len */
352 int msg_flags; /* flags on received message */
355 #define MSG_OOB 0x00000001 /* process out-of-band data */
356 #define MSG_PEEK 0x00000002 /* peek at incoming message */
357 #define MSG_DONTROUTE 0x00000004 /* send without using routing tables */
358 #define MSG_EOR 0x00000008 /* data completes record */
359 #define MSG_TRUNC 0x00000010 /* data discarded before delivery */
360 #define MSG_CTRUNC 0x00000020 /* control data lost before delivery */
361 #define MSG_WAITALL 0x00000040 /* wait for full request or error */
362 #define MSG_DONTWAIT 0x00000080 /* this message should be nonblocking */
363 #define MSG_EOF 0x00000100 /* data completes connection */
364 #define MSG_NOTIFICATION 0x00000200 /* notification message */
365 #define MSG_NOSIGNAL 0x00000400 /* No SIGPIPE to unconnected socket stream */
366 #define MSG_SYNC 0x00000800 /* No asynchronized pru_send */
369 * These override FIONBIO. MSG_FNONBLOCKING is functionally equivalent to
372 #define MSG_FBLOCKING 0x00010000 /* force blocking operation */
373 #define MSG_FNONBLOCKING 0x00020000 /* force non-blocking operation */
375 #define MSG_FMASK 0xFFFF0000 /* force mask */
378 * Header for ancillary data objects in msg_control buffer.
379 * Used for additional information with/about a datagram
380 * not expressible by flags. The format is a sequence
381 * of message elements headed by cmsghdr structures.
384 socklen_t cmsg_len; /* data byte count, including hdr */
385 int cmsg_level; /* originating protocol */
386 int cmsg_type; /* protocol-specific type */
387 /* followed by u_char cmsg_data[]; */
391 * While we may have more groups than this, the cmsgcred struct must
392 * be able to fit in an mbuf, and NGROUPS_MAX is too large to allow
395 #define CMGROUP_MAX 16
398 * Credentials structure, used to verify the identity of a peer
399 * process that has sent us a message. This is allocated by the
400 * peer process but filled in by the kernel. This prevents the
401 * peer from lying about its identity. (Note that cmcred_groups[0]
402 * is the effective GID.)
405 pid_t cmcred_pid; /* PID of sending process */
406 uid_t cmcred_uid; /* real UID of sending process */
407 uid_t cmcred_euid; /* effective UID of sending process */
408 gid_t cmcred_gid; /* real GID of sending process */
409 short cmcred_ngroups; /* number or groups */
410 gid_t cmcred_groups[CMGROUP_MAX]; /* groups */
413 /* Alignment requirement for CMSG struct manipulation */
414 #define _CMSG_ALIGN(n) (((n) + 3) & ~3)
417 #define CMSG_ALIGN(n) _CMSG_ALIGN(n)
420 /* given pointer to struct cmsghdr, return pointer to data */
421 #define CMSG_DATA(cmsg) ((unsigned char *)(cmsg) + \
422 _CMSG_ALIGN(sizeof(struct cmsghdr)))
424 /* given pointer to struct cmsghdr, return pointer to next cmsghdr */
425 #define CMSG_NXTHDR(mhdr, cmsg) \
426 (((caddr_t)(cmsg) + _CMSG_ALIGN((cmsg)->cmsg_len) + \
427 _CMSG_ALIGN(sizeof(struct cmsghdr)) > \
428 (caddr_t)(mhdr)->msg_control + (mhdr)->msg_controllen) ? \
430 (struct cmsghdr *)((caddr_t)(cmsg) + _CMSG_ALIGN((cmsg)->cmsg_len)))
433 * RFC 2292 requires to check msg_controllen, in case that the kernel returns
434 * an empty list for some reasons.
436 #define CMSG_FIRSTHDR(mhdr) \
437 ((mhdr)->msg_controllen >= sizeof(struct cmsghdr) ? \
438 (struct cmsghdr *)(mhdr)->msg_control : \
441 /* RFC 2292 additions */
443 #define CMSG_SPACE(l) (_CMSG_ALIGN(sizeof(struct cmsghdr)) + _CMSG_ALIGN(l))
444 #define CMSG_LEN(l) (_CMSG_ALIGN(sizeof(struct cmsghdr)) + (l))
446 /* "Socket"-level control message types: */
447 #define SCM_RIGHTS 0x01 /* access rights (array of int) */
448 #define SCM_TIMESTAMP 0x02 /* timestamp (struct timeval) */
449 #define SCM_CREDS 0x03 /* process creds (struct cmsgcred) */
452 * howto arguments for shutdown(2), specified by Posix.1g.
454 #define SHUT_RD 0 /* shut down the reading side */
455 #define SHUT_WR 1 /* shut down the writing side */
456 #define SHUT_RDWR 2 /* shut down both sides */
459 * sendfile(2) header/trailer struct
462 struct iovec *headers; /* pointer to an array of header struct iovec's */
463 int hdr_cnt; /* number of header iovec's */
464 struct iovec *trailers; /* pointer to an array of trailer struct iovec's */
465 int trl_cnt; /* number of trailer iovec's */
468 #if !defined(_KERNEL) || defined(_KERNEL_VIRTUAL)
470 #ifndef _SYS_CDEFS_H_
471 #include <sys/cdefs.h>
475 int accept (int, struct sockaddr *, socklen_t *);
476 int extaccept (int, int, struct sockaddr *, socklen_t *);
477 int bind (int, const struct sockaddr *, socklen_t);
478 int connect (int, const struct sockaddr *, socklen_t);
479 int extconnect (int, int, struct sockaddr *, socklen_t);
480 int getpeername (int, struct sockaddr *, socklen_t *);
481 int getsockname (int, struct sockaddr *, socklen_t *);
482 int getsockopt (int, int, int, void *, socklen_t *);
483 int listen (int, int);
484 ssize_t recv (int, void *, size_t, int);
485 ssize_t recvfrom (int, void *, size_t, int, struct sockaddr *, socklen_t *);
486 ssize_t recvmsg (int, struct msghdr *, int);
487 ssize_t send (int, const void *, size_t, int);
488 ssize_t sendto (int, const void *,
489 size_t, int, const struct sockaddr *, socklen_t);
490 ssize_t sendmsg (int, const struct msghdr *, int);
491 int sendfile (int, int, off_t, size_t, struct sf_hdtr *, off_t *, int);
492 int setsockopt (int, int, int, const void *, socklen_t);
493 int shutdown (int, int);
495 int socketpair (int, int, int, int *);
497 void pfctlinput (int, struct sockaddr *);
500 #endif /* !_KERNEL */
502 #if !defined(_KERNEL) || defined(_KERNEL_VIRTUAL)
503 #ifndef _SYS_CDEFS_H_
504 #include <sys/cdefs.h>
508 int socket (int, int, int);
510 #endif /* !_KERNEL || _KERNEL_VIRTUAL */
512 #endif /* !_SYS_SOCKET_H_ */