simulate.py revision 7528:6efc3672733b
1# Copyright (c) 2005 The Regents of The University of Michigan 2# All rights reserved. 3# 4# Redistribution and use in source and binary forms, with or without 5# modification, are permitted provided that the following conditions are 6# met: redistributions of source code must retain the above copyright 7# notice, this list of conditions and the following disclaimer; 8# redistributions in binary form must reproduce the above copyright 9# notice, this list of conditions and the following disclaimer in the 10# documentation and/or other materials provided with the distribution; 11# neither the name of the copyright holders nor the names of its 12# contributors may be used to endorse or promote products derived from 13# this software without specific prior written permission. 14# 15# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 16# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 17# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 18# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 19# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 20# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 21# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 22# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 23# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 24# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 25# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 26# 27# Authors: Nathan Binkert 28# Steve Reinhardt 29 30import atexit 31import os 32import sys 33 34# import the SWIG-wrapped main C++ functions 35import internal 36import core 37import stats 38from main import options 39import SimObject 40import ticks 41import objects 42from util import fatal 43 44# define a MaxTick parameter 45MaxTick = 2**63 - 1 46 47# The final hook to generate .ini files. Called from the user script 48# once the config is built. 49def instantiate(): 50 root = objects.Root.getInstance() 51 52 if not root: 53 fatal("Need to instantiate Root() before calling instantiate()") 54 55 # we need to fix the global frequency 56 ticks.fixGlobalFrequency() 57 58 # Make sure SimObject-valued params are in the configuration 59 # hierarchy so we catch them with future descendants() walks 60 for obj in root.descendants(): obj.adoptOrphanParams() 61 62 # Unproxy in sorted order for determinism 63 for obj in root.descendants(): obj.unproxyParams() 64 65 if options.dump_config: 66 ini_file = file(os.path.join(options.outdir, options.dump_config), 'w') 67 # Print ini sections in sorted order for easier diffing 68 for obj in sorted(root.descendants(), key=lambda o: o.path()): 69 obj.print_ini(ini_file) 70 ini_file.close() 71 72 # Initialize the global statistics 73 stats.initSimStats() 74 75 # Create the C++ sim objects and connect ports 76 for obj in root.descendants(): obj.createCCObject() 77 for obj in root.descendants(): obj.connectPorts() 78 79 # Do a second pass to finish initializing the sim objects 80 for obj in root.descendants(): obj.init() 81 82 # Do a third pass to initialize statistics 83 for obj in root.descendants(): obj.regStats() 84 for obj in root.descendants(): obj.regFormulas() 85 86 # We're done registering statistics. Enable the stats package now. 87 stats.enable() 88 89 # Reset to put the stats in a consistent state. 90 stats.reset() 91 92def doDot(root): 93 dot = pydot.Dot() 94 instance.outputDot(dot) 95 dot.orientation = "portrait" 96 dot.size = "8.5,11" 97 dot.ranksep="equally" 98 dot.rank="samerank" 99 dot.write("config.dot") 100 dot.write_ps("config.ps") 101 102need_resume = [] 103need_startup = True 104def simulate(*args, **kwargs): 105 global need_resume, need_startup 106 107 if need_startup: 108 root = objects.Root.getInstance() 109 for obj in root.descendants(): obj.startup() 110 need_startup = False 111 112 for root in need_resume: 113 resume(root) 114 need_resume = [] 115 116 return internal.event.simulate(*args, **kwargs) 117 118# Export curTick to user script. 119def curTick(): 120 return internal.core.cvar.curTick 121 122# Python exit handlers happen in reverse order. We want to dump stats last. 123atexit.register(internal.stats.dump) 124 125# register our C++ exit callback function with Python 126atexit.register(internal.core.doExitCleanup) 127 128# This loops until all objects have been fully drained. 129def doDrain(root): 130 all_drained = drain(root) 131 while (not all_drained): 132 all_drained = drain(root) 133 134# Tries to drain all objects. Draining might not be completed unless 135# all objects return that they are drained on the first call. This is 136# because as objects drain they may cause other objects to no longer 137# be drained. 138def drain(root): 139 all_drained = False 140 drain_event = internal.event.createCountedDrain() 141 unready_objs = sum(obj.drain(drain_event) for obj in root.descendants()) 142 # If we've got some objects that can't drain immediately, then simulate 143 if unready_objs > 0: 144 drain_event.setCount(unready_objs) 145 simulate() 146 else: 147 all_drained = True 148 internal.event.cleanupCountedDrain(drain_event) 149 return all_drained 150 151def resume(root): 152 for obj in root.descendants(): obj.resume() 153 154def checkpoint(dir): 155 root = objects.Root.getInstance() 156 if not isinstance(root, objects.Root): 157 raise TypeError, "Checkpoint must be called on a root object." 158 doDrain(root) 159 print "Writing checkpoint" 160 internal.core.serializeAll(dir) 161 resume(root) 162 163def restoreCheckpoint(dir): 164 root = objects.Root.getInstance() 165 print "Restoring from checkpoint" 166 internal.core.unserializeAll(dir) 167 need_resume.append(root) 168 stats.reset() 169 170def changeToAtomic(system): 171 if not isinstance(system, (objects.Root, objects.System)): 172 raise TypeError, "Parameter of type '%s'. Must be type %s or %s." % \ 173 (type(system), objects.Root, objects.System) 174 if system.getMemoryMode() != objects.params.atomic: 175 doDrain(system) 176 print "Changing memory mode to atomic" 177 for obj in system.descendants(): 178 obj.changeTiming(objects.params.atomic) 179 180def changeToTiming(system): 181 if not isinstance(system, (objects.Root, objects.System)): 182 raise TypeError, "Parameter of type '%s'. Must be type %s or %s." % \ 183 (type(system), objects.Root, objects.System) 184 185 if system.getMemoryMode() != objects.params.timing: 186 doDrain(system) 187 print "Changing memory mode to timing" 188 for obj in system.descendants(): 189 obj.changeTiming(objects.params.timing) 190 191def switchCpus(cpuList): 192 print "switching cpus" 193 if not isinstance(cpuList, list): 194 raise RuntimeError, "Must pass a list to this function" 195 for item in cpuList: 196 if not isinstance(item, tuple) or len(item) != 2: 197 raise RuntimeError, "List must have tuples of (oldCPU,newCPU)" 198 199 for old_cpu, new_cpu in cpuList: 200 if not isinstance(old_cpu, objects.BaseCPU): 201 raise TypeError, "%s is not of type BaseCPU" % old_cpu 202 if not isinstance(new_cpu, objects.BaseCPU): 203 raise TypeError, "%s is not of type BaseCPU" % new_cpu 204 205 # Now all of the CPUs are ready to be switched out 206 for old_cpu, new_cpu in cpuList: 207 old_cpu._ccObject.switchOut() 208 209 for old_cpu, new_cpu in cpuList: 210 new_cpu.takeOverFrom(old_cpu) 211 212from internal.core import disableAllListeners 213