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