__init__.py revision 2759 
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 sys, os, time, atexit, optparse
31
32# import the SWIG-wrapped main C++ functions
33import 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
37from main import simulate, SimLoopExitEvent
38
39# import the m5 compile options
40import defines
41
42# define this here so we can use it right away if necessary
43def 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.
50def 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# Callback to set trace flags.  Not necessarily the best way to do
62# things in the long run (particularly if we change how these global
63# options are handled).
64def setTraceFlags(option, opt_str, value, parser):
65    objects.Trace.flags = value
66
67def setTraceStart(option, opt_str, value, parser):
68    objects.Trace.start = value
69
70def setTraceFile(option, opt_str, value, parser):
71    objects.Trace.file = value
72
73def usePCSymbol(option, opt_str, value, parser):
74    objects.ExecutionTrace.pc_symbol = value
75
76def printCycle(option, opt_str, value, parser):
77    objects.ExecutionTrace.print_cycle = value
78
79def printOp(option, opt_str, value, parser):
80    objects.ExecutionTrace.print_opclass = value
81
82def printThread(option, opt_str, value, parser):
83    objects.ExecutionTrace.print_thread = value
84
85def printEA(option, opt_str, value, parser):
86    objects.ExecutionTrace.print_effaddr = value
87
88def printData(option, opt_str, value, parser):
89    objects.ExecutionTrace.print_data = value
90
91def printFetchseq(option, opt_str, value, parser):
92    objects.ExecutionTrace.print_fetchseq = value
93
94def printCpseq(option, opt_str, value, parser):
95    objects.ExecutionTrace.print_cpseq = value
96
97def dumpOnExit(option, opt_str, value, parser):
98    objects.Trace.dump_on_exit = value
99
100def debugBreak(option, opt_str, value, parser):
101    objects.Debug.break_cycles = value
102
103def statsTextFile(option, opt_str, value, parser):
104    objects.Statistics.text_file = value
105
106# Extra list to help for options that are true or false
107TrueOrFalse = ['True', 'False']
108TorF = "True | False"
109
110# Standard optparse options.  Need to be explicitly included by the
111# user script when it calls optparse.OptionParser().
112standardOptions = [
113    optparse.make_option("--traceflags", type="string", action="callback",
114                         callback=setTraceFlags),
115    optparse.make_option("--tracestart", type="int", action="callback",
116                         callback=setTraceStart),
117    optparse.make_option("--tracefile", type="string", action="callback",
118                         callback=setTraceFile),
119    optparse.make_option("--pcsymbol", type="choice", choices=TrueOrFalse,
120                         default="True", metavar=TorF,
121                         action="callback", callback=usePCSymbol,
122                         help="Use PC symbols in trace output"),
123    optparse.make_option("--printcycle", type="choice", choices=TrueOrFalse,
124                         default="True", metavar=TorF,
125                         action="callback", callback=printCycle,
126                         help="Print cycle numbers in trace output"),
127    optparse.make_option("--printopclass", type="choice",
128                         choices=TrueOrFalse,
129                         default="True", metavar=TorF,
130                         action="callback", callback=printOp,
131                         help="Print cycle numbers in trace output"),
132    optparse.make_option("--printthread", type="choice",
133                         choices=TrueOrFalse,
134                         default="True", metavar=TorF,
135                         action="callback", callback=printThread,
136                         help="Print thread number in trace output"),
137    optparse.make_option("--printeffaddr", type="choice",
138                         choices=TrueOrFalse,
139                         default="True", metavar=TorF,
140                         action="callback", callback=printEA,
141                         help="Print effective address in trace output"),
142    optparse.make_option("--printdata", type="choice",
143                         choices=TrueOrFalse,
144                         default="True", metavar=TorF,
145                         action="callback", callback=printData,
146                         help="Print result data in trace output"),
147    optparse.make_option("--printfetchseq", type="choice",
148                         choices=TrueOrFalse,
149                         default="True", metavar=TorF,
150                         action="callback", callback=printFetchseq,
151                         help="Print fetch sequence numbers in trace output"),
152    optparse.make_option("--printcpseq", type="choice",
153                         choices=TrueOrFalse,
154                         default="True", metavar=TorF,
155                         action="callback", callback=printCpseq,
156                         help="Print correct path sequence numbers in trace output"),
157    optparse.make_option("--dumponexit", type="choice",
158                         choices=TrueOrFalse,
159                         default="True", metavar=TorF,
160                         action="callback", callback=dumpOnExit,
161                         help="Dump trace buffer on exit"),
162    optparse.make_option("--debugbreak", type="int", metavar="CYCLE",
163                         action="callback", callback=debugBreak,
164                         help="Cycle to create a breakpoint"),
165    optparse.make_option("--statsfile", type="string", action="callback",
166                         callback=statsTextFile, metavar="FILE",
167                         help="Sets the output file for the statistics")
168    ]
169
170# make a SmartDict out of the build options for our local use
171import smartdict
172build_env = smartdict.SmartDict()
173build_env.update(defines.m5_build_env)
174
175# make a SmartDict out of the OS environment too
176env = smartdict.SmartDict()
177env.update(os.environ)
178
179
180# Function to provide to C++ so it can look up instances based on paths
181def resolveSimObject(name):
182    obj = config.instanceDict[name]
183    return obj.getCCObject()
184
185# The final hook to generate .ini files.  Called from the user script
186# once the config is built.
187def instantiate(root):
188    config.ticks_per_sec = float(root.clock.frequency)
189    # ugly temporary hack to get output to config.ini
190    sys.stdout = file('config.ini', 'w')
191    root.print_ini()
192    sys.stdout.close() # close config.ini
193    sys.stdout = sys.__stdout__ # restore to original
194    main.loadIniFile(resolveSimObject)  # load config.ini into C++
195    root.createCCObject()
196    root.connectPorts()
197    main.finalInit()
198    noDot = True # temporary until we fix dot
199    if not noDot:
200       dot = pydot.Dot()
201       instance.outputDot(dot)
202       dot.orientation = "portrait"
203       dot.size = "8.5,11"
204       dot.ranksep="equally"
205       dot.rank="samerank"
206       dot.write("config.dot")
207       dot.write_ps("config.ps")
208
209# Export curTick to user script.
210def curTick():
211    return main.cvar.curTick
212
213# register our C++ exit callback function with Python
214atexit.register(main.doExitCleanup)
215
216# This import allows user scripts to reference 'm5.objects.Foo' after
217# just doing an 'import m5' (without an 'import m5.objects').  May not
218# matter since most scripts will probably 'from m5.objects import *'.
219import objects
220