chipsalliance / chipsalliance/chisel

Better Error Messages For Binary Incompatible Linking

Open
#2,625 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Scala
Stars
4.8k
Forks
658
Avg merge
18h 59m
Merged PRs (30d)
14

Description

**Type of issue**: Feature Request

**Is your feature request related to a problem? Please describe.**

Questions like [this](https://stackoverflow.com/questions/72908415/calling-dsptools-produces-a-chisel-runtime-error/72941635#72941635) come up fairly regularly on Stack Overflow or Gitter where there is a binary incompatibility issue. It would be nice if Chisel could inform you when you're using things that are not compatible.

**Describe the solution you'd like**

@ekiwi had a nice suggestion that the compiler plugin could inject a version number into compiled classes (I'm thinking Bundles and Modules) which would give the Chisel runtime some information such that it could report such issues. From the major version we add this feature, it could report anything without the version as "old and therefore binary incompatible". For things going forward from that major version, it could give a more precise error telling what version the class was compiled with vs. the current runtime version.

**Describe alternatives you've considered**

None considered

**Additional context**

Linked above: https://stackoverflow.com/questions/72908415/calling-dsptools-produces-a-chisel-runtime-error/72941635#72941635

**What is the use case for implementing this feature?**

Better user experience when things go wrong.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.