makefile

# IBM_PROLOG_BEGIN_TAG
# This is an automatically generated prolog.
#
# $Source: makefile $
#
# OpenPOWER HostBoot Project
#
# Contributors Listed Below - COPYRIGHT 2010,2023
# [+] International Business Machines Corp.
#
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
# implied. See the License for the specific language governing
# permissions and limitations under the License.
#
# IBM_PROLOG_END_TAG

SUBDIRS = src.d
ROOTPATH = .

CONFIG_FILE ?= default

GEN_PASS_PRE += $(GENDIR)/.$(notdir $(CONFIG_FILE)).config
CLEAN_TARGETS += $(wildcard $(GENDIR)/.*.config)
CLEAN_TARGETS += $(GENDIR)/config.mk $(GENDIR)/config.h
SKIP_CONFIG_FILE_LOAD = 1

IMAGE_PASS_POST += $(GENDIR)/hwp_id.html
CLEAN_TARGETS   += $(GENDIR)/hwp_id.html

# Name of file to indicate which release Hostboot is building for
HB_FSP_RELEASE = $(GENDIR)/hb_fsp_release
HB_P10_RELEASE = $(GENDIR)/hb_simics_p10_release

IMAGE_PASS_POST += check_istep_modules

# Variables used when running cppcheck tool.
# The actual commands are stored in CXX_CHECK and C_CHECK, which are created as
# dummy variables here, but will be set to the actual tool in the "cppcheck" rule
BUILDCPPCHECK := $(PROJECT_ROOT)/src/build/tools/build-cppcheck
CPPCHECKTOOL := $(PROJECT_ROOT)/src/build/tools/cpptools/cppcheck/cppcheck
CPPCHECKFLAGS := --inline-suppr --quiet --xml --xml-version=2 --error-exitcode=1 --template='Error CPPCHECK {file}: line {line}\nSyntax error string: {id}\n{message}'
CPPCHECK := $(CPPCHECKTOOL) $(CPPCHECKFLAGS)
export CXX_CHECK ?= true
export C_CHECK ?= true

.PHONY: gen_hb_tooldata_tar
gen_hb_tooldata_tar:
	rm -f $(ROOTPATH)/obj/genfiles/hb_tooldata.tar.gz
	tar czf $(ROOTPATH)/obj/genfiles/hb_tooldata.tar.gz $(ROOTPATH)/img/*.syms.mangled

FINAL_PASS += gen_hb_tooldata_tar

include ./config.mk

.PHONY: docs
docs: src/build/doxygen/doxygen.conf
	rm -rf obj/doxygen/*
	doxygen src/build/doxygen/doxygen.conf

.PHONY: citest
citest:
	src/build/citest/cxxtest-start.sh

gcov: HOSTBOOT_PROFILE := 1

export HOSTBOOT_PROFILE

.PHONY: gcov
gcov:
	@echo The following object files were not instrumented: >$(HOSTBOOT_PROFILE_NOCOV_LOG)
	@echo Building Hostboot with profiling enabled.
	$(MAKE)
	@echo Run simics and execute the hb-Gcov command at the end of the simulation to extract gcov data.
	@echo Then you can "make lcov" to generate the coverage report.

.PHONY: lcov
lcov: $(LCOV_TOOL) $(GENHTML_TOOL)
	rm -f obj/lcov_data obj/zero_lcov_data obj/real_lcov_data
	# Write initial baseline (all-zero) coverage data
	$(LCOV_TOOL) --initial -c --dir . -o obj/zero_lcov_data --gcov-tool $(GCOV)
	# Collect real coverage data from the traces
	$(LCOV_TOOL) -c --dir . -o obj/real_lcov_data --gcov-tool $(GCOV)
	# Combine the initial and the real data into one report
	$(LCOV_TOOL) --dir . -a obj/real_lcov_data -a obj/zero_lcov_data -o obj/lcov_data --gcov-tool $(GCOV)
	rm -rf obj/gcov_report
	$(GENHTML_TOOL) obj/lcov_data -o obj/gcov_report --ignore-errors source
	cp $(HOSTBOOT_PROFILE_NOCOV_LOG) obj/gcov_report/
	@echo Coverage report now available in obj/gcov_report

.PHONY: cppcheck
cppcheck:
	@echo Building with CPPCHECK tool
# TODO RTC: 215692
	${BUILDCPPCHECK}
	export CXX_CHECK="$(CPPCHECK) $(filter -D%, $(CXXFLAGS)) $(INCFLAGS)" && \
	export C_CHECK="$(CPPCHECK) $(filter -D%, $(CFLAGS)) $(INCFLAGS)" && \
	export DOCPPCHECK=1 && \
	${MAKE}

PPE_PATH := $(ROOTPATH)/src/build/tools/extern/ppe
SBE_PATH := $(ROOTPATH)/src/build/tools/extern/sbe

.PHONY: ppe
ppe: $(PPE_PATH)/Makefile

.PHONY: $(PPE_PATH)/Makefile
$(PPE_PATH)/Makefile:
ifeq (${HB_PRESERVE_SUBMODULES},1)
	echo "***Skipping submodule update for $(PPE_PATH)"
else
	git submodule update --init --checkout -- $(PPE_PATH)
endif

.PHONY: sbe
sbe: $(SBE_PATH)/Makefile

.PHONY: $(SBE_PATH)/Makefile
$(SBE_PATH)/Makefile:
ifeq (${HB_PRESERVE_SUBMODULES},1)
	echo "***Skipping submodule update for $(SBE_PATH)"
else
	git submodule update --init --checkout -- $(SBE_PATH)
endif

EKB_PATH := $(ROOTPATH)/src/build/tools/extern/ekb

.PHONY: ekb
ekb: $(EKB_PATH)/ekb

.PHONY: $(EKB_PATH)/ekb
$(EKB_PATH)/ekb:
ifeq (${HB_PRESERVE_SUBMODULES},1)
	echo "***Skipping submodule update for $(EKB_PATH)"
else
	git submodule update --init --checkout -- $(EKB_PATH)
endif

.PHONY: gcda_clean
gcda_clean:
	find -name '*.gcda' -exec rm -f {} \;

$(GENDIR)/hwp_id.html :
	$(ROOTPATH)/src/build/tools/hwp_id.pl -i -l > $@

.PHONY: check_istep_modules
check_istep_modules: $(OBJS)
	listdeps.pl $(IMGDIR)  -v

GENCONFIG_TOOL = src/build/tools/hbGenConfig

# At end of rule, create HB_FSP_RELEASE file if compiling with fsprelease.config
# or create HB_P10_RELEASE if compiling with anything else
$(GENDIR)/.$(notdir $(CONFIG_FILE)).config: \
    $(shell find -name HBconfig) \
    $(filter-out $(GENDIR)/.$(notdir $(CONFIG_FILE)).config,\
	    $(wildcard $(GENDIR)/.*.config)) \
    $(GENCONFIG_TOOL) \
    $(filter-out default,$(CONFIG_FILE))
	@mkdir -p $(GENDIR)
	$(C2) "    GENCONFIG"
	$(C1)$(GENCONFIG_TOOL) $(CONFIG_FILE) \
	    $(filter-out $(GENCONFIG_TOOL) $(CONFIG_FILE) \
			 $(wildcard $(GENDIR)/.*.config),$^)
	@rm -f $(wildcard $(GENDIR)/.*.config)
	@touch $@
	@rm -f $(HB_FSP_RELEASE)
	@rm -f $(HB_P10_RELEASE)
    ifneq (,$(findstring fsprelease.config, $(strip $(CONFIG_FILE))))
	@touch $(HB_FSP_RELEASE)
    else  # Use the standalone setup for anything else
	@touch $(HB_P10_RELEASE)
    endif