[linux-block.git] / scripts / Kbuild.include

# SPDX-License-Identifier: GPL-2.0
####
# kbuild: Generic definitions

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


endef

###
# Comparison macros.
# Usage: $(call test-lt, $(CONFIG_LLD_VERSION), 150000)
#
# Use $(intcmp ...) if supported. (Make >= 4.4)
# Otherwise, fall back to the 'test' shell command.
ifeq ($(intcmp 1,0,,,y),y)
test-ge = $(intcmp $(strip $1)0, $(strip $2)0,,y,y)
test-gt = $(intcmp $(strip $1)0, $(strip $2)0,,,y)
else
test-ge = $(shell test $(strip $1)0 -ge $(strip $2)0 && echo y)
test-gt = $(shell test $(strip $1)0 -gt $(strip $2)0 && echo y)
endif
test-le = $(call test-ge, $2, $1)
test-lt = $(call test-gt, $2, $1)

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

###
# Name of target with a '.tmp_' as filename prefix. foo/bar.o => foo/.tmp_bar.o
tmp-target = $(dir $@).tmp_$(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)

###
# The path to Kbuild or Makefile. Kbuild has precedence over Makefile.
kbuild-dir = $(if $(filter /%,$(src)),$(src),$(srctree)/$(src))
kbuild-file = $(or $(wildcard $(kbuild-dir)/Kbuild),$(kbuild-dir)/Makefile)

###
# Read a file, replacing newlines with spaces
#
# Make 4.2 or later can read a file by using its builtin function.
ifneq ($(filter-out 3.% 4.0 4.1, $(MAKE_VERSION)),)
read-file = $(subst $(newline),$(space),$(file < $1))
else
read-file = $(shell cat $1 2>/dev/null)
endif

###
# 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
	$(check-FORCE)
	$(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

###
# 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)';)

# sink stdout for 'make -s'
       redirect :=
 quiet_redirect :=
silent_redirect := exec >/dev/null;

# Delete the target on interruption
#
# GNU Make automatically deletes the target if it has already been changed by
# the interrupted recipe. So, you can safely stop the build by Ctrl-C (Make
# will delete incomplete targets), and resume it later.
#
# However, this does not work when the stderr is piped to another program, like
#  $ make >&2 | tee log
# Make dies with SIGPIPE before cleaning the targets.
#
# To address it, we clean the target in signal traps.
#
# Make deletes the target when it catches SIGHUP, SIGINT, SIGQUIT, SIGTERM.
# So, we cover them, and also SIGPIPE just in case.
#
# Of course, this is unneeded for phony targets.
delete-on-interrupt = \
	$(if $(filter-out $(PHONY), $@), \
		$(foreach sig, HUP INT QUIT TERM PIPE, \
			trap 'rm -f $@; trap - $(sig); kill -s $(sig) $$$$' $(sig);))

# printing commands
cmd = @set -e; $(echo-cmd) $($(quiet)redirect) $(delete-on-interrupt) $(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.
# PHONY targets skipped in both cases.
newer-prereqs = $(filter-out $(PHONY),$?)

# It is a typical mistake to forget the FORCE prerequisite. Check it here so
# no more breakage will slip in.
check-FORCE = $(if $(filter FORCE, $^),,$(warning FORCE prerequisite is missing))

if-changed-cond = $(newer-prereqs)$(cmd-check)$(check-FORCE)

# Execute command if command has changed or prerequisite(s) are updated.
if_changed = $(if $(if-changed-cond),$(cmd_and_savecmd),@:)

cmd_and_savecmd =                                                            \
	$(cmd);                                                              \
	printf '%s\n' 'cmd_$@ := $(make-cmd)' > $(dot-target).cmd

# Execute the command and also postprocess generated .d dependencies file.
if_changed_dep = $(if $(if-changed-cond),$(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 $(if-changed-cond),$(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

###############################################################################

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

# do not delete intermediate files automatically
#
# .NOTINTERMEDIATE is more correct, but only available on newer Make versions.
# Make 4.4 introduced .NOTINTERMEDIATE, and it appears in .FEATURES, but the
# global .NOTINTERMEDIATE does not work. We can use it on Make > 4.4.
# Use .SECONDARY for older Make versions, but "newer-prereq" cannot detect
# deleted files.
ifneq ($(and $(filter notintermediate, $(.FEATURES)),$(filter-out 4.4,$(MAKE_VERSION))),)
.NOTINTERMEDIATE:
else
.SECONDARY:
endif
Commit	Line	Data
96ac6d43	1	# SPDX-License-Identifier: GPL-2.0
8ec4b4ff SR	2	####
	3	# kbuild: Generic definitions
	4
beda9f3a	5	# Convenient variables
8ec4b4ff	6	comma := ,
13338935	7	quote := "
d51bfb78	8	squote := '
8ec4b4ff SR	9	empty :=
8ec4b4ff SR	10	space := $(empty) $(empty)
9c8fa9bc	11	space_escape := _-_SPACE_-_
9564a8cf	12	pound := \#
6768fa4b MY	13	define newline
	14
	15
	16	endef
8ec4b4ff	17
fccb3d3e MY	18	###
	19	# Comparison macros.
	20	# Usage: $(call test-lt, $(CONFIG_LLD_VERSION), 150000)
	21	#
	22	# Use $(intcmp ...) if supported. (Make >= 4.4)
	23	# Otherwise, fall back to the 'test' shell command.
	24	ifeq ($(intcmp 1,0,,,y),y)
	25	test-ge = $(intcmp $(strip $1)0, $(strip $2)0,,y,y)
	26	test-gt = $(intcmp $(strip $1)0, $(strip $2)0,,,y)
	27	else
	28	test-ge = $(shell test $(strip $1)0 -ge $(strip $2)0 && echo y)
	29	test-gt = $(shell test $(strip $1)0 -gt $(strip $2)0 && echo y)
	30	endif
	31	test-le = $(call test-ge, $2, $1)
	32	test-lt = $(call test-gt, $2, $1)
	33
48f1f058 SR	34	###
	35	# Name of target with a '.' as filename prefix. foo/bar.o => foo/.bar.o
	36	dot-target = $(dir $@).$(notdir $@)
	37
c25e1c55 MY	38	###
	39	# Name of target with a '.tmp_' as filename prefix. foo/bar.o => foo/.tmp_bar.o
	40	tmp-target = $(dir $@).tmp_$(notdir $@)
	41
8ec4b4ff	42	###
30a77297	43	# The temporary file to save gcc -MMD generated dependencies must not
8ec4b4ff	44	# contain a comma
48f1f058	45	depfile = $(subst $(comma),_,$(dot-target).d)
8ec4b4ff	46
5e8d780d SR	47	###
	48	# filename of target with directory and extension stripped
	49	basetarget = $(basename $(notdir $@))
	50
afa974b7 MY	51	###
	52	# real prerequisites without phony targets
	53	real-prereqs = $(filter-out $(PHONY), $^)
	54
d51bfb78 SR	55	###
	56	# Escape single quote for use in echo statements
	57	escsq = $(subst $(squote),'\$(squote)',$1)
	58
7e826c44 MY	59	###
	60	# Quote a string to pass it to C files. foo => '"foo"'
	61	stringify = $(squote)$(quote)$1$(quote)$(squote)
	62
a2430b25 MY	63	###
	64	# The path to Kbuild or Makefile. Kbuild has precedence over Makefile.
	65	kbuild-dir = $(if $(filter /%,$(src)),$(src),$(srctree)/$(src))
	66	kbuild-file = $(or $(wildcard $(kbuild-dir)/Kbuild),$(kbuild-dir)/Makefile)
	67
6768fa4b MY	68	###
	69	# Read a file, replacing newlines with spaces
	70	#
	71	# Make 4.2 or later can read a file by using its builtin function.
	72	ifneq ($(filter-out 3.% 4.0 4.1, $(MAKE_VERSION)),)
	73	read-file = $(subst $(newline),$(space),$(file < $1))
	74	else
	75	read-file = $(shell cat $1 2>/dev/null)
	76	endif
	77
5410ecc0 MF	78	###
	79	# Easy method for doing a status message
	80	kecho := :
	81	quiet_kecho := echo
	82	silent_kecho := :
	83	kecho := $($(quiet)kecho)
	84
8ec4b4ff SR	85	###
	86	# filechk is used to check if the content of a generated file is updated.
	87	# Sample usage:
ba97df45 MY	88	#
	89	# filechk_sample = echo $(KERNELRELEASE)
	90	# version.h: FORCE
8ec4b4ff	91	# $(call filechk,sample)
ba97df45	92	#
8ec4b4ff SR	93	# The rule defined shall write to stdout the content of the new file.
	94	# The existing file will be compared with the new one.
	95	# - If no file exist it is created
	96	# - If the content differ the new file is used
	97	# - If they are equal no change, and no timestamp update
8ec4b4ff	98	define filechk
e1f86d7b	99	$(check-FORCE)
88fe89a4 MY	100	$(Q)set -e; \
	101	mkdir -p $(dir $@); \
	102	trap "rm -f $(dot-target).tmp" EXIT; \
	103	{ $(filechk_$(1)); } > $(dot-target).tmp; \
	104	if [ ! -r $@ ] \|\| ! cmp -s $@ $(dot-target).tmp; then \
	105	$(kecho) ' UPD $@'; \
	106	mv -f $(dot-target).tmp $@; \
8ec4b4ff SR	107	fi
	108	endef
	109
beda9f3a	110	###
8ec4b4ff SR	111	# Shorthand for $(Q)$(MAKE) -f scripts/Makefile.build obj=
	112	# Usage:
	113	# $(Q)$(MAKE) $(build)=dir
5b2389b4	114	build := -f $(srctree)/scripts/Makefile.build obj
8ec4b4ff	115
9fb5e537 RR	116	###
	117	# Shorthand for $(Q)$(MAKE) -f scripts/Makefile.dtbinst obj=
	118	# Usage:
	119	# $(Q)$(MAKE) $(dtbinst)=dir
487c7c77	120	dtbinst := -f $(srctree)/scripts/Makefile.dtbinst obj
9fb5e537	121
371fdc77 MY	122	###
	123	# Shorthand for $(Q)$(MAKE) -f scripts/Makefile.clean obj=
	124	# Usage:
	125	# $(Q)$(MAKE) $(clean)=dir
	126	clean := -f $(srctree)/scripts/Makefile.clean obj
	127
5de043f4 OV	128	# echo command.
5de043f4 OV	129	# Short version is used, if $(quiet) equals `quiet_', otherwise full one.
bff288c1	130	echo-cmd = $(if $($(quiet)cmd_$(1)),\
5de043f4 OV	131	echo ' $(call escsq,$($(quiet)cmd_$(1)))$(echo-why)';)
5de043f4 OV	132
174a1dcc MY	133	# sink stdout for 'make -s'
	134	redirect :=
	135	quiet_redirect :=
	136	silent_redirect := exec >/dev/null;
	137
a7f3257d MY	138	# Delete the target on interruption
	139	#
	140	# GNU Make automatically deletes the target if it has already been changed by
	141	# the interrupted recipe. So, you can safely stop the build by Ctrl-C (Make
	142	# will delete incomplete targets), and resume it later.
	143	#
	144	# However, this does not work when the stderr is piped to another program, like
	145	# $ make >&2 \| tee log
	146	# Make dies with SIGPIPE before cleaning the targets.
	147	#
	148	# To address it, we clean the target in signal traps.
	149	#
	150	# Make deletes the target when it catches SIGHUP, SIGINT, SIGQUIT, SIGTERM.
	151	# So, we cover them, and also SIGPIPE just in case.
	152	#
	153	# Of course, this is unneeded for phony targets.
	154	delete-on-interrupt = \
	155	$(if $(filter-out $(PHONY), $@), \
	156	$(foreach sig, HUP INT QUIT TERM PIPE, \
	157	trap 'rm -f $@; trap - $(sig); kill -s $(sig) $$$$' $(sig);))
	158
5de043f4	159	# printing commands
a7f3257d	160	cmd = @set -e; $(echo-cmd) $($(quiet)redirect) $(delete-on-interrupt) $(cmd_$(1))
8ec4b4ff SR	161
8ec4b4ff SR	162	###
5de043f4	163	# if_changed - execute command if any prerequisite is newer than
8ec4b4ff SR	164	# target, or command line has changed
	165	# if_changed_dep - as if_changed, but uses fixdep to reveal dependencies
	166	# including used config symbols
	167	# if_changed_rule - as if_changed but execute rule instead
cd238eff	168	# See Documentation/kbuild/makefiles.rst for more info
8ec4b4ff SR	169
8ec4b4ff SR	170	ifneq ($(KBUILD_NOCMDDEP),1)
50bcca6a	171	# Check if both commands are the same including their order. Result is empty
9c8fa9bc	172	# string if equal. User may override this check using make KBUILD_NOCMDDEP=1
50bcca6a	173	cmd-check = $(filter-out $(subst $(space),$(space_escape),$(strip $(cmd_$@))), \
9c8fa9bc	174	$(subst $(space),$(space_escape),$(strip $(cmd_$1))))
c4d5ee13	175	else
50bcca6a	176	cmd-check = $(if $(strip $(cmd_$@)),,1)
8ec4b4ff SR	177	endif
8ec4b4ff SR	178
164f0d2e MM	179	# Replace >$< with >$$< to preserve $ when reloading the .cmd file
164f0d2e MM	180	# (needed for make)
9564a8cf	181	# Replace >#< with >$(pound)< to avoid starting a comment in the .cmd file
164f0d2e MM	182	# (needed for make)
	183	# Replace >'< with >'\''< to be able to enclose the whole string in '...'
	184	# (needed for the shell)
9564a8cf	185	make-cmd = $(call escsq,$(subst $(pound),$$(pound),$(subst $$,$$$$,$(cmd_$(1)))))
6176aa9a	186
2d3b1b8f	187	# Find any prerequisites that are newer than target or that do not exist.
48f1f058	188	# PHONY targets skipped in both cases.
eba19032	189	newer-prereqs = $(filter-out $(PHONY),$?)
48f1f058	190
e1f86d7b MY	191	# It is a typical mistake to forget the FORCE prerequisite. Check it here so
	192	# no more breakage will slip in.
	193	check-FORCE = $(if $(filter FORCE, $^),,$(warning FORCE prerequisite is missing))
	194
	195	if-changed-cond = $(newer-prereqs)$(cmd-check)$(check-FORCE)
6796e804	196
5de043f4	197	# Execute command if command has changed or prerequisite(s) are updated.
ebd191b3 MY	198	if_changed = $(if $(if-changed-cond),$(cmd_and_savecmd),@:)
	199
	200	cmd_and_savecmd = \
67126965	201	$(cmd); \
ebd191b3	202	printf '%s\n' 'cmd_$@ := $(make-cmd)' > $(dot-target).cmd
8ec4b4ff	203
5de043f4	204	# Execute the command and also postprocess generated .d dependencies file.
6796e804	205	if_changed_dep = $(if $(if-changed-cond),$(cmd_and_fixdep),@:)
c1a95fda	206
e4aca459	207	cmd_and_fixdep = \
3a2429e1	208	$(cmd); \
392885ee	209	scripts/basic/fixdep $(depfile) $@ '$(make-cmd)' > $(dot-target).cmd;\
e5d28910	210	rm -f $(depfile)
c1a95fda	211
8ec4b4ff	212	# Usage: $(call if_changed_rule,foo)
beda9f3a RZ	213	# Will check if $(cmd_foo) or any of the prerequisites changed,
beda9f3a RZ	214	# and if so will execute $(rule_foo).
6796e804	215	if_changed_rule = $(if $(if-changed-cond),$(rule_$(1)),@:)
48f1f058	216
45d506bd	217	###
312a3d09	218	# why - tell why a target got built
45d506bd SR	219	# enabled by make V=2
	220	# Output (listed in the order they are checked):
	221	# (1) - due to target is PHONY
	222	# (2) - due to target missing
	223	# (3) - due to: file1.h file2.h
	224	# (4) - due to command line change
	225	# (5) - due to missing .cmd file
	226	# (6) - due to target not in $(targets)
	227	# (1) PHONY targets are always build
	228	# (2) No target, so we better build it
	229	# (3) Prerequisite is newer than target
	230	# (4) The command line stored in the file named dir/.target.cmd
	231	# differed from actual command line. This happens when compiler
	232	# options changes
	233	# (5) No dir/.target.cmd file (used to store command line)
	234	# (6) No dir/.target.cmd file and target not listed in $(targets)
	235	# This is a good hint that there is a bug in the kbuild file
	236	ifeq ($(KBUILD_VERBOSE),2)
	237	why = \
	238	$(if $(filter $@, $(PHONY)),- due to target is PHONY, \
	239	$(if $(wildcard $@), \
eba19032	240	$(if $(newer-prereqs),- due to: $(newer-prereqs), \
50bcca6a	241	$(if $(cmd-check), \
45d506bd SR	242	$(if $(cmd_$@),- due to command line change, \
	243	$(if $(filter $@, $(targets)), \
	244	- due to missing .cmd file, \
	245	- due to $(notdir $@) not in $$(targets) \
	246	) \
	247	) \
	248	) \
	249	), \
	250	- due to target missing \
	251	) \
	252	)
	253
	254	echo-why = $(call escsq, $(strip $(why)))
	255	endif
3ee550f1	256
3ee550f1	257	###############################################################################
9c2af1c7 MY	258
	259	# delete partially updated (i.e. corrupted) files on error
	260	.DELETE_ON_ERROR:
8e9b61b2 MY	261
8e9b61b2 MY	262	# do not delete intermediate files automatically
875ef1a5 MY	263	#
	264	# .NOTINTERMEDIATE is more correct, but only available on newer Make versions.
	265	# Make 4.4 introduced .NOTINTERMEDIATE, and it appears in .FEATURES, but the
	266	# global .NOTINTERMEDIATE does not work. We can use it on Make > 4.4.
	267	# Use .SECONDARY for older Make versions, but "newer-prereq" cannot detect
	268	# deleted files.
	269	ifneq ($(and $(filter notintermediate, $(.FEATURES)),$(filter-out 4.4,$(MAKE_VERSION))),)
	270	.NOTINTERMEDIATE:
	271	else
8e9b61b2	272	.SECONDARY:
875ef1a5	273	endif