1 /*- 2 * SPDX-License-Identifier: BSD-3-Clause 3 * 4 * Copyright (c) 1982, 1985, 1986, 1988, 1993, 1994 5 * The Regents of the University of California. All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 3. Neither the name of the University nor the names of its contributors 16 * may be used to endorse or promote products derived from this software 17 * without specific prior written permission. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29 * SUCH DAMAGE. 30 * 31 * @(#)socket.h 8.4 (Berkeley) 2/21/94 32 * $FreeBSD$ 33 */ 34 35 #ifndef _SYS_SOCKET_H_ 36 #define _SYS_SOCKET_H_ 37 38 #include <sys/cdefs.h> 39 #include <sys/_types.h> 40 #include <sys/_iovec.h> 41 #include <machine/_align.h> 42 43 /* 44 * Definitions related to sockets: types, address families, options. 45 */ 46 47 /* 48 * Data types. 49 */ 50 #if __BSD_VISIBLE 51 #ifndef _GID_T_DECLARED 52 typedef __gid_t gid_t; 53 #define _GID_T_DECLARED 54 #endif 55 56 #ifndef _OFF_T_DECLARED 57 typedef __off_t off_t; 58 #define _OFF_T_DECLARED 59 #endif 60 61 #ifndef _PID_T_DECLARED 62 typedef __pid_t pid_t; 63 #define _PID_T_DECLARED 64 #endif 65 #endif 66 67 #ifndef _SA_FAMILY_T_DECLARED 68 typedef __sa_family_t sa_family_t; 69 #define _SA_FAMILY_T_DECLARED 70 #endif 71 72 #ifndef _SOCKLEN_T_DECLARED 73 typedef __socklen_t socklen_t; 74 #define _SOCKLEN_T_DECLARED 75 #endif 76 77 #ifndef _SSIZE_T_DECLARED 78 typedef __ssize_t ssize_t; 79 #define _SSIZE_T_DECLARED 80 #endif 81 82 #if __BSD_VISIBLE 83 #ifndef _UID_T_DECLARED 84 typedef __uid_t uid_t; 85 #define _UID_T_DECLARED 86 #endif 87 #endif 88 89 #ifndef _UINT32_T_DECLARED 90 typedef __uint32_t uint32_t; 91 #define _UINT32_T_DECLARED 92 #endif 93 94 #ifndef _UINTPTR_T_DECLARED 95 typedef __uintptr_t uintptr_t; 96 #define _UINTPTR_T_DECLARED 97 #endif 98 99 /* 100 * Types 101 */ 102 #define SOCK_STREAM 1 /* stream socket */ 103 #define SOCK_DGRAM 2 /* datagram socket */ 104 #define SOCK_RAW 3 /* raw-protocol interface */ 105 #if __BSD_VISIBLE 106 #define SOCK_RDM 4 /* reliably-delivered message */ 107 #endif 108 #define SOCK_SEQPACKET 5 /* sequenced packet stream */ 109 110 #if __BSD_VISIBLE 111 /* 112 * Creation flags, OR'ed into socket() and socketpair() type argument. 113 */ 114 #define SOCK_CLOEXEC 0x10000000 115 #define SOCK_NONBLOCK 0x20000000 116 #ifdef _KERNEL 117 /* 118 * Flags for accept1(), kern_accept4() and solisten_dequeue, in addition 119 * to SOCK_CLOEXEC and SOCK_NONBLOCK. 120 */ 121 #define ACCEPT4_INHERIT 0x1 122 #define ACCEPT4_COMPAT 0x2 123 #endif /* _KERNEL */ 124 #endif /* __BSD_VISIBLE */ 125 126 /* 127 * Option flags per-socket. 128 */ 129 #define SO_DEBUG 0x0001 /* turn on debugging info recording */ 130 #define SO_ACCEPTCONN 0x0002 /* socket has had listen() */ 131 #define SO_REUSEADDR 0x0004 /* allow local address reuse */ 132 #define SO_KEEPALIVE 0x0008 /* keep connections alive */ 133 #define SO_DONTROUTE 0x0010 /* just use interface addresses */ 134 #define SO_BROADCAST 0x0020 /* permit sending of broadcast msgs */ 135 #if __BSD_VISIBLE 136 #define SO_USELOOPBACK 0x0040 /* bypass hardware when possible */ 137 #endif 138 #define SO_LINGER 0x0080 /* linger on close if data present */ 139 #define SO_OOBINLINE 0x0100 /* leave received OOB data in line */ 140 #if __BSD_VISIBLE 141 #define SO_REUSEPORT 0x0200 /* allow local address & port reuse */ 142 #define SO_TIMESTAMP 0x0400 /* timestamp received dgram traffic */ 143 #define SO_NOSIGPIPE 0x0800 /* no SIGPIPE from EPIPE */ 144 #define SO_ACCEPTFILTER 0x1000 /* there is an accept filter */ 145 #define SO_BINTIME 0x2000 /* timestamp received dgram traffic */ 146 #endif 147 #define SO_NO_OFFLOAD 0x4000 /* socket cannot be offloaded */ 148 #define SO_NO_DDP 0x8000 /* disable direct data placement */ 149 150 /* 151 * Additional options, not kept in so_options. 152 */ 153 #define SO_SNDBUF 0x1001 /* send buffer size */ 154 #define SO_RCVBUF 0x1002 /* receive buffer size */ 155 #define SO_SNDLOWAT 0x1003 /* send low-water mark */ 156 #define SO_RCVLOWAT 0x1004 /* receive low-water mark */ 157 #define SO_SNDTIMEO 0x1005 /* send timeout */ 158 #define SO_RCVTIMEO 0x1006 /* receive timeout */ 159 #define SO_ERROR 0x1007 /* get error status and clear */ 160 #define SO_TYPE 0x1008 /* get socket type */ 161 #if __BSD_VISIBLE 162 #define SO_LABEL 0x1009 /* socket's MAC label */ 163 #define SO_PEERLABEL 0x1010 /* socket's peer's MAC label */ 164 #define SO_LISTENQLIMIT 0x1011 /* socket's backlog limit */ 165 #define SO_LISTENQLEN 0x1012 /* socket's complete queue length */ 166 #define SO_LISTENINCQLEN 0x1013 /* socket's incomplete queue length */ 167 #define SO_SETFIB 0x1014 /* use this FIB to route */ 168 #define SO_USER_COOKIE 0x1015 /* user cookie (dummynet etc.) */ 169 #define SO_PROTOCOL 0x1016 /* get socket protocol (Linux name) */ 170 #define SO_PROTOTYPE SO_PROTOCOL /* alias for SO_PROTOCOL (SunOS name) */ 171 #define SO_TS_CLOCK 0x1017 /* clock type used for SO_TIMESTAMP */ 172 #define SO_MAX_PACING_RATE 0x1018 /* socket's max TX pacing rate (Linux name) */ 173 #endif 174 175 #if __BSD_VISIBLE 176 #define SO_TS_REALTIME_MICRO 0 /* microsecond resolution, realtime */ 177 #define SO_TS_BINTIME 1 /* sub-nanosecond resolution, realtime */ 178 #define SO_TS_REALTIME 2 /* nanosecond resolution, realtime */ 179 #define SO_TS_MONOTONIC 3 /* nanosecond resolution, monotonic */ 180 #define SO_TS_DEFAULT SO_TS_REALTIME_MICRO 181 #define SO_TS_CLOCK_MAX SO_TS_MONOTONIC 182 #endif 183 184 /* 185 * Space reserved for new socket options added by third-party vendors. 186 * This range applies to all socket option levels. New socket options 187 * in FreeBSD should always use an option value less than SO_VENDOR. 188 */ 189 #if __BSD_VISIBLE 190 #define SO_VENDOR 0x80000000 191 #endif 192 193 /* 194 * Structure used for manipulating linger option. 195 */ 196 struct linger { 197 int l_onoff; /* option on/off */ 198 int l_linger; /* linger time */ 199 }; 200 201 #if __BSD_VISIBLE 202 struct accept_filter_arg { 203 char af_name[16]; 204 char af_arg[256-16]; 205 }; 206 #endif 207 208 /* 209 * Level number for (get/set)sockopt() to apply to socket itself. 210 */ 211 #define SOL_SOCKET 0xffff /* options for socket level */ 212 213 /* 214 * Address families. 215 */ 216 #define AF_UNSPEC 0 /* unspecified */ 217 #if __BSD_VISIBLE 218 #define AF_LOCAL AF_UNIX /* local to host (pipes, portals) */ 219 #endif 220 #define AF_UNIX 1 /* standardized name for AF_LOCAL */ 221 #define AF_INET 2 /* internetwork: UDP, TCP, etc. */ 222 #if __BSD_VISIBLE 223 #define AF_IMPLINK 3 /* arpanet imp addresses */ 224 #define AF_PUP 4 /* pup protocols: e.g. BSP */ 225 #define AF_CHAOS 5 /* mit CHAOS protocols */ 226 #define AF_NETBIOS 6 /* SMB protocols */ 227 #define AF_ISO 7 /* ISO protocols */ 228 #define AF_OSI AF_ISO 229 #define AF_ECMA 8 /* European computer manufacturers */ 230 #define AF_DATAKIT 9 /* datakit protocols */ 231 #define AF_CCITT 10 /* CCITT protocols, X.25 etc */ 232 #define AF_SNA 11 /* IBM SNA */ 233 #define AF_DECnet 12 /* DECnet */ 234 #define AF_DLI 13 /* DEC Direct data link interface */ 235 #define AF_LAT 14 /* LAT */ 236 #define AF_HYLINK 15 /* NSC Hyperchannel */ 237 #define AF_APPLETALK 16 /* Apple Talk */ 238 #define AF_ROUTE 17 /* Internal Routing Protocol */ 239 #define AF_LINK 18 /* Link layer interface */ 240 #define pseudo_AF_XTP 19 /* eXpress Transfer Protocol (no AF) */ 241 #define AF_COIP 20 /* connection-oriented IP, aka ST II */ 242 #define AF_CNT 21 /* Computer Network Technology */ 243 #define pseudo_AF_RTIP 22 /* Help Identify RTIP packets */ 244 #define AF_IPX 23 /* Novell Internet Protocol */ 245 #define AF_SIP 24 /* Simple Internet Protocol */ 246 #define pseudo_AF_PIP 25 /* Help Identify PIP packets */ 247 #define AF_ISDN 26 /* Integrated Services Digital Network*/ 248 #define AF_E164 AF_ISDN /* CCITT E.164 recommendation */ 249 #define pseudo_AF_KEY 27 /* Internal key-management function */ 250 #endif 251 #define AF_INET6 28 /* IPv6 */ 252 #if __BSD_VISIBLE 253 #define AF_NATM 29 /* native ATM access */ 254 #define AF_ATM 30 /* ATM */ 255 #define pseudo_AF_HDRCMPLT 31 /* Used by BPF to not rewrite headers 256 * in interface output routine 257 */ 258 #define AF_NETGRAPH 32 /* Netgraph sockets */ 259 #define AF_SLOW 33 /* 802.3ad slow protocol */ 260 #define AF_SCLUSTER 34 /* Sitara cluster protocol */ 261 #define AF_ARP 35 262 #define AF_BLUETOOTH 36 /* Bluetooth sockets */ 263 #define AF_IEEE80211 37 /* IEEE 802.11 protocol */ 264 #define AF_INET_SDP 40 /* OFED Socket Direct Protocol ipv4 */ 265 #define AF_INET6_SDP 42 /* OFED Socket Direct Protocol ipv6 */ 266 #define AF_MAX 42 267 /* 268 * When allocating a new AF_ constant, please only allocate 269 * even numbered constants for FreeBSD until 134 as odd numbered AF_ 270 * constants 39-133 are now reserved for vendors. 271 */ 272 #define AF_VENDOR00 39 273 #define AF_VENDOR01 41 274 #define AF_VENDOR02 43 275 #define AF_VENDOR03 45 276 #define AF_VENDOR04 47 277 #define AF_VENDOR05 49 278 #define AF_VENDOR06 51 279 #define AF_VENDOR07 53 280 #define AF_VENDOR08 55 281 #define AF_VENDOR09 57 282 #define AF_VENDOR10 59 283 #define AF_VENDOR11 61 284 #define AF_VENDOR12 63 285 #define AF_VENDOR13 65 286 #define AF_VENDOR14 67 287 #define AF_VENDOR15 69 288 #define AF_VENDOR16 71 289 #define AF_VENDOR17 73 290 #define AF_VENDOR18 75 291 #define AF_VENDOR19 77 292 #define AF_VENDOR20 79 293 #define AF_VENDOR21 81 294 #define AF_VENDOR22 83 295 #define AF_VENDOR23 85 296 #define AF_VENDOR24 87 297 #define AF_VENDOR25 89 298 #define AF_VENDOR26 91 299 #define AF_VENDOR27 93 300 #define AF_VENDOR28 95 301 #define AF_VENDOR29 97 302 #define AF_VENDOR30 99 303 #define AF_VENDOR31 101 304 #define AF_VENDOR32 103 305 #define AF_VENDOR33 105 306 #define AF_VENDOR34 107 307 #define AF_VENDOR35 109 308 #define AF_VENDOR36 111 309 #define AF_VENDOR37 113 310 #define AF_VENDOR38 115 311 #define AF_VENDOR39 117 312 #define AF_VENDOR40 119 313 #define AF_VENDOR41 121 314 #define AF_VENDOR42 123 315 #define AF_VENDOR43 125 316 #define AF_VENDOR44 127 317 #define AF_VENDOR45 129 318 #define AF_VENDOR46 131 319 #define AF_VENDOR47 133 320 #endif 321 322 /* 323 * Structure used by kernel to store most 324 * addresses. 325 */ 326 struct sockaddr { 327 unsigned char sa_len; /* total length */ 328 sa_family_t sa_family; /* address family */ 329 char sa_data[14]; /* actually longer; address value */ 330 }; 331 #if __BSD_VISIBLE 332 #define SOCK_MAXADDRLEN 255 /* longest possible addresses */ 333 334 /* 335 * Structure used by kernel to pass protocol 336 * information in raw sockets. 337 */ 338 struct sockproto { 339 unsigned short sp_family; /* address family */ 340 unsigned short sp_protocol; /* protocol */ 341 }; 342 #endif 343 344 #include <sys/_sockaddr_storage.h> 345 346 #if __BSD_VISIBLE 347 /* 348 * Protocol families, same as address families for now. 349 */ 350 #define PF_UNSPEC AF_UNSPEC 351 #define PF_LOCAL AF_LOCAL 352 #define PF_UNIX PF_LOCAL /* backward compatibility */ 353 #define PF_INET AF_INET 354 #define PF_IMPLINK AF_IMPLINK 355 #define PF_PUP AF_PUP 356 #define PF_CHAOS AF_CHAOS 357 #define PF_NETBIOS AF_NETBIOS 358 #define PF_ISO AF_ISO 359 #define PF_OSI AF_ISO 360 #define PF_ECMA AF_ECMA 361 #define PF_DATAKIT AF_DATAKIT 362 #define PF_CCITT AF_CCITT 363 #define PF_SNA AF_SNA 364 #define PF_DECnet AF_DECnet 365 #define PF_DLI AF_DLI 366 #define PF_LAT AF_LAT 367 #define PF_HYLINK AF_HYLINK 368 #define PF_APPLETALK AF_APPLETALK 369 #define PF_ROUTE AF_ROUTE 370 #define PF_LINK AF_LINK 371 #define PF_XTP pseudo_AF_XTP /* really just proto family, no AF */ 372 #define PF_COIP AF_COIP 373 #define PF_CNT AF_CNT 374 #define PF_SIP AF_SIP 375 #define PF_IPX AF_IPX 376 #define PF_RTIP pseudo_AF_RTIP /* same format as AF_INET */ 377 #define PF_PIP pseudo_AF_PIP 378 #define PF_ISDN AF_ISDN 379 #define PF_KEY pseudo_AF_KEY 380 #define PF_INET6 AF_INET6 381 #define PF_NATM AF_NATM 382 #define PF_ATM AF_ATM 383 #define PF_NETGRAPH AF_NETGRAPH 384 #define PF_SLOW AF_SLOW 385 #define PF_SCLUSTER AF_SCLUSTER 386 #define PF_ARP AF_ARP 387 #define PF_BLUETOOTH AF_BLUETOOTH 388 #define PF_IEEE80211 AF_IEEE80211 389 #define PF_INET_SDP AF_INET_SDP 390 #define PF_INET6_SDP AF_INET6_SDP 391 392 #define PF_MAX AF_MAX 393 394 /* 395 * Definitions for network related sysctl, CTL_NET. 396 * 397 * Second level is protocol family. 398 * Third level is protocol number. 399 * 400 * Further levels are defined by the individual families. 401 */ 402 403 /* 404 * PF_ROUTE - Routing table 405 * 406 * Three additional levels are defined: 407 * Fourth: address family, 0 is wildcard 408 * Fifth: type of info, defined below 409 * Sixth: flag(s) to mask with for NET_RT_FLAGS 410 */ 411 #define NET_RT_DUMP 1 /* dump; may limit to a.f. */ 412 #define NET_RT_FLAGS 2 /* by flags, e.g. RESOLVING */ 413 #define NET_RT_IFLIST 3 /* survey interface list */ 414 #define NET_RT_IFMALIST 4 /* return multicast address list */ 415 #define NET_RT_IFLISTL 5 /* Survey interface list, using 'l'en 416 * versions of msghdr structs. */ 417 #endif /* __BSD_VISIBLE */ 418 419 /* 420 * Maximum queue length specifiable by listen. 421 */ 422 #define SOMAXCONN 128 423 424 /* 425 * Message header for recvmsg and sendmsg calls. 426 * Used value-result for recvmsg, value only for sendmsg. 427 */ 428 struct msghdr { 429 void *msg_name; /* optional address */ 430 socklen_t msg_namelen; /* size of address */ 431 struct iovec *msg_iov; /* scatter/gather array */ 432 int msg_iovlen; /* # elements in msg_iov */ 433 void *msg_control; /* ancillary data, see below */ 434 socklen_t msg_controllen; /* ancillary data buffer len */ 435 int msg_flags; /* flags on received message */ 436 }; 437 438 #define MSG_OOB 0x00000001 /* process out-of-band data */ 439 #define MSG_PEEK 0x00000002 /* peek at incoming message */ 440 #define MSG_DONTROUTE 0x00000004 /* send without using routing tables */ 441 #define MSG_EOR 0x00000008 /* data completes record */ 442 #define MSG_TRUNC 0x00000010 /* data discarded before delivery */ 443 #define MSG_CTRUNC 0x00000020 /* control data lost before delivery */ 444 #define MSG_WAITALL 0x00000040 /* wait for full request or error */ 445 #if __BSD_VISIBLE 446 #define MSG_DONTWAIT 0x00000080 /* this message should be nonblocking */ 447 #define MSG_EOF 0x00000100 /* data completes connection */ 448 /* 0x00000200 unused */ 449 /* 0x00000400 unused */ 450 /* 0x00000800 unused */ 451 /* 0x00001000 unused */ 452 #define MSG_NOTIFICATION 0x00002000 /* SCTP notification */ 453 #define MSG_NBIO 0x00004000 /* FIONBIO mode, used by fifofs */ 454 #define MSG_COMPAT 0x00008000 /* used in sendit() */ 455 #endif 456 #ifdef _KERNEL 457 #define MSG_SOCALLBCK 0x00010000 /* for use by socket callbacks - soreceive (TCP) */ 458 #endif 459 #if __POSIX_VISIBLE >= 200809 460 #define MSG_NOSIGNAL 0x00020000 /* do not generate SIGPIPE on EOF */ 461 #endif 462 #if __BSD_VISIBLE 463 #define MSG_CMSG_CLOEXEC 0x00040000 /* make received fds close-on-exec */ 464 #define MSG_WAITFORONE 0x00080000 /* for recvmmsg() */ 465 #endif 466 #ifdef _KERNEL 467 #define MSG_MORETOCOME 0x00100000 /* additional data pending */ 468 #endif 469 470 /* 471 * Header for ancillary data objects in msg_control buffer. 472 * Used for additional information with/about a datagram 473 * not expressible by flags. The format is a sequence 474 * of message elements headed by cmsghdr structures. 475 */ 476 struct cmsghdr { 477 socklen_t cmsg_len; /* data byte count, including hdr */ 478 int cmsg_level; /* originating protocol */ 479 int cmsg_type; /* protocol-specific type */ 480 /* followed by u_char cmsg_data[]; */ 481 }; 482 483 #if __BSD_VISIBLE 484 /* 485 * While we may have more groups than this, the cmsgcred struct must 486 * be able to fit in an mbuf and we have historically supported a 487 * maximum of 16 groups. 488 */ 489 #define CMGROUP_MAX 16 490 491 /* 492 * Credentials structure, used to verify the identity of a peer 493 * process that has sent us a message. This is allocated by the 494 * peer process but filled in by the kernel. This prevents the 495 * peer from lying about its identity. (Note that cmcred_groups[0] 496 * is the effective GID.) 497 */ 498 struct cmsgcred { 499 pid_t cmcred_pid; /* PID of sending process */ 500 uid_t cmcred_uid; /* real UID of sending process */ 501 uid_t cmcred_euid; /* effective UID of sending process */ 502 gid_t cmcred_gid; /* real GID of sending process */ 503 short cmcred_ngroups; /* number or groups */ 504 gid_t cmcred_groups[CMGROUP_MAX]; /* groups */ 505 }; 506 507 /* 508 * Socket credentials. 509 */ 510 struct sockcred { 511 uid_t sc_uid; /* real user id */ 512 uid_t sc_euid; /* effective user id */ 513 gid_t sc_gid; /* real group id */ 514 gid_t sc_egid; /* effective group id */ 515 int sc_ngroups; /* number of supplemental groups */ 516 gid_t sc_groups[1]; /* variable length */ 517 }; 518 519 /* 520 * Compute size of a sockcred structure with groups. 521 */ 522 #define SOCKCREDSIZE(ngrps) \ 523 (sizeof(struct sockcred) + (sizeof(gid_t) * ((ngrps) - 1))) 524 525 #endif /* __BSD_VISIBLE */ 526 527 /* given pointer to struct cmsghdr, return pointer to data */ 528 #define CMSG_DATA(cmsg) ((unsigned char *)(cmsg) + \ 529 _ALIGN(sizeof(struct cmsghdr))) 530 531 /* given pointer to struct cmsghdr, return pointer to next cmsghdr */ 532 #define CMSG_NXTHDR(mhdr, cmsg) \ 533 ((char *)(cmsg) == (char *)0 ? CMSG_FIRSTHDR(mhdr) : \ 534 ((char *)(cmsg) + _ALIGN(((struct cmsghdr *)(cmsg))->cmsg_len) + \ 535 _ALIGN(sizeof(struct cmsghdr)) > \ 536 (char *)(mhdr)->msg_control + (mhdr)->msg_controllen) ? \ 537 (struct cmsghdr *)0 : \ 538 (struct cmsghdr *)(void *)((char *)(cmsg) + \ 539 _ALIGN(((struct cmsghdr *)(cmsg))->cmsg_len))) 540 541 /* 542 * RFC 2292 requires to check msg_controllen, in case that the kernel returns 543 * an empty list for some reasons. 544 */ 545 #define CMSG_FIRSTHDR(mhdr) \ 546 ((mhdr)->msg_controllen >= sizeof(struct cmsghdr) ? \ 547 (struct cmsghdr *)(mhdr)->msg_control : \ 548 (struct cmsghdr *)0) 549 550 #if __BSD_VISIBLE 551 /* RFC 2292 additions */ 552 #define CMSG_SPACE(l) (_ALIGN(sizeof(struct cmsghdr)) + _ALIGN(l)) 553 #define CMSG_LEN(l) (_ALIGN(sizeof(struct cmsghdr)) + (l)) 554 #endif 555 556 #ifdef _KERNEL 557 #define CMSG_ALIGN(n) _ALIGN(n) 558 #endif 559 560 /* "Socket"-level control message types: */ 561 #define SCM_RIGHTS 0x01 /* access rights (array of int) */ 562 #if __BSD_VISIBLE 563 #define SCM_TIMESTAMP 0x02 /* timestamp (struct timeval) */ 564 #define SCM_CREDS 0x03 /* process creds (struct cmsgcred) */ 565 #define SCM_BINTIME 0x04 /* timestamp (struct bintime) */ 566 #define SCM_REALTIME 0x05 /* timestamp (struct timespec) */ 567 #define SCM_MONOTONIC 0x06 /* timestamp (struct timespec) */ 568 #define SCM_TIME_INFO 0x07 /* timestamp info */ 569 570 struct sock_timestamp_info { 571 __uint32_t st_info_flags; 572 __uint32_t st_info_pad0; 573 __uint64_t st_info_rsv[7]; 574 }; 575 576 #define ST_INFO_HW 0x0001 /* SCM_TIMESTAMP was hw */ 577 #define ST_INFO_HW_HPREC 0x0002 /* SCM_TIMESTAMP was hw-assisted 578 on entrance */ 579 #endif 580 581 #if __BSD_VISIBLE 582 /* 583 * 4.3 compat sockaddr, move to compat file later 584 */ 585 struct osockaddr { 586 unsigned short sa_family; /* address family */ 587 char sa_data[14]; /* up to 14 bytes of direct address */ 588 }; 589 590 /* 591 * 4.3-compat message header (move to compat file later). 592 */ 593 struct omsghdr { 594 char *msg_name; /* optional address */ 595 int msg_namelen; /* size of address */ 596 struct iovec *msg_iov; /* scatter/gather array */ 597 int msg_iovlen; /* # elements in msg_iov */ 598 char *msg_accrights; /* access rights sent/received */ 599 int msg_accrightslen; 600 }; 601 #endif 602 603 /* 604 * howto arguments for shutdown(2), specified by Posix.1g. 605 */ 606 #define SHUT_RD 0 /* shut down the reading side */ 607 #define SHUT_WR 1 /* shut down the writing side */ 608 #define SHUT_RDWR 2 /* shut down both sides */ 609 610 #if __BSD_VISIBLE 611 /* for SCTP */ 612 /* we cheat and use the SHUT_XX defines for these */ 613 #define PRU_FLUSH_RD SHUT_RD 614 #define PRU_FLUSH_WR SHUT_WR 615 #define PRU_FLUSH_RDWR SHUT_RDWR 616 #endif 617 618 619 #if __BSD_VISIBLE 620 /* 621 * sendfile(2) header/trailer struct 622 */ 623 struct sf_hdtr { 624 struct iovec *headers; /* pointer to an array of header struct iovec's */ 625 int hdr_cnt; /* number of header iovec's */ 626 struct iovec *trailers; /* pointer to an array of trailer struct iovec's */ 627 int trl_cnt; /* number of trailer iovec's */ 628 }; 629 630 /* 631 * Sendfile-specific flag(s) 632 */ 633 #define SF_NODISKIO 0x00000001 634 #define SF_MNOWAIT 0x00000002 /* obsolete */ 635 #define SF_SYNC 0x00000004 636 #define SF_USER_READAHEAD 0x00000008 637 #define SF_NOCACHE 0x00000010 638 #define SF_FLAGS(rh, flags) (((rh) << 16) | (flags)) 639 640 #ifdef _KERNEL 641 #define SF_READAHEAD(flags) ((flags) >> 16) 642 #endif /* _KERNEL */ 643 644 /* 645 * Sendmmsg/recvmmsg specific structure(s) 646 */ 647 struct mmsghdr { 648 struct msghdr msg_hdr; /* message header */ 649 ssize_t msg_len; /* message length */ 650 }; 651 #endif /* __BSD_VISIBLE */ 652 653 #ifndef _KERNEL 654 655 #include <sys/cdefs.h> 656 657 __BEGIN_DECLS 658 int accept(int, struct sockaddr * __restrict, socklen_t * __restrict); 659 int bind(int, const struct sockaddr *, socklen_t); 660 int connect(int, const struct sockaddr *, socklen_t); 661 #if __BSD_VISIBLE 662 int accept4(int, struct sockaddr * __restrict, socklen_t * __restrict, int); 663 int bindat(int, int, const struct sockaddr *, socklen_t); 664 int connectat(int, int, const struct sockaddr *, socklen_t); 665 #endif 666 int getpeername(int, struct sockaddr * __restrict, socklen_t * __restrict); 667 int getsockname(int, struct sockaddr * __restrict, socklen_t * __restrict); 668 int getsockopt(int, int, int, void * __restrict, socklen_t * __restrict); 669 int listen(int, int); 670 ssize_t recv(int, void *, size_t, int); 671 ssize_t recvfrom(int, void *, size_t, int, struct sockaddr * __restrict, socklen_t * __restrict); 672 ssize_t recvmsg(int, struct msghdr *, int); 673 #if __BSD_VISIBLE 674 struct timespec; 675 ssize_t recvmmsg(int, struct mmsghdr * __restrict, size_t, int, 676 const struct timespec * __restrict); 677 #endif 678 ssize_t send(int, const void *, size_t, int); 679 ssize_t sendto(int, const void *, 680 size_t, int, const struct sockaddr *, socklen_t); 681 ssize_t sendmsg(int, const struct msghdr *, int); 682 #if __BSD_VISIBLE 683 int sendfile(int, int, off_t, size_t, struct sf_hdtr *, off_t *, int); 684 ssize_t sendmmsg(int, struct mmsghdr * __restrict, size_t, int); 685 int setfib(int); 686 #endif 687 int setsockopt(int, int, int, const void *, socklen_t); 688 int shutdown(int, int); 689 int sockatmark(int); 690 int socket(int, int, int); 691 int socketpair(int, int, int, int *); 692 __END_DECLS 693 694 #endif /* !_KERNEL */ 695 696 #ifdef _KERNEL 697 struct socket; 698 699 struct tcpcb *so_sototcpcb(struct socket *so); 700 struct inpcb *so_sotoinpcb(struct socket *so); 701 struct sockbuf *so_sockbuf_snd(struct socket *); 702 struct sockbuf *so_sockbuf_rcv(struct socket *); 703 704 int so_state_get(const struct socket *); 705 void so_state_set(struct socket *, int); 706 707 int so_options_get(const struct socket *); 708 void so_options_set(struct socket *, int); 709 710 int so_error_get(const struct socket *); 711 void so_error_set(struct socket *, int); 712 713 int so_linger_get(const struct socket *); 714 void so_linger_set(struct socket *, int); 715 716 struct protosw *so_protosw_get(const struct socket *); 717 void so_protosw_set(struct socket *, struct protosw *); 718 719 void so_sorwakeup_locked(struct socket *so); 720 void so_sowwakeup_locked(struct socket *so); 721 722 void so_sorwakeup(struct socket *so); 723 void so_sowwakeup(struct socket *so); 724 725 void so_lock(struct socket *so); 726 void so_unlock(struct socket *so); 727 728 #endif /* _KERNEL */ 729 #endif /* !_SYS_SOCKET_H_ */ 730