run.py revision 9447
1# Copyright (c) 2012 ARM Limited
2# All rights reserved
3#
4# The license below extends only to copyright in the software and shall
5# not be construed as granting a license to any other intellectual
6# property including but not limited to intellectual property relating
7# to a hardware implementation of the functionality of the software
8# licensed hereunder.  You may use the software subject to the license
9# terms below provided that you ensure that this notice is replicated
10# unmodified and in its entirety in all distributions of the software,
11# modified or unmodified, in source code or in binary form.
12#
13# Copyright (c) 2006-2007 The Regents of The University of Michigan
14# All rights reserved.
15#
16# Redistribution and use in source and binary forms, with or without
17# modification, are permitted provided that the following conditions are
18# met: redistributions of source code must retain the above copyright
19# notice, this list of conditions and the following disclaimer;
20# redistributions in binary form must reproduce the above copyright
21# notice, this list of conditions and the following disclaimer in the
22# documentation and/or other materials provided with the distribution;
23# neither the name of the copyright holders nor the names of its
24# contributors may be used to endorse or promote products derived from
25# this software without specific prior written permission.
26#
27# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
28# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
29# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
30# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
31# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
32# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
33# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
34# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
35# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
36# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
37# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38#
39# Authors: Steve Reinhardt
40
41import os
42import sys
43import re
44import string
45
46from os.path import join as joinpath
47
48import m5
49
50def skip_test(reason=""):
51    """Signal that a test should be skipped and optionally print why.
52
53    Keyword arguments:
54      reason -- Reason why the test failed. Output is omitted if empty.
55    """
56
57    if reason:
58        print "Skipping test: %s" % reason
59    sys.exit(2)
60
61def has_sim_object(name):
62    """Test if a SimObject exists in the simulator.
63
64    Arguments:
65      name -- Name of SimObject (string)
66
67    Returns: True if the object exists, False otherwise.
68    """
69
70    try:
71        cls = getattr(m5.objects, name)
72        return issubclass(cls, m5.objects.SimObject)
73    except AttributeError:
74        return False
75
76def require_sim_object(name, fatal=False):
77    """Test if a SimObject exists and abort/skip test if not.
78
79    Arguments:
80      name -- Name of SimObject (string)
81
82    Keyword arguments:
83      fatal -- Set to True to indicate that the test should fail
84               instead of being skipped.
85    """
86
87    if has_sim_object(name):
88        return
89    else:
90        msg = "Test requires the '%s' SimObject." % name
91        if fatal:
92            m5.fatal(msg)
93        else:
94            skip_test(msg)
95
96def run_test(root):
97    """Default run_test implementations. Scripts can override it."""
98
99    # instantiate configuration
100    m5.instantiate()
101
102    # simulate until program terminates
103    exit_event = m5.simulate(maxtick)
104    print 'Exiting @ tick', m5.curTick(), 'because', exit_event.getCause()
105
106# Since we're in batch mode, dont allow tcp socket connections
107m5.disableAllListeners()
108
109# single "path" arg encodes everything we need to know about test
110(category, mode, name, isa, opsys, config) = sys.argv[1].split('/')[-6:]
111
112# find path to directory containing this file
113tests_root = os.path.dirname(__file__)
114test_progs = os.environ.get('M5_TEST_PROGS', '/dist/m5/regression/test-progs')
115if not os.path.isdir(test_progs):
116    test_progs = joinpath(tests_root, 'test-progs')
117
118# generate path to binary file
119def binpath(app, file=None):
120    # executable has same name as app unless specified otherwise
121    if not file:
122        file = app
123    return joinpath(test_progs, app, 'bin', isa, opsys, file)
124
125# generate path to input file
126def inputpath(app, file=None):
127    # input file has same name as app unless specified otherwise
128    if not file:
129        file = app
130    return joinpath(test_progs, app, 'input', file)
131
132# build configuration
133sys.path.append(joinpath(tests_root, 'configs'))
134test_filename = config
135# for ruby configurations, remove the protocol name from the test filename
136if re.search('-ruby', test_filename):
137    test_filename = test_filename.split('-ruby')[0]+'-ruby'
138execfile(joinpath(tests_root, 'configs', test_filename + '.py'))
139
140# set default maxtick... script can override
141# -1 means run forever
142maxtick = m5.MaxTick
143
144# tweak configuration for specific test
145sys.path.append(joinpath(tests_root, category, mode, name))
146execfile(joinpath(tests_root, category, mode, name, 'test.py'))
147
148# Initialize all CPUs in a system
149def initCPUs(sys):
150    def initCPU(cpu):
151        # We might actually have a MemTest object or something similar
152        # here that just pretends to be a CPU.
153        if isinstance(cpu, BaseCPU):
154            cpu.createThreads()
155
156    # The CPU attribute doesn't exist in some cases, e.g. the Ruby
157    # testers.
158    if not hasattr(sys, "cpu"):
159        return
160
161    # The CPU can either be a list of CPUs or a single object.
162    if isinstance(sys.cpu, list):
163        [ initCPU(cpu) for cpu in sys.cpu ]
164    else:
165        initCPU(sys.cpu)
166
167# We might be creating a single system or a dual system. Try
168# initializing the CPUs in all known system attributes.
169for sysattr in [ "system", "testsys", "drivesys" ]:
170    if hasattr(root, sysattr):
171        initCPUs(getattr(root, sysattr))
172
173run_test(root)
174