xref: /xnu-11417.140.69/bsd/sys/vsock.h (revision 43a90889846e00bfb5cf1d255cdc0a701a1e05a4)
1*43a90889SApple OSS Distributions /*
2*43a90889SApple OSS Distributions  * Copyright (c) 2020 Apple Inc. All rights reserved.
3*43a90889SApple OSS Distributions  *
4*43a90889SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*43a90889SApple OSS Distributions  *
6*43a90889SApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*43a90889SApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*43a90889SApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*43a90889SApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*43a90889SApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*43a90889SApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*43a90889SApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*43a90889SApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*43a90889SApple OSS Distributions  *
15*43a90889SApple OSS Distributions  * Please obtain a copy of the License at
16*43a90889SApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*43a90889SApple OSS Distributions  *
18*43a90889SApple OSS Distributions  * The Original Code and all software distributed under the License are
19*43a90889SApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*43a90889SApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*43a90889SApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*43a90889SApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*43a90889SApple OSS Distributions  * Please see the License for the specific language governing rights and
24*43a90889SApple OSS Distributions  * limitations under the License.
25*43a90889SApple OSS Distributions  *
26*43a90889SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*43a90889SApple OSS Distributions  */
28*43a90889SApple OSS Distributions 
29*43a90889SApple OSS Distributions #ifndef _VSOCK_H_
30*43a90889SApple OSS Distributions #define _VSOCK_H_
31*43a90889SApple OSS Distributions 
32*43a90889SApple OSS Distributions #include <sys/cdefs.h>
33*43a90889SApple OSS Distributions 
34*43a90889SApple OSS Distributions #include <sys/_types/_sa_family_t.h>
35*43a90889SApple OSS Distributions #include <sys/ucred.h>
36*43a90889SApple OSS Distributions #include <sys/socketvar.h>
37*43a90889SApple OSS Distributions 
38*43a90889SApple OSS Distributions __BEGIN_DECLS
39*43a90889SApple OSS Distributions 
40*43a90889SApple OSS Distributions #define VMADDR_CID_ANY (-1U)
41*43a90889SApple OSS Distributions #define VMADDR_CID_HYPERVISOR 0
42*43a90889SApple OSS Distributions #define VMADDR_CID_RESERVED 1
43*43a90889SApple OSS Distributions #define VMADDR_CID_HOST 2
44*43a90889SApple OSS Distributions 
45*43a90889SApple OSS Distributions #define VMADDR_PORT_ANY (-1U)
46*43a90889SApple OSS Distributions 
47*43a90889SApple OSS Distributions #define IOCTL_VM_SOCKETS_GET_LOCAL_CID _IOR('s',  209, uint32_t)
48*43a90889SApple OSS Distributions 
49*43a90889SApple OSS Distributions struct sockaddr_vm {
50*43a90889SApple OSS Distributions 	__uint8_t      svm_len;        /* total length */
51*43a90889SApple OSS Distributions 	sa_family_t    svm_family;     /* Address family: AF_VSOCK */
52*43a90889SApple OSS Distributions 	__uint16_t     svm_reserved1;
53*43a90889SApple OSS Distributions 	__uint32_t     svm_port;       /* Port # in host byte order */
54*43a90889SApple OSS Distributions 	__uint32_t     svm_cid;        /* Address in host byte order */
55*43a90889SApple OSS Distributions } __attribute__((__packed__));
56*43a90889SApple OSS Distributions 
57*43a90889SApple OSS Distributions typedef u_quad_t vsock_gen_t;
58*43a90889SApple OSS Distributions 
59*43a90889SApple OSS Distributions struct xvsockpcb {
60*43a90889SApple OSS Distributions 	u_int32_t      xv_len;            /* length of this structure */
61*43a90889SApple OSS Distributions 	u_int64_t      xv_vsockpp;
62*43a90889SApple OSS Distributions 	u_int32_t      xvp_local_cid;     /* local address cid */
63*43a90889SApple OSS Distributions 	u_int32_t      xvp_local_port;    /* local address port */
64*43a90889SApple OSS Distributions 	u_int32_t      xvp_remote_cid;    /* remote address cid */
65*43a90889SApple OSS Distributions 	u_int32_t      xvp_remote_port;   /* remote address port */
66*43a90889SApple OSS Distributions 	u_int32_t      xvp_rxcnt;         /* bytes received */
67*43a90889SApple OSS Distributions 	u_int32_t      xvp_txcnt;         /* bytes transmitted */
68*43a90889SApple OSS Distributions 	u_int32_t      xvp_peer_rxhiwat;  /* peer's receive buffer */
69*43a90889SApple OSS Distributions 	u_int32_t      xvp_peer_rxcnt;    /* bytes received by peer */
70*43a90889SApple OSS Distributions 	pid_t          xvp_last_pid;      /* last pid */
71*43a90889SApple OSS Distributions 	vsock_gen_t    xvp_gencnt;        /* vsock generation count */
72*43a90889SApple OSS Distributions 	struct xsocket xv_socket;
73*43a90889SApple OSS Distributions };
74*43a90889SApple OSS Distributions 
75*43a90889SApple OSS Distributions struct  xvsockpgen {
76*43a90889SApple OSS Distributions 	u_int32_t      xvg_len;      /* length of this structure */
77*43a90889SApple OSS Distributions 	u_int64_t      xvg_count;    /* number of PCBs at this time */
78*43a90889SApple OSS Distributions 	vsock_gen_t    xvg_gen;      /* generation count at this time */
79*43a90889SApple OSS Distributions 	so_gen_t       xvg_sogen;    /* current socket generation count */
80*43a90889SApple OSS Distributions };
81*43a90889SApple OSS Distributions 
82*43a90889SApple OSS Distributions __END_DECLS
83*43a90889SApple OSS Distributions 
84*43a90889SApple OSS Distributions #endif /* _VSOCK_H_ */
85