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