llvm / llvm/circt

[FIRRTL] memory parsing crashes on unexpected order of "fields"

Open
#7,580 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Consider:

FIRRTL version 4.0.0

circuit Foo:
  public module Foo:
    mem memory:
      depth => 8
      reader => r
      read-latency => 0
      write-latency => 1
      read-under-write => undefined
      data-type => UInt<8>

Which presently crashes. Moving data-type to the first (above depth => 8), and this works. In the current code is must occur before a port (e.g., reader).

If not supported, this should be rejected / checked.

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 FIRRTL memory parser and run the reproducer from the issue, paying attention to the ordering of data-type, depth, and port fields. The work is complete when this unexpected order no longer crashes and is either accepted correctly or rejected with a diagnostic.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
compilers
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.