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