# SPDX-License-Identifier: GPL-2.0

  ####
  # kbuild: Generic definitions

  # Convenient variables

  comma   := ,

  quote   := "

  squote  := '

  empty   :=
  space   := $(empty) $(empty)

  space_escape := _-_SPACE_-_

  pound := \#

  
  ###

  # Name of target with a '.' as filename prefix. foo/bar.o => foo/.bar.o
  dot-target = $(dir $@).$(notdir $@)
  
  ###

  # The temporary file to save gcc -MMD generated dependencies must not

  # contain a comma

  depfile = $(subst $(comma),_,$(dot-target).d)

  
  ###

  # filename of target with directory and extension stripped
  basetarget = $(basename $(notdir $@))
  
  ###

  # real prerequisites without phony targets
  real-prereqs = $(filter-out $(PHONY), $^)
  
  ###

  # Escape single quote for use in echo statements
  escsq = $(subst $(squote),'\$(squote)',$1)
  
  ###

  # Quote a string to pass it to C files. foo => '"foo"'
  stringify = $(squote)$(quote)$1$(quote)$(squote)
  
  ###

  # Easy method for doing a status message
         kecho := :
   quiet_kecho := echo
  silent_kecho := :
  kecho := $($(quiet)kecho)
  
  ###

  # filechk is used to check if the content of a generated file is updated.
  # Sample usage:

  #
  # filechk_sample = echo $(KERNELRELEASE)
  # version.h: FORCE

  #	$(call filechk,sample)

  #

  # The rule defined shall write to stdout the content of the new file.
  # The existing file will be compared with the new one.
  # - If no file exist it is created
  # - If the content differ the new file is used
  # - If they are equal no change, and no timestamp update

  define filechk

  	$(Q)set -e;						\
  	mkdir -p $(dir $@);					\
  	trap "rm -f $(dot-target).tmp" EXIT;			\
  	{ $(filechk_$(1)); } > $(dot-target).tmp;		\
  	if [ ! -r $@ ] || ! cmp -s $@ $(dot-target).tmp; then	\
  		$(kecho) '  UPD     $@';			\
  		mv -f $(dot-target).tmp $@;			\

  	fi
  endef

  ######

  # gcc support functions

  # See documentation in Documentation/kbuild/makefiles.rst

  # cc-cross-prefix
  # Usage: CROSS_COMPILE := $(call cc-cross-prefix, m68k-linux-gnu- m68k-linux-)

  # Return first <prefix> where a <prefix>gcc is found in PATH.
  # If no gcc found in PATH with listed prefixes return nothing

  #
  # Note: '2>/dev/null' is here to force Make to invoke a shell. Otherwise, it
  # would try to directly execute the shell builtin 'command'. This workaround
  # should be kept for a long time since this issue was fixed only after the
  # GNU Make 4.2.1 release.

  cc-cross-prefix = $(firstword $(foreach c, $(1), \
  			$(if $(shell command -v -- $(c)gcc 2>/dev/null), $(c))))

  # output directory for tests below

  TMPOUT = $(if $(KBUILD_EXTMOD),$(firstword $(KBUILD_EXTMOD))/).tmp_$$$$

  
  # try-run
  # Usage: option = $(call try-run, $(CC)...-o "$$TMP",option-ok,otherwise)

  # Exit code chooses option. "$$TMP" serves as a temporary file and is
  # automatically cleaned up.

  try-run = $(shell set -e;		\

  	TMP=$(TMPOUT)/tmp;		\
  	TMPO=$(TMPOUT)/tmp.o;		\
  	mkdir -p $(TMPOUT);		\
  	trap "rm -rf $(TMPOUT)" EXIT;	\

  	if ($(1)) >/dev/null 2>&1;	\
  	then echo "$(2)";		\
  	else echo "$(3)";		\

  	fi)

  # as-option

  # Usage: cflags-y += $(call as-option,-Wa$(comma)-isa=foo,)

  as-option = $(call try-run,\

  	$(CC) $(KBUILD_CFLAGS) $(1) -c -x assembler /dev/null -o "$$TMP",$(1),$(2))

  # as-instr

  # Usage: cflags-y += $(call as-instr,instr,option1,option2)

  as-instr = $(call try-run,\

  	printf "%b
  " "$(1)" | $(CC) $(KBUILD_AFLAGS) -c -x assembler -o "$$TMP" -,$(2),$(3))

  # __cc-option
  # Usage: MY_CFLAGS += $(call __cc-option,$(CC),$(MY_CFLAGS),-march=winchip-c6,-march=i586)

  __cc-option = $(call try-run,\

  	$(1) -Werror $(2) $(3) -c -x c /dev/null -o "$$TMP",$(3),$(4))

  # cc-option

  # Usage: cflags-y += $(call cc-option,-march=winchip-c6,-march=i586)

  cc-option = $(call __cc-option, $(CC),\

  	$(KBUILD_CPPFLAGS) $(KBUILD_CFLAGS),$(1),$(2))

  # cc-option-yn

  # Usage: flag := $(call cc-option-yn,-march=winchip-c6)

  cc-option-yn = $(call try-run,\

  	$(CC) -Werror $(KBUILD_CPPFLAGS) $(KBUILD_CFLAGS) $(1) -c -x c /dev/null -o "$$TMP",y,n)

  # cc-disable-warning
  # Usage: cflags-y += $(call cc-disable-warning,unused-but-set-variable)

  cc-disable-warning = $(call try-run,\

  	$(CC) -Werror $(KBUILD_CPPFLAGS) $(KBUILD_CFLAGS) -W$(strip $(1)) -c -x c /dev/null -o "$$TMP",-Wno-$(strip $(1)))

  # cc-ifversion
  # Usage:  EXTRA_CFLAGS += $(call cc-ifversion, -lt, 0402, -O1)

  cc-ifversion = $(shell [ $(CONFIG_GCC_VERSION)0 $(1) $(2)000 ] && echo $(3) || echo $(4))

  # ld-option

  # Usage: KBUILD_LDFLAGS += $(call ld-option, -X, -Y)
  ld-option = $(call try-run, $(LD) $(KBUILD_LDFLAGS) $(1) -v,$(1),$(2),$(3))

  # ld-version

  # Note this is mainly for HJ Lu's 3 number binutil versions

  ld-version = $(shell $(LD) --version | $(srctree)/scripts/ld-version.sh)

  
  # ld-ifversion
  # Usage:  $(call ld-ifversion, -ge, 22252, y)

  ld-ifversion = $(shell [ $(ld-version) $(1) $(2) ] && echo $(3) || echo $(4))

  ######

  ###

  # Shorthand for $(Q)$(MAKE) -f scripts/Makefile.build obj=
  # Usage:
  # $(Q)$(MAKE) $(build)=dir

  build := -f $(srctree)/scripts/Makefile.build obj

  ###

  # Shorthand for $(Q)$(MAKE) -f scripts/Makefile.dtbinst obj=
  # Usage:
  # $(Q)$(MAKE) $(dtbinst)=dir

  dtbinst := -f $(srctree)/scripts/Makefile.dtbinst obj

  ###

  # Shorthand for $(Q)$(MAKE) -f scripts/Makefile.clean obj=
  # Usage:
  # $(Q)$(MAKE) $(clean)=dir
  clean := -f $(srctree)/scripts/Makefile.clean obj

  # echo command.
  # Short version is used, if $(quiet) equals `quiet_', otherwise full one.

  echo-cmd = $(if $($(quiet)cmd_$(1)),\

  	echo '  $(call escsq,$($(quiet)cmd_$(1)))$(echo-why)';)
  
  # printing commands

  cmd = @set -e; $(echo-cmd) $(cmd_$(1))

  
  ###

  # if_changed      - execute command if any prerequisite is newer than

  #                   target, or command line has changed
  # if_changed_dep  - as if_changed, but uses fixdep to reveal dependencies
  #                   including used config symbols
  # if_changed_rule - as if_changed but execute rule instead

  # See Documentation/kbuild/makefiles.rst for more info

  
  ifneq ($(KBUILD_NOCMDDEP),1)

  # Check if both commands are the same including their order. Result is empty

  # string if equal. User may override this check using make KBUILD_NOCMDDEP=1

  cmd-check = $(filter-out $(subst $(space),$(space_escape),$(strip $(cmd_$@))), \

                           $(subst $(space),$(space_escape),$(strip $(cmd_$1))))

  else

  cmd-check = $(if $(strip $(cmd_$@)),,1)

  endif

  # Replace >$< with >$$< to preserve $ when reloading the .cmd file
  # (needed for make)

  # Replace >#< with >$(pound)< to avoid starting a comment in the .cmd file

  # (needed for make)
  # Replace >'< with >'\''< to be able to enclose the whole string in '...'
  # (needed for the shell)

  make-cmd = $(call escsq,$(subst $(pound),$$(pound),$(subst $$,$$$$,$(cmd_$(1)))))

  # Find any prerequisites that are newer than target or that do not exist.
  # (This is not true for now; $? should contain any non-existent prerequisites,
  # but it does not work as expected when .SECONDARY is present. This seems a bug
  # of GNU Make.)

  # PHONY targets skipped in both cases.

  newer-prereqs = $(filter-out $(PHONY),$?)

  # Execute command if command has changed or prerequisite(s) are updated.

  if_changed = $(if $(newer-prereqs)$(cmd-check),                              \

  	$(cmd);                                                              \

  	printf '%s
  ' 'cmd_$@ := $(make-cmd)' > $(dot-target).cmd, @:)

  # Execute the command and also postprocess generated .d dependencies file.

  if_changed_dep = $(if $(newer-prereqs)$(cmd-check),$(cmd_and_fixdep),@:)

  cmd_and_fixdep =                                                             \

  	$(cmd);                                                              \

  	scripts/basic/fixdep $(depfile) $@ '$(make-cmd)' > $(dot-target).cmd;\

  	rm -f $(depfile)

  # Usage: $(call if_changed_rule,foo)

  # Will check if $(cmd_foo) or any of the prerequisites changed,
  # and if so will execute $(rule_foo).

  if_changed_rule = $(if $(newer-prereqs)$(cmd-check),$(rule_$(1)),@:)

  ###

  # why - tell why a target got built

  #       enabled by make V=2
  #       Output (listed in the order they are checked):
  #          (1) - due to target is PHONY
  #          (2) - due to target missing
  #          (3) - due to: file1.h file2.h
  #          (4) - due to command line change
  #          (5) - due to missing .cmd file
  #          (6) - due to target not in $(targets)
  # (1) PHONY targets are always build
  # (2) No target, so we better build it
  # (3) Prerequisite is newer than target
  # (4) The command line stored in the file named dir/.target.cmd
  #     differed from actual command line. This happens when compiler
  #     options changes
  # (5) No dir/.target.cmd file (used to store command line)
  # (6) No dir/.target.cmd file and target not listed in $(targets)
  #     This is a good hint that there is a bug in the kbuild file
  ifeq ($(KBUILD_VERBOSE),2)
  why =                                                                        \
      $(if $(filter $@, $(PHONY)),- due to target is PHONY,                    \
          $(if $(wildcard $@),                                                 \

              $(if $(newer-prereqs),- due to: $(newer-prereqs),                \

                  $(if $(cmd-check),                                           \

                      $(if $(cmd_$@),- due to command line change,             \
                          $(if $(filter $@, $(targets)),                       \
                              - due to missing .cmd file,                      \
                              - due to $(notdir $@) not in $$(targets)         \
                           )                                                   \
                       )                                                       \
                   )                                                           \
               ),                                                              \
               - due to target missing                                         \
           )                                                                   \
       )
  
  echo-why = $(call escsq, $(strip $(why)))
  endif

  
  ###############################################################################
  #
  # When a Kconfig string contains a filename, it is suitable for
  # passing to shell commands. It is surrounded by double-quotes, and
  # any double-quotes or backslashes within it are escaped by
  # backslashes.
  #
  # This is no use for dependencies or $(wildcard). We need to strip the
  # surrounding quotes and the escaping from quotes and backslashes, and
  # we *do* need to escape any spaces in the string. So, for example:
  #
  # Usage: $(eval $(call config_filename,FOO))
  #
  # Defines FOO_FILENAME based on the contents of the CONFIG_FOO option,
  # transformed as described above to be suitable for use within the
  # makefile.
  #
  # Also, if the filename is a relative filename and exists in the source
  # tree but not the build tree, define FOO_SRCPREFIX as $(srctree)/ to
  # be prefixed to *both* command invocation and dependencies.
  #
  # Note: We also print the filenames in the quiet_cmd_foo text, and
  # perhaps ought to have a version specially escaped for that purpose.
  # But it's only cosmetic, and $(patsubst "%",%,$(CONFIG_FOO)) is good
  # enough.  It'll strip the quotes in the common case where there's no
  # space and it's a simple filename, and it'll retain the quotes when
  # there's a space. There are some esoteric cases in which it'll print
  # the wrong thing, but we don't really care. The actual dependencies
  # and commands *do* get it right, with various combinations of single
  # and double quotes, backslashes and spaces in the filenames.
  #
  ###############################################################################
  #

  define config_filename
  ifneq ($$(CONFIG_$(1)),"")
  $(1)_FILENAME := $$(subst \\,\,$$(subst \$$(quote),$$(quote),$$(subst $$(space_escape),\$$(space),$$(patsubst "%",%,$$(subst $$(space),$$(space_escape),$$(CONFIG_$(1)))))))
  ifneq ($$(patsubst /%,%,$$(firstword $$($(1)_FILENAME))),$$(firstword $$($(1)_FILENAME)))
  else
  ifeq ($$(wildcard $$($(1)_FILENAME)),)
  ifneq ($$(wildcard $$(srctree)/$$($(1)_FILENAME)),)
  $(1)_SRCPREFIX := $(srctree)/
  endif
  endif
  endif
  endif
  endef
  #
  ###############################################################################

  
  # delete partially updated (i.e. corrupted) files on error
  .DELETE_ON_ERROR:

  
  # do not delete intermediate files automatically
  .SECONDARY: