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