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.
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.
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]
22 * Copyright (c) 1989, 2010, Oracle and/or its affiliates. All rights reserved.
25 /* Copyright (c) 1983, 1984, 1985, 1986, 1987, 1988, 1989 AT&T */
26 /* All Rights Reserved */
29 * University Copyright- Copyright (c) 1982, 1986, 1988
30 * The Regents of the University of California
33 * University Acknowledgment- Portions of this document are derived from
34 * software developed by the University of California, Berkeley, and its
38 /* Copyright (c) 2013, OmniTI Computer Consulting, Inc. All rights reserved. */
43 #include <sys/types.h>
45 #include <sys/feature_tests.h>
46 #include <sys/socket_impl.h>
47 #if !defined(_XPG4_2) || defined(__EXTENSIONS__)
49 #include <sys/netconfig.h>
51 #include <netinet/in.h>
52 #endif /* !defined(_XPG4_2) || defined(__EXTENSIONS__) */
62 * The socklen definitions are reproduced in netinet/in.h for the inet6_
63 * functions. Exposing all of sys/socket.h via netinet/in.h breaks existing
64 * applications and is not required by austin.
66 #if defined(_XPG4_2) && !defined(_XPG5) && !defined(_LP64)
67 typedef size_t socklen_t
;
69 typedef uint32_t socklen_t
;
70 #endif /* defined(_XPG4_2) && !defined(_XPG5) && !defined(_LP64) */
72 #if defined(_XPG4_2) || defined(_BOOT)
73 typedef socklen_t
*_RESTRICT_KYWD Psocklen_t
;
75 typedef void *_RESTRICT_KYWD Psocklen_t
;
76 #endif /* defined(_XPG4_2) || defined(_BOOT) */
78 #endif /* _SOCKLEN_T */
81 * Definitions related to sockets: types, address families, options.
83 #if !defined(_XPG4_2) || defined(__EXTENSIONS__)
85 #define NC_TPI_CLTS 1 /* must agree with netconfig.h */
86 #define NC_TPI_COTS 2 /* must agree with netconfig.h */
87 #define NC_TPI_COTS_ORD 3 /* must agree with netconfig.h */
88 #define NC_TPI_RAW 4 /* must agree with netconfig.h */
89 #endif /* !NC_TPI_CLTS */
90 #endif /* !defined(_XPG4_2) || defined(__EXTENSIONS__) */
95 #if !defined(_XPG4_2) || defined(__EXTENSIONS__)
96 #define SOCK_STREAM NC_TPI_COTS /* stream socket */
97 #define SOCK_DGRAM NC_TPI_CLTS /* datagram socket */
98 #define SOCK_RAW NC_TPI_RAW /* raw-protocol interface */
100 #define SOCK_STREAM 2 /* stream socket */
101 #define SOCK_DGRAM 1 /* datagram socket */
102 #define SOCK_RAW 4 /* raw-protocol interface */
103 #endif /* !defined(_XPG4_2) || defined(__EXTENSIONS__) */
104 #define SOCK_RDM 5 /* reliably-delivered message */
105 #define SOCK_SEQPACKET 6 /* sequenced packet stream */
106 #define SOCK_TYPE_MASK 0xffff /* type reside in these bits only */
109 * Flags for socket() and accept4()
111 #define SOCK_CLOEXEC 0x080000 /* like open(2) O_CLOEXEC for socket */
112 #define SOCK_NONBLOCK 0x100000 /* like O_NONBLOCK */
113 #define SOCK_NDELAY 0x200000 /* like O_NDELAY */
116 * Option flags per-socket.
118 #define SO_DEBUG 0x0001 /* turn on debugging info recording */
119 #define SO_ACCEPTCONN 0x0002 /* socket has had listen() */
120 #define SO_REUSEADDR 0x0004 /* allow local address reuse */
121 #define SO_KEEPALIVE 0x0008 /* keep connections alive */
122 #define SO_DONTROUTE 0x0010 /* just use interface addresses */
123 #define SO_BROADCAST 0x0020 /* permit sending of broadcast msgs */
124 #define SO_USELOOPBACK 0x0040 /* bypass hardware when possible */
125 #define SO_LINGER 0x0080 /* linger on close if data present */
126 #define SO_OOBINLINE 0x0100 /* leave received OOB data in line */
127 #define SO_DGRAM_ERRIND 0x0200 /* Application wants delayed error */
128 #define SO_RECVUCRED 0x0400 /* Application wants ucred of sender */
131 * Socket options are passed using a signed integer, but it is also rare
132 * for more than one to ever be passed at the same time with setsockopt
133 * and only one at a time can be retrieved with getsockopt.
135 * Since the lower numbers cannot be renumbered for compatibility reasons,
136 * it would seem that we need to start a new number space (0x40000000 -
137 * 0x7fffffff) for those that don't need to be stored as a bit flag
138 * somewhere. This limits the flag options to 30 but that seems to be
139 * plenty, anyway. 0x40000000 is reserved for future use.
141 #define SO_ATTACH_FILTER 0x40000001
142 #define SO_DETACH_FILTER 0x40000002
145 #define SO_SND_COPYAVOID 0x0800 /* Internal: use zero-copy */
146 #define SO_SND_BUFINFO 0x1000 /* Internal: get buffer info */
147 /* when doing zero-copy */
149 struct so_snd_bufinfo
{
150 ushort_t sbi_wroff
; /* Write offset */
151 ssize_t sbi_maxblk
; /* Max size of a single mblk */
152 ssize_t sbi_maxpsz
; /* Max total size of a mblk chain */
153 ushort_t sbi_tail
; /* Extra space available at the end */
158 * N.B.: The following definition is present only for compatibility
159 * with release 3.0. It will disappear in later releases.
161 #define SO_DONTLINGER (~SO_LINGER) /* ~SO_LINGER */
164 * Additional options, not kept in so_options.
166 #define SO_SNDBUF 0x1001 /* send buffer size */
167 #define SO_RCVBUF 0x1002 /* receive buffer size */
168 #define SO_SNDLOWAT 0x1003 /* send low-water mark */
169 #define SO_RCVLOWAT 0x1004 /* receive low-water mark */
170 #define SO_SNDTIMEO 0x1005 /* send timeout */
171 #define SO_RCVTIMEO 0x1006 /* receive timeout */
172 #define SO_ERROR 0x1007 /* get error status and clear */
173 #define SO_TYPE 0x1008 /* get socket type */
174 #define SO_PROTOTYPE 0x1009 /* get/set protocol type */
175 #define SO_ANON_MLP 0x100a /* create MLP on anonymous bind */
176 #define SO_MAC_EXEMPT 0x100b /* allow dominated unlabeled peers */
177 #define SO_DOMAIN 0x100c /* get socket domain */
178 #define SO_RCVPSH 0x100d /* receive interval to push data */
180 /* "Socket"-level control message types: */
181 #define SCM_RIGHTS 0x1010 /* access rights (array of int) */
182 #define SO_SECATTR 0x1011 /* socket's security attributes */
183 #define SCM_UCRED 0x1012 /* sender's ucred */
184 #define SO_TIMESTAMP 0x1013 /* socket-level timestamp option */
185 #define SCM_TIMESTAMP SO_TIMESTAMP /* socket control message timestamp */
186 #define SO_ALLZONES 0x1014 /* bind in all zones */
187 #define SO_EXCLBIND 0x1015 /* exclusive binding */
188 #define SO_MAC_IMPLICIT 0x1016 /* hide mac labels on wire */
189 #define SO_VRRP 0x1017 /* VRRP control socket */
192 #define SO_SRCADDR 0x2001 /* Internal: AF_UNIX source address */
193 #define SO_FILEP 0x2002 /* Internal: AF_UNIX file pointer */
194 #define SO_UNIX_CLOSE 0x2003 /* Internal: AF_UNIX peer closed */
198 * Socket filter options
200 #define FIL_ATTACH 0x1 /* attach filter */
201 #define FIL_DETACH 0x2 /* detach filter */
202 #define FIL_LIST 0x3 /* list attached filters */
204 #define FILNAME_MAX 32
206 * Structure returned by FIL_LIST
209 int fi_flags
; /* see below (FILF_*) */
210 int fi_pos
; /* position (0 is bottom) */
211 char fi_name
[FILNAME_MAX
]; /* filter name */
214 #define FILF_PROG 0x1 /* programmatic attach */
215 #define FILF_AUTO 0x2 /* automatic attach */
216 #define FILF_BYPASS 0x4 /* filter is not active */
220 * new socket open flags to identify socket and acceptor streams
222 #define SO_ACCEPTOR 0x20000 /* acceptor socket */
223 #define SO_SOCKSTR 0x40000 /* normal socket stream */
224 #define SO_FALLBACK 0x80000 /* fallback to TPI socket */
227 * Flags for socket_create() and socket_newconn()
229 #define SOCKET_SLEEP KM_SLEEP
230 #define SOCKET_NOSLEEP KM_NOSLEEP
235 * Structure used for manipulating linger option.
238 int l_onoff
; /* option on/off */
239 int l_linger
; /* linger time */
243 * Levels for (get/set)sockopt() that don't apply to a specific protocol.
245 #define SOL_SOCKET 0xffff /* options for socket level */
246 #if !defined(_XPG4_2) || defined(__EXTENSIONS__)
247 #define SOL_ROUTE 0xfffe /* options for routing socket level */
249 #define SOL_PACKET 0xfffd /* options for packet level */
250 #define SOL_FILTER 0xfffc /* options for socket filter level */
255 * Some of these constant names are copied for the DTrace IP provider in
256 * usr/src/lib/libdtrace/common/{ip.d.in, ip.sed.in}, which should be kept
259 #define AF_UNSPEC 0 /* unspecified */
260 #define AF_UNIX 1 /* local to host (pipes, portals) */
261 #define AF_LOCAL AF_UNIX /* Synonym for AF_UNIX */
262 #define AF_FILE AF_UNIX /* Synonym for AF_UNIX */
263 #define AF_INET 2 /* internetwork: UDP, TCP, etc. */
264 #define AF_IMPLINK 3 /* arpanet imp addresses */
265 #define AF_PUP 4 /* pup protocols: e.g. BSP */
266 #define AF_CHAOS 5 /* mit CHAOS protocols */
267 #define AF_NS 6 /* XEROX NS protocols */
268 #define AF_NBS 7 /* nbs protocols */
269 #define AF_ECMA 8 /* european computer manufacturers */
270 #define AF_DATAKIT 9 /* datakit protocols */
271 #define AF_CCITT 10 /* CCITT protocols, X.25 etc */
272 #define AF_SNA 11 /* IBM SNA */
273 #define AF_DECnet 12 /* DECnet */
274 #define AF_DLI 13 /* Direct data link interface */
275 #define AF_LAT 14 /* LAT */
276 #define AF_HYLINK 15 /* NSC Hyperchannel */
277 #define AF_APPLETALK 16 /* Apple Talk */
278 #define AF_NIT 17 /* Network Interface Tap */
279 #define AF_802 18 /* IEEE 802.2, also ISO 8802 */
280 #define AF_OSI 19 /* umbrella for all families used */
281 #define AF_X25 20 /* CCITT X.25 in particular */
282 #define AF_OSINET 21 /* AFI = 47, IDI = 4 */
283 #define AF_GOSIP 22 /* U.S. Government OSI */
284 #define AF_IPX 23 /* Novell Internet Protocol */
285 #define AF_ROUTE 24 /* Internal Routing Protocol */
286 #define AF_LINK 25 /* Link-layer interface */
287 #define AF_INET6 26 /* Internet Protocol, Version 6 */
288 #define AF_KEY 27 /* Security Association DB socket */
289 #define AF_NCA 28 /* NCA socket */
290 #define AF_POLICY 29 /* Security Policy DB socket */
291 #define AF_INET_OFFLOAD 30 /* Sun private; do not use */
292 #define AF_TRILL 31 /* TRILL interface */
293 #define AF_PACKET 32 /* PF_PACKET Linux socket interface */
298 * Protocol families, same as address families for now.
300 #define PF_UNSPEC AF_UNSPEC
301 #define PF_UNIX AF_UNIX
302 #define PF_LOCAL PF_UNIX
303 #define PF_FILE PF_UNIX
304 #define PF_INET AF_INET
305 #define PF_IMPLINK AF_IMPLINK
306 #define PF_PUP AF_PUP
307 #define PF_CHAOS AF_CHAOS
309 #define PF_NBS AF_NBS
310 #define PF_ECMA AF_ECMA
311 #define PF_DATAKIT AF_DATAKIT
312 #define PF_CCITT AF_CCITT
313 #define PF_SNA AF_SNA
314 #define PF_DECnet AF_DECnet
315 #define PF_DLI AF_DLI
316 #define PF_LAT AF_LAT
317 #define PF_HYLINK AF_HYLINK
318 #define PF_APPLETALK AF_APPLETALK
319 #define PF_NIT AF_NIT
320 #define PF_802 AF_802
321 #define PF_OSI AF_OSI
322 #define PF_X25 AF_X25
323 #define PF_OSINET AF_OSINET
324 #define PF_GOSIP AF_GOSIP
325 #define PF_IPX AF_IPX
326 #define PF_ROUTE AF_ROUTE
327 #define PF_LINK AF_LINK
328 #define PF_INET6 AF_INET6
329 #define PF_KEY AF_KEY
330 #define PF_NCA AF_NCA
331 #define PF_POLICY AF_POLICY
332 #define PF_INET_OFFLOAD AF_INET_OFFLOAD /* Sun private; do not use */
333 #define PF_TRILL AF_TRILL
334 #define PF_PACKET AF_PACKET
336 #define PF_MAX AF_MAX
339 * Maximum queue length specifiable by listen.
341 #define SOMAXCONN 128
344 * Message header for recvmsg and sendmsg calls.
347 void *msg_name
; /* optional address */
348 socklen_t msg_namelen
; /* size of address */
349 struct iovec
*msg_iov
; /* scatter/gather array */
350 int msg_iovlen
; /* # elements in msg_iov */
352 #if defined(_XPG4_2) || defined(_KERNEL)
353 void *msg_control
; /* ancillary data */
354 socklen_t msg_controllen
; /* ancillary data buffer len */
355 int msg_flags
; /* flags on received message */
357 caddr_t msg_accrights
; /* access rights sent/received */
358 int msg_accrightslen
;
359 #endif /* defined(_XPG4_2) || defined(_KERNEL) */
365 * N.B.: we assume that omsghdr and nmsghdr are isomorphic, with
366 * the sole exception that nmsghdr has the additional msg_flags
370 void *msg_name
; /* optional address */
371 socklen_t msg_namelen
; /* size of address */
372 struct iovec
*msg_iov
; /* scatter/gather array */
373 int msg_iovlen
; /* # elements in msg_iov */
374 caddr_t msg_accrights
; /* access rights sent/received */
375 int msg_accrightslen
;
378 #define nmsghdr msghdr
380 #if defined(_SYSCALL32)
383 caddr32_t msg_name
; /* optional address */
384 uint32_t msg_namelen
; /* size of address */
385 caddr32_t msg_iov
; /* scatter/gather array */
386 int32_t msg_iovlen
; /* # elements in msg_iov */
387 caddr32_t msg_accrights
; /* access rights sent/received */
388 uint32_t msg_accrightslen
;
392 caddr32_t msg_name
; /* optional address */
393 uint32_t msg_namelen
; /* size of address */
394 caddr32_t msg_iov
; /* scatter/gather array */
395 int32_t msg_iovlen
; /* # elements in msg_iov */
396 caddr32_t msg_control
; /* ancillary data */
397 uint32_t msg_controllen
; /* ancillary data buffer len */
398 int32_t msg_flags
; /* flags on received message */
401 #define nmsghdr32 msghdr32
403 #endif /* _SYSCALL32 */
406 #define MSG_OOB 0x1 /* process out-of-band data */
407 #define MSG_PEEK 0x2 /* peek at incoming message */
408 #define MSG_DONTROUTE 0x4 /* send without using routing tables */
409 /* Added for XPGv2 compliance */
410 #define MSG_EOR 0x8 /* Terminates a record */
411 #define MSG_CTRUNC 0x10 /* Control data truncated */
412 #define MSG_TRUNC 0x20 /* Normal data truncated */
413 #define MSG_WAITALL 0x40 /* Wait for complete recv or error */
414 #define MSG_DUPCTRL 0x800 /* Save control message for use with */
415 /* with left over data */
416 /* End of XPGv2 compliance */
417 #define MSG_DONTWAIT 0x80 /* Don't block for this recv */
418 #define MSG_NOTIFICATION 0x100 /* Notification, not data */
419 #define MSG_XPG4_2 0x8000 /* Private: XPG4.2 flag */
421 #define MSG_MAXIOVLEN 16
426 * for kernel socket only
428 #define MSG_MBLK_QUICKRELE 0x10000000 /* free mblk chain */
429 /* in timely manner */
430 #define MSG_USERSPACE 0x20000000 /* buffer from user space */
435 /* Added for XPGv2 compliance */
441 socklen_t cmsg_len
; /* data byte count, including hdr */
442 int cmsg_level
; /* originating protocol */
443 int cmsg_type
; /* protocol-specific type */
446 #if defined(_XPG4_2) || defined(_KERNEL)
448 /* To maintain backward compatibility, alignment needs to be 8 on sparc. */
449 #define _CMSG_HDR_ALIGNMENT 8
451 /* for __i386 (and other future architectures) */
452 #define _CMSG_HDR_ALIGNMENT 4
453 #endif /* defined(__sparc) */
454 #endif /* defined(_XPG4_2) || defined(_KERNEL) */
458 * The cmsg headers (and macros dealing with them) were made available as
459 * part of UNIX95 and hence need to be protected with a _XPG4_2 define.
461 #define _CMSG_DATA_ALIGNMENT (sizeof (int))
462 #define _CMSG_HDR_ALIGN(x) (((uintptr_t)(x) + _CMSG_HDR_ALIGNMENT - 1) & \
463 ~(_CMSG_HDR_ALIGNMENT - 1))
464 #define _CMSG_DATA_ALIGN(x) (((uintptr_t)(x) + _CMSG_DATA_ALIGNMENT - 1) & \
465 ~(_CMSG_DATA_ALIGNMENT - 1))
466 #define CMSG_DATA(c) \
467 ((unsigned char *)_CMSG_DATA_ALIGN((struct cmsghdr *)(c) + 1))
469 #define CMSG_FIRSTHDR(m) \
470 (((m)->msg_controllen < sizeof (struct cmsghdr)) ? \
471 (struct cmsghdr *)0 : (struct cmsghdr *)((m)->msg_control))
473 #define CMSG_NXTHDR(m, c) \
474 (((c) == 0) ? CMSG_FIRSTHDR(m) : \
475 ((((uintptr_t)_CMSG_HDR_ALIGN((char *)(c) + \
476 ((struct cmsghdr *)(c))->cmsg_len) + sizeof (struct cmsghdr)) > \
477 (((uintptr_t)((struct msghdr *)(m))->msg_control) + \
478 ((uintptr_t)((struct msghdr *)(m))->msg_controllen))) ? \
479 ((struct cmsghdr *)0) : \
480 ((struct cmsghdr *)_CMSG_HDR_ALIGN((char *)(c) + \
481 ((struct cmsghdr *)(c))->cmsg_len))))
483 /* Amount of space + padding needed for a message of length l */
484 #define CMSG_SPACE(l) \
485 ((unsigned int)_CMSG_HDR_ALIGN(sizeof (struct cmsghdr) + (l)))
487 /* Value to be used in cmsg_len, does not include trailing padding */
488 #define CMSG_LEN(l) \
489 ((unsigned int)_CMSG_DATA_ALIGN(sizeof (struct cmsghdr)) + (l))
494 #ifdef __PRAGMA_REDEFINE_EXTNAME
495 #pragma redefine_extname bind __xnet_bind
496 #pragma redefine_extname connect __xnet_connect
497 #pragma redefine_extname recvmsg __xnet_recvmsg
498 #pragma redefine_extname sendmsg __xnet_sendmsg
499 #pragma redefine_extname sendto __xnet_sendto
500 #pragma redefine_extname socket __xnet_socket
501 #pragma redefine_extname socketpair __xnet_socketpair
502 #pragma redefine_extname getsockopt __xnet_getsockopt
503 #else /* __PRAGMA_REDEFINE_EXTNAME */
504 #define bind __xnet_bind
505 #define connect __xnet_connect
506 #define recvmsg __xnet_recvmsg
507 #define sendmsg __xnet_sendmsg
508 #define sendto __xnet_sendto
509 #define socket __xnet_socket
510 #define socketpair __xnet_socketpair
511 #define getsockopt __xnet_getsockopt
512 #endif /* __PRAGMA_REDEFINE_EXTNAME */
516 #if defined(_XPG4_2) && !defined(_XPG5)
517 #ifdef __PRAGMA_REDEFINE_EXTNAME
518 #pragma redefine_extname listen __xnet_listen
519 #else /* __PRAGMA_REDEFINE_EXTNAME */
520 #define listen __xnet_listen
521 #endif /* __PRAGMA_REDEFINE_EXTNAME */
522 #endif /* (_XPG4_2) && !defined(_XPG5) */
524 #if !defined(_KERNEL) || defined(_BOOT)
526 extern int accept(int, struct sockaddr
*_RESTRICT_KYWD
, Psocklen_t
);
527 extern int accept4(int, struct sockaddr
*_RESTRICT_KYWD
, Psocklen_t
, int);
528 extern int bind(int, const struct sockaddr
*, socklen_t
);
529 extern int connect(int, const struct sockaddr
*, socklen_t
);
530 extern int getpeername(int, struct sockaddr
*_RESTRICT_KYWD
, Psocklen_t
);
531 extern int getsockname(int, struct sockaddr
*_RESTRICT_KYWD
, Psocklen_t
);
532 extern int getsockopt(int, int, int, void *_RESTRICT_KYWD
, Psocklen_t
);
533 extern int listen(int, int); /* XXX - fixme??? where do I go */
534 extern int socketpair(int, int, int, int *);
535 extern ssize_t
recv(int, void *, size_t, int);
536 extern ssize_t
recvfrom(int, void *_RESTRICT_KYWD
, size_t, int,
537 struct sockaddr
*_RESTRICT_KYWD
, Psocklen_t
);
538 extern ssize_t
recvmsg(int, struct msghdr
*, int);
539 extern ssize_t
send(int, const void *, size_t, int);
540 extern ssize_t
sendmsg(int, const struct msghdr
*, int);
541 extern ssize_t
sendto(int, const void *, size_t, int, const struct sockaddr
*,
543 extern int setsockopt(int, int, int, const void *, socklen_t
);
544 extern int shutdown(int, int);
545 extern int socket(int, int, int);
547 #if !defined(_XPG4_2) || defined(_XPG6) || defined(__EXTENSIONS__)
548 extern int sockatmark(int);
549 #endif /* !defined(_XPG4_2) || defined(_XPG6) || defined(__EXTENSIONS__) */
552 extern int accept4();
554 extern int connect();
555 extern int getpeername();
556 extern int getsockname();
557 extern int getsockopt();
560 extern int recvfrom();
563 extern int setsockopt();
564 extern int sockatmark();
566 extern int recvmsg();
567 extern int sendmsg();
568 extern int shutdown();
569 extern int socketpair();
570 #endif /* __STDC__ */
571 #endif /* !defined(_KERNEL) || defined(_BOOT) */
577 #endif /* _SYS_SOCKET_H */