sys/sys/socket.h

   1 /*-
   2  * Copyright (c) 1982, 1985, 1986, 1988, 1993, 1994
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 4. Neither the name of the University nor the names of its contributors
  14  *    may be used to endorse or promote products derived from this software
  15  *    without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  *
  29  *      @(#)socket.h    8.4 (Berkeley) 2/21/94
  30  * $FreeBSD$
  31  */
  32
  33 #ifndef _SYS_SOCKET_H_
  34 #define _SYS_SOCKET_H_
  35
  36 #include <sys/cdefs.h>
  37 #include <sys/_types.h>
  38 #include <sys/_iovec.h>
  39 #define _NO_NAMESPACE_POLLUTION
  40 #include <machine/param.h>
  41 #undef _NO_NAMESPACE_POLLUTION
  42
  43 /*
  44  * Definitions related to sockets: types, address families, options.
  45  */
  46
  47 /*
  48  * Data types.
  49  */
  50 #if __BSD_VISIBLE
  51 #ifndef _GID_T_DECLARED
  52 typedef __gid_t         gid_t;
  53 #define _GID_T_DECLARED
  54 #endif
  55
  56 #ifndef _OFF_T_DECLARED
  57 typedef __off_t         off_t;
  58 #define _OFF_T_DECLARED
  59 #endif
  60
  61 #ifndef _PID_T_DECLARED
  62 typedef __pid_t         pid_t;
  63 #define _PID_T_DECLARED
  64 #endif
  65 #endif
  66
  67 #ifndef _SA_FAMILY_T_DECLARED
  68 typedef __sa_family_t   sa_family_t;
  69 #define _SA_FAMILY_T_DECLARED
  70 #endif
  71
  72 #ifndef _SOCKLEN_T_DECLARED
  73 typedef __socklen_t     socklen_t;
  74 #define _SOCKLEN_T_DECLARED
  75 #endif
  76
  77 #ifndef _SSIZE_T_DECLARED
  78 typedef __ssize_t       ssize_t;
  79 #define _SSIZE_T_DECLARED
  80 #endif
  81
  82 #if __BSD_VISIBLE
  83 #ifndef _UID_T_DECLARED
  84 typedef __uid_t         uid_t;
  85 #define _UID_T_DECLARED
  86 #endif
  87 #endif
  88
  89 /*
  90  * Types
  91  */
  92 #define SOCK_STREAM     1               /* stream socket */
  93 #define SOCK_DGRAM      2               /* datagram socket */
  94 #define SOCK_RAW        3               /* raw-protocol interface */
  95 #if __BSD_VISIBLE
  96 #define SOCK_RDM        4               /* reliably-delivered message */
  97 #endif
  98 #define SOCK_SEQPACKET  5               /* sequenced packet stream */
  99
 100 /*
 101  * Option flags per-socket.
 102  */
 103 #define SO_DEBUG        0x0001          /* turn on debugging info recording */
 104 #define SO_ACCEPTCONN   0x0002          /* socket has had listen() */
 105 #define SO_REUSEADDR    0x0004          /* allow local address reuse */
 106 #define SO_KEEPALIVE    0x0008          /* keep connections alive */
 107 #define SO_DONTROUTE    0x0010          /* just use interface addresses */
 108 #define SO_BROADCAST    0x0020          /* permit sending of broadcast msgs */
 109 #if __BSD_VISIBLE
 110 #define SO_USELOOPBACK  0x0040          /* bypass hardware when possible */
 111 #endif
 112 #define SO_LINGER       0x0080          /* linger on close if data present */
 113 #define SO_OOBINLINE    0x0100          /* leave received OOB data in line */
 114 #if __BSD_VISIBLE
 115 #define SO_REUSEPORT    0x0200          /* allow local address & port reuse */
 116 #define SO_TIMESTAMP    0x0400          /* timestamp received dgram traffic */
 117 #define SO_NOSIGPIPE    0x0800          /* no SIGPIPE from EPIPE */
 118 #define SO_ACCEPTFILTER 0x1000          /* there is an accept filter */
 119 #define SO_BINTIME      0x2000          /* timestamp received dgram traffic */
 120 #endif
 121 #define SO_NO_OFFLOAD   0x4000          /* socket cannot be offloaded */
 122 #define SO_NO_DDP       0x8000          /* disable direct data placement */
 123
 124 /*
 125  * Additional options, not kept in so_options.
 126  */
 127 #define SO_SNDBUF       0x1001          /* send buffer size */
 128 #define SO_RCVBUF       0x1002          /* receive buffer size */
 129 #define SO_SNDLOWAT     0x1003          /* send low-water mark */
 130 #define SO_RCVLOWAT     0x1004          /* receive low-water mark */
 131 #define SO_SNDTIMEO     0x1005          /* send timeout */
 132 #define SO_RCVTIMEO     0x1006          /* receive timeout */
 133 #define SO_ERROR        0x1007          /* get error status and clear */
 134 #define SO_TYPE         0x1008          /* get socket type */
 135 #if __BSD_VISIBLE
 136 #define SO_LABEL        0x1009          /* socket's MAC label */
 137 #define SO_PEERLABEL    0x1010          /* socket's peer's MAC label */
 138 #define SO_LISTENQLIMIT 0x1011          /* socket's backlog limit */
 139 #define SO_LISTENQLEN   0x1012          /* socket's complete queue length */
 140 #define SO_LISTENINCQLEN        0x1013  /* socket's incomplete queue length */
 141 #define SO_SETFIB       0x1014          /* use this FIB to route */
 142 #define SO_PROTOCOL     0x1016          /* get socket protocol (Linux name) */
 143 #define SO_PROTOTYPE    SO_PROTOCOL     /* alias for SO_PROTOCOL (SunOS name) */
 144 #endif
 145
 146 /*
 147  * Space reserved for new socket options added by third-party vendors.
 148  * This range applies to all socket option levels.  New socket options
 149  * in FreeBSD should always use an option value less than SO_VENDOR.
 150  */
 151 #if __BSD_VISIBLE
 152 #define SO_VENDOR       0x80000000
 153 #endif
 154
 155 /*
 156  * Structure used for manipulating linger option.
 157  */
 158 struct linger {
 159         int     l_onoff;                /* option on/off */
 160         int     l_linger;               /* linger time */
 161 };
 162
 163 #if __BSD_VISIBLE
 164 struct accept_filter_arg {
 165         char    af_name[16];
 166         char    af_arg[256-16];
 167 };
 168 #endif
 169
 170 /*
 171  * Level number for (get/set)sockopt() to apply to socket itself.
 172  */
 173 #define SOL_SOCKET      0xffff          /* options for socket level */
 174
 175 /*
 176  * Address families.
 177  */
 178 #define AF_UNSPEC       0               /* unspecified */
 179 #if __BSD_VISIBLE
 180 #define AF_LOCAL        AF_UNIX         /* local to host (pipes, portals) */
 181 #endif
 182 #define AF_UNIX         1               /* standardized name for AF_LOCAL */
 183 #define AF_INET         2               /* internetwork: UDP, TCP, etc. */
 184 #if __BSD_VISIBLE
 185 #define AF_IMPLINK      3               /* arpanet imp addresses */
 186 #define AF_PUP          4               /* pup protocols: e.g. BSP */
 187 #define AF_CHAOS        5               /* mit CHAOS protocols */
 188 #define AF_NETBIOS      6               /* SMB protocols */
 189 #define AF_ISO          7               /* ISO protocols */
 190 #define AF_OSI          AF_ISO
 191 #define AF_ECMA         8               /* European computer manufacturers */
 192 #define AF_DATAKIT      9               /* datakit protocols */
 193 #define AF_CCITT        10              /* CCITT protocols, X.25 etc */
 194 #define AF_SNA          11              /* IBM SNA */
 195 #define AF_DECnet       12              /* DECnet */
 196 #define AF_DLI          13              /* DEC Direct data link interface */
 197 #define AF_LAT          14              /* LAT */
 198 #define AF_HYLINK       15              /* NSC Hyperchannel */
 199 #define AF_APPLETALK    16              /* Apple Talk */
 200 #define AF_ROUTE        17              /* Internal Routing Protocol */
 201 #define AF_LINK         18              /* Link layer interface */
 202 #define pseudo_AF_XTP   19              /* eXpress Transfer Protocol (no AF) */
 203 #define AF_COIP         20              /* connection-oriented IP, aka ST II */
 204 #define AF_CNT          21              /* Computer Network Technology */
 205 #define pseudo_AF_RTIP  22              /* Help Identify RTIP packets */
 206 #define AF_IPX          23              /* Novell Internet Protocol */
 207 #define AF_SIP          24              /* Simple Internet Protocol */
 208 #define pseudo_AF_PIP   25              /* Help Identify PIP packets */
 209 #define AF_ISDN         26              /* Integrated Services Digital Network*/
 210 #define AF_E164         AF_ISDN         /* CCITT E.164 recommendation */
 211 #define pseudo_AF_KEY   27              /* Internal key-management function */
 212 #endif
 213 #define AF_INET6        28              /* IPv6 */
 214 #if __BSD_VISIBLE
 215 #define AF_NATM         29              /* native ATM access */
 216 #define AF_ATM          30              /* ATM */
 217 #define pseudo_AF_HDRCMPLT 31           /* Used by BPF to not rewrite headers
 218                                          * in interface output routine
 219                                          */
 220 #define AF_NETGRAPH     32              /* Netgraph sockets */
 221 #define AF_SLOW         33              /* 802.3ad slow protocol */
 222 #define AF_SCLUSTER     34              /* Sitara cluster protocol */
 223 #define AF_ARP          35
 224 #define AF_BLUETOOTH    36              /* Bluetooth sockets */
 225 #define AF_IEEE80211    37              /* IEEE 802.11 protocol */
 226 #define AF_MAX          38
 227 /*
 228  * When allocating a new AF_ constant, please only allocate
 229  * even numbered constants for FreeBSD until 134 as odd numbered AF_
 230  * constants 39-133 are now reserved for vendors.
 231  */
 232 #define AF_VENDOR00 39
 233 #define AF_VENDOR01 41
 234 #define AF_VENDOR02 43
 235 #define AF_VENDOR03 45
 236 #define AF_VENDOR04 47
 237 #define AF_VENDOR05 49
 238 #define AF_VENDOR06 51
 239 #define AF_VENDOR07 53
 240 #define AF_VENDOR08 55
 241 #define AF_VENDOR09 57
 242 #define AF_VENDOR10 59
 243 #define AF_VENDOR11 61
 244 #define AF_VENDOR12 63
 245 #define AF_VENDOR13 65
 246 #define AF_VENDOR14 67
 247 #define AF_VENDOR15 69
 248 #define AF_VENDOR16 71
 249 #define AF_VENDOR17 73
 250 #define AF_VENDOR18 75
 251 #define AF_VENDOR19 77
 252 #define AF_VENDOR20 79
 253 #define AF_VENDOR21 81
 254 #define AF_VENDOR22 83
 255 #define AF_VENDOR23 85
 256 #define AF_VENDOR24 87
 257 #define AF_VENDOR25 89
 258 #define AF_VENDOR26 91
 259 #define AF_VENDOR27 93
 260 #define AF_VENDOR28 95
 261 #define AF_VENDOR29 97
 262 #define AF_VENDOR30 99
 263 #define AF_VENDOR31 101
 264 #define AF_VENDOR32 103
 265 #define AF_VENDOR33 105
 266 #define AF_VENDOR34 107
 267 #define AF_VENDOR35 109
 268 #define AF_VENDOR36 111
 269 #define AF_VENDOR37 113
 270 #define AF_VENDOR38 115
 271 #define AF_VENDOR39 117
 272 #define AF_VENDOR40 119
 273 #define AF_VENDOR41 121
 274 #define AF_VENDOR42 123
 275 #define AF_VENDOR43 125
 276 #define AF_VENDOR44 127
 277 #define AF_VENDOR45 129
 278 #define AF_VENDOR46 131
 279 #define AF_VENDOR47 133
 280 #endif
 281
 282 /*
 283  * Structure used by kernel to store most
 284  * addresses.
 285  */
 286 struct sockaddr {
 287         unsigned char   sa_len;         /* total length */
 288         sa_family_t     sa_family;      /* address family */
 289         char            sa_data[14];    /* actually longer; address value */
 290 };
 291 #if __BSD_VISIBLE
 292 #define SOCK_MAXADDRLEN 255             /* longest possible addresses */
 293
 294 /*
 295  * Structure used by kernel to pass protocol
 296  * information in raw sockets.
 297  */
 298 struct sockproto {
 299         unsigned short  sp_family;              /* address family */
 300         unsigned short  sp_protocol;            /* protocol */
 301 };
 302 #endif
 303
 304 #ifndef _STRUCT_SOCKADDR_STORAGE_DECLARED
 305 /*
 306  * RFC 2553: protocol-independent placeholder for socket addresses
 307  */
 308 #define _SS_MAXSIZE     128U
 309 #define _SS_ALIGNSIZE   (sizeof(__int64_t))
 310 #define _SS_PAD1SIZE    (_SS_ALIGNSIZE - sizeof(unsigned char) - \
 311                             sizeof(sa_family_t))
 312 #define _SS_PAD2SIZE    (_SS_MAXSIZE - sizeof(unsigned char) - \
 313                             sizeof(sa_family_t) - _SS_PAD1SIZE - _SS_ALIGNSIZE)
 314
 315 struct sockaddr_storage {
 316         unsigned char   ss_len;         /* address length */
 317         sa_family_t     ss_family;      /* address family */
 318         char            __ss_pad1[_SS_PAD1SIZE];
 319         __int64_t       __ss_align;     /* force desired struct alignment */
 320         char            __ss_pad2[_SS_PAD2SIZE];
 321 };
 322 #define _STRUCT_SOCKADDR_STORAGE_DECLARED
 323 #endif
 324
 325 #if __BSD_VISIBLE
 326 /*
 327  * Protocol families, same as address families for now.
 328  */
 329 #define PF_UNSPEC       AF_UNSPEC
 330 #define PF_LOCAL        AF_LOCAL
 331 #define PF_UNIX         PF_LOCAL        /* backward compatibility */
 332 #define PF_INET         AF_INET
 333 #define PF_IMPLINK      AF_IMPLINK
 334 #define PF_PUP          AF_PUP
 335 #define PF_CHAOS        AF_CHAOS
 336 #define PF_NETBIOS      AF_NETBIOS
 337 #define PF_ISO          AF_ISO
 338 #define PF_OSI          AF_ISO
 339 #define PF_ECMA         AF_ECMA
 340 #define PF_DATAKIT      AF_DATAKIT
 341 #define PF_CCITT        AF_CCITT
 342 #define PF_SNA          AF_SNA
 343 #define PF_DECnet       AF_DECnet
 344 #define PF_DLI          AF_DLI
 345 #define PF_LAT          AF_LAT
 346 #define PF_HYLINK       AF_HYLINK
 347 #define PF_APPLETALK    AF_APPLETALK
 348 #define PF_ROUTE        AF_ROUTE
 349 #define PF_LINK         AF_LINK
 350 #define PF_XTP          pseudo_AF_XTP   /* really just proto family, no AF */
 351 #define PF_COIP         AF_COIP
 352 #define PF_CNT          AF_CNT
 353 #define PF_SIP          AF_SIP
 354 #define PF_IPX          AF_IPX
 355 #define PF_RTIP         pseudo_AF_RTIP  /* same format as AF_INET */
 356 #define PF_PIP          pseudo_AF_PIP
 357 #define PF_ISDN         AF_ISDN
 358 #define PF_KEY          pseudo_AF_KEY
 359 #define PF_INET6        AF_INET6
 360 #define PF_NATM         AF_NATM
 361 #define PF_ATM          AF_ATM
 362 #define PF_NETGRAPH     AF_NETGRAPH
 363 #define PF_SLOW         AF_SLOW
 364 #define PF_SCLUSTER     AF_SCLUSTER
 365 #define PF_ARP          AF_ARP
 366 #define PF_BLUETOOTH    AF_BLUETOOTH
 367
 368 #define PF_MAX          AF_MAX
 369
 370 /*
 371  * Definitions for network related sysctl, CTL_NET.
 372  *
 373  * Second level is protocol family.
 374  * Third level is protocol number.
 375  *
 376  * Further levels are defined by the individual families below.
 377  */
 378 #define NET_MAXID       AF_MAX
 379
 380 #define CTL_NET_NAMES { \
 381         { 0, 0 }, \
 382         { "unix", CTLTYPE_NODE }, \
 383         { "inet", CTLTYPE_NODE }, \
 384         { "implink", CTLTYPE_NODE }, \
 385         { "pup", CTLTYPE_NODE }, \
 386         { "chaos", CTLTYPE_NODE }, \
 387         { "xerox_ns", CTLTYPE_NODE }, \
 388         { "iso", CTLTYPE_NODE }, \
 389         { "emca", CTLTYPE_NODE }, \
 390         { "datakit", CTLTYPE_NODE }, \
 391         { "ccitt", CTLTYPE_NODE }, \
 392         { "ibm_sna", CTLTYPE_NODE }, \
 393         { "decnet", CTLTYPE_NODE }, \
 394         { "dec_dli", CTLTYPE_NODE }, \
 395         { "lat", CTLTYPE_NODE }, \
 396         { "hylink", CTLTYPE_NODE }, \
 397         { "appletalk", CTLTYPE_NODE }, \
 398         { "route", CTLTYPE_NODE }, \
 399         { "link_layer", CTLTYPE_NODE }, \
 400         { "xtp", CTLTYPE_NODE }, \
 401         { "coip", CTLTYPE_NODE }, \
 402         { "cnt", CTLTYPE_NODE }, \
 403         { "rtip", CTLTYPE_NODE }, \
 404         { "ipx", CTLTYPE_NODE }, \
 405         { "sip", CTLTYPE_NODE }, \
 406         { "pip", CTLTYPE_NODE }, \
 407         { "isdn", CTLTYPE_NODE }, \
 408         { "key", CTLTYPE_NODE }, \
 409         { "inet6", CTLTYPE_NODE }, \
 410         { "natm", CTLTYPE_NODE }, \
 411         { "atm", CTLTYPE_NODE }, \
 412         { "hdrcomplete", CTLTYPE_NODE }, \
 413         { "netgraph", CTLTYPE_NODE }, \
 414         { "snp", CTLTYPE_NODE }, \
 415         { "scp", CTLTYPE_NODE }, \
 416 }
 417
 418 /*
 419  * PF_ROUTE - Routing table
 420  *
 421  * Three additional levels are defined:
 422  *      Fourth: address family, 0 is wildcard
 423  *      Fifth: type of info, defined below
 424  *      Sixth: flag(s) to mask with for NET_RT_FLAGS
 425  */
 426 #define NET_RT_DUMP     1               /* dump; may limit to a.f. */
 427 #define NET_RT_FLAGS    2               /* by flags, e.g. RESOLVING */
 428 #define NET_RT_IFLIST   3               /* survey interface list */
 429 #define NET_RT_IFMALIST 4               /* return multicast address list */
 430 #define NET_RT_IFLISTL  5               /* Survey interface list, using 'l'en
 431                                          * versions of msghdr structs. */
 432 #define NET_RT_MAXID    6
 433
 434 #define CTL_NET_RT_NAMES { \
 435         { 0, 0 }, \
 436         { "dump", CTLTYPE_STRUCT }, \
 437         { "flags", CTLTYPE_STRUCT }, \
 438         { "iflist", CTLTYPE_STRUCT }, \
 439         { "ifmalist", CTLTYPE_STRUCT }, \
 440         { "iflistl", CTLTYPE_STRUCT }, \
 441 }
 442 #endif /* __BSD_VISIBLE */
 443
 444 /*
 445  * Maximum queue length specifiable by listen.
 446  */
 447 #define SOMAXCONN       128
 448
 449 /*
 450  * Message header for recvmsg and sendmsg calls.
 451  * Used value-result for recvmsg, value only for sendmsg.
 452  */
 453 struct msghdr {
 454         void            *msg_name;              /* optional address */
 455         socklen_t        msg_namelen;           /* size of address */
 456         struct iovec    *msg_iov;               /* scatter/gather array */
 457         int              msg_iovlen;            /* # elements in msg_iov */
 458         void            *msg_control;           /* ancillary data, see below */
 459         socklen_t        msg_controllen;        /* ancillary data buffer len */
 460         int              msg_flags;             /* flags on received message */
 461 };
 462
 463 #define MSG_OOB         0x1             /* process out-of-band data */
 464 #define MSG_PEEK        0x2             /* peek at incoming message */
 465 #define MSG_DONTROUTE   0x4             /* send without using routing tables */
 466 #define MSG_EOR         0x8             /* data completes record */
 467 #define MSG_TRUNC       0x10            /* data discarded before delivery */
 468 #define MSG_CTRUNC      0x20            /* control data lost before delivery */
 469 #define MSG_WAITALL     0x40            /* wait for full request or error */
 470 #define MSG_NOTIFICATION 0x2000         /* SCTP notification */
 471 #if __BSD_VISIBLE
 472 #define MSG_DONTWAIT    0x80            /* this message should be nonblocking */
 473 #define MSG_EOF         0x100           /* data completes connection */
 474 #define MSG_NBIO        0x4000          /* FIONBIO mode, used by fifofs */
 475 #define MSG_COMPAT      0x8000          /* used in sendit() */
 476 #endif
 477 #ifdef _KERNEL
 478 #define MSG_SOCALLBCK   0x10000         /* for use by socket callbacks - soreceive (TCP) */
 479 #endif
 480 #if __BSD_VISIBLE
 481 #define MSG_NOSIGNAL    0x20000         /* do not generate SIGPIPE on EOF */
 482 #endif
 483
 484 /*
 485  * Header for ancillary data objects in msg_control buffer.
 486  * Used for additional information with/about a datagram
 487  * not expressible by flags.  The format is a sequence
 488  * of message elements headed by cmsghdr structures.
 489  */
 490 struct cmsghdr {
 491         socklen_t       cmsg_len;               /* data byte count, including hdr */
 492         int             cmsg_level;             /* originating protocol */
 493         int             cmsg_type;              /* protocol-specific type */
 494 /* followed by  u_char  cmsg_data[]; */
 495 };
 496
 497 #if __BSD_VISIBLE
 498 /*
 499  * While we may have more groups than this, the cmsgcred struct must
 500  * be able to fit in an mbuf and we have historically supported a
 501  * maximum of 16 groups.
 502 */
 503 #define CMGROUP_MAX 16
 504
 505 /*
 506  * Credentials structure, used to verify the identity of a peer
 507  * process that has sent us a message. This is allocated by the
 508  * peer process but filled in by the kernel. This prevents the
 509  * peer from lying about its identity. (Note that cmcred_groups[0]
 510  * is the effective GID.)
 511  */
 512 struct cmsgcred {
 513         pid_t   cmcred_pid;             /* PID of sending process */
 514         uid_t   cmcred_uid;             /* real UID of sending process */
 515         uid_t   cmcred_euid;            /* effective UID of sending process */
 516         gid_t   cmcred_gid;             /* real GID of sending process */
 517         short   cmcred_ngroups;         /* number or groups */
 518         gid_t   cmcred_groups[CMGROUP_MAX];     /* groups */
 519 };
 520
 521 /*
 522  * Socket credentials.
 523  */
 524 struct sockcred {
 525         uid_t   sc_uid;                 /* real user id */
 526         uid_t   sc_euid;                /* effective user id */
 527         gid_t   sc_gid;                 /* real group id */
 528         gid_t   sc_egid;                /* effective group id */
 529         int     sc_ngroups;             /* number of supplemental groups */
 530         gid_t   sc_groups[1];           /* variable length */
 531 };
 532
 533 /*
 534  * Compute size of a sockcred structure with groups.
 535  */
 536 #define SOCKCREDSIZE(ngrps) \
 537         (sizeof(struct sockcred) + (sizeof(gid_t) * ((ngrps) - 1)))
 538
 539 #endif /* __BSD_VISIBLE */
 540
 541 /* given pointer to struct cmsghdr, return pointer to data */
 542 #define CMSG_DATA(cmsg)         ((unsigned char *)(cmsg) + \
 543                                  _ALIGN(sizeof(struct cmsghdr)))
 544
 545 /* given pointer to struct cmsghdr, return pointer to next cmsghdr */
 546 #define CMSG_NXTHDR(mhdr, cmsg) \
 547         ((char *)(cmsg) == NULL ? CMSG_FIRSTHDR(mhdr) : \
 548             ((char *)(cmsg) + _ALIGN(((struct cmsghdr *)(cmsg))->cmsg_len) + \
 549           _ALIGN(sizeof(struct cmsghdr)) > \
 550             (char *)(mhdr)->msg_control + (mhdr)->msg_controllen) ? \
 551             (struct cmsghdr *)0 : \
 552             (struct cmsghdr *)((char *)(cmsg) + \
 553             _ALIGN(((struct cmsghdr *)(cmsg))->cmsg_len)))
 554
 555 /*
 556  * RFC 2292 requires to check msg_controllen, in case that the kernel returns
 557  * an empty list for some reasons.
 558  */
 559 #define CMSG_FIRSTHDR(mhdr) \
 560         ((mhdr)->msg_controllen >= sizeof(struct cmsghdr) ? \
 561          (struct cmsghdr *)(mhdr)->msg_control : \
 562          (struct cmsghdr *)NULL)
 563
 564 #if __BSD_VISIBLE
 565 /* RFC 2292 additions */
 566 #define CMSG_SPACE(l)           (_ALIGN(sizeof(struct cmsghdr)) + _ALIGN(l))
 567 #define CMSG_LEN(l)             (_ALIGN(sizeof(struct cmsghdr)) + (l))
 568 #endif
 569
 570 #ifdef _KERNEL
 571 #define CMSG_ALIGN(n)   _ALIGN(n)
 572 #endif
 573
 574 /* "Socket"-level control message types: */
 575 #define SCM_RIGHTS      0x01            /* access rights (array of int) */
 576 #if __BSD_VISIBLE
 577 #define SCM_TIMESTAMP   0x02            /* timestamp (struct timeval) */
 578 #define SCM_CREDS       0x03            /* process creds (struct cmsgcred) */
 579 #define SCM_BINTIME     0x04            /* timestamp (struct bintime) */
 580 #endif
 581
 582 #if __BSD_VISIBLE
 583 /*
 584  * 4.3 compat sockaddr, move to compat file later
 585  */
 586 struct osockaddr {
 587         unsigned short sa_family;       /* address family */
 588         char    sa_data[14];            /* up to 14 bytes of direct address */
 589 };
 590
 591 /*
 592  * 4.3-compat message header (move to compat file later).
 593  */
 594 struct omsghdr {
 595         char    *msg_name;              /* optional address */
 596         int     msg_namelen;            /* size of address */
 597         struct  iovec *msg_iov;         /* scatter/gather array */
 598         int     msg_iovlen;             /* # elements in msg_iov */
 599         char    *msg_accrights;         /* access rights sent/received */
 600         int     msg_accrightslen;
 601 };
 602 #endif
 603
 604 /*
 605  * howto arguments for shutdown(2), specified by Posix.1g.
 606  */
 607 #define SHUT_RD         0               /* shut down the reading side */
 608 #define SHUT_WR         1               /* shut down the writing side */
 609 #define SHUT_RDWR       2               /* shut down both sides */
 610
 611 /* we cheat and use the SHUT_XX defines for these */
 612 #define PRU_FLUSH_RD     SHUT_RD
 613 #define PRU_FLUSH_WR     SHUT_WR
 614 #define PRU_FLUSH_RDWR   SHUT_RDWR
 615
 616
 617 #if __BSD_VISIBLE
 618 /*
 619  * sendfile(2) header/trailer struct
 620  */
 621 struct sf_hdtr {
 622         struct iovec *headers;  /* pointer to an array of header struct iovec's */
 623         int hdr_cnt;            /* number of header iovec's */
 624         struct iovec *trailers; /* pointer to an array of trailer struct iovec's */
 625         int trl_cnt;            /* number of trailer iovec's */
 626 };
 627
 628 /*
 629  * Sendfile-specific flag(s)
 630  */
 631 #define SF_NODISKIO     0x00000001
 632 #define SF_MNOWAIT      0x00000002
 633 #define SF_SYNC         0x00000004
 634 #endif
 635
 636 #ifndef _KERNEL
 637
 638 #include <sys/cdefs.h>
 639
 640 __BEGIN_DECLS
 641 int     accept(int, struct sockaddr * __restrict, socklen_t * __restrict);
 642 int     bind(int, const struct sockaddr *, socklen_t);
 643 int     connect(int, const struct sockaddr *, socklen_t);
 644 int     getpeername(int, struct sockaddr * __restrict, socklen_t * __restrict);
 645 int     getsockname(int, struct sockaddr * __restrict, socklen_t * __restrict);
 646 int     getsockopt(int, int, int, void * __restrict, socklen_t * __restrict);
 647 int     listen(int, int);
 648 ssize_t recv(int, void *, size_t, int);
 649 ssize_t recvfrom(int, void *, size_t, int, struct sockaddr * __restrict, socklen_t * __restrict);
 650 ssize_t recvmsg(int, struct msghdr *, int);
 651 ssize_t send(int, const void *, size_t, int);
 652 ssize_t sendto(int, const void *,
 653             size_t, int, const struct sockaddr *, socklen_t);
 654 ssize_t sendmsg(int, const struct msghdr *, int);
 655 #if __BSD_VISIBLE
 656 int     sendfile(int, int, off_t, size_t, struct sf_hdtr *, off_t *, int);
 657 int     setfib(int);
 658 #endif
 659 int     setsockopt(int, int, int, const void *, socklen_t);
 660 int     shutdown(int, int);
 661 int     sockatmark(int);
 662 int     socket(int, int, int);
 663 int     socketpair(int, int, int, int *);
 664 __END_DECLS
 665
 666 #endif /* !_KERNEL */
 667
 668 #ifdef _KERNEL
 669 struct socket;
 670
 671 struct tcpcb *so_sototcpcb(struct socket *so);
 672 struct inpcb *so_sotoinpcb(struct socket *so);
 673 struct sockbuf *so_sockbuf_snd(struct socket *);
 674 struct sockbuf *so_sockbuf_rcv(struct socket *);
 675
 676 int so_state_get(const struct socket *);
 677 void so_state_set(struct socket *, int);
 678
 679 int so_options_get(const struct socket *);
 680 void so_options_set(struct socket *, int);
 681
 682 int so_error_get(const struct socket *);
 683 void so_error_set(struct socket *, int);
 684
 685 int so_linger_get(const struct socket *);
 686 void so_linger_set(struct socket *, int);
 687
 688 struct protosw *so_protosw_get(const struct socket *);
 689 void so_protosw_set(struct socket *, struct protosw *);
 690
 691 void so_sorwakeup_locked(struct socket *so);
 692 void so_sowwakeup_locked(struct socket *so);
 693
 694 void so_sorwakeup(struct socket *so);
 695 void so_sowwakeup(struct socket *so);
 696
 697 void so_lock(struct socket *so);
 698 void so_unlock(struct socket *so);
 699
 700 void so_listeners_apply_all(struct socket *so, void (*func)(struct socket *, void *), void *arg);
 701
 702 #endif
 703
 704
 705 #endif /* !_SYS_SOCKET_H_ */