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 2007 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 #define SO_DOMAIN 0x100c /* get socket domain */ 148 149 /* "Socket"-level control message types: */ 150 #define SCM_RIGHTS 0x1010 /* access rights (array of int) */ 151 152 #define SO_SECATTR 0x1011 /* socket's security attributes */ 153 #define SCM_UCRED 0x1012 /* sender's ucred */ 154 #define SO_TIMESTAMP 0x1013 /* socket-level timestamp option */ 155 #define SCM_TIMESTAMP SO_TIMESTAMP /* socket control message timestamp */ 156 157 #define SO_ALLZONES 0x1014 /* bind in all zones */ 158 #define SO_EXCLBIND 0x1015 /* exclusive binding */ 159 160 #ifdef _KERNEL 161 #define SO_SRCADDR 0x2001 /* Internal: AF_UNIX source address */ 162 #define SO_FILEP 0x2002 /* Internal: AF_UNIX file pointer */ 163 #define SO_UNIX_CLOSE 0x2003 /* Internal: AF_UNIX peer closed */ 164 #endif /* _KERNEL */ 165 166 #ifdef _KERNEL 167 /* 168 * new socket open flags to identify socket and acceptor streams 169 */ 170 #define SO_ACCEPTOR 0x20000 /* acceptor socket */ 171 #define SO_SOCKSTR 0x40000 /* normal socket stream */ 172 #endif /* _KERNEL */ 173 174 /* 175 * Structure used for manipulating linger option. 176 */ 177 struct linger { 178 int l_onoff; /* option on/off */ 179 int l_linger; /* linger time */ 180 }; 181 182 /* 183 * Level number for (get/set)sockopt() to apply to socket itself. 184 */ 185 #define SOL_SOCKET 0xffff /* options for socket level */ 186 187 /* 188 * Address families. 189 */ 190 #define AF_UNSPEC 0 /* unspecified */ 191 #define AF_UNIX 1 /* local to host (pipes, portals) */ 192 #define AF_INET 2 /* internetwork: UDP, TCP, etc. */ 193 #define AF_IMPLINK 3 /* arpanet imp addresses */ 194 #define AF_PUP 4 /* pup protocols: e.g. BSP */ 195 #define AF_CHAOS 5 /* mit CHAOS protocols */ 196 #define AF_NS 6 /* XEROX NS protocols */ 197 #define AF_NBS 7 /* nbs protocols */ 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 /* 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_NIT 17 /* Network Interface Tap */ 208 #define AF_802 18 /* IEEE 802.2, also ISO 8802 */ 209 #define AF_OSI 19 /* umbrella for all families used */ 210 #define AF_X25 20 /* CCITT X.25 in particular */ 211 #define AF_OSINET 21 /* AFI = 47, IDI = 4 */ 212 #define AF_GOSIP 22 /* U.S. Government OSI */ 213 #define AF_IPX 23 /* Novell Internet Protocol */ 214 #define AF_ROUTE 24 /* Internal Routing Protocol */ 215 #define AF_LINK 25 /* Link-layer interface */ 216 #define AF_INET6 26 /* Internet Protocol, Version 6 */ 217 #define AF_KEY 27 /* Security Association DB socket */ 218 #define AF_NCA 28 /* NCA socket */ 219 #define AF_POLICY 29 /* Security Policy DB socket */ 220 #define AF_INET_OFFLOAD 30 /* Sun private; do not use */ 221 222 #define AF_MAX 30 223 224 /* 225 * Protocol families, same as address families for now. 226 */ 227 #define PF_UNSPEC AF_UNSPEC 228 #define PF_UNIX AF_UNIX 229 #define PF_INET AF_INET 230 #define PF_IMPLINK AF_IMPLINK 231 #define PF_PUP AF_PUP 232 #define PF_CHAOS AF_CHAOS 233 #define PF_NS AF_NS 234 #define PF_NBS AF_NBS 235 #define PF_ECMA AF_ECMA 236 #define PF_DATAKIT AF_DATAKIT 237 #define PF_CCITT AF_CCITT 238 #define PF_SNA AF_SNA 239 #define PF_DECnet AF_DECnet 240 #define PF_DLI AF_DLI 241 #define PF_LAT AF_LAT 242 #define PF_HYLINK AF_HYLINK 243 #define PF_APPLETALK AF_APPLETALK 244 #define PF_NIT AF_NIT 245 #define PF_802 AF_802 246 #define PF_OSI AF_OSI 247 #define PF_X25 AF_X25 248 #define PF_OSINET AF_OSINET 249 #define PF_GOSIP AF_GOSIP 250 #define PF_IPX AF_IPX 251 #define PF_ROUTE AF_ROUTE 252 #define PF_LINK AF_LINK 253 #define PF_INET6 AF_INET6 254 #define PF_KEY AF_KEY 255 #define PF_NCA AF_NCA 256 #define PF_POLICY AF_POLICY 257 #define PF_INET_OFFLOAD AF_INET_OFFLOAD /* Sun private; do not use */ 258 259 #define PF_MAX AF_MAX 260 261 /* 262 * Maximum queue length specifiable by listen. 263 */ 264 #define SOMAXCONN 128 265 266 /* 267 * Message header for recvmsg and sendmsg calls. 268 */ 269 struct msghdr { 270 void *msg_name; /* optional address */ 271 socklen_t msg_namelen; /* size of address */ 272 struct iovec *msg_iov; /* scatter/gather array */ 273 int msg_iovlen; /* # elements in msg_iov */ 274 275 #if defined(_XPG4_2) || defined(_KERNEL) 276 void *msg_control; /* ancillary data */ 277 socklen_t msg_controllen; /* ancillary data buffer len */ 278 int msg_flags; /* flags on received message */ 279 #else 280 caddr_t msg_accrights; /* access rights sent/received */ 281 int msg_accrightslen; 282 #endif /* defined(_XPG4_2) || defined(_KERNEL) */ 283 }; 284 285 #if defined(_KERNEL) 286 287 /* 288 * N.B.: we assume that omsghdr and nmsghdr are isomorphic, with 289 * the sole exception that nmsghdr has the additional msg_flags 290 * field at the end. 291 */ 292 struct omsghdr { 293 void *msg_name; /* optional address */ 294 socklen_t msg_namelen; /* size of address */ 295 struct iovec *msg_iov; /* scatter/gather array */ 296 int msg_iovlen; /* # elements in msg_iov */ 297 caddr_t msg_accrights; /* access rights sent/received */ 298 int msg_accrightslen; 299 }; 300 301 #define nmsghdr msghdr 302 303 #if defined(_SYSCALL32) 304 305 struct omsghdr32 { 306 caddr32_t msg_name; /* optional address */ 307 uint32_t msg_namelen; /* size of address */ 308 caddr32_t msg_iov; /* scatter/gather array */ 309 int32_t msg_iovlen; /* # elements in msg_iov */ 310 caddr32_t msg_accrights; /* access rights sent/received */ 311 uint32_t msg_accrightslen; 312 }; 313 314 struct msghdr32 { 315 caddr32_t msg_name; /* optional address */ 316 uint32_t msg_namelen; /* size of address */ 317 caddr32_t msg_iov; /* scatter/gather array */ 318 int32_t msg_iovlen; /* # elements in msg_iov */ 319 caddr32_t msg_control; /* ancillary data */ 320 uint32_t msg_controllen; /* ancillary data buffer len */ 321 int32_t msg_flags; /* flags on received message */ 322 }; 323 324 #define nmsghdr32 msghdr32 325 326 #endif /* _SYSCALL32 */ 327 #endif /* _KERNEL */ 328 329 #define MSG_OOB 0x1 /* process out-of-band data */ 330 #define MSG_PEEK 0x2 /* peek at incoming message */ 331 #define MSG_DONTROUTE 0x4 /* send without using routing tables */ 332 /* Added for XPGv2 compliance */ 333 #define MSG_EOR 0x8 /* Terminates a record */ 334 #define MSG_CTRUNC 0x10 /* Control data truncated */ 335 #define MSG_TRUNC 0x20 /* Normal data truncated */ 336 #define MSG_WAITALL 0x40 /* Wait for complete recv or error */ 337 /* End of XPGv2 compliance */ 338 #define MSG_DONTWAIT 0x80 /* Don't block for this recv */ 339 #define MSG_NOTIFICATION 0x100 /* Notification, not data */ 340 #define MSG_XPG4_2 0x8000 /* Private: XPG4.2 flag */ 341 342 #define MSG_MAXIOVLEN 16 343 344 /* Added for XPGv2 compliance */ 345 #define SHUT_RD 0 346 #define SHUT_WR 1 347 #define SHUT_RDWR 2 348 349 struct cmsghdr { 350 socklen_t cmsg_len; /* data byte count, including hdr */ 351 int cmsg_level; /* originating protocol */ 352 int cmsg_type; /* protocol-specific type */ 353 }; 354 355 #if defined(_XPG4_2) || defined(_KERNEL) 356 #if defined(__sparc) 357 /* To maintain backward compatibility, alignment needs to be 8 on sparc. */ 358 #define _CMSG_HDR_ALIGNMENT 8 359 #else 360 /* for __i386 (and other future architectures) */ 361 #define _CMSG_HDR_ALIGNMENT 4 362 #endif /* defined(__sparc) */ 363 #endif /* defined(_XPG4_2) || defined(_KERNEL) */ 364 365 #if defined(_XPG4_2) 366 /* 367 * The cmsg headers (and macros dealing with them) were made available as 368 * part of UNIX95 and hence need to be protected with a _XPG4_2 define. 369 */ 370 #define _CMSG_DATA_ALIGNMENT (sizeof (int)) 371 #define _CMSG_HDR_ALIGN(x) (((uintptr_t)(x) + _CMSG_HDR_ALIGNMENT - 1) & \ 372 ~(_CMSG_HDR_ALIGNMENT - 1)) 373 #define _CMSG_DATA_ALIGN(x) (((uintptr_t)(x) + _CMSG_DATA_ALIGNMENT - 1) & \ 374 ~(_CMSG_DATA_ALIGNMENT - 1)) 375 #define CMSG_DATA(c) \ 376 ((unsigned char *)_CMSG_DATA_ALIGN((struct cmsghdr *)(c) + 1)) 377 378 #define CMSG_FIRSTHDR(m) \ 379 (((m)->msg_controllen < sizeof (struct cmsghdr)) ? \ 380 (struct cmsghdr *)0 : (struct cmsghdr *)((m)->msg_control)) 381 382 #define CMSG_NXTHDR(m, c) \ 383 (((c) == 0) ? CMSG_FIRSTHDR(m) : \ 384 ((((uintptr_t)_CMSG_HDR_ALIGN((char *)(c) + \ 385 ((struct cmsghdr *)(c))->cmsg_len) + sizeof (struct cmsghdr)) > \ 386 (((uintptr_t)((struct msghdr *)(m))->msg_control) + \ 387 ((uintptr_t)((struct msghdr *)(m))->msg_controllen))) ? \ 388 ((struct cmsghdr *)0) : \ 389 ((struct cmsghdr *)_CMSG_HDR_ALIGN((char *)(c) + \ 390 ((struct cmsghdr *)(c))->cmsg_len)))) 391 392 /* Amount of space + padding needed for a message of length l */ 393 #define CMSG_SPACE(l) \ 394 ((unsigned int)_CMSG_HDR_ALIGN(sizeof (struct cmsghdr) + (l))) 395 396 /* Value to be used in cmsg_len, does not include trailing padding */ 397 #define CMSG_LEN(l) \ 398 ((unsigned int)_CMSG_DATA_ALIGN(sizeof (struct cmsghdr)) + (l)) 399 400 #endif /* _XPG4_2 */ 401 402 #ifdef _XPG4_2 403 #ifdef __PRAGMA_REDEFINE_EXTNAME 404 #pragma redefine_extname bind __xnet_bind 405 #pragma redefine_extname connect __xnet_connect 406 #pragma redefine_extname recvmsg __xnet_recvmsg 407 #pragma redefine_extname sendmsg __xnet_sendmsg 408 #pragma redefine_extname sendto __xnet_sendto 409 #pragma redefine_extname socket __xnet_socket 410 #pragma redefine_extname socketpair __xnet_socketpair 411 #pragma redefine_extname getsockopt __xnet_getsockopt 412 #else /* __PRAGMA_REDEFINE_EXTNAME */ 413 #define bind __xnet_bind 414 #define connect __xnet_connect 415 #define recvmsg __xnet_recvmsg 416 #define sendmsg __xnet_sendmsg 417 #define sendto __xnet_sendto 418 #define socket __xnet_socket 419 #define socketpair __xnet_socketpair 420 #define getsockopt __xnet_getsockopt 421 #endif /* __PRAGMA_REDEFINE_EXTNAME */ 422 423 #endif /* _XPG4_2 */ 424 425 #if defined(_XPG4_2) && !defined(_XPG5) 426 #ifdef __PRAGMA_REDEFINE_EXTNAME 427 #pragma redefine_extname listen __xnet_listen 428 #else /* __PRAGMA_REDEFINE_EXTNAME */ 429 #define listen __xnet_listen 430 #endif /* __PRAGMA_REDEFINE_EXTNAME */ 431 #endif /* (_XPG4_2) && !defined(_XPG5) */ 432 433 #if !defined(_KERNEL) || defined(_BOOT) 434 #ifdef __STDC__ 435 extern int accept(int, struct sockaddr *_RESTRICT_KYWD, Psocklen_t); 436 extern int bind(int, const struct sockaddr *, socklen_t); 437 extern int connect(int, const struct sockaddr *, socklen_t); 438 extern int getpeername(int, struct sockaddr *_RESTRICT_KYWD, Psocklen_t); 439 extern int getsockname(int, struct sockaddr *_RESTRICT_KYWD, Psocklen_t); 440 extern int getsockopt(int, int, int, void *_RESTRICT_KYWD, Psocklen_t); 441 extern int listen(int, int); /* XXX - fixme??? where do I go */ 442 extern int socketpair(int, int, int, int *); 443 extern ssize_t recv(int, void *, size_t, int); 444 extern ssize_t recvfrom(int, void *_RESTRICT_KYWD, size_t, int, 445 struct sockaddr *_RESTRICT_KYWD, Psocklen_t); 446 extern ssize_t recvmsg(int, struct msghdr *, int); 447 extern ssize_t send(int, const void *, size_t, int); 448 extern ssize_t sendmsg(int, const struct msghdr *, int); 449 extern ssize_t sendto(int, const void *, size_t, int, const struct sockaddr *, 450 socklen_t); 451 extern int setsockopt(int, int, int, const void *, socklen_t); 452 extern int shutdown(int, int); 453 extern int socket(int, int, int); 454 455 #if !defined(_XPG4_2) || defined(_XPG6) || defined(__EXTENSIONS__) 456 extern int sockatmark(int); 457 #endif /* !defined(_XPG4_2) || defined(_XPG6) || defined(__EXTENSIONS__) */ 458 #else /* __STDC__ */ 459 extern int accept(); 460 extern int bind(); 461 extern int connect(); 462 extern int getpeername(); 463 extern int getsockname(); 464 extern int getsockopt(); 465 extern int listen(); 466 extern int recv(); 467 extern int recvfrom(); 468 extern int send(); 469 extern int sendto(); 470 extern int setsockopt(); 471 extern int sockatmark(); 472 extern int socket(); 473 extern int recvmsg(); 474 extern int sendmsg(); 475 extern int shutdown(); 476 extern int socketpair(); 477 #endif /* __STDC__ */ 478 #endif /* !defined(_KERNEL) || defined(_BOOT) */ 479 480 #ifdef __cplusplus 481 } 482 #endif 483 484 #endif /* _SYS_SOCKET_H */ 485