kona-std-fpvm 0.2.0

Platform specific APIs for interacting with Fault Proof VM kernels.
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

//! This module contains the `ClientIO` struct, which is a system call interface for the kernel.

use crate::{BasicKernelInterface, FileDescriptor, errors::IOResult};
use cfg_if::cfg_if;

cfg_if! {
    if #[cfg(target_arch = "mips64")] {
        #[doc = "Concrete implementation of the [BasicKernelInterface] trait for the `MIPS64r2` target architecture."]
        pub(crate) type ClientIO = crate::mips64::io::Mips64IO;
    } else if #[cfg(target_arch = "riscv64")] {
        #[doc = "Concrete implementation of the [BasicKernelInterface] trait for the `riscv64` target architecture."]
        pub(crate) type ClientIO = crate::riscv64::io::RiscV64IO;
    } else {
        use std::{fs::File, os::fd::FromRawFd, io::{Read, Write}};
        use crate::errors::IOError;

        #[doc = "Native implementation of the [BasicKernelInterface] trait."]
        pub(crate) struct NativeClientIO;

        impl BasicKernelInterface for NativeClientIO {
            fn write(fd: FileDescriptor, buf: &[u8]) -> IOResult<usize> {
                unsafe {
                    let mut file = File::from_raw_fd(fd as i32);
                    file.write_all(buf).map_err(|_| IOError(-9))?;
                    std::mem::forget(file);
                    Ok(buf.len())
                }
            }

            fn read(fd: FileDescriptor, buf: &mut [u8]) -> IOResult<usize> {
                unsafe {
                    let mut file = File::from_raw_fd(fd as i32);
                    file.read(buf).map_err(|_| IOError(-9))?;
                    std::mem::forget(file);
                    Ok(buf.len())
                }
            }

            fn exit(code: usize) -> ! {
                std::process::exit(code as i32)
            }
        }

        #[doc = "Native implementation of the [BasicKernelInterface] trait."]
        pub(crate) type ClientIO = NativeClientIO;
    }
}

/// Print the passed string to the standard output [FileDescriptor].
///
/// # Panics
/// Panics if the write operation fails.
#[inline]
pub fn print(s: &str) {
    ClientIO::write(FileDescriptor::StdOut, s.as_bytes()).expect("Error writing to stdout.");
}

/// Print the passed string to the standard error [FileDescriptor].
///
/// # Panics
/// Panics if the write operation fails.
#[inline]
pub fn print_err(s: &str) {
    ClientIO::write(FileDescriptor::StdErr, s.as_bytes()).expect("Error writing to stderr.");
}

/// Write the passed buffer to the given [FileDescriptor].
#[inline]
pub fn write(fd: FileDescriptor, buf: &[u8]) -> IOResult<usize> {
    ClientIO::write(fd, buf)
}

/// Write the passed buffer to the given [FileDescriptor].
#[inline]
pub fn read(fd: FileDescriptor, buf: &mut [u8]) -> IOResult<usize> {
    ClientIO::read(fd, buf)
}

/// Exit the process with the given exit code.
#[inline]
pub fn exit(code: usize) -> ! {
    ClientIO::exit(code)
}