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