xref: /linux/include/uapi/linux/virtio_vsock.h (revision 762f99f4f3cb41a775b5157dd761217beba65873)
1 /*
2  * This header, excluding the #ifdef __KERNEL__ part, is BSD licensed so
3  * anyone can use the definitions to implement compatible drivers/servers:
4  *
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  * 3. Neither the name of IBM nor the names of its contributors
15  *    may be used to endorse or promote products derived from this software
16  *    without specific prior written permission.
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
18  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL IBM OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  * Copyright (C) Red Hat, Inc., 2013-2015
30  * Copyright (C) Asias He <asias@redhat.com>, 2013
31  * Copyright (C) Stefan Hajnoczi <stefanha@redhat.com>, 2015
32  */
33 
34 #ifndef _UAPI_LINUX_VIRTIO_VSOCK_H
35 #define _UAPI_LINUX_VIRTIO_VSOCK_H
36 
37 #include <linux/types.h>
38 #include <linux/virtio_ids.h>
39 #include <linux/virtio_config.h>
40 
41 /* The feature bitmap for virtio vsock */
42 #define VIRTIO_VSOCK_F_SEQPACKET	1	/* SOCK_SEQPACKET supported */
43 
44 struct virtio_vsock_config {
45 	__le64 guest_cid;
46 } __attribute__((packed));
47 
48 enum virtio_vsock_event_id {
49 	VIRTIO_VSOCK_EVENT_TRANSPORT_RESET = 0,
50 };
51 
52 struct virtio_vsock_event {
53 	__le32 id;
54 } __attribute__((packed));
55 
56 struct virtio_vsock_hdr {
57 	__le64	src_cid;
58 	__le64	dst_cid;
59 	__le32	src_port;
60 	__le32	dst_port;
61 	__le32	len;
62 	__le16	type;		/* enum virtio_vsock_type */
63 	__le16	op;		/* enum virtio_vsock_op */
64 	__le32	flags;
65 	__le32	buf_alloc;
66 	__le32	fwd_cnt;
67 } __attribute__((packed));
68 
69 enum virtio_vsock_type {
70 	VIRTIO_VSOCK_TYPE_STREAM = 1,
71 	VIRTIO_VSOCK_TYPE_SEQPACKET = 2,
72 };
73 
74 enum virtio_vsock_op {
75 	VIRTIO_VSOCK_OP_INVALID = 0,
76 
77 	/* Connect operations */
78 	VIRTIO_VSOCK_OP_REQUEST = 1,
79 	VIRTIO_VSOCK_OP_RESPONSE = 2,
80 	VIRTIO_VSOCK_OP_RST = 3,
81 	VIRTIO_VSOCK_OP_SHUTDOWN = 4,
82 
83 	/* To send payload */
84 	VIRTIO_VSOCK_OP_RW = 5,
85 
86 	/* Tell the peer our credit info */
87 	VIRTIO_VSOCK_OP_CREDIT_UPDATE = 6,
88 	/* Request the peer to send the credit info to us */
89 	VIRTIO_VSOCK_OP_CREDIT_REQUEST = 7,
90 };
91 
92 /* VIRTIO_VSOCK_OP_SHUTDOWN flags values */
93 enum virtio_vsock_shutdown {
94 	VIRTIO_VSOCK_SHUTDOWN_RCV = 1,
95 	VIRTIO_VSOCK_SHUTDOWN_SEND = 2,
96 };
97 
98 /* VIRTIO_VSOCK_OP_RW flags values */
99 enum virtio_vsock_rw {
100 	VIRTIO_VSOCK_SEQ_EOM = 1,
101 	VIRTIO_VSOCK_SEQ_EOR = 2,
102 };
103 
104 #endif /* _UAPI_LINUX_VIRTIO_VSOCK_H */
105