git.gag.com Git - fw/sdcc/blob - support/regression/Makefile

   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 CVS.
  19 #       o cvs -d cvs.sdcc.sourceforge.net:/cvsroot/sdcc co 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 # All original tests live in TESTS_DIR and below
  44 TESTS_DIR = tests
  45 TESTS_NAME = $(TESTS_DIR)
  46 # All suite results go in RESULTS_DIR
  47 RESULTS_DIR = results
  48 # All data relating to supported ports live in their own directory
  49 # under PORTS_DIR.
  50 PORTS_DIR = ports
  51
  52 # Itermediate data directories
  53 # Directory that generated cases and the related object code go.
  54 CASES_DIR = gen
  55
  56 # Script that takes a source test suite and generates the iterations
  57 GENERATE_CASES = generate-cases.py
  58
  59 # Magically generate the list of configured ports to test.
  60 # Each directory under ports/ is used as a port name.  Each port is tested.
  61 # The port name must be the same as the one used in the SDCC '-mxxx' argument.
  62 # Each port must have a spec.mk which describes how to build the object
  63 # files and how to run the emulator.
  64 ALL_PORTS = $(filter-out CVS mcs51 gbz80,$(notdir $(wildcard $(PORTS_DIR)/*)))
  65
  66 all: test-ports
  67
  68 # Test all of the ports
  69 test-ports:
  70         for i in $(ALL_PORTS); do $(MAKE) inter-port-clean test-port PORT=$$i; done
  71
  72 # Helper rule for testing the z80 port only
  73 test-z80:
  74         $(MAKE) inter-port-clean test-port PORT=z80
  75
  76 # Helper rule for testing the z80 port only
  77 test-gbz80:
  78         $(MAKE) inter-port-clean test-port PORT=gbz80
  79
  80 # Helper rule for testing the mcs51 small model port only
  81 test-mcs51:
  82         $(MAKE) inter-port-clean test-port PORT=mcs51
  83
  84 # Helper rule for testing the host cc only
  85 test-host:
  86         $(MAKE) inter-port-clean clean test-port PORT=host
  87
  88 test-host2:
  89         $(MAKE) test-port PORT=host
  90
  91 # Begin per-port rules
  92 # List of all of the known source test suites.
  93 ALL_TESTS = $(shell find $(TESTS_DIR) -name "*.c")
  94
  95 # Intermediate directory
  96 PORT_CASES_DIR = $(CASES_DIR)/$(PORT)
  97 PORT_RESULTS_DIR = $(RESULTS_DIR)/$(PORT)
  98 # Each test generates a result log file
  99 PORT_RESULTS = $(ALL_TESTS:$(TESTS_DIR)/%.c=$(PORT_RESULTS_DIR)/%.out)
 100
 101 SDCC_DIR = ../..
 102 SDCC_EXTRA_DIR = ../../../sdcc-extra
 103
 104 # Defaults.  Override in spec.mk if required.
 105 # Path to SDCC
 106 SDCC = $(SDCC_DIR)/bin/sdcc
 107 # Base flags.
 108 SDCCFLAGS = -m$(PORT)
 109 # Extension of object intermediate files
 110 OBJEXT = .o
 111 # Extension of files that can be run in the emulator
 112 EXEEXT = .bin
 113 # Currently unused.  Extension to append to intermediate directories.
 114 DIREXT =
 115
 116 # Only include if we're in a per-port call.
 117 ifdef PORT
 118 include $(PORTS_DIR)/$(PORT)/spec.mk
 119 endif
 120
 121 SDCCFLAGS += -Ifwk/include -Itests
 122
 123 # List of intermediate files to keep.  Pretty much keep everything as
 124 # disk space is free.
 125 .PRECIOUS: $(PORT_CASES_DIR)/% %$(OBJEXT) %$(EXEEXT)
 126
 127 # Rule to generate the iterations of a test suite off the soure suite.
 128 $(PORT_CASES_DIR)/%/iterations.stamp: $(TESTS_DIR)/%.c $(GENERATE_CASES)
 129         echo Processing $<
 130         rm -rf $(CASES_DIR)/$(TESTS_NAME)
 131         mkdir -p $(CASES_DIR)/$(TESTS_NAME)
 132         mkdir -p `dirname $@`
 133         python $(GENERATE_CASES) $< > /dev/null
 134         cp $(CASES_DIR)/$(TESTS_NAME)/*.c `dirname $@`
 135         touch $@
 136
 137 # Rule linking the combined results log to all of the files in the
 138 # iteration directory.
 139 $(PORT_RESULTS_DIR)/%.out: $(PORT_CASES_DIR)/%/iterations.stamp
 140         $(MAKE) iterations PORT=$(PORT) CASES=`dirname $<`
 141
 142 # Rule to summaries the results for one port after all of the tests
 143 # have been run.
 144 port-results: port-dirs $(PORT_RESULTS)
 145         echo Summary for \'$(PORT)\': `cat $(PORT_RESULTS) | python collate-results.py`
 146
 147 port-dirs:
 148         mkdir -p $(PORT_CASES_DIR) $(PORT_RESULTS_DIR)
 149
 150 test-port: port-results
 151
 152 # Begin rules that process each iteration generated from the source
 153 # test
 154
 155 # List of all of the generated iteration source files.
 156 SUB_CASES = $(sort $(wildcard $(CASES)/*.c))
 157 # List of all the sub result logs generated from the iterations.
 158 SUB_RESULTS = $(SUB_CASES:%.c=%.out)
 159 # Overall target.  Concatenation of all of the sub results.
 160 RESULTS = $(CASES:$(CASES_DIR)/%$(DIREXT)=$(RESULTS_DIR)/%.out)
 161
 162 iterations: $(RESULTS)
 163
 164 # Rule to generate the overall target from the sub results.
 165 $(RESULTS): $(SUB_RESULTS)
 166         cat $(SUB_RESULTS) > $@
 167
 168 # The remainder of the rules are in $PORT/spec.mak.  The port needs to
 169 # be able to turn an iterated test suite into a sub result, normally
 170 # by:
 171 #    1. Compile the required library files
 172 #    2. Compile this test suite.
 173 #    3. Link 1, 2, and any required stdlib into an executable.
 174 #    4. Run the executable inside an emulator, and capture the text
 175 #    output into %.out.
 176 #
 177 # The emulator must exit when main() returns.
 178
 179 # BeginGeneric rules
 180
 181 clean:
 182         rm -rf $(CASES_DIR) $(RESULTS_DIR) *.pyc
 183
 184 inter-port-clean:
 185         rm -f  fwk/lib/*.o fwk/lib/*.asm fwk/lib/*.rst fwk/lib/*.lst fwk/lib/*.rel