bsd/sys/socket.h

   1 /*
   2  * Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_OSREFERENCE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License.  The rights granted to you under the
  10  * License may not be used to create, or enable the creation or
  11  * redistribution of, unlawful or unlicensed copies of an Apple operating
  12  * system, or to circumvent, violate, or enable the circumvention or
  13  * violation of, any terms of an Apple operating system software license
  14  * agreement.
  15  *
  16  * Please obtain a copy of the License at
  17  * http://www.opensource.apple.com/apsl/ and read it before using this
  18  * file.
  19  *
  20  * The Original Code and all software distributed under the License are
  21  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  22  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  23  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  24  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  25  * Please see the License for the specific language governing rights and
  26  * limitations under the License.
  27  *
  28  * @APPLE_LICENSE_OSREFERENCE_HEADER_END@
  29  */
  30 /* Copyright (c) 1998, 1999 Apple Computer, Inc. All Rights Reserved */
  31 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
  32 /*
  33  * Copyright (c) 1982, 1985, 1986, 1988, 1993, 1994
  34  *      The Regents of the University of California.  All rights reserved.
  35  *
  36  * Redistribution and use in source and binary forms, with or without
  37  * modification, are permitted provided that the following conditions
  38  * are met:
  39  * 1. Redistributions of source code must retain the above copyright
  40  *    notice, this list of conditions and the following disclaimer.
  41  * 2. Redistributions in binary form must reproduce the above copyright
  42  *    notice, this list of conditions and the following disclaimer in the
  43  *    documentation and/or other materials provided with the distribution.
  44  * 3. All advertising materials mentioning features or use of this software
  45  *    must display the following acknowledgement:
  46  *      This product includes software developed by the University of
  47  *      California, Berkeley and its contributors.
  48  * 4. Neither the name of the University nor the names of its contributors
  49  *    may be used to endorse or promote products derived from this software
  50  *    without specific prior written permission.
  51  *
  52  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  53  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  54  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  55  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  56  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  57  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  58  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  59  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  60  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  61  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  62  * SUCH DAMAGE.
  63  *
  64  *      @(#)socket.h    8.4 (Berkeley) 2/21/94
  65  * $FreeBSD: src/sys/sys/socket.h,v 1.39.2.7 2001/07/03 11:02:01 ume Exp $
  66  */
  67
  68 #ifndef _SYS_SOCKET_H_
  69 #define _SYS_SOCKET_H_
  70
  71 #include <sys/_types.h>
  72 #include <sys/cdefs.h>
  73
  74 #define _NO_NAMESPACE_POLLUTION
  75 #include <machine/param.h>
  76 #undef _NO_NAMESPACE_POLLUTION
  77
  78 /*
  79  * Definitions related to sockets: types, address families, options.
  80  */
  81
  82 /*
  83  * Data types.
  84  */
  85 #ifndef _GID_T
  86 typedef __darwin_gid_t          gid_t;
  87 #define _GID_T
  88 #endif
  89
  90 #ifndef _OFF_T
  91 typedef __darwin_off_t          off_t;
  92 #define _OFF_T
  93 #endif
  94
  95 #ifndef _PID_T
  96 typedef __darwin_pid_t          pid_t;
  97 #define _PID_T
  98 #endif
  99
 100 #ifndef _SA_FAMILY_T
 101 #define _SA_FAMILY_T
 102 typedef __uint8_t               sa_family_t;
 103 #endif
 104
 105 #ifndef _SOCKLEN_T
 106 #define _SOCKLEN_T
 107 typedef __darwin_socklen_t      socklen_t;
 108 #endif
 109
 110 /* XXX Not explicitly defined by POSIX, but function return types are */
 111 #ifndef _SIZE_T
 112 #define _SIZE_T
 113 typedef __darwin_size_t         size_t;
 114 #endif
 115
 116 /* XXX Not explicitly defined by POSIX, but function return types are */
 117 #ifndef _SSIZE_T
 118 #define _SSIZE_T
 119 typedef __darwin_ssize_t        ssize_t;
 120 #endif
 121
 122 /*
 123  * [XSI] The iovec structure shall be defined as described in <sys/uio.h>.
 124  */
 125 #ifndef _STRUCT_IOVEC
 126 #define _STRUCT_IOVEC
 127 struct iovec {
 128         void *   iov_base;      /* [XSI] Base address of I/O memory region */
 129         size_t   iov_len;       /* [XSI] Size of region iov_base points to */
 130 };
 131 #endif
 132
 133 /*
 134  * Types
 135  */
 136 #define SOCK_STREAM     1               /* stream socket */
 137 #define SOCK_DGRAM      2               /* datagram socket */
 138 #define SOCK_RAW        3               /* raw-protocol interface */
 139 #ifndef _POSIX_C_SOURCE
 140 #define SOCK_RDM        4               /* reliably-delivered message */
 141 #endif  /* !_POSIX_C_SOURCE */
 142 #define SOCK_SEQPACKET  5               /* sequenced packet stream */
 143
 144 /*
 145  * Option flags per-socket.
 146  */
 147 #define SO_DEBUG        0x0001          /* turn on debugging info recording */
 148 #define SO_ACCEPTCONN   0x0002          /* socket has had listen() */
 149 #define SO_REUSEADDR    0x0004          /* allow local address reuse */
 150 #define SO_KEEPALIVE    0x0008          /* keep connections alive */
 151 #define SO_DONTROUTE    0x0010          /* just use interface addresses */
 152 #define SO_BROADCAST    0x0020          /* permit sending of broadcast msgs */
 153 #ifndef _POSIX_C_SOURCE
 154 #define SO_USELOOPBACK  0x0040          /* bypass hardware when possible */
 155 #define SO_LINGER       0x0080          /* linger on close if data present (in ticks) */
 156 #else
 157 #define SO_LINGER       0x1080          /* linger on close if data present (in seconds) */
 158 #endif  /* !_POSIX_C_SOURCE */
 159 #define SO_OOBINLINE    0x0100          /* leave received OOB data in line */
 160 #ifndef _POSIX_C_SOURCE
 161 #define SO_REUSEPORT    0x0200          /* allow local address & port reuse */
 162 #define SO_TIMESTAMP    0x0400          /* timestamp received dgram traffic */
 163 #ifndef __APPLE__
 164 #define SO_ACCEPTFILTER 0x1000          /* there is an accept filter */
 165 #else
 166 #define SO_DONTTRUNC    0x2000          /* APPLE: Retain unread data */
 167                                         /*  (ATOMIC proto) */
 168 #define SO_WANTMORE             0x4000          /* APPLE: Give hint when more data ready */
 169 #define SO_WANTOOBFLAG  0x8000          /* APPLE: Want OOB in MSG_FLAG on receive */
 170 #endif
 171 #endif  /* !_POSIX_C_SOURCE */
 172
 173 /*
 174  * Additional options, not kept in so_options.
 175  */
 176 #define SO_SNDBUF       0x1001          /* send buffer size */
 177 #define SO_RCVBUF       0x1002          /* receive buffer size */
 178 #define SO_SNDLOWAT     0x1003          /* send low-water mark */
 179 #define SO_RCVLOWAT     0x1004          /* receive low-water mark */
 180 #define SO_SNDTIMEO     0x1005          /* send timeout */
 181 #define SO_RCVTIMEO     0x1006          /* receive timeout */
 182 #define SO_ERROR        0x1007          /* get error status and clear */
 183 #define SO_TYPE         0x1008          /* get socket type */
 184 #ifndef _POSIX_C_SOURCE
 185 /*efine SO_PRIVSTATE    0x1009             get/deny privileged state */
 186 #ifdef __APPLE__
 187 #define SO_NREAD        0x1020          /* APPLE: get 1st-packet byte count */
 188 #define SO_NKE          0x1021          /* APPLE: Install socket-level NKE */
 189 #define SO_NOSIGPIPE    0x1022          /* APPLE: No SIGPIPE on EPIPE */
 190 #define SO_NOADDRERR    0x1023          /* APPLE: Returns EADDRNOTAVAIL when src is not available anymore */
 191 #define SO_NWRITE       0x1024          /* APPLE: Get number of bytes currently in send socket buffer */
 192 #define SO_LINGER_SEC   0x1080          /* linger on close if data present (in seconds) */
 193 #endif
 194 #endif  /* !_POSIX_C_SOURCE */
 195
 196 /*
 197  * Structure used for manipulating linger option.
 198  */
 199 struct  linger {
 200         int     l_onoff;                /* option on/off */
 201         int     l_linger;               /* linger time */
 202 };
 203
 204 #ifndef __APPLE__
 205 struct  accept_filter_arg {
 206         char    af_name[16];
 207         char    af_arg[256-16];
 208 };
 209 #endif
 210
 211 /*
 212  * Level number for (get/set)sockopt() to apply to socket itself.
 213  */
 214 #define SOL_SOCKET      0xffff          /* options for socket level */
 215
 216 /*
 217  * Address families.
 218  */
 219 #define AF_UNSPEC       0               /* unspecified */
 220 #define AF_UNIX         1               /* local to host (pipes) */
 221 #ifndef _POSIX_C_SOURCE
 222 #define AF_LOCAL        AF_UNIX         /* backward compatibility */
 223 #endif  /* !_POSIX_C_SOURCE */
 224 #define AF_INET         2               /* internetwork: UDP, TCP, etc. */
 225 #ifndef _POSIX_C_SOURCE
 226 #define AF_IMPLINK      3               /* arpanet imp addresses */
 227 #define AF_PUP          4               /* pup protocols: e.g. BSP */
 228 #define AF_CHAOS        5               /* mit CHAOS protocols */
 229 #define AF_NS           6               /* XEROX NS protocols */
 230 #define AF_ISO          7               /* ISO protocols */
 231 #define AF_OSI          AF_ISO
 232 #define AF_ECMA         8               /* European computer manufacturers */
 233 #define AF_DATAKIT      9               /* datakit protocols */
 234 #define AF_CCITT        10              /* CCITT protocols, X.25 etc */
 235 #define AF_SNA          11              /* IBM SNA */
 236 #define AF_DECnet       12              /* DECnet */
 237 #define AF_DLI          13              /* DEC Direct data link interface */
 238 #define AF_LAT          14              /* LAT */
 239 #define AF_HYLINK       15              /* NSC Hyperchannel */
 240 #define AF_APPLETALK    16              /* Apple Talk */
 241 #define AF_ROUTE        17              /* Internal Routing Protocol */
 242 #define AF_LINK         18              /* Link layer interface */
 243 #define pseudo_AF_XTP   19              /* eXpress Transfer Protocol (no AF) */
 244 #define AF_COIP         20              /* connection-oriented IP, aka ST II */
 245 #define AF_CNT          21              /* Computer Network Technology */
 246 #define pseudo_AF_RTIP  22              /* Help Identify RTIP packets */
 247 #define AF_IPX          23              /* Novell Internet Protocol */
 248 #define AF_SIP          24              /* Simple Internet Protocol */
 249 #define pseudo_AF_PIP   25              /* Help Identify PIP packets */
 250 #ifdef __APPLE__
 251 /*define pseudo_AF_BLUE 26         Identify packets for Blue Box - Not used */
 252 #define AF_NDRV         27              /* Network Driver 'raw' access */
 253 #endif
 254 #define AF_ISDN         28              /* Integrated Services Digital Network*/
 255 #define AF_E164         AF_ISDN         /* CCITT E.164 recommendation */
 256 #define pseudo_AF_KEY   29              /* Internal key-management function */
 257 #endif  /* !_POSIX_C_SOURCE */
 258 #define AF_INET6        30              /* IPv6 */
 259 #ifndef _POSIX_C_SOURCE
 260 #define AF_NATM         31              /* native ATM access */
 261 #ifdef __APPLE__
 262 #define AF_SYSTEM       32              /* Kernel event messages */
 263 #define AF_NETBIOS      33              /* NetBIOS */
 264 #define AF_PPP          34              /* PPP communication protocol */
 265 #else
 266 #define AF_ATM          30              /* ATM */
 267 #endif
 268 #define pseudo_AF_HDRCMPLT 35           /* Used by BPF to not rewrite headers
 269                                          * in interface output routine
 270                                          */
 271 #ifdef PRIVATE
 272 #define AF_AFP  36                      /* Used by AFP */
 273 #else
 274 #define AF_RESERVED_36  36              /* Reserved for internal usage */
 275 #endif
 276
 277 #ifndef __APPLE__
 278 #define AF_NETGRAPH     32              /* Netgraph sockets */
 279 #endif
 280 #define AF_MAX          37
 281 #endif  /* !_POSIX_C_SOURCE */
 282
 283 /*
 284  * [XSI] Structure used by kernel to store most addresses.
 285  */
 286 struct sockaddr {
 287         __uint8_t       sa_len;         /* total length */
 288         sa_family_t     sa_family;      /* [XSI] address family */
 289         char            sa_data[14];    /* [XSI] addr value (actually larger) */
 290 };
 291
 292 #ifndef _POSIX_C_SOURCE
 293 #define SOCK_MAXADDRLEN 255             /* longest possible addresses */
 294
 295 /*
 296  * Structure used by kernel to pass protocol
 297  * information in raw sockets.
 298  */
 299 struct sockproto {
 300         __uint16_t      sp_family;              /* address family */
 301         __uint16_t      sp_protocol;            /* protocol */
 302 };
 303 #endif  /* !_POSIX_C_SOURCE*/
 304
 305 /*
 306  * RFC 2553: protocol-independent placeholder for socket addresses
 307  */
 308 #define _SS_MAXSIZE     128
 309 #define _SS_ALIGNSIZE   (sizeof(__int64_t))
 310 #define _SS_PAD1SIZE    \
 311                 (_SS_ALIGNSIZE - sizeof(__uint8_t) - sizeof(sa_family_t))
 312 #define _SS_PAD2SIZE    \
 313                 (_SS_MAXSIZE - sizeof(__uint8_t) - sizeof(sa_family_t) - \
 314                                 _SS_PAD1SIZE - _SS_ALIGNSIZE)
 315
 316 /*
 317  * [XSI] sockaddr_storage
 318  */
 319 struct sockaddr_storage {
 320         __uint8_t       ss_len;         /* address length */
 321         sa_family_t     ss_family;      /* [XSI] address family */
 322         char                    __ss_pad1[_SS_PAD1SIZE];
 323         __int64_t       __ss_align;     /* force structure storage alignment */
 324         char                    __ss_pad2[_SS_PAD2SIZE];
 325 };
 326
 327 /*
 328  * Protocol families, same as address families for now.
 329  */
 330 #define PF_UNSPEC       AF_UNSPEC
 331 #define PF_LOCAL        AF_LOCAL
 332 #define PF_UNIX         PF_LOCAL        /* backward compatibility */
 333 #define PF_INET         AF_INET
 334 #define PF_IMPLINK      AF_IMPLINK
 335 #define PF_PUP          AF_PUP
 336 #define PF_CHAOS        AF_CHAOS
 337 #define PF_NS           AF_NS
 338 #define PF_ISO          AF_ISO
 339 #define PF_OSI          AF_ISO
 340 #define PF_ECMA         AF_ECMA
 341 #define PF_DATAKIT      AF_DATAKIT
 342 #define PF_CCITT        AF_CCITT
 343 #define PF_SNA          AF_SNA
 344 #define PF_DECnet       AF_DECnet
 345 #define PF_DLI          AF_DLI
 346 #define PF_LAT          AF_LAT
 347 #define PF_HYLINK       AF_HYLINK
 348 #define PF_APPLETALK    AF_APPLETALK
 349 #define PF_ROUTE        AF_ROUTE
 350 #define PF_LINK         AF_LINK
 351 #define PF_XTP          pseudo_AF_XTP   /* really just proto family, no AF */
 352 #define PF_COIP         AF_COIP
 353 #define PF_CNT          AF_CNT
 354 #define PF_SIP          AF_SIP
 355 #define PF_IPX          AF_IPX          /* same format as AF_NS */
 356 #define PF_RTIP         pseudo_AF_RTIP  /* same format as AF_INET */
 357 #define PF_PIP          pseudo_AF_PIP
 358 #ifdef __APPLE__
 359 #define PF_NDRV         AF_NDRV
 360 #endif
 361 #define PF_ISDN         AF_ISDN
 362 #define PF_KEY          pseudo_AF_KEY
 363 #define PF_INET6        AF_INET6
 364 #define PF_NATM         AF_NATM
 365 #ifdef __APPLE__
 366 #define PF_SYSTEM       AF_SYSTEM
 367 #define PF_NETBIOS      AF_NETBIOS
 368 #define PF_PPP          AF_PPP
 369 #ifdef PRIVATE
 370 #define PF_AFP          AF_AFP
 371 #else
 372 #define PF_RESERVED_36  AF_RESERVED_36
 373 #endif
 374
 375 #else
 376 #define PF_ATM          AF_ATM
 377 #define PF_NETGRAPH     AF_NETGRAPH
 378 #endif
 379
 380 #define PF_MAX          AF_MAX
 381
 382 /*
 383  * These do not have socket-layer support:
 384  */
 385 #define PF_VLAN         ((uint32_t)0x766c616e)  /* 'vlan' */
 386 #define PF_BOND         ((uint32_t)0x626f6e64)  /* 'bond' */
 387
 388 /*
 389  * Definitions for network related sysctl, CTL_NET.
 390  *
 391  * Second level is protocol family.
 392  * Third level is protocol number.
 393  *
 394  * Further levels are defined by the individual families below.
 395  */
 396 #define NET_MAXID       AF_MAX
 397
 398
 399 #ifdef KERNEL_PRIVATE
 400 #define CTL_NET_NAMES { \
 401         { 0, 0 }, \
 402         { "local", CTLTYPE_NODE }, \
 403         { "inet", CTLTYPE_NODE }, \
 404         { "implink", CTLTYPE_NODE }, \
 405         { "pup", CTLTYPE_NODE }, \
 406         { "chaos", CTLTYPE_NODE }, \
 407         { "xerox_ns", CTLTYPE_NODE }, \
 408         { "iso", CTLTYPE_NODE }, \
 409         { "emca", CTLTYPE_NODE }, \
 410         { "datakit", CTLTYPE_NODE }, \
 411         { "ccitt", CTLTYPE_NODE }, \
 412         { "ibm_sna", CTLTYPE_NODE }, \
 413         { "decnet", CTLTYPE_NODE }, \
 414         { "dec_dli", CTLTYPE_NODE }, \
 415         { "lat", CTLTYPE_NODE }, \
 416         { "hylink", CTLTYPE_NODE }, \
 417         { "appletalk", CTLTYPE_NODE }, \
 418         { "route", CTLTYPE_NODE }, \
 419         { "link_layer", CTLTYPE_NODE }, \
 420         { "xtp", CTLTYPE_NODE }, \
 421         { "coip", CTLTYPE_NODE }, \
 422         { "cnt", CTLTYPE_NODE }, \
 423         { "rtip", CTLTYPE_NODE }, \
 424         { "ipx", CTLTYPE_NODE }, \
 425         { "sip", CTLTYPE_NODE }, \
 426         { "pip", CTLTYPE_NODE }, \
 427         { 0, 0 }, \
 428         { "ndrv", CTLTYPE_NODE }, \
 429         { "isdn", CTLTYPE_NODE }, \
 430         { "key", CTLTYPE_NODE }, \
 431         { "inet6", CTLTYPE_NODE }, \
 432         { "natm", CTLTYPE_NODE }, \
 433         { "sys", CTLTYPE_NODE }, \
 434         { "netbios", CTLTYPE_NODE }, \
 435         { "ppp", CTLTYPE_NODE }, \
 436         { "hdrcomplete", CTLTYPE_NODE }, \
 437 }
 438 #endif KERNEL_PRIVATE
 439
 440 /*
 441  * PF_ROUTE - Routing table
 442  *
 443  * Three additional levels are defined:
 444  *      Fourth: address family, 0 is wildcard
 445  *      Fifth: type of info, defined below
 446  *      Sixth: flag(s) to mask with for NET_RT_FLAGS
 447  */
 448 #define NET_RT_DUMP                     1               /* dump; may limit to a.f. */
 449 #define NET_RT_FLAGS            2               /* by flags, e.g. RESOLVING */
 450 #define NET_RT_IFLIST           3               /* survey interface list */
 451 #define NET_RT_STAT                     4               /* routing statistics */
 452 #define NET_RT_TRASH            5               /* routes not in table but not freed */
 453 #define NET_RT_IFLIST2  6               /* interface list with addresses */
 454 #define NET_RT_DUMP2                     7               /* dump; may limit to a.f. */
 455 #define NET_RT_MAXID            8
 456
 457 #ifdef KERNEL_PRIVATE
 458 #define CTL_NET_RT_NAMES { \
 459         { 0, 0 }, \
 460         { "dump", CTLTYPE_STRUCT }, \
 461         { "flags", CTLTYPE_STRUCT }, \
 462         { "iflist", CTLTYPE_STRUCT }, \
 463         { "stat", CTLTYPE_STRUCT }, \
 464         { "trash", CTLTYPE_INT }, \
 465         { "iflist2", CTLTYPE_STRUCT }, \
 466         { "dump2", CTLTYPE_STRUCT }, \
 467 }
 468
 469 #endif KERNEL_PRIVATE
 470
 471 /*
 472  * Maximum queue length specifiable by listen.
 473  */
 474 #define SOMAXCONN       128
 475
 476 /*
 477  * [XSI] Message header for recvmsg and sendmsg calls.
 478  * Used value-result for recvmsg, value only for sendmsg.
 479  */
 480 struct msghdr {
 481         void            *msg_name;      /* [XSI] optional address */
 482         socklen_t       msg_namelen;    /* [XSI] size of address */
 483         struct          iovec *msg_iov; /* [XSI] scatter/gather array */
 484         int             msg_iovlen;     /* [XSI] # elements in msg_iov */
 485         void            *msg_control;   /* [XSI] ancillary data, see below */
 486         socklen_t       msg_controllen; /* [XSI] ancillary data buffer len */
 487         int             msg_flags;      /* [XSI] flags on received message */
 488 };
 489
 490 // LP64todo - should this move?
 491 #ifdef KERNEL
 492 /* LP64 version of struct msghdr.  all pointers
 493  * grow when we're dealing with a 64-bit process.
 494  * WARNING - keep in sync with struct msghdr
 495  */
 496
 497 struct user_msghdr {
 498         user_addr_t     msg_name;               /* optional address */
 499         socklen_t       msg_namelen;            /* size of address */
 500         user_addr_t     msg_iov __attribute((aligned(8)));              /* scatter/gather array */
 501         int             msg_iovlen;             /* # elements in msg_iov */
 502         user_addr_t     msg_control __attribute((aligned(8)));          /* ancillary data, see below */
 503         socklen_t       msg_controllen;         /* ancillary data buffer len */
 504         int             msg_flags;              /* flags on received message */
 505 };
 506
 507 #endif // KERNEL
 508
 509 #define MSG_OOB         0x1             /* process out-of-band data */
 510 #define MSG_PEEK        0x2             /* peek at incoming message */
 511 #define MSG_DONTROUTE   0x4             /* send without using routing tables */
 512 #define MSG_EOR         0x8             /* data completes record */
 513 #define MSG_TRUNC       0x10            /* data discarded before delivery */
 514 #define MSG_CTRUNC      0x20            /* control data lost before delivery */
 515 #define MSG_WAITALL     0x40            /* wait for full request or error */
 516 #ifndef _POSIX_C_SOURCE
 517 #define MSG_DONTWAIT    0x80            /* this message should be nonblocking */
 518 #define MSG_EOF         0x100           /* data completes connection */
 519 #ifdef __APPLE__
 520 #define MSG_WAITSTREAM  0x200           /* wait up to full request.. may return partial */
 521 #define MSG_FLUSH       0x400           /* Start of 'hold' seq; dump so_temp */
 522 #define MSG_HOLD        0x800           /* Hold frag in so_temp */
 523 #define MSG_SEND        0x1000          /* Send the packet in so_temp */
 524 #define MSG_HAVEMORE    0x2000          /* Data ready to be read */
 525 #define MSG_RCVMORE     0x4000          /* Data remains in current pkt */
 526 #endif
 527 #define MSG_COMPAT      0x8000          /* used in sendit() */
 528 #define MSG_NEEDSA      0x10000         /* Fail receive if socket address cannot be allocated */
 529 #ifdef KERNEL_PRIVATE
 530 #define MSG_NBIO        0x20000         /* FIONBIO mode, used by fifofs */
 531 #endif
 532 #ifdef  KERNEL
 533 #define MSG_USEUPCALL   0x80000000 /* Inherit upcall in sock_accept */
 534 #endif
 535 #endif  /* !_POSIX_C_SOURCE */
 536
 537 /*
 538  * Header for ancillary data objects in msg_control buffer.
 539  * Used for additional information with/about a datagram
 540  * not expressible by flags.  The format is a sequence
 541  * of message elements headed by cmsghdr structures.
 542  */
 543 struct cmsghdr {
 544         socklen_t       cmsg_len;       /* [XSI] data byte count, including hdr */
 545         int             cmsg_level;     /* [XSI] originating protocol */
 546         int             cmsg_type;      /* [XSI] protocol-specific type */
 547 /* followed by  unsigned char  cmsg_data[]; */
 548 };
 549
 550 #ifndef _POSIX_C_SOURCE
 551 #ifndef __APPLE__
 552 /*
 553  * While we may have more groups than this, the cmsgcred struct must
 554  * be able to fit in an mbuf, and NGROUPS_MAX is too large to allow
 555  * this.
 556 */
 557 #define CMGROUP_MAX 16
 558
 559 /*
 560  * Credentials structure, used to verify the identity of a peer
 561  * process that has sent us a message. This is allocated by the
 562  * peer process but filled in by the kernel. This prevents the
 563  * peer from lying about its identity. (Note that cmcred_groups[0]
 564  * is the effective GID.)
 565  */
 566 struct cmsgcred {
 567         pid_t   cmcred_pid;             /* PID of sending process */
 568         uid_t   cmcred_uid;             /* real UID of sending process */
 569         uid_t   cmcred_euid;            /* effective UID of sending process */
 570         gid_t   cmcred_gid;             /* real GID of sending process */
 571         short   cmcred_ngroups;         /* number or groups */
 572         gid_t   cmcred_groups[CMGROUP_MAX];     /* groups */
 573 };
 574 #endif
 575 #endif  /* !_POSIX_C_SOURCE */
 576
 577 /* given pointer to struct cmsghdr, return pointer to data */
 578 #define CMSG_DATA(cmsg)         ((unsigned char *)(cmsg) + \
 579                                  ALIGN(sizeof(struct cmsghdr)))
 580
 581 /* given pointer to struct cmsghdr, return pointer to next cmsghdr */
 582 #define CMSG_NXTHDR(mhdr, cmsg) \
 583         (((unsigned char *)(cmsg) + ALIGN((cmsg)->cmsg_len) + \
 584           ALIGN(sizeof(struct cmsghdr)) > \
 585             (unsigned char *)(mhdr)->msg_control + (mhdr)->msg_controllen) ? \
 586             (struct cmsghdr *)0 /* NULL */ : \
 587             (struct cmsghdr *)((unsigned char *)(cmsg) + ALIGN((cmsg)->cmsg_len)))
 588
 589 #define CMSG_FIRSTHDR(mhdr)     ((struct cmsghdr *)(mhdr)->msg_control)
 590
 591 #ifndef _POSIX_C_SOURCE
 592 /* RFC 2292 additions */
 593 #define CMSG_SPACE(l)           (ALIGN(sizeof(struct cmsghdr)) + ALIGN(l))
 594 #define CMSG_LEN(l)             (ALIGN(sizeof(struct cmsghdr)) + (l))
 595
 596 #ifdef KERNEL
 597 #define CMSG_ALIGN(n)   ALIGN(n)
 598 #endif
 599 #endif  /* !_POSIX_C_SOURCE */
 600
 601 /* "Socket"-level control message types: */
 602 #define SCM_RIGHTS      0x01            /* access rights (array of int) */
 603 #ifndef _POSIX_C_SOURCE
 604 #define SCM_TIMESTAMP   0x02            /* timestamp (struct timeval) */
 605 #define SCM_CREDS       0x03            /* process creds (struct cmsgcred) */
 606
 607 /*
 608  * 4.3 compat sockaddr, move to compat file later
 609  */
 610 struct osockaddr {
 611         __uint16_t      sa_family;      /* address family */
 612         char    sa_data[14];            /* up to 14 bytes of direct address */
 613 };
 614
 615 /*
 616  * 4.3-compat message header (move to compat file later).
 617  */
 618         // LP64todo - fix this.  should msg_iov be * iovec_64?
 619 struct omsghdr {
 620         void            *msg_name;              /* optional address */
 621         socklen_t       msg_namelen;            /* size of address */
 622         struct  iovec   *msg_iov;               /* scatter/gather array */
 623         int             msg_iovlen;             /* # elements in msg_iov */
 624         void            *msg_accrights;         /* access rights sent/rcvd */
 625         int             msg_accrightslen;
 626 };
 627 #endif  /* !_POSIX_C_SOURCE */
 628
 629 /*
 630  * howto arguments for shutdown(2), specified by Posix.1g.
 631  */
 632 #define SHUT_RD         0               /* shut down the reading side */
 633 #define SHUT_WR         1               /* shut down the writing side */
 634 #define SHUT_RDWR       2               /* shut down both sides */
 635
 636 #ifndef _POSIX_C_SOURCE
 637 #if SENDFILE
 638 /*
 639  * sendfile(2) header/trailer struct
 640  */
 641 struct sf_hdtr {
 642         struct iovec *headers;  /* pointer to an array of header struct iovec's */
 643         int hdr_cnt;            /* number of header iovec's */
 644         struct iovec *trailers; /* pointer to an array of trailer struct iovec's */
 645         int trl_cnt;            /* number of trailer iovec's */
 646 };
 647 #endif
 648 #endif  /* !_POSIX_C_SOURCE */
 649
 650 #ifndef KERNEL
 651 __BEGIN_DECLS
 652 int     accept(int, struct sockaddr * __restrict, socklen_t * __restrict)
 653                 __DARWIN_ALIAS(accept);
 654 int     bind(int, const struct sockaddr *, socklen_t) __DARWIN_ALIAS(bind);
 655 int     connect(int, const struct sockaddr *, socklen_t) __DARWIN_ALIAS( connect);
 656 int     getpeername(int, struct sockaddr * __restrict, socklen_t * __restrict)
 657                 __DARWIN_ALIAS(getpeername);
 658 int     getsockname(int, struct sockaddr * __restrict, socklen_t * __restrict)
 659                 __DARWIN_ALIAS(getsockname);
 660 int     getsockopt(int, int, int, void * __restrict, socklen_t * __restrict);
 661 int     listen(int, int) __DARWIN_ALIAS(listen);
 662 ssize_t recv(int, void *, size_t, int) __DARWIN_ALIAS(recv);
 663 ssize_t recvfrom(int, void *, size_t, int, struct sockaddr * __restrict,
 664                 socklen_t * __restrict) __DARWIN_ALIAS(recvfrom);
 665 ssize_t recvmsg(int, struct msghdr *, int) __DARWIN_ALIAS(recvmsg);
 666 ssize_t send(int, const void *, size_t, int) __DARWIN_ALIAS(send);
 667 ssize_t sendmsg(int, const struct msghdr *, int) __DARWIN_ALIAS(sendmsg);
 668 ssize_t sendto(int, const void *, size_t,
 669                 int, const struct sockaddr *, socklen_t) __DARWIN_ALIAS(sendto);
 670 int     setsockopt(int, int, int, const void *, socklen_t);
 671 int     shutdown(int, int);
 672 int     socket(int, int, int);
 673 int     socketpair(int, int, int, int *) __DARWIN_ALIAS(socketpair);
 674 /*
 675  * NOTIMP:
 676  * int sockatmark(int s);
 677  */
 678
 679 #ifndef _POSIX_C_SOURCE
 680 #if SENDFILE
 681 int     sendfile(int, int, off_t, size_t, struct sf_hdtr *, off_t *, int);
 682 #endif
 683 void    pfctlinput(int, struct sockaddr *);
 684 #endif  /* !_POSIX_C_SOURCE */
 685 __END_DECLS
 686
 687 #endif /* !KERNEL */
 688
 689 #ifdef KERNEL
 690 #include <sys/kpi_socket.h>
 691 #endif
 692
 693 #endif /* !_SYS_SOCKET_H_ */