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
32 __all__
= [ 'allFlags', 'baseFlags', 'compoundFlagsMap', 'compoundFlags' ]
35 # The list of trace flags that can be used to condition DPRINTFs etc.
36 # To define a new flag, simply add it to this list.
180 # "Compound" flags correspond to a set of base flags. These exist
181 # solely for convenience in setting them via the command line: if a
182 # compound flag is specified, all of the corresponding base flags are
183 # set. Compound flags cannot be used directly in DPRINTFs etc.
184 # To define a new compound flag, add a new entry to this hash
185 # following the existing examples.
189 'DiskImageAll' : [ 'DiskImage', 'DiskImageRead', 'DiskImageWrite' ],
190 'EthernetAll' : [ 'Ethernet', 'EthernetPIO', 'EthernetDMA',
191 'EthernetData' , 'EthernetDesc', 'EthernetIntr',
192 'EthernetSM', 'EthernetCksum' ],
193 'EthernetNoData' : [ 'Ethernet', 'EthernetPIO', 'EthernetDesc',
194 'EthernetIntr', 'EthernetSM', 'EthernetCksum' ],
195 'Exec' : [ 'ExecEnable', 'ExecTicks', 'ExecOpClass',
196 'ExecThread', 'ExecEffAddr', 'ExecResult',
198 'GDBAll' : [ 'GDBMisc', 'GDBAcc', 'GDBRead', 'GDBWrite', 'GDBSend',
199 'GDBRecv', 'GDBExtra' ],
200 'IdeAll' : [ 'IdeCtrl', 'IdeDisk' ],
201 'O3CPUAll' : [ 'Fetch', 'Decode', 'Rename', 'IEW', 'Commit', 'IQ',
202 'ROB', 'FreeList', 'RenameMap', 'LSQ', 'LSQUnit',
203 'StoreSet', 'MemDepUnit', 'DynInst', 'FullCPU',
204 'O3CPU', 'Activity','Scoreboard','Writeback' ],
205 'OzoneCPUAll' : [ 'BE', 'FE', 'IBE', 'OzoneLSQ', 'OzoneCPU' ],
206 'ScsiAll' : [ 'ScsiDisk', 'ScsiCtrl', 'ScsiNone' ]
209 # extract just the compound flag names into a list
211 compoundFlags
.extend(compoundFlagMap
.keys())
214 allFlags
= frozenset(baseFlags
+ compoundFlags
)
216 #############################################################
218 # Everything below this point generates the appropriate C++
219 # declarations and definitions for the trace flags. If you are simply
220 # adding or modifying flag definitions, you should not have to change
223 def gen_hh(filename
):
225 # First generate the header file. This defines the Flag enum
226 # and some extern declarations for the .cc file.
229 hhfile
= file(filename
, 'w')
231 sys
.exit("can't open %s: %s" % (hhfilename
, e
))
233 # file header boilerplate
236 * DO NOT EDIT THIS FILE!
238 * Automatically generated from traceflags.py
241 #ifndef __BASE_TRACE_FLAGS_HH__
242 #define __BASE_TRACE_FLAGS_HH__
249 # Generate the enum. Base flags come first, then compound flags.
251 for flag
in baseFlags
:
252 print >>hhfile
, ' %s = %d,' % (flag
, idx
)
256 print >>hhfile
, ' NumFlags = %d,' % idx
258 # put a comment in here to separate base from compound flags
260 // The remaining enum values are *not* valid indices for Trace::flags.
261 // They are "compound" flags, which correspond to sets of base
262 // flags, and are used by changeFlag.
265 for flag
in compoundFlags
:
266 print >>hhfile
, ' %s = %d,' % (flag
, idx
)
269 numCompoundFlags
= idx
- numBaseFlags
270 print >>hhfile
, ' NumCompoundFlags = %d' % numCompoundFlags
272 # trailer boilerplate
276 // Array of strings for SimpleEnumParam
277 extern const char *flagStrings[];
278 extern const int numFlagStrings;
280 // Array of arraay pointers: for each compound flag, gives the list of
281 // base flags to set. Inidividual flag arrays are terminated by -1.
282 extern const Flags *compoundFlags[];
284 /* namespace Trace */ }
286 #endif // __BASE_TRACE_FLAGS_HH__
291 def gen_cc(filename
):
292 '''Print out .cc file with array definitions.'''
295 ccfile
= file(filename
, 'w')
297 sys
.exit("can't open %s: %s" % (ccfilename
, e
))
302 * DO NOT EDIT THIS FILE!
304 * Automatically generated from traceflags.pl.
307 #include "base/traceflags.hh"
309 using namespace Trace;
311 const char *Trace::flagStrings[] =
315 # The string array is used by SimpleEnumParam to map the strings
316 # provided by the user to enum values.
317 for flag
in baseFlags
:
318 print >>ccfile
, ' "%s",' % flag
320 for flag
in compoundFlags
:
321 print >>ccfile
, ' "%s",' % flag
323 print >>ccfile
, '};\n'
325 numFlagStrings
= len(baseFlags
) + len(compoundFlags
);
327 print >>ccfile
, 'const int Trace::numFlagStrings = %d;' % numFlagStrings
331 # Now define the individual compound flag arrays. There is an array
332 # for each compound flag listing the component base flags.
335 for flag
in compoundFlags
:
336 flags
= compoundFlagMap
[flag
]
337 flags
.append('(Flags)-1')
338 print >>ccfile
, 'static const Flags %sMap[] =' % flag
339 print >>ccfile
, '{ %s };' % (', '.join(flags
))
343 # Finally the compoundFlags[] array maps the compound flags
344 # to their individual arrays/
346 print >>ccfile
, 'const Flags *Trace::compoundFlags[] ='
349 for flag
in compoundFlags
:
350 print >>ccfile
, ' %sMap,' % flag