1 #
   2 # Copyright (c) 2011, 2018, 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 # When you read this source. Remember that $(sort ...) has the side effect
  27 # of removing duplicates. It is actually this side effect that is
  28 # desired whenever sort is used below!
  29 
  30 ifndef _NATIVE_COMPILATION_GMK
  31 _NATIVE_COMPILATION_GMK := 1
  32 
  33 ifeq ($(_MAKEBASE_GMK), )
  34   $(error You must include MakeBase.gmk prior to including NativeCompilation.gmk)
  35 endif
  36 
  37 ################################################################################
  38 # Create exported symbols file for static libraries
  39 ################################################################################
  40 
  41 # get the exported symbols from mapfiles and if there
  42 # is no mapfile, get them from the archive
  43 define GetSymbols
  44   $(RM) $$(@D)/$$(basename $$(@F)).symbols; \
  45   if [ ! -z $$($1_MAPFILE) -a -e $$($1_MAPFILE) ]; then \
  46     $(ECHO) "Getting symbols from mapfile $$($1_MAPFILE)"; \
  47     $(AWK) '/global:/','/local:/' $$($1_MAPFILE) | \
  48         $(SED) -e 's/#.*//;s/global://;s/local://;s/\;//;s/^[   ]*/_/;/^_$$$$/d' | \
  49         $(EGREP) -v "JNI_OnLoad|JNI_OnUnload|Agent_OnLoad|Agent_OnUnload|Agent_OnAttach" > \
  50         $$(@D)/$$(basename $$(@F)).symbols || true; \
  51     $(NM) $$($1_TARGET) | $(GREP)  " T " | \
  52         $(EGREP) "JNI_OnLoad|JNI_OnUnload|Agent_OnLoad|Agent_OnUnload|Agent_OnAttach" | \
  53         $(CUT) -d ' ' -f 3 >>  $$(@D)/$$(basename $$(@F)).symbols || true;\
  54   else \
  55     $(ECHO) "Getting symbols from nm"; \
  56     $(NM) -m $$($1_TARGET) | $(GREP)  "__TEXT" | \
  57         $(EGREP) -v "non-external|private extern|__TEXT,__eh_frame" | \
  58         $(SED) -e  's/.* //' > $$(@D)/$$(basename $$(@F)).symbols; \
  59   fi
  60 endef
  61 
  62 ################################################################################
  63 # Creates a recipe that creates a compile_commands.json fragment. Remove any
  64 # occurences of FIXPATH programs from the command to show the actual invocation.
  65 #
  66 # Param 1: Name of file to create
  67 # Param 2: Working directory
  68 # Param 3: Source file
  69 # Param 4: Compile command
  70 ################################################################################
  71 define WriteCompileCommandsFragment
  72   $(call LogInfo, Creating compile commands fragment for $(notdir $3))
  73   $(call MakeDir, $(dir $1))
  74   $(call WriteFile,{ \
  75       "directory": "$(strip $2)"$(COMMA) \
  76       "file": "$(strip $3)"$(COMMA) \
  77       "command": "$(strip $(subst $(DQUOTE),\$(DQUOTE),$(subst \,\\,\
  78         $(subst $(FIXPATH),,$4))))" \
  79     }$(COMMA), \
  80     $1)
  81 endef
  82 
  83 ################################################################################
  84 # Define a native toolchain configuration that can be used by
  85 # SetupNativeCompilation calls
  86 #
  87 # Parameter 1 is the name of the toolchain definition
  88 #
  89 # Remaining parameters are named arguments:
  90 #   EXTENDS - Optional parent definition to get defaults from
  91 #   CC - The C compiler
  92 #   CXX - The C++ compiler
  93 #   LD - The Linker
  94 #   AR - Static linker
  95 #   AS - Assembler
  96 #   MT - Windows MT tool
  97 #   RC - Windows RC tool
  98 #   OBJCOPY - The objcopy tool for debug symbol handling
  99 #   STRIP - The tool to use for stripping debug symbols
 100 #   SYSROOT_CFLAGS - Compiler flags for using the specific sysroot
 101 #   SYSROOT_LDFLAGS - Linker flags for using the specific sysroot
 102 DefineNativeToolchain = $(NamedParamsMacroTemplate)
 103 define DefineNativeToolchainBody
 104   # If extending another definition, get default values from that,
 105   # otherwise, nothing more needs to be done as variable assignments
 106   # already happened in NamedParamsMacroTemplate.
 107   ifneq ($$($1_EXTENDS), )
 108     $$(call SetIfEmpty, $1_CC, $$($$($1_EXTENDS)_CC))
 109     $$(call SetIfEmpty, $1_CXX, $$($$($1_EXTENDS)_CXX))
 110     $$(call SetIfEmpty, $1_LD, $$($$($1_EXTENDS)_LD))
 111     $$(call SetIfEmpty, $1_AR, $$($$($1_EXTENDS)_AR))
 112     $$(call SetIfEmpty, $1_AS, $$($$($1_EXTENDS)_AS))
 113     $$(call SetIfEmpty, $1_MT, $$($$($1_EXTENDS)_MT))
 114     $$(call SetIfEmpty, $1_RC, $$($$($1_EXTENDS)_RC))
 115     $$(call SetIfEmpty, $1_OBJCOPY, $$($$($1_EXTENDS)_OBJCOPY))
 116     $$(call SetIfEmpty, $1_STRIP, $$($$($1_EXTENDS)_STRIP))
 117     $$(call SetIfEmpty, $1_SYSROOT_CFLAGS, $$($$($1_EXTENDS)_SYSROOT_CFLAGS))
 118     $$(call SetIfEmpty, $1_SYSROOT_LDFLAGS, $$($$($1_EXTENDS)_SYSROOT_LDFLAGS))
 119   endif
 120 endef
 121 
 122 # Create a default toolchain with the main compiler and linker
 123 $(eval $(call DefineNativeToolchain, TOOLCHAIN_DEFAULT, \
 124     CC := $(CC), \
 125     CXX := $(CXX), \
 126     LD := $(LD), \
 127     AR := $(AR), \
 128     AS := $(AS), \
 129     MT := $(MT), \
 130     RC := $(RC), \
 131     OBJCOPY := $(OBJCOPY), \
 132     STRIP := $(STRIP), \
 133     SYSROOT_CFLAGS := $(SYSROOT_CFLAGS), \
 134     SYSROOT_LDFLAGS := $(SYSROOT_LDFLAGS), \
 135 ))
 136 
 137 # Create a toolchain where linking is done with the C++ linker
 138 $(eval $(call DefineNativeToolchain, TOOLCHAIN_LINK_CXX, \
 139     EXTENDS := TOOLCHAIN_DEFAULT, \
 140     LD := $(LDCXX), \
 141 ))
 142 
 143 # Create a toolchain with the BUILD compiler, used for build tools that
 144 # are to be run during the build.
 145 $(eval $(call DefineNativeToolchain, TOOLCHAIN_BUILD, \
 146     CC := $(BUILD_CC), \
 147     CXX := $(BUILD_CXX), \
 148     LD := $(BUILD_LD), \
 149     AR := $(BUILD_AR), \
 150     AS := $(BUILD_AS), \
 151     OBJCOPY := $(BUILD_OBJCOPY), \
 152     STRIP := $(BUILD_STRIP), \
 153     SYSROOT_CFLAGS := $(BUILD_SYSROOT_CFLAGS), \
 154     SYSROOT_LDFLAGS := $(BUILD_SYSROOT_LDFLAGS), \
 155 ))
 156 
 157 # BUILD toolchain with the C++ linker
 158 $(eval $(call DefineNativeToolchain, TOOLCHAIN_BUILD_LINK_CXX, \
 159     EXTENDS := TOOLCHAIN_BUILD, \
 160     LD := $(BUILD_LDCXX), \
 161 ))
 162 
 163 ################################################################################
 164 
 165 # Extensions of files handled by this macro.
 166 NATIVE_SOURCE_EXTENSIONS := %.s %.S %.c %.cpp %.cc %.m %.mm
 167 
 168 # Replaces native source extensions with the object file extension in a string.
 169 # Param 1: the string containing source file names with extensions
 170 # The surrounding strip is needed to keep additional whitespace out
 171 define replace_with_obj_extension
 172 $(strip \
 173   $(foreach extension, $(NATIVE_SOURCE_EXTENSIONS), \
 174       $(patsubst $(extension),%$(OBJ_SUFFIX), $(filter $(extension), $1))) \
 175 )
 176 endef
 177 
 178 ifeq ($(OPENJDK_BUILD_OS_ENV), windows.cygwin)
 179   UNIX_PATH_PREFIX := /cygdrive
 180 else ifeq ($(OPENJDK_BUILD_OS_ENV), windows.msys)
 181   UNIX_PATH_PREFIX :=
 182 endif
 183 
 184 # This pattern is used to transform the output of the microsoft CL compiler
 185 # into a make syntax dependency file (.d)
 186 WINDOWS_SHOWINCLUDE_SED_PATTERN := \
 187     -e '/^Note: including file:/!d' \
 188     -e 's|Note: including file: *||' \
 189     -e 's|\r||g' \
 190     -e 's|\\|/|g' \
 191     -e 's|^\([a-zA-Z]\):|$(UNIX_PATH_PREFIX)/\1|g' \
 192     -e '\|$(TOPDIR)|I !d' \
 193     -e 's|$$$$| \\|g' \
 194     #
 195 
 196 # This pattern is used to transform a dependency file (.d) to a list
 197 # of make targets for dependent files (.d.targets)
 198 DEPENDENCY_TARGET_SED_PATTERN := \
 199     -e 's/\#.*//' \
 200     -e 's/^[^:]*: *//' \
 201     -e 's/ *\\$$$$//' \
 202     -e 's/^[     ]*//' \
 203     -e '/^$$$$/ d' \
 204     -e 's/$$$$/ :/' \
 205     #
 206 
 207 ################################################################################
 208 # Create the recipe needed to compile a single native source file.
 209 #
 210 # Parameter 1 is the name of the rule, based on the name of the library/
 211 # program being build and the name of the source code file, e.g.
 212 # BUILD_LIBFOO_fooMain.cpp.
 213 #
 214 # Remaining parameters are named arguments:
 215 #   FILE - The full path of the source file to compiler
 216 #   BASE - The name of the rule for the entire binary to build ($1)
 217 #   DISABLE_THIS_FILE_DEFINE - Set to true to disable the THIS_FILE define.
 218 #
 219 SetupCompileNativeFile = $(NamedParamsMacroTemplate)
 220 define SetupCompileNativeFileBody
 221   $1_FILENAME := $$(notdir $$($1_FILE))
 222 
 223   # The target file to be generated.
 224   $1_OBJ := $$($$($1_BASE)_OBJECT_DIR)/$$(call replace_with_obj_extension, \
 225       $$($1_FILENAME))
 226 
 227   # Generate the corresponding compile_commands.json fragment.
 228   $1_OBJ_JSON = $$(MAKESUPPORT_OUTPUTDIR)/compile-commands/$$(subst /,_,$$(subst \
 229       $$(OUTPUTDIR)/,,$$($1_OBJ))).json
 230   $$($1_BASE)_ALL_OBJS_JSON += $$($1_OBJ_JSON)
 231 
 232   # Only continue if this object file hasn't been processed already. This lets
 233   # the first found source file override any other with the same name.
 234   ifeq ($$(findstring $$($1_OBJ), $$($$($1_BASE)_OBJS_SO_FAR)), )
 235     $$($1_BASE)_OBJS_SO_FAR += $$($1_OBJ)
 236     # This is the definite source file to use for $1_FILENAME.
 237     $1_SRC_FILE := $$($1_FILE)
 238 
 239     ifneq ($$($1_DISABLE_THIS_FILE_DEFINE), true)
 240       $1_THIS_FILE = -DTHIS_FILE='"$$(<F)"'
 241     endif
 242 
 243     ifeq ($$($1_OPTIMIZATION), )
 244       $1_OPT_CFLAGS := $$($$($1_BASE)_OPT_CFLAGS)
 245       $1_OPT_CXXFLAGS := $$($$($1_BASE)_OPT_CXXFLAGS)
 246     else
 247       ifeq ($$($1_OPTIMIZATION), NONE)
 248         $1_OPT_CFLAGS := $(C_O_FLAG_NONE)
 249         $1_OPT_CXXFLAGS := $(CXX_O_FLAG_NONE)
 250       else ifeq ($$($1_OPTIMIZATION), LOW)
 251         $1_OPT_CFLAGS := $(C_O_FLAG_NORM)
 252         $1_OPT_CXXFLAGS := $(CXX_O_FLAG_NORM)
 253       else ifeq ($$($1_OPTIMIZATION), HIGH)
 254         $1_OPT_CFLAGS := $(C_O_FLAG_HI)
 255         $1_OPT_CXXFLAGS := $(CXX_O_FLAG_HI)
 256       else ifeq ($$($1_OPTIMIZATION), HIGHEST)
 257         $1_OPT_CFLAGS := $(C_O_FLAG_HIGHEST)
 258         $1_OPT_CXXFLAGS := $(CXX_O_FLAG_HIGHEST)
 259       else ifeq ($$($1_OPTIMIZATION), HIGHEST_JVM)
 260         $1_OPT_CFLAGS := $(C_O_FLAG_HIGHEST_JVM)
 261         $1_OPT_CXXFLAGS := $(CXX_O_FLAG_HIGHEST_JVM)
 262       else ifeq ($$($1_OPTIMIZATION), SIZE)
 263         $1_OPT_CFLAGS := $(C_O_FLAG_SIZE)
 264         $1_OPT_CXXFLAGS := $(CXX_O_FLAG_SIZE)
 265       else
 266         $$(error Unknown value for file OPTIMIZATION: $$($1_OPTIMIZATION))
 267       endif
 268     endif
 269 
 270     ifneq ($$($$($1_BASE)_PRECOMPILED_HEADER), )
 271       ifeq ($$(filter $$($1_FILENAME), $$($$($1_BASE)_PRECOMPILED_HEADER_EXCLUDE)), )
 272         $1_USE_PCH_FLAGS := $$($$($1_BASE)_USE_PCH_FLAGS)
 273       endif
 274     endif
 275 
 276     $1_BASE_CFLAGS :=  $$($$($1_BASE)_CFLAGS) $$($$($1_BASE)_EXTRA_CFLAGS) \
 277         $$($$($1_BASE)_SYSROOT_CFLAGS)
 278     $1_BASE_CXXFLAGS := $$($$($1_BASE)_CXXFLAGS) $$($$($1_BASE)_EXTRA_CXXFLAGS) \
 279         $$($$($1_BASE)_SYSROOT_CFLAGS) $$($1_EXTRA_CXXFLAGS)
 280     $1_BASE_ASFLAGS := $$($$($1_BASE)_ASFLAGS) $$($$($1_BASE)_EXTRA_ASFLAGS)
 281 
 282     ifneq ($$(filter %.c, $$($1_FILENAME)), )
 283       # Compile as a C file
 284       $1_FLAGS := $(CFLAGS_CCACHE) $$($1_USE_PCH_FLAGS) $$($1_BASE_CFLAGS) \
 285           $$($1_OPT_CFLAGS) $$($1_CFLAGS) $$($1_THIS_FILE) -c
 286       $1_COMPILER := $$($$($1_BASE)_CC)
 287       $1_DEP_FLAG := $(C_FLAG_DEPS)
 288     else ifneq ($$(filter %.m, $$($1_FILENAME)), )
 289       # Compile as an Objective-C file
 290       $1_FLAGS := -x objective-c $(CFLAGS_CCACHE) $$($1_USE_PCH_FLAGS) \
 291           $$($1_BASE_CFLAGS) $$($1_OPT_CFLAGS) $$($1_CFLAGS) $$($1_THIS_FILE) -c
 292       $1_COMPILER := $$($$($1_BASE)_CC)
 293       $1_DEP_FLAG := $(C_FLAG_DEPS)
 294     else ifneq ($$(filter %.s %.S, $$($1_FILENAME)), )
 295       # Compile as assembler file
 296       $1_FLAGS := $$($1_BASE_ASFLAGS)
 297       $1_COMPILER := $(AS)
 298       $1_DEP_FLAG :=
 299     else ifneq ($$(filter %.cpp %.cc %.mm, $$($1_FILENAME)), )
 300       # Compile as a C++ or Objective-C++ file
 301       $1_FLAGS := $(CFLAGS_CCACHE) $$($1_USE_PCH_FLAGS) $$($1_BASE_CXXFLAGS) \
 302           $$($1_OPT_CXXFLAGS) $$($1_CXXFLAGS) $$($1_THIS_FILE) -c
 303       $1_COMPILER := $$($$($1_BASE)_CXX)
 304       $1_DEP_FLAG := $(CXX_FLAG_DEPS)
 305     else
 306       $$(error Internal error in NativeCompilation.gmk: no compiler for file $$($1_FILENAME))
 307     endif
 308 
 309     ifeq ($$(filter %.s %.S, $$($1_FILENAME)), )
 310       # And this is the dependency file for this obj file.
 311       $1_DEP := $$(patsubst %$(OBJ_SUFFIX),%.d,$$($1_OBJ))
 312       # The dependency target file lists all dependencies as empty targets to
 313       # avoid make error "No rule to make target" for removed files
 314       $1_DEP_TARGETS := $$(patsubst %$(OBJ_SUFFIX),%.d.targets,$$($1_OBJ))
 315 
 316       # Include previously generated dependency information. (if it exists)
 317       -include $$($1_DEP)
 318       -include $$($1_DEP_TARGETS)
 319     endif
 320 
 321     ifneq ($$(strip $$($1_CFLAGS) $$($1_CXXFLAGS) $$($1_OPTIMIZATION)), )
 322       $1_VARDEPS := $$($1_CFLAGS) $$($1_CXXFLAGS) $$($1_OPTIMIZATION)
 323       $1_VARDEPS_FILE := $$(call DependOnVariable, $1_VARDEPS, $$($1_OBJ).vardeps)
 324     endif
 325 
 326     $1_OBJ_DEPS := $$($1_SRC_FILE) $$($$($1_BASE)_COMPILE_VARDEPS_FILE) \
 327         $$($$($1_BASE)_EXTRA_DEPS) $$($1_VARDEPS_FILE)
 328     $1_COMPILE_OPTIONS := $$($1_FLAGS) $(CC_OUT_OPTION)$$($1_OBJ) $$($1_SRC_FILE)
 329 
 330     $$($1_OBJ_JSON): $$($1_OBJ_DEPS)
 331         $$(call WriteCompileCommandsFragment, $$@, $$(PWD), $$($1_SRC_FILE), \
 332             $$($1_COMPILER) $$($1_COMPILE_OPTIONS))
 333 
 334     $$($1_OBJ): $$($1_OBJ_DEPS) | $$($$($1_BASE)_BUILD_INFO)
 335         $$(call LogInfo, Compiling $$($1_FILENAME) (for $$($$($1_BASE)_BASENAME)))
 336         $$(call MakeDir, $$(@D))
 337         ifneq ($(TOOLCHAIN_TYPE), microsoft)
 338           ifeq ($(TOOLCHAIN_TYPE)$$(filter %.s, $$($1_FILENAME)), solstudio)
 339             # The Solaris studio compiler doesn't output the full path to the
 340             # object file in the generated deps files. Fixing it with sed. If
 341             # compiling assembly, don't try this.
 342             $$(call ExecuteWithLog, $$@, \
 343                 $$($1_COMPILER) $$($1_DEP_FLAG) $$($1_DEP).tmp $$($1_COMPILE_OPTIONS))
 344             $(SED) 's|^$$(@F):|$$@:|' $$($1_DEP).tmp > $$($1_DEP)
 345           else
 346             $$(call ExecuteWithLog, $$@, \
 347                 $$($1_COMPILER) $$($1_DEP_FLAG) $$($1_DEP) $$($1_COMPILE_OPTIONS))
 348           endif
 349           # Create a dependency target file from the dependency file.
 350           # Solution suggested by http://make.mad-scientist.net/papers/advanced-auto-dependency-generation/
 351           ifneq ($$($1_DEP), )
 352             $(SED) $(DEPENDENCY_TARGET_SED_PATTERN) $$($1_DEP) > $$($1_DEP_TARGETS)
 353           endif
 354         else
 355           # The Visual Studio compiler lacks a feature for generating make
 356           # dependencies, but by setting -showIncludes, all included files are
 357           # printed. These are filtered out and parsed into make dependences.
 358           #
 359           # Keep as much as possible on one execution line for best performance
 360           # on Windows. No need to save exit code from compilation since
 361           # pipefail is always active on Windows.
 362           $$(call ExecuteWithLog, $$@, \
 363               $$($1_COMPILER) -showIncludes $$($1_COMPILE_OPTIONS)) \
 364               | $(TR) -d '\r' | $(GREP) -v -e "^Note: including file:" \
 365                   -e "^$$($1_FILENAME)$$$$" || test "$$$$?" = "1" ; \
 366           $(ECHO) $$@: \\ > $$($1_DEP) ; \
 367           $(SED) $(WINDOWS_SHOWINCLUDE_SED_PATTERN) $$($1_OBJ).log \
 368               | $(SORT) -u >> $$($1_DEP) ; \
 369           $(SED) $(DEPENDENCY_TARGET_SED_PATTERN) $$($1_DEP) > $$($1_DEP_TARGETS)
 370         endif
 371   endif
 372 endef
 373 
 374 # Setup make rules for creating a native binary (a shared library or an
 375 # executable).
 376 #
 377 # Parameter 1 is the name of the rule. This name is used as variable prefix,
 378 # and the targets generated are listed in a variable by that name.
 379 #
 380 # Remaining parameters are named arguments. These include:
 381 #   NAME The base name for the resulting binary, excluding decorations (like *.exe)
 382 #   TYPE Type of binary (EXECUTABLE, LIBRARY or STATIC_LIBRARY). Default is LIBRARY.
 383 #   SUFFIX Override the default suffix for the output file
 384 #   TOOLCHAIN Name of toolchain setup to use. Defaults to TOOLCHAIN_DEFAULT.
 385 #   SRC one or more directory roots to scan for C/C++ files.
 386 #   CFLAGS the compiler flags to be used, used both for C and C++.
 387 #   CXXFLAGS the compiler flags to be used for c++, if set overrides CFLAGS.
 388 #   LDFLAGS the linker flags to be used, used both for C and C++.
 389 #   LIBS the libraries to link to
 390 #   ARFLAGS the archiver flags to be used
 391 #   OBJECT_DIR the directory where we store the object files
 392 #   OUTPUT_DIR the directory where the resulting binary is put
 393 #   INCLUDES only pick source from these directories
 394 #   EXCLUDES do not pick source from these directories
 395 #   INCLUDE_FILES only compile exactly these files!
 396 #   EXCLUDE_FILES with these names
 397 #   EXCLUDE_PATTERN exclude files matching any of these substrings
 398 #   EXTRA_FILES List of extra files not in any of the SRC dirs
 399 #   EXTRA_OBJECT_FILES List of extra object files to include when linking
 400 #   EXTRA_DEPS List of extra dependencies to be added to each compiled file
 401 #   VERSIONINFO_RESOURCE Input file for RC. Setting this implies that RC will be run
 402 #   RC_FLAGS flags for RC.
 403 #   EMBED_MANIFEST if true, embed manifest on Windows.
 404 #   MAPFILE mapfile
 405 #   REORDER reorder file
 406 #   USE_MAPFILE_FOR_SYMBOLS if true and this is a STATIC_BUILD, just copy the
 407 #       mapfile for the output symbols file
 408 #   CC the compiler to use, default is $(CC)
 409 #   LD the linker to use, default is $(LD)
 410 #   OPTIMIZATION sets optimization level to NONE, LOW, HIGH, HIGHEST, HIGHEST_JVM, SIZE
 411 #   DISABLED_WARNINGS_<toolchain> Disable the given warnings for the specified toolchain
 412 #   DISABLED_WARNINGS_C_<toolchain> Disable the given warnings for the specified toolchain
 413 #       when compiling C code
 414 #   DISABLED_WARNINGS_CXX_<toolchain> Disable the given warnings for the specified
 415 #       toolchain when compiling C++ code
 416 #   STRIP_SYMBOLS Set to false to override global strip policy and always leave
 417 #       symbols in the binary, if the toolchain allows for it
 418 #   DEBUG_SYMBOLS Set to false to disable generation of debug symbols
 419 #   COPY_DEBUG_SYMBOLS Set to false to override global setting of debug symbol copying
 420 #   ZIP_EXTERNAL_DEBUG_SYMBOLS Set to false to override global setting of debug symbol
 421 #       zipping
 422 #   STRIPFLAGS Optionally change the flags given to the strip command
 423 #   PRECOMPILED_HEADER Header file to use as precompiled header
 424 #   PRECOMPILED_HEADER_EXCLUDE List of source files that should not use PCH
 425 #
 426 # After being called, some variables are exported from this macro, all prefixed
 427 # with parameter 1 followed by a '_':
 428 #   TARGET The library or executable created by the macro
 429 #   TARGET_DEPS All prerequisites for the target calculated by the macro
 430 #   ALL_OBJS All object files
 431 #   IMPORT_LIBRARY The import library created for a shared library on Windows
 432 SetupNativeCompilation = $(NamedParamsMacroTemplate)
 433 define SetupNativeCompilationBody
 434 
 435   # If type is unspecified, default to LIBRARY
 436   ifeq ($$($1_TYPE), )
 437     $1_TYPE := LIBRARY
 438   endif
 439 
 440   # If we're doing a static build and producing a library
 441   # force it to be a static library and remove the -l libraries
 442   ifeq ($(STATIC_BUILD), true)
 443     ifeq ($$($1_TYPE), LIBRARY)
 444       $1_TYPE := STATIC_LIBRARY
 445     endif
 446   endif
 447 
 448   ifeq ($$($1_TYPE), EXECUTABLE)
 449     $1_PREFIX :=
 450     ifeq ($$($1_SUFFIX), )
 451       $1_SUFFIX := $(EXE_SUFFIX)
 452     endif
 453   else
 454     $1_PREFIX := $(LIBRARY_PREFIX)
 455     ifeq ($$($1_TYPE), LIBRARY)
 456       ifeq ($$($1_SUFFIX), )
 457         $1_SUFFIX := $(SHARED_LIBRARY_SUFFIX)
 458       endif
 459     else ifeq ($$($1_TYPE), STATIC_LIBRARY)
 460       ifeq ($$($1_SUFFIX), )
 461         $1_SUFFIX := $(STATIC_LIBRARY_SUFFIX)
 462       endif
 463     endif
 464   endif
 465 
 466   ifneq ($$($1_NAME), $(basename $$($1_NAME)))
 467     $$(error NAME must not contain any directory path in $1)
 468   endif
 469   ifneq ($(findstring $$($1_SUFFIX), $$($1_NAME)), )
 470     $$(error NAME should be specified without suffix: $$($1_SUFFIX) in $1)
 471   endif
 472   ifneq ($(findstring $$($1_PREFIX), $$($1_NAME)), )
 473     $$(error NAME should be specified without prefix: $$($1_PREFIX) in $1)
 474   endif
 475   ifeq ($$($1_OUTPUT_DIR), )
 476     $$(error OUTPUT_DIR is missing in $1)
 477   endif
 478   ifneq ($$($1_MANIFEST), )
 479     ifeq ($$($1_MANIFEST_VERSION), )
 480       $$(error If MANIFEST is provided, then MANIFEST_VERSION is required in $1)
 481     endif
 482   endif
 483 
 484   $1_BASENAME := $$($1_PREFIX)$$($1_NAME)$$($1_SUFFIX)
 485   $1_TARGET := $$($1_OUTPUT_DIR)/$$($1_BASENAME)
 486   $1_NOSUFFIX := $$($1_PREFIX)$$($1_NAME)
 487   $1_SAFE_NAME := $$(strip $$(subst /,_, $1))
 488 
 489   # Setup the toolchain to be used
 490   $$(call SetIfEmpty, $1_TOOLCHAIN, TOOLCHAIN_DEFAULT)
 491   $$(call SetIfEmpty, $1_CC, $$($$($1_TOOLCHAIN)_CC))
 492   $$(call SetIfEmpty, $1_CXX, $$($$($1_TOOLCHAIN)_CXX))
 493   $$(call SetIfEmpty, $1_LD, $$($$($1_TOOLCHAIN)_LD))
 494   $$(call SetIfEmpty, $1_AR, $$($$($1_TOOLCHAIN)_AR))
 495   $$(call SetIfEmpty, $1_AS, $$($$($1_TOOLCHAIN)_AS))
 496   $$(call SetIfEmpty, $1_MT, $$($$($1_TOOLCHAIN)_MT))
 497   $$(call SetIfEmpty, $1_RC, $$($$($1_TOOLCHAIN)_RC))
 498   $$(call SetIfEmpty, $1_OBJCOPY, $$($$($1_TOOLCHAIN)_OBJCOPY))
 499   $$(call SetIfEmpty, $1_STRIP, $$($$($1_TOOLCHAIN)_STRIP))
 500   $$(call SetIfEmpty, $1_SYSROOT_CFLAGS, $$($$($1_TOOLCHAIN)_SYSROOT_CFLAGS))
 501   $$(call SetIfEmpty, $1_SYSROOT_LDFLAGS, $$($$($1_TOOLCHAIN)_SYSROOT_LDFLAGS))
 502 
 503   # Make sure the dirs exist.
 504   $$(call MakeDir, $$($1_OBJECT_DIR) $$($1_OUTPUT_DIR))
 505   $$(foreach d, $$($1_SRC), $$(if $$(wildcard $$d), , \
 506       $$(error SRC specified to SetupNativeCompilation $1 contains missing directory $$d)))
 507 
 508   # Find all files in the source trees. Preserve order.
 509   $1_SRCS := $$(foreach s, $$($1_SRC), $$(call CacheFind, $$(s)))
 510   $1_SRCS := $$(filter $$(NATIVE_SOURCE_EXTENSIONS), $$($1_SRCS))
 511   # Extract the C/C++ files.
 512   ifneq ($$($1_EXCLUDE_PATTERNS), )
 513     # We must not match the exclude pattern against the src root(s).
 514     $1_SRCS_WITHOUT_ROOTS := $$($1_SRCS)
 515     $$(foreach i, $$($1_SRC), $$(eval $1_SRCS_WITHOUT_ROOTS := $$(patsubst \
 516         $$i/%,%, $$($1_SRCS_WITHOUT_ROOTS))))
 517     $1_ALL_EXCLUDE_FILES :=  $$(call containing, $$($1_EXCLUDE_PATTERNS), \
 518         $$($1_SRCS_WITHOUT_ROOTS))
 519   endif
 520   ifneq ($$($1_EXCLUDE_FILES), )
 521     $1_ALL_EXCLUDE_FILES += $$($1_EXCLUDE_FILES)
 522   endif
 523   ifneq ($$($1_ALL_EXCLUDE_FILES), )
 524     $1_EXCLUDE_FILES_PAT := $$($1_ALL_EXCLUDE_FILES) \
 525         $$(foreach i, $$($1_SRC), $$(addprefix $$i/, $$($1_ALL_EXCLUDE_FILES)))
 526     $1_EXCLUDE_FILES_PAT := $$(addprefix %, $$($1_EXCLUDE_FILES_PAT))
 527     $1_SRCS := $$(filter-out $$($1_EXCLUDE_FILES_PAT), $$($1_SRCS))
 528   endif
 529   ifneq ($$($1_INCLUDE_FILES), )
 530     $1_INCLUDE_FILES_PAT := $$(foreach i, $$($1_SRC), $$(addprefix $$i/, $$($1_INCLUDE_FILES)))
 531     $1_SRCS := $$(filter $$($1_INCLUDE_FILES_PAT), $$($1_SRCS))
 532   endif
 533   # There can be only a single bin dir root, no need to foreach over the roots.
 534   $1_BINS := $$(wildcard $$($1_OBJECT_DIR)/*$(OBJ_SUFFIX))
 535   # Now we have a list of all c/c++ files to compile: $$($1_SRCS)
 536   # and we have a list of all existing object files: $$($1_BINS)
 537 
 538   # Prepend the source/bin path to the filter expressions. Then do the filtering.
 539   ifneq ($$($1_INCLUDES), )
 540     $1_SRC_INCLUDES := $$(foreach i, $$($1_SRC), $$(addprefix $$i/, $$(addsuffix /%, $$($1_INCLUDES))))
 541     $1_SRCS := $$(filter $$($1_SRC_INCLUDES), $$($1_SRCS))
 542   endif
 543   ifneq ($$($1_EXCLUDES), )
 544     $1_SRC_EXCLUDES := $$(addsuffix /%, $$($1_EXCLUDES))
 545     $1_SRC_EXCLUDES += $$(foreach i, $$($1_SRC), $$(addprefix $$i/, $$(addsuffix /%, $$($1_EXCLUDES))))
 546     $1_SRCS := $$(filter-out $$($1_SRC_EXCLUDES), $$($1_SRCS))
 547   endif
 548 
 549   $1_SRCS += $$($1_EXTRA_FILES)
 550 
 551   ifeq ($$($1_SRCS), )
 552     $$(error No sources found for $1 when looking inside the dirs $$($1_SRC))
 553   endif
 554 
 555   # Calculate the expected output from compiling the sources
 556   $1_EXPECTED_OBJS_FILENAMES := $$(call replace_with_obj_extension, $$(notdir $$($1_SRCS)))
 557   $1_EXPECTED_OBJS := $$(addprefix $$($1_OBJECT_DIR)/, $$($1_EXPECTED_OBJS_FILENAMES))
 558   # Are there too many object files on disk? Perhaps because some source file was removed?
 559   $1_SUPERFLOUS_OBJS := $$(sort $$(filter-out $$($1_EXPECTED_OBJS), $$($1_BINS)))
 560   # Clean out the superfluous object files.
 561   ifneq ($$($1_SUPERFLUOUS_OBJS), )
 562     $$(shell $(RM) -f $$($1_SUPERFLUOUS_OBJS))
 563   endif
 564   # Sort to remove dupliates and provide a reproducable order on the input files to the linker.
 565   $1_ALL_OBJS := $$(sort $$($1_EXPECTED_OBJS) $$($1_EXTRA_OBJECT_FILES))
 566 
 567   # Pickup extra OPENJDK_TARGET_OS_TYPE, OPENJDK_TARGET_OS, and/or OPENJDK_TARGET_OS plus
 568   # OPENJDK_TARGET_CPU pair dependent variables for CFLAGS.
 569   $1_EXTRA_CFLAGS := $$($1_CFLAGS_$(OPENJDK_TARGET_OS_TYPE)) $$($1_CFLAGS_$(OPENJDK_TARGET_OS)) \
 570       $$($1_CFLAGS_$(OPENJDK_TARGET_OS)_$(OPENJDK_TARGET_CPU))
 571   ifneq ($(DEBUG_LEVEL), release)
 572     # Pickup extra debug dependent variables for CFLAGS
 573     $1_EXTRA_CFLAGS += $$($1_CFLAGS_debug)
 574     $1_EXTRA_CFLAGS += $$($1_CFLAGS_$(OPENJDK_TARGET_OS_TYPE)_debug)
 575     $1_EXTRA_CFLAGS += $$($1_CFLAGS_$(OPENJDK_TARGET_OS)_debug)
 576     $1_EXTRA_CFLAGS += $$($1_CFLAGS_$(OPENJDK_TARGET_OS)_$(OPENJDK_TARGET_CPU)_debug)
 577   else
 578     $1_EXTRA_CFLAGS += $$($1_CFLAGS_release)
 579     $1_EXTRA_CFLAGS += $$($1_CFLAGS_$(OPENJDK_TARGET_OS_TYPE)_release)
 580     $1_EXTRA_CFLAGS += $$($1_CFLAGS_$(OPENJDK_TARGET_OS)_release)
 581     $1_EXTRA_CFLAGS += $$($1_CFLAGS_$(OPENJDK_TARGET_OS)_$(OPENJDK_TARGET_CPU)_release)
 582   endif
 583 
 584   # Pickup extra OPENJDK_TARGET_OS_TYPE and/or OPENJDK_TARGET_OS dependent variables for CXXFLAGS.
 585   $1_EXTRA_CXXFLAGS := $$($1_CXXFLAGS_$(OPENJDK_TARGET_OS_TYPE)) $$($1_CXXFLAGS_$(OPENJDK_TARGET_OS))
 586   ifneq ($(DEBUG_LEVEL), release)
 587     # Pickup extra debug dependent variables for CXXFLAGS
 588     $1_EXTRA_CXXFLAGS += $$($1_CXXFLAGS_debug)
 589     $1_EXTRA_CXXFLAGS += $$($1_CXXFLAGS_$(OPENJDK_TARGET_OS_TYPE)_debug)
 590     $1_EXTRA_CXXFLAGS += $$($1_CXXFLAGS_$(OPENJDK_TARGET_OS)_debug)
 591   else
 592     $1_EXTRA_CXXFLAGS += $$($1_CXXFLAGS_release)
 593     $1_EXTRA_CXXFLAGS += $$($1_CXXFLAGS_$(OPENJDK_TARGET_OS_TYPE)_release)
 594     $1_EXTRA_CXXFLAGS += $$($1_CXXFLAGS_$(OPENJDK_TARGET_OS)_release)
 595   endif
 596 
 597   # If no C++ flags are explicitly set, default to using the C flags.
 598   # After that, we can set additional C++ flags that should not interfere
 599   # with the mechanism for copying the C flags by default.
 600   ifeq ($$($1_CXXFLAGS), )
 601     $1_CXXFLAGS := $$($1_CFLAGS)
 602   endif
 603   ifeq ($$(strip $$($1_EXTRA_CXXFLAGS)), )
 604     $1_EXTRA_CXXFLAGS := $$($1_EXTRA_CFLAGS)
 605   endif
 606 
 607   ifeq ($(COMPILE_WITH_DEBUG_SYMBOLS), true)
 608     $1_EXTRA_CFLAGS += $$(CFLAGS_DEBUG_SYMBOLS)
 609     $1_EXTRA_CXXFLAGS += $$(CFLAGS_DEBUG_SYMBOLS)
 610     $1_EXTRA_ASFLAGS += $$(ASFLAGS_DEBUG_SYMBOLS)
 611   endif
 612 
 613   ifneq ($$($1_REORDER), )
 614     $1_EXTRA_CFLAGS += $$(C_FLAG_REORDER)
 615     $1_EXTRA_CXXFLAGS += $$(C_FLAG_REORDER)
 616   endif
 617 
 618   # Pass the library name for static JNI library naming
 619   ifeq ($$($1_TYPE), STATIC_LIBRARY)
 620     $1_EXTRA_CFLAGS += -DLIBRARY_NAME=$$($1_NAME)
 621     $1_EXTRA_CXXFLAGS += -DLIBRARY_NAME=$$($1_NAME)
 622   endif
 623 
 624   # Pick up disabled warnings, if possible on this platform.
 625   ifneq ($(DISABLE_WARNING_PREFIX), )
 626     $1_EXTRA_CFLAGS += $$(addprefix $(DISABLE_WARNING_PREFIX), \
 627         $$(DISABLED_WARNINGS) \
 628         $$(DISABLED_WARNINGS_C) \
 629         $$($1_DISABLED_WARNINGS_$(TOOLCHAIN_TYPE)) \
 630         $$($1_DISABLED_WARNINGS_C_$(TOOLCHAIN_TYPE)))
 631     $1_EXTRA_CXXFLAGS += $$(addprefix $(DISABLE_WARNING_PREFIX), \
 632         $$(DISABLED_WARNINGS) \
 633         $$(DISABLED_WARNINGS_CXX) \
 634         $$($1_DISABLED_WARNINGS_$(TOOLCHAIN_TYPE)) \
 635         $$($1_DISABLED_WARNINGS_CXX_$(TOOLCHAIN_TYPE)))
 636   endif
 637 
 638   # Check if warnings should be considered errors.
 639   # Pick first binary and toolchain specific, then binary specific, then general setting.
 640   ifeq ($$($1_WARNINGS_AS_ERRORS_$(TOOLCHAIN_TYPE)), )
 641     ifeq ($$($1_WARNINGS_AS_ERRORS), )
 642       $1_WARNINGS_AS_ERRORS_$(TOOLCHAIN_TYPE) := $$(WARNINGS_AS_ERRORS)
 643     else
 644       $1_WARNINGS_AS_ERRORS_$(TOOLCHAIN_TYPE) := $$($1_WARNINGS_AS_ERRORS)
 645     endif
 646   endif
 647 
 648   ifeq ($$($1_WARNINGS_AS_ERRORS_$(TOOLCHAIN_TYPE)), true)
 649     $1_EXTRA_CFLAGS += $(CFLAGS_WARNINGS_ARE_ERRORS)
 650     $1_EXTRA_CXXFLAGS += $(CFLAGS_WARNINGS_ARE_ERRORS)
 651     $1_EXTRA_LDFLAGS += $(LDFLAGS_WARNINGS_ARE_ERRORS)
 652   endif
 653 
 654   ifeq (NONE, $$($1_OPTIMIZATION))
 655     $1_OPT_CFLAGS := $(C_O_FLAG_NONE)
 656     $1_OPT_CXXFLAGS := $(CXX_O_FLAG_NONE)
 657   else ifeq (LOW, $$($1_OPTIMIZATION))
 658     $1_OPT_CFLAGS := $(C_O_FLAG_NORM)
 659     $1_OPT_CXXFLAGS := $(CXX_O_FLAG_NORM)
 660   else ifeq (HIGH, $$($1_OPTIMIZATION))
 661     $1_OPT_CFLAGS := $(C_O_FLAG_HI)
 662     $1_OPT_CXXFLAGS := $(CXX_O_FLAG_HI)
 663   else ifeq (HIGHEST, $$($1_OPTIMIZATION))
 664     $1_OPT_CFLAGS := $(C_O_FLAG_HIGHEST)
 665     $1_OPT_CXXFLAGS := $(CXX_O_FLAG_HIGHEST)
 666   else ifeq (HIGHEST_JVM, $$($1_OPTIMIZATION))
 667     $1_OPT_CFLAGS := $(C_O_FLAG_HIGHEST_JVM)
 668     $1_OPT_CXXFLAGS := $(CXX_O_FLAG_HIGHEST_JVM)
 669   else ifeq (SIZE, $$($1_OPTIMIZATION))
 670     $1_OPT_CFLAGS := $(C_O_FLAG_SIZE)
 671     $1_OPT_CXXFLAGS := $(CXX_O_FLAG_SIZE)
 672   else ifneq (, $$($1_OPTIMIZATION))
 673     $$(error Unknown value for OPTIMIZATION: $$($1_OPTIMIZATION))
 674   endif
 675 
 676   $1_BUILD_INFO := $$($1_OBJECT_DIR)/_build-info.marker
 677 
 678   # Track variable changes for all variables that affect the compilation command
 679   # lines for all object files in this setup. This includes at least all the
 680   # variables used in the call to add_native_source below.
 681   $1_COMPILE_VARDEPS := $$($1_CFLAGS) $$($1_EXTRA_CFLAGS) $$($1_SYSROOT_CFLAGS) \
 682       $$($1_CXXFLAGS) $$($1_EXTRA_CXXFLAGS) $$($1_OPT_CFLAGS) $$($1_OPT_CXXFLAGS) \
 683       $$($1_CC) $$($1_CXX) $$($1_AS) $$($1_ASFLAGS)
 684   $1_COMPILE_VARDEPS_FILE := $$(call DependOnVariable, $1_COMPILE_VARDEPS, \
 685       $$($1_OBJECT_DIR)/$$($1_NOSUFFIX).comp.vardeps)
 686 
 687   ifneq ($$($1_PRECOMPILED_HEADER), )
 688     ifeq ($(USE_PRECOMPILED_HEADER), true)
 689       ifeq ($(TOOLCHAIN_TYPE), microsoft)
 690         $1_PCH_FILE := $$($1_OBJECT_DIR)/$1.pch
 691         $1_GENERATED_PCH_SRC := $$($1_OBJECT_DIR)/$1_pch.cpp
 692         $1_GENERATED_PCH_OBJ := $$($1_OBJECT_DIR)/$1_pch.obj
 693 
 694         $$(eval $$(call SetupCompileNativeFile, $1_$$(notdir $$($1_GENERATED_PCH_SRC)), \
 695             FILE := $$($1_GENERATED_PCH_SRC), \
 696             BASE := $1, \
 697             EXTRA_CXXFLAGS := -Fp$$($1_PCH_FILE) -Yc$$(notdir $$($1_PRECOMPILED_HEADER)), \
 698             DISABLE_THIS_FILE_DEFINE := true, \
 699         ))
 700 
 701         $1_USE_PCH_FLAGS := \
 702             -Fp$$($1_PCH_FILE) -Yu$$(notdir $$($1_PRECOMPILED_HEADER))
 703 
 704         $$($1_ALL_OBJS): $$($1_GENERATED_PCH_OBJ)
 705 
 706         # Explicitly add the pch obj file first to ease comparing to old
 707         # hotspot build.
 708         $1_ALL_OBJS := $$($1_GENERATED_PCH_OBJ) $$($1_ALL_OBJS)
 709 
 710         $$($1_GENERATED_PCH_SRC):
 711                 $(ECHO) "#include \"$$(notdir $$($1_PRECOMPILED_HEADER))\"" > $$@
 712 
 713       else ifneq ($(findstring $(TOOLCHAIN_TYPE), gcc clang), )
 714         ifeq ($(TOOLCHAIN_TYPE), gcc)
 715           $1_PCH_FILE := $$($1_OBJECT_DIR)/precompiled/$$(notdir $$($1_PRECOMPILED_HEADER)).gch
 716           $1_USE_PCH_FLAGS := -I$$($1_OBJECT_DIR)/precompiled
 717         else ifeq ($(TOOLCHAIN_TYPE), clang)
 718           $1_PCH_FILE := $$($1_OBJECT_DIR)/precompiled/$$(notdir $$($1_PRECOMPILED_HEADER)).pch
 719           $1_USE_PCH_FLAGS := -include-pch $$($1_PCH_FILE)
 720         endif
 721         $1_PCH_DEP := $$($1_PCH_FILE).d
 722         $1_PCH_DEP_TARGETS := $$($1_PCH_FILE).d.targets
 723 
 724         -include $$($1_PCH_DEP)
 725         -include $$($1_PCH_DEP_TARGETS)
 726 
 727         $1_PCH_COMMAND := $$($1_CC) $$($1_CFLAGS) $$($1_EXTRA_CFLAGS) $$($1_SYSROOT_CFLAGS) \
 728             $$($1_OPT_CFLAGS) -x c++-header -c $(C_FLAG_DEPS) $$($1_PCH_DEP)
 729 
 730         $$($1_PCH_FILE): $$($1_PRECOMPILED_HEADER) $$($1_COMPILE_VARDEPS_FILE)
 731                 $$(call LogInfo, Generating precompiled header)
 732                 $$(call MakeDir, $$(@D))
 733                 $$(call ExecuteWithLog, $$@, $$($1_PCH_COMMAND) $$< -o $$@)
 734                 $(SED) $(DEPENDENCY_TARGET_SED_PATTERN) $$($1_PCH_DEP) > $$($1_PCH_DEP_TARGETS)
 735 
 736         $$($1_ALL_OBJS): $$($1_PCH_FILE)
 737 
 738         # Generate the corresponding compile_commands.json fragment.
 739         $1_PCH_FILE_JSON := $$(MAKESUPPORT_OUTPUTDIR)/compile-commands/$$(subst /,_,$$(subst \
 740             $$(OUTPUTDIR)/,,$$($1_PCH_FILE))).json
 741         $1_ALL_OBJS_JSON += $$($1_PCH_FILE_JSON)
 742 
 743         $$($1_PCH_FILE_JSON): $$($1_PRECOMPILED_HEADER) $$($1_COMPILE_VARDEPS_FILE)
 744                 $$(call WriteCompileCommandsFragment, $$@, $$(PWD), $$<, \
 745                     $$($1_PCH_COMMAND) $$< -o $$($1_PCH_FILE))
 746       endif
 747     endif
 748   endif
 749 
 750   # Now call SetupCompileNativeFile for each source file we are going to compile.
 751   $$(foreach file, $$($1_SRCS), \
 752       $$(eval $$(call SetupCompileNativeFile, $1_$$(notdir $$(file)),\
 753           FILE := $$(file), \
 754           BASE := $1, \
 755       )) \
 756   )
 757 
 758   # Setup rule for printing progress info when compiling source files.
 759   # This is a rough heuristic and may not always print accurate information.
 760   $$($1_BUILD_INFO): $$($1_SRCS) $$($1_COMPILE_VARDEPS_FILE)
 761         ifeq ($$(wildcard $$($1_TARGET)), )
 762           $(ECHO) 'Creating $$(subst $$(OUTPUTDIR)/,,$$($1_TARGET)) from $$(words \
 763               $$(filter-out %.vardeps, $$?)) file(s)'
 764         else
 765           $(ECHO) $$(strip 'Updating $$(subst $$(OUTPUTDIR)/,,$$($1_TARGET))' \
 766               $$(if $$(filter-out %.vardeps, $$?), \
 767                 'due to $$(words $$(filter-out %.vardeps, $$?)) file(s)', \
 768               $$(if $$(filter %.vardeps, $$?), 'due to makefile changes')))
 769         endif
 770         $(TOUCH) $$@
 771 
 772   # On windows we need to create a resource file
 773   ifeq ($(OPENJDK_TARGET_OS), windows)
 774     ifneq ($$($1_VERSIONINFO_RESOURCE), )
 775       $1_RES := $$($1_OBJECT_DIR)/$$($1_BASENAME).res
 776       $1_RES_DEP := $$($1_RES).d
 777       $1_RES_DEP_TARGETS := $$($1_RES).d.targets
 778       -include $$($1_RES_DEP)
 779       -include $$($1_RES_DEP_TARGETS)
 780 
 781       $1_RES_VARDEPS := $$($1_RC) $$($1_RC_FLAGS)
 782       $1_RES_VARDEPS_FILE := $$(call DependOnVariable, $1_RES_VARDEPS, \
 783           $$($1_RES).vardeps)
 784 
 785       $$($1_RES): $$($1_VERSIONINFO_RESOURCE) $$($1_RES_VARDEPS_FILE)
 786                 $$(call LogInfo, Compiling resource $$(notdir $$($1_VERSIONINFO_RESOURCE)) (for $$($1_BASENAME)))
 787                 $$(call MakeDir, $$(@D) $$($1_OBJECT_DIR))
 788                 $$(call ExecuteWithLog, $$@, \
 789                     $$($1_RC) $$($1_RC_FLAGS) $$($1_SYSROOT_CFLAGS) $(CC_OUT_OPTION)$$@ \
 790                     $$($1_VERSIONINFO_RESOURCE) 2>&1 )
 791                 # Windows RC compiler does not support -showIncludes, so we mis-use CL
 792                 # for this. Filter out RC specific arguments that are unknown to CL.
 793                 # For some unknown reason, in this case CL actually outputs the show
 794                 # includes to stderr so need to redirect it to hide the output from the
 795                 # main log.
 796                 $$(call ExecuteWithLog, $$($1_RES_DEP).obj, \
 797                     $$($1_CC) $$(filter-out -l%, $$($1_RC_FLAGS)) \
 798                         $$($1_SYSROOT_CFLAGS) -showIncludes -nologo -TC \
 799                         $(CC_OUT_OPTION)$$($1_RES_DEP).obj -P -Fi$$($1_RES_DEP).pp \
 800                         $$($1_VERSIONINFO_RESOURCE)) 2>&1 \
 801                     | $(TR) -d '\r' | $(GREP) -v -e "^Note: including file:" \
 802                         -e "^$$(notdir $$($1_VERSIONINFO_RESOURCE))$$$$" || test "$$$$?" = "1" ; \
 803                 $(ECHO) $$($1_RES): \\ > $$($1_RES_DEP) ; \
 804                 $(SED) $(WINDOWS_SHOWINCLUDE_SED_PATTERN) $$($1_RES_DEP).obj.log >> $$($1_RES_DEP) ; \
 805                 $(SED) $(DEPENDENCY_TARGET_SED_PATTERN) $$($1_RES_DEP) > $$($1_RES_DEP_TARGETS)
 806     endif
 807   endif
 808 
 809   ifneq ($(DISABLE_MAPFILES), true)
 810     $1_REAL_MAPFILE := $$($1_MAPFILE)
 811     ifneq ($(OPENJDK_TARGET_OS), windows)
 812       ifneq ($$($1_REORDER), )
 813         $1_REAL_MAPFILE := $$($1_OBJECT_DIR)/mapfile
 814 
 815         $$($1_REAL_MAPFILE) : $$($1_MAPFILE) $$($1_REORDER)
 816                 $$(call MakeDir, $$(@D))
 817                 $$(CP) $$($1_MAPFILE) $$@.tmp
 818                 $$(SED) -e 's=OUTPUTDIR=$$($1_OBJECT_DIR)=' $$($1_REORDER) >> $$@.tmp
 819                 $$(MV) $$@.tmp $$@
 820       endif
 821     endif
 822   endif
 823 
 824   # Pickup extra OPENJDK_TARGET_OS_TYPE and/or OPENJDK_TARGET_OS dependent variables
 825   # for LDFLAGS and LIBS
 826   $1_EXTRA_LDFLAGS += $$($1_LDFLAGS_$(OPENJDK_TARGET_OS_TYPE)) $$($1_LDFLAGS_$(OPENJDK_TARGET_OS))
 827   $1_EXTRA_LIBS += $$($1_LIBS_$(OPENJDK_TARGET_OS_TYPE)) $$($1_LIBS_$(OPENJDK_TARGET_OS))
 828   ifneq ($$($1_REAL_MAPFILE), )
 829     $1_EXTRA_LDFLAGS += $(call SET_SHARED_LIBRARY_MAPFILE,$$($1_REAL_MAPFILE))
 830   endif
 831 
 832   # Need to make sure TARGET is first on list
 833   $1 := $$($1_TARGET)
 834 
 835   ifneq ($$($1_COPY_DEBUG_SYMBOLS), false)
 836     $1_COPY_DEBUG_SYMBOLS := $(COPY_DEBUG_SYMBOLS)
 837   endif
 838 
 839   ifneq ($$($1_ZIP_EXTERNAL_DEBUG_SYMBOLS), false)
 840     $1_ZIP_EXTERNAL_DEBUG_SYMBOLS := $(ZIP_EXTERNAL_DEBUG_SYMBOLS)
 841   endif
 842 
 843   ifeq ($$($1_COPY_DEBUG_SYMBOLS), true)
 844     ifneq ($$($1_DEBUG_SYMBOLS), false)
 845       # Only copy debug symbols for dynamic libraries and programs.
 846       ifneq ($$($1_TYPE), STATIC_LIBRARY)
 847         # Generate debuginfo files.
 848         ifeq ($(OPENJDK_TARGET_OS), windows)
 849           $1_EXTRA_LDFLAGS += -debug "-pdb:$$($1_OUTPUT_DIR)/$$($1_NOSUFFIX).pdb" \
 850               "-map:$$($1_OUTPUT_DIR)/$$($1_NOSUFFIX).map"
 851           $1_DEBUGINFO_FILES := $$($1_OUTPUT_DIR)/$$($1_NOSUFFIX).pdb \
 852               $$($1_OUTPUT_DIR)/$$($1_NOSUFFIX).map
 853 
 854         else ifneq ($(findstring $(OPENJDK_TARGET_OS), linux solaris), )
 855           $1_DEBUGINFO_FILES := $$($1_OUTPUT_DIR)/$$($1_NOSUFFIX).debuginfo
 856           # Setup the command line creating debuginfo files, to be run after linking.
 857           # It cannot be run separately since it updates the original target file
 858           $1_CREATE_DEBUGINFO_CMDS := \
 859               $$($1_OBJCOPY) --only-keep-debug $$($1_TARGET) $$($1_DEBUGINFO_FILES) $$(NEWLINE) \
 860               $(CD) $$($1_OUTPUT_DIR) && \
 861                   $$($1_OBJCOPY) --add-gnu-debuglink=$$($1_DEBUGINFO_FILES) $$($1_TARGET)
 862 
 863         else ifeq ($(OPENJDK_TARGET_OS), macosx)
 864           $1_DEBUGINFO_FILES := \
 865               $$($1_OUTPUT_DIR)/$$($1_BASENAME).dSYM/Contents/Info.plist \
 866               $$($1_OUTPUT_DIR)/$$($1_BASENAME).dSYM/Contents/Resources/DWARF/$$($1_BASENAME)
 867           $1_CREATE_DEBUGINFO_CMDS := \
 868               $(DSYMUTIL) --out $$($1_OUTPUT_DIR)/$$($1_BASENAME).dSYM $$($1_TARGET)
 869         endif # OPENJDK_TARGET_OS
 870 
 871         # Since the link rule creates more than one file that we want to track,
 872         # we have to use some tricks to get make to cooperate. To properly
 873         # trigger downstream dependants of $$($1_DEBUGINFO_FILES), we must have
 874         # a recipe in the rule below. To avoid rerunning the recipe every time
 875         # have it touch the target. If a debuginfo file is deleted by something
 876         # external, explicitly delete the TARGET to trigger a rebuild of both.
 877         ifneq ($$(wildcard $$($1_DEBUGINFO_FILES)), $$($1_DEBUGINFO_FILES))
 878           $$(call LogDebug, Deleting $$($1_BASENAME) because debuginfo files are missing)
 879           $$(shell $(RM) $$($1_TARGET))
 880         endif
 881         $$($1_DEBUGINFO_FILES): $$($1_TARGET)
 882                 $$(if $$(CORRECT_FUNCTION_IN_RECIPE_EVALUATION), \
 883                   $$(if $$(wildcard $$@), , $$(error $$@ was not created for $$<)) \
 884                 )
 885                 $(TOUCH) $$@
 886 
 887         $1 += $$($1_DEBUGINFO_FILES)
 888 
 889         ifeq ($$($1_ZIP_EXTERNAL_DEBUG_SYMBOLS), true)
 890           $1_DEBUGINFO_ZIP := $$($1_OUTPUT_DIR)/$$($1_NOSUFFIX).diz
 891           $1 += $$($1_DEBUGINFO_ZIP)
 892 
 893           # The dependency on TARGET is needed for debuginfo files
 894           # to be rebuilt properly.
 895           $$($1_DEBUGINFO_ZIP): $$($1_DEBUGINFO_FILES) $$($1_TARGET)
 896                 $(CD) $$($1_OUTPUT_DIR) && \
 897                     $(ZIPEXE) -q -r $$@ $$(subst $$($1_OUTPUT_DIR)/,, $$($1_DEBUGINFO_FILES))
 898 
 899         endif
 900        endif # !STATIC_LIBRARY
 901     endif # $1_DEBUG_SYMBOLS != false
 902   endif # COPY_DEBUG_SYMBOLS
 903 
 904   # Unless specifically set, stripping should only happen if symbols are also
 905   # being copied.
 906   $$(call SetIfEmpty, $1_STRIP_SYMBOLS, $$($1_COPY_DEBUG_SYMBOLS))
 907 
 908   ifneq ($$($1_STRIP_SYMBOLS), false)
 909     ifneq ($$($1_STRIP), )
 910       # Default to using the global STRIPFLAGS. Allow for overriding with an empty value
 911       $1_STRIPFLAGS ?= $(STRIPFLAGS)
 912       $1_STRIP_CMD := $$($1_STRIP) $$($1_STRIPFLAGS) $$($1_TARGET)
 913     endif
 914   endif
 915 
 916   ifeq ($$($1_TYPE), STATIC_LIBRARY)
 917     $1_VARDEPS := $$($1_AR) $$($1_ARFLAGS) $$($1_LIBS) \
 918         $$($1_EXTRA_LIBS)
 919     $1_VARDEPS_FILE := $$(call DependOnVariable, $1_VARDEPS, \
 920         $$($1_OBJECT_DIR)/$$($1_NOSUFFIX).vardeps)
 921 
 922     # Generating a static library, ie object file archive.
 923     ifeq ($(STATIC_BUILD), true)
 924       ifeq ($$($1_USE_MAPFILE_FOR_SYMBOLS), true)
 925         STATIC_MAPFILE_DEP := $$($1_MAPFILE)
 926       endif
 927     endif
 928 
 929     $1_TARGET_DEPS := $$($1_ALL_OBJS) $$($1_RES) $$($1_VARDEPS_FILE) $$(STATIC_MAPFILE_DEP)
 930 
 931     $$($1_TARGET): $$($1_TARGET_DEPS)
 932         $$(call LogInfo, Building static library $$($1_BASENAME))
 933         $$(call ExecuteWithLog, $$($1_OBJECT_DIR)/$$($1_SAFE_NAME)_link, \
 934             $$($1_AR) $$($1_ARFLAGS) $(AR_OUT_OPTION)$$($1_TARGET) $$($1_ALL_OBJS) \
 935                 $$($1_RES))
 936         ifeq ($(STATIC_BUILD), true)
 937           ifeq ($$($1_USE_MAPFILE_FOR_SYMBOLS), true)
 938             $(CP) $$($1_MAPFILE) $$(@D)/$$(basename $$(@F)).symbols
 939           else
 940             $(GetSymbols)
 941           endif
 942         endif
 943   else
 944     # A shared dynamic library or an executable binary has been specified
 945     ifeq ($$($1_TYPE), LIBRARY)
 946       # Generating a dynamic library.
 947       $1_EXTRA_LDFLAGS += $$(call SET_SHARED_LIBRARY_NAME,$$($1_BASENAME))
 948 
 949       # Create loadmap on AIX. Helps in diagnosing some problems.
 950       ifneq ($(COMPILER_BINDCMD_FILE_FLAG), )
 951         $1_EXTRA_LDFLAGS += $(COMPILER_BINDCMD_FILE_FLAG)$$($1_OBJECT_DIR)/$$($1_NOSUFFIX).loadmap
 952       endif
 953     endif
 954 
 955     ifeq ($(OPENJDK_TARGET_OS), windows)
 956       ifeq ($$($1_EMBED_MANIFEST), true)
 957         $1_EXTRA_LDFLAGS += -manifest:embed
 958       endif
 959 
 960       $1_IMPORT_LIBRARY := $$($1_OBJECT_DIR)/$$($1_NAME).lib
 961       $1_EXTRA_LDFLAGS += "-implib:$$($1_IMPORT_LIBRARY)"
 962       ifeq ($$($1_TYPE), LIBRARY)
 963         # To properly trigger downstream dependants of the import library, just as
 964         # for debug files, we must have a recipe in the rule. To avoid rerunning
 965         # the recipe every time have it touch the target. If an import library
 966         # file is deleted by something external, explicitly delete the target to
 967         # trigger a rebuild of both.
 968         ifneq ($$(wildcard $$($1_IMPORT_LIBRARY)), $$($1_IMPORT_LIBRARY))
 969           $$(call LogDebug, Deleting $$($1_BASENAME) because import library is missing)
 970           $$(shell $(RM) $$($1_TARGET))
 971         endif
 972         $$($1_IMPORT_LIBRARY): $$($1_TARGET)
 973                 $$(if $$(CORRECT_FUNCTION_IN_RECIPE_EVALUATION), \
 974                   $$(if $$(wildcard $$@), , $$(error $$@ was not created for $$<)) \
 975                 )
 976                 $(TOUCH) $$@
 977       endif
 978     endif
 979 
 980     $1_VARDEPS := $$($1_LD) $$($1_SYSROOT_LDFLAGS) $$($1_LDFLAGS) $$($1_EXTRA_LDFLAGS) \
 981         $$(GLOBAL_LIBS) $$($1_LIBS) $$($1_EXTRA_LIBS) $$($1_MT) \
 982         $$($1_CODESIGN) $$($1_CREATE_DEBUGINFO_CMDS) $$($1_MANIFEST_VERSION) \
 983         $$($1_STRIP_CMD)
 984     $1_VARDEPS_FILE := $$(call DependOnVariable, $1_VARDEPS, \
 985         $$($1_OBJECT_DIR)/$$($1_NOSUFFIX).vardeps)
 986 
 987     $1_LD_OBJ_ARG := $$($1_ALL_OBJS)
 988 
 989     # If there are many object files, use an @-file...
 990     ifneq ($$(word 17, $$($1_ALL_OBJS)), )
 991       $1_OBJ_FILE_LIST := $$($1_OBJECT_DIR)/_$1_objectfilenames.txt
 992       ifneq ($(COMPILER_COMMAND_FILE_FLAG), )
 993         $1_LD_OBJ_ARG := $(COMPILER_COMMAND_FILE_FLAG)$$($1_OBJ_FILE_LIST)
 994       else
 995         # ...except for toolchains which don't support them.
 996         $1_LD_OBJ_ARG := `cat $$($1_OBJ_FILE_LIST)`
 997       endif
 998     endif
 999 
1000     # Unfortunately the @-file trick does not work reliably when using clang.
1001     # Clang does not propagate the @-file parameter to the ld sub process, but
1002     # instead puts the full content on the command line. At least the llvm ld
1003     # does not even support an @-file.
1004     #
1005     # When linking a large amount of object files, we risk hitting the limit
1006     # of the command line length even on posix systems if the path length of
1007     # the output dir is very long due to our use of absolute paths. To
1008     # mitigate this, use paths relative to the output dir when linking over
1009     # 500 files with clang and the output dir path is deep.
1010     ifneq ($$(word 500, $$($1_ALL_OBJS)), )
1011       ifeq ($$(TOOLCHAIN_TYPE), clang)
1012         # There is no strlen function in make, but checking path depth is a
1013         # reasonable approximation.
1014         ifneq ($$(word 10, $$(subst /, ,$$(OUTPUTDIR))), )
1015           $1_LINK_OBJS_RELATIVE := true
1016           $1_ALL_OBJS_RELATIVE := $$(patsubst $$(OUTPUTDIR)/%, %, $$($1_ALL_OBJS))
1017         endif
1018       endif
1019     endif
1020 
1021     $1_TARGET_DEPS := $$($1_ALL_OBJS) $$($1_RES) $$($1_MANIFEST) \
1022         $$($1_REAL_MAPFILE) $$($1_VARDEPS_FILE)
1023 
1024     $$($1_TARGET): $$($1_TARGET_DEPS)
1025                 ifneq ($$($1_OBJ_FILE_LIST), )
1026                   ifeq ($$($1_LINK_OBJS_RELATIVE), true)
1027                     $$(eval $$(call ListPathsSafely, $1_ALL_OBJS_RELATIVE, $$($1_OBJ_FILE_LIST)))
1028                   else
1029                     $$(eval $$(call ListPathsSafely, $1_ALL_OBJS, $$($1_OBJ_FILE_LIST)))
1030                   endif
1031                 endif
1032                 # Keep as much as possible on one execution line for best performance
1033                 # on Windows
1034                 $$(call LogInfo, Linking $$($1_BASENAME))
1035                 ifeq ($(OPENJDK_TARGET_OS), windows)
1036                   $$(call ExecuteWithLog, $$($1_OBJECT_DIR)/$$($1_SAFE_NAME)_link, \
1037                       $$($1_LD) $$($1_LDFLAGS) $$($1_EXTRA_LDFLAGS) $$($1_SYSROOT_LDFLAGS) \
1038                           $(LD_OUT_OPTION)$$($1_TARGET) $$($1_LD_OBJ_ARG) $$($1_RES) $$(GLOBAL_LIBS) \
1039                           $$($1_LIBS) $$($1_EXTRA_LIBS)) \
1040                       | $(GREP) -v "^   Creating library .*\.lib and object .*\.exp" || \
1041                           test "$$$$?" = "1" ; \
1042                   $$($1_CREATE_DEBUGINFO_CMDS)
1043                   $$($1_STRIP_CMD)
1044                 else
1045                   $$(call ExecuteWithLog, $$($1_OBJECT_DIR)/$$($1_SAFE_NAME)_link, \
1046                       $$(if $$($1_LINK_OBJS_RELATIVE), $$(CD) $$(OUTPUTDIR) ; ) \
1047                       $$($1_LD) $$($1_LDFLAGS) $$($1_EXTRA_LDFLAGS) $$($1_SYSROOT_LDFLAGS) \
1048                           $(LD_OUT_OPTION)$$($1_TARGET) $$($1_LD_OBJ_ARG) $$($1_RES) $$(GLOBAL_LIBS) \
1049                           $$($1_LIBS) $$($1_EXTRA_LIBS)) ; \
1050                   $$($1_CREATE_DEBUGINFO_CMDS)
1051                   $$($1_STRIP_CMD)
1052                 endif
1053                 ifeq ($(OPENJDK_TARGET_OS), windows)
1054                   ifneq ($$($1_MANIFEST), )
1055                     $$($1_MT) -nologo -manifest $$($1_MANIFEST) -identity:"$$($1_NAME).exe, version=$$($1_MANIFEST_VERSION)" -outputresource:$$@;#1
1056                   endif
1057                 endif
1058                 # This only works if the openjdk_codesign identity is present on the system. Let
1059                 # silently fail otherwise.
1060                 ifneq ($(CODESIGN), )
1061                   ifneq ($$($1_CODESIGN), )
1062                     $(CODESIGN) -s openjdk_codesign $$@
1063                   endif
1064                 endif
1065   endif
1066 
1067   ifeq ($(GENERATE_COMPILE_COMMANDS_ONLY), true)
1068     $1 := $$($1_ALL_OBJS_JSON)
1069   endif
1070 endef
1071 
1072 endif # _NATIVE_COMPILATION_GMK