socket.h revision 248932
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 248932 2013-03-30 13:30:27Z jilles $
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#include <machine/_align.h>
40
41/*
42 * Definitions related to sockets: types, address families, options.
43 */
44
45/*
46 * Data types.
47 */
48#if __BSD_VISIBLE
49#ifndef _GID_T_DECLARED
50typedef	__gid_t		gid_t;
51#define	_GID_T_DECLARED
52#endif
53
54#ifndef _OFF_T_DECLARED
55typedef	__off_t		off_t;
56#define	_OFF_T_DECLARED
57#endif
58
59#ifndef _PID_T_DECLARED
60typedef	__pid_t		pid_t;
61#define	_PID_T_DECLARED
62#endif
63#endif
64
65#ifndef _SA_FAMILY_T_DECLARED
66typedef	__sa_family_t	sa_family_t;
67#define	_SA_FAMILY_T_DECLARED
68#endif
69
70#ifndef _SOCKLEN_T_DECLARED
71typedef	__socklen_t	socklen_t;
72#define	_SOCKLEN_T_DECLARED
73#endif
74
75#ifndef _SSIZE_T_DECLARED
76typedef	__ssize_t	ssize_t;
77#define	_SSIZE_T_DECLARED
78#endif
79
80#if __BSD_VISIBLE
81#ifndef _UID_T_DECLARED
82typedef	__uid_t		uid_t;
83#define	_UID_T_DECLARED
84#endif
85#endif
86
87/*
88 * Types
89 */
90#define	SOCK_STREAM	1		/* stream socket */
91#define	SOCK_DGRAM	2		/* datagram socket */
92#define	SOCK_RAW	3		/* raw-protocol interface */
93#if __BSD_VISIBLE
94#define	SOCK_RDM	4		/* reliably-delivered message */
95#endif
96#define	SOCK_SEQPACKET	5		/* sequenced packet stream */
97
98#if __BSD_VISIBLE
99/*
100 * Creation flags, OR'ed into socket() and socketpair() type argument.
101 */
102#define	SOCK_CLOEXEC	0x10000000
103#define	SOCK_NONBLOCK	0x20000000
104#endif
105
106/*
107 * Option flags per-socket.
108 */
109#define	SO_DEBUG	0x0001		/* turn on debugging info recording */
110#define	SO_ACCEPTCONN	0x0002		/* socket has had listen() */
111#define	SO_REUSEADDR	0x0004		/* allow local address reuse */
112#define	SO_KEEPALIVE	0x0008		/* keep connections alive */
113#define	SO_DONTROUTE	0x0010		/* just use interface addresses */
114#define	SO_BROADCAST	0x0020		/* permit sending of broadcast msgs */
115#if __BSD_VISIBLE
116#define	SO_USELOOPBACK	0x0040		/* bypass hardware when possible */
117#endif
118#define	SO_LINGER	0x0080		/* linger on close if data present */
119#define	SO_OOBINLINE	0x0100		/* leave received OOB data in line */
120#if __BSD_VISIBLE
121#define	SO_REUSEPORT	0x0200		/* allow local address & port reuse */
122#define	SO_TIMESTAMP	0x0400		/* timestamp received dgram traffic */
123#define	SO_NOSIGPIPE	0x0800		/* no SIGPIPE from EPIPE */
124#define	SO_ACCEPTFILTER	0x1000		/* there is an accept filter */
125#define	SO_BINTIME	0x2000		/* timestamp received dgram traffic */
126#endif
127#define	SO_NO_OFFLOAD	0x4000		/* socket cannot be offloaded */
128#define	SO_NO_DDP	0x8000		/* disable direct data placement */
129
130/*
131 * Additional options, not kept in so_options.
132 */
133#define	SO_SNDBUF	0x1001		/* send buffer size */
134#define	SO_RCVBUF	0x1002		/* receive buffer size */
135#define	SO_SNDLOWAT	0x1003		/* send low-water mark */
136#define	SO_RCVLOWAT	0x1004		/* receive low-water mark */
137#define	SO_SNDTIMEO	0x1005		/* send timeout */
138#define	SO_RCVTIMEO	0x1006		/* receive timeout */
139#define	SO_ERROR	0x1007		/* get error status and clear */
140#define	SO_TYPE		0x1008		/* get socket type */
141#if __BSD_VISIBLE
142#define	SO_LABEL	0x1009		/* socket's MAC label */
143#define	SO_PEERLABEL	0x1010		/* socket's peer's MAC label */
144#define	SO_LISTENQLIMIT	0x1011		/* socket's backlog limit */
145#define	SO_LISTENQLEN	0x1012		/* socket's complete queue length */
146#define	SO_LISTENINCQLEN	0x1013	/* socket's incomplete queue length */
147#define	SO_SETFIB	0x1014		/* use this FIB to route */
148#define	SO_USER_COOKIE	0x1015		/* user cookie (dummynet etc.) */
149#define	SO_PROTOCOL	0x1016		/* get socket protocol (Linux name) */
150#define	SO_PROTOTYPE	SO_PROTOCOL	/* alias for SO_PROTOCOL (SunOS name) */
151#endif
152
153/*
154 * Space reserved for new socket options added by third-party vendors.
155 * This range applies to all socket option levels.  New socket options
156 * in FreeBSD should always use an option value less than SO_VENDOR.
157 */
158#if __BSD_VISIBLE
159#define	SO_VENDOR	0x80000000
160#endif
161
162/*
163 * Structure used for manipulating linger option.
164 */
165struct linger {
166	int	l_onoff;		/* option on/off */
167	int	l_linger;		/* linger time */
168};
169
170#if __BSD_VISIBLE
171struct accept_filter_arg {
172	char	af_name[16];
173	char	af_arg[256-16];
174};
175#endif
176
177/*
178 * Level number for (get/set)sockopt() to apply to socket itself.
179 */
180#define	SOL_SOCKET	0xffff		/* options for socket level */
181
182/*
183 * Address families.
184 */
185#define	AF_UNSPEC	0		/* unspecified */
186#if __BSD_VISIBLE
187#define	AF_LOCAL	AF_UNIX		/* local to host (pipes, portals) */
188#endif
189#define	AF_UNIX		1		/* standardized name for AF_LOCAL */
190#define	AF_INET		2		/* internetwork: UDP, TCP, etc. */
191#if __BSD_VISIBLE
192#define	AF_IMPLINK	3		/* arpanet imp addresses */
193#define	AF_PUP		4		/* pup protocols: e.g. BSP */
194#define	AF_CHAOS	5		/* mit CHAOS protocols */
195#define	AF_NETBIOS	6		/* SMB protocols */
196#define	AF_ISO		7		/* ISO protocols */
197#define	AF_OSI		AF_ISO
198#define	AF_ECMA		8		/* European computer manufacturers */
199#define	AF_DATAKIT	9		/* datakit protocols */
200#define	AF_CCITT	10		/* CCITT protocols, X.25 etc */
201#define	AF_SNA		11		/* IBM SNA */
202#define AF_DECnet	12		/* DECnet */
203#define AF_DLI		13		/* DEC Direct data link interface */
204#define AF_LAT		14		/* LAT */
205#define	AF_HYLINK	15		/* NSC Hyperchannel */
206#define	AF_APPLETALK	16		/* Apple Talk */
207#define	AF_ROUTE	17		/* Internal Routing Protocol */
208#define	AF_LINK		18		/* Link layer interface */
209#define	pseudo_AF_XTP	19		/* eXpress Transfer Protocol (no AF) */
210#define	AF_COIP		20		/* connection-oriented IP, aka ST II */
211#define	AF_CNT		21		/* Computer Network Technology */
212#define pseudo_AF_RTIP	22		/* Help Identify RTIP packets */
213#define	AF_IPX		23		/* Novell Internet Protocol */
214#define	AF_SIP		24		/* Simple Internet Protocol */
215#define	pseudo_AF_PIP	25		/* Help Identify PIP packets */
216#define	AF_ISDN		26		/* Integrated Services Digital Network*/
217#define	AF_E164		AF_ISDN		/* CCITT E.164 recommendation */
218#define	pseudo_AF_KEY	27		/* Internal key-management function */
219#endif
220#define	AF_INET6	28		/* IPv6 */
221#if __BSD_VISIBLE
222#define	AF_NATM		29		/* native ATM access */
223#define	AF_ATM		30		/* ATM */
224#define pseudo_AF_HDRCMPLT 31		/* Used by BPF to not rewrite headers
225					 * in interface output routine
226					 */
227#define	AF_NETGRAPH	32		/* Netgraph sockets */
228#define	AF_SLOW		33		/* 802.3ad slow protocol */
229#define	AF_SCLUSTER	34		/* Sitara cluster protocol */
230#define	AF_ARP		35
231#define	AF_BLUETOOTH	36		/* Bluetooth sockets */
232#define	AF_IEEE80211	37		/* IEEE 802.11 protocol */
233#define	AF_MAX		38
234/*
235 * When allocating a new AF_ constant, please only allocate
236 * even numbered constants for FreeBSD until 134 as odd numbered AF_
237 * constants 39-133 are now reserved for vendors.
238 */
239#define AF_VENDOR00 39
240#define AF_VENDOR01 41
241#define AF_VENDOR02 43
242#define AF_VENDOR03 45
243#define AF_VENDOR04 47
244#define AF_VENDOR05 49
245#define AF_VENDOR06 51
246#define AF_VENDOR07 53
247#define AF_VENDOR08 55
248#define AF_VENDOR09 57
249#define AF_VENDOR10 59
250#define AF_VENDOR11 61
251#define AF_VENDOR12 63
252#define AF_VENDOR13 65
253#define AF_VENDOR14 67
254#define AF_VENDOR15 69
255#define AF_VENDOR16 71
256#define AF_VENDOR17 73
257#define AF_VENDOR18 75
258#define AF_VENDOR19 77
259#define AF_VENDOR20 79
260#define AF_VENDOR21 81
261#define AF_VENDOR22 83
262#define AF_VENDOR23 85
263#define AF_VENDOR24 87
264#define AF_VENDOR25 89
265#define AF_VENDOR26 91
266#define AF_VENDOR27 93
267#define AF_VENDOR28 95
268#define AF_VENDOR29 97
269#define AF_VENDOR30 99
270#define AF_VENDOR31 101
271#define AF_VENDOR32 103
272#define AF_VENDOR33 105
273#define AF_VENDOR34 107
274#define AF_VENDOR35 109
275#define AF_VENDOR36 111
276#define AF_VENDOR37 113
277#define AF_VENDOR38 115
278#define AF_VENDOR39 117
279#define AF_VENDOR40 119
280#define AF_VENDOR41 121
281#define AF_VENDOR42 123
282#define AF_VENDOR43 125
283#define AF_VENDOR44 127
284#define AF_VENDOR45 129
285#define AF_VENDOR46 131
286#define AF_VENDOR47 133
287#endif
288
289/*
290 * Structure used by kernel to store most
291 * addresses.
292 */
293struct sockaddr {
294	unsigned char	sa_len;		/* total length */
295	sa_family_t	sa_family;	/* address family */
296	char		sa_data[14];	/* actually longer; address value */
297};
298#if __BSD_VISIBLE
299#define	SOCK_MAXADDRLEN	255		/* longest possible addresses */
300
301/*
302 * Structure used by kernel to pass protocol
303 * information in raw sockets.
304 */
305struct sockproto {
306	unsigned short	sp_family;		/* address family */
307	unsigned short	sp_protocol;		/* protocol */
308};
309#endif
310
311#include <sys/_sockaddr_storage.h>
312
313#if __BSD_VISIBLE
314/*
315 * Protocol families, same as address families for now.
316 */
317#define	PF_UNSPEC	AF_UNSPEC
318#define	PF_LOCAL	AF_LOCAL
319#define	PF_UNIX		PF_LOCAL	/* backward compatibility */
320#define	PF_INET		AF_INET
321#define	PF_IMPLINK	AF_IMPLINK
322#define	PF_PUP		AF_PUP
323#define	PF_CHAOS	AF_CHAOS
324#define	PF_NETBIOS	AF_NETBIOS
325#define	PF_ISO		AF_ISO
326#define	PF_OSI		AF_ISO
327#define	PF_ECMA		AF_ECMA
328#define	PF_DATAKIT	AF_DATAKIT
329#define	PF_CCITT	AF_CCITT
330#define	PF_SNA		AF_SNA
331#define PF_DECnet	AF_DECnet
332#define PF_DLI		AF_DLI
333#define PF_LAT		AF_LAT
334#define	PF_HYLINK	AF_HYLINK
335#define	PF_APPLETALK	AF_APPLETALK
336#define	PF_ROUTE	AF_ROUTE
337#define	PF_LINK		AF_LINK
338#define	PF_XTP		pseudo_AF_XTP	/* really just proto family, no AF */
339#define	PF_COIP		AF_COIP
340#define	PF_CNT		AF_CNT
341#define	PF_SIP		AF_SIP
342#define	PF_IPX		AF_IPX
343#define PF_RTIP		pseudo_AF_RTIP	/* same format as AF_INET */
344#define PF_PIP		pseudo_AF_PIP
345#define	PF_ISDN		AF_ISDN
346#define	PF_KEY		pseudo_AF_KEY
347#define	PF_INET6	AF_INET6
348#define	PF_NATM		AF_NATM
349#define	PF_ATM		AF_ATM
350#define	PF_NETGRAPH	AF_NETGRAPH
351#define	PF_SLOW		AF_SLOW
352#define PF_SCLUSTER	AF_SCLUSTER
353#define	PF_ARP		AF_ARP
354#define	PF_BLUETOOTH	AF_BLUETOOTH
355
356#define	PF_MAX		AF_MAX
357
358/*
359 * Definitions for network related sysctl, CTL_NET.
360 *
361 * Second level is protocol family.
362 * Third level is protocol number.
363 *
364 * Further levels are defined by the individual families below.
365 */
366#define NET_MAXID	AF_MAX
367
368#define CTL_NET_NAMES { \
369	{ 0, 0 }, \
370	{ "unix", CTLTYPE_NODE }, \
371	{ "inet", CTLTYPE_NODE }, \
372	{ "implink", CTLTYPE_NODE }, \
373	{ "pup", CTLTYPE_NODE }, \
374	{ "chaos", CTLTYPE_NODE }, \
375	{ "xerox_ns", CTLTYPE_NODE }, \
376	{ "iso", CTLTYPE_NODE }, \
377	{ "emca", CTLTYPE_NODE }, \
378	{ "datakit", CTLTYPE_NODE }, \
379	{ "ccitt", CTLTYPE_NODE }, \
380	{ "ibm_sna", CTLTYPE_NODE }, \
381	{ "decnet", CTLTYPE_NODE }, \
382	{ "dec_dli", CTLTYPE_NODE }, \
383	{ "lat", CTLTYPE_NODE }, \
384	{ "hylink", CTLTYPE_NODE }, \
385	{ "appletalk", CTLTYPE_NODE }, \
386	{ "route", CTLTYPE_NODE }, \
387	{ "link_layer", CTLTYPE_NODE }, \
388	{ "xtp", CTLTYPE_NODE }, \
389	{ "coip", CTLTYPE_NODE }, \
390	{ "cnt", CTLTYPE_NODE }, \
391	{ "rtip", CTLTYPE_NODE }, \
392	{ "ipx", CTLTYPE_NODE }, \
393	{ "sip", CTLTYPE_NODE }, \
394	{ "pip", CTLTYPE_NODE }, \
395	{ "isdn", CTLTYPE_NODE }, \
396	{ "key", CTLTYPE_NODE }, \
397	{ "inet6", CTLTYPE_NODE }, \
398	{ "natm", CTLTYPE_NODE }, \
399	{ "atm", CTLTYPE_NODE }, \
400	{ "hdrcomplete", CTLTYPE_NODE }, \
401	{ "netgraph", CTLTYPE_NODE }, \
402	{ "snp", CTLTYPE_NODE }, \
403	{ "scp", CTLTYPE_NODE }, \
404}
405
406/*
407 * PF_ROUTE - Routing table
408 *
409 * Three additional levels are defined:
410 *	Fourth: address family, 0 is wildcard
411 *	Fifth: type of info, defined below
412 *	Sixth: flag(s) to mask with for NET_RT_FLAGS
413 */
414#define NET_RT_DUMP	1		/* dump; may limit to a.f. */
415#define NET_RT_FLAGS	2		/* by flags, e.g. RESOLVING */
416#define NET_RT_IFLIST	3		/* survey interface list */
417#define	NET_RT_IFMALIST	4		/* return multicast address list */
418#define	NET_RT_IFLISTL	5		/* Survey interface list, using 'l'en
419					 * versions of msghdr structs. */
420#define	NET_RT_MAXID	6
421
422#define CTL_NET_RT_NAMES { \
423	{ 0, 0 }, \
424	{ "dump", CTLTYPE_STRUCT }, \
425	{ "flags", CTLTYPE_STRUCT }, \
426	{ "iflist", CTLTYPE_STRUCT }, \
427	{ "ifmalist", CTLTYPE_STRUCT }, \
428	{ "iflistl", CTLTYPE_STRUCT }, \
429}
430#endif /* __BSD_VISIBLE */
431
432/*
433 * Maximum queue length specifiable by listen.
434 */
435#define	SOMAXCONN	128
436
437/*
438 * Message header for recvmsg and sendmsg calls.
439 * Used value-result for recvmsg, value only for sendmsg.
440 */
441struct msghdr {
442	void		*msg_name;		/* optional address */
443	socklen_t	 msg_namelen;		/* size of address */
444	struct iovec	*msg_iov;		/* scatter/gather array */
445	int		 msg_iovlen;		/* # elements in msg_iov */
446	void		*msg_control;		/* ancillary data, see below */
447	socklen_t	 msg_controllen;	/* ancillary data buffer len */
448	int		 msg_flags;		/* flags on received message */
449};
450
451#define	MSG_OOB		0x1		/* process out-of-band data */
452#define	MSG_PEEK	0x2		/* peek at incoming message */
453#define	MSG_DONTROUTE	0x4		/* send without using routing tables */
454#define	MSG_EOR		0x8		/* data completes record */
455#define	MSG_TRUNC	0x10		/* data discarded before delivery */
456#define	MSG_CTRUNC	0x20		/* control data lost before delivery */
457#define	MSG_WAITALL	0x40		/* wait for full request or error */
458#if __POSIX_VISIBLE >= 200809
459#define	MSG_NOSIGNAL	0x20000		/* do not generate SIGPIPE on EOF */
460#endif
461#if __BSD_VISIBLE
462#define	MSG_DONTWAIT	0x80		/* this message should be nonblocking */
463#define	MSG_EOF		0x100		/* data completes connection */
464#define	MSG_NOTIFICATION 0x2000         /* SCTP notification */
465#define	MSG_NBIO	0x4000		/* FIONBIO mode, used by fifofs */
466#define	MSG_COMPAT      0x8000		/* used in sendit() */
467#define	MSG_CMSG_CLOEXEC 0x40000	/* make received fds close-on-exec */
468#endif
469#ifdef _KERNEL
470#define	MSG_SOCALLBCK   0x10000		/* for use by socket callbacks - soreceive (TCP) */
471#endif
472
473/*
474 * Header for ancillary data objects in msg_control buffer.
475 * Used for additional information with/about a datagram
476 * not expressible by flags.  The format is a sequence
477 * of message elements headed by cmsghdr structures.
478 */
479struct cmsghdr {
480	socklen_t	cmsg_len;		/* data byte count, including hdr */
481	int		cmsg_level;		/* originating protocol */
482	int		cmsg_type;		/* protocol-specific type */
483/* followed by	u_char  cmsg_data[]; */
484};
485
486#if __BSD_VISIBLE
487/*
488 * While we may have more groups than this, the cmsgcred struct must
489 * be able to fit in an mbuf and we have historically supported a
490 * maximum of 16 groups.
491*/
492#define CMGROUP_MAX 16
493
494/*
495 * Credentials structure, used to verify the identity of a peer
496 * process that has sent us a message. This is allocated by the
497 * peer process but filled in by the kernel. This prevents the
498 * peer from lying about its identity. (Note that cmcred_groups[0]
499 * is the effective GID.)
500 */
501struct cmsgcred {
502	pid_t	cmcred_pid;		/* PID of sending process */
503	uid_t	cmcred_uid;		/* real UID of sending process */
504	uid_t	cmcred_euid;		/* effective UID of sending process */
505	gid_t	cmcred_gid;		/* real GID of sending process */
506	short	cmcred_ngroups;		/* number or groups */
507	gid_t	cmcred_groups[CMGROUP_MAX];	/* groups */
508};
509
510/*
511 * Socket credentials.
512 */
513struct sockcred {
514	uid_t	sc_uid;			/* real user id */
515	uid_t	sc_euid;		/* effective user id */
516	gid_t	sc_gid;			/* real group id */
517	gid_t	sc_egid;		/* effective group id */
518	int	sc_ngroups;		/* number of supplemental groups */
519	gid_t	sc_groups[1];		/* variable length */
520};
521
522/*
523 * Compute size of a sockcred structure with groups.
524 */
525#define	SOCKCREDSIZE(ngrps) \
526	(sizeof(struct sockcred) + (sizeof(gid_t) * ((ngrps) - 1)))
527
528#endif /* __BSD_VISIBLE */
529
530/* given pointer to struct cmsghdr, return pointer to data */
531#define	CMSG_DATA(cmsg)		((unsigned char *)(cmsg) + \
532				 _ALIGN(sizeof(struct cmsghdr)))
533
534/* given pointer to struct cmsghdr, return pointer to next cmsghdr */
535#define	CMSG_NXTHDR(mhdr, cmsg)	\
536	((char *)(cmsg) == NULL ? CMSG_FIRSTHDR(mhdr) : \
537	    ((char *)(cmsg) + _ALIGN(((struct cmsghdr *)(cmsg))->cmsg_len) + \
538	  _ALIGN(sizeof(struct cmsghdr)) > \
539	    (char *)(mhdr)->msg_control + (mhdr)->msg_controllen) ? \
540	    (struct cmsghdr *)0 : \
541	    (struct cmsghdr *)(void *)((char *)(cmsg) + \
542	    _ALIGN(((struct cmsghdr *)(cmsg))->cmsg_len)))
543
544/*
545 * RFC 2292 requires to check msg_controllen, in case that the kernel returns
546 * an empty list for some reasons.
547 */
548#define	CMSG_FIRSTHDR(mhdr) \
549	((mhdr)->msg_controllen >= sizeof(struct cmsghdr) ? \
550	 (struct cmsghdr *)(mhdr)->msg_control : \
551	 (struct cmsghdr *)NULL)
552
553#if __BSD_VISIBLE
554/* RFC 2292 additions */
555#define	CMSG_SPACE(l)		(_ALIGN(sizeof(struct cmsghdr)) + _ALIGN(l))
556#define	CMSG_LEN(l)		(_ALIGN(sizeof(struct cmsghdr)) + (l))
557#endif
558
559#ifdef _KERNEL
560#define	CMSG_ALIGN(n)	_ALIGN(n)
561#endif
562
563/* "Socket"-level control message types: */
564#define	SCM_RIGHTS	0x01		/* access rights (array of int) */
565#if __BSD_VISIBLE
566#define	SCM_TIMESTAMP	0x02		/* timestamp (struct timeval) */
567#define	SCM_CREDS	0x03		/* process creds (struct cmsgcred) */
568#define	SCM_BINTIME	0x04		/* timestamp (struct bintime) */
569#endif
570
571#if __BSD_VISIBLE
572/*
573 * 4.3 compat sockaddr, move to compat file later
574 */
575struct osockaddr {
576	unsigned short sa_family;	/* address family */
577	char	sa_data[14];		/* up to 14 bytes of direct address */
578};
579
580/*
581 * 4.3-compat message header (move to compat file later).
582 */
583struct omsghdr {
584	char	*msg_name;		/* optional address */
585	int	msg_namelen;		/* size of address */
586	struct	iovec *msg_iov;		/* scatter/gather array */
587	int	msg_iovlen;		/* # elements in msg_iov */
588	char	*msg_accrights;		/* access rights sent/received */
589	int	msg_accrightslen;
590};
591#endif
592
593/*
594 * howto arguments for shutdown(2), specified by Posix.1g.
595 */
596#define	SHUT_RD		0		/* shut down the reading side */
597#define	SHUT_WR		1		/* shut down the writing side */
598#define	SHUT_RDWR	2		/* shut down both sides */
599
600#if __BSD_VISIBLE
601/* for SCTP */
602/* we cheat and use the SHUT_XX defines for these */
603#define PRU_FLUSH_RD     SHUT_RD
604#define PRU_FLUSH_WR     SHUT_WR
605#define PRU_FLUSH_RDWR   SHUT_RDWR
606#endif
607
608
609#if __BSD_VISIBLE
610/*
611 * sendfile(2) header/trailer struct
612 */
613struct sf_hdtr {
614	struct iovec *headers;	/* pointer to an array of header struct iovec's */
615	int hdr_cnt;		/* number of header iovec's */
616	struct iovec *trailers;	/* pointer to an array of trailer struct iovec's */
617	int trl_cnt;		/* number of trailer iovec's */
618};
619
620/*
621 * Sendfile-specific flag(s)
622 */
623#define	SF_NODISKIO     0x00000001
624#define	SF_MNOWAIT	0x00000002
625#define	SF_SYNC		0x00000004
626#endif
627
628#ifndef	_KERNEL
629
630#include <sys/cdefs.h>
631
632__BEGIN_DECLS
633int	accept(int, struct sockaddr * __restrict, socklen_t * __restrict);
634int	bind(int, const struct sockaddr *, socklen_t);
635int	connect(int, const struct sockaddr *, socklen_t);
636#if __BSD_VISIBLE
637int	bindat(int, int, const struct sockaddr *, socklen_t);
638int	connectat(int, int, const struct sockaddr *, socklen_t);
639#endif
640int	getpeername(int, struct sockaddr * __restrict, socklen_t * __restrict);
641int	getsockname(int, struct sockaddr * __restrict, socklen_t * __restrict);
642int	getsockopt(int, int, int, void * __restrict, socklen_t * __restrict);
643int	listen(int, int);
644ssize_t	recv(int, void *, size_t, int);
645ssize_t	recvfrom(int, void *, size_t, int, struct sockaddr * __restrict, socklen_t * __restrict);
646ssize_t	recvmsg(int, struct msghdr *, int);
647ssize_t	send(int, const void *, size_t, int);
648ssize_t	sendto(int, const void *,
649	    size_t, int, const struct sockaddr *, socklen_t);
650ssize_t	sendmsg(int, const struct msghdr *, int);
651#if __BSD_VISIBLE
652int	sendfile(int, int, off_t, size_t, struct sf_hdtr *, off_t *, int);
653int	setfib(int);
654#endif
655int	setsockopt(int, int, int, const void *, socklen_t);
656int	shutdown(int, int);
657int	sockatmark(int);
658int	socket(int, int, int);
659int	socketpair(int, int, int, int *);
660__END_DECLS
661
662#endif /* !_KERNEL */
663
664#ifdef _KERNEL
665struct socket;
666
667struct tcpcb *so_sototcpcb(struct socket *so);
668struct inpcb *so_sotoinpcb(struct socket *so);
669struct sockbuf *so_sockbuf_snd(struct socket *);
670struct sockbuf *so_sockbuf_rcv(struct socket *);
671
672int so_state_get(const struct socket *);
673void so_state_set(struct socket *, int);
674
675int so_options_get(const struct socket *);
676void so_options_set(struct socket *, int);
677
678int so_error_get(const struct socket *);
679void so_error_set(struct socket *, int);
680
681int so_linger_get(const struct socket *);
682void so_linger_set(struct socket *, int);
683
684struct protosw *so_protosw_get(const struct socket *);
685void so_protosw_set(struct socket *, struct protosw *);
686
687void so_sorwakeup_locked(struct socket *so);
688void so_sowwakeup_locked(struct socket *so);
689
690void so_sorwakeup(struct socket *so);
691void so_sowwakeup(struct socket *so);
692
693void so_lock(struct socket *so);
694void so_unlock(struct socket *so);
695
696void so_listeners_apply_all(struct socket *so, void (*func)(struct socket *, void *), void *arg);
697
698#endif
699
700
701#endif /* !_SYS_SOCKET_H_ */
702