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