MainSupport.gmk revision 1725:d7f1098c2fc8
1#
2# Copyright (c) 2011, 2015, 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.
34define RunTests
35	($(CD) $(SRC_ROOT)/test && $(MAKE) $(MAKE_ARGS) -j1 -k MAKEFLAGS= \
36	    JT_HOME=$(JT_HOME) PRODUCT_HOME=$(JDK_IMAGE_DIR) \
37	    TEST_IMAGE_DIR=$(TEST_IMAGE_DIR) \
38	    ALT_OUTPUTDIR=$(OUTPUT_ROOT) CONCURRENCY=$(JOBS) $1) || true
39endef
40
41# Cleans the dir given as $1
42define CleanDir
43	@$(PRINTF) "Cleaning $(strip $1) build artifacts ..."
44	@$(PRINTF) "\n" $(LOG_DEBUG)
45	($(CD) $(OUTPUT_ROOT) && $(RM) -r $1)
46	@$(PRINTF) " done\n"
47endef
48
49define CleanSupportDir
50	@$(PRINTF) "Cleaning $(strip $1) build artifacts ..."
51	@$(PRINTF) "\n" $(LOG_DEBUG)
52	$(RM) -r $(SUPPORT_OUTPUTDIR)/$(strip $1)
53	@$(PRINTF) " done\n"
54endef
55
56define CleanTest
57	@$(PRINTF) "Cleaning test $(strip $1) ..."
58	@$(PRINTF) "\n" $(LOG_DEBUG)
59	$(RM) -r $(SUPPORT_OUTPUTDIR)/test/$(strip $(subst -,/,$1))
60        # Remove as much of the test directory structure as is empty
61	$(RMDIR) -p $(dir $(SUPPORT_OUTPUTDIR)/test/$(strip $(subst -,/,$1))) 2> /dev/null || true
62	@$(PRINTF) " done\n"
63endef
64
65define Clean-gensrc
66	@$(PRINTF) "Cleaning gensrc $(if $1,for $(strip $1) )..."
67	@$(PRINTF) "\n" $(LOG_DEBUG)
68	$(RM) -r $(SUPPORT_OUTPUTDIR)/gensrc/$(strip $1)
69	$(RM) -r $(SUPPORT_OUTPUTDIR)/gensrc_no_docs/$(strip $1)
70	@$(PRINTF) " done\n"
71endef
72
73define 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"
82endef
83
84define 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_libs-stripped/$(strip $1)
90	$(RM) -r $(SUPPORT_OUTPUTDIR)/modules_cmds/$(strip $1)
91	$(RM) -r $(SUPPORT_OUTPUTDIR)/modules_cmds-stripped/$(strip $1)
92	@$(PRINTF) " done\n"
93endef
94
95define 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"
100endef
101
102define Clean-docs
103	@$(PRINTF) "Cleaning docs ..."
104	@$(PRINTF) "\n" $(LOG_DEBUG)
105	$(RM) -r $(SUPPORT_OUTPUTDIR)/docs
106	$(RM) -r $(IMAGES_OUTPUTDIR)/docs
107	@$(PRINTF) " done\n"
108endef
109
110define CleanModule
111  $(call Clean-gensrc, $1)
112  $(call Clean-java, $1)
113  $(call Clean-native, $1)
114  $(call Clean-include, $1)
115endef
116
117
118################################################################################
119
120MAKE_TOPDIR_LIST := $(JDK_TOPDIR) $(CORBA_TOPDIR) $(LANGTOOLS_TOPDIR) \
121    $(HOTSPOT_TOPDIR)
122MAKE_MAKEDIR_LIST := make
123
124# Helper macro for DeclareRecipesForPhase
125# Declare a recipe for calling the module and phase specific makefile.
126# If there are multiple makefiles to call, create a rule for each topdir
127# that contains a makefile with the target $module-$suffix-$repodir,
128# (i.e: java.base-gensrc-jdk)
129# Normally there is only one makefile, and the target will just be
130# $module-$suffix
131# Param 1: Name of list to add targets to
132# Param 2: Module name
133# Param 3: Topdir
134define DeclareRecipeForModuleMakefile
135  ifeq ($$($1_MULTIPLE_MAKEFILES), true)
136    $2-$$($1_TARGET_SUFFIX): $2-$$($1_TARGET_SUFFIX)-$$(notdir $3)
137    $1 += $2-$$($1_TARGET_SUFFIX)-$$(notdir $3)
138
139    $2-$$($1_TARGET_SUFFIX)-$$(notdir $3):
140  else
141    $2-$$($1_TARGET_SUFFIX):
142  endif
143	$(ECHO) $(LOG_INFO) "Building $$@"
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
160endef
161
162# Helper macro for DeclareRecipesForPhase
163# Param 1: Name of list to add targets to
164# Param 2: Module name
165define 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
181endef
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
197define 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))
206endef
207
208################################################################################
209
210endif # _MAINSUPPORT_GMK
211