git-svn-id: https://sdcc.svn.sourceforge.net/svnroot/sdcc/trunk/sdcc@4106 4a8a32a2...
[fw/sdcc] / support / regression / Makefile.in
1 # Test suite Makefile
2 # Part of SDCC - http://sdcc.sourceforge.net/
3 # Michael Hope <michaelh@juju.net.nz> 2001
4 #
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.
12 #
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
16
17 # Dependancies:
18 #   * The sdcc-extra package, available from Subversion.
19 #       o  svn co https://svn.sourceforge.net/svnroot/sdcc/trunk/sdcc-extra 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
26 #
27 # The paths below assume that sdcc, sdcc-extra, and gbdk-lib all reside in
28 # the same directory.
29
30 # Old notes:
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.
38
39 # Uncomment this to show only errors and the summary.
40 # Comment this out for debugging.
41 .SILENT:
42
43 CC = @CC@
44
45 # All original tests live in TESTS_DIR and below
46 TESTS_DIR = tests
47 TESTS_NAME = $(TESTS_DIR)
48 # All suite results go in RESULTS_DIR
49 RESULTS_DIR = results
50 # All data relating to supported ports live in their own directory
51 # under PORTS_DIR.
52 PORTS_DIR = ports
53
54 # Itermediate data directories
55 # Directory that generated cases and the related object code go.
56 CASES_DIR = gen
57
58 # Script that takes a source test suite and generates the iterations
59 GENERATE_CASES = generate-cases.py
60
61 # Magically generate the list of configured ports to test.
62 # Each directory under ports/ is used as a port name.  Each port is tested.
63 # Each port must have a spec.mk which describes how to build the object
64 # files and how to run the emulator.
65 ALL_PORTS = $(filter-out .svn xa51 ucz80 gbz80 pic16,$(notdir $(wildcard $(PORTS_DIR)/*)))
66
67 # These  ports will be cleaned with 'make clean'
68 CLEAN_PORTS = $(filter-out .svn,$(notdir $(wildcard $(PORTS_DIR)/*)))
69
70 MAKE_LIBRARY =
71
72 all: test-ports
73
74 # Test all of the ports
75 test-ports:
76         for i in $(ALL_PORTS); do $(MAKE) make_library test-port PORT=$$i; done
77
78 # Helper rule for testing the z80 port only
79 test-z80:
80         $(MAKE) test-port PORT=z80
81
82 # Helper rule for testing the z80 port only
83 test-gbz80:
84         $(MAKE) test-port PORT=gbz80
85
86 # Helper rule for testing the mcs51 port only
87 test-mcs51:
88         $(MAKE) test-port PORT=mcs51
89
90 test-mcs51-medium:
91         $(MAKE) test-port PORT=mcs51-medium
92
93 test-mcs51-large:
94         $(MAKE) test-port PORT=mcs51-large
95
96 test-mcs51-stack-auto:
97         $(MAKE) test-port PORT=mcs51-stack-auto
98
99 test-mcs51-xstack-auto:
100         $(MAKE) make_library test-port PORT=mcs51-xstack-auto
101
102 # Helper rule for testing the ds390 port only
103 test-ds390:
104         $(MAKE) test-port PORT=ds390
105
106 # Helper rule for testing the z80 port only(use ucSim simulator)
107 test-ucz80:
108         $(MAKE) test-port PORT=ucz80
109
110 # Helper rule for testing the hc08 port only(use ucSim simulator)
111 test-hc08:
112         $(MAKE) test-port PORT=hc08
113
114 # Helper rule for testing the xa51 port only(use ucSim simulator)
115 test-xa51:
116         $(MAKE) test-port PORT=xa51
117
118 # Helper rule for testing the pic16 port only(use gpsim simulator)
119 test-pic16:
120         $(MAKE) test-port PORT=pic16
121
122 ### Helper rule for testing the host cc only
123 test-host:
124         $(MAKE) test-port PORT=host
125
126 test-host2:
127         $(MAKE) test-port PORT=host
128
129 # Begin per-port rules
130 # List of all of the known source test suites.
131 ALL_TESTS = $(shell find $(TESTS_DIR) -name "*.c")
132
133 # Intermediate directory
134 PORT_CASES_DIR = $(CASES_DIR)/$(PORT)
135 PORT_RESULTS_DIR = $(RESULTS_DIR)/$(PORT)
136 # Each test generates a result log file
137 PORT_RESULTS = $(ALL_TESTS:$(TESTS_DIR)/%.c=$(PORT_RESULTS_DIR)/%.out)
138
139 SDCC_DIR = ../..
140 SDCC_EXTRA_DIR = ../../../sdcc-extra
141 INC_DIR = $(SDCC_DIR)/device/include
142
143 # Defaults.  Override in spec.mk if required.
144 # Path to SDCC
145 SDCC = $(SDCC_DIR)/bin/sdcc
146 # Base flags.
147 SDCCFLAGS +=
148 # Extension of object intermediate files
149 OBJEXT = .o
150 # Extension of files that can be run in the emulator
151 EXEEXT = .bin
152 # Currently unused.  Extension to append to intermediate directories.
153 DIREXT =
154
155 # Only include if we're in a per-port call.
156 ifdef PORT
157 include $(PORTS_DIR)/$(PORT)/spec.mk
158 endif
159
160 make_library: $(MAKE_LIBRARY)
161
162 SDCCFLAGS += -Ifwk/include -Itests -I$(INC_DIR)
163
164 # List of intermediate files to keep.  Pretty much keep everything as
165 # disk space is free.
166 .PRECIOUS: $(PORT_CASES_DIR)/% %$(OBJEXT) %$(EXEEXT)
167
168 # Rule to generate the iterations of a test suite off the soure suite.
169 $(PORT_CASES_DIR)/%/iterations.stamp: $(TESTS_DIR)/%.c $(GENERATE_CASES)
170         echo Processing $<
171         rm -rf `dirname $@`
172         mkdir -p `dirname $@`
173         python $(GENERATE_CASES) $< `dirname $@` > /dev/null
174         touch $@
175
176 # Rule linking the combined results log to all of the files in the
177 # iteration directory.
178 $(PORT_RESULTS_DIR)/%.out: $(PORT_CASES_DIR)/%/iterations.stamp
179         $(MAKE) iterations PORT=$(PORT) CASES=`dirname $<`
180
181 # Rule to summaries the results for one port after all of the tests
182 # have been run.
183 port-results: port-dirs $(PORT_RESULTS)
184         echo Summary for \'$(PORT)\': `cat $(PORT_RESULTS) | python collate-results.py`
185         echo
186
187 port-dirs:
188         mkdir -p $(PORT_CASES_DIR) $(PORT_RESULTS_DIR)
189         echo Running $(PORT) regression tests
190
191 test-port: port-results
192
193 # Begin rules that process each iteration generated from the source
194 # test
195
196 # List of all of the generated iteration source files.
197 SUB_CASES = $(sort $(wildcard $(CASES)/*.c))
198 # List of all the sub result logs generated from the iterations.
199 SUB_RESULTS = $(SUB_CASES:%.c=%.out)
200 # Overall target.  Concatenation of all of the sub results.
201 RESULTS = $(CASES:$(CASES_DIR)/%$(DIREXT)=$(RESULTS_DIR)/%.out)
202
203 iterations: $(RESULTS)
204
205 # Rule to generate the overall target from the sub results.
206 $(RESULTS): $(SUB_RESULTS)
207         cat $(SUB_RESULTS) > $@
208
209 # The remainder of the rules are in $PORT/spec.mak.  The port needs to
210 # be able to turn an iterated test suite into a sub result, normally
211 # by:
212 #    1. Compile the required library files
213 #    2. Compile this test suite.
214 #    3. Link 1, 2, and any required stdlib into an executable.
215 #    4. Run the executable inside an emulator, and capture the text
216 #    output into %.out.
217 #
218 # The emulator must exit when main() returns.
219
220 # BeginGeneric rules
221
222 clean:
223         rm -rf $(CASES_DIR) $(RESULTS_DIR) *.pyc fwk/lib/timeout fwk/lib/timeout.exe
224         for i in $(CLEAN_PORTS); do $(MAKE) -f $(PORTS_DIR)/$$i/spec.mk _clean PORTS_DIR=$(PORTS_DIR) PORT=$$i; done