simulate.py revision 8664
14762Snate@binkert.org# Copyright (c) 2005 The Regents of The University of Michigan 27534Ssteve.reinhardt@amd.com# Copyright (c) 2010 Advanced Micro Devices, Inc. 34762Snate@binkert.org# All rights reserved. 44762Snate@binkert.org# 54762Snate@binkert.org# Redistribution and use in source and binary forms, with or without 64762Snate@binkert.org# modification, are permitted provided that the following conditions are 74762Snate@binkert.org# met: redistributions of source code must retain the above copyright 84762Snate@binkert.org# notice, this list of conditions and the following disclaimer; 94762Snate@binkert.org# redistributions in binary form must reproduce the above copyright 104762Snate@binkert.org# notice, this list of conditions and the following disclaimer in the 114762Snate@binkert.org# documentation and/or other materials provided with the distribution; 124762Snate@binkert.org# neither the name of the copyright holders nor the names of its 134762Snate@binkert.org# contributors may be used to endorse or promote products derived from 144762Snate@binkert.org# this software without specific prior written permission. 154762Snate@binkert.org# 164762Snate@binkert.org# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 174762Snate@binkert.org# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 184762Snate@binkert.org# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 194762Snate@binkert.org# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 204762Snate@binkert.org# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 214762Snate@binkert.org# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 224762Snate@binkert.org# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 234762Snate@binkert.org# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 244762Snate@binkert.org# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 254762Snate@binkert.org# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 264762Snate@binkert.org# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 274762Snate@binkert.org# 284762Snate@binkert.org# Authors: Nathan Binkert 294762Snate@binkert.org# Steve Reinhardt 304762Snate@binkert.org 314762Snate@binkert.orgimport atexit 324762Snate@binkert.orgimport os 334762Snate@binkert.orgimport sys 348664SAli.Saidi@ARM.comimport json 354762Snate@binkert.org 364762Snate@binkert.org# import the SWIG-wrapped main C++ functions 374762Snate@binkert.orgimport internal 386001Snate@binkert.orgimport core 396001Snate@binkert.orgimport stats 404762Snate@binkert.orgimport SimObject 414762Snate@binkert.orgimport ticks 424851Snate@binkert.orgimport objects 437525Ssteve.reinhardt@amd.comfrom util import fatal 448664SAli.Saidi@ARM.comfrom util import attrdict 454762Snate@binkert.org 466654Snate@binkert.org# define a MaxTick parameter 476654Snate@binkert.orgMaxTick = 2**63 - 1 486654Snate@binkert.org 494762Snate@binkert.org# The final hook to generate .ini files. Called from the user script 504762Snate@binkert.org# once the config is built. 517531Ssteve.reinhardt@amd.comdef instantiate(ckpt_dir=None): 528245Snate@binkert.org from m5 import options 538234Snate@binkert.org 547525Ssteve.reinhardt@amd.com root = objects.Root.getInstance() 557525Ssteve.reinhardt@amd.com 567525Ssteve.reinhardt@amd.com if not root: 577525Ssteve.reinhardt@amd.com fatal("Need to instantiate Root() before calling instantiate()") 587525Ssteve.reinhardt@amd.com 594762Snate@binkert.org # we need to fix the global frequency 604762Snate@binkert.org ticks.fixGlobalFrequency() 614762Snate@binkert.org 627528Ssteve.reinhardt@amd.com # Make sure SimObject-valued params are in the configuration 637528Ssteve.reinhardt@amd.com # hierarchy so we catch them with future descendants() walks 647528Ssteve.reinhardt@amd.com for obj in root.descendants(): obj.adoptOrphanParams() 657528Ssteve.reinhardt@amd.com 667527Ssteve.reinhardt@amd.com # Unproxy in sorted order for determinism 677527Ssteve.reinhardt@amd.com for obj in root.descendants(): obj.unproxyParams() 685037Smilesck@eecs.umich.edu 695773Snate@binkert.org if options.dump_config: 705773Snate@binkert.org ini_file = file(os.path.join(options.outdir, options.dump_config), 'w') 717527Ssteve.reinhardt@amd.com # Print ini sections in sorted order for easier diffing 727527Ssteve.reinhardt@amd.com for obj in sorted(root.descendants(), key=lambda o: o.path()): 737527Ssteve.reinhardt@amd.com obj.print_ini(ini_file) 745773Snate@binkert.org ini_file.close() 754762Snate@binkert.org 768664SAli.Saidi@ARM.com if options.json_config: 778664SAli.Saidi@ARM.com json_file = file(os.path.join(options.outdir, options.json_config), 'w') 788664SAli.Saidi@ARM.com d = root.get_config_as_dict() 798664SAli.Saidi@ARM.com json.dump(d, json_file, indent=4) 808664SAli.Saidi@ARM.com json_file.close() 818664SAli.Saidi@ARM.com 828664SAli.Saidi@ARM.com 834762Snate@binkert.org # Initialize the global statistics 846001Snate@binkert.org stats.initSimStats() 854762Snate@binkert.org 864762Snate@binkert.org # Create the C++ sim objects and connect ports 877527Ssteve.reinhardt@amd.com for obj in root.descendants(): obj.createCCObject() 887527Ssteve.reinhardt@amd.com for obj in root.descendants(): obj.connectPorts() 894762Snate@binkert.org 904762Snate@binkert.org # Do a second pass to finish initializing the sim objects 917527Ssteve.reinhardt@amd.com for obj in root.descendants(): obj.init() 924762Snate@binkert.org 934762Snate@binkert.org # Do a third pass to initialize statistics 947527Ssteve.reinhardt@amd.com for obj in root.descendants(): obj.regStats() 957527Ssteve.reinhardt@amd.com for obj in root.descendants(): obj.regFormulas() 964762Snate@binkert.org 976001Snate@binkert.org # We're done registering statistics. Enable the stats package now. 986001Snate@binkert.org stats.enable() 994762Snate@binkert.org 1007531Ssteve.reinhardt@amd.com # Restore checkpoint (if any) 1017531Ssteve.reinhardt@amd.com if ckpt_dir: 1027532Ssteve.reinhardt@amd.com ckpt = internal.core.getCheckpoint(ckpt_dir) 1037532Ssteve.reinhardt@amd.com internal.core.unserializeGlobals(ckpt); 1047532Ssteve.reinhardt@amd.com for obj in root.descendants(): obj.loadState(ckpt) 1057531Ssteve.reinhardt@amd.com need_resume.append(root) 1067532Ssteve.reinhardt@amd.com else: 1077532Ssteve.reinhardt@amd.com for obj in root.descendants(): obj.initState() 1087531Ssteve.reinhardt@amd.com 1094762Snate@binkert.org # Reset to put the stats in a consistent state. 1106001Snate@binkert.org stats.reset() 1114762Snate@binkert.org 1124762Snate@binkert.orgdef doDot(root): 1134762Snate@binkert.org dot = pydot.Dot() 1144762Snate@binkert.org instance.outputDot(dot) 1154762Snate@binkert.org dot.orientation = "portrait" 1164762Snate@binkert.org dot.size = "8.5,11" 1174762Snate@binkert.org dot.ranksep="equally" 1184762Snate@binkert.org dot.rank="samerank" 1194762Snate@binkert.org dot.write("config.dot") 1204762Snate@binkert.org dot.write_ps("config.ps") 1214762Snate@binkert.org 1224762Snate@binkert.orgneed_resume = [] 1234762Snate@binkert.orgneed_startup = True 1244762Snate@binkert.orgdef simulate(*args, **kwargs): 1254762Snate@binkert.org global need_resume, need_startup 1264762Snate@binkert.org 1274762Snate@binkert.org if need_startup: 1287527Ssteve.reinhardt@amd.com root = objects.Root.getInstance() 1297527Ssteve.reinhardt@amd.com for obj in root.descendants(): obj.startup() 1304762Snate@binkert.org need_startup = False 1314762Snate@binkert.org 1324762Snate@binkert.org for root in need_resume: 1334762Snate@binkert.org resume(root) 1344762Snate@binkert.org need_resume = [] 1354762Snate@binkert.org 1364762Snate@binkert.org return internal.event.simulate(*args, **kwargs) 1374762Snate@binkert.org 1384762Snate@binkert.org# Export curTick to user script. 1394762Snate@binkert.orgdef curTick(): 1407823Ssteve.reinhardt@amd.com return internal.core.curTick() 1414762Snate@binkert.org 1424762Snate@binkert.org# Python exit handlers happen in reverse order. We want to dump stats last. 1438296Snate@binkert.orgatexit.register(stats.dump) 1444762Snate@binkert.org 1454762Snate@binkert.org# register our C++ exit callback function with Python 1464762Snate@binkert.orgatexit.register(internal.core.doExitCleanup) 1474762Snate@binkert.org 1484762Snate@binkert.org# This loops until all objects have been fully drained. 1494762Snate@binkert.orgdef doDrain(root): 1504762Snate@binkert.org all_drained = drain(root) 1514762Snate@binkert.org while (not all_drained): 1524762Snate@binkert.org all_drained = drain(root) 1534762Snate@binkert.org 1544762Snate@binkert.org# Tries to drain all objects. Draining might not be completed unless 1554762Snate@binkert.org# all objects return that they are drained on the first call. This is 1564762Snate@binkert.org# because as objects drain they may cause other objects to no longer 1574762Snate@binkert.org# be drained. 1584762Snate@binkert.orgdef drain(root): 1594762Snate@binkert.org all_drained = False 1604762Snate@binkert.org drain_event = internal.event.createCountedDrain() 1617527Ssteve.reinhardt@amd.com unready_objs = sum(obj.drain(drain_event) for obj in root.descendants()) 1624762Snate@binkert.org # If we've got some objects that can't drain immediately, then simulate 1637527Ssteve.reinhardt@amd.com if unready_objs > 0: 1647527Ssteve.reinhardt@amd.com drain_event.setCount(unready_objs) 1654762Snate@binkert.org simulate() 1664762Snate@binkert.org else: 1674762Snate@binkert.org all_drained = True 1684762Snate@binkert.org internal.event.cleanupCountedDrain(drain_event) 1694762Snate@binkert.org return all_drained 1704762Snate@binkert.org 1714762Snate@binkert.orgdef resume(root): 1727527Ssteve.reinhardt@amd.com for obj in root.descendants(): obj.resume() 1734762Snate@binkert.org 1747525Ssteve.reinhardt@amd.comdef checkpoint(dir): 1757525Ssteve.reinhardt@amd.com root = objects.Root.getInstance() 1764762Snate@binkert.org if not isinstance(root, objects.Root): 1774762Snate@binkert.org raise TypeError, "Checkpoint must be called on a root object." 1784762Snate@binkert.org doDrain(root) 1794762Snate@binkert.org print "Writing checkpoint" 1804859Snate@binkert.org internal.core.serializeAll(dir) 1814762Snate@binkert.org resume(root) 1824762Snate@binkert.org 1834762Snate@binkert.orgdef changeToAtomic(system): 1844762Snate@binkert.org if not isinstance(system, (objects.Root, objects.System)): 1854762Snate@binkert.org raise TypeError, "Parameter of type '%s'. Must be type %s or %s." % \ 1864762Snate@binkert.org (type(system), objects.Root, objects.System) 1874945Snate@binkert.org if system.getMemoryMode() != objects.params.atomic: 1884762Snate@binkert.org doDrain(system) 1894762Snate@binkert.org print "Changing memory mode to atomic" 1907527Ssteve.reinhardt@amd.com for obj in system.descendants(): 1917527Ssteve.reinhardt@amd.com obj.changeTiming(objects.params.atomic) 1924762Snate@binkert.org 1934762Snate@binkert.orgdef changeToTiming(system): 1944762Snate@binkert.org if not isinstance(system, (objects.Root, objects.System)): 1954762Snate@binkert.org raise TypeError, "Parameter of type '%s'. Must be type %s or %s." % \ 1964762Snate@binkert.org (type(system), objects.Root, objects.System) 1974762Snate@binkert.org 1984945Snate@binkert.org if system.getMemoryMode() != objects.params.timing: 1994762Snate@binkert.org doDrain(system) 2004762Snate@binkert.org print "Changing memory mode to timing" 2017527Ssteve.reinhardt@amd.com for obj in system.descendants(): 2027527Ssteve.reinhardt@amd.com obj.changeTiming(objects.params.timing) 2034762Snate@binkert.org 2044762Snate@binkert.orgdef switchCpus(cpuList): 2054762Snate@binkert.org print "switching cpus" 2064762Snate@binkert.org if not isinstance(cpuList, list): 2074762Snate@binkert.org raise RuntimeError, "Must pass a list to this function" 2084946Snate@binkert.org for item in cpuList: 2094946Snate@binkert.org if not isinstance(item, tuple) or len(item) != 2: 2104762Snate@binkert.org raise RuntimeError, "List must have tuples of (oldCPU,newCPU)" 2114762Snate@binkert.org 2124946Snate@binkert.org for old_cpu, new_cpu in cpuList: 2134946Snate@binkert.org if not isinstance(old_cpu, objects.BaseCPU): 2144946Snate@binkert.org raise TypeError, "%s is not of type BaseCPU" % old_cpu 2154946Snate@binkert.org if not isinstance(new_cpu, objects.BaseCPU): 2164946Snate@binkert.org raise TypeError, "%s is not of type BaseCPU" % new_cpu 2174762Snate@binkert.org 2184946Snate@binkert.org # Now all of the CPUs are ready to be switched out 2194946Snate@binkert.org for old_cpu, new_cpu in cpuList: 2204946Snate@binkert.org old_cpu._ccObject.switchOut() 2214762Snate@binkert.org 2224946Snate@binkert.org for old_cpu, new_cpu in cpuList: 2234946Snate@binkert.org new_cpu.takeOverFrom(old_cpu) 2245523Snate@binkert.org 2255523Snate@binkert.orgfrom internal.core import disableAllListeners 226