[linux-block.git] / tools / build / Build.include

###
# build: Generic definitions
#
#  Lots of this code have been borrowed or heavily inspired from parts
#  of kbuild code, which is not credited, but mostly developed by:
#
#  Copyright (C) Sam Ravnborg <sam@mars.ravnborg.org>, 2015
#  Copyright (C) Linus Torvalds <torvalds@linux-foundation.org>, 2015
#

###
# Convenient variables
comma   := ,
squote  := '
pound   := \#

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

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

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

###
# Check if both arguments has same arguments. Result is empty string if equal.
arg-check = $(strip $(filter-out $(cmd_$(1)), $(cmd_$@)) \
                    $(filter-out $(cmd_$@),   $(cmd_$(1))) )

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

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

###
# 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 is newer than target or that does not exist.
# PHONY targets skipped in both cases.
any-prereq = $(filter-out $(PHONY),$?) $(filter-out $(PHONY) $(wildcard $^),$^)

###
# Copy dependency data into .cmd file
#  - gcc -M dependency info
#  - command line to create object 'cmd_object :='
dep-cmd = $(if $(wildcard $(fixdep)),                                           \
           $(fixdep) $(depfile) $@ '$(make-cmd)' > $(dot-target).tmp;           \
           rm -f $(depfile);                                                    \
           mv -f $(dot-target).tmp $(dot-target).cmd,                           \
           printf '$(pound) cannot find fixdep (%s)\n' $(fixdep) > $(dot-target).cmd; \
           printf '$(pound) using basic dep data\n\n' >> $(dot-target).cmd;           \
           cat $(depfile) >> $(dot-target).cmd;                                 \
           printf '\n%s\n' 'cmd_$@ := $(make-cmd)' >> $(dot-target).cmd)

###
# if_changed_dep  - execute command if any prerequisite is newer than
#                   target, or command line has changed and update
#                   dependencies in the cmd file
if_changed_dep = $(if $(strip $(any-prereq) $(arg-check)),         \
                  @set -e;                                         \
                  $(echo-cmd) $(cmd_$(1));                         \
                  $(dep-cmd))

# if_changed      - execute command if any prerequisite is newer than
#                   target, or command line has changed
if_changed = $(if $(strip $(any-prereq) $(arg-check)),                   \
              @set -e;                                                   \
              $(echo-cmd) $(cmd_$(1));                                   \
              printf '%s\n' 'cmd_$@ := $(make-cmd)' > $(dot-target).cmd)

###
# C flags to be used in rule definitions, includes:
# - depfile generation
# - global $(CFLAGS)
# - per target C flags
# - per object C flags
# - BUILD_STR macro to allow '-D"$(variable)"' constructs
c_flags_1 = -Wp,-MD,$(depfile) -Wp,-MT,$@ $(CFLAGS) -D"BUILD_STR(s)=\#s" $(CFLAGS_$(basetarget).o) $(CFLAGS_$(obj))
c_flags_2 = $(filter-out $(CFLAGS_REMOVE_$(basetarget).o), $(c_flags_1))
c_flags   = $(filter-out $(CFLAGS_REMOVE_$(obj)), $(c_flags_2))
cxx_flags = -Wp,-MD,$(depfile) -Wp,-MT,$@ $(CXXFLAGS) -D"BUILD_STR(s)=\#s" $(CXXFLAGS_$(basetarget).o) $(CXXFLAGS_$(obj))

###
## HOSTCC C flags

host_c_flags = -Wp,-MD,$(depfile) -Wp,-MT,$@ $(HOSTCFLAGS) -D"BUILD_STR(s)=\#s" $(HOSTCFLAGS_$(basetarget).o) $(HOSTCFLAGS_$(obj))

# output directory for tests below
TMPOUT = .tmp_$$$$

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

# cc-option
# Usage: cflags-y += $(call cc-option,-march=winchip-c6,-march=i586)
cc-option = $(call try-run, \
	$(CC) -Werror $(1) -c -x c /dev/null -o "$$TMP",$(1),$(2))

# delete partially updated (i.e. corrupted) files on error
.DELETE_ON_ERROR:
Commit	Line	Data
c819e2cf JO	1	###
	2	# build: Generic definitions
	3	#
	4	# Lots of this code have been borrowed or heavily inspired from parts
	5	# of kbuild code, which is not credited, but mostly developed by:
	6	#
	7	# Copyright (C) Sam Ravnborg <sam@mars.ravnborg.org>, 2015
	8	# Copyright (C) Linus Torvalds <torvalds@linux-foundation.org>, 2015
	9	#
	10
	11	###
	12	# Convenient variables
	13	comma := ,
	14	squote := '
9564a8cf	15	pound := \#
c819e2cf JO	16
	17	###
	18	# Name of target with a '.' as filename prefix. foo/bar.o => foo/.bar.o
	19	dot-target = $(dir $@).$(notdir $@)
	20
	21	###
	22	# filename of target with directory and extension stripped
	23	basetarget = $(basename $(notdir $@))
	24
	25	###
	26	# The temporary file to save gcc -MD generated dependencies must not
	27	# contain a comma
	28	depfile = $(subst $(comma),_,$(dot-target).d)
	29
	30	###
	31	# Check if both arguments has same arguments. Result is empty string if equal.
	32	arg-check = $(strip $(filter-out $(cmd_$(1)), $(cmd_$@)) \
	33	$(filter-out $(cmd_$@), $(cmd_$(1))) )
	34
	35	###
	36	# Escape single quote for use in echo statements
	37	escsq = $(subst $(squote),'\$(squote)',$1)
	38
	39	# Echo command
	40	# Short version is used, if $(quiet) equals `quiet_', otherwise full one.
	41	echo-cmd = $(if $($(quiet)cmd_$(1)),\
	42	echo ' $(call escsq,$($(quiet)cmd_$(1)))';)
	43
	44	###
	45	# Replace >$< with >$$< to preserve $ when reloading the .cmd file
	46	# (needed for make)
9564a8cf	47	# Replace >#< with >$(pound)< to avoid starting a comment in the .cmd file
c819e2cf JO	48	# (needed for make)
	49	# Replace >'< with >'\''< to be able to enclose the whole string in '...'
	50	# (needed for the shell)
9564a8cf	51	make-cmd = $(call escsq,$(subst $(pound),$$(pound),$(subst $$,$$$$,$(cmd_$(1)))))
c819e2cf JO	52
	53	###
	54	# Find any prerequisites that is newer than target or that does not exist.
	55	# PHONY targets skipped in both cases.
	56	any-prereq = $(filter-out $(PHONY),$?) $(filter-out $(PHONY) $(wildcard $^),$^)
	57
275e2d95 JO	58	###
	59	# Copy dependency data into .cmd file
	60	# - gcc -M dependency info
	61	# - command line to create object 'cmd_object :='
9fb81323 JO	62	dep-cmd = $(if $(wildcard $(fixdep)), \
	63	$(fixdep) $(depfile) $@ '$(make-cmd)' > $(dot-target).tmp; \
	64	rm -f $(depfile); \
	65	mv -f $(dot-target).tmp $(dot-target).cmd, \
9feeb638 PM	66	printf '$(pound) cannot find fixdep (%s)\n' $(fixdep) > $(dot-target).cmd; \
9feeb638 PM	67	printf '$(pound) using basic dep data\n\n' >> $(dot-target).cmd; \
9fb81323	68	cat $(depfile) >> $(dot-target).cmd; \
a5ba0a1a	69	printf '\n%s\n' 'cmd_$@ := $(make-cmd)' >> $(dot-target).cmd)
275e2d95	70
c819e2cf JO	71	###
	72	# if_changed_dep - execute command if any prerequisite is newer than
	73	# target, or command line has changed and update
	74	# dependencies in the cmd file
	75	if_changed_dep = $(if $(strip $(any-prereq) $(arg-check)), \
2fedf79b	76	@set -e; \
a278f3d8 AN	77	$(echo-cmd) $(cmd_$(1)); \
a278f3d8 AN	78	$(dep-cmd))
c819e2cf JO	79
	80	# if_changed - execute command if any prerequisite is newer than
	81	# target, or command line has changed
2fedf79b JO	82	if_changed = $(if $(strip $(any-prereq) $(arg-check)), \
	83	@set -e; \
	84	$(echo-cmd) $(cmd_$(1)); \
	85	printf '%s\n' 'cmd_$@ := $(make-cmd)' > $(dot-target).cmd)
c819e2cf JO	86
	87	###
	88	# C flags to be used in rule definitions, includes:
	89	# - depfile generation
	90	# - global $(CFLAGS)
	91	# - per target C flags
	92	# - per object C flags
	93	# - BUILD_STR macro to allow '-D"$(variable)"' constructs
baa1973e	94	c_flags_1 = -Wp,-MD,$(depfile) -Wp,-MT,$@ $(CFLAGS) -D"BUILD_STR(s)=\#s" $(CFLAGS_$(basetarget).o) $(CFLAGS_$(obj))
2ec8107d JO	95	c_flags_2 = $(filter-out $(CFLAGS_REMOVE_$(basetarget).o), $(c_flags_1))
2ec8107d JO	96	c_flags = $(filter-out $(CFLAGS_REMOVE_$(obj)), $(c_flags_2))
baa1973e	97	cxx_flags = -Wp,-MD,$(depfile) -Wp,-MT,$@ $(CXXFLAGS) -D"BUILD_STR(s)=\#s" $(CXXFLAGS_$(basetarget).o) $(CXXFLAGS_$(obj))
0c3b7e42 JO	98
	99	###
	100	## HOSTCC C flags
	101
c77a78c2	102	host_c_flags = -Wp,-MD,$(depfile) -Wp,-MT,$@ $(HOSTCFLAGS) -D"BUILD_STR(s)=\#s" $(HOSTCFLAGS_$(basetarget).o) $(HOSTCFLAGS_$(obj))
b61442df MY	103
	104	# output directory for tests below
	105	TMPOUT = .tmp_$$$$
	106
	107	# try-run
	108	# Usage: option = $(call try-run, $(CC)...-o "$$TMP",option-ok,otherwise)
	109	# Exit code chooses option. "$$TMP" serves as a temporary file and is
	110	# automatically cleaned up.
	111	try-run = $(shell set -e; \
	112	TMP=$(TMPOUT)/tmp; \
	113	mkdir -p $(TMPOUT); \
	114	trap "rm -rf $(TMPOUT)" EXIT; \
	115	if ($(1)) >/dev/null 2>&1; \
	116	then echo "$(2)"; \
	117	else echo "$(3)"; \
	118	fi)
	119
	120	# cc-option
	121	# Usage: cflags-y += $(call cc-option,-march=winchip-c6,-march=i586)
	122	cc-option = $(call try-run, \
	123	$(CC) -Werror $(1) -c -x c /dev/null -o "$$TMP",$(1),$(2))
	124
	125	# delete partially updated (i.e. corrupted) files on error
	126	.DELETE_ON_ERROR: