main.py revision 5472
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]") 852889Sbinkertn@umich.eduadd_option('-i', "--interactive", action="store_true", default=False, 862889Sbinkertn@umich.edu help="Invoke the interactive interpreter after running the script") 872899Sbinkertn@umich.eduadd_option("--pdb", action="store_true", default=False, 882899Sbinkertn@umich.edu help="Invoke the python debugger before running the script") 892889Sbinkertn@umich.eduadd_option('-p', "--path", metavar="PATH[:PATH]", action='append', split=':', 902889Sbinkertn@umich.edu help="Prepend PATH to the system path when invoking the script") 912889Sbinkertn@umich.eduadd_option('-q', "--quiet", action="count", default=0, 922889Sbinkertn@umich.edu help="Reduce verbosity") 932889Sbinkertn@umich.eduadd_option('-v', "--verbose", action="count", default=0, 942889Sbinkertn@umich.edu help="Increase verbosity") 952889Sbinkertn@umich.edu 962889Sbinkertn@umich.edu# Statistics options 972889Sbinkertn@umich.eduset_group("Statistics Options") 982889Sbinkertn@umich.eduadd_option("--stats-file", metavar="FILE", default="m5stats.txt", 992889Sbinkertn@umich.edu help="Sets the output file for statistics [Default: %default]") 1002889Sbinkertn@umich.edu 1012889Sbinkertn@umich.edu# Debugging options 1022889Sbinkertn@umich.eduset_group("Debugging Options") 1032889Sbinkertn@umich.eduadd_option("--debug-break", metavar="TIME[,TIME]", action='append', split=',', 1042889Sbinkertn@umich.edu help="Cycle to create a breakpoint") 1052889Sbinkertn@umich.edu 1062889Sbinkertn@umich.edu# Tracing options 1072889Sbinkertn@umich.eduset_group("Trace Options") 1084053Sbinkertn@umich.eduadd_option("--trace-help", action='store_true', 1094053Sbinkertn@umich.edu help="Print help on trace flags") 1102889Sbinkertn@umich.eduadd_option("--trace-flags", metavar="FLAG[,FLAG]", action='append', split=',', 1114053Sbinkertn@umich.edu help="Sets the flags for tracing (-FLAG disables a flag)") 1124044Sbinkertn@umich.eduadd_option("--trace-start", metavar="TIME", type='int', 1134044Sbinkertn@umich.edu help="Start tracing at TIME (must be in ticks)") 1142889Sbinkertn@umich.eduadd_option("--trace-file", metavar="FILE", default="cout", 1152889Sbinkertn@umich.edu help="Sets the output file for tracing [Default: %default]") 1162889Sbinkertn@umich.eduadd_option("--trace-ignore", metavar="EXPR", action='append', split=':', 1172889Sbinkertn@umich.edu help="Ignore EXPR sim objects") 1182889Sbinkertn@umich.edu 1192889Sbinkertn@umich.edudef main(): 1204042Sbinkertn@umich.edu import defines 1214167Sbinkertn@umich.edu import event 1224042Sbinkertn@umich.edu import info 1233624Sbinkertn@umich.edu import internal 1242889Sbinkertn@umich.edu 1255472Snate@binkert.org # load the options.py config file to allow people to set their own 1265472Snate@binkert.org # default options 1275472Snate@binkert.org options_file = config.get('options.py') 1285472Snate@binkert.org if options_file: 1295472Snate@binkert.org scope = { 'options' : options } 1305472Snate@binkert.org execfile(options_file, scope) 1315472Snate@binkert.org 1325470Snate@binkert.org arguments = options.parse_args() 1332889Sbinkertn@umich.edu 1342889Sbinkertn@umich.edu done = False 1354850Snate@binkert.org 1364850Snate@binkert.org if options.build_info: 1374850Snate@binkert.org done = True 1384850Snate@binkert.org print 'Build information:' 1394850Snate@binkert.org print 1404850Snate@binkert.org print 'compiled %s' % internal.core.cvar.compileDate; 1414850Snate@binkert.org print 'started %s' % datetime.datetime.now().ctime() 1424850Snate@binkert.org print 'executing on %s' % socket.gethostname() 1434850Snate@binkert.org print 'build options:' 1444850Snate@binkert.org keys = defines.m5_build_env.keys() 1454850Snate@binkert.org keys.sort() 1464850Snate@binkert.org for key in keys: 1474850Snate@binkert.org val = defines.m5_build_env[key] 1484850Snate@binkert.org print ' %s = %s' % (key, val) 1494850Snate@binkert.org print 1504850Snate@binkert.org 1512889Sbinkertn@umich.edu if options.copyright: 1522889Sbinkertn@umich.edu done = True 1532889Sbinkertn@umich.edu print info.LICENSE 1542889Sbinkertn@umich.edu print 1552889Sbinkertn@umich.edu 1562889Sbinkertn@umich.edu if options.authors: 1572889Sbinkertn@umich.edu done = True 1582889Sbinkertn@umich.edu print 'Author information:' 1592889Sbinkertn@umich.edu print 1602889Sbinkertn@umich.edu print info.AUTHORS 1612889Sbinkertn@umich.edu print 1622889Sbinkertn@umich.edu 1632889Sbinkertn@umich.edu if options.readme: 1642889Sbinkertn@umich.edu done = True 1652889Sbinkertn@umich.edu print 'Readme:' 1662889Sbinkertn@umich.edu print 1672889Sbinkertn@umich.edu print info.README 1682889Sbinkertn@umich.edu print 1692889Sbinkertn@umich.edu 1702889Sbinkertn@umich.edu if options.release_notes: 1712889Sbinkertn@umich.edu done = True 1722889Sbinkertn@umich.edu print 'Release Notes:' 1732889Sbinkertn@umich.edu print 1742889Sbinkertn@umich.edu print info.RELEASE_NOTES 1752889Sbinkertn@umich.edu print 1762889Sbinkertn@umich.edu 1774053Sbinkertn@umich.edu if options.trace_help: 1784053Sbinkertn@umich.edu done = True 1794053Sbinkertn@umich.edu print "Base Flags:" 1804053Sbinkertn@umich.edu print_list(traceflags.baseFlags, indent=4) 1814053Sbinkertn@umich.edu print 1824053Sbinkertn@umich.edu print "Compound Flags:" 1834053Sbinkertn@umich.edu for flag in traceflags.compoundFlags: 1844053Sbinkertn@umich.edu if flag == 'All': 1854053Sbinkertn@umich.edu continue 1864053Sbinkertn@umich.edu print " %s:" % flag 1874053Sbinkertn@umich.edu print_list(traceflags.compoundFlagMap[flag], indent=8) 1884053Sbinkertn@umich.edu print 1894053Sbinkertn@umich.edu 1902889Sbinkertn@umich.edu if done: 1912889Sbinkertn@umich.edu sys.exit(0) 1922889Sbinkertn@umich.edu 1935470Snate@binkert.org # setting verbose and quiet at the same time doesn't make sense 1945470Snate@binkert.org if options.verbose > 0 and options.quiet > 0: 1955470Snate@binkert.org options.usage(2) 1965470Snate@binkert.org 1975470Snate@binkert.org verbose = options.verbose - options.quiet 1982889Sbinkertn@umich.edu if options.verbose >= 0: 1992889Sbinkertn@umich.edu print "M5 Simulator System" 2002889Sbinkertn@umich.edu print brief_copyright 2012889Sbinkertn@umich.edu print 2024123Sbinkertn@umich.edu print "M5 compiled %s" % internal.core.cvar.compileDate; 2034850Snate@binkert.org print "M5 started %s" % datetime.datetime.now().ctime() 2042889Sbinkertn@umich.edu print "M5 executing on %s" % socket.gethostname() 2055456Ssaidi@eecs.umich.edu 2065456Ssaidi@eecs.umich.edu print "M5 revision %s" % internal.core.cvar.hgRev 2075456Ssaidi@eecs.umich.edu print "M5 commit date %s" % internal.core.cvar.hgDate 2085456Ssaidi@eecs.umich.edu 2092967Sktlim@umich.edu print "command line:", 2102967Sktlim@umich.edu for argv in sys.argv: 2112967Sktlim@umich.edu print argv, 2122967Sktlim@umich.edu print 2132889Sbinkertn@umich.edu 2142889Sbinkertn@umich.edu # check to make sure we can find the listed script 2152889Sbinkertn@umich.edu if not arguments or not os.path.isfile(arguments[0]): 2162922Sktlim@umich.edu if arguments and not os.path.isfile(arguments[0]): 2172922Sktlim@umich.edu print "Script %s not found" % arguments[0] 2184053Sbinkertn@umich.edu 2195470Snate@binkert.org options.usage(2) 2202889Sbinkertn@umich.edu 2212889Sbinkertn@umich.edu # tell C++ about output directory 2224123Sbinkertn@umich.edu internal.core.setOutputDir(options.outdir) 2232889Sbinkertn@umich.edu 2242889Sbinkertn@umich.edu # update the system path with elements from the -p option 2252889Sbinkertn@umich.edu sys.path[0:0] = options.path 2262889Sbinkertn@umich.edu 2272889Sbinkertn@umich.edu import objects 2282889Sbinkertn@umich.edu 2292889Sbinkertn@umich.edu # set stats options 2304078Sbinkertn@umich.edu internal.stats.initText(options.stats_file) 2312889Sbinkertn@umich.edu 2322889Sbinkertn@umich.edu # set debugging options 2333645Sbinkertn@umich.edu for when in options.debug_break: 2343645Sbinkertn@umich.edu internal.debug.schedBreakCycle(int(when)) 2352889Sbinkertn@umich.edu 2364053Sbinkertn@umich.edu on_flags = [] 2374053Sbinkertn@umich.edu off_flags = [] 2384042Sbinkertn@umich.edu for flag in options.trace_flags: 2394053Sbinkertn@umich.edu off = False 2404053Sbinkertn@umich.edu if flag.startswith('-'): 2414053Sbinkertn@umich.edu flag = flag[1:] 2424053Sbinkertn@umich.edu off = True 2434053Sbinkertn@umich.edu if flag not in traceflags.allFlags: 2444053Sbinkertn@umich.edu print >>sys.stderr, "invalid trace flag '%s'" % flag 2454053Sbinkertn@umich.edu sys.exit(1) 2464053Sbinkertn@umich.edu 2474053Sbinkertn@umich.edu if off: 2484053Sbinkertn@umich.edu off_flags.append(flag) 2494053Sbinkertn@umich.edu else: 2504053Sbinkertn@umich.edu on_flags.append(flag) 2514053Sbinkertn@umich.edu 2524053Sbinkertn@umich.edu for flag in on_flags: 2534046Sbinkertn@umich.edu internal.trace.set(flag) 2544042Sbinkertn@umich.edu 2554053Sbinkertn@umich.edu for flag in off_flags: 2564053Sbinkertn@umich.edu internal.trace.clear(flag) 2574053Sbinkertn@umich.edu 2584074Sbinkertn@umich.edu if options.trace_start: 2594042Sbinkertn@umich.edu def enable_trace(): 2604074Sbinkertn@umich.edu internal.trace.cvar.enabled = True 2614167Sbinkertn@umich.edu event.create(enable_trace, int(options.trace_start)) 2624074Sbinkertn@umich.edu else: 2634087Sbinkertn@umich.edu internal.trace.cvar.enabled = True 2644042Sbinkertn@umich.edu 2654046Sbinkertn@umich.edu internal.trace.output(options.trace_file) 2664042Sbinkertn@umich.edu 2674042Sbinkertn@umich.edu for ignore in options.trace_ignore: 2684042Sbinkertn@umich.edu internal.trace.ignore(ignore) 2692889Sbinkertn@umich.edu 2702889Sbinkertn@umich.edu sys.argv = arguments 2712889Sbinkertn@umich.edu sys.path = [ os.path.dirname(sys.argv[0]) ] + sys.path 2722891Sbinkertn@umich.edu 2733887Sbinkertn@umich.edu scope = { '__file__' : sys.argv[0], 2743887Sbinkertn@umich.edu '__name__' : '__m5_main__' } 2752899Sbinkertn@umich.edu 2762899Sbinkertn@umich.edu # we want readline if we're doing anything interactive 2772899Sbinkertn@umich.edu if options.interactive or options.pdb: 2784042Sbinkertn@umich.edu exec "import readline" in scope 2792899Sbinkertn@umich.edu 2802899Sbinkertn@umich.edu # if pdb was requested, execfile the thing under pdb, otherwise, 2812899Sbinkertn@umich.edu # just do the execfile normally 2822899Sbinkertn@umich.edu if options.pdb: 2832899Sbinkertn@umich.edu from pdb import Pdb 2842899Sbinkertn@umich.edu debugger = Pdb() 2852899Sbinkertn@umich.edu debugger.run('execfile("%s")' % sys.argv[0], scope) 2862899Sbinkertn@umich.edu else: 2872899Sbinkertn@umich.edu execfile(sys.argv[0], scope) 2882889Sbinkertn@umich.edu 2892889Sbinkertn@umich.edu # once the script is done 2902889Sbinkertn@umich.edu if options.interactive: 2912889Sbinkertn@umich.edu interact = code.InteractiveConsole(scope) 2922889Sbinkertn@umich.edu interact.interact("M5 Interactive Console") 2932889Sbinkertn@umich.edu 2942889Sbinkertn@umich.eduif __name__ == '__main__': 2952889Sbinkertn@umich.edu from pprint import pprint 2962889Sbinkertn@umich.edu 2972889Sbinkertn@umich.edu parse_args() 2982889Sbinkertn@umich.edu 2992889Sbinkertn@umich.edu print 'opts:' 3002889Sbinkertn@umich.edu pprint(options, indent=4) 3012889Sbinkertn@umich.edu print 3022889Sbinkertn@umich.edu 3032889Sbinkertn@umich.edu print 'args:' 3042889Sbinkertn@umich.edu pprint(arguments, indent=4) 305