base/traceflags.py

   1 #!/usr/bin/env python
   2
   3 # Copyright (c) 2004 The Regents of The University of Michigan
   4 # All rights reserved.
   5 #
   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.
  16 #
  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.
  28
  29 #
  30 # This file generates the header and source files for the flags
  31 # that control the tracing facility.
  32 #
  33 hhfilename="traceflags.hh"
  34 ccfilename="traceflags.cc"
  35
  36 #
  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.
  39 #
  40 baseFlags = [
  41     'TCPIP',
  42     'Bus',
  43     'ScsiDisk',
  44     'ScsiCtrl',
  45     'ScsiNone',
  46     'DMA',
  47     'DMAReadVerbose',
  48     'DMAWriteVerbose',
  49     'TLB',
  50     'SimpleDisk',
  51     'SimpleDiskData',
  52     'Clock',
  53     'Regs',
  54     'MC146818',
  55     'IPI',
  56     'Timer',
  57     'Mbox',
  58     'PCIA',
  59     'PCIDEV',
  60     'PciConfigAll',
  61     'ISP',
  62     'BADADDR',
  63     'Console',
  64     'ConsolePoll',
  65     'ConsoleVerbose',
  66     'TlaserUart',
  67     'AlphaConsole',
  68     'Flow',
  69     'Interrupt',
  70     'Fault',
  71     'Cycle',
  72     'Loader',
  73     'MMU',
  74     'Ethernet',
  75     'EthernetPIO',
  76     'EthernetDMA',
  77     'EthernetData',
  78     'GDBMisc',
  79     'GDBAcc',
  80     'GDBRead',
  81     'GDBWrite',
  82     'GDBSend',
  83     'GDBRecv',
  84     'GDBExtra',
  85     'VtoPhys',
  86     'Printf',
  87     'DebugPrintf',
  88     'Serialize',
  89     'Event',
  90     'PCEvent',
  91     'SyscallWarnings',
  92     'SyscallVerbose',
  93     'DiskImage',
  94     'DiskImageRead',
  95     'DiskImageWrite',
  96     'InstExec',
  97     'BPredRAS',
  98     'Cache',
  99     'IIC',
 100     'IICMore',
 101     'MSHR',
 102     'Chains',
 103     'Dispatch',
 104     'Stats',
 105     'StatEvents',
 106     'Context',
 107     'Config',
 108     'Sampler',
 109     'WriteBarrier',
 110     'IdeCtrl',
 111     'IdeDisk',
 112     'Tsunami',
 113     'TsunamiUart'
 114     ]
 115
 116 #
 117 # "Compound" flags correspond to a set of base flags.  These exist
 118 # solely for convenience in setting them via the command line: if a
 119 # compound flag is specified, all of the corresponding base flags are
 120 # set.  Compound flags cannot be used directly in DPRINTFs etc.
 121 # To define a new compound flag, add a new entry to this hash
 122 # following the existing examples.
 123 #
 124 compoundFlagMap = {
 125     'GDBAll' : [ 'GDBMisc', 'GDBAcc', 'GDBRead', 'GDBWrite', 'GDBSend', 'GDBRecv', 'GDBExtra' ],
 126     'ScsiAll' : [ 'ScsiDisk', 'ScsiCtrl', 'ScsiNone' ],
 127     'DiskImageAll' : [ 'DiskImage', 'DiskImageRead', 'DiskImageWrite' ],
 128     'EthernetAll' : [ 'Ethernet', 'EthernetPIO', 'EthernetDMA', 'EthernetData' ],
 129     'IdeAll' : [ 'IdeCtrl', 'IdeDisk' ]
 130 }
 131
 132 #############################################################
 133 #
 134 # Everything below this point generates the appropriate C++
 135 # declarations and definitions for the trace flags.  If you are simply
 136 # adding or modifying flag definitions, you should not have to change
 137 # anything below.
 138 #
 139
 140 import sys
 141
 142 # extract just the compound flag names into a list
 143 compoundFlags = []
 144 compoundFlags.extend(compoundFlagMap.keys())
 145 compoundFlags.sort()
 146
 147 #
 148 # First generate the header file.  This defines the Flag enum
 149 # and some extern declarations for the .cc file.
 150 #
 151 try:
 152     hhfile = file(hhfilename, 'w')
 153 except IOError, e:
 154     sys.exit("can't open %s: %s" % (hhfilename, e))
 155
 156 # file header boilerplate
 157 print >>hhfile, '''/* $Id $ */
 158
 159 /*
 160  * Copyright (c) 2004
 161  * The Regents of The University of Michigan
 162  * All Rights Reserved
 163  *
 164  * This code is part of the M5 simulator, developed by Nathan Binkert,
 165  * Erik Hallnor, Steve Raasch, and Steve Reinhardt, with contributions
 166  * from Ron Dreslinski, Dave Greene, and Lisa Hsu.
 167  *
 168  * Permission is granted to use, copy, create derivative works and
 169  * redistribute this software and such derivative works for any
 170  * purpose, so long as the copyright notice above, this grant of
 171  * permission, and the disclaimer below appear in all copies made; and
 172  * so long as the name of The University of Michigan is not used in
 173  * any advertising or publicity pertaining to the use or distribution
 174  * of this software without specific, written prior authorization.
 175  *
 176  * THIS SOFTWARE IS PROVIDED AS IS, WITHOUT REPRESENTATION FROM THE
 177  * UNIVERSITY OF MICHIGAN AS TO ITS FITNESS FOR ANY PURPOSE, AND
 178  * WITHOUT WARRANTY BY THE UNIVERSITY OF MICHIGAN OF ANY KIND, EITHER
 179  * EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED
 180  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 181  * PURPOSE. THE REGENTS OF THE UNIVERSITY OF MICHIGAN SHALL NOT BE
 182  * LIABLE FOR ANY DAMAGES, INCLUDING DIRECT, SPECIAL, INDIRECT,
 183  * INCIDENTAL, OR CONSEQUENTIAL DAMAGES, WITH RESPECT TO ANY CLAIM
 184  * ARISING OUT OF OR IN CONNECTION WITH THE USE OF THE SOFTWARE, EVEN
 185  * IF IT HAS BEEN OR IS HEREAFTER ADVISED OF THE POSSIBILITY OF SUCH
 186  * DAMAGES.
 187  */
 188
 189 /*
 190  * DO NOT EDIT THIS FILE!
 191  *
 192  * Automatically generated from traceflags.py
 193  */
 194
 195 #ifndef __BASE_TRACE_FLAGS_HH__
 196 #define __BASE_TRACE_FLAGS_HH__
 197
 198 namespace Trace {
 199
 200 enum Flags {
 201 ''',
 202
 203 # Generate the enum.  Base flags come first, then compound flags.
 204 idx = 0
 205 for flag in baseFlags:
 206     print >>hhfile, '    %s = %d,' % (flag, idx)
 207     idx += 1
 208
 209 numBaseFlags = idx
 210 print >>hhfile, '    NumFlags = %d,' % idx
 211
 212 # put a comment in here to separate base from compound flags
 213 print >>hhfile, '''
 214     // The remaining enum values are *not* valid indices for Trace::flags.
 215     // They are "compound" flags, which correspond to sets of base
 216     // flags, and are used only by TraceParamContext::setFlags().
 217 ''',
 218
 219 for flag in compoundFlags:
 220     print >>hhfile, '    %s = %d,' % (flag, idx)
 221     idx += 1
 222
 223 numCompoundFlags = idx - numBaseFlags
 224 print >>hhfile, '    NumCompoundFlags = %d' % numCompoundFlags
 225
 226 # trailer boilerplate
 227 print >>hhfile, '''\
 228 }; // enum Flags
 229
 230 // Array of strings for SimpleEnumParam
 231 extern const char *flagStrings[];
 232 extern const int numFlagStrings;
 233
 234 // Array of arraay pointers: for each compound flag, gives the list of
 235 // base flags to set.  Inidividual flag arrays are terminated by -1.
 236 extern const Flags *compoundFlags[];
 237
 238 /* namespace Trace */ }
 239
 240 #endif // __BASE_TRACE_FLAGS_HH__
 241 ''',
 242
 243 hhfile.close()
 244
 245 #
 246 #
 247 # Print out .cc file with array definitions.
 248 #
 249 #
 250 try:
 251     ccfile = file(ccfilename, 'w')
 252 except OSError, e:
 253     sys.exit("can't open %s: %s" % (ccfilename, e))
 254
 255 # file header
 256 print >>ccfile, '''\
 257 /* $Id $ */
 258
 259 /*
 260  * Copyright (c) 2004
 261  * The Regents of The University of Michigan
 262  * All Rights Reserved
 263  *
 264  * This code is part of the M5 simulator, developed by Nathan Binkert,
 265  * Erik Hallnor, Steve Raasch, and Steve Reinhardt, with contributions
 266  * from Ron Dreslinski, Dave Greene, and Lisa Hsu.
 267  *
 268  * Permission is granted to use, copy, create derivative works and
 269  * redistribute this software and such derivative works for any
 270  * purpose, so long as the copyright notice above, this grant of
 271  * permission, and the disclaimer below appear in all copies made; and
 272  * so long as the name of The University of Michigan is not used in
 273  * any advertising or publicity pertaining to the use or distribution
 274  * of this software without specific, written prior authorization.
 275  *
 276  * THIS SOFTWARE IS PROVIDED AS IS, WITHOUT REPRESENTATION FROM THE
 277  * UNIVERSITY OF MICHIGAN AS TO ITS FITNESS FOR ANY PURPOSE, AND
 278  * WITHOUT WARRANTY BY THE UNIVERSITY OF MICHIGAN OF ANY KIND, EITHER
 279  * EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED
 280  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 281  * PURPOSE. THE REGENTS OF THE UNIVERSITY OF MICHIGAN SHALL NOT BE
 282  * LIABLE FOR ANY DAMAGES, INCLUDING DIRECT, SPECIAL, INDIRECT,
 283  * INCIDENTAL, OR CONSEQUENTIAL DAMAGES, WITH RESPECT TO ANY CLAIM
 284  * ARISING OUT OF OR IN CONNECTION WITH THE USE OF THE SOFTWARE, EVEN
 285  * IF IT HAS BEEN OR IS HEREAFTER ADVISED OF THE POSSIBILITY OF SUCH
 286  * DAMAGES.
 287  */
 288
 289 /*
 290  * DO NOT EDIT THIS FILE!
 291  *
 292  * Automatically generated from traceflags.pl.
 293  */
 294
 295 #include "base/traceflags.hh"
 296
 297 using namespace Trace;
 298
 299 const char *Trace::flagStrings[] =
 300 {
 301 ''',
 302
 303 # The string array is used by SimpleEnumParam to map the strings
 304 # provided by the user to enum values.
 305 for flag in baseFlags:
 306     print >>ccfile, '    "%s",' % flag
 307
 308 for flag in compoundFlags:
 309     print >>ccfile, '    "%s",' % flag
 310
 311 print >>ccfile, '};\n'
 312
 313 numFlagStrings = len(baseFlags) + len(compoundFlags);
 314
 315 print >>ccfile, 'const int Trace::numFlagStrings = %d;' % numFlagStrings
 316 print >>ccfile
 317
 318 #
 319 # Now define the individual compound flag arrays.  There is an array
 320 # for each compound flag listing the component base flags.
 321 #
 322
 323 for flag in compoundFlags:
 324     flags = compoundFlagMap[flag]
 325     flags.append('(Flags)-1')
 326     print >>ccfile, 'static const Flags %sMap[] =' % flag
 327     print >>ccfile, '{ %s };' % (', '.join(flags))
 328     print >>ccfile
 329
 330 #
 331 # Finally the compoundFlags[] array maps the compound flags
 332 # to their individual arrays/
 333 #
 334 print >>ccfile, 'const Flags *Trace::compoundFlags[] ='
 335 print >>ccfile, '{'
 336
 337 for flag in compoundFlags:
 338     print >>ccfile, '    %sMap,' % flag
 339
 340 # file trailer
 341 print >>ccfile, '};'
 342
 343 ccfile.close()
 344