Merge tag 'nfs-for-4.20-1' of git://git.linux-nfs.org/projects/trondmy/linux-nfs
[linux-2.6-block.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.)
118CC_OPTION_CFLAGS = $(filter-out $(GCC_PLUGINS_CFLAGS),$(KBUILD_CFLAGS))
119
20a468b5 120# cc-option
bff288c1 121# Usage: cflags-y += $(call cc-option,-march=winchip-c6,-march=i586)
beda9f3a 122
9f3f1fd2
MK
123cc-option = $(call __cc-option, $(CC),\
124 $(KBUILD_CPPFLAGS) $(CC_OPTION_CFLAGS),$(1),$(2))
125
126# hostcc-option
127# Usage: cflags-y += $(call hostcc-option,-march=winchip-c6,-march=i586)
128hostcc-option = $(call __cc-option, $(HOSTCC),\
96f14fe7 129 $(KBUILD_HOSTCFLAGS) $(HOST_EXTRACFLAGS),$(1),$(2))
20a468b5
SR
130
131# cc-option-yn
bff288c1 132# Usage: flag := $(call cc-option-yn,-march=winchip-c6)
e08d6de4 133cc-option-yn = $(call try-run,\
c3f0d0bc 134 $(CC) -Werror $(KBUILD_CPPFLAGS) $(CC_OPTION_CFLAGS) $(1) -c -x c /dev/null -o "$$TMP",y,n)
20a468b5 135
8417da6f
MM
136# cc-disable-warning
137# Usage: cflags-y += $(call cc-disable-warning,unused-but-set-variable)
e08d6de4 138cc-disable-warning = $(call try-run,\
c3f0d0bc 139 $(CC) -Werror $(KBUILD_CPPFLAGS) $(CC_OPTION_CFLAGS) -W$(strip $(1)) -c -x c /dev/null -o "$$TMP",-Wno-$(strip $(1)))
8417da6f 140
5631d9c4
MM
141# cc-name
142# Expands to either gcc or clang
e08d6de4 143cc-name = $(shell $(CC) -v 2>&1 | grep -q "clang version" && echo clang || echo gcc)
5631d9c4 144
20a468b5 145# cc-version
e08d6de4 146cc-version = $(shell $(CONFIG_SHELL) $(srctree)/scripts/gcc-version.sh $(CC))
20a468b5 147
0ab2a272 148# cc-fullversion
e08d6de4 149cc-fullversion = $(shell $(CONFIG_SHELL) \
0ab2a272
SB
150 $(srctree)/scripts/gcc-version.sh -p $(CC))
151
20a468b5
SR
152# cc-ifversion
153# Usage: EXTRA_CFLAGS += $(call cc-ifversion, -lt, 0402, -O1)
6dcb4e5e 154cc-ifversion = $(shell [ $(cc-version) $(1) $(2) ] && echo $(3) || echo $(4))
20a468b5 155
f86fd306
SR
156# cc-ldoption
157# Usage: ldflags += $(call cc-ldoption, -Wl$(comma)--hash-style=both)
e08d6de4 158cc-ldoption = $(call try-run,\
86a9df59 159 $(CC) $(1) $(KBUILD_CPPFLAGS) $(CC_OPTION_CFLAGS) -nostdlib -x c /dev/null -o "$$TMP",$(1),$(2))
5de043f4 160
691ef3e7 161# ld-option
d503ac53
MY
162# Usage: KBUILD_LDFLAGS += $(call ld-option, -X, -Y)
163ld-option = $(call try-run, $(LD) $(KBUILD_LDFLAGS) $(1) -v,$(1),$(2),$(3))
691ef3e7 164
40df759e
MM
165# ar-option
166# Usage: KBUILD_ARFLAGS := $(call ar-option,D)
167# Important: no spaces around options
e08d6de4 168ar-option = $(call try-run, $(AR) rc$(1) "$$TMP",$(1),$(2))
40df759e 169
ccbef167 170# ld-version
ccbef167 171# Note this is mainly for HJ Lu's 3 number binutil versions
e08d6de4 172ld-version = $(shell $(LD) --version | $(srctree)/scripts/ld-version.sh)
ccbef167
AK
173
174# ld-ifversion
175# Usage: $(call ld-ifversion, -ge, 22252, y)
6dcb4e5e 176ld-ifversion = $(shell [ $(ld-version) $(1) $(2) ] && echo $(3) || echo $(4))
ccbef167 177
5de043f4 178######
0b0bf7a3 179
beda9f3a 180###
8ec4b4ff
SR
181# Shorthand for $(Q)$(MAKE) -f scripts/Makefile.build obj=
182# Usage:
183# $(Q)$(MAKE) $(build)=dir
5b2389b4 184build := -f $(srctree)/scripts/Makefile.build obj
8ec4b4ff 185
bc081dd6
MM
186###
187# Shorthand for $(Q)$(MAKE) -f scripts/Makefile.modbuiltin obj=
188# Usage:
189# $(Q)$(MAKE) $(modbuiltin)=dir
5b2389b4 190modbuiltin := -f $(srctree)/scripts/Makefile.modbuiltin obj
bc081dd6 191
9fb5e537
RR
192###
193# Shorthand for $(Q)$(MAKE) -f scripts/Makefile.dtbinst obj=
194# Usage:
195# $(Q)$(MAKE) $(dtbinst)=dir
196dtbinst := -f $(if $(KBUILD_SRC),$(srctree)/)scripts/Makefile.dtbinst obj
197
371fdc77
MY
198###
199# Shorthand for $(Q)$(MAKE) -f scripts/Makefile.clean obj=
200# Usage:
201# $(Q)$(MAKE) $(clean)=dir
202clean := -f $(srctree)/scripts/Makefile.clean obj
203
204###
1846dfbd 205# Shorthand for $(Q)$(MAKE) -f scripts/Makefile.headersinst obj=
371fdc77
MY
206# Usage:
207# $(Q)$(MAKE) $(hdr-inst)=dir
1846dfbd 208hdr-inst := -f $(srctree)/scripts/Makefile.headersinst obj
371fdc77 209
beda9f3a 210# Prefix -I with $(srctree) if it is not an absolute path.
5b91c33c
SR
211# skip if -I has no parameter
212addtree = $(if $(patsubst -I%,%,$(1)), \
48f6e3cf 213$(if $(filter-out -I/% -I./% -I../%,$(1)),$(patsubst -I%,-I$(srctree)/%,$(1)),$(1)),$(1))
5de043f4 214
d9df92e2 215# Find all -I options and call addtree
beda9f3a 216flags = $(foreach o,$($(1)),$(if $(filter -I%,$(o)),$(call addtree,$(o)),$(o)))
d9df92e2 217
5de043f4
OV
218# echo command.
219# Short version is used, if $(quiet) equals `quiet_', otherwise full one.
bff288c1 220echo-cmd = $(if $($(quiet)cmd_$(1)),\
5de043f4
OV
221 echo ' $(call escsq,$($(quiet)cmd_$(1)))$(echo-why)';)
222
223# printing commands
6176aa9a 224cmd = @$(echo-cmd) $(cmd_$(1))
8ec4b4ff 225
5de043f4 226# Add $(obj)/ for paths that are not absolute
bff288c1 227objectify = $(foreach o,$(1),$(if $(filter /%,$(o)),$(o),$(obj)/$(o)))
0a504f25 228
8ec4b4ff 229###
5de043f4 230# if_changed - execute command if any prerequisite is newer than
8ec4b4ff
SR
231# target, or command line has changed
232# if_changed_dep - as if_changed, but uses fixdep to reveal dependencies
233# including used config symbols
234# if_changed_rule - as if_changed but execute rule instead
235# See Documentation/kbuild/makefiles.txt for more info
236
237ifneq ($(KBUILD_NOCMDDEP),1)
9c8fa9bc
MY
238# Check if both arguments are the same including their order. Result is empty
239# string if equal. User may override this check using make KBUILD_NOCMDDEP=1
240arg-check = $(filter-out $(subst $(space),$(space_escape),$(strip $(cmd_$@))), \
241 $(subst $(space),$(space_escape),$(strip $(cmd_$1))))
c4d5ee13
MM
242else
243arg-check = $(if $(strip $(cmd_$@)),,1)
8ec4b4ff
SR
244endif
245
164f0d2e
MM
246# Replace >$< with >$$< to preserve $ when reloading the .cmd file
247# (needed for make)
9564a8cf 248# Replace >#< with >$(pound)< to avoid starting a comment in the .cmd file
164f0d2e
MM
249# (needed for make)
250# Replace >'< with >'\''< to be able to enclose the whole string in '...'
251# (needed for the shell)
9564a8cf 252make-cmd = $(call escsq,$(subst $(pound),$$(pound),$(subst $$,$$$$,$(cmd_$(1)))))
6176aa9a 253
48f1f058
SR
254# Find any prerequisites that is newer than target or that does not exist.
255# PHONY targets skipped in both cases.
256any-prereq = $(filter-out $(PHONY),$?) $(filter-out $(PHONY) $(wildcard $^),$^)
257
5de043f4 258# Execute command if command has changed or prerequisite(s) are updated.
48f1f058
SR
259if_changed = $(if $(strip $(any-prereq) $(arg-check)), \
260 @set -e; \
261 $(echo-cmd) $(cmd_$(1)); \
2aedcd09 262 printf '%s\n' 'cmd_$@ := $(make-cmd)' > $(dot-target).cmd, @:)
8ec4b4ff 263
5de043f4 264# Execute the command and also postprocess generated .d dependencies file.
48f1f058
SR
265if_changed_dep = $(if $(strip $(any-prereq) $(arg-check) ), \
266 @set -e; \
e4aca459
NP
267 $(cmd_and_fixdep), @:)
268
c1a95fda
NP
269ifndef CONFIG_TRIM_UNUSED_KSYMS
270
e4aca459 271cmd_and_fixdep = \
48f1f058
SR
272 $(echo-cmd) $(cmd_$(1)); \
273 scripts/basic/fixdep $(depfile) $@ '$(make-cmd)' > $(dot-target).tmp;\
274 rm -f $(depfile); \
e4aca459 275 mv -f $(dot-target).tmp $(dot-target).cmd;
8ec4b4ff 276
c1a95fda
NP
277else
278
279# Filter out exported kernel symbol names from the preprocessor output.
280# See also __KSYM_DEPS__ in include/linux/export.h.
281# We disable the depfile generation here, so as not to overwrite the existing
282# depfile while fixdep is parsing it.
283flags_nodeps = $(filter-out -Wp$(comma)-M%, $($(1)))
284ksym_dep_filter = \
285 case "$(1)" in \
366f4856
NP
286 cc_*_c|cpp_i_c) \
287 $(CPP) $(call flags_nodeps,c_flags) -D__KSYM_DEPS__ $< ;; \
288 as_*_S|cpp_s_S) \
289 $(CPP) $(call flags_nodeps,a_flags) -D__KSYM_DEPS__ $< ;; \
0d070d2b 290 boot*|build*|cpp_its_S|*cpp_lds_S|dtc|host*|vdso*) : ;; \
366f4856 291 *) echo "Don't know how to preprocess $(1)" >&2; false ;; \
fbfa9be9 292 esac | tr ";" "\n" | sed -n 's/^.*=== __KSYM_\(.*\) ===.*$$/_\1/p'
c1a95fda
NP
293
294cmd_and_fixdep = \
295 $(echo-cmd) $(cmd_$(1)); \
296 $(ksym_dep_filter) | \
297 scripts/basic/fixdep -e $(depfile) $@ '$(make-cmd)' \
298 > $(dot-target).tmp; \
299 rm -f $(depfile); \
300 mv -f $(dot-target).tmp $(dot-target).cmd;
301
302endif
303
8ec4b4ff 304# Usage: $(call if_changed_rule,foo)
beda9f3a
RZ
305# Will check if $(cmd_foo) or any of the prerequisites changed,
306# and if so will execute $(rule_foo).
48f1f058
SR
307if_changed_rule = $(if $(strip $(any-prereq) $(arg-check) ), \
308 @set -e; \
2aedcd09 309 $(rule_$(1)), @:)
48f1f058 310
45d506bd 311###
312a3d09 312# why - tell why a target got built
45d506bd
SR
313# enabled by make V=2
314# Output (listed in the order they are checked):
315# (1) - due to target is PHONY
316# (2) - due to target missing
317# (3) - due to: file1.h file2.h
318# (4) - due to command line change
319# (5) - due to missing .cmd file
320# (6) - due to target not in $(targets)
321# (1) PHONY targets are always build
322# (2) No target, so we better build it
323# (3) Prerequisite is newer than target
324# (4) The command line stored in the file named dir/.target.cmd
325# differed from actual command line. This happens when compiler
326# options changes
327# (5) No dir/.target.cmd file (used to store command line)
328# (6) No dir/.target.cmd file and target not listed in $(targets)
329# This is a good hint that there is a bug in the kbuild file
330ifeq ($(KBUILD_VERBOSE),2)
331why = \
332 $(if $(filter $@, $(PHONY)),- due to target is PHONY, \
333 $(if $(wildcard $@), \
334 $(if $(strip $(any-prereq)),- due to: $(any-prereq), \
335 $(if $(arg-check), \
336 $(if $(cmd_$@),- due to command line change, \
337 $(if $(filter $@, $(targets)), \
338 - due to missing .cmd file, \
339 - due to $(notdir $@) not in $$(targets) \
340 ) \
341 ) \
342 ) \
343 ), \
344 - due to target missing \
345 ) \
346 )
347
348echo-why = $(call escsq, $(strip $(why)))
349endif
3ee550f1
DW
350
351###############################################################################
352#
353# When a Kconfig string contains a filename, it is suitable for
354# passing to shell commands. It is surrounded by double-quotes, and
355# any double-quotes or backslashes within it are escaped by
356# backslashes.
357#
358# This is no use for dependencies or $(wildcard). We need to strip the
359# surrounding quotes and the escaping from quotes and backslashes, and
360# we *do* need to escape any spaces in the string. So, for example:
361#
362# Usage: $(eval $(call config_filename,FOO))
363#
364# Defines FOO_FILENAME based on the contents of the CONFIG_FOO option,
365# transformed as described above to be suitable for use within the
366# makefile.
367#
368# Also, if the filename is a relative filename and exists in the source
369# tree but not the build tree, define FOO_SRCPREFIX as $(srctree)/ to
370# be prefixed to *both* command invocation and dependencies.
371#
372# Note: We also print the filenames in the quiet_cmd_foo text, and
373# perhaps ought to have a version specially escaped for that purpose.
374# But it's only cosmetic, and $(patsubst "%",%,$(CONFIG_FOO)) is good
375# enough. It'll strip the quotes in the common case where there's no
376# space and it's a simple filename, and it'll retain the quotes when
377# there's a space. There are some esoteric cases in which it'll print
378# the wrong thing, but we don't really care. The actual dependencies
379# and commands *do* get it right, with various combinations of single
380# and double quotes, backslashes and spaces in the filenames.
381#
382###############################################################################
383#
3ee550f1
DW
384define config_filename
385ifneq ($$(CONFIG_$(1)),"")
386$(1)_FILENAME := $$(subst \\,\,$$(subst \$$(quote),$$(quote),$$(subst $$(space_escape),\$$(space),$$(patsubst "%",%,$$(subst $$(space),$$(space_escape),$$(CONFIG_$(1)))))))
387ifneq ($$(patsubst /%,%,$$(firstword $$($(1)_FILENAME))),$$(firstword $$($(1)_FILENAME)))
388else
389ifeq ($$(wildcard $$($(1)_FILENAME)),)
390ifneq ($$(wildcard $$(srctree)/$$($(1)_FILENAME)),)
391$(1)_SRCPREFIX := $(srctree)/
392endif
393endif
394endif
395endif
396endef
397#
398###############################################################################
9c2af1c7
MY
399
400# delete partially updated (i.e. corrupted) files on error
401.DELETE_ON_ERROR: