1 #
   2 # Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved.
   3 # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4 #
   5 # This code is free software; you can redistribute it and/or modify it
   6 # under the terms of the GNU General Public License version 2 only, as
   7 # published by the Free Software Foundation.  Oracle designates this
   8 # particular file as subject to the "Classpath" exception as provided
   9 # by Oracle in the LICENSE file that accompanied this code.
  10 #
  11 # This code is distributed in the hope that it will be useful, but WITHOUT
  12 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13 # FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14 # version 2 for more details (a copy is included in the LICENSE file that
  15 # accompanied this code).
  16 #
  17 # You should have received a copy of the GNU General Public License version
  18 # 2 along with this work; if not, write to the Free Software Foundation,
  19 # Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20 #
  21 # Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22 # or visit www.oracle.com if you need additional information or have any
  23 # questions.
  24 #
  25 
  26 default: all
  27 
  28 include $(SPEC)
  29 include MakeBase.gmk
  30 include FindTests.gmk
  31 
  32 # We will always run multiple tests serially
  33 .NOTPARALLEL:
  34 
  35 ################################################################################
  36 # Parse global control variables
  37 ################################################################################
  38 
  39 ifneq ($(TEST_VM_OPTS), )
  40   ifneq ($(TEST_OPTS), )
  41     TEST_OPTS := $(TEST_OPTS);VM_OPTIONS=$(TEST_VM_OPTS)
  42   else
  43     TEST_OPTS := VM_OPTIONS=$(TEST_VM_OPTS)
  44   endif
  45 endif
  46 
  47 $(eval $(call ParseKeywordVariable, TEST_OPTS, \
  48     SINGLE_KEYWORDS := JOBS TIMEOUT_FACTOR JCOV JCOV_DIFF_CHANGESET, \
  49     STRING_KEYWORDS := VM_OPTIONS JAVA_OPTIONS, \
  50 ))
  51 
  52 # Helper function to propagate TEST_OPTS values.
  53 #
  54 # Note: No spaces are allowed around the arguments.
  55 # Arg $1 The variable in TEST_OPTS to propagate
  56 # Arg $2 The control variable to propagate it to
  57 define SetTestOpt
  58   ifneq ($$(TEST_OPTS_$1), )
  59     $2_$1 := $$(TEST_OPTS_$1)
  60   endif
  61 endef
  62 
  63 # Setup _NT_SYMBOL_PATH on Windows, which points to our pdb files.
  64 ifeq ($(call isTargetOs, windows), true)
  65   ifndef _NT_SYMBOL_PATH
  66     SYMBOL_PATH := $(call PathList, $(sort $(patsubst %/, %, $(dir $(wildcard \
  67         $(addprefix $(SYMBOLS_IMAGE_DIR)/bin/, *.pdb */*.pdb))))))
  68     export _NT_SYMBOL_PATH := $(subst \\,\, $(call FixPath, \
  69         $(subst $(DQUOTE),, $(SYMBOL_PATH))))
  70     $(call LogDebug, Setting _NT_SYMBOL_PATH to $(_NT_SYMBOL_PATH))
  71   endif
  72 endif
  73 
  74 ################################################################################
  75 # Hook to include the corresponding custom file, if present.
  76 $(eval $(call IncludeCustomExtension, RunTests.gmk))
  77 ################################################################################
  78 
  79 # This is the JDK that we will test
  80 JDK_UNDER_TEST := $(JDK_IMAGE_DIR)
  81 
  82 TEST_RESULTS_DIR := $(OUTPUTDIR)/test-results
  83 TEST_SUPPORT_DIR := $(OUTPUTDIR)/test-support
  84 TEST_SUMMARY := $(TEST_RESULTS_DIR)/test-summary.txt
  85 TEST_LAST_IDS := $(TEST_SUPPORT_DIR)/test-last-ids.txt
  86 
  87 ifeq ($(CUSTOM_ROOT), )
  88   JTREG_TOPDIR := $(TOPDIR)
  89 else
  90   JTREG_TOPDIR := $(CUSTOM_ROOT)
  91 endif
  92 
  93 JTREG_FAILURE_HANDLER_DIR := $(TEST_IMAGE_DIR)/failure_handler
  94 JTREG_FAILURE_HANDLER := $(JTREG_FAILURE_HANDLER_DIR)/jtregFailureHandler.jar
  95 
  96 JTREG_FAILURE_HANDLER_TIMEOUT ?= 0
  97 
  98 ifneq ($(wildcard $(JTREG_FAILURE_HANDLER)), )
  99   JTREG_FAILURE_HANDLER_OPTIONS := \
 100       -timeoutHandlerDir:$(JTREG_FAILURE_HANDLER) \
 101       -observerDir:$(JTREG_FAILURE_HANDLER) \
 102       -timeoutHandler:jdk.test.failurehandler.jtreg.GatherProcessInfoTimeoutHandler \
 103       -observer:jdk.test.failurehandler.jtreg.GatherDiagnosticInfoObserver \
 104       -timeoutHandlerTimeout:$(JTREG_FAILURE_HANDLER_TIMEOUT)
 105 endif
 106 
 107 GTEST_LAUNCHER_DIRS := $(patsubst %/gtestLauncher, %, \
 108     $(wildcard $(TEST_IMAGE_DIR)/hotspot/gtest/*/gtestLauncher))
 109 GTEST_VARIANTS := $(strip $(patsubst $(TEST_IMAGE_DIR)/hotspot/gtest/%, %, \
 110     $(GTEST_LAUNCHER_DIRS)))
 111 
 112 COV_ENVIRONMENT :=
 113 JTREG_COV_OPTIONS :=
 114 
 115 ifeq ($(TEST_OPTS_JCOV), true)
 116   JCOV_OUTPUT_DIR := $(TEST_RESULTS_DIR)/jcov-output
 117   JCOV_GRABBER_LOG := $(JCOV_OUTPUT_DIR)/grabber.log
 118   JCOV_RESULT_FILE := $(JCOV_OUTPUT_DIR)/result.xml
 119   JCOV_REPORT := $(JCOV_OUTPUT_DIR)/report
 120   JCOV_MEM_OPTIONS := -Xms64m -Xmx4g
 121 
 122   # Replace our normal test JDK with the JCov image.
 123   JDK_UNDER_TEST := $(JCOV_IMAGE_DIR)
 124 
 125   COV_ENVIRONMENT += JAVA_TOOL_OPTIONS="$(JCOV_MEM_OPTIONS)" \
 126       _JAVA_OPTIONS="$(JCOV_MEM_OPTIONS)"
 127   JTREG_COV_OPTIONS += -e:JAVA_TOOL_OPTIONS='$(JCOV_MEM_OPTIONS)' \
 128       -e:_JAVA_OPTIONS='$(JCOV_MEM_OPTIONS)'
 129 endif
 130 
 131 ifeq ($(GCOV_ENABLED), true)
 132   GCOV_OUTPUT_DIR := $(TEST_RESULTS_DIR)/gcov-output
 133   COV_ENVIRONMENT += GCOV_PREFIX="$(GCOV_OUTPUT_DIR)"
 134   JTREG_COV_OPTIONS += -e:GCOV_PREFIX="$(GCOV_OUTPUT_DIR)"
 135 endif
 136 
 137 ################################################################################
 138 # Setup global test running parameters
 139 ################################################################################
 140 
 141 # Each factor variable comes in 3 variants. The first one is reserved for users
 142 # to use on command line. The other two are for predifined configurations in JDL
 143 # and for machine specific configurations respectively.
 144 TEST_JOBS_FACTOR ?= 1
 145 TEST_JOBS_FACTOR_JDL ?= 1
 146 TEST_JOBS_FACTOR_MACHINE ?= 1
 147 
 148 ifeq ($(TEST_JOBS), 0)
 149   CORES_DIVIDER := 2
 150   # For some big multi-core machines with low ulimit -u setting we hit the max
 151   # threads/process limit. In such a setup the memory/cores-only-guided
 152   # TEST_JOBS config is insufficient. From experience a concurrency setting of
 153   # 14 works reasonably well for low ulimit values (<= 4096). Thus, use
 154   # divider 4096/14. For high ulimit -u values this shouldn't make a difference.
 155   ULIMIT_DIVIDER := (4096/14)
 156   PROC_ULIMIT := -1
 157   ifneq ($(OPENJDK_TARGET_OS), windows)
 158     PROC_ULIMIT := $(shell $(ULIMIT) -u)
 159     ifeq ($(PROC_ULIMIT), unlimited)
 160       PROC_ULIMIT := -1
 161     endif
 162   endif
 163   MEMORY_DIVIDER := 2048
 164   TEST_JOBS := $(shell $(AWK) \
 165     'BEGIN { \
 166       c = $(NUM_CORES) / $(CORES_DIVIDER); \
 167       m = $(MEMORY_SIZE) / $(MEMORY_DIVIDER); \
 168       u = $(PROC_ULIMIT); \
 169       if (u > -1) { \
 170         u = u / $(ULIMIT_DIVIDER); \
 171         if (u < c) c = u; \
 172       } \
 173       if (c > m) c = m; \
 174       c = c * $(TEST_JOBS_FACTOR); \
 175       c = c * $(TEST_JOBS_FACTOR_JDL); \
 176       c = c * $(TEST_JOBS_FACTOR_MACHINE); \
 177       if (c < 1) c = 1; \
 178       printf "%.0f", c; \
 179     }')
 180 endif
 181 
 182 ################################################################################
 183 # Parse control variables
 184 ################################################################################
 185 
 186 ifneq ($(TEST_OPTS), )
 187   # Inform the user
 188   $(info Running tests using TEST_OPTS control variable '$(TEST_OPTS)')
 189 endif
 190 
 191 ### Jtreg
 192 
 193 $(eval $(call SetTestOpt,VM_OPTIONS,JTREG))
 194 $(eval $(call SetTestOpt,JAVA_OPTIONS,JTREG))
 195 
 196 $(eval $(call SetTestOpt,JOBS,JTREG))
 197 $(eval $(call SetTestOpt,TIMEOUT_FACTOR,JTREG))
 198 $(eval $(call SetTestOpt,FAILURE_HANDLER_TIMEOUT,JTREG))
 199 
 200 $(eval $(call ParseKeywordVariable, JTREG, \
 201     SINGLE_KEYWORDS := JOBS TIMEOUT_FACTOR FAILURE_HANDLER_TIMEOUT \
 202         TEST_MODE ASSERT VERBOSE RETAIN MAX_MEM RUN_PROBLEM_LISTS \
 203         RETRY_COUNT REPEAT_COUNT MAX_OUTPUT, \
 204     STRING_KEYWORDS := OPTIONS JAVA_OPTIONS VM_OPTIONS KEYWORDS \
 205         EXTRA_PROBLEM_LISTS LAUNCHER_OPTIONS, \
 206 ))
 207 
 208 ifneq ($(JTREG), )
 209   # Inform the user
 210   $(info Running tests using JTREG control variable '$(JTREG)')
 211 endif
 212 
 213 ### Gtest
 214 
 215 $(eval $(call SetTestOpt,VM_OPTIONS,GTEST))
 216 $(eval $(call SetTestOpt,JAVA_OPTIONS,GTEST))
 217 
 218 $(eval $(call ParseKeywordVariable, GTEST, \
 219     SINGLE_KEYWORDS := REPEAT, \
 220     STRING_KEYWORDS := OPTIONS VM_OPTIONS JAVA_OPTIONS, \
 221 ))
 222 
 223 ifneq ($(GTEST), )
 224   # Inform the user
 225   $(info Running tests using GTEST control variable '$(GTEST)')
 226 endif
 227 
 228 ### Microbenchmarks
 229 
 230 $(eval $(call SetTestOpt,VM_OPTIONS,MICRO))
 231 $(eval $(call SetTestOpt,JAVA_OPTIONS,MICRO))
 232 
 233 $(eval $(call ParseKeywordVariable, MICRO, \
 234     SINGLE_KEYWORDS := ITER FORK TIME WARMUP_ITER WARMUP_TIME, \
 235     STRING_KEYWORDS := OPTIONS JAVA_OPTIONS VM_OPTIONS RESULTS_FORMAT TEST_JDK \
 236         BENCHMARKS_JAR, \
 237 ))
 238 
 239 ifneq ($(MICRO), )
 240   # Inform the user
 241   $(info Running tests using MICRO control variable '$(MICRO)')
 242 endif
 243 
 244 
 245 ################################################################################
 246 # Component-specific Jtreg settings
 247 ################################################################################
 248 
 249 hotspot_JTREG_MAX_MEM := 0
 250 hotspot_JTREG_ASSERT := false
 251 hotspot_JTREG_NATIVEPATH := $(TEST_IMAGE_DIR)/hotspot/jtreg/native
 252 jdk_JTREG_NATIVEPATH := $(TEST_IMAGE_DIR)/jdk/jtreg/native
 253 lib-test_JTREG_NATIVEPATH := $(TEST_IMAGE_DIR)/lib-test/jtreg/native
 254 
 255 jdk_JTREG_PROBLEM_LIST += $(TOPDIR)/test/jdk/ProblemList.txt
 256 jaxp_JTREG_PROBLEM_LIST += $(TOPDIR)/test/jaxp/ProblemList.txt
 257 langtools_JTREG_PROBLEM_LIST += $(TOPDIR)/test/langtools/ProblemList.txt
 258 hotspot_JTREG_PROBLEM_LIST += $(TOPDIR)/test/hotspot/jtreg/ProblemList.txt
 259 lib-test_JTREG_PROBLEM_LIST += $(TOPDIR)/test/lib-test/ProblemList.txt
 260 
 261 ################################################################################
 262 # Parse test selection
 263 #
 264 # The user has given a test selection in the TEST variable. We must parse it
 265 # and determine what that means in terms of actual calls to the test framework.
 266 #
 267 # The parse functions take as argument a test specification as given by the
 268 # user, and returns a fully qualified test descriptor if it was a match, or
 269 # nothing if not. A single test specification can result in multiple test
 270 # descriptors being returned. A valid test descriptor must always be accepted
 271 # and returned identically.
 272 ################################################################################
 273 
 274 # Helper function to determine if a test specification is a Gtest test
 275 #
 276 # It is a Gtest test if it is either "gtest", or "gtest:" followed by an optional
 277 # test filter string, and an optional "/<variant>" to select a specific JVM
 278 # variant. If no variant is specified, all found variants are tested.
 279 define ParseGtestTestSelection
 280   $(if $(filter gtest%, $1), \
 281     $(if $(filter gtest, $1), \
 282       $(addprefix gtest:all/, $(GTEST_VARIANTS)) \
 283     , \
 284       $(if $(strip $(or $(filter gtest/%, $1) $(filter gtest:/%, $1))), \
 285         $(patsubst gtest:/%, gtest:all/%, $(patsubst gtest/%, gtest:/%, $1)) \
 286       , \
 287         $(if $(filter gtest:%, $1), \
 288           $(if $(findstring /, $1), \
 289             $1 \
 290           , \
 291             $(addprefix $1/, $(GTEST_VARIANTS)) \
 292           ) \
 293         ) \
 294       ) \
 295     ) \
 296   )
 297 endef
 298 
 299 # Helper function to determine if a test specification is a microbenchmark test
 300 #
 301 # It is a microbenchmark test if it is either "micro", or "micro:" followed by
 302 # an optional test filter string.
 303 define ParseMicroTestSelection
 304   $(if $(filter micro%, $1), \
 305     $(if $(filter micro, $1), \
 306       micro:all \
 307     , \
 308       $(if $(filter micro:, $1), \
 309         micro:all \
 310       , \
 311         $1 \
 312       ) \
 313     ) \
 314   )
 315 endef
 316 
 317 # Helper function that removes the TOPDIR part
 318 CleanupJtregPath = \
 319   $(strip $(patsubst %/, %, $(subst $(JTREG_TOPDIR)/,, $1)))
 320 
 321 # Take a partial Jtreg root path and return a full, absolute path to that Jtreg
 322 # root. Also support having "hotspot" as an alias for "hotspot/jtreg".
 323 ExpandJtregRoot = \
 324   $(call CleanupJtregPath, $(wildcard \
 325     $(if $(filter /%, $1), \
 326       $(if $(wildcard $(strip $1)/TEST.ROOT), \
 327         $1 \
 328       ) \
 329     , \
 330       $(filter $(addprefix %, $1), $(JTREG_TESTROOTS) $(addsuffix /, $(JTREG_TESTROOTS))) \
 331       $(filter $(addprefix %, $(strip $1)/jtreg), $(JTREG_TESTROOTS) $(addsuffix /, $(JTREG_TESTROOTS))) \
 332     ) \
 333   ))
 334 
 335 # Take a partial Jtreg test path and return a full, absolute path to that Jtreg
 336 # test. Also support having "hotspot" as an alias for "hotspot/jtreg".
 337 ExpandJtregPath = \
 338   $(if $(call ExpandJtregRoot, $1), \
 339     $(call ExpandJtregRoot, $1) \
 340   , \
 341     $(call CleanupJtregPath, $(wildcard \
 342       $(if $(filter /%, $1), \
 343         $1 \
 344       , \
 345         $(addsuffix /$(strip $1), $(JTREG_TESTROOTS) $(TEST_BASEDIRS)) \
 346         $(addsuffix $(strip $(patsubst hotspot/%, /hotspot/jtreg/%, $1)), $(JTREG_TESTROOTS) $(TEST_BASEDIRS)) \
 347       ) \
 348     )) \
 349   )
 350 
 351 # Helper function to determine if a test specification is a Jtreg test
 352 #
 353 # It is a Jtreg test if it optionally begins with jtreg:, and then is either
 354 # an unspecified group name (possibly prefixed by :), or a group in a
 355 # specified test root, or a path to a test or test directory,
 356 # either absolute or relative to any of the TEST_BASEDIRS or test roots.
 357 define ParseJtregTestSelection
 358   $(eval TEST_NAME := $(strip $(patsubst jtreg:%, %, $1))) \
 359   $(if $(or $(findstring :, $(TEST_NAME)), $(findstring /, $(TEST_NAME))), , \
 360     $(eval TEST_NAME := :$(TEST_NAME)) \
 361   ) \
 362   $(if $(findstring :, $(TEST_NAME)), \
 363     $(if $(filter :%, $(TEST_NAME)), \
 364       $(eval TEST_GROUP := $(patsubst :%, %, $(TEST_NAME))) \
 365       $(eval TEST_ROOTS := $(foreach test_root, $(JTREG_TESTROOTS), \
 366           $(call CleanupJtregPath, $(test_root)))) \
 367     , \
 368       $(eval TEST_PATH := $(word 1, $(subst :, $(SPACE), $(TEST_NAME)))) \
 369       $(eval TEST_GROUP := $(word 2, $(subst :, $(SPACE), $(TEST_NAME)))) \
 370       $(eval TEST_ROOTS := $(call ExpandJtregRoot, $(TEST_PATH))) \
 371     ) \
 372     $(foreach test_root, $(TEST_ROOTS), \
 373       $(if $(filter /%, $(test_root)), \
 374         jtreg:$(test_root):$(TEST_GROUP) \
 375       , \
 376         $(if $(filter $(TEST_GROUP), $($(JTREG_TOPDIR)/$(test_root)_JTREG_TEST_GROUPS)), \
 377           jtreg:$(test_root):$(TEST_GROUP) \
 378         ) \
 379       ) \
 380     ) \
 381   , \
 382     $(eval TEST_PATHS := $(call ExpandJtregPath, $(TEST_NAME))) \
 383     $(foreach test_path, $(TEST_PATHS), \
 384       jtreg:$(test_path) \
 385     ) \
 386   )
 387 endef
 388 
 389 # Helper function to determine if a test specification is a special test
 390 #
 391 # It is a special test if it is "special:" followed by a test name,
 392 # if it is "make:" or "make-" followed by a make test, or any of the special
 393 # test names as a single word.
 394 define ParseSpecialTestSelection
 395   $(if $(filter special:%, $1), \
 396     $1 \
 397   ) \
 398   $(if $(filter make%, $1), \
 399     $(if $(filter make:%, $1), \
 400       special:$(strip $1) \
 401     ) \
 402     $(if $(filter make-%, $1), \
 403       special:$(patsubst make-%,make:%, $1) \
 404     ) \
 405     $(if $(filter make, $1), \
 406       special:make:all \
 407     )
 408   ) \
 409   $(if $(filter failure-handler, $1), \
 410     special:$(strip $1) \
 411   )
 412 endef
 413 
 414 ifeq ($(TEST), )
 415   $(info No test selection given in TEST!)
 416   $(info Please use e.g. 'make test TEST=tier1' or 'make test-tier1')
 417   $(info See doc/testing.[md|html] for help)
 418   $(error Cannot continue)
 419 endif
 420 
 421 # Now intelligently convert the test selection given by the user in TEST
 422 # into a list of fully qualified test descriptors of the tests to run.
 423 TESTS_TO_RUN :=
 424 $(foreach test, $(TEST), \
 425   $(eval PARSED_TESTS := $(call ParseCustomTestSelection, $(test))) \
 426   $(if $(strip $(PARSED_TESTS)), , \
 427     $(eval PARSED_TESTS += $(call ParseGtestTestSelection, $(test))) \
 428   ) \
 429   $(if $(strip $(PARSED_TESTS)), , \
 430     $(eval PARSED_TESTS += $(call ParseMicroTestSelection, $(test))) \
 431   ) \
 432   $(if $(strip $(PARSED_TESTS)), , \
 433     $(eval PARSED_TESTS += $(call ParseJtregTestSelection, $(test))) \
 434   ) \
 435   $(if $(strip $(PARSED_TESTS)), , \
 436     $(eval PARSED_TESTS += $(call ParseSpecialTestSelection, $(test))) \
 437   ) \
 438   $(if $(strip $(PARSED_TESTS)), , \
 439     $(eval UNKNOWN_TEST := $(test)) \
 440   ) \
 441   $(eval TESTS_TO_RUN += $(PARSED_TESTS)) \
 442 )
 443 
 444 ifneq ($(UNKNOWN_TEST), )
 445   $(info Unknown test selection: '$(UNKNOWN_TEST)')
 446   $(info See doc/testing.[md|html] for help)
 447   $(error Cannot continue)
 448 endif
 449 
 450 TESTS_TO_RUN := $(strip $(TESTS_TO_RUN))
 451 
 452 
 453 # Present the result of our parsing to the user
 454 $(info Test selection '$(TEST)', will run:)
 455 $(foreach test, $(TESTS_TO_RUN), $(info * $(test)))
 456 
 457 
 458 ################################################################################
 459 # Functions for setting up rules for running the selected tests
 460 #
 461 # The SetupRun*Test functions all have the same interface:
 462 #
 463 # Parameter 1 is the name of the rule. This is the test id, based on the test
 464 # descriptor, and this is also used as variable prefix, and the targets
 465 # generated are listed in a variable by that name.
 466 #
 467 # Remaining parameters are named arguments. Currently this is only:
 468 #   TEST -- The properly formatted fully qualified test descriptor
 469 #
 470 # After the rule named by the test id has been executed, the following
 471 # variables will be available:
 472 # testid_TOTAL - the total number of tests run
 473 # testid_PASSED - the number of successful tests
 474 # testid_FAILED - the number of failed tests
 475 # testid_ERROR - the number of tests was neither successful or failed
 476 #
 477 ################################################################################
 478 
 479 ### Rules for Gtest
 480 
 481 SetupRunGtestTest = $(NamedParamsMacroTemplate)
 482 define SetupRunGtestTestBody
 483   $1_TEST_RESULTS_DIR := $$(TEST_RESULTS_DIR)/$1
 484   $1_TEST_SUPPORT_DIR := $$(TEST_SUPPORT_DIR)/$1
 485   $1_EXITCODE := $$($1_TEST_RESULTS_DIR)/exitcode.txt
 486 
 487   $1_VARIANT :=  $$(lastword $$(subst /, , $$($1_TEST)))
 488   ifeq ($$(filter $$($1_VARIANT), $$(GTEST_VARIANTS)), )
 489     $$(error Invalid gtest variant '$$($1_VARIANT)'. Valid variants: $$(GTEST_VARIANTS))
 490   endif
 491   $1_TEST_NAME := $$(strip $$(patsubst %/$$($1_VARIANT), %, \
 492       $$(patsubst gtest:%, %, $$($1_TEST))))
 493   ifneq ($$($1_TEST_NAME), all)
 494     $1_GTEST_FILTER := --gtest_filter=$$($1_TEST_NAME)*
 495   endif
 496 
 497   ifneq ($$(GTEST_REPEAT), )
 498     $1_GTEST_REPEAT :=--gtest_repeat=$$(GTEST_REPEAT)
 499   endif
 500 
 501   run-test-$1: pre-run-test
 502 	$$(call LogWarn)
 503 	$$(call LogWarn, Running test '$$($1_TEST)')
 504 	$$(call MakeDir, $$($1_TEST_RESULTS_DIR) $$($1_TEST_SUPPORT_DIR))
 505 	$$(call ExecuteWithLog, $$($1_TEST_SUPPORT_DIR)/gtest, ( \
 506 	    $$(CD) $$($1_TEST_SUPPORT_DIR) && \
 507 	    $$(FIXPATH) $$(TEST_IMAGE_DIR)/hotspot/gtest/$$($1_VARIANT)/gtestLauncher \
 508 	        -jdk $(JDK_UNDER_TEST) $$($1_GTEST_FILTER) \
 509 	        --gtest_output=xml:$$($1_TEST_RESULTS_DIR)/gtest.xml \
 510 	        --gtest_catch_exceptions=0 \
 511 	        $$($1_GTEST_REPEAT) $$(GTEST_OPTIONS) $$(GTEST_VM_OPTIONS) \
 512 	        $$(GTEST_JAVA_OPTIONS) \
 513 	        > >($(TEE) $$($1_TEST_RESULTS_DIR)/gtest.txt) \
 514 	    && $$(ECHO) $$$$? > $$($1_EXITCODE) \
 515 	    || $$(ECHO) $$$$? > $$($1_EXITCODE) \
 516 	))
 517 
 518   $1_RESULT_FILE := $$($1_TEST_RESULTS_DIR)/gtest.txt
 519 
 520   parse-test-$1: run-test-$1
 521 	$$(call LogWarn, Finished running test '$$($1_TEST)')
 522 	$$(call LogWarn, Test report is stored in $$(strip \
 523 	    $$(subst $$(TOPDIR)/, , $$($1_TEST_RESULTS_DIR))))
 524 	$$(if $$(wildcard $$($1_RESULT_FILE)), \
 525 	  $$(eval $1_TOTAL := $$(shell $$(AWK) '/==========.* tests? from .* \
 526 	      test (cases?|suites?) ran/ { print $$$$2 }' $$($1_RESULT_FILE))) \
 527 	  $$(if $$($1_TOTAL), , $$(eval $1_TOTAL := 0)) \
 528 	  $$(eval $1_PASSED := $$(shell $$(AWK) '/\[  PASSED  \] .* tests?./ \
 529 	      { print $$$$4 }' $$($1_RESULT_FILE))) \
 530 	  $$(if $$($1_PASSED), , $$(eval $1_PASSED := 0)) \
 531 	  $$(eval $1_FAILED := $$(shell $$(AWK) '/\[  FAILED  \] .* tests?, \
 532 	      listed below/ { print $$$$4 }' $$($1_RESULT_FILE))) \
 533 	  $$(if $$($1_FAILED), , $$(eval $1_FAILED := 0)) \
 534 	  $$(eval $1_ERROR := $$(shell \
 535 	      $$(EXPR) $$($1_TOTAL) - $$($1_PASSED) - $$($1_FAILED))) \
 536 	, \
 537 	  $$(eval $1_PASSED := 0) \
 538 	  $$(eval $1_FAILED := 0) \
 539 	  $$(eval $1_ERROR := 1) \
 540 	  $$(eval $1_TOTAL := 1) \
 541 	)
 542 
 543   $1: run-test-$1 parse-test-$1
 544 
 545   TARGETS += $1 run-test-$1 parse-test-$1
 546   TEST_TARGETS += parse-test-$1
 547 
 548 endef
 549 
 550 ################################################################################
 551 
 552 ### Rules for Microbenchmarks
 553 
 554 # Helper function for SetupRunMicroTest. Set a MICRO_* variable from, in order:
 555 # 1) Specified by user on command line
 556 # 2) Generic default
 557 #
 558 # Note: No spaces are allowed around the arguments.
 559 # Arg $1 The test ID (i.e. $1 in SetupRunMicroTest)
 560 # Arg $2 Base variable, e.g. MICRO_TEST_JDK
 561 # Arg $3 The default value (optional)
 562 define SetMicroValue
 563   ifneq ($$($2), )
 564     $1_$2 := $$($2)
 565   else
 566     ifneq ($3, )
 567       $1_$2 := $3
 568     endif
 569   endif
 570 endef
 571 
 572 SetupRunMicroTest = $(NamedParamsMacroTemplate)
 573 define SetupRunMicroTestBody
 574   $1_TEST_RESULTS_DIR := $$(TEST_RESULTS_DIR)/$1
 575   $1_TEST_SUPPORT_DIR := $$(TEST_SUPPORT_DIR)/$1
 576   $1_EXITCODE := $$($1_TEST_RESULTS_DIR)/exitcode.txt
 577 
 578   $1_TEST_NAME := $$(strip $$(patsubst micro:%, %, $$($1_TEST)))
 579 
 580   $$(eval $$(call SetMicroValue,$1,MICRO_BENCHMARKS_JAR,$$(TEST_IMAGE_DIR)/micro/benchmarks.jar))
 581   $$(eval $$(call SetMicroValue,$1,MICRO_TEST_JDK,$$(JDK_UNDER_TEST)))
 582   $$(eval $$(call SetMicroValue,$1,MICRO_JAVA_OPTIONS))
 583 
 584   # Current tests needs to open java.io
 585   $1_MICRO_JAVA_OPTIONS += --add-opens=java.base/java.io=ALL-UNNAMED
 586 
 587   # Save output as JSON or CSV file
 588   ifneq ($$(MICRO_RESULTS_FORMAT), )
 589     $1_MICRO_BASIC_OPTIONS += -rf $$(MICRO_RESULTS_FORMAT)
 590     $1_MICRO_BASIC_OPTIONS += -rff $$($1_TEST_RESULTS_DIR)/jmh-result.$(MICRO_RESULTS_FORMAT)
 591   endif
 592 
 593   # Set library path for native dependencies
 594   $1_JMH_JVM_ARGS := -Djava.library.path=$$(TEST_IMAGE_DIR)/micro/native
 595 
 596   ifneq ($$(MICRO_VM_OPTIONS)$$(MICRO_JAVA_OPTIONS), )
 597     $1_JMH_JVM_ARGS += $$(MICRO_VM_OPTIONS) $$(MICRO_JAVA_OPTIONS)
 598   endif
 599 
 600   $1_MICRO_VM_OPTIONS := -jvmArgs $(call ShellQuote,$$($1_JMH_JVM_ARGS))
 601 
 602   ifneq ($$(MICRO_ITER), )
 603     $1_MICRO_ITER := -i $$(MICRO_ITER)
 604   endif
 605   ifneq ($$(MICRO_FORK), )
 606     $1_MICRO_FORK := -f $$(MICRO_FORK)
 607   endif
 608   ifneq ($$(MICRO_TIME), )
 609     $1_MICRO_TIME := -r $$(MICRO_TIME)
 610   endif
 611   ifneq ($$(MICRO_WARMUP_ITER), )
 612     $1_MICRO_WARMUP_ITER := -wi $$(MICRO_WARMUP_ITER)
 613   endif
 614   ifneq ($$(MICRO_WARMUP_TIME), )
 615     $1_MICRO_WARMUP_TIME := -w $$(MICRO_WARMUP_TIME)
 616   endif
 617 
 618   run-test-$1: pre-run-test
 619 	$$(call LogWarn)
 620 	$$(call LogWarn, Running test '$$($1_TEST)')
 621 	$$(call MakeDir, $$($1_TEST_RESULTS_DIR) $$($1_TEST_SUPPORT_DIR))
 622 	$$(call ExecuteWithLog, $$($1_TEST_SUPPORT_DIR)/micro, ( \
 623 	    $$(FIXPATH) $$($1_MICRO_TEST_JDK)/bin/java $$($1_MICRO_JAVA_OPTIONS) \
 624 	        -jar $$($1_MICRO_BENCHMARKS_JAR) \
 625 	        $$($1_MICRO_ITER) $$($1_MICRO_FORK) $$($1_MICRO_TIME) \
 626 	        $$($1_MICRO_WARMUP_ITER) $$($1_MICRO_WARMUP_TIME) \
 627 	        $$($1_MICRO_VM_OPTIONS) $$($1_MICRO_BASIC_OPTIONS) $$(MICRO_OPTIONS) \
 628 	        $$($1_TEST_NAME) \
 629 	        > >($(TEE) $$($1_TEST_RESULTS_DIR)/micro.txt) \
 630 	    && $$(ECHO) $$$$? > $$($1_EXITCODE) \
 631 	    || $$(ECHO) $$$$? > $$($1_EXITCODE) \
 632 	))
 633 
 634   $1_RESULT_FILE := $$($1_TEST_RESULTS_DIR)/micro.txt
 635 
 636   parse-test-$1: run-test-$1
 637 	$$(call LogWarn, Finished running test '$$($1_TEST)')
 638 	$$(call LogWarn, Test report is stored in $$(strip \
 639 	    $$(subst $$(TOPDIR)/, , $$($1_TEST_RESULTS_DIR))))
 640 	$$(if $$(wildcard $$($1_EXITCODE)), \
 641 	  $$(eval $1_EXIT_CODE := $$(shell $$(CAT) $$($1_EXITCODE))) \
 642 	  $$(if $$(filter 0, $$($1_EXIT_CODE)), \
 643 	    $$(eval $1_PASSED := 1) \
 644 	    $$(eval $1_ERROR := 0) \
 645 	  , \
 646 	    $$(eval $1_PASSED := 0) \
 647 	    $$(eval $1_ERROR := 1) \
 648 	  ) \
 649 	  $$(eval $1_FAILED := 0) \
 650 	  $$(eval $1_TOTAL := $$(shell \
 651 	      $$(EXPR) $$($1_PASSED) + $$($1_ERROR))) \
 652 	, \
 653 	  $$(eval $1_PASSED := 0) \
 654 	  $$(eval $1_FAILED := 0) \
 655 	  $$(eval $1_ERROR := 1) \
 656 	  $$(eval $1_TOTAL := 1) \
 657 	)
 658 
 659   $1: run-test-$1 parse-test-$1
 660 
 661   TARGETS += $1 run-test-$1 parse-test-$1
 662   TEST_TARGETS += parse-test-$1
 663 
 664 endef
 665 
 666 ################################################################################
 667 
 668 ### Rules for Jtreg
 669 
 670 # Helper function for SetupRunJtregTest. Set a JTREG_* variable from, in order:
 671 # 1) Specified by user on command line
 672 # 2) Component-specific default
 673 # 3) Generic default
 674 #
 675 # Note: No spaces are allowed around the arguments.
 676 # Arg $1 The test ID (i.e. $1 in SetupRunJtregTest)
 677 # Arg $2 Base variable, e.g. JTREG_JOBS
 678 # Arg $3 The default value (optional)
 679 define SetJtregValue
 680   ifneq ($$($2), )
 681     $1_$2 := $$($2)
 682   else
 683     ifneq ($$($$($1_COMPONENT)_$2), )
 684       $1_$2 := $$($$($1_COMPONENT)_$2)
 685     else
 686       ifneq ($3, )
 687         $1_$2 := $3
 688       endif
 689     endif
 690   endif
 691 endef
 692 
 693 SetupRunJtregTest = $(NamedParamsMacroTemplate)
 694 define SetupRunJtregTestBody
 695   $1_TEST_RESULTS_DIR := $$(TEST_RESULTS_DIR)/$1
 696   $1_TEST_SUPPORT_DIR := $$(TEST_SUPPORT_DIR)/$1
 697   $1_EXITCODE := $$($1_TEST_RESULTS_DIR)/exitcode.txt
 698 
 699   $1_TEST_NAME := $$(strip $$(patsubst jtreg:%, %, $$($1_TEST)))
 700 
 701   $1_TEST_ROOT := \
 702       $$(strip $$(foreach root, $$(JTREG_TESTROOTS), \
 703         $$(if $$(filter $$(root)%, $$(JTREG_TOPDIR)/$$($1_TEST_NAME)), $$(root)) \
 704       ))
 705   $1_COMPONENT := $$(lastword $$(subst /, $$(SPACE), $$($1_TEST_ROOT)))
 706   # This will work only as long as just hotspot has the additional "jtreg" directory
 707   ifeq ($$($1_COMPONENT), jtreg)
 708     $1_COMPONENT := hotspot
 709   endif
 710 
 711   ifeq ($$(JT_HOME), )
 712     $$(info Error: jtreg framework is not found.)
 713     $$(info Please run configure using --with-jtreg.)
 714     $$(error Cannot continue)
 715   endif
 716 
 717   # Unfortunately, we need different defaults for some JTREG values,
 718   # depending on what component we're running.
 719 
 720   # Convert JTREG_foo into $1_JTREG_foo with a suitable value.
 721   $$(eval $$(call SetJtregValue,$1,JTREG_TEST_MODE,agentvm))
 722   $$(eval $$(call SetJtregValue,$1,JTREG_ASSERT,true))
 723   $$(eval $$(call SetJtregValue,$1,JTREG_MAX_MEM,768m))
 724   $$(eval $$(call SetJtregValue,$1,JTREG_NATIVEPATH))
 725   $$(eval $$(call SetJtregValue,$1,JTREG_BASIC_OPTIONS))
 726   $$(eval $$(call SetJtregValue,$1,JTREG_PROBLEM_LIST))
 727 
 728   # Only the problem list for the current test root should be used.
 729   $1_JTREG_PROBLEM_LIST := $$(filter $$($1_TEST_ROOT)%, $$($1_JTREG_PROBLEM_LIST))
 730 
 731   ifneq ($(TEST_JOBS), 0)
 732     $$(eval $$(call SetJtregValue,$1,JTREG_JOBS,$$(TEST_JOBS)))
 733   else
 734     $$(eval $$(call SetJtregValue,$1,JTREG_JOBS,$$(JOBS)))
 735   endif
 736 
 737   # Make sure MaxRAMPercentage is high enough to not cause OOM or swapping since
 738   # we may end up with a lot of JVM's
 739   $1_JTREG_MAX_RAM_PERCENTAGE := $$(shell $(AWK) 'BEGIN { print 25 / $$($1_JTREG_JOBS); }')
 740 
 741   JTREG_TIMEOUT_FACTOR ?= 4
 742 
 743   JTREG_VERBOSE ?= fail,error,summary
 744   JTREG_RETAIN ?= fail,error
 745   JTREG_RUN_PROBLEM_LISTS ?= false
 746   JTREG_RETRY_COUNT ?= 0
 747   JTREG_REPEAT_COUNT ?= 0
 748 
 749   ifneq ($$(JTREG_RETRY_COUNT), 0)
 750     ifneq ($$(JTREG_REPEAT_COUNT), 0)
 751       $$(info Error: Cannot use both JTREG_RETRY_COUNT and JTREG_REPEAT_COUNT together.)
 752       $$(info Please choose one or the other.)
 753       $$(error Cannot continue)
 754     endif
 755   endif
 756 
 757   ifneq ($$(JTREG_LAUNCHER_OPTIONS), )
 758     $1_JTREG_LAUNCHER_OPTIONS += $$(JTREG_LAUNCHER_OPTIONS)
 759   endif
 760 
 761   ifneq ($$(JTREG_MAX_OUTPUT), )
 762     $1_JTREG_LAUNCHER_OPTIONS += -Djavatest.maxOutputSize=$$(JTREG_MAX_OUTPUT)
 763   endif
 764 
 765   ifneq ($$($1_JTREG_MAX_MEM), 0)
 766     $1_JTREG_BASIC_OPTIONS += -vmoption:-Xmx$$($1_JTREG_MAX_MEM)
 767     $1_JTREG_LAUNCHER_OPTIONS += -Xmx$$($1_JTREG_MAX_MEM)
 768   endif
 769 
 770   # Make sure the tmp dir is normalized as some tests will react badly otherwise
 771   $1_TEST_TMP_DIR := $$(abspath $$($1_TEST_SUPPORT_DIR)/tmp)
 772 
 773   $1_JTREG_BASIC_OPTIONS += -$$($1_JTREG_TEST_MODE) \
 774       -verbose:$$(JTREG_VERBOSE) -retain:$$(JTREG_RETAIN) \
 775       -concurrency:$$($1_JTREG_JOBS) -timeoutFactor:$$(JTREG_TIMEOUT_FACTOR) \
 776       -vmoption:-XX:MaxRAMPercentage=$$($1_JTREG_MAX_RAM_PERCENTAGE) \
 777       -vmoption:-Djava.io.tmpdir="$$($1_TEST_TMP_DIR)"
 778 
 779   $1_JTREG_BASIC_OPTIONS += -automatic -ignore:quiet
 780 
 781   # Make it possible to specify the JIB_DATA_DIR for tests using the
 782   # JIB Artifact resolver
 783   $1_JTREG_BASIC_OPTIONS += -e:JIB_DATA_DIR
 784   # Some tests needs to find a boot JDK using the JDK8_HOME variable.
 785   $1_JTREG_BASIC_OPTIONS += -e:JDK8_HOME=$$(BOOT_JDK)
 786   # If running on Windows, propagate the _NT_SYMBOL_PATH to enable
 787   # symbol lookup in hserr files
 788   # The minidumps are disabled by default on client Windows, so enable them
 789   ifeq ($$(call isTargetOs, windows), true)
 790     $1_JTREG_BASIC_OPTIONS += -e:_NT_SYMBOL_PATH
 791     $1_JTREG_BASIC_OPTIONS += -vmoption:-XX:+CreateCoredumpOnCrash
 792   endif
 793 
 794   $1_JTREG_BASIC_OPTIONS += \
 795       $$(addprefix -javaoption:, $$(JTREG_JAVA_OPTIONS)) \
 796       $$(addprefix -vmoption:, $$(JTREG_VM_OPTIONS)) \
 797       #
 798 
 799   ifeq ($$($1_JTREG_ASSERT), true)
 800     $1_JTREG_BASIC_OPTIONS += -ea -esa
 801   endif
 802 
 803   ifneq ($$($1_JTREG_NATIVEPATH), )
 804     $1_JTREG_BASIC_OPTIONS += -nativepath:$$($1_JTREG_NATIVEPATH)
 805   endif
 806 
 807   ifeq ($$(JTREG_RUN_PROBLEM_LISTS), true)
 808     JTREG_PROBLEM_LIST_PREFIX := -match:
 809   else
 810     JTREG_PROBLEM_LIST_PREFIX := -exclude:
 811   endif
 812 
 813   ifneq ($$($1_JTREG_PROBLEM_LIST), )
 814     $1_JTREG_BASIC_OPTIONS += $$(addprefix $$(JTREG_PROBLEM_LIST_PREFIX), $$($1_JTREG_PROBLEM_LIST))
 815   endif
 816 
 817   # Add more Lilliput-specific ProblemLists when UCOH is enabled
 818   ifneq ($$(findstring -XX:+UseCompactObjectHeaders, $$(TEST_OPTS)), )
 819     JTREG_EXTRA_PROBLEM_LISTS += $(TOPDIR)/test/hotspot/jtreg/ProblemList-lilliput.txt
 820   endif
 821 
 822   ifneq ($$(JTREG_EXTRA_PROBLEM_LISTS), )
 823     # Accept both absolute paths as well as relative to the current test root.
 824     $1_JTREG_BASIC_OPTIONS += $$(addprefix $$(JTREG_PROBLEM_LIST_PREFIX), $$(wildcard \
 825         $$(JTREG_EXTRA_PROBLEM_LISTS) \
 826         $$(addprefix $$($1_TEST_ROOT)/, $$(JTREG_EXTRA_PROBLEM_LISTS)) \
 827     ))
 828   endif
 829 
 830   ifneq ($$(JIB_HOME), )
 831     $1_JTREG_BASIC_OPTIONS += -e:JIB_HOME=$$(JIB_HOME)
 832   endif
 833 
 834   $1_JTREG_BASIC_OPTIONS += -e:TEST_IMAGE_DIR=$(TEST_IMAGE_DIR)
 835 
 836   ifneq ($$(JTREG_FAILURE_HANDLER_OPTIONS), )
 837     $1_JTREG_LAUNCHER_OPTIONS += -Djava.library.path="$(JTREG_FAILURE_HANDLER_DIR)"
 838   endif
 839 
 840   ifneq ($$(JTREG_KEYWORDS), )
 841     # The keywords string may contain problematic characters and may be quoted
 842     # already when it arrives here. Remove any existing quotes and replace them
 843     # with one set of single quotes.
 844     $1_JTREG_KEYWORDS := \
 845         $$(strip $$(subst $$(SQUOTE),,$$(subst $$(DQUOTE),,$$(JTREG_KEYWORDS))))
 846     ifneq ($$($1_JTREG_KEYWORDS), )
 847       $1_JTREG_BASIC_OPTIONS += -k:'$$($1_JTREG_KEYWORDS)'
 848     endif
 849   endif
 850 
 851   clean-outputdirs-$1:
 852 	$$(RM) -r $$($1_TEST_SUPPORT_DIR)
 853 	$$(RM) -r $$($1_TEST_RESULTS_DIR)
 854 
 855   $1_COMMAND_LINE := \
 856       $$(JTREG_JAVA) $$($1_JTREG_LAUNCHER_OPTIONS) \
 857           -Dprogram=jtreg -jar $$(JT_HOME)/lib/jtreg.jar \
 858           $$($1_JTREG_BASIC_OPTIONS) \
 859           -testjdk:$$(JDK_UNDER_TEST) \
 860           -dir:$$(JTREG_TOPDIR) \
 861           -reportDir:$$($1_TEST_RESULTS_DIR) \
 862           -workDir:$$($1_TEST_SUPPORT_DIR) \
 863           -status:$$$${JTREG_STATUS} \
 864           $$(JTREG_OPTIONS) \
 865           $$(JTREG_FAILURE_HANDLER_OPTIONS) \
 866           $$(JTREG_COV_OPTIONS) \
 867           $$($1_TEST_NAME) \
 868       && $$(ECHO) $$$$? > $$($1_EXITCODE) \
 869       || $$(ECHO) $$$$? > $$($1_EXITCODE)
 870 
 871 
 872   ifneq ($$(JTREG_RETRY_COUNT), 0)
 873     $1_COMMAND_LINE := \
 874         for i in {0..$$(JTREG_RETRY_COUNT)}; do \
 875           if [ "$$$$i" != 0 ]; then \
 876             $$(PRINTF) "\nRetrying Jtreg run. Attempt: $$$$i\n"; \
 877           fi; \
 878           $$($1_COMMAND_LINE); \
 879           if [ "`$$(CAT) $$($1_EXITCODE)`" = "0" ]; then \
 880             break; \
 881           fi; \
 882           export JTREG_STATUS="-status:error,fail"; \
 883         done
 884   endif
 885 
 886   ifneq ($$(JTREG_REPEAT_COUNT), 0)
 887     $1_COMMAND_LINE := \
 888         for i in {1..$$(JTREG_REPEAT_COUNT)}; do \
 889           $$(PRINTF) "\nRepeating Jtreg run: $$$$i out of $$(JTREG_REPEAT_COUNT)\n"; \
 890           $$($1_COMMAND_LINE); \
 891           if [ "`$$(CAT) $$($1_EXITCODE)`" != "0" ]; then \
 892             $$(PRINTF) "\nFailures detected, no more repeats.\n"; \
 893             break; \
 894           fi; \
 895         done
 896   endif
 897 
 898   run-test-$1: pre-run-test clean-outputdirs-$1
 899 	$$(call LogWarn)
 900 	$$(call LogWarn, Running test '$$($1_TEST)')
 901 	$$(call MakeDir, $$($1_TEST_RESULTS_DIR) $$($1_TEST_SUPPORT_DIR) \
 902 	    $$($1_TEST_TMP_DIR))
 903 	$$(call ExecuteWithLog, $$($1_TEST_SUPPORT_DIR)/jtreg, ( \
 904             $$(COV_ENVIRONMENT) $$($1_COMMAND_LINE) \
 905 	))
 906 
 907   $1_RESULT_FILE := $$($1_TEST_RESULTS_DIR)/text/stats.txt
 908 
 909   parse-test-$1: run-test-$1
 910 	$$(call LogWarn, Finished running test '$$($1_TEST)')
 911 	$$(call LogWarn, Test report is stored in $$(strip \
 912 	    $$(subst $$(TOPDIR)/, , $$($1_TEST_RESULTS_DIR))))
 913 	$$(if $$(wildcard $$($1_RESULT_FILE)), \
 914 	  $$(eval $1_PASSED := $$(shell $$(AWK) '{ gsub(/[,;]/, ""); \
 915 	      for (i=1; i<=NF; i++) { if ($$$$i == "passed:") \
 916 	      print $$$$(i+1) } }' $$($1_RESULT_FILE))) \
 917 	  $$(if $$($1_PASSED), , $$(eval $1_PASSED := 0)) \
 918 	  $$(eval $1_FAILED := $$(shell $$(AWK) '{gsub(/[,;]/, ""); \
 919 	      for (i=1; i<=NF; i++) { if ($$$$i == "failed:") \
 920 	      print $$$$(i+1) } }' $$($1_RESULT_FILE))) \
 921 	  $$(if $$($1_FAILED), , $$(eval $1_FAILED := 0)) \
 922 	  $$(eval $1_ERROR := $$(shell $$(AWK) '{gsub(/[,;]/, ""); \
 923 	      for (i=1; i<=NF; i++) { if ($$$$i == "error:") \
 924 	      print $$$$(i+1) } }' $$($1_RESULT_FILE))) \
 925 	  $$(if $$($1_ERROR), , $$(eval $1_ERROR := 0)) \
 926 	  $$(eval $1_TOTAL := $$(shell \
 927 	      $$(EXPR) $$($1_PASSED) + $$($1_FAILED) + $$($1_ERROR))) \
 928 	, \
 929 	  $$(eval $1_PASSED := 0) \
 930 	  $$(eval $1_FAILED := 0) \
 931 	  $$(eval $1_ERROR := 1) \
 932 	  $$(eval $1_TOTAL := 1) \
 933 	)
 934 
 935   $1: run-test-$1 parse-test-$1 clean-outputdirs-$1
 936 
 937   TARGETS += $1 run-test-$1 parse-test-$1 clean-outputdirs-$1
 938   TEST_TARGETS += parse-test-$1
 939 
 940 endef
 941 
 942 ################################################################################
 943 
 944 ### Rules for special tests
 945 
 946 SetupRunSpecialTest = $(NamedParamsMacroTemplate)
 947 define SetupRunSpecialTestBody
 948   $1_TEST_RESULTS_DIR := $$(TEST_RESULTS_DIR)/$1
 949   $1_TEST_SUPPORT_DIR := $$(TEST_SUPPORT_DIR)/$1
 950   $1_EXITCODE := $$($1_TEST_RESULTS_DIR)/exitcode.txt
 951 
 952   $1_FULL_TEST_NAME := $$(strip $$(patsubst special:%, %, $$($1_TEST)))
 953   ifneq ($$(findstring :, $$($1_FULL_TEST_NAME)), )
 954     $1_TEST_NAME := $$(firstword $$(subst :, ,$$($1_FULL_TEST_NAME)))
 955     $1_TEST_ARGS := $$(strip $$(patsubst special:$$($1_TEST_NAME):%, %, $$($1_TEST)))
 956   else
 957     $1_TEST_NAME := $$($1_FULL_TEST_NAME)
 958     $1_TEST_ARGS :=
 959   endif
 960 
 961   ifeq ($$($1_TEST_NAME), failure-handler)
 962     ifeq ($(BUILD_FAILURE_HANDLER), true)
 963       $1_TEST_COMMAND_LINE := \
 964           ($(CD) $(TOPDIR)/make/test && $(MAKE) $(MAKE_ARGS) -f \
 965           BuildFailureHandler.gmk test)
 966     else
 967       $$(error Cannot test failure handler if it is not built)
 968     endif
 969   else ifeq ($$($1_TEST_NAME), make)
 970     $1_TEST_COMMAND_LINE := \
 971         ($(CD) $(TOPDIR)/test/make && $(MAKE) $(MAKE_ARGS) -f \
 972         TestMake.gmk $$($1_TEST_ARGS) TEST_SUPPORT_DIR="$$($1_TEST_SUPPORT_DIR)")
 973   else
 974     $$(error Invalid special test specification: $$($1_TEST_NAME))
 975   endif
 976 
 977   run-test-$1: pre-run-test
 978 	$$(call LogWarn)
 979 	$$(call LogWarn, Running test '$$($1_TEST)')
 980 	$$(call MakeDir, $$($1_TEST_RESULTS_DIR) $$($1_TEST_SUPPORT_DIR))
 981 	$$(call ExecuteWithLog, $$($1_TEST_SUPPORT_DIR)/test-execution, ( \
 982 	    $$($1_TEST_COMMAND_LINE) \
 983 	        > >($(TEE) $$($1_TEST_RESULTS_DIR)/test-output.txt) \
 984 	    && $$(ECHO) $$$$? > $$($1_EXITCODE) \
 985 	    || $$(ECHO) $$$$? > $$($1_EXITCODE) \
 986 	))
 987 
 988   $1_RESULT_FILE := $$($1_TEST_RESULTS_DIR)/gtest.txt
 989 
 990   # We can not parse the various "special" tests.
 991   parse-test-$1: run-test-$1
 992 	$$(call LogWarn, Finished running test '$$($1_TEST)')
 993 	$$(call LogWarn, Test report is stored in $$(strip \
 994 	    $$(subst $$(TOPDIR)/, , $$($1_TEST_RESULTS_DIR))))
 995 	$$(call LogWarn, Warning: Special test results are not properly parsed!)
 996 	$$(eval $1_PASSED := $$(shell \
 997 	  if [ `$(CAT) $$($1_EXITCODE)` = "0" ]; then $(ECHO) 1; else $(ECHO) 0; fi \
 998 	))
 999 	$$(eval $1_FAILED := $$(shell \
1000 	  if [ `$(CAT) $$($1_EXITCODE)` = "0" ]; then $(ECHO) 0; else $(ECHO) 1; fi \
1001 	))
1002 	$$(eval $1_ERROR := 0)
1003 	$$(eval $1_TOTAL := 1)
1004 
1005   $1: run-test-$1 parse-test-$1
1006 
1007   TARGETS += $1 run-test-$1 parse-test-$1
1008   TEST_TARGETS += parse-test-$1
1009 
1010 endef
1011 
1012 ################################################################################
1013 # Setup and execute make rules for all selected tests
1014 ################################################################################
1015 
1016 # Helper function to determine which handler to use for the given test
1017 UseGtestTestHandler = \
1018   $(if $(filter gtest:%, $1), true)
1019 
1020 UseMicroTestHandler = \
1021   $(if $(filter micro:%, $1), true)
1022 
1023 UseJtregTestHandler = \
1024   $(if $(filter jtreg:%, $1), true)
1025 
1026 UseSpecialTestHandler = \
1027   $(if $(filter special:%, $1), true)
1028 
1029 # Now process each test to run and setup a proper make rule
1030 $(foreach test, $(TESTS_TO_RUN), \
1031   $(eval TEST_ID := $(shell $(ECHO) $(strip $(test)) | \
1032       $(TR) -cs '[a-z][A-Z][0-9]\n' '[_*1000]')) \
1033   $(eval ALL_TEST_IDS += $(TEST_ID)) \
1034   $(if $(call UseCustomTestHandler, $(test)), \
1035     $(eval $(call SetupRunCustomTest, $(TEST_ID), \
1036         TEST := $(test), \
1037     )) \
1038   ) \
1039   $(if $(call UseGtestTestHandler, $(test)), \
1040     $(eval $(call SetupRunGtestTest, $(TEST_ID), \
1041         TEST := $(test), \
1042     )) \
1043   ) \
1044   $(if $(call UseMicroTestHandler, $(test)), \
1045     $(eval $(call SetupRunMicroTest, $(TEST_ID), \
1046         TEST := $(test), \
1047     )) \
1048   ) \
1049   $(if $(call UseJtregTestHandler, $(test)), \
1050     $(eval $(call SetupRunJtregTest, $(TEST_ID), \
1051         TEST := $(test), \
1052     )) \
1053   ) \
1054   $(if $(call UseSpecialTestHandler, $(test)), \
1055     $(eval $(call SetupRunSpecialTest, $(TEST_ID), \
1056         TEST := $(test), \
1057     )) \
1058   ) \
1059 )
1060 
1061 # Sort also removes duplicates, so if there is any we'll get fewer words.
1062 ifneq ($(words $(ALL_TEST_IDS)), $(words $(sort $(ALL_TEST_IDS))))
1063   $(error Duplicate test specification)
1064 endif
1065 
1066 
1067 ################################################################################
1068 # The main target for RunTests.gmk
1069 ################################################################################
1070 
1071 #
1072 # Provide hooks for adding functionality before and after all tests are run.
1073 #
1074 
1075 $(call LogInfo, RunTest setup starting)
1076 
1077 # This target depends on all actual test having been run (TEST_TARGETS has beeen
1078 # populated by the SetupRun*Test functions). If you need to provide a teardown
1079 # hook, you must let it depend on this target.
1080 run-all-tests: $(TEST_TARGETS)
1081 	$(call LogInfo, RunTest teardown starting)
1082 
1083 # This is an abstract target that will be run before any actual tests. Add your
1084 # target as a dependency to thisif you need "setup" type functionality executed
1085 # before all tests.
1086 pre-run-test:
1087 	$(call LogInfo, RunTest setup done)
1088 
1089 # This is an abstract target that will be run after all actual tests, but before
1090 # the test summary. If you need "teardown" type functionality, add your target
1091 # as a dependency on this, and let the teardown target depend on run-all-tests.
1092 post-run-test: run-all-tests
1093 	$(call LogInfo, RunTest teardown done)
1094 
1095 #
1096 # Create and print a table of the result of all tests run
1097 #
1098 TEST_FAILURE := false
1099 
1100 run-test-report: post-run-test
1101 	$(RM) $(TEST_SUMMARY).old 2> /dev/null
1102 	$(MV) $(TEST_SUMMARY) $(TEST_SUMMARY).old 2> /dev/null || true
1103 	$(RM) $(TEST_LAST_IDS).old 2> /dev/null
1104 	$(MV) $(TEST_LAST_IDS) $(TEST_LAST_IDS).old 2> /dev/null || true
1105 	$(ECHO) >> $(TEST_SUMMARY) ==============================
1106 	$(ECHO) >> $(TEST_SUMMARY) Test summary
1107 	$(ECHO) >> $(TEST_SUMMARY) ==============================
1108 	$(PRINTF) >> $(TEST_SUMMARY) "%2s %-49s %5s %5s %5s %5s %2s\n" "  " \
1109 	    TEST TOTAL PASS FAIL ERROR " "
1110 	$(foreach test, $(TESTS_TO_RUN), \
1111 	  $(eval TEST_ID := $(shell $(ECHO) $(strip $(test)) | \
1112 	      $(TR) -cs '[a-z][A-Z][0-9]\n' '[_*1000]')) \
1113 	    $(ECHO) >> $(TEST_LAST_IDS) $(TEST_ID) $(NEWLINE) \
1114 	  $(eval NAME_PATTERN := $(shell $(ECHO) $(test) | $(TR) -c '\n' '[_*1000]')) \
1115 	  $(if $(filter __________________________________________________%, $(NAME_PATTERN)), \
1116 	    $(eval TEST_NAME := ) \
1117 	    $(PRINTF) >> $(TEST_SUMMARY) "%2s %-49s\n" "  " "$(test)"  $(NEWLINE) \
1118 	  , \
1119 	    $(eval TEST_NAME := $(test)) \
1120 	  ) \
1121 	  $(if $(filter $($(TEST_ID)_PASSED), $($(TEST_ID)_TOTAL)), \
1122 	    $(PRINTF) >> $(TEST_SUMMARY) "%2s %-49s %5d %5d %5d %5d %2s\n" \
1123 	        "  " "$(TEST_NAME)" $($(TEST_ID)_TOTAL) $($(TEST_ID)_PASSED) \
1124 	        $($(TEST_ID)_FAILED) $($(TEST_ID)_ERROR) "  " $(NEWLINE) \
1125 	  , \
1126 	    $(PRINTF) >> $(TEST_SUMMARY) "%2s %-49s %5d %5d %5d %5d %2s\n" \
1127 	         ">>" "$(TEST_NAME)" $($(TEST_ID)_TOTAL) $($(TEST_ID)_PASSED) \
1128 	        $($(TEST_ID)_FAILED) $($(TEST_ID)_ERROR) "<<" $(NEWLINE) \
1129 	    $(eval TEST_FAILURE := true) \
1130 	  ) \
1131 	)
1132 	$(ECHO) >> $(TEST_SUMMARY) ==============================
1133 	$(if $(filter true, $(TEST_FAILURE)), \
1134 	  $(ECHO) >> $(TEST_SUMMARY) TEST FAILURE $(NEWLINE) \
1135 	  $(MKDIR) -p $(MAKESUPPORT_OUTPUTDIR) $(NEWLINE) \
1136 	  $(TOUCH) $(MAKESUPPORT_OUTPUTDIR)/exit-with-error \
1137 	, \
1138 	  $(ECHO) >> $(TEST_SUMMARY) TEST SUCCESS \
1139 	)
1140 	$(ECHO)
1141 	$(CAT) $(TEST_SUMMARY)
1142 	$(ECHO)
1143 
1144 # The main run-test target
1145 run-test: run-test-report
1146 
1147 TARGETS += run-all-tests pre-run-test post-run-test run-test-report run-test
1148 
1149 ################################################################################
1150 # Setup JCov
1151 ################################################################################
1152 
1153 ifeq ($(TEST_OPTS_JCOV), true)
1154 
1155   jcov-do-start-grabber:
1156 	$(call MakeDir, $(JCOV_OUTPUT_DIR))
1157 	if $(JAVA) -jar $(JCOV_HOME)/lib/jcov.jar GrabberManager -status 1>/dev/null 2>&1 ; then \
1158 	  $(JAVA) -jar $(JCOV_HOME)/lib/jcov.jar GrabberManager -stop -stoptimeout 3600 ; \
1159 	fi
1160 	$(JAVA) -Xmx4g -jar $(JCOV_HOME)/lib/jcov.jar Grabber -v -t \
1161 	    $(JCOV_IMAGE_DIR)/template.xml -o $(JCOV_RESULT_FILE) \
1162 	    1>$(JCOV_GRABBER_LOG) 2>&1 &
1163 
1164   jcov-start-grabber: jcov-do-start-grabber
1165 	$(call LogWarn, Starting JCov Grabber...)
1166 	$(JAVA) -jar $(JCOV_HOME)/lib/jcov.jar GrabberManager -t 600 -wait
1167 
1168   jcov-stop-grabber:
1169 	$(call LogWarn, Stopping JCov Grabber...)
1170 	$(JAVA) -jar $(JCOV_HOME)/lib/jcov.jar GrabberManager -stop -stoptimeout 3600
1171 
1172   JCOV_REPORT_TITLE := JDK code coverage report<br/>
1173   ifneq ($(JCOV_FILTERS), )
1174     JCOV_REPORT_TITLE += Code filters: $(JCOV_FILTERS)<br>
1175   endif
1176   JCOV_REPORT_TITLE += Tests: $(TEST)
1177 
1178   jcov-gen-report: jcov-stop-grabber
1179 	$(call LogWarn, Generating JCov report ...)
1180 	$(JAVA) -Xmx4g -jar $(JCOV_HOME)/lib/jcov.jar RepGen -sourcepath \
1181 	    `$(ECHO) $(TOPDIR)/src/*/share/classes/ | $(TR) ' ' ':'` -fmt html \
1182 	    $(JCOV_FILTERS) \
1183 	    -mainReportTitle "$(JCOV_REPORT_TITLE)" \
1184 	    -o $(JCOV_REPORT) $(JCOV_RESULT_FILE)
1185 
1186   TARGETS += jcov-do-start-grabber jcov-start-grabber jcov-stop-grabber \
1187       jcov-gen-report
1188 
1189   ifneq ($(TEST_OPTS_JCOV_DIFF_CHANGESET), )
1190 
1191     JCOV_SOURCE_DIFF := $(JCOV_OUTPUT_DIR)/source_diff
1192     JCOV_DIFF_COVERAGE_REPORT := $(JCOV_OUTPUT_DIR)/diff_coverage_report
1193 
1194     ifneq ($(and $(HG), $(wildcard $(TOPDIR)/.hg)), )
1195       DIFF_COMMAND := $(HG) -R $(TOPDIR) diff -r $(TEST_OPTS_JCOV_DIFF_CHANGESET) > $(JCOV_SOURCE_DIFF)
1196     else ifneq ($(and $(GIT), $(wildcard $(TOPDIR)/.git)), )
1197       DIFF_COMMAND := $(GIT) -C $(TOPDIR) diff $(TEST_OPTS_JCOV_DIFF_CHANGESET) > $(JCOV_SOURCE_DIFF)
1198     else
1199       $(info Error: Must be either hg or git source tree for diff coverage.)
1200       $(error Neither hg nor git source tree.)
1201     endif
1202 
1203     jcov-gen-diffcoverage: jcov-stop-grabber
1204 	$(call LogWarn, Generating diff coverage with changeset $(TEST_OPTS_JCOV_DIFF_CHANGESET) ... )
1205 	$(DIFF_COMMAND)
1206 	$(JAVA) -Xmx4g -jar $(JCOV_HOME)/lib/jcov.jar \
1207 	  DiffCoverage -replaceDiff "src/.*/classes/:" -all \
1208 	    $(JCOV_RESULT_FILE) $(JCOV_SOURCE_DIFF) > \
1209 	    $(JCOV_DIFF_COVERAGE_REPORT)
1210 
1211     TARGETS += jcov-gen-diffcoverage
1212 
1213   endif
1214 
1215   # Hook this into the framework at appropriate places
1216   pre-run-test: jcov-start-grabber
1217 
1218   post-run-test: jcov-gen-report
1219 
1220   ifneq ($(TEST_OPTS_JCOV_DIFF_CHANGESET), )
1221 
1222     post-run-test: jcov-gen-diffcoverage
1223 
1224   endif
1225 
1226   jcov-stop-grabber: run-all-tests
1227 
1228 endif
1229 
1230 ################################################################################
1231 
1232 all: run-test
1233 
1234 .PHONY: default all $(TARGETS)