File: LauncherCommon.gmk

package info (click to toggle)
openjdk-27 27~13ea-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 846,032 kB
  • sloc: java: 5,777,901; xml: 1,398,183; cpp: 1,354,255; ansic: 490,634; asm: 404,027; objc: 21,234; sh: 14,666; javascript: 12,730; python: 8,552; makefile: 2,549; perl: 357; awk: 351; pascal: 103; exp: 99; sed: 72; jsp: 24
file content (294 lines) | stat: -rw-r--r-- 11,704 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
#
# Copyright (c) 2011, 2025, Oracle and/or its affiliates. All rights reserved.
# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
#
# This code is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License version 2 only, as
# published by the Free Software Foundation.  Oracle designates this
# particular file as subject to the "Classpath" exception as provided
# by Oracle in the LICENSE file that accompanied this code.
#
# This code is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
# version 2 for more details (a copy is included in the LICENSE file that
# accompanied this code).
#
# You should have received a copy of the GNU General Public License version
# 2 along with this work; if not, write to the Free Software Foundation,
# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
#
# Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
# or visit www.oracle.com if you need additional information or have any
# questions.
#

include MakeIncludeStart.gmk
ifeq ($(INCLUDE), true)

################################################################################

include CopyFiles.gmk
include JdkNativeCompilation.gmk
include Modules.gmk
include ProcessMarkdown.gmk
include $(TOPDIR)/make/ToolsJdk.gmk

LAUNCHER_SRC := $(TOPDIR)/src/java.base/share/native/launcher
LAUNCHER_CFLAGS += -I$(TOPDIR)/src/java.base/share/native/launcher \
    -I$(TOPDIR)/src/java.base/share/native/libjli \
    -I$(TOPDIR)/src/java.base/$(OPENJDK_TARGET_OS_TYPE)/native/libjli \
    -I$(TOPDIR)/src/java.base/$(OPENJDK_TARGET_OS)/native/libjli \
    #
MACOSX_PLIST_DIR := $(TOPDIR)/src/java.base/macosx/native/launcher
JAVA_MANIFEST := $(TOPDIR)/src/java.base/windows/native/launcher/java.manifest

INCLUDED_LAUNCHERS_FILE := $(SUPPORT_OUTPUTDIR)/modules_static-launchers/$(MODULE)/module-included-launchers.txt
INCLUDED_LAUNCHERS :=

################################################################################
# Build standard launcher.

# Setup make rules for building a standard launcher.
#
# Parameter 1 is the name of the rule. This name is used as variable prefix,
# and the targets generated are listed in a variable by that name. It is also
# used as the name of the executable.
#
# Remaining parameters are named arguments. These include:
# MAIN_CLASS   The Java main class to launch
# JAVA_ARGS   Additional arguments to pass to Java when launching the main class
# EXPAND_CLASSPATH_WILDCARDS   Set to true to pass EXPAND_CLASSPATH_WILDCARDS
# ENABLE_ARG_FILES   Set to true to pass ENABLE_ARG_FILES
# WINDOWS_JAVAW   Set to true to pass JAVAW on Windows
# EXTRA_RCFLAGS   Additional EXTRA_RCFLAGS
# MACOSX_PRIVILEGED   On macosx, allow to access other processes
# OPTIMIZATION   Override default optimization level (LOW)
# OUTPUT_DIR   Override default output directory
# VERSION_INFO_RESOURCE   Override default Windows resource file
# STATIC_LAUNCHER   If true, will use settings for building a static launcher
# LIBS   Additional libraries to pass as LIBS argument to SetupJdkExecutable
SetupBuildLauncher = $(NamedParamsMacroTemplate)
define SetupBuildLauncherBody
  # Setup default values (unless overridden)
  ifeq ($$($1_OPTIMIZATION), )
    $1_OPTIMIZATION := LOW
  endif

  $1_MAIN_MODULE := $(MODULE)

  $1_RELAUNCHER_ARGUMENTS :=

  ifneq ($$($1_MAIN_CLASS), )
    $1_JAVA_ARGS += -Xms8m
    $1_LAUNCHER_CLASS := -m $$($1_MAIN_MODULE)/$$($1_MAIN_CLASS)
  endif

  ifeq ($$($1_ENABLE_ARG_FILES), true)
    $1_CFLAGS += -DDISABLE_ARGFILE=JNI_FALSE
  else
    $1_CFLAGS += -DDISABLE_ARGFILE=JNI_TRUE
    # This must be the first argument given, if it should be present
    $1_RELAUNCHER_ARGUMENTS += -DjavaLauncherArgFiles=false
  endif

  ifeq ($$($1_EXPAND_CLASSPATH_WILDCARDS), true)
    $1_CFLAGS += -DCLASSPATH_WILDCARDS=JNI_TRUE
  else
    $1_CFLAGS += -DCLASSPATH_WILDCARDS=JNI_FALSE
    $1_RELAUNCHER_ARGUMENTS += -DjavaLauncherWildcards=false
  endif

  $1_RELAUNCHER_ARGUMENTS += -DjavaLauncherProgname=$1

  ifeq ($(call isTargetOs, windows), true)
    ifeq ($$($1_WINDOWS_JAVAW), true)
      $1_CFLAGS += -DJAVAW
    endif
  endif

  ifneq ($$($1_JAVA_ARGS), )
    $1_PREFIXED_JAVA_ARGS := $$(addprefix -J, $$($1_JAVA_ARGS)) \
        $$($1_LAUNCHER_CLASS)
    $1_JAVA_ARGS_STR := '{ $$(strip $$(foreach a, $$($1_PREFIXED_JAVA_ARGS), \
        "$$a"$(COMMA) )) }'
    $1_CFLAGS += -DJAVA_ARGS=$$($1_JAVA_ARGS_STR)
    # To preserve spaces, substitute them with a hopefully unique pattern
    $1_RELAUNCHER_ARGUMENTS += \
        -DjavaLauncherArgs=$$(subst $$(SPACE),||||,$$($1_PREFIXED_JAVA_ARGS))
  endif

  ifeq ($(call isTargetOs, macosx), true)
    ifeq ($$($1_MACOSX_PRIVILEGED), true)
      $1_PLIST_EXTRA := <key>SecTaskAccess</key><string>allowed</string>
    endif

    $1_PLIST_FILE := $$(SUPPORT_OUTPUTDIR)/native/$$(MODULE)/$1/Info.plist

    $$(eval $$(call SetupTextFileProcessing, BUILD_PLIST_$1, \
        SOURCE_FILES := $(TOPDIR)/make/data/bundle/cmdline-Info.plist.template, \
        OUTPUT_FILE := $$($1_PLIST_FILE), \
        REPLACEMENTS := \
            @@ID@@ => $(MACOSX_BUNDLE_ID_BASE).$1 ; \
            @@VERSION@@ => $(VERSION_NUMBER) ; \
            @@BUILD_VERSION@@ => $(MACOSX_BUNDLE_BUILD_VERSION) ; \
            @@EXTRA@@ => $$($1_PLIST_EXTRA), \
    ))

    $1_LDFLAGS += -sectcreate __TEXT __info_plist $$($1_PLIST_FILE)
  endif

  $1_EXTRA_FILES := $(LAUNCHER_SRC)/main.c

  ifeq ($(ASAN_ENABLED), true)
    $1_EXTRA_FILES += $(TOPDIR)/make/data/asan/asan_default_options.c
  endif

  ifeq ($(LSAN_ENABLED), true)
    $1_EXTRA_FILES += $(TOPDIR)/make/data/lsan/lsan_default_options.c
  endif

  ifneq ($$($1_STATIC_LAUNCHER), true)
      $1_JDK_LIBS := java.base:libjli
      $1_JDK_LIBS_windows := java.base:libjava
  else
    ifneq ($(findstring $(TOOLCHAIN_TYPE), gcc clang), )
      $1_LDFLAGS_FILTER_OUT := -Wl$(COMMA)--exclude-libs$(COMMA)ALL
    endif
  endif

  ##############################################################################
  ## Build launcher "$1"
  ##############################################################################

  $$(eval $$(call SetupJdkExecutable, BUILD_LAUNCHER_$1, \
      NAME := $1, \
      EXTRA_FILES := $$($1_EXTRA_FILES), \
      OPTIMIZATION := $$($1_OPTIMIZATION), \
      CFLAGS := $$(LAUNCHER_CFLAGS) \
          $$(VERSION_CFLAGS) \
          -DLAUNCHER_NAME='"$$(LAUNCHER_NAME)"' \
          -DPROGNAME='"$1"' \
          $$($1_CFLAGS), \
      EXTRA_HEADER_DIRS := java.base:libjvm, \
      JAVA_HEADERS := false, \
      DISABLED_WARNINGS_gcc := unused-function unused-variable, \
      DISABLED_WARNINGS_clang := unused-function, \
      LDFLAGS := $$($1_LDFLAGS), \
      LDFLAGS_linux := $$(call SetExecutableOrigin,/../lib), \
      LDFLAGS_macosx := $$(call SetExecutableOrigin,/../lib), \
      LDFLAGS_FILTER_OUT := $$($1_LDFLAGS_FILTER_OUT), \
      JDK_LIBS := $$($1_JDK_LIBS), \
      JDK_LIBS_windows := $$($1_JDK_LIBS_windows), \
      LIBS := $$($1_LIBS), \
      LINK_TYPE := $$($1_LINK_TYPE), \
      OUTPUT_DIR := $$($1_OUTPUT_DIR), \
      OBJECT_DIR := $$($1_OBJECT_DIR), \
      VERSIONINFO_RESOURCE := $$($1_VERSION_INFO_RESOURCE), \
      EXTRA_RCFLAGS := $$($1_EXTRA_RCFLAGS), \
      MANIFEST := $(JAVA_MANIFEST), \
      MANIFEST_VERSION := $(VERSION_NUMBER_FOUR_POSITIONS), \
  ))

  $1 += $$(BUILD_LAUNCHER_$1)

  $1_RELAUNCHER_ARGUMENTS_FILE := \
      $$(SUPPORT_OUTPUTDIR)/static-native/relaunchers/$$(MODULE)/$1-relauncher-arguments.txt

  $1_VARDEPS := $$($1_RELAUNCHER_ARGUMENTS)
  $1_VARDEPS_FILE := $$(call DependOnVariable, $1_VARDEPS, \
      $$($1_RELAUNCHER_ARGUMENTS_FILE).vardeps)

  $$($1_RELAUNCHER_ARGUMENTS_FILE):
	$$(call MakeDir, $$(@D))
	$$(ECHO) '$$($1_RELAUNCHER_ARGUMENTS)' > $$@

  $1 += $$($1_RELAUNCHER_ARGUMENTS_FILE)

  TARGETS += $$($1)

  # Record the fact that this launcher is part of the current module.
  INCLUDED_LAUNCHERS += $1

  # Add a dependency from this launcher to the launcher list
  $$(INCLUDED_LAUNCHERS_FILE): $$($1)

  $$(BUILD_LAUNCHER_$1): $$(BUILD_PLIST_$1)

  ifeq ($(call isTargetOs, macosx), true)
    $$(BUILD_LAUNCHER_$1): $$($1_PLIST_FILE)
  endif
endef

################################################################################
# Create man pages for jmod to pick up. There should be a one-to-one
# relationship between executables and man pages (even if this is not always
# the case), so piggyback man page generation on the launcher compilation. This
# file may be included from other places as well, so only process man pages
# when called from <module>/Launcher.gmk.

ifeq ($(call isTargetOsType, unix)+$(MAKEFILE_PREFIX), true+Launcher)
  # Only build manpages on unix systems.
  # We assume all our man pages should reside in section 1.

  MAN_FILES_MD := $(wildcard $(addsuffix /*.md, $(call FindModuleManDirs, $(MODULE))))

  ifneq ($(MAN_FILES_MD), )
    ifeq ($(ENABLE_PANDOC), true)
      # Create dynamic man pages from markdown using pandoc. We need
      # PANDOC_TROFF_MANPAGE_FILTER, a wrapper around
      # PANDOC_TROFF_MANPAGE_FILTER_JAVASCRIPT. This is created by buildtools-jdk.

      # We should also depend on the source code for the filter
      PANDOC_TROFF_MANPAGE_FILTER_SOURCE := $(call FindFiles, \
          $(TOPDIR)/make/jdk/src/classes/build/tools/pandocfilter)

      # The norm in man pages is to display code literals as bold, but pandoc
      # "correctly" converts these constructs (encoded in markdown using `...`
      # or ```...```) to \f[C]. Ideally, we should use the filter to encapsulate
      # the Code/CodeBlock in Strong. While this works for Code, pandoc cannot
      # correctly render man page output for CodeBlock wrapped in Strong. So we
      # take the easy way out, and post-process the troff output, replacing
      # \f[C] with \f[CB]. This has the added benefit of working correctly on
      # pandoc prior to version 2.0, which cannot properly produced nested
      # formatting in man pages (see https://github.com/jgm/pandoc/issues/3568).
      #
      # As of pandoc 2.3, the termination of formatting is still broken
      # (see https://github.com/jgm/pandoc/issues/4973). We need to replace
      # \f[] with \f[R].
      MAN_POST_PROCESS := $(SED) -e 's/\\f\[C\]/\\f\[CB\]/g' \
          -e 's/\\f\[\]/\\f\[R\]/g'

      # Now generate the man pages from markdown using pandoc
      $(eval $(call SetupProcessMarkdown, BUILD_MAN_PAGES, \
          DEST := $(SUPPORT_OUTPUTDIR)/modules_man/$(MODULE)/man1, \
          FILES := $(MAN_FILES_MD), \
          FORMAT := man, \
          FILTER := $(PANDOC_TROFF_MANPAGE_FILTER), \
          POST_PROCESS := $(MAN_POST_PROCESS), \
          REPLACEMENTS := \
              @@COPYRIGHT_YEAR@@ => $(COPYRIGHT_YEAR) ; \
              @@VERSION_SHORT@@ => $(VERSION_SHORT) ; \
              @@VERSION_SPECIFICATION@@ => $(VERSION_SPECIFICATION), \
          EXTRA_DEPS := $(PANDOC_TROFF_MANPAGE_FILTER) \
              $(PANDOC_TROFF_MANPAGE_FILTER_SOURCE), \
      ))

      TARGETS += $(BUILD_MAN_PAGES)
    endif
  endif
endif

################################################################################

# We need to keep track of which launchers are created by this module. This
# information is required for static builds, to know which relaunchers to
# create. The file module-included-launchers.txt is then read in StaticLibs.gmk.
$(INCLUDED_LAUNCHERS_FILE):
	$(call MakeDir, $(@D))
	$(ECHO) $(INCLUDED_LAUNCHERS) > $@

TARGETS += $(INCLUDED_LAUNCHERS_FILE)

endif # include guard
include MakeIncludeEnd.gmk