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