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
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

use vpi_sys::PLI_INT32;

/// Returns simulator invocation metadata from `vpi_get_vlog_info`.
///
/// This includes the simulator product string, version string, and command-line
/// arguments as reported by the active VPI implementation.
#[must_use]
pub fn simulator_info() -> SimulatorInfo {
    let mut vlog_info = vpi_sys::t_vpi_vlog_info {
        argc: 0,
        argv: std::ptr::null_mut(),
        version: std::ptr::null_mut(),
        product: std::ptr::null_mut(),
    };
    unsafe { vpi_sys::vpi_get_vlog_info(&raw mut vlog_info) };
    let version = unsafe { std::ffi::CStr::from_ptr(vlog_info.version) }
        .to_str()
        .unwrap_or("Unknown")
        .to_string();
    let product = unsafe { std::ffi::CStr::from_ptr(vlog_info.product) }
        .to_str()
        .unwrap_or("Unknown")
        .to_string();
    let mut arguments = Vec::new();
    for i in 0..vlog_info.argc {
        let arg_ptr = unsafe { *vlog_info.argv.add(i as usize) };
        let arg = unsafe { std::ffi::CStr::from_ptr(arg_ptr) }
            .to_str()
            .unwrap_or("Unknown")
            .to_string();
        arguments.push(arg);
    }
    SimulatorInfo {
        arguments,
        version,
        product,
    }
}

/// Simulator metadata reported by `vpi_get_vlog_info`.
#[derive(Debug)]
pub struct SimulatorInfo {
    /// Command-line arguments used to start the simulator.
    pub arguments: Vec<String>,
    /// Simulator version string.
    pub version: String,
    /// Simulator product name.
    pub product: String,
}

/// Returns the simulator product name.
#[must_use]
pub fn simulator_name() -> String {
    let mut vlog_info = vpi_sys::t_vpi_vlog_info {
        argc: 0,
        argv: std::ptr::null_mut(),
        version: std::ptr::null_mut(),
        product: std::ptr::null_mut(),
    };
    unsafe { vpi_sys::vpi_get_vlog_info(&raw mut vlog_info) };
    unsafe { std::ffi::CStr::from_ptr(vlog_info.product) }
        .to_str()
        .unwrap_or("Unknown")
        .to_string()
}

/// Returns the simulator version string.
#[must_use]
pub fn simulator_version() -> String {
    let mut vlog_info = vpi_sys::t_vpi_vlog_info {
        argc: 0,
        argv: std::ptr::null_mut(),
        version: std::ptr::null_mut(),
        product: std::ptr::null_mut(),
    };
    unsafe { vpi_sys::vpi_get_vlog_info(&raw mut vlog_info) };
    unsafe { std::ffi::CStr::from_ptr(vlog_info.version) }
        .to_str()
        .unwrap_or("Unknown")
        .to_string()
}

/// Represents a module's timescale information
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct Timescale {
    /// Time unit as a power of 10 (e.g., -9 for 1ns, -12 for 1ps)
    pub unit: i32,
    /// Time precision as a power of 10 (e.g., -12 for 1ps)
    pub precision: i32,
}

impl Timescale {
    /// Get the timescale for a given module handle
    ///
    /// # Safety
    /// The handle must be a valid VPI module handle
    pub unsafe fn from_module(module_handle: vpi_sys::vpiHandle) -> Option<Self> {
        // SAFETY: Caller guarantees module_handle is valid
        let unit =
            unsafe { vpi_sys::vpi_get(crate::Property::TimeUnit as PLI_INT32, module_handle) };
        let precision =
            unsafe { vpi_sys::vpi_get(crate::Property::TimePrecision as PLI_INT32, module_handle) };
        Some(Timescale { unit, precision })
    }

    /// Convert time unit/precision to a human-readable string
    /// E.g., -9 => "1ns", -12 => "1ps"
    #[must_use]
    pub fn unit_str(&self) -> String {
        power_of_10_to_time_str(self.unit)
    }

    /// Convert time precision to a human-readable string
    #[must_use]
    pub fn precision_str(&self) -> String {
        power_of_10_to_time_str(self.precision)
    }
}

impl std::fmt::Display for Timescale {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{} / {}", self.unit_str(), self.precision_str())
    }
}

/// Convert a power of 10 to a time unit string
fn power_of_10_to_time_str(power: i32) -> String {
    match power {
        2 => "100s".to_string(),
        1 => "10s".to_string(),
        0 => "1s".to_string(),
        -1 => "100ms".to_string(),
        -2 => "10ms".to_string(),
        -3 => "1ms".to_string(),
        -4 => "100us".to_string(),
        -5 => "10us".to_string(),
        -6 => "1us".to_string(),
        -7 => "100ns".to_string(),
        -8 => "10ns".to_string(),
        -9 => "1ns".to_string(),
        -10 => "100ps".to_string(),
        -11 => "10ps".to_string(),
        -12 => "1ps".to_string(),
        -13 => "100fs".to_string(),
        -14 => "10fs".to_string(),
        -15 => "1fs".to_string(),
        _ => format!("10^{power}s"),
    }
}

/// Returns timescale information for top-level modules.
///
/// Each entry contains `(module_name, timescale)` where `timescale` is `None`
/// when time unit/precision properties are not available.
#[must_use]
pub fn get_top_module_timescales() -> Vec<(String, Option<Timescale>)> {
    let mut results = Vec::new();

    unsafe {
        // Iterate over all top-level modules
        let iter = vpi_sys::vpi_iterate(vpi_sys::vpiModule as i32, std::ptr::null_mut());
        if iter.is_null() {
            return results;
        }

        loop {
            let module = vpi_sys::vpi_scan(iter);
            if module.is_null() {
                break;
            }

            // Get module name
            let name_ptr = vpi_sys::vpi_get_str(crate::Property::Name as i32, module);
            let name = if name_ptr.is_null() {
                "Unknown".to_string()
            } else {
                std::ffi::CStr::from_ptr(name_ptr)
                    .to_str()
                    .unwrap_or("Unknown")
                    .to_string()
            };

            // Get timescale
            let timescale = Timescale::from_module(module);

            results.push((name, timescale));
        }
    }

    results
}

#[cfg(test)]
mod tests {
    use super::{power_of_10_to_time_str, Timescale};

    #[test]
    fn maps_known_power_values_to_expected_units() {
        assert_eq!(power_of_10_to_time_str(2), "100s");
        assert_eq!(power_of_10_to_time_str(1), "10s");
        assert_eq!(power_of_10_to_time_str(0), "1s");
        assert_eq!(power_of_10_to_time_str(-1), "100ms");
        assert_eq!(power_of_10_to_time_str(-2), "10ms");
        assert_eq!(power_of_10_to_time_str(-3), "1ms");
        assert_eq!(power_of_10_to_time_str(-6), "1us");
        assert_eq!(power_of_10_to_time_str(-9), "1ns");
        assert_eq!(power_of_10_to_time_str(-12), "1ps");
        assert_eq!(power_of_10_to_time_str(-15), "1fs");
    }

    #[test]
    fn timescale_unit_and_precision_helpers_use_power_mapping() {
        let timescale = Timescale {
            unit: -9,
            precision: -12,
        };

        assert_eq!(timescale.unit_str(), "1ns");
        assert_eq!(timescale.precision_str(), "1ps");
    }

    #[test]
    fn timescale_display_formats_as_unit_slash_precision() {
        let timescale = Timescale {
            unit: -6,
            precision: -15,
        };

        assert_eq!(timescale.to_string(), "1us / 1fs");
    }
}