1#!/usr/bin/env python
2#
3# Copyright (c) 2016 ARM Limited
4# All rights reserved
5#
6# The license below extends only to copyright in the software and shall
7# not be construed as granting a license to any other intellectual
8# property including but not limited to intellectual property relating
9# to a hardware implementation of the functionality of the software
10# licensed hereunder. You may use the software subject to the license
11# terms below provided that you ensure that this notice is replicated
12# unmodified and in its entirety in all distributions of the software,
13# modified or unmodified, in source code or in binary form.
14#
15# Redistribution and use in source and binary forms, with or without
16# modification, are permitted provided that the following conditions are
17# met: redistributions of source code must retain the above copyright
18# notice, this list of conditions and the following disclaimer;
19# redistributions in binary form must reproduce the above copyright
20# notice, this list of conditions and the following disclaimer in the
21# documentation and/or other materials provided with the distribution;
22# neither the name of the copyright holders nor the names of its
23# contributors may be used to endorse or promote products derived from
24# this software without specific prior written permission.
25#
26# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
27# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
28# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
29# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
30# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
31# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
32# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
33# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
34# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
35# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
36# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37#
38# Authors: Andreas Sandberg
39
40from abc import ABCMeta, abstractmethod
41import os
42from collections import namedtuple
43from units import *
44from results import TestResult
45import shutil
46
47_test_base = os.path.join(os.path.dirname(__file__), "..")
48
49ClassicConfig = namedtuple("ClassicConfig", (
50 "category",
51 "mode",
52 "workload",
53 "isa",
54 "os",
55 "config",
56))
57
58# There are currently two "classes" of test
59# configurations. Architecture-specific ones and generic ones
60# (typically SE mode tests). In both cases, the configuration name
61# matches a file in tests/configs/ that will be picked up by the test
62# runner (run.py).
63#
64# Architecture specific configurations are listed in the arch_configs
65# dictionary. This is indexed by a (cpu architecture, gpu
66# architecture) tuple. GPU architecture is optional and may be None.
67#
68# Generic configurations are listed in the generic_configs tuple.
69#
70# When discovering available test cases, this script look uses the
71# test list as a list of /candidate/ configurations. A configuration
72# is only used if a test has a reference output for that
73# configuration. In addition to the base configurations from
74# arch_configs and generic_configs, a Ruby configuration may be
75# appended to the base name (this is probed /in addition/ to the
76# original name. See get_tests() for details.
77#
78arch_configs = {
79 ("alpha", None) : (
80 'tsunami-simple-atomic',
81 'tsunami-simple-timing',
82 'tsunami-simple-atomic-dual',
83 'tsunami-simple-timing-dual',
84 'twosys-tsunami-simple-atomic',
85 'tsunami-o3', 'tsunami-o3-dual',
86 'tsunami-minor', 'tsunami-minor-dual',
87 'tsunami-switcheroo-full',
88 ),
89
90 ("arm", None) : (
91 'simple-atomic-dummychecker',
92 'o3-timing-checker',
93 'realview-simple-atomic',
94 'realview-simple-atomic-dual',
95 'realview-simple-atomic-checkpoint',
96 'realview-simple-timing',
97 'realview-simple-timing-dual',
98 'realview-o3',
99 'realview-o3-checker',
100 'realview-o3-dual',
101 'realview-minor',
102 'realview-minor-dual',
103 'realview-switcheroo-atomic',
104 'realview-switcheroo-timing',
105 'realview-switcheroo-o3',
106 'realview-switcheroo-full',
107 'realview64-simple-atomic',
108 'realview64-simple-atomic-checkpoint',
109 'realview64-simple-atomic-dual',
110 'realview64-simple-timing',
111 'realview64-simple-timing-dual',
112 'realview64-o3',
113 'realview64-o3-checker',
114 'realview64-o3-dual',
115 'realview64-minor',
116 'realview64-minor-dual',
117 'realview64-switcheroo-atomic',
118 'realview64-switcheroo-timing',
119 'realview64-switcheroo-o3',
120 'realview64-switcheroo-full',
121 ),
122
123 ("sparc", None) : (
124 't1000-simple-atomic',
125 't1000-simple-x86',
126 ),
127
128 ("timing", None) : (
129 'pc-simple-atomic',
130 'pc-simple-timing',
131 'pc-o3-timing',
132 'pc-switcheroo-full',
133 ),
134
135 ("x86", "hsail") : (
136 'gpu',
137 ),
138}
139
140generic_configs = (
141 'simple-atomic',
142 'simple-atomic-mp',
143 'simple-timing',
144 'simple-timing-mp',
145
146 'minor-timing',
147 'minor-timing-mp',
148
149 'o3-timing',
150 'o3-timing-mt',
151 'o3-timing-mp',
152
153 'rubytest',
154 'memcheck',
155 'memtest',
156 'memtest-filter',
157 'tgen-simple-mem',
158 'tgen-dram-ctrl',
159
160 'learning-gem5-p1-simple',
161 'learning-gem5-p1-two-level',
162)
163
164all_categories = ("quick", "long")
165all_modes = ("fs", "se")
166
167class Test(object):
168 """Test case base class.
169
170 Test cases consists of one or more test units that are run in two
171 phases. A run phase (units produced by run_units() and a verify
172 phase (units from verify_units()). The verify phase is skipped if
173 the run phase fails.
174
175 """
176
177 __metaclass__ = ABCMeta
178
179 def __init__(self, name):
180 self.test_name = name
181
182 @abstractmethod
183 def ref_files(self):
184 """Get a list of reference files used by this test case"""
185 pass
186
187 @abstractmethod
188 def run_units(self):
189 """Units (typically RunGem5 instances) that describe the run phase of
190 this test.
191
192 """
193 pass
194
195 @abstractmethod
196 def verify_units(self):
197 """Verify the output from the run phase (see run_units())."""
198 pass
199
200 @abstractmethod
201 def update_ref(self):
202 """Update reference files with files from a test run"""
203 pass
204
205 def run(self):
206 """Run this test case and return a list of results"""
207
208 run_results = [ u.run() for u in self.run_units() ]
209 run_ok = all([not r.skipped() and r for r in run_results ])
210
211 verify_results = [
212 u.run() if run_ok else u.skip()
213 for u in self.verify_units()
214 ]
215
| 1#!/usr/bin/env python
2#
3# Copyright (c) 2016 ARM Limited
4# All rights reserved
5#
6# The license below extends only to copyright in the software and shall
7# not be construed as granting a license to any other intellectual
8# property including but not limited to intellectual property relating
9# to a hardware implementation of the functionality of the software
10# licensed hereunder. You may use the software subject to the license
11# terms below provided that you ensure that this notice is replicated
12# unmodified and in its entirety in all distributions of the software,
13# modified or unmodified, in source code or in binary form.
14#
15# Redistribution and use in source and binary forms, with or without
16# modification, are permitted provided that the following conditions are
17# met: redistributions of source code must retain the above copyright
18# notice, this list of conditions and the following disclaimer;
19# redistributions in binary form must reproduce the above copyright
20# notice, this list of conditions and the following disclaimer in the
21# documentation and/or other materials provided with the distribution;
22# neither the name of the copyright holders nor the names of its
23# contributors may be used to endorse or promote products derived from
24# this software without specific prior written permission.
25#
26# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
27# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
28# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
29# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
30# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
31# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
32# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
33# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
34# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
35# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
36# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37#
38# Authors: Andreas Sandberg
39
40from abc import ABCMeta, abstractmethod
41import os
42from collections import namedtuple
43from units import *
44from results import TestResult
45import shutil
46
47_test_base = os.path.join(os.path.dirname(__file__), "..")
48
49ClassicConfig = namedtuple("ClassicConfig", (
50 "category",
51 "mode",
52 "workload",
53 "isa",
54 "os",
55 "config",
56))
57
58# There are currently two "classes" of test
59# configurations. Architecture-specific ones and generic ones
60# (typically SE mode tests). In both cases, the configuration name
61# matches a file in tests/configs/ that will be picked up by the test
62# runner (run.py).
63#
64# Architecture specific configurations are listed in the arch_configs
65# dictionary. This is indexed by a (cpu architecture, gpu
66# architecture) tuple. GPU architecture is optional and may be None.
67#
68# Generic configurations are listed in the generic_configs tuple.
69#
70# When discovering available test cases, this script look uses the
71# test list as a list of /candidate/ configurations. A configuration
72# is only used if a test has a reference output for that
73# configuration. In addition to the base configurations from
74# arch_configs and generic_configs, a Ruby configuration may be
75# appended to the base name (this is probed /in addition/ to the
76# original name. See get_tests() for details.
77#
78arch_configs = {
79 ("alpha", None) : (
80 'tsunami-simple-atomic',
81 'tsunami-simple-timing',
82 'tsunami-simple-atomic-dual',
83 'tsunami-simple-timing-dual',
84 'twosys-tsunami-simple-atomic',
85 'tsunami-o3', 'tsunami-o3-dual',
86 'tsunami-minor', 'tsunami-minor-dual',
87 'tsunami-switcheroo-full',
88 ),
89
90 ("arm", None) : (
91 'simple-atomic-dummychecker',
92 'o3-timing-checker',
93 'realview-simple-atomic',
94 'realview-simple-atomic-dual',
95 'realview-simple-atomic-checkpoint',
96 'realview-simple-timing',
97 'realview-simple-timing-dual',
98 'realview-o3',
99 'realview-o3-checker',
100 'realview-o3-dual',
101 'realview-minor',
102 'realview-minor-dual',
103 'realview-switcheroo-atomic',
104 'realview-switcheroo-timing',
105 'realview-switcheroo-o3',
106 'realview-switcheroo-full',
107 'realview64-simple-atomic',
108 'realview64-simple-atomic-checkpoint',
109 'realview64-simple-atomic-dual',
110 'realview64-simple-timing',
111 'realview64-simple-timing-dual',
112 'realview64-o3',
113 'realview64-o3-checker',
114 'realview64-o3-dual',
115 'realview64-minor',
116 'realview64-minor-dual',
117 'realview64-switcheroo-atomic',
118 'realview64-switcheroo-timing',
119 'realview64-switcheroo-o3',
120 'realview64-switcheroo-full',
121 ),
122
123 ("sparc", None) : (
124 't1000-simple-atomic',
125 't1000-simple-x86',
126 ),
127
128 ("timing", None) : (
129 'pc-simple-atomic',
130 'pc-simple-timing',
131 'pc-o3-timing',
132 'pc-switcheroo-full',
133 ),
134
135 ("x86", "hsail") : (
136 'gpu',
137 ),
138}
139
140generic_configs = (
141 'simple-atomic',
142 'simple-atomic-mp',
143 'simple-timing',
144 'simple-timing-mp',
145
146 'minor-timing',
147 'minor-timing-mp',
148
149 'o3-timing',
150 'o3-timing-mt',
151 'o3-timing-mp',
152
153 'rubytest',
154 'memcheck',
155 'memtest',
156 'memtest-filter',
157 'tgen-simple-mem',
158 'tgen-dram-ctrl',
159
160 'learning-gem5-p1-simple',
161 'learning-gem5-p1-two-level',
162)
163
164all_categories = ("quick", "long")
165all_modes = ("fs", "se")
166
167class Test(object):
168 """Test case base class.
169
170 Test cases consists of one or more test units that are run in two
171 phases. A run phase (units produced by run_units() and a verify
172 phase (units from verify_units()). The verify phase is skipped if
173 the run phase fails.
174
175 """
176
177 __metaclass__ = ABCMeta
178
179 def __init__(self, name):
180 self.test_name = name
181
182 @abstractmethod
183 def ref_files(self):
184 """Get a list of reference files used by this test case"""
185 pass
186
187 @abstractmethod
188 def run_units(self):
189 """Units (typically RunGem5 instances) that describe the run phase of
190 this test.
191
192 """
193 pass
194
195 @abstractmethod
196 def verify_units(self):
197 """Verify the output from the run phase (see run_units())."""
198 pass
199
200 @abstractmethod
201 def update_ref(self):
202 """Update reference files with files from a test run"""
203 pass
204
205 def run(self):
206 """Run this test case and return a list of results"""
207
208 run_results = [ u.run() for u in self.run_units() ]
209 run_ok = all([not r.skipped() and r for r in run_results ])
210
211 verify_results = [
212 u.run() if run_ok else u.skip()
213 for u in self.verify_units()
214 ]
215
|
217
218 def __str__(self):
219 return self.test_name
220
221class ClassicTest(Test):
222 # The diff ignore list contains all files that shouldn't be diffed
223 # using DiffOutFile. These files typically use special-purpose
224 # diff tools (e.g., DiffStatFile).
225 diff_ignore_files = (
226 # Stat files use a special stat differ
227 "stats.txt",
228 )
229
230 # These files should never be included in the list of
231 # reference files. This list should include temporary files
232 # and other files that we don't care about.
233 ref_ignore_files = (
234 )
235
236 def __init__(self, gem5, output_dir, config_tuple,
237 timeout=None,
238 skip=False, skip_diff_out=False, skip_diff_stat=False):
239
240 super(ClassicTest, self).__init__("/".join(config_tuple))
241
242 ct = config_tuple
243
244 self.gem5 = os.path.abspath(gem5)
245 self.script = os.path.join(_test_base, "run.py")
246 self.config_tuple = ct
247 self.timeout = timeout
248
249 self.output_dir = output_dir
250 self.ref_dir = os.path.join(_test_base,
251 ct.category, ct.mode, ct.workload,
252 "ref", ct.isa, ct.os, ct.config)
253 self.skip_run = skip
254 self.skip_diff_out = skip or skip_diff_out
255 self.skip_diff_stat = skip or skip_diff_stat
256
257 def ref_files(self):
258 ref_dir = os.path.abspath(self.ref_dir)
259 for root, dirs, files in os.walk(ref_dir, topdown=False):
260 for f in files:
261 fpath = os.path.join(root[len(ref_dir) + 1:], f)
262 if fpath not in ClassicTest.ref_ignore_files:
263 yield fpath
264
265 def run_units(self):
266 args = [
267 self.script,
268 "/".join(self.config_tuple),
269 ]
270
271 return [
272 RunGem5(self.gem5, args,
273 ref_dir=self.ref_dir, test_dir=self.output_dir,
274 skip=self.skip_run),
275 ]
276
277 def verify_units(self):
278 return [
279 DiffStatFile(ref_dir=self.ref_dir, test_dir=self.output_dir,
280 skip=self.skip_diff_stat)
281 ] + [
282 DiffOutFile(f,
283 ref_dir=self.ref_dir, test_dir=self.output_dir,
284 skip=self.skip_diff_out)
285 for f in self.ref_files()
286 if f not in ClassicTest.diff_ignore_files
287 ]
288
289 def update_ref(self):
290 for fname in self.ref_files():
291 shutil.copy(
292 os.path.join(self.output_dir, fname),
293 os.path.join(self.ref_dir, fname))
294
295def parse_test_filter(test_filter):
296 wildcards = ("", "*")
297
298 _filter = list(test_filter.split("/"))
299 if len(_filter) > 3:
300 raise RuntimeError("Illegal test filter string")
301 _filter += [ "", ] * (3 - len(_filter))
302
303 isa, cat, mode = _filter
304
305 if isa in wildcards:
306 raise RuntimeError("No ISA specified")
307
308 cat = all_categories if cat in wildcards else (cat, )
309 mode = all_modes if mode in wildcards else (mode, )
310
311 return isa, cat, mode
312
313def get_tests(isa,
314 categories=all_categories, modes=all_modes,
315 ruby_protocol=None, gpu_isa=None):
316
317 # Generate a list of candidate configs
318 configs = list(arch_configs.get((isa, gpu_isa), []))
319
320 if (isa, gpu_isa) == ("x86", "hsail"):
321 if ruby_protocol == "GPU_RfO":
322 configs += ['gpu-randomtest']
323 else:
324 configs += generic_configs
325
326 if ruby_protocol == 'MI_example':
327 configs += [ "%s-ruby" % (c, ) for c in configs ]
328 elif ruby_protocol is not None:
329 # Override generic ISA configs when using Ruby (excluding
330 # MI_example which is included in all ISAs by default). This
331 # reduces the number of generic tests we re-run for when
332 # compiling Ruby targets.
333 configs = [ "%s-ruby-%s" % (c, ruby_protocol) for c in configs ]
334
335 # /(quick|long)/(fs|se)/workload/ref/arch/guest/config/
336 for conf_script in configs:
337 for cat in categories:
338 for mode in modes:
339 mode_dir = os.path.join(_test_base, cat, mode)
340 if not os.path.exists(mode_dir):
341 continue
342
343 for workload in os.listdir(mode_dir):
344 isa_dir = os.path.join(mode_dir, workload, "ref", isa)
345 if not os.path.isdir(isa_dir):
346 continue
347
348 for _os in os.listdir(isa_dir):
349 test_dir = os.path.join(isa_dir, _os, conf_script)
350 if not os.path.exists(test_dir) or \
351 os.path.exists(os.path.join(test_dir, "skip")):
352 continue
353
354 yield ClassicConfig(cat, mode, workload, isa, _os,
355 conf_script)
| 219
220 def __str__(self):
221 return self.test_name
222
223class ClassicTest(Test):
224 # The diff ignore list contains all files that shouldn't be diffed
225 # using DiffOutFile. These files typically use special-purpose
226 # diff tools (e.g., DiffStatFile).
227 diff_ignore_files = (
228 # Stat files use a special stat differ
229 "stats.txt",
230 )
231
232 # These files should never be included in the list of
233 # reference files. This list should include temporary files
234 # and other files that we don't care about.
235 ref_ignore_files = (
236 )
237
238 def __init__(self, gem5, output_dir, config_tuple,
239 timeout=None,
240 skip=False, skip_diff_out=False, skip_diff_stat=False):
241
242 super(ClassicTest, self).__init__("/".join(config_tuple))
243
244 ct = config_tuple
245
246 self.gem5 = os.path.abspath(gem5)
247 self.script = os.path.join(_test_base, "run.py")
248 self.config_tuple = ct
249 self.timeout = timeout
250
251 self.output_dir = output_dir
252 self.ref_dir = os.path.join(_test_base,
253 ct.category, ct.mode, ct.workload,
254 "ref", ct.isa, ct.os, ct.config)
255 self.skip_run = skip
256 self.skip_diff_out = skip or skip_diff_out
257 self.skip_diff_stat = skip or skip_diff_stat
258
259 def ref_files(self):
260 ref_dir = os.path.abspath(self.ref_dir)
261 for root, dirs, files in os.walk(ref_dir, topdown=False):
262 for f in files:
263 fpath = os.path.join(root[len(ref_dir) + 1:], f)
264 if fpath not in ClassicTest.ref_ignore_files:
265 yield fpath
266
267 def run_units(self):
268 args = [
269 self.script,
270 "/".join(self.config_tuple),
271 ]
272
273 return [
274 RunGem5(self.gem5, args,
275 ref_dir=self.ref_dir, test_dir=self.output_dir,
276 skip=self.skip_run),
277 ]
278
279 def verify_units(self):
280 return [
281 DiffStatFile(ref_dir=self.ref_dir, test_dir=self.output_dir,
282 skip=self.skip_diff_stat)
283 ] + [
284 DiffOutFile(f,
285 ref_dir=self.ref_dir, test_dir=self.output_dir,
286 skip=self.skip_diff_out)
287 for f in self.ref_files()
288 if f not in ClassicTest.diff_ignore_files
289 ]
290
291 def update_ref(self):
292 for fname in self.ref_files():
293 shutil.copy(
294 os.path.join(self.output_dir, fname),
295 os.path.join(self.ref_dir, fname))
296
297def parse_test_filter(test_filter):
298 wildcards = ("", "*")
299
300 _filter = list(test_filter.split("/"))
301 if len(_filter) > 3:
302 raise RuntimeError("Illegal test filter string")
303 _filter += [ "", ] * (3 - len(_filter))
304
305 isa, cat, mode = _filter
306
307 if isa in wildcards:
308 raise RuntimeError("No ISA specified")
309
310 cat = all_categories if cat in wildcards else (cat, )
311 mode = all_modes if mode in wildcards else (mode, )
312
313 return isa, cat, mode
314
315def get_tests(isa,
316 categories=all_categories, modes=all_modes,
317 ruby_protocol=None, gpu_isa=None):
318
319 # Generate a list of candidate configs
320 configs = list(arch_configs.get((isa, gpu_isa), []))
321
322 if (isa, gpu_isa) == ("x86", "hsail"):
323 if ruby_protocol == "GPU_RfO":
324 configs += ['gpu-randomtest']
325 else:
326 configs += generic_configs
327
328 if ruby_protocol == 'MI_example':
329 configs += [ "%s-ruby" % (c, ) for c in configs ]
330 elif ruby_protocol is not None:
331 # Override generic ISA configs when using Ruby (excluding
332 # MI_example which is included in all ISAs by default). This
333 # reduces the number of generic tests we re-run for when
334 # compiling Ruby targets.
335 configs = [ "%s-ruby-%s" % (c, ruby_protocol) for c in configs ]
336
337 # /(quick|long)/(fs|se)/workload/ref/arch/guest/config/
338 for conf_script in configs:
339 for cat in categories:
340 for mode in modes:
341 mode_dir = os.path.join(_test_base, cat, mode)
342 if not os.path.exists(mode_dir):
343 continue
344
345 for workload in os.listdir(mode_dir):
346 isa_dir = os.path.join(mode_dir, workload, "ref", isa)
347 if not os.path.isdir(isa_dir):
348 continue
349
350 for _os in os.listdir(isa_dir):
351 test_dir = os.path.join(isa_dir, _os, conf_script)
352 if not os.path.exists(test_dir) or \
353 os.path.exists(os.path.join(test_dir, "skip")):
354 continue
355
356 yield ClassicConfig(cat, mode, workload, isa, _os,
357 conf_script)
|