1 #
   2 # Copyright (c) 2011, 2016, 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 Main.gmk.
  28 ################################################################################
  29 
  30 ifndef _MAINSUPPORT_GMK
  31 _MAINSUPPORT_GMK := 1
  32 
  33 # Run the tests specified by $1, with PRODUCT_HOME specified by $2
  34 # JT_JAVA is picked up by the jtreg launcher and used to run Jtreg itself.
  35 define RunTests
  36         ($(CD) $(SRC_ROOT)/test && $(MAKE) $(MAKE_ARGS) -j1 -k MAKEFLAGS= \
  37             JT_HOME=$(JT_HOME) PRODUCT_HOME=$(strip $2) \
  38             TEST_IMAGE_DIR=$(TEST_IMAGE_DIR) \
  39             ALT_OUTPUTDIR=$(OUTPUT_ROOT) TEST_JOBS=$(TEST_JOBS) \
  40             JT_JAVA=$(BOOT_JDK) \
  41             JOBS=$(JOBS) $1) || true
  42 endef
  43 
  44 # Cleans the dir given as $1
  45 define CleanDir
  46         @$(PRINTF) "Cleaning $(strip $1) build artifacts ..."
  47         @$(PRINTF) "\n" $(LOG_DEBUG)
  48         ($(CD) $(OUTPUT_ROOT) && $(RM) -r $1)
  49         @$(PRINTF) " done\n"
  50 endef
  51 
  52 define CleanSupportDir
  53         @$(PRINTF) "Cleaning $(strip $1) build artifacts ..."
  54         @$(PRINTF) "\n" $(LOG_DEBUG)
  55         $(RM) -r $(SUPPORT_OUTPUTDIR)/$(strip $1)
  56         @$(PRINTF) " done\n"
  57 endef
  58 
  59 define CleanTest
  60         @$(PRINTF) "Cleaning test $(strip $1) ..."
  61         @$(PRINTF) "\n" $(LOG_DEBUG)
  62         $(RM) -r $(SUPPORT_OUTPUTDIR)/test/$(strip $(subst -,/,$1))
  63         # Remove as much of the test directory structure as is empty
  64         $(RMDIR) -p $(dir $(SUPPORT_OUTPUTDIR)/test/$(strip $(subst -,/,$1))) 2> /dev/null || true
  65         @$(PRINTF) " done\n"
  66 endef
  67 
  68 define Clean-gensrc
  69         @$(PRINTF) "Cleaning gensrc $(if $1,for $(strip $1) )..."
  70         @$(PRINTF) "\n" $(LOG_DEBUG)
  71         $(RM) -r $(SUPPORT_OUTPUTDIR)/gensrc/$(strip $1)
  72         @$(PRINTF) " done\n"
  73 endef
  74 
  75 define Clean-java
  76         @$(PRINTF) "Cleaning java $(if $1,for $(strip $1) )..."
  77         @$(PRINTF) "\n" $(LOG_DEBUG)
  78         $(RM) -r $(JDK_OUTPUTDIR)/modules/$(strip $1)
  79         $(RM) -r $(SUPPORT_OUTPUTDIR)/special_classes/$(strip $1)
  80         $(PRINTF) " done\n"
  81         $(PRINTF) "Cleaning headers $(if $1,for $(strip $1)) ..."
  82         $(RM) -r $(SUPPORT_OUTPUTDIR)/headers/$(strip $1)
  83         @$(PRINTF) " done\n"
  84 endef
  85 
  86 define Clean-native
  87         @$(PRINTF) "Cleaning native $(if $1,for $(strip $1) )..."
  88         @$(PRINTF) "\n" $(LOG_DEBUG)
  89         $(RM) -r $(SUPPORT_OUTPUTDIR)/native/$(strip $1)
  90         $(RM) -r $(SUPPORT_OUTPUTDIR)/modules_libs/$(strip $1)
  91         $(RM) -r $(SUPPORT_OUTPUTDIR)/modules_cmds/$(strip $1)
  92         @$(PRINTF) " done\n"
  93 endef
  94 
  95 define Clean-include
  96         @$(PRINTF) "Cleaning include $(if $1,for $(strip $1) )..."
  97         @$(PRINTF) "\n" $(LOG_DEBUG)
  98         $(RM) -r $(SUPPORT_OUTPUTDIR)/modules_include/$(strip $1)
  99         @$(PRINTF) " done\n"
 100 endef
 101 
 102 define Clean-docs
 103         @$(PRINTF) "Cleaning docs ..."
 104         @$(PRINTF) "\n" $(LOG_DEBUG)
 105         $(RM) -r $(SUPPORT_OUTPUTDIR)/docs
 106         $(RM) -r $(IMAGES_OUTPUTDIR)/docs
 107         $(RM) $(OUTPUT_ROOT)/bundles/jdk-*-docs.zip
 108         @$(PRINTF) " done\n"
 109 endef
 110 
 111 define CleanModule
 112   $(call Clean-gensrc, $1)
 113   $(call Clean-java, $1)
 114   $(call Clean-native, $1)
 115   $(call Clean-include, $1)
 116 endef
 117 
 118 
 119 ################################################################################
 120 
 121 MAKE_TOPDIR_LIST := $(JDK_TOPDIR) $(CORBA_TOPDIR) $(LANGTOOLS_TOPDIR) \
 122     $(HOTSPOT_TOPDIR)
 123 MAKE_MAKEDIR_LIST := make
 124 
 125 # Helper macro for DeclareRecipesForPhase
 126 # Declare a recipe for calling the module and phase specific makefile.
 127 # If there are multiple makefiles to call, create a rule for each topdir
 128 # that contains a makefile with the target $module-$suffix-$repodir,
 129 # (i.e: java.base-gensrc-jdk)
 130 # Normally there is only one makefile, and the target will just be
 131 # $module-$suffix
 132 # Param 1: Name of list to add targets to
 133 # Param 2: Module name
 134 # Param 3: Topdir
 135 define DeclareRecipeForModuleMakefile
 136   ifeq ($$($1_MULTIPLE_MAKEFILES), true)
 137     $2-$$($1_TARGET_SUFFIX): $2-$$($1_TARGET_SUFFIX)-$$(notdir $3)
 138     $1 += $2-$$($1_TARGET_SUFFIX)-$$(notdir $3)
 139 
 140     $2-$$($1_TARGET_SUFFIX)-$$(notdir $3):
 141   else
 142     $2-$$($1_TARGET_SUFFIX):
 143   endif
 144         ifeq ($$($1_USE_WRAPPER), true)
 145           +($(CD) $(SRC_ROOT)/make && $(MAKE) $(MAKE_ARGS) \
 146               -f ModuleWrapper.gmk \
 147                   $$(addprefix -I, $$(wildcard $$(addprefix $3/, $(MAKE_MAKEDIR_LIST)) \
 148                   $$(addsuffix /$$($1_MAKE_SUBDIR), $$(addprefix $3/, $(MAKE_MAKEDIR_LIST))))) \
 149                   MODULE=$2 MAKEFILE_PREFIX=$$($1_FILE_PREFIX))
 150         else
 151           +($(CD) $$(dir $$(firstword $$(wildcard $$(patsubst %, \
 152                   $3/%/$$($1_MAKE_SUBDIR)/$$($1_FILE_PREFIX)-$2.gmk, $(MAKE_MAKEDIR_LIST))))) \
 153             && $(MAKE) $(MAKE_ARGS) \
 154                   -f $$($1_FILE_PREFIX)-$2.gmk \
 155                   $$(addprefix -I, $$(wildcard $$(addprefix $3/, $(MAKE_MAKEDIR_LIST)) \
 156                   $$(addsuffix /$$($1_MAKE_SUBDIR), $$(addprefix $3/, $(MAKE_MAKEDIR_LIST))))) \
 157                   MODULE=$2)
 158         endif
 159 
 160 endef
 161 
 162 # Helper macro for DeclareRecipesForPhase
 163 # Param 1: Name of list to add targets to
 164 # Param 2: Module name
 165 define DeclareRecipesForPhaseAndModule
 166   $1_$2_TOPDIRS := $$(strip $$(sort $$(foreach d, $(MAKE_TOPDIR_LIST), \
 167       $$(patsubst $$d/%, $$d, $$(filter $$d/%, \
 168           $$(wildcard $$(patsubst %, %/$$($1_MAKE_SUBDIR)/$$($1_FILE_PREFIX)-$2.gmk, \
 169           $$(foreach s, $(MAKE_MAKEDIR_LIST), \
 170               $$(addsuffix /$$s, $(MAKE_TOPDIR_LIST))))))))))
 171 
 172   # Only declare recipes if there are makefiles to call
 173   ifneq ($$($1_$2_TOPDIRS), )
 174     ifeq ($(NO_RECIPES),)
 175       $$(foreach d, $$($1_$2_TOPDIRS), \
 176           $$(eval $$(call DeclareRecipeForModuleMakefile,$1,$2,$$d)))
 177     endif
 178     $1 += $2-$$($1_TARGET_SUFFIX)
 179     $1_MODULES += $2
 180   endif
 181 endef
 182 
 183 # Declare recipes for a specific module and build phase if there are makefiles
 184 # present for the specific combination.
 185 # Param 1: Name of list to add targets to
 186 # Named params:
 187 # TARGET_SUFFIX : Suffix of target to create for recipe
 188 # MAKE_SUBDIR : Subdir for this build phase
 189 # FILE_PREFIX : File prefix for this build phase
 190 # USE_WRAPPER : Set to true to use ModuleWrapper.gmk
 191 # CHECK_MODULES : List of modules to try
 192 # MULTIPLE_MAKEFILES : Set to true to handle makefiles for the same module and
 193 #                      phase in multiple repos
 194 # Exported variables:
 195 # $1_MODULES : All modules that had rules generated
 196 # $1_TARGETS : All targets generated
 197 define DeclareRecipesForPhase
 198   $(foreach i,2 3 4 5 6 7, $(if $($i),$(strip $1)_$(strip $($i)))$(NEWLINE))
 199   $(if $(8),$(error Internal makefile error: Too many arguments to \
 200       DeclareRecipesForPhase, please update MakeHelper.gmk))
 201 
 202   $$(foreach m, $$($(strip $1)_CHECK_MODULES), \
 203       $$(eval $$(call DeclareRecipesForPhaseAndModule,$(strip $1),$$m)))
 204 
 205   $(strip $1)_TARGETS := $$($(strip $1))
 206 endef
 207 
 208 ################################################################################
 209 
 210 endif # _MAINSUPPORT_GMK