refactor parse a bit
This commit is contained in:
Yehowshua Immanuel
parent
b685bf8be7
commit
e931d9a825
3 changed files with 616 additions and 597 deletions
504
src/vcd/parse/events.rs
Normal file
504
src/vcd/parse/events.rs
Normal file
|
|
@ -0,0 +1,504 @@
|
|||
//! part of the vcd parser that handles parsing the signal tree and
|
||||
//! building the resulting signal tree
|
||||
use function_name::named;
|
||||
|
||||
use super::*;
|
||||
|
||||
#[derive(Debug)]
|
||||
pub(super) enum BinaryParserErrTypes {x_value, z_value, u_value, other_value(char), too_long}
|
||||
|
||||
// We build a quick and not so dirty bit string parser.
|
||||
fn base2_str_to_byte(word : &[u8]) -> Result<u8, BinaryParserErrTypes> {
|
||||
let mut val = 0u8;
|
||||
|
||||
// shouldn't have more than 8 chars in str
|
||||
let len = word.len();
|
||||
if len > 8 {
|
||||
let (f, l )= (file!(), line!());
|
||||
let err = format!(
|
||||
"Error near {f}:{l}. Base2 string has length {len} > 8.");
|
||||
return Err(BinaryParserErrTypes::too_long)
|
||||
}
|
||||
|
||||
let bit_lut = [
|
||||
0b0000_0001u8,
|
||||
0b0000_0010u8,
|
||||
0b0000_0100u8,
|
||||
0b0000_1000u8,
|
||||
0b0001_0000u8,
|
||||
0b0010_0000u8,
|
||||
0b0100_0000u8,
|
||||
0b1000_0000u8
|
||||
];
|
||||
|
||||
for (idx, chr) in word.iter().rev().enumerate() {
|
||||
match chr {
|
||||
b'1' => {val = bit_lut[idx] | val}
|
||||
b'0' => {}
|
||||
b'x' | b'X' => {return Err(BinaryParserErrTypes::x_value)}
|
||||
b'z' | b'Z' => {return Err(BinaryParserErrTypes::z_value)}
|
||||
b'u' | b'U' => {return Err(BinaryParserErrTypes::u_value)}
|
||||
_ => {return Err(BinaryParserErrTypes::other_value(*chr as char))}
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
Ok(val)
|
||||
}
|
||||
|
||||
fn binary_str_to_vec_u8(binary_str : &str) -> Result<Vec<u8>, BinaryParserErrTypes> {
|
||||
let mut vec_u8 : Vec<u8> = Vec::new();
|
||||
let mut binary_str_as_bytes = binary_str.as_bytes();
|
||||
|
||||
let mut tail_idx = binary_str_as_bytes.len();
|
||||
// clamp head if provided binary str is less than 8 long
|
||||
let mut head_idx =
|
||||
if tail_idx >= 8
|
||||
{binary_str_as_bytes.len() - 8}
|
||||
else
|
||||
{0};
|
||||
while {tail_idx > 0} {
|
||||
let curr_b_val = &binary_str_as_bytes[head_idx..tail_idx];
|
||||
let val_u8 = base2_str_to_byte(curr_b_val)?;
|
||||
vec_u8.push(val_u8);
|
||||
|
||||
|
||||
if head_idx < 8 {
|
||||
head_idx = 0
|
||||
}
|
||||
else {
|
||||
head_idx = head_idx - 8;
|
||||
}
|
||||
|
||||
if tail_idx < 8 {
|
||||
tail_idx = 0
|
||||
}
|
||||
else {
|
||||
tail_idx = tail_idx - 8;
|
||||
}
|
||||
|
||||
}
|
||||
Ok(vec_u8)
|
||||
}
|
||||
|
||||
#[named]
|
||||
pub(super) fn parse_events<'a>(
|
||||
word_reader : &mut WordReader,
|
||||
vcd : &'a mut VCD,
|
||||
signal_map : &mut HashMap<String, Signal_Idx>
|
||||
) -> Result<(), String> {
|
||||
|
||||
loop {
|
||||
let next_word = word_reader.next_word();
|
||||
// if we've reached the end of the file, then there is obviously
|
||||
// nothing left to do...
|
||||
if next_word.is_none() {break};
|
||||
|
||||
let (word, cursor) = next_word.unwrap();
|
||||
let Cursor(Line(_), Word(word_in_line_idx)) = cursor;
|
||||
// we only want to match on the first word in a line
|
||||
if word_in_line_idx != 1 {continue}
|
||||
match &word[0..1] {
|
||||
"$" => {}
|
||||
"#" => {
|
||||
let value = &word[1..];
|
||||
let (f, l )= (file!(), line!());
|
||||
let value = BigInt::parse_bytes(value.as_bytes(), 10).ok_or(
|
||||
format!("Error near {f}:{l}. Failed to parse {value} as BigInt at {cursor:?}").as_str())?;
|
||||
let (_, mut value) = value.to_bytes_le();
|
||||
// TODO : u32 helps with less memory, but should ideally likely be
|
||||
// configurable.
|
||||
let (f, l )= (file!(), line!());
|
||||
let start_idx = u32::try_from(vcd.timeline.len()).map_err(
|
||||
|e| format!("Error near {f}:{l}. Failed to convert from usize to u32."))?;
|
||||
vcd.timeline_markers.push(StartIdx(start_idx));
|
||||
vcd.timeline.append(&mut value);
|
||||
}
|
||||
|
||||
// handle the case of an n bit signal whose value must be parsed
|
||||
"b" => {
|
||||
let binary_value = &word[1..];
|
||||
let observed_num_bits = binary_value.len();
|
||||
let (f, l )= (file!(), line!());
|
||||
|
||||
let mut value_u8 : Vec<u8> = Vec::new();
|
||||
let mut value_string = String::new();
|
||||
|
||||
let mut store_as_string = false;
|
||||
|
||||
// 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 we propagate up other errors.
|
||||
match binary_str_to_vec_u8(binary_value) {
|
||||
Ok(result) => {value_u8 = result;}
|
||||
Err(BinaryParserErrTypes::x_value |
|
||||
BinaryParserErrTypes::z_value |
|
||||
BinaryParserErrTypes::u_value
|
||||
) =>
|
||||
{
|
||||
store_as_string = true;
|
||||
value_string = binary_value.to_string();
|
||||
}
|
||||
Err(e) => {
|
||||
let (f, l )= (file!(), line!());
|
||||
Err(e).map_err(
|
||||
|e| format!("Error near {f}:{l}. Error {e:?} at {cursor:?}."))?;
|
||||
}
|
||||
}
|
||||
|
||||
// this word should be the signal alias
|
||||
let (word, cursor) = word_reader.next_word().unwrap();
|
||||
|
||||
// lookup signal idx
|
||||
let (f, l )= (file!(), line!());
|
||||
let Signal_Idx(ref signal_idx) = signal_map.get(word).ok_or(
|
||||
format!("Error near {f}:{l}. Failed to lookup signal {word} at {cursor:?}"))?;
|
||||
|
||||
// account for fact that signal idx could be an alias, so there
|
||||
// could be one step of indirection
|
||||
let signal_idx =
|
||||
{
|
||||
let signal = vcd.all_signals.get(*signal_idx).unwrap();
|
||||
match signal {
|
||||
Signal::Data {..} => {*signal_idx}
|
||||
Signal::Alias {name, signal_alias} => {
|
||||
let Signal_Idx(ref signal_idx) = signal_alias;
|
||||
signal_idx.clone()
|
||||
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
// after handling potential indirection, go ahead and update the timeline
|
||||
// of the signal signal_idx references
|
||||
let signal = vcd.all_signals.get_mut(signal_idx).unwrap();
|
||||
match signal {
|
||||
Signal::Data {name, sig_type, ref mut signal_error, num_bits,
|
||||
self_idx, u8_timeline, u8_timeline_markers, string_timeline,
|
||||
string_timeline_markers, ..} => {
|
||||
|
||||
if signal_error.is_some() {continue;}
|
||||
|
||||
// Get the observed number of bits for the value parsed earlier
|
||||
// and verify that it is not greater than the numbits declared
|
||||
// when the signal was declared.
|
||||
// Also account for the error case of a bitwidth of `None`
|
||||
match num_bits {
|
||||
Some(ref num_bits) => {
|
||||
if observed_num_bits > *num_bits {
|
||||
let (f, l) = (file!(), line!());
|
||||
let msg = format!("\
|
||||
Error near {f}:{l}. The bitwidth for signal {name} \
|
||||
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:?}");
|
||||
*signal_error = Some(msg);
|
||||
continue;
|
||||
}
|
||||
}
|
||||
None => {
|
||||
let (f, l) = (file!(), line!());
|
||||
let msg = format!("\
|
||||
Error near {f}:{l}. The bitwidth for signal {name} \
|
||||
must be specified for a signal of type {sig_type:?}. \
|
||||
This error occurred while parsing the vcd file at \
|
||||
{cursor:?}");
|
||||
Err(msg)?;
|
||||
}
|
||||
};
|
||||
|
||||
let (f, l )= (file!(), line!());
|
||||
let timeline_idx = u32::try_from(vcd.timeline.len()).map_err(
|
||||
|e| format!("Error near {f}:{l}. Failed to convert from usize to u32."))?;
|
||||
let timeline_idx = TimelineIdx(timeline_idx);
|
||||
|
||||
if store_as_string {
|
||||
string_timeline_markers.push(timeline_idx);
|
||||
string_timeline.push(value_string);
|
||||
Ok(())
|
||||
|
||||
}
|
||||
else {
|
||||
u8_timeline_markers.push(timeline_idx);
|
||||
|
||||
let mut curr_num_bytes = value_u8.len();
|
||||
u8_timeline.append(&mut value_u8);
|
||||
|
||||
// we may need to zero extend values
|
||||
// so that we end up storing all values
|
||||
// of a particular signal in a consistent
|
||||
// amount of bytes
|
||||
let num_bits = num_bits.unwrap();
|
||||
let bytes_required = (num_bits / 8) +
|
||||
if (num_bits % 8) > 0 {1} else {0};
|
||||
|
||||
while curr_num_bytes < bytes_required {
|
||||
// useful for debugging
|
||||
// let err = format!("Error at {cursor:?}.\
|
||||
// num_bits = {num_bits}, \
|
||||
// observed_bits = {observed_num_bits}, \
|
||||
// curr_num_bytes = {curr_num_bytes}, \
|
||||
// bytes_required = {bytes_required} \
|
||||
// for signal {name}");
|
||||
// Err(err)?;
|
||||
|
||||
u8_timeline.push(0u8);
|
||||
curr_num_bytes += 1;
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
Signal::Alias {..} => {
|
||||
let (f, l )= (file!(), line!());
|
||||
let msg = format!(
|
||||
"Error near {f}:{l}, a signal alias should not point to a signal alias.\n\
|
||||
This error occurred while parsing vcd file at {cursor:?}");
|
||||
Err(msg)
|
||||
}
|
||||
}?;
|
||||
}
|
||||
|
||||
// handle the case of a one bit signal whose value is set to `0`
|
||||
"0" => {
|
||||
// lookup signal idx
|
||||
let hash = &word[1..];
|
||||
let (f, l )= (file!(), line!());
|
||||
let Signal_Idx(ref signal_idx) = signal_map.get(hash).ok_or(
|
||||
format!("Error near {f}:{l}. Failed to lookup signal {hash} at {cursor:?}"))?;
|
||||
|
||||
// account for fact that signal idx could be an alias, so there
|
||||
// could be one step of indirection
|
||||
let signal_idx =
|
||||
{
|
||||
let signal = vcd.all_signals.get(*signal_idx).unwrap();
|
||||
match signal {
|
||||
Signal::Data {..} => {*signal_idx}
|
||||
Signal::Alias {name, signal_alias} => {
|
||||
let Signal_Idx(ref signal_idx) = signal_alias;
|
||||
signal_idx.clone()
|
||||
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
// after handling potential indirection, go ahead and update the timeline
|
||||
// of the signal signal_idx references
|
||||
let signal = vcd.all_signals.get_mut(signal_idx).unwrap();
|
||||
match signal {
|
||||
Signal::Data {name, sig_type, ref mut signal_error, num_bits,
|
||||
self_idx, u8_timeline, u8_timeline_markers, ..} => {
|
||||
|
||||
// if this is a bad signal, go ahead and skip it
|
||||
if signal_error.is_some() {continue;}
|
||||
|
||||
// Get bitwidth and verify that it is 1.
|
||||
// Also account for the error case of a bitwidth of `None`
|
||||
match num_bits {
|
||||
Some(ref num_bits) => {
|
||||
if *num_bits != 1 {
|
||||
let (f, l) = (file!(), line!());
|
||||
let msg = format!("\
|
||||
Error near {f}:{l}. The bitwidth for signal {name} \
|
||||
of sig_type {sig_type:?} is expected to be `1` not \
|
||||
`{num_bits}`. \
|
||||
This error occurred while parsing the vcd file at \
|
||||
{cursor:?}");
|
||||
*signal_error = Some(msg);
|
||||
continue;
|
||||
}
|
||||
}
|
||||
None => {
|
||||
let (f, l) = (file!(), line!());
|
||||
let msg = format!("\
|
||||
Error near {f}:{l}. The bitwidth for signal {name} \
|
||||
must be specified for a signal of type {sig_type:?}. \
|
||||
This error occurred while parsing the vcd file at \
|
||||
{cursor:?}");
|
||||
Err(msg)?;
|
||||
}
|
||||
};
|
||||
|
||||
let (f, l )= (file!(), line!());
|
||||
let timeline_idx = u32::try_from(vcd.timeline.len()).map_err(
|
||||
|e| format!("Error near {f}:{l}. Failed to convert from usize to u32."))?;
|
||||
let timeline_idx = TimelineIdx(timeline_idx);
|
||||
|
||||
u8_timeline_markers.push(timeline_idx);
|
||||
u8_timeline.push(0u8);
|
||||
Ok(())
|
||||
}
|
||||
Signal::Alias {..} => {
|
||||
let (f, l )= (file!(), line!());
|
||||
let msg = format!(
|
||||
"Error near {f}:{l}, a signal alias should not point to a signal alias.\n\
|
||||
This error occurred while parsing vcd file at {cursor:?}");
|
||||
Err(msg)
|
||||
}
|
||||
}?;
|
||||
}
|
||||
|
||||
"1" => {
|
||||
// lokup signal idx
|
||||
let hash = &word[1..];
|
||||
let (f, l )= (file!(), line!());
|
||||
let Signal_Idx(ref signal_idx) = signal_map.get(hash).ok_or(
|
||||
format!("Error near {f}:{l}. Failed to lookup signal {hash} at {cursor:?}"))?;
|
||||
|
||||
// account for fact that signal idx could be an alias, so there
|
||||
// could be one step of indirection
|
||||
let signal_idx =
|
||||
{
|
||||
let signal = vcd.all_signals.get(*signal_idx).unwrap();
|
||||
match signal {
|
||||
Signal::Data {..} => {*signal_idx}
|
||||
Signal::Alias {name, signal_alias} => {
|
||||
let Signal_Idx(ref signal_idx) = signal_alias;
|
||||
signal_idx.clone()
|
||||
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
// after handling potential indirection, go ahead and update the timeline
|
||||
// of the signal signal_idx references
|
||||
let signal = vcd.all_signals.get_mut(signal_idx).unwrap();
|
||||
match signal {
|
||||
Signal::Data {name, sig_type, ref mut signal_error, num_bits,
|
||||
self_idx, u8_timeline, u8_timeline_markers, scope_parent, ..} => {
|
||||
|
||||
// if this is a bad signal, go ahead and skip it
|
||||
if signal_error.is_some() {continue;}
|
||||
|
||||
// Get bitwidth and verify that it is 1.
|
||||
// Also account for the error case of a bitwidth of `None`
|
||||
match num_bits {
|
||||
Some(ref num_bits) => {
|
||||
if *num_bits != 1 {
|
||||
let (f, l) = (file!(), line!());
|
||||
let msg = format!("\
|
||||
Error near {f}:{l}. The bitwidth for signal {name} \
|
||||
of sig_type {sig_type:?} is expected to be `1` not \
|
||||
`{num_bits}`. \
|
||||
This error occurred while parsing the vcd file at \
|
||||
{cursor:?}");
|
||||
*signal_error = Some(msg);
|
||||
continue;
|
||||
}
|
||||
}
|
||||
None => {
|
||||
let (f, l) = (file!(), line!());
|
||||
let msg = format!("\
|
||||
Error near {f}:{l}. The bitwidth for signal {name} \
|
||||
must be specified for a signal of type {sig_type:?}. \
|
||||
This error occurred while parsing the vcd file at \
|
||||
{cursor:?}");
|
||||
Err(msg)?;
|
||||
}
|
||||
};
|
||||
|
||||
let (f, l )= (file!(), line!());
|
||||
let timeline_idx = u32::try_from(vcd.timeline.len()).map_err(
|
||||
|e| format!("Error near {f}:{l}. Failed to convert from usize to u32."))?;
|
||||
let timeline_idx = TimelineIdx(timeline_idx);
|
||||
|
||||
u8_timeline_markers.push(timeline_idx);
|
||||
u8_timeline.push(1u8);
|
||||
Ok(())
|
||||
}
|
||||
Signal::Alias {..} => {
|
||||
let (f, l )= (file!(), line!());
|
||||
let msg = format!(
|
||||
"Error near {f}:{l}, a signal alias should not point to a signal alias.\n\
|
||||
This error occurred while parsing vcd file at {cursor:?}");
|
||||
Err(msg)
|
||||
}
|
||||
}?;
|
||||
}
|
||||
// other one bit cases
|
||||
"x" | "X" | "z" | "Z" | "u" | "U" => {
|
||||
let val = word.to_string();
|
||||
// lokup signal idx
|
||||
let hash = &word[1..];
|
||||
let (f, l )= (file!(), line!());
|
||||
let Signal_Idx(ref signal_idx) = signal_map.get(hash).ok_or(
|
||||
format!("Error near {f}:{l}. Failed to lookup signal {hash} at {cursor:?}"))?;
|
||||
|
||||
// account for fact that signal idx could be an alias, so there
|
||||
// could be one step of indirection
|
||||
let signal_idx =
|
||||
{
|
||||
let signal = vcd.all_signals.get(*signal_idx).unwrap();
|
||||
match signal {
|
||||
Signal::Data {..} => {*signal_idx}
|
||||
Signal::Alias {name, signal_alias} => {
|
||||
let Signal_Idx(ref signal_idx) = signal_alias;
|
||||
signal_idx.clone()
|
||||
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
// after handling potential indirection, go ahead and update the timeline
|
||||
// of the signal signal_idx references
|
||||
let signal = vcd.all_signals.get_mut(signal_idx).unwrap();
|
||||
match signal {
|
||||
Signal::Data {name, sig_type, ref mut signal_error, num_bits,
|
||||
self_idx, u8_timeline, u8_timeline_markers, string_timeline,
|
||||
string_timeline_markers, ..} => {
|
||||
|
||||
// if this is a bad signal, go ahead and skip it
|
||||
if signal_error.is_some() {continue;}
|
||||
|
||||
// Get bitwidth and verify that it is 1.
|
||||
// Also account for the error case of a bitwidth of `None`
|
||||
match num_bits {
|
||||
Some(ref num_bits) => {
|
||||
if *num_bits != 1 {
|
||||
let (f, l) = (file!(), line!());
|
||||
let msg = format!("\
|
||||
Error near {f}:{l}. The bitwidth for signal {name} \
|
||||
of sig_type {sig_type:?} is expected to be `1` not \
|
||||
`{num_bits}`. \
|
||||
This error occurred while parsing the vcd file at \
|
||||
{cursor:?}");
|
||||
*signal_error = Some(msg);
|
||||
continue;
|
||||
}
|
||||
}
|
||||
None => {
|
||||
let (f, l) = (file!(), line!());
|
||||
let msg = format!("\
|
||||
Error near {f}:{l}. The bitwidth for signal {name} \
|
||||
must be specified for a signal of type {sig_type:?}. \
|
||||
This error occurred while parsing the vcd file at \
|
||||
{cursor:?}");
|
||||
Err(msg)?;
|
||||
}
|
||||
};
|
||||
|
||||
let (f, l )= (file!(), line!());
|
||||
let timeline_idx = u32::try_from(vcd.timeline.len()).map_err(
|
||||
|e| format!("Error near {f}:{l}. Failed to convert from usize to u32."))?;
|
||||
let timeline_idx = TimelineIdx(timeline_idx);
|
||||
|
||||
string_timeline_markers.push(timeline_idx);
|
||||
string_timeline.push(val);
|
||||
Ok(())
|
||||
}
|
||||
Signal::Alias {..} => {
|
||||
let (f, l )= (file!(), line!());
|
||||
let msg = format!(
|
||||
"Error near {f}:{l}, a signal alias should not point to a signal alias.\n\
|
||||
This error occurred while parsing vcd file at {cursor:?}");
|
||||
Err(msg)
|
||||
}
|
||||
}?;
|
||||
}
|
||||
|
||||
_ => {}
|
||||
}
|
||||
}
|
||||
|
||||
Ok(())
|
||||
}
|
||||
Reference in a new issue