[mirror_ubuntu-jammy-kernel.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 := \#

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

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

# printing commands
cmd = @set -e; $(echo-cmd) $($(quiet)redirect) $(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.
# (This is not true for now; $? should contain any non-existent prerequisites,
# but it does not work as expected when .SECONDARY is present. This seems a bug
# of GNU Make.)
# 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);                                                              \
	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

###############################################################################
#
# 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
#
###############################################################################

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

# do not delete intermediate files automatically
.SECONDARY:
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 := \#
8ec4b4ff	13
48f1f058 SR	14	###
	15	# Name of target with a '.' as filename prefix. foo/bar.o => foo/.bar.o
	16	dot-target = $(dir $@).$(notdir $@)
	17
8ec4b4ff	18	###
30a77297	19	# The temporary file to save gcc -MMD generated dependencies must not
8ec4b4ff	20	# contain a comma
48f1f058	21	depfile = $(subst $(comma),_,$(dot-target).d)
8ec4b4ff	22
5e8d780d SR	23	###
	24	# filename of target with directory and extension stripped
	25	basetarget = $(basename $(notdir $@))
	26
afa974b7 MY	27	###
	28	# real prerequisites without phony targets
	29	real-prereqs = $(filter-out $(PHONY), $^)
	30
d51bfb78 SR	31	###
	32	# Escape single quote for use in echo statements
	33	escsq = $(subst $(squote),'\$(squote)',$1)
	34
7e826c44 MY	35	###
	36	# Quote a string to pass it to C files. foo => '"foo"'
	37	stringify = $(squote)$(quote)$1$(quote)$(squote)
	38
5410ecc0 MF	39	###
	40	# Easy method for doing a status message
	41	kecho := :
	42	quiet_kecho := echo
	43	silent_kecho := :
	44	kecho := $($(quiet)kecho)
	45
8ec4b4ff SR	46	###
	47	# filechk is used to check if the content of a generated file is updated.
	48	# Sample usage:
ba97df45 MY	49	#
	50	# filechk_sample = echo $(KERNELRELEASE)
	51	# version.h: FORCE
8ec4b4ff	52	# $(call filechk,sample)
ba97df45	53	#
8ec4b4ff SR	54	# The rule defined shall write to stdout the content of the new file.
	55	# The existing file will be compared with the new one.
	56	# - If no file exist it is created
	57	# - If the content differ the new file is used
	58	# - If they are equal no change, and no timestamp update
8ec4b4ff	59	define filechk
e1f86d7b	60	$(check-FORCE)
88fe89a4 MY	61	$(Q)set -e; \
	62	mkdir -p $(dir $@); \
	63	trap "rm -f $(dot-target).tmp" EXIT; \
	64	{ $(filechk_$(1)); } > $(dot-target).tmp; \
	65	if [ ! -r $@ ] \|\| ! cmp -s $@ $(dot-target).tmp; then \
	66	$(kecho) ' UPD $@'; \
	67	mv -f $(dot-target).tmp $@; \
8ec4b4ff SR	68	fi
	69	endef
	70
beda9f3a	71	###
8ec4b4ff SR	72	# Shorthand for $(Q)$(MAKE) -f scripts/Makefile.build obj=
	73	# Usage:
	74	# $(Q)$(MAKE) $(build)=dir
5b2389b4	75	build := -f $(srctree)/scripts/Makefile.build obj
8ec4b4ff	76
9fb5e537 RR	77	###
	78	# Shorthand for $(Q)$(MAKE) -f scripts/Makefile.dtbinst obj=
	79	# Usage:
	80	# $(Q)$(MAKE) $(dtbinst)=dir
487c7c77	81	dtbinst := -f $(srctree)/scripts/Makefile.dtbinst obj
9fb5e537	82
371fdc77 MY	83	###
	84	# Shorthand for $(Q)$(MAKE) -f scripts/Makefile.clean obj=
	85	# Usage:
	86	# $(Q)$(MAKE) $(clean)=dir
	87	clean := -f $(srctree)/scripts/Makefile.clean obj
	88
5de043f4 OV	89	# echo command.
5de043f4 OV	90	# Short version is used, if $(quiet) equals `quiet_', otherwise full one.
bff288c1	91	echo-cmd = $(if $($(quiet)cmd_$(1)),\
5de043f4 OV	92	echo ' $(call escsq,$($(quiet)cmd_$(1)))$(echo-why)';)
5de043f4 OV	93
174a1dcc MY	94	# sink stdout for 'make -s'
	95	redirect :=
	96	quiet_redirect :=
	97	silent_redirect := exec >/dev/null;
	98
5de043f4	99	# printing commands
174a1dcc	100	cmd = @set -e; $(echo-cmd) $($(quiet)redirect) $(cmd_$(1))
8ec4b4ff SR	101
8ec4b4ff SR	102	###
5de043f4	103	# if_changed - execute command if any prerequisite is newer than
8ec4b4ff SR	104	# target, or command line has changed
	105	# if_changed_dep - as if_changed, but uses fixdep to reveal dependencies
	106	# including used config symbols
	107	# if_changed_rule - as if_changed but execute rule instead
cd238eff	108	# See Documentation/kbuild/makefiles.rst for more info
8ec4b4ff SR	109
8ec4b4ff SR	110	ifneq ($(KBUILD_NOCMDDEP),1)
50bcca6a	111	# Check if both commands are the same including their order. Result is empty
9c8fa9bc	112	# string if equal. User may override this check using make KBUILD_NOCMDDEP=1
50bcca6a	113	cmd-check = $(filter-out $(subst $(space),$(space_escape),$(strip $(cmd_$@))), \
9c8fa9bc	114	$(subst $(space),$(space_escape),$(strip $(cmd_$1))))
c4d5ee13	115	else
50bcca6a	116	cmd-check = $(if $(strip $(cmd_$@)),,1)
8ec4b4ff SR	117	endif
8ec4b4ff SR	118
164f0d2e MM	119	# Replace >$< with >$$< to preserve $ when reloading the .cmd file
164f0d2e MM	120	# (needed for make)
9564a8cf	121	# Replace >#< with >$(pound)< to avoid starting a comment in the .cmd file
164f0d2e MM	122	# (needed for make)
	123	# Replace >'< with >'\''< to be able to enclose the whole string in '...'
	124	# (needed for the shell)
9564a8cf	125	make-cmd = $(call escsq,$(subst $(pound),$$(pound),$(subst $$,$$$$,$(cmd_$(1)))))
6176aa9a	126
2d3b1b8f MY	127	# Find any prerequisites that are newer than target or that do not exist.
	128	# (This is not true for now; $? should contain any non-existent prerequisites,
	129	# but it does not work as expected when .SECONDARY is present. This seems a bug
	130	# of GNU Make.)
48f1f058	131	# PHONY targets skipped in both cases.
eba19032	132	newer-prereqs = $(filter-out $(PHONY),$?)
48f1f058	133
e1f86d7b MY	134	# It is a typical mistake to forget the FORCE prerequisite. Check it here so
	135	# no more breakage will slip in.
	136	check-FORCE = $(if $(filter FORCE, $^),,$(warning FORCE prerequisite is missing))
	137
	138	if-changed-cond = $(newer-prereqs)$(cmd-check)$(check-FORCE)
6796e804	139
5de043f4	140	# Execute command if command has changed or prerequisite(s) are updated.
6796e804	141	if_changed = $(if $(if-changed-cond), \
67126965	142	$(cmd); \
2aedcd09	143	printf '%s\n' 'cmd_$@ := $(make-cmd)' > $(dot-target).cmd, @:)
8ec4b4ff	144
5de043f4	145	# Execute the command and also postprocess generated .d dependencies file.
6796e804	146	if_changed_dep = $(if $(if-changed-cond),$(cmd_and_fixdep),@:)
c1a95fda	147
e4aca459	148	cmd_and_fixdep = \
3a2429e1	149	$(cmd); \
392885ee	150	scripts/basic/fixdep $(depfile) $@ '$(make-cmd)' > $(dot-target).cmd;\
e5d28910	151	rm -f $(depfile)
c1a95fda	152
8ec4b4ff	153	# Usage: $(call if_changed_rule,foo)
beda9f3a RZ	154	# Will check if $(cmd_foo) or any of the prerequisites changed,
beda9f3a RZ	155	# and if so will execute $(rule_foo).
6796e804	156	if_changed_rule = $(if $(if-changed-cond),$(rule_$(1)),@:)
48f1f058	157
45d506bd	158	###
312a3d09	159	# why - tell why a target got built
45d506bd SR	160	# enabled by make V=2
	161	# Output (listed in the order they are checked):
	162	# (1) - due to target is PHONY
	163	# (2) - due to target missing
	164	# (3) - due to: file1.h file2.h
	165	# (4) - due to command line change
	166	# (5) - due to missing .cmd file
	167	# (6) - due to target not in $(targets)
	168	# (1) PHONY targets are always build
	169	# (2) No target, so we better build it
	170	# (3) Prerequisite is newer than target
	171	# (4) The command line stored in the file named dir/.target.cmd
	172	# differed from actual command line. This happens when compiler
	173	# options changes
	174	# (5) No dir/.target.cmd file (used to store command line)
	175	# (6) No dir/.target.cmd file and target not listed in $(targets)
	176	# This is a good hint that there is a bug in the kbuild file
	177	ifeq ($(KBUILD_VERBOSE),2)
	178	why = \
	179	$(if $(filter $@, $(PHONY)),- due to target is PHONY, \
	180	$(if $(wildcard $@), \
eba19032	181	$(if $(newer-prereqs),- due to: $(newer-prereqs), \
50bcca6a	182	$(if $(cmd-check), \
45d506bd SR	183	$(if $(cmd_$@),- due to command line change, \
	184	$(if $(filter $@, $(targets)), \
	185	- due to missing .cmd file, \
	186	- due to $(notdir $@) not in $$(targets) \
	187	) \
	188	) \
	189	) \
	190	), \
	191	- due to target missing \
	192	) \
	193	)
	194
	195	echo-why = $(call escsq, $(strip $(why)))
	196	endif
3ee550f1 DW	197
	198	###############################################################################
	199	#
	200	# When a Kconfig string contains a filename, it is suitable for
	201	# passing to shell commands. It is surrounded by double-quotes, and
	202	# any double-quotes or backslashes within it are escaped by
	203	# backslashes.
	204	#
	205	# This is no use for dependencies or $(wildcard). We need to strip the
	206	# surrounding quotes and the escaping from quotes and backslashes, and
	207	# we do need to escape any spaces in the string. So, for example:
	208	#
	209	# Usage: $(eval $(call config_filename,FOO))
	210	#
	211	# Defines FOO_FILENAME based on the contents of the CONFIG_FOO option,
	212	# transformed as described above to be suitable for use within the
	213	# makefile.
	214	#
	215	# Also, if the filename is a relative filename and exists in the source
	216	# tree but not the build tree, define FOO_SRCPREFIX as $(srctree)/ to
	217	# be prefixed to both command invocation and dependencies.
	218	#
	219	# Note: We also print the filenames in the quiet_cmd_foo text, and
	220	# perhaps ought to have a version specially escaped for that purpose.
	221	# But it's only cosmetic, and $(patsubst "%",%,$(CONFIG_FOO)) is good
	222	# enough. It'll strip the quotes in the common case where there's no
	223	# space and it's a simple filename, and it'll retain the quotes when
	224	# there's a space. There are some esoteric cases in which it'll print
	225	# the wrong thing, but we don't really care. The actual dependencies
	226	# and commands do get it right, with various combinations of single
	227	# and double quotes, backslashes and spaces in the filenames.
	228	#
	229	###############################################################################
	230	#
3ee550f1 DW	231	define config_filename
	232	ifneq ($$(CONFIG_$(1)),"")
	233	$(1)_FILENAME := $$(subst \\,\,$$(subst \$$(quote),$$(quote),$$(subst $$(space_escape),\$$(space),$$(patsubst "%",%,$$(subst $$(space),$$(space_escape),$$(CONFIG_$(1)))))))
	234	ifneq ($$(patsubst /%,%,$$(firstword $$($(1)_FILENAME))),$$(firstword $$($(1)_FILENAME)))
	235	else
	236	ifeq ($$(wildcard $$($(1)_FILENAME)),)
	237	ifneq ($$(wildcard $$(srctree)/$$($(1)_FILENAME)),)
	238	$(1)_SRCPREFIX := $(srctree)/
	239	endif
	240	endif
	241	endif
	242	endif
	243	endef
	244	#
	245	###############################################################################
9c2af1c7 MY	246
	247	# delete partially updated (i.e. corrupted) files on error
	248	.DELETE_ON_ERROR:
8e9b61b2 MY	249
	250	# do not delete intermediate files automatically
	251	.SECONDARY: