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