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