llvm / llvm/circt

[ExportVerilog] "$name is not allowed in Verilog output" error does not fail pass

Open
#4,770 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

bug ExportVerilog
Dominant language
C++
Stars
2.2k
Forks
524
Avg merge
3d 2h
Merged PRs (30d)
46

Description

Encountered crafting test over here: https://github.com/llvm/circt/pull/4589#discussion_r1126488967 .

Is currently reachable + executed as part of the `verilog-errors.mlir` test case:

```mlir
hw.module.extern @parameter ()
```

=>

```
verilog-error.mlir:4:1: error: name "parameter" is not allowed in Verilog output
hw.module.extern @parameter ()
^
verilog-error.mlir:4:1: note: see current operation:
"hw.module.extern"() ({
}) {argLocs = [], argNames = [], comment = "", function_type = () -> (), parameters = [], resultLocs = [], resultNames = [], sym_name = "parameter"} : () -> ()
// Generated by CIRCT 1.34.0g20230304_3ddf879
// external module parameter
```

As an aside, getting our error tests to check that pass/execution is not successful would be great, cc #4553 .

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the verilog-errors.mlir test case and the linked discussion in PR 4589. Check how the ExportVerilog error test is executed, then make the test report unsuccessful when the forbidden name diagnostic is produced; verify that the existing parameter case no longer passes silently.

Written by the indexing model from the issue text.

Assessment

Domain
compilers, testing-qa
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.