From 82273107c1836b87df3695ecb7dc93faa816b338 Mon Sep 17 00:00:00 2001 From: abejgonzalez Date: Fri, 8 Mar 2019 16:23:35 -0800 Subject: [PATCH 1/5] makefile changes/split | add scripts --- .ctags | 13 ++ .ctagsignore | 1 + .gitignore | 9 +- Makefrag | 105 +++++++++------ Makefrag-Variables | 79 ++++++++++++ scripts/gen-tags.sh | 17 +++ sims/verisim/Makefile | 92 +++++++------- ...{Makefrag-verilator => Makefrag-Verilator} | 19 ++- sims/vsim/Makefile | 120 ++++++++++-------- 9 files changed, 317 insertions(+), 138 deletions(-) create mode 100644 .ctags create mode 100644 .ctagsignore create mode 100644 Makefrag-Variables create mode 100755 scripts/gen-tags.sh rename sims/verisim/{Makefrag-verilator => Makefrag-Verilator} (54%) diff --git a/.ctags b/.ctags new file mode 100644 index 00000000..b7d31250 --- /dev/null +++ b/.ctags @@ -0,0 +1,13 @@ +--langdef=scala +--langmap=scala:.scala + +--regex-scala=/^[ \t]*((abstract|final|sealed|implicit|lazy)[ \t]*)*(private[^ ]*|protected)?[ \t]*class[ \t]+([a-zA-Z0-9_]+)/\4/c,classes/ +--regex-scala=/^[ \t]*((abstract|final|sealed|implicit|lazy)[ \t]*)*(private[^ ]*|protected)?[ \t]*object[ \t]+([a-zA-Z0-9_]+)/\4/o,objects/ +--regex-scala=/^[ \t]*((abstract|final|sealed|implicit|lazy)[ \t]*)*(private[^ ]*|protected)?[ \t]*((abstract|final|sealed|implicit|lazy)[ \t ]*)*case class[ \t ]+([a-zA-Z0-9_]+)/\6/C,case classes/ +--regex-scala=/^[ \t]*((abstract|final|sealed|implicit|lazy)[ \t]*)*(private[^ ]*|protected)?[ \t]*case object[ \t]+([a-zA-Z0-9_]+)/\4/O,case objects/ +--regex-scala=/^[ \t]*((abstract|final|sealed|implicit|lazy)[ \t]*)*(private[^ ]*|protected)?[ \t]*trait[ \t]+([a-zA-Z0-9_]+)/\4/t,traits/ +--regex-scala=/^[ \t]*type[ \t]+([a-zA-Z0-9_]+)/\1/T,types/ +--regex-scala=/^[ \t]*((abstract|final|sealed|implicit|lazy|override|private[^ ]*(\[[a-z]*\])*|protected)[ \t]*)*def[ \t]+([a-zA-Z0-9_]+)/\4/m,methods/ +--regex-scala=/^[ \t]*((abstract|final|sealed|implicit|lazy|override|private[^ ]*|protected)[ \t]*)*val[ \t]+([a-zA-Z0-9_]+)/\3/V,values/ +--regex-scala=/^[ \t]*((abstract|final|sealed|implicit|lazy|override|private[^ ]*|protected)[ \t]*)*var[ \t]+([a-zA-Z0-9_]+)/\3/v,variables/ +--regex-scala=/^[ \t]*package[ \t]+([a-zA-Z0-9_.]+)/\1/p,packages/ diff --git a/.ctagsignore b/.ctagsignore new file mode 100644 index 00000000..c910d58a --- /dev/null +++ b/.ctagsignore @@ -0,0 +1 @@ +*/target diff --git a/.gitignore b/.gitignore index f0fb9a39..2efa7a6a 100644 --- a/.gitignore +++ b/.gitignore @@ -3,10 +3,11 @@ bootrom target *.jar *.stamp -/vsim -/verisim/generated-src* -/verisim/simulator-* -/verisim/verilator +/sims/vsim +/sims/verisim simv* *.vcd +*.swp +.idea .DS_Store +tags diff --git a/Makefrag b/Makefrag index 3d90d8c9..591069bf 100644 --- a/Makefrag +++ b/Makefrag @@ -1,50 +1,38 @@ -ROCKETCHIP_DIR=$(base_dir)/generators/rocket-chip -TESTCHIP_DIR = $(base_dir)/generators/testchipip - -SCALA_VERSION=2.12.4 -SCALA_VERSION_MAJOR=$(basename $(SCALA_VERSION)) - -SBT ?= java -Xmx2G -Xss8M -XX:MaxPermSize=256M -jar $(ROCKETCHIP_DIR)/sbt-launch.jar ++$(SCALA_VERSION) +######################################################################################### +# set default shell for make +######################################################################################### +SHELL=/bin/bash +######################################################################################### +# variables to get all *.scala files +######################################################################################### lookup_scala_srcs = $(shell find $(1)/ -iname "*.scala" 2> /dev/null) PACKAGES=rocket-chip testchipip SCALA_SOURCES=$(foreach pkg,$(PACKAGES),$(call lookup_scala_srcs,$(base_dir)/generators/$(pkg)/src/main/scala)) $(call lookup_scala_srcs,$(base_dir)/src/main/scala) +######################################################################################### +# rocket and testchipip classes +######################################################################################### ROCKET_CLASSES ?= "$(ROCKETCHIP_DIR)/target/scala-$(SCALA_VERSION_MAJOR)/classes:$(ROCKETCHIP_DIR)/chisel3/target/scala-$(SCALA_VERSION_MAJOR)/*" TESTCHIPIP_CLASSES ?= "$(TESTCHIP_DIR)/target/scala-$(SCALA_VERSION_MAJOR)/classes" + +######################################################################################### +# jar creation variables and rules +######################################################################################### FIRRTL_JAR ?= $(ROCKETCHIP_DIR)/lib/firrtl.jar +# this should match whatever the commonSettings version is in build.sbt +BARSTOOLS_VER=1.0 +TAPEOUT_JAR=$(base_dir)/tools/barstools/tapeout/target/scala-$(SCALA_VERSION_MAJOR)/tapeout-assembly-$(BARSTOOLS_VER).jar +MACROCOMPILER_JAR=$(base_dir)/tools/barstools/macros/target/scala-$(SCALA_VERSION_MAJOR)/barstools-macros-assembly-$(BARSTOOLS_VER).jar + $(FIRRTL_JAR): $(call lookup_scala_srcs, $(ROCKETCHIP_DIR)/firrtl/src/main/scala) $(MAKE) -C $(ROCKETCHIP_DIR)/firrtl SBT="$(SBT)" root_dir=$(ROCKETCHIP_DIR)/firrtl build-scala mkdir -p $(dir $@) cp -p $(ROCKETCHIP_DIR)/firrtl/utils/bin/firrtl.jar $@ touch $@ -build_dir=$(sim_dir)/generated-src - -CHISEL_ARGS ?= - -long_name=$(PROJECT).$(MODEL).$(CONFIG) - -FIRRTL_FILE ?=$(build_dir)/$(long_name).fir -ANNO_FILE ?=$(build_dir)/$(long_name).anno.json -VERILOG_FILE ?=$(build_dir)/$(long_name).top.v -HARNESS_FILE ?=$(build_dir)/$(long_name).harness.v -SMEMS_FILE ?=$(build_dir)/$(long_name).mems.v -SMEMS_CONF ?=$(build_dir)/$(long_name).mems.conf -sim_dotf ?= $(build_dir)/sim_files.f - -REPL_SEQ_MEM = --repl-seq-mem -c:$(MODEL):-o:$(SMEMS_CONF) - -# This should match whatever the commonSettings version is in build.sbt -BARSTOOLS_VER=1.0 -TAPEOUT_JAR=$(base_dir)/tools/barstools/tapeout/target/scala-$(SCALA_VERSION_MAJOR)/tapeout-assembly-$(BARSTOOLS_VER).jar -MACROCOMPILER_JAR=$(base_dir)/tools/barstools/macros/target/scala-$(SCALA_VERSION_MAJOR)/barstools-macros-assembly-$(BARSTOOLS_VER).jar - -TAPEOUT ?= java -Xmx8G -Xss8M -cp $(ROCKET_CLASSES):$(TESTCHIPIP_CLASSES):$(TAPEOUT_JAR) -MACROCOMPILER ?= java -Xmx8G -Xss8M -cp $(ROCKET_CLASSES):$(TESTCHIPIP_CLASSES):$(MACROCOMPILER_JAR) - $(TAPEOUT_JAR): $(call lookup_scala_srcs, $(base_dir)/tools/barstools/tapeout/src/main/scala) cd $(base_dir) && $(SBT) "tapeout/assembly" @@ -54,13 +42,32 @@ $(MACROCOMPILER_JAR): $(call lookup_scala_srcs, $(base_dir)/tools/barstools/macr .PHONY: jars jars: $(MACROCOMPILER_JAR) $(TAPEOUT_JAR) +######################################################################################### +# tapeout and macrocompiler commands +######################################################################################### +TAPEOUT ?= java -Xmx8G -Xss8M -cp $(ROCKET_CLASSES):$(TESTCHIPIP_CLASSES):$(TAPEOUT_JAR) +MACROCOMPILER ?= java -Xmx8G -Xss8M -cp $(ROCKET_CLASSES):$(TESTCHIPIP_CLASSES):$(MACROCOMPILER_JAR) + +######################################################################################### +# create simulation args file rule +######################################################################################### $(sim_dotf): $(SCALA_SOURCES) $(FIRRTL_JAR) cd $(base_dir) && $(SBT) "runMain example.GenerateSimFiles -td $(build_dir) -sim $(sim_name)" +######################################################################################### +# create firrtl file rule and variables +######################################################################################### +CHISEL_ARGS ?= + $(FIRRTL_FILE) $(ANNO_FILE): $(SCALA_SOURCES) $(sim_dotf) mkdir -p $(build_dir) cd $(base_dir) && $(SBT) "runMain $(PROJECT).Generator $(CHISEL_ARGS) $(build_dir) $(PROJECT) $(MODEL) $(CFG_PROJECT) $(CONFIG)" +######################################################################################### +# create verilog files rules and variables +######################################################################################### +REPL_SEQ_MEM = --repl-seq-mem -c:$(MODEL):-o:$(SMEMS_CONF) + $(VERILOG_FILE) $(SMEMS_CONF): $(FIRRTL_FILE) $(ANNO_FILE) $(TAPEOUT_JAR) $(TAPEOUT) barstools.tapeout.transforms.GenerateTop -o $(VERILOG_FILE) -i $(FIRRTL_FILE) --syn-top $(TOP) --harness-top $(MODEL) -faf $(ANNO_FILE) $(REPL_SEQ_MEM) -td $(build_dir) @@ -71,6 +78,30 @@ $(HARNESS_FILE): $(FIRRTL_FILE) $(ANNO_FILE) $(TAPEOUT_JAR) $(SMEMS_FILE): $(SMEMS_CONF) $(MACROCOMPILER_JAR) $(MACROCOMPILER) barstools.macros.MacroCompiler -n $(SMEMS_CONF) -v $(SMEMS_FILE) --mode synflops +######################################################################################### +# run assembly/benchmarks rules +######################################################################################### +$(output_dir)/%: $(RISCV)/riscv64-unknown-elf/share/riscv-tests/isa/% + mkdir -p $(output_dir) + ln -sf $< $@ + +$(output_dir)/%.run: $(output_dir)/% $(sim) + $(sim) +max-cycles=$(timeout_cycles) $< && touch $@ + +$(output_dir)/%.out: $(output_dir)/% $(sim) + $(sim) +verbose +max-cycles=$(timeout_cycles) $< 3>&1 1>&2 2>&3 | spike-dasm > $@ + +######################################################################################### +# include build/project specific makefrags made from the generator +######################################################################################### +ifneq ($(filter run% %.run %.out %.vpd %.vcd,$(MAKECMDGOALS)),) +-include $(build_dir)/$(long_name).d +endif + +######################################################################################### +# default regression tests variables and rules +# TODO: Remove in favor of each project having its own regression tests? +######################################################################################### regression-tests = \ rv64ud-v-fcvt \ rv64ud-p-fdiv \ @@ -98,12 +129,14 @@ regression-tests = \ rv64um-v-mulh \ rv64si-p-dirty -output_dir=$(sim_dir)/output - -$(output_dir)/%: $(RISCV)/riscv64-unknown-elf/share/riscv-tests/isa/% - mkdir -p $(output_dir) - ln -sf $< $@ +.PHONY: run-regression-tests run-regression-tests-fast run-regression-tests-debug +run-regression-tests: $(addprefix $(output_dir)/,$(addsuffix .out,$(regression-tests))) +run-regression-tests-fast: $(addprefix $(output_dir)/,$(addsuffix .run,$(regression-tests))) +run-regression-tests-debug: $(addprefix $(output_dir)/,$(addsuffix .vpd,$(regression-tests))) +######################################################################################### +# general jar cleanup rule +######################################################################################### .PHONY: clean-scala clean-scala: rm -rf $(MACROCOMPILER_JAR) $(TAPEOUT_JAR) diff --git a/Makefrag-Variables b/Makefrag-Variables new file mode 100644 index 00000000..18793d3d --- /dev/null +++ b/Makefrag-Variables @@ -0,0 +1,79 @@ +######################################################################################### +# makefile variables shared across multiple makefiles +######################################################################################### + +######################################################################################### +# default variables to invoke the generator +# descriptions: +# PROJECT = the scala package to find the MODEL in +# MODEL = the top level module of the project +# CONFIG = the configuration class to give the parameters for the project +# CFG_PROJECT = the scala package to find the CONFIG class +# TB = TODO +# TOP = TODO +######################################################################################### +PROJECT ?= example +MODEL ?= TestHarness +CONFIG ?= DefaultExampleConfig +CFG_PROJECT ?= $(PROJECT) +TB ?= TestDriver +TOP ?= ExampleTop + +######################################################################################### +# path to rocket-chip and testchipip +######################################################################################### +ROCKETCHIP_DIR = $(base_dir)/generators/rocket-chip +TESTCHIP_DIR = $(base_dir)/generators/testchipip + +######################################################################################### +# names of various files needed to compile and run things +######################################################################################### +long_name = $(PROJECT).$(MODEL).$(CONFIG) + +FIRRTL_FILE ?= $(build_dir)/$(long_name).fir +ANNO_FILE ?= $(build_dir)/$(long_name).anno.json +VERILOG_FILE ?= $(build_dir)/$(long_name).top.v +HARNESS_FILE ?= $(build_dir)/$(long_name).harness.v +SMEMS_FILE ?= $(build_dir)/$(long_name).mems.v +SMEMS_CONF ?= $(build_dir)/$(long_name).mems.conf +sim_dotf ?= $(build_dir)/sim_files.f + +######################################################################################### +# default sbt launch command +######################################################################################### +SCALA_VERSION=2.12.4 +SCALA_VERSION_MAJOR=$(basename $(SCALA_VERSION)) + +SBT ?= java -Xmx2G -Xss8M -XX:MaxPermSize=256M -jar $(ROCKETCHIP_DIR)/sbt-launch.jar ++$(SCALA_VERSION) + +######################################################################################### +# output directory for tests +######################################################################################### +output_dir=$(sim_dir)/output + +######################################################################################### +# build output directory for compilation +######################################################################################### +build_dir=$(sim_dir)/generated-src + +######################################################################################### +# vsrcs needed to run projects +######################################################################################### +rocketchip_vsrc_dir = $(ROCKETCHIP_DIR)/src/main/resources/vsrc + +######################################################################################### +# sources needed to run simulators +######################################################################################### +sim_blackboxes = \ + $(build_dir)/firrtl_black_box_resource_files.f + +sim_vsrcs = \ + $(VERILOG_FILE) \ + $(HARNESS_FILE) \ + $(SMEMS_FILE) + +######################################################################################### +# assembly/benchmark variables +######################################################################################### +timeout_cycles = 10000000 +bmark_timeout_cycles = 100000000 diff --git a/scripts/gen-tags.sh b/scripts/gen-tags.sh new file mode 100755 index 00000000..52df9aa7 --- /dev/null +++ b/scripts/gen-tags.sh @@ -0,0 +1,17 @@ +#!/usr/bin/env bash + +# run this script in the main rebar directory to generate ctags for all relevant repos +# note: this requires exuberant-ctags +# tested with: Exuberant Ctags 5.8 +# instructions: +# cd /path/to/rebar/ +# ./scripts/gen-tags.sh +# +# input: +# * nothing +# +# output: +# * tags file in the directory that this was called in + +# ctags wrapper +ctags -R --exclude=@.ctagsignore --links=no diff --git a/sims/verisim/Makefile b/sims/verisim/Makefile index 9cab741c..f75fb5f1 100644 --- a/sims/verisim/Makefile +++ b/sims/verisim/Makefile @@ -1,41 +1,43 @@ +######################################################################################### +# verilator makefile +######################################################################################### + +######################################################################################### +# general path variables +######################################################################################### base_dir=$(abspath ../..) sim_dir=$(abspath .) -PROJECT ?= example -MODEL ?= TestHarness -CONFIG ?= DefaultExampleConfig -CFG_PROJECT ?= $(PROJECT) -TB ?= TestDriver -TOP ?= ExampleTop +######################################################################################### +# include shared variables +######################################################################################### +include $(base_dir)/Makefrag-Variables +######################################################################################### +# name of simulator (used to generate *.f arguments file) +######################################################################################### sim_name = verilator -sim = $(sim_dir)/simulator-$(PROJECT)-$(CONFIG) -sim_debug = $(sim_dir)/simulator-$(PROJECT)-$(CONFIG)-debug +######################################################################################### +# vcs simulator types and rules +######################################################################################### +sim_prefix = simulator +sim = $(sim_dir)/$(sim_prefix)-$(PROJECT)-$(CONFIG) +sim_debug = $(sim_dir)/$(sim_prefix)-$(PROJECT)-$(CONFIG)-debug +.PHONY: default debug default: $(sim) - debug: $(sim_debug) -CXXFLAGS := $(CXXFLAGS) -O1 -std=c++11 -I$(RISCV)/include -D__STDC_FORMAT_MACROS -LDFLAGS := $(LDFLAGS) -L$(RISCV)/lib -Wl,-rpath,$(RISCV)/lib -L$(sim_dir) -lfesvr -lpthread - +######################################################################################### +# import other necessary rules and variables +######################################################################################### include $(base_dir)/Makefrag -include $(sim_dir)/Makefrag-verilator -ifneq ($(filter run% %.run %.out %.vpd %.vcd,$(MAKECMDGOALS)),) --include $(build_dir)/$(long_name).d -endif - -sim_blackboxes = \ - $(build_dir)/firrtl_black_box_resource_files.f - -rocketchip_vsrc_dir = $(ROCKETCHIP_DIR)/src/main/resources/vsrc - -sim_vsrcs = \ - $(VERILOG_FILE) \ - $(HARNESS_FILE) \ - $(SMEMS_FILE) +include $(sim_dir)/Makefrag-Verilator +######################################################################################### +# verilator build paths and file names +######################################################################################### model_dir = $(build_dir)/$(long_name) model_dir_debug = $(build_dir)/$(long_name).debug @@ -45,6 +47,11 @@ model_header_debug = $(model_dir_debug)/V$(MODEL).h model_mk = $(model_dir)/V$(MODEL).mk model_mk_debug = $(model_dir_debug)/V$(MODEL).mk +######################################################################################### +# build makefile fragment that builds the verilator sim rules +######################################################################################### +LDFLAGS := $(LDFLAGS) -L$(RISCV)/lib -Wl,-rpath,$(RISCV)/lib -L$(sim_dir) -lfesvr -lpthread + $(model_mk): $(sim_vsrcs) $(sim_dotf) $(INSTALLED_VERILATOR) rm -rf $(build_dir)/$(long_name) mkdir -p $(build_dir)/$(long_name) @@ -53,10 +60,6 @@ $(model_mk): $(sim_vsrcs) $(sim_dotf) $(INSTALLED_VERILATOR) -CFLAGS "-I$(build_dir) -include $(build_dir)/$(long_name).plusArgs -include $(model_header)" touch $@ -$(sim): $(model_mk) - $(MAKE) VM_PARALLEL_BUILDS=1 -C $(build_dir)/$(long_name) -f V$(MODEL).mk - - $(model_mk_debug): $(sim_vsrcs) $(sim_dotf) $(INSTALLED_VERILATOR) rm -rf $(build_dir)/$(long_name) mkdir -p $(build_dir)/$(long_name).debug @@ -65,25 +68,26 @@ $(model_mk_debug): $(sim_vsrcs) $(sim_dotf) $(INSTALLED_VERILATOR) -CFLAGS "-I$(build_dir) -include $(build_dir)/$(long_name).plusArgs -include $(model_header_debug)" touch $@ +######################################################################################### +# invoke make to make verilator sim rules +######################################################################################### +$(sim): $(model_mk) + $(MAKE) VM_PARALLEL_BUILDS=1 -C $(build_dir)/$(long_name) -f V$(MODEL).mk + $(sim_debug): $(model_mk_debug) $(MAKE) VM_PARALLEL_BUILDS=1 -C $(build_dir)/$(long_name).debug -f V$(MODEL).mk -$(output_dir)/%.out: $(output_dir)/% $(sim) - $(sim) +verbose +max-cycles=1000000 $< 3>&1 1>&2 2>&3 | spike-dasm > $@ - -$(output_dir)/%.run: $(output_dir)/% $(sim) - $(sim) +max-cycles=1000000 $< && touch $@ - +######################################################################################### +# create a vcs vpd rule +######################################################################################### $(output_dir)/%.vpd: $(output_dir)/% $(sim_debug) rm -f $@.vcd && mkfifo $@.vcd vcd2vpd $@.vcd $@ > /dev/null & - $(sim_debug) -v$@.vcd +max-cycles=1000000 $< - -run-regression-tests: $(addprefix $(output_dir)/,$(addsuffix .out,$(regression-tests))) - -run-regression-tests-fast: $(addprefix $(output_dir)/,$(addsuffix .run,$(regression-tests))) - -run-regression-tests-debug: $(addprefix $(output_dir)/,$(addsuffix .vpd,$(regression-tests))) + $(sim_debug) -v$@.vcd +max-cycles=$(timeout_cycles) $< +######################################################################################### +# general cleanup rule +######################################################################################### +.PHONY: clean clean: clean-scala - rm -rf generated-src ./simulator-* + rm -rf $(build_dir) $(sim_prefix)-* diff --git a/sims/verisim/Makefrag-verilator b/sims/verisim/Makefrag-Verilator similarity index 54% rename from sims/verisim/Makefrag-verilator rename to sims/verisim/Makefrag-Verilator index f8ea0b4c..3af9b335 100644 --- a/sims/verisim/Makefrag-verilator +++ b/sims/verisim/Makefrag-Verilator @@ -1,7 +1,17 @@ -# Build and install our own Verilator, to work around versionining issues. -VERILATOR_VERSION=3.920 +######################################################################################### +# verilator installation makefrag +######################################################################################### + +######################################################################################### +# verilator version, binary, and path +######################################################################################### +VERILATOR_VERSION=4.008 VERILATOR_SRCDIR=verilator/src/verilator-$(VERILATOR_VERSION) INSTALLED_VERILATOR=$(abspath verilator/install/bin/verilator) + +######################################################################################### +# build and install our own verilator to work around versioning issues +######################################################################################### $(INSTALLED_VERILATOR): $(VERILATOR_SRCDIR)/bin/verilator $(MAKE) -C $(VERILATOR_SRCDIR) installbin installdata touch $@ @@ -24,8 +34,11 @@ verilator/verilator-$(VERILATOR_VERSION).tar.gz: mkdir -p $(dir $@) wget http://www.veripool.org/ftp/verilator-$(VERILATOR_VERSION).tgz -O $@ -# Run Verilator to produce a fast binary to emulate this circuit. +######################################################################################### +# verilator binary and flags +######################################################################################### VERILATOR := $(INSTALLED_VERILATOR) --cc --exe +CXXFLAGS := $(CXXFLAGS) -O1 -std=c++11 -I$(RISCV)/include -D__STDC_FORMAT_MACROS VERILATOR_FLAGS := --top-module $(MODEL) \ +define+PRINTF_COND=\$$c\(\"verbose\",\"\&\&\"\,\"done_reset\"\) \ +define+STOP_COND=\$$c\(\"done_reset\"\) --assert \ diff --git a/sims/vsim/Makefile b/sims/vsim/Makefile index c0ed1bc1..451b4602 100644 --- a/sims/vsim/Makefile +++ b/sims/vsim/Makefile @@ -1,84 +1,102 @@ +######################################################################################### +# vcs makefile +######################################################################################### + +######################################################################################### +# general path variables +######################################################################################### base_dir=$(abspath ../..) sim_dir=$(abspath .) -PROJECT ?= example -MODEL ?= TestHarness -CONFIG ?= DefaultExampleConfig -CFG_PROJECT ?= $(PROJECT) -TB ?= TestDriver -TOP ?= ExampleTop +######################################################################################### +# include shared variables +######################################################################################### +include $(base_dir)/Makefrag-Variables +######################################################################################### +# name of simulator (used to generate *.f arguments file) +######################################################################################### sim_name = vcs -simv = $(sim_dir)/simv-$(PROJECT)-$(CONFIG) -simv_debug = $(sim_dir)/simv-$(PROJECT)-$(CONFIG)-debug +######################################################################################### +# vcs simulator types and rules +######################################################################################### +sim_prefix = simv +sim = $(sim_dir)/$(sim_prefix)-$(PROJECT)-$(CONFIG) +sim_debug = $(sim_dir)/$(sim_prefix)-$(PROJECT)-$(CONFIG)-debug -default: $(simv) - -debug: $(simv_debug) +.PHONY: default debug +default: $(sim) +debug: $(sim_debug) +######################################################################################### +# import other necessary rules and variables +######################################################################################### include $(base_dir)/Makefrag -ifneq ($(filter run% %.run %.out %.vpd %.vcd,$(MAKECMDGOALS)),) --include $(build_dir)/$(long_name).d -endif - -sim_blackboxes = \ - $(build_dir)/firrtl_black_box_resource_files.f - -rocketchip_vsrc_dir = $(ROCKETCHIP_DIR)/src/main/resources/vsrc - -sim_vsrcs = \ - $(VERILOG_FILE) \ - $(HARNESS_FILE) \ - $(SMEMS_FILE) +######################################################################################### +# vcs binary and arguments +######################################################################################### VCS = vcs -full64 -VCS_OPTS = -notice -line +lint=all,noVCDE,noONGS,noUI -error=PCWM-L -timescale=1ns/10ps -quiet \ - +rad +v2k +vcs+lic+wait \ - +vc+list -CC "-I$(VCS_HOME)/include" \ +VCS_CC_OPTS = \ + -CC "-I$(VCS_HOME)/include" \ -CC "-I$(RISCV)/include" \ -CC "-std=c++11" \ -CC "-Wl,-rpath,$(RISCV)/lib" \ - -f $(sim_blackboxes) -f $(sim_dotf) \ - $(RISCV)/lib/libfesvr.so \ + $(RISCV)/lib/libfesvr.so + +VCS_NONCC_OPTS = \ + +lint=all,noVCDE,noONGS,noUI \ + -error=PCWM-L \ + -timescale=1ns/10ps \ + -quiet \ + +rad \ + +v2k \ + +vcs+lic+wait \ + +vc+list \ + -f $(sim_blackboxes) \ + -f $(sim_dotf) \ -sverilog \ - +incdir+$(generated_dir) \ - +define+CLOCK_PERIOD=1.0 $(sim_vsrcs) \ + +incdir+$(build_dir) \ + +define+CLOCK_PERIOD=1.0 \ + $(sim_vsrcs) \ +define+PRINTF_COND=$(TB).printf_cond \ +define+STOP_COND=!$(TB).reset \ +define+RANDOMIZE_MEM_INIT \ +define+RANDOMIZE_REG_INIT \ +define+RANDOMIZE_GARBAGE_ASSIGN \ +define+RANDOMIZE_INVALID_ASSIGN \ - +libext+.v \ + +libext+.v +VCS_OPTS = -notice -line $(VCS_CC_OPTS) $(VCS_NONCC_OPTS) + +######################################################################################### +# helper rule to just make verilog files +######################################################################################### +.PHONY: verilog verilog: $(sim_vsrcs) -$(simv): $(sim_vsrcs) $(sim_dotf) +######################################################################################### +# vcs simulator rules +######################################################################################### +$(sim): $(sim_vsrcs) $(sim_dotf) rm -rf csrc && $(VCS) $(VCS_OPTS) -o $@ \ -debug_pp -$(simv_debug) : $(sim_vsrcs) $(sim_dotf) +$(sim_debug) : $(sim_vsrcs) $(sim_dotf) rm -rf csrc && $(VCS) $(VCS_OPTS) -o $@ \ +define+DEBUG -debug_pp -$(output_dir)/%.out: $(output_dir)/% $(simv) - $(simv) +verbose +max-cycles=1000000 $< 3>&1 1>&2 2>&3 | spike-dasm > $@ - -$(output_dir)/%.run: $(output_dir)/% $(simv) - $(simv) +max-cycles=1000000 $< && touch $@ - -$(output_dir)/%.vpd: $(output_dir)/% $(simv_debug) - $(simv_debug) +vcdplusfile=$@ +max-cycles=1000000 $< - -run-regression-tests: $(addprefix $(output_dir)/,$(addsuffix .out,$(regression-tests))) - -run-regression-tests-fast: $(addprefix $(output_dir)/,$(addsuffix .run,$(regression-tests))) - -run-regression-tests-debug: $(addprefix $(output_dir)/,$(addsuffix .vpd,$(regression-tests))) - -clean: - rm -rf generated-src csrc simv-* ucli.key vc_hdrs.h +######################################################################################### +# create a vcs vpd rule +######################################################################################### +$(output_dir)/%.vpd: $(output_dir)/% $(sim_debug) + $(sim_debug) +vcdplusfile=$@ +max-cycles=$(timeout_cycles) $< +######################################################################################### +# general cleanup rule +######################################################################################### .PHONY: clean +clean: clean-scala + rm -rf $(build_dir) csrc $(sim_prefix)-* ucli.key vc_hdrs.h From 2c246af1108ad46d25ab10d385ebf90d6cdec702 Mon Sep 17 00:00:00 2001 From: abejgonzalez Date: Fri, 8 Mar 2019 16:47:27 -0800 Subject: [PATCH 2/5] rename makefiles | move verilog rule to common.mk --- Makefrag => common.mk | 6 ++++ sims/verisim/Makefile | 6 ++-- sims/verisim/Makefrag-Verilator | 47 ------------------------------ sims/vsim/Makefile | 10 ++----- Makefrag-Variables => variables.mk | 6 ++-- 5 files changed, 14 insertions(+), 61 deletions(-) rename Makefrag => common.mk (96%) delete mode 100644 sims/verisim/Makefrag-Verilator rename Makefrag-Variables => variables.mk (93%) diff --git a/Makefrag b/common.mk similarity index 96% rename from Makefrag rename to common.mk index 591069bf..dd1cbd8e 100644 --- a/Makefrag +++ b/common.mk @@ -78,6 +78,12 @@ $(HARNESS_FILE): $(FIRRTL_FILE) $(ANNO_FILE) $(TAPEOUT_JAR) $(SMEMS_FILE): $(SMEMS_CONF) $(MACROCOMPILER_JAR) $(MACROCOMPILER) barstools.macros.MacroCompiler -n $(SMEMS_CONF) -v $(SMEMS_FILE) --mode synflops +######################################################################################### +# helper rule to just make verilog files +######################################################################################### +.PHONY: verilog +verilog: $(sim_vsrcs) + ######################################################################################### # run assembly/benchmarks rules ######################################################################################### diff --git a/sims/verisim/Makefile b/sims/verisim/Makefile index f75fb5f1..8049bab9 100644 --- a/sims/verisim/Makefile +++ b/sims/verisim/Makefile @@ -11,7 +11,7 @@ sim_dir=$(abspath .) ######################################################################################### # include shared variables ######################################################################################### -include $(base_dir)/Makefrag-Variables +include $(base_dir)/variables.mk ######################################################################################### # name of simulator (used to generate *.f arguments file) @@ -32,8 +32,8 @@ debug: $(sim_debug) ######################################################################################### # import other necessary rules and variables ######################################################################################### -include $(base_dir)/Makefrag -include $(sim_dir)/Makefrag-Verilator +include $(base_dir)/common.mk +include $(sim_dir)/verilator.mk ######################################################################################### # verilator build paths and file names diff --git a/sims/verisim/Makefrag-Verilator b/sims/verisim/Makefrag-Verilator deleted file mode 100644 index 3af9b335..00000000 --- a/sims/verisim/Makefrag-Verilator +++ /dev/null @@ -1,47 +0,0 @@ -######################################################################################### -# verilator installation makefrag -######################################################################################### - -######################################################################################### -# verilator version, binary, and path -######################################################################################### -VERILATOR_VERSION=4.008 -VERILATOR_SRCDIR=verilator/src/verilator-$(VERILATOR_VERSION) -INSTALLED_VERILATOR=$(abspath verilator/install/bin/verilator) - -######################################################################################### -# build and install our own verilator to work around versioning issues -######################################################################################### -$(INSTALLED_VERILATOR): $(VERILATOR_SRCDIR)/bin/verilator - $(MAKE) -C $(VERILATOR_SRCDIR) installbin installdata - touch $@ - -$(VERILATOR_SRCDIR)/bin/verilator: $(VERILATOR_SRCDIR)/Makefile - $(MAKE) -C $(VERILATOR_SRCDIR) verilator_bin - touch $@ - -$(VERILATOR_SRCDIR)/Makefile: $(VERILATOR_SRCDIR)/configure - mkdir -p $(dir $@) - cd $(dir $@) && ./configure --prefix=$(abspath verilator/install) - -$(VERILATOR_SRCDIR)/configure: verilator/verilator-$(VERILATOR_VERSION).tar.gz - rm -rf $(dir $@) - mkdir -p $(dir $@) - cat $^ | tar -xz --strip-components=1 -C $(dir $@) - touch $@ - -verilator/verilator-$(VERILATOR_VERSION).tar.gz: - mkdir -p $(dir $@) - wget http://www.veripool.org/ftp/verilator-$(VERILATOR_VERSION).tgz -O $@ - -######################################################################################### -# verilator binary and flags -######################################################################################### -VERILATOR := $(INSTALLED_VERILATOR) --cc --exe -CXXFLAGS := $(CXXFLAGS) -O1 -std=c++11 -I$(RISCV)/include -D__STDC_FORMAT_MACROS -VERILATOR_FLAGS := --top-module $(MODEL) \ - +define+PRINTF_COND=\$$c\(\"verbose\",\"\&\&\"\,\"done_reset\"\) \ - +define+STOP_COND=\$$c\(\"done_reset\"\) --assert \ - --output-split 20000 \ - -Wno-STMTDLY --x-assign unique \ - -O3 -CFLAGS "$(CXXFLAGS) -DTEST_HARNESS=V$(MODEL) -DVERILATOR" diff --git a/sims/vsim/Makefile b/sims/vsim/Makefile index 451b4602..022e8079 100644 --- a/sims/vsim/Makefile +++ b/sims/vsim/Makefile @@ -11,7 +11,7 @@ sim_dir=$(abspath .) ######################################################################################### # include shared variables ######################################################################################### -include $(base_dir)/Makefrag-Variables +include $(base_dir)/variables.mk ######################################################################################### # name of simulator (used to generate *.f arguments file) @@ -32,7 +32,7 @@ debug: $(sim_debug) ######################################################################################### # import other necessary rules and variables ######################################################################################### -include $(base_dir)/Makefrag +include $(base_dir)/common.mk ######################################################################################### # vcs binary and arguments @@ -71,12 +71,6 @@ VCS_NONCC_OPTS = \ VCS_OPTS = -notice -line $(VCS_CC_OPTS) $(VCS_NONCC_OPTS) -######################################################################################### -# helper rule to just make verilog files -######################################################################################### -.PHONY: verilog -verilog: $(sim_vsrcs) - ######################################################################################### # vcs simulator rules ######################################################################################### diff --git a/Makefrag-Variables b/variables.mk similarity index 93% rename from Makefrag-Variables rename to variables.mk index 18793d3d..f44286c5 100644 --- a/Makefrag-Variables +++ b/variables.mk @@ -6,11 +6,11 @@ # default variables to invoke the generator # descriptions: # PROJECT = the scala package to find the MODEL in -# MODEL = the top level module of the project +# MODEL = the top level module of the project (normally the harness) # CONFIG = the configuration class to give the parameters for the project # CFG_PROJECT = the scala package to find the CONFIG class -# TB = TODO -# TOP = TODO +# TB = wrapper over the TestHarness needed to simulate in VCS +# TOP = top level module of the project (normally the module instantiated by the harness) ######################################################################################### PROJECT ?= example MODEL ?= TestHarness From 4fd1bfbd567e137d09ca85106f614d9044c1d53e Mon Sep 17 00:00:00 2001 From: abejgonzalez Date: Fri, 8 Mar 2019 17:00:21 -0800 Subject: [PATCH 3/5] delete .ctags (have the user put this in their home) --- .ctags | 13 ------------- 1 file changed, 13 deletions(-) delete mode 100644 .ctags diff --git a/.ctags b/.ctags deleted file mode 100644 index b7d31250..00000000 --- a/.ctags +++ /dev/null @@ -1,13 +0,0 @@ ---langdef=scala ---langmap=scala:.scala - ---regex-scala=/^[ \t]*((abstract|final|sealed|implicit|lazy)[ \t]*)*(private[^ ]*|protected)?[ \t]*class[ \t]+([a-zA-Z0-9_]+)/\4/c,classes/ ---regex-scala=/^[ \t]*((abstract|final|sealed|implicit|lazy)[ \t]*)*(private[^ ]*|protected)?[ \t]*object[ \t]+([a-zA-Z0-9_]+)/\4/o,objects/ ---regex-scala=/^[ \t]*((abstract|final|sealed|implicit|lazy)[ \t]*)*(private[^ ]*|protected)?[ \t]*((abstract|final|sealed|implicit|lazy)[ \t ]*)*case class[ \t ]+([a-zA-Z0-9_]+)/\6/C,case classes/ ---regex-scala=/^[ \t]*((abstract|final|sealed|implicit|lazy)[ \t]*)*(private[^ ]*|protected)?[ \t]*case object[ \t]+([a-zA-Z0-9_]+)/\4/O,case objects/ ---regex-scala=/^[ \t]*((abstract|final|sealed|implicit|lazy)[ \t]*)*(private[^ ]*|protected)?[ \t]*trait[ \t]+([a-zA-Z0-9_]+)/\4/t,traits/ ---regex-scala=/^[ \t]*type[ \t]+([a-zA-Z0-9_]+)/\1/T,types/ ---regex-scala=/^[ \t]*((abstract|final|sealed|implicit|lazy|override|private[^ ]*(\[[a-z]*\])*|protected)[ \t]*)*def[ \t]+([a-zA-Z0-9_]+)/\4/m,methods/ ---regex-scala=/^[ \t]*((abstract|final|sealed|implicit|lazy|override|private[^ ]*|protected)[ \t]*)*val[ \t]+([a-zA-Z0-9_]+)/\3/V,values/ ---regex-scala=/^[ \t]*((abstract|final|sealed|implicit|lazy|override|private[^ ]*|protected)[ \t]*)*var[ \t]+([a-zA-Z0-9_]+)/\3/v,variables/ ---regex-scala=/^[ \t]*package[ \t]+([a-zA-Z0-9_.]+)/\1/p,packages/ From c3648695638a7416290892a5e96add15419394f3 Mon Sep 17 00:00:00 2001 From: abejgonzalez Date: Fri, 8 Mar 2019 18:11:10 -0800 Subject: [PATCH 4/5] default to .gitignoring all files in verisim/vsim | read verilator.mk --- .gitignore | 3 --- sims/verisim/.gitignore | 3 ++- sims/verisim/verilator.mk | 47 +++++++++++++++++++++++++++++++++++++++ sims/vsim/.gitignore | 3 ++- 4 files changed, 51 insertions(+), 5 deletions(-) create mode 100644 sims/verisim/verilator.mk diff --git a/.gitignore b/.gitignore index 2efa7a6a..3866cf2f 100644 --- a/.gitignore +++ b/.gitignore @@ -3,9 +3,6 @@ bootrom target *.jar *.stamp -/sims/vsim -/sims/verisim -simv* *.vcd *.swp .idea diff --git a/sims/verisim/.gitignore b/sims/verisim/.gitignore index e442175e..afbfb95f 100644 --- a/sims/verisim/.gitignore +++ b/sims/verisim/.gitignore @@ -1,3 +1,4 @@ +* !.gitignore !Makefile -!Makefrag-verilator +!verilator.mk diff --git a/sims/verisim/verilator.mk b/sims/verisim/verilator.mk new file mode 100644 index 00000000..3af9b335 --- /dev/null +++ b/sims/verisim/verilator.mk @@ -0,0 +1,47 @@ +######################################################################################### +# verilator installation makefrag +######################################################################################### + +######################################################################################### +# verilator version, binary, and path +######################################################################################### +VERILATOR_VERSION=4.008 +VERILATOR_SRCDIR=verilator/src/verilator-$(VERILATOR_VERSION) +INSTALLED_VERILATOR=$(abspath verilator/install/bin/verilator) + +######################################################################################### +# build and install our own verilator to work around versioning issues +######################################################################################### +$(INSTALLED_VERILATOR): $(VERILATOR_SRCDIR)/bin/verilator + $(MAKE) -C $(VERILATOR_SRCDIR) installbin installdata + touch $@ + +$(VERILATOR_SRCDIR)/bin/verilator: $(VERILATOR_SRCDIR)/Makefile + $(MAKE) -C $(VERILATOR_SRCDIR) verilator_bin + touch $@ + +$(VERILATOR_SRCDIR)/Makefile: $(VERILATOR_SRCDIR)/configure + mkdir -p $(dir $@) + cd $(dir $@) && ./configure --prefix=$(abspath verilator/install) + +$(VERILATOR_SRCDIR)/configure: verilator/verilator-$(VERILATOR_VERSION).tar.gz + rm -rf $(dir $@) + mkdir -p $(dir $@) + cat $^ | tar -xz --strip-components=1 -C $(dir $@) + touch $@ + +verilator/verilator-$(VERILATOR_VERSION).tar.gz: + mkdir -p $(dir $@) + wget http://www.veripool.org/ftp/verilator-$(VERILATOR_VERSION).tgz -O $@ + +######################################################################################### +# verilator binary and flags +######################################################################################### +VERILATOR := $(INSTALLED_VERILATOR) --cc --exe +CXXFLAGS := $(CXXFLAGS) -O1 -std=c++11 -I$(RISCV)/include -D__STDC_FORMAT_MACROS +VERILATOR_FLAGS := --top-module $(MODEL) \ + +define+PRINTF_COND=\$$c\(\"verbose\",\"\&\&\"\,\"done_reset\"\) \ + +define+STOP_COND=\$$c\(\"done_reset\"\) --assert \ + --output-split 20000 \ + -Wno-STMTDLY --x-assign unique \ + -O3 -CFLAGS "$(CXXFLAGS) -DTEST_HARNESS=V$(MODEL) -DVERILATOR" diff --git a/sims/vsim/.gitignore b/sims/vsim/.gitignore index 803a3908..a0991ff4 100644 --- a/sims/vsim/.gitignore +++ b/sims/vsim/.gitignore @@ -1,2 +1,3 @@ -!Makefile +* !.gitignore +!Makefile From e33f2fcedf889e10332317dfe2b6d531e9bb08bd Mon Sep 17 00:00:00 2001 From: abejgonzalez Date: Tue, 12 Mar 2019 15:39:19 -0700 Subject: [PATCH 5/5] find now follows symlinks --- common.mk | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/common.mk b/common.mk index dd1cbd8e..1ff52172 100644 --- a/common.mk +++ b/common.mk @@ -6,7 +6,7 @@ SHELL=/bin/bash ######################################################################################### # variables to get all *.scala files ######################################################################################### -lookup_scala_srcs = $(shell find $(1)/ -iname "*.scala" 2> /dev/null) +lookup_scala_srcs = $(shell find -L $(1)/ -iname "*.scala" 2> /dev/null) PACKAGES=rocket-chip testchipip SCALA_SOURCES=$(foreach pkg,$(PACKAGES),$(call lookup_scala_srcs,$(base_dir)/generators/$(pkg)/src/main/scala)) $(call lookup_scala_srcs,$(base_dir)/src/main/scala)