#

# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved.

# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

#

# This code is free software; you can redistribute it and/or modify it

# under the terms of the GNU General Public License version 2 only, as

# published by the Free Software Foundation.  Oracle designates this

# particular file as subject to the "Classpath" exception as provided

# by Oracle in the LICENSE file that accompanied this code.

#

# This code is distributed in the hope that it will be useful, but WITHOUT

# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

# version 2 for more details (a copy is included in the LICENSE file that

# accompanied this code).

#

# You should have received a copy of the GNU General Public License version

# 2 along with this work; if not, write to the Free Software Foundation,

# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

#

# Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

# or visit www.oracle.com if you need additional information or have any

# questions.

#

default: all

include $(SPEC)

include MakeBase.gmk

include FindTests.gmk

# We will always run multiple tests serially

.NOTPARALLEL:

################################################################################

# Parse global control variables

################################################################################

ifneq ($(TEST_VM_OPTS), )

  ifneq ($(TEST_OPTS), )

    TEST_OPTS := $(TEST_OPTS);VM_OPTIONS=$(TEST_VM_OPTS)

  else

    TEST_OPTS := VM_OPTIONS=$(TEST_VM_OPTS)

  endif

endif

$(eval $(call ParseKeywordVariable, TEST_OPTS, \

    SINGLE_KEYWORDS := JOBS TIMEOUT_FACTOR JCOV, \

    STRING_KEYWORDS := VM_OPTIONS JAVA_OPTIONS AOT_MODULES, \

))

# Helper function to propagate TEST_OPTS values.

#

# Note: No spaces are allowed around the arguments.

# Arg $1 The variable in TEST_OPTS to propagate

# Arg $2 The control variable to propagate it to

define SetTestOpt

  ifneq ($$(TEST_OPTS_$1), )

    $2_$1 := $$(TEST_OPTS_$1)

  endif

endef

# Setup _NT_SYMBOL_PATH on Windows

ifeq ($(call isTargetOs, windows), true)

  ifndef _NT_SYMBOL_PATH

    # Can't use PathList here as it adds quotes around the value.

    _NT_SYMBOL_PATH := \

        $(subst $(SPACE),;,$(strip \

            $(foreach p, $(sort $(dir $(wildcard \

                $(addprefix $(SYMBOLS_IMAGE_DIR)/bin/, *.pdb */*.pdb)))), \

              $(call FixPath, $p) \

            ) \

        ))

    export _NT_SYMBOL_PATH

    $(call LogDebug, Rewriting _NT_SYMBOL_PATH to $(_NT_SYMBOL_PATH))

  endif

endif

################################################################################

# Hook to include the corresponding custom file, if present.

$(eval $(call IncludeCustomExtension, RunTests.gmk))

################################################################################

# This is the JDK that we will test

JDK_UNDER_TEST := $(JDK_IMAGE_DIR)

TEST_RESULTS_DIR := $(OUTPUTDIR)/test-results

TEST_SUPPORT_DIR := $(OUTPUTDIR)/test-support

TEST_SUMMARY := $(TEST_RESULTS_DIR)/test-summary.txt

TEST_LAST_IDS := $(TEST_SUPPORT_DIR)/test-last-ids.txt

ifeq ($(CUSTOM_ROOT), )

  JTREG_TOPDIR := $(TOPDIR)

else

  JTREG_TOPDIR := $(CUSTOM_ROOT)

endif

JTREG_FAILURE_HANDLER_DIR := $(TEST_IMAGE_DIR)/failure_handler

JTREG_FAILURE_HANDLER := $(JTREG_FAILURE_HANDLER_DIR)/jtregFailureHandler.jar

ifneq ($(wildcard $(JTREG_FAILURE_HANDLER)), )

  JTREG_FAILURE_HANDLER_OPTIONS := \

      -timeoutHandlerDir:$(JTREG_FAILURE_HANDLER) \

      -observerDir:$(JTREG_FAILURE_HANDLER) \

      -timeoutHandler:jdk.test.failurehandler.jtreg.GatherProcessInfoTimeoutHandler \

      -observer:jdk.test.failurehandler.jtreg.GatherDiagnosticInfoObserver \

      -timeoutHandlerTimeout:0

endif

GTEST_LAUNCHER_DIRS := $(patsubst %/gtestLauncher, %, \

    $(wildcard $(TEST_IMAGE_DIR)/hotspot/gtest/*/gtestLauncher))

GTEST_VARIANTS := $(strip $(patsubst $(TEST_IMAGE_DIR)/hotspot/gtest/%, %, \

    $(GTEST_LAUNCHER_DIRS)))

COV_ENVIRONMENT :=

JTREG_COV_OPTIONS :=

ifeq ($(TEST_OPTS_JCOV), true)

  JCOV_OUTPUT_DIR := $(TEST_RESULTS_DIR)/jcov-output

  JCOV_GRABBER_LOG := $(JCOV_OUTPUT_DIR)/grabber.log

  JCOV_RESULT_FILE := $(JCOV_OUTPUT_DIR)/result.xml

  JCOV_REPORT := $(JCOV_OUTPUT_DIR)/report

  JCOV_MEM_OPTIONS := -Xms64m -Xmx4g

  # Replace our normal test JDK with the JCov image.

  JDK_UNDER_TEST := $(JCOV_IMAGE_DIR)

  COV_ENVIRONMENT += JAVA_TOOL_OPTIONS="$(JCOV_MEM_OPTIONS)" \

      _JAVA_OPTIONS="$(JCOV_MEM_OPTIONS)"

  JTREG_COV_OPTIONS += -e:JAVA_TOOL_OPTIONS='$(JCOV_MEM_OPTIONS)' \

      -e:_JAVA_OPTIONS='$(JCOV_MEM_OPTIONS)'

endif

ifeq ($(GCOV_ENABLED), true)

  GCOV_OUTPUT_DIR := $(TEST_RESULTS_DIR)/gcov-output

  COV_ENVIRONMENT += GCOV_PREFIX="$(GCOV_OUTPUT_DIR)"

  JTREG_COV_OPTIONS += -e:GCOV_PREFIX="$(GCOV_OUTPUT_DIR)"

endif

################################################################################

# Optionally create AOT libraries for specified modules before running tests.

# Note, this could not be done during JDK build time.

################################################################################

# Note, this could not be done during JDK build time.

# Parameter 1 is the name of the rule.

#

# Remaining parameters are named arguments.

#   MODULE      The module to generate a library for

#   BIN         Output directory in which to put the library

#   VM_OPTIONS  List of JVM arguments to use when creating library

#   OPTIONS_VAR Name of variable to put AOT java options in

#   PREREQS_VAR Name of variable to put all AOT prerequisite rule targets in

#               for test rules to depend on

#

SetupAotModule = $(NamedParamsMacroTemplate)

define SetupAotModuleBody

  $1_AOT_LIB := $$($1_BIN)/$$(call SHARED_LIBRARY,$$($1_MODULE))

  $1_AOT_CCLIST := $$(wildcard $$(TOPDIR)/test/hotspot/jtreg/compiler/aot/scripts/$$($1_MODULE)-list.txt)

  # Create jaotc flags.

  # VM flags which don't affect AOT code generation are filtered out:

  # -Xcomp, -XX:+-TieredCompilation

  $1_JAOTC_OPTS := \

      -J-Xmx4g --info \

      $$(addprefix -J, $$(filter-out -Xcomp %TieredCompilation, $$($1_VM_OPTIONS))) \

      $$(addprefix --compile-commands$(SPACE), $$($1_AOT_CCLIST)) \

      --linker-path $$(LD_JAOTC) \

      #

  ifneq ($$(filter -ea, $$($1_VM_OPTIONS)), )

    $1_JAOTC_OPTS += --compile-with-assertions

  endif

  $$($1_AOT_LIB): $$(JDK_UNDER_TEST)/release \

      $$(call DependOnVariable, $1_JAOTC_OPTS) \

      $$(call DependOnVariable, JDK_UNDER_TEST)

	$$(call LogWarn, Generating $$(patsubst $$(OUTPUTDIR)/%, %, $$@))

	$$(call MakeTargetDir)

	$$(call ExecuteWithLog, $$@, \

	    $((COV_ENVIRONMENT) \

	    $$(FIXPATH) $$(JDK_UNDER_TEST)/bin/jaotc \

	        $$($1_JAOTC_OPTS) --output $$@ --module $$($1_MODULE) \

	)

	$$(call ExecuteWithLog, $$@.check, \

	    $$(FIXPATH) $$(JDK_UNDER_TEST)/bin/java \

	        $$($1_VM_OPTIONS) -XX:+UnlockDiagnosticVMOptions -XX:+UnlockExperimentalVMOptions \

	        -XX:+PrintAOT -XX:+UseAOTStrictLoading \

	        -XX:AOTLibrary=$$@ -version \

	         > $$@.verify-aot \

	)

  $1_AOT_OPTIONS += -XX:+UnlockExperimentalVMOptions

  $1_AOT_OPTIONS += -XX:AOTLibrary=$$($1_AOT_LIB)

  $1_AOT_TARGETS += $$($1_AOT_LIB)

endef

# Parameter 1 is the name of the rule.

#

# Remaining parameters are named arguments.

#   MODULES     The modules to generate a library for

#   VM_OPTIONS  List of JVM arguments to use when creating libraries

#

# After calling this, the following variables are defined

#   $1_AOT_OPTIONS List of all java options needed to use the AOT libraries

#   $1_AOT_TARGETS List of all targets that the test rule will need to depend on

#

SetupAot = $(NamedParamsMacroTemplate)

define SetupAotBody

  $$(info Running with AOTd libraries for $$($1_MODULES))

  # Put aot libraries in a separate directory so they are not deleted between

  # test runs and may be reused between make invocations.

  $$(foreach m, $$($1_MODULES), \

    $$(eval $$(call SetupAotModule, $1_$$m, \

        MODULE := $$m, \

        BIN := $$(TEST_SUPPORT_DIR)/aot/$1, \

        VM_OPTIONS := $$($1_VM_OPTIONS), \

    )) \

    $$(eval $1_AOT_OPTIONS += $$($1_$$m_AOT_OPTIONS)) \

    $$(eval $1_AOT_TARGETS += $$($1_$$m_AOT_TARGETS)) \

  )

endef

################################################################################

# Setup global test running parameters

################################################################################

# Each factor variable comes in 3 variants. The first one is reserved for users

# to use on command line. The other two are for predifined configurations in JDL

# and for machine specific configurations respectively.

TEST_JOBS_FACTOR ?= 1

TEST_JOBS_FACTOR_JDL ?= 1

TEST_JOBS_FACTOR_MACHINE ?= 1

ifeq ($(TEST_JOBS), 0)

  CORES_DIVIDER := 2

  ifeq ($(call isTargetCpuArch, sparc), true)

    # For smaller SPARC machines we see reasonable scaling of throughput up to

    # cpus/4 without affecting test reliability. On the bigger machines, cpus/4

    # causes intermittent timeouts.

    ifeq ($(shell $(EXPR) $(NUM_CORES) \> 16), 1)

      CORES_DIVIDER := 5

    else

      CORES_DIVIDER := 4

    endif

  endif

  MEMORY_DIVIDER := 2048

  TEST_JOBS := $(shell $(AWK) \

    'BEGIN { \

      c = $(NUM_CORES) / $(CORES_DIVIDER); \

      m = $(MEMORY_SIZE) / $(MEMORY_DIVIDER); \

      if (c > m) c = m; \

      c = c * $(TEST_JOBS_FACTOR); \

      c = c * $(TEST_JOBS_FACTOR_JDL); \

      c = c * $(TEST_JOBS_FACTOR_MACHINE); \

      if (c < 1) c = 1; \

      printf "%.0f", c; \

    }')

endif

################################################################################

# Parse control variables

################################################################################

ifneq ($(TEST_OPTS), )

  # Inform the user

  $(info Running tests using TEST_OPTS control variable '$(TEST_OPTS)')

endif

### Jtreg

$(eval $(call SetTestOpt,VM_OPTIONS,JTREG))

$(eval $(call SetTestOpt,JAVA_OPTIONS,JTREG))

$(eval $(call SetTestOpt,AOT_MODULES,JTREG))

$(eval $(call SetTestOpt,JOBS,JTREG))

$(eval $(call SetTestOpt,TIMEOUT_FACTOR,JTREG))

$(eval $(call ParseKeywordVariable, JTREG, \

    SINGLE_KEYWORDS := JOBS TIMEOUT_FACTOR TEST_MODE ASSERT VERBOSE RETAIN \

        MAX_MEM RUN_PROBLEM_LISTS, \

    STRING_KEYWORDS := OPTIONS JAVA_OPTIONS VM_OPTIONS KEYWORDS \

        EXTRA_PROBLEM_LISTS AOT_MODULES, \

))

ifneq ($(JTREG), )

  # Inform the user

  $(info Running tests using JTREG control variable '$(JTREG)')

endif

### Gtest

$(eval $(call SetTestOpt,VM_OPTIONS,GTEST))

$(eval $(call SetTestOpt,JAVA_OPTIONS,GTEST))

$(eval $(call SetTestOpt,AOT_MODULES,GTEST))

$(eval $(call ParseKeywordVariable, GTEST, \

    SINGLE_KEYWORDS := REPEAT, \

    STRING_KEYWORDS := OPTIONS VM_OPTIONS JAVA_OPTIONS AOT_MODULES, \

))

ifneq ($(GTEST), )

  # Inform the user

  $(info Running tests using GTEST control variable '$(GTEST)')

endif

### Microbenchmarks

$(eval $(call SetTestOpt,VM_OPTIONS,MICRO))

$(eval $(call SetTestOpt,JAVA_OPTIONS,MICRO))

$(eval $(call ParseKeywordVariable, MICRO, \

    SINGLE_KEYWORDS := ITER FORK TIME WARMUP_ITER WARMUP_TIME, \

    STRING_KEYWORDS := OPTIONS JAVA_OPTIONS VM_OPTIONS RESULTS_FORMAT TEST_JDK \

        BENCHMARKS_JAR, \

))

ifneq ($(MICRO), )

  # Inform the user

  $(info Running tests using MICRO control variable '$(MICRO)')

endif

################################################################################

# Component-specific Jtreg settings

################################################################################

hotspot_JTREG_MAX_MEM := 0

hotspot_JTREG_ASSERT := false

hotspot_JTREG_NATIVEPATH := $(TEST_IMAGE_DIR)/hotspot/jtreg/native

jdk_JTREG_NATIVEPATH := $(TEST_IMAGE_DIR)/jdk/jtreg/native

jdk_JTREG_PROBLEM_LIST += $(TOPDIR)/test/jdk/ProblemList.txt

jaxp_JTREG_PROBLEM_LIST += $(TOPDIR)/test/jaxp/ProblemList.txt

langtools_JTREG_PROBLEM_LIST += $(TOPDIR)/test/langtools/ProblemList.txt

nashorn_JTREG_PROBLEM_LIST += $(TOPDIR)/test/nashorn/ProblemList.txt

hotspot_JTREG_PROBLEM_LIST += $(TOPDIR)/test/hotspot/jtreg/ProblemList.txt

langtools_JTREG_MAX_MEM := 768m

################################################################################

# Parse test selection

#

# The user has given a test selection in the TEST variable. We must parse it

# and determine what that means in terms of actual calls to the test framework.

#

# The parse functions take as argument a test specification as given by the

# user, and returns a fully qualified test descriptor if it was a match, or

# nothing if not. A single test specification can result in multiple test

# descriptors being returned. A valid test descriptor must always be accepted

# and returned identically.

################################################################################

# Helper function to determine if a test specification is a Gtest test

#

# It is a Gtest test if it is either "gtest", or "gtest:" followed by an optional

# test filter string, and an optional "/<variant>" to select a specific JVM

# variant. If no variant is specified, all found variants are tested.

define ParseGtestTestSelection

  $(if $(filter gtest%, $1), \

    $(if $(filter gtest, $1), \

      $(addprefix gtest:all/, $(GTEST_VARIANTS)) \

    , \

      $(if $(strip $(or $(filter gtest/%, $1) $(filter gtest:/%, $1))), \

        $(patsubst gtest:/%, gtest:all/%, $(patsubst gtest/%, gtest:/%, $1)) \

      , \

        $(if $(filter gtest:%, $1), \

          $(if $(findstring /, $1), \

            $1 \

          , \

            $(addprefix $1/, $(GTEST_VARIANTS)) \

          ) \

        ) \

      ) \

    ) \

  )

endef

# Helper function to determine if a test specification is a microbenchmark test

#

# It is a microbenchmark test if it is either "micro", or "micro:" followed by

# an optional test filter string.

define ParseMicroTestSelection

  $(if $(filter micro%, $1), \

    $(if $(filter micro, $1), \

      micro:all \

    , \

      $(if $(filter micro:, $1), \

        micro:all \

      , \

        $1 \

      ) \

    ) \

  )

endef

# Helper function that removes the TOPDIR part

CleanupJtregPath = \

  $(strip $(patsubst %/, %, $(subst $(JTREG_TOPDIR)/,, $1)))

# Take a partial Jtreg root path and return a full, absolute path to that Jtreg

# root. Also support having "hotspot" as an alias for "hotspot/jtreg".

ExpandJtregRoot = \

  $(call CleanupJtregPath, $(wildcard \

    $(if $(filter /%, $1), \

      $(if $(wildcard $(strip $1)/TEST.ROOT), \

        $1 \

      ) \

    , \

      $(filter $(addprefix %, $1), $(JTREG_TESTROOTS) $(addsuffix /, $(JTREG_TESTROOTS))) \

      $(filter $(addprefix %, $(strip $1)/jtreg), $(JTREG_TESTROOTS) $(addsuffix /, $(JTREG_TESTROOTS))) \

    ) \

  ))

# Take a partial Jtreg test path and return a full, absolute path to that Jtreg

# test. Also support having "hotspot" as an alias for "hotspot/jtreg".

ExpandJtregPath = \

  $(if $(call ExpandJtregRoot, $1), \

    $(call ExpandJtregRoot, $1) \

  , \

    $(call CleanupJtregPath, $(wildcard \

      $(if $(filter /%, $1), \

        $1 \

      , \

        $(addsuffix /$(strip $1), $(JTREG_TESTROOTS) $(TEST_BASEDIRS)) \

        $(addsuffix $(strip $(patsubst hotspot/%, /hotspot/jtreg/%, $1)), $(JTREG_TESTROOTS) $(TEST_BASEDIRS)) \

      ) \

    )) \

  )

# Helper function to determine if a test specification is a Jtreg test

#

# It is a Jtreg test if it optionally begins with jtreg:, and then is either

# an unspecified group name (possibly prefixed by :), or a group in a

# specified test root, or a path to a test or test directory,

# either absolute or relative to any of the TEST_BASEDIRS or test roots.

define ParseJtregTestSelection

  $(eval TEST_NAME := $(strip $(patsubst jtreg:%, %, $1))) \

  $(if $(or $(findstring :, $(TEST_NAME)), $(findstring /, $(TEST_NAME))), , \

    $(eval TEST_NAME := :$(TEST_NAME)) \

  ) \

  $(if $(findstring :, $(TEST_NAME)), \

    $(if $(filter :%, $(TEST_NAME)), \

      $(eval TEST_GROUP := $(patsubst :%, %, $(TEST_NAME))) \

      $(eval TEST_ROOTS := $(foreach test_root, $(JTREG_TESTROOTS), \

          $(call CleanupJtregPath, $(test_root)))) \

    , \

      $(eval TEST_PATH := $(word 1, $(subst :, $(SPACE), $(TEST_NAME)))) \

      $(eval TEST_GROUP := $(word 2, $(subst :, $(SPACE), $(TEST_NAME)))) \

      $(eval TEST_ROOTS := $(call ExpandJtregRoot, $(TEST_PATH))) \

    ) \

    $(foreach test_root, $(TEST_ROOTS), \

      $(if $(filter /%, $(test_root)), \

        jtreg:$(test_root):$(TEST_GROUP) \

      , \

        $(if $(filter $(TEST_GROUP), $($(JTREG_TOPDIR)/$(test_root)_JTREG_TEST_GROUPS)), \

          jtreg:$(test_root):$(TEST_GROUP) \

        ) \

      ) \

    ) \

  , \

    $(eval TEST_PATHS := $(call ExpandJtregPath, $(TEST_NAME))) \

    $(foreach test_path, $(TEST_PATHS), \

      jtreg:$(test_path) \

    ) \

  )

endef

# Helper function to determine if a test specification is a special test

#

# It is a special test if it is "special:" followed by a test name,

# if it is "make:" or "make-" followed by a make test, or any of the special

# test names as a single word.

define ParseSpecialTestSelection

  $(if $(filter special:%, $1), \

    $1 \

  ) \

  $(if $(filter make%, $1), \

    $(if $(filter make:%, $1), \

      special:$(strip $1) \

    ) \

    $(if $(filter make-%, $1), \

      special:$(patsubst make-%,make:%, $1) \

    ) \

    $(if $(filter make, $1), \

      special:make:all \

    )

  ) \

  $(if $(filter failure-handler, $1), \

    special:$(strip $1) \

  )

endef