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. Neither the name of the University nor the names of its contributors 14 * may be used to endorse or promote products derived from this software 15 * without specific prior written permission. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27 * SUCH DAMAGE. 28 * 29 * @(#)socket.h 8.4 (Berkeley) 2/21/94 30 * $FreeBSD: src/sys/sys/socket.h,v 1.39.2.7 2001/07/03 11:02:01 ume Exp $ 31 */ 32 33 #ifndef _SYS_SOCKET_H_ 34 #define _SYS_SOCKET_H_ 35 36 #ifndef _SYS_CDEFS_H_ 37 #include <sys/cdefs.h> 38 #endif 39 40 #include <sys/_iovec.h> 41 42 #ifndef _SYS_TYPES_H_ 43 #include <sys/types.h> 44 #endif 45 #include <machine/stdint.h> 46 47 #define _NO_NAMESPACE_POLLUTION 48 #include <machine/param.h> 49 #undef _NO_NAMESPACE_POLLUTION 50 51 /* 52 * Definitions related to sockets: types, address families, options. 53 */ 54 55 /* 56 * Data types. 57 */ 58 #ifndef _SA_FAMILY_T_DECLARED 59 typedef __uint8_t sa_family_t; 60 #define _SA_FAMILY_T_DECLARED 61 #endif 62 63 #ifndef _SOCKLEN_T_DECLARED 64 #define _SOCKLEN_T_DECLARED 65 typedef __socklen_t socklen_t; 66 #endif 67 68 69 /* 70 * Types 71 */ 72 #define SOCK_STREAM 1 /* stream socket */ 73 #define SOCK_DGRAM 2 /* datagram socket */ 74 #define SOCK_RAW 3 /* raw-protocol interface */ 75 #define SOCK_RDM 4 /* reliably-delivered message */ 76 #define SOCK_SEQPACKET 5 /* sequenced packet stream */ 77 78 /* 79 * Creation flags, OR'ed into socket() and socketpair() type argument. 80 */ 81 #define SOCK_CLOEXEC 0x10000000 82 #define SOCK_NONBLOCK 0x20000000 83 #ifdef _KERNEL 84 /* 85 * For kern_accept(): don't inherit FNONBLOCK or FASYNC. 86 */ 87 #define SOCK_KERN_NOINHERIT 0x00100000 88 #endif 89 90 /* 91 * Option flags per-socket. 92 */ 93 #define SO_DEBUG 0x0001 /* turn on debugging info recording */ 94 #define SO_ACCEPTCONN 0x0002 /* socket has had listen() */ 95 #define SO_REUSEADDR 0x0004 /* allow local address reuse */ 96 #define SO_KEEPALIVE 0x0008 /* keep connections alive */ 97 #define SO_DONTROUTE 0x0010 /* just use interface addresses */ 98 #define SO_BROADCAST 0x0020 /* permit sending of broadcast msgs */ 99 #define SO_USELOOPBACK 0x0040 /* bypass hardware when possible */ 100 #define SO_LINGER 0x0080 /* linger on close if data present */ 101 #define SO_OOBINLINE 0x0100 /* leave received OOB data in line */ 102 #define SO_REUSEPORT 0x0200 /* allow local address & port reuse */ 103 #define SO_TIMESTAMP 0x0400 /* timestamp received dgram traffic */ 104 #define SO_NOSIGPIPE 0x0800 /* no SIGPIPE from EPIPE */ 105 #define SO_ACCEPTFILTER 0x1000 /* there is an accept filter */ 106 107 /* 108 * Additional options, not kept in so_options. 109 */ 110 #define SO_SNDBUF 0x1001 /* send buffer size */ 111 #define SO_RCVBUF 0x1002 /* receive buffer size */ 112 #define SO_SNDLOWAT 0x1003 /* send low-water mark */ 113 #define SO_RCVLOWAT 0x1004 /* receive low-water mark */ 114 #define SO_SNDTIMEO 0x1005 /* send timeout */ 115 #define SO_RCVTIMEO 0x1006 /* receive timeout */ 116 #define SO_ERROR 0x1007 /* get error status and clear */ 117 #define SO_TYPE 0x1008 /* get socket type */ 118 /* 0x1009 reserved for FreeBSD compat */ 119 #define SO_SNDSPACE 0x100a /* get appr. send buffer free space */ 120 /* 0x1010 ~ 0x102f reserved for FreeBSD compat */ 121 #define SO_CPUHINT 0x1030 /* get socket's owner cpuid hint */ 122 123 /* 124 * Structure used for manipulating linger option. 125 */ 126 struct linger { 127 int l_onoff; /* option on/off */ 128 int l_linger; /* linger time */ 129 }; 130 131 struct accept_filter_arg { 132 char af_name[16]; 133 char af_arg[256-16]; 134 }; 135 136 /* 137 * Level number for (get/set)sockopt() to apply to socket itself. 138 */ 139 #define SOL_SOCKET 0xffff /* options for socket level */ 140 141 /* 142 * Address families. 143 */ 144 #define AF_UNSPEC 0 /* unspecified */ 145 #define AF_LOCAL 1 /* local to host (pipes, portals) */ 146 #define AF_UNIX AF_LOCAL /* backward compatibility */ 147 #define AF_INET 2 /* internetwork: UDP, TCP, etc. */ 148 #define AF_IMPLINK 3 /* arpanet imp addresses */ 149 #define AF_PUP 4 /* pup protocols: e.g. BSP */ 150 #define AF_CHAOS 5 /* mit CHAOS protocols */ 151 #define AF_NETBIOS 6 /* SMB protocols */ 152 #define AF_ISO 7 /* ISO protocols */ 153 #define AF_OSI AF_ISO 154 #define AF_ECMA 8 /* European computer manufacturers */ 155 #define AF_DATAKIT 9 /* datakit protocols */ 156 #define AF_CCITT 10 /* CCITT protocols, X.25 etc */ 157 #define AF_SNA 11 /* IBM SNA */ 158 #define AF_DECnet 12 /* DECnet */ 159 #define AF_DLI 13 /* DEC Direct data link interface */ 160 #define AF_LAT 14 /* LAT */ 161 #define AF_HYLINK 15 /* NSC Hyperchannel */ 162 #define AF_APPLETALK 16 /* Apple Talk */ 163 #define AF_ROUTE 17 /* Internal Routing Protocol */ 164 #define AF_LINK 18 /* Link layer interface */ 165 #define pseudo_AF_XTP 19 /* eXpress Transfer Protocol (no AF) */ 166 #define AF_COIP 20 /* connection-oriented IP, aka ST II */ 167 #define AF_CNT 21 /* Computer Network Technology */ 168 #define pseudo_AF_RTIP 22 /* Help Identify RTIP packets */ 169 #define AF_IPX 23 /* Novell Internet Protocol */ 170 #define AF_SIP 24 /* Simple Internet Protocol */ 171 #define pseudo_AF_PIP 25 /* Help Identify PIP packets */ 172 #define AF_ISDN 26 /* Integrated Services Digital Network*/ 173 #define AF_E164 AF_ISDN /* CCITT E.164 recommendation */ 174 #define pseudo_AF_KEY 27 /* Internal key-management function */ 175 #define AF_INET6 28 /* IPv6 */ 176 #define AF_NATM 29 /* native ATM access */ 177 #define AF_ATM 30 /* ATM */ 178 #define pseudo_AF_HDRCMPLT 31 /* Used by BPF to not rewrite headers 179 * in interface output routine 180 */ 181 #define AF_NETGRAPH 32 /* Netgraph sockets */ 182 #define AF_BLUETOOTH 33 /* Bluetooth */ 183 #define AF_MPLS 34 /* Multi-Protocol Label Switching */ 184 #define AF_IEEE80211 35 /* IEEE 802.11 protocol */ 185 186 #define AF_MAX 36 187 188 /* 189 * Structure used by kernel to store most 190 * addresses. 191 */ 192 struct sockaddr { 193 __uint8_t sa_len; /* total length */ 194 sa_family_t sa_family; /* address family */ 195 char sa_data[14]; /* actually longer; address value */ 196 }; 197 #define SOCK_MAXADDRLEN 255 /* longest possible addresses */ 198 199 #ifdef _KERNEL 200 201 #ifndef _SYS_LIBKERN_H_ 202 #include <sys/libkern.h> /* for bcmp() */ 203 #endif 204 205 static __inline boolean_t 206 sa_equal(const struct sockaddr *a1, const struct sockaddr *a2) 207 { 208 return (bcmp(a1, a2, a1->sa_len) == 0); 209 } 210 #endif 211 212 /* 213 * Structure used by kernel to pass protocol 214 * information in raw sockets. 215 */ 216 struct sockproto { 217 __uint16_t sp_family; /* address family */ 218 __uint16_t sp_protocol; /* protocol */ 219 }; 220 221 /* 222 * RFC 2553: protocol-independent placeholder for socket addresses 223 */ 224 #define _SS_MAXSIZE 128 225 #define _SS_ALIGNSIZE (sizeof(int64_t)) 226 #define _SS_PAD1SIZE (_SS_ALIGNSIZE - sizeof(unsigned char) - sizeof(sa_family_t)) 227 #define _SS_PAD2SIZE (_SS_MAXSIZE - sizeof(unsigned char) - sizeof(sa_family_t) - \ 228 _SS_PAD1SIZE - _SS_ALIGNSIZE) 229 230 struct sockaddr_storage { 231 __uint8_t ss_len; /* address length */ 232 sa_family_t ss_family; /* address family */ 233 char __ss_pad1[_SS_PAD1SIZE]; 234 __int64_t __ss_align; /* force desired structure storage alignment */ 235 char __ss_pad2[_SS_PAD2SIZE]; 236 }; 237 238 /* 239 * Protocol families, same as address families for now. 240 */ 241 #define PF_UNSPEC AF_UNSPEC 242 #define PF_LOCAL AF_LOCAL 243 #define PF_UNIX PF_LOCAL /* backward compatibility */ 244 #define PF_INET AF_INET 245 #define PF_IMPLINK AF_IMPLINK 246 #define PF_PUP AF_PUP 247 #define PF_CHAOS AF_CHAOS 248 #define PF_NETBIOS AF_NETBIOS 249 #define PF_ISO AF_ISO 250 #define PF_OSI AF_ISO 251 #define PF_ECMA AF_ECMA 252 #define PF_DATAKIT AF_DATAKIT 253 #define PF_CCITT AF_CCITT 254 #define PF_SNA AF_SNA 255 #define PF_DECnet AF_DECnet 256 #define PF_DLI AF_DLI 257 #define PF_LAT AF_LAT 258 #define PF_HYLINK AF_HYLINK 259 #define PF_APPLETALK AF_APPLETALK 260 #define PF_ROUTE AF_ROUTE 261 #define PF_LINK AF_LINK 262 #define PF_XTP pseudo_AF_XTP /* really just proto family, no AF */ 263 #define PF_COIP AF_COIP 264 #define PF_CNT AF_CNT 265 #define PF_SIP AF_SIP 266 #define PF_IPX AF_IPX /* same format as AF_NS */ 267 #define PF_RTIP pseudo_AF_RTIP /* same format as AF_INET */ 268 #define PF_PIP pseudo_AF_PIP 269 #define PF_ISDN AF_ISDN 270 #define PF_KEY pseudo_AF_KEY 271 #define PF_INET6 AF_INET6 272 #define PF_NATM AF_NATM 273 #define PF_ATM AF_ATM 274 #define PF_NETGRAPH AF_NETGRAPH 275 #define PF_BLUETOOTH AF_BLUETOOTH 276 277 #define PF_MAX AF_MAX 278 279 /* 280 * Definitions for network related sysctl, CTL_NET. 281 * 282 * Second level is protocol family. 283 * Third level is protocol number. 284 * 285 * Further levels are defined by the individual families below. 286 */ 287 #define NET_MAXID AF_MAX 288 289 #define CTL_NET_NAMES { \ 290 { 0, 0 }, \ 291 { "unix", CTLTYPE_NODE }, \ 292 { "inet", CTLTYPE_NODE }, \ 293 { "implink", CTLTYPE_NODE }, \ 294 { "pup", CTLTYPE_NODE }, \ 295 { "chaos", CTLTYPE_NODE }, \ 296 { "xerox_ns", CTLTYPE_NODE }, \ 297 { "iso", CTLTYPE_NODE }, \ 298 { "emca", CTLTYPE_NODE }, \ 299 { "datakit", CTLTYPE_NODE }, \ 300 { "ccitt", CTLTYPE_NODE }, \ 301 { "ibm_sna", CTLTYPE_NODE }, \ 302 { "decnet", CTLTYPE_NODE }, \ 303 { "dec_dli", CTLTYPE_NODE }, \ 304 { "lat", CTLTYPE_NODE }, \ 305 { "hylink", CTLTYPE_NODE }, \ 306 { "appletalk", CTLTYPE_NODE }, \ 307 { "route", CTLTYPE_NODE }, \ 308 { "link_layer", CTLTYPE_NODE }, \ 309 { "xtp", CTLTYPE_NODE }, \ 310 { "coip", CTLTYPE_NODE }, \ 311 { "cnt", CTLTYPE_NODE }, \ 312 { "rtip", CTLTYPE_NODE }, \ 313 { "ipx", CTLTYPE_NODE }, \ 314 { "sip", CTLTYPE_NODE }, \ 315 { "pip", CTLTYPE_NODE }, \ 316 { "isdn", CTLTYPE_NODE }, \ 317 { "key", CTLTYPE_NODE }, \ 318 { "inet6", CTLTYPE_NODE }, \ 319 { "natm", CTLTYPE_NODE }, \ 320 { "atm", CTLTYPE_NODE }, \ 321 { "hdrcomplete", CTLTYPE_NODE }, \ 322 { "netgraph", CTLTYPE_NODE }, \ 323 { "bluetooth", CTLTYPE_NODE}, \ 324 } 325 326 /* 327 * PF_ROUTE - Routing table 328 * 329 * Three additional levels are defined: 330 * Fourth: address family, 0 is wildcard 331 * Fifth: type of info, defined below 332 * Sixth: flag(s) to mask with for NET_RT_FLAGS 333 */ 334 #define NET_RT_DUMP 1 /* dump; may limit to a.f. */ 335 #define NET_RT_FLAGS 2 /* by flags, e.g. RESOLVING */ 336 #define NET_RT_IFLIST 3 /* survey interface list */ 337 #define NET_RT_MAXID 4 338 339 #define CTL_NET_RT_NAMES { \ 340 { 0, 0 }, \ 341 { "dump", CTLTYPE_STRUCT }, \ 342 { "flags", CTLTYPE_STRUCT }, \ 343 { "iflist", CTLTYPE_STRUCT }, \ 344 } 345 346 /* 347 * Maximum queue length specifiable by listen. 348 */ 349 #define SOMAXCONN 128 350 351 /* 352 * Maximum setsockopt buffer size 353 */ 354 #define SOMAXOPT_SIZE 65536 355 356 /* 357 * Message header for recvmsg and sendmsg calls. 358 * Used value-result for recvmsg, value only for sendmsg. 359 */ 360 struct msghdr { 361 void *msg_name; /* optional address */ 362 socklen_t msg_namelen; /* size of address */ 363 struct iovec *msg_iov; /* scatter/gather array */ 364 int msg_iovlen; /* # elements in msg_iov */ 365 void *msg_control; /* ancillary data, see below */ 366 socklen_t msg_controllen; /* ancillary data buffer len */ 367 int msg_flags; /* flags on received message */ 368 }; 369 370 #define MSG_OOB 0x00000001 /* process out-of-band data */ 371 #define MSG_PEEK 0x00000002 /* peek at incoming message */ 372 #define MSG_DONTROUTE 0x00000004 /* send without using routing tables */ 373 #define MSG_EOR 0x00000008 /* data completes record */ 374 #define MSG_TRUNC 0x00000010 /* data discarded before delivery */ 375 #define MSG_CTRUNC 0x00000020 /* control data lost before delivery */ 376 #define MSG_WAITALL 0x00000040 /* wait for full request or error */ 377 #define MSG_DONTWAIT 0x00000080 /* this message should be nonblocking */ 378 #define MSG_EOF 0x00000100 /* data completes connection */ 379 #define MSG_UNUSED09 0x00000200 /* was: notification message (SCTP) */ 380 #define MSG_NOSIGNAL 0x00000400 /* No SIGPIPE to unconnected socket stream */ 381 #define MSG_SYNC 0x00000800 /* No asynchronized pru_send */ 382 #define MSG_CMSG_CLOEXEC 0x00001000 /* make received fds close-on-exec */ 383 /* 0x2000 unused */ 384 /* 0x4000 unused */ 385 /* 0x8000 unused */ 386 /* 387 * These override FIONBIO. MSG_FNONBLOCKING is functionally equivalent to 388 * MSG_DONTWAIT. 389 */ 390 #define MSG_FBLOCKING 0x00010000 /* force blocking operation */ 391 #define MSG_FNONBLOCKING 0x00020000 /* force non-blocking operation */ 392 #define MSG_FMASK 0xFFFF0000 /* force mask */ 393 394 /* 395 * Header for ancillary data objects in msg_control buffer. 396 * Used for additional information with/about a datagram 397 * not expressible by flags. The format is a sequence 398 * of message elements headed by cmsghdr structures. 399 */ 400 struct cmsghdr { 401 socklen_t cmsg_len; /* data byte count, including hdr */ 402 int cmsg_level; /* originating protocol */ 403 int cmsg_type; /* protocol-specific type */ 404 /* followed by u_char cmsg_data[]; */ 405 }; 406 407 /* 408 * While we may have more groups than this, the cmsgcred struct must 409 * be able to fit in an mbuf, and NGROUPS_MAX is too large to allow 410 * this. 411 */ 412 #define CMGROUP_MAX 16 413 414 /* 415 * Credentials structure, used to verify the identity of a peer 416 * process that has sent us a message. This is allocated by the 417 * peer process but filled in by the kernel. This prevents the 418 * peer from lying about its identity. (Note that cmcred_groups[0] 419 * is the effective GID.) 420 */ 421 struct cmsgcred { 422 pid_t cmcred_pid; /* PID of sending process */ 423 uid_t cmcred_uid; /* real UID of sending process */ 424 uid_t cmcred_euid; /* effective UID of sending process */ 425 gid_t cmcred_gid; /* real GID of sending process */ 426 short cmcred_ngroups; /* number or groups */ 427 gid_t cmcred_groups[CMGROUP_MAX]; /* groups */ 428 }; 429 430 /* Alignment requirement for CMSG struct manipulation */ 431 #define _CMSG_ALIGN(n) (((n) + 3) & ~3) 432 433 #ifdef _KERNEL 434 #define CMSG_ALIGN(n) _CMSG_ALIGN(n) 435 #endif 436 437 /* given pointer to struct cmsghdr, return pointer to data */ 438 #define CMSG_DATA(cmsg) ((unsigned char *)(cmsg) + \ 439 _CMSG_ALIGN(sizeof(struct cmsghdr))) 440 441 /* given pointer to struct cmsghdr, return pointer to next cmsghdr */ 442 #define CMSG_NXTHDR(mhdr, cmsg) \ 443 (((caddr_t)(cmsg) + _CMSG_ALIGN((cmsg)->cmsg_len) + \ 444 _CMSG_ALIGN(sizeof(struct cmsghdr)) > \ 445 (caddr_t)(mhdr)->msg_control + (mhdr)->msg_controllen) ? \ 446 NULL : \ 447 (struct cmsghdr *)((caddr_t)(cmsg) + _CMSG_ALIGN((cmsg)->cmsg_len))) 448 449 /* 450 * RFC 2292 requires to check msg_controllen, in case that the kernel returns 451 * an empty list for some reasons. 452 */ 453 #define CMSG_FIRSTHDR(mhdr) \ 454 ((mhdr)->msg_controllen >= sizeof(struct cmsghdr) ? \ 455 (struct cmsghdr *)(mhdr)->msg_control : \ 456 NULL) 457 458 /* RFC 2292 additions */ 459 460 #define CMSG_SPACE(l) (_CMSG_ALIGN(sizeof(struct cmsghdr)) + _CMSG_ALIGN(l)) 461 #define CMSG_LEN(l) (_CMSG_ALIGN(sizeof(struct cmsghdr)) + (l)) 462 463 /* "Socket"-level control message types: */ 464 #define SCM_RIGHTS 0x01 /* access rights (array of int) */ 465 #define SCM_TIMESTAMP 0x02 /* timestamp (struct timeval) */ 466 #define SCM_CREDS 0x03 /* process creds (struct cmsgcred) */ 467 468 /* 469 * howto arguments for shutdown(2), specified by Posix.1g. 470 */ 471 #define SHUT_RD 0 /* shut down the reading side */ 472 #define SHUT_WR 1 /* shut down the writing side */ 473 #define SHUT_RDWR 2 /* shut down both sides */ 474 475 /* 476 * sendfile(2) header/trailer struct 477 */ 478 struct sf_hdtr { 479 struct iovec *headers; /* pointer to an array of header struct iovec's */ 480 int hdr_cnt; /* number of header iovec's */ 481 struct iovec *trailers; /* pointer to an array of trailer struct iovec's */ 482 int trl_cnt; /* number of trailer iovec's */ 483 }; 484 485 #if !defined(_KERNEL) || defined(_KERNEL_VIRTUAL) 486 487 __BEGIN_DECLS 488 int accept(int, struct sockaddr *, socklen_t *); 489 int accept4(int, struct sockaddr *, socklen_t *, int); 490 int extaccept(int, int, struct sockaddr *, socklen_t *); 491 int bind(int, const struct sockaddr *, socklen_t); 492 int connect(int, const struct sockaddr *, socklen_t); 493 int extconnect(int, int, struct sockaddr *, socklen_t); 494 int getpeername(int, struct sockaddr *, socklen_t *); 495 int getsockname(int, struct sockaddr *, socklen_t *); 496 int getsockopt(int, int, int, void *, socklen_t *); 497 int listen(int, int); 498 ssize_t recv(int, void *, size_t, int); 499 ssize_t recvfrom(int, void *, size_t, int, struct sockaddr *, socklen_t *); 500 ssize_t recvmsg(int, struct msghdr *, int); 501 ssize_t send(int, const void *, size_t, int); 502 ssize_t sendto(int, const void *, 503 size_t, int, const struct sockaddr *, socklen_t); 504 ssize_t sendmsg(int, const struct msghdr *, int); 505 int sendfile(int, int, off_t, size_t, struct sf_hdtr *, off_t *, int); 506 int setsockopt(int, int, int, const void *, socklen_t); 507 int shutdown(int, int); 508 int sockatmark(int); 509 int socket(int, int, int); 510 int socketpair(int, int, int, int *); 511 512 void pfctlinput(int, struct sockaddr *); 513 __END_DECLS 514 515 #endif /* !_KERNEL || _KERNEL_VIRTUAL */ 516 517 #endif /* !_SYS_SOCKET_H_ */ 518