run.py revision 12575
19401SAndreas.Sandberg@ARM.com# Copyright (c) 2012 ARM Limited 29401SAndreas.Sandberg@ARM.com# All rights reserved 39401SAndreas.Sandberg@ARM.com# 49401SAndreas.Sandberg@ARM.com# The license below extends only to copyright in the software and shall 59401SAndreas.Sandberg@ARM.com# not be construed as granting a license to any other intellectual 69401SAndreas.Sandberg@ARM.com# property including but not limited to intellectual property relating 79401SAndreas.Sandberg@ARM.com# to a hardware implementation of the functionality of the software 89401SAndreas.Sandberg@ARM.com# licensed hereunder. You may use the software subject to the license 99401SAndreas.Sandberg@ARM.com# terms below provided that you ensure that this notice is replicated 109401SAndreas.Sandberg@ARM.com# unmodified and in its entirety in all distributions of the software, 119401SAndreas.Sandberg@ARM.com# modified or unmodified, in source code or in binary form. 129401SAndreas.Sandberg@ARM.com# 134977Ssaidi@eecs.umich.edu# Copyright (c) 2006-2007 The Regents of The University of Michigan 142997Sstever@eecs.umich.edu# All rights reserved. 152997Sstever@eecs.umich.edu# 162997Sstever@eecs.umich.edu# Redistribution and use in source and binary forms, with or without 172997Sstever@eecs.umich.edu# modification, are permitted provided that the following conditions are 182997Sstever@eecs.umich.edu# met: redistributions of source code must retain the above copyright 192997Sstever@eecs.umich.edu# notice, this list of conditions and the following disclaimer; 202997Sstever@eecs.umich.edu# redistributions in binary form must reproduce the above copyright 212997Sstever@eecs.umich.edu# notice, this list of conditions and the following disclaimer in the 222997Sstever@eecs.umich.edu# documentation and/or other materials provided with the distribution; 232997Sstever@eecs.umich.edu# neither the name of the copyright holders nor the names of its 242997Sstever@eecs.umich.edu# contributors may be used to endorse or promote products derived from 252997Sstever@eecs.umich.edu# this software without specific prior written permission. 262997Sstever@eecs.umich.edu# 272997Sstever@eecs.umich.edu# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 282997Sstever@eecs.umich.edu# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 292997Sstever@eecs.umich.edu# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 302997Sstever@eecs.umich.edu# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 312997Sstever@eecs.umich.edu# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 322997Sstever@eecs.umich.edu# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 332997Sstever@eecs.umich.edu# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 342997Sstever@eecs.umich.edu# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 352997Sstever@eecs.umich.edu# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 362997Sstever@eecs.umich.edu# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 372997Sstever@eecs.umich.edu# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 382997Sstever@eecs.umich.edu# 392997Sstever@eecs.umich.edu# Authors: Steve Reinhardt 402997Sstever@eecs.umich.edu 4112575Sgiacomo.travaglini@arm.comfrom __future__ import print_function 4212575Sgiacomo.travaglini@arm.com 435523Snate@binkert.orgimport os 445523Snate@binkert.orgimport sys 456928SBrad.Beckmann@amd.comimport re 466928SBrad.Beckmann@amd.comimport string 476289Snate@binkert.org 486289Snate@binkert.orgfrom os.path import join as joinpath 499654SAndreas.Sandberg@ARM.comimport os.path 509654SAndreas.Sandberg@ARM.comimport os 516289Snate@binkert.org 525523Snate@binkert.orgimport m5 535523Snate@binkert.org 549401SAndreas.Sandberg@ARM.comdef skip_test(reason=""): 559401SAndreas.Sandberg@ARM.com """Signal that a test should be skipped and optionally print why. 569401SAndreas.Sandberg@ARM.com 579401SAndreas.Sandberg@ARM.com Keyword arguments: 589401SAndreas.Sandberg@ARM.com reason -- Reason why the test failed. Output is omitted if empty. 599401SAndreas.Sandberg@ARM.com """ 609401SAndreas.Sandberg@ARM.com 619401SAndreas.Sandberg@ARM.com if reason: 6212575Sgiacomo.travaglini@arm.com print("Skipping test: %s" % reason) 639401SAndreas.Sandberg@ARM.com sys.exit(2) 649401SAndreas.Sandberg@ARM.com 659401SAndreas.Sandberg@ARM.comdef has_sim_object(name): 669401SAndreas.Sandberg@ARM.com """Test if a SimObject exists in the simulator. 679401SAndreas.Sandberg@ARM.com 689401SAndreas.Sandberg@ARM.com Arguments: 699401SAndreas.Sandberg@ARM.com name -- Name of SimObject (string) 709401SAndreas.Sandberg@ARM.com 719401SAndreas.Sandberg@ARM.com Returns: True if the object exists, False otherwise. 729401SAndreas.Sandberg@ARM.com """ 739401SAndreas.Sandberg@ARM.com 749401SAndreas.Sandberg@ARM.com try: 759401SAndreas.Sandberg@ARM.com cls = getattr(m5.objects, name) 769401SAndreas.Sandberg@ARM.com return issubclass(cls, m5.objects.SimObject) 779401SAndreas.Sandberg@ARM.com except AttributeError: 789401SAndreas.Sandberg@ARM.com return False 799401SAndreas.Sandberg@ARM.com 809401SAndreas.Sandberg@ARM.comdef require_sim_object(name, fatal=False): 819401SAndreas.Sandberg@ARM.com """Test if a SimObject exists and abort/skip test if not. 829401SAndreas.Sandberg@ARM.com 839401SAndreas.Sandberg@ARM.com Arguments: 849401SAndreas.Sandberg@ARM.com name -- Name of SimObject (string) 859401SAndreas.Sandberg@ARM.com 869401SAndreas.Sandberg@ARM.com Keyword arguments: 879401SAndreas.Sandberg@ARM.com fatal -- Set to True to indicate that the test should fail 889401SAndreas.Sandberg@ARM.com instead of being skipped. 899401SAndreas.Sandberg@ARM.com """ 909401SAndreas.Sandberg@ARM.com 919401SAndreas.Sandberg@ARM.com if has_sim_object(name): 929401SAndreas.Sandberg@ARM.com return 939401SAndreas.Sandberg@ARM.com else: 949401SAndreas.Sandberg@ARM.com msg = "Test requires the '%s' SimObject." % name 959401SAndreas.Sandberg@ARM.com if fatal: 969401SAndreas.Sandberg@ARM.com m5.fatal(msg) 979401SAndreas.Sandberg@ARM.com else: 989401SAndreas.Sandberg@ARM.com skip_test(msg) 999401SAndreas.Sandberg@ARM.com 1009654SAndreas.Sandberg@ARM.com 1019654SAndreas.Sandberg@ARM.comdef require_file(path, fatal=False, mode=os.F_OK): 1029654SAndreas.Sandberg@ARM.com """Test if a file exists and abort/skip test if not. 1039654SAndreas.Sandberg@ARM.com 1049654SAndreas.Sandberg@ARM.com Arguments: 1059654SAndreas.Sandberg@ARM.com path -- File to test for. 1069654SAndreas.Sandberg@ARM.com 1079654SAndreas.Sandberg@ARM.com Keyword arguments: 1089654SAndreas.Sandberg@ARM.com fatal -- Set to True to indicate that the test should fail 1099654SAndreas.Sandberg@ARM.com instead of being skipped. 1109654SAndreas.Sandberg@ARM.com modes -- Mode to test for, default to existence. See the 1119654SAndreas.Sandberg@ARM.com Python documentation for os.access(). 1129654SAndreas.Sandberg@ARM.com """ 1139654SAndreas.Sandberg@ARM.com 1149654SAndreas.Sandberg@ARM.com if os.access(path, mode): 1159654SAndreas.Sandberg@ARM.com return 1169654SAndreas.Sandberg@ARM.com else: 1179654SAndreas.Sandberg@ARM.com msg = "Test requires '%s'" % path 1189654SAndreas.Sandberg@ARM.com if not os.path.exists(path): 1199654SAndreas.Sandberg@ARM.com msg += " which does not exist." 1209654SAndreas.Sandberg@ARM.com else: 1219654SAndreas.Sandberg@ARM.com msg += " which has incorrect permissions." 1229654SAndreas.Sandberg@ARM.com 1239654SAndreas.Sandberg@ARM.com if fatal: 1249654SAndreas.Sandberg@ARM.com m5.fatal(msg) 1259654SAndreas.Sandberg@ARM.com else: 1269654SAndreas.Sandberg@ARM.com skip_test(msg) 1279654SAndreas.Sandberg@ARM.com 1289654SAndreas.Sandberg@ARM.comdef require_kvm(kvm_dev="/dev/kvm", fatal=False): 1299654SAndreas.Sandberg@ARM.com """Test if KVM is available. 1309654SAndreas.Sandberg@ARM.com 1319654SAndreas.Sandberg@ARM.com Keyword arguments: 1329654SAndreas.Sandberg@ARM.com kvm_dev -- Device to test (normally /dev/kvm) 1339654SAndreas.Sandberg@ARM.com fatal -- Set to True to indicate that the test should fail 1349654SAndreas.Sandberg@ARM.com instead of being skipped. 1359654SAndreas.Sandberg@ARM.com """ 1369654SAndreas.Sandberg@ARM.com 1379654SAndreas.Sandberg@ARM.com require_sim_object("BaseKvmCPU", fatal=fatal) 1389654SAndreas.Sandberg@ARM.com require_file(kvm_dev, fatal=fatal, mode=os.R_OK | os.W_OK) 1399654SAndreas.Sandberg@ARM.com 1409447SAndreas.Sandberg@ARM.comdef run_test(root): 1419447SAndreas.Sandberg@ARM.com """Default run_test implementations. Scripts can override it.""" 1429447SAndreas.Sandberg@ARM.com 1439447SAndreas.Sandberg@ARM.com # instantiate configuration 1449447SAndreas.Sandberg@ARM.com m5.instantiate() 1459447SAndreas.Sandberg@ARM.com 1469447SAndreas.Sandberg@ARM.com # simulate until program terminates 1479447SAndreas.Sandberg@ARM.com exit_event = m5.simulate(maxtick) 14812575Sgiacomo.travaglini@arm.com print('Exiting @ tick', m5.curTick(), 'because', exit_event.getCause()) 1499447SAndreas.Sandberg@ARM.com 1505523Snate@binkert.org# Since we're in batch mode, dont allow tcp socket connections 1515523Snate@binkert.orgm5.disableAllListeners() 1522997Sstever@eecs.umich.edu 1532997Sstever@eecs.umich.edu# single "path" arg encodes everything we need to know about test 1548802Sgblack@eecs.umich.edu(category, mode, name, isa, opsys, config) = sys.argv[1].split('/')[-6:] 1552997Sstever@eecs.umich.edu 1562997Sstever@eecs.umich.edu# find path to directory containing this file 1572997Sstever@eecs.umich.edutests_root = os.path.dirname(__file__) 1586874SSteve.Reinhardt@amd.comtest_progs = os.environ.get('M5_TEST_PROGS', '/dist/m5/regression/test-progs') 1596874SSteve.Reinhardt@amd.comif not os.path.isdir(test_progs): 1606289Snate@binkert.org test_progs = joinpath(tests_root, 'test-progs') 1612998Sstever@eecs.umich.edu 1622998Sstever@eecs.umich.edu# generate path to binary file 1632998Sstever@eecs.umich.edudef binpath(app, file=None): 1642998Sstever@eecs.umich.edu # executable has same name as app unless specified otherwise 1652998Sstever@eecs.umich.edu if not file: 1662998Sstever@eecs.umich.edu file = app 1676289Snate@binkert.org return joinpath(test_progs, app, 'bin', isa, opsys, file) 1682997Sstever@eecs.umich.edu 1693475Sktlim@umich.edu# generate path to input file 1703475Sktlim@umich.edudef inputpath(app, file=None): 1713475Sktlim@umich.edu # input file has same name as app unless specified otherwise 1723475Sktlim@umich.edu if not file: 1733475Sktlim@umich.edu file = app 1746289Snate@binkert.org return joinpath(test_progs, app, 'input', file) 1753475Sktlim@umich.edu 17611475Sandreas.sandberg@arm.comdef srcpath(path): 17711475Sandreas.sandberg@arm.com """Path to file in gem5's source tree""" 17811475Sandreas.sandberg@arm.com return joinpath(os.path.dirname(__file__), "..", path) 17911475Sandreas.sandberg@arm.com 1802997Sstever@eecs.umich.edu# build configuration 1816289Snate@binkert.orgsys.path.append(joinpath(tests_root, 'configs')) 1826928SBrad.Beckmann@amd.comtest_filename = config 1836928SBrad.Beckmann@amd.com# for ruby configurations, remove the protocol name from the test filename 1846928SBrad.Beckmann@amd.comif re.search('-ruby', test_filename): 1856928SBrad.Beckmann@amd.com test_filename = test_filename.split('-ruby')[0]+'-ruby' 1866928SBrad.Beckmann@amd.comexecfile(joinpath(tests_root, 'configs', test_filename + '.py')) 1872997Sstever@eecs.umich.edu 1882997Sstever@eecs.umich.edu# set default maxtick... script can override 1892998Sstever@eecs.umich.edu# -1 means run forever 1905523Snate@binkert.orgmaxtick = m5.MaxTick 1912997Sstever@eecs.umich.edu 1922997Sstever@eecs.umich.edu# tweak configuration for specific test 1938802Sgblack@eecs.umich.edusys.path.append(joinpath(tests_root, category, mode, name)) 1948802Sgblack@eecs.umich.eduexecfile(joinpath(tests_root, category, mode, name, 'test.py')) 1952997Sstever@eecs.umich.edu 1969384SAndreas.Sandberg@arm.com# Initialize all CPUs in a system 1979384SAndreas.Sandberg@arm.comdef initCPUs(sys): 1989384SAndreas.Sandberg@arm.com def initCPU(cpu): 1999384SAndreas.Sandberg@arm.com # We might actually have a MemTest object or something similar 2009384SAndreas.Sandberg@arm.com # here that just pretends to be a CPU. 2019851Sandreas.hansson@arm.com try: 2029384SAndreas.Sandberg@arm.com cpu.createThreads() 2039851Sandreas.hansson@arm.com except: 2049851Sandreas.hansson@arm.com pass 2059384SAndreas.Sandberg@arm.com 2069384SAndreas.Sandberg@arm.com # The CPU attribute doesn't exist in some cases, e.g. the Ruby 2079384SAndreas.Sandberg@arm.com # testers. 2089384SAndreas.Sandberg@arm.com if not hasattr(sys, "cpu"): 2099384SAndreas.Sandberg@arm.com return 2109384SAndreas.Sandberg@arm.com 2119384SAndreas.Sandberg@arm.com # The CPU can either be a list of CPUs or a single object. 2129384SAndreas.Sandberg@arm.com if isinstance(sys.cpu, list): 2139384SAndreas.Sandberg@arm.com [ initCPU(cpu) for cpu in sys.cpu ] 2149384SAndreas.Sandberg@arm.com else: 2159384SAndreas.Sandberg@arm.com initCPU(sys.cpu) 2169384SAndreas.Sandberg@arm.com 2179384SAndreas.Sandberg@arm.com# We might be creating a single system or a dual system. Try 2189384SAndreas.Sandberg@arm.com# initializing the CPUs in all known system attributes. 2199384SAndreas.Sandberg@arm.comfor sysattr in [ "system", "testsys", "drivesys" ]: 2209384SAndreas.Sandberg@arm.com if hasattr(root, sysattr): 2219384SAndreas.Sandberg@arm.com initCPUs(getattr(root, sysattr)) 2229384SAndreas.Sandberg@arm.com 2239447SAndreas.Sandberg@ARM.comrun_test(root) 224