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