[linux.git] / scripts / Kbuild.include

####
# kbuild: Generic definitions

# Convenient variables
comma   := ,
quote   := "
squote  := '
empty   :=
space   := $(empty) $(empty)
space_escape := _-_SPACE_-_

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

###
# The temporary file to save gcc -MD generated dependencies must not
# contain a comma
depfile = $(subst $(comma),_,$(dot-target).d)

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

###
# filename of first prerequisite with directory and extension stripped
baseprereq = $(basename $(notdir $<))

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

###
# 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:
# define filechk_sample
#	echo $KERNELRELEASE
# endef
# version.h : Makefile
#	$(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
# - stdin is piped in from the first prerequisite ($<) so one has
#   to specify a valid file as first prerequisite (often the kbuild file)
define filechk
	$(Q)set -e;				\
	$(kecho) '  CHK     $@';		\
	mkdir -p $(dir $@);			\
	$(filechk_$(1)) < $< > [email protected];		\
	if [ -r $@ ] && cmp -s $@ [email protected]; then	\
		rm -f [email protected];			\
	else					\
		$(kecho) '  UPD     $@';	\
		mv -f [email protected] $@;		\
	fi
endef

######
# gcc support functions
# See documentation in Documentation/kbuild/makefiles.txt

# cc-cross-prefix
# Usage: CROSS_COMPILE := $(call cc-cross-prefix, m68k-linux-gnu- m68k-linux-)
# Return first prefix where a prefix$(CC) is found in PATH.
# If no $(CC) found in PATH with listed prefixes return nothing
cc-cross-prefix =  \
	$(word 1, $(foreach c,$(1),                                   \
		$(shell set -e;                                       \
		if (which $(strip $(c))$(CC)) > /dev/null 2>&1 ; then \
			echo $(c);                                    \
		fi)))

# output directory for tests below
TMPOUT := $(if $(KBUILD_EXTMOD),$(firstword $(KBUILD_EXTMOD))/)

# try-run
# Usage: option = $(call try-run, $(CC)...-o "$$TMP",option-ok,otherwise)
# Exit code chooses option. "$$TMP" is can be used as temporary file and
# is automatically cleaned up.
try-run = $(shell set -e;		\
	TMP="$(TMPOUT).$$$$.tmp";	\
	TMPO="$(TMPOUT).$$$$.o";	\
	if ($(1)) >/dev/null 2>&1;	\
	then echo "$(2)";		\
	else echo "$(3)";		\
	fi;				\
	rm -f "$$TMP" "$$TMPO")

# 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\n" "$(1)" | $(CC) $(KBUILD_AFLAGS) -c -x assembler -o "$$TMP" -,$(2),$(3))

# Do not attempt to build with gcc plugins during cc-option tests.
# (And this uses delayed resolution so the flags will be up to date.)
CC_OPTION_CFLAGS = $(filter-out $(GCC_PLUGINS_CFLAGS),$(KBUILD_CFLAGS))

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

cc-option = $(call try-run,\
	$(CC) $(KBUILD_CPPFLAGS) $(CC_OPTION_CFLAGS) $(1) -c -x c /dev/null -o "$$TMP",$(1),$(2))

# cc-option-yn
# Usage: flag := $(call cc-option-yn,-march=winchip-c6)
cc-option-yn = $(call try-run,\
	$(CC) $(KBUILD_CPPFLAGS) $(CC_OPTION_CFLAGS) $(1) -c -x c /dev/null -o "$$TMP",y,n)

# cc-option-align
# Prefix align with either -falign or -malign
cc-option-align = $(subst -functions=0,,\
	$(call cc-option,-falign-functions=0,-malign-functions=0))

# cc-disable-warning
# Usage: cflags-y += $(call cc-disable-warning,unused-but-set-variable)
cc-disable-warning = $(call try-run,\
	$(CC) $(KBUILD_CPPFLAGS) $(CC_OPTION_CFLAGS) -W$(strip $(1)) -c -x c /dev/null -o "$$TMP",-Wno-$(strip $(1)))

# cc-name
# Expands to either gcc or clang
cc-name = $(shell $(CC) -v 2>&1 | grep -q "clang version" && echo clang || echo gcc)

# cc-version
cc-version = $(shell $(CONFIG_SHELL) $(srctree)/scripts/gcc-version.sh $(CC))

# cc-fullversion
cc-fullversion = $(shell $(CONFIG_SHELL) \
	$(srctree)/scripts/gcc-version.sh -p $(CC))

# cc-ifversion
# Usage:  EXTRA_CFLAGS += $(call cc-ifversion, -lt, 0402, -O1)
cc-ifversion = $(shell [ $(cc-version) $(1) $(2) ] && echo $(3) || echo $(4))

# cc-ldoption
# Usage: ldflags += $(call cc-ldoption, -Wl$(comma)--hash-style=both)
cc-ldoption = $(call try-run,\
	$(CC) $(1) -nostdlib -x c /dev/null -o "$$TMP",$(1),$(2))

# ld-option
# Usage: LDFLAGS += $(call ld-option, -X)
ld-option = $(call try-run,\
	$(CC) -x c /dev/null -c -o "$$TMPO" ; $(LD) $(1) "$$TMPO" -o "$$TMP",$(1),$(2))

# ar-option
# Usage: KBUILD_ARFLAGS := $(call ar-option,D)
# Important: no spaces around options
ar-option = $(call try-run, $(AR) rc$(1) "$$TMP",$(1),$(2))

# 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.modbuiltin obj=
# Usage:
# $(Q)$(MAKE) $(modbuiltin)=dir
modbuiltin := -f $(srctree)/scripts/Makefile.modbuiltin obj

###
# Shorthand for $(Q)$(MAKE) -f scripts/Makefile.dtbinst obj=
# Usage:
# $(Q)$(MAKE) $(dtbinst)=dir
dtbinst := -f $(if $(KBUILD_SRC),$(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

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

# Prefix -I with $(srctree) if it is not an absolute path.
# skip if -I has no parameter
addtree = $(if $(patsubst -I%,%,$(1)), \
$(if $(filter-out -I/% -I./% -I../%,$(1)),$(patsubst -I%,-I$(srctree)/%,$(1)),$(1)))

# Find all -I options and call addtree
flags = $(foreach o,$($(1)),$(if $(filter -I%,$(o)),$(call addtree,$(o)),$(o)))

# 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 = @$(echo-cmd) $(cmd_$(1))

# Add $(obj)/ for paths that are not absolute
objectify = $(foreach o,$(1),$(if $(filter /%,$(o)),$(o),$(obj)/$(o)))

###
# 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.txt for more info

ifneq ($(KBUILD_NOCMDDEP),1)
# Check if both arguments are the same including their order. Result is empty
# string if equal. User may override this check using make KBUILD_NOCMDDEP=1
arg-check = $(filter-out $(subst $(space),$(space_escape),$(strip $(cmd_$@))), \
                         $(subst $(space),$(space_escape),$(strip $(cmd_$1))))
else
arg-check = $(if $(strip $(cmd_$@)),,1)
endif

# Replace >$< with >$$< to preserve $ when reloading the .cmd file
# (needed for make)
# Replace >#< with >\#< 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 \#,\\\#,$(subst $$,$$$$,$(cmd_$(1)))))

# Find any prerequisites that is newer than target or that does not exist.
# PHONY targets skipped in both cases.
any-prereq = $(filter-out $(PHONY),$?) $(filter-out $(PHONY) $(wildcard $^),$^)

# Execute command if command has changed or prerequisite(s) are updated.
#
if_changed = $(if $(strip $(any-prereq) $(arg-check)),                       \
	@set -e;                                                             \
	$(echo-cmd) $(cmd_$(1));                                             \
	printf '%s\n' 'cmd_$@ := $(make-cmd)' > $(dot-target).cmd, @:)

# Execute the command and also postprocess generated .d dependencies file.
if_changed_dep = $(if $(strip $(any-prereq) $(arg-check) ),                  \
	@set -e;                                                             \
	$(cmd_and_fixdep), @:)

ifndef CONFIG_TRIM_UNUSED_KSYMS

cmd_and_fixdep =                                                             \
	$(echo-cmd) $(cmd_$(1));                                             \
	scripts/basic/fixdep $(depfile) $@ '$(make-cmd)' > $(dot-target).tmp;\
	rm -f $(depfile);                                                    \
	mv -f $(dot-target).tmp $(dot-target).cmd;

else

# Filter out exported kernel symbol names from the preprocessor output.
# See also __KSYM_DEPS__ in include/linux/export.h.
# We disable the depfile generation here, so as not to overwrite the existing
# depfile while fixdep is parsing it.
flags_nodeps = $(filter-out -Wp$(comma)-M%, $($(1)))
ksym_dep_filter =                                                            \
	case "$(1)" in                                                       \
	  cc_*_c|cpp_i_c)                                                    \
	    $(CPP) $(call flags_nodeps,c_flags) -D__KSYM_DEPS__ $< ;;        \
	  as_*_S|cpp_s_S)                                                    \
	    $(CPP) $(call flags_nodeps,a_flags) -D__KSYM_DEPS__ $< ;;        \
	  boot*|build*|cpp_its_S|*cpp_lds_S|dtc|host*|vdso*) : ;;            \
	  *) echo "Don't know how to preprocess $(1)" >&2; false ;;          \
	esac | tr ";" "\n" | sed -rn 's/^.*=== __KSYM_(.*) ===.*$$/KSYM_\1/p'

cmd_and_fixdep =                                                             \
	$(echo-cmd) $(cmd_$(1));                                             \
	$(ksym_dep_filter) |                                                 \
		scripts/basic/fixdep -e $(depfile) $@ '$(make-cmd)'          \
			> $(dot-target).tmp;	                             \
	rm -f $(depfile);                                                    \
	mv -f $(dot-target).tmp $(dot-target).cmd;

endif

# 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 $(strip $(any-prereq) $(arg-check) ),                 \
	@set -e;                                                             \
	$(rule_$(1)), @:)

###
# why - tell why a a target got build
#       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 $(strip $(any-prereq)),- due to: $(any-prereq),             \
                $(if $(arg-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
#
###############################################################################
Commit	Line	Data
8ec4b4ff SR	1	####
	2	# kbuild: Generic definitions
	3
beda9f3a	4	# Convenient variables
8ec4b4ff	5	comma := ,
13338935	6	quote := "
d51bfb78	7	squote := '
8ec4b4ff SR	8	empty :=
8ec4b4ff SR	9	space := $(empty) $(empty)
9c8fa9bc	10	space_escape := _-_SPACE_-_
8ec4b4ff	11
48f1f058 SR	12	###
	13	# Name of target with a '.' as filename prefix. foo/bar.o => foo/.bar.o
	14	dot-target = $(dir $@).$(notdir $@)
	15
8ec4b4ff SR	16	###
	17	# The temporary file to save gcc -MD generated dependencies must not
	18	# contain a comma
48f1f058	19	depfile = $(subst $(comma),_,$(dot-target).d)
8ec4b4ff	20
5e8d780d SR	21	###
	22	# filename of target with directory and extension stripped
	23	basetarget = $(basename $(notdir $@))
	24
e0318d85 AL	25	###
	26	# filename of first prerequisite with directory and extension stripped
	27	baseprereq = $(basename $(notdir $<))
	28
d51bfb78 SR	29	###
	30	# Escape single quote for use in echo statements
	31	escsq = $(subst $(squote),'\$(squote)',$1)
	32
5410ecc0 MF	33	###
	34	# Easy method for doing a status message
	35	kecho := :
	36	quiet_kecho := echo
	37	silent_kecho := :
	38	kecho := $($(quiet)kecho)
	39
8ec4b4ff SR	40	###
	41	# filechk is used to check if the content of a generated file is updated.
	42	# Sample usage:
	43	# define filechk_sample
	44	# echo $KERNELRELEASE
	45	# endef
	46	# version.h : Makefile
	47	# $(call filechk,sample)
	48	# The rule defined shall write to stdout the content of the new file.
	49	# The existing file will be compared with the new one.
	50	# - If no file exist it is created
	51	# - If the content differ the new file is used
	52	# - If they are equal no change, and no timestamp update
	53	# - stdin is piped in from the first prerequisite ($<) so one has
	54	# to specify a valid file as first prerequisite (often the kbuild file)
	55	define filechk
	56	$(Q)set -e; \
fd54f502	57	$(kecho) ' CHK $@'; \
8ec4b4ff SR	58	mkdir -p $(dir $@); \
	59	$(filechk_$(1)) < $< > [email protected]; \
	60	if [ -r $@ ] && cmp -s $@ [email protected]; then \
	61	rm -f [email protected]; \
	62	else \
fd54f502	63	$(kecho) ' UPD $@'; \
8ec4b4ff SR	64	mv -f [email protected] $@; \
	65	fi
	66	endef
	67
20a468b5	68	######
9d6e7a70	69	# gcc support functions
20a468b5 SR	70	# See documentation in Documentation/kbuild/makefiles.txt
20a468b5 SR	71
910b4046 SR	72	# cc-cross-prefix
	73	# Usage: CROSS_COMPILE := $(call cc-cross-prefix, m68k-linux-gnu- m68k-linux-)
	74	# Return first prefix where a prefix$(CC) is found in PATH.
	75	# If no $(CC) found in PATH with listed prefixes return nothing
	76	cc-cross-prefix = \
	77	$(word 1, $(foreach c,$(1), \
	78	$(shell set -e; \
	79	if (which $(strip $(c))$(CC)) > /dev/null 2>&1 ; then \
	80	echo $(c); \
	81	fi)))
	82
beda9f3a RZ	83	# output directory for tests below
	84	TMPOUT := $(if $(KBUILD_EXTMOD),$(firstword $(KBUILD_EXTMOD))/)
	85
	86	# try-run
	87	# Usage: option = $(call try-run, $(CC)...-o "$$TMP",option-ok,otherwise)
	88	# Exit code chooses option. "$$TMP" is can be used as temporary file and
	89	# is automatically cleaned up.
	90	try-run = $(shell set -e; \
	91	TMP="$(TMPOUT).$$$$.tmp"; \
691ef3e7	92	TMPO="$(TMPOUT).$$$$.o"; \
beda9f3a RZ	93	if ($(1)) >/dev/null 2>&1; \
	94	then echo "$(2)"; \
	95	else echo "$(3)"; \
	96	fi; \
691ef3e7	97	rm -f "$$TMP" "$$TMPO")
347a00fb	98
20a468b5	99	# as-option
bff288c1	100	# Usage: cflags-y += $(call as-option,-Wa$(comma)-isa=foo,)
beda9f3a RZ	101
beda9f3a RZ	102	as-option = $(call try-run,\
b1e0d8b7	103	$(CC) $(KBUILD_CFLAGS) $(1) -c -x assembler /dev/null -o "$$TMP",$(1),$(2))
20a468b5	104
e2414910	105	# as-instr
bff288c1	106	# Usage: cflags-y += $(call as-instr,instr,option1,option2)
beda9f3a RZ	107
beda9f3a RZ	108	as-instr = $(call try-run,\
b1e0d8b7	109	printf "%b\n" "$(1)" \| $(CC) $(KBUILD_AFLAGS) -c -x assembler -o "$$TMP" -,$(2),$(3))
e2414910	110
d26e9414 ER	111	# Do not attempt to build with gcc plugins during cc-option tests.
	112	# (And this uses delayed resolution so the flags will be up to date.)
	113	CC_OPTION_CFLAGS = $(filter-out $(GCC_PLUGINS_CFLAGS),$(KBUILD_CFLAGS))
	114
20a468b5	115	# cc-option
bff288c1	116	# Usage: cflags-y += $(call cc-option,-march=winchip-c6,-march=i586)
beda9f3a RZ	117
beda9f3a RZ	118	cc-option = $(call try-run,\
d26e9414	119	$(CC) $(KBUILD_CPPFLAGS) $(CC_OPTION_CFLAGS) $(1) -c -x c /dev/null -o "$$TMP",$(1),$(2))
20a468b5 SR	120
20a468b5 SR	121	# cc-option-yn
bff288c1	122	# Usage: flag := $(call cc-option-yn,-march=winchip-c6)
beda9f3a	123	cc-option-yn = $(call try-run,\
d26e9414	124	$(CC) $(KBUILD_CPPFLAGS) $(CC_OPTION_CFLAGS) $(1) -c -x c /dev/null -o "$$TMP",y,n)
20a468b5 SR	125
	126	# cc-option-align
	127	# Prefix align with either -falign or -malign
	128	cc-option-align = $(subst -functions=0,,\
beda9f3a	129	$(call cc-option,-falign-functions=0,-malign-functions=0))
20a468b5	130
8417da6f MM	131	# cc-disable-warning
	132	# Usage: cflags-y += $(call cc-disable-warning,unused-but-set-variable)
	133	cc-disable-warning = $(call try-run,\
d26e9414	134	$(CC) $(KBUILD_CPPFLAGS) $(CC_OPTION_CFLAGS) -W$(strip $(1)) -c -x c /dev/null -o "$$TMP",-Wno-$(strip $(1)))
8417da6f	135
5631d9c4 MM	136	# cc-name
	137	# Expands to either gcc or clang
	138	cc-name = $(shell $(CC) -v 2>&1 \| grep -q "clang version" && echo clang \|\| echo gcc)
	139
20a468b5	140	# cc-version
8eb3afe0	141	cc-version = $(shell $(CONFIG_SHELL) $(srctree)/scripts/gcc-version.sh $(CC))
20a468b5	142
0ab2a272	143	# cc-fullversion
0ab2a272 SB	144	cc-fullversion = $(shell $(CONFIG_SHELL) \
	145	$(srctree)/scripts/gcc-version.sh -p $(CC))
	146
20a468b5 SR	147	# cc-ifversion
20a468b5 SR	148	# Usage: EXTRA_CFLAGS += $(call cc-ifversion, -lt, 0402, -O1)
6dcb4e5e	149	cc-ifversion = $(shell [ $(cc-version) $(1) $(2) ] && echo $(3) \|\| echo $(4))
20a468b5	150
f86fd306 SR	151	# cc-ldoption
	152	# Usage: ldflags += $(call cc-ldoption, -Wl$(comma)--hash-style=both)
	153	cc-ldoption = $(call try-run,\
b1e0d8b7	154	$(CC) $(1) -nostdlib -x c /dev/null -o "$$TMP",$(1),$(2))
5de043f4	155
691ef3e7 SR	156	# ld-option
	157	# Usage: LDFLAGS += $(call ld-option, -X)
	158	ld-option = $(call try-run,\
5b83df2b	159	$(CC) -x c /dev/null -c -o "$$TMPO" ; $(LD) $(1) "$$TMPO" -o "$$TMP",$(1),$(2))
691ef3e7	160
40df759e MM	161	# ar-option
	162	# Usage: KBUILD_ARFLAGS := $(call ar-option,D)
	163	# Important: no spaces around options
	164	ar-option = $(call try-run, $(AR) rc$(1) "$$TMP",$(1),$(2))
	165
ccbef167	166	# ld-version
ccbef167 AK	167	# Note this is mainly for HJ Lu's 3 number binutil versions
	168	ld-version = $(shell $(LD) --version \| $(srctree)/scripts/ld-version.sh)
	169
	170	# ld-ifversion
	171	# Usage: $(call ld-ifversion, -ge, 22252, y)
6dcb4e5e	172	ld-ifversion = $(shell [ $(ld-version) $(1) $(2) ] && echo $(3) \|\| echo $(4))
ccbef167	173
5de043f4	174	######
0b0bf7a3	175
beda9f3a	176	###
8ec4b4ff SR	177	# Shorthand for $(Q)$(MAKE) -f scripts/Makefile.build obj=
	178	# Usage:
	179	# $(Q)$(MAKE) $(build)=dir
5b2389b4	180	build := -f $(srctree)/scripts/Makefile.build obj
8ec4b4ff	181
bc081dd6 MM	182	###
	183	# Shorthand for $(Q)$(MAKE) -f scripts/Makefile.modbuiltin obj=
	184	# Usage:
	185	# $(Q)$(MAKE) $(modbuiltin)=dir
5b2389b4	186	modbuiltin := -f $(srctree)/scripts/Makefile.modbuiltin obj
bc081dd6	187
9fb5e537 RR	188	###
	189	# Shorthand for $(Q)$(MAKE) -f scripts/Makefile.dtbinst obj=
	190	# Usage:
	191	# $(Q)$(MAKE) $(dtbinst)=dir
	192	dtbinst := -f $(if $(KBUILD_SRC),$(srctree)/)scripts/Makefile.dtbinst obj
	193
371fdc77 MY	194	###
	195	# Shorthand for $(Q)$(MAKE) -f scripts/Makefile.clean obj=
	196	# Usage:
	197	# $(Q)$(MAKE) $(clean)=dir
	198	clean := -f $(srctree)/scripts/Makefile.clean obj
	199
	200	###
1846dfbd	201	# Shorthand for $(Q)$(MAKE) -f scripts/Makefile.headersinst obj=
371fdc77 MY	202	# Usage:
371fdc77 MY	203	# $(Q)$(MAKE) $(hdr-inst)=dir
1846dfbd	204	hdr-inst := -f $(srctree)/scripts/Makefile.headersinst obj
371fdc77	205
beda9f3a	206	# Prefix -I with $(srctree) if it is not an absolute path.
5b91c33c SR	207	# skip if -I has no parameter
5b91c33c SR	208	addtree = $(if $(patsubst -I%,%,$(1)), \
db547ef1	209	$(if $(filter-out -I/% -I./% -I../%,$(1)),$(patsubst -I%,-I$(srctree)/%,$(1)),$(1)))
5de043f4	210
d9df92e2	211	# Find all -I options and call addtree
beda9f3a	212	flags = $(foreach o,$($(1)),$(if $(filter -I%,$(o)),$(call addtree,$(o)),$(o)))
d9df92e2	213
5de043f4 OV	214	# echo command.
5de043f4 OV	215	# Short version is used, if $(quiet) equals `quiet_', otherwise full one.
bff288c1	216	echo-cmd = $(if $($(quiet)cmd_$(1)),\
5de043f4 OV	217	echo ' $(call escsq,$($(quiet)cmd_$(1)))$(echo-why)';)
	218
	219	# printing commands
6176aa9a	220	cmd = @$(echo-cmd) $(cmd_$(1))
8ec4b4ff	221
5de043f4	222	# Add $(obj)/ for paths that are not absolute
bff288c1	223	objectify = $(foreach o,$(1),$(if $(filter /%,$(o)),$(o),$(obj)/$(o)))
0a504f25	224
8ec4b4ff	225	###
5de043f4	226	# if_changed - execute command if any prerequisite is newer than
8ec4b4ff SR	227	# target, or command line has changed
	228	# if_changed_dep - as if_changed, but uses fixdep to reveal dependencies
	229	# including used config symbols
	230	# if_changed_rule - as if_changed but execute rule instead
	231	# See Documentation/kbuild/makefiles.txt for more info
	232
	233	ifneq ($(KBUILD_NOCMDDEP),1)
9c8fa9bc MY	234	# Check if both arguments are the same including their order. Result is empty
	235	# string if equal. User may override this check using make KBUILD_NOCMDDEP=1
	236	arg-check = $(filter-out $(subst $(space),$(space_escape),$(strip $(cmd_$@))), \
	237	$(subst $(space),$(space_escape),$(strip $(cmd_$1))))
c4d5ee13 MM	238	else
c4d5ee13 MM	239	arg-check = $(if $(strip $(cmd_$@)),,1)
8ec4b4ff SR	240	endif
8ec4b4ff SR	241
164f0d2e MM	242	# Replace >$< with >$$< to preserve $ when reloading the .cmd file
	243	# (needed for make)
	244	# Replace >#< with >\#< to avoid starting a comment in the .cmd file
	245	# (needed for make)
	246	# Replace >'< with >'\''< to be able to enclose the whole string in '...'
	247	# (needed for the shell)
	248	make-cmd = $(call escsq,$(subst \#,\\\#,$(subst $$,$$$$,$(cmd_$(1)))))
6176aa9a	249
48f1f058 SR	250	# Find any prerequisites that is newer than target or that does not exist.
	251	# PHONY targets skipped in both cases.
	252	any-prereq = $(filter-out $(PHONY),$?) $(filter-out $(PHONY) $(wildcard $^),$^)
	253
5de043f4	254	# Execute command if command has changed or prerequisite(s) are updated.
4f193362	255	#
48f1f058 SR	256	if_changed = $(if $(strip $(any-prereq) $(arg-check)), \
	257	@set -e; \
	258	$(echo-cmd) $(cmd_$(1)); \
2aedcd09	259	printf '%s\n' 'cmd_$@ := $(make-cmd)' > $(dot-target).cmd, @:)
8ec4b4ff	260
5de043f4	261	# Execute the command and also postprocess generated .d dependencies file.
48f1f058 SR	262	if_changed_dep = $(if $(strip $(any-prereq) $(arg-check) ), \
48f1f058 SR	263	@set -e; \
e4aca459 NP	264	$(cmd_and_fixdep), @:)
e4aca459 NP	265
c1a95fda NP	266	ifndef CONFIG_TRIM_UNUSED_KSYMS
c1a95fda NP	267
e4aca459	268	cmd_and_fixdep = \
48f1f058 SR	269	$(echo-cmd) $(cmd_$(1)); \
	270	scripts/basic/fixdep $(depfile) $@ '$(make-cmd)' > $(dot-target).tmp;\
	271	rm -f $(depfile); \
e4aca459	272	mv -f $(dot-target).tmp $(dot-target).cmd;
8ec4b4ff	273
c1a95fda NP	274	else
	275
	276	# Filter out exported kernel symbol names from the preprocessor output.
	277	# See also __KSYM_DEPS__ in include/linux/export.h.
	278	# We disable the depfile generation here, so as not to overwrite the existing
	279	# depfile while fixdep is parsing it.
	280	flags_nodeps = $(filter-out -Wp$(comma)-M%, $($(1)))
	281	ksym_dep_filter = \
	282	case "$(1)" in \
366f4856 NP	283	cc_*_c\|cpp_i_c) \
	284	$(CPP) $(call flags_nodeps,c_flags) -D__KSYM_DEPS__ $< ;; \
	285	as_*_S\|cpp_s_S) \
	286	$(CPP) $(call flags_nodeps,a_flags) -D__KSYM_DEPS__ $< ;; \
0d070d2b	287	boot\|build\|cpp_its_S\|cpp_lds_S\|dtc\|host\|vdso*) : ;; \
366f4856	288	*) echo "Don't know how to preprocess $(1)" >&2; false ;; \
f110e0fe	289	esac \| tr ";" "\n" \| sed -rn 's/^.=== __KSYM_(.) ===.*$$/KSYM_\1/p'
c1a95fda NP	290
	291	cmd_and_fixdep = \
	292	$(echo-cmd) $(cmd_$(1)); \
	293	$(ksym_dep_filter) \| \
	294	scripts/basic/fixdep -e $(depfile) $@ '$(make-cmd)' \
	295	> $(dot-target).tmp; \
	296	rm -f $(depfile); \
	297	mv -f $(dot-target).tmp $(dot-target).cmd;
	298
	299	endif
	300
8ec4b4ff	301	# Usage: $(call if_changed_rule,foo)
beda9f3a RZ	302	# Will check if $(cmd_foo) or any of the prerequisites changed,
beda9f3a RZ	303	# and if so will execute $(rule_foo).
48f1f058 SR	304	if_changed_rule = $(if $(strip $(any-prereq) $(arg-check) ), \
48f1f058 SR	305	@set -e; \
2aedcd09	306	$(rule_$(1)), @:)
48f1f058	307
45d506bd SR	308	###
	309	# why - tell why a a target got build
	310	# enabled by make V=2
	311	# Output (listed in the order they are checked):
	312	# (1) - due to target is PHONY
	313	# (2) - due to target missing
	314	# (3) - due to: file1.h file2.h
	315	# (4) - due to command line change
	316	# (5) - due to missing .cmd file
	317	# (6) - due to target not in $(targets)
	318	# (1) PHONY targets are always build
	319	# (2) No target, so we better build it
	320	# (3) Prerequisite is newer than target
	321	# (4) The command line stored in the file named dir/.target.cmd
	322	# differed from actual command line. This happens when compiler
	323	# options changes
	324	# (5) No dir/.target.cmd file (used to store command line)
	325	# (6) No dir/.target.cmd file and target not listed in $(targets)
	326	# This is a good hint that there is a bug in the kbuild file
	327	ifeq ($(KBUILD_VERBOSE),2)
	328	why = \
	329	$(if $(filter $@, $(PHONY)),- due to target is PHONY, \
	330	$(if $(wildcard $@), \
	331	$(if $(strip $(any-prereq)),- due to: $(any-prereq), \
	332	$(if $(arg-check), \
	333	$(if $(cmd_$@),- due to command line change, \
	334	$(if $(filter $@, $(targets)), \
	335	- due to missing .cmd file, \
	336	- due to $(notdir $@) not in $$(targets) \
	337	) \
	338	) \
	339	) \
	340	), \
	341	- due to target missing \
	342	) \
	343	)
	344
	345	echo-why = $(call escsq, $(strip $(why)))
	346	endif
3ee550f1 DW	347
	348	###############################################################################
	349	#
	350	# When a Kconfig string contains a filename, it is suitable for
	351	# passing to shell commands. It is surrounded by double-quotes, and
	352	# any double-quotes or backslashes within it are escaped by
	353	# backslashes.
	354	#
	355	# This is no use for dependencies or $(wildcard). We need to strip the
	356	# surrounding quotes and the escaping from quotes and backslashes, and
	357	# we do need to escape any spaces in the string. So, for example:
	358	#
	359	# Usage: $(eval $(call config_filename,FOO))
	360	#
	361	# Defines FOO_FILENAME based on the contents of the CONFIG_FOO option,
	362	# transformed as described above to be suitable for use within the
	363	# makefile.
	364	#
	365	# Also, if the filename is a relative filename and exists in the source
	366	# tree but not the build tree, define FOO_SRCPREFIX as $(srctree)/ to
	367	# be prefixed to both command invocation and dependencies.
	368	#
	369	# Note: We also print the filenames in the quiet_cmd_foo text, and
	370	# perhaps ought to have a version specially escaped for that purpose.
	371	# But it's only cosmetic, and $(patsubst "%",%,$(CONFIG_FOO)) is good
	372	# enough. It'll strip the quotes in the common case where there's no
	373	# space and it's a simple filename, and it'll retain the quotes when
	374	# there's a space. There are some esoteric cases in which it'll print
	375	# the wrong thing, but we don't really care. The actual dependencies
	376	# and commands do get it right, with various combinations of single
	377	# and double quotes, backslashes and spaces in the filenames.
	378	#
	379	###############################################################################
	380	#
3ee550f1 DW	381	define config_filename
	382	ifneq ($$(CONFIG_$(1)),"")
	383	$(1)_FILENAME := $$(subst \\,\,$$(subst \$$(quote),$$(quote),$$(subst $$(space_escape),\$$(space),$$(patsubst "%",%,$$(subst $$(space),$$(space_escape),$$(CONFIG_$(1)))))))
	384	ifneq ($$(patsubst /%,%,$$(firstword $$($(1)_FILENAME))),$$(firstword $$($(1)_FILENAME)))
	385	else
	386	ifeq ($$(wildcard $$($(1)_FILENAME)),)
	387	ifneq ($$(wildcard $$(srctree)/$$($(1)_FILENAME)),)
	388	$(1)_SRCPREFIX := $(srctree)/
	389	endif
	390	endif
	391	endif
	392	endif
	393	endef
	394	#
	395	###############################################################################