InitSupport.gmk revision 1411:f077ae77feb1 
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
35# Setup information about available configurations, if any.
36build_dir=$(topdir)/build
37all_spec_files=$(wildcard $(build_dir)/*/spec.gmk)
38# Extract the configuration names from the path
39all_confs=$(patsubst %/spec.gmk, %, $(patsubst $(build_dir)/%, %, $(all_spec_files)))
40any_spec_file=$(firstword $(all_spec_files))
41
42ifeq ($(HAS_SPEC),)
43  ##############################################################################
44  # Helper functions for the initial part of Init.gmk, before the spec file is
45  # loaded. Most of these functions provide parsing and setting up make options
46  # from the command-line.
47  ##############################################################################
48
49  # Make control variables, handled by Init.gmk
50  INIT_CONTROL_VARIABLES := LOG CONF SPEC JOBS CONF_CHECK
51
52  # All known make control variables
53  MAKE_CONTROL_VARIABLES := $(INIT_CONTROL_VARIABLES) TEST JDK_FILTER
54
55  # Define a simple reverse function.
56  # Should maybe move to MakeBase.gmk, but we can't include that file now.
57  reverse = \
58      $(if $(strip $(1)), $(call reverse, $(wordlist 2, $(words $(1)), $(1)))) \
59          $(firstword $(1))
60
61  # The variable MAKEOVERRIDES contains variable assignments from the command
62  # line, but in reverse order to what the user entered.
63  COMMAND_LINE_VARIABLES := $(subst \#,\ , $(call reverse, $(subst \ ,\#,$(MAKEOVERRIDES))))
64
65  # A list like FOO="val1" BAR="val2" containing all user-supplied make variables
66  # that we should propagate.
67  USER_MAKE_VARS := $(filter-out $(addsuffix =%, $(INIT_CONTROL_VARIABLES)), \
68      $(MAKEOVERRIDES))
69
70  # Check for unknown command-line variables
71  define CheckControlVariables
72    command_line_variables := $$(strip $$(foreach var, \
73        $$(subst \ ,_,$$(MAKEOVERRIDES)), \
74        $$(firstword $$(subst =, , $$(var)))))
75    unknown_command_line_variables := $$(strip $$(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 ($$(any_spec_file),)
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), $$(if $$(findstring $$(CONF), $$(var)), $$(var))))
200        endif
201        ifeq ($$(matching_confs),)
202          $$(info Error: No configurations found matching CONF=$$(CONF).)
203          $$(info Available configurations in $$(build_dir):)
204          $$(foreach var, $$(all_confs), $$(info * $$(var)))
205          $$(error Cannot continue)
206        else
207          ifeq ($$(words $$(matching_confs)), 1)
208            $$(info Building configuration '$$(matching_confs)' (matching CONF=$$(CONF)))
209          else
210            $$(info Building these configurations (matching CONF=$$(CONF)):)
211            $$(foreach var, $$(matching_confs), $$(info * $$(var)))
212          endif
213        endif
214
215        # Create a SPEC definition. This will contain the path to one or more spec.gmk files.
216        SPECS := $$(addsuffix /spec.gmk, $$(addprefix $$(build_dir)/, $$(matching_confs)))
217      else
218        # No CONF or SPEC given, check the available configurations
219        ifneq ($$(words $$(all_spec_files)), 1)
220          $$(info Error: No CONF given, but more than one configuration found.)
221          $$(info Available configurations in $$(build_dir):)
222          $$(foreach var, $$(all_confs), $$(info * $$(var)))
223          $$(info Please retry building with CONF=<config pattern> (or SPEC=<spec file>).)
224          $$(info )
225          $$(error Cannot continue)
226        endif
227
228        # We found exactly one configuration, use it
229        SPECS := $$(strip $$(all_spec_files))
230      endif
231    endif
232  endef
233
234  define PrintConfCheckFailed
235	@echo ' '
236	@echo "Please rerun configure! Easiest way to do this is by running"
237	@echo "'make reconfigure'."
238	@echo "This behavior may also be changed using CONF_CHECK=<ignore|auto>."
239	@echo ' '
240  endef
241
242else # $(HAS_SPEC)=true
243  ##############################################################################
244  # Helper functions for the 'main' target. These functions assume a single,
245  # proper and existing SPEC is provided, and will load it.
246  ##############################################################################
247
248  include $(SPEC)
249  include $(SRC_ROOT)/make/common/MakeBase.gmk
250
251  # Define basic logging setup
252  BUILD_LOG := $(OUTPUT_ROOT)/build.log
253  BUILD_TRACE_LOG := $(OUTPUT_ROOT)/build-trace-time.log
254
255  BUILD_LOG_WRAPPER := $(BASH) $(SRC_ROOT)/common/bin/logger.sh $(BUILD_LOG)
256
257  # Disable the build log wrapper on sjavac+windows until
258  # we have solved how to prevent the log wrapper to wait
259  # for the background sjavac server process.
260  ifeq ($(ENABLE_SJAVAC)X$(OPENJDK_BUILD_OS),yesXwindows)
261    LOG_NOFILE := true
262  endif
263
264  # Sanity check the spec file, so it matches this source code
265  define CheckSpecSanity
266    ifneq ($$(topdir), $$(TOPDIR))
267      ifneq ($$(topdir), $$(ORIGINAL_TOPDIR))
268        ifneq ($$(topdir), $$(CANONICAL_TOPDIR))
269          $$(info Error: SPEC mismatch! Current working directory)
270          $$(info $$(topdir))
271          $$(info does not match either TOPDIR, ORIGINAL_TOPDIR or CANONICAL_TOPDIR)
272          $$(info $$(TOPDIR))
273          $$(info $$(ORIGINAL_TOPDIR))
274          $$(info $$(CANONICAL_TOPDIR))
275          $$(error Cannot continue)
276        endif
277      endif
278    endif
279  endef
280
281  define RotateLogFiles
282	$(RM) $(BUILD_LOG).old 2> /dev/null
283	$(MV) $(BUILD_LOG) $(BUILD_LOG).old 2> /dev/null || true
284	$(if $(findstring trace, $(LOG_LEVEL)), \
285	  $(RM) $(BUILD_TRACE_LOG).old 2> /dev/null && \
286	  $(MV) $(BUILD_TRACE_LOG) $(BUILD_TRACE_LOG).old 2> /dev/null || true \
287	)
288  endef
289
290  # Remove any javac server logs and port files. This
291  # prevents a new make run to reuse the previous servers.
292  define PrepareSmartJavac
293	$(if $(SJAVAC_SERVER_DIR), \
294	  $(RM) -r $(SJAVAC_SERVER_DIR) 2> /dev/null && \
295	  $(MKDIR) -p $(SJAVAC_SERVER_DIR) \
296	)
297  endef
298
299  define CleanupSmartJavac
300	[ -f $(SJAVAC_SERVER_DIR)/server.port ] && $(ECHO) Stopping sjavac server && \
301	    $(TOUCH) $(SJAVAC_SERVER_DIR)/server.port.stop; true
302  endef
303
304  define StartGlobalTimer
305	$(RM) -r $(BUILDTIMESDIR) 2> /dev/null
306	$(MKDIR) -p $(BUILDTIMESDIR)
307	$(call RecordStartTime,TOTAL)
308  endef
309
310  define StopGlobalTimer
311	$(call RecordEndTime,TOTAL)
312  endef
313
314  # Find all build_time_* files and print their contents in a list sorted
315  # on the name of the sub repository.
316  define ReportBuildTimes
317	$(BUILD_LOG_WRAPPER) $(PRINTF) $(LOG_INFO) -- \
318	    "----- Build times -------\nStart %s\nEnd   %s\n%s\n%s\n-------------------------\n" \
319	    "`$(CAT) $(BUILDTIMESDIR)/build_time_start_TOTAL_human_readable`" \
320	    "`$(CAT) $(BUILDTIMESDIR)/build_time_end_TOTAL_human_readable`" \
321	    "`$(LS) $(BUILDTIMESDIR)/build_time_diff_* | $(GREP) -v _TOTAL | \
322	    $(XARGS) $(CAT) | $(SORT) -k 2`" \
323	    "`$(CAT) $(BUILDTIMESDIR)/build_time_diff_TOTAL`"
324  endef
325
326endif # HAS_SPEC
327
328endif # _INITSUPPORT_GMK
329