GNUmakefile

###############################################################################
# Copyright (c) 2015, 2020 IBM Corp. and others
#
# This program and the accompanying materials are made available under
# the terms of the Eclipse Public License 2.0 which accompanies this
# distribution and is available at https://www.eclipse.org/legal/epl-2.0/
# or the Apache License, Version 2.0 which accompanies this distribution and
# is available at https://www.apache.org/licenses/LICENSE-2.0.
#
# This Source Code may also be made available under the following
# Secondary Licenses when the conditions for such availability set
# forth in the Eclipse Public License, v. 2.0 are satisfied: GNU
# General Public License, version 2 with the GNU Classpath
# Exception [1] and GNU General Public License, version 2 with the
# OpenJDK Assembly Exception [2].
#
# [1] https://www.gnu.org/software/classpath/license.html
# [2] http://openjdk.java.net/legal/assembly-exception.html
#
# SPDX-License-Identifier: EPL-2.0 OR Apache-2.0 OR GPL-2.0 WITH Classpath-exception-2.0 OR LicenseRef-GPL-2.0 WITH Assembly-exception
###############################################################################

top_srcdir := .

include $(top_srcdir)/omrmakefiles/configure.mk

###
### Global targets
###

all : postbuild
.DEFAULT : all
clean :
.PHONY : all clean help

help :
	@echo "help   Display this help message."
	@echo "all    Build OMR."
	@echo "clean  Clean OMR build artifacts."
	@echo "test   Run functional verification tests."
	@echo "lint   Run the OMR linter."

# recursively find files in directory $1 matching the pattern $2
FindAllFiles = \
	$(wildcard $1/$2) \
	$(foreach i,$(wildcard $1/*),$(call FindAllFiles,$i,$2))

###
### Tracegen
###
ifeq (yes,$(ENABLE_TRACEGEN))

TRACEGEN_DEFINITION_TDF_FILES := $(patsubst ./%,%,$(call FindAllFiles,$(top_srcdir),*.tdf))

tracegen.sentinel : $(TRACEGEN_DEFINITION_TDF_FILES)
	cd $(exe_output_dir) && ./tracegen -treatWarningAsError -generatecfiles -threshold 1 -root $(top_srcdir)
	touch $@

# re-run tracegen if the executable has changed
tracegen.sentinel : $(exe_output_dir)/tracegen$(EXEEXT)

TRACEGEN_COMMAND := $(MAKE) -f GNUmakefile tracegen.sentinel

tracemerge.sentinel : tracegen.sentinel
	cd $(exe_output_dir) && ./tracemerge -majorversion 5 -minorversion 1 -root $(top_srcdir)
	touch $@

# re-run tracemerge if the executable has changed
tracemerge.sentinel : $(exe_output_dir)/tracemerge$(EXEEXT)

TRACEMERGE_COMMAND := $(MAKE) -f GNUmakefile tracemerge.sentinel

else # ENABLE_TRACEGEN

TRACEGEN_COMMAND :=
TRACEMERGE_COMMAND :=

endif # ENABLE_TRACEGEN

# ASCII To EBCDIC Targets
ifeq (zos,$(OMR_HOST_OS))
tool_targets += util/a2e
endif

tool_targets += tools/hookgen

# convert Cygwin path to Windows path with regular slashes
ifneq (,$(findstring CYGWIN,$(shell uname -s)))
convertPath = $(shell cygpath -m $1)
else
convertPath = $1
endif

HOOK_DEFINITION_FILES = $(call convertPath,$(abspath ./gc/base/omrmmprivate.hdf ./gc/include/omrmm.hdf ./fvtest/algotest/hooksample.hdf))
HOOK_DEFINITION_SENTINELS = $(patsubst %.hdf,%.sentinel, $(HOOK_DEFINITION_FILES))

# Trace Build Tools
ifeq (yes,$(ENABLE_TRACEGEN))
tool_targets += tools/tracegen
tool_targets += tools/tracemerge
endif

# FVTest Helper Libraries
test_prereqs := third_party/pugixml-1.5 fvtest/util fvtest/omrGtestGlue
test_targets += $(test_prereqs)

# Utility Libraries
main_targets += util/omrutil util/pool util/avl util/hashtable util/hookable
test_targets += \
  fvtest/algotest \
  fvtest/utiltest

# Thread Targets
ifeq (1,$(OMR_THREAD))
main_targets += thread
test_targets += fvtest/threadtest
test_targets += fvtest/threadextendedtest
endif

# OMR GLue Target
main_targets += omr_glue_static_lib

# Garbage Collection Targets
ifeq (1,$(OMR_GC))
main_targets += \
  gc/base \
  gc/base/standard \
  gc/startup \
  gc/stats \
  gc/structs \
  gc/verbose \
  gc/verbose/handler_standard
test_targets += fvtest/gctest
test_targets += perftest/gctest
endif

# Omrsig Targets
ifeq (1,$(OMR_OMRSIG))
main_targets += omrsigcompat
test_targets += fvtest/sigtest
endif

# Portlibrary Targets
ifeq (1,$(OMR_PORT))
main_targets += port
test_targets += fvtest/porttest
test_targets += fvtest/porttest/sltestlib
ifeq (aix,$(OMR_HOST_OS))
test_targets += fvtest/porttest/aixbaddep
endif
endif

ifeq (1, $(OMR_RAS_TDF_TRACE))
# RAS Libraries
main_targets += omrtrace
# RAS Tests
test_targets += fvtest/rastest
endif

# OMR Startup
main_targets += omr omr/startup

# OMR Example Targets
ifeq (1,$(OMR_EXAMPLE))
test_targets += example
main_targets += omrtrace
endif

# VM Tests
test_targets += fvtest/vmtest

# List of targets that are needed for the test compiler and jitbuilder
compiler_prereqs = port thread util/pool util/omrutil util/avl util/hashtable util/hookable

# Test Compiler
ifeq (1,$(OMR_TEST_COMPILER))
  main_targets += fvtest/compilertest
endif

# JitBuilder
ifeq (1,$(OMR_JITBUILDER))
  main_targets += jitbuilder
  test_targets += fvtest/jitbuildertest jitbuilder/release/cpp
endif

ifeq (yes,$(ENABLE_DDR))
  postbuild_targets += ddr
  ddr : staticlib
ifeq (zos,$(OMR_HOST_OS))
  ddr : util/a2e
endif
endif

DO_TEST_TARGET := yes
# ENABLE_FVTEST_AGENT forces rastest to build, even if fvtests are disabled.
ifeq (no,$(ENABLE_FVTEST))
DO_TEST_TARGET := no
ifeq (yes,$(ENABLE_FVTEST_AGENT))
DO_TEST_TARGET := yes
test_targets := $(test_prereqs)
main_targets += omrtrace
test_targets += fvtest/rastest fvtest/util
endif
endif
postbuild_targets += tests

# Remove duplicates
main_targets := $(sort $(main_targets))
test_targets := $(sort $(test_targets))

targets += $(tool_targets) $(main_targets) omr_static_lib $(test_targets) ddr
targets_clean := $(addsuffix _clean,$(targets))
targets_ddrgen := $(addsuffix _ddrgen,$(filter-out omr_static_lib jitbuilder/% fvtest/% perftest/% third_party/% tools/% ddr ddr/% example/%,$(targets)))

###
### Rules
###

postbuild : $(postbuild_targets)
	$(TRACEMERGE_COMMAND)

tests : staticlib
ifeq (yes,$(DO_TEST_TARGET))
	@$(MAKE) -f GNUmakefile $(test_targets)
endif

staticlib : mainbuild
	@$(MAKE) -f GNUmakefile omr_static_lib

mainbuild : prebuild
	@$(MAKE) -f GNUmakefile $(main_targets)

prebuild : tools
	@$(MAKE) -f GNUmakefile hook_definition_sentinel_all
	$(TRACEGEN_COMMAND)

tools :
	@$(MAKE) -f GNUmakefile $(tool_targets)

.PHONY : hook_definition_sentinel_all tools prebuild mainbuild staticlib tests postbuild

###
### Inter-target Dependencies
###

# If a prereq directory is not also defined in $(targets),
# then we won't execute 'make' in the prereq directory.

ifeq (zos,$(OMR_HOST_OS))
tools/hookgen : util/a2e
tools/tracegen : util/a2e
tools/tracemerge : util/a2e
endif

hook_definition_sentinel_all : $(HOOK_DEFINITION_SENTINELS)

# re-run hookgen if the executable has changed
$(HOOK_DEFINITION_SENTINELS) : $(exe_output_dir)/hookgen$(EXEEXT)

%.sentinel : %.hdf
	cd $(exe_output_dir) && ./hookgen $<
	touch $@

hook_definition_sentinel_clean :
	rm -f $(HOOK_DEFINITION_SENTINELS)

omrsigcompat : util/omrutil

example : $(test_prereqs)

fvtest/algotest : $(test_prereqs)
fvtest/gctest : $(test_prereqs)
fvtest/jitbuildertest : $(test_prereqs)
fvtest/porttest : $(test_prereqs)
fvtest/rastest : $(test_prereqs)
fvtest/sigtest : $(test_prereqs)
fvtest/threadextendedtest : $(test_prereqs)
fvtest/threadtest : $(test_prereqs)
fvtest/utiltest : $(test_prereqs)
fvtest/vmtest : $(test_prereqs)

perftest/gctest : $(test_prereqs)

# Test Compiler dependencies
ifeq (1,$(OMR_TEST_COMPILER))
  fvtest/compilertest : $(compiler_prereqs)
endif

# JitBuilder dependencies
ifeq (1,$(OMR_JITBUILDER))
  fvtest/jitbuildertest : $(compiler_prereqs)
  jitbuilder : $(compiler_prereqs)
  jitbuilder/release/cpp : $(compiler_prereqs)
endif

###
### Targets
###

# Because we haven't expressed dependencies of these targets clearly, we can't
# allow make to build them in parallel (at least at this level). Otherwise,
# things like util/a2e (a prerequisite of several targets) get built twice.
# Often we get lucky and both branches leave things in a reasonable state for
# dependents, but not always.
.NOTPARALLEL :

$(targets) :
	$(MAKE) -C $@ all

.PHONY : $(targets)

% :
	@echo Error, No rule to build target $@
	@exit -1

clean : $(targets_clean) hook_definition_sentinel_clean
$(targets_clean) :
	$(MAKE) -C $(patsubst %_clean,%,$@) clean
.PHONY : $(targets_clean)

lint :
	$(MAKE) -C fvtest/compilertest -f linter.mk
.PHONY : lint

test :
ifeq (yes,$(ENABLE_FVTEST))
	$(MAKE) -f fvtest/omrtest.mk test
else
	@echo Functional verification tests are disabled.
	@echo Enable by configuring with --enable-fvtest
endif
.PHONY : test

# preprocess ddrgen-annotated source code

ddrgen :
	$(MAKE) -f GNUmakefile $(targets_ddrgen)

$(targets_ddrgen) :
	$(MAKE) -C $(patsubst %_ddrgen,%,$@) ddrgen

.PHONY : ddrgen $(targets_ddrgen)

# Rerunning configure

configure.mk : config.status configure.mk.in
	config.status

config.status : $(top_srcdir)/configure
	$(top_srcdir)/configure -C

$(top_srcdir)/configure : $(top_srcdir)/configure.ac
	cd $(top_srcdir) && autoconf