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.
29 # Authors: Nathan Binkert
33 # This file generates the header and source files for the flags
34 # that control the tracing facility.
39 if len(sys
.argv
) != 2:
40 print "%s: Need argument (basename of cc/hh files)" % sys
.argv
[0]
43 hhfilename
= sys
.argv
[1] + '.hh'
44 ccfilename
= sys
.argv
[1] + '.cc'
47 # The list of trace flags that can be used to condition DPRINTFs etc.
48 # To define a new flag, simply add it to this list.
165 # "Compound" flags correspond to a set of base flags. These exist
166 # solely for convenience in setting them via the command line: if a
167 # compound flag is specified, all of the corresponding base flags are
168 # set. Compound flags cannot be used directly in DPRINTFs etc.
169 # To define a new compound flag, add a new entry to this hash
170 # following the existing examples.
173 'GDBAll' : [ 'GDBMisc', 'GDBAcc', 'GDBRead', 'GDBWrite', 'GDBSend', 'GDBRecv', 'GDBExtra' ],
174 'ScsiAll' : [ 'ScsiDisk', 'ScsiCtrl', 'ScsiNone' ],
175 'DiskImageAll' : [ 'DiskImage', 'DiskImageRead', 'DiskImageWrite' ],
176 'EthernetAll' : [ 'Ethernet', 'EthernetPIO', 'EthernetDMA', 'EthernetData' , 'EthernetDesc', 'EthernetIntr', 'EthernetSM', 'EthernetCksum' ],
177 'EthernetNoData' : [ 'Ethernet', 'EthernetPIO', 'EthernetDesc', 'EthernetIntr', 'EthernetSM', 'EthernetCksum' ],
178 'IdeAll' : [ 'IdeCtrl', 'IdeDisk' ],
179 'O3CPUAll' : [ 'Fetch', 'Decode', 'Rename', 'IEW', 'Commit', 'IQ', 'ROB', 'FreeList', 'RenameMap', 'LSQ', 'LSQUnit', 'StoreSet', 'MemDepUnit', 'DynInst', 'FullCPU', 'O3CPU', 'Activity','Scoreboard','Writeback'],
180 'OzoneCPUAll' : [ 'BE', 'FE', 'IBE', 'OzoneLSQ', 'OzoneCPU']
183 #############################################################
185 # Everything below this point generates the appropriate C++
186 # declarations and definitions for the trace flags. If you are simply
187 # adding or modifying flag definitions, you should not have to change
193 # extract just the compound flag names into a list
195 compoundFlags
.extend(compoundFlagMap
.keys())
199 # First generate the header file. This defines the Flag enum
200 # and some extern declarations for the .cc file.
203 hhfile
= file(hhfilename
, 'w')
205 sys
.exit("can't open %s: %s" % (hhfilename
, e
))
207 # file header boilerplate
210 * DO NOT EDIT THIS FILE!
212 * Automatically generated from traceflags.py
215 #ifndef __BASE_TRACE_FLAGS_HH__
216 #define __BASE_TRACE_FLAGS_HH__
223 # Generate the enum. Base flags come first, then compound flags.
225 for flag
in baseFlags
:
226 print >>hhfile
, ' %s = %d,' % (flag
, idx
)
230 print >>hhfile
, ' NumFlags = %d,' % idx
232 # put a comment in here to separate base from compound flags
234 // The remaining enum values are *not* valid indices for Trace::flags.
235 // They are "compound" flags, which correspond to sets of base
236 // flags, and are used only by TraceParamContext::setFlags().
239 for flag
in compoundFlags
:
240 print >>hhfile
, ' %s = %d,' % (flag
, idx
)
243 numCompoundFlags
= idx
- numBaseFlags
244 print >>hhfile
, ' NumCompoundFlags = %d' % numCompoundFlags
246 # trailer boilerplate
250 // Array of strings for SimpleEnumParam
251 extern const char *flagStrings[];
252 extern const int numFlagStrings;
254 // Array of arraay pointers: for each compound flag, gives the list of
255 // base flags to set. Inidividual flag arrays are terminated by -1.
256 extern const Flags *compoundFlags[];
258 /* namespace Trace */ }
260 #endif // __BASE_TRACE_FLAGS_HH__
267 # Print out .cc file with array definitions.
271 ccfile
= file(ccfilename
, 'w')
273 sys
.exit("can't open %s: %s" % (ccfilename
, e
))
278 * DO NOT EDIT THIS FILE!
280 * Automatically generated from traceflags.pl.
283 #include "base/traceflags.hh"
285 using namespace Trace;
287 const char *Trace::flagStrings[] =
291 # The string array is used by SimpleEnumParam to map the strings
292 # provided by the user to enum values.
293 for flag
in baseFlags
:
294 print >>ccfile
, ' "%s",' % flag
296 for flag
in compoundFlags
:
297 print >>ccfile
, ' "%s",' % flag
299 print >>ccfile
, '};\n'
301 numFlagStrings
= len(baseFlags
) + len(compoundFlags
);
303 print >>ccfile
, 'const int Trace::numFlagStrings = %d;' % numFlagStrings
307 # Now define the individual compound flag arrays. There is an array
308 # for each compound flag listing the component base flags.
311 for flag
in compoundFlags
:
312 flags
= compoundFlagMap
[flag
]
313 flags
.append('(Flags)-1')
314 print >>ccfile
, 'static const Flags %sMap[] =' % flag
315 print >>ccfile
, '{ %s };' % (', '.join(flags
))
319 # Finally the compoundFlags[] array maps the compound flags
320 # to their individual arrays/
322 print >>ccfile
, 'const Flags *Trace::compoundFlags[] ='
325 for flag
in compoundFlags
:
326 print >>ccfile
, ' %sMap,' % flag