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