Init.gmk revision 1701:23d62be63eef 
1#
2# Copyright (c) 2012, 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 is the bootstrapping part of the build. This file is included from the
28# top level Makefile, and is responsible for launching the Main.gmk file with
29# the proper make and the proper make arguments.
30################################################################################
31
32# This must be the first rule
33default:
34.PHONY: default
35
36# Inclusion of this pseudo-target will cause make to execute this file
37# serially, regardless of -j.
38.NOTPARALLEL:
39
40ifeq ($(HAS_SPEC),)
41  ##############################################################################
42  # This is the default mode. We have not been recursively called with a SPEC.
43  ##############################################################################
44
45  # Include our helper functions.
46  include $(topdir)/make/InitSupport.gmk
47
48  # Here are "global" targets, i.e. targets that can be executed without having
49  # a configuration. This will define ALL_GLOBAL_TARGETS.
50  include $(topdir)/make/Help.gmk
51
52  # Targets provided by Init.gmk.
53  ALL_INIT_TARGETS := print-modules print-targets print-configuration \
54      reconfigure pre-compare-build post-compare-build
55
56  # CALLED_TARGETS is the list of targets that the user provided,
57  # or "default" if unspecified.
58  CALLED_TARGETS := $(if $(MAKECMDGOALS), $(MAKECMDGOALS), default)
59
60  # Extract non-global targets that require a spec file.
61  CALLED_SPEC_TARGETS := $(filter-out $(ALL_GLOBAL_TARGETS), $(CALLED_TARGETS))
62
63  # If we have only global targets, or if we are called with -qp (assuming an
64  # external part, e.g. bash completion, is trying to understand our targets),
65  # we will skip SPEC location and the sanity checks.
66  ifeq ($(CALLED_SPEC_TARGETS), )
67    ONLY_GLOBAL_TARGETS := true
68  endif
69  ifneq ($(findstring qp, $(MAKEFLAGS)),)
70    ONLY_GLOBAL_TARGETS := true
71  endif
72
73  ifeq ($(ONLY_GLOBAL_TARGETS), true)
74    ############################################################################
75    # We have only global targets, or are called with -pq.
76    ############################################################################
77
78    ifeq ($(wildcard $(SPEC)), )
79      # If we have no SPEC provided, we will just make a "best effort" target list.
80      # First try to grab any available pre-existing main-targets.gmk.
81      main_targets_file := $(firstword $(wildcard $(build_dir)/*/make-support/main-targets.gmk))
82      ifneq ($(main_targets_file), )
83        # Extract the SPEC that corresponds to this main-targets.gmk file.
84        SPEC := $(patsubst %/make-support/main-targets.gmk, %/spec.gmk, $(main_targets_file))
85      else
86        # None found, pick an arbitrary SPEC for which to generate a file
87        SPEC := $(firstword $(all_spec_files))
88      endif
89    endif
90
91    ifneq ($(wildcard $(SPEC)), )
92      $(eval $(call DefineMainTargets, LAZY, $(SPEC)))
93    else
94      # If we have no configurations we can not provide any main targets.
95      ALL_MAIN_TARGETS :=
96    endif
97
98    ALL_TARGETS := $(sort $(ALL_GLOBAL_TARGETS) $(ALL_MAIN_TARGETS) $(ALL_INIT_TARGETS))
99
100    # Just list all our targets.
101    $(ALL_TARGETS):
102
103    .PHONY: $(ALL_TARGETS)
104
105  else
106    ############################################################################
107    # This is the normal case, we have been called from the command line by the
108    # user and we need to call ourself back with a proper SPEC.
109    # We have at least one non-global target, so we need to find a spec file.
110    ############################################################################
111
112    # Basic checks on environment and command line.
113    $(eval $(call CheckControlVariables))
114    $(eval $(call CheckDeprecatedEnvironment))
115    $(eval $(call CheckInvalidMakeFlags))
116
117    # Check that CONF_CHECK is valid.
118    $(eval $(call ParseConfCheckOption))
119
120    # Check that the LOG given is valid, and set LOG_LEVEL, LOG_NOFILE and MAKE_LOG_FLAGS.
121    $(eval $(call ParseLogLevel))
122
123    # After this SPECS contain 1..N spec files (otherwise ParseConfAndSpec fails).
124    $(eval $(call ParseConfAndSpec))
125
126    # Extract main targets from Main.gmk using the spec(s) provided. In theory,
127    # with multiple specs, we should find the intersection of targets provided
128    # by all specs, but we approximate this by an arbitrary spec from the list.
129    # This will setup ALL_MAIN_TARGETS.
130    $(eval $(call DefineMainTargets, FORCE, $(firstword $(SPECS))))
131
132    # Separate called targets depending on type.
133    INIT_TARGETS := $(filter $(ALL_INIT_TARGETS), $(CALLED_SPEC_TARGETS))
134    MAIN_TARGETS := $(filter $(ALL_MAIN_TARGETS), $(CALLED_SPEC_TARGETS))
135    SEQUENTIAL_TARGETS := $(filter dist-clean clean%, $(MAIN_TARGETS))
136    PARALLEL_TARGETS := $(filter-out $(SEQUENTIAL_TARGETS), $(MAIN_TARGETS))
137
138    # The spec files depend on the autoconf source code. This check makes sure
139    # the configuration is up to date after changes to configure.
140    CUSTOM_CONFIG_DIR ?= $(topdir)/closed/autoconf
141
142    $(SPECS): $(wildcard $(topdir)/common/autoconf/*) $(wildcard $(CUSTOM_CONFIG_DIR)/*)
143        ifeq ($(CONF_CHECK), fail)
144	  @echo "Error: The configuration is not up to date for '$(lastword $(subst /, , $(dir $@)))'."
145	  $(call PrintConfCheckFailed)
146	  @exit 2
147        else ifeq ($(CONF_CHECK), auto)
148	  @echo "Note: The configuration is not up to date for '$(lastword $(subst /, , $(dir $@)))'."
149	  @( cd $(topdir) && \
150	      $(MAKE) $(MFLAGS) $(MAKE_LOG_FLAGS) -r -R -f $(topdir)/make/Init.gmk \
151	      SPEC=$@ HAS_SPEC=true ACTUAL_TOPDIR=$(topdir) \
152	      reconfigure )
153        else ifeq ($(CONF_CHECK), ignore)
154          # Do nothing
155        endif
156
157    # Unless reconfigure is explicitely called, let all main targets depend on
158    # the spec files to be up to date.
159    ifeq ($(findstring reconfigure, $(INIT_TARGETS)), )
160      $(MAIN_TARGETS): $(SPECS)
161    endif
162
163    make-info:
164        ifneq ($(findstring $(LOG_LEVEL),info debug trace),)
165	  $(info Running make as '$(strip $(MAKE) $(MFLAGS) \
166	      $(COMMAND_LINE_VARIABLES) $(MAKECMDGOALS))')
167        endif
168
169    MAKE_INIT_WITH_SPEC_ARGUMENTS := ACTUAL_TOPDIR=$(topdir) \
170        USER_MAKE_VARS="$(USER_MAKE_VARS)" MAKE_LOG_FLAGS=$(MAKE_LOG_FLAGS) \
171        LOG_LEVEL=$(LOG_LEVEL) LOG_NOFILE=$(LOG_NOFILE) \
172        INIT_TARGETS="$(INIT_TARGETS)" \
173        SEQUENTIAL_TARGETS="$(SEQUENTIAL_TARGETS)" \
174        PARALLEL_TARGETS="$(PARALLEL_TARGETS)"
175
176    # Now the init and main targets will be called, once for each SPEC. The
177    # recipe will be run once for every target specified, but we only want to
178    # execute the recipe a single time, hence the TARGET_DONE with a dummy
179    # command if true.
180    # The COMPARE_BUILD part implements special support for makefile development.
181    $(ALL_INIT_TARGETS) $(ALL_MAIN_TARGETS): make-info
182	@$(if $(TARGET_DONE), \
183	  true \
184	, \
185	  ( cd $(topdir) && \
186	  $(foreach spec, $(SPECS), \
187	    $(MAKE) $(MFLAGS) $(MAKE_LOG_FLAGS) -r -R -j 1 -f $(topdir)/make/Init.gmk \
188	        SPEC=$(spec) HAS_SPEC=true $(MAKE_INIT_WITH_SPEC_ARGUMENTS) \
189	        main && \
190	    $(if $(and $(COMPARE_BUILD), $(PARALLEL_TARGETS)), \
191	        $(MAKE) $(MFLAGS) $(MAKE_LOG_FLAGS) -r -R -f $(topdir)/make/Init.gmk \
192	            SPEC=$(spec) HAS_SPEC=true ACTUAL_TOPDIR=$(topdir) \
193	            COMPARE_BUILD="$(COMPARE_BUILD)" pre-compare-build && \
194	        $(MAKE) $(MFLAGS) $(MAKE_LOG_FLAGS) -r -R -j 1 -f $(topdir)/make/Init.gmk \
195	            SPEC=$(spec) HAS_SPEC=true $(MAKE_INIT_WITH_SPEC_ARGUMENTS) \
196	            COMPARE_BUILD="$(COMPARE_BUILD)" main && \
197	        $(MAKE) $(MFLAGS) $(MAKE_LOG_FLAGS) -r -R -f $(topdir)/make/Init.gmk \
198	            SPEC=$(spec) HAS_SPEC=true ACTUAL_TOPDIR=$(topdir) \
199	            COMPARE_BUILD="$(COMPARE_BUILD)" post-compare-build && \
200	    ) \
201	  ) true ) \
202	  $(eval TARGET_DONE=true) \
203	)
204
205    .PHONY: $(ALL_MAIN_TARGETS) $(ALL_INIT_TARGETS)
206
207  endif # $(ONLY_GLOBAL_TARGETS)!=true
208
209else # HAS_SPEC=true
210
211  ##############################################################################
212  # Now we have a spec. This part provides the "main" target that acts as a
213  # trampoline to call the Main.gmk with the value of $(MAKE) found in the spec
214  # file.
215  ##############################################################################
216
217  include $(SPEC)
218
219  # Our helper functions.
220  include $(TOPDIR)/make/InitSupport.gmk
221
222  # Verify that the spec file we included seems okay.
223  $(eval $(call CheckSpecSanity))
224
225  # Parse COMPARE_BUILD (for makefile development)
226  $(eval $(call ParseCompareBuild))
227
228  ifeq ($(LOG_NOFILE), true)
229    # Disable log wrapper if LOG=[level,]nofile was given
230    override BUILD_LOG_WRAPPER :=
231  endif
232
233  ifeq ($(OUTPUT_SYNC_SUPPORTED), true)
234    OUTPUT_SYNC_FLAG := -O$(OUTPUT_SYNC)
235  endif
236
237  ##############################################################################
238  # Init targets
239  ##############################################################################
240
241  print-modules:
242	( cd $(TOPDIR) && \
243	    $(MAKE) $(MAKE_ARGS) -j 1 -f make/Main.gmk $(USER_MAKE_VARS) \
244	    NO_RECIPES=true print-modules )
245
246  print-targets:
247	( cd $(TOPDIR) && \
248	    $(MAKE) $(MAKE_ARGS) -j 1 -f make/Main.gmk $(USER_MAKE_VARS) \
249	    NO_RECIPES=true print-targets )
250
251  print-configuration:
252	  $(ECHO) $(CONFIGURE_COMMAND_LINE)
253
254  reconfigure:
255        ifneq ($(CONFIGURE_COMMAND_LINE), )
256	  $(ECHO) "Re-running configure using arguments '$(CONFIGURE_COMMAND_LINE)'"
257        else
258	  $(ECHO) "Re-running configure using default settings"
259        endif
260	( cd $(OUTPUT_ROOT) && PATH="$(ORIGINAL_PATH)" \
261	    $(BASH) $(TOPDIR)/configure $(CONFIGURE_COMMAND_LINE) )
262
263  ##############################################################################
264  # The main target, for delegating into Main.gmk
265  ##############################################################################
266
267  MAIN_TARGETS := $(SEQUENTIAL_TARGETS) $(PARALLEL_TARGETS) $(COMPARE_BUILD_MAKE)
268  TARGET_DESCRIPTION := target$(if $(word 2, $(MAIN_TARGETS)),s) \
269      '$(strip $(MAIN_TARGETS))' in configuration '$(CONF_NAME)'
270
271  # MAKEOVERRIDES is automatically set and propagated by Make to sub-Make calls.
272  # We need to clear it of the init-specific variables. The user-specified
273  # variables are explicitely propagated using $(USER_MAKE_VARS).
274  main: MAKEOVERRIDES :=
275
276  main: $(INIT_TARGETS)
277        ifneq ($(SEQUENTIAL_TARGETS)$(PARALLEL_TARGETS), )
278	  $(call RotateLogFiles)
279	  $(call PrepareFailureLogs)
280	  $(BUILD_LOG_WRAPPER) $(PRINTF) "Building $(TARGET_DESCRIPTION)\n"
281          ifneq ($(SEQUENTIAL_TARGETS), )
282            # Don't touch build output dir since we might be cleaning. That
283            # means no log wrapper.
284	    ( cd $(TOPDIR) && \
285	        $(MAKE) $(MAKE_ARGS) -j 1 -f make/Main.gmk $(USER_MAKE_VARS) \
286	        $(SEQUENTIAL_TARGETS) )
287          endif
288          ifneq ($(PARALLEL_TARGETS), )
289	    $(call StartGlobalTimer)
290	    $(call PrepareSmartJavac)
291	    ( cd $(TOPDIR) && \
292	        $(BUILD_LOG_WRAPPER) $(NICE) $(MAKE) $(MAKE_ARGS) $(OUTPUT_SYNC_FLAG) \
293	            -j $(JOBS) -f make/Main.gmk $(USER_MAKE_VARS) \
294	            $(PARALLEL_TARGETS) $(COMPARE_BUILD_MAKE) || \
295	        ( exitcode=$$? && $(BUILD_LOG_WRAPPER) \
296	        $(PRINTF) "\nERROR: Build failed for $(TARGET_DESCRIPTION) (exit code $$exitcode) \n" && \
297	        cd $(TOPDIR) && $(MAKE) $(MAKE_ARGS) -j 1 -f make/Init.gmk \
298	            HAS_SPEC=true on-failure ; \
299	        exit $$exitcode ) )
300	    $(call CleanupSmartJavac)
301	    $(call StopGlobalTimer)
302	    $(call ReportBuildTimes)
303          endif
304	  $(BUILD_LOG_WRAPPER) $(PRINTF) "Finished building $(TARGET_DESCRIPTION)\n"
305        endif
306
307    on-failure:
308        ifneq ($(wildcard $(MAKESUPPORT_OUTPUTDIR)/failure-logs/*), )
309	  $(PRINTF) "=== Output from failing command(s) repeated here ===\n"
310	  $(foreach logfile, $(sort $(wildcard $(MAKESUPPORT_OUTPUTDIR)/failure-logs/*)), \
311	      $(PRINTF) "* For target $(notdir $(basename $(logfile))):\n" $(NEWLINE) \
312	      $(CAT) $(logfile) | $(GREP) -v -e "^Note: including file:" $(NEWLINE) \
313	  )
314	  $(PRINTF) "=== End of repeated output ===\n"
315        endif
316	if $(GREP) -q "recipe for target .* failed" $(BUILD_LOG) 2> /dev/null; then  \
317	  $(PRINTF) "=== Make failure sequence repeated here ===\n" ; \
318	  $(GREP) "recipe for target .* failed" $(BUILD_LOG) ; \
319	  $(PRINTF) "=== End of repeated output ===\n" ; \
320	  $(PRINTF) "Hint: Try searching the build log for the name of the first failed target.\n" ; \
321	else \
322	  $(PRINTF) "No indication of failed target found.\n" ; \
323	  $(PRINTF) "Hint: Try searching the build log for '] Error'.\n" ; \
324	fi
325	$(PRINTF) "Hint: If caused by a warning, try configure --disable-warnings-as-errors.\n\n"
326
327    # Support targets for COMPARE_BUILD, used for makefile development
328    pre-compare-build:
329	$(ECHO) "Preparing for comparison rebuild"
330        # Apply patch, if any
331        ifneq ($(COMPARE_BUILD_PATCH), )
332	  $(PATCH) -p1 < $(COMPARE_BUILD_PATCH)
333        endif
334        # Move the first build away and re-create the output directory
335	( cd $(TOPDIR) && \
336	    $(MV) $(OUTPUT_ROOT) $(OUTPUT_ROOT).OLD && \
337	    $(MKDIR) -p $(OUTPUT_ROOT) )
338        # Re-run configure with the same arguments (and possibly some additional),
339	# must be done after patching.
340	( cd $(OUTPUT_ROOT) && PATH="$(ORIGINAL_PATH)" \
341	    $(BASH) $(TOPDIR)/configure $(CONFIGURE_COMMAND_LINE) $(COMPARE_BUILD_CONF))
342
343    post-compare-build:
344        # Compare first and second build. Ignore any error code from compare.sh.
345	$(ECHO) "Comparing between comparison rebuild (this/new) and baseline (other/old)"
346        ifneq ($(COMPARE_BUILD_COMP_DIR), )
347	  +(cd $(OUTPUT_ROOT) && ./compare.sh $(COMPARE_BUILD_COMP_OPTS) -2dirs $(OUTPUT_ROOT)/$(COMPARE_BUILD_COMP_DIR) $(OUTPUT_ROOT).OLD/$(COMPARE_BUILD_COMP_DIR) || true)
348        else
349	  +(cd $(OUTPUT_ROOT) && ./compare.sh $(COMPARE_BUILD_COMP_OPTS) -o $(OUTPUT_ROOT).OLD || true)
350        endif
351
352  .PHONY: print-targets print-modules reconfigure main on-failure
353endif
354