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, optparse, os, socket, sys
30from datetime import datetime
31from attrdict import attrdict
32import traceflags
33
34__all__ = [ 'options', 'arguments', 'main' ]
35
36usage="%prog [m5 options] script.py [script options]"
37version="%prog 2.0"
38brief_copyright='''
39Copyright (c) 2001-2006
40The Regents of The University of Michigan
41All Rights Reserved
42'''
43
44def print_list(items, indent=4):
45 line = ' ' * indent
46 for i,item in enumerate(items):
47 if len(line) + len(item) > 76:
48 print line
49 line = ' ' * indent
50
51 if i < len(items) - 1:
52 line += '%s, ' % item
53 else:
54 line += item
55 print line
56
57# there's only one option parsing done, so make it global and add some
58# helper functions to make it work well.
59parser = optparse.OptionParser(usage=usage, version=version,
60 description=brief_copyright,
61 formatter=optparse.TitledHelpFormatter())
62parser.disable_interspersed_args()
63
64# current option group
65group = None
66
67def set_group(*args, **kwargs):
68 '''set the current option group'''
69 global group
70 if not args and not kwargs:
71 group = None
72 else:
73 group = parser.add_option_group(*args, **kwargs)
74
75class splitter(object):
76 def __init__(self, split):
77 self.split = split
78 def __call__(self, option, opt_str, value, parser):
79 getattr(parser.values, option.dest).extend(value.split(self.split))
80
81def add_option(*args, **kwargs):
82 '''add an option to the current option group, or global none set'''
83
84 # if action=split, but allows the option arguments
85 # themselves to be lists separated by the split variable'''
86
87 if kwargs.get('action', None) == 'append' and 'split' in kwargs:
88 split = kwargs.pop('split')
89 kwargs['default'] = []
90 kwargs['type'] = 'string'
91 kwargs['action'] = 'callback'
92 kwargs['callback'] = splitter(split)
93
94 if group:
95 return group.add_option(*args, **kwargs)
96
97 return parser.add_option(*args, **kwargs)
98
99def bool_option(name, default, help):
100 '''add a boolean option called --name and --no-name.
101 Display help depending on which is the default'''
102
103 tname = '--%s' % name
104 fname = '--no-%s' % name
105 dest = name.replace('-', '_')
106 if default:
107 thelp = optparse.SUPPRESS_HELP
108 fhelp = help
109 else:
110 thelp = help
111 fhelp = optparse.SUPPRESS_HELP
112
113 add_option(tname, action="store_true", default=default, help=thelp)
114 add_option(fname, action="store_false", dest=dest, help=fhelp)
115
116# Help options
117add_option('-A', "--authors", action="store_true", default=False,
118 help="Show author information")
119add_option('-C', "--copyright", action="store_true", default=False,
120 help="Show full copyright information")
121add_option('-R', "--readme", action="store_true", default=False,
122 help="Show the readme")
123add_option('-N', "--release-notes", action="store_true", default=False,
124 help="Show the release notes")
125
126# Options for configuring the base simulator
127add_option('-d', "--outdir", metavar="DIR", default=".",
128 help="Set the output directory to DIR [Default: %default]")
129add_option('-i', "--interactive", action="store_true", default=False,
130 help="Invoke the interactive interpreter after running the script")
131add_option("--pdb", action="store_true", default=False,
132 help="Invoke the python debugger before running the script")
133add_option('-p', "--path", metavar="PATH[:PATH]", action='append', split=':',
134 help="Prepend PATH to the system path when invoking the script")
135add_option('-q', "--quiet", action="count", default=0,
136 help="Reduce verbosity")
137add_option('-v', "--verbose", action="count", default=0,
138 help="Increase verbosity")
139
140# Statistics options
141set_group("Statistics Options")
142add_option("--stats-file", metavar="FILE", default="m5stats.txt",
143 help="Sets the output file for statistics [Default: %default]")
144
145# Debugging options
146set_group("Debugging Options")
147add_option("--debug-break", metavar="TIME[,TIME]", action='append', split=',',
148 help="Cycle to create a breakpoint")
149
150# Tracing options
151set_group("Trace Options")
152add_option("--trace-help", action='store_true',
153 help="Print help on trace flags")
154add_option("--trace-flags", metavar="FLAG[,FLAG]", action='append', split=',',
155 help="Sets the flags for tracing (-FLAG disables a flag)")
156add_option("--trace-start", metavar="TIME", type='int',
157 help="Start tracing at TIME (must be in ticks)")
158add_option("--trace-file", metavar="FILE", default="cout",
159 help="Sets the output file for tracing [Default: %default]")
160add_option("--trace-ignore", metavar="EXPR", action='append', split=':',
161 help="Ignore EXPR sim objects")
162
163options = attrdict()
164arguments = []
165
166def usage(exitcode=None):
167 parser.print_help()
168 if exitcode is not None:
169 sys.exit(exitcode)
170
171def parse_args():
172 _opts,args = parser.parse_args()
173 opts = attrdict(_opts.__dict__)
174
175 # setting verbose and quiet at the same time doesn't make sense
176 if opts.verbose > 0 and opts.quiet > 0:
177 usage(2)
178
179 # store the verbosity in a single variable. 0 is default,
180 # negative numbers represent quiet and positive values indicate verbose
181 opts.verbose -= opts.quiet
182
183 del opts.quiet
184
185 options.update(opts)
186 arguments.extend(args)
187 return opts,args
188
189def main():
190 import defines
| 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, optparse, os, socket, sys
30from datetime import datetime
31from attrdict import attrdict
32import traceflags
33
34__all__ = [ 'options', 'arguments', 'main' ]
35
36usage="%prog [m5 options] script.py [script options]"
37version="%prog 2.0"
38brief_copyright='''
39Copyright (c) 2001-2006
40The Regents of The University of Michigan
41All Rights Reserved
42'''
43
44def print_list(items, indent=4):
45 line = ' ' * indent
46 for i,item in enumerate(items):
47 if len(line) + len(item) > 76:
48 print line
49 line = ' ' * indent
50
51 if i < len(items) - 1:
52 line += '%s, ' % item
53 else:
54 line += item
55 print line
56
57# there's only one option parsing done, so make it global and add some
58# helper functions to make it work well.
59parser = optparse.OptionParser(usage=usage, version=version,
60 description=brief_copyright,
61 formatter=optparse.TitledHelpFormatter())
62parser.disable_interspersed_args()
63
64# current option group
65group = None
66
67def set_group(*args, **kwargs):
68 '''set the current option group'''
69 global group
70 if not args and not kwargs:
71 group = None
72 else:
73 group = parser.add_option_group(*args, **kwargs)
74
75class splitter(object):
76 def __init__(self, split):
77 self.split = split
78 def __call__(self, option, opt_str, value, parser):
79 getattr(parser.values, option.dest).extend(value.split(self.split))
80
81def add_option(*args, **kwargs):
82 '''add an option to the current option group, or global none set'''
83
84 # if action=split, but allows the option arguments
85 # themselves to be lists separated by the split variable'''
86
87 if kwargs.get('action', None) == 'append' and 'split' in kwargs:
88 split = kwargs.pop('split')
89 kwargs['default'] = []
90 kwargs['type'] = 'string'
91 kwargs['action'] = 'callback'
92 kwargs['callback'] = splitter(split)
93
94 if group:
95 return group.add_option(*args, **kwargs)
96
97 return parser.add_option(*args, **kwargs)
98
99def bool_option(name, default, help):
100 '''add a boolean option called --name and --no-name.
101 Display help depending on which is the default'''
102
103 tname = '--%s' % name
104 fname = '--no-%s' % name
105 dest = name.replace('-', '_')
106 if default:
107 thelp = optparse.SUPPRESS_HELP
108 fhelp = help
109 else:
110 thelp = help
111 fhelp = optparse.SUPPRESS_HELP
112
113 add_option(tname, action="store_true", default=default, help=thelp)
114 add_option(fname, action="store_false", dest=dest, help=fhelp)
115
116# Help options
117add_option('-A', "--authors", action="store_true", default=False,
118 help="Show author information")
119add_option('-C', "--copyright", action="store_true", default=False,
120 help="Show full copyright information")
121add_option('-R', "--readme", action="store_true", default=False,
122 help="Show the readme")
123add_option('-N', "--release-notes", action="store_true", default=False,
124 help="Show the release notes")
125
126# Options for configuring the base simulator
127add_option('-d', "--outdir", metavar="DIR", default=".",
128 help="Set the output directory to DIR [Default: %default]")
129add_option('-i', "--interactive", action="store_true", default=False,
130 help="Invoke the interactive interpreter after running the script")
131add_option("--pdb", action="store_true", default=False,
132 help="Invoke the python debugger before running the script")
133add_option('-p', "--path", metavar="PATH[:PATH]", action='append', split=':',
134 help="Prepend PATH to the system path when invoking the script")
135add_option('-q', "--quiet", action="count", default=0,
136 help="Reduce verbosity")
137add_option('-v', "--verbose", action="count", default=0,
138 help="Increase verbosity")
139
140# Statistics options
141set_group("Statistics Options")
142add_option("--stats-file", metavar="FILE", default="m5stats.txt",
143 help="Sets the output file for statistics [Default: %default]")
144
145# Debugging options
146set_group("Debugging Options")
147add_option("--debug-break", metavar="TIME[,TIME]", action='append', split=',',
148 help="Cycle to create a breakpoint")
149
150# Tracing options
151set_group("Trace Options")
152add_option("--trace-help", action='store_true',
153 help="Print help on trace flags")
154add_option("--trace-flags", metavar="FLAG[,FLAG]", action='append', split=',',
155 help="Sets the flags for tracing (-FLAG disables a flag)")
156add_option("--trace-start", metavar="TIME", type='int',
157 help="Start tracing at TIME (must be in ticks)")
158add_option("--trace-file", metavar="FILE", default="cout",
159 help="Sets the output file for tracing [Default: %default]")
160add_option("--trace-ignore", metavar="EXPR", action='append', split=':',
161 help="Ignore EXPR sim objects")
162
163options = attrdict()
164arguments = []
165
166def usage(exitcode=None):
167 parser.print_help()
168 if exitcode is not None:
169 sys.exit(exitcode)
170
171def parse_args():
172 _opts,args = parser.parse_args()
173 opts = attrdict(_opts.__dict__)
174
175 # setting verbose and quiet at the same time doesn't make sense
176 if opts.verbose > 0 and opts.quiet > 0:
177 usage(2)
178
179 # store the verbosity in a single variable. 0 is default,
180 # negative numbers represent quiet and positive values indicate verbose
181 opts.verbose -= opts.quiet
182
183 del opts.quiet
184
185 options.update(opts)
186 arguments.extend(args)
187 return opts,args
188
189def main():
190 import defines
|