Compare commits

..

No commits in common. "main" and "refactor-signal" have entirely different histories.

21 changed files with 321 additions and 996 deletions

View file

@ -10,7 +10,7 @@ debug = 1
[dependencies]
num = "0.4"
clap = { version = "4.4.6", features = ["derive"] }
clap = { version = "3.1.8", features = ["derive"] }
chrono = "0.4"
# TODO : remove itertools once date parser is reworked.
itertools = "0.11"
itertools = "0.10.3"

View file

@ -1,23 +1,11 @@
Copyright(2023) - Yehowshua Immanuel
# Vision
Imagine being able to visualize a CPU pipeline diagram by merely loading a simulation waveform dump, sprinkling in a bit of code, and dragging and dropping some diagram blocks into the visualizer. This project aims to offer such an experience.
Since this project is written in Rust, it should also be able to run in the browser via web-assembly.
# Status
As of January 2024, work on the Fastwave Backend is stalled. It has been a fun journey watching Fastwave enable the first iterations of the [surfer waveform viewer](https://surfer-project.org). Now surfer uses an even better backend called [Wellen](https://github.com/ekiwi/wellen?tab=readme-ov-file). Go check it out! I hear it's really good. Perhaps I will soon archive the Fastwave Backend.
Browser demo: https://app.surfer-project.org/
Screenshot of surfer frontend below:
<img width="1609" alt="image" src="https://github.com/ThePerfectComputer/FastWaveBackend/assets/103011002/63deffc0-98b0-405f-b093-74d10b422b01">
Copyright - Yehowshua Immanuel
# A High performance, VCD Parser written in Rust
I hope for a GUI that eventually looks like the following...
Below is a screenshot of the early stages of the proprietary
viewer frontend that builds on this backend:
![](assets/FastWaveMockup.png)
![](assets/viewer.png)
# Current Features
@ -52,8 +40,6 @@ slower.
## Results
LZ4 should really improve memory usage once I add it. Note that GTKWave uses LZ4 on the fly.
| Software | Time(s) | Memory(MB) |
|----------|---------|------------|
| FastWave | ~27.30 | 1100+ |

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.1 MiB

BIN
assets/viewer.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 378 KiB

View file

@ -10,6 +10,7 @@ use fastwave_backend::parse_vcd;
#[derive(Parser)]
struct Cli {
/// The path to the file to read
#[clap(parse(from_os_str))]
path: std::path::PathBuf,
}
@ -23,11 +24,8 @@ fn main() -> std::io::Result<()> {
parse_vcd(file).unwrap();
let elapsed = now.elapsed();
println!(
"Parsed VCD file {} : {:.2?}",
&args.path.as_os_str().to_str().unwrap(),
elapsed
);
println!("Parsed VCD file {} : {:.2?}", &args.path.as_os_str().to_str().unwrap(), elapsed);
Ok(())
}

View file

@ -4,12 +4,10 @@
// the root of the folder containing the sources for this program.
use std::fs::File;
use fastwave_backend::{parse_vcd, ScopeIdx, SignalIdx, VCD};
use fastwave_backend::{ScopeIdx, VCD, parse_vcd, SignalIdx};
fn indented_print(indent : u8, name : &String) {
for _ in 0..indent {
print!(" |");
}
for _ in 0..indent {print!(" |");}
print!("---");
println!("{name}");
}
@ -27,7 +25,7 @@ fn visit_all_scopes(vcd: &VCD) {
let SignalIdx(idx) = signal_idx;
indented_print(indent + 1, &format!("{},{}", signal.name(), idx));
}
visit_all_scope_children(child_scope_idx, vcd, indent + 1);
visit_all_scope_children(child_scope_idx, vcd.clone(), indent + 1);
}
}
}
@ -38,6 +36,7 @@ fn visit_all_scopes(vcd: &VCD) {
}
fn main() -> std::io::Result<()> {
use std::time::Instant;
// we start by printing out the entire signal tree of
@ -54,6 +53,7 @@ fn main() -> std::io::Result<()> {
println!("Done Printing Scopes");
println!();
// we then parse another VCD, print its signal tree and
// query some values on its timeline
let now = Instant::now();
@ -73,8 +73,11 @@ fn main() -> std::io::Result<()> {
let timestamps = vec![31499_000u32, 31500_000u32, 57760_000u32];
for timestamp in timestamps {
let time = num::BigUint::from(timestamp);
let val = state_signal.query_string_val_on_tmln(&time, &vcd).unwrap();
let val = state_signal
.query_string_val_on_tmln(&time, &vcd)
.unwrap();
println!("Signal `{name}` has value `{val}` at time `{time}`");
}
Ok(())

View file

@ -5,8 +5,8 @@
mod vcd;
pub use vcd::parse::parse_vcd;
pub use vcd::signal::{Signal, SignalType, SignalValue, SignalErrors};
pub use vcd::types::{Metadata, Timescale, Version};
pub use vcd::types::{ScopeIdx, SignalIdx, VCD};
pub use vcd::types::{Metadata, Timescale, Version};
pub use vcd::signal::{Signal};
pub use num::BigUint;

View file

@ -3,8 +3,8 @@
// and the YEHOWSHUA license, both of which can be found at
// the root of the folder containing the sources for this program.
pub(crate) mod parse;
mod reader;
pub(crate) mod signal;
pub(crate) mod types;
pub(crate) mod parse;
pub(crate) mod signal;
mod utilities;

View file

@ -2,14 +2,16 @@
// This program is distributed under both the GPLV3 license
// and the YEHOWSHUA license, both of which can be found at
// the root of the folder containing the sources for this program.
use std::fs::File;
mod combinator_atoms;
mod events;
mod types;
mod metadata;
mod scopes;
mod types;
mod events;
pub fn parse_vcd(file: impl std::io::Read) -> Result<super::types::VCD, String> {
pub fn parse_vcd(file: File) -> Result<super::types::VCD, String> {
let mut word_gen = super::reader::WordReader::new(file);
let header = metadata::parse_metadata(&mut word_gen)?;
@ -25,7 +27,6 @@ pub fn parse_vcd(file: impl std::io::Read) -> Result<super::types::VCD, String>
all_signals: vec![],
all_scopes: vec![],
root_scopes: vec![],
largest_timestamp: None,
};
scopes::parse_scopes(&mut word_gen, &mut vcd, &mut signal_map)?;

View file

@ -6,13 +6,15 @@ use super::super::reader::{next_word, WordReader};
use super::types::ParseResult;
pub(super) fn digit(chr: u8) -> bool {
let zero = b'0';
let nine = b'9';
let zero = b'0' as u8;
let nine = b'9' as u8;
(chr >= zero) && (nine >= chr)
let between_zero_and_nine = (chr >= zero) && (nine >= chr);
return between_zero_and_nine;
}
pub(super) fn take_until(word: &str, pattern: u8) -> ParseResult<'_> {
pub(super) fn take_until<'a>(word: &'a str, pattern: u8) -> ParseResult<'a> {
let mut new_start = 0;
for chr in word.as_bytes() {
@ -23,13 +25,13 @@ pub(super) fn take_until(word: &str, pattern: u8) -> ParseResult<'_> {
}
}
ParseResult {
return ParseResult {
matched: &word[0..new_start],
residual: &word[new_start..],
}
};
}
pub(super) fn take_while(word: &str, cond: fn(u8) -> bool) -> ParseResult<'_> {
pub(super) fn take_while<'a>(word: &'a str, cond: fn(u8) -> bool) -> ParseResult<'a> {
let mut new_start = 0;
for chr in word.as_bytes() {
@ -40,10 +42,10 @@ pub(super) fn take_while(word: &str, cond: fn(u8) -> bool) -> ParseResult<'_> {
}
}
ParseResult {
return ParseResult {
matched: &word[0..new_start],
residual: &word[new_start..],
}
};
}
pub(super) fn tag<'a>(word: &'a str, pattern: &'a str) -> ParseResult<'a> {
@ -61,23 +63,20 @@ pub(super) fn tag<'a>(word: &'a str, pattern: &'a str) -> ParseResult<'a> {
new_start += 1;
}
ParseResult {
return ParseResult {
matched: &word[0..new_start],
residual: &word[new_start..],
}
};
}
pub(super) fn ident<R: std::io::Read>(
word_reader: &mut WordReader<R>,
keyword: &str,
) -> Result<(), String> {
pub(super) fn ident(word_reader: &mut WordReader, keyword: &str) -> Result<(), String> {
// let keyword = "module";
let (word, cursor) = next_word!(word_reader)?;
if word == keyword {
Ok(())
return Ok(());
} else {
let err = format!("found keyword `{word}` but expected `{keyword}` on {cursor:?}");
Err(err)
return Err(err);
}
}

View file

@ -3,17 +3,18 @@
// and the YEHOWSHUA license, both of which can be found at
// the root of the folder containing the sources for this program.
use num::BigUint;
use std::collections::HashMap;
use num::BigUint;
use super::super::reader::{next_word, Cursor, Line, Word, WordReader};
use super::super::signal::{LsbIdxOfTmstmpValOnTmln, SignalEnum};
use super::super::utilities::{BinaryParserErrTypes, binary_str_to_vec_u8};
use super::super::signal::{SignalEnum, LsbIdxOfTmstmpValOnTmln};
use super::super::reader::{WordReader, Cursor, Line, Word, next_word};
use super::super::types::{SignalIdx, VCD};
use super::super::utilities::{binary_str_to_vec_u8, BinaryParserErrTypes};
pub(super) fn parse_events<R: std::io::Read>(
word_reader: &mut WordReader<R>,
vcd: &mut VCD,
pub(super) fn parse_events<'a>(
word_reader: &mut WordReader,
vcd: &'a mut VCD,
signal_map: &mut HashMap<String, SignalIdx>,
) -> Result<(), String> {
let mut curr_tmstmp_lsb_idx = 0u32;
@ -39,14 +40,14 @@ pub(super) fn parse_events<R: std::io::Read>(
"#" => {
let value = &word[1..];
let (f, l) = (file!(), line!());
let value_biguint = BigUint::parse_bytes(value.as_bytes(), 10)
let value = BigUint::parse_bytes(value.as_bytes(), 10)
.ok_or(())
.map_err(|_| {
format!(
"Error near {f}:{l}. Failed to parse {value} as BigInt at {cursor:?}"
)
})?;
let mut value = value_biguint.to_bytes_le();
let mut value = value.to_bytes_le();
// TODO : u32 helps with less memory, but should ideally likely be
// configurable.
curr_tmstmp_len_u8 = u8::try_from(value.len()).map_err(|_| {
@ -65,16 +66,15 @@ pub(super) fn parse_events<R: std::io::Read>(
)
})?;
vcd.tmstmps_encoded_as_u8s.append(&mut value);
vcd.largest_timestamp = Some(value_biguint);
}
// handle the case of an n bit signal whose value must be parsed
"b" => {
let binary_value = &word[1..];
let observed_num_bits = u32::try_from(binary_value.len()).map_err(|_| {
let observed_num_bits = u16::try_from(binary_value.len()).map_err(|_| {
format!(
"Error near {}:{}, {cursor:?}. \
Found signal with more than 2^32 - 1 bits.",
Found signal with more than 2^16 - 1 bits.",
file!(),
line!()
)
@ -85,9 +85,9 @@ pub(super) fn parse_events<R: std::io::Read>(
let mut store_as_string = false;
// If we encounter other values than 0 or 1, we can recover from
// If we encounter x or z in a value, we can recover from
// the error and store the value as a string.
// Or else, we propagate up other errors.
// Or else, we we propagate up other errors.
match binary_str_to_vec_u8(binary_value) {
Ok(result) => {
value_u8 = result;
@ -95,15 +95,10 @@ pub(super) fn parse_events<R: std::io::Read>(
Err(
BinaryParserErrTypes::XValue
| BinaryParserErrTypes::ZValue
| BinaryParserErrTypes::UValue
| BinaryParserErrTypes::WValue
| BinaryParserErrTypes::HValue
| BinaryParserErrTypes::DashValue
| BinaryParserErrTypes::LValue,
| BinaryParserErrTypes::UValue,
) => {
store_as_string = true;
// Turn to lower case for consistency
value_string = binary_value.to_ascii_lowercase();
value_string = binary_value.to_string();
}
Err(e) => {
let (f, l) = (file!(), line!());
@ -130,7 +125,7 @@ pub(super) fn parse_events<R: std::io::Read>(
match signal {
SignalEnum::Data {
name,
signal_type,
sig_type,
ref mut signal_error,
num_bits,
num_bytes,
@ -139,7 +134,6 @@ pub(super) fn parse_events<R: std::io::Read>(
lsb_indxs_of_num_tmstmp_vals_on_tmln,
byte_len_of_num_tmstmp_vals_on_tmln,
lsb_indxs_of_string_tmstmp_vals_on_tmln,
byte_len_of_string_tmstmp_vals_on_tmln,
..
} => {
// we've already identified in a prior loop iteration that the signal has
@ -158,7 +152,7 @@ pub(super) fn parse_events<R: std::io::Read>(
let (f, l) = (file!(), line!());
let msg = format!("\
Error near {f}:{l}. The bitwidth for signal {name} \
of signal_type {signal_type:?} is expected to be `{num_bits}` not \
of sig_type {sig_type:?} is expected to be `{num_bits}` not \
`{observed_num_bits}`. \
This error occurred while parsing the vcd file at \
{cursor:?}");
@ -171,7 +165,7 @@ pub(super) fn parse_events<R: std::io::Read>(
let msg = format!(
"\
Error near {f}:{l}. The bitwidth for signal {name} \
must be specified for a signal of type {signal_type:?}. \
must be specified for a signal of type {sig_type:?}. \
This error occurred while parsing the vcd file at \
{cursor:?}"
);
@ -182,7 +176,6 @@ pub(super) fn parse_events<R: std::io::Read>(
if store_as_string {
lsb_indxs_of_string_tmstmp_vals_on_tmln
.push(LsbIdxOfTmstmpValOnTmln(curr_tmstmp_lsb_idx));
byte_len_of_string_tmstmp_vals_on_tmln.push(curr_tmstmp_len_u8);
string_vals.push(value_string);
Ok(())
} else {
@ -200,11 +193,11 @@ pub(super) fn parse_events<R: std::io::Read>(
format!("Error near {}:{}. num_bytes empty.", file!(), line!())
})?;
let mut curr_num_bytes =
u16::try_from(value_u8.len()).map_err(|_| {
u8::try_from(value_u8.len()).map_err(|_| {
format!(
"Error near {}:{}. \
Found signal {name} with with value change of greater \
than 2^32 - 1 bits on {cursor:?}.",
than 2^16 - 1 bits on {cursor:?}.",
file!(),
line!()
)
@ -245,7 +238,7 @@ pub(super) fn parse_events<R: std::io::Read>(
match signal {
SignalEnum::Data {
name,
signal_type,
sig_type,
ref mut signal_error,
num_bits,
num_bytes,
@ -268,7 +261,7 @@ pub(super) fn parse_events<R: std::io::Read>(
let msg = format!(
"\
Error near {f}:{l}. The bitwidth for signal {name} \
of signal_type {signal_type:?} is expected to be `1` not \
of sig_type {sig_type:?} is expected to be `1` not \
`{num_bits}`. \
This error occurred while parsing the vcd file at \
{cursor:?}"
@ -282,7 +275,7 @@ pub(super) fn parse_events<R: std::io::Read>(
let msg = format!(
"\
Error near {f}:{l}. The bitwidth for signal {name} \
must be specified for a signal of type {signal_type:?}. \
must be specified for a signal of type {sig_type:?}. \
This error occurred while parsing the vcd file at \
{cursor:?}"
);
@ -336,7 +329,7 @@ pub(super) fn parse_events<R: std::io::Read>(
match signal {
SignalEnum::Data {
name,
signal_type,
sig_type,
ref mut signal_error,
num_bits,
num_bytes,
@ -359,7 +352,7 @@ pub(super) fn parse_events<R: std::io::Read>(
let msg = format!(
"\
Error near {f}:{l}. The bitwidth for signal {name} \
of signal_type {signal_type:?} is expected to be `1` not \
of sig_type {sig_type:?} is expected to be `1` not \
`{num_bits}`. \
This error occurred while parsing the vcd file at \
{cursor:?}"
@ -373,7 +366,7 @@ pub(super) fn parse_events<R: std::io::Read>(
let msg = format!(
"\
Error near {f}:{l}. The bitwidth for signal {name} \
must be specified for a signal of type {signal_type:?}. \
must be specified for a signal of type {sig_type:?}. \
This error occurred while parsing the vcd file at \
{cursor:?}"
);
@ -411,10 +404,9 @@ pub(super) fn parse_events<R: std::io::Read>(
}?;
}
// other one bit cases
"x" | "X" | "z" | "Z" | "u" | "U" | "h" | "H" | "l" | "L" | "w" | "W" | "-" => {
// Select value and turn to lowercase for consistency
let val = word[0..1].to_ascii_lowercase();
// // other one bit cases
"x" | "X" | "z" | "Z" | "u" | "U" => {
let val = word.to_string();
// lokup signal idx
let hash = &word[1..];
let signal_idx = signal_map.get(hash).ok_or(()).map_err(|_| {
@ -430,7 +422,7 @@ pub(super) fn parse_events<R: std::io::Read>(
match signal {
SignalEnum::Data {
name,
signal_type,
sig_type,
ref mut signal_error,
num_bits,
string_vals,
@ -452,7 +444,7 @@ pub(super) fn parse_events<R: std::io::Read>(
let msg = format!(
"\
Error near {f}:{l}. The bitwidth for signal {name} \
of signal_type {signal_type:?} is expected to be `1` not \
of sig_type {sig_type:?} is expected to be `1` not \
`{num_bits}`. \
This error occurred while parsing the vcd file at \
{cursor:?}"
@ -466,7 +458,7 @@ pub(super) fn parse_events<R: std::io::Read>(
let msg = format!(
"\
Error near {f}:{l}. The bitwidth for signal {name} \
must be specified for a signal of type {signal_type:?}. \
must be specified for a signal of type {sig_type:?}. \
This error occurred while parsing the vcd file at \
{cursor:?}"
);
@ -492,8 +484,7 @@ pub(super) fn parse_events<R: std::io::Read>(
}
}?;
}
// Store real values as a string as well and let the user parse it to an f64
"s" | " S" | "r" | "R" => {
"s" => {
let val = word[1..].to_string();
let (hash, cursor) = next_word!(word_reader)?;
// lokup signal idx

View file

@ -2,14 +2,14 @@
// This program is distributed under both the GPLV3 license
// and the YEHOWSHUA license, both of which can be found at
// the root of the folder containing the sources for this program.
use chrono::prelude::{DateTime, Utc};
use chrono::prelude::{DateTime, Utc, TimeZone};
use itertools::Itertools;
use super::super::reader::{next_word, Cursor, WordReader};
use super::super::types::{Metadata, Timescale, Version};
use super::super::reader::{Cursor, WordReader, next_word};
use super::super::types::{Timescale, Version, Metadata};
use super::combinator_atoms::{digit, tag, take_until, take_while};
use super::types::ParseResult;
use super::combinator_atoms::{take_until, take_while, digit, tag};
use super::types::{ParseResult};
pub(super) fn parse_date(
word_and_ctx1: (&str, &Cursor),
@ -133,9 +133,9 @@ pub(super) fn parse_date(
// unfortunately, the minutes, seconds, and hour could occur in an
// unexpected order
let full_date = format!("{day} {month} {date} {hh}:{mm}:{ss} {year}");
let full_date = DateTime::parse_from_str(full_date.as_str(), "%a %b %e %T %Y");
let full_date = Utc.datetime_from_str(full_date.as_str(), "%a %b %e %T %Y");
if full_date.is_ok() {
return Ok(full_date.unwrap().into());
return Ok(full_date.unwrap());
}
Err(format!(
@ -145,9 +145,7 @@ pub(super) fn parse_date(
))
}
pub(super) fn parse_version<R: std::io::Read>(
word_reader: &mut WordReader<R>,
) -> Result<Version, String> {
pub(super) fn parse_version(word_reader: &mut WordReader) -> Result<Version, String> {
let mut version = String::new();
loop {
@ -159,13 +157,13 @@ pub(super) fn parse_version<R: std::io::Read>(
return Ok(Version(version));
} else {
version.push_str(word);
version.push(' ');
version.push_str(" ");
}
}
}
pub(super) fn parse_timescale<R: std::io::Read>(
word_reader: &mut WordReader<R>,
pub(super) fn parse_timescale(
word_reader: &mut WordReader,
) -> Result<(Option<u32>, Timescale), String> {
// we might see `1ps $end` or `1 ps $end`
// first get timescale
@ -179,7 +177,7 @@ pub(super) fn parse_timescale<R: std::io::Read>(
.map_err(|e| format!("Error near {}:{}. {e}", file!(), line!()))?;
let timescale = {
if residual.is_empty() {
if residual == "" {
let (word, _) = next_word!(word_reader)?;
let unit = match word {
"fs" => Ok(Timescale::Fs),
@ -219,12 +217,10 @@ pub(super) fn parse_timescale<R: std::io::Read>(
let (word, _) = next_word!(word_reader)?;
tag(word, "$end").assert_match()?;
Ok(timescale)
return Ok(timescale);
}
pub(super) fn parse_metadata<R: std::io::Read>(
word_reader: &mut WordReader<R>,
) -> Result<Metadata, String> {
pub(super) fn parse_metadata(word_reader: &mut WordReader) -> Result<Metadata, String> {
let mut metadata = Metadata {
date: None,
version: None,
@ -331,5 +327,5 @@ pub(super) fn parse_metadata<R: std::io::Read>(
_ => {}
}
}
Ok(metadata)
return Ok(metadata);
}

View file

@ -5,67 +5,45 @@
/// part of the vcd parser that handles parsing the signal tree and
/// building the resulting signal tree
use std::collections::HashMap;
use super::super::reader::{curr_word, next_word, WordReader};
use super::super::signal::{SignalEnum, SignalType};
use super::super::types::{Scope, ScopeIdx, SignalIdx, VCD};
use super::super::reader::{WordReader, next_word, curr_word};
use super::super::types::{VCD, Scope, ScopeIdx, SignalIdx};
use super::super::signal::{SigType, SignalEnum};
use super::combinator_atoms::{ident, tag};
use super::types::ParseResult;
use super::combinator_atoms::{tag, ident};
use super::types::{ParseResult};
pub(super) fn parse_var<R: std::io::Read>(
word_reader: &mut WordReader<R>,
pub(super) fn parse_var<'a>(
word_reader: &mut WordReader,
parent_scope_idx: ScopeIdx,
vcd: &mut VCD,
vcd: &'a mut VCD,
signal_map: &mut HashMap<String, SignalIdx>,
path: &Vec<String>,
) -> Result<(), String> {
let (word, cursor) = next_word!(word_reader)?;
let expected_types = [
"event",
"integer",
"parameter",
"real",
"realtime",
"reg",
"string",
"supply0",
"supply1",
"time",
"tri",
"triand",
"trior",
"trireg",
"tri0",
"tri1",
"wand",
"wire",
"wor",
"tri1",
"time",
];
// $var parameter 3 a IDLE $end
// ^^^^^^^^^ - var_type
let var_type = match word {
"event" => Ok(SignalType::Event),
"integer" => Ok(SignalType::Integer),
"parameter" => Ok(SignalType::Parameter),
"real" => Ok(SignalType::Real),
"realtime" => Ok(SignalType::RealTime),
"reg" => Ok(SignalType::Reg),
"string" => Ok(SignalType::Str),
"supply0" => Ok(SignalType::Supply0),
"supply1" => Ok(SignalType::Supply1),
"tri" => Ok(SignalType::Tri),
"triand" => Ok(SignalType::TriAnd),
"trior" => Ok(SignalType::TriOr),
"trireg" => Ok(SignalType::TriReg),
"tri0" => Ok(SignalType::Tri0),
"tri1" => Ok(SignalType::Tri1),
"time" => Ok(SignalType::Time),
"wand" => Ok(SignalType::WAnd),
"wire" => Ok(SignalType::Wire),
"wor" => Ok(SignalType::WOr),
"integer" => Ok(SigType::Integer),
"parameter" => Ok(SigType::Parameter),
"real" => Ok(SigType::Real),
"reg" => Ok(SigType::Reg),
"string" => Ok(SigType::Str),
"wire" => Ok(SigType::Wire),
"tri1" => Ok(SigType::Tri1),
"time" => Ok(SigType::Time),
_ => {
let err = format!(
"Error near {}:{} \
@ -85,36 +63,25 @@ pub(super) fn parse_var<R: std::io::Read>(
// $var parameter 3 a IDLE $end
// ^ - num_bits
let num_bits = match var_type {
SignalType::Event
| SignalType::Integer
| SignalType::Parameter
| SignalType::Reg
| SignalType::Supply0
| SignalType::Supply1
| SignalType::Tri
| SignalType::TriAnd
| SignalType::TriOr
| SignalType::TriReg
| SignalType::Tri0
| SignalType::Tri1
| SignalType::Time
| SignalType::WAnd
| SignalType::Wire
| SignalType::WOr => {
let num_bits = word
.parse::<usize>()
.unwrap_or_else(|_| panic!("{}", parse_err));
let num_bits = u32::try_from(num_bits).map_err(|_| {
SigType::Integer
| SigType::Parameter
| SigType::Real
| SigType::Reg
| SigType::Wire
| SigType::Tri1
| SigType::Time => {
let num_bits = word.parse::<usize>().expect(parse_err.as_str());
let num_bits = u16::try_from(num_bits).map_err(|_| {
format!(
"Error near {}:{} while parsing vcd file at {cursor:?}. \
This signal has {num_bits} > 2^32 - 1 bits.",
This signal has {num_bits} > 2^16 - 1 bits.",
file!(),
line!()
)
})?;
Some(num_bits)
}
// for strings, reals, and realtimes we don't really care what the number of bits is
// for strings, we don't really care what the number of bits is
_ => None,
};
@ -126,12 +93,10 @@ pub(super) fn parse_var<R: std::io::Read>(
// $var parameter 3 a IDLE $end
// ^^^^ - full_signal_name(can extend until $end)
let mut full_signal_name = Vec::<String>::new();
let mut size = None;
loop {
let (word, _) = next_word!(word_reader)?;
match word {
"$end" => break,
other if other.starts_with('[') => size = Some(other.to_string()),
_ => full_signal_name.push(word.to_string()),
}
}
@ -151,12 +116,7 @@ pub(super) fn parse_var<R: std::io::Read>(
Some(ref_signal_idx) => {
let signal_idx = SignalIdx(vcd.all_signals.len());
let signal = SignalEnum::Alias {
name: full_signal_name.clone(),
path: path
.iter()
.cloned()
.chain([full_signal_name])
.collect::<Vec<String>>(),
name: full_signal_name,
signal_alias: *ref_signal_idx,
};
(signal, signal_idx)
@ -165,17 +125,11 @@ pub(super) fn parse_var<R: std::io::Read>(
let signal_idx = SignalIdx(vcd.all_signals.len());
signal_map.insert(signal_alias.to_string(), signal_idx);
let signal = SignalEnum::Data {
name: full_signal_name.clone(),
path: path
.iter()
.cloned()
.chain([full_signal_name])
.collect::<Vec<String>>(),
signal_type: var_type,
index: size,
name: full_signal_name,
sig_type: var_type,
signal_error: None,
num_bits,
num_bytes,
num_bits: num_bits,
num_bytes: num_bytes,
self_idx: signal_idx,
nums_encoded_as_fixed_width_le_u8: vec![],
string_vals: vec![],
@ -183,6 +137,7 @@ pub(super) fn parse_var<R: std::io::Read>(
byte_len_of_num_tmstmp_vals_on_tmln: vec![],
byte_len_of_string_tmstmp_vals_on_tmln: vec![],
lsb_indxs_of_string_tmstmp_vals_on_tmln: vec![],
scope_parent: parent_scope_idx,
};
(signal, signal_idx)
}
@ -198,9 +153,9 @@ pub(super) fn parse_var<R: std::io::Read>(
/// Sometimes, variables can be listed outside of scopes.
/// We call these orphaned vars.
fn parse_orphaned_vars<R: std::io::Read>(
word_reader: &mut WordReader<R>,
vcd: &mut VCD,
fn parse_orphaned_vars<'a>(
word_reader: &mut WordReader,
vcd: &'a mut VCD,
signal_map: &mut HashMap<String, SignalIdx>,
) -> Result<(), String> {
// create scope for unscoped signals if such a scope does not
@ -226,6 +181,7 @@ fn parse_orphaned_vars<R: std::io::Read>(
if !scope_already_exists {
vcd.all_scopes.push(Scope {
name: scope_name.to_string(),
parent_idx: None,
self_idx: scope_idx,
child_signals: vec![],
child_scopes: vec![],
@ -235,14 +191,14 @@ fn parse_orphaned_vars<R: std::io::Read>(
// we can go ahead and parse the current var as we've already encountered
// "$var" before now.
parse_var(word_reader, scope_idx, vcd, signal_map, &vec![])?;
parse_var(word_reader, scope_idx, vcd, signal_map)?;
loop {
let (word, cursor) = next_word!(word_reader)?;
match word {
"$var" => {
parse_var(word_reader, scope_idx, vcd, signal_map, &vec![])?;
parse_var(word_reader, scope_idx, vcd, signal_map)?;
}
"$scope" => break,
_ => {
@ -261,18 +217,17 @@ fn parse_orphaned_vars<R: std::io::Read>(
Ok(())
}
fn parse_scopes_inner<R: std::io::Read>(
word_reader: &mut WordReader<R>,
fn parse_scopes_inner<'a>(
word_reader: &mut WordReader,
parent_scope_idx: Option<ScopeIdx>,
vcd: &mut VCD,
vcd: &'a mut VCD,
signal_map: &mut HashMap<String, SignalIdx>,
path: &Vec<String>,
) -> Result<(), String> {
// $scope module reg_mag_i $end
// ^^^^^^ - module keyword
let (keyword, cursor) = next_word!(word_reader)?;
let expected = ["module", "begin", "task", "function", "fork"];
let expected = ["module", "begin", "task", "function"];
if expected.contains(&keyword) {
Ok(())
} else {
@ -289,12 +244,6 @@ fn parse_scopes_inner<R: std::io::Read>(
// $scope module reg_mag_i $end
// ^^^^^^^^^ - scope name
let (scope_name, _) = next_word!(word_reader)?;
// In some cases there are VCD files which have scopes without names.
// since these occur in the wild, we'll tolerate them even if it is unclear
// if it is supported or not by the spec.
if scope_name != "$end" {
let mut path = path.clone();
path.push(scope_name.to_string());
let curr_scope_idx = ScopeIdx(vcd.all_scopes.len());
@ -312,6 +261,7 @@ fn parse_scopes_inner<R: std::io::Read>(
// add this scope to list of existing scopes
vcd.all_scopes.push(Scope {
name: scope_name.to_string(),
parent_idx: parent_scope_idx,
self_idx: curr_scope_idx,
child_signals: vec![],
child_scopes: vec![],
@ -330,16 +280,10 @@ fn parse_scopes_inner<R: std::io::Read>(
match residual {
"scope" => {
// recursive - parse inside of current scope tree
parse_scopes_inner(
word_reader,
Some(curr_scope_idx),
vcd,
signal_map,
&path,
)?;
parse_scopes_inner(word_reader, Some(curr_scope_idx), vcd, signal_map)?;
}
"var" => {
parse_var(word_reader, curr_scope_idx, vcd, signal_map, &path)?;
parse_var(word_reader, curr_scope_idx, vcd, signal_map)?;
}
"upscope" => {
ident(word_reader, "$end")?;
@ -376,77 +320,13 @@ fn parse_scopes_inner<R: std::io::Read>(
}
}
}
} else {
// We'll be conservative and only allow new scopes in this case, and make the nameless
// scope completely transparent. I.e.
// $scope module a $end
// $scope module $end
// $scope module b $end
// ...
// $upscope
// $upscope
// $upscope
// will create `a.b`
loop {
let (word, cursor) = next_word!(word_reader)?;
let ParseResult { matched, residual } = tag(word, "$");
match matched {
// we hope that this word starts with a `$`
"$" => {
match residual {
"scope" => {
// recursive - parse inside of current scope tree
parse_scopes_inner(
word_reader,
parent_scope_idx,
vcd,
signal_map,
&path,
)?;
}
"upscope" => {
ident(word_reader, "$end")?;
break;
}
// we ignore comments
"comment" => loop {
if ident(word_reader, "$end").is_ok() {
break;
}
},
_ => {
let err = format!(
"Error near {}:{}. \
found keyword `{residual}` in annonyoums scope but expected \
`$scope`, `$comment`, or `$upscope` \
on {cursor:?}",
file!(),
line!()
);
return Err(err);
}
}
}
_ => {
let err = format!(
"Error near {}:{}. \
found keyword `{matched}` but \
expected `$` on {cursor:?}",
file!(),
line!()
);
return Err(err);
}
}
}
}
Ok(())
}
pub(super) fn parse_scopes<R: std::io::Read>(
word_reader: &mut WordReader<R>,
vcd: &mut VCD,
pub(super) fn parse_scopes<'a>(
word_reader: &mut WordReader,
vcd: &'a mut VCD,
signal_map: &mut HashMap<String, SignalIdx>,
) -> Result<(), String> {
// get the current word
@ -476,7 +356,7 @@ pub(super) fn parse_scopes<R: std::io::Read>(
}
// now for the interesting part
parse_scopes_inner(word_reader, None, vcd, signal_map, &vec![])?;
parse_scopes_inner(word_reader, None, vcd, signal_map)?;
// let err = format!("reached end of file without parser leaving {}", function_name!());
let expected_keywords = ["$scope", "$enddefinitions"];
@ -490,13 +370,13 @@ pub(super) fn parse_scopes<R: std::io::Read>(
match word {
"$scope" => {
parse_scopes_inner(word_reader, None, vcd, signal_map, &vec![])?;
parse_scopes_inner(word_reader, None, vcd, signal_map)?;
}
"$enddefinitions" => {
ident(word_reader, "$end")?;
break;
}
"$comment" => {
"comment" => {
// although we don't store comments, we still need to advance the
// word_reader cursor to the end of the comment
loop {

View file

@ -5,23 +5,25 @@
#[derive(Debug)]
pub(super) struct ParseResult<'a> {
pub(super) matched : &'a str,
pub(super) residual: &'a str,
}
pub(super) residual : &'a str}
impl<'a> ParseResult<'a> {
pub(super) fn assert_match(& self) -> Result<&str, String> {
if self.matched.is_empty() {
Err("no match".to_string())
} else {
Ok(self.matched)
if self.matched == "" {
return Err("no match".to_string())
}
else {
return Ok(self.matched)
}
}
pub(super) fn assert_residual(& self) -> Result<&str, String> {
if self.residual.is_empty() {
Err("no residual".to_string())
} else {
Ok(self.residual)
if self.residual == "" {
return Err("no residual".to_string())
}
else {
return Ok(self.residual)
}
}
}

View file

@ -3,6 +3,7 @@
// and the YEHOWSHUA license, both of which can be found at
// the root of the folder containing the sources for this program.
use std::collections::VecDeque;
use std::fs::File;
use std::io;
use std::io::BufRead;
use std::slice;
@ -15,8 +16,8 @@ pub(super) struct Word(pub(super) usize);
#[derive(Debug, Clone)]
pub(super) struct Cursor(pub(super) Line, pub(super) Word);
pub(super) struct WordReader<R: io::Read> {
reader: io::BufReader<R>,
pub(super) struct WordReader {
reader: io::BufReader<File>,
eof: bool,
buffers: Vec<String>,
curr_line: usize,
@ -24,11 +25,11 @@ pub(super) struct WordReader<R: io::Read> {
curr_slice: Option<(*const u8, usize, Cursor)>,
}
impl<R: std::io::Read> WordReader<R> {
pub(super) fn new(file: R) -> WordReader<R> {
impl WordReader {
pub(super) fn new(file: File) -> WordReader {
let reader = io::BufReader::new(file);
WordReader {
reader,
reader: reader,
eof: false,
buffers: vec![],
curr_line: 0,

View file

@ -2,49 +2,33 @@
// This program is distributed under both the GPLV3 license
// and the YEHOWSHUA license, both of which can be found at
// the root of the folder containing the sources for this program.
use super::types::{ScopeIdx, SignalIdx};
use super::types;
use super::types::SignalIdx;
use num::BigUint;
use num::{BigUint};
// Index to the least significant byte of a timestamp
// value on the timeline
#[derive(Debug, Copy, Clone)]
pub struct LsbIdxOfTmstmpValOnTmln(pub(super) u32);
#[derive(Debug, Eq, PartialEq, Clone)]
pub enum SignalType {
Event,
#[derive(Debug)]
pub enum SigType {
Integer,
Parameter,
Real,
RealTime,
Reg,
Str,
Supply0,
Supply1,
Time,
Tri,
TriAnd,
TriOr,
TriReg,
Tri0,
Tri1,
WAnd,
Wire,
WOr,
Tri1,
Time,
}
#[derive(Debug, PartialEq)]
pub enum SignalValue {
#[derive(Debug)]
pub(super) enum TimelineQueryResults {
BigUint(BigUint),
String(String),
}
pub struct QueryResult<T> {
pub current: Option<(TimeStamp, T)>,
pub next: Option<TimeStamp>,
}
pub struct Signal<'a>(pub(super) &'a SignalEnum);
impl<'a> Signal<'a> {
@ -52,127 +36,21 @@ impl<'a> Signal<'a> {
let Signal(signal_enum) = &self;
signal_enum.name()
}
pub fn name_with_index(&self) -> String {
let Signal(signal_enum) = &self;
signal_enum.name_with_index()
}
pub fn index(&self) -> Option<String> {
let Signal(signal_enum) = &self;
signal_enum.index()
}
pub fn path(&self) -> &[String] {
match self.0 {
SignalEnum::Data { path, .. } => path,
SignalEnum::Alias { path, .. } => path,
}
}
pub fn signal_type(&self) -> Option<&SignalType> {
let Signal(signal_enum) = &self;
signal_enum.signal_type()
}
pub fn real_idx(&self) -> SignalIdx {
match self.0 {
SignalEnum::Data { self_idx, .. } => *self_idx,
SignalEnum::Alias { signal_alias, .. } => *signal_alias,
}
}
pub fn num_bits(&self) -> Option<u32> {
let Signal(signal_enum) = &self;
signal_enum.bits_required()
}
// NOTE: (zoq) I am removing thse because they aren't used in Surfer so I can't test them
// properly
/*
pub fn query_string_val_on_tmln(
&self,
desired_time: &BigUint,
vcd: &types::VCD,
) -> Result<String, SignalErrors> {
let Signal(signal_enum) = &self;
signal_enum
.query_string_val_on_tmln(desired_time, &vcd.tmstmps_encoded_as_u8s, &vcd.all_signals)
.map(|QueryResult{current, next: _}| current.map(|c| c.1))
signal_enum.query_string_val_on_tmln(desired_time, &vcd.tmstmps_encoded_as_u8s, &vcd.all_signals)
}
pub fn query_num_val_on_tmln(
&self,
desired_time: &BigUint,
vcd: &types::VCD,
) -> Result<Option<BigUint>, SignalErrors> {
) -> Result<BigUint, SignalErrors> {
let Signal(signal_enum) = &self;
signal_enum
.query_num_val_on_tmln(desired_time, &vcd.tmstmps_encoded_as_u8s, &vcd.all_signals)
.map(|QueryResult{current, next: _}| current.map(|c| c.1))
}
*/
pub fn query_val_on_tmln(
&self,
desired_time: &BigUint,
vcd: &types::VCD,
) -> Result<QueryResult<SignalValue>, SignalErrors> {
let Signal(signal_enum) = &self;
let num_query_out = signal_enum.query_num_val_on_tmln(
desired_time,
&vcd.tmstmps_encoded_as_u8s,
&vcd.all_signals,
);
let str_query_out = signal_enum.query_string_val_on_tmln(
desired_time,
&vcd.tmstmps_encoded_as_u8s,
&vcd.all_signals,
);
// Both num and str will return the newest value that is closest to
// the desired time. If both have valid values, select the most recent
// one
match (num_query_out, str_query_out) {
(Ok(num_result), Ok(str_result)) => {
let next = match (num_result.next, str_result.next) {
(Some(n), Some(s)) => Some(n.min(s)),
(Some(n), None) => Some(n),
(None, Some(s)) => Some(s),
(None, None) => None,
};
match (num_result.current, str_result.current) {
(Some((num_time, num_value)), Some((str_time, str_value))) => {
if num_time > str_time {
Ok(QueryResult {
current: Some((num_time, SignalValue::BigUint(num_value))),
next,
})
} else {
Ok(QueryResult {
current: Some((str_time, SignalValue::String(str_value))),
next,
})
}
}
(Some((num_time, num_val)), None) => Ok(QueryResult {
current: Some((num_time, SignalValue::BigUint(num_val))),
next,
}),
(None, Some((str_time, str_value))) => Ok(QueryResult {
current: Some((str_time, SignalValue::String(str_value))),
next,
}),
(None, None) => Ok(QueryResult {
current: None,
next,
}),
}
}
(_e, Err(e)) => Err(e),
(Err(e), _e) => Err(e),
}
signal_enum.query_num_val_on_tmln(desired_time, &vcd.tmstmps_encoded_as_u8s, &vcd.all_signals)
}
}
@ -180,18 +58,14 @@ impl<'a> Signal<'a> {
pub(super) enum SignalEnum {
Data {
name: String,
path: Vec<String>,
signal_type: SignalType,
/// The optional [start:end] part of the signal name that is sometimes
/// added to signals
index: Option<String>,
sig_type: SigType,
/// I've seen a 0 bit signal parameter in a xilinx
/// simulation before that gets assigned 1 bit values.
/// I consider this to be bad behavior. We capture such
/// errors in the following type:
signal_error: Option<String>,
num_bits: Option<u32>,
num_bytes: Option<u16>,
num_bits: Option<u16>,
num_bytes: Option<u8>,
/// TODO : may be able to remove self_idx
self_idx: SignalIdx,
/// A signal may take on a new value and hold that value
@ -219,16 +93,20 @@ pub(super) enum SignalEnum {
byte_len_of_num_tmstmp_vals_on_tmln: Vec<u8>,
byte_len_of_string_tmstmp_vals_on_tmln: Vec<u8>,
lsb_indxs_of_string_tmstmp_vals_on_tmln: Vec<LsbIdxOfTmstmpValOnTmln>,
scope_parent: ScopeIdx,
},
Alias {
name: String,
path: Vec<String>,
signal_alias: SignalIdx,
},
}
#[derive(Debug)]
pub enum SignalErrors {
PreTimeline {
desired_time: BigUint,
timeline_start_time: BigUint,
},
EmptyTimeline,
TimelineNotMultiple,
StrTmlnLenMismatch,
@ -251,40 +129,10 @@ impl SignalEnum {
pub fn name(&self) -> String {
match self {
SignalEnum::Data { name, ..} => name,
SignalEnum::Alias { name, .. } => name,
}
.clone()
SignalEnum::Alias { name, .. } => name
}.clone()
}
pub fn signal_type(&self) -> Option<&SignalType> {
match self {
SignalEnum::Data { signal_type, .. } => Some(signal_type),
// TODO: Follow aliases?
SignalEnum::Alias { .. } => None,
}
.clone()
}
pub fn name_with_index(&self) -> String {
match self {
SignalEnum::Data {
name, index: None, ..
} => format!("{name}"),
SignalEnum::Data {
name,
index: Some(size),
..
} => format!("{name} {size}"),
SignalEnum::Alias { name, .. } => name.clone(),
}
}
pub fn index(&self) -> Option<String> {
match self {
SignalEnum::Data { index, .. } => index.clone(),
SignalEnum::Alias { .. } => None,
}
}
}
// helper functions ultimately used by Signal's query functions later on
@ -292,12 +140,12 @@ impl SignalEnum {
/// Computes the bytes required to store a signal's numerical value
/// using the num_bits which another function would provide from
/// the num_bits field of the Signal::Data variant.
pub(super) fn bytes_required(num_bits: u32, name: &String) -> Result<u16, String> {
pub(super) fn bytes_required(num_bits: u16, name: &String) -> Result<u8, String> {
let bytes_required = (num_bits / 8) + if (num_bits % 8) > 0 { 1 } else { 0 };
let bytes_required = u16::try_from(bytes_required).map_err(|_| {
let bytes_required = u8::try_from(bytes_required).map_err(|_| {
format!(
"Error near {}:{}. Signal {name} of length num_bits requires \
{bytes_required} > 65536 bytes.",
{bytes_required} > 256 bytes.",
file!(),
line!()
)
@ -339,10 +187,6 @@ impl SignalEnum {
lsb_indxs_of_string_tmstmp_vals_on_tmln[event_idx];
let timestamp_idx = timestamp_idx as usize;
if byte_len_of_string_tmstmp_vals_on_tmln.is_empty() {
return Err(SignalErrors::EmptyTimeline);
}
// form timestamp
let byte_len = byte_len_of_string_tmstmp_vals_on_tmln[event_idx] as usize;
let timestamp = &tmstmps_encoded_as_u8s[timestamp_idx..(timestamp_idx + byte_len)];
@ -409,14 +253,6 @@ impl SignalEnum {
Ok((timestamp, signal_val))
}
fn bits_required(&self) -> Option<u32> {
match self {
SignalEnum::Data { num_bits, .. } => *num_bits,
// TODO: Follow aliases?
SignalEnum::Alias { .. } => None,
}
}
}
// Val and string query functions.
@ -429,7 +265,7 @@ impl SignalEnum {
desired_time: &BigUint,
tmstmps_encoded_as_u8s: &Vec<u8>,
all_signals: &Vec<SignalEnum>,
) -> Result<QueryResult<String>, SignalErrors> {
) -> Result<String, SignalErrors> {
let signal_idx = match self {
Self::Data { self_idx, .. } => {
let SignalIdx(idx) = self_idx;
@ -438,7 +274,6 @@ impl SignalEnum {
Self::Alias {
name: _,
signal_alias,
path: _,
} => {
let SignalIdx(idx) = signal_alias;
*idx
@ -451,22 +286,24 @@ impl SignalEnum {
// 2. the vector of indices into timeline where events occur
// for this signal
// else we propagate Err(..).
let (string_vals, lsb_indxs_of_string_tmstmp_vals_on_tmln) = match &all_signals[signal_idx]
{
let (string_vals, lsb_indxs_of_string_tmstmp_vals_on_tmln) =
match &all_signals[signal_idx] {
SignalEnum::Data {
ref string_vals,
ref lsb_indxs_of_string_tmstmp_vals_on_tmln,
..
} => Ok((string_vals, lsb_indxs_of_string_tmstmp_vals_on_tmln)),
} => {
Ok((
string_vals,
lsb_indxs_of_string_tmstmp_vals_on_tmln,
))
}
SignalEnum::Alias { .. } => Err(SignalErrors::PointsToAlias),
}?;
// this signal should at least have some events, otherwise, trying to index into
// an empty vector later on would fail
if lsb_indxs_of_string_tmstmp_vals_on_tmln.is_empty() {
return Ok(QueryResult {
current: None,
next: None
});
return Err(SignalErrors::EmptyTimeline);
}
// the vector of string timeline lsb indices should have the same
@ -480,9 +317,9 @@ impl SignalEnum {
let (timeline_start_time, _) =
self.time_and_str_val_at_event_idx(0, tmstmps_encoded_as_u8s)?;
if *desired_time < timeline_start_time {
return Ok(QueryResult {
current: None,
next: Some(timeline_start_time),
return Err(SignalErrors::PreTimeline {
desired_time: desired_time.clone(),
timeline_start_time: timeline_start_time,
});
}
@ -494,10 +331,7 @@ impl SignalEnum {
// check if we're requesting a value that occurs beyond the end of the timeline,
// if so, return the last value in this timeline
if *desired_time > timeline_end_time {
return Ok(QueryResult {
current: Some((timeline_end_time, timeline_end_val.to_string())),
next: None,
});
return Ok(timeline_end_val.to_string());
}
// This while loop is the meat of the lookup. Performance is log2(n),
@ -516,21 +350,7 @@ impl SignalEnum {
lower_idx = mid_idx + 1;
}
std::cmp::Ordering::Equal => {
let next_time = if mid_idx < lsb_indxs_of_string_tmstmp_vals_on_tmln.len() - 1 {
Some(
self.time_and_str_val_at_event_idx(
mid_idx + 1,
tmstmps_encoded_as_u8s,
)?
.0,
)
} else {
None
};
return Ok(QueryResult {
current: Some((curr_time, curr_val.to_string())),
next: next_time,
});
return Ok(curr_val.to_string());
}
std::cmp::Ordering::Greater => {
upper_idx = mid_idx - 1;
@ -553,17 +373,14 @@ impl SignalEnum {
});
}
Ok(QueryResult {
current: Some((left_time, left_val.to_string())),
next: Some(right_time),
})
return Ok(left_val.to_string());
}
pub fn query_num_val_on_tmln(
&self,
desired_time: &BigUint,
tmstmps_encoded_as_u8s: &Vec<u8>,
all_signals: &Vec<SignalEnum>,
) -> Result<QueryResult<BigUint>, SignalErrors> {
) -> Result<BigUint, SignalErrors> {
let signal_idx = match self {
Self::Data { self_idx, .. } => {
let SignalIdx(idx) = self_idx;
@ -571,7 +388,6 @@ impl SignalEnum {
}
Self::Alias {
name: _,
path: _,
signal_alias,
} => {
let SignalIdx(idx) = signal_alias;
@ -608,10 +424,7 @@ impl SignalEnum {
// this signal should at least have some events, otherwise, trying to index into
// an empty vector later on would fail
if lsb_indxs_of_num_tmstmp_vals_on_tmln.is_empty() {
return Ok(QueryResult {
current: None,
next: None
});
return Err(SignalErrors::EmptyTimeline);
}
// assertion that value_sequence is a proper multiple of
@ -634,9 +447,9 @@ impl SignalEnum {
let (timeline_start_time, _) =
self.time_and_num_val_at_event_idx(0, tmstmps_encoded_as_u8s)?;
if *desired_time < timeline_start_time {
return Ok(QueryResult {
current: None,
next: Some(timeline_start_time),
return Err(SignalErrors::PreTimeline {
desired_time: desired_time.clone(),
timeline_start_time: timeline_start_time,
});
}
@ -648,10 +461,7 @@ impl SignalEnum {
// check if we're requesting a value that occurs beyond the end of the timeline,
// if so, return the last value in this timeline
if *desired_time > timeline_end_time {
return Ok(QueryResult {
current: Some((timeline_end_time, timeline_end_val)),
next: None,
});
return Ok(timeline_end_val);
}
// This while loop is the meat of the lookup. Performance is log2(n),
@ -670,21 +480,7 @@ impl SignalEnum {
lower_idx = mid_idx + 1;
}
std::cmp::Ordering::Equal => {
let next_time = if mid_idx < lsb_indxs_of_num_tmstmp_vals_on_tmln.len() - 1 {
Some(
self.time_and_num_val_at_event_idx(
mid_idx + 1,
tmstmps_encoded_as_u8s,
)?
.0,
)
} else {
None
};
return Ok(QueryResult {
current: Some((curr_time, curr_val)),
next: next_time,
});
return Ok(curr_val);
}
std::cmp::Ordering::Greater => {
upper_idx = mid_idx - 1;
@ -707,9 +503,6 @@ impl SignalEnum {
});
}
return Ok(QueryResult {
current: Some((left_time, left_val)),
next: Some(right_time),
});
return Ok(left_val);
}
}

View file

@ -4,15 +4,13 @@
// This program is distributed under both the GPLV3 license
// and the YEHOWSHUA license, both of which can be found at
// the root of the folder containing the sources for this program.
use super::signal::{Signal, SignalEnum};
use chrono::prelude::{DateTime, Utc};
use num::BigUint;
use std::fmt;
use super::signal::{Signal, SignalEnum};
#[derive(Debug, Clone)]
#[derive(Debug)]
pub struct Version(pub String);
#[derive(Debug, Clone, Copy, Eq, PartialEq)]
#[derive(Debug)]
pub enum Timescale {
Fs,
Ps,
@ -23,20 +21,6 @@ pub enum Timescale {
Unit,
}
impl fmt::Display for Timescale {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
Timescale::Fs => write!(f, "fs"),
Timescale::Ps => write!(f, "ps"),
Timescale::Ns => write!(f, "ns"),
Timescale::Us => write!(f, "μs"),
Timescale::Ms => write!(f, "ms"),
Timescale::S => write!(f, "s"),
Timescale::Unit => write!(f, "unit"),
}
}
}
#[derive(Debug)]
pub struct Metadata {
pub date: Option<DateTime<Utc>>,
@ -45,16 +29,17 @@ pub struct Metadata {
}
// We do a lot of arena allocation in this codebase.
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
#[derive(Debug, Copy, Clone, PartialEq)]
pub struct ScopeIdx(pub usize);
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
#[derive(Debug, Copy, Clone, PartialEq)]
pub struct SignalIdx(pub usize);
#[derive(Debug)]
pub(super) struct Scope {
pub(super) name: String,
pub(super) parent_idx: Option<ScopeIdx>,
pub(super) self_idx: ScopeIdx,
pub(super) child_signals: Vec<SignalIdx>,
@ -78,7 +63,6 @@ pub struct VCD {
pub(super) all_signals: Vec<SignalEnum>,
pub(super) all_scopes: Vec<Scope>,
pub(super) root_scopes: Vec<ScopeIdx>,
pub(super) largest_timestamp: Option<BigUint>,
}
impl VCD {
@ -100,7 +84,7 @@ impl VCD {
let scope = &self.all_scopes[idx];
&scope.name
}
pub fn signal_from_signal_idx(&self, idx: SignalIdx) -> Signal<'_> {
pub fn signal_from_signal_idx<'a>(&'a self, idx: SignalIdx) -> Signal<'a> {
let SignalIdx(idx) = idx;
let signal_enum = &self.all_signals[idx];
return Signal(signal_enum);
@ -137,8 +121,4 @@ impl VCD {
)),
}
}
pub fn max_timestamp(&self) -> &Option<BigUint> {
&self.largest_timestamp
}
}

View file

@ -7,10 +7,6 @@ pub(super) enum BinaryParserErrTypes {
XValue,
ZValue,
UValue,
HValue,
LValue,
DashValue,
WValue,
OtherValue(char),
TooLong,
}
@ -38,15 +34,11 @@ fn base2_str_to_byte(word: &[u8]) -> Result<u8, BinaryParserErrTypes> {
for (idx, chr) in word.iter().rev().enumerate() {
match chr {
b'1' => val |= bit_lut[idx],
b'1' => val = bit_lut[idx] | val,
b'0' => {}
b'x' | b'X' => return Err(BinaryParserErrTypes::XValue),
b'z' | b'Z' => return Err(BinaryParserErrTypes::ZValue),
b'u' | b'U' => return Err(BinaryParserErrTypes::UValue),
b'l' | b'L' => return Err(BinaryParserErrTypes::LValue),
b'h' | b'H' => return Err(BinaryParserErrTypes::HValue),
b'w' | b'W' => return Err(BinaryParserErrTypes::WValue),
b'-' => return Err(BinaryParserErrTypes::DashValue),
_ => return Err(BinaryParserErrTypes::OtherValue(*chr as char)),
}
}
@ -73,13 +65,13 @@ pub(super) fn binary_str_to_vec_u8(binary_str: &str) -> Result<Vec<u8>, BinaryPa
if head_idx < 8 {
head_idx = 0
} else {
head_idx -= 8;
head_idx = head_idx - 8;
}
if tail_idx < 8 {
tail_idx = 0
} else {
tail_idx -= 8;
tail_idx = tail_idx - 8;
}
}
Ok(vec_u8)

View file

@ -5,7 +5,7 @@
// TODO: we should eventually be able to only test on just
// the files const
pub const FILES: [&str; 31] = [
pub const FILES : [&str; 30] = [
"./tests/vcd-files/aldec/SPI_Write.vcd",
"./tests/vcd-files/ghdl/alu.vcd",
"./tests/vcd-files/ghdl/idea.vcd",
@ -36,8 +36,7 @@ pub const FILES: [&str; 31] = [
"./tests/vcd-files/xilinx_isim/test.vcd",
"./tests/vcd-files/xilinx_isim/test1.vcd",
// TODO : add signal ignore list to handle bitwidth mismatches
"./tests/vcd-files/xilinx_isim/test2x2_regex22_string1.vcd",
"./tests/vcd-files/scope_with_comment.vcd",
"./tests/vcd-files/xilinx_isim/test2x2_regex22_string1.vcd"
];
pub const GOOD_DATE_FILES : [&str; 24] = [
@ -64,7 +63,7 @@ pub const GOOD_DATE_FILES: [&str; 24] = [
"./test-vcd-files/verilator/vlt_dump.vcd",
"./test-vcd-files/xilinx_isim/test.vcd",
"./test-vcd-files/xilinx_isim/test1.vcd",
"./test-vcd-files/xilinx_isim/test2x2_regex22_string1.vcd",
"./test-vcd-files/xilinx_isim/test2x2_regex22_string1.vcd"
];
pub const BAD_DATE_FILES : [&str; 6] = [

View file

@ -1,296 +0,0 @@
$date
Sat Dec 26 15:33:14 2020
$end
$version
ModelSim Version 10.5b
$end
$timescale
1ns
$end
$scope module clkdiv2n_tb $end
$comment foo $end
$var reg 1 ! clk $end
$var reg 1 " reset $end
$var wire 1 # clk_out $end
$scope module t1 $end
$var parameter 32 $ WIDTH $end
$var parameter 32 % N $end
$var wire 1 & clk $end
$var wire 1 ' reset $end
$var wire 1 # clk_out $end
$var reg 3 ( r_reg [2:0] $end
$var wire 1 ) r_nxt [2] $end
$var wire 1 * r_nxt [1] $end
$var wire 1 + r_nxt [0] $end
$var reg 1 , clk_track $end
$upscope $end
$comment foo $end
$upscope $end
$comment foo $end
$enddefinitions $end
#0
$comment foo $end
$dumpvars
0!
x"
bx (
x,
b11 $
b110 %
x#
x+
x*
x)
x'
0&
$end
#5
1"
1'
b0 (
0,
1+
0*
0)
0#
#10
1!
1&
#15
0"
0'
#20
0!
0&
#30
1!
1&
b1 (
0+
1*
#40
0!
0&
#50
1!
1&
b10 (
1+
#60
0!
0&
#70
1!
1&
b11 (
0+
0*
1)
#80
0!
0&
#90
1!
1&
b100 (
1+
#100
0!
0&
#110
1!
1&
b101 (
0+
1*
#120
0!
0&
#130
1!
1&
b0 (
1,
1+
0*
0)
1#
#140
0!
0&
#150
1!
1&
b1 (
0+
1*
#160
0!
0&
#170
1!
1&
b10 (
1+
#180
0!
0&
#190
1!
1&
b11 (
0+
0*
1)
#200
0!
0&
#210
1!
1&
b100 (
1+
#220
0!
0&
#230
1!
1&
b101 (
0+
1*
#240
0!
0&
#250
1!
1&
b0 (
0,
1+
0*
0)
0#
#260
0!
0&
#270
1!
1&
b1 (
0+
1*
#280
0!
0&
#290
1!
1&
b10 (
1+
#300
0!
0&
#310
1!
1&
b11 (
0+
0*
1)
#320
0!
0&
#330
1!
1&
b100 (
1+
#340
0!
0&
#350
1!
1&
b101 (
0+
1*
#360
0!
0&
#370
1!
1&
b0 (
1,
1+
0*
0)
1#
#380
0!
0&
#390
1!
1&
b1 (
0+
1*
#400
0!
0&
#410
1!
1&
b10 (
1+
#420
0!
0&
#430
1!
1&
b11 (
0+
0*
1)
#440
0!
0&
#450
1!
1&
b100 (
1+
#460
0!
0&
#470
1!
1&
b101 (
0+
1*
#480
0!
0&
#490
1!
1&
b0 (
0,
1+
0*
0)
0#
#500
0!
0&
#510
1!
1&
b1 (
0+
1*