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