| # |
| # Copyright (c) 2011, 2015, Oracle and/or its affiliates. All rights reserved. |
| # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| # |
| # This code is free software; you can redistribute it and/or modify it |
| # under the terms of the GNU General Public License version 2 only, as |
| # published by the Free Software Foundation. Oracle designates this |
| # particular file as subject to the "Classpath" exception as provided |
| # by Oracle in the LICENSE file that accompanied this code. |
| # |
| # This code is distributed in the hope that it will be useful, but WITHOUT |
| # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| # FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| # version 2 for more details (a copy is included in the LICENSE file that |
| # accompanied this code). |
| # |
| # You should have received a copy of the GNU General Public License version |
| # 2 along with this work; if not, write to the Free Software Foundation, |
| # Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| # |
| # Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| # or visit www.oracle.com if you need additional information or have any |
| # questions. |
| # |
| |
| ################################################################ |
| # |
| # This file contains helper functions for the top-level Makefile that does |
| # not depend on the spec.gmk file having been read. (The purpose of this |
| # file is ju to avoid cluttering the top-level Makefile.) |
| # |
| ################################################################ |
| |
| ifndef _MAKEHELPERS_GMK |
| _MAKEHELPERS_GMK := 1 |
| |
| ############################## |
| # Stuff to run at include time |
| ############################## |
| |
| # Find out which variables were passed explicitely on the make command line. These |
| # will be passed on to sub-makes, overriding spec.gmk settings. |
| MAKE_ARGS=$(foreach var,$(subst =command,,$(filter %=command,$(foreach var,$(.VARIABLES),$(var)=$(firstword $(origin $(var)))))),$(var)="$($(var))") |
| |
| list_alt_overrides_with_origins=$(filter ALT_%=environment ALT_%=command,$(foreach var,$(.VARIABLES),$(var)=$(firstword $(origin $(var))))) |
| list_alt_overrides=$(subst =command,,$(subst =environment,,$(list_alt_overrides_with_origins))) |
| |
| # Store the build times in this directory. |
| BUILDTIMESDIR=$(OUTPUT_ROOT)/make-support/build-times |
| |
| # Global targets are possible to run either with or without a SPEC. The prototypical |
| # global target is "help". |
| global_targets=help |
| |
| ############################## |
| # Functions |
| ############################## |
| |
| define CheckEnvironment |
| # Find all environment or command line variables that begin with ALT. |
| $(if $(list_alt_overrides), |
| @$(PRINTF) "\nWARNING: You have the following ALT_ variables set:\n" |
| @$(PRINTF) "$(foreach var,$(list_alt_overrides),$(var)=$$$(var))\n" |
| @$(PRINTF) "ALT_ variables are deprecated and will be ignored. Please clean your environment.\n\n" |
| ) |
| endef |
| |
| ### Functions for timers |
| |
| # Record starting time for build of a sub repository. |
| define RecordStartTime |
| $(MKDIR) -p $(BUILDTIMESDIR) |
| $(DATE) '+%Y %m %d %H %M %S' | $(NAWK) '{ print $$1,$$2,$$3,$$4,$$5,$$6,($$4*3600+$$5*60+$$6) }' > $(BUILDTIMESDIR)/build_time_start_$1 |
| $(DATE) '+%Y-%m-%d %H:%M:%S' > $(BUILDTIMESDIR)/build_time_start_$1_human_readable |
| endef |
| |
| # Record ending time and calculate the difference and store it in a |
| # easy to read format. Handles builds that cross midnight. Expects |
| # that a build will never take 24 hours or more. |
| define RecordEndTime |
| $(DATE) '+%Y %m %d %H %M %S' | $(NAWK) '{ print $$1,$$2,$$3,$$4,$$5,$$6,($$4*3600+$$5*60+$$6) }' > $(BUILDTIMESDIR)/build_time_end_$1 |
| $(DATE) '+%Y-%m-%d %H:%M:%S' > $(BUILDTIMESDIR)/build_time_end_$1_human_readable |
| $(ECHO) `$(CAT) $(BUILDTIMESDIR)/build_time_start_$1` `$(CAT) $(BUILDTIMESDIR)/build_time_end_$1` $1 | \ |
| $(NAWK) '{ F=$$7; T=$$14; if (F > T) { T+=3600*24 }; D=T-F; H=int(D/3600); \ |
| M=int((D-H*3600)/60); S=D-H*3600-M*60; printf("%02d:%02d:%02d %s\n",H,M,S,$$15); }' \ |
| > $(BUILDTIMESDIR)/build_time_diff_$1 |
| endef |
| |
| # Find all build_time_* files and print their contents in a list sorted |
| # on the name of the sub repository. |
| define ReportBuildTimes |
| $(BUILD_LOG_WRAPPER) $(PRINTF) -- "----- Build times -------\nStart %s\nEnd %s\n%s\n%s\n-------------------------\n" \ |
| "`$(CAT) $(BUILDTIMESDIR)/build_time_start_TOTAL_human_readable`" \ |
| "`$(CAT) $(BUILDTIMESDIR)/build_time_end_TOTAL_human_readable`" \ |
| "`$(LS) $(BUILDTIMESDIR)/build_time_diff_* | $(GREP) -v _TOTAL | $(XARGS) $(CAT) | $(SORT) -k 2`" \ |
| "`$(CAT) $(BUILDTIMESDIR)/build_time_diff_TOTAL`" |
| endef |
| |
| define ResetAllTimers |
| $$(shell $(MKDIR) -p $(BUILDTIMESDIR) && $(RM) $(BUILDTIMESDIR)/build_time_*) |
| endef |
| |
| define StartGlobalTimer |
| $(call RecordStartTime,TOTAL) |
| endef |
| |
| define StopGlobalTimer |
| $(call RecordEndTime,TOTAL) |
| endef |
| |
| ### Functions for managing makefile structure (start/end of makefile and individual targets) |
| |
| # Do not indent this function, this will add whitespace at the start which the caller won't handle |
| define GetRealTarget |
| $(strip $(if $(findstring main-wrapper, $(MAKECMDGOALS)), $(MAIN_TARGETS), \ |
| $(if $(MAKECMDGOALS),$(MAKECMDGOALS),default))) |
| endef |
| |
| # Do not indent this function, this will add whitespace at the start which the caller won't handle |
| define LastGoal |
| $(strip $(lastword $(call GetRealTarget))) |
| endef |
| |
| # Check if the current target is the final target, as specified by |
| # the user on the command line. If so, call AtRootMakeEnd. |
| define CheckIfMakeAtEnd |
| # Check if the current target is the last goal |
| $(if $(filter $@,$(call LastGoal)),$(call AtMakeEnd)) |
| # If the target is 'foo-only', check if our goal was stated as 'foo' |
| $(if $(filter $@,$(call LastGoal)-only),$(call AtMakeEnd)) |
| endef |
| |
| # Hook to be called when starting to execute a top-level target |
| define TargetEnter |
| $(PRINTF) "## Starting $(patsubst %-only,%,$@)\n" |
| $(call RecordStartTime,$(patsubst %-only,%,$@)) |
| endef |
| |
| # Hook to be called when finish executing a top-level target |
| define TargetExit |
| $(call RecordEndTime,$(patsubst %-only,%,$@)) |
| $(PRINTF) "## Finished $(patsubst %-only,%,$@) (build time %s)\n\n" \ |
| "`$(CAT) $(BUILDTIMESDIR)/build_time_diff_$(patsubst %-only,%,$@) | $(CUT) -f 1 -d ' '`" |
| endef |
| |
| # Hook to be called as the very first thing when running a normal build |
| define AtMakeStart |
| $(if $(findstring --jobserver,$(MAKEFLAGS)),$(error make -j is not supported, use make JOBS=n)) |
| $(call CheckEnvironment) |
| $(BUILD_LOG_WRAPPER) $(PRINTF) $(LOG_INFO) "Running make as '$(MAKE) $(MFLAGS) $(MAKE_ARGS)'\n" |
| $(BUILD_LOG_WRAPPER) $(PRINTF) "Building $(PRODUCT_NAME) for target '$(call GetRealTarget)' in configuration '$(CONF_NAME)'\n\n" |
| $(call StartGlobalTimer) |
| endef |
| |
| # Hook to be called as the very last thing for targets that are "top level" targets |
| define AtMakeEnd |
| [ -f $(SJAVAC_SERVER_DIR)/server.port ] && echo Stopping sjavac server && $(TOUCH) $(SJAVAC_SERVER_DIR)/server.port.stop; true |
| $(call StopGlobalTimer) |
| $(call ReportBuildTimes) |
| @$(PRINTF) "\nFinished building $(PRODUCT_NAME) for target '$(call GetRealTarget)'\n" |
| $(call CheckEnvironment) |
| endef |
| |
| ### Functions for parsing and setting up make options from command-line |
| |
| define FatalError |
| # If the user specificed a "global" target (e.g. 'help'), do not exit but continue running |
| $$(if $$(filter-out $(global_targets),$$(call GetRealTarget)),$$(error Cannot continue)) |
| endef |
| |
| define ParseLogLevel |
| ifeq ($$(origin VERBOSE),undefined) |
| # Setup logging according to LOG (but only if VERBOSE is not given) |
| |
| # If the "nofile" argument is given, act on it and strip it away |
| ifneq ($$(findstring nofile,$$(LOG)),) |
| # Reset the build log wrapper, regardless of other values |
| override BUILD_LOG_WRAPPER= |
| # COMMA is defined in spec.gmk, but that is not included yet |
| COMMA=, |
| # First try to remove ",nofile" if it exists |
| LOG_STRIPPED1=$$(subst $$(COMMA)nofile,,$$(LOG)) |
| # Otherwise just remove "nofile" |
| LOG_STRIPPED2=$$(subst nofile,,$$(LOG_STRIPPED1)) |
| # We might have ended up with a leading comma. Remove it |
| LOG_STRIPPED3=$$(strip $$(patsubst $$(COMMA)%,%,$$(LOG_STRIPPED2))) |
| LOG_LEVEL:=$$(LOG_STRIPPED3) |
| else |
| LOG_LEVEL:=$$(LOG) |
| endif |
| |
| ifeq ($$(LOG_LEVEL),) |
| # Set LOG to "warn" as default if not set (and no VERBOSE given) |
| override LOG_LEVEL=warn |
| endif |
| ifeq ($$(LOG_LEVEL),warn) |
| VERBOSE=-s |
| else ifeq ($$(LOG_LEVEL),info) |
| VERBOSE=-s |
| else ifeq ($$(LOG_LEVEL),debug) |
| VERBOSE= |
| else ifeq ($$(LOG_LEVEL),trace) |
| VERBOSE= |
| else |
| $$(info Error: LOG must be one of: warn, info, debug or trace.) |
| $$(eval $$(call FatalError)) |
| endif |
| else |
| # Provide resonable interpretations of LOG_LEVEL if VERBOSE is given. |
| ifeq ($(VERBOSE),) |
| LOG_LEVEL:=debug |
| else |
| LOG_LEVEL:=warn |
| endif |
| ifneq ($$(LOG),) |
| # We have both a VERBOSE and a LOG argument. This is OK only if this is a repeated call by ourselves, |
| # but complain if this is the top-level make call. |
| ifeq ($$(MAKELEVEL),0) |
| $$(info Cannot use LOG=$$(LOG) and VERBOSE=$$(VERBOSE) at the same time. Choose one.) |
| $$(eval $$(call FatalError)) |
| endif |
| endif |
| endif |
| endef |
| |
| define ParseConfAndSpec |
| ifneq ($$(filter-out $(global_targets),$$(call GetRealTarget)),) |
| # If we only have global targets, no need to bother with SPEC or CONF |
| ifneq ($$(origin SPEC),undefined) |
| # We have been given a SPEC, check that it works out properly |
| ifneq ($$(origin CONF),undefined) |
| # We also have a CONF argument. This is OK only if this is a repeated call by ourselves, |
| # but complain if this is the top-level make call. |
| ifeq ($$(MAKELEVEL),0) |
| $$(info Error: Cannot use CONF=$$(CONF) and SPEC=$$(SPEC) at the same time. Choose one.) |
| $$(eval $$(call FatalError)) |
| endif |
| endif |
| ifeq ($$(wildcard $$(SPEC)),) |
| $$(info Error: Cannot locate spec.gmk, given by SPEC=$$(SPEC).) |
| $$(eval $$(call FatalError)) |
| endif |
| # ... OK, we're satisfied, we'll use this SPEC later on |
| else |
| # Find all spec.gmk files in the build output directory |
| output_dir=$$(root_dir)/build |
| all_spec_files=$$(wildcard $$(output_dir)/*/spec.gmk) |
| ifeq ($$(all_spec_files),) |
| $$(info Error: No configurations found for $$(root_dir).) |
| $$(info Please run 'bash configure' to create a configuration.) |
| $$(eval $$(call FatalError)) |
| endif |
| # Extract the configuration names from the path |
| all_confs=$$(patsubst %/spec.gmk,%,$$(patsubst $$(output_dir)/%,%,$$(all_spec_files))) |
| |
| ifneq ($$(origin CONF),undefined) |
| # User have given a CONF= argument. |
| ifeq ($$(CONF),) |
| # If given CONF=, match all configurations |
| matching_confs=$$(strip $$(all_confs)) |
| else |
| # Otherwise select those that contain the given CONF string |
| matching_confs=$$(strip $$(foreach var,$$(all_confs),$$(if $$(findstring $$(CONF),$$(var)),$$(var)))) |
| endif |
| ifeq ($$(matching_confs),) |
| $$(info Error: No configurations found matching CONF=$$(CONF).) |
| $$(info Available configurations in $$(output_dir):) |
| $$(foreach var,$$(all_confs),$$(info * $$(var))) |
| $$(eval $$(call FatalError)) |
| else |
| ifeq ($$(words $$(matching_confs)),1) |
| $$(info Building '$$(matching_confs)' (matching CONF=$$(CONF))) |
| else |
| $$(info Building target '$(call GetRealTarget)' in these configurations (matching CONF=$$(CONF)):) |
| $$(foreach var,$$(matching_confs),$$(info * $$(var))) |
| endif |
| endif |
| |
| # Create a SPEC definition. This will contain the path to one or more spec.gmk files. |
| SPEC=$$(addsuffix /spec.gmk,$$(addprefix $$(output_dir)/,$$(matching_confs))) |
| else |
| # No CONF or SPEC given, check the available configurations |
| ifneq ($$(words $$(all_spec_files)),1) |
| $$(info Error: No CONF given, but more than one configuration found.) |
| $$(info Available configurations in $$(output_dir):) |
| $$(foreach var,$$(all_confs),$$(info * $$(var))) |
| $$(info Please retry building with CONF=<config pattern> (or SPEC=<specfile>).) |
| $$(eval $$(call FatalError)) |
| endif |
| |
| # We found exactly one configuration, use it |
| SPEC=$$(strip $$(all_spec_files)) |
| endif |
| endif |
| endif |
| endef |
| |
| ### Convenience functions from Main.gmk |
| |
| # Run the tests specified by $1. |
| define RunTests |
| ($(CD) $(SRC_ROOT)/test && $(MAKE) $(MAKE_ARGS) -j1 -k MAKEFLAGS= \ |
| JT_HOME=$(JT_HOME) PRODUCT_HOME=$(JDK_IMAGE_DIR) \ |
| TEST_IMAGE_DIR=$(TEST_IMAGE_DIR) \ |
| ALT_OUTPUTDIR=$(OUTPUT_ROOT) CONCURRENCY=$(JOBS) $1) || true |
| endef |
| |
| # Cleans the dir given as $1 |
| define CleanDir |
| @$(PRINTF) "Cleaning $(strip $1) build artifacts ..." |
| @($(CD) $(OUTPUT_ROOT) && $(RM) -r $1) |
| @$(PRINTF) " done\n" |
| endef |
| |
| define CleanTest |
| @$(PRINTF) "Cleaning test $(strip $1) ..." |
| @$(RM) -r $(SUPPORT_OUTPUTDIR)/test/$(strip $(subst -,/,$1)) |
| @$(PRINTF) " done\n" |
| endef |
| |
| define Clean-gensrc |
| @$(PRINTF) "Cleaning gensrc $(if $1,for $(strip $1) )..." |
| @$(RM) -r $(SUPPORT_OUTPUTDIR)/gensrc/$(strip $1) |
| @$(RM) -r $(SUPPORT_OUTPUTDIR)/gensrc_no_docs/$(strip $1) |
| @$(PRINTF) " done\n" |
| endef |
| |
| define Clean-java |
| @$(PRINTF) "Cleaning java $(if $1,for $(strip $1) )..." |
| @$(RM) -r $(JDK_OUTPUTDIR)/modules/$(strip $1) |
| @$(RM) -r $(SUPPORT_OUTPUTDIR)/misc/$(strip $1) |
| @$(PRINTF) " done\n" |
| @$(PRINTF) "Cleaning headers $(if $1,for $(strip $1)) ..." |
| @$(RM) -r $(SUPPORT_OUTPUTDIR)/headers/$(strip $1) |
| @$(PRINTF) " done\n" |
| endef |
| |
| define Clean-native |
| @$(PRINTF) "Cleaning native $(if $1,for $(strip $1) )..." |
| @$(RM) -r $(SUPPORT_OUTPUTDIR)/native/$(strip $1) |
| @$(RM) -r $(SUPPORT_OUTPUTDIR)/modules_libs/$(strip $1) |
| @$(RM) -r $(SUPPORT_OUTPUTDIR)/modules_libs-stripped/$(strip $1) |
| @$(RM) -r $(SUPPORT_OUTPUTDIR)/modules_cmds/$(strip $1) |
| @$(RM) -r $(SUPPORT_OUTPUTDIR)/modules_cmds-stripped/$(strip $1) |
| @$(PRINTF) " done\n" |
| endef |
| |
| define Clean-include |
| @$(PRINTF) "Cleaning include $(if $1,for $(strip $1) )..." |
| @$(RM) -r $(SUPPORT_OUTPUTDIR)/modules_include/$(strip $1) |
| @$(PRINTF) " done\n" |
| endef |
| |
| define CleanModule |
| $(call Clean-gensrc, $1) |
| $(call Clean-java, $1) |
| $(call Clean-native, $1) |
| $(call Clean-include, $1) |
| endef |
| |
| |
| ################################################################################ |
| |
| MAKE_TOPDIR_LIST := $(JDK_TOPDIR) $(CORBA_TOPDIR) $(LANGTOOLS_TOPDIR) |
| MAKE_MAKEDIR_LIST := make |
| |
| # Helper macro for DeclareRecipesForPhase |
| # Declare a recipe for calling the module and phase specific makefile. |
| # If there are multiple makefiles to call, create a rule for each topdir |
| # that contains a makefile with the target $module-$suffix-$repodir, |
| # (i.e: java.base-gensrc-jdk) |
| # Normally there is only one makefile, and the target will just be |
| # $module-$suffix |
| # Param 1: Name of list to add targets to |
| # Param 2: Module name |
| # Param 3: Topdir |
| define DeclareRecipeForModuleMakefile |
| ifeq ($$($1_MULTIPLE_MAKEFILES), true) |
| $2-$$($1_TARGET_SUFFIX): $2-$$($1_TARGET_SUFFIX)-$$(notdir $3) |
| $1 += $2-$$($1_TARGET_SUFFIX)-$$(notdir $3) |
| |
| $2-$$($1_TARGET_SUFFIX)-$$(notdir $3): |
| else |
| $2-$$($1_TARGET_SUFFIX): |
| endif |
| $(ECHO) $(LOG_INFO) "Building $$@" |
| ifeq ($$($1_USE_WRAPPER), true) |
| +($(CD) $(SRC_ROOT)/make && $(MAKE) $(MAKE_ARGS) \ |
| -f ModuleWrapper.gmk \ |
| $$(addprefix -I, $$(wildcard $$(addprefix $3/, $(MAKE_MAKEDIR_LIST)) \ |
| $$(addsuffix /$$($1_MAKE_SUBDIR), $$(addprefix $3/, $(MAKE_MAKEDIR_LIST))))) \ |
| MODULE=$2 MAKEFILE_PREFIX=$$($1_FILE_PREFIX)) |
| else |
| +($(CD) $$(dir $$(firstword $$(wildcard $$(patsubst %, \ |
| $3/%/$$($1_MAKE_SUBDIR)/$$($1_FILE_PREFIX)-$2.gmk, $(MAKE_MAKEDIR_LIST))))) \ |
| && $(MAKE) $(MAKE_ARGS) \ |
| -f $$($1_FILE_PREFIX)-$2.gmk \ |
| $$(addprefix -I, $$(wildcard $$(addprefix $3/, $(MAKE_MAKEDIR_LIST)) \ |
| $$(addsuffix /$$($1_MAKE_SUBDIR), $$(addprefix $3/, $(MAKE_MAKEDIR_LIST))))) \ |
| MODULE=$2) |
| endif |
| |
| endef |
| |
| # Helper macro for DeclareRecipesForPhase |
| # Param 1: Name of list to add targets to |
| # Param 2: Module name |
| define DeclareRecipesForPhaseAndModule |
| $1_$2_TOPDIRS := $$(strip $$(sort $$(foreach d, $(MAKE_TOPDIR_LIST), \ |
| $$(patsubst $$d/%, $$d, $$(filter $$d/%, \ |
| $$(wildcard $$(patsubst %, %/$$($1_MAKE_SUBDIR)/$$($1_FILE_PREFIX)-$2.gmk, \ |
| $$(foreach s, $(MAKE_MAKEDIR_LIST), \ |
| $$(addsuffix /$$s, $(MAKE_TOPDIR_LIST)))))))))) |
| |
| # Only declare recipes if there are makefiles to call |
| ifneq ($$($1_$2_TOPDIRS), ) |
| $$(foreach d, $$($1_$2_TOPDIRS), \ |
| $$(eval $$(call DeclareRecipeForModuleMakefile,$1,$2,$$d))) |
| $1 += $2-$$($1_TARGET_SUFFIX) |
| $1_MODULES += $2 |
| endif |
| endef |
| |
| # Declare recipes for a specific module and build phase if there are makefiles |
| # present for the specific combination. |
| # Param 1: Name of list to add targets to |
| # Named params: |
| # TARGET_SUFFIX : Suffix of target to create for recipe |
| # MAKE_SUBDIR : Subdir for this build phase |
| # FILE_PREFIX : File prefix for this build phase |
| # USE_WRAPPER : Set to true to use ModuleWrapper.gmk |
| # CHECK_MODULES : List of modules to try |
| # MULTIPLE_MAKEFILES : Set to true to handle makefils for the same module in |
| # phase in multiple repos |
| # Exported variables: |
| # $1_MODULES : All modules that had rules generated |
| # $1_TARGETS : All targets generated |
| define DeclareRecipesForPhase |
| $(foreach i,2 3 4 5 6 7, $(if $($i),$(strip $1)_$(strip $($i)))$(NEWLINE)) |
| $(if $(8),$(error Internal makefile error: Too many arguments to \ |
| DeclareRecipesForPhase, please update MakeHelper.gmk)) |
| |
| $$(foreach m, $$($(strip $1)_CHECK_MODULES), \ |
| $$(eval $$(call DeclareRecipesForPhaseAndModule,$(strip $1),$$m))) |
| |
| $(strip $1)_TARGETS := $$($(strip $1)) |
| endef |
| |
| ################################################################################ |
| |
| endif # _MAKEHELPERS_GMK |
