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