[mirror_qemu.git] / rules.mak


COMMA := ,

# Don't use implicit rules or variables
# we have explicit rules for everything
MAKEFLAGS += -rR

# Files with this suffixes are final, don't try to generate them
# using implicit rules
%/trace-events:
%.hx:
%.py:
%.objs:
%.d:
%.h:
%.c:
%.cc:
%.cpp:
%.m:
%.mak:
clean-target:

# Flags for dependency generation
QEMU_DGFLAGS += -MMD -MP -MT $@ -MF $(@D)/$(*F).d

# Compiler searches the source file dir first, but in vpath builds
# we need to make it search the build dir too, before any other
# explicit search paths. There are two search locations in the build
# dir, one absolute and the other relative to the compiler working
# directory. These are the same for target-independent files, but
# different for target-dependent ones.
QEMU_LOCAL_INCLUDES = -I$(BUILD_DIR)/$(@D) -I$(@D)

WL_U := -Wl,-u,
find-symbols = $(if $1, $(sort $(shell $(NM) -P -g $1 | $2)))
defined-symbols = $(call find-symbols,$1,awk '$$2!="U"{print $$1}')
undefined-symbols = $(call find-symbols,$1,awk '$$2=="U"{print $$1}')

# All the .mo objects in -m variables are also added into corresponding -y
# variable in unnest-vars, but filtered out here, when LINK is called.
#
# The .mo objects are supposed to be linked as a DSO, for module build. So here
# they are only used as a placeholders to generate those "archive undefined"
# symbol options (-Wl,-u,$symbol_name), which are the archive functions
# referenced by the code in the DSO.
#
# Also the presence in -y variables will also guarantee they are built before
# linking executables that will load them. So we can look up symbol reference
# in LINK.
#
# This is necessary because the exectuable itself may not use the function, in
# which case the function would not be linked in. Then the DSO loading will
# fail because of the missing symbol.
process-archive-undefs = $(filter-out %.a %.mo,$1) \
                $(addprefix $(WL_U), \
                     $(filter $(call defined-symbols,$(filter %.a, $1)), \
                              $(call undefined-symbols,$(filter %.mo,$1)))) \
                $(filter %.a,$1)

extract-libs = $(strip $(foreach o,$(filter-out %.mo,$1),$($o-libs)))
expand-objs = $(strip $(sort $(filter %.o,$1)) \
                  $(foreach o,$(filter %.mo,$1),$($o-objs)) \
                  $(filter-out %.o %.mo,$1))

%.o: %.c
	$(call quiet-command,$(CC) $(QEMU_LOCAL_INCLUDES) $(QEMU_INCLUDES) \
	       $(QEMU_CFLAGS) $(QEMU_DGFLAGS) $(CFLAGS) $($@-cflags) \
	       -c -o $@ $<,"CC","$(TARGET_DIR)$@")
%.o: %.rc
	$(call quiet-command,$(WINDRES) -I. -o $@ $<,"RC","$(TARGET_DIR)$@")

# If we have a CXX we might have some C++ objects, in which case we
# must link with the C++ compiler, not the plain C compiler.
LINKPROG = $(or $(CXX),$(CC))

LINK = $(call quiet-command, $(LINKPROG) $(QEMU_CFLAGS) $(CFLAGS) $(LDFLAGS) -o $@ \
       $(call process-archive-undefs, $1) \
       $(version-obj-y) $(call extract-libs,$1) $(LIBS),"LINK","$(TARGET_DIR)$@")

%.o: %.S
	$(call quiet-command,$(CCAS) $(QEMU_LOCAL_INCLUDES) $(QEMU_INCLUDES) \
	       $(QEMU_CFLAGS) $(QEMU_DGFLAGS) $(CFLAGS) \
	       -c -o $@ $<,"CCAS","$(TARGET_DIR)$@")

%.o: %.cc
	$(call quiet-command,$(CXX) $(QEMU_LOCAL_INCLUDES) $(QEMU_INCLUDES) \
	       $(QEMU_CXXFLAGS) $(QEMU_DGFLAGS) $(CFLAGS) $($@-cflags) \
	       -c -o $@ $<,"CXX","$(TARGET_DIR)$@")

%.o: %.cpp
	$(call quiet-command,$(CXX) $(QEMU_LOCAL_INCLUDES) $(QEMU_INCLUDES) \
	       $(QEMU_CXXFLAGS) $(QEMU_DGFLAGS) $(CFLAGS) $($@-cflags) \
	       -c -o $@ $<,"CXX","$(TARGET_DIR)$@")

%.o: %.m
	$(call quiet-command,$(OBJCC) $(QEMU_LOCAL_INCLUDES) $(QEMU_INCLUDES) \
	       $(QEMU_CFLAGS) $(QEMU_DGFLAGS) $(CFLAGS) $($@-cflags) \
	       -c -o $@ $<,"OBJC","$(TARGET_DIR)$@")

%.o: %.dtrace
	$(call quiet-command,dtrace -o $@ -G -s $<,"GEN","$(TARGET_DIR)$@")

DSO_OBJ_CFLAGS := -fPIC -DBUILD_DSO
module-common.o: CFLAGS += $(DSO_OBJ_CFLAGS)
%$(DSOSUF): LDFLAGS += $(LDFLAGS_SHARED)
%$(DSOSUF): %.mo
	$(call LINK,$^)
	@# Copy to build root so modules can be loaded when program started without install
	$(if $(findstring /,$@),$(call quiet-command,cp $@ $(subst /,-,$@),"CP","$(subst /,-,$@)"))


LD_REL := $(CC) -nostdlib $(LD_REL_FLAGS)

%.mo:
	$(call quiet-command,$(LD_REL) -o $@ $^,"LD","$(TARGET_DIR)$@")

.PHONY: modules
modules:

%$(EXESUF): %.o
	$(call LINK,$(filter %.o %.a %.mo, $^))

%.a:
	$(call quiet-command,rm -f $@ && $(AR) rcs $@ $^,"AR","$(TARGET_DIR)$@")

# Usage: $(call quiet-command,command and args,"NAME","args to print")
# This will run "command and args", and either:
#  if V=1 just print the whole command and args
#  otherwise print the 'quiet' output in the format "  NAME     args to print"
# NAME should be a short name of the command, 7 letters or fewer.
# If called with only a single argument, will print nothing in quiet mode.
quiet-command = $(if $(V),$1,$(if $(2),@printf "  %-7s %s\n" $2 $3 && $1, @$1))

# cc-option
# Usage: CFLAGS+=$(call cc-option, -falign-functions=0, -malign-functions=0)

cc-option = $(if $(shell $(CC) $1 $2 -S -o /dev/null -xc /dev/null \
              >/dev/null 2>&1 && echo OK), $2, $3)
cc-c-option = $(if $(shell $(CC) $1 $2 -c -o /dev/null -xc /dev/null \
                >/dev/null 2>&1 && echo OK), $2, $3)

VPATH_SUFFIXES = %.c %.h %.S %.cc %.cpp %.m %.mak %.texi %.sh %.rc
set-vpath = $(if $1,$(foreach PATTERN,$(VPATH_SUFFIXES),$(eval vpath $(PATTERN) $1)))

# install-prog list, dir
define install-prog
	$(INSTALL_DIR) "$2"
	$(INSTALL_PROG) $1 "$2"
	$(if $(STRIP),$(STRIP) $(foreach T,$1,"$2/$(notdir $T)"),)
endef

# find-in-path
# Usage: $(call find-in-path, prog)
# Looks in the PATH if the argument contains no slash, else only considers one
# specific directory.  Returns an # empty string if the program doesn't exist
# there.
find-in-path = $(if $(findstring /, $1), \
        $(wildcard $1), \
        $(wildcard $(patsubst %, %/$1, $(subst :, ,$(PATH)))))

# Logical functions (for operating on y/n values like CONFIG_FOO vars)
# Inputs to these must be either "y" (true) or "n" or "" (both false)
# Output is always either "y" or "n".
# Usage: $(call land,$(CONFIG_FOO),$(CONFIG_BAR))
# Logical NOT
lnot = $(if $(subst n,,$1),n,y)
# Logical AND
land = $(if $(findstring yy,$1$2),y,n)
# Logical OR
lor = $(if $(findstring y,$1$2),y,n)
# Logical XOR (note that this is the inverse of leqv)
lxor = $(if $(filter $(call lnot,$1),$(call lnot,$2)),n,y)
# Logical equivalence (note that leqv "","n" is true)
leqv = $(if $(filter $(call lnot,$1),$(call lnot,$2)),y,n)
# Logical if: like make's $(if) but with an leqv-like test
lif = $(if $(subst n,,$1),$2,$3)

# String testing functions: inputs to these can be any string;
# the output is always either "y" or "n". Leading and trailing whitespace
# is ignored when comparing strings.
# String equality
eq = $(if $(subst $2,,$1)$(subst $1,,$2),n,y)
# String inequality
ne = $(if $(subst $2,,$1)$(subst $1,,$2),y,n)
# Emptiness/non-emptiness tests:
isempty = $(if $1,n,y)
notempty = $(if $1,y,n)

# Generate files with tracetool
TRACETOOL=$(PYTHON) $(SRC_PATH)/scripts/tracetool.py

# Generate timestamp files for .h include files

config-%.h: config-%.h-timestamp
	@cmp $< $@ >/dev/null 2>&1 || cp $< $@

config-%.h-timestamp: config-%.mak $(SRC_PATH)/scripts/create_config
	$(call quiet-command, sh $(SRC_PATH)/scripts/create_config < $< > $@,"GEN","$(TARGET_DIR)config-$*.h")

.PHONY: clean-timestamp
clean-timestamp:
	rm -f *.timestamp
clean: clean-timestamp

# will delete the target of a rule if commands exit with a nonzero exit status
.DELETE_ON_ERROR:

# save-vars
# Usage: $(call save-vars, vars)
# Save each variable $v in $vars as save-vars-$v, save their object's
# variables, then clear $v.  saved-vars-$v contains the variables that
# where saved for the objects, in order to speedup load-vars.
define save-vars
    $(foreach v,$1,
        $(eval save-vars-$v := $(value $v))
        $(eval saved-vars-$v := $(foreach o,$($v), \
            $(if $($o-cflags), $o-cflags $(eval save-vars-$o-cflags := $($o-cflags))$(eval $o-cflags := )) \
            $(if $($o-libs), $o-libs $(eval save-vars-$o-libs := $($o-libs))$(eval $o-libs := )) \
            $(if $($o-objs), $o-objs $(eval save-vars-$o-objs := $($o-objs))$(eval $o-objs := ))))
        $(eval $v := ))
endef

# load-vars
# Usage: $(call load-vars, vars, add_var)
# Load the saved value for each variable in @vars, and the per object
# variables.
# Append @add_var's current value to the loaded value.
define load-vars
    $(eval $2-new-value := $(value $2))
    $(foreach v,$1,
        $(eval $v := $(value save-vars-$v))
        $(foreach o,$(saved-vars-$v),
            $(eval $o := $(save-vars-$o)) $(eval save-vars-$o := ))
        $(eval save-vars-$v := )
        $(eval saved-vars-$v := ))
    $(eval $2 := $(value $2) $($2-new-value))
endef

# fix-paths
# Usage: $(call fix-paths, obj_path, src_path, vars)
# Add prefix @obj_path to all objects in @vars, and add prefix @src_path to all
# directories in @vars.
define fix-paths
    $(foreach v,$3,
        $(foreach o,$($v),
            $(if $($o-libs),
                $(eval $1$o-libs := $($o-libs)))
            $(if $($o-cflags),
                $(eval $1$o-cflags := $($o-cflags)))
            $(if $($o-objs),
                $(eval $1$o-objs := $(addprefix $1,$($o-objs)))))
        $(eval $v := $(addprefix $1,$(filter-out %/,$($v))) \
                     $(addprefix $2,$(filter %/,$($v)))))
endef

# unnest-var-recursive
# Usage: $(call unnest-var-recursive, obj_prefix, vars, var)
#
# Unnest @var by including subdir Makefile.objs, while protect others in @vars
# unchanged.
#
# @obj_prefix is the starting point of object path prefix.
#
define unnest-var-recursive
    $(eval dirs := $(sort $(filter %/,$($3))))
    $(eval $3 := $(filter-out %/,$($3)))
    $(foreach d,$(dirs:%/=%),
            $(call save-vars,$2)
            $(eval obj := $(if $1,$1/)$d)
            $(eval -include $(SRC_PATH)/$d/Makefile.objs)
            $(call fix-paths,$(if $1,$1/)$d/,$d/,$2)
            $(call load-vars,$2,$3)
            $(call unnest-var-recursive,$1,$2,$3))
endef

# unnest-vars
# Usage: $(call unnest-vars, obj_prefix, vars)
#
# @obj_prefix: object path prefix, can be empty, or '..', etc. Don't include
# ending '/'.
#
# @vars: the list of variable names to unnest.
#
# This macro will scan subdirectories's Makefile.objs, include them, to build
# up each variable listed in @vars.
#
# Per object and per module cflags and libs are saved with relative path fixed
# as well, those variables include -libs, -cflags and -objs. Items in -objs are
# also fixed to relative path against SRC_PATH plus the prefix @obj_prefix.
#
# All nested variables postfixed by -m in names are treated as DSO variables,
# and will be built as modules, if enabled.
#
# A simple example of the unnest:
#
#     obj_prefix = ..
#     vars = hot cold
#     hot  = fire.o sun.o season/
#     cold = snow.o water/ season/
#
# Unnest through a faked source directory structure:
#
#     SRC_PATH
#        ├── water
#        │   └── Makefile.objs──────────────────┐
#        │       │ hot += steam.o               │
#        │       │ cold += ice.mo               │
#        │       │ ice.mo-libs := -licemaker    │
#        │       │ ice.mo-objs := ice1.o ice2.o │
#        │       └──────────────────────────────┘
#        │
#        └── season
#            └── Makefile.objs──────┐
#                │ hot += summer.o  │
#                │ cold += winter.o │
#                └──────────────────┘
#
# In the end, the result will be:
#
#     hot  = ../fire.o ../sun.o ../season/summer.o
#     cold = ../snow.o ../water/ice.mo ../season/winter.o
#     ../water/ice.mo-libs = -licemaker
#     ../water/ice.mo-objs = ../water/ice1.o ../water/ice2.o
#
# Note that 'hot' didn't include 'season/' in the input, so 'summer.o' is not
# included.
#
define unnest-vars
    # In the case of target build (i.e. $1 == ..), fix path for top level
    # Makefile.objs objects
    $(if $1,$(call fix-paths,$1/,,$2))

    # Descend and include every subdir Makefile.objs
    $(foreach v, $2,
        $(call unnest-var-recursive,$1,$2,$v)
        # Pass the .mo-cflags and .mo-libs along to its member objects
        $(foreach o, $(filter %.mo,$($v)),
            $(foreach p,$($o-objs),
                $(if $($o-cflags), $(eval $p-cflags += $($o-cflags)))
                $(if $($o-libs), $(eval $p-libs += $($o-libs))))))

    # For all %.mo objects that are directly added into -y, just expand them
    $(foreach v,$(filter %-y,$2),
        $(eval $v := $(foreach o,$($v),$(if $($o-objs),$($o-objs),$o))))

    $(foreach v,$(filter %-m,$2),
        # All .o found in *-m variables are single object modules, create .mo
        # for them
        $(foreach o,$(filter %.o,$($v)),
            $(eval $(o:%.o=%.mo)-objs := $o))
        # Now unify .o in -m variable to .mo
        $(eval $v := $($v:%.o=%.mo))
        $(eval modules-m += $($v))

        # For module build, build shared libraries during "make modules"
        # For non-module build, add -m to -y
        $(if $(CONFIG_MODULES),
             $(foreach o,$($v),
                   $(eval $($o-objs): CFLAGS += $(DSO_OBJ_CFLAGS))
                   $(eval $o: $($o-objs)))
             $(eval $(patsubst %-m,%-y,$v) += $($v))
             $(eval modules: $($v:%.mo=%$(DSOSUF))),
             $(eval $(patsubst %-m,%-y,$v) += $(call expand-objs, $($v)))))

    # Post-process all the unnested vars
    $(foreach v,$2,
        $(foreach o, $(filter %.mo,$($v)),
            # Find all the .mo objects in variables and add dependency rules
            # according to .mo-objs. Report error if not set
            $(if $($o-objs),
                $(eval $(o:%.mo=%$(DSOSUF)): module-common.o $($o-objs)),
                $(error $o added in $v but $o-objs is not set)))
        $(shell mkdir -p ./ $(sort $(dir $($v))))
        # Include all the .d files
        $(eval -include $(patsubst %.o,%.d,$(patsubst %.mo,%.d,$($v))))
        $(eval $v := $(filter-out %/,$($v))))
endef

TEXI2MAN = $(call quiet-command, \
	perl -Ww -- $(SRC_PATH)/scripts/texi2pod.pl $(TEXI2PODFLAGS) $< $@.pod && \
	$(POD2MAN) --section=$(subst .,,$(suffix $@)) --center=" " --release=" " $@.pod > $@, \
	"GEN","$@")

%.1:
	$(call TEXI2MAN)
%.7:
	$(call TEXI2MAN)
%.8:
	$(call TEXI2MAN)
Commit	Line	Data
17759187	1
2f4e4dc2 FZ	2	COMMA := ,
2f4e4dc2 FZ	3
5ab28867 JQ	4	# Don't use implicit rules or variables
	5	# we have explicit rules for everything
	6	MAKEFLAGS += -rR
	7
	8	# Files with this suffixes are final, don't try to generate them
	9	# using implicit rules
a273f4ce PB	10	%/trace-events:
	11	%.hx:
	12	%.py:
	13	%.objs:
5ab28867 JQ	14	%.d:
	15	%.h:
	16	%.c:
c3dc9fd5	17	%.cc:
83f73fce	18	%.cpp:
5ab28867 JQ	19	%.m:
5ab28867 JQ	20	%.mak:
dced7eec	21	clean-target:
5ab28867	22
7ebf54bc	23	# Flags for dependency generation
998b7b1d	24	QEMU_DGFLAGS += -MMD -MP -MT $@ -MF $(@D)/$(*F).d
02d5467e	25
ba78db44 DB	26	# Compiler searches the source file dir first, but in vpath builds
	27	# we need to make it search the build dir too, before any other
	28	# explicit search paths. There are two search locations in the build
	29	# dir, one absolute and the other relative to the compiler working
	30	# directory. These are the same for target-independent files, but
	31	# different for target-dependent ones.
	32	QEMU_LOCAL_INCLUDES = -I$(BUILD_DIR)/$(@D) -I$(@D)
9d9199a0	33
c261d774	34	WL_U := -Wl,-u,
4852ee95	35	find-symbols = $(if $1, $(sort $(shell $(NM) -P -g $1 \| $2)))
c261d774 FZ	36	defined-symbols = $(call find-symbols,$1,awk '$$2!="U"{print $$1}')
	37	undefined-symbols = $(call find-symbols,$1,awk '$$2=="U"{print $$1}')
	38
	39	# All the .mo objects in -m variables are also added into corresponding -y
	40	# variable in unnest-vars, but filtered out here, when LINK is called.
	41	#
	42	# The .mo objects are supposed to be linked as a DSO, for module build. So here
	43	# they are only used as a placeholders to generate those "archive undefined"
	44	# symbol options (-Wl,-u,$symbol_name), which are the archive functions
	45	# referenced by the code in the DSO.
	46	#
	47	# Also the presence in -y variables will also guarantee they are built before
	48	# linking executables that will load them. So we can look up symbol reference
	49	# in LINK.
	50	#
	51	# This is necessary because the exectuable itself may not use the function, in
	52	# which case the function would not be linked in. Then the DSO loading will
	53	# fail because of the missing symbol.
	54	process-archive-undefs = $(filter-out %.a %.mo,$1) \
	55	$(addprefix $(WL_U), \
	56	$(filter $(call defined-symbols,$(filter %.a, $1)), \
	57	$(call undefined-symbols,$(filter %.mo,$1)))) \
	58	$(filter %.a,$1)
	59
5b1b6dbd	60	extract-libs = $(strip $(foreach o,$(filter-out %.mo,$1),$($o-libs)))
17969268 FZ	61	expand-objs = $(strip $(sort $(filter %.o,$1)) \
	62	$(foreach o,$(filter %.mo,$1),$($o-objs)) \
	63	$(filter-out %.o %.mo,$1))
5c0d52bc	64
0e8c9214	65	%.o: %.c
ba78db44 DB	66	$(call quiet-command,$(CC) $(QEMU_LOCAL_INCLUDES) $(QEMU_INCLUDES) \
	67	$(QEMU_CFLAGS) $(QEMU_DGFLAGS) $(CFLAGS) $($@-cflags) \
	68	-c -o $@ $<,"CC","$(TARGET_DIR)$@")
6821cdc7	69	%.o: %.rc
0bdb12c7	70	$(call quiet-command,$(WINDRES) -I. -o $@ $<,"RC","$(TARGET_DIR)$@")
17759187	71
3144f78b PM	72	# If we have a CXX we might have some C++ objects, in which case we
	73	# must link with the C++ compiler, not the plain C compiler.
	74	LINKPROG = $(or $(CXX),$(CC))
	75
1c33ac57	76	LINK = $(call quiet-command, $(LINKPROG) $(QEMU_CFLAGS) $(CFLAGS) $(LDFLAGS) -o $@ \
c261d774	77	$(call process-archive-undefs, $1) \
0bdb12c7	78	$(version-obj-y) $(call extract-libs,$1) $(LIBS),"LINK","$(TARGET_DIR)$@")
44dc0ca3	79
5f6f0e27	80	%.o: %.S
ba78db44 DB	81	$(call quiet-command,$(CCAS) $(QEMU_LOCAL_INCLUDES) $(QEMU_INCLUDES) \
	82	$(QEMU_CFLAGS) $(QEMU_DGFLAGS) $(CFLAGS) \
	83	-c -o $@ $<,"CCAS","$(TARGET_DIR)$@")
17759187	84
c3dc9fd5	85	%.o: %.cc
ba78db44 DB	86	$(call quiet-command,$(CXX) $(QEMU_LOCAL_INCLUDES) $(QEMU_INCLUDES) \
	87	$(QEMU_CXXFLAGS) $(QEMU_DGFLAGS) $(CFLAGS) $($@-cflags) \
	88	-c -o $@ $<,"CXX","$(TARGET_DIR)$@")
c3dc9fd5	89
83f73fce	90	%.o: %.cpp
ba78db44 DB	91	$(call quiet-command,$(CXX) $(QEMU_LOCAL_INCLUDES) $(QEMU_INCLUDES) \
	92	$(QEMU_CXXFLAGS) $(QEMU_DGFLAGS) $(CFLAGS) $($@-cflags) \
	93	-c -o $@ $<,"CXX","$(TARGET_DIR)$@")
83f73fce	94
17759187	95	%.o: %.m
ba78db44 DB	96	$(call quiet-command,$(OBJCC) $(QEMU_LOCAL_INCLUDES) $(QEMU_INCLUDES) \
	97	$(QEMU_CFLAGS) $(QEMU_DGFLAGS) $(CFLAGS) $($@-cflags) \
	98	-c -o $@ $<,"OBJC","$(TARGET_DIR)$@")
17759187	99
2c13ec50	100	%.o: %.dtrace
0bdb12c7	101	$(call quiet-command,dtrace -o $@ -G -s $<,"GEN","$(TARGET_DIR)$@")
2c13ec50	102
d24697e1 FZ	103	DSO_OBJ_CFLAGS := -fPIC -DBUILD_DSO
d24697e1 FZ	104	module-common.o: CFLAGS += $(DSO_OBJ_CFLAGS)
17969268	105	%$(DSOSUF): LDFLAGS += $(LDFLAGS_SHARED)
c261d774	106	%$(DSOSUF): %.mo
17969268	107	$(call LINK,$^)
e26110cf	108	@# Copy to build root so modules can be loaded when program started without install
0bdb12c7	109	$(if $(findstring /,$@),$(call quiet-command,cp $@ $(subst /,-,$@),"CP","$(subst /,-,$@)"))
17969268	110
c261d774	111
7ecf44a5	112	LD_REL := $(CC) -nostdlib $(LD_REL_FLAGS)
c261d774 FZ	113
c261d774 FZ	114	%.mo:
0bdb12c7	115	$(call quiet-command,$(LD_REL) -o $@ $^,"LD","$(TARGET_DIR)$@")
c261d774	116
17969268 FZ	117	.PHONY: modules
	118	modules:
	119
3aa892d7	120	%$(EXESUF): %.o
cefa2bbd	121	$(call LINK,$(filter %.o %.a %.mo, $^))
4f188f88	122
93a0dba7	123	%.a:
0bdb12c7	124	$(call quiet-command,rm -f $@ && $(AR) rcs $@ $^,"AR","$(TARGET_DIR)$@")
93a0dba7	125
0bdb12c7 PM	126	# Usage: $(call quiet-command,command and args,"NAME","args to print")
	127	# This will run "command and args", and either:
	128	# if V=1 just print the whole command and args
	129	# otherwise print the 'quiet' output in the format " NAME args to print"
	130	# NAME should be a short name of the command, 7 letters or fewer.
	131	# If called with only a single argument, will print nothing in quiet mode.
	132	quiet-command = $(if $(V),$1,$(if $(2),@printf " %-7s %s\n" $2 $3 && $1, @$1))
70071e17 JQ	133
70071e17 JQ	134	# cc-option
8a2e6ab5	135	# Usage: CFLAGS+=$(call cc-option, -falign-functions=0, -malign-functions=0)
70071e17	136
fc3baad7 TM	137	cc-option = $(if $(shell $(CC) $1 $2 -S -o /dev/null -xc /dev/null \
fc3baad7 TM	138	>/dev/null 2>&1 && echo OK), $2, $3)
036999e9 PB	139	cc-c-option = $(if $(shell $(CC) $1 $2 -c -o /dev/null -xc /dev/null \
036999e9 PB	140	>/dev/null 2>&1 && echo OK), $2, $3)
1215c6e7	141
c3dc9fd5	142	VPATH_SUFFIXES = %.c %.h %.S %.cc %.cpp %.m %.mak %.texi %.sh %.rc
288e7bcc	143	set-vpath = $(if $1,$(foreach PATTERN,$(VPATH_SUFFIXES),$(eval vpath $(PATTERN) $1)))
076d2471	144
0d659426 MT	145	# install-prog list, dir
	146	define install-prog
	147	$(INSTALL_DIR) "$2"
	148	$(INSTALL_PROG) $1 "$2"
	149	$(if $(STRIP),$(STRIP) $(foreach T,$1,"$2/$(notdir $T)"),)
	150	endef
	151
2b2e59e6 PB	152	# find-in-path
	153	# Usage: $(call find-in-path, prog)
	154	# Looks in the PATH if the argument contains no slash, else only considers one
	155	# specific directory. Returns an # empty string if the program doesn't exist
	156	# there.
88071589	157	find-in-path = $(if $(findstring /, $1), \
2b2e59e6 PB	158	$(wildcard $1), \
	159	$(wildcard $(patsubst %, %/$1, $(subst :, ,$(PATH)))))
	160
837a2e26 PM	161	# Logical functions (for operating on y/n values like CONFIG_FOO vars)
	162	# Inputs to these must be either "y" (true) or "n" or "" (both false)
	163	# Output is always either "y" or "n".
	164	# Usage: $(call land,$(CONFIG_FOO),$(CONFIG_BAR))
	165	# Logical NOT
	166	lnot = $(if $(subst n,,$1),n,y)
	167	# Logical AND
	168	land = $(if $(findstring yy,$1$2),y,n)
	169	# Logical OR
	170	lor = $(if $(findstring y,$1$2),y,n)
	171	# Logical XOR (note that this is the inverse of leqv)
	172	lxor = $(if $(filter $(call lnot,$1),$(call lnot,$2)),n,y)
	173	# Logical equivalence (note that leqv "","n" is true)
	174	leqv = $(if $(filter $(call lnot,$1),$(call lnot,$2)),y,n)
	175	# Logical if: like make's $(if) but with an leqv-like test
	176	lif = $(if $(subst n,,$1),$2,$3)
	177
9ef622e3 PM	178	# String testing functions: inputs to these can be any string;
	179	# the output is always either "y" or "n". Leading and trailing whitespace
	180	# is ignored when comparing strings.
	181	# String equality
	182	eq = $(if $(subst $2,,$1)$(subst $1,,$2),n,y)
	183	# String inequality
	184	ne = $(if $(subst $2,,$1)$(subst $1,,$2),y,n)
	185	# Emptiness/non-emptiness tests:
	186	isempty = $(if $1,n,y)
	187	notempty = $(if $1,y,n)
	188
c0424934 LV	189	# Generate files with tracetool
	190	TRACETOOL=$(PYTHON) $(SRC_PATH)/scripts/tracetool.py
	191
1215c6e7 JQ	192	# Generate timestamp files for .h include files
1215c6e7 JQ	193
4b25966a MT	194	config-%.h: config-%.h-timestamp
4b25966a MT	195	@cmp $< $@ >/dev/null 2>&1 \|\| cp $< $@
1215c6e7	196
55335015	197	config-%.h-timestamp: config-%.mak $(SRC_PATH)/scripts/create_config
0bdb12c7	198	$(call quiet-command, sh $(SRC_PATH)/scripts/create_config < $< > $@,"GEN","$(TARGET_DIR)config-$*.h")
7dbbbb0c	199
7586317b MT	200	.PHONY: clean-timestamp
	201	clean-timestamp:
	202	rm -f *.timestamp
	203	clean: clean-timestamp
	204
7dbbbb0c MT	205	# will delete the target of a rule if commands exit with a nonzero exit status
7dbbbb0c MT	206	.DELETE_ON_ERROR:
e05804ee	207
1c33ac57 FZ	208	# save-vars
	209	# Usage: $(call save-vars, vars)
	210	# Save each variable $v in $vars as save-vars-$v, save their object's
5ffb3505 PB	211	# variables, then clear $v. saved-vars-$v contains the variables that
5ffb3505 PB	212	# where saved for the objects, in order to speedup load-vars.
1c33ac57 FZ	213	define save-vars
	214	$(foreach v,$1,
	215	$(eval save-vars-$v := $(value $v))
5ffb3505 PB	216	$(eval saved-vars-$v := $(foreach o,$($v), \
	217	$(if $($o-cflags), $o-cflags $(eval save-vars-$o-cflags := $($o-cflags))$(eval $o-cflags := )) \
	218	$(if $($o-libs), $o-libs $(eval save-vars-$o-libs := $($o-libs))$(eval $o-libs := )) \
	219	$(if $($o-objs), $o-objs $(eval save-vars-$o-objs := $($o-objs))$(eval $o-objs := ))))
1c33ac57	220	$(eval $v := ))
5c0d52bc FZ	221	endef
5c0d52bc FZ	222
1c33ac57 FZ	223	# load-vars
	224	# Usage: $(call load-vars, vars, add_var)
	225	# Load the saved value for each variable in @vars, and the per object
	226	# variables.
	227	# Append @add_var's current value to the loaded value.
	228	define load-vars
	229	$(eval $2-new-value := $(value $2))
	230	$(foreach v,$1,
	231	$(eval $v := $(value save-vars-$v))
5ffb3505 PB	232	$(foreach o,$(saved-vars-$v),
	233	$(eval $o := $(save-vars-$o)) $(eval save-vars-$o := ))
	234	$(eval save-vars-$v := )
	235	$(eval saved-vars-$v := ))
1c33ac57	236	$(eval $2 := $(value $2) $($2-new-value))
e05804ee PB	237	endef
e05804ee PB	238
1c33ac57 FZ	239	# fix-paths
	240	# Usage: $(call fix-paths, obj_path, src_path, vars)
	241	# Add prefix @obj_path to all objects in @vars, and add prefix @src_path to all
	242	# directories in @vars.
	243	define fix-paths
	244	$(foreach v,$3,
	245	$(foreach o,$($v),
	246	$(if $($o-libs),
	247	$(eval $1$o-libs := $($o-libs)))
	248	$(if $($o-cflags),
	249	$(eval $1$o-cflags := $($o-cflags)))
	250	$(if $($o-objs),
	251	$(eval $1$o-objs := $(addprefix $1,$($o-objs)))))
	252	$(eval $v := $(addprefix $1,$(filter-out %/,$($v))) \
	253	$(addprefix $2,$(filter %/,$($v)))))
e05804ee PB	254	endef
e05804ee PB	255
1c33ac57 FZ	256	# unnest-var-recursive
	257	# Usage: $(call unnest-var-recursive, obj_prefix, vars, var)
	258	#
	259	# Unnest @var by including subdir Makefile.objs, while protect others in @vars
	260	# unchanged.
	261	#
	262	# @obj_prefix is the starting point of object path prefix.
	263	#
	264	define unnest-var-recursive
	265	$(eval dirs := $(sort $(filter %/,$($3))))
	266	$(eval $3 := $(filter-out %/,$($3)))
	267	$(foreach d,$(dirs:%/=%),
	268	$(call save-vars,$2)
	269	$(eval obj := $(if $1,$1/)$d)
	270	$(eval -include $(SRC_PATH)/$d/Makefile.objs)
	271	$(call fix-paths,$(if $1,$1/)$d/,$d/,$2)
	272	$(call load-vars,$2,$3)
	273	$(call unnest-var-recursive,$1,$2,$3))
17969268 FZ	274	endef
17969268 FZ	275
1c33ac57 FZ	276	# unnest-vars
	277	# Usage: $(call unnest-vars, obj_prefix, vars)
	278	#
	279	# @obj_prefix: object path prefix, can be empty, or '..', etc. Don't include
	280	# ending '/'.
	281	#
	282	# @vars: the list of variable names to unnest.
	283	#
	284	# This macro will scan subdirectories's Makefile.objs, include them, to build
	285	# up each variable listed in @vars.
	286	#
	287	# Per object and per module cflags and libs are saved with relative path fixed
	288	# as well, those variables include -libs, -cflags and -objs. Items in -objs are
	289	# also fixed to relative path against SRC_PATH plus the prefix @obj_prefix.
	290	#
	291	# All nested variables postfixed by -m in names are treated as DSO variables,
	292	# and will be built as modules, if enabled.
	293	#
	294	# A simple example of the unnest:
	295	#
	296	# obj_prefix = ..
	297	# vars = hot cold
	298	# hot = fire.o sun.o season/
	299	# cold = snow.o water/ season/
	300	#
	301	# Unnest through a faked source directory structure:
	302	#
	303	# SRC_PATH
	304	# ├── water
	305	# │ └── Makefile.objs──────────────────┐
	306	# │ │ hot += steam.o │
	307	# │ │ cold += ice.mo │
	308	# │ │ ice.mo-libs := -licemaker │
	309	# │ │ ice.mo-objs := ice1.o ice2.o │
	310	# │ └──────────────────────────────┘
	311	# │
	312	# └── season
	313	# └── Makefile.objs──────┐
	314	# │ hot += summer.o │
	315	# │ cold += winter.o │
	316	# └──────────────────┘
	317	#
	318	# In the end, the result will be:
	319	#
	320	# hot = ../fire.o ../sun.o ../season/summer.o
	321	# cold = ../snow.o ../water/ice.mo ../season/winter.o
	322	# ../water/ice.mo-libs = -licemaker
	323	# ../water/ice.mo-objs = ../water/ice1.o ../water/ice2.o
	324	#
	325	# Note that 'hot' didn't include 'season/' in the input, so 'summer.o' is not
	326	# included.
	327	#
e05804ee	328	define unnest-vars
1c33ac57 FZ	329	# In the case of target build (i.e. $1 == ..), fix path for top level
	330	# Makefile.objs objects
	331	$(if $1,$(call fix-paths,$1/,,$2))
	332
	333	# Descend and include every subdir Makefile.objs
c88f68ec FZ	334	$(foreach v, $2,
	335	$(call unnest-var-recursive,$1,$2,$v)
	336	# Pass the .mo-cflags and .mo-libs along to its member objects
	337	$(foreach o, $(filter %.mo,$($v)),
	338	$(foreach p,$($o-objs),
	339	$(if $($o-cflags), $(eval $p-cflags += $($o-cflags)))
	340	$(if $($o-libs), $(eval $p-libs += $($o-libs))))))
	341
	342	# For all %.mo objects that are directly added into -y, just expand them
	343	$(foreach v,$(filter %-y,$2),
	344	$(eval $v := $(foreach o,$($v),$(if $($o-objs),$($o-objs),$o))))
1c33ac57 FZ	345
	346	$(foreach v,$(filter %-m,$2),
	347	# All .o found in *-m variables are single object modules, create .mo
	348	# for them
	349	$(foreach o,$(filter %.o,$($v)),
	350	$(eval $(o:%.o=%.mo)-objs := $o))
	351	# Now unify .o in -m variable to .mo
	352	$(eval $v := $($v:%.o=%.mo))
	353	$(eval modules-m += $($v))
	354
	355	# For module build, build shared libraries during "make modules"
	356	# For non-module build, add -m to -y
	357	$(if $(CONFIG_MODULES),
c261d774	358	$(foreach o,$($v),
d24697e1	359	$(eval $($o-objs): CFLAGS += $(DSO_OBJ_CFLAGS))
c261d774 FZ	360	$(eval $o: $($o-objs)))
c261d774 FZ	361	$(eval $(patsubst %-m,%-y,$v) += $($v))
1c33ac57 FZ	362	$(eval modules: $($v:%.mo=%$(DSOSUF))),
	363	$(eval $(patsubst %-m,%-y,$v) += $(call expand-objs, $($v)))))
	364
	365	# Post-process all the unnested vars
	366	$(foreach v,$2,
	367	$(foreach o, $(filter %.mo,$($v)),
	368	# Find all the .mo objects in variables and add dependency rules
	369	# according to .mo-objs. Report error if not set
	370	$(if $($o-objs),
	371	$(eval $(o:%.mo=%$(DSOSUF)): module-common.o $($o-objs)),
c88f68ec	372	$(error $o added in $v but $o-objs is not set)))
1c33ac57 FZ	373	$(shell mkdir -p ./ $(sort $(dir $($v))))
1c33ac57 FZ	374	# Include all the .d files
27fa7479	375	$(eval -include $(patsubst %.o,%.d,$(patsubst %.mo,%.d,$($v))))
1c33ac57	376	$(eval $v := $(filter-out %/,$($v))))
e05804ee	377	endef
76480423 MAL	378
76480423 MAL	379	TEXI2MAN = $(call quiet-command, \
d59157ea	380	perl -Ww -- $(SRC_PATH)/scripts/texi2pod.pl $(TEXI2PODFLAGS) $< $@.pod && \
76480423 MAL	381	$(POD2MAN) --section=$(subst .,,$(suffix $@)) --center=" " --release=" " $@.pod > $@, \
	382	"GEN","$@")
	383
	384	%.1:
	385	$(call TEXI2MAN)
56e8bdd4 MAL	386	%.7:
56e8bdd4 MAL	387	$(call TEXI2MAN)
76480423 MAL	388	%.8:
76480423 MAL	389	$(call TEXI2MAN)