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 $
35 * $DragonFly: src/sys/sys/socket.h,v 1.3 2003/08/20 07:31:21 rob Exp $
38 #ifndef _SYS_SOCKET_H_
39 #define _SYS_SOCKET_H_
41 #include <machine/ansi.h>
42 #define _NO_NAMESPACE_POLLUTION
43 #include <machine/param.h>
44 #undef _NO_NAMESPACE_POLLUTION
47 * Definitions related to sockets: types, address families, options.
53 typedef u_char sa_family_t;
54 #ifdef _BSD_SOCKLEN_T_
55 typedef _BSD_SOCKLEN_T_ socklen_t;
56 #undef _BSD_SOCKLEN_T_
62 #define SOCK_STREAM 1 /* stream socket */
63 #define SOCK_DGRAM 2 /* datagram socket */
64 #define SOCK_RAW 3 /* raw-protocol interface */
65 #define SOCK_RDM 4 /* reliably-delivered message */
66 #define SOCK_SEQPACKET 5 /* sequenced packet stream */
69 * Option flags per-socket.
71 #define SO_DEBUG 0x0001 /* turn on debugging info recording */
72 #define SO_ACCEPTCONN 0x0002 /* socket has had listen() */
73 #define SO_REUSEADDR 0x0004 /* allow local address reuse */
74 #define SO_KEEPALIVE 0x0008 /* keep connections alive */
75 #define SO_DONTROUTE 0x0010 /* just use interface addresses */
76 #define SO_BROADCAST 0x0020 /* permit sending of broadcast msgs */
77 #define SO_USELOOPBACK 0x0040 /* bypass hardware when possible */
78 #define SO_LINGER 0x0080 /* linger on close if data present */
79 #define SO_OOBINLINE 0x0100 /* leave received OOB data in line */
80 #define SO_REUSEPORT 0x0200 /* allow local address & port reuse */
81 #define SO_TIMESTAMP 0x0400 /* timestamp received dgram traffic */
82 #define SO_ACCEPTFILTER 0x1000 /* there is an accept filter */
85 * Additional options, not kept in so_options.
87 #define SO_SNDBUF 0x1001 /* send buffer size */
88 #define SO_RCVBUF 0x1002 /* receive buffer size */
89 #define SO_SNDLOWAT 0x1003 /* send low-water mark */
90 #define SO_RCVLOWAT 0x1004 /* receive low-water mark */
91 #define SO_SNDTIMEO 0x1005 /* send timeout */
92 #define SO_RCVTIMEO 0x1006 /* receive timeout */
93 #define SO_ERROR 0x1007 /* get error status and clear */
94 #define SO_TYPE 0x1008 /* get socket type */
95 /*efine SO_PRIVSTATE 0x1009 get/deny privileged state */
98 * Structure used for manipulating linger option.
101 int l_onoff; /* option on/off */
102 int l_linger; /* linger time */
105 struct accept_filter_arg {
111 * Level number for (get/set)sockopt() to apply to socket itself.
113 #define SOL_SOCKET 0xffff /* options for socket level */
118 #define AF_UNSPEC 0 /* unspecified */
119 #define AF_LOCAL 1 /* local to host (pipes, portals) */
120 #define AF_UNIX AF_LOCAL /* backward compatibility */
121 #define AF_INET 2 /* internetwork: UDP, TCP, etc. */
122 #define AF_IMPLINK 3 /* arpanet imp addresses */
123 #define AF_PUP 4 /* pup protocols: e.g. BSP */
124 #define AF_CHAOS 5 /* mit CHAOS protocols */
125 #define AF_NS 6 /* XEROX NS protocols */
126 #define AF_ISO 7 /* ISO protocols */
127 #define AF_OSI AF_ISO
128 #define AF_ECMA 8 /* European computer manufacturers */
129 #define AF_DATAKIT 9 /* datakit protocols */
130 #define AF_CCITT 10 /* CCITT protocols, X.25 etc */
131 #define AF_SNA 11 /* IBM SNA */
132 #define AF_DECnet 12 /* DECnet */
133 #define AF_DLI 13 /* DEC Direct data link interface */
134 #define AF_LAT 14 /* LAT */
135 #define AF_HYLINK 15 /* NSC Hyperchannel */
136 #define AF_APPLETALK 16 /* Apple Talk */
137 #define AF_ROUTE 17 /* Internal Routing Protocol */
138 #define AF_LINK 18 /* Link layer interface */
139 #define pseudo_AF_XTP 19 /* eXpress Transfer Protocol (no AF) */
140 #define AF_COIP 20 /* connection-oriented IP, aka ST II */
141 #define AF_CNT 21 /* Computer Network Technology */
142 #define pseudo_AF_RTIP 22 /* Help Identify RTIP packets */
143 #define AF_IPX 23 /* Novell Internet Protocol */
144 #define AF_SIP 24 /* Simple Internet Protocol */
145 #define pseudo_AF_PIP 25 /* Help Identify PIP packets */
146 #define AF_ISDN 26 /* Integrated Services Digital Network*/
147 #define AF_E164 AF_ISDN /* CCITT E.164 recommendation */
148 #define pseudo_AF_KEY 27 /* Internal key-management function */
149 #define AF_INET6 28 /* IPv6 */
150 #define AF_NATM 29 /* native ATM access */
151 #define AF_ATM 30 /* ATM */
152 #define pseudo_AF_HDRCMPLT 31 /* Used by BPF to not rewrite headers
153 * in interface output routine
155 #define AF_NETGRAPH 32 /* Netgraph sockets */
160 * Structure used by kernel to store most
164 u_char sa_len; /* total length */
165 sa_family_t sa_family; /* address family */
166 char sa_data[14]; /* actually longer; address value */
168 #define SOCK_MAXADDRLEN 255 /* longest possible addresses */
171 * Structure used by kernel to pass protocol
172 * information in raw sockets.
175 u_short sp_family; /* address family */
176 u_short sp_protocol; /* protocol */
180 * RFC 2553: protocol-independent placeholder for socket addresses
182 #define _SS_MAXSIZE 128
183 #define _SS_ALIGNSIZE (sizeof(int64_t))
184 #define _SS_PAD1SIZE (_SS_ALIGNSIZE - sizeof(u_char) - sizeof(sa_family_t))
185 #define _SS_PAD2SIZE (_SS_MAXSIZE - sizeof(u_char) - sizeof(sa_family_t) - \
186 _SS_PAD1SIZE - _SS_ALIGNSIZE)
188 struct sockaddr_storage {
189 u_char ss_len; /* address length */
190 sa_family_t ss_family; /* address family */
191 char __ss_pad1[_SS_PAD1SIZE];
192 int64_t __ss_align; /* force desired structure storage alignment */
193 char __ss_pad2[_SS_PAD2SIZE];
197 * Protocol families, same as address families for now.
199 #define PF_UNSPEC AF_UNSPEC
200 #define PF_LOCAL AF_LOCAL
201 #define PF_UNIX PF_LOCAL /* backward compatibility */
202 #define PF_INET AF_INET
203 #define PF_IMPLINK AF_IMPLINK
204 #define PF_PUP AF_PUP
205 #define PF_CHAOS AF_CHAOS
207 #define PF_ISO AF_ISO
208 #define PF_OSI AF_ISO
209 #define PF_ECMA AF_ECMA
210 #define PF_DATAKIT AF_DATAKIT
211 #define PF_CCITT AF_CCITT
212 #define PF_SNA AF_SNA
213 #define PF_DECnet AF_DECnet
214 #define PF_DLI AF_DLI
215 #define PF_LAT AF_LAT
216 #define PF_HYLINK AF_HYLINK
217 #define PF_APPLETALK AF_APPLETALK
218 #define PF_ROUTE AF_ROUTE
219 #define PF_LINK AF_LINK
220 #define PF_XTP pseudo_AF_XTP /* really just proto family, no AF */
221 #define PF_COIP AF_COIP
222 #define PF_CNT AF_CNT
223 #define PF_SIP AF_SIP
224 #define PF_IPX AF_IPX /* same format as AF_NS */
225 #define PF_RTIP pseudo_AF_RTIP /* same format as AF_INET */
226 #define PF_PIP pseudo_AF_PIP
227 #define PF_ISDN AF_ISDN
228 #define PF_KEY pseudo_AF_KEY
229 #define PF_INET6 AF_INET6
230 #define PF_NATM AF_NATM
231 #define PF_ATM AF_ATM
232 #define PF_NETGRAPH AF_NETGRAPH
234 #define PF_MAX AF_MAX
237 * Definitions for network related sysctl, CTL_NET.
239 * Second level is protocol family.
240 * Third level is protocol number.
242 * Further levels are defined by the individual families below.
244 #define NET_MAXID AF_MAX
246 #define CTL_NET_NAMES { \
248 { "unix", CTLTYPE_NODE }, \
249 { "inet", CTLTYPE_NODE }, \
250 { "implink", CTLTYPE_NODE }, \
251 { "pup", CTLTYPE_NODE }, \
252 { "chaos", CTLTYPE_NODE }, \
253 { "xerox_ns", CTLTYPE_NODE }, \
254 { "iso", CTLTYPE_NODE }, \
255 { "emca", CTLTYPE_NODE }, \
256 { "datakit", CTLTYPE_NODE }, \
257 { "ccitt", CTLTYPE_NODE }, \
258 { "ibm_sna", CTLTYPE_NODE }, \
259 { "decnet", CTLTYPE_NODE }, \
260 { "dec_dli", CTLTYPE_NODE }, \
261 { "lat", CTLTYPE_NODE }, \
262 { "hylink", CTLTYPE_NODE }, \
263 { "appletalk", CTLTYPE_NODE }, \
264 { "route", CTLTYPE_NODE }, \
265 { "link_layer", CTLTYPE_NODE }, \
266 { "xtp", CTLTYPE_NODE }, \
267 { "coip", CTLTYPE_NODE }, \
268 { "cnt", CTLTYPE_NODE }, \
269 { "rtip", CTLTYPE_NODE }, \
270 { "ipx", CTLTYPE_NODE }, \
271 { "sip", CTLTYPE_NODE }, \
272 { "pip", CTLTYPE_NODE }, \
273 { "isdn", CTLTYPE_NODE }, \
274 { "key", CTLTYPE_NODE }, \
275 { "inet6", CTLTYPE_NODE }, \
276 { "natm", CTLTYPE_NODE }, \
277 { "atm", CTLTYPE_NODE }, \
278 { "hdrcomplete", CTLTYPE_NODE }, \
279 { "netgraph", CTLTYPE_NODE }, \
283 * PF_ROUTE - Routing table
285 * Three additional levels are defined:
286 * Fourth: address family, 0 is wildcard
287 * Fifth: type of info, defined below
288 * Sixth: flag(s) to mask with for NET_RT_FLAGS
290 #define NET_RT_DUMP 1 /* dump; may limit to a.f. */
291 #define NET_RT_FLAGS 2 /* by flags, e.g. RESOLVING */
292 #define NET_RT_IFLIST 3 /* survey interface list */
293 #define NET_RT_MAXID 4
295 #define CTL_NET_RT_NAMES { \
297 { "dump", CTLTYPE_STRUCT }, \
298 { "flags", CTLTYPE_STRUCT }, \
299 { "iflist", CTLTYPE_STRUCT }, \
303 * Maximum queue length specifiable by listen.
305 #define SOMAXCONN 128
308 * Message header for recvmsg and sendmsg calls.
309 * Used value-result for recvmsg, value only for sendmsg.
312 void *msg_name; /* optional address */
313 socklen_t msg_namelen; /* size of address */
314 struct iovec *msg_iov; /* scatter/gather array */
315 int msg_iovlen; /* # elements in msg_iov */
316 void *msg_control; /* ancillary data, see below */
317 socklen_t msg_controllen; /* ancillary data buffer len */
318 int msg_flags; /* flags on received message */
321 #define MSG_OOB 0x1 /* process out-of-band data */
322 #define MSG_PEEK 0x2 /* peek at incoming message */
323 #define MSG_DONTROUTE 0x4 /* send without using routing tables */
324 #define MSG_EOR 0x8 /* data completes record */
325 #define MSG_TRUNC 0x10 /* data discarded before delivery */
326 #define MSG_CTRUNC 0x20 /* control data lost before delivery */
327 #define MSG_WAITALL 0x40 /* wait for full request or error */
328 #define MSG_DONTWAIT 0x80 /* this message should be nonblocking */
329 #define MSG_EOF 0x100 /* data completes connection */
330 #define MSG_COMPAT 0x8000 /* used in sendit() */
333 * Header for ancillary data objects in msg_control buffer.
334 * Used for additional information with/about a datagram
335 * not expressible by flags. The format is a sequence
336 * of message elements headed by cmsghdr structures.
339 socklen_t cmsg_len; /* data byte count, including hdr */
340 int cmsg_level; /* originating protocol */
341 int cmsg_type; /* protocol-specific type */
342 /* followed by u_char cmsg_data[]; */
346 * While we may have more groups than this, the cmsgcred struct must
347 * be able to fit in an mbuf, and NGROUPS_MAX is too large to allow
350 #define CMGROUP_MAX 16
353 * Credentials structure, used to verify the identity of a peer
354 * process that has sent us a message. This is allocated by the
355 * peer process but filled in by the kernel. This prevents the
356 * peer from lying about its identity. (Note that cmcred_groups[0]
357 * is the effective GID.)
360 pid_t cmcred_pid; /* PID of sending process */
361 uid_t cmcred_uid; /* real UID of sending process */
362 uid_t cmcred_euid; /* effective UID of sending process */
363 gid_t cmcred_gid; /* real GID of sending process */
364 short cmcred_ngroups; /* number or groups */
365 gid_t cmcred_groups[CMGROUP_MAX]; /* groups */
368 /* given pointer to struct cmsghdr, return pointer to data */
369 #define CMSG_DATA(cmsg) ((u_char *)(cmsg) + \
370 _ALIGN(sizeof(struct cmsghdr)))
372 /* given pointer to struct cmsghdr, return pointer to next cmsghdr */
373 #define CMSG_NXTHDR(mhdr, cmsg) \
374 (((caddr_t)(cmsg) + _ALIGN((cmsg)->cmsg_len) + \
375 _ALIGN(sizeof(struct cmsghdr)) > \
376 (caddr_t)(mhdr)->msg_control + (mhdr)->msg_controllen) ? \
377 (struct cmsghdr *)NULL : \
378 (struct cmsghdr *)((caddr_t)(cmsg) + _ALIGN((cmsg)->cmsg_len)))
380 #define CMSG_FIRSTHDR(mhdr) ((struct cmsghdr *)(mhdr)->msg_control)
382 /* RFC 2292 additions */
384 #define CMSG_SPACE(l) (_ALIGN(sizeof(struct cmsghdr)) + _ALIGN(l))
385 #define CMSG_LEN(l) (_ALIGN(sizeof(struct cmsghdr)) + (l))
388 #define CMSG_ALIGN(n) _ALIGN(n)
391 /* "Socket"-level control message types: */
392 #define SCM_RIGHTS 0x01 /* access rights (array of int) */
393 #define SCM_TIMESTAMP 0x02 /* timestamp (struct timeval) */
394 #define SCM_CREDS 0x03 /* process creds (struct cmsgcred) */
397 * 4.3 compat sockaddr, move to compat file later
400 u_short sa_family; /* address family */
401 char sa_data[14]; /* up to 14 bytes of direct address */
405 * 4.3-compat message header (move to compat file later).
408 caddr_t msg_name; /* optional address */
409 int msg_namelen; /* size of address */
410 struct iovec *msg_iov; /* scatter/gather array */
411 int msg_iovlen; /* # elements in msg_iov */
412 caddr_t msg_accrights; /* access rights sent/received */
413 int msg_accrightslen;
417 * howto arguments for shutdown(2), specified by Posix.1g.
419 #define SHUT_RD 0 /* shut down the reading side */
420 #define SHUT_WR 1 /* shut down the writing side */
421 #define SHUT_RDWR 2 /* shut down both sides */
424 * sendfile(2) header/trailer struct
427 struct iovec *headers; /* pointer to an array of header struct iovec's */
428 int hdr_cnt; /* number of header iovec's */
429 struct iovec *trailers; /* pointer to an array of trailer struct iovec's */
430 int trl_cnt; /* number of trailer iovec's */
435 #include <sys/cdefs.h>
438 int accept (int, struct sockaddr *, socklen_t *);
439 int bind (int, const struct sockaddr *, socklen_t);
440 int connect (int, const struct sockaddr *, socklen_t);
441 int getpeername (int, struct sockaddr *, socklen_t *);
442 int getsockname (int, struct sockaddr *, socklen_t *);
443 int getsockopt (int, int, int, void *, socklen_t *);
444 int listen (int, int);
445 ssize_t recv (int, void *, size_t, int);
446 ssize_t recvfrom (int, void *, size_t, int, struct sockaddr *, socklen_t *);
447 ssize_t recvmsg (int, struct msghdr *, int);
448 ssize_t send (int, const void *, size_t, int);
449 ssize_t sendto (int, const void *,
450 size_t, int, const struct sockaddr *, socklen_t);
451 ssize_t sendmsg (int, const struct msghdr *, int);
452 int sendfile (int, int, off_t, size_t, struct sf_hdtr *, off_t *, int);
453 int setsockopt (int, int, int, const void *, socklen_t);
454 int shutdown (int, int);
455 int socket (int, int, int);
456 int socketpair (int, int, int, int *);
458 void pfctlinput (int, struct sockaddr *);
461 #endif /* !_KERNEL */
463 #endif /* !_SYS_SOCKET_H_ */