#

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

#

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

#

# Setup common utility functions.

#

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

ifndef _MAKEBASE_GMK

_MAKEBASE_GMK := 1

ifeq ($(wildcard $(SPEC)),)

  $(error MakeBase.gmk needs SPEC set to a proper spec.gmk)

endif

# By defining this pseudo target, make will automatically remove targets

# if their recipe fails so that a rebuild is automatically triggered on the

# next make invocation.

.DELETE_ON_ERROR:

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

# Definitions for special characters

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

# When calling macros, the spaces between arguments are

# often semantically important! Sometimes we need to subst

# spaces and commas, therefore we need the following macros.

X:=

SPACE:=$(X) $(X)

COMMA:=,

DOLLAR:=$$

HASH:=\#

LEFT_PAREN:=(

RIGHT_PAREN:=)

SQUOTE:='

#'

DQUOTE:="

#"

define NEWLINE

endef

# In GNU Make 4.0 and higher, there is a file function for writing to files.

ifeq (4.0, $(firstword $(sort 4.0 $(MAKE_VERSION))))

  HAS_FILE_FUNCTION := true

  CORRECT_FUNCTION_IN_RECIPE_EVALUATION := true

endif

# For convenience, MakeBase.gmk continues to include these separate files, at

# least for now.

include $(TOPDIR)/make/common/Utils.gmk

include $(TOPDIR)/make/common/MakeIO.gmk

include $(TOPDIR)/make/common/CopyFiles.gmk

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

# Functions for timers

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

# Store the build times in this directory.

BUILDTIMESDIR=$(OUTPUTDIR)/make-support/build-times

# Record starting time for build of a sub repository.

define RecordStartTime

	$(DATE) '+%Y %m %d %H %M %S' | $(NAWK) '{ print $$1,$$2,$$3,$$4,$$5,$$6,($$4*3600+$$5*60+$$6) }' > $(BUILDTIMESDIR)/build_time_start_$(strip $1) && \

	$(DATE) '+%Y-%m-%d %H:%M:%S' > $(BUILDTIMESDIR)/build_time_start_$(strip $1)_human_readable

endef

# Record ending time and calculate the difference and store it in a

# easy to read format. Handles builds that cross midnight. Expects

# that a build will never take 24 hours or more.

define RecordEndTime

	$(DATE) '+%Y %m %d %H %M %S' | $(NAWK) '{ print $$1,$$2,$$3,$$4,$$5,$$6,($$4*3600+$$5*60+$$6) }' > $(BUILDTIMESDIR)/build_time_end_$(strip $1)

	$(DATE) '+%Y-%m-%d %H:%M:%S' > $(BUILDTIMESDIR)/build_time_end_$(strip $1)_human_readable

	$(ECHO) `$(CAT) $(BUILDTIMESDIR)/build_time_start_$(strip $1)` `$(CAT) $(BUILDTIMESDIR)/build_time_end_$(strip $1)` $1 | \

	    $(NAWK) '{ F=$$7; T=$$14; if (F > T) { T+=3600*24 }; D=T-F; H=int(D/3600); \

	    M=int((D-H*3600)/60); S=D-H*3600-M*60; printf("%02d:%02d:%02d %s\n",H,M,S,$$15); }' \

	    > $(BUILDTIMESDIR)/build_time_diff_$(strip $1)

endef

# Hook to be called when starting to execute a top-level target

define TargetEnter

	$(PRINTF) "## Starting $(patsubst %-only,%,$@)\n"

	$(call RecordStartTime,$(patsubst %-only,%,$@))

endef

# Hook to be called when finish executing a top-level target

define TargetExit

	$(call RecordEndTime,$(patsubst %-only,%,$@))

	$(PRINTF) "## Finished $(patsubst %-only,%,$@) (build time %s)\n\n" \

	    "`$(CAT) $(BUILDTIMESDIR)/build_time_diff_$(patsubst %-only,%,$@) | $(CUT) -f 1 -d ' '`"

endef

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

# A file containing a way to uniquely identify the source code revision that

# the build was created from

SOURCE_REVISION_TRACKER := $(SUPPORT_OUTPUTDIR)/src-rev/source-revision-tracker

# Locate all hg repositories included in the forest, as absolute paths

FindAllReposAbs = \

    $(strip $(sort $(dir $(filter-out $(TOPDIR)/build/%, $(wildcard \

        $(addprefix $(TOPDIR)/, .hg */.hg */*/.hg */*/*/.hg */*/*/*/.hg) \

        $(addprefix $(TOPDIR)/, .git */.git */*/.git */*/*/.git */*/*/*/.git) \

    )))))

# Locate all hg repositories included in the forest, as relative paths

FindAllReposRel = \

    $(strip $(subst $(TOPDIR)/,.,$(patsubst $(TOPDIR)/%/, %, $(FindAllReposAbs))))

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

define SetupLogging

  ifeq ($$(LOG_PROFILE_TIMES_FILE), true)

    ifeq ($$(IS_GNU_TIME), yes)

      SHELL :=  $$(BASH) $$(TOPDIR)/make/scripts/shell-profiler.sh \

                gnutime $$(TIME) \

                $$(OUTPUTDIR)/build-profile.log $$(SHELL)

    else ifneq ($$(FLOCK), )

      SHELL :=  $$(BASH) $$(TOPDIR)/make/scripts/shell-profiler.sh \

                flock $$(FLOCK) \

                $$(OUTPUTDIR)/build-profile.log $$(SHELL)

    endif

  endif

  ifeq ($$(LOG_LEVEL), trace)

    SHELL_NO_RECURSE := $$(SHELL)

    # Shell redefinition trick inspired by http://www.cmcrossroads.com/ask-mr-make/6535-tracing-rule-execution-in-gnu-make

    # For each target executed, will print

    # Building <TARGET> (from <FIRST PREREQUISITE>) (<ALL NEWER PREREQUISITES> newer)

    # but with a limit of 20 on <ALL NEWER PREREQUISITES>, to avoid cluttering logs too much

    # (and causing a crash on Cygwin).

    SHELL = $$(warning $$(if $$@,Building $$@,Running shell command) $$(if $$<, (from $$<))$$(if $$?, ($$(wordlist 1, 20, $$?) $$(if $$(wordlist 21, 22, $$?), ... [in total $$(words $$?) files]) newer)))$$(SHELL_NO_RECURSE) -x

  endif

  # The warn level can never be turned off

  LogWarn = $$(info $$(strip $$1))

  LOG_WARN :=

  ifneq ($$(findstring $$(LOG_LEVEL), info debug trace),)

    LogInfo = $$(info $$(strip $$1))

    LOG_INFO :=

  else

    LogInfo =

    LOG_INFO := > /dev/null

  endif

  ifneq ($$(findstring $$(LOG_LEVEL), debug trace),)

    LogDebug = $$(info $$(strip $$1))

    LOG_DEBUG :=

  else

    LogDebug =

    LOG_DEBUG := > /dev/null

  endif

  ifneq ($$(findstring $$(LOG_LEVEL), trace),)

    LogTrace = $$(info $$(strip $$1))

    LOG_TRACE :=

  else

    LogTrace =

    LOG_TRACE := > /dev/null

  endif

endef

# Make sure logging is setup for everyone that includes MakeBase.gmk.

$(eval $(call SetupLogging))

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

MAX_PARAMS := 36

PARAM_SEQUENCE := $(call sequence, 2, $(MAX_PARAMS))

# Template for creating a macro taking named parameters. To use it, assign the

# template to a variable with the name you want for your macro, using '='

# assignment. Then define a macro body with the suffix "Body". The Body macro

# should take 1 parameter which should be a unique string for that invocation

# of the macro.

# Ex:

# SetupFoo = $(NamedParamsMacroTemplate)

# define SetupFooBody

#   # do something

#   # access parameters as $$($1_BAR)

# endef

# Call it like this

# $(eval $(call SetupFoo, BUILD_SOMETHING, \

#     BAR := some parameter value, \

# ))

define NamedParamsMacroTemplate

  $(if $($(MAX_PARAMS)),$(error Internal makefile error: \

      Too many named arguments to macro, please update MAX_PARAMS in MakeBase.gmk))

  # Iterate over 2 3 4... and evaluate the named parameters with $1_ as prefix

  $(foreach i,$(PARAM_SEQUENCE), $(if $(strip $($i)),\

    $(strip $1)_$(strip $(call EscapeHash, $(call DoubleDollar, $($i))))$(NEWLINE)))

  # Debug print all named parameter names and values

  $(if $(findstring $(LOG_LEVEL),debug trace), \

    $(info $0 $(strip $1) $(foreach i,$(PARAM_SEQUENCE), \

      $(if $(strip $($i)),$(NEWLINE) $(strip [$i] $(if $(filter $(LOG_LEVEL), trace), \

        $($i), $(wordlist 1, 20, $($(i))) $(if $(word 21, $($(i))), ...)))))))

  $(if $(DEBUG_$(strip $1)),

    $(info -------- <<< Begin expansion of $(strip $1)) \

    $(info $(call $(0)Body,$(strip $1))) \

    $(info -------- >>> End expansion of $(strip $1)) \

  )

  $(call $(0)Body,$(strip $1))

endef

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

# Make directory without forking mkdir if not needed.

#

# If a directory with an encoded space is provided, the wildcard function

# sometimes returns false answers (typically if the dir existed when the

# makefile was parsed, but was deleted by a previous rule). In that case, always

# call mkdir regardless of what wildcard says.

#

# 1: List of directories to create

MakeDir = \

    $(strip \

        $(eval MakeDir_dirs_to_make := $(strip $(foreach d, $1, \

          $(if $(findstring ?, $d), '$(call DecodeSpace, $d)', \

            $(if $(wildcard $d), , $d) \

          ) \

        ))) \

        $(if $(MakeDir_dirs_to_make), $(shell $(MKDIR) -p $(MakeDir_dirs_to_make))) \

    )

# Make directory for target file. Should handle spaces in filenames. Just

# calling $(call MakeDir $(@D)) will not work if the directory contains a space

# and the target file already exists. In that case, the target file will have

# its wildcard ? resolved and the $(@D) will evaluate each space separated dir

# part on its own.

MakeTargetDir = \

    $(call MakeDir, $(dir $(call EncodeSpace, $@)))

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

# All install-file and related macros automatically call DecodeSpace when needed.

ifeq ($(call isTargetOs, solaris), true)

  # On Solaris, if the target is a symlink and exists, cp won't overwrite.

  # Cp has to operate in recursive mode to allow for -P flag, to preserve soft links. If the

  # name of the target file differs from the source file, rename after copy.

  # If the source and target parent directories are the same, recursive copy doesn't work

  # so we fall back on regular copy, which isn't preserving symlinks.

  define install-file

	$(call MakeTargetDir)

	$(RM) '$(call DecodeSpace, $@)'

	if [ '$(call DecodeSpace, $(dir $(call EncodeSpace, $@)))' != \

	    '$(call DecodeSpace, $(dir $(call EncodeSpace, $<)))' ]; then \

	  $(CP) -f -r -P '$(call DecodeSpace, $<)' \

	      '$(call DecodeSpace, $(dir $(call EncodeSpace, $@)))'; \

	  if [ '$(call DecodeSpace, $(notdir $(call EncodeSpace, $@)))' != \

	      '$(call DecodeSpace, $(notdir $(call EncodeSpace, $(<))))' ]; then \

	    $(MV) '$(call DecodeSpace, $(dir $(call EncodeSpace, $@))/$(notdir $(call EncodeSpace, $<)))' \

	        '$(call DecodeSpace, $@)'; \

	  fi; \

	else \

	  if [ -L '$(call DecodeSpace, $<)' ]; then \

	    $(ECHO) "Source file is a symlink and target is in the same directory: $< $@" ; \

	    exit 1; \

	  fi; \

	  $(CP) -f '$(call DecodeSpace, $<)' '$(call DecodeSpace, $@)'; \

	fi

  endef

else ifeq ($(call isTargetOs, macosx), true)

  # On mac, extended attributes sometimes creep into the source files, which may later

  # cause the creation of ._* files which confuses testing. Clear these with xattr if

  # set. Some files get their write permissions removed after being copied to the

  # output dir. When these are copied again to images, xattr would fail. By only clearing

  # attributes when they are present, failing on this is avoided.

  #

  # If copying a soft link to a directory, need to delete the target first to avoid

  # weird errors.

  define install-file

	$(call MakeTargetDir)

	$(RM) '$(call DecodeSpace, $@)'

        # Work around a weirdness with cp on Macosx. When copying a symlink, if

        # the target of the link is write protected (e.g. 444), cp will add

        # write permission for the user on the target file (644). Avoid this by

        # using ln to create a new link instead.

	if [ -h '$(call DecodeSpace, $<)' ]; then \

	  $(LN) -s "`$(READLINK) '$(call DecodeSpace, $<)'`" '$(call DecodeSpace, $@)'; \

	else \

	  $(CP) -fRP '$(call DecodeSpace, $<)' '$(call DecodeSpace, $@)'; \

	fi

	if [ -n "`$(XATTR) -ls '$(call DecodeSpace, $@)'`" ]; then \

	  $(XATTR) -cs '$(call DecodeSpace, $@)'; \

	fi

  endef

else

  define install-file

	$(call MakeTargetDir)

	$(CP) -fP '$(call DecodeSpace, $<)' '$(call DecodeSpace, $@)'

  endef

endif

# Variant of install file that does not preserve symlinks

define install-file-nolink

	$(call MakeTargetDir)

	$(CP) -f '$(call DecodeSpace, $<)' '$(call DecodeSpace, $@)'

endef

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

# link-file-* works similarly to install-file but creates a symlink instead.

# There are two versions, either creating a relative or an absolute link. Be

# careful when using this on Windows since the symlink created is only valid in

# the unix emulation environment.

define link-file-relative

	$(call MakeTargetDir)

	$(RM) '$(call DecodeSpace, $@)'

	$(LN) -s '$(call DecodeSpace, $(call RelativePath, $<, $(@D)))' '$(call DecodeSpace, $@)'

endef

define link-file-absolute

	$(call MakeTargetDir)

	$(RM) '$(call DecodeSpace, $@)'

	$(LN) -s '$(call DecodeSpace, $<)' '$(call DecodeSpace, $@)'

endef

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

ifneq ($(DISABLE_CACHE_FIND), true)

  # In Cygwin, finds are very costly, both because of expensive forks and because

  # of bad file system caching. Find is used extensively in $(shell) commands to

  # find source files. This makes rerunning make with no or few changes rather

  # expensive. To speed this up, these two macros are used to cache the results

  # of simple find commands for reuse.

  #

  # Runs a find and stores both the directories where it was run and the results.

  # This macro can be called multiple times to add to the cache. Only finds files

  # with no filters.

  #

  # Files containing space will get spaces replaced with ? because GNU Make

  # cannot handle lists of files with space in them. By using ?, make will match

  # the wildcard to space in many situations so we don't need to replace back

  # to space on every use. While not a complete solution it does allow some uses

  # of CacheFind to function with spaces in file names, including for

  # SetupCopyFiles.

  #

  # Needs to be called with $(eval )

  #

  # Even if the performance benifit is negligible on other platforms, keep the

  # functionality active unless explicitly disabled to exercise it more.

  #

  # Initialize FIND_CACHE_DIRS with := to make it a non recursively-expanded variable

  FIND_CACHE_DIRS :=

  # Param 1 - Dirs to find in

  # Param 2 - (optional) specialization. Normally "-a \( ... \)" expression.

  define FillCacheFind

    # Filter out already cached dirs. The - is needed when FIND_CACHE_DIRS is empty

    # since filter out will then return empty.

    FIND_CACHE_NEW_DIRS := $$(filter-out $$(addsuffix /%,\

        - $(FIND_CACHE_DIRS)) $(FIND_CACHE_DIRS), $1)

    ifneq ($$(FIND_CACHE_NEW_DIRS), )

      # Remove any trailing slash from dirs in the cache dir list

      FIND_CACHE_DIRS += $$(patsubst %/,%, $$(FIND_CACHE_NEW_DIRS))

      FIND_CACHE := $$(sort $$(FIND_CACHE) \

          $$(shell $(FIND) $$(wildcard $$(FIND_CACHE_NEW_DIRS)) \

              \( -type f -o -type l \) $2 | $(TR) ' ' '?'))

    endif

  endef

  # Mimics find by looking in the cache if all of the directories have been cached.

  # Otherwise reverts to shell find. This is safe to call on all platforms, even if

  # cache is deactivated.

  #

  # $1 can be either a directory or a file. If it's a directory, make

  # sure we have exactly one trailing slash before the wildcard.

  # The extra - is needed when FIND_CACHE_DIRS is empty but should be harmless.

  #

  # Param 1 - Dirs to find in

  # Param 2 - (optional) specialization. Normally "-a \( ... \)" expression.

  define CacheFind

    $(if $(filter-out $(addsuffix /%,- $(FIND_CACHE_DIRS)) $(FIND_CACHE_DIRS),$1), \

          | $(TR) ' ' '?')), \

      $(filter $(addsuffix /%,$(patsubst %/,%,$1)) $1,$(FIND_CACHE)))

  endef

else

  # If CacheFind is disabled, just run the find command.

  # Param 1 - Dirs to find in

  # Param 2 - (optional) specialization. Normally "-a \( ... \)" expression.

  define CacheFind

    $(if $(wildcard $1, \

      $(shell $(FIND) $(wildcard $1) \( -type f -o -type l \) $2 | $(TR) ' ' '?') \

    )

  endef

endif

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

# FixPath

#

# On Windows, converts a path from cygwin/unix style (e.g. /bin/foo) into

# "mixed mode" (e.g. c:/cygwin/bin/foo). On other platforms, return the path

# unchanged.

# This is normally not needed since we use the FIXPATH prefix for command lines,

# but might be needed in certain circumstances.

ifeq ($(call isTargetOs, windows), true)

  FixPath = \

      $(shell $(CYGPATH) -m $1)

else

  FixPath = \

      $1

endif

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

# DependOnVariable

#

# This macro takes a variable name and puts the value in a file only if the

# value has changed since last. The name of the file is returned. This can be

# used to create rule dependencies on make variable values. The following

# example would get rebuilt if the value of SOME_VAR was changed:

#

# path/to/some-file: $(call DependOnVariable, SOME_VAR)

#         echo $(SOME_VAR) > $@

#

# Note that leading and trailing white space in the value is ignored.

#

# Defines the sub directory structure to store variable value file in

DependOnVariableDirName = \

    $(strip $(addsuffix $(if $(MODULE),/$(MODULE)), \

        $(subst $(TOPDIR)/,, $(if $(filter /%, $(firstword $(MAKEFILE_LIST))), \

          $(firstword $(MAKEFILE_LIST)), \

          $(CURDIR)/$(firstword $(MAKEFILE_LIST))))))

# Defines the name of the file to store variable value in. Generates a name

# unless parameter 2 is given.

# Param 1 - Name of variable

# Param 2 - (optional) name of file to store value in

DependOnVariableFileName = \

    $(strip $(if $(strip $2), $2, \

      $(MAKESUPPORT_OUTPUTDIR)/vardeps/$(DependOnVariableDirName)/$(strip $1).vardeps))

# Does the actual work with parameters stripped.

# If the file exists AND the contents is the same as the variable, do nothing

# else print a new file.

# Always returns the name of the file where the value was printed.

# Param 1 - Name of variable

# Param 2 - (optional) name of file to store value in

DependOnVariableHelper = \

    $(strip \

        $(eval -include $(call DependOnVariableFileName, $1, $2)) \

        $(if $(call equals, $(strip $($1)), $(strip $($1_old))),,\

          $(call MakeDir, $(dir $(call DependOnVariableFileName, $1, $2))) \

          $(if $(findstring $(LOG_LEVEL), trace), \

              $(info NewVariable $1: >$(strip $($1))<) \

              $(info OldVariable $1: >$(strip $($1_old))<)) \

          $(call WriteFile, $1_old:=$(call DoubleDollar,$(call EscapeHash,$($1))), \

              $(call DependOnVariableFileName, $1, $2))) \

        $(call DependOnVariableFileName, $1, $2) \

    )

# Main macro

# Param 1 - Name of variable

# Param 2 - (optional) name of file to store value in

DependOnVariable = \

    $(call DependOnVariableHelper,$(strip $1),$(strip $2))

# LogCmdlines is only intended to be used by ExecuteWithLog

ifeq ($(LOG_CMDLINES), true)

  LogCmdlines = $(info $(strip $1))