#
# Copyright (c) 2013, 2019, 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.
#

################################################################################
# Gensrc support for dtrace. The files generated here are included by dtrace.hpp

ifeq ($(call check-jvm-feature, dtrace), true)

  ifeq ($(call isTargetOs, solaris), true)
    DTRACE_FLAGS := -64
    DTRACE_CPP_FLAGS := -D_LP64
  else ifeq ($(call isTargetOs, macosx), true)
    DTRACE_CPP_FLAGS := -D_LP64 -x c
  else ifeq ($(call isTargetOs, linux), true)
    DTRACE_CPP_FLAGS := -x c
  endif

  DTRACE_SOURCE_DIR := $(TOPDIR)/src/hotspot/os/posix/dtrace
  DTRACE_GENSRC_DIR := $(JVM_VARIANT_OUTPUTDIR)/gensrc/dtracefiles

  # Make sure we run our selected compiler for preprocessing instead of letting
  # the dtrace tool pick it on it's own.
  $(DTRACE_GENSRC_DIR)/%.h: $(DTRACE_SOURCE_DIR)/%.d
	$(call LogInfo, Generating dtrace header file $(@F))
	$(call MakeDir, $(@D) $(DTRACE_SUPPORT_DIR))
	$(call ExecuteWithLog, $(DTRACE_SUPPORT_DIR)/$(@F).d, \
	    ($(CPP) $(DTRACE_CPP_FLAGS) $< > $(DTRACE_SUPPORT_DIR)/$(@F).d))
	$(call ExecuteWithLog, $@, $(DTRACE) $(DTRACE_FLAGS) -h -o $@ -s $(DTRACE_SUPPORT_DIR)/$(@F).d)

  # Process all .d files in DTRACE_SOURCE_DIR. They are:
  # hotspot_jni.d hotspot.d hs_private.d
  TARGETS += $(patsubst $(DTRACE_SOURCE_DIR)/%.d, \
      $(DTRACE_GENSRC_DIR)/%.h, $(wildcard $(DTRACE_SOURCE_DIR)/*.d))

  ifeq ($(call isTargetOs, solaris), true)
    ############################################################################
    # First we need to generate the dtraceGenOffsets tool. When run, this will
    # produce two header files and a C++ file. Note that generateJvmOffsets.cpp
    # is using the same JVM_CFLAGS as libjvm.so.

    # Include support files that will setup JVM compiler flags.
    include lib/JvmFeatures.gmk
    include lib/JvmFlags.gmk

    # We cannot compile until the JVMTI and JFR gensrc has finished.
    # JFR_FILES is defined in GensrcJfr.gmk.
    JVMTI_H := $(JVM_VARIANT_OUTPUTDIR)/gensrc/jvmtifiles/jvmti.h

    $(eval $(call SetupNativeCompilation, BUILD_DTRACE_GEN_OFFSETS, \
        NAME := dtraceGenOffsets, \
        TYPE := EXECUTABLE, \
        SRC := $(TOPDIR)/make/hotspot/src/native/dtrace, \
        TOOLCHAIN := $(TOOLCHAIN_BUILD), \
        LDFLAGS := -m64, \
        CFLAGS := -m64 $(JVM_CFLAGS), \
        DISABLED_WARNINGS_solstudio := hidef w_novirtualdescr unknownpragma \
            doubunder nokeyworddefine wunreachable, \
        EXTRA_DEPS := $(JVMTI_H) $(JFR_FILES), \
        OBJECT_DIR := $(JVM_VARIANT_OUTPUTDIR)/tools/dtrace-gen-offsets/objs, \
        OUTPUT_DIR := $(JVM_VARIANT_OUTPUTDIR)/tools/dtrace-gen-offsets, \
        DEFINE_THIS_FILE := false, \
    ))

    DTRACE_GEN_OFFSETS_TOOL := $(BUILD_DTRACE_GEN_OFFSETS_TARGET)

    # Argument 1: Output filename
    # Argument 2: dtrace-gen-offset tool command line option
    define SetupDtraceOffsetsGeneration
      $$(eval $$(call SetupExecute, dtrace_offset_$$(strip $2), \
          INFO := Generating dtrace $2 file, \
          DEPS := $$(BUILD_DTRACE_GEN_OFFSETS), \
          OUTPUT_FILE := $1, \
          COMMAND := ( $$(DTRACE_GEN_OFFSETS_TOOL) -$$(strip $2) > $1 ), \
      ))

      TARGETS += $$(dtrace_offset_$$(strip $2)_TARGET)
    endef

    JVM_OFFSETS_H := $(DTRACE_GENSRC_DIR)/JvmOffsets.h
    JVM_OFFSETS_CPP := $(DTRACE_GENSRC_DIR)/JvmOffsets.cpp
    JVM_OFFSETS_INDEX_H := $(DTRACE_GENSRC_DIR)/JvmOffsetsIndex.h

    ############################################################################
    # Run the dtrace-gen-offset tool to generate these three files.
    # The generated JvmOffsets.cpp is compiled with the rest of libjvm.
    # The header files are used by libjvm_db and jhelper.d, respectively.

    $(eval $(call SetupDtraceOffsetsGeneration, $(JVM_OFFSETS_H), header))
    $(eval $(call SetupDtraceOffsetsGeneration, $(JVM_OFFSETS_INDEX_H), index))
    $(eval $(call SetupDtraceOffsetsGeneration, $(JVM_OFFSETS_CPP), table))
  endif

endif