wavetools 0.1.2

Command-line tools for digital simulation waveform analysis -- read, filter, and diff FST and VCD files
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

//------------------------------------------------------------------------------
// cat_option_tests.rs
// Tests for wavecat output options: time filtering, formatting, format forcing
//
// SPDX-FileCopyrightText: Hudson River Trading
// SPDX-License-Identifier: MIT
//------------------------------------------------------------------------------

use wavetools::{
    names_only, open_wave_file, open_wave_file_with_format, write_names, write_signals_wave,
    NameOptions, SignalOutputOptions, WaveFormat,
};
use std::path::Path;

fn read_names_with_options(path: &str, name_options: &NameOptions) -> String {
    let (_, hier) =
        open_wave_file(Path::new(path), name_options).expect("Failed to open wave file");
    let handle_to_names = names_only(&hier.signal_map, &hier.names);

    let mut output = Vec::new();
    write_names(&mut output, &handle_to_names, true).expect("Failed to write names");
    String::from_utf8(output).expect("Invalid UTF-8")
}

fn read_signals_with_options(
    path: &str,
    start: u64,
    end: Option<u64>,
    output_options: &SignalOutputOptions,
) -> String {
    let name_options = NameOptions::default();
    let (mut reader, hier) =
        open_wave_file(Path::new(path), &name_options).expect("Failed to open wave file");
    let handle_to_names = names_only(&hier.signal_map, &hier.names);

    let mut output = Vec::new();
    write_signals_wave(
        &mut output,
        &mut reader,
        &handle_to_names,
        start,
        end,
        output_options,
    )
    .expect("Failed to write signals");
    String::from_utf8(output).expect("Invalid UTF-8")
}

// -- Time filtering tests ----------------------------------------------------

#[test]
fn test_signals_start_end_fst() {
    let options = SignalOutputOptions { sort: true, time_pound: false };
    let output = read_signals_with_options("tests/data/counter.fst", 10, Some(30), &options);
    let expected = "\
10 t.clk 1
10 t.cyc 00000000000000000000000000000001
10 t.the_sub.cyc 00000000000000000000000000000001
10 t.the_sub.cyc_plus_one 00000000000000000000000000000010
20 t.clk 0
30 t.clk 1
30 t.cyc 00000000000000000000000000000010
30 t.the_sub.cyc 00000000000000000000000000000010
30 t.the_sub.cyc_plus_one 00000000000000000000000000000011
";
    assert_eq!(output, expected);
}

#[test]
fn test_signals_start_end_vcd() {
    let options = SignalOutputOptions { sort: true, time_pound: false };
    let output = read_signals_with_options("tests/data/counter.vcd", 10, Some(30), &options);
    let expected = "\
10 t.clk 1
10 t.cyc 00000000000000000000000000000001
10 t.the_sub.cyc 00000000000000000000000000000001
10 t.the_sub.cyc_plus_one 00000000000000000000000000000010
20 t.clk 0
30 t.clk 1
30 t.cyc 00000000000000000000000000000010
30 t.the_sub.cyc 00000000000000000000000000000010
30 t.the_sub.cyc_plus_one 00000000000000000000000000000011
";
    assert_eq!(output, expected);
}

#[test]
fn test_signals_start_only() {
    let options = SignalOutputOptions { sort: true, time_pound: false };
    let output = read_signals_with_options("tests/data/counter.fst", 40, None, &options);
    let expected = "\
40 t.clk 0
50 t.clk 1
";
    assert_eq!(output, expected);
}

#[test]
fn test_signals_end_only() {
    let options = SignalOutputOptions { sort: true, time_pound: false };
    let output = read_signals_with_options("tests/data/counter.fst", 0, Some(10), &options);
    let expected = "\
0 t.clk 0
0 t.cyc 00000000000000000000000000000000
0 t.the_sub.cyc 00000000000000000000000000000000
0 t.the_sub.cyc_plus_one 00000000000000000000000000000001
10 t.clk 1
10 t.cyc 00000000000000000000000000000001
10 t.the_sub.cyc 00000000000000000000000000000001
10 t.the_sub.cyc_plus_one 00000000000000000000000000000010
";
    assert_eq!(output, expected);
}

#[test]
fn test_signals_start_beyond_data() {
    let options = SignalOutputOptions { sort: true, time_pound: false };
    let output = read_signals_with_options("tests/data/counter.fst", 1000, None, &options);
    assert!(output.is_empty(), "No output expected when start is beyond all data");
}

// -- Output option tests -----------------------------------------------------

#[test]
fn test_signals_time_pound() {
    let options = SignalOutputOptions { sort: true, time_pound: true };
    let output = read_signals_with_options("tests/data/counter.fst", 0, Some(10), &options);
    let expected = "\
#0 t.clk 0
#0 t.cyc 00000000000000000000000000000000
#0 t.the_sub.cyc 00000000000000000000000000000000
#0 t.the_sub.cyc_plus_one 00000000000000000000000000000001
#10 t.clk 1
#10 t.cyc 00000000000000000000000000000001
#10 t.the_sub.cyc 00000000000000000000000000000001
#10 t.the_sub.cyc_plus_one 00000000000000000000000000000010
";
    assert_eq!(output, expected);
}

#[test]
fn test_signals_time_pound_vcd() {
    let options = SignalOutputOptions { sort: true, time_pound: true };
    let output = read_signals_with_options("tests/data/counter.vcd", 0, Some(10), &options);
    let expected = "\
#0 t.clk 0
#0 t.cyc 00000000000000000000000000000000
#0 t.the_sub.cyc 00000000000000000000000000000000
#0 t.the_sub.cyc_plus_one 00000000000000000000000000000001
#10 t.clk 1
#10 t.cyc 00000000000000000000000000000001
#10 t.the_sub.cyc 00000000000000000000000000000001
#10 t.the_sub.cyc_plus_one 00000000000000000000000000000010
";
    assert_eq!(output, expected);
}

// -- no_range_space tests ----------------------------------------------------

#[test]
fn test_names_with_range_default() {
    let output = read_names_with_options("tests/data/range.vcd", &NameOptions::default());
    let expected = "\
t.clk
t.dat [3:0]
";
    assert_eq!(output, expected);
}

#[test]
fn test_names_with_range_no_space() {
    let options = NameOptions { no_range_space: true };
    let output = read_names_with_options("tests/data/range.vcd", &options);
    let expected = "\
t.clk
t.dat[3:0]
";
    assert_eq!(output, expected);
}

// -- Format forcing tests ----------------------------------------------------

#[test]
fn test_format_forcing_fst() {
    let name_options = NameOptions::default();
    let result = open_wave_file_with_format(
        Path::new("tests/data/counter.fst"),
        &name_options,
        Some(WaveFormat::Fst),
    );
    assert!(result.is_ok(), "Should open FST file with forced FST format");
}

#[test]
fn test_format_forcing_vcd() {
    let name_options = NameOptions::default();
    let result = open_wave_file_with_format(
        Path::new("tests/data/counter.vcd"),
        &name_options,
        Some(WaveFormat::Vcd),
    );
    assert!(result.is_ok(), "Should open VCD file with forced VCD format");
}

#[test]
fn test_format_forcing_wrong_format() {
    let name_options = NameOptions::default();
    let result = open_wave_file_with_format(
        Path::new("tests/data/counter.fst"),
        &name_options,
        Some(WaveFormat::Vcd),
    );
    assert!(result.is_err(), "Should fail to open FST file as VCD");
}