main.py revision 7974:13692327bb0b
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 30import datetime 31import os 32import socket 33import sys 34 35from util import attrdict, fatal 36import config 37from options import OptionParser 38 39__all__ = [ 'options', 'arguments', 'main' ] 40 41usage="%prog [m5 options] script.py [script options]" 42version="%prog 2.0" 43brief_copyright=''' 44Copyright (c) 2001-2008 45The Regents of The University of Michigan 46All Rights Reserved 47''' 48 49options = OptionParser(usage=usage, version=version, 50 description=brief_copyright) 51add_option = options.add_option 52set_group = options.set_group 53usage = options.usage 54 55# Help options 56add_option('-A', "--authors", action="store_true", default=False, 57 help="Show author information") 58add_option('-B', "--build-info", action="store_true", default=False, 59 help="Show build information") 60add_option('-C', "--copyright", action="store_true", default=False, 61 help="Show full copyright information") 62add_option('-R', "--readme", action="store_true", default=False, 63 help="Show the readme") 64 65# Options for configuring the base simulator 66add_option('-d', "--outdir", metavar="DIR", default="m5out", 67 help="Set the output directory to DIR [Default: %default]") 68add_option('-r', "--redirect-stdout", action="store_true", default=False, 69 help="Redirect stdout (& stderr, without -e) to file") 70add_option('-e', "--redirect-stderr", action="store_true", default=False, 71 help="Redirect stderr to file") 72add_option("--stdout-file", metavar="FILE", default="simout", 73 help="Filename for -r redirection [Default: %default]") 74add_option("--stderr-file", metavar="FILE", default="simerr", 75 help="Filename for -e redirection [Default: %default]") 76add_option('-i', "--interactive", action="store_true", default=False, 77 help="Invoke the interactive interpreter after running the script") 78add_option("--pdb", action="store_true", default=False, 79 help="Invoke the python debugger before running the script") 80add_option('-p', "--path", metavar="PATH[:PATH]", action='append', split=':', 81 help="Prepend PATH to the system path when invoking the script") 82add_option('-q', "--quiet", action="count", default=0, 83 help="Reduce verbosity") 84add_option('-v', "--verbose", action="count", default=0, 85 help="Increase verbosity") 86 87# Statistics options 88set_group("Statistics Options") 89add_option("--stats-file", metavar="FILE", default="stats.txt", 90 help="Sets the output file for statistics [Default: %default]") 91 92# Configuration Options 93set_group("Configuration Options") 94add_option("--dump-config", metavar="FILE", default="config.ini", 95 help="Dump configuration output file [Default: %default]") 96 97# Debugging options 98set_group("Debugging Options") 99add_option("--debug-break", metavar="TIME[,TIME]", action='append', split=',', 100 help="Cycle to create a breakpoint") 101add_option("--remote-gdb-port", type='int', default=7000, 102 help="Remote gdb base port (set to 0 to disable listening)") 103 104# Tracing options 105set_group("Trace Options") 106add_option("--trace-help", action='store_true', 107 help="Print help on trace flags") 108add_option("--trace-flags", metavar="FLAG[,FLAG]", action='append', split=',', 109 help="Sets the flags for tracing (-FLAG disables a flag)") 110add_option("--trace-start", metavar="TIME", type='int', 111 help="Start tracing at TIME (must be in ticks)") 112add_option("--trace-file", metavar="FILE", default="cout", 113 help="Sets the output file for tracing [Default: %default]") 114add_option("--trace-ignore", metavar="EXPR", action='append', split=':', 115 help="Ignore EXPR sim objects") 116 117# Help options 118set_group("Help Options") 119add_option("--list-sim-objects", action='store_true', default=False, 120 help="List all built-in SimObjects, their parameters and default values") 121 122# load the options.py config file to allow people to set their own 123# default options 124options_file = config.get('options.py') 125if options_file: 126 scope = { 'options' : options } 127 execfile(options_file, scope) 128 129arguments = options.parse_args() 130 131def main(): 132 import core 133 import debug 134 import defines 135 import event 136 import info 137 import stats 138 import trace 139 140 def check_tracing(): 141 if defines.TRACING_ON: 142 return 143 144 fatal("Tracing is not enabled. Compile with TRACING_ON") 145 146 if not os.path.isdir(options.outdir): 147 os.makedirs(options.outdir) 148 149 # These filenames are used only if the redirect_std* options are set 150 stdout_file = os.path.join(options.outdir, options.stdout_file) 151 stderr_file = os.path.join(options.outdir, options.stderr_file) 152 153 # Print redirection notices here before doing any redirection 154 if options.redirect_stdout and not options.redirect_stderr: 155 print "Redirecting stdout and stderr to", stdout_file 156 else: 157 if options.redirect_stdout: 158 print "Redirecting stdout to", stdout_file 159 if options.redirect_stderr: 160 print "Redirecting stderr to", stderr_file 161 162 # Now redirect stdout/stderr as desired 163 if options.redirect_stdout: 164 redir_fd = os.open(stdout_file, os. O_WRONLY | os.O_CREAT | os.O_TRUNC) 165 os.dup2(redir_fd, sys.stdout.fileno()) 166 if not options.redirect_stderr: 167 os.dup2(redir_fd, sys.stderr.fileno()) 168 169 if options.redirect_stderr: 170 redir_fd = os.open(stderr_file, os. O_WRONLY | os.O_CREAT | os.O_TRUNC) 171 os.dup2(redir_fd, sys.stderr.fileno()) 172 173 done = False 174 175 if options.build_info: 176 done = True 177 print 'Build information:' 178 print 179 print 'compiled %s' % defines.compileDate; 180 print "revision %s" % defines.hgRev 181 print 'build options:' 182 keys = defines.buildEnv.keys() 183 keys.sort() 184 for key in keys: 185 val = defines.buildEnv[key] 186 print ' %s = %s' % (key, val) 187 print 188 189 if options.copyright: 190 done = True 191 print info.LICENSE 192 print 193 194 if options.authors: 195 done = True 196 print 'Author information:' 197 print 198 print info.AUTHORS 199 print 200 201 if options.readme: 202 done = True 203 print 'Readme:' 204 print 205 print info.README 206 print 207 208 if options.trace_help: 209 done = True 210 check_tracing() 211 trace.help() 212 213 if options.list_sim_objects: 214 import SimObject 215 done = True 216 print "SimObjects:" 217 objects = SimObject.allClasses.keys() 218 objects.sort() 219 for name in objects: 220 obj = SimObject.allClasses[name] 221 print " %s" % obj 222 params = obj._params.keys() 223 params.sort() 224 for pname in params: 225 param = obj._params[pname] 226 default = getattr(param, 'default', '') 227 print " %s" % pname 228 if default: 229 print " default: %s" % default 230 print " desc: %s" % param.desc 231 print 232 print 233 234 if done: 235 sys.exit(0) 236 237 # setting verbose and quiet at the same time doesn't make sense 238 if options.verbose > 0 and options.quiet > 0: 239 options.usage(2) 240 241 verbose = options.verbose - options.quiet 242 if options.verbose >= 0: 243 print "M5 Simulator System" 244 print brief_copyright 245 print 246 247 print "M5 compiled %s" % defines.compileDate; 248 print "M5 revision %s" % defines.hgRev 249 250 print "M5 started %s" % datetime.datetime.now().strftime("%b %e %Y %X") 251 print "M5 executing on %s" % socket.gethostname() 252 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 263 options.usage(2) 264 265 # tell C++ about output directory 266 core.setOutputDir(options.outdir) 267 268 # update the system path with elements from the -p option 269 sys.path[0:0] = options.path 270 271 # set stats options 272 stats.initText(options.stats_file) 273 274 # set debugging options 275 debug.setRemoteGDBPort(options.remote_gdb_port) 276 for when in options.debug_break: 277 debug.schedBreakCycle(int(when)) 278 279 if options.trace_flags: 280 check_tracing() 281 282 on_flags = [] 283 off_flags = [] 284 for flag in options.trace_flags: 285 off = False 286 if flag.startswith('-'): 287 flag = flag[1:] 288 off = True 289 if flag not in trace.flags.all and flag != "All": 290 print >>sys.stderr, "invalid trace flag '%s'" % flag 291 sys.exit(1) 292 293 if off: 294 off_flags.append(flag) 295 else: 296 on_flags.append(flag) 297 298 for flag in on_flags: 299 trace.set(flag) 300 301 for flag in off_flags: 302 trace.clear(flag) 303 304 if options.trace_start: 305 check_tracing() 306 e = event.create(trace.enable, event.Event.Trace_Enable_Pri) 307 event.mainq.schedule(e, options.trace_start) 308 else: 309 trace.enable() 310 311 trace.output(options.trace_file) 312 313 for ignore in options.trace_ignore: 314 check_tracing() 315 trace.ignore(ignore) 316 317 sys.argv = arguments 318 sys.path = [ os.path.dirname(sys.argv[0]) ] + sys.path 319 320 filename = sys.argv[0] 321 filedata = file(filename, 'r').read() 322 filecode = compile(filedata, filename, 'exec') 323 scope = { '__file__' : filename, 324 '__name__' : '__m5_main__' } 325 326 # we want readline if we're doing anything interactive 327 if options.interactive or options.pdb: 328 exec "import readline" in scope 329 330 # if pdb was requested, execfile the thing under pdb, otherwise, 331 # just do the execfile normally 332 if options.pdb: 333 import pdb 334 import traceback 335 336 pdb = pdb.Pdb() 337 try: 338 pdb.run(filecode, scope) 339 except SystemExit: 340 print "The program exited via sys.exit(). Exit status: ", 341 print sys.exc_info()[1] 342 except: 343 traceback.print_exc() 344 print "Uncaught exception. Entering post mortem debugging" 345 t = sys.exc_info()[2] 346 while t.tb_next is not None: 347 t = t.tb_next 348 pdb.interaction(t.tb_frame,t) 349 else: 350 exec filecode in scope 351 352 # once the script is done 353 if options.interactive: 354 banner = "M5 Interactive Console" 355 try: 356 from IPython.Shell import IPShellEmbed 357 ipshell = IPShellEmbed(banner=banner,user_ns=scope) 358 ipshell() 359 except ImportError: 360 code.InteractiveConsole(scope).interact(banner) 361 362if __name__ == '__main__': 363 from pprint import pprint 364 365 print 'opts:' 366 pprint(options, indent=4) 367 print 368 369 print 'args:' 370 pprint(arguments, indent=4) 371