1 # Copyright (c) 2012 ARM Limited
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.
13 # Copyright (c) 2006-2007 The Regents of The University of Michigan
14 # All rights reserved.
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.
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.
39 # Authors: Steve Reinhardt
41 from __future__
import print_function
48 from os
.path
import join
as joinpath
54 def skip_test(reason
=""):
55 """Signal that a test should be skipped and optionally print why.
58 reason -- Reason why the test failed. Output is omitted if empty.
62 print("Skipping test: %s" % reason
)
65 def has_sim_object(name
):
66 """Test if a SimObject exists in the simulator.
69 name -- Name of SimObject (string)
71 Returns: True if the object exists, False otherwise.
75 cls
= getattr(m5
.objects
, name
)
76 return issubclass(cls
, m5
.objects
.SimObject
)
77 except AttributeError:
80 def require_sim_object(name
, fatal
=False):
81 """Test if a SimObject exists and abort/skip test if not.
84 name -- Name of SimObject (string)
87 fatal -- Set to True to indicate that the test should fail
88 instead of being skipped.
91 if has_sim_object(name
):
94 msg
= "Test requires the '%s' SimObject." % name
101 def require_file(path
, fatal
=False, mode
=os
.F_OK
):
102 """Test if a file exists and abort/skip test if not.
105 path -- File to test for.
108 fatal -- Set to True to indicate that the test should fail
109 instead of being skipped.
110 modes -- Mode to test for, default to existence. See the
111 Python documentation for os.access().
114 if os
.access(path
, mode
):
117 msg
= "Test requires '%s'" % path
118 if not os
.path
.exists(path
):
119 msg
+= " which does not exist."
121 msg
+= " which has incorrect permissions."
128 def require_kvm(kvm_dev
="/dev/kvm", fatal
=False):
129 """Test if KVM is available.
132 kvm_dev -- Device to test (normally /dev/kvm)
133 fatal -- Set to True to indicate that the test should fail
134 instead of being skipped.
137 require_sim_object("BaseKvmCPU", fatal
=fatal
)
138 require_file(kvm_dev
, fatal
=fatal
, mode
=os
.R_OK | os
.W_OK
)
141 """Default run_test implementations. Scripts can override it."""
143 # instantiate configuration
146 # simulate until program terminates
147 exit_event
= m5
.simulate(maxtick
)
148 print('Exiting @ tick', m5
.curTick(), 'because', exit_event
.getCause())
150 # Since we're in batch mode, dont allow tcp socket connections
151 m5
.disableAllListeners()
153 # single "path" arg encodes everything we need to know about test
154 (category
, mode
, name
, isa
, opsys
, config
) = sys
.argv
[1].split('/')[-6:]
156 # find path to directory containing this file
157 tests_root
= os
.path
.dirname(__file__
)
158 test_progs
= os
.environ
.get('M5_TEST_PROGS', '/dist/m5/regression/test-progs')
159 if not os
.path
.isdir(test_progs
):
160 test_progs
= joinpath(tests_root
, 'test-progs')
162 # generate path to binary file
163 def binpath(app
, file=None):
164 # executable has same name as app unless specified otherwise
167 return joinpath(test_progs
, app
, 'bin', isa
, opsys
, file)
169 # generate path to input file
170 def inputpath(app
, file=None):
171 # input file has same name as app unless specified otherwise
174 return joinpath(test_progs
, app
, 'input', file)
177 """Path to file in gem5's source tree"""
178 return joinpath(os
.path
.dirname(__file__
), "..", path
)
180 def run_config(config
, argv
=None):
181 """Execute a configuration script that is external to the test system"""
183 src_root
= os
.path
.abspath(os
.path
.join(os
.path
.dirname(__file__
), "../"))
184 abs_path
= joinpath(src_root
, config
)
186 code
= compile(open(abs_path
, 'r').read(), abs_path
, 'exec')
189 '__name__' : '__m5_main__',
192 # Set the working directory in case we are executing from
193 # outside gem5's source tree
196 # gem5 normally adds the script's directory to the path to make
197 # script-relative imports work.
198 sys
.path
= [ os
.path
.dirname(abs_path
), ] + sys
.path
201 sys
.argv
= [ config
, ]
206 # build configuration
207 sys
.path
.append(joinpath(tests_root
, 'configs'))
208 test_filename
= config
209 # for ruby configurations, remove the protocol name from the test filename
210 if re
.search('-ruby', test_filename
):
211 test_filename
= test_filename
.split('-ruby')[0]+'-ruby'
213 open(joinpath(tests_root
, 'configs', test_filename
+ '.py')).read(), \
214 joinpath(tests_root
, 'configs', test_filename
+ '.py'), 'exec'))
216 # set default maxtick... script can override
217 # -1 means run forever
220 # tweak configuration for specific test
221 sys
.path
.append(joinpath(tests_root
, category
, mode
, name
))
223 open(joinpath(tests_root
, category
, mode
, name
, 'test.py')).read(), \
224 joinpath(tests_root
, category
, mode
, name
, 'test.py'), 'exec'))
226 # Initialize all CPUs in a system
229 # We might actually have a MemTest object or something similar
230 # here that just pretends to be a CPU.
236 # The CPU attribute doesn't exist in some cases, e.g. the Ruby
238 if not hasattr(sys
, "cpu"):
241 # The CPU can either be a list of CPUs or a single object.
242 if isinstance(sys
.cpu
, list):
243 [ initCPU(cpu
) for cpu
in sys
.cpu
]
247 # We might be creating a single system or a dual system. Try
248 # initializing the CPUs in all known system attributes.
249 for sysattr
in [ "system", "testsys", "drivesys" ]:
250 if hasattr(root
, sysattr
):
251 initCPUs(getattr(root
, sysattr
))