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