From 92a6169d2a793fdea47add1d667ab5a43eb1bbe2 Mon Sep 17 00:00:00 2001
From: Florent Kermarrec <florent@enjoy-digital.fr>
Date: Sun, 9 Dec 2018 08:10:50 +0100
Subject: [PATCH] build/sim: add coverage parameter to enable code coverage

---
 litex/build/sim/core/Makefile |  4 +++-
 litex/build/sim/verilator.py  | 13 ++++++++-----
 2 files changed, 11 insertions(+), 6 deletions(-)

diff --git a/litex/build/sim/core/Makefile b/litex/build/sim/core/Makefile
index 4be325cac..80d201e3e 100644
--- a/litex/build/sim/core/Makefile
+++ b/litex/build/sim/core/Makefile
@@ -30,7 +30,9 @@ sim: mkdir $(OBJS_SIM)
 		$(if $(THREADS), --threads $(THREADS),) \
 		-CFLAGS "$(CFLAGS) -I$(SRC_DIR)" \
 		-LDFLAGS "$(LDFLAGS)" \
-		-trace $(INC_DIR)
+		--trace \
+		$(if $(COVERAGE), --coverage,) \
+		$(INC_DIR)
 	make -j -C $(OBJ_DIR) -f Vdut.mk Vdut
 
 .PHONY: modules
diff --git a/litex/build/sim/verilator.py b/litex/build/sim/verilator.py
index ac8124721..397003298 100644
--- a/litex/build/sim/verilator.py
+++ b/litex/build/sim/verilator.py
@@ -118,13 +118,16 @@ def _generate_sim_config(config):
     tools.write_to_file("sim_config.js", content)
 
 
-def _build_sim(platform, build_name, threads, verbose):
+def _build_sim(platform, build_name, threads, coverage, verbose):
     makefile = os.path.join(core_directory, 'Makefile')
     build_script_contents = """\
 rm -rf obj_dir/
-make -C . -f {} {}
+make -C . -f {} {} {}
 mkdir -p modules && cp obj_dir/*.so modules
-""".format(makefile, "THREADS={}".format(threads) if int(threads) > 1 else "")
+""".format(makefile,
+    "THREADS={}".format(threads) if int(threads) > 1 else "",
+    "COVERAGE=1" if coverage else "",
+    )
     build_script_file = "build_" + build_name + ".sh"
     tools.write_to_file(build_script_file, build_script_contents, force_unix=True)
 
@@ -161,7 +164,7 @@ def _run_sim(build_name, as_root=False):
 class SimVerilatorToolchain:
     def build(self, platform, fragment, build_dir="build", build_name="dut",
             toolchain_path=None, serial="console", build=True, run=True, threads=1,
-            verbose=True, sim_config=None, trace=False):
+            verbose=True, sim_config=None, trace=False, coverage=False):
 
         os.makedirs(build_dir, exist_ok=True)
         os.chdir(build_dir)
@@ -188,7 +191,7 @@ class SimVerilatorToolchain:
             if sim_config:
                 _generate_sim_config(sim_config)
 
-            _build_sim(platform, build_name, threads, verbose)
+            _build_sim(platform, build_name, threads, coverage, verbose)
 
         if run:
             _run_sim(build_name, as_root=sim_config.has_module("ethernet"))