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