Skip to content

Add a link to the instrumentation report from the sim flow HTML summary report#210

Merged
AlexJones0 merged 1 commit into
lowRISC:masterfrom
AlexJones0:instrumentation_report_linking
May 21, 2026
Merged

Add a link to the instrumentation report from the sim flow HTML summary report#210
AlexJones0 merged 1 commit into
lowRISC:masterfrom
AlexJones0:instrumentation_report_linking

Conversation

@AlexJones0
Copy link
Copy Markdown
Contributor

@AlexJones0 AlexJones0 commented May 20, 2026

This PR is the seventeenth of a series of PRs to introduce instrumentation reporting to DVSim.

This is intended to be merged after the visualizations have been added via the other instrumentation report PRs, but it doesn't strictly depend on them. If DVSim is run with instrumentation enabled and a report was generated, then this will place a link to that instrumentation report ("metrics.html") in the generated simulation flow report summary. The idea is to make sure that we have one central index for simulation flows from which all the generated report data can be reached.


Now, the generated simulation index.html summary report will look something like:

image

With the Instrumentation Report button taking you to the metrics.html report.

@AlexJones0 AlexJones0 requested a review from machshev May 20, 2026 22:55
Copy link
Copy Markdown
Collaborator

@machshev machshev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @AlexJones0!

Couple of nits but not major.

Comment thread src/dvsim/sim/report.py Outdated
Comment thread src/dvsim/templates/reports/summary_report.html Outdated
Add a link to the HTML instrumentation report (metrics.html) from the
summary HTML report if the instrumentation report exists in the given
output directory. This will combine the two different report views
together for simulation runs, providing a single central index.

Signed-off-by: Alex Jones <alex.jones@lowrisc.org>
@AlexJones0 AlexJones0 force-pushed the instrumentation_report_linking branch from 1c45a0a to 5049fd2 Compare May 21, 2026 13:47
@AlexJones0 AlexJones0 requested a review from machshev May 21, 2026 13:51
Copy link
Copy Markdown
Collaborator

@machshev machshev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, thanks @AlexJones0!

@AlexJones0 AlexJones0 added this pull request to the merge queue May 21, 2026
Merged via the queue into lowRISC:master with commit aa4e68f May 21, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants