aoqi@0: # aoqi@0: # Copyright (c) 2011, 2012, Oracle and/or its affiliates. All rights reserved. aoqi@0: # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. aoqi@0: # aoqi@0: # This code is free software; you can redistribute it and/or modify it aoqi@0: # under the terms of the GNU General Public License version 2 only, as aoqi@0: # published by the Free Software Foundation. Oracle designates this aoqi@0: # particular file as subject to the "Classpath" exception as provided aoqi@0: # by Oracle in the LICENSE file that accompanied this code. aoqi@0: # aoqi@0: # This code is distributed in the hope that it will be useful, but WITHOUT aoqi@0: # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or aoqi@0: # FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License aoqi@0: # version 2 for more details (a copy is included in the LICENSE file that aoqi@0: # accompanied this code). aoqi@0: # aoqi@0: # You should have received a copy of the GNU General Public License version aoqi@0: # 2 along with this work; if not, write to the Free Software Foundation, aoqi@0: # Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. aoqi@0: # aoqi@0: # Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA aoqi@0: # or visit www.oracle.com if you need additional information or have any aoqi@0: # questions. aoqi@0: # aoqi@0: aoqi@0: ################################################################ aoqi@0: # aoqi@0: # This file contains helper functions for the top-level Makefile that does aoqi@0: # not depend on the spec.gmk file having been read. (The purpose of this aoqi@0: # file is ju to avoid cluttering the top-level Makefile.) aoqi@0: # aoqi@0: ################################################################ aoqi@0: aoqi@0: ifndef _MAKEHELPERS_GMK aoqi@0: _MAKEHELPERS_GMK := 1 aoqi@0: aoqi@0: ############################## aoqi@0: # Stuff to run at include time aoqi@0: ############################## aoqi@0: aoqi@0: # Find out which variables were passed explicitely on the make command line. These aoqi@0: # will be passed on to sub-makes, overriding spec.gmk settings. aoqi@0: MAKE_ARGS=$(foreach var,$(subst =command,,$(filter %=command,$(foreach var,$(.VARIABLES),$(var)=$(firstword $(origin $(var)))))),$(var)=$($(var))) aoqi@0: aoqi@0: list_alt_overrides_with_origins=$(filter ALT_%=environment ALT_%=command,$(foreach var,$(.VARIABLES),$(var)=$(firstword $(origin $(var))))) aoqi@0: list_alt_overrides=$(subst =command,,$(subst =environment,,$(list_alt_overrides_with_origins))) aoqi@0: aoqi@0: # Store the build times in this directory. aoqi@0: BUILDTIMESDIR=$(OUTPUT_ROOT)/tmp/buildtimes aoqi@0: aoqi@0: # Global targets are possible to run either with or without a SPEC. The prototypical aoqi@0: # global target is "help". aoqi@0: global_targets=help jprt% bridgeBuild bridge2configure aoqi@0: aoqi@0: ############################## aoqi@0: # Functions aoqi@0: ############################## aoqi@0: aoqi@0: define CheckEnvironment aoqi@0: # Find all environment or command line variables that begin with ALT. aoqi@0: $(if $(list_alt_overrides), aoqi@0: @$(PRINTF) "\nWARNING: You have the following ALT_ variables set:\n" aoqi@0: @$(PRINTF) "$(foreach var,$(list_alt_overrides),$(var)=$$$(var))\n" aoqi@0: @$(PRINTF) "ALT_ variables are deprecated and will be ignored. Please clean your environment.\n\n" aoqi@0: ) aoqi@0: endef aoqi@0: aoqi@0: ### Functions for timers aoqi@0: aoqi@0: # Record starting time for build of a sub repository. aoqi@0: define RecordStartTime aoqi@0: $(MKDIR) -p $(BUILDTIMESDIR) aoqi@0: $(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 aoqi@0: $(DATE) '+%Y-%m-%d %H:%M:%S' > $(BUILDTIMESDIR)/build_time_start_$1_human_readable aoqi@0: endef aoqi@0: aoqi@0: # Record ending time and calculate the difference and store it in a aoqi@0: # easy to read format. Handles builds that cross midnight. Expects aoqi@0: # that a build will never take 24 hours or more. aoqi@0: define RecordEndTime aoqi@0: $(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 aoqi@0: $(DATE) '+%Y-%m-%d %H:%M:%S' > $(BUILDTIMESDIR)/build_time_end_$1_human_readable aoqi@0: $(ECHO) `$(CAT) $(BUILDTIMESDIR)/build_time_start_$1` `$(CAT) $(BUILDTIMESDIR)/build_time_end_$1` $1 | \ aoqi@0: $(NAWK) '{ F=$$7; T=$$14; if (F > T) { T+=3600*24 }; D=T-F; H=int(D/3600); \ aoqi@0: M=int((D-H*3600)/60); S=D-H*3600-M*60; printf("%02d:%02d:%02d %s\n",H,M,S,$$15); }' \ aoqi@0: > $(BUILDTIMESDIR)/build_time_diff_$1 aoqi@0: endef aoqi@0: aoqi@0: # Find all build_time_* files and print their contents in a list sorted aoqi@0: # on the name of the sub repository. aoqi@0: define ReportBuildTimes aoqi@0: $(BUILD_LOG_WRAPPER) $(PRINTF) -- "----- Build times -------\nStart %s\nEnd %s\n%s\n%s\n-------------------------\n" \ aoqi@0: "`$(CAT) $(BUILDTIMESDIR)/build_time_start_TOTAL_human_readable`" \ aoqi@0: "`$(CAT) $(BUILDTIMESDIR)/build_time_end_TOTAL_human_readable`" \ aoqi@0: "`$(LS) $(BUILDTIMESDIR)/build_time_diff_* | $(GREP) -v _TOTAL | $(XARGS) $(CAT) | $(SORT) -k 2`" \ aoqi@0: "`$(CAT) $(BUILDTIMESDIR)/build_time_diff_TOTAL`" aoqi@0: endef aoqi@0: aoqi@0: define ResetAllTimers aoqi@0: $$(shell $(MKDIR) -p $(BUILDTIMESDIR) && $(RM) $(BUILDTIMESDIR)/build_time_*) aoqi@0: endef aoqi@0: aoqi@0: define StartGlobalTimer aoqi@0: $(call RecordStartTime,TOTAL) aoqi@0: endef aoqi@0: aoqi@0: define StopGlobalTimer aoqi@0: $(call RecordEndTime,TOTAL) aoqi@0: endef aoqi@0: aoqi@0: ### Functions for managing makefile structure (start/end of makefile and individual targets) aoqi@0: aoqi@0: # Do not indent this function, this will add whitespace at the start which the caller won't handle aoqi@0: define GetRealTarget aoqi@0: $(strip $(if $(MAKECMDGOALS),$(MAKECMDGOALS),default)) aoqi@0: endef aoqi@0: aoqi@0: # Do not indent this function, this will add whitespace at the start which the caller won't handle aoqi@0: define LastGoal aoqi@0: $(strip $(lastword $(call GetRealTarget))) aoqi@0: endef aoqi@0: aoqi@0: # Check if the current target is the final target, as specified by aoqi@0: # the user on the command line. If so, call AtRootMakeEnd. aoqi@0: define CheckIfMakeAtEnd aoqi@0: # Check if the current target is the last goal aoqi@0: $(if $(filter $@,$(call LastGoal)),$(call AtMakeEnd)) aoqi@0: # If the target is 'foo-only', check if our goal was stated as 'foo' aoqi@0: $(if $(filter $@,$(call LastGoal)-only),$(call AtMakeEnd)) aoqi@0: endef aoqi@0: aoqi@0: # Hook to be called when starting to execute a top-level target aoqi@0: define TargetEnter aoqi@0: $(BUILD_LOG_WRAPPER) $(PRINTF) "## Starting $(patsubst %-only,%,$@)\n" aoqi@0: $(call RecordStartTime,$(patsubst %-only,%,$@)) aoqi@0: endef aoqi@0: aoqi@0: # Hook to be called when finish executing a top-level target aoqi@0: define TargetExit aoqi@0: $(call RecordEndTime,$(patsubst %-only,%,$@)) aoqi@0: $(BUILD_LOG_WRAPPER) $(PRINTF) "## Finished $(patsubst %-only,%,$@) (build time %s)\n\n" \ aoqi@0: "`$(CAT) $(BUILDTIMESDIR)/build_time_diff_$(patsubst %-only,%,$@) | $(CUT) -f 1 -d ' '`" aoqi@0: $(call CheckIfMakeAtEnd) aoqi@0: endef aoqi@0: aoqi@0: # Hook to be called as the very first thing when running a normal build aoqi@0: define AtMakeStart aoqi@0: $(if $(findstring --jobserver,$(MAKEFLAGS)),$(error make -j is not supported, use make JOBS=n)) aoqi@0: $(call CheckEnvironment) aoqi@0: @$(PRINTF) $(LOG_INFO) "Running make as '$(MAKE) $(MFLAGS) $(MAKE_ARGS)'\n" aoqi@0: @$(PRINTF) "Building $(PRODUCT_NAME) for target '$(call GetRealTarget)' in configuration '$(CONF_NAME)'\n\n" aoqi@0: $(call StartGlobalTimer) aoqi@0: endef aoqi@0: aoqi@0: # Hook to be called as the very last thing for targets that are "top level" targets aoqi@0: define AtMakeEnd aoqi@0: [ -f $(SJAVAC_SERVER_DIR)/server.port ] && echo Stopping sjavac server && $(TOUCH) $(SJAVAC_SERVER_DIR)/server.port.stop; true aoqi@0: $(call StopGlobalTimer) aoqi@0: $(call ReportBuildTimes) aoqi@0: @$(PRINTF) "Finished building $(PRODUCT_NAME) for target '$(call GetRealTarget)'\n" aoqi@0: $(call CheckEnvironment) aoqi@0: endef aoqi@0: aoqi@0: ### Functions for parsing and setting up make options from command-line aoqi@0: aoqi@0: define FatalError aoqi@0: # If the user specificed a "global" target (e.g. 'help'), do not exit but continue running aoqi@0: $$(if $$(filter-out $(global_targets),$$(call GetRealTarget)),$$(error Cannot continue)) aoqi@0: endef aoqi@0: aoqi@0: define ParseLogLevel aoqi@0: ifeq ($$(origin VERBOSE),undefined) aoqi@0: # Setup logging according to LOG (but only if VERBOSE is not given) aoqi@0: aoqi@0: # If the "nofile" argument is given, act on it and strip it away aoqi@0: ifneq ($$(findstring nofile,$$(LOG)),) aoqi@0: # Reset the build log wrapper, regardless of other values aoqi@0: override BUILD_LOG_WRAPPER= aoqi@0: # COMMA is defined in spec.gmk, but that is not included yet aoqi@0: COMMA=, aoqi@0: # First try to remove ",nofile" if it exists aoqi@0: LOG_STRIPPED1=$$(subst $$(COMMA)nofile,,$$(LOG)) aoqi@0: # Otherwise just remove "nofile" aoqi@0: LOG_STRIPPED2=$$(subst nofile,,$$(LOG_STRIPPED1)) aoqi@0: # We might have ended up with a leading comma. Remove it aoqi@0: LOG_STRIPPED3=$$(strip $$(patsubst $$(COMMA)%,%,$$(LOG_STRIPPED2))) aoqi@0: LOG_LEVEL:=$$(LOG_STRIPPED3) aoqi@0: else aoqi@0: LOG_LEVEL:=$$(LOG) aoqi@0: endif aoqi@0: aoqi@0: ifeq ($$(LOG_LEVEL),) aoqi@0: # Set LOG to "warn" as default if not set (and no VERBOSE given) aoqi@0: override LOG_LEVEL=warn aoqi@0: endif aoqi@0: ifeq ($$(LOG_LEVEL),warn) aoqi@0: VERBOSE=-s aoqi@0: else ifeq ($$(LOG_LEVEL),info) aoqi@0: VERBOSE=-s aoqi@0: else ifeq ($$(LOG_LEVEL),debug) aoqi@0: VERBOSE= aoqi@0: else ifeq ($$(LOG_LEVEL),trace) aoqi@0: VERBOSE= aoqi@0: else aoqi@0: $$(info Error: LOG must be one of: warn, info, debug or trace.) aoqi@0: $$(eval $$(call FatalError)) aoqi@0: endif aoqi@0: else aoqi@0: # Provide resonable interpretations of LOG_LEVEL if VERBOSE is given. aoqi@0: ifeq ($(VERBOSE),) aoqi@0: LOG_LEVEL:=debug aoqi@0: else aoqi@0: LOG_LEVEL:=warn aoqi@0: endif aoqi@0: ifneq ($$(LOG),) aoqi@0: # We have both a VERBOSE and a LOG argument. This is OK only if this is a repeated call by ourselves, aoqi@0: # but complain if this is the top-level make call. aoqi@0: ifeq ($$(MAKELEVEL),0) aoqi@0: $$(info Cannot use LOG=$$(LOG) and VERBOSE=$$(VERBOSE) at the same time. Choose one.) aoqi@0: $$(eval $$(call FatalError)) aoqi@0: endif aoqi@0: endif aoqi@0: endif aoqi@0: endef aoqi@0: aoqi@0: define ParseConfAndSpec aoqi@0: ifneq ($$(filter-out $(global_targets),$$(call GetRealTarget)),) aoqi@0: # If we only have global targets, no need to bother with SPEC or CONF aoqi@0: ifneq ($$(origin SPEC),undefined) aoqi@0: # We have been given a SPEC, check that it works out properly aoqi@0: ifeq ($$(wildcard $$(SPEC)),) aoqi@0: $$(info Cannot locate spec.gmk, given by SPEC=$$(SPEC)) aoqi@0: $$(eval $$(call FatalError)) aoqi@0: endif aoqi@0: ifneq ($$(origin CONF),undefined) aoqi@0: # We also have a CONF argument. This is OK only if this is a repeated call by ourselves, aoqi@0: # but complain if this is the top-level make call. aoqi@0: ifeq ($$(MAKELEVEL),0) aoqi@0: $$(info Cannot use CONF=$$(CONF) and SPEC=$$(SPEC) at the same time. Choose one.) aoqi@0: $$(eval $$(call FatalError)) aoqi@0: endif aoqi@0: endif aoqi@0: # ... OK, we're satisfied, we'll use this SPEC later on aoqi@0: else aoqi@0: # Find all spec.gmk files in the build output directory aoqi@0: output_dir=$$(root_dir)/build aoqi@0: all_spec_files=$$(wildcard $$(output_dir)/*/spec.gmk) aoqi@0: ifeq ($$(all_spec_files),) aoqi@0: $$(info No configurations found for $$(root_dir)! Please run configure to create a configuration.) aoqi@0: $$(eval $$(call FatalError)) aoqi@0: endif aoqi@0: # Extract the configuration names from the path aoqi@0: all_confs=$$(patsubst %/spec.gmk,%,$$(patsubst $$(output_dir)/%,%,$$(all_spec_files))) aoqi@0: aoqi@0: ifneq ($$(origin CONF),undefined) aoqi@0: # User have given a CONF= argument. aoqi@0: ifeq ($$(CONF),) aoqi@0: # If given CONF=, match all configurations aoqi@0: matching_confs=$$(strip $$(all_confs)) aoqi@0: else aoqi@0: # Otherwise select those that contain the given CONF string aoqi@0: matching_confs=$$(strip $$(foreach var,$$(all_confs),$$(if $$(findstring $$(CONF),$$(var)),$$(var)))) aoqi@0: endif aoqi@0: ifeq ($$(matching_confs),) aoqi@0: $$(info No configurations found matching CONF=$$(CONF)) aoqi@0: $$(info Available configurations:) aoqi@0: $$(foreach var,$$(all_confs),$$(info * $$(var))) aoqi@0: $$(eval $$(call FatalError)) aoqi@0: else aoqi@0: ifeq ($$(words $$(matching_confs)),1) aoqi@0: $$(info Building '$$(matching_confs)' (matching CONF=$$(CONF))) aoqi@0: else aoqi@0: $$(info Building target '$(call GetRealTarget)' in the following configurations (matching CONF=$$(CONF)):) aoqi@0: $$(foreach var,$$(matching_confs),$$(info * $$(var))) aoqi@0: endif aoqi@0: endif aoqi@0: aoqi@0: # Create a SPEC definition. This will contain the path to one or more spec.gmk files. aoqi@0: SPEC=$$(addsuffix /spec.gmk,$$(addprefix $$(output_dir)/,$$(matching_confs))) aoqi@0: else aoqi@0: # No CONF or SPEC given, check the available configurations aoqi@0: ifneq ($$(words $$(all_spec_files)),1) aoqi@0: $$(info No CONF given, but more than one configuration found in $$(output_dir).) aoqi@0: $$(info Available configurations:) aoqi@0: $$(foreach var,$$(all_confs),$$(info * $$(var))) aoqi@0: $$(info Please retry building with CONF= (or SPEC=)) aoqi@0: $$(eval $$(call FatalError)) aoqi@0: endif aoqi@0: aoqi@0: # We found exactly one configuration, use it aoqi@0: SPEC=$$(strip $$(all_spec_files)) aoqi@0: endif aoqi@0: endif aoqi@0: endif aoqi@0: endef aoqi@0: aoqi@0: ### Convenience functions from Main.gmk aoqi@0: aoqi@0: # Cleans the component given as $1 aoqi@0: define CleanComponent aoqi@0: @$(PRINTF) "Cleaning $1 build artifacts ..." aoqi@0: @($(CD) $(OUTPUT_ROOT) && $(RM) -r $1) aoqi@0: @$(PRINTF) " done\n" aoqi@0: endef aoqi@0: aoqi@0: endif # _MAKEHELPERS_GMK