socket.h revision 127976
1/*
2 * Copyright (c) 1982, 1985, 1986, 1988, 1993, 1994
3 *	The Regents of the University of California.  All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
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 * 4. Neither the name of the University nor the names of its contributors
14 *    may be used to endorse or promote products derived from this software
15 *    without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 *
29 *	@(#)socket.h	8.4 (Berkeley) 2/21/94
30 * $FreeBSD: head/sys/sys/socket.h 127976 2004-04-07 04:19:52Z imp $
31 */
32
33#ifndef _SYS_SOCKET_H_
34#define	_SYS_SOCKET_H_
35
36#include <sys/cdefs.h>
37#include <sys/_types.h>
38#include <sys/_iovec.h>
39#define _NO_NAMESPACE_POLLUTION
40#include <machine/param.h>
41#undef _NO_NAMESPACE_POLLUTION
42
43/*
44 * Definitions related to sockets: types, address families, options.
45 */
46
47/*
48 * Data types.
49 */
50#if __BSD_VISIBLE
51#ifndef _GID_T_DECLARED
52typedef	__gid_t		gid_t;
53#define	_GID_T_DECLARED
54#endif
55
56#ifndef _OFF_T_DECLARED
57typedef	__off_t		off_t;
58#define	_OFF_T_DECLARED
59#endif
60
61#ifndef _PID_T_DECLARED
62typedef	__pid_t		pid_t;
63#define	_PID_T_DECLARED
64#endif
65#endif
66
67#ifndef _SA_FAMILY_T_DECLARED
68typedef	__sa_family_t	sa_family_t;
69#define	_SA_FAMILY_T_DECLARED
70#endif
71
72#ifndef _SOCKLEN_T_DECLARED
73typedef	__socklen_t	socklen_t;
74#define	_SOCKLEN_T_DECLARED
75#endif
76
77#ifndef _SSIZE_T_DECLARED
78typedef	__ssize_t	ssize_t;
79#define	_SSIZE_T_DECLARED
80#endif
81
82#if __BSD_VISIBLE
83#ifndef _UID_T_DECLARED
84typedef	__uid_t		uid_t;
85#define	_UID_T_DECLARED
86#endif
87#endif
88
89/*
90 * Types
91 */
92#define	SOCK_STREAM	1		/* stream socket */
93#define	SOCK_DGRAM	2		/* datagram socket */
94#define	SOCK_RAW	3		/* raw-protocol interface */
95#if __BSD_VISIBLE
96#define	SOCK_RDM	4		/* reliably-delivered message */
97#endif
98#define	SOCK_SEQPACKET	5		/* sequenced packet stream */
99
100/*
101 * Option flags per-socket.
102 */
103#define	SO_DEBUG	0x0001		/* turn on debugging info recording */
104#define	SO_ACCEPTCONN	0x0002		/* socket has had listen() */
105#define	SO_REUSEADDR	0x0004		/* allow local address reuse */
106#define	SO_KEEPALIVE	0x0008		/* keep connections alive */
107#define	SO_DONTROUTE	0x0010		/* just use interface addresses */
108#define	SO_BROADCAST	0x0020		/* permit sending of broadcast msgs */
109#if __BSD_VISIBLE
110#define	SO_USELOOPBACK	0x0040		/* bypass hardware when possible */
111#endif
112#define	SO_LINGER	0x0080		/* linger on close if data present */
113#define	SO_OOBINLINE	0x0100		/* leave received OOB data in line */
114#if __BSD_VISIBLE
115#define	SO_REUSEPORT	0x0200		/* allow local address & port reuse */
116#define	SO_TIMESTAMP	0x0400		/* timestamp received dgram traffic */
117#define	SO_NOSIGPIPE	0x0800		/* no SIGPIPE from EPIPE */
118#define	SO_ACCEPTFILTER	0x1000		/* there is an accept filter */
119#define	SO_BINTIME	0x2000		/* timestamp received dgram traffic */
120#endif
121
122/*
123 * Additional options, not kept in so_options.
124 */
125#define	SO_SNDBUF	0x1001		/* send buffer size */
126#define	SO_RCVBUF	0x1002		/* receive buffer size */
127#define	SO_SNDLOWAT	0x1003		/* send low-water mark */
128#define	SO_RCVLOWAT	0x1004		/* receive low-water mark */
129#define	SO_SNDTIMEO	0x1005		/* send timeout */
130#define	SO_RCVTIMEO	0x1006		/* receive timeout */
131#define	SO_ERROR	0x1007		/* get error status and clear */
132#define	SO_TYPE		0x1008		/* get socket type */
133#if __BSD_VISIBLE
134#define	SO_LABEL	0x1009		/* socket's MAC label */
135#define	SO_PEERLABEL	0x1010		/* socket's peer's MAC label */
136#endif
137
138/*
139 * Structure used for manipulating linger option.
140 */
141struct linger {
142	int	l_onoff;		/* option on/off */
143	int	l_linger;		/* linger time */
144};
145
146#if __BSD_VISIBLE
147struct accept_filter_arg {
148	char	af_name[16];
149	char	af_arg[256-16];
150};
151#endif
152
153/*
154 * Level number for (get/set)sockopt() to apply to socket itself.
155 */
156#define	SOL_SOCKET	0xffff		/* options for socket level */
157
158/*
159 * Address families.
160 */
161#define	AF_UNSPEC	0		/* unspecified */
162#if __BSD_VISIBLE
163#define	AF_LOCAL	AF_UNIX		/* local to host (pipes, portals) */
164#endif
165#define	AF_UNIX		1		/* standardized name for AF_LOCAL */
166#define	AF_INET		2		/* internetwork: UDP, TCP, etc. */
167#if __BSD_VISIBLE
168#define	AF_IMPLINK	3		/* arpanet imp addresses */
169#define	AF_PUP		4		/* pup protocols: e.g. BSP */
170#define	AF_CHAOS	5		/* mit CHAOS protocols */
171#define	AF_NETBIOS	6		/* SMB protocols */
172#define	AF_ISO		7		/* ISO protocols */
173#define	AF_OSI		AF_ISO
174#define	AF_ECMA		8		/* European computer manufacturers */
175#define	AF_DATAKIT	9		/* datakit protocols */
176#define	AF_CCITT	10		/* CCITT protocols, X.25 etc */
177#define	AF_SNA		11		/* IBM SNA */
178#define AF_DECnet	12		/* DECnet */
179#define AF_DLI		13		/* DEC Direct data link interface */
180#define AF_LAT		14		/* LAT */
181#define	AF_HYLINK	15		/* NSC Hyperchannel */
182#define	AF_APPLETALK	16		/* Apple Talk */
183#define	AF_ROUTE	17		/* Internal Routing Protocol */
184#define	AF_LINK		18		/* Link layer interface */
185#define	pseudo_AF_XTP	19		/* eXpress Transfer Protocol (no AF) */
186#define	AF_COIP		20		/* connection-oriented IP, aka ST II */
187#define	AF_CNT		21		/* Computer Network Technology */
188#define pseudo_AF_RTIP	22		/* Help Identify RTIP packets */
189#define	AF_IPX		23		/* Novell Internet Protocol */
190#define	AF_SIP		24		/* Simple Internet Protocol */
191#define	pseudo_AF_PIP	25		/* Help Identify PIP packets */
192#define	AF_ISDN		26		/* Integrated Services Digital Network*/
193#define	AF_E164		AF_ISDN		/* CCITT E.164 recommendation */
194#define	pseudo_AF_KEY	27		/* Internal key-management function */
195#endif
196#define	AF_INET6	28		/* IPv6 */
197#if __BSD_VISIBLE
198#define	AF_NATM		29		/* native ATM access */
199#define	AF_ATM		30		/* ATM */
200#define pseudo_AF_HDRCMPLT 31		/* Used by BPF to not rewrite headers
201					 * in interface output routine
202					 */
203#define	AF_NETGRAPH	32		/* Netgraph sockets */
204#define	AF_SLOW		33		/* 802.3ad slow protocol */
205#define	AF_SCLUSTER	34		/* Sitara cluster protocol */
206#define	AF_ARP		35
207#define	AF_MAX		36
208#endif
209
210/*
211 * Structure used by kernel to store most
212 * addresses.
213 */
214struct sockaddr {
215	unsigned char	sa_len;		/* total length */
216	sa_family_t	sa_family;	/* address family */
217	char		sa_data[14];	/* actually longer; address value */
218};
219#if __BSD_VISIBLE
220#define	SOCK_MAXADDRLEN	255		/* longest possible addresses */
221
222/*
223 * Structure used by kernel to pass protocol
224 * information in raw sockets.
225 */
226struct sockproto {
227	unsigned short	sp_family;		/* address family */
228	unsigned short	sp_protocol;		/* protocol */
229};
230#endif
231
232/*
233 * RFC 2553: protocol-independent placeholder for socket addresses
234 */
235#define	_SS_MAXSIZE	128U
236#define	_SS_ALIGNSIZE	(sizeof(__int64_t))
237#define	_SS_PAD1SIZE	(_SS_ALIGNSIZE - sizeof(unsigned char) - \
238			    sizeof(sa_family_t))
239#define	_SS_PAD2SIZE	(_SS_MAXSIZE - sizeof(unsigned char) - \
240			    sizeof(sa_family_t) - _SS_PAD1SIZE - _SS_ALIGNSIZE)
241
242struct sockaddr_storage {
243	unsigned char	ss_len;		/* address length */
244	sa_family_t	ss_family;	/* address family */
245	char		__ss_pad1[_SS_PAD1SIZE];
246	__int64_t	__ss_align;	/* force desired struct alignment */
247	char		__ss_pad2[_SS_PAD2SIZE];
248};
249
250#if __BSD_VISIBLE
251/*
252 * Protocol families, same as address families for now.
253 */
254#define	PF_UNSPEC	AF_UNSPEC
255#define	PF_LOCAL	AF_LOCAL
256#define	PF_UNIX		PF_LOCAL	/* backward compatibility */
257#define	PF_INET		AF_INET
258#define	PF_IMPLINK	AF_IMPLINK
259#define	PF_PUP		AF_PUP
260#define	PF_CHAOS	AF_CHAOS
261#define	PF_NETBIOS	AF_NETBIOS
262#define	PF_ISO		AF_ISO
263#define	PF_OSI		AF_ISO
264#define	PF_ECMA		AF_ECMA
265#define	PF_DATAKIT	AF_DATAKIT
266#define	PF_CCITT	AF_CCITT
267#define	PF_SNA		AF_SNA
268#define PF_DECnet	AF_DECnet
269#define PF_DLI		AF_DLI
270#define PF_LAT		AF_LAT
271#define	PF_HYLINK	AF_HYLINK
272#define	PF_APPLETALK	AF_APPLETALK
273#define	PF_ROUTE	AF_ROUTE
274#define	PF_LINK		AF_LINK
275#define	PF_XTP		pseudo_AF_XTP	/* really just proto family, no AF */
276#define	PF_COIP		AF_COIP
277#define	PF_CNT		AF_CNT
278#define	PF_SIP		AF_SIP
279#define	PF_IPX		AF_IPX
280#define PF_RTIP		pseudo_AF_RTIP	/* same format as AF_INET */
281#define PF_PIP		pseudo_AF_PIP
282#define	PF_ISDN		AF_ISDN
283#define	PF_KEY		pseudo_AF_KEY
284#define	PF_INET6	AF_INET6
285#define	PF_NATM		AF_NATM
286#define	PF_ATM		AF_ATM
287#define	PF_NETGRAPH	AF_NETGRAPH
288#define	PF_SLOW		AF_SLOW
289#define PF_SCLUSTER	AF_SCLUSTER
290#define	PF_ARP		AF_ARP
291
292#define	PF_MAX		AF_MAX
293
294/*
295 * Definitions for network related sysctl, CTL_NET.
296 *
297 * Second level is protocol family.
298 * Third level is protocol number.
299 *
300 * Further levels are defined by the individual families below.
301 */
302#define NET_MAXID	AF_MAX
303
304#define CTL_NET_NAMES { \
305	{ 0, 0 }, \
306	{ "unix", CTLTYPE_NODE }, \
307	{ "inet", CTLTYPE_NODE }, \
308	{ "implink", CTLTYPE_NODE }, \
309	{ "pup", CTLTYPE_NODE }, \
310	{ "chaos", CTLTYPE_NODE }, \
311	{ "xerox_ns", CTLTYPE_NODE }, \
312	{ "iso", CTLTYPE_NODE }, \
313	{ "emca", CTLTYPE_NODE }, \
314	{ "datakit", CTLTYPE_NODE }, \
315	{ "ccitt", CTLTYPE_NODE }, \
316	{ "ibm_sna", CTLTYPE_NODE }, \
317	{ "decnet", CTLTYPE_NODE }, \
318	{ "dec_dli", CTLTYPE_NODE }, \
319	{ "lat", CTLTYPE_NODE }, \
320	{ "hylink", CTLTYPE_NODE }, \
321	{ "appletalk", CTLTYPE_NODE }, \
322	{ "route", CTLTYPE_NODE }, \
323	{ "link_layer", CTLTYPE_NODE }, \
324	{ "xtp", CTLTYPE_NODE }, \
325	{ "coip", CTLTYPE_NODE }, \
326	{ "cnt", CTLTYPE_NODE }, \
327	{ "rtip", CTLTYPE_NODE }, \
328	{ "ipx", CTLTYPE_NODE }, \
329	{ "sip", CTLTYPE_NODE }, \
330	{ "pip", CTLTYPE_NODE }, \
331	{ "isdn", CTLTYPE_NODE }, \
332	{ "key", CTLTYPE_NODE }, \
333	{ "inet6", CTLTYPE_NODE }, \
334	{ "natm", CTLTYPE_NODE }, \
335	{ "atm", CTLTYPE_NODE }, \
336	{ "hdrcomplete", CTLTYPE_NODE }, \
337	{ "netgraph", CTLTYPE_NODE }, \
338	{ "snp", CTLTYPE_NODE }, \
339	{ "scp", CTLTYPE_NODE }, \
340}
341
342/*
343 * PF_ROUTE - Routing table
344 *
345 * Three additional levels are defined:
346 *	Fourth: address family, 0 is wildcard
347 *	Fifth: type of info, defined below
348 *	Sixth: flag(s) to mask with for NET_RT_FLAGS
349 */
350#define NET_RT_DUMP	1		/* dump; may limit to a.f. */
351#define NET_RT_FLAGS	2		/* by flags, e.g. RESOLVING */
352#define NET_RT_IFLIST	3		/* survey interface list */
353#define	NET_RT_IFMALIST	4		/* return multicast address list */
354#define	NET_RT_MAXID	5
355
356#define CTL_NET_RT_NAMES { \
357	{ 0, 0 }, \
358	{ "dump", CTLTYPE_STRUCT }, \
359	{ "flags", CTLTYPE_STRUCT }, \
360	{ "iflist", CTLTYPE_STRUCT }, \
361	{ "ifmalist", CTLTYPE_STRUCT }, \
362}
363#endif /* __BSD_VISIBLE */
364
365/*
366 * Maximum queue length specifiable by listen.
367 */
368#define	SOMAXCONN	128
369
370/*
371 * Message header for recvmsg and sendmsg calls.
372 * Used value-result for recvmsg, value only for sendmsg.
373 */
374struct msghdr {
375	void		*msg_name;		/* optional address */
376	socklen_t	 msg_namelen;		/* size of address */
377	struct iovec	*msg_iov;		/* scatter/gather array */
378	int		 msg_iovlen;		/* # elements in msg_iov */
379	void		*msg_control;		/* ancillary data, see below */
380	socklen_t	 msg_controllen;	/* ancillary data buffer len */
381	int		 msg_flags;		/* flags on received message */
382};
383
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#if __BSD_VISIBLE
392#define	MSG_DONTWAIT	0x80		/* this message should be nonblocking */
393#define	MSG_EOF		0x100		/* data completes connection */
394#define MSG_COMPAT      0x8000		/* used in sendit() */
395#endif
396
397/*
398 * Header for ancillary data objects in msg_control buffer.
399 * Used for additional information with/about a datagram
400 * not expressible by flags.  The format is a sequence
401 * of message elements headed by cmsghdr structures.
402 */
403struct cmsghdr {
404	socklen_t	cmsg_len;		/* data byte count, including hdr */
405	int		cmsg_level;		/* originating protocol */
406	int		cmsg_type;		/* protocol-specific type */
407/* followed by	u_char  cmsg_data[]; */
408};
409
410#if __BSD_VISIBLE
411/*
412 * While we may have more groups than this, the cmsgcred struct must
413 * be able to fit in an mbuf, and NGROUPS_MAX is too large to allow
414 * this.
415*/
416#define CMGROUP_MAX 16
417
418/*
419 * Credentials structure, used to verify the identity of a peer
420 * process that has sent us a message. This is allocated by the
421 * peer process but filled in by the kernel. This prevents the
422 * peer from lying about its identity. (Note that cmcred_groups[0]
423 * is the effective GID.)
424 */
425struct cmsgcred {
426	pid_t	cmcred_pid;		/* PID of sending process */
427	uid_t	cmcred_uid;		/* real UID of sending process */
428	uid_t	cmcred_euid;		/* effective UID of sending process */
429	gid_t	cmcred_gid;		/* real GID of sending process */
430	short	cmcred_ngroups;		/* number or groups */
431	gid_t	cmcred_groups[CMGROUP_MAX];	/* groups */
432};
433#endif /* __BSD_VISIBLE */
434
435/* given pointer to struct cmsghdr, return pointer to data */
436#define	CMSG_DATA(cmsg)		((unsigned char *)(cmsg) + \
437				 _ALIGN(sizeof(struct cmsghdr)))
438
439/* given pointer to struct cmsghdr, return pointer to next cmsghdr */
440#define	CMSG_NXTHDR(mhdr, cmsg)	\
441	(((char *)(cmsg) + _ALIGN((cmsg)->cmsg_len) + \
442	  _ALIGN(sizeof(struct cmsghdr)) > \
443	    (char *)(mhdr)->msg_control + (mhdr)->msg_controllen) ? \
444	    (struct cmsghdr *)NULL : \
445	    (struct cmsghdr *)((char *)(cmsg) + _ALIGN((cmsg)->cmsg_len)))
446
447#define	CMSG_FIRSTHDR(mhdr)	((struct cmsghdr *)(mhdr)->msg_control)
448
449#if __BSD_VISIBLE
450/* RFC 2292 additions */
451#define	CMSG_SPACE(l)		(_ALIGN(sizeof(struct cmsghdr)) + _ALIGN(l))
452#define	CMSG_LEN(l)		(_ALIGN(sizeof(struct cmsghdr)) + (l))
453#endif
454
455#ifdef _KERNEL
456#define	CMSG_ALIGN(n)	_ALIGN(n)
457#endif
458
459/* "Socket"-level control message types: */
460#define	SCM_RIGHTS	0x01		/* access rights (array of int) */
461#if __BSD_VISIBLE
462#define	SCM_TIMESTAMP	0x02		/* timestamp (struct timeval) */
463#define	SCM_CREDS	0x03		/* process creds (struct cmsgcred) */
464#define	SCM_BINTIME	0x04		/* timestamp (struct bintime) */
465#endif
466
467#if __BSD_VISIBLE
468/*
469 * 4.3 compat sockaddr, move to compat file later
470 */
471struct osockaddr {
472	unsigned short sa_family;	/* address family */
473	char	sa_data[14];		/* up to 14 bytes of direct address */
474};
475
476/*
477 * 4.3-compat message header (move to compat file later).
478 */
479struct omsghdr {
480	char	*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	char	*msg_accrights;		/* access rights sent/received */
485	int	msg_accrightslen;
486};
487#endif
488
489/*
490 * howto arguments for shutdown(2), specified by Posix.1g.
491 */
492#define	SHUT_RD		0		/* shut down the reading side */
493#define	SHUT_WR		1		/* shut down the writing side */
494#define	SHUT_RDWR	2		/* shut down both sides */
495
496#if __BSD_VISIBLE
497/*
498 * sendfile(2) header/trailer struct
499 */
500struct sf_hdtr {
501	struct iovec *headers;	/* pointer to an array of header struct iovec's */
502	int hdr_cnt;		/* number of header iovec's */
503	struct iovec *trailers;	/* pointer to an array of trailer struct iovec's */
504	int trl_cnt;		/* number of trailer iovec's */
505};
506
507/*
508 * Sendfile-specific flag(s)
509 */
510#define        SF_NODISKIO     0x00000001
511#endif
512
513#ifndef	_KERNEL
514
515#include <sys/cdefs.h>
516
517__BEGIN_DECLS
518int	accept(int, struct sockaddr * __restrict, socklen_t * __restrict);
519int	bind(int, const struct sockaddr *, socklen_t);
520int	connect(int, const struct sockaddr *, socklen_t);
521int	getpeername(int, struct sockaddr * __restrict, socklen_t * __restrict);
522int	getsockname(int, struct sockaddr * __restrict, socklen_t * __restrict);
523int	getsockopt(int, int, int, void * __restrict, socklen_t * __restrict);
524int	listen(int, int);
525ssize_t	recv(int, void *, size_t, int);
526ssize_t	recvfrom(int, void *, size_t, int, struct sockaddr * __restrict, socklen_t * __restrict);
527ssize_t	recvmsg(int, struct msghdr *, int);
528ssize_t	send(int, const void *, size_t, int);
529ssize_t	sendto(int, const void *,
530	    size_t, int, const struct sockaddr *, socklen_t);
531ssize_t	sendmsg(int, const struct msghdr *, int);
532#if __BSD_VISIBLE
533int	sendfile(int, int, off_t, size_t, struct sf_hdtr *, off_t *, int);
534#endif
535int	setsockopt(int, int, int, const void *, socklen_t);
536int	shutdown(int, int);
537int	sockatmark(int);
538int	socket(int, int, int);
539int	socketpair(int, int, int, int *);
540__END_DECLS
541
542#endif /* !_KERNEL */
543
544#endif /* !_SYS_SOCKET_H_ */
545