Modules.gmk revision 2597:d273234a040d 
1#
2# Copyright (c) 2014, 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
26ifndef _MODULES_GMK
27_MODULES_GMK := 1
28
29################################################################################
30#
31# BOOT_MODULES are modules defined by the boot loader
32# PLATFORM_MODULES are modules defined by the platform loader
33# JRE_TOOL_MODULES are tools included in JRE and defined by the application loader
34#
35# All other modules not declared below are defined by the application loader
36# and are not included in JRE.
37
38BOOT_MODULES :=
39PLATFORM_MODULES :=
40JRE_TOOL_MODULES :=
41UPGRADEABLE_MODULES :=
42AGGREGATOR_MODULES :=
43DOCS_MODULES :=
44
45# Hook to include the corresponding custom file, if present.
46$(eval $(call IncludeCustomExtension, , common/Modules.gmk))
47
48BOOT_MODULES += \
49    java.base \
50    java.datatransfer \
51    java.desktop \
52    java.instrument \
53    java.logging \
54    java.management \
55    java.management.rmi \
56    java.naming \
57    java.prefs \
58    java.rmi \
59    java.security.sasl \
60    java.xml \
61    jdk.httpserver \
62    jdk.internal.vm.ci \
63    jdk.management \
64    jdk.management.agent \
65    jdk.net \
66    jdk.sctp \
67    jdk.unsupported \
68    #
69
70# to be deprivileged
71BOOT_MODULES += \
72    jdk.naming.rmi \
73    #
74
75UPGRADEABLE_MODULES += \
76    java.activation \
77    java.corba \
78    java.transaction \
79    java.xml.bind \
80    java.xml.ws \
81    java.xml.ws.annotation \
82    jdk.internal.vm.compiler \
83    #
84
85# Modules explicitly declared as not being upgradeable even though they require
86# an upgradeable module.
87NON_UPGRADEABLE_MODULES += \
88    jdk.aot \
89    #
90
91AGGREGATOR_MODULES += \
92    java.se \
93    java.se.ee \
94    #
95
96PLATFORM_MODULES += \
97    $(UPGRADEABLE_MODULES) \
98    $(AGGREGATOR_MODULES)
99    #
100
101PLATFORM_MODULES += \
102    java.compiler \
103    java.scripting \
104    java.security.jgss \
105    java.smartcardio \
106    java.sql \
107    java.sql.rowset \
108    java.xml.crypto \
109    jdk.accessibility \
110    jdk.charsets \
111    jdk.crypto.cryptoki \
112    jdk.crypto.ec \
113    jdk.dynalink \
114    jdk.incubator.httpclient \
115    jdk.jsobject \
116    jdk.localedata \
117    jdk.naming.dns \
118    jdk.scripting.nashorn \
119    jdk.security.auth \
120    jdk.security.jgss \
121    jdk.xml.dom \
122    jdk.zipfs \
123    #
124
125ifeq ($(OPENJDK_TARGET_OS), windows)
126  PLATFORM_MODULES += jdk.crypto.mscapi
127endif
128
129ifeq ($(OPENJDK_TARGET_OS), solaris)
130  PLATFORM_MODULES += jdk.crypto.ucrypto
131endif
132
133JRE_TOOL_MODULES += \
134    jdk.jdwp.agent \
135    jdk.pack \
136    jdk.scripting.nashorn.shell \
137    #
138
139################################################################################
140
141# DOCS_MODULES defines the root modules for javadoc generation.
142# All of their `require transitive` modules directly and indirectly will be included.
143DOCS_MODULES += \
144    java.se.ee \
145    java.smartcardio \
146    jdk.accessibility \
147    jdk.attach \
148    jdk.charsets \
149    jdk.compiler \
150    jdk.crypto.cryptoki \
151    jdk.crypto.ec \
152    jdk.dynalink \
153    jdk.editpad \
154    jdk.hotspot.agent \
155    jdk.httpserver \
156    jdk.incubator.httpclient \
157    jdk.jartool \
158    jdk.javadoc \
159    jdk.jcmd \
160    jdk.jconsole \
161    jdk.jdeps \
162    jdk.jdi \
163    jdk.jdwp.agent \
164    jdk.jlink \
165    jdk.jsobject \
166    jdk.jshell \
167    jdk.jstatd \
168    jdk.localedata \
169    jdk.management \
170    jdk.management.agent \
171    jdk.naming.dns \
172    jdk.naming.rmi \
173    jdk.net \
174    jdk.pack \
175    jdk.policytool \
176    jdk.rmic \
177    jdk.scripting.nashorn \
178    jdk.sctp \
179    jdk.security.auth \
180    jdk.security.jgss \
181    jdk.xml.dom \
182    jdk.zipfs \
183    #
184
185# These modules are included in the interim image which is used to run profiling
186# before building the real images.
187INTERIM_IMAGE_MODULES := java.base java.logging
188
189################################################################################
190# Some platforms don't have the serviceability agent
191
192ifeq ($(INCLUDE_SA), false)
193  MODULES_FILTER += jdk.hotspot.agent
194endif
195
196################################################################################
197# Filter out Graal specific modules if Graal build is disabled
198
199ifeq ($(INCLUDE_GRAAL), false)
200  MODULES_FILTER += jdk.internal.vm.compiler
201endif
202
203################################################################################
204# Filter out aot specific modules if aot is disabled
205
206ifeq ($(ENABLE_AOT), false)
207  MODULES_FILTER += jdk.aot
208endif
209
210################################################################################
211# Module list macros
212
213# Use append so that the custom extension may add to these variables
214
215GENERATED_SRC_DIRS += \
216    $(SUPPORT_OUTPUTDIR)/gensrc \
217    #
218
219TOP_SRC_DIRS += \
220    $(CORBA_TOPDIR)/src \
221    $(HOTSPOT_TOPDIR)/src \
222    $(JDK_TOPDIR)/src \
223    $(LANGTOOLS_TOPDIR)/src \
224    $(JAXP_TOPDIR)/src \
225    $(JAXWS_TOPDIR)/src \
226    $(NASHORN_TOPDIR)/src \
227    #
228
229SRC_SUBDIRS += $(OPENJDK_TARGET_OS)/classes
230ifneq ($(OPENJDK_TARGET_OS), $(OPENJDK_TARGET_OS_TYPE))
231  SRC_SUBDIRS += $(OPENJDK_TARGET_OS_TYPE)/classes
232endif
233SRC_SUBDIRS += share/classes
234
235SPEC_SUBDIRS += share/specs
236
237# Find all module-info.java files for the current build target platform and
238# configuration.
239# Param 1 - Module to find for, set to * for finding all
240FindAllModuleInfos = \
241    $(wildcard \
242        $(foreach sub, $(SRC_SUBDIRS), \
243          $(patsubst %,%/$(strip $1)/$(sub)/module-info.java, $(TOP_SRC_DIRS))) \
244        $(patsubst %,%/$(strip $1)/module-info.java, $(IMPORT_MODULES_SRC)))
245
246# Find module-info.java files in the specific source dir
247# Param 1 - Src dir to find module-info.java files in
248FindModuleInfosForSrcDir = \
249    $(wildcard \
250        $(foreach sub, $(SRC_SUBDIRS), \
251          $(patsubst %,%/*/$(sub)/module-info.java, $(strip $1)) \
252        ) \
253        $(patsubst %,%/*/module-info.java, $(strip $1)) \
254    )
255
256# Extract the module names from the paths of module-info.java files. The
257# position of the module directory differs depending on if this is an imported
258# src dir or not.
259GetModuleNameFromModuleInfo = \
260    $(strip $(foreach mi, $1, \
261      $(if $(filter $(addsuffix %, $(IMPORT_MODULES_SRC)), $(mi)), \
262        $(notdir $(patsubst %/,%, $(dir $(mi)))), \
263        $(notdir $(patsubst %/,%, $(dir $(patsubst %/,%, $(dir $(patsubst %/,%, $(dir $(mi)))))))))))
264
265# Find all modules by looking for module-info.java files and looking at parent
266# directories.
267FindAllModules = \
268    $(sort $(filter-out $(MODULES_FILTER), \
269    $(call GetModuleNameFromModuleInfo, $(MODULE_INFOS))))
270
271# Find all modules in a specific src dir
272# Param 1 - Src dir to find modules in
273FindModulesForSrcDir = \
274    $(sort $(filter-out $(MODULES_FILTER), \
275        $(call GetModuleNameFromModuleInfo, $(call FindModuleInfosForSrcDir, $1)) \
276    ))
277
278FindImportedModules = \
279    $(filter-out $(MODULES_FILTER), \
280    $(if $(IMPORT_MODULES_CLASSES), $(notdir $(wildcard $(IMPORT_MODULES_CLASSES)/*))))
281
282# Find all source dirs for a particular module
283# $1 - Module to find source dirs for
284FindModuleSrcDirs = \
285    $(strip $(wildcard \
286        $(addsuffix /$(strip $1), $(GENERATED_SRC_DIRS) $(IMPORT_MODULES_SRC)) \
287        $(foreach sub, $(SRC_SUBDIRS), $(addsuffix /$(strip $1)/$(sub), $(TOP_SRC_DIRS)))))
288
289# Find all specs dirs for a particular module
290# $1 - Module to find specs dirs for
291FindModuleSpecsDirs = \
292    $(strip $(wildcard \
293        $(foreach sub, $(SPEC_SUBDIRS), $(addsuffix /$(strip $1)/$(sub), $(TOP_SRC_DIRS)))))
294
295# Construct the complete module source path
296GetModuleSrcPath = \
297    $(call PathList, \
298        $(addsuffix /*, $(GENERATED_SRC_DIRS) $(IMPORT_MODULES_SRC)) \
299        $(foreach sub, $(SRC_SUBDIRS), $(addsuffix /*/$(sub), $(TOP_SRC_DIRS))))
300
301################################################################################
302# Extract module dependencies from module-info.java files, both normal
303# dependencies ("requires"), and indirect exports ("requires transitive").
304
305MODULE_DEPS_MAKEFILE := $(MAKESUPPORT_OUTPUTDIR)/module-deps.gmk
306
307MODULE_INFOS := $(call FindAllModuleInfos, *)
308
309$(MODULE_DEPS_MAKEFILE): $(MODULE_INFOS) \
310    $(call DependOnVariable, MODULE_INFOS, $(MAKESUPPORT_OUTPUTDIR)/MODULE_INFOS.vardeps)
311	$(MKDIR) -p $(@D)
312	$(RM) $@
313	$(foreach m, $(MODULE_INFOS), \
314	    ( $(PRINTF) "DEPS_$(call GetModuleNameFromModuleInfo, $m) :=" && \
315	      $(NAWK) -v MODULE=$(call GetModuleNameFromModuleInfo, $m) '\
316	          BEGIN      { if (MODULE != "java.base") printf(" java.base"); } \
317	          /^ *requires/ { sub(/;/, ""); \
318	                          sub(/requires/, ""); \
319	                          sub(/transitive/, ""); \
320	                          sub(/\/\/.*/, ""); \
321	                          sub(/\/\*.*\*\//, ""); \
322	                          gsub(/^ +\*.*/, ""); \
323	                          gsub(/ /, ""); \
324	                          printf(" %s", $$0) } \
325	          END           { printf("\n") }' $m && \
326	      $(PRINTF) "TRANSITIVE_MODULES_$(call GetModuleNameFromModuleInfo, $m) :=" && \
327	      $(NAWK) -v MODULE=$(call GetModuleNameFromModuleInfo, $m) '\
328	          BEGIN      { if (MODULE != "java.base") printf(" java.base"); } \
329	          /^ *requires  *transitive/ { \
330	                          sub(/;/, ""); \
331	                          sub(/requires/, ""); \
332	                          sub(/transitive/, ""); \
333	                          sub(/\/\/.*/, ""); \
334	                          sub(/\/\*.*\*\//, ""); \
335	                          gsub(/^ +\*.*/, ""); \
336	                          gsub(/ /, ""); \
337	                          printf(" %s", $$0) } \
338	          END           { printf("\n") }' $m \
339	    ) >> $@ $(NEWLINE))
340
341-include $(MODULE_DEPS_MAKEFILE)
342
343# Find dependencies ("requires") for a given module.
344# Param 1: Module to find dependencies for.
345FindDepsForModule = \
346  $(DEPS_$(strip $1))
347
348# Find dependencies ("requires") transitively in 3 levels for a given module.
349# Param 1: Module to find dependencies for.
350FindTransitiveDepsForModule = \
351    $(sort $(call FindDepsForModule, $1) \
352        $(foreach m, $(call FindDepsForModule, $1), \
353            $(call FindDepsForModule, $m) \
354            $(foreach n, $(call FindDepsForModule, $m), \
355                 $(call FindDepsForModule, $n))))
356
357# Find dependencies ("requires") transitively in 3 levels for a set of modules.
358# Param 1: List of modules to find dependencies for.
359FindTransitiveDepsForModules = \
360    $(sort $(foreach m, $1, $(call FindTransitiveDepsForModule, $m)))
361
362# Find indirect exported modules ("requires transitive") for a given module .
363# Param 1: Module to find indirect exported modules for.
364FindIndirectExportsForModule = \
365  $(TRANSITIVE_MODULES_$(strip $1))
366
367# Finds indirect exported modules transitively in 3 levels for a given module.
368# Param 1: Module to find indirect exported modules for.
369FindTransitiveIndirectDepsForModule = \
370    $(sort $(call FindIndirectExportsForModule, $1) \
371        $(foreach m, $(call FindIndirectExportsForModule, $1), \
372            $(call FindIndirectExportsForModule, $m) \
373            $(foreach n, $(call FindIndirectExportsForModule, $m), \
374                 $(call FindIndirectExportsForModule, $n))))
375
376# Finds indirect exported modules transitively in 3 levels for a set of modules.
377# Param 1: List of modules to find indirect exported modules for.
378FindTransitiveIndirectDepsForModules = \
379    $(sort $(foreach m, $1, $(call FindTransitiveIndirectDepsForModule, $m)))
380
381# Upgradeable modules are those that are either defined as upgradeable or that
382# require an upradeable module.
383FindAllUpgradeableModules = \
384    $(filter-out $(MODULES_FILTER) $(NON_UPGRADEABLE_MODULES), \
385        $(sort $(UPGRADEABLE_MODULES) $(foreach m, \
386            $(filter-out $(UPGRADEABLE_MODULES), $(call FindAllModules)), \
387          $(if $(filter $(UPGRADEABLE_MODULES), \
388              $(call FindTransitiveDepsForModule, $m)), \
389            $m \
390          ) \
391        )) \
392    )
393
394################################################################################
395
396LEGAL_SUBDIRS += $(OPENJDK_TARGET_OS)/legal
397ifneq ($(OPENJDK_TARGET_OS), $(OPENJDK_TARGET_OS_TYPE))
398  LEGAL_SUBDIRS += $(OPENJDK_TARGET_OS_TYPE)/legal
399endif
400LEGAL_SUBDIRS += share/legal
401
402# Find all legal dirs for a particular module
403# $1 - Module to find legal dirs for
404FindModuleLegalDirs = \
405    $(strip $(wildcard \
406        $(addsuffix /$(strip $1), $(IMPORT_MODULES_LEGAL)) \
407        $(foreach sub, $(LEGAL_SUBDIRS), $(addsuffix /$(strip $1)/$(sub), $(TOP_SRC_DIRS)))))
408
409################################################################################
410
411# Param 1 - Name of module
412define ReadSingleImportMetaData
413    ifneq ($$(wildcard $(IMPORT_MODULES_MAKE)/$$(strip $1)/build.properties), )
414      classloader :=
415      include_in_jre :=
416      include_in_jdk :=
417      include $(IMPORT_MODULES_MAKE)/$$(strip $1)/build.properties
418      ifeq ($$(include_in_jre), true)
419        JRE_MODULES += $1
420      endif
421      ifeq ($$(include_in_jdk), true)
422        JDK_MODULES += $1
423      endif
424      ifeq ($$(classloader), boot)
425        BOOT_MODULES += $1
426      else ifeq ($$(classloader), ext)
427        PLATFORM_MODULES += $1
428      endif
429      ifneq ($$(include_in_docs), false)
430        # defaults to true if unspecified
431        DOCS_MODULES += $1
432      endif
433    else
434      # Default to include in all
435      JRE_MODULES += $1
436      JDK_MODULES += $1
437    endif
438endef
439
440# Reading the imported modules metadata has a cost, so to make it available,
441# a makefile needs to eval-call this macro first. After calling this, the
442# following variables are populated with data from the imported modules:
443# * JRE_MODULES
444# * JDK_MODULES
445# * BOOT_MODULES
446# * PLATFORM_MODULES
447# * JRE_TOOL_MODULES
448define ReadImportMetaData
449    IMPORTED_MODULES := $$(call FindImportedModules)
450    $$(foreach m, $$(IMPORTED_MODULES), \
451      $$(eval $$(call ReadSingleImportMetaData, $$m)))
452endef
453
454################################################################################
455
456endif # _MODULES_GMK
457