Skip to content

Conversation

seldridge
Copy link
Member

@seldridge seldridge commented May 17, 2025

Directories created with [;<>] are problematic for Makefiles and/or
Verilator. Drop these if we see them. This fixes issues where tests,
converted to ChiselSim, will fail to compile through Verilator due to
observed use of semicolons in test scopes or serialization of Chisel
types, e.g., UInt<16>.

Note: the continued patching of this indicates that we should setup an
allowlist of legal characters as opposed to continuing to exlcude
characters.

Release Notes

Drop ;, <, and > if they show up in a ChiselSim Scalatest scope name. This fixes a bug where Verilator (or the generated Makefile for ChiselSim) could fail to compile if it sees directories with these characters.

Directories created with `[;<>]` are problematic for Makefiles and/or
Verilator.  Drop these if we see them.  This fixes issues where tests,
converted to ChiselSim, will fail to compile through Verilator due to
observed use of semicolons in test scopes or serialization of Chisel
types, e.g., `UInt<16>`.

Note: the continued patching of this indicates that we should setup an
allowlist of legal characters as opposed to continuing to exlcude
characters.

Signed-off-by: Schuyler Eldridge <schuyler.eldridge@sifive.com>
@seldridge seldridge requested a review from jackkoenig May 17, 2025 19:09
@seldridge seldridge added the Bugfix Fixes a bug, will be included in release notes label May 17, 2025
@seldridge seldridge merged commit 7ac8e9e into main May 18, 2025
17 of 18 checks passed
@seldridge seldridge deleted the dev/seldridge/chiselsim-mangle-more-characters-in-directories branch May 18, 2025 21:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bugfix Fixes a bug, will be included in release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants