socket.h revision 1817
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 * $Id$ 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 * Types 46 */ 47#define SOCK_STREAM 1 /* stream socket */ 48#define SOCK_DGRAM 2 /* datagram socket */ 49#define SOCK_RAW 3 /* raw-protocol interface */ 50#define SOCK_RDM 4 /* reliably-delivered message */ 51#define SOCK_SEQPACKET 5 /* sequenced packet stream */ 52 53/* 54 * Option flags per-socket. 55 */ 56#define SO_DEBUG 0x0001 /* turn on debugging info recording */ 57#define SO_ACCEPTCONN 0x0002 /* socket has had listen() */ 58#define SO_REUSEADDR 0x0004 /* allow local address reuse */ 59#define SO_KEEPALIVE 0x0008 /* keep connections alive */ 60#define SO_DONTROUTE 0x0010 /* just use interface addresses */ 61#define SO_BROADCAST 0x0020 /* permit sending of broadcast msgs */ 62#define SO_USELOOPBACK 0x0040 /* bypass hardware when possible */ 63#define SO_LINGER 0x0080 /* linger on close if data present */ 64#define SO_OOBINLINE 0x0100 /* leave received OOB data in line */ 65#define SO_REUSEPORT 0x0200 /* allow local address & port reuse */ 66 67/* 68 * Additional options, not kept in so_options. 69 */ 70#define SO_SNDBUF 0x1001 /* send buffer size */ 71#define SO_RCVBUF 0x1002 /* receive buffer size */ 72#define SO_SNDLOWAT 0x1003 /* send low-water mark */ 73#define SO_RCVLOWAT 0x1004 /* receive low-water mark */ 74#define SO_SNDTIMEO 0x1005 /* send timeout */ 75#define SO_RCVTIMEO 0x1006 /* receive timeout */ 76#define SO_ERROR 0x1007 /* get error status and clear */ 77#define SO_TYPE 0x1008 /* get socket type */ 78 79/* 80 * Structure used for manipulating linger option. 81 */ 82struct linger { 83 int l_onoff; /* option on/off */ 84 int l_linger; /* linger time */ 85}; 86 87/* 88 * Level number for (get/set)sockopt() to apply to socket itself. 89 */ 90#define SOL_SOCKET 0xffff /* options for socket level */ 91 92/* 93 * Address families. 94 */ 95#define AF_UNSPEC 0 /* unspecified */ 96#define AF_LOCAL 1 /* local to host (pipes, portals) */ 97#define AF_UNIX AF_LOCAL /* backward compatibility */ 98#define AF_INET 2 /* internetwork: UDP, TCP, etc. */ 99#define AF_IMPLINK 3 /* arpanet imp addresses */ 100#define AF_PUP 4 /* pup protocols: e.g. BSP */ 101#define AF_CHAOS 5 /* mit CHAOS protocols */ 102#define AF_NS 6 /* XEROX NS protocols */ 103#define AF_ISO 7 /* ISO protocols */ 104#define AF_OSI AF_ISO 105#define AF_ECMA 8 /* european computer manufacturers */ 106#define AF_DATAKIT 9 /* datakit protocols */ 107#define AF_CCITT 10 /* CCITT protocols, X.25 etc */ 108#define AF_SNA 11 /* IBM SNA */ 109#define AF_DECnet 12 /* DECnet */ 110#define AF_DLI 13 /* DEC Direct data link interface */ 111#define AF_LAT 14 /* LAT */ 112#define AF_HYLINK 15 /* NSC Hyperchannel */ 113#define AF_APPLETALK 16 /* Apple Talk */ 114#define AF_ROUTE 17 /* Internal Routing Protocol */ 115#define AF_LINK 18 /* Link layer interface */ 116#define pseudo_AF_XTP 19 /* eXpress Transfer Protocol (no AF) */ 117#define AF_COIP 20 /* connection-oriented IP, aka ST II */ 118#define AF_CNT 21 /* Computer Network Technology */ 119#define pseudo_AF_RTIP 22 /* Help Identify RTIP packets */ 120#define AF_IPX 23 /* Novell Internet Protocol */ 121#define AF_SIP 24 /* Simple Internet Protocol */ 122#define pseudo_AF_PIP 25 /* Help Identify PIP packets */ 123 124#define AF_MAX 26 125 126/* 127 * Structure used by kernel to store most 128 * addresses. 129 */ 130struct sockaddr { 131 u_char sa_len; /* total length */ 132 u_char sa_family; /* address family */ 133 char sa_data[14]; /* actually longer; address value */ 134}; 135 136/* 137 * Structure used by kernel to pass protocol 138 * information in raw sockets. 139 */ 140struct sockproto { 141 u_short sp_family; /* address family */ 142 u_short sp_protocol; /* protocol */ 143}; 144 145/* 146 * Protocol families, same as address families for now. 147 */ 148#define PF_UNSPEC AF_UNSPEC 149#define PF_LOCAL AF_LOCAL 150#define PF_UNIX PF_LOCAL /* backward compatibility */ 151#define PF_INET AF_INET 152#define PF_IMPLINK AF_IMPLINK 153#define PF_PUP AF_PUP 154#define PF_CHAOS AF_CHAOS 155#define PF_NS AF_NS 156#define PF_ISO AF_ISO 157#define PF_OSI AF_ISO 158#define PF_ECMA AF_ECMA 159#define PF_DATAKIT AF_DATAKIT 160#define PF_CCITT AF_CCITT 161#define PF_SNA AF_SNA 162#define PF_DECnet AF_DECnet 163#define PF_DLI AF_DLI 164#define PF_LAT AF_LAT 165#define PF_HYLINK AF_HYLINK 166#define PF_APPLETALK AF_APPLETALK 167#define PF_ROUTE AF_ROUTE 168#define PF_LINK AF_LINK 169#define PF_XTP pseudo_AF_XTP /* really just proto family, no AF */ 170#define PF_COIP AF_COIP 171#define PF_CNT AF_CNT 172#define PF_SIP AF_SIP 173#define PF_IPX AF_IPX /* same format as AF_NS */ 174#define PF_RTIP pseudo_AF_FTIP /* same format as AF_INET */ 175#define PF_PIP pseudo_AF_PIP 176 177#define PF_MAX AF_MAX 178 179/* 180 * Definitions for network related sysctl, CTL_NET. 181 * 182 * Second level is protocol family. 183 * Third level is protocol number. 184 * 185 * Further levels are defined by the individual families below. 186 */ 187#define NET_MAXID AF_MAX 188 189#define CTL_NET_NAMES { \ 190 { 0, 0 }, \ 191 { "unix", CTLTYPE_NODE }, \ 192 { "inet", CTLTYPE_NODE }, \ 193 { "implink", CTLTYPE_NODE }, \ 194 { "pup", CTLTYPE_NODE }, \ 195 { "chaos", CTLTYPE_NODE }, \ 196 { "xerox_ns", CTLTYPE_NODE }, \ 197 { "iso", CTLTYPE_NODE }, \ 198 { "emca", CTLTYPE_NODE }, \ 199 { "datakit", CTLTYPE_NODE }, \ 200 { "ccitt", CTLTYPE_NODE }, \ 201 { "ibm_sna", CTLTYPE_NODE }, \ 202 { "decnet", CTLTYPE_NODE }, \ 203 { "dec_dli", CTLTYPE_NODE }, \ 204 { "lat", CTLTYPE_NODE }, \ 205 { "hylink", CTLTYPE_NODE }, \ 206 { "appletalk", CTLTYPE_NODE }, \ 207 { "route", CTLTYPE_NODE }, \ 208 { "link_layer", CTLTYPE_NODE }, \ 209 { "xtp", CTLTYPE_NODE }, \ 210 { "coip", CTLTYPE_NODE }, \ 211 { "cnt", CTLTYPE_NODE }, \ 212 { "rtip", CTLTYPE_NODE }, \ 213 { "ipx", CTLTYPE_NODE }, \ 214 { "sip", CTLTYPE_NODE }, \ 215 { "pip", CTLTYPE_NODE }, \ 216} 217 218/* 219 * PF_ROUTE - Routing table 220 * 221 * Three additional levels are defined: 222 * Fourth: address family, 0 is wildcard 223 * Fifth: type of info, defined below 224 * Sixth: flag(s) to mask with for NET_RT_FLAGS 225 */ 226#define NET_RT_DUMP 1 /* dump; may limit to a.f. */ 227#define NET_RT_FLAGS 2 /* by flags, e.g. RESOLVING */ 228#define NET_RT_IFLIST 3 /* survey interface list */ 229#define NET_RT_MAXID 4 230 231#define CTL_NET_RT_NAMES { \ 232 { 0, 0 }, \ 233 { "dump", CTLTYPE_STRUCT }, \ 234 { "flags", CTLTYPE_STRUCT }, \ 235 { "iflist", CTLTYPE_STRUCT }, \ 236} 237 238/* 239 * Maximum queue length specifiable by listen. 240 */ 241#define SOMAXCONN 5 242 243/* 244 * Message header for recvmsg and sendmsg calls. 245 * Used value-result for recvmsg, value only for sendmsg. 246 */ 247struct msghdr { 248 caddr_t msg_name; /* optional address */ 249 u_int msg_namelen; /* size of address */ 250 struct iovec *msg_iov; /* scatter/gather array */ 251 u_int msg_iovlen; /* # elements in msg_iov */ 252 caddr_t msg_control; /* ancillary data, see below */ 253 u_int msg_controllen; /* ancillary data buffer len */ 254 int msg_flags; /* flags on received message */ 255}; 256 257#define MSG_OOB 0x1 /* process out-of-band data */ 258#define MSG_PEEK 0x2 /* peek at incoming message */ 259#define MSG_DONTROUTE 0x4 /* send without using routing tables */ 260#define MSG_EOR 0x8 /* data completes record */ 261#define MSG_TRUNC 0x10 /* data discarded before delivery */ 262#define MSG_CTRUNC 0x20 /* control data lost before delivery */ 263#define MSG_WAITALL 0x40 /* wait for full request or error */ 264#define MSG_DONTWAIT 0x80 /* this message should be nonblocking */ 265 266/* 267 * Header for ancillary data objects in msg_control buffer. 268 * Used for additional information with/about a datagram 269 * not expressible by flags. The format is a sequence 270 * of message elements headed by cmsghdr structures. 271 */ 272struct cmsghdr { 273 u_int cmsg_len; /* data byte count, including hdr */ 274 int cmsg_level; /* originating protocol */ 275 int cmsg_type; /* protocol-specific type */ 276/* followed by u_char cmsg_data[]; */ 277}; 278 279/* given pointer to struct cmsghdr, return pointer to data */ 280#define CMSG_DATA(cmsg) ((u_char *)((cmsg) + 1)) 281 282/* given pointer to struct cmsghdr, return pointer to next cmsghdr */ 283#define CMSG_NXTHDR(mhdr, cmsg) \ 284 (((caddr_t)(cmsg) + (cmsg)->cmsg_len + sizeof(struct cmsghdr) > \ 285 (mhdr)->msg_control + (mhdr)->msg_controllen) ? \ 286 (struct cmsghdr *)NULL : \ 287 (struct cmsghdr *)((caddr_t)(cmsg) + ALIGN((cmsg)->cmsg_len))) 288 289#define CMSG_FIRSTHDR(mhdr) ((struct cmsghdr *)(mhdr)->msg_control) 290 291/* "Socket"-level control message types: */ 292#define SCM_RIGHTS 0x01 /* access rights (array of int) */ 293 294/* 295 * 4.3 compat sockaddr, move to compat file later 296 */ 297struct osockaddr { 298 u_short sa_family; /* address family */ 299 char sa_data[14]; /* up to 14 bytes of direct address */ 300}; 301 302/* 303 * 4.3-compat message header (move to compat file later). 304 */ 305struct omsghdr { 306 caddr_t msg_name; /* optional address */ 307 int msg_namelen; /* size of address */ 308 struct iovec *msg_iov; /* scatter/gather array */ 309 int msg_iovlen; /* # elements in msg_iov */ 310 caddr_t msg_accrights; /* access rights sent/received */ 311 int msg_accrightslen; 312}; 313 314#ifndef KERNEL 315 316#include <sys/cdefs.h> 317 318__BEGIN_DECLS 319int accept __P((int, struct sockaddr *, int *)); 320int bind __P((int, const struct sockaddr *, int)); 321int connect __P((int, const struct sockaddr *, int)); 322int getpeername __P((int, struct sockaddr *, int *)); 323int getsockname __P((int, struct sockaddr *, int *)); 324int getsockopt __P((int, int, int, void *, int *)); 325int listen __P((int, int)); 326ssize_t recv __P((int, void *, size_t, int)); 327ssize_t recvfrom __P((int, void *, size_t, int, struct sockaddr *, int *)); 328ssize_t recvmsg __P((int, struct msghdr *, int)); 329ssize_t send __P((int, const void *, size_t, int)); 330ssize_t sendto __P((int, const void *, 331 size_t, int, const struct sockaddr *, int)); 332ssize_t sendmsg __P((int, const struct msghdr *, int)); 333int setsockopt __P((int, int, int, const void *, int)); 334int shutdown __P((int, int)); 335int socket __P((int, int, int)); 336int socketpair __P((int, int, int, int *)); 337__END_DECLS 338 339#endif /* !KERNEL */ 340#endif /* !_SYS_SOCKET_H_ */ 341