1 #
2 # Copyright (c) 2011, 2019, 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 include JdkNativeCompilation.gmk
27 include Modules.gmk
28 include ProcessMarkdown.gmk
29 include ToolsJdk.gmk
30
31 # Tell the compiler not to export any functions unless declared so in
32 # the source code. On Windows, this is the default and cannot be changed.
33 # On Mac, we have always exported all symbols, probably due to oversight
34 # and/or misunderstanding. To emulate this, don't hide any symbols
35 # by default.
36 # On AIX/xlc we need at least xlc 13.1 for the symbol hiding (see JDK-8214063)
37 # Also provide an override for non-conformant libraries.
38 ifeq ($(TOOLCHAIN_TYPE), gcc)
39 LAUNCHER_CFLAGS += -fvisibility=hidden
40 LDFLAGS_JDKEXE += -Wl,--exclude-libs,ALL
41 else ifeq ($(TOOLCHAIN_TYPE), clang)
42 LAUNCHER_CFLAGS += -fvisibility=hidden
43 else ifeq ($(TOOLCHAIN_TYPE), solstudio)
44 LAUNCHER_CFLAGS += -xldscope=hidden
45 endif
46
47 LAUNCHER_SRC := $(TOPDIR)/src/java.base/share/native/launcher
48 LAUNCHER_CFLAGS += -I$(TOPDIR)/src/java.base/share/native/launcher \
49 -I$(TOPDIR)/src/java.base/share/native/libjli \
50 -I$(TOPDIR)/src/java.base/$(OPENJDK_TARGET_OS_TYPE)/native/libjli \
51 -I$(TOPDIR)/src/java.base/$(OPENJDK_TARGET_OS)/native/libjli \
52 #
53 GLOBAL_VERSION_INFO_RESOURCE := $(TOPDIR)/src/java.base/windows/native/common/version.rc
54 MACOSX_PLIST_DIR := $(TOPDIR)/src/java.base/macosx/native/launcher
55 JAVA_MANIFEST := $(TOPDIR)/src/java.base/windows/native/launcher/java.manifest
56
57 ################################################################################
58 # Build standard launcher.
59
60 # Setup make rules for building a standard launcher.
61 #
62 # Parameter 1 is the name of the rule. This name is used as variable prefix,
63 # and the targets generated are listed in a variable by that name. It is also
64 # used as the name of the executable.
65 #
66 # Remaining parameters are named arguments. These include:
67 # MAIN_MODULE The module of the main class to launch if different from the
68 # current module
69 # MAIN_CLASS The Java main class to launch
70 # JAVA_ARGS Processed into a -DJAVA_ARGS and added to CFLAGS
71 # EXTRA_JAVA_ARGS Processed into a -DEXTRA_JAVA_ARGS and is prepended
72 # before JAVA_ARGS to CFLAGS, primarily to allow long string literal
73 # compile time defines exceeding Visual Studio 2013 limitations.
74 # CFLAGS Additional CFLAGS
75 # CFLAGS_windows Additional CFLAGS_windows
76 # EXTRA_RC_FLAGS Additional EXTRA_RC_FLAGS
77 # MACOSX_PRIVILEGED On macosx, allow to access other processes
78 # OPTIMIZATION Override default optimization level (LOW)
79 # OUTPUT_DIR Override default output directory
80 # VERSION_INFO_RESOURCE Override default Windows resource file
81 SetupBuildLauncher = $(NamedParamsMacroTemplate)
82 define SetupBuildLauncherBody
83 # Setup default values (unless overridden)
84 ifeq ($$($1_OPTIMIZATION), )
85 $1_OPTIMIZATION := LOW
86 endif
87
88 ifeq ($$($1_MAIN_MODULE), )
89 $1_MAIN_MODULE := $(MODULE)
90 endif
91
92 $1_JAVA_ARGS += -ms8m
93 ifneq ($$($1_MAIN_CLASS), )
94 $1_LAUNCHER_CLASS := -m $$($1_MAIN_MODULE)/$$($1_MAIN_CLASS)
95 endif
96
97 ifneq ($$($1_EXTRA_JAVA_ARGS), )
98 $1_EXTRA_JAVA_ARGS_STR := '{ $$(strip $$(foreach a, \
99 $$(addprefix -J, $$($1_EXTRA_JAVA_ARGS)), "$$a"$(COMMA) )) }'
100 $1_CFLAGS += -DEXTRA_JAVA_ARGS=$$($1_EXTRA_JAVA_ARGS_STR)
101 endif
102 $1_JAVA_ARGS_STR := '{ $$(strip $$(foreach a, \
103 $$(addprefix -J, $$($1_JAVA_ARGS)) $$($1_LAUNCHER_CLASS), "$$a"$(COMMA) )) }'
104 $1_CFLAGS += -DJAVA_ARGS=$$($1_JAVA_ARGS_STR)
105
106 ifeq ($(call isTargetOs, macosx), true)
107 ifeq ($$($1_MACOSX_PRIVILEGED), true)
108 $1_PLIST_FILE := Info-privileged.plist
109 else
110 $1_PLIST_FILE := Info-cmdline.plist
111 endif
112
113 $1_LDFLAGS += -sectcreate __TEXT __info_plist $(MACOSX_PLIST_DIR)/$$($1_PLIST_FILE)
114
115 ifeq ($(STATIC_BUILD), true)
116 $1_LDFLAGS += -exported_symbols_list \
117 $(SUPPORT_OUTPUTDIR)/build-static/exported.symbols
118 $1_LIBS += \
119 $$(shell $(FIND) $(SUPPORT_OUTPUTDIR)/modules_libs/java.base -name "*.a") \
120 $(SUPPORT_OUTPUTDIR)/modules_libs/jdk.jdwp.agent/libdt_socket.a \
121 $(SUPPORT_OUTPUTDIR)/modules_libs/jdk.jdwp.agent/libjdwp.a \
122 $(SUPPORT_OUTPUTDIR)/native/java.base/$(LIBRARY_PREFIX)fdlibm$(STATIC_LIBRARY_SUFFIX) \
123 -framework CoreFoundation \
124 -framework Foundation \
125 -framework SystemConfiguration \
126 -lstdc++ -liconv
127 endif
128 endif
129
130 ifeq ($(USE_EXTERNAL_LIBZ), true)
131 $1_LIBS += -lz
132 endif
133
134 $1_WINDOWS_JLI_LIB := $(call FindStaticLib, java.base, jli, /libjli)
135
136 $$(eval $$(call SetupJdkExecutable, BUILD_LAUNCHER_$1, \
137 NAME := $1, \
138 EXTRA_FILES := $(LAUNCHER_SRC)/main.c, \
139 OPTIMIZATION := $$($1_OPTIMIZATION), \
140 CFLAGS := $$(CFLAGS_JDKEXE) \
141 $$(LAUNCHER_CFLAGS) \
142 $$(VERSION_CFLAGS) \
143 -DLAUNCHER_NAME='"$$(LAUNCHER_NAME)"' \
144 -DPROGNAME='"$1"' \
145 $$($1_CFLAGS), \
146 CFLAGS_solaris := -KPIC -DHAVE_GETHRTIME, \
147 CFLAGS_windows := $$($1_CFLAGS_windows), \
148 DISABLED_WARNINGS_gcc := unused-function, \
149 LDFLAGS := $$(LDFLAGS_JDKEXE) \
150 $$(call SET_EXECUTABLE_ORIGIN) \
151 $$($1_LDFLAGS), \
152 LDFLAGS_linux := $$(call SET_EXECUTABLE_ORIGIN,/../lib) \
153 -L$(call FindLibDirForModule, java.base), \
154 LDFLAGS_macosx := $$(call SET_EXECUTABLE_ORIGIN,/../lib) \
155 -L$(call FindLibDirForModule, java.base), \
156 LDFLAGS_solaris := $$(call SET_EXECUTABLE_ORIGIN,/../lib) \
157 -L$(call FindLibDirForModule, java.base), \
158 LDFLAGS_aix := -L$(SUPPORT_OUTPUTDIR)/native/java.base, \
159 LIBS := $(JDKEXE_LIBS) $$($1_LIBS), \
160 LIBS_linux := -ljli -lpthread $(LIBDL), \
161 LIBS_macosx := -ljli -framework Cocoa -framework Security \
162 -framework ApplicationServices, \
163 LIBS_solaris := -ljli -lthread $(LIBDL), \
164 LIBS_aix := -ljli_static, \
165 LIBS_windows := $$($1_WINDOWS_JLI_LIB) \
166 $(SUPPORT_OUTPUTDIR)/native/java.base/libjava/java.lib, \
167 OUTPUT_DIR := $$($1_OUTPUT_DIR), \
168 VERSIONINFO_RESOURCE := $$($1_VERSION_INFO_RESOURCE), \
169 EXTRA_RC_FLAGS := $$($1_EXTRA_RC_FLAGS), \
170 MANIFEST := $(JAVA_MANIFEST), \
171 MANIFEST_VERSION := $(VERSION_NUMBER_FOUR_POSITIONS), \
172 ))
173
174 $1 += $$(BUILD_LAUNCHER_$1)
175 TARGETS += $$($1)
176
177 ifeq ($(call isTargetOs, aix), true)
178 $$(BUILD_LAUNCHER_$1): $(call FindStaticLib, java.base, jli_static)
179 endif
180
181 ifeq ($(call isTargetOs, windows), true)
182 $$(BUILD_LAUNCHER_$1): $(call FindStaticLib, java.base, java, /libjava) \
183 $$($1_WINDOWS_JLI_LIB)
184 endif
185 endef
186
187 ################################################################################
188 # Create man pages for jmod to pick up. There should be a one-to-one
189 # relationship between executables and man pages (even if this is not always
190 # the case), so piggyback man page generation on the launcher compilation.
191
192 ifeq ($(call isTargetOsType, unix), true)
193 # Only build manpages on unix systems.
194 # We assume all our man pages should reside in section 1.
195
196 MAN_FILES_MD := $(wildcard $(addsuffix /*.md, $(call FindModuleManDirs, $(MODULE))))
197 MAN_FILES_TROFF := $(wildcard $(addsuffix /*.1, $(call FindModuleManDirs, $(MODULE))))
198
199 ifneq ($(MAN_FILES_MD), )
200 # If we got markdown files, ignore the troff files
201 ifeq ($(ENABLE_PANDOC), false)
202 $(info Warning: pandoc not found. Not generating man pages)
203 else
204 # Create dynamic man pages from markdown using pandoc. We need
205 # PANDOC_TROFF_MANPAGE_FILTER, a wrapper around
206 # PANDOC_TROFF_MANPAGE_FILTER_JAVASCRIPT. This is created by buildtools-jdk.
207
208 # We should also depend on the source javascript filter
209 PANDOC_TROFF_MANPAGE_FILTER_JAVASCRIPT := \
210 $(TOPDIR)/make/scripts/pandoc-troff-manpage-filter.js
211
212 # The norm in man pages is to display code literals as bold, but pandoc
213 # "correctly" converts these constructs (encoded in markdown using `...`
214 # or ```...```) to \f[C]. Ideally, we should use the filter to encapsulate
215 # the Code/CodeBlock in Strong. While this works for Code, pandoc cannot
216 # correctly render man page output for CodeBlock wrapped in Strong. So we
217 # take the easy way out, and post-process the troff output, replacing
218 # \f[C] with \f[CB]. This has the added benefit of working correctly on
219 # pandoc prior to version 2.0, which cannot properly produced nested
220 # formatting in man pages (see https://github.com/jgm/pandoc/issues/3568).
221 #
222 # As of pandoc 2.3, the termination of formatting is still broken
223 # (see https://github.com/jgm/pandoc/issues/4973). We need to replace
224 # \f[] with \f[R].
225 MAN_POST_PROCESS := $(SED) -e 's/\\f\[C\]/\\f\[CB\]/g' \
226 -e 's/\\f\[\]/\\f\[R\]/g'
227
228 # Now generate the man pages from markdown using pandoc
229 $(eval $(call SetupProcessMarkdown, BUILD_MAN_PAGES, \
230 DEST := $(SUPPORT_OUTPUTDIR)/modules_man/$(MODULE)/man1, \
231 FILES := $(MAN_FILES_MD), \
232 FORMAT := man, \
233 FILTER := $(PANDOC_TROFF_MANPAGE_FILTER), \
234 POST_PROCESS := $(MAN_POST_PROCESS), \
235 REPLACEMENTS := @@VERSION_SHORT@@ => $(VERSION_SHORT), \
236 EXTRA_DEPS := $(PANDOC_TROFF_MANPAGE_FILTER) \
237 $(PANDOC_TROFF_MANPAGE_FILTER_JAVASCRIPT), \
238 ))
239
240 TARGETS += $(BUILD_MAN_PAGES)
241 endif
242 else
243 # No markdown man pages present
244 ifeq ($(BUILD_MANPAGES), true)
245 # BUILD_MANPAGES is a mis-nomer. It really means "copy the pre-generated man pages".
246 $(eval $(call SetupCopyFiles, COPY_MAN_PAGES, \
247 DEST := $(SUPPORT_OUTPUTDIR)/modules_man/$(MODULE)/man1, \
248 FILES := $(MAN_FILES_TROFF), \
249 ))
250
251 TARGETS += $(COPY_MAN_PAGES)
252 endif
253 endif
254 endif