1 #
2 # Copyright (c) 1995, 2017, 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 #
27 # Common logic to run various tests for a component, to be included by the
28 # component specific test makefiles.
29 #
30
31 # Default values for some properties that can be overridden by components.
32 USE_JTREG_VERSION ?= 4.2
33 JTREG_VM_TYPE ?= -agentvm
34 USE_JTREG_ASSERT ?= true
35 LIMIT_JTREG_VM_MEMORY ?= true
36
37 .DEFAULT : all
38
39 # Empty these to get rid of some default rules
40 .SUFFIXES:
41 .SUFFIXES: .java
42 CO=
43 GET=
44
45 # Utilities used
46 AWK = awk
47 CAT = cat
48 CD = cd
49 CHMOD = chmod
50 CP = cp
51 CUT = cut
52 DIRNAME = dirname
53 ECHO = echo
54 EGREP = egrep
55 EXPAND = expand
56 FIND = find
57 MKDIR = mkdir
58 PWD = pwd
59 RM = rm -f
60 SED = sed
61 SORT = sort
62 TEE = tee
63 UNAME = uname
64 UNIQ = uniq
65 WC = wc
66 ZIPEXE = zip
67
68 # Get OS name from uname (Cygwin inexplicably adds _NT-5.1)
69 UNAME_S := $(shell $(UNAME) -s | $(CUT) -f1 -d_)
70
71 # Commands to run on paths to make mixed paths for java on windows
72 ifeq ($(findstring CYGWIN,$(UNAME_S)), CYGWIN)
73 # Location of developer shared files
74 SLASH_JAVA = J:
75 GETMIXEDPATH = cygpath -m
76 PLATFORM = windows
77 else
78 # Location of developer shared files
79 SLASH_JAVA = /java
80 GETMIXEDPATH = $(ECHO)
81 PLATFORM = unix # we only care about windows or bsd.
82 ifeq ($(UNAME_S), Darwin)
83 PLATFORM = bsd
84 endif
85 ifeq ($(findstring BSD,$(UNAME_S)), BSD)
86 PLATFORM = bsd
87 endif
88 endif
89
90 ifdef ALT_SLASH_JAVA
91 SLASH_JAVA = $(ALT_SLASH_JAVA)
92 endif
93
94 # Root of this test area (important to use full paths in some places)
95 TEST_ROOT := $(shell $(PWD))
96
97 # Root of all test results
98 ifdef TEST_OUTPUT_DIR
99 $(shell $(MKDIR) -p $(TEST_OUTPUT_DIR)/jtreg)
100 ABS_TEST_OUTPUT_DIR := \
101 $(shell $(CD) $(TEST_OUTPUT_DIR)/jtreg && $(PWD))
102 else
103 ifdef ALT_OUTPUTDIR
104 ABS_OUTPUTDIR = $(shell $(CD) $(ALT_OUTPUTDIR) && $(PWD))
105 else
106 ABS_OUTPUTDIR = $(shell $(CD) $(TEST_ROOT)/.. && $(PWD))
107 endif
108
109 ABS_PLATFORM_BUILD_ROOT = $(ABS_OUTPUTDIR)
110 ABS_TEST_OUTPUT_DIR := $(ABS_PLATFORM_BUILD_ROOT)/testoutput/$(UNIQUE_DIR)
111 endif
112
113 # Expect JPRT to set PRODUCT_HOME (the product or jdk in this case to test)
114 ifndef PRODUCT_HOME
115 # Try to use images/jdk if it exists
116 ABS_JDK_IMAGE = $(ABS_PLATFORM_BUILD_ROOT)/images/jdk
117 PRODUCT_HOME := \
118 $(shell \
119 if [ -d $(ABS_JDK_IMAGE) ] ; then \
120 $(ECHO) "$(ABS_JDK_IMAGE)"; \
121 else \
122 $(ECHO) "$(ABS_PLATFORM_BUILD_ROOT)"; \
123 fi)
124 PRODUCT_HOME := $(PRODUCT_HOME)
125 endif
126
127 # Expect JPRT to set JPRT_PRODUCT_ARGS (e.g. -server etc.)
128 # Should be passed into 'java' only.
129 # Could include: -d64 -server -client OR any java option
130 ifdef JPRT_PRODUCT_ARGS
131 JAVA_ARGS = $(JPRT_PRODUCT_ARGS)
132 endif
133
134 # Expect JPRT to set JPRT_PRODUCT_VM_ARGS (e.g. -Xcomp etc.)
135 # Should be passed into anything running the vm (java, javac, javadoc, ...).
136 ifdef JPRT_PRODUCT_VM_ARGS
137 JAVA_VM_ARGS = $(JPRT_PRODUCT_VM_ARGS)
138 endif
139
140 ifneq ($(NATIVE_TEST_PATH), )
141 # jtreg -nativepath <dir>
142 #
143 # Local make tests will be TEST_IMAGE_DIR and JPRT with jprt.use.reg.test.bundle=true
144 # should be JPRT_TESTNATIVE_PATH
145 ifdef TEST_IMAGE_DIR
146 TESTNATIVE_DIR = $(TEST_IMAGE_DIR)
147 else ifdef JPRT_TESTNATIVE_PATH
148 TESTNATIVE_DIR = $(JPRT_TESTNATIVE_PATH)
149 endif
150 ifdef TESTNATIVE_DIR
151 JTREG_NATIVE_PATH = -nativepath:$(shell $(GETMIXEDPATH) "$(TESTNATIVE_DIR)/$(NATIVE_TEST_PATH)")
152 endif
153 endif
154
155 ifeq ($(USE_FAILURE_HANDLER), true)
156 # jtreg failure handler config
157 ifeq ($(FAILURE_HANDLER_DIR), )
158 ifneq ($(TESTNATIVE_DIR), )
159 FAILURE_HANDLER_DIR := $(TESTNATIVE_DIR)/failure_handler
160 endif
161 endif
162 ifneq ($(FAILURE_HANDLER_DIR), )
163 FAILURE_HANDLER_DIR_MIXED := $(shell $(GETMIXEDPATH) "$(FAILURE_HANDLER_DIR)")
164 JTREG_FAILURE_HANDLER_OPTIONS := \
165 -timeoutHandlerDir:$(FAILURE_HANDLER_DIR_MIXED)/jtregFailureHandler.jar \
166 -observerDir:$(FAILURE_HANDLER_DIR_MIXED)/jtregFailureHandler.jar \
167 -timeoutHandler:jdk.test.failurehandler.jtreg.GatherProcessInfoTimeoutHandler \
168 -observer:jdk.test.failurehandler.jtreg.GatherDiagnosticInfoObserver \
169 -timeoutHandlerTimeout:0
170 ifeq ($(PLATFORM), windows)
171 JTREG_FAILURE_HANDLER_OPTIONS += -J-Djava.library.path="$(FAILURE_HANDLER_DIR_MIXED)"
172 endif
173 endif
174 endif
175
176 # Expect JPRT to set JPRT_ARCHIVE_BUNDLE (path to zip bundle for results)
177 ifdef JPRT_ARCHIVE_BUNDLE
178 ARCHIVE_BUNDLE = $(JPRT_ARCHIVE_BUNDLE)
179 endif
180
181 # How to create the test bundle (pass or fail, we want to create this)
182 # Follow command with ";$(BUNDLE_UP_AND_EXIT)", so it always gets executed.
183 ifneq ($(ARCHIVE_BUNDLE), )
184 ZIP_UP_RESULTS = ( $(MKDIR) -p `$(DIRNAME) $(ARCHIVE_BUNDLE)` \
185 && $(CD) $(ABS_TEST_OUTPUT_DIR) \
186 && $(CHMOD) -R a+r . \
187 && $(ZIPEXE) -q -r $(ARCHIVE_BUNDLE) . ) ;
188 CLEAN_ARCHIVE_BUNDLE = @$(RM) $(ARCHIVE_BUNDLE)
189 endif
190
191 # AddressSanitizer
192 ifeq ($(ASAN_ENABLED), yes)
193 export ASAN_OPTIONS="handle_segv=0 detect_leaks=0"
194 JTREG_BASIC_OPTIONS += -e:ASAN_OPTIONS=$(ASAN_OPTIONS)
195 ifneq ($(DEVKIT_LIB_DIR),)
196 export LD_LIBRARY_PATH:=$(LD_LIBRARY_PATH):$(DEVKIT_LIB_DIR)
197 JTREG_BASIC_OPTIONS += -e:LD_LIBRARY_PATH=$(LD_LIBRARY_PATH)
198 endif
199 endif
200
201 # important results files
202 SUMMARY_TXT = $(shell $(GETMIXEDPATH) "$(ABS_TEST_OUTPUT_DIR)/JTreport/text/summary.txt")
203 STATS_TXT_NAME = Stats.txt
204 STATS_TXT = $(shell $(GETMIXEDPATH) "$(ABS_TEST_OUTPUT_DIR)/$(STATS_TXT_NAME)")
205 RUNLIST = $(shell $(GETMIXEDPATH) "$(ABS_TEST_OUTPUT_DIR)/runlist.txt")
206 PASSLIST = $(shell $(GETMIXEDPATH) "$(ABS_TEST_OUTPUT_DIR)/passlist.txt")
207 FAILLIST = $(shell $(GETMIXEDPATH) "$(ABS_TEST_OUTPUT_DIR)/faillist.txt")
208 EXITCODE = $(shell $(GETMIXEDPATH) "$(ABS_TEST_OUTPUT_DIR)/exitcode.txt")
209
210 TESTEXIT = \
211 if [ ! -s $(EXITCODE) ] ; then \
212 $(ECHO) "ERROR: EXITCODE file not filled in."; \
213 $(ECHO) "1" > $(EXITCODE); \
214 fi ; \
215 testExitCode=`$(CAT) $(EXITCODE)`; \
216 $(ECHO) "EXIT CODE: $${testExitCode}"; \
217 exit $${testExitCode}
218
219 ifeq ($(TREAT_EXIT_CODE_1_AS_0), true)
220 ADJUST_EXIT_CODE := \
221 if [ $${jtregExitCode} = 1 ] ; then \
222 jtregExitCode=0; \
223 fi
224 else
225 # colon is the shell no-op
226 ADJUST_EXIT_CODE := :
227 endif
228
229 BUNDLE_UP_AND_EXIT = \
230 ( \
231 jtregExitCode=$$? && \
232 _summary="$(SUMMARY_TXT)"; \
233 $(ADJUST_EXIT_CODE) ; \
234 $(RM) -f $(STATS_TXT) $(RUNLIST) $(PASSLIST) $(FAILLIST) $(EXITCODE); \
235 $(ECHO) "$${jtregExitCode}" > $(EXITCODE); \
236 if [ -r "$${_summary}" ] ; then \
237 $(ECHO) "Summary: $(UNIQUE_DIR)" > $(STATS_TXT); \
238 $(EXPAND) $${_summary} | $(EGREP) -v ' Not run\.' > $(RUNLIST); \
239 $(EGREP) ' Passed\.' $(RUNLIST) \
240 | $(EGREP) -v ' Error\.' \
241 | $(EGREP) -v ' Failed\.' > $(PASSLIST); \
242 ( $(EGREP) ' Failed\.' $(RUNLIST); \
243 $(EGREP) ' Error\.' $(RUNLIST); \
244 $(EGREP) -v ' Passed\.' $(RUNLIST) ) \
245 | $(SORT) | $(UNIQ) > $(FAILLIST); \
246 if [ $${jtregExitCode} != 0 -o -s $(FAILLIST) ] ; then \
247 $(EXPAND) $(FAILLIST) \
248 | $(CUT) -d' ' -f1 \
249 | $(SED) -e 's@^@FAILED: @' >> $(STATS_TXT); \
250 if [ $${jtregExitCode} = 0 ] ; then \
251 jtregExitCode=1; \
252 fi; \
253 fi; \
254 runc="`$(CAT) $(RUNLIST) | $(WC) -l | $(AWK) '{print $$1;}'`"; \
255 passc="`$(CAT) $(PASSLIST) | $(WC) -l | $(AWK) '{print $$1;}'`"; \
256 failc="`$(CAT) $(FAILLIST) | $(WC) -l | $(AWK) '{print $$1;}'`"; \
257 exclc="FIXME CODETOOLS-7900176"; \
258 $(ECHO) "TEST STATS: name=$(UNIQUE_DIR) run=$${runc} pass=$${passc} fail=$${failc}" \
259 >> $(STATS_TXT); \
260 else \
261 $(ECHO) "Missing file: $${_summary}" >> $(STATS_TXT); \
262 fi; \
263 if [ -f $(STATS_TXT) ] ; then \
264 $(CAT) $(STATS_TXT); \
265 fi; \
266 $(ZIP_UP_RESULTS) \
267 $(TESTEXIT) \
268 )
269
270 ################################################################
271
272 # Prep for output
273 # Change execute permissions on shared library files.
274 # Files in repositories should never have execute permissions, but
275 # there are some tests that have pre-built shared libraries, and these
276 # windows dll files must have execute permission. Adding execute
277 # permission may happen automatically on windows when using certain
278 # versions of mercurial but it cannot be guaranteed. And blindly
279 # adding execute permission might be seen as a mercurial 'change', so
280 # we avoid adding execute permission to repository files. But testing
281 # from a plain source tree needs the chmod a+rx. Applying the chmod to
282 # all shared libraries not just dll files. And with CYGWIN and sshd
283 # service, you may need CYGWIN=ntsec for this to work.
284 prep:
285 @$(MKDIR) -p $(ABS_TEST_OUTPUT_DIR)
286 @if [ ! -d $(TEST_ROOT)/../../.hg ] && [ ! -d $(TEST_ROOT)/../../../.hg ]; then \
287 $(FIND) $(TEST_ROOT) \( -name \*.dll -o -name \*.DLL -o -name \*.so \) \
288 -exec $(CHMOD) a+rx {} \; ; \
289 fi
290
291 ifeq ($(CLEAN_BEFORE_PREP), true)
292 prep: clean
293
294 endif
295
296 # Cleanup
297 clean:
298 @$(RM) -r $(ABS_TEST_OUTPUT_DIR)
299 $(CLEAN_ARCHIVE_BUNDLE)
300
301 ################################################################
302
303 # jtreg tests
304
305 # Expect JT_HOME to be set for jtreg tests. (home for jtreg)
306 ifndef JT_HOME
307 JT_HOME = $(SLASH_JAVA)/re/jtreg/$(USE_JTREG_VERSION)/promoted/latest/binaries/jtreg
308 ifdef JPRT_JTREG_HOME
309 JT_HOME = $(JPRT_JTREG_HOME)
310 endif
311 endif
312
313 # Problematic tests to be excluded
314 PROBLEM_LISTS=$(call MixedDirs,$(wildcard ProblemList.txt))
315
316 # Create exclude list for this platform and arch
317 ifdef NO_EXCLUDES
318 JTREG_EXCLUSIONS =
319 else
320 JTREG_EXCLUSIONS = $(PROBLEM_LISTS:%=-exclude:%)
321 endif
322
323 # convert list of directories to dos paths
324 define MixedDirs
325 $(foreach i,$1,$(shell $(GETMIXEDPATH) "${i}"))
326 endef
327
328 # ------------------------------------------------------------------
329
330 # When called from JPRT the TESTDIRS variable is set to the jtreg tests to run
331 ifdef TESTDIRS
332 TEST_SELECTION = $(TESTDIRS)
333 endif
334
335 ifeq ($(UNAME_S), SunOS)
336 NUM_CORES := $(shell LC_MESSAGES=C /usr/sbin/psrinfo -v | grep -c on-line)
337 endif
338 ifeq ($(UNAME_S), Linux)
339 NUM_CORES := $(shell cat /proc/cpuinfo | grep -c processor)
340 endif
341 ifeq ($(UNAME_S), Darwin)
342 NUM_CORES := $(shell /usr/sbin/sysctl -n hw.ncpu)
343 endif
344 ifeq ($(findstring CYGWIN,$(UNAME_S)), CYGWIN)
345 ifneq ($(NUMBER_OF_PROCESSORS), )
346 NUM_CORES := $(NUMBER_OF_PROCESSORS)
347 else
348 ifneq ($(HOTSPOT_BUILD_JOBS), )
349 NUM_CORES := $(HOTSPOT_BUILD_JOBS)
350 else
351 NUM_CORES := 1 # fallback
352 endif
353 endif
354 endif
355
356 ifndef CONCURRENCY_FACTOR
357 CONCURRENCY_FACTOR = 1
358 endif
359
360 # Concurrency based on min(cores / 2, 12) * CONCURRENCY_FACTOR
361 CONCURRENCY := $(shell $(AWK) \
362 'BEGIN { \
363 c = $(NUM_CORES) / 2; \
364 if (c > 12) c = 12; \
365 c = c * $(CONCURRENCY_FACTOR); \
366 if (c < 1) c = 1; \
367 printf "%.0f", c; \
368 }')
369 JTREG_BASIC_OPTIONS += -concurrency:$(CONCURRENCY)
370
371 # Make sure MaxRAMPercentage is low enough to not cause OOM or swapping since
372 # we may end up with a lot of JVM's
373 MAX_RAM_PERCENTAGE := $(shell expr 25 / $(CONCURRENCY))
374 JTREG_BASIC_OPTIONS += -vmoption:-XX:MaxRAMPercentage=$(MAX_RAM_PERCENTAGE)
375
376 ifdef EXTRA_JTREG_OPTIONS
377 JTREG_BASIC_OPTIONS += $(EXTRA_JTREG_OPTIONS)
378 endif
379
380 # Default JTREG to run
381 JTREG = $(JT_HOME)/bin/jtreg
382 # run in agentvm/othervm mode
383 JTREG_BASIC_OPTIONS += $(JTREG_VM_TYPE)
384 # Only run automatic tests
385 JTREG_BASIC_OPTIONS += -a
386 # Always turn on assertions
387 ifeq ($(USE_JTREG_ASSERT), true)
388 JTREG_ASSERT_OPTION = -ea -esa
389 endif
390 JTREG_BASIC_OPTIONS += $(JTREG_ASSERT_OPTION)
391 # jtreg verbosity setting
392 # Default is to report details on all failed or error tests, times too
393 JTREG_VERBOSE ?= fail,error,time
394 JTREG_BASIC_OPTIONS += $(if $(JTREG_VERBOSE),-v:$(JTREG_VERBOSE))
395 # Retain all files for failing tests
396 JTREG_BASIC_OPTIONS += -retain:fail,error
397 # Ignore tests are not run and completely silent about it
398 JTREG_IGNORE_OPTION = -ignore:quiet
399 JTREG_BASIC_OPTIONS += $(JTREG_IGNORE_OPTION)
400 # Multiply by 4 the timeout factor
401 JTREG_TIMEOUT_OPTION = -timeoutFactor:4
402 JTREG_BASIC_OPTIONS += $(JTREG_TIMEOUT_OPTION)
403 ifeq ($(LIMIT_JTREG_VM_MEMORY), true)
404 # Set the max memory for jtreg control vm
405 JTREG_MEMORY_OPTION = -J-Xmx512m
406 JTREG_BASIC_OPTIONS += $(JTREG_MEMORY_OPTION)
407 # Set the max memory for jtreg target test vms
408 JTREG_TESTVM_MEMORY_OPTION = -vmoption:-Xmx512m
409 JTREG_TEST_OPTIONS += $(JTREG_TESTVM_MEMORY_OPTION)
410 endif
411 # Make it possible to specify the JIB_DATA_DIR for tests using the
412 # JIB Artifact resolver
413 JTREG_BASIC_OPTIONS += -e:JIB_DATA_DIR
414 # Give tests access to JT_JAVA, see JDK-8141609
415 JTREG_BASIC_OPTIONS += -e:JDK8_HOME=${JT_JAVA}
416 # Give aot tests access to Visual Studio installation
417 ifneq ($(VS120COMNTOOLS), )
418 JTREG_BASIC_OPTIONS += -e:VS120COMNTOOLS=$(shell $(GETMIXEDPATH) "$(VS120COMNTOOLS)")
419 endif
420 # Set other vm and test options
421 JTREG_TEST_OPTIONS += $(JAVA_ARGS:%=-javaoptions:%) $(JAVA_VM_ARGS:%=-vmoption:%)
422 ifneq ($(JIB_JAR), )
423 JTREG_BASIC_OPTIONS += -cpa:$(shell $(GETMIXEDPATH) "$(JIB_JAR)")
424 endif
425 ifeq ($(IGNORE_MARKED_TESTS), true)
426 # Option to tell jtreg to not run tests marked with "ignore"
427 ifeq ($(PLATFORM), windows)
428 JTREG_KEY_OPTION = -k:!ignore
429 else
430 JTREG_KEY_OPTION = -k:\!ignore
431 endif
432 JTREG_BASIC_OPTIONS += $(JTREG_KEY_OPTION)
433 endif
434
435 # Make sure jtreg exists
436 ifeq ($(USE_WINDOWS_EXISTENCE_CHECK), true)
437 jtreg_exists:
438 test -d $(shell $(GETMIXEDPATH) "$(JT_HOME)")
439 test -f $(shell $(GETMIXEDPATH) "$(JTREG)")
440
441 else
442 jtreg_exists: $(JT_HOME)
443 endif
444 PHONY_LIST += jtreg_exists
445
446 # Run jtreg
447 jtreg_tests: prep jtreg_exists $(PRODUCT_HOME)
448 ( \
449 ( JT_HOME=$(shell $(GETMIXEDPATH) "$(JT_HOME)"); \
450 export JT_HOME; \
451 $(shell $(GETMIXEDPATH) "$(JTREG)") \
452 $(JTREG_BASIC_OPTIONS) \
453 -r:$(shell $(GETMIXEDPATH) "$(ABS_TEST_OUTPUT_DIR)/JTreport") \
454 -w:$(shell $(GETMIXEDPATH) "$(ABS_TEST_OUTPUT_DIR)/JTwork") \
455 -jdk:$(shell $(GETMIXEDPATH) "$(PRODUCT_HOME)") \
456 $(JTREG_NATIVE_PATH) \
457 $(JTREG_FAILURE_HANDLER_OPTIONS) \
458 $(JTREG_EXCLUSIONS) \
459 $(JTREG_TEST_OPTIONS) \
460 $(TEST_SELECTION) \
461 ) ; \
462 $(BUNDLE_UP_AND_EXIT) \
463 ) 2>&1 | $(TEE) $(ABS_TEST_OUTPUT_DIR)/output.txt ; $(TESTEXIT)
464
465 PHONY_LIST += jtreg_tests
466
467 # Make it possible to call this with <component>_jtreg_tests
468 %_jtreg_tests: jtreg_tests
469 # Must have a fake recipe here to prevent make from matching any other rule
470
471 ################################################################
472
473 # Phony targets (e.g. these are not filenames)
474 .PHONY: all clean prep $(PHONY_LIST)
475
476 ################################################################