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