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