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