xref: /xnu-10002.41.9/bsd/sys/vsock_transport.h (revision 699cd48037512bf4380799317ca44ca453c82f57)
1*699cd480SApple OSS Distributions /*
2*699cd480SApple OSS Distributions  * Copyright (c) 2020 Apple Inc. All rights reserved.
3*699cd480SApple OSS Distributions  *
4*699cd480SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*699cd480SApple OSS Distributions  *
6*699cd480SApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*699cd480SApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*699cd480SApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*699cd480SApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*699cd480SApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*699cd480SApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*699cd480SApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*699cd480SApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*699cd480SApple OSS Distributions  *
15*699cd480SApple OSS Distributions  * Please obtain a copy of the License at
16*699cd480SApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*699cd480SApple OSS Distributions  *
18*699cd480SApple OSS Distributions  * The Original Code and all software distributed under the License are
19*699cd480SApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*699cd480SApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*699cd480SApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*699cd480SApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*699cd480SApple OSS Distributions  * Please see the License for the specific language governing rights and
24*699cd480SApple OSS Distributions  * limitations under the License.
25*699cd480SApple OSS Distributions  *
26*699cd480SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*699cd480SApple OSS Distributions  */
28*699cd480SApple OSS Distributions 
29*699cd480SApple OSS Distributions #ifndef _VSOCK_TRANSPORT_H_
30*699cd480SApple OSS Distributions #define _VSOCK_TRANSPORT_H_
31*699cd480SApple OSS Distributions #ifdef  KERNEL_PRIVATE
32*699cd480SApple OSS Distributions 
33*699cd480SApple OSS Distributions #include <sys/cdefs.h>
34*699cd480SApple OSS Distributions 
35*699cd480SApple OSS Distributions __BEGIN_DECLS
36*699cd480SApple OSS Distributions 
37*699cd480SApple OSS Distributions #include <sys/queue.h>
38*699cd480SApple OSS Distributions #include <sys/kernel_types.h>
39*699cd480SApple OSS Distributions #include <sys/vsock.h>
40*699cd480SApple OSS Distributions 
41*699cd480SApple OSS Distributions #define VSOCK_MAX_PACKET_SIZE 65536
42*699cd480SApple OSS Distributions 
43*699cd480SApple OSS Distributions enum vsock_operation {
44*699cd480SApple OSS Distributions 	VSOCK_REQUEST = 0,
45*699cd480SApple OSS Distributions 	VSOCK_RESPONSE = 1,
46*699cd480SApple OSS Distributions 	VSOCK_PAYLOAD = 2,
47*699cd480SApple OSS Distributions 	VSOCK_SHUTDOWN = 3,
48*699cd480SApple OSS Distributions 	VSOCK_SHUTDOWN_RECEIVE = 4,
49*699cd480SApple OSS Distributions 	VSOCK_SHUTDOWN_SEND = 5,
50*699cd480SApple OSS Distributions 	VSOCK_RESET = 6,
51*699cd480SApple OSS Distributions 	VSOCK_CREDIT_UPDATE = 7,
52*699cd480SApple OSS Distributions 	VSOCK_CREDIT_REQUEST = 8,
53*699cd480SApple OSS Distributions };
54*699cd480SApple OSS Distributions 
55*699cd480SApple OSS Distributions struct vsock_address {
56*699cd480SApple OSS Distributions 	uint32_t cid;
57*699cd480SApple OSS Distributions 	uint32_t port;
58*699cd480SApple OSS Distributions };
59*699cd480SApple OSS Distributions 
60*699cd480SApple OSS Distributions struct vsock_transport {
61*699cd480SApple OSS Distributions 	void *provider;
62*699cd480SApple OSS Distributions 	int (*get_cid)(void *provider, uint32_t *cid);
63*699cd480SApple OSS Distributions 	int (*attach_socket)(void *provider);
64*699cd480SApple OSS Distributions 	int (*detach_socket)(void *provider);
65*699cd480SApple OSS Distributions 	int (*put_message)(void *provider, struct vsock_address src, struct vsock_address dst,
66*699cd480SApple OSS Distributions 	    enum vsock_operation op, uint32_t buf_alloc, uint32_t fwd_cnt, mbuf_t m);
67*699cd480SApple OSS Distributions };
68*699cd480SApple OSS Distributions 
69*699cd480SApple OSS Distributions extern int vsock_add_transport(struct vsock_transport *transport);
70*699cd480SApple OSS Distributions extern int vsock_remove_transport(struct vsock_transport *transport);
71*699cd480SApple OSS Distributions extern int vsock_reset_transport(struct vsock_transport *transport);
72*699cd480SApple OSS Distributions extern int vsock_put_message(struct vsock_address src, struct vsock_address dst,
73*699cd480SApple OSS Distributions     enum vsock_operation op, uint32_t buf_alloc, uint32_t fwd_cnt, mbuf_t m);
74*699cd480SApple OSS Distributions 
75*699cd480SApple OSS Distributions __END_DECLS
76*699cd480SApple OSS Distributions 
77*699cd480SApple OSS Distributions #endif /* KERNEL_PRIVATE */
78*699cd480SApple OSS Distributions #endif /* _VSOCK_TRANSPORT_H_ */
79