Yehowshua/FastWaveBackend
1
0
Fork 0
Code Issues 9 Pull requests 1 Actions Packages Projects Releases Wiki Activity

update README tasks

Browse source
This commit is contained in:
Yehowshua Immanuel 2022-08-04 20:29:49 -04:00
parent 2f512e24de
commit 2953c27e84
1 changed files with 7 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -3,10 +3,14 @@ Copyright - Yehowshua Immanuel
# A High performance, VCD Parser written in Rust # A High performance, VCD Parser written in Rust
## Current Features ## Current Features
- pretty fast, parses 3.04 GB VCD file in ~67s on M1 Macbook Air with - pretty fast, parses 3.04 GB VCD file in ~54s on M1 Macbook Air with
respect to 50s with GTKWave on the same device. FastWave currently respect to 50s with GTKWave on the same device. FastWave currently
offers highly robust error handling which GTKWave doesn't have. offers highly robust error handling which GTKWave doesn't have.
I noticed that when running FastWave in the VsCode terminal as opposed
to the MacOS system terminal or the Lapce terminal, FastWave takes 67s
to parse the 3.04GB file.
# Current Limitations # Current Limitations
Unable to handle VCD files that have signals with more than Unable to handle VCD files that have signals with more than
@ -31,16 +35,14 @@ sure that the parser gives useful/sane errors.
Here's a command to test on a malformed VCD: Here's a command to test on a malformed VCD:
`cargo run --release test-vcd-files/VCD_file_with_errors.vcd` `cargo run --release test-vcd-files/VCD_file_with_errors.vcd`
Should work well on Linux. On MacOS, remove `release` for line numbers
in error, see
[here](https://github.com/rust-lang/cargo/issues/4490#issuecomment-1205611137).
`cargo run test-vcd-files/VCD_file_with_errors.vcd`
# TODO # TODO
## Features ## Features
- [ ] macro for getting line number when propagating errors
- [ ] re-order all signal timelines as binary balanced trees with respect to timestamps - [ ] re-order all signal timelines as binary balanced trees with respect to timestamps
- support multithreaded re-ordering - support multithreaded re-ordering
- [ ] looks into making a macro for filename and linenumber later
- [ ] Print out git commit or release number. - [ ] Print out git commit or release number.
- [ ] Should be able to load waveform whilst viewing it live. - [ ] Should be able to load waveform whilst viewing it live.
- could be quite challenging to implement for various reasons - could be quite challenging to implement for various reasons