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

Cache object: 3159815a75346418c27ab81b25c83521


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