socket.h revision 126937
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 * 3. All advertising materials mentioning features or use of this software 14 * must display the following acknowledgement: 15 * This product includes software developed by the University of 16 * California, Berkeley and its contributors. 17 * 4. Neither the name of the University nor the names of its contributors 18 * may be used to endorse or promote products derived from this software 19 * without specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31 * SUCH DAMAGE. 32 * 33 * @(#)socket.h 8.4 (Berkeley) 2/21/94 34 * $FreeBSD: head/sys/sys/socket.h 126937 2004-03-14 00:49:09Z mdodd $ 35 */ 36 37#ifndef _SYS_SOCKET_H_ 38#define _SYS_SOCKET_H_ 39 40#include <sys/cdefs.h> 41#include <sys/_types.h> 42#include <sys/_iovec.h> 43#define _NO_NAMESPACE_POLLUTION 44#include <machine/param.h> 45#undef _NO_NAMESPACE_POLLUTION 46 47/* 48 * Definitions related to sockets: types, address families, options. 49 */ 50 51/* 52 * Data types. 53 */ 54#if __BSD_VISIBLE 55#ifndef _GID_T_DECLARED 56typedef __gid_t gid_t; 57#define _GID_T_DECLARED 58#endif 59 60#ifndef _OFF_T_DECLARED 61typedef __off_t off_t; 62#define _OFF_T_DECLARED 63#endif 64 65#ifndef _PID_T_DECLARED 66typedef __pid_t pid_t; 67#define _PID_T_DECLARED 68#endif 69#endif 70 71#ifndef _SA_FAMILY_T_DECLARED 72typedef __sa_family_t sa_family_t; 73#define _SA_FAMILY_T_DECLARED 74#endif 75 76#ifndef _SOCKLEN_T_DECLARED 77typedef __socklen_t socklen_t; 78#define _SOCKLEN_T_DECLARED 79#endif 80 81#ifndef _SSIZE_T_DECLARED 82typedef __ssize_t ssize_t; 83#define _SSIZE_T_DECLARED 84#endif 85 86#if __BSD_VISIBLE 87#ifndef _UID_T_DECLARED 88typedef __uid_t uid_t; 89#define _UID_T_DECLARED 90#endif 91#endif 92 93/* 94 * Types 95 */ 96#define SOCK_STREAM 1 /* stream socket */ 97#define SOCK_DGRAM 2 /* datagram socket */ 98#define SOCK_RAW 3 /* raw-protocol interface */ 99#if __BSD_VISIBLE 100#define SOCK_RDM 4 /* reliably-delivered message */ 101#endif 102#define SOCK_SEQPACKET 5 /* sequenced packet stream */ 103 104/* 105 * Option flags per-socket. 106 */ 107#define SO_DEBUG 0x0001 /* turn on debugging info recording */ 108#define SO_ACCEPTCONN 0x0002 /* socket has had listen() */ 109#define SO_REUSEADDR 0x0004 /* allow local address reuse */ 110#define SO_KEEPALIVE 0x0008 /* keep connections alive */ 111#define SO_DONTROUTE 0x0010 /* just use interface addresses */ 112#define SO_BROADCAST 0x0020 /* permit sending of broadcast msgs */ 113#if __BSD_VISIBLE 114#define SO_USELOOPBACK 0x0040 /* bypass hardware when possible */ 115#endif 116#define SO_LINGER 0x0080 /* linger on close if data present */ 117#define SO_OOBINLINE 0x0100 /* leave received OOB data in line */ 118#if __BSD_VISIBLE 119#define SO_REUSEPORT 0x0200 /* allow local address & port reuse */ 120#define SO_TIMESTAMP 0x0400 /* timestamp received dgram traffic */ 121#define SO_NOSIGPIPE 0x0800 /* no SIGPIPE from EPIPE */ 122#define SO_ACCEPTFILTER 0x1000 /* there is an accept filter */ 123#define SO_BINTIME 0x2000 /* timestamp received dgram traffic */ 124#endif 125 126/* 127 * Additional options, not kept in so_options. 128 */ 129#define SO_SNDBUF 0x1001 /* send buffer size */ 130#define SO_RCVBUF 0x1002 /* receive buffer size */ 131#define SO_SNDLOWAT 0x1003 /* send low-water mark */ 132#define SO_RCVLOWAT 0x1004 /* receive low-water mark */ 133#define SO_SNDTIMEO 0x1005 /* send timeout */ 134#define SO_RCVTIMEO 0x1006 /* receive timeout */ 135#define SO_ERROR 0x1007 /* get error status and clear */ 136#define SO_TYPE 0x1008 /* get socket type */ 137#if __BSD_VISIBLE 138#define SO_LABEL 0x1009 /* socket's MAC label */ 139#define SO_PEERLABEL 0x1010 /* socket's peer's MAC label */ 140#endif 141 142/* 143 * Structure used for manipulating linger option. 144 */ 145struct linger { 146 int l_onoff; /* option on/off */ 147 int l_linger; /* linger time */ 148}; 149 150#if __BSD_VISIBLE 151struct accept_filter_arg { 152 char af_name[16]; 153 char af_arg[256-16]; 154}; 155#endif 156 157/* 158 * Level number for (get/set)sockopt() to apply to socket itself. 159 */ 160#define SOL_SOCKET 0xffff /* options for socket level */ 161 162/* 163 * Address families. 164 */ 165#define AF_UNSPEC 0 /* unspecified */ 166#if __BSD_VISIBLE 167#define AF_LOCAL AF_UNIX /* local to host (pipes, portals) */ 168#endif 169#define AF_UNIX 1 /* standardized name for AF_LOCAL */ 170#define AF_INET 2 /* internetwork: UDP, TCP, etc. */ 171#if __BSD_VISIBLE 172#define AF_IMPLINK 3 /* arpanet imp addresses */ 173#define AF_PUP 4 /* pup protocols: e.g. BSP */ 174#define AF_CHAOS 5 /* mit CHAOS protocols */ 175#define AF_NETBIOS 6 /* SMB protocols */ 176#define AF_ISO 7 /* ISO protocols */ 177#define AF_OSI AF_ISO 178#define AF_ECMA 8 /* European computer manufacturers */ 179#define AF_DATAKIT 9 /* datakit protocols */ 180#define AF_CCITT 10 /* CCITT protocols, X.25 etc */ 181#define AF_SNA 11 /* IBM SNA */ 182#define AF_DECnet 12 /* DECnet */ 183#define AF_DLI 13 /* DEC Direct data link interface */ 184#define AF_LAT 14 /* LAT */ 185#define AF_HYLINK 15 /* NSC Hyperchannel */ 186#define AF_APPLETALK 16 /* Apple Talk */ 187#define AF_ROUTE 17 /* Internal Routing Protocol */ 188#define AF_LINK 18 /* Link layer interface */ 189#define pseudo_AF_XTP 19 /* eXpress Transfer Protocol (no AF) */ 190#define AF_COIP 20 /* connection-oriented IP, aka ST II */ 191#define AF_CNT 21 /* Computer Network Technology */ 192#define pseudo_AF_RTIP 22 /* Help Identify RTIP packets */ 193#define AF_IPX 23 /* Novell Internet Protocol */ 194#define AF_SIP 24 /* Simple Internet Protocol */ 195#define pseudo_AF_PIP 25 /* Help Identify PIP packets */ 196#define AF_ISDN 26 /* Integrated Services Digital Network*/ 197#define AF_E164 AF_ISDN /* CCITT E.164 recommendation */ 198#define pseudo_AF_KEY 27 /* Internal key-management function */ 199#endif 200#define AF_INET6 28 /* IPv6 */ 201#if __BSD_VISIBLE 202#define AF_NATM 29 /* native ATM access */ 203#define AF_ATM 30 /* ATM */ 204#define pseudo_AF_HDRCMPLT 31 /* Used by BPF to not rewrite headers 205 * in interface output routine 206 */ 207#define AF_NETGRAPH 32 /* Netgraph sockets */ 208#define AF_SLOW 33 /* 802.3ad slow protocol */ 209#define AF_SCLUSTER 34 /* Sitara cluster protocol */ 210#define AF_ARP 35 211#define AF_MAX 36 212#endif 213 214/* 215 * Structure used by kernel to store most 216 * addresses. 217 */ 218struct sockaddr { 219 unsigned char sa_len; /* total length */ 220 sa_family_t sa_family; /* address family */ 221 char sa_data[14]; /* actually longer; address value */ 222}; 223#if __BSD_VISIBLE 224#define SOCK_MAXADDRLEN 255 /* longest possible addresses */ 225 226/* 227 * Structure used by kernel to pass protocol 228 * information in raw sockets. 229 */ 230struct sockproto { 231 unsigned short sp_family; /* address family */ 232 unsigned short sp_protocol; /* protocol */ 233}; 234#endif 235 236/* 237 * RFC 2553: protocol-independent placeholder for socket addresses 238 */ 239#define _SS_MAXSIZE 128U 240#define _SS_ALIGNSIZE (sizeof(__int64_t)) 241#define _SS_PAD1SIZE (_SS_ALIGNSIZE - sizeof(unsigned char) - \ 242 sizeof(sa_family_t)) 243#define _SS_PAD2SIZE (_SS_MAXSIZE - sizeof(unsigned char) - \ 244 sizeof(sa_family_t) - _SS_PAD1SIZE - _SS_ALIGNSIZE) 245 246struct sockaddr_storage { 247 unsigned char ss_len; /* address length */ 248 sa_family_t ss_family; /* address family */ 249 char __ss_pad1[_SS_PAD1SIZE]; 250 __int64_t __ss_align; /* force desired struct alignment */ 251 char __ss_pad2[_SS_PAD2SIZE]; 252}; 253 254#if __BSD_VISIBLE 255/* 256 * Protocol families, same as address families for now. 257 */ 258#define PF_UNSPEC AF_UNSPEC 259#define PF_LOCAL AF_LOCAL 260#define PF_UNIX PF_LOCAL /* backward compatibility */ 261#define PF_INET AF_INET 262#define PF_IMPLINK AF_IMPLINK 263#define PF_PUP AF_PUP 264#define PF_CHAOS AF_CHAOS 265#define PF_NETBIOS AF_NETBIOS 266#define PF_ISO AF_ISO 267#define PF_OSI AF_ISO 268#define PF_ECMA AF_ECMA 269#define PF_DATAKIT AF_DATAKIT 270#define PF_CCITT AF_CCITT 271#define PF_SNA AF_SNA 272#define PF_DECnet AF_DECnet 273#define PF_DLI AF_DLI 274#define PF_LAT AF_LAT 275#define PF_HYLINK AF_HYLINK 276#define PF_APPLETALK AF_APPLETALK 277#define PF_ROUTE AF_ROUTE 278#define PF_LINK AF_LINK 279#define PF_XTP pseudo_AF_XTP /* really just proto family, no AF */ 280#define PF_COIP AF_COIP 281#define PF_CNT AF_CNT 282#define PF_SIP AF_SIP 283#define PF_IPX AF_IPX 284#define PF_RTIP pseudo_AF_RTIP /* same format as AF_INET */ 285#define PF_PIP pseudo_AF_PIP 286#define PF_ISDN AF_ISDN 287#define PF_KEY pseudo_AF_KEY 288#define PF_INET6 AF_INET6 289#define PF_NATM AF_NATM 290#define PF_ATM AF_ATM 291#define PF_NETGRAPH AF_NETGRAPH 292#define PF_SLOW AF_SLOW 293#define PF_SCLUSTER AF_SCLUSTER 294#define PF_ARP AF_ARP 295 296#define PF_MAX AF_MAX 297 298/* 299 * Definitions for network related sysctl, CTL_NET. 300 * 301 * Second level is protocol family. 302 * Third level is protocol number. 303 * 304 * Further levels are defined by the individual families below. 305 */ 306#define NET_MAXID AF_MAX 307 308#define CTL_NET_NAMES { \ 309 { 0, 0 }, \ 310 { "unix", CTLTYPE_NODE }, \ 311 { "inet", CTLTYPE_NODE }, \ 312 { "implink", CTLTYPE_NODE }, \ 313 { "pup", CTLTYPE_NODE }, \ 314 { "chaos", CTLTYPE_NODE }, \ 315 { "xerox_ns", CTLTYPE_NODE }, \ 316 { "iso", CTLTYPE_NODE }, \ 317 { "emca", CTLTYPE_NODE }, \ 318 { "datakit", CTLTYPE_NODE }, \ 319 { "ccitt", CTLTYPE_NODE }, \ 320 { "ibm_sna", CTLTYPE_NODE }, \ 321 { "decnet", CTLTYPE_NODE }, \ 322 { "dec_dli", CTLTYPE_NODE }, \ 323 { "lat", CTLTYPE_NODE }, \ 324 { "hylink", CTLTYPE_NODE }, \ 325 { "appletalk", CTLTYPE_NODE }, \ 326 { "route", CTLTYPE_NODE }, \ 327 { "link_layer", CTLTYPE_NODE }, \ 328 { "xtp", CTLTYPE_NODE }, \ 329 { "coip", CTLTYPE_NODE }, \ 330 { "cnt", CTLTYPE_NODE }, \ 331 { "rtip", CTLTYPE_NODE }, \ 332 { "ipx", CTLTYPE_NODE }, \ 333 { "sip", CTLTYPE_NODE }, \ 334 { "pip", CTLTYPE_NODE }, \ 335 { "isdn", CTLTYPE_NODE }, \ 336 { "key", CTLTYPE_NODE }, \ 337 { "inet6", CTLTYPE_NODE }, \ 338 { "natm", CTLTYPE_NODE }, \ 339 { "atm", CTLTYPE_NODE }, \ 340 { "hdrcomplete", CTLTYPE_NODE }, \ 341 { "netgraph", CTLTYPE_NODE }, \ 342 { "snp", CTLTYPE_NODE }, \ 343 { "scp", CTLTYPE_NODE }, \ 344} 345 346/* 347 * PF_ROUTE - Routing table 348 * 349 * Three additional levels are defined: 350 * Fourth: address family, 0 is wildcard 351 * Fifth: type of info, defined below 352 * Sixth: flag(s) to mask with for NET_RT_FLAGS 353 */ 354#define NET_RT_DUMP 1 /* dump; may limit to a.f. */ 355#define NET_RT_FLAGS 2 /* by flags, e.g. RESOLVING */ 356#define NET_RT_IFLIST 3 /* survey interface list */ 357#define NET_RT_IFMALIST 4 /* return multicast address list */ 358#define NET_RT_MAXID 5 359 360#define CTL_NET_RT_NAMES { \ 361 { 0, 0 }, \ 362 { "dump", CTLTYPE_STRUCT }, \ 363 { "flags", CTLTYPE_STRUCT }, \ 364 { "iflist", CTLTYPE_STRUCT }, \ 365 { "ifmalist", CTLTYPE_STRUCT }, \ 366} 367#endif /* __BSD_VISIBLE */ 368 369/* 370 * Maximum queue length specifiable by listen. 371 */ 372#define SOMAXCONN 128 373 374/* 375 * Message header for recvmsg and sendmsg calls. 376 * Used value-result for recvmsg, value only for sendmsg. 377 */ 378struct msghdr { 379 void *msg_name; /* optional address */ 380 socklen_t msg_namelen; /* size of address */ 381 struct iovec *msg_iov; /* scatter/gather array */ 382 int msg_iovlen; /* # elements in msg_iov */ 383 void *msg_control; /* ancillary data, see below */ 384 socklen_t msg_controllen; /* ancillary data buffer len */ 385 int msg_flags; /* flags on received message */ 386}; 387 388#define MSG_OOB 0x1 /* process out-of-band data */ 389#define MSG_PEEK 0x2 /* peek at incoming message */ 390#define MSG_DONTROUTE 0x4 /* send without using routing tables */ 391#define MSG_EOR 0x8 /* data completes record */ 392#define MSG_TRUNC 0x10 /* data discarded before delivery */ 393#define MSG_CTRUNC 0x20 /* control data lost before delivery */ 394#define MSG_WAITALL 0x40 /* wait for full request or error */ 395#if __BSD_VISIBLE 396#define MSG_DONTWAIT 0x80 /* this message should be nonblocking */ 397#define MSG_EOF 0x100 /* data completes connection */ 398#define MSG_COMPAT 0x8000 /* used in sendit() */ 399#endif 400 401/* 402 * Header for ancillary data objects in msg_control buffer. 403 * Used for additional information with/about a datagram 404 * not expressible by flags. The format is a sequence 405 * of message elements headed by cmsghdr structures. 406 */ 407struct cmsghdr { 408 socklen_t cmsg_len; /* data byte count, including hdr */ 409 int cmsg_level; /* originating protocol */ 410 int cmsg_type; /* protocol-specific type */ 411/* followed by u_char cmsg_data[]; */ 412}; 413 414#if __BSD_VISIBLE 415/* 416 * While we may have more groups than this, the cmsgcred struct must 417 * be able to fit in an mbuf, and NGROUPS_MAX is too large to allow 418 * this. 419*/ 420#define CMGROUP_MAX 16 421 422/* 423 * Credentials structure, used to verify the identity of a peer 424 * process that has sent us a message. This is allocated by the 425 * peer process but filled in by the kernel. This prevents the 426 * peer from lying about its identity. (Note that cmcred_groups[0] 427 * is the effective GID.) 428 */ 429struct cmsgcred { 430 pid_t cmcred_pid; /* PID of sending process */ 431 uid_t cmcred_uid; /* real UID of sending process */ 432 uid_t cmcred_euid; /* effective UID of sending process */ 433 gid_t cmcred_gid; /* real GID of sending process */ 434 short cmcred_ngroups; /* number or groups */ 435 gid_t cmcred_groups[CMGROUP_MAX]; /* groups */ 436}; 437#endif /* __BSD_VISIBLE */ 438 439/* given pointer to struct cmsghdr, return pointer to data */ 440#define CMSG_DATA(cmsg) ((unsigned char *)(cmsg) + \ 441 _ALIGN(sizeof(struct cmsghdr))) 442 443/* given pointer to struct cmsghdr, return pointer to next cmsghdr */ 444#define CMSG_NXTHDR(mhdr, cmsg) \ 445 (((char *)(cmsg) + _ALIGN((cmsg)->cmsg_len) + \ 446 _ALIGN(sizeof(struct cmsghdr)) > \ 447 (char *)(mhdr)->msg_control + (mhdr)->msg_controllen) ? \ 448 (struct cmsghdr *)NULL : \ 449 (struct cmsghdr *)((char *)(cmsg) + _ALIGN((cmsg)->cmsg_len))) 450 451#define CMSG_FIRSTHDR(mhdr) ((struct cmsghdr *)(mhdr)->msg_control) 452 453#if __BSD_VISIBLE 454/* RFC 2292 additions */ 455#define CMSG_SPACE(l) (_ALIGN(sizeof(struct cmsghdr)) + _ALIGN(l)) 456#define CMSG_LEN(l) (_ALIGN(sizeof(struct cmsghdr)) + (l)) 457#endif 458 459#ifdef _KERNEL 460#define CMSG_ALIGN(n) _ALIGN(n) 461#endif 462 463/* "Socket"-level control message types: */ 464#define SCM_RIGHTS 0x01 /* access rights (array of int) */ 465#if __BSD_VISIBLE 466#define SCM_TIMESTAMP 0x02 /* timestamp (struct timeval) */ 467#define SCM_CREDS 0x03 /* process creds (struct cmsgcred) */ 468#define SCM_BINTIME 0x04 /* timestamp (struct bintime) */ 469#endif 470 471#if __BSD_VISIBLE 472/* 473 * 4.3 compat sockaddr, move to compat file later 474 */ 475struct osockaddr { 476 unsigned short sa_family; /* address family */ 477 char sa_data[14]; /* up to 14 bytes of direct address */ 478}; 479 480/* 481 * 4.3-compat message header (move to compat file later). 482 */ 483struct omsghdr { 484 char *msg_name; /* optional address */ 485 int msg_namelen; /* size of address */ 486 struct iovec *msg_iov; /* scatter/gather array */ 487 int msg_iovlen; /* # elements in msg_iov */ 488 char *msg_accrights; /* access rights sent/received */ 489 int msg_accrightslen; 490}; 491#endif 492 493/* 494 * howto arguments for shutdown(2), specified by Posix.1g. 495 */ 496#define SHUT_RD 0 /* shut down the reading side */ 497#define SHUT_WR 1 /* shut down the writing side */ 498#define SHUT_RDWR 2 /* shut down both sides */ 499 500#if __BSD_VISIBLE 501/* 502 * sendfile(2) header/trailer struct 503 */ 504struct sf_hdtr { 505 struct iovec *headers; /* pointer to an array of header struct iovec's */ 506 int hdr_cnt; /* number of header iovec's */ 507 struct iovec *trailers; /* pointer to an array of trailer struct iovec's */ 508 int trl_cnt; /* number of trailer iovec's */ 509}; 510 511/* 512 * Sendfile-specific flag(s) 513 */ 514#define SF_NODISKIO 0x00000001 515#endif 516 517#ifndef _KERNEL 518 519#include <sys/cdefs.h> 520 521__BEGIN_DECLS 522int accept(int, struct sockaddr * __restrict, socklen_t * __restrict); 523int bind(int, const struct sockaddr *, socklen_t); 524int connect(int, const struct sockaddr *, socklen_t); 525int getpeername(int, struct sockaddr * __restrict, socklen_t * __restrict); 526int getsockname(int, struct sockaddr * __restrict, socklen_t * __restrict); 527int getsockopt(int, int, int, void * __restrict, socklen_t * __restrict); 528int listen(int, int); 529ssize_t recv(int, void *, size_t, int); 530ssize_t recvfrom(int, void *, size_t, int, struct sockaddr * __restrict, socklen_t * __restrict); 531ssize_t recvmsg(int, struct msghdr *, int); 532ssize_t send(int, const void *, size_t, int); 533ssize_t sendto(int, const void *, 534 size_t, int, const struct sockaddr *, socklen_t); 535ssize_t sendmsg(int, const struct msghdr *, int); 536#if __BSD_VISIBLE 537int sendfile(int, int, off_t, size_t, struct sf_hdtr *, off_t *, int); 538#endif 539int setsockopt(int, int, int, const void *, socklen_t); 540int shutdown(int, int); 541int sockatmark(int); 542int socket(int, int, int); 543int socketpair(int, int, int, int *); 544__END_DECLS 545 546#endif /* !_KERNEL */ 547 548#endif /* !_SYS_SOCKET_H_ */ 549