InitSupport.gmk revision 1426:f658baecb743
1# 2# Copyright (c) 2011, 2015, 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 32ifndef _INITSUPPORT_GMK 33_INITSUPPORT_GMK := 1 34 35ifeq ($(HAS_SPEC),) 36 ############################################################################## 37 # Helper functions for the initial part of Init.gmk, before the spec file is 38 # loaded. Most of these functions provide parsing and setting up make options 39 # from the command-line. 40 ############################################################################## 41 42 # Make control variables, handled by Init.gmk 43 INIT_CONTROL_VARIABLES := LOG CONF SPEC JOBS CONF_CHECK 44 45 # All known make control variables 46 MAKE_CONTROL_VARIABLES := $(INIT_CONTROL_VARIABLES) TEST JDK_FILTER 47 48 # Define a simple reverse function. 49 # Should maybe move to MakeBase.gmk, but we can't include that file now. 50 reverse = \ 51 $(if $(strip $(1)), $(call reverse, $(wordlist 2, $(words $(1)), $(1)))) \ 52 $(firstword $(1)) 53 54 # The variable MAKEOVERRIDES contains variable assignments from the command 55 # line, but in reverse order to what the user entered. 56 COMMAND_LINE_VARIABLES := $(subst \#,\ , $(call reverse, $(subst \ ,\#,$(MAKEOVERRIDES)))) 57 58 # A list like FOO="val1" BAR="val2" containing all user-supplied make 59 # variables that we should propagate. 60 USER_MAKE_VARS := $(filter-out $(addsuffix =%, $(INIT_CONTROL_VARIABLES)), \ 61 $(MAKEOVERRIDES)) 62 63 # Setup information about available configurations, if any. 64 build_dir=$(topdir)/build 65 all_spec_files=$(wildcard $(build_dir)/*/spec.gmk) 66 # Extract the configuration names from the path 67 all_confs=$(patsubst %/spec.gmk, %, $(patsubst $(build_dir)/%, %, $(all_spec_files))) 68 69 # Check for unknown command-line variables 70 define CheckControlVariables 71 command_line_variables := $$(strip $$(foreach var, \ 72 $$(subst \ ,_,$$(MAKEOVERRIDES)), \ 73 $$(firstword $$(subst =, , $$(var))))) 74 unknown_command_line_variables := $$(strip \ 75 $$(filter-out $$(MAKE_CONTROL_VARIABLES), $$(command_line_variables))) 76 ifneq ($$(unknown_command_line_variables), ) 77 $$(info Note: Command line contains non-control variables:) 78 $$(foreach var, $$(unknown_command_line_variables), $$(info * $$(var)=$$($$(var)))) 79 $$(info Make sure it is not mistyped, and that you intend to override this variable.) 80 $$(info 'make help' will list known control variables.) 81 $$(info ) 82 endif 83 endef 84 85 # Check for deprecated ALT_ variables 86 define CheckDeprecatedEnvironment 87 defined_alt_variables := $$(filter ALT_%, $$(.VARIABLES)) 88 ifneq ($$(defined_alt_variables), ) 89 $$(info Warning: You have the following ALT_ variables set:) 90 $$(foreach var, $$(defined_alt_variables), $$(info * $$(var)=$$($$(var)))) 91 $$(info ALT_ variables are deprecated, and may result in a failed build.) 92 $$(info Please clean your environment.) 93 $$(info ) 94 endif 95 endef 96 97 # Check for invalid make flags like -j 98 define CheckInvalidMakeFlags 99 # This is a trick to get this rule to execute before any other rules 100 # MAKEFLAGS only indicate -j if read in a recipe (!) 101 $$(topdir)/make/Init.gmk: .FORCE 102 $$(if $$(findstring --jobserver, $$(MAKEFLAGS)), \ 103 $$(info Error: 'make -jN' is not supported, use 'make JOBS=N') \ 104 $$(error Cannot continue) \ 105 ) 106 .FORCE: 107 .PHONY: .FORCE 108 endef 109 110 # Check that the CONF_CHECK option is valid and set up handling 111 define ParseConfCheckOption 112 ifeq ($$(CONF_CHECK), ) 113 # Default behavior is fail 114 CONF_CHECK := fail 115 else ifneq ($$(filter-out auto fail ignore, $$(CONF_CHECK)),) 116 $$(info Error: CONF_CHECK must be one of: auto, fail or ignore.) 117 $$(error Cannot continue) 118 endif 119 endef 120 121 define ParseLogLevel 122 # Catch old-style VERBOSE= command lines. 123 ifneq ($$(origin VERBOSE), undefined) 124 $$(info Error: VERBOSE is deprecated. Use LOG=<warn|info|debug|trace> instead.) 125 $$(error Cannot continue) 126 endif 127 128 # Setup logging according to LOG 129 130 # If the "nofile" argument is given, act on it and strip it away 131 ifneq ($$(findstring nofile, $$(LOG)),) 132 LOG_NOFILE := true 133 # COMMA is defined in spec.gmk, but that is not included yet 134 COMMA := , 135 # First try to remove ",nofile" if it exists, otherwise just remove "nofile" 136 LOG_STRIPPED := $$(subst nofile,, $$(subst $$(COMMA)nofile,, $$(LOG))) 137 # We might have ended up with a leading comma. Remove it 138 LOG_LEVEL := $$(strip $$(patsubst $$(COMMA)%, %, $$(LOG_STRIPPED))) 139 else 140 LOG_LEVEL := $$(LOG) 141 endif 142 143 ifeq ($$(LOG_LEVEL),) 144 # Set LOG to "warn" as default if not set 145 LOG_LEVEL := warn 146 endif 147 148 ifeq ($$(LOG_LEVEL), warn) 149 MAKE_LOG_FLAGS := -s 150 else ifeq ($$(LOG_LEVEL), info) 151 MAKE_LOG_FLAGS := -s 152 else ifeq ($$(LOG_LEVEL), debug) 153 MAKE_LOG_FLAGS := 154 else ifeq ($$(LOG_LEVEL), trace) 155 MAKE_LOG_FLAGS := -d 156 else 157 $$(info Error: LOG must be one of: warn, info, debug or trace.) 158 $$(error Cannot continue) 159 endif 160 endef 161 162 define ParseConfAndSpec 163 ifneq ($$(origin SPEC), undefined) 164 # We have been given a SPEC, check that it works out properly 165 ifneq ($$(origin CONF), undefined) 166 # We also have a CONF argument. We can't have both. 167 $$(info Error: Cannot use CONF=$$(CONF) and SPEC=$$(SPEC) at the same time. Choose one.) 168 $$(error Cannot continue) 169 endif 170 ifeq ($$(wildcard $$(SPEC)),) 171 $$(info Error: Cannot locate spec.gmk, given by SPEC=$$(SPEC).) 172 $$(error Cannot continue) 173 endif 174 ifeq ($$(filter /%, $$(SPEC)),) 175 # If given with relative path, make it absolute 176 SPECS := $$(CURDIR)/$$(strip $$(SPEC)) 177 else 178 SPECS := $$(SPEC) 179 endif 180 181 # For now, unset this SPEC variable. 182 override SPEC := 183 else 184 # Use spec.gmk files in the build output directory 185 ifeq ($$(all_spec_files),) 186 $$(info Error: No configurations found for $$(topdir).) 187 $$(info Please run 'bash configure' to create a configuration.) 188 $$(info ) 189 $$(error Cannot continue) 190 endif 191 192 ifneq ($$(origin CONF), undefined) 193 # User have given a CONF= argument. 194 ifeq ($$(CONF),) 195 # If given CONF=, match all configurations 196 matching_confs := $$(strip $$(all_confs)) 197 else 198 # Otherwise select those that contain the given CONF string 199 matching_confs := $$(strip $$(foreach var, $$(all_confs), \ 200 $$(if $$(findstring $$(CONF), $$(var)), $$(var)))) 201 endif 202 ifeq ($$(matching_confs),) 203 $$(info Error: No configurations found matching CONF=$$(CONF).) 204 $$(info Available configurations in $$(build_dir):) 205 $$(foreach var, $$(all_confs), $$(info * $$(var))) 206 $$(error Cannot continue) 207 else 208 ifeq ($$(words $$(matching_confs)), 1) 209 $$(info Building configuration '$$(matching_confs)' (matching CONF=$$(CONF))) 210 else 211 $$(info Building these configurations (matching CONF=$$(CONF)):) 212 $$(foreach var, $$(matching_confs), $$(info * $$(var))) 213 endif 214 endif 215 216 # Create a SPEC definition. This will contain the path to one or more spec.gmk files. 217 SPECS := $$(addsuffix /spec.gmk, $$(addprefix $$(build_dir)/, $$(matching_confs))) 218 else 219 # No CONF or SPEC given, check the available configurations 220 ifneq ($$(words $$(all_spec_files)), 1) 221 $$(info Error: No CONF given, but more than one configuration found.) 222 $$(info Available configurations in $$(build_dir):) 223 $$(foreach var, $$(all_confs), $$(info * $$(var))) 224 $$(info Please retry building with CONF=<config pattern> (or SPEC=<spec file>).) 225 $$(info ) 226 $$(error Cannot continue) 227 endif 228 229 # We found exactly one configuration, use it 230 SPECS := $$(strip $$(all_spec_files)) 231 endif 232 endif 233 endef 234 235 # Extract main targets from Main.gmk using the spec provided in $2. 236 # 237 # Param 1: FORCE = force generation of main-targets.gmk or LAZY = do not force. 238 # Param 2: The SPEC file to use. 239 define DefineMainTargets 240 241 # We will start by making sure the main-targets.gmk file is removed, if 242 # make has not been restarted. By the -include, we will trigger the 243 # rule for generating the file (which is never there since we removed it), 244 # thus generating it fresh, and make will restart, incrementing the restart 245 # count. 246 main_targets_file := $$(dir $(strip $2))make-support/main-targets.gmk 247 248 ifeq ($$(MAKE_RESTARTS),) 249 # Only do this if make has not been restarted, and if we do not force it. 250 ifeq ($(strip $1), FORCE) 251 $$(shell rm -f $$(main_targets_file)) 252 endif 253 endif 254 255 $$(main_targets_file): 256 @( cd $$(topdir) && \ 257 $$(MAKE) $$(MAKE_LOG_FLAGS) -r -R -f $$(topdir)/make/Main.gmk \ 258 -I $$(topdir)/make/common SPEC=$(strip $2) NO_RECIPES=true \ 259 LOG_LEVEL=$$(LOG_LEVEL) \ 260 create-main-targets-include ) 261 262 # Now include main-targets.gmk. This will define ALL_MAIN_TARGETS. 263 -include $$(main_targets_file) 264 endef 265 266 define PrintConfCheckFailed 267 @echo ' ' 268 @echo "Please rerun configure! Easiest way to do this is by running" 269 @echo "'make reconfigure'." 270 @echo "This behavior may also be changed using CONF_CHECK=<ignore|auto>." 271 @echo ' ' 272 endef 273 274else # $(HAS_SPEC)=true 275 ############################################################################## 276 # Helper functions for the 'main' target. These functions assume a single, 277 # proper and existing SPEC is included. 278 ############################################################################## 279 280 include $(SRC_ROOT)/make/common/MakeBase.gmk 281 282 # Define basic logging setup 283 BUILD_LOG := $(OUTPUT_ROOT)/build.log 284 BUILD_TRACE_LOG := $(OUTPUT_ROOT)/build-trace-time.log 285 286 BUILD_LOG_WRAPPER := $(BASH) $(SRC_ROOT)/common/bin/logger.sh $(BUILD_LOG) 287 288 # Disable the build log wrapper on sjavac+windows until 289 # we have solved how to prevent the log wrapper to wait 290 # for the background sjavac server process. 291 ifeq ($(ENABLE_SJAVAC)X$(OPENJDK_BUILD_OS),yesXwindows) 292 LOG_NOFILE := true 293 endif 294 295 # Sanity check the spec file, so it matches this source code 296 define CheckSpecSanity 297 ifneq ($$(ACTUAL_TOPDIR), $$(TOPDIR)) 298 ifneq ($$(ACTUAL_TOPDIR), $$(ORIGINAL_TOPDIR)) 299 ifneq ($$(ACTUAL_TOPDIR), $$(CANONICAL_TOPDIR)) 300 $$(info Error: SPEC mismatch! Current working directory) 301 $$(info $$(ACTUAL_TOPDIR)) 302 $$(info does not match either TOPDIR, ORIGINAL_TOPDIR or CANONICAL_TOPDIR) 303 $$(info $$(TOPDIR)) 304 $$(info $$(ORIGINAL_TOPDIR)) 305 $$(info $$(CANONICAL_TOPDIR)) 306 $$(error Cannot continue) 307 endif 308 endif 309 endif 310 endef 311 312 define RotateLogFiles 313 $(RM) $(BUILD_LOG).old 2> /dev/null 314 $(MV) $(BUILD_LOG) $(BUILD_LOG).old 2> /dev/null || true 315 $(if $(findstring trace, $(LOG_LEVEL)), \ 316 $(RM) $(BUILD_TRACE_LOG).old 2> /dev/null && \ 317 $(MV) $(BUILD_TRACE_LOG) $(BUILD_TRACE_LOG).old 2> /dev/null || true \ 318 ) 319 endef 320 321 # Remove any javac server logs and port files. This 322 # prevents a new make run to reuse the previous servers. 323 define PrepareSmartJavac 324 $(if $(SJAVAC_SERVER_DIR), \ 325 $(RM) -r $(SJAVAC_SERVER_DIR) 2> /dev/null && \ 326 $(MKDIR) -p $(SJAVAC_SERVER_DIR) \ 327 ) 328 endef 329 330 define CleanupSmartJavac 331 [ -f $(SJAVAC_SERVER_DIR)/server.port ] && $(ECHO) Stopping sjavac server && \ 332 $(TOUCH) $(SJAVAC_SERVER_DIR)/server.port.stop; true 333 endef 334 335 define StartGlobalTimer 336 $(RM) -r $(BUILDTIMESDIR) 2> /dev/null 337 $(MKDIR) -p $(BUILDTIMESDIR) 338 $(call RecordStartTime,TOTAL) 339 endef 340 341 define StopGlobalTimer 342 $(call RecordEndTime,TOTAL) 343 endef 344 345 # Find all build_time_* files and print their contents in a list sorted 346 # on the name of the sub repository. 347 define ReportBuildTimes 348 $(BUILD_LOG_WRAPPER) $(PRINTF) $(LOG_INFO) -- \ 349 "----- Build times -------\nStart %s\nEnd %s\n%s\n%s\n-------------------------\n" \ 350 "`$(CAT) $(BUILDTIMESDIR)/build_time_start_TOTAL_human_readable`" \ 351 "`$(CAT) $(BUILDTIMESDIR)/build_time_end_TOTAL_human_readable`" \ 352 "`$(LS) $(BUILDTIMESDIR)/build_time_diff_* | $(GREP) -v _TOTAL | \ 353 $(XARGS) $(CAT) | $(SORT) -k 2`" \ 354 "`$(CAT) $(BUILDTIMESDIR)/build_time_diff_TOTAL`" 355 endef 356 357endif # HAS_SPEC 358 359endif # _INITSUPPORT_GMK 360