2022-07-28 14:43:58 +00:00
|
|
|
Copyright - Yehowshua Immanuel
|
2022-05-21 21:55:27 +00:00
|
|
|
|
2022-07-28 14:43:58 +00:00
|
|
|
# A High performance, VCD Parser written in Rust
|
2022-04-14 04:50:37 +00:00
|
|
|
|
2022-05-22 00:40:46 +00:00
|
|
|
## Current Features
|
2022-08-01 20:52:42 +00:00
|
|
|
- pretty fast, parses 3.04 GB VCD file in ~67s on M1 Macbook Air with
|
|
|
|
|
respect to 50s with GTKWave on the same device. FastWave currently
|
|
|
|
|
offers highly robust error handling which GTKWave doesn't have.
|
2022-05-22 00:40:46 +00:00
|
|
|
|
2022-07-28 14:43:58 +00:00
|
|
|
|
|
|
|
|
# Current Limitations
|
|
|
|
|
Unable to handle VCD files that have signals with more than
|
|
|
|
|
2^32 - 1 = 4,294,967,295 deltas/changes.
|
2022-04-14 04:50:37 +00:00
|
|
|
|
|
|
|
|
## Running
|
|
|
|
|
|
2022-08-01 16:29:25 +00:00
|
|
|
This repository comes with several smaller VCD files emitted from
|
|
|
|
|
various EDA tools. If you want a larger VCD file, grab one from
|
2022-04-14 04:50:37 +00:00
|
|
|
[here](https://drive.google.com/file/d/1pfm2qo2l8fGTHHJ8TLrg1vSGaV_TUbp2/view?usp=sharing).
|
|
|
|
|
|
|
|
|
|
The first build of the program may take some time.
|
|
|
|
|
|
2022-05-19 00:47:55 +00:00
|
|
|
``cargo run --release test-vcd-files/aldec/SPI_Write.vcd``
|
2022-04-14 04:50:37 +00:00
|
|
|
|
2022-06-22 01:06:51 +00:00
|
|
|
You can run all the tests with ``cargo test``
|
|
|
|
|
|
2022-08-04 18:29:29 +00:00
|
|
|
# Testing on Bad Files
|
|
|
|
|
You may wish to test the parser on a malformed VCD just to make
|
|
|
|
|
sure that the parser gives useful/sane errors.
|
|
|
|
|
|
|
|
|
|
Here's a command to test on a malformed 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`
|
|
|
|
|
|
2022-05-19 02:57:42 +00:00
|
|
|
# TODO
|
2022-08-01 16:29:25 +00:00
|
|
|
|
|
|
|
|
## Features
|
2022-08-04 18:29:29 +00:00
|
|
|
- [ ] re-order all signal timelines as binary balanced trees with respect to timestamps
|
|
|
|
|
- support multithreaded re-ordering
|
2022-07-20 14:38:56 +00:00
|
|
|
- [ ] Print out git commit or release number.
|
2022-07-18 16:53:44 +00:00
|
|
|
- [ ] Should be able to load waveform whilst viewing it live.
|
|
|
|
|
- could be quite challenging to implement for various reasons
|
2022-08-01 16:29:25 +00:00
|
|
|
- [ ] Take a look at GTKWave parser to compare efficiency.
|
2022-06-19 13:44:57 +00:00
|
|
|
|
2022-08-01 16:29:25 +00:00
|
|
|
## Repairs
|
|
|
|
|
- [ ] make a custom date parser for possibly up to 18 different versions(that is, for each possible tool).
|
2022-07-14 22:52:12 +00:00
|
|
|
- [ ] Consolidate error messages and add cursors throughout.
|
2022-08-01 16:29:25 +00:00
|
|
|
- [ ] Fix warnings especially usage and restriction warnings once I'm
|
|
|
|
|
able to successfully parse all sample VCDs.
|
|
|
|
|
|
|
|
|
|
## 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.
|
