6811333 Remove prom_printf() message in emlxs driver
[opensolaris.git] / usr / src / uts / common / sys / socket.h
blob4e3b2b5778c847d6fcd7395e8a96c555c2ba4839
1 /*
2 * CDDL HEADER START
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]
19 * CDDL HEADER END
22 * Copyright 2009 Sun Microsystems, Inc. All rights reserved.
23 * Use is subject to license terms.
26 /* Copyright (c) 1983, 1984, 1985, 1986, 1987, 1988, 1989 AT&T */
27 /* All Rights Reserved */
30 * University Copyright- Copyright (c) 1982, 1986, 1988
31 * The Regents of the University of California
32 * All Rights Reserved
34 * University Acknowledgment- Portions of this document are derived from
35 * software developed by the University of California, Berkeley, and its
36 * contributors.
39 #ifndef _SYS_SOCKET_H
40 #define _SYS_SOCKET_H
42 #include <sys/types.h>
43 #include <sys/uio.h>
44 #include <sys/feature_tests.h>
45 #include <sys/socket_impl.h>
46 #if !defined(_XPG4_2) || defined(__EXTENSIONS__)
47 #ifndef _KERNEL
48 #include <sys/netconfig.h>
49 #endif /* !_KERNEL */
50 #include <netinet/in.h>
51 #endif /* !defined(_XPG4_2) || defined(__EXTENSIONS__) */
53 #ifdef __cplusplus
54 extern "C" {
55 #endif
57 #ifndef _SOCKLEN_T
58 #define _SOCKLEN_T
61 * The socklen definitions are reproduced in netinet/in.h for the inet6_
62 * functions. Exposing all of sys/socket.h via netinet/in.h breaks existing
63 * applications and is not required by austin.
65 #if defined(_XPG4_2) && !defined(_XPG5) && !defined(_LP64)
66 typedef size_t socklen_t;
67 #else
68 typedef uint32_t socklen_t;
69 #endif /* defined(_XPG4_2) && !defined(_XPG5) && !defined(_LP64) */
71 #if defined(_XPG4_2) || defined(_BOOT)
72 typedef socklen_t *_RESTRICT_KYWD Psocklen_t;
73 #else
74 typedef void *_RESTRICT_KYWD Psocklen_t;
75 #endif /* defined(_XPG4_2) || defined(_BOOT) */
77 #endif /* _SOCKLEN_T */
80 * Definitions related to sockets: types, address families, options.
82 #if !defined(_XPG4_2) || defined(__EXTENSIONS__)
83 #ifndef NC_TPI_CLTS
84 #define NC_TPI_CLTS 1 /* must agree with netconfig.h */
85 #define NC_TPI_COTS 2 /* must agree with netconfig.h */
86 #define NC_TPI_COTS_ORD 3 /* must agree with netconfig.h */
87 #define NC_TPI_RAW 4 /* must agree with netconfig.h */
88 #endif /* !NC_TPI_CLTS */
89 #endif /* !defined(_XPG4_2) || defined(__EXTENSIONS__) */
92 * Types
94 #if !defined(_XPG4_2) || defined(__EXTENSIONS__)
95 #define SOCK_STREAM NC_TPI_COTS /* stream socket */
96 #define SOCK_DGRAM NC_TPI_CLTS /* datagram socket */
97 #define SOCK_RAW NC_TPI_RAW /* raw-protocol interface */
98 #else
99 #define SOCK_STREAM 2 /* stream socket */
100 #define SOCK_DGRAM 1 /* datagram socket */
101 #define SOCK_RAW 4 /* raw-protocol interface */
102 #endif /* !defined(_XPG4_2) || defined(__EXTENSIONS__) */
103 #define SOCK_RDM 5 /* reliably-delivered message */
104 #define SOCK_SEQPACKET 6 /* sequenced packet stream */
107 * Option flags per-socket.
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 #define SO_USELOOPBACK 0x0040 /* bypass hardware when possible */
116 #define SO_LINGER 0x0080 /* linger on close if data present */
117 #define SO_OOBINLINE 0x0100 /* leave received OOB data in line */
118 #define SO_DGRAM_ERRIND 0x0200 /* Application wants delayed error */
119 #define SO_RECVUCRED 0x0400 /* Application wants ucred of sender */
121 #ifdef _KERNEL
122 #define SO_SND_COPYAVOID 0x0800 /* Internal: use zero-copy */
123 #define SO_SND_BUFINFO 0x1000 /* Internal: get buffer info */
124 /* when doing zero-copy */
126 struct so_snd_bufinfo {
127 ushort_t sbi_wroff; /* Write offset */
128 ssize_t sbi_maxblk; /* Max size of a single mblk */
129 ssize_t sbi_maxpsz; /* Max total size of a mblk chain */
130 ushort_t sbi_tail; /* Extra space available at the end */
132 #endif /* _KERNEL */
135 * N.B.: The following definition is present only for compatibility
136 * with release 3.0. It will disappear in later releases.
138 #define SO_DONTLINGER (~SO_LINGER) /* ~SO_LINGER */
141 * Additional options, not kept in so_options.
143 #define SO_SNDBUF 0x1001 /* send buffer size */
144 #define SO_RCVBUF 0x1002 /* receive buffer size */
145 #define SO_SNDLOWAT 0x1003 /* send low-water mark */
146 #define SO_RCVLOWAT 0x1004 /* receive low-water mark */
147 #define SO_SNDTIMEO 0x1005 /* send timeout */
148 #define SO_RCVTIMEO 0x1006 /* receive timeout */
149 #define SO_ERROR 0x1007 /* get error status and clear */
150 #define SO_TYPE 0x1008 /* get socket type */
151 #define SO_PROTOTYPE 0x1009 /* get/set protocol type */
152 #define SO_ANON_MLP 0x100a /* create MLP on anonymous bind */
153 #define SO_MAC_EXEMPT 0x100b /* allow dominated unlabeled peers */
154 #define SO_DOMAIN 0x100c /* get socket domain */
155 #define SO_RCVPSH 0x100d /* receive interval to push data */
157 /* "Socket"-level control message types: */
158 #define SCM_RIGHTS 0x1010 /* access rights (array of int) */
159 #define SO_SECATTR 0x1011 /* socket's security attributes */
160 #define SCM_UCRED 0x1012 /* sender's ucred */
161 #define SO_TIMESTAMP 0x1013 /* socket-level timestamp option */
162 #define SCM_TIMESTAMP SO_TIMESTAMP /* socket control message timestamp */
163 #define SO_ALLZONES 0x1014 /* bind in all zones */
164 #define SO_EXCLBIND 0x1015 /* exclusive binding */
166 #ifdef _KERNEL
167 #define SO_SRCADDR 0x2001 /* Internal: AF_UNIX source address */
168 #define SO_FILEP 0x2002 /* Internal: AF_UNIX file pointer */
169 #define SO_UNIX_CLOSE 0x2003 /* Internal: AF_UNIX peer closed */
170 #endif /* _KERNEL */
172 #ifdef _KERNEL
174 * new socket open flags to identify socket and acceptor streams
176 #define SO_ACCEPTOR 0x20000 /* acceptor socket */
177 #define SO_SOCKSTR 0x40000 /* normal socket stream */
178 #define SO_FALLBACK 0x80000 /* fallback to TPI socket */
181 * Flags for socket_create() and socket_newconn()
183 #define SOCKET_SLEEP KM_SLEEP
184 #define SOCKET_NOSLEEP KM_NOSLEEP
188 * flags used by sockfs when falling back to tpi socket
190 #define SO_FB_START 0x1
191 #define SO_FB_FINISH 0x2
193 #endif /* _KERNEL */
196 * Structure used for manipulating linger option.
198 struct linger {
199 int l_onoff; /* option on/off */
200 int l_linger; /* linger time */
204 * Levels for (get/set)sockopt() that don't apply to a specific protocol.
206 #define SOL_SOCKET 0xffff /* options for socket level */
207 #if !defined(_XPG4_2) || defined(__EXTENSIONS__)
208 #define SOL_ROUTE 0xfffe /* options for routing socket level */
209 #endif
212 * Address families.
214 * Some of these constant names are copied for the DTrace IP provider in
215 * usr/src/lib/libdtrace/common/{ip.d.in, ip.sed.in}, which should be kept
216 * in sync.
218 #define AF_UNSPEC 0 /* unspecified */
219 #define AF_UNIX 1 /* local to host (pipes, portals) */
220 #define AF_LOCAL AF_UNIX /* Synonym for AF_UNIX */
221 #define AF_FILE AF_UNIX /* Synonym for AF_UNIX */
222 #define AF_INET 2 /* internetwork: UDP, TCP, etc. */
223 #define AF_IMPLINK 3 /* arpanet imp addresses */
224 #define AF_PUP 4 /* pup protocols: e.g. BSP */
225 #define AF_CHAOS 5 /* mit CHAOS protocols */
226 #define AF_NS 6 /* XEROX NS protocols */
227 #define AF_NBS 7 /* nbs protocols */
228 #define AF_ECMA 8 /* european computer manufacturers */
229 #define AF_DATAKIT 9 /* datakit protocols */
230 #define AF_CCITT 10 /* CCITT protocols, X.25 etc */
231 #define AF_SNA 11 /* IBM SNA */
232 #define AF_DECnet 12 /* DECnet */
233 #define AF_DLI 13 /* Direct data link interface */
234 #define AF_LAT 14 /* LAT */
235 #define AF_HYLINK 15 /* NSC Hyperchannel */
236 #define AF_APPLETALK 16 /* Apple Talk */
237 #define AF_NIT 17 /* Network Interface Tap */
238 #define AF_802 18 /* IEEE 802.2, also ISO 8802 */
239 #define AF_OSI 19 /* umbrella for all families used */
240 #define AF_X25 20 /* CCITT X.25 in particular */
241 #define AF_OSINET 21 /* AFI = 47, IDI = 4 */
242 #define AF_GOSIP 22 /* U.S. Government OSI */
243 #define AF_IPX 23 /* Novell Internet Protocol */
244 #define AF_ROUTE 24 /* Internal Routing Protocol */
245 #define AF_LINK 25 /* Link-layer interface */
246 #define AF_INET6 26 /* Internet Protocol, Version 6 */
247 #define AF_KEY 27 /* Security Association DB socket */
248 #define AF_NCA 28 /* NCA socket */
249 #define AF_POLICY 29 /* Security Policy DB socket */
250 #define AF_INET_OFFLOAD 30 /* Sun private; do not use */
252 #define AF_MAX 30
255 * Protocol families, same as address families for now.
257 #define PF_UNSPEC AF_UNSPEC
258 #define PF_UNIX AF_UNIX
259 #define PF_LOCAL PF_UNIX
260 #define PF_FILE PF_UNIX
261 #define PF_INET AF_INET
262 #define PF_IMPLINK AF_IMPLINK
263 #define PF_PUP AF_PUP
264 #define PF_CHAOS AF_CHAOS
265 #define PF_NS AF_NS
266 #define PF_NBS AF_NBS
267 #define PF_ECMA AF_ECMA
268 #define PF_DATAKIT AF_DATAKIT
269 #define PF_CCITT AF_CCITT
270 #define PF_SNA AF_SNA
271 #define PF_DECnet AF_DECnet
272 #define PF_DLI AF_DLI
273 #define PF_LAT AF_LAT
274 #define PF_HYLINK AF_HYLINK
275 #define PF_APPLETALK AF_APPLETALK
276 #define PF_NIT AF_NIT
277 #define PF_802 AF_802
278 #define PF_OSI AF_OSI
279 #define PF_X25 AF_X25
280 #define PF_OSINET AF_OSINET
281 #define PF_GOSIP AF_GOSIP
282 #define PF_IPX AF_IPX
283 #define PF_ROUTE AF_ROUTE
284 #define PF_LINK AF_LINK
285 #define PF_INET6 AF_INET6
286 #define PF_KEY AF_KEY
287 #define PF_NCA AF_NCA
288 #define PF_POLICY AF_POLICY
289 #define PF_INET_OFFLOAD AF_INET_OFFLOAD /* Sun private; do not use */
291 #define PF_MAX AF_MAX
294 * Maximum queue length specifiable by listen.
296 #define SOMAXCONN 128
299 * Message header for recvmsg and sendmsg calls.
301 struct msghdr {
302 void *msg_name; /* optional address */
303 socklen_t msg_namelen; /* size of address */
304 struct iovec *msg_iov; /* scatter/gather array */
305 int msg_iovlen; /* # elements in msg_iov */
307 #if defined(_XPG4_2) || defined(_KERNEL)
308 void *msg_control; /* ancillary data */
309 socklen_t msg_controllen; /* ancillary data buffer len */
310 int msg_flags; /* flags on received message */
311 #else
312 caddr_t msg_accrights; /* access rights sent/received */
313 int msg_accrightslen;
314 #endif /* defined(_XPG4_2) || defined(_KERNEL) */
317 #if defined(_KERNEL)
320 * N.B.: we assume that omsghdr and nmsghdr are isomorphic, with
321 * the sole exception that nmsghdr has the additional msg_flags
322 * field at the end.
324 struct omsghdr {
325 void *msg_name; /* optional address */
326 socklen_t msg_namelen; /* size of address */
327 struct iovec *msg_iov; /* scatter/gather array */
328 int msg_iovlen; /* # elements in msg_iov */
329 caddr_t msg_accrights; /* access rights sent/received */
330 int msg_accrightslen;
333 #define nmsghdr msghdr
335 #if defined(_SYSCALL32)
337 struct omsghdr32 {
338 caddr32_t msg_name; /* optional address */
339 uint32_t msg_namelen; /* size of address */
340 caddr32_t msg_iov; /* scatter/gather array */
341 int32_t msg_iovlen; /* # elements in msg_iov */
342 caddr32_t msg_accrights; /* access rights sent/received */
343 uint32_t msg_accrightslen;
346 struct msghdr32 {
347 caddr32_t msg_name; /* optional address */
348 uint32_t msg_namelen; /* size of address */
349 caddr32_t msg_iov; /* scatter/gather array */
350 int32_t msg_iovlen; /* # elements in msg_iov */
351 caddr32_t msg_control; /* ancillary data */
352 uint32_t msg_controllen; /* ancillary data buffer len */
353 int32_t msg_flags; /* flags on received message */
356 #define nmsghdr32 msghdr32
358 #endif /* _SYSCALL32 */
359 #endif /* _KERNEL */
361 #define MSG_OOB 0x1 /* process out-of-band data */
362 #define MSG_PEEK 0x2 /* peek at incoming message */
363 #define MSG_DONTROUTE 0x4 /* send without using routing tables */
364 /* Added for XPGv2 compliance */
365 #define MSG_EOR 0x8 /* Terminates a record */
366 #define MSG_CTRUNC 0x10 /* Control data truncated */
367 #define MSG_TRUNC 0x20 /* Normal data truncated */
368 #define MSG_WAITALL 0x40 /* Wait for complete recv or error */
369 #define MSG_DUPCTRL 0x800 /* Save control message for use with */
370 /* with left over data */
371 /* End of XPGv2 compliance */
372 #define MSG_DONTWAIT 0x80 /* Don't block for this recv */
373 #define MSG_NOTIFICATION 0x100 /* Notification, not data */
374 #define MSG_XPG4_2 0x8000 /* Private: XPG4.2 flag */
376 #define MSG_MAXIOVLEN 16
378 #ifdef _KERNEL
381 * for kernel socket only
383 #define MSG_MBLK_QUICKRELE 0x10000000 /* free mblk chain */
384 /* in timely manner */
385 #define MSG_USERSPACE 0x20000000 /* buffer from user space */
387 #endif /* _KERNEL */
390 /* Added for XPGv2 compliance */
391 #define SHUT_RD 0
392 #define SHUT_WR 1
393 #define SHUT_RDWR 2
395 struct cmsghdr {
396 socklen_t cmsg_len; /* data byte count, including hdr */
397 int cmsg_level; /* originating protocol */
398 int cmsg_type; /* protocol-specific type */
401 #if defined(_XPG4_2) || defined(_KERNEL)
402 #if defined(__sparc)
403 /* To maintain backward compatibility, alignment needs to be 8 on sparc. */
404 #define _CMSG_HDR_ALIGNMENT 8
405 #else
406 /* for __i386 (and other future architectures) */
407 #define _CMSG_HDR_ALIGNMENT 4
408 #endif /* defined(__sparc) */
409 #endif /* defined(_XPG4_2) || defined(_KERNEL) */
411 #if defined(_XPG4_2)
413 * The cmsg headers (and macros dealing with them) were made available as
414 * part of UNIX95 and hence need to be protected with a _XPG4_2 define.
416 #define _CMSG_DATA_ALIGNMENT (sizeof (int))
417 #define _CMSG_HDR_ALIGN(x) (((uintptr_t)(x) + _CMSG_HDR_ALIGNMENT - 1) & \
418 ~(_CMSG_HDR_ALIGNMENT - 1))
419 #define _CMSG_DATA_ALIGN(x) (((uintptr_t)(x) + _CMSG_DATA_ALIGNMENT - 1) & \
420 ~(_CMSG_DATA_ALIGNMENT - 1))
421 #define CMSG_DATA(c) \
422 ((unsigned char *)_CMSG_DATA_ALIGN((struct cmsghdr *)(c) + 1))
424 #define CMSG_FIRSTHDR(m) \
425 (((m)->msg_controllen < sizeof (struct cmsghdr)) ? \
426 (struct cmsghdr *)0 : (struct cmsghdr *)((m)->msg_control))
428 #define CMSG_NXTHDR(m, c) \
429 (((c) == 0) ? CMSG_FIRSTHDR(m) : \
430 ((((uintptr_t)_CMSG_HDR_ALIGN((char *)(c) + \
431 ((struct cmsghdr *)(c))->cmsg_len) + sizeof (struct cmsghdr)) > \
432 (((uintptr_t)((struct msghdr *)(m))->msg_control) + \
433 ((uintptr_t)((struct msghdr *)(m))->msg_controllen))) ? \
434 ((struct cmsghdr *)0) : \
435 ((struct cmsghdr *)_CMSG_HDR_ALIGN((char *)(c) + \
436 ((struct cmsghdr *)(c))->cmsg_len))))
438 /* Amount of space + padding needed for a message of length l */
439 #define CMSG_SPACE(l) \
440 ((unsigned int)_CMSG_HDR_ALIGN(sizeof (struct cmsghdr) + (l)))
442 /* Value to be used in cmsg_len, does not include trailing padding */
443 #define CMSG_LEN(l) \
444 ((unsigned int)_CMSG_DATA_ALIGN(sizeof (struct cmsghdr)) + (l))
446 #endif /* _XPG4_2 */
448 #ifdef _XPG4_2
449 #ifdef __PRAGMA_REDEFINE_EXTNAME
450 #pragma redefine_extname bind __xnet_bind
451 #pragma redefine_extname connect __xnet_connect
452 #pragma redefine_extname recvmsg __xnet_recvmsg
453 #pragma redefine_extname sendmsg __xnet_sendmsg
454 #pragma redefine_extname sendto __xnet_sendto
455 #pragma redefine_extname socket __xnet_socket
456 #pragma redefine_extname socketpair __xnet_socketpair
457 #pragma redefine_extname getsockopt __xnet_getsockopt
458 #else /* __PRAGMA_REDEFINE_EXTNAME */
459 #define bind __xnet_bind
460 #define connect __xnet_connect
461 #define recvmsg __xnet_recvmsg
462 #define sendmsg __xnet_sendmsg
463 #define sendto __xnet_sendto
464 #define socket __xnet_socket
465 #define socketpair __xnet_socketpair
466 #define getsockopt __xnet_getsockopt
467 #endif /* __PRAGMA_REDEFINE_EXTNAME */
469 #endif /* _XPG4_2 */
471 #if defined(_XPG4_2) && !defined(_XPG5)
472 #ifdef __PRAGMA_REDEFINE_EXTNAME
473 #pragma redefine_extname listen __xnet_listen
474 #else /* __PRAGMA_REDEFINE_EXTNAME */
475 #define listen __xnet_listen
476 #endif /* __PRAGMA_REDEFINE_EXTNAME */
477 #endif /* (_XPG4_2) && !defined(_XPG5) */
479 #if !defined(_KERNEL) || defined(_BOOT)
480 #ifdef __STDC__
481 extern int accept(int, struct sockaddr *_RESTRICT_KYWD, Psocklen_t);
482 extern int bind(int, const struct sockaddr *, socklen_t);
483 extern int connect(int, const struct sockaddr *, socklen_t);
484 extern int getpeername(int, struct sockaddr *_RESTRICT_KYWD, Psocklen_t);
485 extern int getsockname(int, struct sockaddr *_RESTRICT_KYWD, Psocklen_t);
486 extern int getsockopt(int, int, int, void *_RESTRICT_KYWD, Psocklen_t);
487 extern int listen(int, int); /* XXX - fixme??? where do I go */
488 extern int socketpair(int, int, int, int *);
489 extern ssize_t recv(int, void *, size_t, int);
490 extern ssize_t recvfrom(int, void *_RESTRICT_KYWD, size_t, int,
491 struct sockaddr *_RESTRICT_KYWD, Psocklen_t);
492 extern ssize_t recvmsg(int, struct msghdr *, int);
493 extern ssize_t send(int, const void *, size_t, int);
494 extern ssize_t sendmsg(int, const struct msghdr *, int);
495 extern ssize_t sendto(int, const void *, size_t, int, const struct sockaddr *,
496 socklen_t);
497 extern int setsockopt(int, int, int, const void *, socklen_t);
498 extern int shutdown(int, int);
499 extern int socket(int, int, int);
501 #if !defined(_XPG4_2) || defined(_XPG6) || defined(__EXTENSIONS__)
502 extern int sockatmark(int);
503 #endif /* !defined(_XPG4_2) || defined(_XPG6) || defined(__EXTENSIONS__) */
504 #else /* __STDC__ */
505 extern int accept();
506 extern int bind();
507 extern int connect();
508 extern int getpeername();
509 extern int getsockname();
510 extern int getsockopt();
511 extern int listen();
512 extern int recv();
513 extern int recvfrom();
514 extern int send();
515 extern int sendto();
516 extern int setsockopt();
517 extern int sockatmark();
518 extern int socket();
519 extern int recvmsg();
520 extern int sendmsg();
521 extern int shutdown();
522 extern int socketpair();
523 #endif /* __STDC__ */
524 #endif /* !defined(_KERNEL) || defined(_BOOT) */
526 #ifdef __cplusplus
528 #endif
530 #endif /* _SYS_SOCKET_H */