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