2 # Part of SDCC - http://sdcc.sourceforge.net/
3 # Michael Hope <michaelh@juju.net.nz> 2001
5 # This Makefile builds and runs the test suites under tests/ for each
6 # one of the supported ports located under ports/. The test suite
7 # results are summarised and individual test failures are logged. The
8 # expected result is a single line per port summarising the number of
9 # failures, test points, and test cases. The philosophy is that
10 # checked in code should always pass the suite with no failures, as
11 # then if there are failures then it is in the current developers code.
13 # Only the required suites are run. Changing sdcc causes all to be
14 # re-run. Changing one suite causes just that to be run. Changing
15 # one of the library files should cause all to re-run
18 # * The sdcc-extra package, available from svn.
19 # o svn co https://svn.sourceforge.net/svnroot/sdcc/trunk/sdcc-extra
20 # o Provides the emulators
21 # * The gbdk-lib package from gbdk.
22 # o cvs -d cvs.gbdk.sourceforge.net:/cvsroot/gbdk co gbdk-lib
23 # o Proviles mul, div, and include files for the z80 tests.
24 # * python 1.5 or above
25 # * uCsim for the mcs51 port
27 # The paths below assume that sdcc, sdcc-extra, and gbdk-lib all reside in
31 # Starting at the bottom
32 # Set of source test suites
33 # Each source suite is processesd producing multiple device specific test suites.
34 # Each device specific test suite is compiled.
35 # Each device specific test suite is run, and the output recorded.
36 # The output from each device specific test suite derrived from a source
37 # test suite are collated.
39 # Uncomment this to show only errors and the summary.
40 # Comment this out for debugging.
49 top_srcdir = @top_srcdir@
50 top_builddir = @top_builddir@
52 # All original tests live in TESTS_DIR and below
53 TESTS_DIR = $(srcdir)/tests
54 TESTS_NAME = $(TESTS_DIR)
55 # All suite results go in RESULTS_DIR
57 # All data relating to supported ports live in their own directory
59 PORTS_DIR = $(srcdir)/ports
61 # Itermediate data directories
62 # Directory that generated cases and the related object code go.
65 # Script that takes a source test suite and generates the iterations
66 GENERATE_CASES = $(srcdir)/generate-cases.py
68 # Magically generate the list of configured ports to test.
69 # Each directory under ports/ is used as a port name. Each port is tested.
70 # Each port must have a spec.mk which describes how to build the object
71 # files and how to run the emulator.
72 ALL_PORTS = $(filter-out .svn xa51 ucz80 gbz80 pic16,$(notdir $(wildcard $(PORTS_DIR)/*)))
74 # These ports will be cleaned with 'make clean'
75 CLEAN_PORTS = $(filter-out .svn,$(notdir $(wildcard $(PORTS_DIR)/*)))
81 # Test all of the ports
83 for i in $(ALL_PORTS); do $(MAKE) make_library test-port PORT=$$i; done
85 # Helper rule for testing the z80 port only
87 $(MAKE) test-port PORT=z80
89 # Helper rule for testing the z80 port only
91 $(MAKE) test-port PORT=gbz80
93 # Helper rule for testing the mcs51 port only
95 $(MAKE) test-port PORT=mcs51
98 $(MAKE) test-port PORT=mcs51-medium
101 $(MAKE) test-port PORT=mcs51-large
103 test-mcs51-stack-auto:
104 $(MAKE) test-port PORT=mcs51-stack-auto
106 test-mcs51-xstack-auto:
107 $(MAKE) make_library test-port PORT=mcs51-xstack-auto
109 # Helper rule for testing the ds390 port only
111 $(MAKE) test-port PORT=ds390
113 # Helper rule for testing the z80 port only(use ucSim simulator)
115 $(MAKE) test-port PORT=ucz80
117 # Helper rule for testing the hc08 port only(use ucSim simulator)
119 $(MAKE) test-port PORT=hc08
121 # Helper rule for testing the xa51 port only(use ucSim simulator)
123 $(MAKE) test-port PORT=xa51
125 # Helper rule for testing the pic16 port only(use gpsim simulator)
127 $(MAKE) test-port PORT=pic16
129 ### Helper rule for testing the host cc only
131 $(MAKE) test-port PORT=host
134 $(MAKE) test-port PORT=host
136 # Begin per-port rules
137 # List of all of the known source test suites.
138 ALL_TESTS = $(shell find $(TESTS_DIR) -name "*.c" | sort)
140 # Intermediate directory
141 PORT_CASES_DIR = $(CASES_DIR)/$(PORT)
142 PORT_RESULTS_DIR = $(RESULTS_DIR)/$(PORT)
143 # Each test generates a result log file
144 PORT_RESULTS = $(ALL_TESTS:$(TESTS_DIR)/%.c=$(PORT_RESULTS_DIR)/%.out)
146 SDCC_EXTRA_DIR = $(top_builddir)../sdcc-extra
147 INC_DIR = $(top_srcdir)/device/include
149 # Defaults. Override in spec.mk if required.
151 SDCC = $(top_builddir)bin/sdcc
154 # Extension of object intermediate files
156 # Extension of files that can be run in the emulator
158 # Currently unused. Extension to append to intermediate directories.
161 # Only include if we're in a per-port call.
163 include $(PORTS_DIR)/$(PORT)/spec.mk
166 make_library: $(MAKE_LIBRARY)
168 SDCCFLAGS += -I$(srcdir)/fwk/include -I$(srcdir)/tests -I$(INC_DIR)
170 # List of intermediate files to keep. Pretty much keep everything as
171 # disk space is free.
172 .PRECIOUS: $(PORT_CASES_DIR)/% %$(OBJEXT) %$(EXEEXT)
174 # Rule to generate the iterations of a test suite off the soure suite.
175 $(PORT_CASES_DIR)/%/iterations.stamp: $(TESTS_DIR)/%.c $(GENERATE_CASES)
176 echo Processing $(notdir $<)
179 python $(GENERATE_CASES) $< $(dir $@) > /dev/null
182 # Rule linking the combined results log to all of the files in the
183 # iteration directory.
184 $(PORT_RESULTS_DIR)/%.out: $(PORT_CASES_DIR)/%/iterations.stamp
185 $(MAKE) iterations PORT=$(PORT) CASES=$(dir $<)
187 # Rule to summaries the results for one port after all of the tests
189 port-results: port-dirs $(PORT_RESULTS)
190 echo Summary for \'$(PORT)\': `cat $(PORT_RESULTS) | python $(srcdir)/collate-results.py`
194 mkdir -p $(PORT_CASES_DIR) $(PORT_RESULTS_DIR)
195 echo Running $(PORT) regression tests
197 test-port: port-results
199 # Begin rules that process each iteration generated from the source
202 # List of all of the generated iteration source files.
203 SUB_CASES = $(sort $(wildcard $(CASES)*.c))
204 # List of all the sub result logs generated from the iterations.
205 SUB_RESULTS = $(SUB_CASES:%.c=%.out)
206 # Overall target. Concatenation of all of the sub results.
207 RESULTS = $(CASES:$(CASES_DIR)/%/$(DIREXT)=$(RESULTS_DIR)/%.out)
209 iterations: $(RESULTS)
211 # Rule to generate the overall target from the sub results.
212 $(RESULTS): $(SUB_RESULTS)
213 cat $(SUB_RESULTS) > $@
215 # The remainder of the rules are in $PORT/spec.mk. The port needs to
216 # be able to turn an iterated test suite into a sub result, normally
218 # 1. Compile the required library files
219 # 2. Compile this test suite.
220 # 3. Link 1, 2, and any required stdlib into an executable.
221 # 4. Run the executable inside an emulator, and capture the text
224 # The emulator must exit when main() returns.
229 rm -rf $(CASES_DIR) $(RESULTS_DIR) *.pyc
230 for i in $(CLEAN_PORTS); do $(MAKE) -f $(PORTS_DIR)/$$i/spec.mk _clean PORTS_DIR=$(PORTS_DIR) PORT=$$i; done