[mirror_ubuntu-zesty-kernel.git] / scripts / Kbuild.include

####
# kbuild: Generic definitions

# Convenient variables
comma   := ,
squote  := '
empty   :=
space   := $(empty) $(empty)

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

###
# The temporary file to save gcc -MD generated dependencies must not
# contain a comma
depfile = $(subst $(comma),_,$(dot-target).d)

###
# filename of target with directory and extension stripped
basetarget = $(basename $(notdir $@))

###
# Escape single quote for use in echo statements
escsq = $(subst $(squote),'\$(squote)',$1)

###
# 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:
# define filechk_sample
#	echo $KERNELRELEASE
# endef
# version.h : Makefile
#	$(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
# - stdin is piped in from the first prerequisite ($<) so one has
#   to specify a valid file as first prerequisite (often the kbuild file)
       chk_filechk = :
 quiet_chk_filechk = echo '  CHK     $@'
silent_chk_filechk = :
       upd_filechk = :
 quiet_upd_filechk = echo '  UPD     $@'
silent_upd_filechk = :

define filechk
	$(Q)set -e;				\
	$($(quiet)chk_filechk);			\
	mkdir -p $(dir $@);			\
	$(filechk_$(1)) < $< > $@.tmp;		\
	if [ -r $@ ] && cmp -s $@ $@.tmp; then	\
		rm -f $@.tmp;			\
	else					\
		$($(quiet)upd_filechk);		\
		mv -f $@.tmp $@;		\
	fi
endef

######
# gcc support functions
# See documentation in Documentation/kbuild/makefiles.txt

# cc-cross-prefix
# Usage: CROSS_COMPILE := $(call cc-cross-prefix, m68k-linux-gnu- m68k-linux-)
# Return first prefix where a prefix$(CC) is found in PATH.
# If no $(CC) found in PATH with listed prefixes return nothing
cc-cross-prefix =  \
	$(word 1, $(foreach c,$(1),                                   \
		$(shell set -e;                                       \
		if (which $(strip $(c))$(CC)) > /dev/null 2>&1 ; then \
			echo $(c);                                    \
		fi)))

# output directory for tests below
TMPOUT := $(if $(KBUILD_EXTMOD),$(firstword $(KBUILD_EXTMOD))/)

# try-run
# Usage: option = $(call try-run, $(CC)...-o "$$TMP",option-ok,otherwise)
# Exit code chooses option. "$$TMP" is can be used as temporary file and
# is automatically cleaned up.
try-run = $(shell set -e;		\
	TMP="$(TMPOUT).$$$$.tmp";	\
	if ($(1)) >/dev/null 2>&1;	\
	then echo "$(2)";		\
	else echo "$(3)";		\
	fi;				\
	rm -f "$$TMP")

# as-option
# Usage: cflags-y += $(call as-option,-Wa$(comma)-isa=foo,)

as-option = $(call try-run,\
	$(CC) $(KBUILD_CFLAGS) $(1) -c -xassembler /dev/null -o "$$TMP",$(1),$(2))

# as-instr
# Usage: cflags-y += $(call as-instr,instr,option1,option2)

as-instr = $(call try-run,\
	echo -e "$(1)" | $(CC) $(KBUILD_AFLAGS) -c -xassembler -o "$$TMP" -,$(2),$(3))

# cc-option
# Usage: cflags-y += $(call cc-option,-march=winchip-c6,-march=i586)

cc-option = $(call try-run,\
	$(CC) $(KBUILD_CFLAGS) $(1) -c -xc /dev/null -o "$$TMP",$(1),$(2))

# cc-option-yn
# Usage: flag := $(call cc-option-yn,-march=winchip-c6)
cc-option-yn = $(call try-run,\
	$(CC) $(KBUILD_CFLAGS) $(1) -c -xc /dev/null -o "$$TMP",y,n)

# cc-option-align
# Prefix align with either -falign or -malign
cc-option-align = $(subst -functions=0,,\
	$(call cc-option,-falign-functions=0,-malign-functions=0))

# cc-version
# Usage gcc-ver := $(call cc-version)
cc-version = $(shell $(CONFIG_SHELL) $(srctree)/scripts/gcc-version.sh $(CC))

# cc-fullversion
# Usage gcc-ver := $(call cc-fullversion)
cc-fullversion = $(shell $(CONFIG_SHELL) \
	$(srctree)/scripts/gcc-version.sh -p $(CC))

# cc-ifversion
# Usage:  EXTRA_CFLAGS += $(call cc-ifversion, -lt, 0402, -O1)
cc-ifversion = $(shell [ $(call cc-version, $(CC)) $(1) $(2) ] && echo $(3))

# ld-option
# Usage: ldflags += $(call ld-option, -Wl$(comma)--hash-style=both)
ld-option = $(call try-run,\
	$(CC) $(1) -nostdlib -xc /dev/null -o "$$TMP",$(1),$(2))

######

###
# Shorthand for $(Q)$(MAKE) -f scripts/Makefile.build obj=
# Usage:
# $(Q)$(MAKE) $(build)=dir
build := -f $(if $(KBUILD_SRC),$(srctree)/)scripts/Makefile.build obj

# Prefix -I with $(srctree) if it is not an absolute path.
# skip if -I has no parameter
addtree = $(if $(patsubst -I%,%,$(1)), \
$(if $(filter-out -I/%,$(1)),$(patsubst -I%,-I$(srctree)/%,$(1))) $(1))

# Find all -I options and call addtree
flags = $(foreach o,$($(1)),$(if $(filter -I%,$(o)),$(call addtree,$(o)),$(o)))

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

# printing commands
cmd = @$(echo-cmd) $(cmd_$(1))

# Add $(obj)/ for paths that are not absolute
objectify = $(foreach o,$(1),$(if $(filter /%,$(o)),$(o),$(obj)/$(o)))

###
# 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.txt for more info

ifneq ($(KBUILD_NOCMDDEP),1)
# Check if both arguments has same arguments. Result is empty string if equal.
# User may override this check using make KBUILD_NOCMDDEP=1
arg-check = $(strip $(filter-out $(cmd_$(1)), $(cmd_$@)) \
                    $(filter-out $(cmd_$@),   $(cmd_$(1))) )
endif

# >'< substitution is for echo to work,
# >$< substitution to preserve $ when reloading .cmd file
# note: when using inline perl scripts [perl -e '...$$t=1;...']
# in $(cmd_xxx) double $$ your perl vars
make-cmd = $(subst \#,\\\#,$(subst $$,$$$$,$(call escsq,$(cmd_$(1)))))

# Find any prerequisites that is newer than target or that does not exist.
# PHONY targets skipped in both cases.
any-prereq = $(filter-out $(PHONY),$?) $(filter-out $(PHONY) $(wildcard $^),$^)

# Execute command if command has changed or prerequisite(s) are updated.
#
if_changed = $(if $(strip $(any-prereq) $(arg-check)),                       \
	@set -e;                                                             \
	$(echo-cmd) $(cmd_$(1));                                             \
	echo 'cmd_$@ := $(make-cmd)' > $(dot-target).cmd)

# Execute the command and also postprocess generated .d dependencies file.
if_changed_dep = $(if $(strip $(any-prereq) $(arg-check) ),                  \
	@set -e;                                                             \
	$(echo-cmd) $(cmd_$(1));                                             \
	scripts/basic/fixdep $(depfile) $@ '$(make-cmd)' > $(dot-target).tmp;\
	rm -f $(depfile);                                                    \
	mv -f $(dot-target).tmp $(dot-target).cmd)

# 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 $(strip $(any-prereq) $(arg-check) ),                 \
	@set -e;                                                             \
	$(rule_$(1)))

###
# why - tell why a a target got build
#       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 $(strip $(any-prereq)),- due to: $(any-prereq),             \
                $(if $(arg-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
Commit	Line	Data
8ec4b4ff SR	1	####
	2	# kbuild: Generic definitions
	3
beda9f3a	4	# Convenient variables
8ec4b4ff	5	comma := ,
d51bfb78	6	squote := '
8ec4b4ff SR	7	empty :=
	8	space := $(empty) $(empty)
	9
48f1f058 SR	10	###
	11	# Name of target with a '.' as filename prefix. foo/bar.o => foo/.bar.o
	12	dot-target = $(dir $@).$(notdir $@)
	13
8ec4b4ff SR	14	###
	15	# The temporary file to save gcc -MD generated dependencies must not
	16	# contain a comma
48f1f058	17	depfile = $(subst $(comma),_,$(dot-target).d)
8ec4b4ff	18
5e8d780d SR	19	###
	20	# filename of target with directory and extension stripped
	21	basetarget = $(basename $(notdir $@))
	22
d51bfb78 SR	23	###
	24	# Escape single quote for use in echo statements
	25	escsq = $(subst $(squote),'\$(squote)',$1)
	26
5410ecc0 MF	27	###
	28	# Easy method for doing a status message
	29	kecho := :
	30	quiet_kecho := echo
	31	silent_kecho := :
	32	kecho := $($(quiet)kecho)
	33
8ec4b4ff SR	34	###
	35	# filechk is used to check if the content of a generated file is updated.
	36	# Sample usage:
	37	# define filechk_sample
	38	# echo $KERNELRELEASE
	39	# endef
	40	# version.h : Makefile
	41	# $(call filechk,sample)
	42	# The rule defined shall write to stdout the content of the new file.
	43	# The existing file will be compared with the new one.
	44	# - If no file exist it is created
	45	# - If the content differ the new file is used
	46	# - If they are equal no change, and no timestamp update
	47	# - stdin is piped in from the first prerequisite ($<) so one has
	48	# to specify a valid file as first prerequisite (often the kbuild file)
fab1e310	49	chk_filechk = :
d75f4c68 MF	50	quiet_chk_filechk = echo ' CHK $@'
d75f4c68 MF	51	silent_chk_filechk = :
fab1e310	52	upd_filechk = :
d75f4c68 MF	53	quiet_upd_filechk = echo ' UPD $@'
d75f4c68 MF	54	silent_upd_filechk = :
fab1e310	55
8ec4b4ff SR	56	define filechk
8ec4b4ff SR	57	$(Q)set -e; \
d75f4c68	58	$($(quiet)chk_filechk); \
8ec4b4ff SR	59	mkdir -p $(dir $@); \
	60	$(filechk_$(1)) < $< > $@.tmp; \
	61	if [ -r $@ ] && cmp -s $@ $@.tmp; then \
	62	rm -f $@.tmp; \
	63	else \
d75f4c68	64	$($(quiet)upd_filechk); \
8ec4b4ff SR	65	mv -f $@.tmp $@; \
	66	fi
	67	endef
	68
20a468b5	69	######
9d6e7a70	70	# gcc support functions
20a468b5 SR	71	# See documentation in Documentation/kbuild/makefiles.txt
20a468b5 SR	72
910b4046 SR	73	# cc-cross-prefix
	74	# Usage: CROSS_COMPILE := $(call cc-cross-prefix, m68k-linux-gnu- m68k-linux-)
	75	# Return first prefix where a prefix$(CC) is found in PATH.
	76	# If no $(CC) found in PATH with listed prefixes return nothing
	77	cc-cross-prefix = \
	78	$(word 1, $(foreach c,$(1), \
	79	$(shell set -e; \
	80	if (which $(strip $(c))$(CC)) > /dev/null 2>&1 ; then \
	81	echo $(c); \
	82	fi)))
	83
beda9f3a RZ	84	# output directory for tests below
	85	TMPOUT := $(if $(KBUILD_EXTMOD),$(firstword $(KBUILD_EXTMOD))/)
	86
	87	# try-run
	88	# Usage: option = $(call try-run, $(CC)...-o "$$TMP",option-ok,otherwise)
	89	# Exit code chooses option. "$$TMP" is can be used as temporary file and
	90	# is automatically cleaned up.
	91	try-run = $(shell set -e; \
	92	TMP="$(TMPOUT).$$$$.tmp"; \
	93	if ($(1)) >/dev/null 2>&1; \
	94	then echo "$(2)"; \
	95	else echo "$(3)"; \
	96	fi; \
	97	rm -f "$$TMP")
347a00fb	98
20a468b5	99	# as-option
bff288c1	100	# Usage: cflags-y += $(call as-option,-Wa$(comma)-isa=foo,)
beda9f3a RZ	101
beda9f3a RZ	102	as-option = $(call try-run,\
a0f97e06	103	$(CC) $(KBUILD_CFLAGS) $(1) -c -xassembler /dev/null -o "$$TMP",$(1),$(2))
20a468b5	104
e2414910	105	# as-instr
bff288c1	106	# Usage: cflags-y += $(call as-instr,instr,option1,option2)
beda9f3a RZ	107
beda9f3a RZ	108	as-instr = $(call try-run,\
222d394d	109	echo -e "$(1)" \| $(CC) $(KBUILD_AFLAGS) -c -xassembler -o "$$TMP" -,$(2),$(3))
e2414910	110
20a468b5	111	# cc-option
bff288c1	112	# Usage: cflags-y += $(call cc-option,-march=winchip-c6,-march=i586)
beda9f3a RZ	113
beda9f3a RZ	114	cc-option = $(call try-run,\
43789e21	115	$(CC) $(KBUILD_CFLAGS) $(1) -c -xc /dev/null -o "$$TMP",$(1),$(2))
20a468b5 SR	116
20a468b5 SR	117	# cc-option-yn
bff288c1	118	# Usage: flag := $(call cc-option-yn,-march=winchip-c6)
beda9f3a	119	cc-option-yn = $(call try-run,\
43789e21	120	$(CC) $(KBUILD_CFLAGS) $(1) -c -xc /dev/null -o "$$TMP",y,n)
20a468b5 SR	121
	122	# cc-option-align
	123	# Prefix align with either -falign or -malign
	124	cc-option-align = $(subst -functions=0,,\
beda9f3a	125	$(call cc-option,-falign-functions=0,-malign-functions=0))
20a468b5 SR	126
20a468b5 SR	127	# cc-version
0ab2a272	128	# Usage gcc-ver := $(call cc-version)
8eb3afe0	129	cc-version = $(shell $(CONFIG_SHELL) $(srctree)/scripts/gcc-version.sh $(CC))
20a468b5	130
0ab2a272 SB	131	# cc-fullversion
	132	# Usage gcc-ver := $(call cc-fullversion)
	133	cc-fullversion = $(shell $(CONFIG_SHELL) \
	134	$(srctree)/scripts/gcc-version.sh -p $(CC))
	135
20a468b5 SR	136	# cc-ifversion
20a468b5 SR	137	# Usage: EXTRA_CFLAGS += $(call cc-ifversion, -lt, 0402, -O1)
5de043f4	138	cc-ifversion = $(shell [ $(call cc-version, $(CC)) $(1) $(2) ] && echo $(3))
20a468b5	139
0b0bf7a3 RM	140	# ld-option
0b0bf7a3 RM	141	# Usage: ldflags += $(call ld-option, -Wl$(comma)--hash-style=both)
beda9f3a RZ	142	ld-option = $(call try-run,\
beda9f3a RZ	143	$(CC) $(1) -nostdlib -xc /dev/null -o "$$TMP",$(1),$(2))
5de043f4 OV	144
5de043f4 OV	145	######
0b0bf7a3	146
beda9f3a	147	###
8ec4b4ff SR	148	# Shorthand for $(Q)$(MAKE) -f scripts/Makefile.build obj=
	149	# Usage:
	150	# $(Q)$(MAKE) $(build)=dir
	151	build := -f $(if $(KBUILD_SRC),$(srctree)/)scripts/Makefile.build obj
	152
beda9f3a	153	# Prefix -I with $(srctree) if it is not an absolute path.
5b91c33c SR	154	# skip if -I has no parameter
	155	addtree = $(if $(patsubst -I%,%,$(1)), \
	156	$(if $(filter-out -I/%,$(1)),$(patsubst -I%,-I$(srctree)/%,$(1))) $(1))
5de043f4	157
d9df92e2	158	# Find all -I options and call addtree
beda9f3a	159	flags = $(foreach o,$($(1)),$(if $(filter -I%,$(o)),$(call addtree,$(o)),$(o)))
d9df92e2	160
5de043f4 OV	161	# echo command.
5de043f4 OV	162	# Short version is used, if $(quiet) equals `quiet_', otherwise full one.
bff288c1	163	echo-cmd = $(if $($(quiet)cmd_$(1)),\
5de043f4 OV	164	echo ' $(call escsq,$($(quiet)cmd_$(1)))$(echo-why)';)
	165
	166	# printing commands
6176aa9a	167	cmd = @$(echo-cmd) $(cmd_$(1))
8ec4b4ff	168
5de043f4	169	# Add $(obj)/ for paths that are not absolute
bff288c1	170	objectify = $(foreach o,$(1),$(if $(filter /%,$(o)),$(o),$(obj)/$(o)))
0a504f25	171
8ec4b4ff	172	###
5de043f4	173	# if_changed - execute command if any prerequisite is newer than
8ec4b4ff SR	174	# target, or command line has changed
	175	# if_changed_dep - as if_changed, but uses fixdep to reveal dependencies
	176	# including used config symbols
	177	# if_changed_rule - as if_changed but execute rule instead
	178	# See Documentation/kbuild/makefiles.txt for more info
	179
	180	ifneq ($(KBUILD_NOCMDDEP),1)
beda9f3a	181	# Check if both arguments has same arguments. Result is empty string if equal.
8ec4b4ff	182	# User may override this check using make KBUILD_NOCMDDEP=1
48f1f058 SR	183	arg-check = $(strip $(filter-out $(cmd_$(1)), $(cmd_$@)) \
48f1f058 SR	184	$(filter-out $(cmd_$@), $(cmd_$(1))) )
8ec4b4ff SR	185	endif
8ec4b4ff SR	186
48f1f058 SR	187	# >'< substitution is for echo to work,
	188	# >$< substitution to preserve $ when reloading .cmd file
	189	# note: when using inline perl scripts [perl -e '...$$t=1;...']
	190	# in $(cmd_xxx) double $$ your perl vars
6176aa9a JB	191	make-cmd = $(subst \#,\\\#,$(subst $$,$$$$,$(call escsq,$(cmd_$(1)))))
6176aa9a JB	192
48f1f058 SR	193	# Find any prerequisites that is newer than target or that does not exist.
	194	# PHONY targets skipped in both cases.
	195	any-prereq = $(filter-out $(PHONY),$?) $(filter-out $(PHONY) $(wildcard $^),$^)
	196
5de043f4	197	# Execute command if command has changed or prerequisite(s) are updated.
4f193362	198	#
48f1f058 SR	199	if_changed = $(if $(strip $(any-prereq) $(arg-check)), \
	200	@set -e; \
	201	$(echo-cmd) $(cmd_$(1)); \
	202	echo 'cmd_$@ := $(make-cmd)' > $(dot-target).cmd)
8ec4b4ff	203
5de043f4	204	# Execute the command and also postprocess generated .d dependencies file.
48f1f058 SR	205	if_changed_dep = $(if $(strip $(any-prereq) $(arg-check) ), \
	206	@set -e; \
	207	$(echo-cmd) $(cmd_$(1)); \
	208	scripts/basic/fixdep $(depfile) $@ '$(make-cmd)' > $(dot-target).tmp;\
	209	rm -f $(depfile); \
	210	mv -f $(dot-target).tmp $(dot-target).cmd)
8ec4b4ff SR	211
8ec4b4ff SR	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).
48f1f058 SR	215	if_changed_rule = $(if $(strip $(any-prereq) $(arg-check) ), \
	216	@set -e; \
	217	$(rule_$(1)))
	218
45d506bd SR	219	###
	220	# why - tell why a a target got build
	221	# enabled by make V=2
	222	# Output (listed in the order they are checked):
	223	# (1) - due to target is PHONY
	224	# (2) - due to target missing
	225	# (3) - due to: file1.h file2.h
	226	# (4) - due to command line change
	227	# (5) - due to missing .cmd file
	228	# (6) - due to target not in $(targets)
	229	# (1) PHONY targets are always build
	230	# (2) No target, so we better build it
	231	# (3) Prerequisite is newer than target
	232	# (4) The command line stored in the file named dir/.target.cmd
	233	# differed from actual command line. This happens when compiler
	234	# options changes
	235	# (5) No dir/.target.cmd file (used to store command line)
	236	# (6) No dir/.target.cmd file and target not listed in $(targets)
	237	# This is a good hint that there is a bug in the kbuild file
	238	ifeq ($(KBUILD_VERBOSE),2)
	239	why = \
	240	$(if $(filter $@, $(PHONY)),- due to target is PHONY, \
	241	$(if $(wildcard $@), \
	242	$(if $(strip $(any-prereq)),- due to: $(any-prereq), \
	243	$(if $(arg-check), \
	244	$(if $(cmd_$@),- due to command line change, \
	245	$(if $(filter $@, $(targets)), \
	246	- due to missing .cmd file, \
	247	- due to $(notdir $@) not in $$(targets) \
	248	) \
	249	) \
	250	) \
	251	), \
	252	- due to target missing \
	253	) \
	254	)
	255
	256	echo-why = $(call escsq, $(strip $(why)))
	257	endif