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

Cache object: fde3a71b4ad8b36fb7f919ef47546a3e


[ 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.