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 sys, os, time, atexit, optparse
  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 # Prepend given directory to system module search path.  We may not
  48 # need this anymore if we can structure our config library more like a
  49 # Python package.
  50 def AddToPath(path):
  51     # if it's a relative path and we know what directory the current
  52     # python script is in, make the path relative to that directory.
  53     if not os.path.isabs(path) and sys.path[0]:
  54         path = os.path.join(sys.path[0], path)
  55     path = os.path.realpath(path)
  56     # sys.path[0] should always refer to the current script's directory,
  57     # so place the new dir right after that.
  58     sys.path.insert(1, path)
  59
  60
  61 # The m5 module's pointer to the parsed options object
  62 options = None
  63
  64
  65 # User should call this function after calling parse_args() to pass
  66 # parsed standard option values back into the m5 module for
  67 # processing.
  68 def setStandardOptions(_options):
  69     # Set module global var
  70     global options
  71     options = _options
  72     # tell C++ about output directory
  73     cc_main.setOutputDir(options.outdir)
  74
  75 # Callback to set trace flags.  Not necessarily the best way to do
  76 # things in the long run (particularly if we change how these global
  77 # options are handled).
  78 def setTraceFlags(option, opt_str, value, parser):
  79     objects.Trace.flags = value
  80
  81 def setTraceStart(option, opt_str, value, parser):
  82     objects.Trace.start = value
  83
  84 def setTraceFile(option, opt_str, value, parser):
  85     objects.Trace.file = value
  86
  87 def noPCSymbol(option, opt_str, value, parser):
  88     objects.ExecutionTrace.pc_symbol = False
  89
  90 def noPrintCycle(option, opt_str, value, parser):
  91     objects.ExecutionTrace.print_cycle = False
  92
  93 def noPrintOpclass(option, opt_str, value, parser):
  94     objects.ExecutionTrace.print_opclass = False
  95
  96 def noPrintThread(option, opt_str, value, parser):
  97     objects.ExecutionTrace.print_thread = False
  98
  99 def noPrintEA(option, opt_str, value, parser):
 100     objects.ExecutionTrace.print_effaddr = False
 101
 102 def noPrintData(option, opt_str, value, parser):
 103     objects.ExecutionTrace.print_data = False
 104
 105 def printFetchseq(option, opt_str, value, parser):
 106     objects.ExecutionTrace.print_fetchseq = True
 107
 108 def printCpseq(option, opt_str, value, parser):
 109     objects.ExecutionTrace.print_cpseq = True
 110
 111 def dumpOnExit(option, opt_str, value, parser):
 112     objects.Trace.dump_on_exit = True
 113
 114 def debugBreak(option, opt_str, value, parser):
 115     objects.Debug.break_cycles = value
 116
 117 def statsTextFile(option, opt_str, value, parser):
 118     objects.Statistics.text_file = value
 119
 120 # Extra list to help for options that are true or false
 121 TrueOrFalse = ['True', 'False']
 122 TorF = "True | False"
 123
 124 # Standard optparse options.  Need to be explicitly included by the
 125 # user script when it calls optparse.OptionParser().
 126 standardOptions = [
 127     optparse.make_option("--outdir", type="string", default="."),
 128     optparse.make_option("--traceflags", type="string", action="callback",
 129                          callback=setTraceFlags),
 130     optparse.make_option("--tracestart", type="int", action="callback",
 131                          callback=setTraceStart),
 132     optparse.make_option("--tracefile", type="string", action="callback",
 133                          callback=setTraceFile),
 134     optparse.make_option("--nopcsymbol",
 135                          action="callback", callback=noPCSymbol,
 136                          help="Disable PC symbols in trace output"),
 137     optparse.make_option("--noprintcycle",
 138                          action="callback", callback=noPrintCycle,
 139                          help="Don't print cycle numbers in trace output"),
 140     optparse.make_option("--noprintopclass",
 141                          action="callback", callback=noPrintOpclass,
 142                          help="Don't print op class type in trace output"),
 143     optparse.make_option("--noprintthread",
 144                          action="callback", callback=noPrintThread,
 145                          help="Don't print thread number in trace output"),
 146     optparse.make_option("--noprinteffaddr",
 147                          action="callback", callback=noPrintEA,
 148                          help="Don't print effective address in trace output"),
 149     optparse.make_option("--noprintdata",
 150                          action="callback", callback=noPrintData,
 151                          help="Don't print result data in trace output"),
 152     optparse.make_option("--printfetchseq",
 153                          action="callback", callback=printFetchseq,
 154                          help="Print fetch sequence numbers in trace output"),
 155     optparse.make_option("--printcpseq",
 156                          action="callback", callback=printCpseq,
 157                          help="Print correct path sequence numbers in trace output"),
 158     optparse.make_option("--dumponexit",
 159                          action="callback", callback=dumpOnExit,
 160                          help="Dump trace buffer on exit"),
 161     optparse.make_option("--debugbreak", type="int", metavar="CYCLE",
 162                          action="callback", callback=debugBreak,
 163                          help="Cycle to create a breakpoint"),
 164     optparse.make_option("--statsfile", type="string", action="callback",
 165                          callback=statsTextFile, metavar="FILE",
 166                          help="Sets the output file for the statistics")
 167     ]
 168
 169 # make a SmartDict out of the build options for our local use
 170 import smartdict
 171 build_env = smartdict.SmartDict()
 172 build_env.update(defines.m5_build_env)
 173
 174 # make a SmartDict out of the OS environment too
 175 env = smartdict.SmartDict()
 176 env.update(os.environ)
 177
 178
 179 # Function to provide to C++ so it can look up instances based on paths
 180 def resolveSimObject(name):
 181     obj = config.instanceDict[name]
 182     return obj.getCCObject()
 183
 184 # The final hook to generate .ini files.  Called from the user script
 185 # once the config is built.
 186 def instantiate(root):
 187     config.ticks_per_sec = float(root.clock.frequency)
 188     # ugly temporary hack to get output to config.ini
 189     sys.stdout = file(os.path.join(options.outdir, 'config.ini'), 'w')
 190     root.print_ini()
 191     sys.stdout.close() # close config.ini
 192     sys.stdout = sys.__stdout__ # restore to original
 193     cc_main.loadIniFile(resolveSimObject)  # load config.ini into C++
 194     root.createCCObject()
 195     root.connectPorts()
 196     cc_main.finalInit()
 197     noDot = True # temporary until we fix dot
 198     if not noDot:
 199        dot = pydot.Dot()
 200        instance.outputDot(dot)
 201        dot.orientation = "portrait"
 202        dot.size = "8.5,11"
 203        dot.ranksep="equally"
 204        dot.rank="samerank"
 205        dot.write("config.dot")
 206        dot.write_ps("config.ps")
 207
 208 # Export curTick to user script.
 209 def curTick():
 210     return cc_main.cvar.curTick
 211
 212 # register our C++ exit callback function with Python
 213 atexit.register(cc_main.doExitCleanup)
 214
 215 # This import allows user scripts to reference 'm5.objects.Foo' after
 216 # just doing an 'import m5' (without an 'import m5.objects').  May not
 217 # matter since most scripts will probably 'from m5.objects import *'.
 218 import objects