2022-05-21 21:55:27 +00:00
|
|
|
# Disclaimer
|
|
|
|
|
PROPRIETARY - Copyright - Yehowshua Immanuel
|
|
|
|
|
|
2022-04-14 04:50:37 +00:00
|
|
|
# The Beginnings of a high-performance, low memory footprint VCD Viewer in Rust for massive multi-GB waveforms
|
|
|
|
|
|
2022-05-22 00:40:46 +00:00
|
|
|
## Current Features
|
2022-04-14 04:50:37 +00:00
|
|
|
- very fast
|
2022-05-22 00:40:46 +00:00
|
|
|
- loads 400MB of VCD waveform per second on an 8 core 2017 desktop CPU with NVMe storage
|
2022-04-14 04:50:37 +00:00
|
|
|
- consumes roughly between 10 - 50MB of memory per GB of waveform
|
2022-05-22 00:40:46 +00:00
|
|
|
|
|
|
|
|
## Planed Features
|
2022-04-14 04:50:37 +00:00
|
|
|
- elegant/pretty UI
|
|
|
|
|
- can be easily ported to work in browser via webassembly
|
|
|
|
|
- allows high-performance custom Rust plugins to manipulate and
|
|
|
|
|
generate new waveforms live
|
|
|
|
|
|
|
|
|
|
## Running
|
|
|
|
|
|
|
|
|
|
Make sure you have a test vcd file to get you started. You can grab
|
|
|
|
|
a large VCD file from
|
|
|
|
|
[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-05-19 02:57:42 +00:00
|
|
|
# TODO
|
2022-07-14 22:52:12 +00:00
|
|
|
- [ ] support multiple root scopes
|
2022-06-19 13:44:57 +00:00
|
|
|
- [ ] support parsing dates with commas
|
2022-06-22 01:06:51 +00:00
|
|
|
- [ ] Fix warning especially usage and restriction warnings once I'm
|
|
|
|
|
able to successfully parse all sample VCDs.
|
2022-06-19 13:44:57 +00:00
|
|
|
|
2022-07-14 22:52:12 +00:00
|
|
|
- [ ] Consolidate error messages and add cursors throughout.
|
2022-05-24 03:59:57 +00:00
|
|
|
- [ ] Consider what to do with don't care values
|
2022-07-14 22:52:12 +00:00
|
|
|
will probably just convert them to strings for now.
|
2022-05-23 03:00:03 +00:00
|
|
|
- [ ] Include line and possible column numbers
|
2022-05-19 02:57:42 +00:00
|
|
|
- [ ] Take a look at GTKWave parser to compare effificiency.
|
|
|
|
|
- [ ] Send survey to community channel.
|
|
|
|
|
|
2022-05-24 03:59:57 +00:00
|
|
|
# Probably No Longer Needed
|
2022-06-24 00:56:44 +00:00
|
|
|
- [ ] Should insert nodes in BFS order
|
