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