kkiningh / rules_verilator

Bazel build rules for Verilator

Bazel build rules for Verilator

Overview

Add the following to your WORKSPACE file

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

# Verilator
http_archive(
    name = "rules_verilator",
    # See release page for latest urls + sha
)

load(
    "@rules_verilator//verilator:repositories.bzl",
    "rules_verilator_dependencies",
    "rules_verilator_toolchains"
)
rules_verilator_dependencies()
rules_verilator_toolchains()

# Register toolchain dependencies
load("@rules_m4//m4:m4.bzl", "m4_register_toolchains")
m4_register_toolchains()

load("@rules_flex//flex:flex.bzl", "flex_register_toolchains")
flex_register_toolchains()

load("@rules_bison//bison:bison.bzl", "bison_register_toolchains")
bison_register_toolchains()

Supported Bazel Versions

These rules are under active development and the minimum supported Bazel version may change. Currently, the master branch requires Bazel >= 5.2.0.

Build rules

load("@rules_verilator//verilator:defs.bzl", "verilator_cc_library")

verilator_cc_library(
    name = "alu",
    mtop = "alu", # defaults to name if not specified
    srcs = ["alu.sv"],
)

cc_binary(
    name = "alu_bin",
    srcs = ["alu.cpp"],
    deps = [":alu"],
)

The details of a verilog module (sources, top name, etc.) can also be specified by a verilog_module which can be reused in other rules.

load("@rules_verilog//verilog:defs.bzl", "verilog_module")

load("@rules_verilator//verilator:defs.bzl", "verilator_cc_library")

verilog_module(
    name = "alu_module",
    top = "alu",
    srcs = ["alu.sv"],
)

verilator_cc_library(
    name = "alu",
    module = ":alu_module",
)

See test/alu/BUILD for working examples.

License

Released under Apache 2.0.

rules_verilator's Issues

remote caching across different build environments

hey all,

I've been looking at getting remote caching working with verilator. Verilated files are cached across build environments that are equivalent --mac to mac, linux to linux, but the problem is that a cache should be shared across build environments

ctx.actions.run(
    arguments = [args],
    executable = verilator_toolchain.verilator_executable, //problem 
    inputs = inputs,
    outputs = [verilator_output],
    progress_message = "[Verilator] Compiling {}".format(ctx.label),
)

After doing some digging, the only is the verilator_executable itself. Does anyone have any ideas how to eliminate the verilator_executable as an input when fetching cached files? The purist view would be that this is "non-hermetic" but I don't think that's much of an issue.

bazel build test/alu:alu is failing

There is a build breakage at head with bazel 4.2.1

bazel build test/alu:alu

Gives the error:

ERROR: /home/$USER/rules_verilator/test/alu/BUILD:9:21: in verilator_cc_library rule //test/alu:alu:
/home/$USER/rules_verilator/verilator/defs.bzl:77:5: for 'files', got a depset of 'NoneType', expected a depset of 'File'

Expose libverilator

Hi there,

just found this project as I was looking for a way to get verilated.h and friends into bazel. Is there a way with the current rules that I can get hold of libverilator in verilator.BUILD?

Also, do you plan on making a new release with v4.224?

Thanks.

Link Error Ubuntu 16.04 LTS

Hi there,

Thanks for the project, this looks to be exactly what I am looking for. I am having some issues building your example, this is a fresh system with Ubuntu 16.04 LTS.

Steps:

cd test/alu
bazel run //:alu_bin

Error

INFO: Analyzed target //:alu_bin (0 packages loaded, 0 targets configured).
INFO: Found 1 target...
ERROR: ~/rules_verilator/test/alu/BUILD:9:1: Linking of rule '//:alu_bin' failed (Exit 1) gcc failed: error executing command /usr/bin/gcc @bazel-out/k8-fastbuild/bin/alu_bin-2.params

Use --sandbox_debug to see verbose messages from the sandbox
bazel-out/k8-fastbuild/bin/libalu.a(Valu.o):Valu.cpp:function Valu::Valu(char const*): error: undefined reference to 'VerilatedModule::VerilatedModule(char const*)'
bazel-out/k8-fastbuild/bin/libalu.a(Valu.o):Valu.cpp:function Valu::Valu(char const*): error: undefined reference to 'VerilatedModule::~VerilatedModule()'
bazel-out/k8-fastbuild/bin/libalu.a(Valu.o):Valu.cpp:function Valu::~Valu(): error: undefined reference to 'VerilatedModule::~VerilatedModule()'
bazel-out/k8-fastbuild/bin/libalu.a(Valu.o):Valu.cpp:function Valu::eval(): error: undefined reference to 'Verilated::debug(int)'
bazel-out/k8-fastbuild/bin/libalu.a(Valu.o):Valu.cpp:function Valu::eval(): error: undefined reference to 'Verilated::debug(int)'
bazel-out/k8-fastbuild/bin/libalu.a(Valu.o):Valu.cpp:function Valu::eval(): error: undefined reference to 'VL_FATAL_MT(char const*, int, char const*, char const*)'
bazel-out/k8-fastbuild/bin/libalu.a(Valu.o):Valu.cpp:function Valu::_eval_initial_loop(Valu__Syms*): error: undefined reference to 'Verilated::debug(int)'
bazel-out/k8-fastbuild/bin/libalu.a(Valu.o):Valu.cpp:function Valu::_eval_initial_loop(Valu__Syms*): error: undefined reference to 'Verilated::debug(int)'
bazel-out/k8-fastbuild/bin/libalu.a(Valu.o):Valu.cpp:function Valu::_eval_initial_loop(Valu__Syms*): error: undefined reference to 'VL_FATAL_MT(char const*, int, char const*, char const*)'
bazel-out/k8-fastbuild/bin/libalu.a(Valu.o):Valu.cpp:function Valu::_ctor_var_reset(): error: undefined reference to 'VL_RAND_RESET_I(int)'
bazel-out/k8-fastbuild/bin/libalu.a(Valu.o):Valu.cpp:function Valu::_ctor_var_reset(): error: undefined reference to 'VL_RAND_RESET_I(int)'
bazel-out/k8-fastbuild/bin/libalu.a(Valu.o):Valu.cpp:function Valu::_ctor_var_reset(): error: undefined reference to 'VL_RAND_RESET_I(int)'
bazel-out/k8-fastbuild/bin/libalu.a(Valu.o):Valu.cpp:function Valu__Syms::~Valu__Syms(): error: undefined reference to 'VerilatedSyms::~VerilatedSyms()'
bazel-out/k8-fastbuild/bin/libalu.a(Valu__Syms.o):Valu__Syms.cpp:function Valu__Syms::Valu__Syms(Valu*, char const*): error: undefined reference to 'VerilatedSyms::VerilatedSyms()'
bazel-out/k8-fastbuild/bin/libalu.a(Valu__Syms.o):Valu__Syms.cpp:function Valu__Syms::Valu__Syms(Valu*, char const*): error: undefined reference to 'VerilatedSyms::~VerilatedSyms()'
collect2: error: ld returned 1 exit status
Target //:alu_bin failed to build
Use --verbose_failures to see the command lines of failed build steps.