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