Update dev (#12)

* Add docker command to README.md and modify simulation files so they avoid features we do not have available. * Rename example folders and add verilator docker scripts * Remove unecessary code. * Update action * Remove interactive docker when not necessary. * Set shell in makefile * Try different approach to escape #
OrbitNTNU · Feb 9, 2024 · 3e14267 · 3e14267
1 parent 5cb9a7a
commit 3e14267
Show file tree

Hide file tree

Showing 24 changed files with 90 additions and 36 deletions.
diff --git a/.github/workflows/makefile.yml b/.github/workflows/makefile.yml
@@ -15,4 +15,4 @@ jobs:
     - uses: actions/checkout@v3
 
     - name: Docker test
-      run: docker run -v ${PWD}:/work --user $(id -u):$(id -g) -e CCACHE_DIR=/work/.ccache --entrypoint make verilator/verilator:stable
+      run: make
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 examples/**/obj_dir
 examples/**/*.txt
 examples/**/*.vcd
+.ccache
diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@ The main contribution of this project is the `verilator.mk` makefile. Include it
 
 The examples show how Verilator can be used to simualate a Verilog circuit. Feel free to add more examples and tests for them.
 
-All examples can be run using the `makefile` at the top level of this repository.
+All examples can be run using the `makefile` at the top level of this repository. Simply type `make` to run the makefile.
 
 ## And
 

diff --git a/examples/add/Add.sv → examples/Add/Add.sv b/examples/add/Add.sv → examples/Add/Add.sv
diff --git a/examples/add/makefile → examples/Add/makefile b/examples/add/makefile → examples/Add/makefile
diff --git a/examples/add/sim.cpp → examples/Add/sim.cpp b/examples/add/sim.cpp → examples/Add/sim.cpp
@@ -6,15 +6,14 @@
 #include <iostream>
 
 int main(int argc, char** argv) {
-    VerilatedContext* contextp = new VerilatedContext;
-    contextp->commandArgs(argc, argv);
-    VAdd* top = new VAdd{contextp};
+    VAdd* top = new VAdd;
+    Verilated::commandArgs(argc, argv);
 
     int stimuli_a[] = { 2, -1, 1, -6 };
     int stimuli_b[] = { 4,  5, 2,  7 }; 
 
     for (int i = 0; i < sizeof(stimuli_a) / sizeof(stimuli_a[0]); i++) {
-        if (contextp->gotFinish()) break;
+        if (Verilated::gotFinish()) break;
 
         top->a = stimuli_a[i];
         top->b = stimuli_b[i];
@@ -25,6 +24,5 @@ int main(int argc, char** argv) {
     }
 
     delete top;
-    delete contextp;
     return 0;
 }
diff --git a/examples/and/And.sv → examples/And/And.sv b/examples/and/And.sv → examples/And/And.sv
diff --git a/examples/and/makefile → examples/And/makefile b/examples/and/makefile → examples/And/makefile
diff --git a/examples/and/sim.cpp → examples/And/sim.cpp b/examples/and/sim.cpp → examples/And/sim.cpp
@@ -9,9 +9,8 @@
 #include <iostream>
 
 int main(int argc, char** argv) {
-    VerilatedContext* contextp = new VerilatedContext;
-    contextp->commandArgs(argc, argv);
-    VAnd* top = new VAnd{contextp};
+    VAnd* top = new VAnd;
+    Verilated::commandArgs(argc, argv);
 
     // For waveform generation
     unsigned long tickcount = 0;
@@ -27,7 +26,7 @@ int main(int argc, char** argv) {
     bool stimuli_b[] = { false, true, false, true }; 
 
     for (int i = 0; i < sizeof(stimuli_a) / sizeof(stimuli_a[0]); i++) {
-        if (contextp->gotFinish()) break;
+        if (Verilated::gotFinish()) break;
 
         top->a = stimuli_a[i];
         top->b = stimuli_b[i];
@@ -47,6 +46,5 @@ int main(int argc, char** argv) {
     delete trace;
 
     delete top;
-    delete contextp;
     return 0;
 }
diff --git a/examples/doublesub/DoubleSub.sv → examples/Doublesub/DoubleSub.sv b/examples/doublesub/DoubleSub.sv → examples/Doublesub/DoubleSub.sv
diff --git a/examples/doublesub/Sub.sv → examples/Doublesub/Sub.sv b/examples/doublesub/Sub.sv → examples/Doublesub/Sub.sv
diff --git a/examples/doublesub/from_file.cpp → examples/Doublesub/from_file.cpp b/examples/doublesub/from_file.cpp → examples/Doublesub/from_file.cpp
diff --git a/examples/doublesub/makefile → examples/Doublesub/makefile b/examples/doublesub/makefile → examples/Doublesub/makefile
diff --git a/examples/doublesub/operands.data → examples/Doublesub/operands.data b/examples/doublesub/operands.data → examples/Doublesub/operands.data
diff --git a/examples/doublesub/sim.cpp → examples/Doublesub/sim.cpp b/examples/doublesub/sim.cpp → examples/Doublesub/sim.cpp
@@ -7,9 +7,8 @@
 int get_stimuli(std::string filename, int *data);
 
 int main(int argc, char** argv) {
-    VerilatedContext* contextp = new VerilatedContext;
-    contextp->commandArgs(argc, argv);
-    VDoubleSub* top = new VDoubleSub{contextp};
+    VDoubleSub* top = new VDoubleSub;
+    Verilated::commandArgs(argc, argv);
 
     int *operands = new int[200];
     int noperands = get_stimuli(std::string{"operands.data"}, operands);
@@ -29,6 +28,5 @@ int main(int argc, char** argv) {
 
 
     delete top;
-    delete contextp;
     return 0;
 }
diff --git a/examples/hierarchy/delay/Delay.sv → examples/Hierarchy/Delay/Delay.sv b/examples/hierarchy/delay/Delay.sv → examples/Hierarchy/Delay/Delay.sv
diff --git a/examples/hierarchy/delay/main.cpp → examples/Hierarchy/Delay/main.cpp b/examples/hierarchy/delay/main.cpp → examples/Hierarchy/Delay/main.cpp
@@ -5,9 +5,8 @@
 #include <iostream>
 
 int main(int argc, char** argv) {
-    VerilatedContext* contextp = new VerilatedContext;
-    contextp->commandArgs(argc, argv);
-    VDelay* top = new VDelay{contextp};
+    VDelay* top = new VDelay;
+    Verilated::commandArgs(argc, argv);
 
     int data_in = 0x66234223;
 
@@ -40,6 +39,5 @@ int main(int argc, char** argv) {
     assert(top->delayed_data == data_in);
 
     delete top;
-    delete contextp;
     return 0;
 }
diff --git a/examples/hierarchy/delay/makefile → examples/Hierarchy/Delay/makefile b/examples/hierarchy/delay/makefile → examples/Hierarchy/Delay/makefile
diff --git a/examples/hierarchy/Hierarchy.sv → examples/Hierarchy/Hierarchy.sv b/examples/hierarchy/Hierarchy.sv → examples/Hierarchy/Hierarchy.sv
@@ -1,5 +1,5 @@
-`include "../doublesub/Sub.sv"
-`include "delay/Delay.sv"
+`include "../Doublesub/Sub.sv"
+`include "Delay/Delay.sv"
 
 module Hierarchy (
     input clk,

diff --git a/examples/hierarchy/main.cpp → examples/Hierarchy/main.cpp b/examples/hierarchy/main.cpp → examples/Hierarchy/main.cpp
@@ -5,9 +5,8 @@
 #include <iostream>
 
 int main(int argc, char** argv) {
-    VerilatedContext* contextp = new VerilatedContext;
-    contextp->commandArgs(argc, argv);
-    VHierarchy* top = new VHierarchy{contextp};
+    VHierarchy* top = new VHierarchy;
+    Verilated::commandArgs(argc, argv);
 
     int data_in = 0x66234223;
     int subtract = 22;
@@ -44,6 +43,5 @@ int main(int argc, char** argv) {
     assert(top->data_out == (data_in - subtract));
 
     delete top;
-    delete contextp;
     return 0;
 }
diff --git a/examples/hierarchy/makefile → examples/Hierarchy/makefile b/examples/hierarchy/makefile → examples/Hierarchy/makefile
diff --git a/verilator-docker.sh b/verilator-docker.sh
@@ -0,0 +1,17 @@
+#!/bin/bash
+# DESCRIPTION: Wrap a verilator call to run a docker container
+#
+# Copyright 2020 by Stefan Wallentowitz. This program is free software; you
+# can redistribute it and/or modify it under the terms of either the GNU
+# Lesser General Public License Version 3 or the Perl Artistic License
+# Version 2.0.
+# SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0
+
+# Pull newest image 
+docker pull verilator/verilator:4.038 > /dev/null
+
+# Get the project root
+project_root=$(realpath $3)
+
+# Run the docker image with the user we "made" above
+docker run -e CCACHE_DIR=/work/.ccache -v ${project_root}:/work -w /work/$2 --user $(id -u):$(id -g) verilator/verilator:$1 "${@:4}"
diff --git a/verilator-wrap.sh b/verilator-wrap.sh
@@ -0,0 +1,31 @@
+#!/bin/bash
+# DESCRIPTION: Wrap a Verilator call and copy vlt includes
+#              (inside docker container)
+#
+# Copyright 2020 by Stefan Wallentowitz. This program is free software; you
+# can redistribute it and/or modify it under the terms of either the GNU
+# Lesser General Public License Version 3 or the Perl Artistic License
+# Version 2.0.
+# SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0
+
+perl /usr/local/bin/verilator "$@"
+status=$?
+if [ $status -ne 0 ]; then
+    exit $status
+fi
+
+# Check if user set an obj_dir
+obj_dir=$(echo " $@" | grep -oP '\s--Mdir\s*\K\S+')
+if [ "$obj_dir" == "" ]; then
+    obj_dir="obj_dir"
+fi
+
+# If the run was successful: Copy required files to allow build without this container
+if [ -e ${obj_dir} ]; then
+    # Copy files required for the build
+    mkdir -p ${obj_dir}/vlt
+    cp -r /usr/local/share/verilator/bin ${obj_dir}/vlt
+    cp -r /usr/local/share/verilator/include ${obj_dir}/vlt
+    # Point Makefile to that folder
+    sed -i 's/VERILATOR_ROOT = \/usr\/local\/share\/verilator/VERILATOR_ROOT = vlt/g' ${obj_dir}/*.mk
+fi
diff --git a/verilator.mk b/verilator.mk
@@ -1,23 +1,38 @@
+MODULE_FOLDER ?= examples
+PROJECT_ROOT ?= ${VERILATOR_ROOT}
 
-VERILATOR_EXE := obj_dir/V$(PROJECT_NAME)
+SHELL := /bin/bash
 
-PARSER ?= $(VERILATOR_ROOT)/default_parser.sh
+# Hashtag is a comment in make, but we want to use it in shell commands
+HASHTAG := \#
+
+# Find the path between the top level folder and the source code folder
+# Just doing ${MODULE_FOLDER}/${PROJECT_NAME} is not sufficient, because there
+# might be folders between the module folder and project folder. Like in the
+# Hierachy example.
+PATH_FROM_ROOT_TO_SRC = $(shell p=$(shell pwd); g=$${p${HASHTAG}${HASHTAG}*/${MODULE_FOLDER}}; echo $$g)
 
-VERILATOR_ARGS += --cc --build --exe --trace
+VERILATOR := $(VERILATOR_ROOT)/verilator-docker.sh
+VERILATOR_ARGS := 4.038 ${MODULE_FOLDER}${PATH_FROM_ROOT_TO_SRC} ${PROJECT_ROOT}
+VERILATOR_ARGS_LINT     := --lint-only -Wall
+VERILATOR_ARGS_EMULATOR := --cc --build --exe --trace
+
+VERILATOR_EMULATOR := obj_dir/V$(PROJECT_NAME)
+PARSER ?= $(VERILATOR_ROOT)/default_parser.sh
 
 all: run
 
-lint: $(SOURCES)
-	verilator --lint-only -Wall $^ --top-module $(PROJECT_NAME)
+lint: $(SOURCES) $(GENERATED)
+	./$(VERILATOR) $(VERILATOR_ARGS) $(VERILATOR_ARGS_LINT) $(SOURCES) --top-module $(PROJECT_NAME)
 
-$(VERILATOR_EXE): lint | $(SOURCES)
-	verilator $(VERILATOR_ARGS) $(SIMFILES) $(SOURCES) > /dev/null
+$(VERILATOR_EMULATOR): lint | $(SOURCES) $(GENERATED)
+	./$(VERILATOR) $(VERILATOR_ARGS) $(VERILATOR_ARGS_EMULATOR) $(SIMFILES) $(SOURCES) > /dev/null
 
-run: $(VERILATOR_EXE)
-	# https://stackoverflow.com/questions/17757039/equivalent-of-pipefail-in-dash-shell
+# https://stackoverflow.com/questions/17757039/equivalent-of-pipefail-in-dash-shell
+run: $(VERILATOR_EMULATOR)
 	@mkfifo named_pipe
 	@tee output.txt < named_pipe &
-	@./$(VERILATOR_EXE) > named_pipe; ./$(PARSER) $(PROJECT_NAME) $$? output.txt
+	@./$(VERILATOR_EMULATOR) > named_pipe; ./$(PARSER) $(PROJECT_NAME) $$? output.txt
 	@rm named_pipe
 
 clean:
-Original file line number
+Diff line change
@@ Expand Up @@
     The examples show how Verilator can be used to simualate a Verilog circuit. Feel free to add more examples and tests for them.
-    All examples can be run using the `makefile` at the top level of this repository.
+    All examples can be run using the `makefile` at the top level of this repository. Simply type `make` to run the makefile.
     ## And
@@ Expand Down @@