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

update README

Browse source
This commit is contained in:
Yehowshua Immanuel 2022-08-01 12:29:25 -04:00
parent 232b026f62
commit 557f385336
1 changed files with 19 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

43
README.md
View file

@ -3,10 +3,8 @@ 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 - pretty fast, parses 3.04 GB VCD file in ~62s on M1 Macbook Air.
## Planned Features
- rapid log2n scrubbing through a signal's timeline
# 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
@ -14,8 +12,8 @@ Unable to handle VCD files that have signals with more than
## Running ## Running
Make sure you have a test vcd file to get you started. You can grab This repository comes with several smaller VCD files emitted from
a large VCD file from various EDA tools. If you want a larger VCD file, grab one from
[here](https://drive.google.com/file/d/1pfm2qo2l8fGTHHJ8TLrg1vSGaV_TUbp2/view?usp=sharing). [here](https://drive.google.com/file/d/1pfm2qo2l8fGTHHJ8TLrg1vSGaV_TUbp2/view?usp=sharing).
The first build of the program may take some time. The first build of the program may take some time.
@ -25,27 +23,26 @@ The first build of the program may take some time.
You can run all the tests with ``cargo test`` You can run all the tests with ``cargo test``
# TODO # TODO
- [ ] make a custon date parser for possibly up to 18 different versions(that
is, for each possible tool). ## Features
- [ ] Fix warning especially usage and restriction warnings once I'm - [ ] handle signals with x or z as string
able to successfully parse all sample VCDs. - the one bit parsers may also need to handle string
- [ ] Change error messages to line and filenames. Go through all calls to ``format!`` - move parse_orphaned_vars to scopes.rs
whilst also keep performance in mind.
- [ ] Create compressed fungible numeric enums with good heuristic support.
- [ ] 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
- [ ] Take a look at GTKWave parser to compare efficiency.
- [ ] re-order all signal timelines as binary balanced trees with respect to timestamps
- support multithreaded re-ordering
## Repairs
- [ ] make a custom date parser for possibly up to 18 different versions(that is, for each possible tool).
- [ ] Consolidate error messages and add cursors throughout. - [ ] Consolidate error messages and add cursors throughout.
- [ ] Consider what to do with don't care values - [ ] Fix warnings especially usage and restriction warnings once I'm
will probably just convert them to strings for now. able to successfully parse all sample VCDs.
- [ ] Include line and possible column numbers
- [ ] Take a look at GTKWave parser to compare effificiency. ## Code Consistency
- [ ] Change error messages to line and filenames. Go through all calls to ``format!`` whilst also keeping performance in mind.
## Marketing
- [ ] Send survey to community channel. - [ ] Send survey to community channel.
# Questions to Answer
- [ ] Is it safe to assume that we may treat any values before the first
non-zero timestamp as having occured on `#0`?
# Probably No Longer Needed
- [ ] Should insert nodes in BFS order