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
29import code, optparse, os, socket, sys
30from datetime import datetime
31from attrdict import attrdict
32
33try:
34 import info
35except ImportError:
36 info = None
37
38__all__ = [ 'options', 'arguments', 'main' ]
39
40usage="%prog [m5 options] script.py [script options]"
41version="%prog 2.0"
42brief_copyright='''
43Copyright (c) 2001-2006
44The Regents of The University of Michigan
45All Rights Reserved
46'''
47
48# there's only one option parsing done, so make it global and add some
49# helper functions to make it work well.
50parser = optparse.OptionParser(usage=usage, version=version,
51 description=brief_copyright,
52 formatter=optparse.TitledHelpFormatter())
53parser.disable_interspersed_args()
54
55# current option group
56group = None
57
58def set_group(*args, **kwargs):
59 '''set the current option group'''
60 global group
61 if not args and not kwargs:
62 group = None
63 else:
64 group = parser.add_option_group(*args, **kwargs)
65
66class splitter(object):
67 def __init__(self, split):
68 self.split = split
69 def __call__(self, option, opt_str, value, parser):
70 getattr(parser.values, option.dest).extend(value.split(self.split))
71
72def add_option(*args, **kwargs):
73 '''add an option to the current option group, or global none set'''
74
75 # if action=split, but allows the option arguments
76 # themselves to be lists separated by the split variable'''
77
78 if kwargs.get('action', None) == 'append' and 'split' in kwargs:
79 split = kwargs.pop('split')
80 kwargs['default'] = []
81 kwargs['type'] = 'string'
82 kwargs['action'] = 'callback'
83 kwargs['callback'] = splitter(split)
84
85 if group:
86 return group.add_option(*args, **kwargs)
87
88 return parser.add_option(*args, **kwargs)
89
90def bool_option(name, default, help):
91 '''add a boolean option called --name and --no-name.
92 Display help depending on which is the default'''
93
94 tname = '--%s' % name
95 fname = '--no-%s' % name
96 dest = name.replace('-', '_')
97 if default:
98 thelp = optparse.SUPPRESS_HELP
99 fhelp = help
100 else:
101 thelp = help
102 fhelp = optparse.SUPPRESS_HELP
103
104 add_option(tname, action="store_true", default=default, help=thelp)
105 add_option(fname, action="store_false", dest=dest, help=fhelp)
106
107# Help options
108add_option('-A', "--authors", action="store_true", default=False,
109 help="Show author information")
110add_option('-C', "--copyright", action="store_true", default=False,
111 help="Show full copyright information")
112add_option('-R', "--readme", action="store_true", default=False,
113 help="Show the readme")
114add_option('-N', "--release-notes", action="store_true", default=False,
115 help="Show the release notes")
116
117# Options for configuring the base simulator
118add_option('-d', "--outdir", metavar="DIR", default=".",
119 help="Set the output directory to DIR [Default: %default]")
120add_option('-i', "--interactive", action="store_true", default=False,
121 help="Invoke the interactive interpreter after running the script")
122add_option("--pdb", action="store_true", default=False,
123 help="Invoke the python debugger before running the script")
124add_option('-p', "--path", metavar="PATH[:PATH]", action='append', split=':',
125 help="Prepend PATH to the system path when invoking the script")
126add_option('-q', "--quiet", action="count", default=0,
127 help="Reduce verbosity")
128add_option('-v', "--verbose", action="count", default=0,
129 help="Increase verbosity")
130
131# Statistics options
132set_group("Statistics Options")
133add_option("--stats-file", metavar="FILE", default="m5stats.txt",
134 help="Sets the output file for statistics [Default: %default]")
135
136# Debugging options
137set_group("Debugging Options")
138add_option("--debug-break", metavar="TIME[,TIME]", action='append', split=',',
139 help="Cycle to create a breakpoint")
140
141# Tracing options
142set_group("Trace Options")
143add_option("--trace-flags", metavar="FLAG[,FLAG]", action='append', split=',',
144 help="Sets the flags for tracing")
145add_option("--trace-start", metavar="TIME", default='0s',
146 help="Start tracing at TIME (must have units)")
| 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
29import code, optparse, os, socket, sys
30from datetime import datetime
31from attrdict import attrdict
32
33try:
34 import info
35except ImportError:
36 info = None
37
38__all__ = [ 'options', 'arguments', 'main' ]
39
40usage="%prog [m5 options] script.py [script options]"
41version="%prog 2.0"
42brief_copyright='''
43Copyright (c) 2001-2006
44The Regents of The University of Michigan
45All Rights Reserved
46'''
47
48# there's only one option parsing done, so make it global and add some
49# helper functions to make it work well.
50parser = optparse.OptionParser(usage=usage, version=version,
51 description=brief_copyright,
52 formatter=optparse.TitledHelpFormatter())
53parser.disable_interspersed_args()
54
55# current option group
56group = None
57
58def set_group(*args, **kwargs):
59 '''set the current option group'''
60 global group
61 if not args and not kwargs:
62 group = None
63 else:
64 group = parser.add_option_group(*args, **kwargs)
65
66class splitter(object):
67 def __init__(self, split):
68 self.split = split
69 def __call__(self, option, opt_str, value, parser):
70 getattr(parser.values, option.dest).extend(value.split(self.split))
71
72def add_option(*args, **kwargs):
73 '''add an option to the current option group, or global none set'''
74
75 # if action=split, but allows the option arguments
76 # themselves to be lists separated by the split variable'''
77
78 if kwargs.get('action', None) == 'append' and 'split' in kwargs:
79 split = kwargs.pop('split')
80 kwargs['default'] = []
81 kwargs['type'] = 'string'
82 kwargs['action'] = 'callback'
83 kwargs['callback'] = splitter(split)
84
85 if group:
86 return group.add_option(*args, **kwargs)
87
88 return parser.add_option(*args, **kwargs)
89
90def bool_option(name, default, help):
91 '''add a boolean option called --name and --no-name.
92 Display help depending on which is the default'''
93
94 tname = '--%s' % name
95 fname = '--no-%s' % name
96 dest = name.replace('-', '_')
97 if default:
98 thelp = optparse.SUPPRESS_HELP
99 fhelp = help
100 else:
101 thelp = help
102 fhelp = optparse.SUPPRESS_HELP
103
104 add_option(tname, action="store_true", default=default, help=thelp)
105 add_option(fname, action="store_false", dest=dest, help=fhelp)
106
107# Help options
108add_option('-A', "--authors", action="store_true", default=False,
109 help="Show author information")
110add_option('-C', "--copyright", action="store_true", default=False,
111 help="Show full copyright information")
112add_option('-R', "--readme", action="store_true", default=False,
113 help="Show the readme")
114add_option('-N', "--release-notes", action="store_true", default=False,
115 help="Show the release notes")
116
117# Options for configuring the base simulator
118add_option('-d', "--outdir", metavar="DIR", default=".",
119 help="Set the output directory to DIR [Default: %default]")
120add_option('-i', "--interactive", action="store_true", default=False,
121 help="Invoke the interactive interpreter after running the script")
122add_option("--pdb", action="store_true", default=False,
123 help="Invoke the python debugger before running the script")
124add_option('-p', "--path", metavar="PATH[:PATH]", action='append', split=':',
125 help="Prepend PATH to the system path when invoking the script")
126add_option('-q', "--quiet", action="count", default=0,
127 help="Reduce verbosity")
128add_option('-v', "--verbose", action="count", default=0,
129 help="Increase verbosity")
130
131# Statistics options
132set_group("Statistics Options")
133add_option("--stats-file", metavar="FILE", default="m5stats.txt",
134 help="Sets the output file for statistics [Default: %default]")
135
136# Debugging options
137set_group("Debugging Options")
138add_option("--debug-break", metavar="TIME[,TIME]", action='append', split=',',
139 help="Cycle to create a breakpoint")
140
141# Tracing options
142set_group("Trace Options")
143add_option("--trace-flags", metavar="FLAG[,FLAG]", action='append', split=',',
144 help="Sets the flags for tracing")
145add_option("--trace-start", metavar="TIME", default='0s',
146 help="Start tracing at TIME (must have units)")
|
147add_option("--trace-file", metavar="FILE", default="cout",
148 help="Sets the output file for tracing [Default: %default]")
149add_option("--trace-circlebuf", metavar="SIZE", type="int", default=0,
150 help="If SIZE is non-zero, turn on the circular buffer with SIZE lines")
151add_option("--no-trace-circlebuf", action="store_const", const=0,
152 dest='trace_circlebuf', help=optparse.SUPPRESS_HELP)
153bool_option("trace-dumponexit", default=False,
154 help="Dump trace buffer on exit")
155add_option("--trace-ignore", metavar="EXPR", action='append', split=':',
156 help="Ignore EXPR sim objects")
157
158# Execution Trace options
159set_group("Execution Trace Options")
160bool_option("speculative", default=True,
161 help="Don't capture speculative instructions")
162bool_option("print-cycle", default=True,
163 help="Don't print cycle numbers in trace output")
164bool_option("print-symbol", default=True,
165 help="Disable PC symbols in trace output")
166bool_option("print-opclass", default=True,
167 help="Don't print op class type in trace output")
168bool_option("print-thread", default=True,
169 help="Don't print thread number in trace output")
170bool_option("print-effaddr", default=True,
171 help="Don't print effective address in trace output")
172bool_option("print-data", default=True,
173 help="Don't print result data in trace output")
174bool_option("print-iregs", default=False,
175 help="Print fetch sequence numbers in trace output")
176bool_option("print-fetch-seq", default=False,
177 help="Print fetch sequence numbers in trace output")
178bool_option("print-cpseq", default=False,
179 help="Print correct path sequence numbers in trace output")
180#bool_option("print-reg-delta", default=False,
181# help="Print which registers changed to what in trace output")
182
183options = attrdict()
184arguments = []
185
186def usage(exitcode=None):
187 parser.print_help()
188 if exitcode is not None:
189 sys.exit(exitcode)
190
191def parse_args():
192 _opts,args = parser.parse_args()
193 opts = attrdict(_opts.__dict__)
194
195 # setting verbose and quiet at the same time doesn't make sense
196 if opts.verbose > 0 and opts.quiet > 0:
197 usage(2)
198
199 # store the verbosity in a single variable. 0 is default,
200 # negative numbers represent quiet and positive values indicate verbose
201 opts.verbose -= opts.quiet
202
203 del opts.quiet
204
205 options.update(opts)
206 arguments.extend(args)
207 return opts,args
208
209def main():
210 import cc_main
211
212 parse_args()
213
214 done = False
215 if options.copyright:
216 done = True
217 print info.LICENSE
218 print
219
220 if options.authors:
221 done = True
222 print 'Author information:'
223 print
224 print info.AUTHORS
225 print
226
227 if options.readme:
228 done = True
229 print 'Readme:'
230 print
231 print info.README
232 print
233
234 if options.release_notes:
235 done = True
236 print 'Release Notes:'
237 print
238 print info.RELEASE_NOTES
239 print
240
241 if done:
242 sys.exit(0)
243
244 if options.verbose >= 0:
245 print "M5 Simulator System"
246 print brief_copyright
247 print
248 print "M5 compiled %s" % cc_main.cvar.compileDate;
249 print "M5 started %s" % datetime.now().ctime()
250 print "M5 executing on %s" % socket.gethostname()
251 print "command line:",
252 for argv in sys.argv:
253 print argv,
254 print
255
256 # check to make sure we can find the listed script
257 if not arguments or not os.path.isfile(arguments[0]):
258 if arguments and not os.path.isfile(arguments[0]):
259 print "Script %s not found" % arguments[0]
260 usage(2)
261
262 # tell C++ about output directory
263 cc_main.setOutputDir(options.outdir)
264
265 # update the system path with elements from the -p option
266 sys.path[0:0] = options.path
267
268 import objects
269
270 # set stats options
271 objects.Statistics.text_file = options.stats_file
272
273 # set debugging options
274 objects.Debug.break_cycles = options.debug_break
275
276 # set tracing options
277 objects.Trace.flags = options.trace_flags
278 objects.Trace.start = options.trace_start
279 objects.Trace.file = options.trace_file
280 objects.Trace.bufsize = options.trace_circlebuf
281 objects.Trace.dump_on_exit = options.trace_dumponexit
282 objects.Trace.ignore = options.trace_ignore
283
284 # set execution trace options
285 objects.ExecutionTrace.speculative = options.speculative
286 objects.ExecutionTrace.print_cycle = options.print_cycle
287 objects.ExecutionTrace.pc_symbol = options.print_symbol
288 objects.ExecutionTrace.print_opclass = options.print_opclass
289 objects.ExecutionTrace.print_thread = options.print_thread
290 objects.ExecutionTrace.print_effaddr = options.print_effaddr
291 objects.ExecutionTrace.print_data = options.print_data
292 objects.ExecutionTrace.print_iregs = options.print_iregs
293 objects.ExecutionTrace.print_fetchseq = options.print_fetch_seq
294 objects.ExecutionTrace.print_cpseq = options.print_cpseq
295 #objects.ExecutionTrace.print_reg_delta = options.print_reg_delta
296
297 sys.argv = arguments
298 sys.path = [ os.path.dirname(sys.argv[0]) ] + sys.path
299
300 scope = { '__file__' : sys.argv[0] }
301
302 # we want readline if we're doing anything interactive
303 if options.interactive or options.pdb:
304 exec("import readline", scope)
305
306 # if pdb was requested, execfile the thing under pdb, otherwise,
307 # just do the execfile normally
308 if options.pdb:
309 from pdb import Pdb
310 debugger = Pdb()
311 debugger.run('execfile("%s")' % sys.argv[0], scope)
312 else:
313 execfile(sys.argv[0], scope)
314
315 # once the script is done
316 if options.interactive:
317 interact = code.InteractiveConsole(scope)
318 interact.interact("M5 Interactive Console")
319
320if __name__ == '__main__':
321 from pprint import pprint
322
323 parse_args()
324
325 print 'opts:'
326 pprint(options, indent=4)
327 print
328
329 print 'args:'
330 pprint(arguments, indent=4)
| 149add_option("--trace-file", metavar="FILE", default="cout",
150 help="Sets the output file for tracing [Default: %default]")
151add_option("--trace-circlebuf", metavar="SIZE", type="int", default=0,
152 help="If SIZE is non-zero, turn on the circular buffer with SIZE lines")
153add_option("--no-trace-circlebuf", action="store_const", const=0,
154 dest='trace_circlebuf', help=optparse.SUPPRESS_HELP)
155bool_option("trace-dumponexit", default=False,
156 help="Dump trace buffer on exit")
157add_option("--trace-ignore", metavar="EXPR", action='append', split=':',
158 help="Ignore EXPR sim objects")
159
160# Execution Trace options
161set_group("Execution Trace Options")
162bool_option("speculative", default=True,
163 help="Don't capture speculative instructions")
164bool_option("print-cycle", default=True,
165 help="Don't print cycle numbers in trace output")
166bool_option("print-symbol", default=True,
167 help="Disable PC symbols in trace output")
168bool_option("print-opclass", default=True,
169 help="Don't print op class type in trace output")
170bool_option("print-thread", default=True,
171 help="Don't print thread number in trace output")
172bool_option("print-effaddr", default=True,
173 help="Don't print effective address in trace output")
174bool_option("print-data", default=True,
175 help="Don't print result data in trace output")
176bool_option("print-iregs", default=False,
177 help="Print fetch sequence numbers in trace output")
178bool_option("print-fetch-seq", default=False,
179 help="Print fetch sequence numbers in trace output")
180bool_option("print-cpseq", default=False,
181 help="Print correct path sequence numbers in trace output")
182#bool_option("print-reg-delta", default=False,
183# help="Print which registers changed to what in trace output")
184
185options = attrdict()
186arguments = []
187
188def usage(exitcode=None):
189 parser.print_help()
190 if exitcode is not None:
191 sys.exit(exitcode)
192
193def parse_args():
194 _opts,args = parser.parse_args()
195 opts = attrdict(_opts.__dict__)
196
197 # setting verbose and quiet at the same time doesn't make sense
198 if opts.verbose > 0 and opts.quiet > 0:
199 usage(2)
200
201 # store the verbosity in a single variable. 0 is default,
202 # negative numbers represent quiet and positive values indicate verbose
203 opts.verbose -= opts.quiet
204
205 del opts.quiet
206
207 options.update(opts)
208 arguments.extend(args)
209 return opts,args
210
211def main():
212 import cc_main
213
214 parse_args()
215
216 done = False
217 if options.copyright:
218 done = True
219 print info.LICENSE
220 print
221
222 if options.authors:
223 done = True
224 print 'Author information:'
225 print
226 print info.AUTHORS
227 print
228
229 if options.readme:
230 done = True
231 print 'Readme:'
232 print
233 print info.README
234 print
235
236 if options.release_notes:
237 done = True
238 print 'Release Notes:'
239 print
240 print info.RELEASE_NOTES
241 print
242
243 if done:
244 sys.exit(0)
245
246 if options.verbose >= 0:
247 print "M5 Simulator System"
248 print brief_copyright
249 print
250 print "M5 compiled %s" % cc_main.cvar.compileDate;
251 print "M5 started %s" % datetime.now().ctime()
252 print "M5 executing on %s" % socket.gethostname()
253 print "command line:",
254 for argv in sys.argv:
255 print argv,
256 print
257
258 # check to make sure we can find the listed script
259 if not arguments or not os.path.isfile(arguments[0]):
260 if arguments and not os.path.isfile(arguments[0]):
261 print "Script %s not found" % arguments[0]
262 usage(2)
263
264 # tell C++ about output directory
265 cc_main.setOutputDir(options.outdir)
266
267 # update the system path with elements from the -p option
268 sys.path[0:0] = options.path
269
270 import objects
271
272 # set stats options
273 objects.Statistics.text_file = options.stats_file
274
275 # set debugging options
276 objects.Debug.break_cycles = options.debug_break
277
278 # set tracing options
279 objects.Trace.flags = options.trace_flags
280 objects.Trace.start = options.trace_start
281 objects.Trace.file = options.trace_file
282 objects.Trace.bufsize = options.trace_circlebuf
283 objects.Trace.dump_on_exit = options.trace_dumponexit
284 objects.Trace.ignore = options.trace_ignore
285
286 # set execution trace options
287 objects.ExecutionTrace.speculative = options.speculative
288 objects.ExecutionTrace.print_cycle = options.print_cycle
289 objects.ExecutionTrace.pc_symbol = options.print_symbol
290 objects.ExecutionTrace.print_opclass = options.print_opclass
291 objects.ExecutionTrace.print_thread = options.print_thread
292 objects.ExecutionTrace.print_effaddr = options.print_effaddr
293 objects.ExecutionTrace.print_data = options.print_data
294 objects.ExecutionTrace.print_iregs = options.print_iregs
295 objects.ExecutionTrace.print_fetchseq = options.print_fetch_seq
296 objects.ExecutionTrace.print_cpseq = options.print_cpseq
297 #objects.ExecutionTrace.print_reg_delta = options.print_reg_delta
298
299 sys.argv = arguments
300 sys.path = [ os.path.dirname(sys.argv[0]) ] + sys.path
301
302 scope = { '__file__' : sys.argv[0] }
303
304 # we want readline if we're doing anything interactive
305 if options.interactive or options.pdb:
306 exec("import readline", scope)
307
308 # if pdb was requested, execfile the thing under pdb, otherwise,
309 # just do the execfile normally
310 if options.pdb:
311 from pdb import Pdb
312 debugger = Pdb()
313 debugger.run('execfile("%s")' % sys.argv[0], scope)
314 else:
315 execfile(sys.argv[0], scope)
316
317 # once the script is done
318 if options.interactive:
319 interact = code.InteractiveConsole(scope)
320 interact.interact("M5 Interactive Console")
321
322if __name__ == '__main__':
323 from pprint import pprint
324
325 parse_args()
326
327 print 'opts:'
328 pprint(options, indent=4)
329 print
330
331 print 'args:'
332 pprint(arguments, indent=4)
|