main.py revision 5524
12889Sbinkertn@umich.edu# Copyright (c) 2005 The Regents of The University of Michigan 22889Sbinkertn@umich.edu# All rights reserved. 32889Sbinkertn@umich.edu# 42889Sbinkertn@umich.edu# Redistribution and use in source and binary forms, with or without 52889Sbinkertn@umich.edu# modification, are permitted provided that the following conditions are 62889Sbinkertn@umich.edu# met: redistributions of source code must retain the above copyright 72889Sbinkertn@umich.edu# notice, this list of conditions and the following disclaimer; 82889Sbinkertn@umich.edu# redistributions in binary form must reproduce the above copyright 92889Sbinkertn@umich.edu# notice, this list of conditions and the following disclaimer in the 102889Sbinkertn@umich.edu# documentation and/or other materials provided with the distribution; 112889Sbinkertn@umich.edu# neither the name of the copyright holders nor the names of its 122889Sbinkertn@umich.edu# contributors may be used to endorse or promote products derived from 132889Sbinkertn@umich.edu# this software without specific prior written permission. 142889Sbinkertn@umich.edu# 152889Sbinkertn@umich.edu# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 162889Sbinkertn@umich.edu# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 172889Sbinkertn@umich.edu# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 182889Sbinkertn@umich.edu# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 192889Sbinkertn@umich.edu# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 202889Sbinkertn@umich.edu# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 212889Sbinkertn@umich.edu# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 222889Sbinkertn@umich.edu# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 232889Sbinkertn@umich.edu# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 242889Sbinkertn@umich.edu# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 252889Sbinkertn@umich.edu# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 262889Sbinkertn@umich.edu# 272889Sbinkertn@umich.edu# Authors: Nathan Binkert 282889Sbinkertn@umich.edu 294850Snate@binkert.orgimport code 304850Snate@binkert.orgimport datetime 314850Snate@binkert.orgimport os 324850Snate@binkert.orgimport socket 334850Snate@binkert.orgimport sys 344850Snate@binkert.org 355467Snate@binkert.orgfrom util import attrdict 365471Snate@binkert.orgimport config 374850Snate@binkert.orgimport defines 385470Snate@binkert.orgfrom options import OptionParser 394053Sbinkertn@umich.eduimport traceflags 402889Sbinkertn@umich.edu 412889Sbinkertn@umich.edu__all__ = [ 'options', 'arguments', 'main' ] 422889Sbinkertn@umich.edu 434053Sbinkertn@umich.edudef print_list(items, indent=4): 444053Sbinkertn@umich.edu line = ' ' * indent 454053Sbinkertn@umich.edu for i,item in enumerate(items): 464053Sbinkertn@umich.edu if len(line) + len(item) > 76: 474053Sbinkertn@umich.edu print line 484053Sbinkertn@umich.edu line = ' ' * indent 494053Sbinkertn@umich.edu 504053Sbinkertn@umich.edu if i < len(items) - 1: 514053Sbinkertn@umich.edu line += '%s, ' % item 524053Sbinkertn@umich.edu else: 534053Sbinkertn@umich.edu line += item 544053Sbinkertn@umich.edu print line 554053Sbinkertn@umich.edu 565470Snate@binkert.orgusage="%prog [m5 options] script.py [script options]" 575470Snate@binkert.orgversion="%prog 2.0" 585470Snate@binkert.orgbrief_copyright=''' 595470Snate@binkert.orgCopyright (c) 2001-2008 605470Snate@binkert.orgThe Regents of The University of Michigan 615470Snate@binkert.orgAll Rights Reserved 625470Snate@binkert.org''' 632889Sbinkertn@umich.edu 645470Snate@binkert.orgoptions = OptionParser(usage=usage, version=version, 655470Snate@binkert.org description=brief_copyright) 665470Snate@binkert.orgadd_option = options.add_option 675470Snate@binkert.orgset_group = options.set_group 685470Snate@binkert.orgusage = options.usage 692889Sbinkertn@umich.edu 702889Sbinkertn@umich.edu# Help options 712889Sbinkertn@umich.eduadd_option('-A', "--authors", action="store_true", default=False, 722889Sbinkertn@umich.edu help="Show author information") 734850Snate@binkert.orgadd_option('-B', "--build-info", action="store_true", default=False, 744850Snate@binkert.org help="Show build information") 752889Sbinkertn@umich.eduadd_option('-C', "--copyright", action="store_true", default=False, 762889Sbinkertn@umich.edu help="Show full copyright information") 772889Sbinkertn@umich.eduadd_option('-R', "--readme", action="store_true", default=False, 782889Sbinkertn@umich.edu help="Show the readme") 792889Sbinkertn@umich.eduadd_option('-N', "--release-notes", action="store_true", default=False, 802889Sbinkertn@umich.edu help="Show the release notes") 812889Sbinkertn@umich.edu 822889Sbinkertn@umich.edu# Options for configuring the base simulator 832889Sbinkertn@umich.eduadd_option('-d', "--outdir", metavar="DIR", default=".", 842889Sbinkertn@umich.edu help="Set the output directory to DIR [Default: %default]") 855524Sstever@gmail.comadd_option('-r', "--redirect-stdout", action="store_true", default=False, 865524Sstever@gmail.com help="Redirect stdout (& stderr, without -e) to file") 875524Sstever@gmail.comadd_option('-e', "--redirect-stderr", action="store_true", default=False, 885524Sstever@gmail.com help="Redirect stderr to file") 895524Sstever@gmail.comadd_option("--stdout-file", metavar="FILE", default="simout", 905524Sstever@gmail.com help="Filename for -r redirection [Default: %default]") 915524Sstever@gmail.comadd_option("--stderr-file", metavar="FILE", default="simerr", 925524Sstever@gmail.com help="Filename for -e redirection [Default: %default]") 932889Sbinkertn@umich.eduadd_option('-i', "--interactive", action="store_true", default=False, 942889Sbinkertn@umich.edu help="Invoke the interactive interpreter after running the script") 952899Sbinkertn@umich.eduadd_option("--pdb", action="store_true", default=False, 962899Sbinkertn@umich.edu help="Invoke the python debugger before running the script") 972889Sbinkertn@umich.eduadd_option('-p', "--path", metavar="PATH[:PATH]", action='append', split=':', 982889Sbinkertn@umich.edu help="Prepend PATH to the system path when invoking the script") 992889Sbinkertn@umich.eduadd_option('-q', "--quiet", action="count", default=0, 1002889Sbinkertn@umich.edu help="Reduce verbosity") 1012889Sbinkertn@umich.eduadd_option('-v', "--verbose", action="count", default=0, 1022889Sbinkertn@umich.edu help="Increase verbosity") 1032889Sbinkertn@umich.edu 1042889Sbinkertn@umich.edu# Statistics options 1052889Sbinkertn@umich.eduset_group("Statistics Options") 1062889Sbinkertn@umich.eduadd_option("--stats-file", metavar="FILE", default="m5stats.txt", 1072889Sbinkertn@umich.edu help="Sets the output file for statistics [Default: %default]") 1082889Sbinkertn@umich.edu 1092889Sbinkertn@umich.edu# Debugging options 1102889Sbinkertn@umich.eduset_group("Debugging Options") 1112889Sbinkertn@umich.eduadd_option("--debug-break", metavar="TIME[,TIME]", action='append', split=',', 1122889Sbinkertn@umich.edu help="Cycle to create a breakpoint") 1135512SMichael.Adler@intel.comadd_option("--remote-gdb-port", type='int', default=7000, 1145512SMichael.Adler@intel.com help="Remote gdb base port") 1152889Sbinkertn@umich.edu 1162889Sbinkertn@umich.edu# Tracing options 1172889Sbinkertn@umich.eduset_group("Trace Options") 1184053Sbinkertn@umich.eduadd_option("--trace-help", action='store_true', 1194053Sbinkertn@umich.edu help="Print help on trace flags") 1202889Sbinkertn@umich.eduadd_option("--trace-flags", metavar="FLAG[,FLAG]", action='append', split=',', 1214053Sbinkertn@umich.edu help="Sets the flags for tracing (-FLAG disables a flag)") 1224044Sbinkertn@umich.eduadd_option("--trace-start", metavar="TIME", type='int', 1234044Sbinkertn@umich.edu help="Start tracing at TIME (must be in ticks)") 1242889Sbinkertn@umich.eduadd_option("--trace-file", metavar="FILE", default="cout", 1252889Sbinkertn@umich.edu help="Sets the output file for tracing [Default: %default]") 1262889Sbinkertn@umich.eduadd_option("--trace-ignore", metavar="EXPR", action='append', split=':', 1272889Sbinkertn@umich.edu help="Ignore EXPR sim objects") 1282889Sbinkertn@umich.edu 1295473Snate@binkert.org# Help options 1305473Snate@binkert.orgset_group("Help Options") 1315473Snate@binkert.orgadd_option("--list-sim-objects", action='store_true', default=False, 1325473Snate@binkert.org help="List all built-in SimObjects, their parameters and default values") 1335473Snate@binkert.org 1342889Sbinkertn@umich.edudef main(): 1354042Sbinkertn@umich.edu import defines 1364167Sbinkertn@umich.edu import event 1374042Sbinkertn@umich.edu import info 1383624Sbinkertn@umich.edu import internal 1392889Sbinkertn@umich.edu 1405472Snate@binkert.org # load the options.py config file to allow people to set their own 1415472Snate@binkert.org # default options 1425472Snate@binkert.org options_file = config.get('options.py') 1435472Snate@binkert.org if options_file: 1445472Snate@binkert.org scope = { 'options' : options } 1455472Snate@binkert.org execfile(options_file, scope) 1465472Snate@binkert.org 1475470Snate@binkert.org arguments = options.parse_args() 1482889Sbinkertn@umich.edu 1495524Sstever@gmail.com if not os.path.isdir(options.outdir): 1505524Sstever@gmail.com os.makedirs(options.outdir) 1515524Sstever@gmail.com 1525524Sstever@gmail.com # These filenames are used only if the redirect_std* options are set 1535524Sstever@gmail.com stdout_file = os.path.join(options.outdir, options.stdout_file) 1545524Sstever@gmail.com stderr_file = os.path.join(options.outdir, options.stderr_file) 1555524Sstever@gmail.com 1565524Sstever@gmail.com # Print redirection notices here before doing any redirection 1575524Sstever@gmail.com if options.redirect_stdout and not options.redirect_stderr: 1585524Sstever@gmail.com print "Redirecting stdout and stderr to", stdout_file 1595524Sstever@gmail.com else: 1605524Sstever@gmail.com if options.redirect_stdout: 1615524Sstever@gmail.com print "Redirecting stdout to", stdout_file 1625524Sstever@gmail.com if options.redirect_stderr: 1635524Sstever@gmail.com print "Redirecting stderr to", stderr_file 1645524Sstever@gmail.com 1655524Sstever@gmail.com # Now redirect stdout/stderr as desired 1665524Sstever@gmail.com if options.redirect_stdout: 1675524Sstever@gmail.com redir_fd = os.open(stdout_file, os. O_WRONLY | os.O_CREAT | os.O_TRUNC) 1685524Sstever@gmail.com os.dup2(redir_fd, sys.stdout.fileno()) 1695524Sstever@gmail.com if not options.redirect_stderr: 1705524Sstever@gmail.com os.dup2(redir_fd, sys.stderr.fileno()) 1715524Sstever@gmail.com 1725524Sstever@gmail.com if options.redirect_stderr: 1735524Sstever@gmail.com redir_fd = os.open(stderr_file, os. O_WRONLY | os.O_CREAT | os.O_TRUNC) 1745524Sstever@gmail.com os.dup2(redir_fd, sys.stderr.fileno()) 1755524Sstever@gmail.com 1762889Sbinkertn@umich.edu done = False 1774850Snate@binkert.org 1784850Snate@binkert.org if options.build_info: 1794850Snate@binkert.org done = True 1804850Snate@binkert.org print 'Build information:' 1814850Snate@binkert.org print 1824850Snate@binkert.org print 'compiled %s' % internal.core.cvar.compileDate; 1834850Snate@binkert.org print 'started %s' % datetime.datetime.now().ctime() 1844850Snate@binkert.org print 'executing on %s' % socket.gethostname() 1854850Snate@binkert.org print 'build options:' 1864850Snate@binkert.org keys = defines.m5_build_env.keys() 1874850Snate@binkert.org keys.sort() 1884850Snate@binkert.org for key in keys: 1894850Snate@binkert.org val = defines.m5_build_env[key] 1904850Snate@binkert.org print ' %s = %s' % (key, val) 1914850Snate@binkert.org print 1924850Snate@binkert.org 1932889Sbinkertn@umich.edu if options.copyright: 1942889Sbinkertn@umich.edu done = True 1952889Sbinkertn@umich.edu print info.LICENSE 1962889Sbinkertn@umich.edu print 1972889Sbinkertn@umich.edu 1982889Sbinkertn@umich.edu if options.authors: 1992889Sbinkertn@umich.edu done = True 2002889Sbinkertn@umich.edu print 'Author information:' 2012889Sbinkertn@umich.edu print 2022889Sbinkertn@umich.edu print info.AUTHORS 2032889Sbinkertn@umich.edu print 2042889Sbinkertn@umich.edu 2052889Sbinkertn@umich.edu if options.readme: 2062889Sbinkertn@umich.edu done = True 2072889Sbinkertn@umich.edu print 'Readme:' 2082889Sbinkertn@umich.edu print 2092889Sbinkertn@umich.edu print info.README 2102889Sbinkertn@umich.edu print 2112889Sbinkertn@umich.edu 2122889Sbinkertn@umich.edu if options.release_notes: 2132889Sbinkertn@umich.edu done = True 2142889Sbinkertn@umich.edu print 'Release Notes:' 2152889Sbinkertn@umich.edu print 2162889Sbinkertn@umich.edu print info.RELEASE_NOTES 2172889Sbinkertn@umich.edu print 2182889Sbinkertn@umich.edu 2194053Sbinkertn@umich.edu if options.trace_help: 2204053Sbinkertn@umich.edu done = True 2214053Sbinkertn@umich.edu print "Base Flags:" 2224053Sbinkertn@umich.edu print_list(traceflags.baseFlags, indent=4) 2234053Sbinkertn@umich.edu print 2244053Sbinkertn@umich.edu print "Compound Flags:" 2254053Sbinkertn@umich.edu for flag in traceflags.compoundFlags: 2264053Sbinkertn@umich.edu if flag == 'All': 2274053Sbinkertn@umich.edu continue 2284053Sbinkertn@umich.edu print " %s:" % flag 2294053Sbinkertn@umich.edu print_list(traceflags.compoundFlagMap[flag], indent=8) 2304053Sbinkertn@umich.edu print 2314053Sbinkertn@umich.edu 2325473Snate@binkert.org if options.list_sim_objects: 2335473Snate@binkert.org import SimObject 2345473Snate@binkert.org done = True 2355473Snate@binkert.org print "SimObjects:" 2365473Snate@binkert.org objects = SimObject.allClasses.keys() 2375473Snate@binkert.org objects.sort() 2385473Snate@binkert.org for name in objects: 2395473Snate@binkert.org obj = SimObject.allClasses[name] 2405473Snate@binkert.org print " %s" % obj 2415473Snate@binkert.org params = obj._params.keys() 2425473Snate@binkert.org params.sort() 2435473Snate@binkert.org for pname in params: 2445473Snate@binkert.org param = obj._params[pname] 2455473Snate@binkert.org default = getattr(param, 'default', '') 2465473Snate@binkert.org print " %s" % pname 2475473Snate@binkert.org if default: 2485473Snate@binkert.org print " default: %s" % default 2495473Snate@binkert.org print " desc: %s" % param.desc 2505473Snate@binkert.org print 2515473Snate@binkert.org print 2525473Snate@binkert.org 2532889Sbinkertn@umich.edu if done: 2542889Sbinkertn@umich.edu sys.exit(0) 2552889Sbinkertn@umich.edu 2565470Snate@binkert.org # setting verbose and quiet at the same time doesn't make sense 2575470Snate@binkert.org if options.verbose > 0 and options.quiet > 0: 2585470Snate@binkert.org options.usage(2) 2595470Snate@binkert.org 2605470Snate@binkert.org verbose = options.verbose - options.quiet 2612889Sbinkertn@umich.edu if options.verbose >= 0: 2622889Sbinkertn@umich.edu print "M5 Simulator System" 2632889Sbinkertn@umich.edu print brief_copyright 2642889Sbinkertn@umich.edu print 2654123Sbinkertn@umich.edu print "M5 compiled %s" % internal.core.cvar.compileDate; 2664850Snate@binkert.org print "M5 started %s" % datetime.datetime.now().ctime() 2672889Sbinkertn@umich.edu print "M5 executing on %s" % socket.gethostname() 2685456Ssaidi@eecs.umich.edu 2695456Ssaidi@eecs.umich.edu print "M5 revision %s" % internal.core.cvar.hgRev 2705456Ssaidi@eecs.umich.edu print "M5 commit date %s" % internal.core.cvar.hgDate 2715456Ssaidi@eecs.umich.edu 2722967Sktlim@umich.edu print "command line:", 2732967Sktlim@umich.edu for argv in sys.argv: 2742967Sktlim@umich.edu print argv, 2752967Sktlim@umich.edu print 2762889Sbinkertn@umich.edu 2772889Sbinkertn@umich.edu # check to make sure we can find the listed script 2782889Sbinkertn@umich.edu if not arguments or not os.path.isfile(arguments[0]): 2792922Sktlim@umich.edu if arguments and not os.path.isfile(arguments[0]): 2802922Sktlim@umich.edu print "Script %s not found" % arguments[0] 2814053Sbinkertn@umich.edu 2825470Snate@binkert.org options.usage(2) 2832889Sbinkertn@umich.edu 2842889Sbinkertn@umich.edu # tell C++ about output directory 2854123Sbinkertn@umich.edu internal.core.setOutputDir(options.outdir) 2862889Sbinkertn@umich.edu 2872889Sbinkertn@umich.edu # update the system path with elements from the -p option 2882889Sbinkertn@umich.edu sys.path[0:0] = options.path 2892889Sbinkertn@umich.edu 2902889Sbinkertn@umich.edu import objects 2912889Sbinkertn@umich.edu 2922889Sbinkertn@umich.edu # set stats options 2934078Sbinkertn@umich.edu internal.stats.initText(options.stats_file) 2942889Sbinkertn@umich.edu 2952889Sbinkertn@umich.edu # set debugging options 2965512SMichael.Adler@intel.com internal.debug.setRemoteGDBPort(options.remote_gdb_port) 2973645Sbinkertn@umich.edu for when in options.debug_break: 2983645Sbinkertn@umich.edu internal.debug.schedBreakCycle(int(when)) 2992889Sbinkertn@umich.edu 3004053Sbinkertn@umich.edu on_flags = [] 3014053Sbinkertn@umich.edu off_flags = [] 3024042Sbinkertn@umich.edu for flag in options.trace_flags: 3034053Sbinkertn@umich.edu off = False 3044053Sbinkertn@umich.edu if flag.startswith('-'): 3054053Sbinkertn@umich.edu flag = flag[1:] 3064053Sbinkertn@umich.edu off = True 3074053Sbinkertn@umich.edu if flag not in traceflags.allFlags: 3084053Sbinkertn@umich.edu print >>sys.stderr, "invalid trace flag '%s'" % flag 3094053Sbinkertn@umich.edu sys.exit(1) 3104053Sbinkertn@umich.edu 3114053Sbinkertn@umich.edu if off: 3124053Sbinkertn@umich.edu off_flags.append(flag) 3134053Sbinkertn@umich.edu else: 3144053Sbinkertn@umich.edu on_flags.append(flag) 3154053Sbinkertn@umich.edu 3164053Sbinkertn@umich.edu for flag in on_flags: 3174046Sbinkertn@umich.edu internal.trace.set(flag) 3184042Sbinkertn@umich.edu 3194053Sbinkertn@umich.edu for flag in off_flags: 3204053Sbinkertn@umich.edu internal.trace.clear(flag) 3214053Sbinkertn@umich.edu 3224074Sbinkertn@umich.edu if options.trace_start: 3234042Sbinkertn@umich.edu def enable_trace(): 3244074Sbinkertn@umich.edu internal.trace.cvar.enabled = True 3254167Sbinkertn@umich.edu event.create(enable_trace, int(options.trace_start)) 3264074Sbinkertn@umich.edu else: 3274087Sbinkertn@umich.edu internal.trace.cvar.enabled = True 3284042Sbinkertn@umich.edu 3294046Sbinkertn@umich.edu internal.trace.output(options.trace_file) 3304042Sbinkertn@umich.edu 3314042Sbinkertn@umich.edu for ignore in options.trace_ignore: 3324042Sbinkertn@umich.edu internal.trace.ignore(ignore) 3332889Sbinkertn@umich.edu 3342889Sbinkertn@umich.edu sys.argv = arguments 3352889Sbinkertn@umich.edu sys.path = [ os.path.dirname(sys.argv[0]) ] + sys.path 3362891Sbinkertn@umich.edu 3373887Sbinkertn@umich.edu scope = { '__file__' : sys.argv[0], 3383887Sbinkertn@umich.edu '__name__' : '__m5_main__' } 3392899Sbinkertn@umich.edu 3402899Sbinkertn@umich.edu # we want readline if we're doing anything interactive 3412899Sbinkertn@umich.edu if options.interactive or options.pdb: 3424042Sbinkertn@umich.edu exec "import readline" in scope 3432899Sbinkertn@umich.edu 3442899Sbinkertn@umich.edu # if pdb was requested, execfile the thing under pdb, otherwise, 3452899Sbinkertn@umich.edu # just do the execfile normally 3462899Sbinkertn@umich.edu if options.pdb: 3472899Sbinkertn@umich.edu from pdb import Pdb 3482899Sbinkertn@umich.edu debugger = Pdb() 3492899Sbinkertn@umich.edu debugger.run('execfile("%s")' % sys.argv[0], scope) 3502899Sbinkertn@umich.edu else: 3512899Sbinkertn@umich.edu execfile(sys.argv[0], scope) 3522889Sbinkertn@umich.edu 3532889Sbinkertn@umich.edu # once the script is done 3542889Sbinkertn@umich.edu if options.interactive: 3552889Sbinkertn@umich.edu interact = code.InteractiveConsole(scope) 3562889Sbinkertn@umich.edu interact.interact("M5 Interactive Console") 3572889Sbinkertn@umich.edu 3582889Sbinkertn@umich.eduif __name__ == '__main__': 3592889Sbinkertn@umich.edu from pprint import pprint 3602889Sbinkertn@umich.edu 3612889Sbinkertn@umich.edu parse_args() 3622889Sbinkertn@umich.edu 3632889Sbinkertn@umich.edu print 'opts:' 3642889Sbinkertn@umich.edu pprint(options, indent=4) 3652889Sbinkertn@umich.edu print 3662889Sbinkertn@umich.edu 3672889Sbinkertn@umich.edu print 'args:' 3682889Sbinkertn@umich.edu pprint(arguments, indent=4) 369