Merge pull request #3297 from Pinata-Consulting/synthesis-consistent-naming-and-hash

synthesis: more consistent naming of logs and results

Author: maliberty

flow/Makefile

@@ -258,7 +258,7 @@ synth-report: synth
 
 .PHONY: do-synth-report
 do-synth-report:
-	($(TIME_CMD) $(OPENROAD_CMD) $(SCRIPTS_DIR)/synth_metrics.tcl) 2>&1 | tee $(abspath $(LOG_DIR)/1_1_yosys_metrics.log)
+	($(TIME_CMD) $(OPENROAD_CMD) $(SCRIPTS_DIR)/synth_metrics.tcl) 2>&1 | tee $(abspath $(LOG_DIR)/1_2_yosys_metrics.log)
 
 .PHONY: memory
 memory:
@@ -282,24 +282,24 @@ yosys-dependencies: $(YOSYS_DEPENDENCIES)
 
 .PHONY: do-yosys
 do-yosys: $(DONT_USE_SC_LIB)
-	$(SCRIPTS_DIR)/synth.sh $(SYNTH_SCRIPT) $(LOG_DIR)/1_1_yosys.log
+	$(SCRIPTS_DIR)/synth.sh $(SYNTH_SCRIPT) $(LOG_DIR)/1_2_yosys.log
 
 .PHONY: do-yosys-canonicalize
 do-yosys-canonicalize: yosys-dependencies $(DONT_USE_SC_LIB)
 	$(SCRIPTS_DIR)/synth.sh $(SCRIPTS_DIR)/synth_canonicalize.tcl $(LOG_DIR)/1_1_yosys_canonicalize.log
 
-$(RESULTS_DIR)/1_synth.rtlil: $(YOSYS_DEPENDENCIES)
+$(RESULTS_DIR)/1_1_yosys_canonicalize.rtlil: $(YOSYS_DEPENDENCIES)
 	$(UNSET_AND_MAKE) do-yosys-canonicalize
 
-$(RESULTS_DIR)/1_1_yosys.v: $(RESULTS_DIR)/1_synth.rtlil
+$(RESULTS_DIR)/1_2_yosys.v: $(RESULTS_DIR)/1_1_yosys_canonicalize.rtlil
 	$(UNSET_AND_MAKE) do-yosys
 
 .PHONY: do-synth
 do-synth:
 	mkdir -p $(RESULTS_DIR) $(LOG_DIR) $(REPORTS_DIR)
-	cp $(RESULTS_DIR)/1_1_yosys.v $(RESULTS_DIR)/1_synth.v
+	cp $(RESULTS_DIR)/1_2_yosys.v $(RESULTS_DIR)/1_synth.v
 
-$(RESULTS_DIR)/1_synth.v: $(RESULTS_DIR)/1_1_yosys.v
+$(RESULTS_DIR)/1_synth.v: $(RESULTS_DIR)/1_2_yosys.v
 	$(UNSET_AND_MAKE) do-synth
 
 .PHONY: clean_synth

flow/scripts/synth.tcl

@@ -1,5 +1,5 @@
 source $::env(SCRIPTS_DIR)/synth_preamble.tcl
-read_checkpoint $::env(RESULTS_DIR)/1_synth.rtlil
+read_checkpoint $::env(RESULTS_DIR)/1_1_yosys_canonicalize.rtlil
 
 hierarchy -check -top $::env(DESIGN_NAME)
 
@@ -145,7 +145,7 @@ if { ![env_var_exists_and_non_empty SYNTH_WRAPPED_OPERATORS] } {
 }
 
 # Write synthesized design
-write_verilog -nohex -nodec $::env(RESULTS_DIR)/1_1_yosys.v
+write_verilog -nohex -nodec $::env(RESULTS_DIR)/1_2_yosys.v
 # One day a more sophisticated synthesis will write out a modified
 # .sdc file after synthesis. For now, just copy the input .sdc file,
 # making synthesis more consistent with other stages.

flow/scripts/synth_canonicalize.tcl

@@ -10,4 +10,4 @@ hierarchy -check -top $::env(DESIGN_NAME)
 # Get rid of unused modules
 opt_clean -purge
 # The hash of this file will not change if files not part of synthesis do not change
-write_rtlil $::env(RESULTS_DIR)/1_synth.rtlil
+write_rtlil $::env(RESULTS_DIR)/1_1_yosys_canonicalize.rtlil

flow/scripts/synth_metrics.tcl

@@ -1,5 +1,5 @@
 utl::set_metrics_stage "synth__{}"
 source $::env(SCRIPTS_DIR)/load.tcl
-load_design 1_1_yosys.v 1_synth.sdc
+load_design 1_2_yosys.v 1_synth.sdc
 
 report_metrics 1 "Post synthesis" false false

flow/scripts/synth_preamble.tcl

@@ -8,11 +8,11 @@ erase_non_stage_variables synth
 # floorplan step to be re-executed.
 if { [env_var_exists_and_non_empty SYNTH_NETLIST_FILES] } {
   if { [llength $::env(SYNTH_NETLIST_FILES)] == 1 } {
-    log_cmd exec cp -p $::env(SYNTH_NETLIST_FILES) $::env(RESULTS_DIR)/1_1_yosys.v
+    log_cmd exec cp -p $::env(SYNTH_NETLIST_FILES) $::env(RESULTS_DIR)/1_2_yosys.v
   } else {
     # The date should be the most recent date of the files, but to
     # keep things simple we just use the creation date
-    log_cmd exec cat {*}$::env(SYNTH_NETLIST_FILES) > $::env(RESULTS_DIR)/1_1_yosys.v
+    log_cmd exec cat {*}$::env(SYNTH_NETLIST_FILES) > $::env(RESULTS_DIR)/1_2_yosys.v
   }
   log_cmd exec cp -p $::env(SDC_FILE) $::env(RESULTS_DIR)/1_synth.sdc
   if { [env_var_exists_and_non_empty CACHED_REPORTS] } {

flow/util/genElapsedTime.py

@@ -62,20 +62,22 @@ def print_log_dir_times(logdir, args):
                         int(line.split("Peak memory: ")[1].split("KB")[0]) / 1024
                     )
 
-            # content hash for .odb file alongside .log file is useful to
+            # content hash for the result file alongside .log file is useful to
             # debug divergent results under what should be identical
             # builds(such as local and CI builds)
-            odb_file = pathlib.Path(
-                str(f).replace("logs/", "results/").replace(".log", ".odb")
-            )
-            if odb_file.exists():
-                hasher = hashlib.sha1()
-                with open(odb_file, "rb") as odb_f:
-                    while chunk := odb_f.read(16 * 1024 * 1024):
-                        hasher.update(chunk)
-                odb_hash = hasher.hexdigest()
-            else:
-                odb_hash = "N/A"
+            for ext in [".odb", ".rtlil", ".v"]:
+                result_file = pathlib.Path(
+                    str(f).replace("logs/", "results/").replace(".log", ext)
+                )
+                if result_file.exists():
+                    hasher = hashlib.sha1()
+                    with open(result_file, "rb") as odb_f:
+                        while chunk := odb_f.read(16 * 1024 * 1024):
+                            hasher.update(chunk)
+                    odb_hash = hasher.hexdigest()
+                    break
+                else:
+                    odb_hash = "N/A"
 
             if not found:
                 print("No elapsed time found in", str(f), file=sys.stderr)

flow/util/genMetrics.py

@@ -288,7 +288,7 @@ def extract_metrics(
     # Accumulate time
     # =========================================================================
 
-    extractGnuTime("synth", metrics_dict, logPath + "/1_1_yosys.log")
+    extractGnuTime("synth", metrics_dict, logPath + "/1_2_yosys.log")
     extractGnuTime("floorplan", metrics_dict, logPath + "/2_1_floorplan.log")
     extractGnuTime("floorplan_io", metrics_dict, logPath + "/2_2_floorplan_io.log")
     extractGnuTime(