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 # LDFLAGS_solaris Additional LDFLAGS_solaris
  77 # RC_FLAGS   Additional RC_FLAGS
  78 # MACOSX_SIGNED   On macosx, sign this binary
  79 # OPTIMIZATION   Override default optimization level (LOW)
  80 # OUTPUT_DIR   Override default output directory
  81 # VERSION_INFO_RESOURCE   Override default Windows resource file
  82 SetupBuildLauncher = $(NamedParamsMacroTemplate)
  83 define SetupBuildLauncherBody
  84   # Setup default values (unless overridden)
  85   ifeq ($$($1_OPTIMIZATION), )
  86     $1_OPTIMIZATION := LOW
  87   endif
  88 
  89   ifeq ($$($1_MAIN_MODULE), )
  90     $1_MAIN_MODULE := $(MODULE)
  91   endif
  92 
  93   $1_JAVA_ARGS += -ms8m
  94   ifneq ($$($1_MAIN_CLASS), )
  95     $1_LAUNCHER_CLASS := -m $$($1_MAIN_MODULE)/$$($1_MAIN_CLASS)
  96   endif
  97 
  98   ifneq ($$($1_EXTRA_JAVA_ARGS), )
  99     $1_EXTRA_JAVA_ARGS_STR := '{ $$(strip $$(foreach a, \
 100       $$(addprefix -J, $$($1_EXTRA_JAVA_ARGS)), "$$a"$(COMMA) )) }'
 101     $1_CFLAGS += -DEXTRA_JAVA_ARGS=$$($1_EXTRA_JAVA_ARGS_STR)
 102   endif
 103   $1_JAVA_ARGS_STR := '{ $$(strip $$(foreach a, \
 104       $$(addprefix -J, $$($1_JAVA_ARGS)) $$($1_LAUNCHER_CLASS), "$$a"$(COMMA) )) }'
 105   $1_CFLAGS += -DJAVA_ARGS=$$($1_JAVA_ARGS_STR)
 106 
 107   ifeq ($(call isTargetOs, macosx), true)
 108     ifeq ($$($1_MACOSX_SIGNED), true)
 109       $1_PLIST_FILE := Info-privileged.plist
 110         $1_CODESIGN := true
 111     else
 112       $1_PLIST_FILE := Info-cmdline.plist
 113     endif
 114 
 115     $1_LDFLAGS += -sectcreate __TEXT __info_plist $(MACOSX_PLIST_DIR)/$$($1_PLIST_FILE)
 116 
 117     ifeq ($(STATIC_BUILD), true)
 118       $1_LDFLAGS += -exported_symbols_list \
 119               $(SUPPORT_OUTPUTDIR)/build-static/exported.symbols
 120       $1_LIBS += \
 121           $$(shell $(FIND) $(SUPPORT_OUTPUTDIR)/modules_libs/java.base -name "*.a") \
 122           $(SUPPORT_OUTPUTDIR)/modules_libs/jdk.jdwp.agent/libdt_socket.a \
 123           $(SUPPORT_OUTPUTDIR)/modules_libs/jdk.jdwp.agent/libjdwp.a \
 124           $(SUPPORT_OUTPUTDIR)/native/java.base/$(LIBRARY_PREFIX)fdlibm$(STATIC_LIBRARY_SUFFIX) \
 125           -framework CoreFoundation \
 126           -framework Foundation \
 127           -framework SystemConfiguration \
 128           -lstdc++ -liconv
 129     endif
 130   endif
 131 
 132   ifeq ($(USE_EXTERNAL_LIBZ), true)
 133     $1_LIBS += -lz
 134   endif
 135 
 136   $1_WINDOWS_JLI_LIB := $(call FindStaticLib, java.base, jli, /libjli)
 137 
 138   $$(eval $$(call SetupJdkExecutable, BUILD_LAUNCHER_$1, \
 139       NAME := $1, \
 140       EXTRA_FILES := $(LAUNCHER_SRC)/main.c, \
 141       OPTIMIZATION := $$($1_OPTIMIZATION), \
 142       CFLAGS := $$(CFLAGS_JDKEXE) $$($1_CFLAGS) \
 143           $(LAUNCHER_CFLAGS) \
 144           $(VERSION_CFLAGS) \
 145           -DLAUNCHER_NAME='"$(LAUNCHER_NAME)"' \
 146           -DPROGNAME='"$1"' \
 147           $$($1_CFLAGS), \
 148       CFLAGS_linux := -fPIC, \
 149       CFLAGS_solaris := -KPIC -DHAVE_GETHRTIME, \
 150       CFLAGS_windows := $$($1_CFLAGS_windows), \
 151       DISABLED_WARNINGS_gcc := unused-function, \
 152       LDFLAGS := $$(LDFLAGS_JDKEXE) \
 153           $$(call SET_EXECUTABLE_ORIGIN) \
 154           $$($1_LDFLAGS), \
 155       LDFLAGS_linux := $$(call SET_EXECUTABLE_ORIGIN,/../lib) \
 156           -L$(call FindLibDirForModule, java.base), \
 157       LDFLAGS_macosx := $$(call SET_EXECUTABLE_ORIGIN,/../lib) \
 158           -L$(call FindLibDirForModule, java.base), \
 159       LDFLAGS_solaris := $$(call SET_EXECUTABLE_ORIGIN,/../lib) \
 160           -L$(call FindLibDirForModule, java.base), \
 161       LDFLAGS_aix := -L$(SUPPORT_OUTPUTDIR)/native/java.base, \
 162       LIBS := $(JDKEXE_LIBS) $$($1_LIBS), \
 163       LIBS_linux := -ljli -lpthread $(LIBDL), \
 164       LIBS_macosx := -ljli -framework Cocoa -framework Security \
 165           -framework ApplicationServices, \
 166       LIBS_solaris := -ljli -lthread $(LIBDL), \
 167       LIBS_aix := -ljli_static, \
 168       LIBS_windows := $$($1_WINDOWS_JLI_LIB) \
 169           $(SUPPORT_OUTPUTDIR)/native/java.base/libjava/java.lib, \
 170       OUTPUT_DIR := $$($1_OUTPUT_DIR), \
 171       VERSIONINFO_RESOURCE := $$($1_VERSION_INFO_RESOURCE), \
 172       EXTRA_RC_FLAGS := $$($1_EXTRA_RC_FLAGS), \
 173       MANIFEST := $(JAVA_MANIFEST), \
 174       MANIFEST_VERSION := $(VERSION_NUMBER_FOUR_POSITIONS), \
 175       CODESIGN := $$($1_CODESIGN), \
 176   ))
 177 
 178   $1 += $$(BUILD_LAUNCHER_$1)
 179   TARGETS += $$($1)
 180 
 181   ifeq ($(call isTargetOs, aix), true)
 182     $$(BUILD_LAUNCHER_$1): $(call FindStaticLib, java.base, jli_static)
 183   endif
 184 
 185   ifeq ($(call isTargetOs, windows), true)
 186     $$(BUILD_LAUNCHER_$1): $(call FindStaticLib, java.base, java, /libjava) \
 187         $$($1_WINDOWS_JLI_LIB)
 188   endif
 189 endef
 190 
 191 ################################################################################
 192 # Create man pages for jmod to pick up. There should be a one-to-one
 193 # relationship between executables and man pages (even if this is not always
 194 # the case), so piggyback man page generation on the launcher compilation.
 195 
 196 ifeq ($(call isTargetOsType, unix), true)
 197   # Only build manpages on unix systems.
 198   # We assume all our man pages should reside in section 1.
 199 
 200   MAN_FILES_MD := $(wildcard $(addsuffix /*.md, $(call FindModuleManDirs, $(MODULE))))
 201   MAN_FILES_TROFF := $(wildcard $(addsuffix /*.1, $(call FindModuleManDirs, $(MODULE))))
 202 
 203   ifneq ($(MAN_FILES_MD), )
 204     # If we got markdown files, ignore the troff files
 205     ifeq ($(ENABLE_PANDOC), false)
 206       $(info Warning: pandoc not found. Not generating man pages)
 207     else
 208       # Create dynamic man pages from markdown using pandoc. We need
 209       # PANDOC_TROFF_MANPAGE_FILTER, a wrapper around
 210       # PANDOC_TROFF_MANPAGE_FILTER_JAVASCRIPT. This is created by buildtools-jdk.
 211 
 212       # We should also depend on the source javascript filter
 213       PANDOC_TROFF_MANPAGE_FILTER_JAVASCRIPT := \
 214           $(TOPDIR)/make/scripts/pandoc-troff-manpage-filter.js
 215 
 216       # The norm in man pages is to display code literals as bold, but pandoc
 217       # "correctly" converts these constructs (encoded in markdown using `...`
 218       # or ```...```) to \f[C]. Ideally, we should use the filter to encapsulate
 219       # the Code/CodeBlock in Strong. While this works for Code, pandoc cannot
 220       # correctly render man page output for CodeBlock wrapped in Strong. So we
 221       # take the easy way out, and post-process the troff output, replacing
 222       # \f[C] with \f[CB]. This has the added benefit of working correctly on
 223       # pandoc prior to version 2.0, which cannot properly produced nested
 224       # formatting in man pages (see https://github.com/jgm/pandoc/issues/3568).
 225       #
 226       # As of pandoc 2.3, the termination of formatting is still broken
 227       # (see https://github.com/jgm/pandoc/issues/4973). We need to replace
 228       # \f[] with \f[R].
 229       MAN_POST_PROCESS := $(SED) -e 's/\\f\[C\]/\\f\[CB\]/g' \
 230           -e 's/\\f\[\]/\\f\[R\]/g'
 231 
 232       # Now generate the man pages from markdown using pandoc
 233       $(eval $(call SetupProcessMarkdown, BUILD_MAN_PAGES, \
 234           DEST := $(SUPPORT_OUTPUTDIR)/modules_man/$(MODULE)/man1, \
 235           FILES := $(MAN_FILES_MD), \
 236           FORMAT := man, \
 237           FILTER := $(PANDOC_TROFF_MANPAGE_FILTER), \
 238           POST_PROCESS := $(MAN_POST_PROCESS), \
 239           REPLACEMENTS := @@VERSION_SHORT@@ => $(VERSION_SHORT), \
 240           EXTRA_DEPS := $(PANDOC_TROFF_MANPAGE_FILTER) \
 241               $(PANDOC_TROFF_MANPAGE_FILTER_JAVASCRIPT), \
 242       ))
 243 
 244       TARGETS += $(BUILD_MAN_PAGES)
 245     endif
 246   else
 247     # No markdown man pages present
 248     ifeq ($(BUILD_MANPAGES), true)
 249       # BUILD_MANPAGES is a mis-nomer. It really means "copy the pre-generated man pages".
 250       $(eval $(call SetupCopyFiles, COPY_MAN_PAGES, \
 251           DEST := $(SUPPORT_OUTPUTDIR)/modules_man/$(MODULE)/man1, \
 252           FILES := $(MAN_FILES_TROFF), \
 253       ))
 254 
 255       TARGETS += $(COPY_MAN_PAGES)
 256     endif
 257   endif
 258 endif