1 #
  2 # Copyright (c) 2011, 2022, 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 # This file contains helper functions for Init.gmk.
 28 # It is divided in two parts, depending on if a SPEC is present or not
 29 # (HAS_SPEC is true or not).
 30 ################################################################################
 31 
 32 ifndef _INITSUPPORT_GMK
 33 _INITSUPPORT_GMK := 1
 34 
 35 ifeq ($(HAS_SPEC),)
 36 
 37   # COMMA is defined in spec.gmk, but that is not included yet
 38   COMMA := ,
 39 
 40   # Include the corresponding closed file, if present.
 41   ifneq ($(CUSTOM_MAKE_DIR), )
 42     -include $(CUSTOM_MAKE_DIR)/InitSupport.gmk
 43   endif
 44 
 45   ##############################################################################
 46   # Helper functions for the initial part of Init.gmk, before the spec file is
 47   # loaded. Most of these functions provide parsing and setting up make options
 48   # from the command-line.
 49   ##############################################################################
 50 
 51   # Make control variables, handled by Init.gmk
 52   INIT_CONTROL_VARIABLES += LOG CONF CONF_NAME SPEC JOBS TEST_JOBS CONF_CHECK \
 53       COMPARE_BUILD JTREG GTEST MICRO TEST_OPTS TEST_VM_OPTS
 54 
 55   # All known make control variables
 56   MAKE_CONTROL_VARIABLES := $(INIT_CONTROL_VARIABLES) TEST JDK_FILTER SPEC_FILTER
 57 
 58   # Define a simple reverse function.
 59   # Should maybe move to MakeBase.gmk, but we can't include that file now.
 60   reverse = \
 61       $(if $(strip $(1)), $(call reverse, $(wordlist 2, $(words $(1)), $(1)))) \
 62           $(firstword $(1))
 63 
 64   # The variable MAKEOVERRIDES contains variable assignments from the command
 65   # line, but in reverse order to what the user entered.
 66   # The '\#' <=> '\ 'dance is needed to keep values with space in them connected.
 67   COMMAND_LINE_VARIABLES := $(subst \#,\ , $(call reverse, $(subst \ ,\#,$(MAKEOVERRIDES))))
 68 
 69   # A list like FOO="val1" BAR="val2" containing all user-supplied make
 70   # variables that we should propagate.
 71   # The '\#' <=> '\ 'dance is needed to keep values with space in them connected.
 72   USER_MAKE_VARS := $(subst \#,\ , $(filter-out $(addsuffix =%, $(INIT_CONTROL_VARIABLES)), \
 73       $(subst \ ,\#,$(MAKEOVERRIDES))))
 74 
 75   # Setup information about available configurations, if any.
 76   ifneq ($(CUSTOM_ROOT), )
 77     build_dir=$(CUSTOM_ROOT)/build
 78   else
 79     build_dir=$(topdir)/build
 80   endif
 81   all_spec_files=$(wildcard $(build_dir)/*/spec.gmk)
 82   # Extract the configuration names from the path
 83   all_confs=$(patsubst %/spec.gmk, %, $(patsubst $(build_dir)/%, %, $(all_spec_files)))
 84 
 85   # Check for unknown command-line variables
 86   define CheckControlVariables
 87     command_line_variables := $$(strip $$(foreach var, \
 88         $$(subst \ ,_,$$(MAKEOVERRIDES)), \
 89         $$(firstword $$(subst =, , $$(var)))))
 90     unknown_command_line_variables := $$(strip \
 91         $$(filter-out $$(MAKE_CONTROL_VARIABLES), $$(command_line_variables)))
 92     ifneq ($$(unknown_command_line_variables), )
 93       $$(info Note: Command line contains non-control variables:)
 94       $$(foreach var, $$(unknown_command_line_variables), $$(info * $$(var)=$$($$(var))))
 95       $$(info Make sure it is not mistyped, and that you intend to override this variable.)
 96       $$(info 'make help' will list known control variables.)
 97       $$(info )
 98     endif
 99   endef
100 
101   # Check for deprecated ALT_ variables
102   define CheckDeprecatedEnvironment
103     defined_alt_variables := $$(filter ALT_%, $$(.VARIABLES))
104     ifneq ($$(defined_alt_variables), )
105       $$(info Warning: You have the following ALT_ variables set:)
106       $$(foreach var, $$(defined_alt_variables), $$(info * $$(var)=$$($$(var))))
107       $$(info ALT_ variables are deprecated, and may result in a failed build.)
108       $$(info Please clean your environment.)
109       $$(info )
110     endif
111   endef
112 
113   # Check for invalid make flags like -j
114   define CheckInvalidMakeFlags
115     # This is a trick to get this rule to execute before any other rules
116     # MAKEFLAGS only indicate -j if read in a recipe (!)
117     $$(topdir)/make/Init.gmk: .FORCE
118 	$$(if $$(findstring --jobserver, $$(MAKEFLAGS)), \
119 	    $$(info Error: 'make -jN' is not supported, use 'make JOBS=N') \
120 	    $$(error Cannot continue) \
121 	)
122     .FORCE:
123     .PHONY: .FORCE
124   endef
125 
126   # Check that the CONF_CHECK option is valid and set up handling
127   define ParseConfCheckOption
128     ifeq ($$(CONF_CHECK), )
129       # Default behavior is fail
130       CONF_CHECK := fail
131     else ifneq ($$(filter-out auto fail ignore, $$(CONF_CHECK)),)
132       $$(info Error: CONF_CHECK must be one of: auto, fail or ignore.)
133       $$(error Cannot continue)
134     endif
135   endef
136 
137   define ParseConfAndSpec
138     ifneq ($$(origin SPEC), undefined)
139       # We have been given a SPEC, check that it works out properly
140       ifneq ($$(origin CONF), undefined)
141         # We also have a CONF argument. We can't have both.
142         $$(info Error: Cannot use CONF=$$(CONF) and SPEC=$$(SPEC) at the same time. Choose one.)
143         $$(error Cannot continue)
144       endif
145       ifneq ($$(origin CONF_NAME), undefined)
146         # We also have a CONF_NAME argument. We can't have both.
147         $$(info Error: Cannot use CONF_NAME=$$(CONF_NAME) and SPEC=$$(SPEC) at the same time. Choose one.)
148         $$(error Cannot continue)
149       endif
150       ifeq ($$(wildcard $$(SPEC)),)
151         $$(info Error: Cannot locate spec.gmk, given by SPEC=$$(SPEC).)
152         $$(error Cannot continue)
153       endif
154       ifeq ($$(filter /%, $$(SPEC)),)
155         # If given with relative path, make it absolute
156         SPECS := $$(CURDIR)/$$(strip $$(SPEC))
157       else
158         SPECS := $$(SPEC)
159       endif
160 
161       # For now, unset this SPEC variable.
162       override SPEC :=
163     else
164       # Use spec.gmk files in the build output directory
165       ifeq ($$(all_spec_files),)
166         ifneq ($(CUSTOM_ROOT), )
167           $$(info Error: No configurations found for $$(CUSTOM_ROOT).)
168         else
169           $$(info Error: No configurations found for $$(topdir).)
170         endif
171         $$(info Please run 'bash configure' to create a configuration.)
172         $$(info )
173         $$(error Cannot continue)
174       endif
175 
176       ifneq ($$(origin CONF_NAME), undefined)
177         ifneq ($$(origin CONF), undefined)
178           # We also have a CONF argument. We can't have both.
179           $$(info Error: Cannot use CONF=$$(CONF) and CONF_NAME=$$(CONF_NAME) at the same time. Choose one.)
180           $$(error Cannot continue)
181         endif
182         matching_conf := $$(strip $$(filter $$(CONF_NAME), $$(all_confs)))
183         ifeq ($$(matching_conf),)
184           $$(info Error: No configurations found matching CONF_NAME=$$(CONF_NAME).)
185           $$(info Available configurations in $$(build_dir):)
186           $$(foreach var, $$(all_confs), $$(info * $$(var)))
187           $$(error Cannot continue)
188         else ifneq ($$(words $$(matching_conf)), 1)
189           $$(info Error: Matching more than one configuration CONF_NAME=$$(CONF_NAME).)
190           $$(info Available configurations in $$(build_dir):)
191           $$(foreach var, $$(all_confs), $$(info * $$(var)))
192           $$(error Cannot continue)
193         else
194           $$(info Building configuration '$$(matching_conf)' (matching CONF_NAME=$$(CONF_NAME)))
195         endif
196         # Create a SPEC definition. This will contain the path to exactly one spec file.
197         SPECS := $$(build_dir)/$$(matching_conf)/spec.gmk
198       else ifneq ($$(origin CONF), undefined)
199         # User have given a CONF= argument.
200         ifeq ($$(CONF),)
201           # If given CONF=, match all configurations
202           matching_confs := $$(strip $$(all_confs))
203         else
204           # Otherwise select those that contain the given CONF string
205           matching_confs := $$(strip $$(foreach var, $$(all_confs), \
206               $$(if $$(findstring $$(CONF), $$(var)), $$(var))))
207           ifneq ($$(filter $$(CONF), $$(matching_confs)), )
208             # If we found an exact match, use that
209             matching_confs := $$(CONF)
210             # Don't repeat this output on make restarts caused by including
211             # generated files.
212             ifeq ($$(MAKE_RESTARTS),)
213               $$(info Using exact match for CONF=$$(CONF) (other matches are possible))
214             endif
215           endif
216         endif
217         ifeq ($$(matching_confs),)
218           $$(info Error: No configurations found matching CONF=$$(CONF).)
219           $$(info Available configurations in $$(build_dir):)
220           $$(foreach var, $$(all_confs), $$(info * $$(var)))
221           $$(error Cannot continue)
222         else
223           # Don't repeat this output on make restarts caused by including
224           # generated files.
225           ifeq ($$(MAKE_RESTARTS),)
226             ifeq ($$(words $$(matching_confs)), 1)
227               ifneq ($$(findstring $$(LOG_LEVEL), info debug trace),)
228                 $$(info Building configuration '$$(matching_confs)' (matching CONF=$$(CONF)))
229               endif
230             else
231               $$(info Building these configurations (matching CONF=$$(CONF)):)
232               $$(foreach var, $$(matching_confs), $$(info * $$(var)))
233             endif
234           endif
235         endif
236 
237         # Create a SPEC definition. This will contain the path to one or more spec.gmk files.
238         SPECS := $$(addsuffix /spec.gmk, $$(addprefix $$(build_dir)/, $$(matching_confs)))
239       else
240         # No CONF or SPEC given, check the available configurations
241         ifneq ($$(words $$(all_spec_files)), 1)
242           $$(info Error: No CONF given, but more than one configuration found.)
243           $$(info Available configurations in $$(build_dir):)
244           $$(foreach var, $$(all_confs), $$(info * $$(var)))
245           $$(info Please retry building with CONF=<config pattern> (or SPEC=<spec file>).)
246           $$(info )
247           $$(error Cannot continue)
248         endif
249 
250         # We found exactly one configuration, use it
251         SPECS := $$(strip $$(all_spec_files))
252       endif
253     endif
254   endef
255 
256   # Extract main targets from Main.gmk using the spec provided in $2.
257   #
258   # Param 1: FORCE = force generation of main-targets.gmk or LAZY = do not force.
259   # Param 2: The SPEC file to use.
260   define DefineMainTargets
261 
262     # We will start by making sure the main-targets.gmk file is removed, if
263     # make has not been restarted. By the -include, we will trigger the
264     # rule for generating the file (which is never there since we removed it),
265     # thus generating it fresh, and make will restart, incrementing the restart
266     # count.
267     main_targets_file := $$(dir $(strip $2))make-support/main-targets.gmk
268 
269     ifeq ($$(MAKE_RESTARTS),)
270       # Only do this if make has not been restarted, and if we do not force it.
271       ifeq ($(strip $1), FORCE)
272         $$(shell rm -f $$(main_targets_file))
273       endif
274     endif
275 
276     $$(main_targets_file):
277 	@( cd $$(topdir) && \
278 	$$(MAKE) $$(MAKE_LOG_FLAGS) -r -R -f $$(topdir)/make/Main.gmk \
279 	    -I $$(topdir)/make/common SPEC=$(strip $2) NO_RECIPES=true \
280 	    $$(MAKE_LOG_VARS) \
281 	    create-main-targets-include )
282 
283     # Now include main-targets.gmk. This will define ALL_MAIN_TARGETS.
284     -include $$(main_targets_file)
285   endef
286 
287   define PrintConfCheckFailed
288 	@echo ' '
289 	@echo "Please rerun configure! Easiest way to do this is by running"
290 	@echo "'make reconfigure'."
291 	@echo "This behavior may also be changed using CONF_CHECK=<ignore|auto>."
292 	@echo ' '
293   endef
294 
295 else # $(HAS_SPEC)=true
296   ##############################################################################
297   # Helper functions for the 'main' target. These functions assume a single,
298   # proper and existing SPEC is included.
299   ##############################################################################
300 
301   include $(TOPDIR)/make/common/MakeBase.gmk
302 
303   # Define basic logging setup
304   BUILD_LOG := $(OUTPUTDIR)/build.log
305   BUILD_PROFILE_LOG := $(OUTPUTDIR)/build-profile.log
306 
307   BUILD_LOG_PIPE := > >($(TEE) -a $(BUILD_LOG)) 2> >($(TEE) -a $(BUILD_LOG) >&2) && wait
308   # Use this for simple echo/printf commands that are never expected to print
309   # to stderr.
310   BUILD_LOG_PIPE_SIMPLE := | $(TEE) -a $(BUILD_LOG)
311 
312   ifneq ($(CUSTOM_ROOT), )
313     topdir=$(CUSTOM_ROOT)
314   else
315     topdir=$(TOPDIR)
316   endif
317 
318   # Setup the build environment to match the requested specification on
319   # level of reproducible builds
320   define SetupReproducibleBuild
321     ifeq ($$(SOURCE_DATE), updated)
322       # For static values of SOURCE_DATE (not "updated"), these are set in spec.gmk
323       export SOURCE_DATE_EPOCH := $$(shell $$(DATE) +"%s")
324       export SOURCE_DATE_ISO_8601 := $$(call EpochToISO8601, $$(SOURCE_DATE_EPOCH))
325     endif
326   endef
327 
328   # Parse COMPARE_BUILD into COMPARE_BUILD_*
329   # Syntax: COMPARE_BUILD=CONF=<configure options>:PATCH=<patch file>:
330   #         MAKE=<make targets>:COMP_OPTS=<compare script options>:
331   #         COMP_DIR=<compare script base dir>|<default>:
332   #         FAIL=<bool>
333   # If neither CONF or PATCH is given, assume <default> means CONF if it
334   # begins with "--", otherwise assume it means PATCH.
335   # MAKE and COMP_OPTS can only be used with CONF and/or PATCH specified.
336   # If any value contains "+", it will be replaced by space.
337   # FAIL can be set to false to have the return value of compare be ignored.
338   define ParseCompareBuild
339     ifneq ($$(COMPARE_BUILD), )
340       COMPARE_BUILD_OUTPUTDIR := $(topdir)/build/compare-build/$(CONF_NAME)
341       COMPARE_BUILD_FAIL := true
342 
343       ifneq ($$(findstring :, $$(COMPARE_BUILD)), )
344         $$(foreach part, $$(subst :, , $$(COMPARE_BUILD)), \
345           $$(if $$(filter PATCH=%, $$(part)), \
346             $$(eval COMPARE_BUILD_PATCH=$$(strip $$(patsubst PATCH=%, %, $$(part)))) \
347           ) \
348           $$(if $$(filter CONF=%, $$(part)), \
349             $$(eval COMPARE_BUILD_CONF=$$(strip $$(subst +, , $$(patsubst CONF=%, %, $$(part))))) \
350           ) \
351           $$(if $$(filter MAKE=%, $$(part)), \
352             $$(eval COMPARE_BUILD_MAKE=$$(strip $$(subst +, , $$(patsubst MAKE=%, %, $$(part))))) \
353           ) \
354           $$(if $$(filter COMP_OPTS=%, $$(part)), \
355             $$(eval COMPARE_BUILD_COMP_OPTS=$$(strip $$(subst +, , $$(patsubst COMP_OPTS=%, %, $$(part))))) \
356           ) \
357           $$(if $$(filter COMP_DIR=%, $$(part)), \
358             $$(eval COMPARE_BUILD_COMP_DIR=$$(strip $$(subst +, , $$(patsubst COMP_DIR=%, %, $$(part))))) \
359           ) \
360           $$(if $$(filter FAIL=%, $$(part)), \
361             $$(eval COMPARE_BUILD_FAIL=$$(strip $$(subst +, , $$(patsubst FAIL=%, %, $$(part))))) \
362           ) \
363           $$(if $$(filter NODRYRUN=%, $$(part)), \
364             $$(eval COMPARE_BUILD_NODRYRUN=$$(strip $$(subst +, , $$(patsubst NODRYRUN=%, %, $$(part))))) \
365           ) \
366         )
367       else
368         # Separate handling for single field case, to allow for spaces in values.
369         ifneq ($$(filter PATCH=%, $$(COMPARE_BUILD)), )
370           COMPARE_BUILD_PATCH=$$(strip $$(patsubst PATCH=%, %, $$(COMPARE_BUILD)))
371         else ifneq ($$(filter CONF=%, $$(COMPARE_BUILD)), )
372           COMPARE_BUILD_CONF=$$(strip $$(subst +, , $$(patsubst CONF=%, %, $$(COMPARE_BUILD))))
373         else ifneq ($$(filter --%, $$(COMPARE_BUILD)), )
374           # Assume CONF if value begins with --
375           COMPARE_BUILD_CONF=$$(strip $$(subst +, , $$(COMPARE_BUILD)))
376         else
377           # Otherwise assume patch file
378           COMPARE_BUILD_PATCH=$$(strip $$(COMPARE_BUILD))
379         endif
380       endif
381       ifneq ($$(COMPARE_BUILD_PATCH), )
382         ifneq ($$(wildcard $$(topdir)/$$(COMPARE_BUILD_PATCH)), )
383           # Assume relative path, if file exists
384           COMPARE_BUILD_PATCH := $$(wildcard $$(topdir)/$$(COMPARE_BUILD_PATCH))
385         else ifeq ($$(wildcard $$(COMPARE_BUILD_PATCH)), )
386           $$(error Patch file $$(COMPARE_BUILD_PATCH) does not exist)
387         endif
388         ifneq ($$(COMPARE_BUILD_NODRYRUN), true)
389           PATCH_DRY_RUN := $$(shell cd $$(topdir) && $$(PATCH) --dry-run -p1 < $$(COMPARE_BUILD_PATCH) > /dev/null 2>&1 || $$(ECHO) FAILED)
390           ifeq ($$(PATCH_DRY_RUN), FAILED)
391             $$(error Patch file $$(COMPARE_BUILD_PATCH) does not apply cleanly)
392           endif
393         endif
394       endif
395       ifneq ($$(COMPARE_BUILD_FAIL), true)
396         COMPARE_BUILD_IGNORE_RESULT := || true
397       endif
398     endif
399   endef
400 
401   # Prepare for a comparison rebuild
402   define PrepareCompareBuild
403 	$(ECHO) "Preparing for comparison rebuild"
404         # Apply patch, if any
405 	$(if $(COMPARE_BUILD_PATCH), cd $(topdir) && $(PATCH) -p1 < $(COMPARE_BUILD_PATCH))
406         # Move the first build away temporarily
407 	$(RM) -r $(topdir)/build/.compare-build-temp
408 	$(MKDIR) -p $(topdir)/build/.compare-build-temp
409 	$(MV) $(OUTPUTDIR) $(topdir)/build/.compare-build-temp
410         # Restore an old compare-build, or create a new compare-build directory.
411 	if test -d $(COMPARE_BUILD_OUTPUTDIR); then \
412 	  $(MV) $(COMPARE_BUILD_OUTPUTDIR) $(OUTPUTDIR); \
413 	else \
414 	  $(MKDIR) -p $(OUTPUTDIR); \
415 	fi
416         # Re-run configure with the same arguments (and possibly some additional),
417         # must be done after patching.
418 	( cd $(CONFIGURE_START_DIR) && PATH="$(ORIGINAL_PATH)" \
419 	    $(BASH) $(topdir)/configure $(CONFIGURE_COMMAND_LINE) $(COMPARE_BUILD_CONF))
420   endef
421 
422   # Cleanup after a compare build
423   define CleanupCompareBuild
424         # If running with a COMPARE_BUILD patch, reverse-apply it
425 	$(if $(COMPARE_BUILD_PATCH), cd $(topdir) && $(PATCH) -R -p1 < $(COMPARE_BUILD_PATCH))
426         # Move this build away and restore the original build
427 	$(MKDIR) -p $(topdir)/build/compare-build
428 	$(MV) $(OUTPUTDIR) $(COMPARE_BUILD_OUTPUTDIR)
429 	$(MV) $(topdir)/build/.compare-build-temp/$(CONF_NAME) $(OUTPUTDIR)
430 	$(RM) -r $(topdir)/build/.compare-build-temp
431   endef
432 
433   # Do the actual comparison of two builds
434   define CompareBuildDoComparison
435         # Compare first and second build. Ignore any error code from compare.sh.
436 	$(ECHO) "Comparing between comparison rebuild (this/new) and baseline (other/old)"
437 	$(if $(COMPARE_BUILD_COMP_DIR), \
438 	  +(cd $(COMPARE_BUILD_OUTPUTDIR) && ./compare.sh -vv $(COMPARE_BUILD_COMP_OPTS) \
439 	      -2dirs $(COMPARE_BUILD_OUTPUTDIR)/$(COMPARE_BUILD_COMP_DIR) \
440 	      $(OUTPUTDIR)/$(COMPARE_BUILD_COMP_DIR) $(COMPARE_BUILD_IGNORE_RESULT)), \
441 	  +(cd $(COMPARE_BUILD_OUTPUTDIR) && ./compare.sh -vv $(COMPARE_BUILD_COMP_OPTS) \
442 	      -o $(OUTPUTDIR) $(COMPARE_BUILD_IGNORE_RESULT)) \
443 	)
444   endef
445 
446   define PrintFailureReports
447 	$(if $(filter none, $(LOG_REPORT)), , \
448 	  $(RM) $(MAKESUPPORT_OUTPUTDIR)/failure-summary.log ; \
449 	  $(if $(wildcard $(MAKESUPPORT_OUTPUTDIR)/failure-logs/*.log), \
450 	    ( \
451 	      $(PRINTF) "\n=== Output from failing command(s) repeated here ===\n" ;  \
452 	      $(foreach logfile, $(sort $(wildcard $(MAKESUPPORT_OUTPUTDIR)/failure-logs/*.log)), \
453 	          $(PRINTF) "* For target $(notdir $(basename $(logfile))):\n" ; \
454 	          $(if $(filter all, $(LOG_REPORT)), \
455 	            $(GREP) -v -e "^Note: including file:" <  $(logfile) || true ; \
456 	          , \
457 	            ($(GREP) -v -e "^Note: including file:" <  $(logfile) || true); \
458 	            if test `$(WC) -l < $(logfile)` -gt 15; then \
459 	              $(ECHO) "   ... (rest of output omitted)" ; \
460 	            fi ; \
461 	          ) \
462 	      ) \
463 	      $(PRINTF) "\n* All command lines available in $(MAKESUPPORT_OUTPUTDIR)/failure-logs.\n" ; \
464 	      $(PRINTF) "=== End of repeated output ===\n" ; \
465 	    )  >> $(MAKESUPPORT_OUTPUTDIR)/failure-summary.log  \
466 	  ) \
467 	)
468   endef
469 
470   define PrintBuildLogFailures
471 	$(if $(filter none, $(LOG_REPORT)), , \
472 	  if $(GREP) -q "recipe for target .* failed" $(BUILD_LOG) 2> /dev/null; then  \
473 	    $(PRINTF) "\n=== Make failed targets repeated here ===\n" ; \
474 	    $(GREP) "recipe for target .* failed" $(BUILD_LOG) ; \
475 	    $(PRINTF) "=== End of repeated output ===\n" ; \
476 	    $(PRINTF) "\nHELP: Try searching the build log for the name of the first failed target.\n" ; \
477 	  else \
478 	    $(PRINTF) "\nNo indication of failed target found.\n" ; \
479 	    $(PRINTF) "HELP: Try searching the build log for '] Error'.\n" ; \
480 	  fi >> $(MAKESUPPORT_OUTPUTDIR)/failure-summary.log ; \
481 	  $(CAT) $(MAKESUPPORT_OUTPUTDIR)/failure-summary.log \
482 	)
483   endef
484 
485   define RotateLogFiles
486 	$(RM) $(BUILD_LOG).old 2> /dev/null && \
487 	$(MV) $(BUILD_LOG) $(BUILD_LOG).old 2> /dev/null || true
488 	$(if $(findstring true, $(LOG_PROFILE_TIMES_FILE)), \
489 	  $(RM) $(BUILD_PROFILE_LOG).old 2> /dev/null && \
490 	  $(MV) $(BUILD_PROFILE_LOG) $(BUILD_PROFILE_LOG).old 2> /dev/null || true \
491 	)
492   endef
493 
494   # Failure logs are only supported for "parallel" main targets, not the
495   # (trivial) sequential make targets (such as clean and reconfigure),
496   # since the failure-logs directory creation will conflict with clean.
497   define PrepareFailureLogs
498 	$(RM) -r $(MAKESUPPORT_OUTPUTDIR)/failure-logs 2> /dev/null && \
499 	$(MKDIR) -p $(MAKESUPPORT_OUTPUTDIR)/failure-logs
500 	$(RM) $(MAKESUPPORT_OUTPUTDIR)/exit-with-error 2> /dev/null
501   endef
502 
503   # Remove any javac server logs and port files. This
504   # prevents a new make run to reuse the previous servers.
505   define PrepareJavacServer
506 	$(if $(JAVAC_SERVER_DIR), \
507 	  $(RM) -r $(JAVAC_SERVER_DIR) 2> /dev/null && \
508 	  $(MKDIR) -p $(JAVAC_SERVER_DIR) \
509 	)
510   endef
511 
512   define CleanupJavacServer
513 	[ -f $(JAVAC_SERVER_DIR)/server.port ] && $(ECHO) Stopping javac server && \
514 	    $(TOUCH) $(JAVAC_SERVER_DIR)/server.port.stop; true
515   endef
516 
517   ifeq ($(call isBuildOs, windows), true)
518     # On windows we need to synchronize with the javac server to be able to
519     # move or remove the build output directory. Since we have no proper
520     # synchronization process, wait for a while and hope it helps. This is only
521     # used by build comparisons.
522     define WaitForJavacServerFinish
523 	$(if $(JAVAC_SERVER_DIR), \
524 	  sleep 5\
525 	)
526     endef
527   else
528     define WaitForJavacServerFinish
529     endef
530   endif
531 
532   define StartGlobalTimer
533 	$(RM) -r $(BUILDTIMESDIR) 2> /dev/null && \
534 	$(MKDIR) -p $(BUILDTIMESDIR) && \
535 	$(call RecordStartTime,TOTAL)
536   endef
537 
538   define StopGlobalTimer
539 	$(call RecordEndTime,TOTAL)
540   endef
541 
542   # Find all build_time_* files and print their contents in a list sorted
543   # on the name of the sub repository.
544   define ReportBuildTimes
545 	$(PRINTF) $(LOG_INFO) -- \
546 	    "----- Build times -------\nStart %s\nEnd   %s\n%s\n%s\n-------------------------\n" \
547 	    "`$(CAT) $(BUILDTIMESDIR)/build_time_start_TOTAL_human_readable`" \
548 	    "`$(CAT) $(BUILDTIMESDIR)/build_time_end_TOTAL_human_readable`" \
549 	    "`$(LS) $(BUILDTIMESDIR)/build_time_diff_* | $(GREP) -v _TOTAL | \
550 	    $(XARGS) $(CAT) | $(SORT) -k 2`" \
551 	    "`$(CAT) $(BUILDTIMESDIR)/build_time_diff_TOTAL`" \
552 	    $(BUILD_LOG_PIPE_SIMPLE)
553   endef
554 
555   define ReportProfileTimes
556     $(if $(findstring true, $(LOG_PROFILE_TIMES_LOG)), \
557       [ ! -f $(BUILD_PROFILE_LOG) ] || \
558       { $(ECHO) Begin $(notdir $(BUILD_PROFILE_LOG)) && \
559         $(CAT) $(BUILD_PROFILE_LOG) && \
560         $(ECHO) End $(notdir $(BUILD_PROFILE_LOG)); \
561       } \
562       $(BUILD_LOG_PIPE_SIMPLE)
563     )
564   endef
565 
566 endif # HAS_SPEC
567 
568 # Look for a given option in the LOG variable, and if found, set a variable
569 # and remove the option from the LOG variable
570 # $1: The option to look for
571 # $2: The variable to set to "true" if the option is found
572 define ParseLogOption
573   ifneq ($$(findstring $1, $$(LOG)),)
574     override $2 := true
575     # First try to remove ",<option>" if it exists, otherwise just remove "<option>"
576     LOG_STRIPPED := $$(subst $1,, $$(subst $$(COMMA)$$(strip $1),, $$(LOG)))
577     # We might have ended up with a leading comma. Remove it. Need override
578     # since LOG is set from the command line.
579     override LOG := $$(strip $$(patsubst $$(COMMA)%, %, $$(LOG_STRIPPED)))
580   endif
581 endef
582 
583 # Look for a given option with an assignment in the LOG variable, and if found,
584 # set a variable to that value and remove the option from the LOG variable
585 # $1: The option to look for
586 # $2: The variable to set to the value of the option, if found
587 define ParseLogValue
588   ifneq ($$(findstring $1=, $$(LOG)),)
589     # Make words of out comma-separated list and find the one with opt=val
590     value := $$(strip $$(subst $$(strip $1)=,, $$(filter $$(strip $1)=%, $$(subst $$(COMMA), , $$(LOG)))))
591     override $2 := $$(value)
592     # First try to remove ",<option>" if it exists, otherwise just remove "<option>"
593     LOG_STRIPPED := $$(subst $$(strip $1)=$$(value),, \
594         $$(subst $$(COMMA)$$(strip $1)=$$(value),, $$(LOG)))
595     # We might have ended up with a leading comma. Remove it. Need override
596     # since LOG is set from the command line.
597     override LOG := $$(strip $$(patsubst $$(COMMA)%, %, $$(LOG_STRIPPED)))
598   endif
599 endef
600 
601 
602 define ParseLogLevel
603   # Catch old-style VERBOSE= command lines.
604   ifneq ($$(origin VERBOSE), undefined)
605     $$(info Error: VERBOSE is deprecated. Use LOG=<warn|info|debug|trace> instead.)
606     $$(error Cannot continue)
607   endif
608 
609   # Setup logging according to LOG
610 
611   # If "nofile" is present, do not log to a file
612   $$(eval $$(call ParseLogOption, nofile, LOG_NOFILE))
613 
614   # If "cmdline" is present, print all executes "important" command lines.
615   $$(eval $$(call ParseLogOption, cmdlines, LOG_CMDLINES))
616 
617   # If "report" is present, use non-standard reporting options at build failure.
618   $$(eval $$(call ParseLogValue, report, LOG_REPORT))
619   ifneq ($$(LOG_REPORT), )
620     ifeq ($$(filter $$(LOG_REPORT), none all default), )
621       $$(info Error: LOG=report has invalid value: $$(LOG_REPORT).)
622       $$(info Valid values: LOG=report=<none>|<all>|<default>)
623       $$(error Cannot continue)
624     endif
625   endif
626 
627   # If "profile-to-log" is present, write shell times in build log
628   $$(eval $$(call ParseLogOption, profile-to-log, LOG_PROFILE_TIMES_LOG))
629 
630   # If "profile" is present, write shell times in separate log file
631   # IMPORTANT: $(ParseLogOption profile-to-log) should go first. Otherwise
632   # parsing of 'LOG=debug,profile-to-log,nofile' ends up in the following error:
633   # Error: LOG contains unknown option or log level: debug-to-log.
634   $$(eval $$(call ParseLogOption, profile, LOG_PROFILE_TIMES_FILE))
635 
636   # Treat LOG=profile-to-log as if it were LOG=profile,profile-to-log
637   LOG_PROFILE_TIMES_FILE := $$(firstword $$(LOG_PROFILE_TIMES_FILE) $$(LOG_PROFILE_TIMES_LOG))
638 
639   override LOG_LEVEL := $$(LOG)
640 
641   ifeq ($$(LOG_LEVEL),)
642     # Set LOG to "warn" as default if not set
643     override LOG_LEVEL := warn
644   endif
645 
646   ifeq ($$(LOG_LEVEL), warn)
647     override MAKE_LOG_FLAGS := -s
648   else ifeq ($$(LOG_LEVEL), info)
649     override MAKE_LOG_FLAGS := -s
650   else ifeq ($$(LOG_LEVEL), debug)
651     override MAKE_LOG_FLAGS :=
652   else ifeq ($$(LOG_LEVEL), trace)
653     override MAKE_LOG_FLAGS :=
654   else
655     $$(info Error: LOG contains unknown option or log level: $$(LOG).)
656     $$(info LOG can be <level>[,<opt>[...]] where <opt> is nofile | cmdlines | profile | profile-to-log)
657     $$(info and <level> is warn | info | debug | trace)
658     $$(error Cannot continue)
659   endif
660 endef
661 
662 MAKE_LOG_VARS = $(foreach v, \
663     LOG_LEVEL LOG_NOFILE LOG_CMDLINES LOG_REPORT LOG_PROFILE_TIMES_LOG \
664     LOG_PROFILE_TIMES_FILE, \
665     $v=$($v) \
666 )
667 
668 endif # _INITSUPPORT_GMK