https://github.com/pieter3d/simview

https://github.com/pieter3d/simview

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/pieter3d/simview
• Owner: pieter3d
• License: mit
• Created: 2020-01-19T02:03:30.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2024-03-02T03:03:17.000Z (8 months ago)
• Last Synced: 2024-07-16T07:39:45.348Z (4 months ago)
• Language: C++
• Size: 893 KB
• Stars: 77
• Watchers: 4
• Forks: 7
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-opensource-hardware - simview

README

        
# simview

Simview is a text-based SystemVerilog design browser and waveform viewer. As an

[ncurses](https://en.wikipedia.org/wiki/Ncurses) TUI application, it has very

little library dependencies and can be easily run over an SSH connection in

your favorite terminal emulator. Control of the UI is intuitive and fully

keyboard shortcut driven. While that may sound contradictory, there is nice

contextual help for every function.

Simview is generally meant to debug and analyze hardware designs written in

SystemVerilog. Support for non-synthesizable testbench code is limited.

![Screenshot](simview.png)

## Features

* Full design parsing and elaboration, powered by [Surelog](https://github.com/chipsalliance/Surelog).

* Trace signal drivers or loads.

* Waveform format support for VCD and FST, the most common formats written by [Verilator](https://github.com/verilator/verilator).

* Automatic (or manual) matching of wave file hierarchy to design hierarchy.

* Send signals from source code to the wave viewer and vice versa.

* Search source code and signal lists.

## Usage

Simview can be launched with either a VCD/FST wave file, a SystemVerilog

design, or both. To load a wave file use the `-waves ` command line

option. All other command line options are passed to the Surelog parser. These

generally match most EDA tools, with things like `-timescale`, `+incdir`,

`+define=val` etc. Use `-help` to get the full list of parsing options from

Surelog.

Tips for UI navigation:

  * Use Tab to cycle through the available panes.

  * Keep an eye on the bottom tooltip bar for available commands.

  * Ctrl-arrow keys to resize UI panes.

  * Enter/space to expand collapse tree items.

  * vim-style hjkl keys generally work. Also $^ for horizontal and gG for vertical movement.

## Build

Simview is written with C++17 and uses CMake as the build system. Linux or Linux under WSL are

currently the only supported platforms, no native Windows or MacOSX support at the

moment.

1. Install pre-requisite packages (Ubuntu 20.04 LTS)

  * `sudo apt install build-essential cmake git pkg-config tclsh swig uuid-dev

      libgoogle-perftools-dev python3 python3-orderedmultidict python3-dev default-jre lcov libncurses-dev`

1. Build and install [Surelog](https://github.com/chipsalliance/Surelog)

  * `git clone [email protected]:chipsalliance/Surelog.git`

  * `cd Surelog`

  * `git submodule update --init --recursive`

  * `make`

  * `sudo make install`

1. Build simview:

  * `git clone [email protected]:pieter3d/simview.git`

  * `cd simview`

  * `mkdir build`

  * `cd build`

  * `cmake ..`

  * `make`

## TODO

A list of features that have not yet been implemented.

* Source viewer: Navigate include files

* Settings file (libconfig)

  * Sort instances by name or by position in file

  * Customizable colors.

  * Source search: whole file or active scope?

  * Save UI layout dimensions?

* A colorscheme that works with white backgrounds.

* Polish: Syntax highlighting of macros

* Source window: Need a clean way to add multiple signals from the source to the waves at once.

* alternate layout maybe: left has waves and signals stacked vertically

* Expose local nets in functions and tasks

* Expose local variables in always blocks?

* tracing loads does not trace things on the left side, e.g idx isn't traced in `net[idx] = val;`

* Time multiplier for waves (e.g. wave 1 unit is really X us/ns/ps/)

* Wave + source should be able to figure out enums in waves.

* Reload waves, and possibly live updates.

* Search for value in wave.

* Analog signals.

* Detect unrolled arrays in waves, make them expandable in the waveforms

* Lazy / on-demand loading of VCD wave data. Not clear if this is useful since

  loading anything requires parsing the whole file anyway.

* Someday: Support FSDB via dynamically loading the necessary .so's on systems

  that have them installed with a valid license.

* Command line option to load a saved signal list file at startup.

* Investigate including Surelog as a git submodule, to avoid breakages.