Migrate most of main() and and all option parsing to python

configs/test/fs.py:
configs/test/test.py:
    update for the new way that m5 deals with options
src/python/SConscript:
    Compile AUTHORS, LICENSE, README, and RELEASE_NOTES into the
    python stuff.
src/python/m5/__init__.py:
    redo the way options work.
    Move them all to main.py
src/sim/main.cc:
    Migrate more functionality for main() into python.
    Namely option parsing
src/python/m5/attrdict.py:
    A dictionary object that overrides attribute access to
    do item access.
src/python/m5/main.py:
    The new location for M5's option parsing, and the main()
    routine to set up the simulation.

--HG--
extra : convert_revision : c86b87a9f508bde1994088e23fd470c7753ee4c1

3 files changed, 370 insertions, 107 deletions

diff --git a/src/python/m5/__init__.py b/src/python/m5/__init__.py
index f4f5be2d1..3d0e3defa 100644
--- a/src/python/m5/__init__.py
+++ b/src/python/m5/__init__.py
@@ -27,7 +27,7 @@
 # Authors: Nathan Binkert
 #          Steve Reinhardt
 
-import sys, os, time, atexit, optparse
+import atexit, os, sys
 
 # import the SWIG-wrapped main C++ functions
 import cc_main
@@ -57,111 +57,6 @@ def AddToPath(path):
     # so place the new dir right after that.
     sys.path.insert(1, path)
 
-
-# The m5 module's pointer to the parsed options object
-options = None
-
-
-# User should call this function after calling parse_args() to pass
-# parsed standard option values back into the m5 module for
-# processing.
-def setStandardOptions(_options):
-    # Set module global var
-    global options
-    options = _options
-    # tell C++ about output directory
-    cc_main.setOutputDir(options.outdir)
-
-# Callback to set trace flags.  Not necessarily the best way to do
-# things in the long run (particularly if we change how these global
-# options are handled).
-def setTraceFlags(option, opt_str, value, parser):
-    objects.Trace.flags = value
-
-def setTraceStart(option, opt_str, value, parser):
-    objects.Trace.start = value
-
-def setTraceFile(option, opt_str, value, parser):
-    objects.Trace.file = value
-
-def noPCSymbol(option, opt_str, value, parser):
-    objects.ExecutionTrace.pc_symbol = False
-
-def noPrintCycle(option, opt_str, value, parser):
-    objects.ExecutionTrace.print_cycle = False
-
-def noPrintOpclass(option, opt_str, value, parser):
-    objects.ExecutionTrace.print_opclass = False
-
-def noPrintThread(option, opt_str, value, parser):
-    objects.ExecutionTrace.print_thread = False
-
-def noPrintEA(option, opt_str, value, parser):
-    objects.ExecutionTrace.print_effaddr = False
-
-def noPrintData(option, opt_str, value, parser):
-    objects.ExecutionTrace.print_data = False
-
-def printFetchseq(option, opt_str, value, parser):
-    objects.ExecutionTrace.print_fetchseq = True
-
-def printCpseq(option, opt_str, value, parser):
-    objects.ExecutionTrace.print_cpseq = True
-
-def dumpOnExit(option, opt_str, value, parser):
-    objects.Trace.dump_on_exit = True
-
-def debugBreak(option, opt_str, value, parser):
-    objects.Debug.break_cycles = value
-
-def statsTextFile(option, opt_str, value, parser):
-    objects.Statistics.text_file = value
-
-# Standard optparse options.  Need to be explicitly included by the
-# user script when it calls optparse.OptionParser().
-standardOptions = [
-    optparse.make_option("--outdir", type="string", default="."),
-    optparse.make_option("--traceflags", type="string", action="callback",
-                         callback=setTraceFlags),
-    optparse.make_option("--tracestart", type="int", action="callback",
-                         callback=setTraceStart),
-    optparse.make_option("--tracefile", type="string", action="callback",
-                         callback=setTraceFile),
-    optparse.make_option("--nopcsymbol",
-                         action="callback", callback=noPCSymbol,
-                         help="Disable PC symbols in trace output"),
-    optparse.make_option("--noprintcycle",
-                         action="callback", callback=noPrintCycle,
-                         help="Don't print cycle numbers in trace output"),
-    optparse.make_option("--noprintopclass",
-                         action="callback", callback=noPrintOpclass,
-                         help="Don't print op class type in trace output"),
-    optparse.make_option("--noprintthread",
-                         action="callback", callback=noPrintThread,
-                         help="Don't print thread number in trace output"),
-    optparse.make_option("--noprinteffaddr",
-                         action="callback", callback=noPrintEA,
-                         help="Don't print effective address in trace output"),
-    optparse.make_option("--noprintdata",
-                         action="callback", callback=noPrintData,
-                         help="Don't print result data in trace output"),
-    optparse.make_option("--printfetchseq",
-                         action="callback", callback=printFetchseq,
-                         help="Print fetch sequence numbers in trace output"),
-    optparse.make_option("--printcpseq",
-                         action="callback", callback=printCpseq,
-                         help="Print correct path sequence numbers in trace output"),
-    optparse.make_option("--dumponexit",
-                         action="callback", callback=dumpOnExit,
-                         help="Dump trace buffer on exit"),
-    optparse.make_option("--debugbreak", type="int", metavar="CYCLE",
-                         action="callback", callback=debugBreak,
-                         help="Cycle to create a breakpoint"),
-    optparse.make_option("--statsfile", type="string", action="callback",
-                         callback=statsTextFile, metavar="FILE",
-                         help="Sets the output file for the statistics")
-    ]
-
 # make a SmartDict out of the build options for our local use
 import smartdict
 build_env = smartdict.SmartDict()
@@ -171,12 +66,13 @@ build_env.update(defines.m5_build_env)
 env = smartdict.SmartDict()
 env.update(os.environ)
 
-
 # Function to provide to C++ so it can look up instances based on paths
 def resolveSimObject(name):
     obj = config.instanceDict[name]
     return obj.getCCObject()
 
+from main import options, arguments, main
+
 # The final hook to generate .ini files.  Called from the user script
 # once the config is built.
 def instantiate(root):
diff --git a/src/python/m5/attrdict.py b/src/python/m5/attrdict.py
new file mode 100644
index 000000000..4ee7f1b8c
--- /dev/null
+++ b/src/python/m5/attrdict.py
@@ -0,0 +1,61 @@
+# Copyright (c) 2006 The Regents of The University of Michigan
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met: redistributions of source code must retain the above copyright
+# notice, this list of conditions and the following disclaimer;
+# redistributions in binary form must reproduce the above copyright
+# notice, this list of conditions and the following disclaimer in the
+# documentation and/or other materials provided with the distribution;
+# neither the name of the copyright holders nor the names of its
+# contributors may be used to endorse or promote products derived from
+# this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+# Authors: Nathan Binkert
+
+__all__ = [ 'attrdict' ]
+
+class attrdict(dict):
+    def __getattr__(self, attr):
+        if attr in self:
+            return self.__getitem__(attr)
+        return super(attrdict, self).__getattribute__(attr)
+
+    def __setattr__(self, attr, value):
+        if attr in dir(self):
+            return super(attrdict, self).__setattr__(attr, value)
+        return self.__setitem__(attr, value)
+
+    def __delattr__(self, attr):
+        if attr in self:
+            return self.__delitem__(attr)
+        return super(attrdict, self).__delattr__(attr, value)
+
+if __name__ == '__main__':
+    x = attrdict()
+    x.y = 1
+    x['z'] = 2
+    print x['y'], x.y
+    print x['z'], x.z
+    print dir(x)
+    print x
+
+    print
+
+    del x['y']
+    del x.z
+    print dir(x)
+    print(x)
diff --git a/src/python/m5/main.py b/src/python/m5/main.py
new file mode 100644
index 000000000..b4c89f612
--- /dev/null
+++ b/src/python/m5/main.py
@@ -0,0 +1,306 @@
+# Copyright (c) 2005 The Regents of The University of Michigan
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met: redistributions of source code must retain the above copyright
+# notice, this list of conditions and the following disclaimer;
+# redistributions in binary form must reproduce the above copyright
+# notice, this list of conditions and the following disclaimer in the
+# documentation and/or other materials provided with the distribution;
+# neither the name of the copyright holders nor the names of its
+# contributors may be used to endorse or promote products derived from
+# this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+# Authors: Nathan Binkert
+
+import code, optparse, os, socket, sys
+from datetime import datetime
+from attrdict import attrdict
+
+try:
+    import info
+except ImportError:
+    info = None
+
+__all__ = [ 'options', 'arguments', 'main' ]
+
+usage="%prog [m5 options] script.py [script options]"
+version="%prog 2.0"
+brief_copyright='''
+Copyright (c) 2001-2006
+The Regents of The University of Michigan
+All Rights Reserved
+'''
+
+# there's only one option parsing done, so make it global and add some
+# helper functions to make it work well.
+parser = optparse.OptionParser(usage=usage, version=version,
+                               description=brief_copyright,
+                               formatter=optparse.TitledHelpFormatter())
+
+# current option group
+group = None
+
+def set_group(*args, **kwargs):
+    '''set the current option group'''
+    global group
+    if not args and not kwargs:
+        group = None
+    else:
+        group = parser.add_option_group(*args, **kwargs)
+
+class splitter(object):
+    def __init__(self, split):
+        self.split = split
+    def __call__(self, option, opt_str, value, parser):
+        getattr(parser.values, option.dest).extend(value.split(self.split))
+
+def add_option(*args, **kwargs):
+    '''add an option to the current option group, or global none set'''
+
+    # if action=split, but allows the option arguments
+    # themselves to be lists separated by the split variable'''
+
+    if kwargs.get('action', None) == 'append' and 'split' in kwargs:
+        split = kwargs.pop('split')
+        kwargs['default'] = []
+        kwargs['type'] = 'string'
+        kwargs['action'] = 'callback'
+        kwargs['callback'] = splitter(split)
+
+    if group:
+        return group.add_option(*args, **kwargs)
+
+    return parser.add_option(*args, **kwargs)
+
+def bool_option(name, default, help):
+    '''add a boolean option called --name and --no-name.
+    Display help depending on which is the default'''
+
+    tname = '--%s' % name
+    fname = '--no-%s' % name
+    dest = name.replace('-', '_')
+    if default:
+        thelp = optparse.SUPPRESS_HELP
+        fhelp = help
+    else:
+        thelp = help
+        fhelp = optparse.SUPPRESS_HELP
+
+    add_option(tname, action="store_true", default=default, help=thelp)
+    add_option(fname, action="store_false", dest=dest, help=fhelp)
+
+# Help options
+add_option('-A', "--authors", action="store_true", default=False,
+    help="Show author information")
+add_option('-C', "--copyright", action="store_true", default=False,
+    help="Show full copyright information")
+add_option('-R', "--readme", action="store_true", default=False,
+    help="Show the readme")
+add_option('-N', "--release-notes", action="store_true", default=False,
+    help="Show the release notes")
+
+# Options for configuring the base simulator
+add_option('-d', "--outdir", metavar="DIR", default=".",
+    help="Set the output directory to DIR [Default: %default]")
+add_option('-i', "--interactive", action="store_true", default=False,
+    help="Invoke the interactive interpreter after running the script")
+add_option('-p', "--path", metavar="PATH[:PATH]", action='append', split=':',
+    help="Prepend PATH to the system path when invoking the script")
+add_option('-q', "--quiet", action="count", default=0,
+    help="Reduce verbosity")
+add_option('-v', "--verbose", action="count", default=0,
+    help="Increase verbosity")
+
+# Statistics options
+set_group("Statistics Options")
+add_option("--stats-file", metavar="FILE", default="m5stats.txt",
+    help="Sets the output file for statistics [Default: %default]")
+
+# Debugging options
+set_group("Debugging Options")
+add_option("--debug-break", metavar="TIME[,TIME]", action='append', split=',',
+    help="Cycle to create a breakpoint")
+
+# Tracing options
+set_group("Trace Options")
+add_option("--trace-flags", metavar="FLAG[,FLAG]", action='append', split=',',
+    help="Sets the flags for tracing")
+add_option("--trace-start", metavar="TIME", default='0s',
+    help="Start tracing at TIME (must have units)")
+add_option("--trace-file", metavar="FILE", default="cout",
+    help="Sets the output file for tracing [Default: %default]")
+add_option("--trace-circlebuf", metavar="SIZE", type="int", default=0,
+    help="If SIZE is non-zero, turn on the circular buffer with SIZE lines")
+add_option("--no-trace-circlebuf", action="store_const", const=0,
+    dest='trace_circlebuf', help=optparse.SUPPRESS_HELP)
+bool_option("trace-dumponexit", default=False,
+    help="Dump trace buffer on exit")
+add_option("--trace-ignore", metavar="EXPR", action='append', split=':',
+    help="Ignore EXPR sim objects")
+
+# Execution Trace options
+set_group("Execution Trace Options")
+bool_option("speculative", default=True,
+    help="Don't capture speculative instructions")
+bool_option("print-cycle", default=True,
+    help="Don't print cycle numbers in trace output")
+bool_option("print-symbol", default=True,
+    help="Disable PC symbols in trace output")
+bool_option("print-opclass", default=True,
+    help="Don't print op class type in trace output")
+bool_option("print-thread", default=True,
+    help="Don't print thread number in trace output")
+bool_option("print-effaddr", default=True,
+    help="Don't print effective address in trace output")
+bool_option("print-data", default=True,
+    help="Don't print result data in trace output")
+bool_option("print-iregs", default=False,
+    help="Print fetch sequence numbers in trace output")
+bool_option("print-fetch-seq", default=False,
+    help="Print fetch sequence numbers in trace output")
+bool_option("print-cpseq", default=False,
+    help="Print correct path sequence numbers in trace output")
+
+options = attrdict()
+arguments = []
+
+def usage(exitcode=None):
+    print parser.help
+    if exitcode is not None:
+        sys.exit(exitcode)
+
+def parse_args():
+    _opts,args = parser.parse_args()
+    opts = attrdict(_opts.__dict__)
+
+    # setting verbose and quiet at the same time doesn't make sense
+    if opts.verbose > 0 and opts.quiet > 0:
+        usage(2)
+
+    # store the verbosity in a single variable.  0 is default,
+    # negative numbers represent quiet and positive values indicate verbose
+    opts.verbose -= opts.quiet
+
+    del opts.quiet
+
+    options.update(opts)
+    arguments.extend(args)
+    return opts,args
+
+def main():
+    import cc_main
+
+    parse_args()
+
+    done = False
+    if options.copyright:
+        done = True
+        print info.LICENSE
+        print
+
+    if options.authors:
+        done = True
+        print 'Author information:'
+        print
+        print info.AUTHORS
+        print
+
+    if options.readme:
+        done = True
+        print 'Readme:'
+        print
+        print info.README
+        print
+
+    if options.release_notes:
+        done = True
+        print 'Release Notes:'
+        print
+        print info.RELEASE_NOTES
+        print
+
+    if done:
+        sys.exit(0)
+
+    if options.verbose >= 0:
+        print "M5 Simulator System"
+        print brief_copyright
+        print
+        print "M5 compiled %s" % cc_main.cvar.compileDate;
+        print "M5 started %s" % datetime.now().ctime()
+        print "M5 executing on %s" % socket.gethostname()
+
+    # check to make sure we can find the listed script
+    if not arguments or not os.path.isfile(arguments[0]):
+        usage(2)
+
+    # tell C++ about output directory
+    cc_main.setOutputDir(options.outdir)
+
+    # update the system path with elements from the -p option
+    sys.path[0:0] = options.path
+
+    import objects
+
+    # set stats options
+    objects.Statistics.text_file = options.stats_file
+
+    # set debugging options
+    objects.Debug.break_cycles = options.debug_break
+
+    # set tracing options
+    objects.Trace.flags = options.trace_flags
+    objects.Trace.start = options.trace_start
+    objects.Trace.file = options.trace_file
+    objects.Trace.bufsize = options.trace_circlebuf
+    objects.Trace.dump_on_exit = options.trace_dumponexit
+    objects.Trace.ignore = options.trace_ignore
+
+    # set execution trace options
+    objects.ExecutionTrace.speculative = options.speculative
+    objects.ExecutionTrace.print_cycle = options.print_cycle
+    objects.ExecutionTrace.pc_symbol = options.print_symbol
+    objects.ExecutionTrace.print_opclass = options.print_opclass
+    objects.ExecutionTrace.print_thread = options.print_thread
+    objects.ExecutionTrace.print_effaddr = options.print_effaddr
+    objects.ExecutionTrace.print_data = options.print_data
+    objects.ExecutionTrace.print_iregs = options.print_iregs
+    objects.ExecutionTrace.print_fetchseq = options.print_fetch_seq
+    objects.ExecutionTrace.print_cpseq = options.print_cpseq
+
+    scope = { '__file__' : sys.argv[0] }
+    sys.argv = arguments
+    sys.path = [ os.path.dirname(sys.argv[0]) ] + sys.path
+    exec("import readline", scope)
+    execfile(sys.argv[0], scope)
+
+    # once the script is done
+    if options.interactive:
+        interact = code.InteractiveConsole(scope)
+        interact.interact("M5 Interactive Console")
+
+if __name__ == '__main__':
+    from pprint import pprint
+
+    parse_args()
+
+    print 'opts:'
+    pprint(options, indent=4)
+    print
+
+    print 'args:'
+    pprint(arguments, indent=4)