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