main.py revision 5472
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 36import config 37import defines 38from options import OptionParser 39import traceflags 40 41__all__ = [ 'options', 'arguments', 'main' ] 42 43def print_list(items, indent=4): 44 line = ' ' * indent 45 for i,item in enumerate(items): 46 if len(line) + len(item) > 76: 47 print line 48 line = ' ' * indent 49 50 if i < len(items) - 1: 51 line += '%s, ' % item 52 else: 53 line += item 54 print line 55 56usage="%prog [m5 options] script.py [script options]" 57version="%prog 2.0" 58brief_copyright=''' 59Copyright (c) 2001-2008 60The Regents of The University of Michigan 61All Rights Reserved 62''' 63 64options = OptionParser(usage=usage, version=version, 65 description=brief_copyright) 66add_option = options.add_option 67set_group = options.set_group 68usage = options.usage 69 70# Help options 71add_option('-A', "--authors", action="store_true", default=False, 72 help="Show author information") 73add_option('-B', "--build-info", action="store_true", default=False, 74 help="Show build information") 75add_option('-C', "--copyright", action="store_true", default=False, 76 help="Show full copyright information") 77add_option('-R', "--readme", action="store_true", default=False, 78 help="Show the readme") 79add_option('-N', "--release-notes", action="store_true", default=False, 80 help="Show the release notes") 81 82# Options for configuring the base simulator 83add_option('-d', "--outdir", metavar="DIR", default=".", 84 help="Set the output directory to DIR [Default: %default]") 85add_option('-i', "--interactive", action="store_true", default=False, 86 help="Invoke the interactive interpreter after running the script") 87add_option("--pdb", action="store_true", default=False, 88 help="Invoke the python debugger before running the script") 89add_option('-p', "--path", metavar="PATH[:PATH]", action='append', split=':', 90 help="Prepend PATH to the system path when invoking the script") 91add_option('-q', "--quiet", action="count", default=0, 92 help="Reduce verbosity") 93add_option('-v', "--verbose", action="count", default=0, 94 help="Increase verbosity") 95 96# Statistics options 97set_group("Statistics Options") 98add_option("--stats-file", metavar="FILE", default="m5stats.txt", 99 help="Sets the output file for statistics [Default: %default]") 100 101# Debugging options 102set_group("Debugging Options") 103add_option("--debug-break", metavar="TIME[,TIME]", action='append', split=',', 104 help="Cycle to create a breakpoint") 105 106# Tracing options 107set_group("Trace Options") 108add_option("--trace-help", action='store_true', 109 help="Print help on trace flags") 110add_option("--trace-flags", metavar="FLAG[,FLAG]", action='append', split=',', 111 help="Sets the flags for tracing (-FLAG disables a flag)") 112add_option("--trace-start", metavar="TIME", type='int', 113 help="Start tracing at TIME (must be in ticks)") 114add_option("--trace-file", metavar="FILE", default="cout", 115 help="Sets the output file for tracing [Default: %default]") 116add_option("--trace-ignore", metavar="EXPR", action='append', split=':', 117 help="Ignore EXPR sim objects") 118 119def main(): 120 import defines 121 import event 122 import info 123 import internal 124 125 # load the options.py config file to allow people to set their own 126 # default options 127 options_file = config.get('options.py') 128 if options_file: 129 scope = { 'options' : options } 130 execfile(options_file, scope) 131 132 arguments = options.parse_args() 133 134 done = False 135 136 if options.build_info: 137 done = True 138 print 'Build information:' 139 print 140 print 'compiled %s' % internal.core.cvar.compileDate; 141 print 'started %s' % datetime.datetime.now().ctime() 142 print 'executing on %s' % socket.gethostname() 143 print 'build options:' 144 keys = defines.m5_build_env.keys() 145 keys.sort() 146 for key in keys: 147 val = defines.m5_build_env[key] 148 print ' %s = %s' % (key, val) 149 print 150 151 if options.copyright: 152 done = True 153 print info.LICENSE 154 print 155 156 if options.authors: 157 done = True 158 print 'Author information:' 159 print 160 print info.AUTHORS 161 print 162 163 if options.readme: 164 done = True 165 print 'Readme:' 166 print 167 print info.README 168 print 169 170 if options.release_notes: 171 done = True 172 print 'Release Notes:' 173 print 174 print info.RELEASE_NOTES 175 print 176 177 if options.trace_help: 178 done = True 179 print "Base Flags:" 180 print_list(traceflags.baseFlags, indent=4) 181 print 182 print "Compound Flags:" 183 for flag in traceflags.compoundFlags: 184 if flag == 'All': 185 continue 186 print " %s:" % flag 187 print_list(traceflags.compoundFlagMap[flag], indent=8) 188 print 189 190 if done: 191 sys.exit(0) 192 193 # setting verbose and quiet at the same time doesn't make sense 194 if options.verbose > 0 and options.quiet > 0: 195 options.usage(2) 196 197 verbose = options.verbose - options.quiet 198 if options.verbose >= 0: 199 print "M5 Simulator System" 200 print brief_copyright 201 print 202 print "M5 compiled %s" % internal.core.cvar.compileDate; 203 print "M5 started %s" % datetime.datetime.now().ctime() 204 print "M5 executing on %s" % socket.gethostname() 205 206 print "M5 revision %s" % internal.core.cvar.hgRev 207 print "M5 commit date %s" % internal.core.cvar.hgDate 208 209 print "command line:", 210 for argv in sys.argv: 211 print argv, 212 print 213 214 # check to make sure we can find the listed script 215 if not arguments or not os.path.isfile(arguments[0]): 216 if arguments and not os.path.isfile(arguments[0]): 217 print "Script %s not found" % arguments[0] 218 219 options.usage(2) 220 221 # tell C++ about output directory 222 internal.core.setOutputDir(options.outdir) 223 224 # update the system path with elements from the -p option 225 sys.path[0:0] = options.path 226 227 import objects 228 229 # set stats options 230 internal.stats.initText(options.stats_file) 231 232 # set debugging options 233 for when in options.debug_break: 234 internal.debug.schedBreakCycle(int(when)) 235 236 on_flags = [] 237 off_flags = [] 238 for flag in options.trace_flags: 239 off = False 240 if flag.startswith('-'): 241 flag = flag[1:] 242 off = True 243 if flag not in traceflags.allFlags: 244 print >>sys.stderr, "invalid trace flag '%s'" % flag 245 sys.exit(1) 246 247 if off: 248 off_flags.append(flag) 249 else: 250 on_flags.append(flag) 251 252 for flag in on_flags: 253 internal.trace.set(flag) 254 255 for flag in off_flags: 256 internal.trace.clear(flag) 257 258 if options.trace_start: 259 def enable_trace(): 260 internal.trace.cvar.enabled = True 261 event.create(enable_trace, int(options.trace_start)) 262 else: 263 internal.trace.cvar.enabled = True 264 265 internal.trace.output(options.trace_file) 266 267 for ignore in options.trace_ignore: 268 internal.trace.ignore(ignore) 269 270 sys.argv = arguments 271 sys.path = [ os.path.dirname(sys.argv[0]) ] + sys.path 272 273 scope = { '__file__' : sys.argv[0], 274 '__name__' : '__m5_main__' } 275 276 # we want readline if we're doing anything interactive 277 if options.interactive or options.pdb: 278 exec "import readline" in scope 279 280 # if pdb was requested, execfile the thing under pdb, otherwise, 281 # just do the execfile normally 282 if options.pdb: 283 from pdb import Pdb 284 debugger = Pdb() 285 debugger.run('execfile("%s")' % sys.argv[0], scope) 286 else: 287 execfile(sys.argv[0], scope) 288 289 # once the script is done 290 if options.interactive: 291 interact = code.InteractiveConsole(scope) 292 interact.interact("M5 Interactive Console") 293 294if __name__ == '__main__': 295 from pprint import pprint 296 297 parse_args() 298 299 print 'opts:' 300 pprint(options, indent=4) 301 print 302 303 print 'args:' 304 pprint(arguments, indent=4) 305