sphinx/qapidoc: Do not emit TODO sections into user manuals
[qemu/armbru.git] / tests / tcg / Makefile.target
blob72876cc84e5a1c2a88d2b760d059af8ff91c9dfc
1 # -*- Mode: makefile -*-
3 # TCG tests
5 # These are complicated by the fact we want to build them for guest
6 # systems. This requires knowing what guests we are building and which
7 # ones we have cross-compilers for or docker images with
8 # cross-compilers.
10 # The tests themselves should be as minimal as possible as
11 # cross-compilers don't always have a large amount of libraries
12 # available.
14 # We only include the host build system for SRC_PATH and we don't
15 # bother with the common rules.mk. We expect the following:
17 #   CC - the C compiler command
18 #   EXTRA_CFLAGS - any extra CFLAGS
19 #   BUILD_STATIC - are we building static binaries
21 # By default all tests are statically compiled but some host systems
22 # may not package static libraries by default. If an external
23 # cross-compiler can only build dynamic libraries the user might need
24 # to make extra efforts to ensure ld.so can link at runtime when the
25 # tests are run.
27 # We also accept SPEED=slow to enable slower running tests
29 # We also expect to be in the tests build dir for the FOO-(linux-user|softmmu).
32 all:
33 -include ../config-host.mak
34 -include config-target.mak
36 # Get semihosting definitions for user-mode emulation
37 ifeq ($(filter %-softmmu, $(TARGET)),)
38 -include $(SRC_PATH)/configs/targets/$(TARGET).mak
39 endif
41 # for including , in command strings
42 COMMA := ,
43 NULL :=
44 SPACE := $(NULL) #
45 TARGET_PREFIX=tests/tcg/$(TARGET):$(SPACE)
47 quiet-@ = $(if $(V),,@$(if $1,printf "  %-7s %s\n" "$(strip $1)" "$(strip $2)" && ))
48 quiet-command = $(call quiet-@,$2,$3)$1
50 cc-test = $(CC) -Werror $1 -c -o /dev/null -xc /dev/null >/dev/null 2>&1
51 cc-option = if $(call cc-test, $1); then \
52     echo "$(TARGET_PREFIX)$1 detected" && echo "$(strip $2)=y" >&3; else \
53     echo "$(TARGET_PREFIX)$1 not detected"; fi
55 # $1 = test name, $2 = cmd, $3 = desc
56 ifeq ($(filter %-softmmu, $(TARGET)),)
57 run-test = $(call quiet-command, timeout -s KILL --foreground $(TIMEOUT) $2 > $1.out, \
58         TEST,$(or $3, $*, $<) on $(TARGET_NAME))
59 else
60 run-test = $(call quiet-command, timeout -s KILL --foreground $(TIMEOUT) $2, \
61         TEST,$(or $3, $*, $<) on $(TARGET_NAME))
62 endif
64 # $1 = test name, $2 = reference
65 # to work around the pipe squashing the status we only pipe the result if
66 # we know it failed and then force failure at the end.
67 diff-out = $(call quiet-command, diff -q $1.out $2 || \
68                                  (diff -u $1.out $2 | head -n 10 && false), \
69                                  DIFF,$1.out with $2)
71 # $1 = test name, $2 = reason
72 skip-test = @printf "  SKIPPED %s on $(TARGET_NAME) because %s\n" $1 $2
74 # $1 = test name, $2 = reference
75 # As above but only diff if reference file exists, otherwise the test
76 # passes if it managed to complete with a status of zero
77 conditional-diff-out =                                                  \
78         $(if $(wildcard $2),                                            \
79                 $(call diff-out,$1,$2),                                 \
80                 $(call skip-test,"$1 check","no reference"))
83 # Tests we are building
84 TESTS=
85 # additional tests which may re-use existing binaries
86 EXTRA_TESTS=
88 # Start with a blank slate, the build targets get to add stuff first
89 CFLAGS=
90 LDFLAGS=
92 QEMU_OPTS=
95 # If TCG debugging, or TCI is enabled things are a lot slower
96 # ??? Makefile no longer has any indication that TCI is enabled,
97 # but for the record:
98 #   15s    original default
99 #   60s    with --enable-debug
100 #   90s    with --enable-tcg-interpreter
101 TIMEOUT=90
103 ifeq ($(filter %-softmmu, $(TARGET)),)
104 # The order we include is important. We include multiarch first and
105 # then the target. If there are common tests shared between
106 # sub-targets (e.g. ARM & AArch64) then it is up to
107 # $(TARGET_NAME)/Makefile.target to include the common parent
108 # architecture in its VPATH.
109 -include $(SRC_PATH)/tests/tcg/multiarch/Makefile.target
110 -include $(SRC_PATH)/tests/tcg/$(TARGET_NAME)/Makefile.target
112 # Add the common build options
113 CFLAGS+=-Wall -Werror -O0 -g -fno-strict-aliasing
114 ifeq ($(BUILD_STATIC),y)
115 LDFLAGS+=-static
116 endif
118 %: %.c
119         $(CC) $(CFLAGS) $(EXTRA_CFLAGS) $< -o $@ $(LDFLAGS)
120 %: %.S
121         $(CC) $(CFLAGS) $(EXTRA_CFLAGS) $< -o $@ $(LDFLAGS)
122 else
123 # For softmmu targets we include a different Makefile fragement as the
124 # build options for bare programs are usually pretty different. They
125 # are expected to provide their own build recipes.
126 EXTRA_CFLAGS += -ffreestanding
127 -include $(SRC_PATH)/tests/tcg/minilib/Makefile.target
128 -include $(SRC_PATH)/tests/tcg/multiarch/system/Makefile.softmmu-target
129 -include $(SRC_PATH)/tests/tcg/$(TARGET_NAME)/Makefile.softmmu-target
131 endif
133 all: $(TESTS) $(EXTRA_TESTS)
136 # Test Runners
138 # By default we just run the test with the appropriate QEMU for the
139 # target. More advanced tests may want to override the runner in their
140 # specific make rules. Additional runners for the same binary should
141 # be added to EXTRA_RUNS.
144 RUN_TESTS=$(patsubst %,run-%, $(TESTS))
146 # If plugins exist also include those in the tests
147 ifeq ($(CONFIG_PLUGIN),y)
148 PLUGIN_SRC=$(SRC_PATH)/tests/plugin
149 PLUGIN_LIB=../../plugin
150 VPATH+=$(PLUGIN_LIB)
151 PLUGINS=$(patsubst %.c, lib%.so, $(notdir $(wildcard $(PLUGIN_SRC)/*.c)))
153 # We need to ensure expand the run-plugin-TEST-with-PLUGIN
154 # pre-requistes manually here as we can't use stems to handle it. We
155 # only expand MULTIARCH_TESTS which are common on most of our targets
156 # to avoid an exponential explosion as new tests are added. We also
157 # add some special helpers the run-plugin- rules can use bellow.
159 ifneq ($(MULTIARCH_TESTS),)
160 $(foreach p,$(PLUGINS), \
161         $(foreach t,$(MULTIARCH_TESTS),\
162                 $(eval run-plugin-$(t)-with-$(p): $t $p) \
163                 $(eval RUN_TESTS+=run-plugin-$(t)-with-$(p))))
164 endif # MULTIARCH_TESTS
165 endif # CONFIG_PLUGIN
167 strip-plugin = $(wordlist 1, 1, $(subst -with-, ,$1))
168 extract-plugin = $(wordlist 2, 2, $(subst -with-, ,$1))
170 RUN_TESTS+=$(EXTRA_RUNS)
172 ifeq ($(filter %-softmmu, $(TARGET)),)
173 run-%: %
174         $(call run-test, $<, $(QEMU) $(QEMU_OPTS) $<)
176 run-plugin-%:
177         $(call run-test, $@, $(QEMU) $(QEMU_OPTS) \
178                 -plugin $(PLUGIN_LIB)/$(call extract-plugin,$@) \
179                 -d plugin -D $*.pout \
180                  $(call strip-plugin,$<))
181 else
182 run-%: %
183         $(call run-test, $<, \
184           $(QEMU) -monitor none -display none \
185                   -chardev file$(COMMA)path=$<.out$(COMMA)id=output \
186                   $(QEMU_OPTS) $<)
188 run-plugin-%:
189         $(call run-test, $@, \
190           $(QEMU) -monitor none -display none \
191                   -chardev file$(COMMA)path=$@.out$(COMMA)id=output \
192                   -plugin $(PLUGIN_LIB)/$(call extract-plugin,$@) \
193                   -d plugin -D $*.pout \
194                   $(QEMU_OPTS) $(call strip-plugin,$<))
195 endif
197 gdb-%: %
198         gdb --args $(QEMU) $(QEMU_OPTS) $<
200 .PHONY: run
201 run: $(RUN_TESTS)
203 clean:
204         rm -f $(TESTS) *.o $(CLEANFILES)
206 distclean:
207         rm -f config-cc.mak config-target.mak ../config-$(TARGET).mak
209 .PHONY: help
210 help:
211         @echo "TCG tests help $(TARGET_NAME)"
212         @echo "Built with $(CC)"
213         @echo "Available tests:"
214         @$(foreach t,$(RUN_TESTS),echo "  $t";)