MainSupport.gmk revision 2716:d48c70fef706
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
30ifndef _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.
35define 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) JIB_JAR=$(JIB_JAR) \
41	    JOBS=$(JOBS) $1) || true
42endef
43
44define 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"
51endef
52
53# Cleans the dir given as $1
54define CleanDir
55	@$(PRINTF) "Cleaning $(strip $1) build artifacts ..."
56	@$(PRINTF) "\n" $(LOG_DEBUG)
57	($(CD) $(OUTPUT_ROOT) && $(RM) -r $1)
58	@$(PRINTF) " done\n"
59endef
60
61define CleanSupportDir
62	@$(PRINTF) "Cleaning $(strip $1) build artifacts ..."
63	@$(PRINTF) "\n" $(LOG_DEBUG)
64	$(RM) -r $(SUPPORT_OUTPUTDIR)/$(strip $1)
65	@$(PRINTF) " done\n"
66endef
67
68define 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"
75endef
76
77define 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"
82endef
83
84define 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"
93endef
94
95define 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"
102endef
103
104define 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"
109endef
110
111define CleanModule
112  $(call Clean-gensrc, $1)
113  $(call Clean-java, $1)
114  $(call Clean-native, $1)
115  $(call Clean-include, $1)
116endef
117
118
119################################################################################
120
121MAKE_TOPDIR_LIST := $(JDK_TOPDIR) $(CORBA_TOPDIR) $(LANGTOOLS_TOPDIR) \
122    $(HOTSPOT_TOPDIR)
123MAKE_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
135define DeclareRecipeForModuleMakefile
136  ifeq ($$($1_MULTIPLE_MAKEFILES), true)
137    $2-$$($1_TARGET_SUFFIX): $2-$$($1_TARGET_SUFFIX)-$$(notdir $3)
138
139    $2-$$($1_TARGET_SUFFIX)-$$(notdir $3):
140  else
141    $2-$$($1_TARGET_SUFFIX):
142  endif
143        ifeq ($$($1_USE_WRAPPER), true)
144	  +($(CD) $(SRC_ROOT)/make && $(MAKE) $(MAKE_ARGS) \
145	      -f ModuleWrapper.gmk \
146	          $$(addprefix -I, $$(wildcard $$(addprefix $3/, $(MAKE_MAKEDIR_LIST)) \
147	          $$(addsuffix /$$($1_MAKE_SUBDIR), $$(addprefix $3/, $(MAKE_MAKEDIR_LIST))))) \
148	          MODULE=$2 MAKEFILE_PREFIX=$$($1_FILE_PREFIX))
149        else
150	  +($(CD) $$(dir $$(firstword $$(wildcard $$(patsubst %, \
151	          $3/%/$$($1_MAKE_SUBDIR)/$$($1_FILE_PREFIX)-$2.gmk, $(MAKE_MAKEDIR_LIST))))) \
152	    && $(MAKE) $(MAKE_ARGS) \
153	          -f $$($1_FILE_PREFIX)-$2.gmk \
154	          $$(addprefix -I, $$(wildcard $$(addprefix $3/, $(MAKE_MAKEDIR_LIST)) \
155	          $$(addsuffix /$$($1_MAKE_SUBDIR), $$(addprefix $3/, $(MAKE_MAKEDIR_LIST))))) \
156	          MODULE=$2)
157        endif
158
159endef
160
161# Helper macro for DeclareRecipesForPhase
162# Param 1: Name of list to add targets to
163# Param 2: Module name
164define DeclareRecipesForPhaseAndModule
165  $1_$2_TOPDIRS := $$(strip $$(sort $$(foreach d, $(MAKE_TOPDIR_LIST), \
166      $$(patsubst $$d/%, $$d, $$(filter $$d/%, \
167          $$(wildcard $$(patsubst %, %/$$($1_MAKE_SUBDIR)/$$($1_FILE_PREFIX)-$2.gmk, \
168          $$(foreach s, $(MAKE_MAKEDIR_LIST), \
169              $$(addsuffix /$$s, $(MAKE_TOPDIR_LIST))))))))))
170
171  # Only declare recipes if there are makefiles to call
172  ifneq ($$($1_$2_TOPDIRS), )
173    # Add the top dir specific target to target list regardless of if recipe
174    # generation is disabled.
175    ifeq ($$($1_MULTIPLE_MAKEFILES), true)
176      $$(foreach d, $$($1_$2_TOPDIRS), \
177        $$(eval $1 += $2-$$($1_TARGET_SUFFIX)-$$(notdir $$d)))
178    endif
179    ifeq ($(NO_RECIPES),)
180      $$(foreach d, $$($1_$2_TOPDIRS), \
181          $$(eval $$(call DeclareRecipeForModuleMakefile,$1,$2,$$d)))
182    endif
183    $1 += $2-$$($1_TARGET_SUFFIX)
184    $1_MODULES += $2
185  endif
186endef
187
188# Declare recipes for a specific module and build phase if there are makefiles
189# present for the specific combination.
190# Param 1: Name of list to add targets to
191# Named params:
192# TARGET_SUFFIX : Suffix of target to create for recipe
193# MAKE_SUBDIR : Subdir for this build phase
194# FILE_PREFIX : File prefix for this build phase
195# USE_WRAPPER : Set to true to use ModuleWrapper.gmk
196# CHECK_MODULES : List of modules to try
197# MULTIPLE_MAKEFILES : Set to true to handle makefiles for the same module and
198#                      phase in multiple repos
199# Exported variables:
200# $1_MODULES : All modules that had rules generated
201# $1_TARGETS : All targets generated
202define DeclareRecipesForPhase
203  $(foreach i,2 3 4 5 6 7, $(if $($i),$(strip $1)_$(strip $($i)))$(NEWLINE))
204  $(if $(8),$(error Internal makefile error: Too many arguments to \
205      DeclareRecipesForPhase, please update MakeHelper.gmk))
206
207  $$(foreach m, $$($(strip $1)_CHECK_MODULES), \
208      $$(eval $$(call DeclareRecipesForPhaseAndModule,$(strip $1),$$m)))
209
210  $(strip $1)_TARGETS := $$($(strip $1))
211endef
212
213################################################################################
214
215endif # _MAINSUPPORT_GMK
216