1 # Makefile for regression testing the GNU debugger.
2 # Copyright 1992-2024 Free Software Foundation, Inc.
4 # This file is part of GDB.
6 # This program is free software; you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 3 of the License, or
9 # (at your option) any later version.
11 # This program is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 # GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License
17 # along with this program. If not, see <http://www.gnu.org/licenses/>.
22 exec_prefix = @
exec_prefix@
23 abs_builddir
= @abs_builddir@
24 abs_srcdir
= @abs_srcdir@
26 target_alias
= @target_noncanonical@
27 program_transform_name
= @program_transform_name@
28 build_canonical
= @build@
29 host_canonical
= @host@
30 target_canonical
= @target@
31 enable_libctf
= @enable_libctf@
36 RPATH_ENVVAR
= @RPATH_ENVVAR@
40 EXPECT
= `if [ "$${READ1}" != "" ] ; then \
41 echo $${rootme}/expect-read1; \
42 elif [ "$${READMORE}" != "" ] ; then \
43 echo $${rootme}/expect-readmore; \
44 elif [ -f $${rootme}/../../expect/expect ] ; then \
45 echo $${rootme}/../../expect/expect ; \
50 RUNTEST
= $(RUNTEST_FOR_TARGET
)
59 # Default number of iterations that we will use to run the testsuite
60 # if the user does not specify the RACY_ITER environment variable
61 # (e.g., when the user calls the make rule directly from the command
65 RUNTEST_FOR_TARGET
= `\
66 if [ -f $${srcdir}/../../dejagnu/runtest ]; then \
67 echo $${srcdir}/../../dejagnu/runtest; \
69 if [ "$(host_canonical)" = "$(target_canonical)" ]; then \
72 t='$(program_transform_name)'; echo runtest | sed -e $$t; \
76 #### host, target, and site specific Makefile frags come in here.
78 # The use of $$(x_FOR_TARGET) reduces the command line length by not
79 # duplicating the lengthy definition.
81 TARGET_FLAGS_TO_PASS
= \
83 "exec_prefix=$(exec_prefix)" \
84 "against=$(against)" \
85 'CC=$$(CC_FOR_TARGET)' \
86 "CC_FOR_TARGET=$(CC_FOR_TARGET)" \
87 "CFLAGS=$(TESTSUITE_CFLAGS)" \
88 'CXX=$$(CXX_FOR_TARGET)' \
89 "CXX_FOR_TARGET=$(CXX_FOR_TARGET)" \
90 "CXXFLAGS=$(CXXFLAGS)" \
91 "MAKEINFO=$(MAKEINFO)" \
92 "INSTALL=$(INSTALL)" \
93 "INSTALL_PROGRAM=$(INSTALL_PROGRAM)" \
94 "INSTALL_DATA=$(INSTALL_DATA)" \
95 "LDFLAGS=$(LDFLAGS)" \
97 "RUNTEST=$(RUNTEST)" \
98 "RUNTESTFLAGS=$(RUNTESTFLAGS)"
117 # Use absolute `site.exp' path everywhere to suppress VPATH lookups for it.
118 # Bare `site.exp' is used as a target here if user requests it explicitly.
119 # $(RUNTEST) is looking up `site.exp' only in the current directory.
121 $(abs_builddir
)/site.exp site.exp
: Makefile
125 mv site.exp site.bak
; \
126 echo
"## these variables are automatically generated by make ##" > .
/tmp0
; \
127 echo
"# Do not edit here. If you wish to override these values" >> .
/tmp0
; \
128 echo
"# add them to the last section" >> .
/tmp0
; \
129 echo
"set host_triplet ${host_canonical}" >> .
/tmp0
; \
130 echo
"set target_alias $(target_alias)" >> .
/tmp0
; \
131 echo
"set target_triplet ${target_canonical}" >> .
/tmp0
; \
132 echo
"set build_triplet ${build_canonical}" >> .
/tmp0
; \
133 echo
"set srcdir ${abs_srcdir}" >> .
/tmp0
; \
134 echo
"set tool gdb" >> .
/tmp0
; \
135 echo
"set enable_libctf ${enable_libctf}" >> .
/tmp0
; \
136 echo
'source $${srcdir}/lib/append_gdb_boards_dir.exp' >> .
/tmp0
; \
137 echo
"## All variables above are generated by configure. Do Not Edit ##" >> .
/tmp0
; \
138 cat .
/tmp0
> site.exp
; \
140 -e
'1,/^## All variables above are.*##/ d' >> site.exp
; \
145 # See whether -j was given to make. Before GNU make 4.2, either it was
146 # given with no arguments, and appears as "j" in the first word, or it was
147 # given an argument and appears as "-j" in a separate word. Starting with
148 # GNU make 4.2, it always appears as "-j"/"-jN" in a separate word.
149 saw_dash_j
= $(or
$(findstring j
,$(firstword $(MAKEFLAGS
))),$(filter -j
%,$(MAKEFLAGS
)))
151 # Try to run the tests in parallel if any -j option is given. If RUNTESTFLAGS
152 # is not empty, then by default the tests will be serialized. This can be
153 # overridden by setting FORCE_PARALLEL to any non-empty value.
154 CHECK_TARGET_TMP
= $(if
$(FORCE_PARALLEL
),check-parallel
,$(if
$(RUNTESTFLAGS
),check-single
,$(if
$(saw_dash_j
),check-parallel
,check-single
)))
155 CHECK_TARGET
= $(if
$(RACY_ITER
),$(addsuffix -racy
,$(CHECK_TARGET_TMP
)),$(CHECK_TARGET_TMP
))
157 # Note that we must resort to a recursive make invocation here,
158 # because GNU make 3.82 has a bug preventing MAKEFLAGS from being used
160 check: all $(abs_builddir
)/site.exp
161 $(MAKE
) $(CHECK_TARGET
)
163 check-read1
: read1.so expect-read1
164 $(MAKE
) READ1
="1" check
166 check-readmore
: readmore.so expect-readmore
167 $(MAKE
) READMORE
="1" check
169 # Check whether we need to print the timestamp for each line of
171 TIMESTAMP
= $(if
$(TS
),|
$(srcdir)/print-ts.py
$(if
$(TS_FORMAT
),$(TS_FORMAT
),),)
173 gdb_debug
= $(if
$(GDB_DEBUG
),GDB_DEBUG
=$(GDB_DEBUG
) ; export GDB_DEBUG
;,)
174 gdbserver_debug
= $(if
$(GDBSERVER_DEBUG
),GDBSERVER_DEBUG
=$(GDBSERVER_DEBUG
) ; export GDBSERVER_DEBUG
;,)
177 # All the hair to invoke dejagnu. A given invocation can just append
180 rootme
=`pwd`; export rootme
; \
181 srcdir=${srcdir} ; export srcdir ; \
182 EXPECT
=${EXPECT} ; export EXPECT
; \
183 EXEEXT
=${EXEEXT} ; export EXEEXT
; $(gdb_debug
) $(gdbserver_debug
) \
184 $(RPATH_ENVVAR
)=$$rootme/..
/..
/expect
:$$rootme/..
/..
/libstdc
++:$$rootme/..
/..
/tk
/unix
:$$rootme/..
/..
/tcl
/unix
:$$rootme/..
/..
/bfd
:$$rootme/..
/..
/opcodes
:$$$(RPATH_ENVVAR
); \
185 export $(RPATH_ENVVAR
); \
186 if
[ -f
$${rootme}/..
/..
/expect
/expect
] ; then \
187 TCL_LIBRARY
=$${srcdir}/..
/..
/tcl
/library
; \
188 export TCL_LIBRARY
; fi
; \
191 # TESTS exists for the user to pass on the command line to easily
192 # say "Only run these tests." With check-single it's not necessary, but
193 # with check-parallel there's no other way to (easily) specify a subset
194 # of tests. For consistency we support it for check-single as well.
195 # To specify all tests in a subdirectory, use TESTS=gdb.subdir/*.exp.
196 # E.g., make check TESTS="gdb.server/*.exp gdb.threads/*.exp".
199 ifeq ($(strip $(TESTS
)),)
200 expanded_tests_or_none
:=
202 expanded_tests
:= $(patsubst $(srcdir)/%,%,$(wildcard $(addprefix $(srcdir)/,$(TESTS
))))
203 expanded_tests_or_none
:= $(or
$(expanded_tests
),no-matching-tests-found
)
206 # With check-single, if TESTS was expanded to "no-matching-tests-found" then
207 # this will be passed to DejaGnu, resuling in an error. With check-parallel
208 # in the same situation, we avoid invoking DejaGnu, and instead just call
209 # the check/no-matching-tests-found rule (which prints a helpful message).
211 # To get the same behaviour for check-single we decide here, based on how
212 # TESTS expanded, whether check-single should redirect to do-check-single or
213 # to check/no-matching-tests-found.
214 ifeq ($(expanded_tests_or_none
),no-matching-tests-found
)
215 CHECK_SINGLE_DEP
=check/no-matching-tests-found
217 CHECK_SINGLE_DEP
=do-check-single
220 # Shorthand for running all the tests in a single directory.
222 $(MAKE
) check TESTS
="gdb.$*/*.exp"
225 -rm -f
*core
* gdb.sum gdb.log
226 $(DO_RUNTEST
) $(RUNTESTFLAGS
) $(expanded_tests_or_none
) $(TIMESTAMP
); \
228 if
test -e gdb.sum
; then \
229 $(SHELL
) $(srcdir)/lib
/dg-add-core-file-count.sh
; \
230 sed
-n
'/=== gdb Summary ===/,$$ p' gdb.sum
; \
234 check-single
: $(CHECK_SINGLE_DEP
)
237 -rm -rf cache racy_outputs temp
238 mkdir
-p racy_outputs
; \
239 racyiter
="$(RACY_ITER)"; \
240 test "x$$racyiter" = "x" && \
241 racyiter
=$(DEFAULT_RACY_ITER
); \
242 if
test $$racyiter -lt
2 ; then \
243 echo
"RACY_ITER must be at least 2."; \
247 for n in
`seq $$racyiter` ; do \
248 mkdir
-p racy_outputs
/$$n; \
249 $(DO_RUNTEST
) --outdir
=racy_outputs
/$$n $(RUNTESTFLAGS
) \
250 $(expanded_tests_or_none
) $(TIMESTAMP
); \
252 $(srcdir)/analyze-racy-logs.py \
253 `ls racy_outputs/*/gdb.sum` > racy.sum
; \
254 sed
-n
'/=== gdb Summary ===/,$$ p' racy.sum
258 -rm -rf cache outputs temp
259 $(MAKE
) -k do-check-parallel
; \
261 if
test -d outputs
; then \
262 $(SHELL
) $(srcdir)/..
/..
/contrib
/dg-extract-results.sh \
263 `find outputs -name gdb.sum -print` > gdb.sum
; \
264 $(SHELL
) $(srcdir)/..
/..
/contrib
/dg-extract-results.sh
-L \
265 `find outputs -name gdb.log -print` > gdb.log
; \
266 $(SHELL
) $(srcdir)/lib
/dg-add-core-file-count.sh
; \
267 sed
-n
'/=== gdb Summary ===/,$$ p' gdb.sum
; \
272 -rm -rf cache racy_outputs temp
273 racyiter
="$(RACY_ITER)"; \
274 test "x$$racyiter" = "x" && \
275 racyiter
=$(DEFAULT_RACY_ITER
); \
276 if
test $$racyiter -lt
2 ; then \
277 echo
"RACY_ITER must be at least 2."; \
281 for n in
`seq $$racyiter` ; do \
282 $(MAKE
) -k do-check-parallel-racy \
284 $(SHELL
) $(srcdir)/..
/..
/contrib
/dg-extract-results.sh \
285 `find racy_outputs/$$n -name gdb.sum -print` > \
286 racy_outputs
/$$n/gdb.sum
; \
287 $(SHELL
) $(srcdir)/..
/..
/contrib
/dg-extract-results.sh
-L \
288 `find racy_outputs/$$n -name gdb.log -print` > \
289 racy_outputs
/$$n/gdb.log
; \
290 sed
-n
'/=== gdb Summary ===/,$$ p' racy_outputs
/$$n/gdb.sum
; \
292 $(srcdir)/analyze-racy-logs.py \
293 `ls racy_outputs/*/gdb.sum` > racy.sum
; \
294 sed
-n
'/=== gdb Summary ===/,$$ p' racy.sum
296 # Turn a list of .exp files into "check/" targets. Only examine .exp
297 # files appearing in a gdb.* directory -- we don't want to pick up
298 # lib/ by mistake. For example, gdb.linespec/linespec.exp becomes
299 # check/gdb.linespec/linespec.exp. The list is generally sorted
300 # alphabetically, but we take a few tests known to be slow and push
301 # them to the front of the list to try to lessen the overall time
302 # taken by the test suite -- if one of these tests happens to be run
303 # late, it will cause the overall time to increase.
304 ifeq ($(strip $(TESTS
)),)
305 slow_tests
= gdb.base
/break-interp.exp gdb.base
/interp.exp \
306 gdb.base
/multi-forks.exp
307 all_tests
:= $(shell cd
$(srcdir) && find gdb.
* -name
'*.exp' -print)
308 reordered_tests
:= $(slow_tests
) $(filter-out $(slow_tests
),$(all_tests
))
309 TEST_TARGETS
:= $(addprefix $(if
$(RACY_ITER
),check-racy
,check)/,$(reordered_tests
))
311 TEST_TARGETS
:= $(addprefix $(if
$(RACY_ITER
),check-racy
,check)/,$(expanded_tests_or_none
))
314 do-check-parallel
: $(TEST_TARGETS
)
319 @
$(DO_RUNTEST
) GDB_PARALLEL
=yes
--outdir
=outputs
/$* $*.exp
$(RUNTESTFLAGS
) $(TIMESTAMP
)
321 do-check-parallel-racy
: $(TEST_TARGETS
)
325 -mkdir
-p racy_outputs
/$(RACY_OUTPUT_N
)/$*
326 $(DO_RUNTEST
) GDB_PARALLEL
=yes \
327 --outdir
=racy_outputs
/$(RACY_OUTPUT_N
)/$* $*.exp \
328 $(RUNTESTFLAGS
) $(TIMESTAMP
)
330 check/no-matching-tests-found
:
332 @echo
"No matching tests found."
335 # Utility rule invoked by step 2 of the build-perf rule.
337 mkdir
-p gdb.perf
/outputs
/$*
338 $(DO_RUNTEST
) --outdir
=gdb.perf
/outputs
/$* lib
/build-piece.exp WORKER
=$* GDB_PARALLEL
=gdb.perf
$(RUNTESTFLAGS
) GDB_PERFTEST_MODE
=compile GDB_PERFTEST_SUBMODE
=build-pieces
$(TIMESTAMP
)
340 # Utility rule to build tests that support it in parallel.
341 # The build is broken into 3 steps distinguished by GDB_PERFTEST_SUBMODE:
342 # gen-workers, build-pieces, final.
344 # GDB_PERFTEST_MODE appears *after* RUNTESTFLAGS here because we don't want
345 # anything in RUNTESTFLAGS to override it.
347 # We don't delete the outputs directory here as these programs can take
348 # awhile to build, and perftest.exp has support for deciding whether to
349 # recompile them. If you want to remove these directories, make clean.
351 # The point of step 1 is to construct the set of worker tasks for step 2.
352 # All of the information needed by build-piece.exp is contained in the name
353 # of the generated .worker file.
354 build-perf
: $(abs_builddir
)/site.exp
355 rm -rf gdb.perf
/workers
356 mkdir
-p gdb.perf
/workers
357 @
: Step
1: Generate the build .worker files.
358 $(DO_RUNTEST
) --directory
=gdb.perf
--outdir gdb.perf
/workers GDB_PARALLEL
=gdb.perf
$(RUNTESTFLAGS
) GDB_PERFTEST_MODE
=compile GDB_PERFTEST_SUBMODE
=gen-workers
$(TIMESTAMP
)
359 @
: Step
2: Compile the pieces. Here is the build parallelism.
360 $(MAKE
) $$(cd gdb.perf
&& echo workers
/*/*.worker
)
361 @
: Step
3: Do the final link.
362 $(DO_RUNTEST
) --directory
=gdb.perf
--outdir gdb.perf GDB_PARALLEL
=gdb.perf
$(RUNTESTFLAGS
) GDB_PERFTEST_MODE
=compile GDB_PERFTEST_SUBMODE
=final
$(TIMESTAMP
)
364 # The default is to both compile and run the tests.
365 GDB_PERFTEST_MODE
= both
367 check-perf
: all $(abs_builddir
)/site.exp
368 @if
test ! -d gdb.perf
; then mkdir gdb.perf
; fi
369 $(DO_RUNTEST
) --directory
=gdb.perf
--outdir gdb.perf GDB_PERFTEST_MODE
=$(GDB_PERFTEST_MODE
) $(RUNTESTFLAGS
) $(TIMESTAMP
)
372 check-all-boards
: all $(abs_builddir
)/site.exp
373 @if
[ -z
"$(GDB_TARGET_USERNAME)" ]; then \
374 echo
"Must define GDB_TARGET_USERNAME"; \
377 @if
[ -z
"$(GDB_HOST_USERNAME)" ]; then \
378 echo
"Must define GDB_HOST_USERNAME"; \
381 @if
[ -z
"$(TESTS)" ]; then \
382 echo
"Must define TESTS"; \
385 ${abs_srcdir}/make-check-all.sh
--keep-results \
386 --host-user
"$(GDB_HOST_USERNAME)" \
387 --target-user
"$(GDB_TARGET_USERNAME)" \
393 -rm -f
*~ core
*.o a.out xgdb
*.x
*.grt bigcore.corefile .gdb_history
394 -rm -f core.
* *.tf
*.cl tracecommandsscript copy1.txt zzz-gdbscript
396 -rm -rf outputs temp cache
397 -rm -rf gdb.perf
/workers gdb.perf
/outputs gdb.perf
/temp gdb.perf
/cache
398 -rm -f read1.so expect-read1 readmore.so expect-readmore
400 distclean maintainer-clean
realclean: clean
402 -rm -f Makefile config.status
*-init.exp lib
/pdtrace
403 -rm -fr
*.log summary detail
*.plog
*.sum
*.psum site.
*
405 Makefile
: Makefile.in config.status
$(host_makefile_frag
)
406 $(SHELL
) config.status Makefile
408 lib
/pdtrace
: pdtrace.in config.status
409 $(SHELL
) config.status lib
/pdtrace
411 config.status
: configure
412 $(SHELL
) config.status
--recheck
415 find
$(srcdir) -name
'*.exp' -print | \
417 --regex
='/\(proc\|proc_with_prefix\|gdb_caching_proc\)[ \t]+\([^ \t]+\)/\2/' \
420 # Build the expect wrapper script that preloads the read1.so library.
421 expect-read1 expect-readmore
:
425 echo
"# THIS FILE IS GENERATED -*- buffer-read-only: t -*- \n" >>$@
-tmp
; \
426 echo
"# vi:set ro: */\n\n" >>$@
-tmp
; \
427 echo
"# To regenerate this file, run:\n" >>$@
-tmp
; \
428 echo
"# make clean; make/\n" >>$@
-tmp
; \
429 if
[ $@
= expect-read1
]; then \
430 echo
"export LD_PRELOAD=`pwd`/read1.so" >>$@
-tmp
; \
432 echo
"export LD_PRELOAD=`pwd`/readmore.so" >>$@
-tmp
; \
434 echo
'exec expect "$$@"' >>$@
-tmp
; \
438 # Build the read1.so preload library. This overrides the `read'
439 # function, making it read one byte at a time. Running the testsuite
440 # with this catches racy tests.
441 read1.so
: lib
/read1.c
442 $(ECHO_CC
) $(CC
) -o
$@
${srcdir}/lib
/read1.c
-Wall
-g
-shared
-fPIC
$(CFLAGS
)
444 # Build the readmore.so preload library. This overrides the `read'
445 # function, making it try harder to read more at a time. Running the
446 # testsuite with this catches racy tests.
447 readmore.so
: lib
/read1.c
448 $(ECHO_CC
) $(CC
) -o
$@
${srcdir}/lib
/read1.c
-Wall
-g
-shared
-fPIC \
451 # Build the read1 machinery.
452 .PHONY
: read1 readmore
453 read1
: read1.so expect-read1
454 readmore
: readmore.so expect-readmore
456 # Disable implicit make rules.
457 include $(srcdir)/..
/disable-implicit-rules.mk
458 include $(srcdir)/..
/silent-rules.mk