xref: /linux/scripts/Kbuild.include (revision beda9f3a13bbb22cde92a45f230a02ef2afef6a9)
18ec4b4ffSSam Ravnborg####
28ec4b4ffSSam Ravnborg# kbuild: Generic definitions
38ec4b4ffSSam Ravnborg
4*beda9f3aSRoman Zippel# Convenient variables
58ec4b4ffSSam Ravnborgcomma   := ,
6d51bfb78SSam Ravnborgsquote  := '
78ec4b4ffSSam Ravnborgempty   :=
88ec4b4ffSSam Ravnborgspace   := $(empty) $(empty)
98ec4b4ffSSam Ravnborg
108ec4b4ffSSam Ravnborg###
1148f1f058SSam Ravnborg# Name of target with a '.' as filename prefix. foo/bar.o => foo/.bar.o
1248f1f058SSam Ravnborgdot-target = $(dir $@).$(notdir $@)
1348f1f058SSam Ravnborg
1448f1f058SSam Ravnborg###
158ec4b4ffSSam Ravnborg# The temporary file to save gcc -MD generated dependencies must not
168ec4b4ffSSam Ravnborg# contain a comma
1748f1f058SSam Ravnborgdepfile = $(subst $(comma),_,$(dot-target).d)
188ec4b4ffSSam Ravnborg
198ec4b4ffSSam Ravnborg###
205e8d780dSSam Ravnborg# filename of target with directory and extension stripped
215e8d780dSSam Ravnborgbasetarget = $(basename $(notdir $@))
225e8d780dSSam Ravnborg
235e8d780dSSam Ravnborg###
24d51bfb78SSam Ravnborg# Escape single quote for use in echo statements
25d51bfb78SSam Ravnborgescsq = $(subst $(squote),'\$(squote)',$1)
26d51bfb78SSam Ravnborg
27d51bfb78SSam Ravnborg###
288ec4b4ffSSam Ravnborg# filechk is used to check if the content of a generated file is updated.
298ec4b4ffSSam Ravnborg# Sample usage:
308ec4b4ffSSam Ravnborg# define filechk_sample
318ec4b4ffSSam Ravnborg#	echo $KERNELRELEASE
328ec4b4ffSSam Ravnborg# endef
338ec4b4ffSSam Ravnborg# version.h : Makefile
348ec4b4ffSSam Ravnborg#	$(call filechk,sample)
358ec4b4ffSSam Ravnborg# The rule defined shall write to stdout the content of the new file.
368ec4b4ffSSam Ravnborg# The existing file will be compared with the new one.
378ec4b4ffSSam Ravnborg# - If no file exist it is created
388ec4b4ffSSam Ravnborg# - If the content differ the new file is used
398ec4b4ffSSam Ravnborg# - If they are equal no change, and no timestamp update
408ec4b4ffSSam Ravnborg# - stdin is piped in from the first prerequisite ($<) so one has
418ec4b4ffSSam Ravnborg#   to specify a valid file as first prerequisite (often the kbuild file)
428ec4b4ffSSam Ravnborgdefine filechk
438ec4b4ffSSam Ravnborg	$(Q)set -e;				\
448ec4b4ffSSam Ravnborg	echo '  CHK     $@';			\
458ec4b4ffSSam Ravnborg	mkdir -p $(dir $@);			\
468ec4b4ffSSam Ravnborg	$(filechk_$(1)) < $< > $@.tmp;		\
478ec4b4ffSSam Ravnborg	if [ -r $@ ] && cmp -s $@ $@.tmp; then	\
488ec4b4ffSSam Ravnborg		rm -f $@.tmp;			\
498ec4b4ffSSam Ravnborg	else					\
508ec4b4ffSSam Ravnborg		echo '  UPD     $@';		\
518ec4b4ffSSam Ravnborg		mv -f $@.tmp $@;		\
528ec4b4ffSSam Ravnborg	fi
538ec4b4ffSSam Ravnborgendef
548ec4b4ffSSam Ravnborg
5520a468b5SSam Ravnborg######
569d6e7a70SSam Ravnborg# gcc support functions
5720a468b5SSam Ravnborg# See documentation in Documentation/kbuild/makefiles.txt
5820a468b5SSam Ravnborg
59*beda9f3aSRoman Zippel# output directory for tests below
60*beda9f3aSRoman ZippelTMPOUT := $(if $(KBUILD_EXTMOD),$(firstword $(KBUILD_EXTMOD))/)
61*beda9f3aSRoman Zippel
62*beda9f3aSRoman Zippel# try-run
63*beda9f3aSRoman Zippel# Usage: option = $(call try-run, $(CC)...-o "$$TMP",option-ok,otherwise)
64*beda9f3aSRoman Zippel# Exit code chooses option. "$$TMP" is can be used as temporary file and
65*beda9f3aSRoman Zippel# is automatically cleaned up.
66*beda9f3aSRoman Zippeltry-run = $(shell set -e;		\
67*beda9f3aSRoman Zippel	TMP="$(TMPOUT).$$$$.tmp";	\
68*beda9f3aSRoman Zippel	if ($(1)) >/dev/null 2>&1;	\
695de043f4SOleg Verych	then echo "$(2)";		\
705de043f4SOleg Verych	else echo "$(3)";		\
715de043f4SOleg Verych	fi;				\
72*beda9f3aSRoman Zippel	rm -f "$$TMP")
73347a00fbSRoman Zippel
7420a468b5SSam Ravnborg# as-option
7520a468b5SSam Ravnborg# Usage: cflags-y += $(call as-option,-Wa$(comma)-isa=foo,)
76*beda9f3aSRoman Zippel
77*beda9f3aSRoman Zippelas-option = $(call try-run,\
78*beda9f3aSRoman Zippel	$(CC) $(CFLAGS) $(1) -c -xassembler /dev/null -o "$$TMP",$(1),$(2))
7920a468b5SSam Ravnborg
80e2414910SAndi Kleen# as-instr
81e2414910SAndi Kleen# Usage: cflags-y += $(call as-instr,instr,option1,option2)
82*beda9f3aSRoman Zippel
83*beda9f3aSRoman Zippelas-instr = $(call try-run,\
84*beda9f3aSRoman Zippel	echo -e "$(1)" | $(CC) $(AFLAGS) -c -xassembler -o "$$TMP" -,$(2),$(3))
85e2414910SAndi Kleen
8620a468b5SSam Ravnborg# cc-option
8720a468b5SSam Ravnborg# Usage: cflags-y += $(call cc-option,-march=winchip-c6,-march=i586)
88*beda9f3aSRoman Zippel
89*beda9f3aSRoman Zippelcc-option = $(call try-run,\
90*beda9f3aSRoman Zippel	$(CC) $(CFLAGS) $(1) -S -xc /dev/null -o "$$TMP",$(1),$(2))
9120a468b5SSam Ravnborg
9220a468b5SSam Ravnborg# cc-option-yn
9320a468b5SSam Ravnborg# Usage: flag := $(call cc-option-yn,-march=winchip-c6)
94*beda9f3aSRoman Zippelcc-option-yn = $(call try-run,\
95*beda9f3aSRoman Zippel	$(CC) $(CFLAGS) $(1) -S -xc /dev/null -o "$$TMP",y,n)
9620a468b5SSam Ravnborg
9720a468b5SSam Ravnborg# cc-option-align
9820a468b5SSam Ravnborg# Prefix align with either -falign or -malign
9920a468b5SSam Ravnborgcc-option-align = $(subst -functions=0,,\
10020a468b5SSam Ravnborg	$(call cc-option,-falign-functions=0,-malign-functions=0))
10120a468b5SSam Ravnborg
10220a468b5SSam Ravnborg# cc-version
10320a468b5SSam Ravnborg# Usage gcc-ver := $(call cc-version,$(CC))
1048eb3afe0SSam Ravnborgcc-version = $(shell $(CONFIG_SHELL) $(srctree)/scripts/gcc-version.sh $(CC))
10520a468b5SSam Ravnborg
10620a468b5SSam Ravnborg# cc-ifversion
10720a468b5SSam Ravnborg# Usage:  EXTRA_CFLAGS += $(call cc-ifversion, -lt, 0402, -O1)
1085de043f4SOleg Verychcc-ifversion = $(shell [ $(call cc-version, $(CC)) $(1) $(2) ] && echo $(3))
10920a468b5SSam Ravnborg
1100b0bf7a3SRoland McGrath# ld-option
1110b0bf7a3SRoland McGrath# Usage: ldflags += $(call ld-option, -Wl$(comma)--hash-style=both)
112*beda9f3aSRoman Zippelld-option = $(call try-run,\
113*beda9f3aSRoman Zippel	$(CC) $(1) -nostdlib -xc /dev/null -o "$$TMP",$(1),$(2))
1140b0bf7a3SRoland McGrath
1155de043f4SOleg Verych######
1165de043f4SOleg Verych
117*beda9f3aSRoman Zippel###
1188ec4b4ffSSam Ravnborg# Shorthand for $(Q)$(MAKE) -f scripts/Makefile.build obj=
1198ec4b4ffSSam Ravnborg# Usage:
1208ec4b4ffSSam Ravnborg# $(Q)$(MAKE) $(build)=dir
1218ec4b4ffSSam Ravnborgbuild := -f $(if $(KBUILD_SRC),$(srctree)/)scripts/Makefile.build obj
1228ec4b4ffSSam Ravnborg
123*beda9f3aSRoman Zippel# Prefix -I with $(srctree) if it is not an absolute path.
124*beda9f3aSRoman Zippeladdtree = $(if $(filter-out -I/%,$(1)),$(patsubst -I%,-I$(srctree)/%,$(1))) $(1)
125d9df92e2SSam Ravnborg
1265de043f4SOleg Verych# Find all -I options and call addtree
127*beda9f3aSRoman Zippelflags = $(foreach o,$($(1)),$(if $(filter -I%,$(o)),$(call addtree,$(o)),$(o)))
1285de043f4SOleg Verych
1295de043f4SOleg Verych# echo command.
1305de043f4SOleg Verych# Short version is used, if $(quiet) equals `quiet_', otherwise full one.
1315de043f4SOleg Verychecho-cmd = $(if $($(quiet)cmd_$(1)),\
1325de043f4SOleg Verych	echo '  $(call escsq,$($(quiet)cmd_$(1)))$(echo-why)';)
1335de043f4SOleg Verych
1345de043f4SOleg Verych# printing commands
1356176aa9aSJan Beulichcmd = @$(echo-cmd) $(cmd_$(1))
1368ec4b4ffSSam Ravnborg
1375de043f4SOleg Verych# Add $(obj)/ for paths that are not absolute
1380a504f25SSam Ravnborgobjectify = $(foreach o,$(1),$(if $(filter /%,$(o)),$(o),$(obj)/$(o)))
1390a504f25SSam Ravnborg
1408ec4b4ffSSam Ravnborg###
1418ec4b4ffSSam Ravnborg# if_changed      - execute command if any prerequisite is newer than
1428ec4b4ffSSam Ravnborg#                   target, or command line has changed
1438ec4b4ffSSam Ravnborg# if_changed_dep  - as if_changed, but uses fixdep to reveal dependencies
1448ec4b4ffSSam Ravnborg#                   including used config symbols
1458ec4b4ffSSam Ravnborg# if_changed_rule - as if_changed but execute rule instead
1468ec4b4ffSSam Ravnborg# See Documentation/kbuild/makefiles.txt for more info
1478ec4b4ffSSam Ravnborg
1488ec4b4ffSSam Ravnborgifneq ($(KBUILD_NOCMDDEP),1)
149*beda9f3aSRoman Zippel# Check if both arguments has same arguments. Result is empty string if equal.
1508ec4b4ffSSam Ravnborg# User may override this check using make KBUILD_NOCMDDEP=1
15148f1f058SSam Ravnborgarg-check = $(strip $(filter-out $(cmd_$(1)), $(cmd_$@)) \
15248f1f058SSam Ravnborg                    $(filter-out $(cmd_$@),   $(cmd_$(1))) )
1538ec4b4ffSSam Ravnborgendif
1548ec4b4ffSSam Ravnborg
15548f1f058SSam Ravnborg# >'< substitution is for echo to work,
15648f1f058SSam Ravnborg# >$< substitution to preserve $ when reloading .cmd file
15748f1f058SSam Ravnborg# note: when using inline perl scripts [perl -e '...$$t=1;...']
15848f1f058SSam Ravnborg# in $(cmd_xxx) double $$ your perl vars
1596176aa9aSJan Beulichmake-cmd = $(subst \#,\\\#,$(subst $$,$$$$,$(call escsq,$(cmd_$(1)))))
1606176aa9aSJan Beulich
16148f1f058SSam Ravnborg# Find any prerequisites that is newer than target or that does not exist.
16248f1f058SSam Ravnborg# PHONY targets skipped in both cases.
16348f1f058SSam Ravnborgany-prereq = $(filter-out $(PHONY),$?) $(filter-out $(PHONY) $(wildcard $^),$^)
16448f1f058SSam Ravnborg
1655de043f4SOleg Verych# Execute command if command has changed or prerequisite(s) are updated.
1668ec4b4ffSSam Ravnborg#
16748f1f058SSam Ravnborgif_changed = $(if $(strip $(any-prereq) $(arg-check)),                       \
1688ec4b4ffSSam Ravnborg	@set -e;                                                             \
1696176aa9aSJan Beulich	$(echo-cmd) $(cmd_$(1));                                             \
17048f1f058SSam Ravnborg	echo 'cmd_$@ := $(make-cmd)' > $(dot-target).cmd)
1718ec4b4ffSSam Ravnborg
1725de043f4SOleg Verych# Execute the command and also postprocess generated .d dependencies file.
17348f1f058SSam Ravnborgif_changed_dep = $(if $(strip $(any-prereq) $(arg-check) ),                  \
1748ec4b4ffSSam Ravnborg	@set -e;                                                             \
1756176aa9aSJan Beulich	$(echo-cmd) $(cmd_$(1));                                             \
17648f1f058SSam Ravnborg	scripts/basic/fixdep $(depfile) $@ '$(make-cmd)' > $(dot-target).tmp;\
1778ec4b4ffSSam Ravnborg	rm -f $(depfile);                                                    \
17848f1f058SSam Ravnborg	mv -f $(dot-target).tmp $(dot-target).cmd)
1798ec4b4ffSSam Ravnborg
1808ec4b4ffSSam Ravnborg# Usage: $(call if_changed_rule,foo)
181*beda9f3aSRoman Zippel# Will check if $(cmd_foo) or any of the prerequisites changed,
182*beda9f3aSRoman Zippel# and if so will execute $(rule_foo).
18348f1f058SSam Ravnborgif_changed_rule = $(if $(strip $(any-prereq) $(arg-check) ),                 \
1848ec4b4ffSSam Ravnborg	@set -e;                                                             \
1858ec4b4ffSSam Ravnborg	$(rule_$(1)))
18648f1f058SSam Ravnborg
18745d506bdSSam Ravnborg###
18845d506bdSSam Ravnborg# why - tell why a a target got build
18945d506bdSSam Ravnborg#       enabled by make V=2
19045d506bdSSam Ravnborg#       Output (listed in the order they are checked):
19145d506bdSSam Ravnborg#          (1) - due to target is PHONY
19245d506bdSSam Ravnborg#          (2) - due to target missing
19345d506bdSSam Ravnborg#          (3) - due to: file1.h file2.h
19445d506bdSSam Ravnborg#          (4) - due to command line change
19545d506bdSSam Ravnborg#          (5) - due to missing .cmd file
19645d506bdSSam Ravnborg#          (6) - due to target not in $(targets)
19745d506bdSSam Ravnborg# (1) PHONY targets are always build
19845d506bdSSam Ravnborg# (2) No target, so we better build it
19945d506bdSSam Ravnborg# (3) Prerequisite is newer than target
20045d506bdSSam Ravnborg# (4) The command line stored in the file named dir/.target.cmd
20145d506bdSSam Ravnborg#     differed from actual command line. This happens when compiler
20245d506bdSSam Ravnborg#     options changes
20345d506bdSSam Ravnborg# (5) No dir/.target.cmd file (used to store command line)
20445d506bdSSam Ravnborg# (6) No dir/.target.cmd file and target not listed in $(targets)
20545d506bdSSam Ravnborg#     This is a good hint that there is a bug in the kbuild file
20645d506bdSSam Ravnborgifeq ($(KBUILD_VERBOSE),2)
20745d506bdSSam Ravnborgwhy =                                                                        \
20845d506bdSSam Ravnborg    $(if $(filter $@, $(PHONY)),- due to target is PHONY,                    \
20945d506bdSSam Ravnborg        $(if $(wildcard $@),                                                 \
21045d506bdSSam Ravnborg            $(if $(strip $(any-prereq)),- due to: $(any-prereq),             \
21145d506bdSSam Ravnborg                $(if $(arg-check),                                           \
21245d506bdSSam Ravnborg                    $(if $(cmd_$@),- due to command line change,             \
21345d506bdSSam Ravnborg                        $(if $(filter $@, $(targets)),                       \
21445d506bdSSam Ravnborg                            - due to missing .cmd file,                      \
21545d506bdSSam Ravnborg                            - due to $(notdir $@) not in $$(targets)         \
21645d506bdSSam Ravnborg                         )                                                   \
21745d506bdSSam Ravnborg                     )                                                       \
21845d506bdSSam Ravnborg                 )                                                           \
21945d506bdSSam Ravnborg             ),                                                              \
22045d506bdSSam Ravnborg             - due to target missing                                         \
22145d506bdSSam Ravnborg         )                                                                   \
22245d506bdSSam Ravnborg     )
22345d506bdSSam Ravnborg
22445d506bdSSam Ravnborgecho-why = $(call escsq, $(strip $(why)))
22545d506bdSSam Ravnborgendif
226