fleker / chipyard-viewer

An online viewer for Chipyard output files

Chipyard Viewer

An online app that can visualize Chipyard-generated .out files.

It is available in hosted form online: https://felker.dev/chipyard-viewer

Features

• Show Pass/Fail state clearly
• Visualize clock cycles with gaps
• Hover over each operation to see operation details
• View file text with syntax highlighting

Setup

Prerequisites

• Node.js >= 12.14.0

npm install
npm run start # Starts app on localhost
npm run build # Generates website under `/dist/app`
npm run test  # Run unit tests

Examples

Examples in /examples largely are generated by following the Chipyard getting started guide with default settings.

These examples are used to verify the behavior of the app through unit tests.

LICENSE

This is licensed under Apache-2.0. See LICENSE.

chipyard-viewer's Issues

Add dark theme

Add LICENSE

Apache-2.0 license

Use event subscription system for theme

Right now the hovercard does not change when the theme is changed. It needs a page refresh due to only getting this value in the init. If we used a subscription system we'd get notified every time.

Improve architecture

[ ] Split JS and CSS into separate files
[ ] Unit tests for JS against various output files

Create custom favicon

Chipyard has an icon. Don't use this, but use something that is more iconic than the Angular icon.

Add support for a 'default' theme

Add a bit of JS to the app-component.ts to check the system dark theme and enable it in the changeDarkTheme method rather than just checking the app setting.

Hover dialog to turn hex into decimal/oct/bin

Have some kind of extra feature for this? Make a component number-viewer?

Support command-line/cURL interface?

Can we have an easy instruction which can open up this viewer to your output file from the command line, to make things faster?

Add lines 6/7 of metadata to output

CH. 0 TOTAL_STORAGE : 4096MB | 1 Ranks | 16 Devices per rank
DRAMSim2 Clock Frequency =666666666Hz, CPU Clock Frequency=100000000Hz

Unit tests on parsing example .out files

Use tables in hover dialog to align write / read events

Add sample .out files

Will be useful

.out file syntax highlighting

Write a blog post on the project

Also add a README

Create menu UI

Add menu UI for a Settings dialog to appear and allow other dialogs to be created in the future like a register viewer.

Have a good way to highlight pass/fail state

Last line of output is:

*** PASSED *** Completed after 17583 cycles

Can we provide a greater insight of this?

Instruction disassembler

Is there a way to easily break down the instruction opcodes to provide insight into how it is converted into a specific instruction/params?

Probably not unless we make certain architectural assumptions.

Consolidate file parsing to one instance

Create a file-parser.service which uses file-parser to make sense of all data. Then send that to each of the three chipyard HTML elements rather than each one performing the parsing themselves.

Assembly instruction decoder

Have a mapping from the assembly op to the canonical instruction.

addi ...

Should be mapped to some kind of content like:

Add Immediate: This instruction is used to do X, Y, or Z.

Add link/badge to GitHub from webapp

Fix typo in README#Examples

"gettign started"

Register viewer over time

Keep track of which registers are updated at each clock cycle and create a new dialog to show them at different cycles