[linux.git] / scripts / Kbuild.include

####
# kbuild: Generic definitions

# Convenient constants
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)

###
# 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)
define filechk
	$(Q)set -e;				\
	echo '  CHK     $@';			\
	mkdir -p $(dir $@);			\
	$(filechk_$(1)) < $< > [email protected];		\
	if [ -r $@ ] && cmp -s $@ [email protected]; then	\
		rm -f [email protected];			\
	else					\
		echo '  UPD     $@';		\
		mv -f [email protected] $@;		\
	fi
endef

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

# checker-shell
# Usage: option = $(call checker-shell,$(CC)...-o $$OUT,option-ok,otherwise)
# Exit code chooses option. $$OUT is safe location for needless output.
define checker-shell
$(shell set -e; \
  DIR=$(KBUILD_EXTMOD); \
  cd $${DIR:-$(objtree)}; \
  OUT=$$PWD/.$$$$.null; \
  if $(1) >/dev/null 2>&1; \
    then echo "$(2)"; \
    else echo "$(3)"; \
  fi; \
  rm -f $$OUT)
endef

# as-option
# Usage: cflags-y += $(call as-option,-Wa$(comma)-isa=foo,)
as-option = $(call checker-shell,\
   $(CC) $(CFLAGS) $(1) -c -xassembler /dev/null -o $$OUT,$(1),$(2))

# as-instr
# Usage: cflags-y += $(call as-instr,instr,option1,option2)
as-instr = $(call checker-shell,\
   printf "$(1)" | $(CC) $(AFLAGS) -c -xassembler -o $$OUT -,$(2),$(3))

# cc-option
# Usage: cflags-y += $(call cc-option,-march=winchip-c6,-march=i586)
cc-option = $(call checker-shell,\
   $(CC) $(CFLAGS) $(if $(3),$(3),$(1)) -S -xc /dev/null -o $$OUT,$(1),$(2))

# cc-option-yn
# Usage: flag := $(call cc-option-yn,-march=winchip-c6)
cc-option-yn = $(call cc-option,"y","n",$(1))

# 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))
cc-version = $(shell $(CONFIG_SHELL) $(srctree)/scripts/gcc-version.sh $(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 checker-shell,\
   $(CC) $(1) -nostdlib -xc /dev/null -o $$OUT,$(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,
# add original to the end
addtree = $(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)

# Will check if $(cmd_foo) changed, or any of the prerequisites changed,
# and if so will execute $(rule_foo).
# Usage: $(call if_changed_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
5de043f4	4	# Convenient constants
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
8ec4b4ff SR	27	###
	28	# filechk is used to check if the content of a generated file is updated.
	29	# Sample usage:
	30	# define filechk_sample
	31	# echo $KERNELRELEASE
	32	# endef
	33	# version.h : Makefile
	34	# $(call filechk,sample)
	35	# The rule defined shall write to stdout the content of the new file.
	36	# The existing file will be compared with the new one.
	37	# - If no file exist it is created
	38	# - If the content differ the new file is used
	39	# - If they are equal no change, and no timestamp update
	40	# - stdin is piped in from the first prerequisite ($<) so one has
	41	# to specify a valid file as first prerequisite (often the kbuild file)
	42	define filechk
	43	$(Q)set -e; \
	44	echo ' CHK $@'; \
	45	mkdir -p $(dir $@); \
	46	$(filechk_$(1)) < $< > [email protected]; \
	47	if [ -r $@ ] && cmp -s $@ [email protected]; then \
	48	rm -f [email protected]; \
	49	else \
	50	echo ' UPD $@'; \
	51	mv -f [email protected] $@; \
	52	fi
	53	endef
	54
20a468b5	55	######
9d6e7a70	56	# gcc support functions
20a468b5 SR	57	# See documentation in Documentation/kbuild/makefiles.txt
20a468b5 SR	58
5de043f4	59	# checker-shell
bff288c1	60	# Usage: option = $(call checker-shell,$(CC)...-o $$OUT,option-ok,otherwise)
5de043f4 OV	61	# Exit code chooses option. $$OUT is safe location for needless output.
5de043f4 OV	62	define checker-shell
b892afd1 LT	63	$(shell set -e; \
	64	DIR=$(KBUILD_EXTMOD); \
	65	cd $${DIR:-$(objtree)}; \
	66	OUT=$$PWD/.$$$$.null; \
	67	if $(1) >/dev/null 2>&1; \
	68	then echo "$(2)"; \
	69	else echo "$(3)"; \
	70	fi; \
	71	rm -f $$OUT)
5de043f4	72	endef
347a00fb	73
20a468b5	74	# as-option
bff288c1 OV	75	# Usage: cflags-y += $(call as-option,-Wa$(comma)-isa=foo,)
	76	as-option = $(call checker-shell,\
	77	$(CC) $(CFLAGS) $(1) -c -xassembler /dev/null -o $$OUT,$(1),$(2))
20a468b5	78
e2414910	79	# as-instr
bff288c1 OV	80	# Usage: cflags-y += $(call as-instr,instr,option1,option2)
	81	as-instr = $(call checker-shell,\
	82	printf "$(1)" \| $(CC) $(AFLAGS) -c -xassembler -o $$OUT -,$(2),$(3))
e2414910	83
20a468b5	84	# cc-option
bff288c1 OV	85	# Usage: cflags-y += $(call cc-option,-march=winchip-c6,-march=i586)
	86	cc-option = $(call checker-shell,\
	87	$(CC) $(CFLAGS) $(if $(3),$(3),$(1)) -S -xc /dev/null -o $$OUT,$(1),$(2))
20a468b5 SR	88
20a468b5 SR	89	# cc-option-yn
bff288c1 OV	90	# Usage: flag := $(call cc-option-yn,-march=winchip-c6)
bff288c1 OV	91	cc-option-yn = $(call cc-option,"y","n",$(1))
20a468b5 SR	92
	93	# cc-option-align
	94	# Prefix align with either -falign or -malign
	95	cc-option-align = $(subst -functions=0,,\
5de043f4	96	$(call cc-option,-falign-functions=0,-malign-functions=0))
20a468b5 SR	97
20a468b5 SR	98	# cc-version
bff288c1	99	# Usage gcc-ver := $(call cc-version,$(CC))
8eb3afe0	100	cc-version = $(shell $(CONFIG_SHELL) $(srctree)/scripts/gcc-version.sh $(CC))
20a468b5 SR	101
	102	# cc-ifversion
	103	# Usage: EXTRA_CFLAGS += $(call cc-ifversion, -lt, 0402, -O1)
5de043f4	104	cc-ifversion = $(shell [ $(call cc-version, $(CC)) $(1) $(2) ] && echo $(3))
20a468b5	105
0b0bf7a3 RM	106	# ld-option
0b0bf7a3 RM	107	# Usage: ldflags += $(call ld-option, -Wl$(comma)--hash-style=both)
bff288c1 OV	108	ld-option = $(call checker-shell,\
bff288c1 OV	109	$(CC) $(1) -nostdlib -xc /dev/null -o $$OUT,$(1),$(2))
5de043f4 OV	110
5de043f4 OV	111	######
0b0bf7a3	112
8ec4b4ff SR	113	# Shorthand for $(Q)$(MAKE) -f scripts/Makefile.build obj=
	114	# Usage:
	115	# $(Q)$(MAKE) $(build)=dir
	116	build := -f $(if $(KBUILD_SRC),$(srctree)/)scripts/Makefile.build obj
	117
5de043f4 OV	118	# Prefix -I with $(srctree) if it is not an absolute path,
	119	# add original to the end
	120	addtree = $(if \
bff288c1	121	$(filter-out -I/%,$(1)),$(patsubst -I%,-I$(srctree)/%,$(1))) $(1)
5de043f4	122
d9df92e2	123	# Find all -I options and call addtree
bff288c1 OV	124	flags = $(foreach o,$($(1)),\
bff288c1 OV	125	$(if $(filter -I%,$(o)),$(call addtree,$(o)),$(o)))
d9df92e2	126
5de043f4 OV	127	# echo command.
5de043f4 OV	128	# Short version is used, if $(quiet) equals `quiet_', otherwise full one.
bff288c1	129	echo-cmd = $(if $($(quiet)cmd_$(1)),\
5de043f4 OV	130	echo ' $(call escsq,$($(quiet)cmd_$(1)))$(echo-why)';)
	131
	132	# printing commands
6176aa9a	133	cmd = @$(echo-cmd) $(cmd_$(1))
8ec4b4ff	134
5de043f4	135	# Add $(obj)/ for paths that are not absolute
bff288c1	136	objectify = $(foreach o,$(1),$(if $(filter /%,$(o)),$(o),$(obj)/$(o)))
0a504f25	137
8ec4b4ff	138	###
5de043f4	139	# if_changed - execute command if any prerequisite is newer than
8ec4b4ff SR	140	# target, or command line has changed
	141	# if_changed_dep - as if_changed, but uses fixdep to reveal dependencies
	142	# including used config symbols
	143	# if_changed_rule - as if_changed but execute rule instead
	144	# See Documentation/kbuild/makefiles.txt for more info
	145
	146	ifneq ($(KBUILD_NOCMDDEP),1)
5de043f4	147	# Check if both arguments has same arguments. Result is empty string, if equal.
8ec4b4ff	148	# User may override this check using make KBUILD_NOCMDDEP=1
48f1f058 SR	149	arg-check = $(strip $(filter-out $(cmd_$(1)), $(cmd_$@)) \
48f1f058 SR	150	$(filter-out $(cmd_$@), $(cmd_$(1))) )
8ec4b4ff SR	151	endif
8ec4b4ff SR	152
48f1f058 SR	153	# >'< substitution is for echo to work,
	154	# >$< substitution to preserve $ when reloading .cmd file
	155	# note: when using inline perl scripts [perl -e '...$$t=1;...']
	156	# in $(cmd_xxx) double $$ your perl vars
6176aa9a JB	157	make-cmd = $(subst \#,\\\#,$(subst $$,$$$$,$(call escsq,$(cmd_$(1)))))
6176aa9a JB	158
48f1f058 SR	159	# Find any prerequisites that is newer than target or that does not exist.
	160	# PHONY targets skipped in both cases.
	161	any-prereq = $(filter-out $(PHONY),$?) $(filter-out $(PHONY) $(wildcard $^),$^)
	162
5de043f4	163	# Execute command if command has changed or prerequisite(s) are updated.
4f193362	164	#
48f1f058 SR	165	if_changed = $(if $(strip $(any-prereq) $(arg-check)), \
	166	@set -e; \
	167	$(echo-cmd) $(cmd_$(1)); \
	168	echo 'cmd_$@ := $(make-cmd)' > $(dot-target).cmd)
8ec4b4ff	169
5de043f4 OV	170	# Execute the command and also postprocess generated .d dependencies file.
5de043f4 OV	171	#
48f1f058 SR	172	if_changed_dep = $(if $(strip $(any-prereq) $(arg-check) ), \
	173	@set -e; \
	174	$(echo-cmd) $(cmd_$(1)); \
	175	scripts/basic/fixdep $(depfile) $@ '$(make-cmd)' > $(dot-target).tmp;\
	176	rm -f $(depfile); \
	177	mv -f $(dot-target).tmp $(dot-target).cmd)
8ec4b4ff	178
5de043f4 OV	179	# Will check if $(cmd_foo) changed, or any of the prerequisites changed,
5de043f4 OV	180	# and if so will execute $(rule_foo).
8ec4b4ff	181	# Usage: $(call if_changed_rule,foo)
5de043f4	182	#
48f1f058 SR	183	if_changed_rule = $(if $(strip $(any-prereq) $(arg-check) ), \
	184	@set -e; \
	185	$(rule_$(1)))
	186
45d506bd SR	187	###
	188	# why - tell why a a target got build
	189	# enabled by make V=2
	190	# Output (listed in the order they are checked):
	191	# (1) - due to target is PHONY
	192	# (2) - due to target missing
	193	# (3) - due to: file1.h file2.h
	194	# (4) - due to command line change
	195	# (5) - due to missing .cmd file
	196	# (6) - due to target not in $(targets)
	197	# (1) PHONY targets are always build
	198	# (2) No target, so we better build it
	199	# (3) Prerequisite is newer than target
	200	# (4) The command line stored in the file named dir/.target.cmd
	201	# differed from actual command line. This happens when compiler
	202	# options changes
	203	# (5) No dir/.target.cmd file (used to store command line)
	204	# (6) No dir/.target.cmd file and target not listed in $(targets)
	205	# This is a good hint that there is a bug in the kbuild file
	206	ifeq ($(KBUILD_VERBOSE),2)
	207	why = \
	208	$(if $(filter $@, $(PHONY)),- due to target is PHONY, \
	209	$(if $(wildcard $@), \
	210	$(if $(strip $(any-prereq)),- due to: $(any-prereq), \
	211	$(if $(arg-check), \
	212	$(if $(cmd_$@),- due to command line change, \
	213	$(if $(filter $@, $(targets)), \
	214	- due to missing .cmd file, \
	215	- due to $(notdir $@) not in $$(targets) \
	216	) \
	217	) \
	218	) \
	219	), \
	220	- due to target missing \
	221	) \
	222	)
	223
	224	echo-why = $(call escsq, $(strip $(why)))
	225	endif