#

# Copyright (c) 2011, 2018, 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.

#

# When you read this source. Remember that $(sort ...) has the side effect

# of removing duplicates. It is actually this side effect that is

# desired whenever sort is used below!

ifndef _NATIVE_COMPILATION_GMK

_NATIVE_COMPILATION_GMK := 1

ifeq ($(_MAKEBASE_GMK), )

  $(error You must include MakeBase.gmk prior to including NativeCompilation.gmk)

endif

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

# Create exported symbols file for static libraries

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

# get the exported symbols from mapfiles and if there

# is no mapfile, get them from the archive

define GetSymbols

  $(RM) $$(@D)/$$(basename $$(@F)).symbols; \

  if [ ! -z $$($1_MAPFILE) -a -e $$($1_MAPFILE) ]; then \

    $(ECHO) "Getting symbols from mapfile $$($1_MAPFILE)"; \

    $(AWK) '/global:/','/local:/' $$($1_MAPFILE) | \

        $(SED) -e 's/#.*//;s/global://;s/local://;s/\;//;s/^[ 	]*/_/;/^_$$$$/d' | \

        $(EGREP) -v "JNI_OnLoad|JNI_OnUnload|Agent_OnLoad|Agent_OnUnload|Agent_OnAttach" > \

        $$(@D)/$$(basename $$(@F)).symbols || true; \

    $(NM) $$($1_TARGET) | $(GREP)  " T " | \

        $(EGREP) "JNI_OnLoad|JNI_OnUnload|Agent_OnLoad|Agent_OnUnload|Agent_OnAttach" | \

        $(CUT) -d ' ' -f 3 >>  $$(@D)/$$(basename $$(@F)).symbols || true;\

  else \

    $(ECHO) "Getting symbols from nm"; \

    $(NM) -m $$($1_TARGET) | $(GREP)  "__TEXT" | \

        $(EGREP) -v "non-external|private extern|__TEXT,__eh_frame" | \

        $(SED) -e  's/.* //' > $$(@D)/$$(basename $$(@F)).symbols; \

  fi

endef

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

# Define a native toolchain configuration that can be used by

# SetupNativeCompilation calls

#

# Parameter 1 is the name of the toolchain definition

#

# Remaining parameters are named arguments:

#   EXTENDS - Optional parent definition to get defaults from

#   CC - The C compiler

#   CXX - The C++ compiler

#   LD - The Linker

#   AR - Static linker

#   AS - Assembler

#   MT - Windows MT tool

#   RC - Windows RC tool

#   OBJCOPY - The objcopy tool for debug symbol handling

#   STRIP - The tool to use for stripping debug symbols

#   SYSROOT_CFLAGS - Compiler flags for using the specific sysroot

#   SYSROOT_LDFLAGS - Linker flags for using the specific sysroot

DefineNativeToolchain = $(NamedParamsMacroTemplate)

define DefineNativeToolchainBody

  # If extending another definition, get default values from that,

  # otherwise, nothing more needs to be done as variable assignments

  # already happened in NamedParamsMacroTemplate.

  ifneq ($$($1_EXTENDS), )

    $$(call SetIfEmpty, $1_CC, $$($$($1_EXTENDS)_CC))

    $$(call SetIfEmpty, $1_CXX, $$($$($1_EXTENDS)_CXX))

    $$(call SetIfEmpty, $1_LD, $$($$($1_EXTENDS)_LD))

    $$(call SetIfEmpty, $1_AR, $$($$($1_EXTENDS)_AR))

    $$(call SetIfEmpty, $1_AS, $$($$($1_EXTENDS)_AS))

    $$(call SetIfEmpty, $1_MT, $$($$($1_EXTENDS)_MT))

    $$(call SetIfEmpty, $1_RC, $$($$($1_EXTENDS)_RC))

    $$(call SetIfEmpty, $1_OBJCOPY, $$($$($1_EXTENDS)_OBJCOPY))

    $$(call SetIfEmpty, $1_STRIP, $$($$($1_EXTENDS)_STRIP))

    $$(call SetIfEmpty, $1_SYSROOT_CFLAGS, $$($$($1_EXTENDS)_SYSROOT_CFLAGS))

    $$(call SetIfEmpty, $1_SYSROOT_LDFLAGS, $$($$($1_EXTENDS)_SYSROOT_LDFLAGS))

  endif

endef

# Create a default toolchain with the main compiler and linker

$(eval $(call DefineNativeToolchain, TOOLCHAIN_DEFAULT, \

    CC := $(CC), \

    CXX := $(CXX), \

    LD := $(LD), \

    AR := $(AR), \

    AS := $(AS), \

    MT := $(MT), \

    RC := $(RC), \

    OBJCOPY := $(OBJCOPY), \

    STRIP := $(STRIP), \

    SYSROOT_CFLAGS := $(SYSROOT_CFLAGS), \

    SYSROOT_LDFLAGS := $(SYSROOT_LDFLAGS), \

))

# Create a toolchain where linking is done with the C++ linker

$(eval $(call DefineNativeToolchain, TOOLCHAIN_LINK_CXX, \

    EXTENDS := TOOLCHAIN_DEFAULT, \

    LD := $(LDCXX), \

))

# Create a toolchain with the BUILD compiler, used for build tools that

# are to be run during the build.

$(eval $(call DefineNativeToolchain, TOOLCHAIN_BUILD, \

    CC := $(BUILD_CC), \

    CXX := $(BUILD_CXX), \

    LD := $(BUILD_LD), \

    AR := $(BUILD_AR), \

    AS := $(BUILD_AS), \

    OBJCOPY := $(BUILD_OBJCOPY), \

    STRIP := $(BUILD_STRIP), \

    SYSROOT_CFLAGS := $(BUILD_SYSROOT_CFLAGS), \

    SYSROOT_LDFLAGS := $(BUILD_SYSROOT_LDFLAGS), \

))

# BUILD toolchain with the C++ linker

$(eval $(call DefineNativeToolchain, TOOLCHAIN_BUILD_LINK_CXX, \

    EXTENDS := TOOLCHAIN_BUILD, \

    LD := $(BUILD_LDCXX), \

))

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

# Extensions of files handled by this macro.

NATIVE_SOURCE_EXTENSIONS := %.s %.S %.c %.cpp %.cc %.m %.mm

# Replaces native source extensions with the object file extension in a string.

# Param 1: the string containing source file names with extensions

# The surrounding strip is needed to keep additional whitespace out

define replace_with_obj_extension

$(strip \

  $(foreach extension, $(NATIVE_SOURCE_EXTENSIONS), \

      $(patsubst $(extension),%$(OBJ_SUFFIX), $(filter $(extension), $1))) \

)

endef

ifeq ($(OPENJDK_BUILD_OS_ENV), windows.cygwin)

  UNIX_PATH_PREFIX := /cygdrive

else ifeq ($(OPENJDK_BUILD_OS_ENV), windows.msys)

  UNIX_PATH_PREFIX :=

endif

# This pattern is used to transform the output of the microsoft CL compiler

# into a make syntax dependency file (.d)

WINDOWS_SHOWINCLUDE_SED_PATTERN := \

    -e '/^Note: including file:/!d' \

    -e 's|Note: including file: *||' \

    -e 's|\r||g' \

    -e 's|\\|/|g' \

    -e 's|^\([a-zA-Z]\):|$(UNIX_PATH_PREFIX)/\1|g' \

    -e '\|$(TOPDIR)|I !d' \

    -e 's|$$$$| \\|g' \

    #

# This pattern is used to transform a dependency file (.d) to a list

# of make targets for dependent files (.d.targets)

DEPENDENCY_TARGET_SED_PATTERN := \

    -e 's/\#.*//' \

    -e 's/^[^:]*: *//' \

    -e 's/ *\\$$$$//' \

    -e 's/^[	 ]*//' \

    -e '/^$$$$/ d' \

    -e 's/$$$$/ :/' \

    #

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

# Create the recipe needed to compile a single native source file.

#

# Parameter 1 is the name of the rule, based on the name of the library/

# program being build and the name of the source code file, e.g.

# BUILD_LIBFOO_fooMain.cpp.

#

# Remaining parameters are named arguments:

#   FILE - The full path of the source file to compiler

#   BASE - The name of the rule for the entire binary to build ($1)

#   DISABLE_THIS_FILE_DEFINE - Set to true to disable the THIS_FILE define.

#

SetupCompileNativeFile = $(NamedParamsMacroTemplate)

define SetupCompileNativeFileBody

  $1_FILENAME := $$(notdir $$($1_FILE))

  # The target file to be generated.

  $1_OBJ := $$($$($1_BASE)_OBJECT_DIR)/$$(call replace_with_obj_extension, \

      $$($1_FILENAME))

  # Only continue if this object file hasn't been processed already. This lets

  # the first found source file override any other with the same name.

  ifeq ($$(findstring $$($1_OBJ), $$($$($1_BASE)_OBJS_SO_FAR)), )

    $$($1_BASE)_OBJS_SO_FAR += $$($1_OBJ)

    # This is the definite source file to use for $1_FILENAME.

    $1_SRC_FILE := $$($1_FILE)

    ifneq ($$($1_DISABLE_THIS_FILE_DEFINE), true)

      $1_THIS_FILE = -DTHIS_FILE='"$$(<F)"'

    endif

    ifeq ($$($1_OPTIMIZATION), )

      $1_OPT_CFLAGS := $$($$($1_BASE)_OPT_CFLAGS)

      $1_OPT_CXXFLAGS := $$($$($1_BASE)_OPT_CXXFLAGS)

    else

      ifeq ($$($1_OPTIMIZATION), NONE)

        $1_OPT_CFLAGS := $(C_O_FLAG_NONE)

        $1_OPT_CXXFLAGS := $(CXX_O_FLAG_NONE)

      else ifeq ($$($1_OPTIMIZATION), LOW)

        $1_OPT_CFLAGS := $(C_O_FLAG_NORM)

        $1_OPT_CXXFLAGS := $(CXX_O_FLAG_NORM)

      else ifeq ($$($1_OPTIMIZATION), HIGH)

        $1_OPT_CFLAGS := $(C_O_FLAG_HI)

        $1_OPT_CXXFLAGS := $(CXX_O_FLAG_HI)

      else ifeq ($$($1_OPTIMIZATION), HIGHEST)

        $1_OPT_CFLAGS := $(C_O_FLAG_HIGHEST)

        $1_OPT_CXXFLAGS := $(CXX_O_FLAG_HIGHEST)

      else ifeq ($$($1_OPTIMIZATION), HIGHEST_JVM)

        $1_OPT_CFLAGS := $(C_O_FLAG_HIGHEST_JVM)

        $1_OPT_CXXFLAGS := $(CXX_O_FLAG_HIGHEST_JVM)

      else ifeq ($$($1_OPTIMIZATION), SIZE)

        $1_OPT_CFLAGS := $(C_O_FLAG_SIZE)

        $1_OPT_CXXFLAGS := $(CXX_O_FLAG_SIZE)

      else

        $$(error Unknown value for file OPTIMIZATION: $$($1_OPTIMIZATION))

      endif

    endif

    ifneq ($$($$($1_BASE)_PRECOMPILED_HEADER), )

      ifeq ($$(filter $$($1_FILENAME), $$($$($1_BASE)_PRECOMPILED_HEADER_EXCLUDE)), )

        $1_USE_PCH_FLAGS := $$($$($1_BASE)_USE_PCH_FLAGS)

      endif

    endif

    $1_BASE_CFLAGS :=  $$($$($1_BASE)_CFLAGS) $$($$($1_BASE)_EXTRA_CFLAGS) \

        $$($$($1_BASE)_SYSROOT_CFLAGS)

    $1_BASE_CXXFLAGS := $$($$($1_BASE)_CXXFLAGS) $$($$($1_BASE)_EXTRA_CXXFLAGS) \

        $$($$($1_BASE)_SYSROOT_CFLAGS) $$($1_EXTRA_CXXFLAGS)

    $1_BASE_ASFLAGS := $$($$($1_BASE)_ASFLAGS) $$($$($1_BASE)_EXTRA_ASFLAGS)

    ifneq ($$(filter %.c, $$($1_FILENAME)), )

      # Compile as a C file

      $1_FLAGS := $(CFLAGS_CCACHE) $$($1_USE_PCH_FLAGS) $$($1_BASE_CFLAGS) \

          $$($1_OPT_CFLAGS) $$($1_CFLAGS) $$($1_THIS_FILE) -c

      $1_COMPILER := $$($$($1_BASE)_CC)

      $1_DEP_FLAG := $(C_FLAG_DEPS)

    else ifneq ($$(filter %.m, $$($1_FILENAME)), )

      # Compile as an Objective-C file

      $1_FLAGS := -x objective-c $(CFLAGS_CCACHE) $$($1_USE_PCH_FLAGS) \

          $$($1_BASE_CFLAGS) $$($1_OPT_CFLAGS) $$($1_CFLAGS) $$($1_THIS_FILE) -c

      $1_COMPILER := $$($$($1_BASE)_CC)

      $1_DEP_FLAG := $(C_FLAG_DEPS)

    else ifneq ($$(filter %.s %.S, $$($1_FILENAME)), )

      # Compile as assembler file

      $1_FLAGS := $$($1_BASE_ASFLAGS)

      $1_COMPILER := $(AS)

      $1_DEP_FLAG :=

    else ifneq ($$(filter %.cpp %.cc %.mm, $$($1_FILENAME)), )

      # Compile as a C++ or Objective-C++ file

      $1_FLAGS := $(CFLAGS_CCACHE) $$($1_USE_PCH_FLAGS) $$($1_BASE_CXXFLAGS) \

          $$($1_OPT_CXXFLAGS) $$($1_CXXFLAGS) $$($1_THIS_FILE) -c

      $1_COMPILER := $$($$($1_BASE)_CXX)

      $1_DEP_FLAG := $(CXX_FLAG_DEPS)

    else

      $$(error Internal error in NativeCompilation.gmk: no compiler for file $$($1_FILENAME))

    endif

    ifeq ($$(filter %.s %.S, $$($1_FILENAME)), )

      # And this is the dependency file for this obj file.

      $1_DEP := $$(patsubst %$(OBJ_SUFFIX),%.d,$$($1_OBJ))

      # The dependency target file lists all dependencies as empty targets to

      # avoid make error "No rule to make target" for removed files

      $1_DEP_TARGETS := $$(patsubst %$(OBJ_SUFFIX),%.d.targets,$$($1_OBJ))

      # Include previously generated dependency information. (if it exists)

      -include $$($1_DEP)

      -include $$($1_DEP_TARGETS)

    endif

    ifneq ($$(strip $$($1_CFLAGS) $$($1_CXXFLAGS) $$($1_OPTIMIZATION)), )

      $1_VARDEPS := $$($1_CFLAGS) $$($1_CXXFLAGS) $$($1_OPTIMIZATION)

      $1_VARDEPS_FILE := $$(call DependOnVariable, $1_VARDEPS, $$($1_OBJ).vardeps)

    endif

	$$(call LogInfo, Compiling $$($1_FILENAME) (for $$($$($1_BASE)_BASENAME)))

	$$(call MakeDir, $$(@D))

        ifneq ($(TOOLCHAIN_TYPE), microsoft)

          ifeq ($(TOOLCHAIN_TYPE)$$(filter %.s, $$($1_FILENAME)), solstudio)

            # The Solaris studio compiler doesn't output the full path to the

            # object file in the generated deps files. Fixing it with sed. If

            # compiling assembly, don't try this.

	    $$(call ExecuteWithLog, $$@, \

	    $(SED) 's|^$$(@F):|$$@:|' $$($1_DEP).tmp > $$($1_DEP)

          else

	    $$(call ExecuteWithLog, $$@, \

          endif

          # Create a dependency target file from the dependency file.

          # Solution suggested by http://make.mad-scientist.net/papers/advanced-auto-dependency-generation/

          ifneq ($$($1_DEP), )

	    $(SED) $(DEPENDENCY_TARGET_SED_PATTERN) $$($1_DEP) > $$($1_DEP_TARGETS)

          endif

        else

          # The Visual Studio compiler lacks a feature for generating make

          # dependencies, but by setting -showIncludes, all included files are

          # printed. These are filtered out and parsed into make dependences.

          #

          # Keep as much as possible on one execution line for best performance

          # on Windows. No need to save exit code from compilation since

          # pipefail is always active on Windows.

	  $$(call ExecuteWithLog, $$@, \

	      | $(TR) -d '\r' | $(GREP) -v -e "^Note: including file:" \

	          -e "^$$($1_FILENAME)$$$$" || test "$$$$?" = "1" ; \

	  $(ECHO) $$@: \\ > $$($1_DEP) ; \

	  $(SED) $(WINDOWS_SHOWINCLUDE_SED_PATTERN) $$($1_OBJ).log \

	      | $(SORT) -u >> $$($1_DEP) ; \

	  $(SED) $(DEPENDENCY_TARGET_SED_PATTERN) $$($1_DEP) > $$($1_DEP_TARGETS)

        endif

  endif

endef

# Setup make rules for creating a native binary (a shared library or an

# executable).

#

# 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.

#

# Remaining parameters are named arguments. These include:

#   NAME The base name for the resulting binary, excluding decorations (like *.exe)

#   TYPE Type of binary (EXECUTABLE, LIBRARY or STATIC_LIBRARY). Default is LIBRARY.

#   SUFFIX Override the default suffix for the output file

#   TOOLCHAIN Name of toolchain setup to use. Defaults to TOOLCHAIN_DEFAULT.

#   SRC one or more directory roots to scan for C/C++ files.

#   CFLAGS the compiler flags to be used, used both for C and C++.

#   CXXFLAGS the compiler flags to be used for c++, if set overrides CFLAGS.

#   LDFLAGS the linker flags to be used, used both for C and C++.

#   LIBS the libraries to link to

#   ARFLAGS the archiver flags to be used

#   OBJECT_DIR the directory where we store the object files

#   OUTPUT_DIR the directory where the resulting binary is put

#   INCLUDES only pick source from these directories

#   EXCLUDES do not pick source from these directories

#   INCLUDE_FILES only compile exactly these files!

#   EXCLUDE_FILES with these names

#   EXCLUDE_PATTERN exclude files matching any of these substrings

#   EXTRA_FILES List of extra files not in any of the SRC dirs

#   EXTRA_OBJECT_FILES List of extra object files to include when linking

#   EXTRA_DEPS List of extra dependencies to be added to each compiled file

#   VERSIONINFO_RESOURCE Input file for RC. Setting this implies that RC will be run

#   RC_FLAGS flags for RC.

#   EMBED_MANIFEST if true, embed manifest on Windows.

#   MAPFILE mapfile

#   REORDER reorder file

#   USE_MAPFILE_FOR_SYMBOLS if true and this is a STATIC_BUILD, just copy the

#       mapfile for the output symbols file

#   CC the compiler to use, default is $(CC)

#   LD the linker to use, default is $(LD)

#   OPTIMIZATION sets optimization level to NONE, LOW, HIGH, HIGHEST, HIGHEST_JVM, SIZE

#   DISABLED_WARNINGS_<toolchain> Disable the given warnings for the specified toolchain

#   DISABLED_WARNINGS_C_<toolchain> Disable the given warnings for the specified toolchain

#       when compiling C code

#   DISABLED_WARNINGS_CXX_<toolchain> Disable the given warnings for the specified

#       toolchain when compiling C++ code

#   STRIP_SYMBOLS Set to false to override global strip policy and always leave

#       symbols in the binary, if the toolchain allows for it

#   DEBUG_SYMBOLS Set to false to disable generation of debug symbols

#   COPY_DEBUG_SYMBOLS Set to false to override global setting of debug symbol copying

#   ZIP_EXTERNAL_DEBUG_SYMBOLS Set to false to override global setting of debug symbol

#       zipping

#   STRIPFLAGS Optionally change the flags given to the strip command

#   PRECOMPILED_HEADER Header file to use as precompiled header

#   PRECOMPILED_HEADER_EXCLUDE List of source files that should not use PCH

#

# After being called, some variables are exported from this macro, all prefixed

# with parameter 1 followed by a '_':

#   TARGET The library or executable created by the macro

#   TARGET_DEPS All prerequisites for the target calculated by the macro

#   ALL_OBJS All object files

#   IMPORT_LIBRARY The import library created for a shared library on Windows

SetupNativeCompilation = $(NamedParamsMacroTemplate)

define SetupNativeCompilationBody

  # If type is unspecified, default to LIBRARY

  ifeq ($$($1_TYPE), )

    $1_TYPE := LIBRARY

  endif

  # If we're doing a static build and producing a library

  # force it to be a static library and remove the -l libraries

  ifeq ($(STATIC_BUILD), true)

    ifeq ($$($1_TYPE), LIBRARY)

      $1_TYPE := STATIC_LIBRARY

    endif

  endif

  ifeq ($$($1_TYPE), EXECUTABLE)

    $1_PREFIX :=

    ifeq ($$($1_SUFFIX), )

      $1_SUFFIX := $(EXE_SUFFIX)

    endif

  else

    $1_PREFIX := $(LIBRARY_PREFIX)

    ifeq ($$($1_TYPE), LIBRARY)

      ifeq ($$($1_SUFFIX), )

        $1_SUFFIX := $(SHARED_LIBRARY_SUFFIX)

      endif

    else ifeq ($$($1_TYPE), STATIC_LIBRARY)

      ifeq ($$($1_SUFFIX), )

        $1_SUFFIX := $(STATIC_LIBRARY_SUFFIX)

      endif

    endif

  endif

  ifneq ($$($1_NAME), $(basename $$($1_NAME)))

    $$(error NAME must not contain any directory path in $1)

  endif

  ifneq ($(findstring $$($1_SUFFIX), $$($1_NAME)), )

    $$(error NAME should be specified without suffix: $$($1_SUFFIX) in $1)

  endif

  ifneq ($(findstring $$($1_PREFIX), $$($1_NAME)), )

    $$(error NAME should be specified without prefix: $$($1_PREFIX) in $1)

  endif

  ifeq ($$($1_OUTPUT_DIR), )

    $$(error OUTPUT_DIR is missing in $1)

  endif

  ifneq ($$($1_MANIFEST), )

    ifeq ($$($1_MANIFEST_VERSION), )

      $$(error If MANIFEST is provided, then MANIFEST_VERSION is required in $1)

    endif

  endif

  $1_BASENAME := $$($1_PREFIX)$$($1_NAME)$$($1_SUFFIX)

  $1_TARGET := $$($1_OUTPUT_DIR)/$$($1_BASENAME)

  $1_NOSUFFIX := $$($1_PREFIX)$$($1_NAME)

  $1_SAFE_NAME := $$(strip $$(subst /,_, $1))