socket.h revision 132258
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: head/sys/sys/socket.h 132258 2004-07-16 17:42:48Z harti $ 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 52typedef __gid_t gid_t; 53#define _GID_T_DECLARED 54#endif 55 56#ifndef _OFF_T_DECLARED 57typedef __off_t off_t; 58#define _OFF_T_DECLARED 59#endif 60 61#ifndef _PID_T_DECLARED 62typedef __pid_t pid_t; 63#define _PID_T_DECLARED 64#endif 65#endif 66 67#ifndef _SA_FAMILY_T_DECLARED 68typedef __sa_family_t sa_family_t; 69#define _SA_FAMILY_T_DECLARED 70#endif 71 72#ifndef _SOCKLEN_T_DECLARED 73typedef __socklen_t socklen_t; 74#define _SOCKLEN_T_DECLARED 75#endif 76 77#ifndef _SSIZE_T_DECLARED 78typedef __ssize_t ssize_t; 79#define _SSIZE_T_DECLARED 80#endif 81 82#if __BSD_VISIBLE 83#ifndef _UID_T_DECLARED 84typedef __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 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#endif 137 138/* 139 * Structure used for manipulating linger option. 140 */ 141struct linger { 142 int l_onoff; /* option on/off */ 143 int l_linger; /* linger time */ 144}; 145 146#if __BSD_VISIBLE 147struct accept_filter_arg { 148 char af_name[16]; 149 char af_arg[256-16]; 150}; 151#endif 152 153/* 154 * Level number for (get/set)sockopt() to apply to socket itself. 155 */ 156#define SOL_SOCKET 0xffff /* options for socket level */ 157 158/* 159 * Address families. 160 */ 161#define AF_UNSPEC 0 /* unspecified */ 162#if __BSD_VISIBLE 163#define AF_LOCAL AF_UNIX /* local to host (pipes, portals) */ 164#endif 165#define AF_UNIX 1 /* standardized name for AF_LOCAL */ 166#define AF_INET 2 /* internetwork: UDP, TCP, etc. */ 167#if __BSD_VISIBLE 168#define AF_IMPLINK 3 /* arpanet imp addresses */ 169#define AF_PUP 4 /* pup protocols: e.g. BSP */ 170#define AF_CHAOS 5 /* mit CHAOS protocols */ 171#define AF_NETBIOS 6 /* SMB protocols */ 172#define AF_ISO 7 /* ISO protocols */ 173#define AF_OSI AF_ISO 174#define AF_ECMA 8 /* European computer manufacturers */ 175#define AF_DATAKIT 9 /* datakit protocols */ 176#define AF_CCITT 10 /* CCITT protocols, X.25 etc */ 177#define AF_SNA 11 /* IBM SNA */ 178#define AF_DECnet 12 /* DECnet */ 179#define AF_DLI 13 /* DEC Direct data link interface */ 180#define AF_LAT 14 /* LAT */ 181#define AF_HYLINK 15 /* NSC Hyperchannel */ 182#define AF_APPLETALK 16 /* Apple Talk */ 183#define AF_ROUTE 17 /* Internal Routing Protocol */ 184#define AF_LINK 18 /* Link layer interface */ 185#define pseudo_AF_XTP 19 /* eXpress Transfer Protocol (no AF) */ 186#define AF_COIP 20 /* connection-oriented IP, aka ST II */ 187#define AF_CNT 21 /* Computer Network Technology */ 188#define pseudo_AF_RTIP 22 /* Help Identify RTIP packets */ 189#define AF_IPX 23 /* Novell Internet Protocol */ 190#define AF_SIP 24 /* Simple Internet Protocol */ 191#define pseudo_AF_PIP 25 /* Help Identify PIP packets */ 192#define AF_ISDN 26 /* Integrated Services Digital Network*/ 193#define AF_E164 AF_ISDN /* CCITT E.164 recommendation */ 194#define pseudo_AF_KEY 27 /* Internal key-management function */ 195#endif 196#define AF_INET6 28 /* IPv6 */ 197#if __BSD_VISIBLE 198#define AF_NATM 29 /* native ATM access */ 199#define AF_ATM 30 /* ATM */ 200#define pseudo_AF_HDRCMPLT 31 /* Used by BPF to not rewrite headers 201 * in interface output routine 202 */ 203#define AF_NETGRAPH 32 /* Netgraph sockets */ 204#define AF_SLOW 33 /* 802.3ad slow protocol */ 205#define AF_SCLUSTER 34 /* Sitara cluster protocol */ 206#define AF_ARP 35 207#define AF_BLUETOOTH 36 /* Bluetooth sockets */ 208#define AF_MAX 37 209#endif 210 211/* 212 * Structure used by kernel to store most 213 * addresses. 214 */ 215struct sockaddr { 216 unsigned char sa_len; /* total length */ 217 sa_family_t sa_family; /* address family */ 218 char sa_data[14]; /* actually longer; address value */ 219}; 220#if __BSD_VISIBLE 221#define SOCK_MAXADDRLEN 255 /* longest possible addresses */ 222 223/* 224 * Structure used by kernel to pass protocol 225 * information in raw sockets. 226 */ 227struct sockproto { 228 unsigned short sp_family; /* address family */ 229 unsigned short sp_protocol; /* protocol */ 230}; 231#endif 232 233/* 234 * RFC 2553: protocol-independent placeholder for socket addresses 235 */ 236#define _SS_MAXSIZE 128U 237#define _SS_ALIGNSIZE (sizeof(__int64_t)) 238#define _SS_PAD1SIZE (_SS_ALIGNSIZE - sizeof(unsigned char) - \ 239 sizeof(sa_family_t)) 240#define _SS_PAD2SIZE (_SS_MAXSIZE - sizeof(unsigned char) - \ 241 sizeof(sa_family_t) - _SS_PAD1SIZE - _SS_ALIGNSIZE) 242 243struct sockaddr_storage { 244 unsigned char ss_len; /* address length */ 245 sa_family_t ss_family; /* address family */ 246 char __ss_pad1[_SS_PAD1SIZE]; 247 __int64_t __ss_align; /* force desired struct alignment */ 248 char __ss_pad2[_SS_PAD2SIZE]; 249}; 250 251#if __BSD_VISIBLE 252/* 253 * Protocol families, same as address families for now. 254 */ 255#define PF_UNSPEC AF_UNSPEC 256#define PF_LOCAL AF_LOCAL 257#define PF_UNIX PF_LOCAL /* backward compatibility */ 258#define PF_INET AF_INET 259#define PF_IMPLINK AF_IMPLINK 260#define PF_PUP AF_PUP 261#define PF_CHAOS AF_CHAOS 262#define PF_NETBIOS AF_NETBIOS 263#define PF_ISO AF_ISO 264#define PF_OSI AF_ISO 265#define PF_ECMA AF_ECMA 266#define PF_DATAKIT AF_DATAKIT 267#define PF_CCITT AF_CCITT 268#define PF_SNA AF_SNA 269#define PF_DECnet AF_DECnet 270#define PF_DLI AF_DLI 271#define PF_LAT AF_LAT 272#define PF_HYLINK AF_HYLINK 273#define PF_APPLETALK AF_APPLETALK 274#define PF_ROUTE AF_ROUTE 275#define PF_LINK AF_LINK 276#define PF_XTP pseudo_AF_XTP /* really just proto family, no AF */ 277#define PF_COIP AF_COIP 278#define PF_CNT AF_CNT 279#define PF_SIP AF_SIP 280#define PF_IPX AF_IPX 281#define PF_RTIP pseudo_AF_RTIP /* same format as AF_INET */ 282#define PF_PIP pseudo_AF_PIP 283#define PF_ISDN AF_ISDN 284#define PF_KEY pseudo_AF_KEY 285#define PF_INET6 AF_INET6 286#define PF_NATM AF_NATM 287#define PF_ATM AF_ATM 288#define PF_NETGRAPH AF_NETGRAPH 289#define PF_SLOW AF_SLOW 290#define PF_SCLUSTER AF_SCLUSTER 291#define PF_ARP AF_ARP 292#define PF_BLUETOOTH AF_BLUETOOTH 293 294#define PF_MAX AF_MAX 295 296/* 297 * Definitions for network related sysctl, CTL_NET. 298 * 299 * Second level is protocol family. 300 * Third level is protocol number. 301 * 302 * Further levels are defined by the individual families below. 303 */ 304#define NET_MAXID AF_MAX 305 306#define CTL_NET_NAMES { \ 307 { 0, 0 }, \ 308 { "unix", CTLTYPE_NODE }, \ 309 { "inet", CTLTYPE_NODE }, \ 310 { "implink", CTLTYPE_NODE }, \ 311 { "pup", CTLTYPE_NODE }, \ 312 { "chaos", CTLTYPE_NODE }, \ 313 { "xerox_ns", CTLTYPE_NODE }, \ 314 { "iso", CTLTYPE_NODE }, \ 315 { "emca", CTLTYPE_NODE }, \ 316 { "datakit", CTLTYPE_NODE }, \ 317 { "ccitt", CTLTYPE_NODE }, \ 318 { "ibm_sna", CTLTYPE_NODE }, \ 319 { "decnet", CTLTYPE_NODE }, \ 320 { "dec_dli", CTLTYPE_NODE }, \ 321 { "lat", CTLTYPE_NODE }, \ 322 { "hylink", CTLTYPE_NODE }, \ 323 { "appletalk", CTLTYPE_NODE }, \ 324 { "route", CTLTYPE_NODE }, \ 325 { "link_layer", CTLTYPE_NODE }, \ 326 { "xtp", CTLTYPE_NODE }, \ 327 { "coip", CTLTYPE_NODE }, \ 328 { "cnt", CTLTYPE_NODE }, \ 329 { "rtip", CTLTYPE_NODE }, \ 330 { "ipx", CTLTYPE_NODE }, \ 331 { "sip", CTLTYPE_NODE }, \ 332 { "pip", CTLTYPE_NODE }, \ 333 { "isdn", CTLTYPE_NODE }, \ 334 { "key", CTLTYPE_NODE }, \ 335 { "inet6", CTLTYPE_NODE }, \ 336 { "natm", CTLTYPE_NODE }, \ 337 { "atm", CTLTYPE_NODE }, \ 338 { "hdrcomplete", CTLTYPE_NODE }, \ 339 { "netgraph", CTLTYPE_NODE }, \ 340 { "snp", CTLTYPE_NODE }, \ 341 { "scp", CTLTYPE_NODE }, \ 342} 343 344/* 345 * PF_ROUTE - Routing table 346 * 347 * Three additional levels are defined: 348 * Fourth: address family, 0 is wildcard 349 * Fifth: type of info, defined below 350 * Sixth: flag(s) to mask with for NET_RT_FLAGS 351 */ 352#define NET_RT_DUMP 1 /* dump; may limit to a.f. */ 353#define NET_RT_FLAGS 2 /* by flags, e.g. RESOLVING */ 354#define NET_RT_IFLIST 3 /* survey interface list */ 355#define NET_RT_IFMALIST 4 /* return multicast address list */ 356#define NET_RT_MAXID 5 357 358#define CTL_NET_RT_NAMES { \ 359 { 0, 0 }, \ 360 { "dump", CTLTYPE_STRUCT }, \ 361 { "flags", CTLTYPE_STRUCT }, \ 362 { "iflist", CTLTYPE_STRUCT }, \ 363 { "ifmalist", CTLTYPE_STRUCT }, \ 364} 365#endif /* __BSD_VISIBLE */ 366 367/* 368 * Maximum queue length specifiable by listen. 369 */ 370#define SOMAXCONN 128 371 372/* 373 * Message header for recvmsg and sendmsg calls. 374 * Used value-result for recvmsg, value only for sendmsg. 375 */ 376struct msghdr { 377 void *msg_name; /* optional address */ 378 socklen_t msg_namelen; /* size of address */ 379 struct iovec *msg_iov; /* scatter/gather array */ 380 int msg_iovlen; /* # elements in msg_iov */ 381 void *msg_control; /* ancillary data, see below */ 382 socklen_t msg_controllen; /* ancillary data buffer len */ 383 int msg_flags; /* flags on received message */ 384}; 385 386#define MSG_OOB 0x1 /* process out-of-band data */ 387#define MSG_PEEK 0x2 /* peek at incoming message */ 388#define MSG_DONTROUTE 0x4 /* send without using routing tables */ 389#define MSG_EOR 0x8 /* data completes record */ 390#define MSG_TRUNC 0x10 /* data discarded before delivery */ 391#define MSG_CTRUNC 0x20 /* control data lost before delivery */ 392#define MSG_WAITALL 0x40 /* wait for full request or error */ 393#if __BSD_VISIBLE 394#define MSG_DONTWAIT 0x80 /* this message should be nonblocking */ 395#define MSG_EOF 0x100 /* data completes connection */ 396#define MSG_NBIO 0x4000 /* FIONBIO mode, used by fifofs */ 397#define MSG_COMPAT 0x8000 /* used in sendit() */ 398#endif 399 400/* 401 * Header for ancillary data objects in msg_control buffer. 402 * Used for additional information with/about a datagram 403 * not expressible by flags. The format is a sequence 404 * of message elements headed by cmsghdr structures. 405 */ 406struct cmsghdr { 407 socklen_t cmsg_len; /* data byte count, including hdr */ 408 int cmsg_level; /* originating protocol */ 409 int cmsg_type; /* protocol-specific type */ 410/* followed by u_char cmsg_data[]; */ 411}; 412 413#if __BSD_VISIBLE 414/* 415 * While we may have more groups than this, the cmsgcred struct must 416 * be able to fit in an mbuf, and NGROUPS_MAX is too large to allow 417 * this. 418*/ 419#define CMGROUP_MAX 16 420 421/* 422 * Credentials structure, used to verify the identity of a peer 423 * process that has sent us a message. This is allocated by the 424 * peer process but filled in by the kernel. This prevents the 425 * peer from lying about its identity. (Note that cmcred_groups[0] 426 * is the effective GID.) 427 */ 428struct cmsgcred { 429 pid_t cmcred_pid; /* PID of sending process */ 430 uid_t cmcred_uid; /* real UID of sending process */ 431 uid_t cmcred_euid; /* effective UID of sending process */ 432 gid_t cmcred_gid; /* real GID of sending process */ 433 short cmcred_ngroups; /* number or groups */ 434 gid_t cmcred_groups[CMGROUP_MAX]; /* groups */ 435}; 436#endif /* __BSD_VISIBLE */ 437 438/* given pointer to struct cmsghdr, return pointer to data */ 439#define CMSG_DATA(cmsg) ((unsigned char *)(cmsg) + \ 440 _ALIGN(sizeof(struct cmsghdr))) 441 442/* given pointer to struct cmsghdr, return pointer to next cmsghdr */ 443#define CMSG_NXTHDR(mhdr, cmsg) \ 444 (((char *)(cmsg) + _ALIGN((cmsg)->cmsg_len) + \ 445 _ALIGN(sizeof(struct cmsghdr)) > \ 446 (char *)(mhdr)->msg_control + (mhdr)->msg_controllen) ? \ 447 (struct cmsghdr *)0 : \ 448 (struct cmsghdr *)((char *)(cmsg) + _ALIGN((cmsg)->cmsg_len))) 449 450#define CMSG_FIRSTHDR(mhdr) ((struct cmsghdr *)(mhdr)->msg_control) 451 452#if __BSD_VISIBLE 453/* RFC 2292 additions */ 454#define CMSG_SPACE(l) (_ALIGN(sizeof(struct cmsghdr)) + _ALIGN(l)) 455#define CMSG_LEN(l) (_ALIGN(sizeof(struct cmsghdr)) + (l)) 456#endif 457 458#ifdef _KERNEL 459#define CMSG_ALIGN(n) _ALIGN(n) 460#endif 461 462/* "Socket"-level control message types: */ 463#define SCM_RIGHTS 0x01 /* access rights (array of int) */ 464#if __BSD_VISIBLE 465#define SCM_TIMESTAMP 0x02 /* timestamp (struct timeval) */ 466#define SCM_CREDS 0x03 /* process creds (struct cmsgcred) */ 467#define SCM_BINTIME 0x04 /* timestamp (struct bintime) */ 468#endif 469 470#if __BSD_VISIBLE 471/* 472 * 4.3 compat sockaddr, move to compat file later 473 */ 474struct osockaddr { 475 unsigned short sa_family; /* address family */ 476 char sa_data[14]; /* up to 14 bytes of direct address */ 477}; 478 479/* 480 * 4.3-compat message header (move to compat file later). 481 */ 482struct omsghdr { 483 char *msg_name; /* optional address */ 484 int msg_namelen; /* size of address */ 485 struct iovec *msg_iov; /* scatter/gather array */ 486 int msg_iovlen; /* # elements in msg_iov */ 487 char *msg_accrights; /* access rights sent/received */ 488 int msg_accrightslen; 489}; 490#endif 491 492/* 493 * howto arguments for shutdown(2), specified by Posix.1g. 494 */ 495#define SHUT_RD 0 /* shut down the reading side */ 496#define SHUT_WR 1 /* shut down the writing side */ 497#define SHUT_RDWR 2 /* shut down both sides */ 498 499#if __BSD_VISIBLE 500/* 501 * sendfile(2) header/trailer struct 502 */ 503struct sf_hdtr { 504 struct iovec *headers; /* pointer to an array of header struct iovec's */ 505 int hdr_cnt; /* number of header iovec's */ 506 struct iovec *trailers; /* pointer to an array of trailer struct iovec's */ 507 int trl_cnt; /* number of trailer iovec's */ 508}; 509 510/* 511 * Sendfile-specific flag(s) 512 */ 513#define SF_NODISKIO 0x00000001 514#endif 515 516#ifndef _KERNEL 517 518#include <sys/cdefs.h> 519 520__BEGIN_DECLS 521int accept(int, struct sockaddr * __restrict, socklen_t * __restrict); 522int bind(int, const struct sockaddr *, socklen_t); 523int connect(int, const struct sockaddr *, socklen_t); 524int getpeername(int, struct sockaddr * __restrict, socklen_t * __restrict); 525int getsockname(int, struct sockaddr * __restrict, socklen_t * __restrict); 526int getsockopt(int, int, int, void * __restrict, socklen_t * __restrict); 527int listen(int, int); 528ssize_t recv(int, void *, size_t, int); 529ssize_t recvfrom(int, void *, size_t, int, struct sockaddr * __restrict, socklen_t * __restrict); 530ssize_t recvmsg(int, struct msghdr *, int); 531ssize_t send(int, const void *, size_t, int); 532ssize_t sendto(int, const void *, 533 size_t, int, const struct sockaddr *, socklen_t); 534ssize_t sendmsg(int, const struct msghdr *, int); 535#if __BSD_VISIBLE 536int sendfile(int, int, off_t, size_t, struct sf_hdtr *, off_t *, int); 537#endif 538int setsockopt(int, int, int, const void *, socklen_t); 539int shutdown(int, int); 540int sockatmark(int); 541int socket(int, int, int); 542int socketpair(int, int, int, int *); 543__END_DECLS 544 545#endif /* !_KERNEL */ 546 547#endif /* !_SYS_SOCKET_H_ */ 548