1 /* $OpenBSD: socket.h,v 1.46 2003/06/02 23:28:21 millert Exp $ */ 2 /* $NetBSD: socket.h,v 1.14 1996/02/09 18:25:36 christos Exp $ */ 3 4 /* 5 * Copyright (c) 1982, 1985, 1986, 1988, 1993, 1994 6 * The Regents of the University of California. All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 3. Neither the name of the University nor the names of its contributors 17 * may be used to endorse or promote products derived from this software 18 * without specific prior written permission. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30 * SUCH DAMAGE. 31 * 32 * @(#)socket.h 8.4 (Berkeley) 2/21/94 33 */ 34 35 #ifndef _SYS_SOCKET_H_ 36 #define _SYS_SOCKET_H_ 37 38 /* 39 * needed for ALIGNBYTES 40 */ 41 #include <machine/param.h> 42 43 /* 44 * Definitions related to sockets: types, address families, options. 45 */ 46 47 /* 48 * Types 49 */ 50 #define SOCK_STREAM 1 /* stream socket */ 51 #define SOCK_DGRAM 2 /* datagram socket */ 52 #define SOCK_RAW 3 /* raw-protocol interface */ 53 #define SOCK_RDM 4 /* reliably-delivered message */ 54 #define SOCK_SEQPACKET 5 /* sequenced packet stream */ 55 56 /* 57 * Option flags per-socket. 58 */ 59 #define SO_DEBUG 0x0001 /* turn on debugging info recording */ 60 #define SO_ACCEPTCONN 0x0002 /* socket has had listen() */ 61 #define SO_REUSEADDR 0x0004 /* allow local address reuse */ 62 #define SO_KEEPALIVE 0x0008 /* keep connections alive */ 63 #define SO_DONTROUTE 0x0010 /* just use interface addresses */ 64 #define SO_BROADCAST 0x0020 /* permit sending of broadcast msgs */ 65 #define SO_USELOOPBACK 0x0040 /* bypass hardware when possible */ 66 #define SO_LINGER 0x0080 /* linger on close if data present */ 67 #define SO_OOBINLINE 0x0100 /* leave received OOB data in line */ 68 #define SO_REUSEPORT 0x0200 /* allow local address & port reuse */ 69 70 /* 71 * Additional options, not kept in so_options. 72 */ 73 #define SO_SNDBUF 0x1001 /* send buffer size */ 74 #define SO_RCVBUF 0x1002 /* receive buffer size */ 75 #define SO_SNDLOWAT 0x1003 /* send low-water mark */ 76 #define SO_RCVLOWAT 0x1004 /* receive low-water mark */ 77 #define SO_SNDTIMEO 0x1005 /* send timeout */ 78 #define SO_RCVTIMEO 0x1006 /* receive timeout */ 79 #define SO_ERROR 0x1007 /* get error status and clear */ 80 #define SO_TYPE 0x1008 /* get socket type */ 81 #define SO_NETPROC 0x1020 /* multiplex; network processing */ 82 83 /* 84 * Structure used for manipulating linger option. 85 */ 86 struct linger { 87 int l_onoff; /* option on/off */ 88 int l_linger; /* linger time */ 89 }; 90 91 /* 92 * Level number for (get/set)sockopt() to apply to socket itself. 93 */ 94 #define SOL_SOCKET 0xffff /* options for socket level */ 95 96 /* 97 * Address families. 98 */ 99 #define AF_UNSPEC 0 /* unspecified */ 100 #define AF_LOCAL 1 /* local to host (pipes, portals) */ 101 #define AF_UNIX AF_LOCAL /* backward compatibility */ 102 #define AF_INET 2 /* internetwork: UDP, TCP, etc. */ 103 #define AF_IMPLINK 3 /* arpanet imp addresses */ 104 #define AF_PUP 4 /* pup protocols: e.g. BSP */ 105 #define AF_CHAOS 5 /* mit CHAOS protocols */ 106 #define AF_NS 6 /* XEROX NS protocols */ 107 #define AF_ISO 7 /* ISO protocols */ 108 #define AF_OSI AF_ISO 109 #define AF_ECMA 8 /* european computer manufacturers */ 110 #define AF_DATAKIT 9 /* datakit protocols */ 111 #define AF_CCITT 10 /* CCITT protocols, X.25 etc */ 112 #define AF_SNA 11 /* IBM SNA */ 113 #define AF_DECnet 12 /* DECnet */ 114 #define AF_DLI 13 /* DEC Direct data link interface */ 115 #define AF_LAT 14 /* LAT */ 116 #define AF_HYLINK 15 /* NSC Hyperchannel */ 117 #define AF_APPLETALK 16 /* Apple Talk */ 118 #define AF_ROUTE 17 /* Internal Routing Protocol */ 119 #define AF_LINK 18 /* Link layer interface */ 120 #define pseudo_AF_XTP 19 /* eXpress Transfer Protocol (no AF) */ 121 #define AF_COIP 20 /* connection-oriented IP, aka ST II */ 122 #define AF_CNT 21 /* Computer Network Technology */ 123 #define pseudo_AF_RTIP 22 /* Help Identify RTIP packets */ 124 #define AF_IPX 23 /* Novell Internet Protocol */ 125 #define AF_INET6 24 /* IPv6 */ 126 #define pseudo_AF_PIP 25 /* Help Identify PIP packets */ 127 #define AF_ISDN 26 /* Integrated Services Digital Network*/ 128 #define AF_E164 AF_ISDN /* CCITT E.164 recommendation */ 129 #define AF_NATM 27 /* native ATM access */ 130 #define AF_ENCAP 28 131 #define AF_SIP 29 /* Simple Internet Protocol */ 132 #define AF_KEY 30 133 #define pseudo_AF_HDRCMPLT 31 /* Used by BPF to not rewrite headers 134 in interface output routine */ 135 #define AF_MAX 32 136 137 /* 138 * Structure used by kernel to store most 139 * addresses. 140 */ 141 struct sockaddr { 142 u_int8_t sa_len; /* total length */ 143 sa_family_t sa_family; /* address family */ 144 char sa_data[14]; /* actually longer; address value */ 145 }; 146 147 /* 148 * Sockaddr type which can hold any sockaddr type available 149 * in the system. 150 * 151 * Note: __ss_{len,family} is defined in RFC2553. During RFC2553 discussion 152 * the field name went back and forth between ss_len and __ss_len, 153 * and RFC2553 specifies it to be __ss_len. openbsd picked ss_len. 154 * For maximum portability, userland programmer would need to 155 * (1) make the code never touch ss_len portion (cast it into sockaddr and 156 * touch sa_len), or (2) add "-Dss_len=__ss_len" into CFLAGS to unify all 157 * occurences (including header file) to __ss_len. 158 */ 159 struct sockaddr_storage { 160 u_int8_t ss_len; /* total length */ 161 sa_family_t ss_family; /* address family */ 162 unsigned char __ss_pad1[6]; /* align to quad */ 163 u_int64_t __ss_pad2; /* force alignment for stupid compilers */ 164 unsigned char __ss_pad3[240]; /* pad to a total of 256 bytes */ 165 }; 166 167 /* 168 * Structure used by kernel to pass protocol 169 * information in raw sockets. 170 */ 171 struct sockproto { 172 unsigned short sp_family; /* address family */ 173 unsigned short sp_protocol; /* protocol */ 174 }; 175 176 /* 177 * Protocol families, same as address families for now. 178 */ 179 #define PF_UNSPEC AF_UNSPEC 180 #define PF_LOCAL AF_LOCAL 181 #define PF_UNIX PF_LOCAL /* backward compatibility */ 182 #define PF_INET AF_INET 183 #define PF_IMPLINK AF_IMPLINK 184 #define PF_PUP AF_PUP 185 #define PF_CHAOS AF_CHAOS 186 #define PF_NS AF_NS 187 #define PF_ISO AF_ISO 188 #define PF_OSI AF_ISO 189 #define PF_ECMA AF_ECMA 190 #define PF_DATAKIT AF_DATAKIT 191 #define PF_CCITT AF_CCITT 192 #define PF_SNA AF_SNA 193 #define PF_DECnet AF_DECnet 194 #define PF_DLI AF_DLI 195 #define PF_LAT AF_LAT 196 #define PF_HYLINK AF_HYLINK 197 #define PF_APPLETALK AF_APPLETALK 198 #define PF_ROUTE AF_ROUTE 199 #define PF_LINK AF_LINK 200 #define PF_XTP pseudo_AF_XTP /* really just proto family, no AF */ 201 #define PF_COIP AF_COIP 202 #define PF_CNT AF_CNT 203 #define PF_IPX AF_IPX /* same format as AF_NS */ 204 #define PF_INET6 AF_INET6 205 #define PF_RTIP pseudo_AF_FTIP /* same format as AF_INET */ 206 #define PF_PIP pseudo_AF_PIP 207 #define PF_ISDN AF_ISDN 208 #define PF_NATM AF_NATM 209 #define PF_ENCAP AF_ENCAP 210 #define PF_SIP AF_SIP 211 #define PF_KEY AF_KEY 212 #define PF_MAX AF_MAX 213 214 /* 215 * These are the valid values for the "how" field used by shutdown(2). 216 */ 217 #define SHUT_RD 0 218 #define SHUT_WR 1 219 #define SHUT_RDWR 2 220 221 /* 222 * Socket credentials. 223 */ 224 struct sockcred { 225 uid_t sc_uid; /* real user id */ 226 uid_t sc_euid; /* effective user id */ 227 gid_t sc_gid; /* real group id */ 228 gid_t sc_egid; /* effective group id */ 229 int sc_ngroups; /* number of supplemental groups */ 230 gid_t sc_groups[1]; /* variable length */ 231 }; 232 233 /* 234 * Compute size of a sockcred structure with groups. 235 */ 236 #define SOCKCREDSIZE(ngrps) \ 237 (sizeof(struct sockcred) + (sizeof(gid_t) * ((ngrps) - 1))) 238 239 /* 240 * Definitions for network related sysctl, CTL_NET. 241 * 242 * Second level is protocol family. 243 * Third level is protocol number. 244 * 245 * Further levels are defined by the individual families below. 246 */ 247 #define NET_MAXID AF_MAX 248 249 #define CTL_NET_NAMES { \ 250 { 0, 0 }, \ 251 { "unix", CTLTYPE_NODE }, \ 252 { "inet", CTLTYPE_NODE }, \ 253 { "implink", CTLTYPE_NODE }, \ 254 { "pup", CTLTYPE_NODE }, \ 255 { "chaos", CTLTYPE_NODE }, \ 256 { "xerox_ns", CTLTYPE_NODE }, \ 257 { "iso", CTLTYPE_NODE }, \ 258 { "emca", CTLTYPE_NODE }, \ 259 { "datakit", CTLTYPE_NODE }, \ 260 { "ccitt", CTLTYPE_NODE }, \ 261 { "ibm_sna", CTLTYPE_NODE }, \ 262 { "decnet", CTLTYPE_NODE }, \ 263 { "dec_dli", CTLTYPE_NODE }, \ 264 { "lat", CTLTYPE_NODE }, \ 265 { "hylink", CTLTYPE_NODE }, \ 266 { "appletalk", CTLTYPE_NODE }, \ 267 { "route", CTLTYPE_NODE }, \ 268 { "link_layer", CTLTYPE_NODE }, \ 269 { "xtp", CTLTYPE_NODE }, \ 270 { "coip", CTLTYPE_NODE }, \ 271 { "cnt", CTLTYPE_NODE }, \ 272 { "rtip", CTLTYPE_NODE }, \ 273 { "ipx", CTLTYPE_NODE }, \ 274 { "inet6", CTLTYPE_NODE }, \ 275 { "pip", CTLTYPE_NODE }, \ 276 { "isdn", CTLTYPE_NODE }, \ 277 { "natm", CTLTYPE_NODE }, \ 278 { "encap", CTLTYPE_NODE }, \ 279 { "sip", CTLTYPE_NODE }, \ 280 { "key", CTLTYPE_NODE }, \ 281 } 282 283 /* 284 * PF_ROUTE - Routing table 285 * 286 * Three additional levels are defined: 287 * Fourth: address family, 0 is wildcard 288 * Fifth: type of info, defined below 289 * Sixth: flag(s) to mask with for NET_RT_FLAGS 290 */ 291 #define NET_RT_DUMP 1 /* dump; may limit to a.f. */ 292 #define NET_RT_FLAGS 2 /* by flags, e.g. RESOLVING */ 293 #define NET_RT_IFLIST 3 /* survey interface list */ 294 #define NET_RT_MAXID 4 295 296 #define CTL_NET_RT_NAMES { \ 297 { 0, 0 }, \ 298 { "dump", CTLTYPE_STRUCT }, \ 299 { "flags", CTLTYPE_STRUCT }, \ 300 { "iflist", CTLTYPE_STRUCT }, \ 301 } 302 303 /* 304 * Maximum queue length specifiable by listen(2). 305 */ 306 #define SOMAXCONN 128 307 308 /* 309 * Message header for recvmsg and sendmsg calls. 310 * Used value-result for recvmsg, value only for sendmsg. 311 */ 312 struct msghdr { 313 void *msg_name; /* optional address */ 314 socklen_t msg_namelen; /* size of address */ 315 struct iovec *msg_iov; /* scatter/gather array */ 316 unsigned int msg_iovlen; /* # elements in msg_iov */ 317 void *msg_control; /* ancillary data, see below */ 318 socklen_t msg_controllen; /* ancillary data buffer len */ 319 int msg_flags; /* flags on received message */ 320 }; 321 322 #define MSG_OOB 0x1 /* process out-of-band data */ 323 #define MSG_PEEK 0x2 /* peek at incoming message */ 324 #define MSG_DONTROUTE 0x4 /* send without using routing tables */ 325 #define MSG_EOR 0x8 /* data completes record */ 326 #define MSG_TRUNC 0x10 /* data discarded before delivery */ 327 #define MSG_CTRUNC 0x20 /* control data lost before delivery */ 328 #define MSG_WAITALL 0x40 /* wait for full request or error */ 329 #define MSG_DONTWAIT 0x80 /* this message should be nonblocking */ 330 #define MSG_BCAST 0x100 /* this message rec'd as broadcast */ 331 #define MSG_MCAST 0x200 /* this message rec'd as multicast */ 332 333 /* 334 * Header for ancillary data objects in msg_control buffer. 335 * Used for additional information with/about a datagram 336 * not expressible by flags. The format is a sequence 337 * of message elements headed by cmsghdr structures. 338 */ 339 struct cmsghdr { 340 socklen_t cmsg_len; /* data byte count, including hdr */ 341 int cmsg_level; /* originating protocol */ 342 int cmsg_type; /* protocol-specific type */ 343 /* followed by u_char cmsg_data[]; */ 344 }; 345 346 /* given pointer to struct cmsghdr, return pointer to data */ 347 #define CMSG_DATA(cmsg) \ 348 ((u_char *)(cmsg) + __CMSG_ALIGN(sizeof(struct cmsghdr))) 349 350 /* given pointer to struct cmsghdr, return pointer to next cmsghdr */ 351 #define CMSG_NXTHDR(mhdr, cmsg) \ 352 (((caddr_t)(cmsg) + __CMSG_ALIGN((cmsg)->cmsg_len) + \ 353 __CMSG_ALIGN(sizeof(struct cmsghdr)) > \ 354 ((caddr_t)(mhdr)->msg_control) + (mhdr)->msg_controllen) ? \ 355 (struct cmsghdr *)NULL : \ 356 (struct cmsghdr *)((caddr_t)(cmsg) + __CMSG_ALIGN((cmsg)->cmsg_len))) 357 358 /* 359 * RFC 2292 requires to check msg_controllen, in case that the kernel returns 360 * an empty list for some reasons. 361 */ 362 #define CMSG_FIRSTHDR(mhdr) \ 363 ((mhdr)->msg_controllen >= sizeof(struct cmsghdr) ? \ 364 (struct cmsghdr *)(mhdr)->msg_control : \ 365 (struct cmsghdr *)NULL) 366 367 /* Round len up to next alignment boundary */ 368 #define __CMSG_ALIGN(len) ALIGN(len) 369 #ifdef _KERNEL 370 #define CMSG_ALIGN(n) __CMSG_ALIGN(n) 371 #endif 372 373 /* Length of the contents of a control message of length len */ 374 #define CMSG_LEN(len) (__CMSG_ALIGN(sizeof(struct cmsghdr)) + (len)) 375 376 /* Length of the space taken up by a padded control message of length len */ 377 #define CMSG_SPACE(len) (__CMSG_ALIGN(sizeof(struct cmsghdr)) + __CMSG_ALIGN(len)) 378 379 /* "Socket"-level control message types: */ 380 #define SCM_RIGHTS 0x01 /* access rights (array of int) */ 381 #define SCM_CREDS 0x02 /* credentials (struct sockcred) */ 382 383 /* 384 * 4.3 compat sockaddr, move to compat file later 385 */ 386 struct osockaddr { 387 unsigned short sa_family; /* address family */ 388 char sa_data[14]; /* up to 14 bytes of direct address */ 389 }; 390 391 /* 392 * 4.3-compat message header (move to compat file later). 393 */ 394 struct omsghdr { 395 caddr_t msg_name; /* optional address */ 396 int msg_namelen; /* size of address */ 397 struct iovec *msg_iov; /* scatter/gather array */ 398 int msg_iovlen; /* # elements in msg_iov */ 399 caddr_t msg_accrights; /* access rights sent/received */ 400 int msg_accrightslen; 401 }; 402 403 #define SA_LEN(x) ((x)->sa_len) 404 405 #ifndef _KERNEL 406 407 #include <sys/cdefs.h> 408 409 __BEGIN_DECLS 410 int accept(int, struct sockaddr *, socklen_t *); 411 int bind(int, const struct sockaddr *, socklen_t); 412 int connect(int, const struct sockaddr *, socklen_t); 413 int getpeereid(int, uid_t *, gid_t *); 414 int getpeername(int, struct sockaddr *, socklen_t *); 415 int getsockname(int, struct sockaddr *, socklen_t *); 416 int getsockopt(int, int, int, void *, socklen_t *); 417 int listen(int, int); 418 ssize_t recv(int, void *, size_t, int); 419 ssize_t recvfrom(int, void *, size_t, int, struct sockaddr *, socklen_t *); 420 ssize_t recvmsg(int, struct msghdr *, int); 421 ssize_t send(int, const void *, size_t, int); 422 ssize_t sendto(int, const void *, 423 size_t, int, const struct sockaddr *, socklen_t); 424 ssize_t sendmsg(int, const struct msghdr *, int); 425 int setsockopt(int, int, int, const void *, socklen_t); 426 int shutdown(int, int); 427 int socket(int, int, int); 428 int socketpair(int, int, int, int *); 429 __END_DECLS 430 #else 431 # if defined(COMPAT_43) || defined(COMPAT_SUNOS) || defined(COMPAT_LINUX) || \ 432 defined(COMPAT_HPUX) || defined(COMPAT_FREEBSD) || defined(COMPAT_BSDOS) \ 433 || defined(COMPAT_OSF1) 434 # define COMPAT_OLDSOCK 435 # define MSG_COMPAT 0x8000 436 # endif 437 438 void pfctlinput(int, struct sockaddr *); 439 #endif /* !_KERNEL */ 440 441 #endif /* !_SYS_SOCKET_H_ */ 442