run.py revision 9401 
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
96# Since we're in batch mode, dont allow tcp socket connections
97m5.disableAllListeners()
98
99# single "path" arg encodes everything we need to know about test
100(category, mode, name, isa, opsys, config) = sys.argv[1].split('/')[-6:]
101
102# find path to directory containing this file
103tests_root = os.path.dirname(__file__)
104test_progs = os.environ.get('M5_TEST_PROGS', '/dist/m5/regression/test-progs')
105if not os.path.isdir(test_progs):
106    test_progs = joinpath(tests_root, 'test-progs')
107
108# generate path to binary file
109def binpath(app, file=None):
110    # executable has same name as app unless specified otherwise
111    if not file:
112        file = app
113    return joinpath(test_progs, app, 'bin', isa, opsys, file)
114
115# generate path to input file
116def inputpath(app, file=None):
117    # input file has same name as app unless specified otherwise
118    if not file:
119        file = app
120    return joinpath(test_progs, app, 'input', file)
121
122# build configuration
123sys.path.append(joinpath(tests_root, 'configs'))
124test_filename = config
125# for ruby configurations, remove the protocol name from the test filename
126if re.search('-ruby', test_filename):
127    test_filename = test_filename.split('-ruby')[0]+'-ruby'
128execfile(joinpath(tests_root, 'configs', test_filename + '.py'))
129
130# set default maxtick... script can override
131# -1 means run forever
132maxtick = m5.MaxTick
133
134# tweak configuration for specific test
135sys.path.append(joinpath(tests_root, category, mode, name))
136execfile(joinpath(tests_root, category, mode, name, 'test.py'))
137
138# Initialize all CPUs in a system
139def initCPUs(sys):
140    def initCPU(cpu):
141        # We might actually have a MemTest object or something similar
142        # here that just pretends to be a CPU.
143        if isinstance(cpu, BaseCPU):
144            cpu.createThreads()
145
146    # The CPU attribute doesn't exist in some cases, e.g. the Ruby
147    # testers.
148    if not hasattr(sys, "cpu"):
149        return
150
151    # The CPU can either be a list of CPUs or a single object.
152    if isinstance(sys.cpu, list):
153        [ initCPU(cpu) for cpu in sys.cpu ]
154    else:
155        initCPU(sys.cpu)
156
157# We might be creating a single system or a dual system. Try
158# initializing the CPUs in all known system attributes.
159for sysattr in [ "system", "testsys", "drivesys" ]:
160    if hasattr(root, sysattr):
161        initCPUs(getattr(root, sysattr))
162
163# instantiate configuration
164m5.instantiate()
165
166# simulate until program terminates
167exit_event = m5.simulate(maxtick)
168
169print 'Exiting @ tick', m5.curTick(), 'because', exit_event.getCause()
170