1 # Copyright (c) 2016 ARM Limited
4 # The license below extends only to copyright in the software and shall
5 # not be construed as granting a license to any other intellectual
6 # property including but not limited to intellectual property relating
7 # to a hardware implementation of the functionality of the software
8 # licensed hereunder. You may use the software subject to the license
9 # terms below provided that you ensure that this notice is replicated
10 # unmodified and in its entirety in all distributions of the software,
11 # modified or unmodified, in source code or in binary form.
13 # Copyright (c) 2005 The Regents of The University of Michigan
14 # All rights reserved.
16 # Redistribution and use in source and binary forms, with or without
17 # modification, are permitted provided that the following conditions are
18 # met: redistributions of source code must retain the above copyright
19 # notice, this list of conditions and the following disclaimer;
20 # redistributions in binary form must reproduce the above copyright
21 # notice, this list of conditions and the following disclaimer in the
22 # documentation and/or other materials provided with the distribution;
23 # neither the name of the copyright holders nor the names of its
24 # contributors may be used to endorse or promote products derived from
25 # this software without specific prior written permission.
27 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
28 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
29 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
30 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
31 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
32 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
33 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
34 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
35 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
36 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
37 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 # Authors: Nathan Binkert
41 from __future__
import print_function
49 __all__
= [ 'options', 'arguments', 'main' ]
51 usage
="%prog [gem5 options] script.py [script options]"
54 "gem5 is copyrighted software; use the --copyright option for details."
58 from options
import OptionParser
60 options
= OptionParser(usage
=usage
, version
=version
,
61 description
=brief_copyright
)
62 option
= options
.add_option
63 group
= options
.set_group
65 listener_modes
= ( "on", "off", "auto" )
68 option('-B', "--build-info", action
="store_true", default
=False,
69 help="Show build information")
70 option('-C', "--copyright", action
="store_true", default
=False,
71 help="Show full copyright information")
72 option('-R', "--readme", action
="store_true", default
=False,
73 help="Show the readme")
75 # Options for configuring the base simulator
76 option('-d', "--outdir", metavar
="DIR", default
="m5out",
77 help="Set the output directory to DIR [Default: %default]")
78 option('-r', "--redirect-stdout", action
="store_true", default
=False,
79 help="Redirect stdout (& stderr, without -e) to file")
80 option('-e', "--redirect-stderr", action
="store_true", default
=False,
81 help="Redirect stderr to file")
82 option("--stdout-file", metavar
="FILE", default
="simout",
83 help="Filename for -r redirection [Default: %default]")
84 option("--stderr-file", metavar
="FILE", default
="simerr",
85 help="Filename for -e redirection [Default: %default]")
86 option("--listener-mode", metavar
="{on,off,auto}",
87 choices
=listener_modes
, default
="auto",
88 help="Port (e.g., gdb) listener mode (auto: Enable if running " \
89 "interactively) [Default: %default]")
90 option("--listener-loopback-only", action
="store_true", default
=False,
91 help="Port listeners will only accept connections over the " \
93 option('-i', "--interactive", action
="store_true", default
=False,
94 help="Invoke the interactive interpreter after running the script")
95 option("--pdb", action
="store_true", default
=False,
96 help="Invoke the python debugger before running the script")
97 option('-p', "--path", metavar
="PATH[:PATH]", action
='append', split
=':',
98 help="Prepend PATH to the system path when invoking the script")
99 option('-q', "--quiet", action
="count", default
=0,
100 help="Reduce verbosity")
101 option('-v', "--verbose", action
="count", default
=0,
102 help="Increase verbosity")
105 group("Statistics Options")
106 option("--stats-file", metavar
="FILE", default
="stats.txt",
107 help="Sets the output file for statistics [Default: %default]")
109 # Configuration Options
110 group("Configuration Options")
111 option("--dump-config", metavar
="FILE", default
="config.ini",
112 help="Dump configuration output file [Default: %default]")
113 option("--json-config", metavar
="FILE", default
="config.json",
114 help="Create JSON output of the configuration [Default: %default]")
115 option("--dot-config", metavar
="FILE", default
="config.dot",
116 help="Create DOT & pdf outputs of the configuration [Default: %default]")
117 option("--dot-dvfs-config", metavar
="FILE", default
=None,
118 help="Create DOT & pdf outputs of the DVFS configuration" + \
119 " [Default: %default]")
122 group("Debugging Options")
123 option("--debug-break", metavar
="TICK[,TICK]", action
='append', split
=',',
124 help="Create breakpoint(s) at TICK(s) " \
125 "(kills process if no debugger attached)")
126 option("--debug-help", action
='store_true',
127 help="Print help on debug flags")
128 option("--debug-flags", metavar
="FLAG[,FLAG]", action
='append', split
=',',
129 help="Sets the flags for debug output (-FLAG disables a flag)")
130 option("--debug-start", metavar
="TICK", type='int',
131 help="Start debug output at TICK")
132 option("--debug-end", metavar
="TICK", type='int',
133 help="End debug output at TICK")
134 option("--debug-file", metavar
="FILE", default
="cout",
135 help="Sets the output file for debug [Default: %default]")
136 option("--debug-ignore", metavar
="EXPR", action
='append', split
=':',
137 help="Ignore EXPR sim objects")
138 option("--remote-gdb-port", type='int', default
=7000,
139 help="Remote gdb base port (set to 0 to disable listening)")
142 group("Help Options")
143 option("--list-sim-objects", action
='store_true', default
=False,
144 help="List all built-in SimObjects, their params and default values")
146 # load the options.py config file to allow people to set their own
148 options_file
= config
.get('options.py')
150 scope
= { 'options' : options
}
151 execfile(options_file
, scope
)
153 arguments
= options
.parse_args()
154 return options
,arguments
157 banner
= "gem5 Interactive Console"
160 prompt_in1
= "gem5 \\#> "
161 prompt_out
= "gem5 \\#: "
163 # Is IPython version 0.10 or earlier available?
165 from IPython
.Shell
import IPShellEmbed
166 ipshell
= IPShellEmbed(argv
=["-prompt_in1", prompt_in1
,
167 "-prompt_out", prompt_out
],
168 banner
=banner
, user_ns
=scope
)
172 # Is IPython version 0.11 or later available?
176 from IPython
.config
.loader
import Config
177 from IPython
.terminal
.embed
import InteractiveShellEmbed
180 cfg
.PromptManager
.in_template
= prompt_in1
181 cfg
.PromptManager
.out_template
= prompt_out
182 ipshell
= InteractiveShellEmbed(config
=cfg
, user_ns
=scope
,
190 # Use the Python shell in the standard library if IPython
192 code
.InteractiveConsole(scope
).interact(banner
)
205 from util
import inform
, fatal
, panic
, isInteractive
208 options
, arguments
= parse_options()
210 options
, arguments
= args
212 raise TypeError, "main() takes 0 or 2 arguments (%d given)" % len(args
)
217 if defines
.TRACING_ON
:
220 fatal("Tracing is not enabled. Compile with TRACING_ON")
222 # Set the main event queue for the main thread.
223 event
.mainq
= event
.getEventQueue(0)
224 event
.setEventQueue(event
.mainq
)
226 if not os
.path
.isdir(options
.outdir
):
227 os
.makedirs(options
.outdir
)
229 # These filenames are used only if the redirect_std* options are set
230 stdout_file
= os
.path
.join(options
.outdir
, options
.stdout_file
)
231 stderr_file
= os
.path
.join(options
.outdir
, options
.stderr_file
)
233 # Print redirection notices here before doing any redirection
234 if options
.redirect_stdout
and not options
.redirect_stderr
:
235 print("Redirecting stdout and stderr to", stdout_file
)
237 if options
.redirect_stdout
:
238 print("Redirecting stdout to", stdout_file
)
239 if options
.redirect_stderr
:
240 print("Redirecting stderr to", stderr_file
)
242 # Now redirect stdout/stderr as desired
243 if options
.redirect_stdout
:
244 redir_fd
= os
.open(stdout_file
, os
. O_WRONLY | os
.O_CREAT | os
.O_TRUNC
)
245 os
.dup2(redir_fd
, sys
.stdout
.fileno())
246 if not options
.redirect_stderr
:
247 os
.dup2(redir_fd
, sys
.stderr
.fileno())
249 if options
.redirect_stderr
:
250 redir_fd
= os
.open(stderr_file
, os
. O_WRONLY | os
.O_CREAT | os
.O_TRUNC
)
251 os
.dup2(redir_fd
, sys
.stderr
.fileno())
255 if options
.build_info
:
257 print('Build information:')
259 print('compiled %s' % defines
.compileDate
)
260 print('build options:')
261 keys
= defines
.buildEnv
.keys()
264 val
= defines
.buildEnv
[key
]
265 print(' %s = %s' % (key
, val
))
268 if options
.copyright
:
280 if options
.debug_help
:
285 if options
.list_sim_objects
:
289 objects
= SimObject
.allClasses
.keys()
292 obj
= SimObject
.allClasses
[name
]
294 params
= obj
._params
.keys()
297 param
= obj
._params
[pname
]
298 default
= getattr(param
, 'default', '')
301 print(" default: %s" % default
)
302 print(" desc: %s" % param
.desc
)
309 # setting verbose and quiet at the same time doesn't make sense
310 if options
.verbose
> 0 and options
.quiet
> 0:
313 verbose
= options
.verbose
- options
.quiet
315 print("gem5 Simulator System. http://gem5.org")
316 print(brief_copyright
)
319 print("gem5 compiled %s" % defines
.compileDate
)
321 print("gem5 started %s" %
322 datetime
.datetime
.now().strftime("%b %e %Y %X"))
323 print("gem5 executing on %s, pid %d" %
324 (socket
.gethostname(), os
.getpid()))
326 # in Python 3 pipes.quote() is moved to shlex.quote()
328 print("command line:", " ".join(map(pipes
.quote
, sys
.argv
)))
331 # check to make sure we can find the listed script
332 if not arguments
or not os
.path
.isfile(arguments
[0]):
333 if arguments
and not os
.path
.isfile(arguments
[0]):
334 print("Script %s not found" % arguments
[0])
338 # tell C++ about output directory
339 core
.setOutputDir(options
.outdir
)
341 # update the system path with elements from the -p option
342 sys
.path
[0:0] = options
.path
345 stats
.addStatVisitor(options
.stats_file
)
347 # Disable listeners unless running interactively or explicitly
349 if options
.listener_mode
== "off":
350 m5
.disableAllListeners()
351 elif options
.listener_mode
== "auto":
352 if not isInteractive():
353 inform("Standard input is not a terminal, disabling listeners.")
354 m5
.disableAllListeners()
355 elif options
.listener_mode
== "on":
358 panic("Unhandled listener mode: %s" % options
.listener_mode
)
360 if options
.listener_loopback_only
:
361 m5
.listenersLoopbackOnly()
363 # set debugging options
364 debug
.setRemoteGDBPort(options
.remote_gdb_port
)
365 for when
in options
.debug_break
:
366 debug
.schedBreak(int(when
))
368 if options
.debug_flags
:
373 for flag
in options
.debug_flags
:
375 if flag
.startswith('-'):
379 if flag
not in debug
.flags
:
380 print("invalid debug flag '%s'" % flag
, file=sys
.stderr
)
384 debug
.flags
[flag
].disable()
386 debug
.flags
[flag
].enable()
388 if options
.debug_start
:
390 e
= event
.create(trace
.enable
, event
.Event
.Debug_Enable_Pri
)
391 event
.mainq
.schedule(e
, options
.debug_start
)
395 if options
.debug_end
:
397 e
= event
.create(trace
.disable
, event
.Event
.Debug_Enable_Pri
)
398 event
.mainq
.schedule(e
, options
.debug_end
)
400 trace
.output(options
.debug_file
)
402 for ignore
in options
.debug_ignore
:
407 sys
.path
= [ os
.path
.dirname(sys
.argv
[0]) ] + sys
.path
409 filename
= sys
.argv
[0]
410 filedata
= file(filename
, 'r').read()
411 filecode
= compile(filedata
, filename
, 'exec')
412 scope
= { '__file__' : filename
,
413 '__name__' : '__m5_main__' }
415 # if pdb was requested, execfile the thing under pdb, otherwise,
416 # just do the execfile normally
423 pdb
.run(filecode
, scope
)
425 print("The program exited via sys.exit(). Exit status: ", end
=' ')
426 print(sys
.exc_info()[1])
428 traceback
.print_exc()
429 print("Uncaught exception. Entering post mortem debugging")
430 t
= sys
.exc_info()[2]
431 while t
.tb_next
is not None:
433 pdb
.interaction(t
.tb_frame
,t
)
435 exec filecode
in scope
437 # once the script is done
438 if options
.interactive
:
441 if __name__
== '__main__':
442 from pprint
import pprint
444 options
, arguments
= parse_options()
447 pprint(options
, indent
=4)
451 pprint(arguments
, indent
=4)