1 #
   2 # Copyright (c) 2012, 2018, 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
  33 default:
  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 
  40 ifeq ($(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       print-tests 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   ifeq ($(findstring p, $(MAKEFLAGS))$(findstring q, $(MAKEFLAGS)), pq)
  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, MAKE_LOG_VARS 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     $(SPECS): $(wildcard $(topdir)/make/autoconf/*) \
 141             $(if $(CUSTOM_CONFIG_DIR), $(wildcard $(CUSTOM_CONFIG_DIR)/*))
 142         ifeq ($(CONF_CHECK), fail)
 143           @echo Error: The configuration is not up to date for \
 144               "'$(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 \
 149               "'$(lastword $(subst /, , $(dir $@)))'."
 150           @( cd $(topdir) && \
 151               $(MAKE) $(MFLAGS) $(MAKE_LOG_FLAGS) -r -R -f $(topdir)/make/Init.gmk \
 152               SPEC=$@ HAS_SPEC=true ACTUAL_TOPDIR=$(topdir) \
 153               reconfigure )
 154         else ifeq ($(CONF_CHECK), ignore)
 155           # Do nothing
 156         endif
 157 
 158     # Do not let make delete spec files even if aborted while doing a reconfigure
 159     .PRECIOUS: $(SPECS)
 160 
 161     # Unless reconfigure is explicitly called, let all main targets depend on
 162     # the spec files to be up to date.
 163     ifeq ($(findstring reconfigure, $(INIT_TARGETS)), )
 164       $(MAIN_TARGETS): $(SPECS)
 165     endif
 166 
 167     make-info:
 168         ifneq ($(findstring $(LOG_LEVEL),info debug trace),)
 169           $(info Running make as '$(strip $(MAKE) $(MFLAGS) \
 170               $(COMMAND_LINE_VARIABLES) $(MAKECMDGOALS))')
 171         endif
 172 
 173     MAKE_INIT_WITH_SPEC_ARGUMENTS := ACTUAL_TOPDIR=$(topdir) \
 174         USER_MAKE_VARS="$(USER_MAKE_VARS)" MAKE_LOG_FLAGS=$(MAKE_LOG_FLAGS) \
 175         $(MAKE_LOG_VARS) \
 176         INIT_TARGETS="$(INIT_TARGETS)" \
 177         SEQUENTIAL_TARGETS="$(SEQUENTIAL_TARGETS)" \
 178         PARALLEL_TARGETS="$(PARALLEL_TARGETS)"
 179 
 180     # Now the init and main targets will be called, once for each SPEC. The
 181     # recipe will be run once for every target specified, but we only want to
 182     # execute the recipe a single time, hence the TARGET_DONE with a dummy
 183     # command if true.
 184     # The COMPARE_BUILD part implements special support for makefile development.
 185     $(ALL_INIT_TARGETS) $(ALL_MAIN_TARGETS): make-info
 186         @$(if $(TARGET_DONE), \
 187           true \
 188         , \
 189           ( cd $(topdir) && \
 190           $(foreach spec, $(SPECS), \
 191             $(MAKE) $(MFLAGS) $(MAKE_LOG_FLAGS) -r -R -j 1 -f $(topdir)/make/Init.gmk \
 192                 SPEC=$(spec) HAS_SPEC=true $(MAKE_INIT_WITH_SPEC_ARGUMENTS) \
 193                 main && \
 194             $(if $(and $(COMPARE_BUILD), $(PARALLEL_TARGETS)), \
 195                 $(MAKE) $(MFLAGS) $(MAKE_LOG_FLAGS) -r -R -f $(topdir)/make/Init.gmk \
 196                     SPEC=$(spec) HAS_SPEC=true ACTUAL_TOPDIR=$(topdir) \
 197                     COMPARE_BUILD="$(COMPARE_BUILD)" pre-compare-build && \
 198                 $(MAKE) $(MFLAGS) $(MAKE_LOG_FLAGS) -r -R -j 1 -f $(topdir)/make/Init.gmk \
 199                     SPEC=$(spec) HAS_SPEC=true $(MAKE_INIT_WITH_SPEC_ARGUMENTS) \
 200                     COMPARE_BUILD="$(COMPARE_BUILD)" main && \
 201                 $(MAKE) $(MFLAGS) $(MAKE_LOG_FLAGS) -r -R -f $(topdir)/make/Init.gmk \
 202                     SPEC=$(spec) HAS_SPEC=true ACTUAL_TOPDIR=$(topdir) \
 203                     COMPARE_BUILD="$(COMPARE_BUILD)" post-compare-build && \
 204             ) \
 205           ) true ) \
 206           $(eval TARGET_DONE=true) \
 207         )
 208 
 209     .PHONY: $(ALL_MAIN_TARGETS) $(ALL_INIT_TARGETS)
 210 
 211   endif # $(ONLY_GLOBAL_TARGETS)!=true
 212 
 213 else # HAS_SPEC=true
 214 
 215   ##############################################################################
 216   # Now we have a spec. This part provides the "main" target that acts as a
 217   # trampoline to call the Main.gmk with the value of $(MAKE) found in the spec
 218   # file.
 219   ##############################################################################
 220 
 221   include $(SPEC)
 222 
 223   # Our helper functions.
 224   include $(TOPDIR)/make/InitSupport.gmk
 225 
 226   # Parse COMPARE_BUILD (for makefile development)
 227   $(eval $(call ParseCompareBuild))
 228 
 229   # If no LOG= was given on command line, but we have a non-standard default
 230   # value, use that instead and re-parse log level.
 231   ifeq ($(LOG), )
 232     ifneq ($(DEFAULT_LOG), )
 233       override LOG := $(DEFAULT_LOG)
 234       $(eval $(call ParseLogLevel))
 235     endif
 236   endif
 237 
 238   ifeq ($(LOG_NOFILE), true)
 239     # Disable build log if LOG=[level,]nofile was given
 240     override BUILD_LOG_PIPE :=
 241   endif
 242 
 243   ifeq ($(filter dist-clean, $(SEQUENTIAL_TARGETS)), dist-clean)
 244     # We can't have a log file if we're about to remove it.
 245     override BUILD_LOG_PIPE :=
 246   endif
 247 
 248   ifeq ($(OUTPUT_SYNC_SUPPORTED), true)
 249     OUTPUT_SYNC_FLAG := -O$(OUTPUT_SYNC)
 250   endif
 251 
 252   ##############################################################################
 253   # Init targets
 254   ##############################################################################
 255 
 256   print-modules:
 257         ( cd $(TOPDIR) && \
 258             $(MAKE) $(MAKE_ARGS) -j 1 -f make/Main.gmk $(USER_MAKE_VARS) \
 259             NO_RECIPES=true print-modules )
 260 
 261   print-targets:
 262         ( cd $(TOPDIR) && \
 263             $(MAKE) $(MAKE_ARGS) -j 1 -f make/Main.gmk $(USER_MAKE_VARS) \
 264             NO_RECIPES=true print-targets )
 265 
 266   print-tests:
 267         ( cd $(TOPDIR) && \
 268             $(MAKE) $(MAKE_ARGS) -j 1 -f make/Main.gmk $(USER_MAKE_VARS) \
 269             NO_RECIPES=true print-tests )
 270 
 271   print-configuration:
 272           $(ECHO) $(CONFIGURE_COMMAND_LINE)
 273 
 274   reconfigure:
 275         ifneq ($(CONFIGURE_COMMAND_LINE), )
 276           $(ECHO) "Re-running configure using arguments '$(CONFIGURE_COMMAND_LINE)'"
 277         else
 278           $(ECHO) "Re-running configure using default settings"
 279         endif
 280         ( cd $(OUTPUTDIR) && PATH="$(ORIGINAL_PATH)" \
 281             CUSTOM_ROOT="$(CUSTOM_ROOT)" \
 282             CUSTOM_CONFIG_DIR="$(CUSTOM_CONFIG_DIR)" \
 283             $(BASH) $(TOPDIR)/configure $(CONFIGURE_COMMAND_LINE) )
 284 
 285   ##############################################################################
 286   # The main target, for delegating into Main.gmk
 287   ##############################################################################
 288 
 289   MAIN_TARGETS := $(SEQUENTIAL_TARGETS) $(PARALLEL_TARGETS) $(COMPARE_BUILD_MAKE)
 290   # If building the default target, add what they are to the description.
 291   DESCRIPTION_TARGETS := $(strip $(MAIN_TARGETS))
 292   ifeq ($(DESCRIPTION_TARGETS), default)
 293     DESCRIPTION_TARGETS += ($(DEFAULT_MAKE_TARGET))
 294   endif
 295   TARGET_DESCRIPTION := target$(if $(word 2, $(MAIN_TARGETS)),s) \
 296       '$(strip $(DESCRIPTION_TARGETS))' in configuration '$(CONF_NAME)'
 297 
 298   # MAKEOVERRIDES is automatically set and propagated by Make to sub-Make calls.
 299   # We need to clear it of the init-specific variables. The user-specified
 300   # variables are explicitly propagated using $(USER_MAKE_VARS).
 301   main: MAKEOVERRIDES :=
 302 
 303   main: $(INIT_TARGETS)
 304         ifneq ($(SEQUENTIAL_TARGETS)$(PARALLEL_TARGETS), )
 305           $(call RotateLogFiles)
 306           $(PRINTF) "Building $(TARGET_DESCRIPTION)\n" $(BUILD_LOG_PIPE)
 307           ifneq ($(SEQUENTIAL_TARGETS), )
 308             # Don't touch build output dir since we might be cleaning. That
 309             # means no log pipe.
 310             ( cd $(TOPDIR) && \
 311                 $(MAKE) $(MAKE_ARGS) -j 1 -f make/Main.gmk $(USER_MAKE_VARS) \
 312                 $(SEQUENTIAL_TARGETS) )
 313           endif
 314           ifneq ($(PARALLEL_TARGETS), )
 315             $(call PrepareFailureLogs)
 316             $(call StartGlobalTimer)
 317             $(call PrepareSmartJavac)
 318             # JOBS will only be empty for a bootcycle-images recursive call
 319             # or if specified via a make argument directly. In those cases
 320             # treat it as NOT using jobs at all.
 321             ( cd $(TOPDIR) && \
 322                 $(NICE) $(MAKE) $(MAKE_ARGS) $(OUTPUT_SYNC_FLAG) \
 323                     $(if $(JOBS), -j $(JOBS)) \
 324                     -f make/Main.gmk $(USER_MAKE_VARS) \
 325                     $(PARALLEL_TARGETS) $(COMPARE_BUILD_MAKE) $(BUILD_LOG_PIPE) || \
 326                 ( exitcode=$$? && \
 327                 $(PRINTF) "\nERROR: Build failed for $(TARGET_DESCRIPTION) (exit code $$exitcode) \n" \
 328                     $(BUILD_LOG_PIPE) && \
 329                 cd $(TOPDIR) && $(MAKE) $(MAKE_ARGS) -j 1 -f make/Init.gmk \
 330                     HAS_SPEC=true on-failure ; \
 331                 exit $$exitcode ) )
 332             $(call CleanupSmartJavac)
 333             $(call StopGlobalTimer)
 334             $(call ReportBuildTimes)
 335           endif
 336           if test -f $(MAKESUPPORT_OUTPUTDIR)/exit-with-error ; then \
 337             exit 1 ; \
 338           fi
 339           $(PRINTF) "Finished building $(TARGET_DESCRIPTION)\n" $(BUILD_LOG_PIPE)
 340           $(call ReportProfileTimes)
 341         endif
 342 
 343     on-failure:
 344         $(call CleanupSmartJavac)
 345         $(call StopGlobalTimer)
 346         $(call ReportBuildTimes)
 347         $(call PrintFailureReports)
 348         $(call PrintBuildLogFailures)
 349         $(call ReportProfileTimes)
 350         $(PRINTF) "Hint: See doc/building.html#troubleshooting for assistance.\n\n"
 351         ifneq ($(COMPARE_BUILD), )
 352           $(call CleanupCompareBuild)
 353         endif
 354 
 355     # Support targets for COMPARE_BUILD, used for makefile development
 356     pre-compare-build:
 357         $(call WaitForSmartJavacFinish)
 358         $(call PrepareCompareBuild)
 359 
 360     post-compare-build:
 361         $(call WaitForSmartJavacFinish)
 362         $(call CleanupCompareBuild)
 363         $(call CompareBuildDoComparison)
 364 
 365   .PHONY: print-targets print-modules reconfigure main on-failure
 366 endif