# Utilities
#===============================================================================
.PHONY: metadata
metadata: finish metadata-generate metadata-check

# Synthesis-only metadata: generate and check QoR after just the synth
# stage, without running the full flow. The synthesis-stage subset of
# the design's regular rules file gates the run, so no per-variant
# rules file needs to be committed. Sequential sub-makes rather than
# prerequisites: each step consumes the previous one's outputs, which
# plain prerequisites would race under make -j.
.PHONY: metadata-synth
metadata-synth: export RULES_JSON = $(DESIGN_DIR)/rules-base.json
metadata-synth:
	$(MAKE) synth
	$(MAKE) metadata-generate
	$(MAKE) metadata-check-synth

.PHONY: metadata-generate
metadata-generate:
	mkdir -p $(REPORTS_DIR)
	echo $(DESIGN_DIR) > $(REPORTS_DIR)/design-dir.txt
	$(PYTHON_EXE) $(UTILS_DIR)/genMetrics.py -d $(DESIGN_NICKNAME) \
	    -p $(PLATFORM) \
	    -v $(FLOW_VARIANT) \
	    --logs $(LOG_DIR) \
	    --reports $(REPORTS_DIR) \
	    --results $(RESULTS_DIR) \
	    -o $(REPORTS_DIR)/metadata.json 2>&1 \
	    | tee $(abspath $(REPORTS_DIR)/metadata-generate.log)

export RULES_JSON ?= $(DESIGN_DIR)/rules-$(FLOW_VARIANT).json

.PHONY: metadata-check
metadata-check:
	$(PYTHON_EXE) $(UTILS_DIR)/checkMetadata.py \
	    -m $(REPORTS_DIR)/metadata.json \
	    -r $(RULES_JSON) 2>&1 \
	    | tee $(abspath $(REPORTS_DIR)/metadata-check.log)

# Check only the synthesis-stage subset of RULES_JSON, so a
# synthesis-only run can be gated by the design's full-flow rules file.
.PHONY: metadata-check-synth
metadata-check-synth:
	$(PYTHON_EXE) $(UTILS_DIR)/checkMetadata.py \
	    -m $(REPORTS_DIR)/metadata.json \
	    -r $(RULES_JSON) \
	    --only-prefix synth__ constraints__ 2>&1 \
	    | tee $(abspath $(REPORTS_DIR)/metadata-check.log)

.PHONY: clean_metadata
clean_metadata:
	rm -f $(REPORTS_DIR)/design-dir.txt
	rm -f $(REPORTS_DIR)/metadata*.*

.PHONY: update_ok
update_ok: update_rules

.PHONY: update_metadata
update_metadata:
	cp -f $(REPORTS_DIR)/metadata.json \
	      $(DESIGN_DIR)/metadata-$(FLOW_VARIANT)-ok.json

.PHONY: do-update_rules
do-update_rules:
	mkdir -p $(REPORTS_DIR)
	$(PYTHON_EXE) $(UTILS_DIR)/genRuleFile.py \
	    --rules $(RULES_JSON) \
	    --new-rules $(REPORTS_DIR)/rules.json \
	    --reference $(REPORTS_DIR)/metadata.json \
	    --variant $(FLOW_VARIANT) \
	    --failing \
	    --tighten

.PHONY: do-copy_update_rules
do-copy_update_rules:
	cp -f $(REPORTS_DIR)/rules.json \
	      $(RULES_JSON)

.PHONY: update_rules
update_rules: do-update_rules do-copy_update_rules

.PHONY: do-update_rules_force
do-update_rules_force:
	mkdir -p $(REPORTS_DIR)
	$(PYTHON_EXE) $(UTILS_DIR)/genRuleFile.py \
	    --rules $(RULES_JSON) \
	    --new-rules $(REPORTS_DIR)/rules.json \
	    --reference $(REPORTS_DIR)/metadata.json \
	    --variant $(FLOW_VARIANT) \
	    --update

.PHONY: update_rules_force
update_rules_force: do-update_rules_force
	cp -f $(REPORTS_DIR)/rules.json \
	      $(RULES_JSON)

.PHONY: update_metadata_autotuner
update_metadata_autotuner:
	$(PYTHON_EXE) $(UTILS_DIR)/genMetrics.py -d $(DESIGN_NICKNAME) \
	    -p $(PLATFORM) \
	    -v $(FLOW_VARIANT) \
	    --logs $(LOG_DIR) \
	    --reports $(REPORTS_DIR) \
	    --results $(RESULTS_DIR) \
	    -o $(DESIGN_DIR)/metadata-$(FLOW_VARIANT)-at.json -x

#-------------------------------------------------------------------------------

.PHONY: write_rc
write_rc: $(RESULTS_DIR)/6_nets_rc.csv $(RESULTS_DIR)/6_segments_rc.csv

# A pattern rule to write both files with a single run, as the grouped target
# syntax requires GNU Make 4.3.
%_nets_rc.csv %_segments_rc.csv:
	$(RUN_CMD) --log $(LOG_DIR)/6_write_rc.log --tee -- $(OPENROAD_CMD) $(UTILS_DIR)/write_rc.tcl

.PHONY: correlate_rc
correlate_rc: $(RESULTS_DIR)/6_segments_rc.csv
	$(PYTHON_EXE) $(UTILS_DIR)/correlateRC.py \
	    -segments_rc_file $(RESULTS_DIR)/6_segments_rc.csv

# TODO Make always wants to redo designs with this rule, regardless of which variations are tried.
#	$(MAKE) DESIGN_CONFIG=$$config write_rc; \
#$(foreach config,$(wildcard designs/$(PLATFORM)/*/config.mk),$(MAKE) DESIGN_CONFIG=$(config) write_rc; )
.PHONY: correlate_platform_rc
correlate_platform_rc:
	for config in designs/$(PLATFORM)/*/config.mk; do \
	  design=$$(basename $$(dirname $$config)); \
	  make DESIGN_CONFIG=./$$config \
	    results/$(PLATFORM)/$$design/base/6_nets_rc.csv \
	    results/$(PLATFORM)/$$design/base/6_segments_rc.csv; \
	done
	$(PYTHON_EXE) $(UTILS_DIR)/correlateRC.py \
	    -segments_rc_file $$(find results/$(PLATFORM)/*/base -name 6_segments_rc.csv)

# Run test using gnu parallel
#-------------------------------------------------------------------------------
TEST_SCRIPT ?= $(TEST_DIR)/core_tests.sh
.PHONY: run_test
run_test:
	parallel --sshloginfile $(TEST_DIR)/nodes.txt \
	         --timeout 21600 \
	         --workdir `pwd` < $(TEST_SCRIPT) \
	         --joblog $(TEST_DIR)/parallel.log

.PHONY: clean_test
clean_test:
	rm -rf $(TEST_DIR)/logs
	rm -rf $(TEST_DIR)/parallel.log

# Utility to create issues
#-------------------------------------------------------------------------------
# Run "make {script}_issue" where script is wildcarded from the scripts folder
#   e.g "make cts_issue"
# Set the ISSUE_TAG variable to rename the generated tar file
#-------------------------------------------------------------------------------
ISSUE_SCRIPTS = $(patsubst %.tcl,%,$(notdir $(sort $(wildcard $(SCRIPTS_DIR)/*.tcl))))
define \n


endef

.PHONY: $(foreach script,$(ISSUE_SCRIPTS),$(script)_issue)

$(foreach script,$(ISSUE_SCRIPTS),$(script)_issue): %_issue :
	$(UTILS_DIR)/makeIssue.sh $(WORK_HOME)/$*

.PHONY: clean_issues
clean_issues:
	rm -f $(foreach issue, $(ISSUE_SCRIPTS), $(issue)_*.tar.gz)
	rm -f vars*.sh vars*.tcl vars*.gdb run-me*.sh

$(RESULTS_DIR)/6_final_only_clk.def: $(RESULTS_DIR)/6_final.def
	$(RUN_CMD) --tee -- $(OPENROAD_CMD) $(SCRIPTS_DIR)/deleteNonClkNets.tcl

$(RESULTS_DIR)/6_final_no_power.def: $(RESULTS_DIR)/6_final.def
	$(RUN_CMD) --tee -- $(OPENROAD_CMD) $(SCRIPTS_DIR)/deletePowerNets.tcl


.PHONY: gallery
gallery: check-klayout $(RESULTS_DIR)/6_final_no_power.def $(RESULTS_DIR)/6_final_only_clk.def
	$(RUN_CMD) --log $(LOG_DIR)/6_1_merge.log --tee -- \
	        klayout -z -nc -rx -rd gallery_json=util/gallery.json \
	        -rd results_path=$(RESULTS_DIR) \
	        -rd tech_file=$(OBJECTS_DIR)/klayout.lyt \
	        -rm $(UTILS_DIR)/createGallery.py

.PHONY: view_cells view_cells_web
view_cells:
	$(OPENROAD_GUI_CMD) $(SCRIPTS_DIR)/view_cells.tcl

.PHONY: view_cells_web
view_cells_web:
	$(OPENROAD_WEB_CMD) $(SCRIPTS_DIR)/view_cells.tcl

## Quick access to command line
.PHONY: command
command:
	$(OPENROAD_NO_EXIT_CMD)

## Provide easy access to debugging
ifdef GDB
export OPENROAD_EXE := gdb --args $(OPENROAD_EXE)
endif

## Provide easy way to run valgrind
ifdef VALGRIND
export OPENROAD_EXE := valgrind $(VALGRIND_ARGS) $(OPENROAD_EXE)
endif

## Convert RVE DRC database to JSON
.PHONY: convert_rve
convert_rve: $(REPORTS_DIR)/drc.json

$(REPORTS_DIR)/drc.json: $(DRC_FILE)
ifneq ($(DRC_FILE),)
	$(KLAYOUT_CMD) -z -rd in_drc="$<" \
	        -rd out_file="$@" \
	        -rm $(UTILS_DIR)/convertDrc.py
else
	@echo "No DRC_FILE defined."
endif

# Update the clock period sdc based on the worst slack reported by the final
# (post global route) timing.
.PHONY: update_sdc_clocks
update_sdc_clocks: $(RESULTS_DIR)/route.guide
	cp $(RESULTS_DIR)/updated_clks.sdc $(SDC_FILE)