3 # Copyright (c) 2004 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.
33 hhfilename
="traceflags.hh"
34 ccfilename
="traceflags.cc"
37 # The list of trace flags that can be used to condition DPRINTFs etc.
38 # To define a new flag, simply add it to this list.
110 # "Compound" flags correspond to a set of base flags. These exist
111 # solely for convenience in setting them via the command line: if a
112 # compound flag is specified, all of the corresponding base flags are
113 # set. Compound flags cannot be used directly in DPRINTFs etc.
114 # To define a new compound flag, add a new entry to this hash
115 # following the existing examples.
118 'GDBAll' : [ 'GDBMisc', 'GDBAcc', 'GDBRead', 'GDBWrite', 'GDBSend', 'GDBRecv', 'GDBExtra' ],
119 'ScsiAll' : [ 'ScsiDisk', 'ScsiCtrl', 'ScsiNone' ],
120 'DiskImageAll' : [ 'DiskImage', 'DiskImageRead', 'DiskImageWrite' ],
121 'EthernetAll' : [ 'Ethernet', 'EthernetPIO', 'EthernetDMA', 'EthernetData' ]
124 #############################################################
126 # Everything below this point generates the appropriate C++
127 # declarations and definitions for the trace flags. If you are simply
128 # adding or modifying flag definitions, you should not have to change
134 # extract just the compound flag names into a list
136 compoundFlags
.extend(compoundFlagMap
.keys())
140 # First generate the header file. This defines the Flag enum
141 # and some extern declarations for the .cc file.
144 hhfile
= file(hhfilename
, 'w')
146 sys
.exit("can't open %s: %s" % (hhfilename
, e
))
148 # file header boilerplate
149 print >>hhfile
, '''/* $Id $ */
153 * The Regents of The University of Michigan
154 * All Rights Reserved
156 * This code is part of the M5 simulator, developed by Nathan Binkert,
157 * Erik Hallnor, Steve Raasch, and Steve Reinhardt, with contributions
158 * from Ron Dreslinski, Dave Greene, and Lisa Hsu.
160 * Permission is granted to use, copy, create derivative works and
161 * redistribute this software and such derivative works for any
162 * purpose, so long as the copyright notice above, this grant of
163 * permission, and the disclaimer below appear in all copies made; and
164 * so long as the name of The University of Michigan is not used in
165 * any advertising or publicity pertaining to the use or distribution
166 * of this software without specific, written prior authorization.
168 * THIS SOFTWARE IS PROVIDED AS IS, WITHOUT REPRESENTATION FROM THE
169 * UNIVERSITY OF MICHIGAN AS TO ITS FITNESS FOR ANY PURPOSE, AND
170 * WITHOUT WARRANTY BY THE UNIVERSITY OF MICHIGAN OF ANY KIND, EITHER
171 * EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED
172 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
173 * PURPOSE. THE REGENTS OF THE UNIVERSITY OF MICHIGAN SHALL NOT BE
174 * LIABLE FOR ANY DAMAGES, INCLUDING DIRECT, SPECIAL, INDIRECT,
175 * INCIDENTAL, OR CONSEQUENTIAL DAMAGES, WITH RESPECT TO ANY CLAIM
176 * ARISING OUT OF OR IN CONNECTION WITH THE USE OF THE SOFTWARE, EVEN
177 * IF IT HAS BEEN OR IS HEREAFTER ADVISED OF THE POSSIBILITY OF SUCH
182 * DO NOT EDIT THIS FILE!
184 * Automatically generated from traceflags.py
187 #ifndef __BASE_TRACE_FLAGS_HH__
188 #define __BASE_TRACE_FLAGS_HH__
195 # Generate the enum. Base flags come first, then compound flags.
197 for flag
in baseFlags
:
198 print >>hhfile
, ' %s = %d,' % (flag
, idx
)
202 print >>hhfile
, ' NumFlags = %d,' % idx
204 # put a comment in here to separate base from compound flags
206 // The remaining enum values are *not* valid indices for Trace::flags.
207 // They are "compound" flags, which correspond to sets of base
208 // flags, and are used only by TraceParamContext::setFlags().
211 for flag
in compoundFlags
:
212 print >>hhfile
, ' %s = %d,' % (flag
, idx
)
215 numCompoundFlags
= idx
- numBaseFlags
216 print >>hhfile
, ' NumCompoundFlags = %d' % numCompoundFlags
218 # trailer boilerplate
222 // Array of strings for SimpleEnumParam
223 extern const char *flagStrings[];
224 extern const int numFlagStrings;
226 // Array of arraay pointers: for each compound flag, gives the list of
227 // base flags to set. Inidividual flag arrays are terminated by -1.
228 extern const Flags *compoundFlags[];
230 /* namespace Trace */ }
232 #endif // __BASE_TRACE_FLAGS_HH__
239 # Print out .cc file with array definitions.
243 ccfile
= file(ccfilename
, 'w')
245 sys
.exit("can't open %s: %s" % (ccfilename
, e
))
253 * The Regents of The University of Michigan
254 * All Rights Reserved
256 * This code is part of the M5 simulator, developed by Nathan Binkert,
257 * Erik Hallnor, Steve Raasch, and Steve Reinhardt, with contributions
258 * from Ron Dreslinski, Dave Greene, and Lisa Hsu.
260 * Permission is granted to use, copy, create derivative works and
261 * redistribute this software and such derivative works for any
262 * purpose, so long as the copyright notice above, this grant of
263 * permission, and the disclaimer below appear in all copies made; and
264 * so long as the name of The University of Michigan is not used in
265 * any advertising or publicity pertaining to the use or distribution
266 * of this software without specific, written prior authorization.
268 * THIS SOFTWARE IS PROVIDED AS IS, WITHOUT REPRESENTATION FROM THE
269 * UNIVERSITY OF MICHIGAN AS TO ITS FITNESS FOR ANY PURPOSE, AND
270 * WITHOUT WARRANTY BY THE UNIVERSITY OF MICHIGAN OF ANY KIND, EITHER
271 * EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED
272 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
273 * PURPOSE. THE REGENTS OF THE UNIVERSITY OF MICHIGAN SHALL NOT BE
274 * LIABLE FOR ANY DAMAGES, INCLUDING DIRECT, SPECIAL, INDIRECT,
275 * INCIDENTAL, OR CONSEQUENTIAL DAMAGES, WITH RESPECT TO ANY CLAIM
276 * ARISING OUT OF OR IN CONNECTION WITH THE USE OF THE SOFTWARE, EVEN
277 * IF IT HAS BEEN OR IS HEREAFTER ADVISED OF THE POSSIBILITY OF SUCH
282 * DO NOT EDIT THIS FILE!
284 * Automatically generated from traceflags.pl.
287 #include "base/traceflags.hh"
289 using namespace Trace;
291 const char *Trace::flagStrings[] =
295 # The string array is used by SimpleEnumParam to map the strings
296 # provided by the user to enum values.
297 for flag
in baseFlags
:
298 print >>ccfile
, ' "%s",' % flag
300 for flag
in compoundFlags
:
301 print >>ccfile
, ' "%s",' % flag
303 print >>ccfile
, '};\n'
305 numFlagStrings
= len(baseFlags
) + len(compoundFlags
);
307 print >>ccfile
, 'const int Trace::numFlagStrings = %d;' % numFlagStrings
311 # Now define the individual compound flag arrays. There is an array
312 # for each compound flag listing the component base flags.
315 for flag
in compoundFlags
:
316 flags
= compoundFlagMap
[flag
]
317 flags
.append('(Flags)-1')
318 print >>ccfile
, 'static const Flags %sMap[] =' % flag
319 print >>ccfile
, '{ %s };' % (', '.join(flags
))
323 # Finally the compoundFlags[] array maps the compound flags
324 # to their individual arrays/
326 print >>ccfile
, 'const Flags *Trace::compoundFlags[] ='
329 for flag
in compoundFlags
:
330 print >>ccfile
, ' %sMap,' % flag