The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/sys/socket.h

Version: -  FREEBSD  -  FREEBSD-13-STABLE  -  FREEBSD-13-0  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  l41  -  OPENBSD  -  linux-2.6  -  MK84  -  PLAN9  -  xnu-8792 
SearchContext: -  none  -  3  -  10 

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

Cache object: 8a54d359512a2e400377420e6b1ef653


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.