simulate.py revision 9344
18999Suri.wiener@arm.com# Copyright (c) 2012 ARM Limited 28999Suri.wiener@arm.com# All rights reserved. 38999Suri.wiener@arm.com# 48999Suri.wiener@arm.com# The license below extends only to copyright in the software and shall 58999Suri.wiener@arm.com# not be construed as granting a license to any other intellectual 68999Suri.wiener@arm.com# property including but not limited to intellectual property relating 78999Suri.wiener@arm.com# to a hardware implementation of the functionality of the software 88999Suri.wiener@arm.com# licensed hereunder. You may use the software subject to the license 98999Suri.wiener@arm.com# terms below provided that you ensure that this notice is replicated 108999Suri.wiener@arm.com# unmodified and in its entirety in all distributions of the software, 118999Suri.wiener@arm.com# modified or unmodified, in source code or in binary form. 128999Suri.wiener@arm.com# 134762Snate@binkert.org# Copyright (c) 2005 The Regents of The University of Michigan 147534Ssteve.reinhardt@amd.com# Copyright (c) 2010 Advanced Micro Devices, Inc. 154762Snate@binkert.org# All rights reserved. 164762Snate@binkert.org# 174762Snate@binkert.org# Redistribution and use in source and binary forms, with or without 184762Snate@binkert.org# modification, are permitted provided that the following conditions are 194762Snate@binkert.org# met: redistributions of source code must retain the above copyright 204762Snate@binkert.org# notice, this list of conditions and the following disclaimer; 214762Snate@binkert.org# redistributions in binary form must reproduce the above copyright 224762Snate@binkert.org# notice, this list of conditions and the following disclaimer in the 234762Snate@binkert.org# documentation and/or other materials provided with the distribution; 244762Snate@binkert.org# neither the name of the copyright holders nor the names of its 254762Snate@binkert.org# contributors may be used to endorse or promote products derived from 264762Snate@binkert.org# this software without specific prior written permission. 274762Snate@binkert.org# 284762Snate@binkert.org# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 294762Snate@binkert.org# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 304762Snate@binkert.org# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 314762Snate@binkert.org# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 324762Snate@binkert.org# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 334762Snate@binkert.org# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 344762Snate@binkert.org# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 354762Snate@binkert.org# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 364762Snate@binkert.org# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 374762Snate@binkert.org# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 384762Snate@binkert.org# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 394762Snate@binkert.org# 404762Snate@binkert.org# Authors: Nathan Binkert 414762Snate@binkert.org# Steve Reinhardt 424762Snate@binkert.org 434762Snate@binkert.orgimport atexit 444762Snate@binkert.orgimport os 454762Snate@binkert.orgimport sys 464762Snate@binkert.org 474762Snate@binkert.org# import the SWIG-wrapped main C++ functions 484762Snate@binkert.orgimport internal 496001Snate@binkert.orgimport core 506001Snate@binkert.orgimport stats 514762Snate@binkert.orgimport SimObject 524762Snate@binkert.orgimport ticks 534851Snate@binkert.orgimport objects 548999Suri.wiener@arm.comfrom m5.util.dot_writer import do_dot 559262Ssascha.bischoff@arm.comfrom m5.internal.stats import updateEvents as updateStatEvents 568999Suri.wiener@arm.com 577525Ssteve.reinhardt@amd.comfrom util import fatal 588664SAli.Saidi@ARM.comfrom util import attrdict 594762Snate@binkert.org 606654Snate@binkert.org# define a MaxTick parameter 616654Snate@binkert.orgMaxTick = 2**63 - 1 626654Snate@binkert.org 634762Snate@binkert.org# The final hook to generate .ini files. Called from the user script 644762Snate@binkert.org# once the config is built. 657531Ssteve.reinhardt@amd.comdef instantiate(ckpt_dir=None): 668245Snate@binkert.org from m5 import options 678234Snate@binkert.org 687525Ssteve.reinhardt@amd.com root = objects.Root.getInstance() 697525Ssteve.reinhardt@amd.com 707525Ssteve.reinhardt@amd.com if not root: 717525Ssteve.reinhardt@amd.com fatal("Need to instantiate Root() before calling instantiate()") 727525Ssteve.reinhardt@amd.com 734762Snate@binkert.org # we need to fix the global frequency 744762Snate@binkert.org ticks.fixGlobalFrequency() 754762Snate@binkert.org 767528Ssteve.reinhardt@amd.com # Make sure SimObject-valued params are in the configuration 777528Ssteve.reinhardt@amd.com # hierarchy so we catch them with future descendants() walks 787528Ssteve.reinhardt@amd.com for obj in root.descendants(): obj.adoptOrphanParams() 797528Ssteve.reinhardt@amd.com 807527Ssteve.reinhardt@amd.com # Unproxy in sorted order for determinism 817527Ssteve.reinhardt@amd.com for obj in root.descendants(): obj.unproxyParams() 825037Smilesck@eecs.umich.edu 835773Snate@binkert.org if options.dump_config: 845773Snate@binkert.org ini_file = file(os.path.join(options.outdir, options.dump_config), 'w') 857527Ssteve.reinhardt@amd.com # Print ini sections in sorted order for easier diffing 867527Ssteve.reinhardt@amd.com for obj in sorted(root.descendants(), key=lambda o: o.path()): 877527Ssteve.reinhardt@amd.com obj.print_ini(ini_file) 885773Snate@binkert.org ini_file.close() 894762Snate@binkert.org 908664SAli.Saidi@ARM.com if options.json_config: 918675SAli.Saidi@ARM.com try: 928675SAli.Saidi@ARM.com import json 938675SAli.Saidi@ARM.com json_file = file(os.path.join(options.outdir, options.json_config), 'w') 948675SAli.Saidi@ARM.com d = root.get_config_as_dict() 958675SAli.Saidi@ARM.com json.dump(d, json_file, indent=4) 968675SAli.Saidi@ARM.com json_file.close() 978675SAli.Saidi@ARM.com except ImportError: 988675SAli.Saidi@ARM.com pass 998664SAli.Saidi@ARM.com 1008999Suri.wiener@arm.com do_dot(root, options.outdir, options.dot_config) 1018664SAli.Saidi@ARM.com 1024762Snate@binkert.org # Initialize the global statistics 1036001Snate@binkert.org stats.initSimStats() 1044762Snate@binkert.org 1054762Snate@binkert.org # Create the C++ sim objects and connect ports 1067527Ssteve.reinhardt@amd.com for obj in root.descendants(): obj.createCCObject() 1077527Ssteve.reinhardt@amd.com for obj in root.descendants(): obj.connectPorts() 1084762Snate@binkert.org 1094762Snate@binkert.org # Do a second pass to finish initializing the sim objects 1107527Ssteve.reinhardt@amd.com for obj in root.descendants(): obj.init() 1114762Snate@binkert.org 1124762Snate@binkert.org # Do a third pass to initialize statistics 1137527Ssteve.reinhardt@amd.com for obj in root.descendants(): obj.regStats() 1144762Snate@binkert.org 1156001Snate@binkert.org # We're done registering statistics. Enable the stats package now. 1166001Snate@binkert.org stats.enable() 1174762Snate@binkert.org 1187531Ssteve.reinhardt@amd.com # Restore checkpoint (if any) 1197531Ssteve.reinhardt@amd.com if ckpt_dir: 1207532Ssteve.reinhardt@amd.com ckpt = internal.core.getCheckpoint(ckpt_dir) 1217532Ssteve.reinhardt@amd.com internal.core.unserializeGlobals(ckpt); 1227532Ssteve.reinhardt@amd.com for obj in root.descendants(): obj.loadState(ckpt) 1237531Ssteve.reinhardt@amd.com need_resume.append(root) 1247532Ssteve.reinhardt@amd.com else: 1257532Ssteve.reinhardt@amd.com for obj in root.descendants(): obj.initState() 1267531Ssteve.reinhardt@amd.com 1279262Ssascha.bischoff@arm.com # Check to see if any of the stat events are in the past after resuming from 1289262Ssascha.bischoff@arm.com # a checkpoint, If so, this call will shift them to be at a valid time. 1299262Ssascha.bischoff@arm.com updateStatEvents() 1309262Ssascha.bischoff@arm.com 1314762Snate@binkert.org # Reset to put the stats in a consistent state. 1326001Snate@binkert.org stats.reset() 1334762Snate@binkert.org 1344762Snate@binkert.orgneed_resume = [] 1354762Snate@binkert.orgneed_startup = True 1364762Snate@binkert.orgdef simulate(*args, **kwargs): 1374762Snate@binkert.org global need_resume, need_startup 1384762Snate@binkert.org 1394762Snate@binkert.org if need_startup: 1407527Ssteve.reinhardt@amd.com root = objects.Root.getInstance() 1417527Ssteve.reinhardt@amd.com for obj in root.descendants(): obj.startup() 1424762Snate@binkert.org need_startup = False 1434762Snate@binkert.org 1444762Snate@binkert.org for root in need_resume: 1454762Snate@binkert.org resume(root) 1464762Snate@binkert.org need_resume = [] 1474762Snate@binkert.org 1484762Snate@binkert.org return internal.event.simulate(*args, **kwargs) 1494762Snate@binkert.org 1504762Snate@binkert.org# Export curTick to user script. 1514762Snate@binkert.orgdef curTick(): 1527823Ssteve.reinhardt@amd.com return internal.core.curTick() 1534762Snate@binkert.org 1544762Snate@binkert.org# Python exit handlers happen in reverse order. We want to dump stats last. 1558296Snate@binkert.orgatexit.register(stats.dump) 1564762Snate@binkert.org 1574762Snate@binkert.org# register our C++ exit callback function with Python 1584762Snate@binkert.orgatexit.register(internal.core.doExitCleanup) 1594762Snate@binkert.org 1609344SAndreas.Sandberg@arm.com# Drain the system in preparation of a checkpoint or memory mode 1619344SAndreas.Sandberg@arm.com# switch. 1629344SAndreas.Sandberg@arm.comdef drain(root): 1639344SAndreas.Sandberg@arm.com # Try to drain all objects. Draining might not be completed unless 1649344SAndreas.Sandberg@arm.com # all objects return that they are drained on the first call. This 1659344SAndreas.Sandberg@arm.com # is because as objects drain they may cause other objects to no 1669344SAndreas.Sandberg@arm.com # longer be drained. 1679344SAndreas.Sandberg@arm.com def _drain(): 1689344SAndreas.Sandberg@arm.com all_drained = False 1699344SAndreas.Sandberg@arm.com dm = internal.drain.createDrainManager() 1709344SAndreas.Sandberg@arm.com unready_objs = sum(obj.drain(dm) for obj in root.descendants()) 1719344SAndreas.Sandberg@arm.com # If we've got some objects that can't drain immediately, then simulate 1729344SAndreas.Sandberg@arm.com if unready_objs > 0: 1739344SAndreas.Sandberg@arm.com dm.setCount(unready_objs) 1749344SAndreas.Sandberg@arm.com simulate() 1759344SAndreas.Sandberg@arm.com else: 1769344SAndreas.Sandberg@arm.com all_drained = True 1779344SAndreas.Sandberg@arm.com internal.drain.cleanupDrainManager(dm) 1789344SAndreas.Sandberg@arm.com return all_drained 1799344SAndreas.Sandberg@arm.com 1809344SAndreas.Sandberg@arm.com all_drained = _drain() 1814762Snate@binkert.org while (not all_drained): 1829344SAndreas.Sandberg@arm.com all_drained = _drain() 1834762Snate@binkert.org 1844762Snate@binkert.orgdef resume(root): 1859342SAndreas.Sandberg@arm.com for obj in root.descendants(): obj.drainResume() 1864762Snate@binkert.org 1877525Ssteve.reinhardt@amd.comdef checkpoint(dir): 1887525Ssteve.reinhardt@amd.com root = objects.Root.getInstance() 1894762Snate@binkert.org if not isinstance(root, objects.Root): 1904762Snate@binkert.org raise TypeError, "Checkpoint must be called on a root object." 1919344SAndreas.Sandberg@arm.com drain(root) 1924762Snate@binkert.org print "Writing checkpoint" 1934859Snate@binkert.org internal.core.serializeAll(dir) 1944762Snate@binkert.org resume(root) 1954762Snate@binkert.org 1969343SAndreas.Sandberg@arm.comdef changeMemoryMode(system, mode): 1974762Snate@binkert.org if not isinstance(system, (objects.Root, objects.System)): 1984762Snate@binkert.org raise TypeError, "Parameter of type '%s'. Must be type %s or %s." % \ 1994762Snate@binkert.org (type(system), objects.Root, objects.System) 2009343SAndreas.Sandberg@arm.com if system.getMemoryMode() != mode: 2019344SAndreas.Sandberg@arm.com drain(system) 2029343SAndreas.Sandberg@arm.com system.setMemoryMode(mode) 2039343SAndreas.Sandberg@arm.com else: 2049343SAndreas.Sandberg@arm.com print "System already in target mode. Memory mode unchanged." 2054762Snate@binkert.org 2069343SAndreas.Sandberg@arm.comdef changeToAtomic(system, **kwargs): 2079343SAndreas.Sandberg@arm.com print "Changing memory mode to atomic" 2089343SAndreas.Sandberg@arm.com changeMemoryMode(system, objects.params.atomic, **kwargs) 2094762Snate@binkert.org 2109343SAndreas.Sandberg@arm.comdef changeToTiming(system, **kwargs): 2119343SAndreas.Sandberg@arm.com print "Changing memory mode to timing" 2129343SAndreas.Sandberg@arm.com changeMemoryMode(system, objects.params.timing, **kwargs) 2134762Snate@binkert.org 2144762Snate@binkert.orgdef switchCpus(cpuList): 2154762Snate@binkert.org print "switching cpus" 2164762Snate@binkert.org if not isinstance(cpuList, list): 2174762Snate@binkert.org raise RuntimeError, "Must pass a list to this function" 2184946Snate@binkert.org for item in cpuList: 2194946Snate@binkert.org if not isinstance(item, tuple) or len(item) != 2: 2204762Snate@binkert.org raise RuntimeError, "List must have tuples of (oldCPU,newCPU)" 2214762Snate@binkert.org 2224946Snate@binkert.org for old_cpu, new_cpu in cpuList: 2234946Snate@binkert.org if not isinstance(old_cpu, objects.BaseCPU): 2244946Snate@binkert.org raise TypeError, "%s is not of type BaseCPU" % old_cpu 2254946Snate@binkert.org if not isinstance(new_cpu, objects.BaseCPU): 2264946Snate@binkert.org raise TypeError, "%s is not of type BaseCPU" % new_cpu 2274762Snate@binkert.org 2284946Snate@binkert.org # Now all of the CPUs are ready to be switched out 2294946Snate@binkert.org for old_cpu, new_cpu in cpuList: 2309254SAndreas.Sandberg@arm.com old_cpu.switchOut() 2314762Snate@binkert.org 2324946Snate@binkert.org for old_cpu, new_cpu in cpuList: 2334946Snate@binkert.org new_cpu.takeOverFrom(old_cpu) 2345523Snate@binkert.org 2355523Snate@binkert.orgfrom internal.core import disableAllListeners 236