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