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