virtiofs_opendal/
filesystem_message.rs

1// Licensed to the Apache Software Foundation (ASF) under one
2// or more contributor license agreements.  See the NOTICE file
3// distributed with this work for additional information
4// regarding copyright ownership.  The ASF licenses this file
5// to you under the Apache License, Version 2.0 (the
6// "License"); you may not use this file except in compliance
7// with the License.  You may obtain a copy of the License at
8//
9//   http://www.apache.org/licenses/LICENSE-2.0
10//
11// Unless required by applicable law or agreed to in writing,
12// software distributed under the License is distributed on an
13// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14// KIND, either express or implied.  See the License for the
15// specific language governing permissions and limitations
16// under the License.
17
18use vm_memory::ByteValued;
19
20use crate::error::*;
21
22/// Opcode represents the filesystem call that needs to be executed by VMs message.
23/// The corresponding value needs to be aligned with the specification.
24#[non_exhaustive]
25pub enum Opcode {
26    Lookup = 1,
27    Forget = 2,
28    Getattr = 3,
29    Setattr = 4,
30    Unlink = 10,
31    Open = 14,
32    Read = 15,
33    Write = 16,
34    Release = 18,
35    Flush = 25,
36    Init = 26,
37    Create = 35,
38    Destroy = 38,
39}
40
41impl TryFrom<u32> for Opcode {
42    type Error = Error;
43
44    fn try_from(value: u32) -> Result<Self, Self::Error> {
45        match value {
46            1 => Ok(Opcode::Lookup),
47            2 => Ok(Opcode::Forget),
48            3 => Ok(Opcode::Getattr),
49            4 => Ok(Opcode::Setattr),
50            10 => Ok(Opcode::Unlink),
51            14 => Ok(Opcode::Open),
52            15 => Ok(Opcode::Read),
53            16 => Ok(Opcode::Write),
54            18 => Ok(Opcode::Release),
55            25 => Ok(Opcode::Flush),
56            26 => Ok(Opcode::Init),
57            35 => Ok(Opcode::Create),
58            38 => Ok(Opcode::Destroy),
59            _ => Err(new_vhost_user_fs_error("failed to decode opcode", None)),
60        }
61    }
62}
63
64/// Attr represents the file attributes in virtiofs.
65///
66/// The fields of the struct need to conform to the specific format of the virtiofs message.
67/// Currently, we only need to align them exactly with virtiofsd.
68/// Reference: https://gitlab.com/virtio-fs/virtiofsd/-/blob/main/src/fuse.rs?ref_type=heads#L577
69#[repr(C)]
70#[derive(Debug, Default, Clone, Copy)]
71pub struct Attr {
72    pub ino: u64,
73    pub size: u64,
74    pub blocks: u64,
75    pub atime: u64,
76    pub mtime: u64,
77    pub ctime: u64,
78    pub atimensec: u32,
79    pub mtimensec: u32,
80    pub ctimensec: u32,
81    pub mode: u32,
82    pub nlink: u32,
83    pub uid: u32,
84    pub gid: u32,
85    pub rdev: u32,
86    pub blksize: u32,
87    pub flags: u32,
88}
89
90/// InHeader represents the incoming message header in the filesystem call.
91///
92/// The fields of the struct need to conform to the specific format of the virtiofs message.
93/// Currently, we only need to align them exactly with virtiofsd.
94/// Reference: https://gitlab.com/virtio-fs/virtiofsd/-/blob/main/src/fuse.rs?ref_type=heads#L1155
95#[repr(C)]
96#[derive(Debug, Default, Clone, Copy)]
97pub struct InHeader {
98    pub len: u32,
99    pub opcode: u32,
100    pub unique: u64,
101    pub nodeid: u64,
102    pub uid: u32,
103    pub gid: u32,
104    pub pid: u32,
105    pub total_extlen: u16,
106    pub padding: u16,
107}
108
109/// OutHeader represents the message header returned in the filesystem call.
110///
111/// The fields of the struct need to conform to the specific format of the virtiofs message.
112/// Currently, we only need to align them exactly with virtiofsd.
113/// Reference: https://gitlab.com/virtio-fs/virtiofsd/-/blob/main/src/fuse.rs?ref_type=heads#L1170
114#[repr(C)]
115#[derive(Debug, Default, Clone, Copy)]
116pub struct OutHeader {
117    pub len: u32,
118    pub error: i32,
119    pub unique: u64,
120}
121
122/// InitIn is used to parse the parameters passed in the Init filesystem call.
123///
124/// The fields of the struct need to conform to the specific format of the virtiofs message.
125/// Currently, we only need to align them exactly with virtiofsd.
126/// Reference: https://gitlab.com/virtio-fs/virtiofsd/-/blob/main/src/fuse.rs?ref_type=heads#L1030
127#[repr(C)]
128#[derive(Debug, Default, Clone, Copy)]
129pub struct InitIn {
130    pub major: u32,
131    pub minor: u32,
132    pub max_readahead: u32,
133    pub flags: u32,
134}
135
136/// InitOut is used to return the result of the Init filesystem call.
137///
138/// The fields of the struct need to conform to the specific format of the virtiofs message.
139/// Currently, we only need to align them exactly with virtiofsd.
140/// Reference: https://gitlab.com/virtio-fs/virtiofsd/-/blob/main/src/fuse.rs?ref_type=heads#L1048
141#[repr(C)]
142#[derive(Debug, Default, Clone, Copy)]
143pub struct InitOut {
144    pub major: u32,
145    pub minor: u32,
146    pub max_readahead: u32,
147    pub flags: u32,
148    pub max_background: u16,
149    pub congestion_threshold: u16,
150    pub max_write: u32,
151    pub time_gran: u32,
152    pub max_pages: u16,
153    pub map_alignment: u16,
154    pub flags2: u32,
155    pub unused: [u32; 7],
156}
157
158/// EntryOut is used to return the file entry in the filesystem call.
159///
160/// The fields of the struct need to conform to the specific format of the virtiofs message.
161/// Currently, we only need to align them exactly with virtiofsd.
162/// Reference: https://gitlab.com/virtio-fs/virtiofsd/-/blob/main/src/fuse.rs?ref_type=heads#L737
163#[repr(C)]
164#[derive(Debug, Default, Clone, Copy)]
165pub struct EntryOut {
166    pub nodeid: u64,
167    pub generation: u64,
168    pub entry_valid: u64,
169    pub attr_valid: u64,
170    pub entry_valid_nsec: u32,
171    pub attr_valid_nsec: u32,
172    pub attr: Attr,
173}
174
175/// AttrOut is used to return the file attributes in the filesystem call.
176///
177/// The fields of the struct need to conform to the specific format of the virtiofs message.
178/// Currently, we only need to align them exactly with virtiofsd.
179/// Reference: https://gitlab.com/virtio-fs/virtiofsd/-/blob/main/src/fuse.rs?ref_type=heads#L782
180#[repr(C)]
181#[derive(Debug, Default, Clone, Copy)]
182pub struct AttrOut {
183    pub attr_valid: u64,
184    pub attr_valid_nsec: u32,
185    pub dummy: u32,
186    pub attr: Attr,
187}
188
189/// CreateIn is used to parse the parameters passed in the Create filesystem call.
190///
191/// The fields of the struct need to conform to the specific format of the virtiofs message.
192/// Currently, we only need to align them exactly with virtiofsd.
193/// Reference: https://gitlab.com/virtio-fs/virtiofsd/-/blob/main/src/fuse.rs?ref_type=heads#L881
194#[repr(C)]
195#[derive(Debug, Default, Clone, Copy)]
196pub struct CreateIn {
197    pub flags: u32,
198    pub mode: u32,
199    pub umask: u32,
200    pub open_flags: u32,
201}
202
203/// OpenIn is used to parse the parameters passed in the Open filesystem call.
204///
205/// The fields of the struct need to conform to the specific format of the virtiofs message.
206/// Currently, we only need to align them exactly with virtiofsd.
207/// Reference: https://gitlab.com/virtio-fs/virtiofsd/-/blob/main/src/fuse.rs?ref_type=heads#873
208#[repr(C)]
209#[derive(Debug, Default, Clone, Copy)]
210pub struct OpenIn {
211    pub flags: u32,
212    pub open_flags: u32,
213}
214
215/// OpenOut is used to return the file descriptor in the filesystem call.
216///
217/// The fields of the struct need to conform to the specific format of the virtiofs message.
218/// Currently, we only need to align them exactly with virtiofsd.
219/// Reference: https://gitlab.com/virtio-fs/virtiofsd/-/blob/main/src/fuse.rs?ref_type=heads#L891
220#[repr(C)]
221#[derive(Debug, Default, Clone, Copy)]
222pub struct OpenOut {
223    pub fh: u64,
224    pub open_flags: u32,
225    pub padding: u32,
226}
227
228/// ReadIn is used to parse the parameters passed in the Read filesystem call.
229///
230/// The fields of the struct need to conform to the specific format of the virtiofs message.
231/// Currently, we only need to align them exactly with virtiofsd.
232/// Reference: https://gitlab.com/virtio-fs/virtiofsd/-/blob/main/src/fuse.rs?ref_type=heads#920
233#[repr(C)]
234#[derive(Debug, Default, Clone, Copy)]
235pub struct ReadIn {
236    pub fh: u64,
237    pub offset: u64,
238    pub size: u32,
239    pub read_flags: u32,
240    pub lock_owner: u64,
241    pub flags: u32,
242    pub padding: u32,
243}
244
245/// WriteIn is used to parse the parameters passed in the Write filesystem call.
246///
247/// The fields of the struct need to conform to the specific format of the virtiofs message.
248/// Currently, we only need to align them exactly with virtiofsd.
249/// Reference: https://gitlab.com/virtio-fs/virtiofsd/-/blob/main/src/fuse.rs?ref_type=heads#933
250#[repr(C)]
251#[derive(Debug, Default, Clone, Copy)]
252pub struct WriteIn {
253    pub fh: u64,
254    pub offset: u64,
255    pub size: u32,
256    pub write_flags: u32,
257    pub lock_owner: u64,
258    pub flags: u32,
259    pub padding: u32,
260}
261
262/// WriteOut is used to return the number of bytes written in the Write filesystem call.
263///
264/// The fields of the struct need to conform to the specific format of the virtiofs message.
265/// Currently, we only need to align them exactly with virtiofsd.
266/// Reference: https://gitlab.com/virtio-fs/virtiofsd/-/blob/main/src/fuse.rs?ref_type=heads#L946
267#[repr(C)]
268#[derive(Debug, Default, Clone, Copy)]
269pub struct WriteOut {
270    pub size: u32,
271    pub padding: u32,
272}
273
274/// We will use ByteValued to implement the encoding and decoding
275/// of these structures in shared memory.
276unsafe impl ByteValued for Attr {}
277unsafe impl ByteValued for InHeader {}
278unsafe impl ByteValued for OutHeader {}
279unsafe impl ByteValued for InitIn {}
280unsafe impl ByteValued for InitOut {}
281unsafe impl ByteValued for EntryOut {}
282unsafe impl ByteValued for AttrOut {}
283unsafe impl ByteValued for CreateIn {}
284unsafe impl ByteValued for OpenIn {}
285unsafe impl ByteValued for OpenOut {}
286unsafe impl ByteValued for ReadIn {}
287unsafe impl ByteValued for WriteIn {}
288unsafe impl ByteValued for WriteOut {}
virtiofs_opendal/filesystem_message.rs

virtiofs_opendal/
filesystem_message.rs
