3 # Copyright (c) 2004-2005 The Regents of The University of Michigan
6 # Redistribution and use in source and binary forms, with or without
7 # modification, are permitted provided that the following conditions are
8 # met: redistributions of source code must retain the above copyright
9 # notice, this list of conditions and the following disclaimer;
10 # redistributions in binary form must reproduce the above copyright
11 # notice, this list of conditions and the following disclaimer in the
12 # documentation and/or other materials provided with the distribution;
13 # neither the name of the copyright holders nor the names of its
14 # contributors may be used to endorse or promote products derived from
15 # this software without specific prior written permission.
17 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 # This file generates the header and source files for the flags
31 # that control the tracing facility.
36 if len(sys
.argv
) != 2:
37 print "%s: Need argument (basename of cc/hh files)" % sys
.argv
[0]
40 hhfilename
= sys
.argv
[1] + '.hh'
41 ccfilename
= sys
.argv
[1] + '.cc'
44 # The list of trace flags that can be used to condition DPRINTFs etc.
45 # To define a new flag, simply add it to this list.
152 # "Compound" flags correspond to a set of base flags. These exist
153 # solely for convenience in setting them via the command line: if a
154 # compound flag is specified, all of the corresponding base flags are
155 # set. Compound flags cannot be used directly in DPRINTFs etc.
156 # To define a new compound flag, add a new entry to this hash
157 # following the existing examples.
160 'GDBAll' : [ 'GDBMisc', 'GDBAcc', 'GDBRead', 'GDBWrite', 'GDBSend', 'GDBRecv', 'GDBExtra' ],
161 'ScsiAll' : [ 'ScsiDisk', 'ScsiCtrl', 'ScsiNone' ],
162 'DiskImageAll' : [ 'DiskImage', 'DiskImageRead', 'DiskImageWrite' ],
163 'EthernetAll' : [ 'Ethernet', 'EthernetPIO', 'EthernetDMA', 'EthernetData' , 'EthernetDesc', 'EthernetIntr', 'EthernetSM', 'EthernetCksum' ],
164 'EthernetNoData' : [ 'Ethernet', 'EthernetPIO', 'EthernetDesc', 'EthernetIntr', 'EthernetSM', 'EthernetCksum' ],
165 'IdeAll' : [ 'IdeCtrl', 'IdeDisk' ],
166 'FullCPUAll' : [ 'Fetch', 'Decode', 'Rename', 'IEW', 'Commit', 'IQ', 'ROB', 'FreeList', 'RenameMap', 'LDSTQ', 'StoreSet', 'MemDepUnit', 'DynInst', 'FullCPU']
169 #############################################################
171 # Everything below this point generates the appropriate C++
172 # declarations and definitions for the trace flags. If you are simply
173 # adding or modifying flag definitions, you should not have to change
179 # extract just the compound flag names into a list
181 compoundFlags
.extend(compoundFlagMap
.keys())
185 # First generate the header file. This defines the Flag enum
186 # and some extern declarations for the .cc file.
189 hhfile
= file(hhfilename
, 'w')
191 sys
.exit("can't open %s: %s" % (hhfilename
, e
))
193 # file header boilerplate
196 * DO NOT EDIT THIS FILE!
198 * Automatically generated from traceflags.py
201 #ifndef __BASE_TRACE_FLAGS_HH__
202 #define __BASE_TRACE_FLAGS_HH__
209 # Generate the enum. Base flags come first, then compound flags.
211 for flag
in baseFlags
:
212 print >>hhfile
, ' %s = %d,' % (flag
, idx
)
216 print >>hhfile
, ' NumFlags = %d,' % idx
218 # put a comment in here to separate base from compound flags
220 // The remaining enum values are *not* valid indices for Trace::flags.
221 // They are "compound" flags, which correspond to sets of base
222 // flags, and are used only by TraceParamContext::setFlags().
225 for flag
in compoundFlags
:
226 print >>hhfile
, ' %s = %d,' % (flag
, idx
)
229 numCompoundFlags
= idx
- numBaseFlags
230 print >>hhfile
, ' NumCompoundFlags = %d' % numCompoundFlags
232 # trailer boilerplate
236 // Array of strings for SimpleEnumParam
237 extern const char *flagStrings[];
238 extern const int numFlagStrings;
240 // Array of arraay pointers: for each compound flag, gives the list of
241 // base flags to set. Inidividual flag arrays are terminated by -1.
242 extern const Flags *compoundFlags[];
244 /* namespace Trace */ }
246 #endif // __BASE_TRACE_FLAGS_HH__
253 # Print out .cc file with array definitions.
257 ccfile
= file(ccfilename
, 'w')
259 sys
.exit("can't open %s: %s" % (ccfilename
, e
))
264 * DO NOT EDIT THIS FILE!
266 * Automatically generated from traceflags.pl.
269 #include "base/traceflags.hh"
271 using namespace Trace;
273 const char *Trace::flagStrings[] =
277 # The string array is used by SimpleEnumParam to map the strings
278 # provided by the user to enum values.
279 for flag
in baseFlags
:
280 print >>ccfile
, ' "%s",' % flag
282 for flag
in compoundFlags
:
283 print >>ccfile
, ' "%s",' % flag
285 print >>ccfile
, '};\n'
287 numFlagStrings
= len(baseFlags
) + len(compoundFlags
);
289 print >>ccfile
, 'const int Trace::numFlagStrings = %d;' % numFlagStrings
293 # Now define the individual compound flag arrays. There is an array
294 # for each compound flag listing the component base flags.
297 for flag
in compoundFlags
:
298 flags
= compoundFlagMap
[flag
]
299 flags
.append('(Flags)-1')
300 print >>ccfile
, 'static const Flags %sMap[] =' % flag
301 print >>ccfile
, '{ %s };' % (', '.join(flags
))
305 # Finally the compoundFlags[] array maps the compound flags
306 # to their individual arrays/
308 print >>ccfile
, 'const Flags *Trace::compoundFlags[] ='
311 for flag
in compoundFlags
:
312 print >>ccfile
, ' %sMap,' % flag