1#!/usr/bin/env python2
2#
3# Copyright (c) 2016-2017 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
164default_ruby_protocol = {
165 "arm" : "MOESI_CMP_directory",
166}
167
168def get_default_protocol(arch):
|
170
171all_categories = ("quick", "long")
172all_modes = ("fs", "se")
173
174class Test(object):
175 """Test case base class.
176
177 Test cases consists of one or more test units that are run in two
178 phases. A run phase (units produced by run_units() and a verify
179 phase (units from verify_units()). The verify phase is skipped if
180 the run phase fails.
181
182 """
183
184 __metaclass__ = ABCMeta
185
186 def __init__(self, name):
187 self.test_name = name
188
189 @abstractmethod
190 def ref_files(self):
191 """Get a list of reference files used by this test case"""
192 pass
193
194 @abstractmethod
195 def run_units(self):
196 """Units (typically RunGem5 instances) that describe the run phase of
197 this test.
198
199 """
200 pass
201
202 @abstractmethod
203 def verify_units(self):
204 """Verify the output from the run phase (see run_units())."""
205 pass
206
207 @abstractmethod
208 def update_ref(self):
209 """Update reference files with files from a test run"""
210 pass
211
212 def run(self):
213 """Run this test case and return a list of results"""
214
215 run_results = [ u.run() for u in self.run_units() ]
216 run_ok = all([not r.skipped() and r for r in run_results ])
217
218 verify_results = [
219 u.run() if run_ok else u.skip()
220 for u in self.verify_units()
221 ]
222
223 return TestResult(self.test_name,
224 run_results=run_results,
225 verify_results=verify_results)
226
227 def __str__(self):
228 return self.test_name
229
230class ClassicTest(Test):
231 # The diff ignore list contains all files that shouldn't be diffed
232 # using DiffOutFile. These files typically use special-purpose
233 # diff tools (e.g., DiffStatFile).
234 diff_ignore_files = FileIgnoreList(
235 names=(
236 # Stat files use a special stat differ
237 "stats.txt",
238 ), rex=(
239 ))
240
241 # These files should never be included in the list of
242 # reference files. This list should include temporary files
243 # and other files that we don't care about.
244 ref_ignore_files = FileIgnoreList(
245 names=(
246 "EMPTY",
247 ), rex=(
248 # Mercurial sometimes leaves backups when applying MQ patches
249 r"\.orig$",
250 r"\.rej$",
251 ))
252
253 def __init__(self, gem5, output_dir, config_tuple,
254 timeout=None,
255 skip=False, skip_diff_out=False, skip_diff_stat=False):
256
257 super(ClassicTest, self).__init__("/".join(config_tuple))
258
259 ct = config_tuple
260
261 self.gem5 = os.path.abspath(gem5)
262 self.script = os.path.join(_test_base, "run.py")
263 self.config_tuple = ct
264 self.timeout = timeout
265
266 self.output_dir = output_dir
267 self.ref_dir = os.path.join(_test_base,
268 ct.category, ct.mode, ct.workload,
269 "ref", ct.isa, ct.os, ct.config)
270 self.skip_run = skip
271 self.skip_diff_out = skip or skip_diff_out
272 self.skip_diff_stat = skip or skip_diff_stat
273
274 def ref_files(self):
275 ref_dir = os.path.abspath(self.ref_dir)
276 for root, dirs, files in os.walk(ref_dir, topdown=False):
277 for f in files:
278 fpath = os.path.join(root[len(ref_dir) + 1:], f)
279 if fpath not in ClassicTest.ref_ignore_files:
280 yield fpath
281
282 def run_units(self):
283 args = [
284 self.script,
285 "/".join(self.config_tuple),
286 ]
287
288 return [
289 RunGem5(self.gem5, args,
290 ref_dir=self.ref_dir, test_dir=self.output_dir,
291 skip=self.skip_run),
292 ]
293
294 def verify_units(self):
295 ref_files = set(self.ref_files())
296 units = []
297 if "stats.txt" in ref_files:
298 units.append(
299 DiffStatFile(ref_dir=self.ref_dir, test_dir=self.output_dir,
300 skip=self.skip_diff_stat))
301 units += [
302 DiffOutFile(f,
303 ref_dir=self.ref_dir, test_dir=self.output_dir,
304 skip=self.skip_diff_out)
305 for f in ref_files if f not in ClassicTest.diff_ignore_files
306 ]
307
308 return units
309
310 def update_ref(self):
311 for fname in self.ref_files():
312 shutil.copy(
313 os.path.join(self.output_dir, fname),
314 os.path.join(self.ref_dir, fname))
315
316def parse_test_filter(test_filter):
317 wildcards = ("", "*")
318
319 _filter = list(test_filter.split("/"))
320 if len(_filter) > 3:
321 raise RuntimeError("Illegal test filter string")
322 _filter += [ "", ] * (3 - len(_filter))
323
324 isa, cat, mode = _filter
325
326 if isa in wildcards:
327 raise RuntimeError("No ISA specified")
328
329 cat = all_categories if cat in wildcards else (cat, )
330 mode = all_modes if mode in wildcards else (mode, )
331
332 return isa, cat, mode
333
334def get_tests(isa,
335 categories=all_categories, modes=all_modes,
336 ruby_protocol=None, gpu_isa=None):
337
338 # Generate a list of candidate configs
339 configs = list(arch_configs.get((isa, gpu_isa), []))
340
341 if (isa, gpu_isa) == ("x86", "hsail"):
342 if ruby_protocol == "GPU_RfO":
343 configs += ['gpu-randomtest']
344 else:
345 configs += generic_configs
346
347 if ruby_protocol == get_default_protocol(isa):
348 if ruby_protocol == 'MI_example':
349 configs += [ "%s-ruby" % (c, ) for c in configs ]
350 else:
351 configs += [ "%s-ruby-%s" % (c, ruby_protocol) for c in configs ]
352 elif ruby_protocol is not None:
353 # Override generic ISA configs when using Ruby (excluding
354 # MI_example which is included in all ISAs by default). This
355 # reduces the number of generic tests we re-run for when
356 # compiling Ruby targets.
357 configs = [ "%s-ruby-%s" % (c, ruby_protocol) for c in configs ]
358
359 # /(quick|long)/(fs|se)/workload/ref/arch/guest/config/
360 for conf_script in configs:
361 for cat in categories:
362 for mode in modes:
363 mode_dir = os.path.join(_test_base, cat, mode)
364 if not os.path.exists(mode_dir):
365 continue
366
367 for workload in os.listdir(mode_dir):
368 isa_dir = os.path.join(mode_dir, workload, "ref", isa)
369 if not os.path.isdir(isa_dir):
370 continue
371
372 for _os in os.listdir(isa_dir):
373 test_dir = os.path.join(isa_dir, _os, conf_script)
374 if not os.path.exists(test_dir) or \
375 os.path.exists(os.path.join(test_dir, "skip")):
376 continue
377
378 yield ClassicConfig(cat, mode, workload, isa, _os,
379 conf_script)
|