Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Toward a calyx testbench #2162

Open
ethanuppal opened this issue Jun 18, 2024 · 6 comments · May be fixed by #2181
Open

Toward a calyx testbench #2162

ethanuppal opened this issue Jun 18, 2024 · 6 comments · May be fixed by #2181
Assignees
Labels
C: fud2 experimental driver Status: In progress Issue is being worked on

Comments

@ethanuppal
Copy link
Contributor

@nathanielnrn said that we don't have a way to drop in a harness and directly interface with calyx components to test them (please correct me if I'm misinterpreting this!). It seems quite useful to exercise this kind of lower-level control over the signals instead of just memory inspection in post. Please let me know if this infrastructure already exists and is flourishing.

In terms of execution, there could be a fud2 op --through tb tb.sources="tb1.py,tb2.rs". We could cocotb, which is quite standard, I believe, and whose AXI wrapper is already being used to test YXI stuff. There's also this rust tb inspired by cocotb, but it hasn't been updated for 2 years. (The issue with using cocotb directly is that boilerplate-y Makefiles have to be littered throughout the testing codebase.) And of course, we could use a verilator harness, but those are similarly clunky and also take forever to compile.

@ethanuppal
Copy link
Contributor Author

ethanuppal commented Jun 18, 2024

It also might be worth seeing if we can integrate calyx somehow directly as a cocotb sim? Unless this doesn't make sense semantically. It seems that (following https://github.com/cocotb/cocotb/blob/master/src/cocotb_tools/makefiles/simulators/Makefile.verilator) we'd need to create a Makefile that runs the tool, which means we could just wrap icarus verilog and call it a day.

@rachitnigam
Copy link
Contributor

We generally dump out the VCD for the design and query specific signals we care about. However, you are right: this is a pretty baroque approach to doing things and a more principled approach to doing this would be good.

I'm AFK so can't link but two things to look at:

  • Spade has C++ bindings to make it easy to write harnesses for Spade generated designs
  • Chisel/FIRRTL has the concept of "boring" (drilling sense) internal signals up to the top module for testing. We could do similar things potentially.

@ethanuppal
Copy link
Contributor Author

Spade's harnesses seem like a thin wrapper around cocotb/verilator, as I suggested above. I also wrote a harness wrapper for my own language compiling to calyx. I also think it would be useful to test arbitrary components and not simply the top-level one.

@rachitnigam
Copy link
Contributor

Do you have a specific design in mind for something like this?

@ethanuppal
Copy link
Contributor Author

I think we can have a fud op that sends a calyx program through a bunch of test benches, whether they be cocotb benches or verilator harnessss (inferred maybe by file extension?). I'm not sure if this approach would allow you to test arbitrary components, but I have the feeling that verilator generates headers for all components.

@ethanuppal
Copy link
Contributor Author

Talked with @jku20 about multi-input ops in fud2 and a potential current workaround of passing the extra data via the config.

@ethanuppal ethanuppal linked a pull request Jun 30, 2024 that will close this issue
@ethanuppal ethanuppal linked a pull request Jun 30, 2024 that will close this issue
@ethanuppal ethanuppal self-assigned this Jul 8, 2024
@ethanuppal ethanuppal added Status: In progress Issue is being worked on C: fud2 experimental driver rust labels Jul 9, 2024
@rachitnigam rachitnigam removed the rust label Jul 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C: fud2 experimental driver Status: In progress Issue is being worked on
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants