wasi_virt_layer 0.3.0

A virtual layer for WASI modules
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
#![allow(dead_code)]

use crate::__private::wasip1;

/// Transports data between the virtual layer and the underlying WASI system.
pub struct Wasip1Transporter;

#[cfg(all(not(feature = "multi_memory"), target_os = "wasi"))]
use crate::memory::WasmAccessDynCompatible;

#[cfg(not(feature = "multi_memory"))]
use crate::memory::WasmAccessName;

#[cfg(not(feature = "multi_memory"))]
use crate::prelude::WasmAccess;

#[cfg(not(feature = "multi_memory"))]
use crate::memory::WasmAccessDynCompatibleRaw;

pub unsafe fn non_recursive_fd_read(
    fd: wasip1::Fd,
    iovs: wasip1::IovecArray<'_>,
) -> Result<wasip1::Size, wasip1::Errno> {
    let mut rp0 = core::mem::MaybeUninit::<wasip1::Size>::uninit();

    let fd = fd as i32;
    let iovs_ptr = iovs.as_ptr() as i32;
    let iovs_len = iovs.len() as i32;
    let rp0_ptr = rp0.as_mut_ptr() as i32;

    let ret = crate::non_recursive_wasi_snapshot_preview1!(
        fd_read(
            fd: i32,
            iovs_ptr: i32,
            iovs_len: i32,
            rp0_ptr: i32
        ) -> i32
    );

    match ret {
        0 => Ok(unsafe { core::ptr::read(rp0.as_mut_ptr() as i32 as *const wasip1::Size) }),
        _ => Err(unsafe { core::mem::transmute::<u16, wasip1::Errno>(ret as u16) }),
    }
}

pub unsafe fn non_recursive_fd_write(
    fd: wasip1::Fd,
    iovs: wasip1::CiovecArray<'_>,
) -> Result<wasip1::Size, wasip1::Errno> {
    let mut rp0 = core::mem::MaybeUninit::<wasip1::Size>::uninit();

    let fd = fd as i32;
    let iovs_ptr = iovs.as_ptr() as i32;
    let iovs_len = iovs.len() as i32;
    let rp0_ptr = rp0.as_mut_ptr() as i32;

    let ret = crate::non_recursive_wasi_snapshot_preview1!(
        fd_write(
            fd: i32,
            iovs_ptr: i32,
            iovs_len: i32,
            rp0_ptr: i32
        ) -> i32
    );

    match ret {
        0 => Ok(unsafe { core::ptr::read(rp0.as_mut_ptr() as i32 as *const wasip1::Size) }),
        _ => Err(unsafe { core::mem::transmute::<u16, wasip1::Errno>(ret as u16) }),
    }
}

pub unsafe fn non_recursive_proc_exit(rval: wasip1::Exitcode) -> ! {
    let rval = rval as i32;

    crate::non_recursive_wasi_snapshot_preview1!(
        proc_exit(rval: i32) -> ()
    );

    unreachable!();
}

pub unsafe fn non_recursive_sched_yield() {
    crate::non_recursive_wasi_snapshot_preview1!(
        sched_yield() -> i32
    );
}

/// Calls the WASI `random_get` function using a non-recursive call.
pub unsafe fn non_recursive_random_get(
    buf: *mut u8,
    buf_len: wasip1::Size,
) -> Result<(), wasip1::Errno> {
    let buf = buf as i32;
    let buf_len = buf_len as i32;

    let ret = crate::non_recursive_wasi_snapshot_preview1!(
        random_get(
            buf: i32,
            buf_len: i32
        ) -> i32
    );

    match ret {
        0 => Ok(()),
        _ => Err(unsafe { core::mem::transmute::<u16, wasip1::Errno>(ret as u16) }),
    }
}

/// Calls the WASI `clock_time_get` function using a non-recursive call.
pub unsafe fn non_recursive_clock_time_get(
    id: wasip1::Clockid,
    precision: wasip1::Timestamp,
) -> Result<wasip1::Timestamp, wasip1::Errno> {
    let mut rp0 = core::mem::MaybeUninit::<wasip1::Timestamp>::uninit();

    let id = id.raw() as i32;
    let precision = precision as i64;
    let rp0_ptr = rp0.as_mut_ptr() as i32;

    let ret = crate::non_recursive_wasi_snapshot_preview1!(
        clock_time_get(
            id: i32,
            precision: i64,
            rp0_ptr: i32
        ) -> i32
    );

    match ret {
        0 => Ok(unsafe { core::ptr::read(rp0.as_mut_ptr() as i32 as *const wasip1::Timestamp) }),
        _ => Err(unsafe { core::mem::transmute::<u16, wasip1::Errno>(ret as u16) }),
    }
}

/// Calls the WASI `clock_res_get` function using a non-recursive call.
pub unsafe fn non_recursive_clock_res_get(
    id: wasip1::Clockid,
) -> Result<wasip1::Timestamp, wasip1::Errno> {
    let mut rp0 = core::mem::MaybeUninit::<wasip1::Timestamp>::uninit();

    let id = id.raw() as i32;
    let rp0_ptr = rp0.as_mut_ptr() as i32;

    let ret = crate::non_recursive_wasi_snapshot_preview1!(
        clock_res_get(
            id: i32,
            rp0_ptr: i32
        ) -> i32
    );

    match ret {
        0 => Ok(unsafe { core::ptr::read(rp0.as_mut_ptr() as i32 as *const wasip1::Timestamp) }),
        _ => Err(unsafe { core::mem::transmute::<u16, wasip1::Errno>(ret as u16) }),
    }
}

impl Wasip1Transporter {
    /// Reads data from stdin into the provided buffer using a non-recursive WASI call.
    #[allow(unused_variables)]
    pub fn read_from_stdin(buf: &mut [u8]) -> Result<wasip1::Size, wasip1::Errno> {
        #[cfg(target_os = "wasi")]
        {
            let iovec_arr = [wasip1::Iovec {
                buf: buf.as_mut_ptr() as *mut u8,
                buf_len: buf.len(),
            }];

            unsafe { non_recursive_fd_read(wasip1::FD_STDIN, &iovec_arr) }
        }

        #[cfg(not(target_os = "wasi"))]
        {
            unimplemented!("this is not supported on this architecture");
        }
    }

    /// Reads data from stdin directly into WASM memory.
    #[cfg(not(feature = "multi_memory"))]
    #[allow(unused_variables)]
    pub fn read_from_stdin_direct<Wasm: WasmAccess + WasmAccessName + 'static>(
        buf: *mut u8,
        len: usize,
    ) -> Result<wasip1::Size, wasip1::Errno> {
        #[cfg(target_os = "wasi")]
        {
            let iovec_arr = [wasip1::Iovec {
                buf: Wasm::memory_director_mut(buf),
                buf_len: len,
            }];

            unsafe { non_recursive_fd_read(wasip1::FD_STDIN, &iovec_arr) }
        }

        #[cfg(not(target_os = "wasi"))]
        {
            unimplemented!("this is not supported on this architecture");
        }
    }

    #[cfg(not(feature = "multi_memory"))]
    #[cfg_attr(not(target_os = "wasi"), allow(unused_variables))]
    pub fn read_from_stdin_direct_dyn_compatible(
        access: &dyn WasmAccessDynCompatibleRaw,
        buf: *mut u8,
        len: usize,
    ) -> Result<wasip1::Size, wasip1::Errno> {
        #[cfg(target_os = "wasi")]
        {
            #[cfg(feature = "alloc")]
            if let Some(directed_buf) = access.memory_director_mut_with(buf) {
                let iovec_arr = [wasip1::Iovec {
                    buf: directed_buf,
                    buf_len: len,
                }];

                unsafe { non_recursive_fd_read(wasip1::FD_STDIN, &iovec_arr) }
            } else {
                let mut alloc_buf = alloc::vec![0u8; len];
                let iovec_arr = [wasip1::Iovec {
                    buf: alloc_buf.as_mut_ptr() as *mut u8,
                    buf_len: len,
                }];
                let nread = unsafe { non_recursive_fd_read(wasip1::FD_STDIN, &iovec_arr) }?;

                access.memcpy_with(buf, &alloc_buf[..nread]);

                Ok(nread)
            }

            #[cfg(not(feature = "alloc"))]
            {
                let iovec_arr = [wasip1::Iovec {
                    buf: access.memory_director_mut_with(buf).unwrap(),
                    buf_len: len,
                }];

                unsafe { non_recursive_fd_read(wasip1::FD_STDIN, &iovec_arr) }
            }
        }

        #[cfg(not(target_os = "wasi"))]
        {
            unimplemented!("this is not supported on this architecture");
        }
    }

    /// Writes data to stdout from the provided buffer.
    #[allow(unused_variables)]
    pub fn write_to_stdout(data: &[u8]) -> Result<wasip1::Size, wasip1::Errno> {
        #[cfg(target_os = "wasi")]
        {
            let ciovec_arr = [wasip1::Ciovec {
                buf: data.as_ptr() as *const u8,
                buf_len: data.len(),
            }];

            unsafe { non_recursive_fd_write(wasip1::FD_STDOUT, &ciovec_arr) }
        }

        #[cfg(not(target_os = "wasi"))]
        {
            unimplemented!("this is not supported on this architecture");
        }
    }

    /// Writes data to stdout directly from WASM memory.
    #[cfg(not(feature = "multi_memory"))]
    #[allow(unused_variables)]
    pub fn write_to_stdout_direct<Wasm: WasmAccess + WasmAccessName + 'static>(
        buf: *const u8,
        len: usize,
    ) -> Result<wasip1::Size, wasip1::Errno> {
        let ciovec_arr = [wasip1::Ciovec {
            buf: Wasm::memory_director(buf),
            buf_len: len,
        }];

        #[cfg(target_os = "wasi")]
        unsafe {
            non_recursive_fd_write(wasip1::FD_STDOUT, &ciovec_arr)
        }

        #[cfg(not(target_os = "wasi"))]
        {
            unimplemented!("this is not supported on this architecture");
        }
    }

    #[cfg(not(feature = "multi_memory"))]
    #[cfg_attr(not(target_os = "wasi"), allow(unused_variables))]
    pub fn write_to_stdout_direct_dyn_compatible(
        access: &dyn WasmAccessDynCompatibleRaw,
        buf: *const u8,
        len: usize,
    ) -> Result<wasip1::Size, wasip1::Errno> {
        #[cfg(target_os = "wasi")]
        {
            #[cfg(feature = "alloc")]
            if let Some(directed_buf) = access.memory_director_with(buf) {
                let ciovec_arr = [wasip1::Ciovec {
                    buf: directed_buf,
                    buf_len: len,
                }];

                unsafe { non_recursive_fd_write(wasip1::FD_STDOUT, &ciovec_arr) }
            } else {
                let mut alloc_buf = alloc::vec![0u8; len];
                access.memcpy_to_with(&mut alloc_buf, buf);
                let ciovec_arr = [wasip1::Ciovec {
                    buf: alloc_buf.as_ptr() as *const u8,
                    buf_len: len,
                }];
                unsafe { non_recursive_fd_write(wasip1::FD_STDOUT, &ciovec_arr) }
            }

            #[cfg(not(feature = "alloc"))]
            {
                let ciovec_arr = [wasip1::Ciovec {
                    buf: access.memory_director_with(buf).unwrap(),
                    buf_len: len,
                }];

                unsafe { non_recursive_fd_write(wasip1::FD_STDOUT, &ciovec_arr) }
            }
        }

        #[cfg(not(target_os = "wasi"))]
        {
            unimplemented!("this is not supported on this architecture");
        }
    }

    /// Writes data to stderr from the provided buffer.
    #[allow(unused_variables)]
    pub fn write_to_stderr(data: &[u8]) -> Result<wasip1::Size, wasip1::Errno> {
        #[cfg(target_os = "wasi")]
        {
            let ciovec_arr = [wasip1::Ciovec {
                buf: data.as_ptr() as *const u8,
                buf_len: data.len(),
            }];

            unsafe { non_recursive_fd_write(wasip1::FD_STDERR, &ciovec_arr) }
        }

        #[cfg(not(target_os = "wasi"))]
        {
            unimplemented!("this is not supported on this architecture");
        }
    }

    /// Writes data to stderr directly from WASM memory.
    #[cfg(not(feature = "multi_memory"))]
    #[allow(unused_variables)]
    pub fn write_to_stderr_direct<Wasm: WasmAccess + WasmAccessName + 'static>(
        buf: *const u8,
        len: usize,
    ) -> Result<wasip1::Size, wasip1::Errno> {
        #[cfg(target_os = "wasi")]
        {
            let ciovec_arr = [wasip1::Ciovec {
                buf: Wasm::memory_director(buf),
                buf_len: len,
            }];

            unsafe { non_recursive_fd_write(wasip1::FD_STDERR, &ciovec_arr) }
        }

        #[cfg(not(target_os = "wasi"))]
        {
            unimplemented!("this is not supported on this architecture");
        }
    }

    #[cfg(not(feature = "multi_memory"))]
    #[cfg_attr(not(target_os = "wasi"), allow(unused_variables))]
    pub fn write_to_stderr_direct_dyn_compatible(
        access: &dyn WasmAccessDynCompatibleRaw,
        buf: *const u8,
        len: usize,
    ) -> Result<wasip1::Size, wasip1::Errno> {
        #[cfg(target_os = "wasi")]
        {
            #[cfg(feature = "alloc")]
            if let Some(directed_buf) = access.memory_director_with(buf) {
                let ciovec_arr = [wasip1::Ciovec {
                    buf: directed_buf,
                    buf_len: len,
                }];

                unsafe { non_recursive_fd_write(wasip1::FD_STDERR, &ciovec_arr) }
            } else {
                let mut alloc_buf = alloc::vec![0u8; len];
                access.memcpy_to_with(&mut alloc_buf, buf);
                let ciovec_arr = [wasip1::Ciovec {
                    buf: alloc_buf.as_ptr() as *const u8,
                    buf_len: len,
                }];
                unsafe { non_recursive_fd_write(wasip1::FD_STDERR, &ciovec_arr) }
            }

            #[cfg(not(feature = "alloc"))]
            {
                let ciovec_arr = [wasip1::Ciovec {
                    buf: access.memory_director_with(buf).unwrap(),
                    buf_len: len,
                }];

                unsafe { non_recursive_fd_write(wasip1::FD_STDERR, &ciovec_arr) }
            }
        }

        #[cfg(not(target_os = "wasi"))]
        {
            unimplemented!("this is not supported on this architecture");
        }
    }

    /// Aborts the current process with the given exit code.
    #[allow(unused_variables)]
    pub fn process_abort(rval: wasip1::Exitcode) -> ! {
        #[cfg(not(target_os = "wasi"))]
        unimplemented!("this is not supported on this architecture");

        #[cfg(target_os = "wasi")]
        {
            // This is a no-op in wasm, as wasm does not support unwinding.
            // If you need to handle unwinding, you should use a different mechanism.
            // For example, you can use `wasip1::exit` to exit the process.
            unsafe { non_recursive_proc_exit(rval) };
        }
    }
}