xref: /illumos-gate/usr/src/uts/common/sys/socket.h (revision 45916cd2)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 /*
22  * Copyright 2006 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 /*	Copyright (c) 1983, 1984, 1985, 1986, 1987, 1988, 1989 AT&T	*/
27 /*	  All Rights Reserved	*/
28 
29 /*
30  * University Copyright- Copyright (c) 1982, 1986, 1988
31  * The Regents of the University of California
32  * All Rights Reserved
33  *
34  * University Acknowledgment- Portions of this document are derived from
35  * software developed by the University of California, Berkeley, and its
36  * contributors.
37  */
38 
39 #ifndef	_SYS_SOCKET_H
40 #define	_SYS_SOCKET_H
41 
42 #pragma ident	"%Z%%M%	%I%	%E% SMI"
43 
44 #include <sys/types.h>
45 #include <sys/uio.h>
46 #include <sys/feature_tests.h>
47 #include <sys/socket_impl.h>
48 #if !defined(_XPG4_2) || defined(__EXTENSIONS__)
49 #ifndef	_KERNEL
50 #include <sys/netconfig.h>
51 #endif	/* !_KERNEL */
52 #include <netinet/in.h>
53 #endif	/* !defined(_XPG4_2) || defined(__EXTENSIONS__) */
54 
55 #ifdef	__cplusplus
56 extern "C" {
57 #endif
58 
59 #ifndef	_SOCKLEN_T
60 #define	_SOCKLEN_T
61 
62 /*
63  * The socklen definitions are reproduced in netinet/in.h for the inet6_
64  * functions.  Exposing all of sys/socket.h via netinet/in.h breaks existing
65  * applications and is not required by austin.
66  */
67 #if defined(_XPG4_2) && !defined(_XPG5) && !defined(_LP64)
68 typedef	size_t		socklen_t;
69 #else
70 typedef	uint32_t	socklen_t;
71 #endif	/* defined(_XPG4_2) && !defined(_XPG5) && !defined(_LP64) */
72 
73 #if defined(_XPG4_2) || defined(_BOOT)
74 typedef	socklen_t	*_RESTRICT_KYWD Psocklen_t;
75 #else
76 typedef	void		*_RESTRICT_KYWD Psocklen_t;
77 #endif	/* defined(_XPG4_2) || defined(_BOOT) */
78 
79 #endif	/* _SOCKLEN_T */
80 
81 /*
82  * Definitions related to sockets: types, address families, options.
83  */
84 #if !defined(_XPG4_2) || defined(__EXTENSIONS__)
85 #ifndef	NC_TPI_CLTS
86 #define	NC_TPI_CLTS	1		/* must agree with netconfig.h */
87 #define	NC_TPI_COTS	2		/* must agree with netconfig.h */
88 #define	NC_TPI_COTS_ORD	3		/* must agree with netconfig.h */
89 #define	NC_TPI_RAW	4		/* must agree with netconfig.h */
90 #endif	/* !NC_TPI_CLTS */
91 #endif	/* !defined(_XPG4_2) || defined(__EXTENSIONS__) */
92 
93 /*
94  * Types
95  */
96 #if !defined(_XPG4_2) || defined(__EXTENSIONS__)
97 #define	SOCK_STREAM	NC_TPI_COTS	/* stream socket */
98 #define	SOCK_DGRAM	NC_TPI_CLTS	/* datagram socket */
99 #define	SOCK_RAW	NC_TPI_RAW	/* raw-protocol interface */
100 #else
101 #define	SOCK_STREAM	2		/* stream socket */
102 #define	SOCK_DGRAM	1		/* datagram socket */
103 #define	SOCK_RAW	4		/* raw-protocol interface */
104 #endif	/* !defined(_XPG4_2) || defined(__EXTENSIONS__) */
105 #define	SOCK_RDM	5		/* reliably-delivered message */
106 #define	SOCK_SEQPACKET	6		/* sequenced packet stream */
107 
108 /*
109  * Option flags per-socket.
110  */
111 #define	SO_DEBUG	0x0001		/* turn on debugging info recording */
112 #define	SO_ACCEPTCONN	0x0002		/* socket has had listen() */
113 #define	SO_REUSEADDR	0x0004		/* allow local address reuse */
114 #define	SO_KEEPALIVE	0x0008		/* keep connections alive */
115 #define	SO_DONTROUTE	0x0010		/* just use interface addresses */
116 #define	SO_BROADCAST	0x0020		/* permit sending of broadcast msgs */
117 #define	SO_USELOOPBACK	0x0040		/* bypass hardware when possible */
118 #define	SO_LINGER	0x0080		/* linger on close if data present */
119 #define	SO_OOBINLINE	0x0100		/* leave received OOB data in line */
120 #define	SO_DGRAM_ERRIND	0x0200		/* Application wants delayed error */
121 #define	SO_RECVUCRED	0x0400		/* Application wants ucred of sender */
122 
123 #ifdef _KERNEL
124 #define	SO_SND_COPYAVOID 0x0800		/* Internal: use zero-copy */
125 #endif /* _KERNEL */
126 
127 /*
128  * N.B.: The following definition is present only for compatibility
129  * with release 3.0.  It will disappear in later releases.
130  */
131 #define	SO_DONTLINGER	(~SO_LINGER)	/* ~SO_LINGER */
132 
133 /*
134  * Additional options, not kept in so_options.
135  */
136 #define	SO_SNDBUF	0x1001		/* send buffer size */
137 #define	SO_RCVBUF	0x1002		/* receive buffer size */
138 #define	SO_SNDLOWAT	0x1003		/* send low-water mark */
139 #define	SO_RCVLOWAT	0x1004		/* receive low-water mark */
140 #define	SO_SNDTIMEO	0x1005		/* send timeout */
141 #define	SO_RCVTIMEO	0x1006		/* receive timeout */
142 #define	SO_ERROR	0x1007		/* get error status and clear */
143 #define	SO_TYPE		0x1008		/* get socket type */
144 #define	SO_PROTOTYPE	0x1009		/* get/set protocol type */
145 #define	SO_ANON_MLP	0x100a		/* create MLP on anonymous bind */
146 #define	SO_MAC_EXEMPT	0x100b		/* allow dominated unlabeled peers */
147 
148 /* "Socket"-level control message types: */
149 #define	SCM_RIGHTS	0x1010		/* access rights (array of int) */
150 
151 #define	SO_SECATTR	0x1011		/* socket's security attributes */
152 #define	SCM_UCRED	0x1012		/* sender's ucred */
153 #define	SO_TIMESTAMP	0x1013		/* socket-level timestamp option */
154 #define	SCM_TIMESTAMP	SO_TIMESTAMP	/* socket control message timestamp */
155 
156 #ifdef	_KERNEL
157 #define	SO_SRCADDR	0x2001		/* Internal: AF_UNIX source address */
158 #define	SO_FILEP	0x2002		/* Internal: AF_UNIX file pointer */
159 #define	SO_UNIX_CLOSE	0x2003		/* Internal: AF_UNIX peer closed */
160 #endif	/* _KERNEL */
161 
162 #ifdef	_KERNEL
163 /*
164  * new socket open flags to identify socket and acceptor streams
165  */
166 #define	SO_ACCEPTOR	0x20000		/* acceptor socket */
167 #define	SO_SOCKSTR	0x40000		/* normal socket stream */
168 #endif	/* _KERNEL */
169 
170 /*
171  * Structure used for manipulating linger option.
172  */
173 struct	linger {
174 	int	l_onoff;		/* option on/off */
175 	int	l_linger;		/* linger time */
176 };
177 
178 /*
179  * Level number for (get/set)sockopt() to apply to socket itself.
180  */
181 #define	SOL_SOCKET	0xffff		/* options for socket level */
182 
183 /*
184  * Address families.
185  */
186 #define	AF_UNSPEC	0		/* unspecified */
187 #define	AF_UNIX		1		/* local to host (pipes, portals) */
188 #define	AF_INET		2		/* internetwork: UDP, TCP, etc. */
189 #define	AF_IMPLINK	3		/* arpanet imp addresses */
190 #define	AF_PUP		4		/* pup protocols: e.g. BSP */
191 #define	AF_CHAOS	5		/* mit CHAOS protocols */
192 #define	AF_NS		6		/* XEROX NS protocols */
193 #define	AF_NBS		7		/* nbs protocols */
194 #define	AF_ECMA		8		/* european computer manufacturers */
195 #define	AF_DATAKIT	9		/* datakit protocols */
196 #define	AF_CCITT	10		/* CCITT protocols, X.25 etc */
197 #define	AF_SNA		11		/* IBM SNA */
198 #define	AF_DECnet	12		/* DECnet */
199 #define	AF_DLI		13		/* Direct data link interface */
200 #define	AF_LAT		14		/* LAT */
201 #define	AF_HYLINK	15		/* NSC Hyperchannel */
202 #define	AF_APPLETALK	16		/* Apple Talk */
203 #define	AF_NIT		17		/* Network Interface Tap */
204 #define	AF_802		18		/* IEEE 802.2, also ISO 8802 */
205 #define	AF_OSI		19		/* umbrella for all families used */
206 #define	AF_X25		20		/* CCITT X.25 in particular */
207 #define	AF_OSINET	21		/* AFI = 47, IDI = 4 */
208 #define	AF_GOSIP	22		/* U.S. Government OSI */
209 #define	AF_IPX		23		/* Novell Internet Protocol */
210 #define	AF_ROUTE	24		/* Internal Routing Protocol */
211 #define	AF_LINK		25		/* Link-layer interface */
212 #define	AF_INET6	26		/* Internet Protocol, Version 6 */
213 #define	AF_KEY		27		/* Security Association DB socket */
214 #define	AF_NCA		28		/* NCA socket */
215 #define	AF_POLICY	29		/* Security Policy DB socket */
216 
217 #define	AF_MAX		29
218 
219 /*
220  * Protocol families, same as address families for now.
221  */
222 #define	PF_UNSPEC	AF_UNSPEC
223 #define	PF_UNIX		AF_UNIX
224 #define	PF_INET		AF_INET
225 #define	PF_IMPLINK	AF_IMPLINK
226 #define	PF_PUP		AF_PUP
227 #define	PF_CHAOS	AF_CHAOS
228 #define	PF_NS		AF_NS
229 #define	PF_NBS		AF_NBS
230 #define	PF_ECMA		AF_ECMA
231 #define	PF_DATAKIT	AF_DATAKIT
232 #define	PF_CCITT	AF_CCITT
233 #define	PF_SNA		AF_SNA
234 #define	PF_DECnet	AF_DECnet
235 #define	PF_DLI		AF_DLI
236 #define	PF_LAT		AF_LAT
237 #define	PF_HYLINK	AF_HYLINK
238 #define	PF_APPLETALK	AF_APPLETALK
239 #define	PF_NIT		AF_NIT
240 #define	PF_802		AF_802
241 #define	PF_OSI		AF_OSI
242 #define	PF_X25		AF_X25
243 #define	PF_OSINET	AF_OSINET
244 #define	PF_GOSIP	AF_GOSIP
245 #define	PF_IPX		AF_IPX
246 #define	PF_ROUTE	AF_ROUTE
247 #define	PF_LINK		AF_LINK
248 #define	PF_INET6	AF_INET6
249 #define	PF_KEY		AF_KEY
250 #define	PF_NCA		AF_NCA
251 #define	PF_POLICY	AF_POLICY
252 
253 #define	PF_MAX		AF_MAX
254 
255 /*
256  * Maximum queue length specifiable by listen.
257  */
258 #define	SOMAXCONN	128
259 
260 /*
261  * Message header for recvmsg and sendmsg calls.
262  */
263 struct msghdr {
264 	void		*msg_name;		/* optional address */
265 	socklen_t	msg_namelen;		/* size of address */
266 	struct iovec	*msg_iov;		/* scatter/gather array */
267 	int		msg_iovlen;		/* # elements in msg_iov */
268 
269 #if defined(_XPG4_2) || defined(_KERNEL)
270 	void		*msg_control;		/* ancillary data */
271 	socklen_t	msg_controllen;		/* ancillary data buffer len */
272 	int		msg_flags;		/* flags on received message */
273 #else
274 	caddr_t		msg_accrights;	/* access rights sent/received */
275 	int		msg_accrightslen;
276 #endif	/* defined(_XPG4_2) || defined(_KERNEL) */
277 };
278 
279 #if	defined(_KERNEL)
280 
281 /*
282  *	N.B.:  we assume that omsghdr and nmsghdr are isomorphic, with
283  *	the sole exception that nmsghdr has the additional msg_flags
284  *	field at the end.
285  */
286 struct omsghdr {
287 	void		*msg_name;	/* optional address */
288 	socklen_t	msg_namelen;	/* size of address */
289 	struct	iovec	*msg_iov;	/* scatter/gather array */
290 	int		msg_iovlen;	/* # elements in msg_iov */
291 	caddr_t		msg_accrights;	/* access rights sent/received */
292 	int		msg_accrightslen;
293 };
294 
295 #define	nmsghdr		msghdr
296 
297 #if defined(_SYSCALL32)
298 
299 struct omsghdr32 {
300 	caddr32_t	msg_name;	/* optional address */
301 	uint32_t	msg_namelen;	/* size of address */
302 	caddr32_t	msg_iov;	/* scatter/gather array */
303 	int32_t		msg_iovlen;	/* # elements in msg_iov */
304 	caddr32_t	msg_accrights;	/* access rights sent/received */
305 	uint32_t	msg_accrightslen;
306 };
307 
308 struct msghdr32 {
309 	caddr32_t	msg_name;	/* optional address */
310 	uint32_t	msg_namelen;	/* size of address */
311 	caddr32_t	msg_iov;	/* scatter/gather array */
312 	int32_t		msg_iovlen;	/* # elements in msg_iov */
313 	caddr32_t	msg_control;	/* ancillary data */
314 	uint32_t	msg_controllen;	/* ancillary data buffer len */
315 	int32_t		msg_flags;	/* flags on received message */
316 };
317 
318 #define	nmsghdr32	msghdr32
319 
320 #endif	/* _SYSCALL32 */
321 #endif	/* _KERNEL */
322 
323 #define	MSG_OOB		0x1		/* process out-of-band data */
324 #define	MSG_PEEK	0x2		/* peek at incoming message */
325 #define	MSG_DONTROUTE	0x4		/* send without using routing tables */
326 /* Added for XPGv2 compliance */
327 #define	MSG_EOR		0x8		/* Terminates a record */
328 #define	MSG_CTRUNC	0x10		/* Control data truncated */
329 #define	MSG_TRUNC	0x20		/* Normal data truncated */
330 #define	MSG_WAITALL	0x40		/* Wait for complete recv or error */
331 /* End of XPGv2 compliance */
332 #define	MSG_DONTWAIT	0x80		/* Don't block for this recv */
333 #define	MSG_NOTIFICATION 0x100		/* Notification, not data */
334 #define	MSG_XPG4_2	0x8000		/* Private: XPG4.2 flag */
335 
336 #define	MSG_MAXIOVLEN	16
337 
338 /* Added for XPGv2 compliance */
339 #define	SHUT_RD		0
340 #define	SHUT_WR		1
341 #define	SHUT_RDWR	2
342 
343 struct cmsghdr {
344 	socklen_t	cmsg_len;	/* data byte count, including hdr */
345 	int		cmsg_level;	/* originating protocol */
346 	int		cmsg_type;	/* protocol-specific type */
347 };
348 
349 #if defined(_XPG4_2) || defined(_KERNEL)
350 #if defined(__sparc)
351 /* To maintain backward compatibility, alignment needs to be 8 on sparc. */
352 #define	_CMSG_HDR_ALIGNMENT	8
353 #else
354 /* for __i386 (and other future architectures) */
355 #define	_CMSG_HDR_ALIGNMENT	4
356 #endif	/* defined(__sparc) */
357 #endif	/* defined(_XPG4_2) || defined(_KERNEL) */
358 
359 #if defined(_XPG4_2)
360 /*
361  * The cmsg headers (and macros dealing with them) were made available as
362  * part of UNIX95 and hence need to be protected with a _XPG4_2 define.
363  */
364 #define	_CMSG_DATA_ALIGNMENT	(sizeof (int))
365 #define	_CMSG_HDR_ALIGN(x)	(((uintptr_t)(x) + _CMSG_HDR_ALIGNMENT - 1) & \
366 				    ~(_CMSG_HDR_ALIGNMENT - 1))
367 #define	_CMSG_DATA_ALIGN(x)	(((uintptr_t)(x) + _CMSG_DATA_ALIGNMENT - 1) & \
368 				    ~(_CMSG_DATA_ALIGNMENT - 1))
369 #define	CMSG_DATA(c)							\
370 	((unsigned char *)_CMSG_DATA_ALIGN((struct cmsghdr *)(c) + 1))
371 
372 #define	CMSG_FIRSTHDR(m)						\
373 	(((m)->msg_controllen < sizeof (struct cmsghdr)) ?		\
374 	    (struct cmsghdr *)0 : (struct cmsghdr *)((m)->msg_control))
375 
376 #define	CMSG_NXTHDR(m, c)						\
377 	(((c) == 0) ? CMSG_FIRSTHDR(m) :			\
378 	((((uintptr_t)_CMSG_HDR_ALIGN((char *)(c) +			\
379 	((struct cmsghdr *)(c))->cmsg_len) + sizeof (struct cmsghdr)) >	\
380 	(((uintptr_t)((struct msghdr *)(m))->msg_control) +		\
381 	((uintptr_t)((struct msghdr *)(m))->msg_controllen))) ?		\
382 	((struct cmsghdr *)0) :						\
383 	((struct cmsghdr *)_CMSG_HDR_ALIGN((char *)(c) +		\
384 	    ((struct cmsghdr *)(c))->cmsg_len))))
385 
386 /* Amount of space + padding needed for a message of length l */
387 #define	CMSG_SPACE(l)							\
388 	((unsigned int)_CMSG_HDR_ALIGN(sizeof (struct cmsghdr) + (l)))
389 
390 /* Value to be used in cmsg_len, does not include trailing padding */
391 #define	CMSG_LEN(l)							\
392 	((unsigned int)_CMSG_DATA_ALIGN(sizeof (struct cmsghdr)) + (l))
393 
394 #endif	/* _XPG4_2 */
395 
396 #ifdef	_XPG4_2
397 #ifdef	__PRAGMA_REDEFINE_EXTNAME
398 #pragma redefine_extname bind __xnet_bind
399 #pragma redefine_extname connect __xnet_connect
400 #pragma redefine_extname recvmsg __xnet_recvmsg
401 #pragma redefine_extname sendmsg __xnet_sendmsg
402 #pragma redefine_extname sendto __xnet_sendto
403 #pragma redefine_extname socket __xnet_socket
404 #pragma redefine_extname socketpair __xnet_socketpair
405 #pragma redefine_extname getsockopt __xnet_getsockopt
406 #else	/* __PRAGMA_REDEFINE_EXTNAME */
407 #define	bind	__xnet_bind
408 #define	connect	__xnet_connect
409 #define	recvmsg	__xnet_recvmsg
410 #define	sendmsg	__xnet_sendmsg
411 #define	sendto	__xnet_sendto
412 #define	socket	__xnet_socket
413 #define	socketpair	__xnet_socketpair
414 #define	getsockopt	__xnet_getsockopt
415 #endif	/* __PRAGMA_REDEFINE_EXTNAME */
416 
417 #endif	/* _XPG4_2 */
418 
419 #if defined(_XPG4_2) && !defined(_XPG5)
420 #ifdef	__PRAGMA_REDEFINE_EXTNAME
421 #pragma redefine_extname listen __xnet_listen
422 #else	/* __PRAGMA_REDEFINE_EXTNAME */
423 #define	listen	__xnet_listen
424 #endif	/* __PRAGMA_REDEFINE_EXTNAME */
425 #endif /* (_XPG4_2) && !defined(_XPG5) */
426 
427 #if !defined(_KERNEL) || defined(_BOOT)
428 #ifdef	__STDC__
429 extern int accept(int, struct sockaddr *_RESTRICT_KYWD, Psocklen_t);
430 extern int bind(int, const struct sockaddr *, socklen_t);
431 extern int connect(int, const struct sockaddr *, socklen_t);
432 extern int getpeername(int, struct sockaddr *_RESTRICT_KYWD, Psocklen_t);
433 extern int getsockname(int, struct sockaddr *_RESTRICT_KYWD, Psocklen_t);
434 extern int getsockopt(int, int, int, void *_RESTRICT_KYWD, Psocklen_t);
435 extern int listen(int, int);	/* XXX - fixme???  where do I go */
436 extern int socketpair(int, int, int, int *);
437 extern ssize_t recv(int, void *, size_t, int);
438 extern ssize_t recvfrom(int, void *_RESTRICT_KYWD, size_t, int,
439 	struct sockaddr *_RESTRICT_KYWD, Psocklen_t);
440 extern ssize_t recvmsg(int, struct msghdr *, int);
441 extern ssize_t send(int, const void *, size_t, int);
442 extern ssize_t sendmsg(int, const struct msghdr *, int);
443 extern ssize_t sendto(int, const void *, size_t, int, const struct sockaddr *,
444 	socklen_t);
445 extern int setsockopt(int, int, int, const void *, socklen_t);
446 extern int shutdown(int, int);
447 extern int socket(int, int, int);
448 
449 #if !defined(_XPG4_2) || defined(_XPG6) || defined(__EXTENSIONS__)
450 extern int sockatmark(int);
451 #endif /* !defined(_XPG4_2) || defined(_XPG6) || defined(__EXTENSIONS__) */
452 #else	/* __STDC__ */
453 extern int accept();
454 extern int bind();
455 extern int connect();
456 extern int getpeername();
457 extern int getsockname();
458 extern int getsockopt();
459 extern int listen();
460 extern int recv();
461 extern int recvfrom();
462 extern int send();
463 extern int sendto();
464 extern int setsockopt();
465 extern int sockatmark();
466 extern int socket();
467 extern int recvmsg();
468 extern int sendmsg();
469 extern int shutdown();
470 extern int socketpair();
471 #endif	/* __STDC__ */
472 #endif	/* !defined(_KERNEL) || defined(_BOOT) */
473 
474 #ifdef	__cplusplus
475 }
476 #endif
477 
478 #endif	/* _SYS_SOCKET_H */
479