vpi 0.1.1

Safe and ergonomic Rust bindings to the Verilog and SystemVerilog VPI C API for writing VPI applications in Rust.
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

use std::ffi::CString;

/// Multi-channel descriptor used by VPI for output streams.
pub struct MCD {
    /// Bitmask identifying one or more simulator output channels.
    mask: u32,
}

/// Standard output MCD descriptor.
pub static MCD_STDOUT: MCD = MCD { mask: 0x1 };

impl MCD {
    /// Creates a new MCD for the given output file name.
    pub fn new(filename: impl AsRef<str>) -> Self {
        let c_filename = CString::new(filename.as_ref()).unwrap();
        let mask = unsafe { vpi_sys::vpi_mcd_open(c_filename.as_ptr().cast_mut()) };
        Self { mask }
    }

    /// Write a message to the MCD.
    pub fn write(&self, msg: impl AsRef<str>) {
        let cstr = CString::new(msg.as_ref()).unwrap();
        unsafe {
            vpi_sys::vpi_mcd_printf(self.mask, cstr.as_ptr().cast_mut());
        }
    }

    /// Write a message with a newline to the MCD.
    pub fn writeln(&self, msg: impl AsRef<str>) {
        self.write(format!("{}\n", msg.as_ref()));
    }

    /// Closes this MCD stream in the simulator.
    pub fn close(&self) {
        unsafe {
            vpi_sys::vpi_mcd_close(self.mask);
        }
    }

    /// Flushes any buffered MCD output.
    pub fn flush(&self) {
        unsafe {
            vpi_sys::vpi_mcd_flush(self.mask);
        }
    }

    #[must_use]
    /// Get the filename associated with this MCD, if any.
    pub fn file_name(&self) -> Option<String> {
        let ptr = unsafe { vpi_sys::vpi_mcd_name(self.mask) };
        if ptr.is_null() {
            None
        } else {
            let cstr = unsafe { CString::from_raw(ptr) };
            cstr.into_string().ok()
        }
    }
}

/// Combines two MCD descriptors into one destination mask.
impl std::ops::BitOr for MCD {
    type Output = Self;

    fn bitor(self, rhs: Self) -> Self::Output {
        Self {
            mask: self.mask | rhs.mask,
        }
    }
}

/// Formats and writes a line to an [`MCD`].
#[macro_export]
macro_rules! mcd_println {
    ($mcd:expr, $($arg:tt)*) => {{
        $mcd.writeln(&format!($($arg)*));
    }}
}