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
47import os.path
48import os
49
50import m5
51
52def skip_test(reason=""):
53 """Signal that a test should be skipped and optionally print why.
54
55 Keyword arguments:
56 reason -- Reason why the test failed. Output is omitted if empty.
57 """
58
59 if reason:
60 print "Skipping test: %s" % reason
61 sys.exit(2)
62
63def has_sim_object(name):
64 """Test if a SimObject exists in the simulator.
65
66 Arguments:
67 name -- Name of SimObject (string)
68
69 Returns: True if the object exists, False otherwise.
70 """
71
72 try:
73 cls = getattr(m5.objects, name)
74 return issubclass(cls, m5.objects.SimObject)
75 except AttributeError:
76 return False
77
78def require_sim_object(name, fatal=False):
79 """Test if a SimObject exists and abort/skip test if not.
80
81 Arguments:
82 name -- Name of SimObject (string)
83
84 Keyword arguments:
85 fatal -- Set to True to indicate that the test should fail
86 instead of being skipped.
87 """
88
89 if has_sim_object(name):
90 return
91 else:
92 msg = "Test requires the '%s' SimObject." % name
93 if fatal:
94 m5.fatal(msg)
95 else:
96 skip_test(msg)
97
98
99def require_file(path, fatal=False, mode=os.F_OK):
100 """Test if a file exists and abort/skip test if not.
101
102 Arguments:
103 path -- File to test for.
104
105 Keyword arguments:
106 fatal -- Set to True to indicate that the test should fail
107 instead of being skipped.
108 modes -- Mode to test for, default to existence. See the
109 Python documentation for os.access().
110 """
111
112 if os.access(path, mode):
113 return
114 else:
115 msg = "Test requires '%s'" % path
116 if not os.path.exists(path):
117 msg += " which does not exist."
118 else:
119 msg += " which has incorrect permissions."
120
121 if fatal:
122 m5.fatal(msg)
123 else:
124 skip_test(msg)
125
126def require_kvm(kvm_dev="/dev/kvm", fatal=False):
127 """Test if KVM is available.
128
129 Keyword arguments:
130 kvm_dev -- Device to test (normally /dev/kvm)
131 fatal -- Set to True to indicate that the test should fail
132 instead of being skipped.
133 """
134
135 require_sim_object("BaseKvmCPU", fatal=fatal)
136 require_file(kvm_dev, fatal=fatal, mode=os.R_OK | os.W_OK)
137
138def run_test(root):
139 """Default run_test implementations. Scripts can override it."""
140
141 # instantiate configuration
142 m5.instantiate()
143
144 # simulate until program terminates
145 exit_event = m5.simulate(maxtick)
146 print 'Exiting @ tick', m5.curTick(), 'because', exit_event.getCause()
147
148# Since we're in batch mode, dont allow tcp socket connections
149m5.disableAllListeners()
150
151# single "path" arg encodes everything we need to know about test
152(category, mode, name, isa, opsys, config) = sys.argv[1].split('/')[-6:]
153
154# find path to directory containing this file
155tests_root = os.path.dirname(__file__)
156test_progs = os.environ.get('M5_TEST_PROGS', '/dist/m5/regression/test-progs')
157if not os.path.isdir(test_progs):
158 test_progs = joinpath(tests_root, 'test-progs')
159
160# generate path to binary file
161def binpath(app, file=None):
162 # executable has same name as app unless specified otherwise
163 if not file:
164 file = app
165 return joinpath(test_progs, app, 'bin', isa, opsys, file)
166
167# generate path to input file
168def inputpath(app, file=None):
169 # input file has same name as app unless specified otherwise
170 if not file:
171 file = app
172 return joinpath(test_progs, app, 'input', file)
173
174# build configuration
175sys.path.append(joinpath(tests_root, 'configs'))
176test_filename = config
177# for ruby configurations, remove the protocol name from the test filename
178if re.search('-ruby', test_filename):
179 test_filename = test_filename.split('-ruby')[0]+'-ruby'
180execfile(joinpath(tests_root, 'configs', test_filename + '.py'))
181
182# set default maxtick... script can override
183# -1 means run forever
184maxtick = m5.MaxTick
185
186# tweak configuration for specific test
187sys.path.append(joinpath(tests_root, category, mode, name))
188execfile(joinpath(tests_root, category, mode, name, 'test.py'))
189
190# Initialize all CPUs in a system
191def initCPUs(sys):
192 def initCPU(cpu):
193 # We might actually have a MemTest object or something similar
194 # here that just pretends to be a CPU.
| 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
47import os.path
48import os
49
50import m5
51
52def skip_test(reason=""):
53 """Signal that a test should be skipped and optionally print why.
54
55 Keyword arguments:
56 reason -- Reason why the test failed. Output is omitted if empty.
57 """
58
59 if reason:
60 print "Skipping test: %s" % reason
61 sys.exit(2)
62
63def has_sim_object(name):
64 """Test if a SimObject exists in the simulator.
65
66 Arguments:
67 name -- Name of SimObject (string)
68
69 Returns: True if the object exists, False otherwise.
70 """
71
72 try:
73 cls = getattr(m5.objects, name)
74 return issubclass(cls, m5.objects.SimObject)
75 except AttributeError:
76 return False
77
78def require_sim_object(name, fatal=False):
79 """Test if a SimObject exists and abort/skip test if not.
80
81 Arguments:
82 name -- Name of SimObject (string)
83
84 Keyword arguments:
85 fatal -- Set to True to indicate that the test should fail
86 instead of being skipped.
87 """
88
89 if has_sim_object(name):
90 return
91 else:
92 msg = "Test requires the '%s' SimObject." % name
93 if fatal:
94 m5.fatal(msg)
95 else:
96 skip_test(msg)
97
98
99def require_file(path, fatal=False, mode=os.F_OK):
100 """Test if a file exists and abort/skip test if not.
101
102 Arguments:
103 path -- File to test for.
104
105 Keyword arguments:
106 fatal -- Set to True to indicate that the test should fail
107 instead of being skipped.
108 modes -- Mode to test for, default to existence. See the
109 Python documentation for os.access().
110 """
111
112 if os.access(path, mode):
113 return
114 else:
115 msg = "Test requires '%s'" % path
116 if not os.path.exists(path):
117 msg += " which does not exist."
118 else:
119 msg += " which has incorrect permissions."
120
121 if fatal:
122 m5.fatal(msg)
123 else:
124 skip_test(msg)
125
126def require_kvm(kvm_dev="/dev/kvm", fatal=False):
127 """Test if KVM is available.
128
129 Keyword arguments:
130 kvm_dev -- Device to test (normally /dev/kvm)
131 fatal -- Set to True to indicate that the test should fail
132 instead of being skipped.
133 """
134
135 require_sim_object("BaseKvmCPU", fatal=fatal)
136 require_file(kvm_dev, fatal=fatal, mode=os.R_OK | os.W_OK)
137
138def run_test(root):
139 """Default run_test implementations. Scripts can override it."""
140
141 # instantiate configuration
142 m5.instantiate()
143
144 # simulate until program terminates
145 exit_event = m5.simulate(maxtick)
146 print 'Exiting @ tick', m5.curTick(), 'because', exit_event.getCause()
147
148# Since we're in batch mode, dont allow tcp socket connections
149m5.disableAllListeners()
150
151# single "path" arg encodes everything we need to know about test
152(category, mode, name, isa, opsys, config) = sys.argv[1].split('/')[-6:]
153
154# find path to directory containing this file
155tests_root = os.path.dirname(__file__)
156test_progs = os.environ.get('M5_TEST_PROGS', '/dist/m5/regression/test-progs')
157if not os.path.isdir(test_progs):
158 test_progs = joinpath(tests_root, 'test-progs')
159
160# generate path to binary file
161def binpath(app, file=None):
162 # executable has same name as app unless specified otherwise
163 if not file:
164 file = app
165 return joinpath(test_progs, app, 'bin', isa, opsys, file)
166
167# generate path to input file
168def inputpath(app, file=None):
169 # input file has same name as app unless specified otherwise
170 if not file:
171 file = app
172 return joinpath(test_progs, app, 'input', file)
173
174# build configuration
175sys.path.append(joinpath(tests_root, 'configs'))
176test_filename = config
177# for ruby configurations, remove the protocol name from the test filename
178if re.search('-ruby', test_filename):
179 test_filename = test_filename.split('-ruby')[0]+'-ruby'
180execfile(joinpath(tests_root, 'configs', test_filename + '.py'))
181
182# set default maxtick... script can override
183# -1 means run forever
184maxtick = m5.MaxTick
185
186# tweak configuration for specific test
187sys.path.append(joinpath(tests_root, category, mode, name))
188execfile(joinpath(tests_root, category, mode, name, 'test.py'))
189
190# Initialize all CPUs in a system
191def initCPUs(sys):
192 def initCPU(cpu):
193 # We might actually have a MemTest object or something similar
194 # here that just pretends to be a CPU.
|