src/python/m5/__init__.py

   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
  30 import atexit, os, sys
  31
  32 # import the SWIG-wrapped main C++ functions
  33 import cc_main
  34 # import a few SWIG-wrapped items (those that are likely to be used
  35 # directly by user scripts) completely into this module for
  36 # convenience
  37 from cc_main import simulate, SimLoopExitEvent
  38
  39 # import the m5 compile options
  40 import defines
  41
  42 # define this here so we can use it right away if necessary
  43 def panic(string):
  44     print >>sys.stderr, 'panic:', string
  45     sys.exit(1)
  46
  47 def makeList(objOrList):
  48     if isinstance(objOrList, list):
  49         return objOrList
  50     return [objOrList]
  51
  52 # Prepend given directory to system module search path.  We may not
  53 # need this anymore if we can structure our config library more like a
  54 # Python package.
  55 def AddToPath(path):
  56     # if it's a relative path and we know what directory the current
  57     # python script is in, make the path relative to that directory.
  58     if not os.path.isabs(path) and sys.path[0]:
  59         path = os.path.join(sys.path[0], path)
  60     path = os.path.realpath(path)
  61     # sys.path[0] should always refer to the current script's directory,
  62     # so place the new dir right after that.
  63     sys.path.insert(1, path)
  64
  65 # make a SmartDict out of the build options for our local use
  66 import smartdict
  67 build_env = smartdict.SmartDict()
  68 build_env.update(defines.m5_build_env)
  69
  70 # make a SmartDict out of the OS environment too
  71 env = smartdict.SmartDict()
  72 env.update(os.environ)
  73
  74 # Function to provide to C++ so it can look up instances based on paths
  75 def resolveSimObject(name):
  76     obj = config.instanceDict[name]
  77     return obj.getCCObject()
  78
  79 from main import options, arguments, main
  80
  81 # The final hook to generate .ini files.  Called from the user script
  82 # once the config is built.
  83 def instantiate(root):
  84     config.ticks_per_sec = float(root.clock.frequency)
  85     # ugly temporary hack to get output to config.ini
  86     sys.stdout = file(os.path.join(options.outdir, 'config.ini'), 'w')
  87     root.print_ini()
  88     sys.stdout.close() # close config.ini
  89     sys.stdout = sys.__stdout__ # restore to original
  90     cc_main.loadIniFile(resolveSimObject)  # load config.ini into C++
  91     root.createCCObject()
  92     root.connectPorts()
  93     cc_main.finalInit()
  94     noDot = True # temporary until we fix dot
  95     if not noDot:
  96        dot = pydot.Dot()
  97        instance.outputDot(dot)
  98        dot.orientation = "portrait"
  99        dot.size = "8.5,11"
 100        dot.ranksep="equally"
 101        dot.rank="samerank"
 102        dot.write("config.dot")
 103        dot.write_ps("config.ps")
 104
 105 # Export curTick to user script.
 106 def curTick():
 107     return cc_main.cvar.curTick
 108
 109 # register our C++ exit callback function with Python
 110 atexit.register(cc_main.doExitCleanup)
 111
 112 # This import allows user scripts to reference 'm5.objects.Foo' after
 113 # just doing an 'import m5' (without an 'import m5.objects').  May not
 114 # matter since most scripts will probably 'from m5.objects import *'.
 115 import objects
 116
 117 # This loops until all objects have been fully drained.
 118 def doDrain(root):
 119     all_drained = drain(root)
 120     while (not all_drained):
 121         all_drained = drain(root)
 122
 123 # Tries to drain all objects.  Draining might not be completed unless
 124 # all objects return that they are drained on the first call.  This is
 125 # because as objects drain they may cause other objects to no longer
 126 # be drained.
 127 def drain(root):
 128     all_drained = False
 129     drain_event = cc_main.createCountedDrain()
 130     unready_objects = root.startDrain(drain_event, True)
 131     # If we've got some objects that can't drain immediately, then simulate
 132     if unready_objects > 0:
 133         drain_event.setCount(unready_objects)
 134         simulate()
 135     else:
 136         all_drained = True
 137     cc_main.cleanupCountedDrain(drain_event)
 138     return all_drained
 139
 140 def resume(root):
 141     root.resume()
 142
 143 def checkpoint(root, dir):
 144     if not isinstance(root, objects.Root):
 145         raise TypeError, "Object is not a root object. Checkpoint must be called on a root object."
 146     doDrain(root)
 147     print "Writing checkpoint"
 148     cc_main.serializeAll(dir)
 149     resume(root)
 150
 151 def restoreCheckpoint(root, dir):
 152     print "Restoring from checkpoint"
 153     cc_main.unserializeAll(dir)
 154     resume(root)
 155
 156 def changeToAtomic(system):
 157     if not isinstance(system, objects.Root) and not isinstance(system, System):
 158         raise TypeError, "Object is not a root or system object.  Checkpoint must be "
 159         "called on a root object."
 160     doDrain(system)
 161     print "Changing memory mode to atomic"
 162     system.changeTiming(cc_main.SimObject.Atomic)
 163     resume(system)
 164
 165 def changeToTiming(system):
 166     if not isinstance(system, objects.Root) and not isinstance(system, System):
 167         raise TypeError, "Object is not a root or system object.  Checkpoint must be "
 168         "called on a root object."
 169     doDrain(system)
 170     print "Changing memory mode to timing"
 171     system.changeTiming(cc_main.SimObject.Timing)
 172     resume(system)
 173
 174 def switchCpus(cpuList):
 175     if not isinstance(cpuList, list):
 176         raise RuntimeError, "Must pass a list to this function"
 177     for i in cpuList:
 178         if not isinstance(i, tuple):
 179             raise RuntimeError, "List must have tuples of (oldCPU,newCPU)"
 180
 181     [old_cpus, new_cpus] = zip(*cpuList)
 182
 183     for cpu in old_cpus:
 184         if not isinstance(cpu, objects.BaseCPU):
 185             raise TypeError, "%s is not of type BaseCPU", cpu
 186     for cpu in new_cpus:
 187         if not isinstance(cpu, objects.BaseCPU):
 188             raise TypeError, "%s is not of type BaseCPU", cpu
 189
 190     # Drain all of the individual CPUs
 191     drain_event = cc_main.createCountedDrain()
 192     unready_cpus = 0
 193     for old_cpu in old_cpus:
 194         unready_cpus += old_cpu.startDrain(drain_event, False)
 195     # If we've got some objects that can't drain immediately, then simulate
 196     if unready_cpus > 0:
 197         drain_event.setCount(unready_cpus)
 198         simulate()
 199     cc_main.cleanupCountedDrain(drain_event)
 200     # Now all of the CPUs are ready to be switched out
 201     for old_cpu in old_cpus:
 202         old_cpu._ccObject.switchOut()
 203     index = 0
 204     print "Switching CPUs"
 205     for new_cpu in new_cpus:
 206         new_cpu.takeOverFrom(old_cpus[index])
 207         new_cpu._ccObject.resume()
 208         index += 1