src/base/traceflags.py

   1 #!/usr/bin/env python
   2
   3 # Copyright (c) 2004-2005 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 # Authors: Nathan Binkert
  30 #          Steve Reinhardt
  31
  32 __all__ = [ 'allFlags', 'baseFlags', 'compoundFlagsMap', 'compoundFlags' ]
  33
  34 #
  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.
  37 #
  38 baseFlags = [
  39     'Activity',
  40     'AlphaConsole',
  41     'Annotate',
  42     'BADADDR',
  43     'BE',
  44     'BPredRAS',
  45     'Bus',
  46     'BusAddrRanges',
  47     'BusBridge',
  48     'Cache',
  49     'CachePort',
  50     'Chains',
  51     'Checker',
  52     'Clock',
  53     'Commit',
  54     'CommitRate',
  55     'Config',
  56     'Console',
  57     'ConsolePoll',
  58     'ConsoleVerbose',
  59     'Context',
  60     'Cycle',
  61     'DMA',
  62     'DMAReadVerbose',
  63     'DMAWriteVerbose',
  64     'DebugPrintf',
  65     'Decode',
  66     'DiskImage',
  67     'DiskImageRead',
  68     'DiskImageWrite',
  69     'DynInst',
  70     'Ethernet',
  71     'EthernetCksum',
  72     'EthernetDMA',
  73     'EthernetData',
  74     'EthernetDesc',
  75     'EthernetEEPROM',
  76     'EthernetIntr',
  77     'EthernetPIO',
  78     'EthernetSM',
  79     'Event',
  80     'ExecEnable',
  81     'ExecCPSeq',
  82     'ExecEffAddr',
  83     'ExecFetchSeq',
  84     'ExecIntRegs',
  85     'ExecIntel',
  86     'ExecLegion',
  87     'ExecOpClass',
  88     'ExecRegDelta',
  89     'ExecResult',
  90     'ExecSpeculative',
  91     'ExecSymbol',
  92     'ExecThread',
  93     'ExecTicks',
  94     'FE',
  95     'Fault',
  96     'Fetch',
  97     'Flow',
  98     'FreeList',
  99     'FullCPU',
 100     'FunctionalAccess',
 101     'GDBAcc',
 102     'GDBExtra',
 103     'GDBMisc',
 104     'GDBRead',
 105     'GDBRecv',
 106     'GDBSend',
 107     'GDBWrite',
 108     'HWPrefetch',
 109     'IBE',
 110     'IEW',
 111     'IIC',
 112     'IICMore',
 113     'IPI',
 114     'IPR',
 115     'IQ',
 116     'ISP',
 117     'IdeCtrl',
 118     'IdeDisk',
 119     'Iob',
 120     'Interrupt',
 121     'LLSC',
 122     'LSQ',
 123     'LSQUnit',
 124     'Loader',
 125     'MC146818',
 126     'MMU',
 127     'MSHR',
 128     'Mbox',
 129     'MemDepUnit',
 130     'MemoryAccess',
 131     'MemTest',
 132     'MipsPRA',
 133     'O3CPU',
 134     'OzoneCPU',
 135     'OzoneLSQ',
 136     'PCEvent',
 137     'PCIA',
 138     'PCIDEV',
 139     'PciConfigAll',
 140     'Pipeline',
 141     'Printf',
 142     'Predecoder',
 143     'Quiesce',
 144     'ROB',
 145     'Regs',
 146     'Rename',
 147     'RenameMap',
 148     'SQL',
 149     'Sampler',
 150     'Scoreboard',
 151     'ScsiCtrl',
 152     'ScsiDisk',
 153     'ScsiNone',
 154     'Serialize',
 155     'SimpleCPU',
 156     'SimpleDisk',
 157     'SimpleDiskData',
 158     'Sparc',
 159     'Split',
 160     'Stack',
 161     'StatEvents',
 162     'Stats',
 163     'StoreSet',
 164     'Syscall',
 165     'SyscallVerbose',
 166     'TCPIP',
 167     'TLB',
 168     'Thread',
 169     'Timer',
 170     'Tsunami',
 171     'Uart',
 172     'VtoPhys',
 173     'WriteBarrier',
 174     'Writeback',
 175     'X86',
 176     ]
 177
 178 #
 179 # "Compound" flags correspond to a set of base flags.  These exist
 180 # solely for convenience in setting them via the command line: if a
 181 # compound flag is specified, all of the corresponding base flags are
 182 # set.  Compound flags cannot be used directly in DPRINTFs etc.
 183 # To define a new compound flag, add a new entry to this hash
 184 # following the existing examples.
 185 #
 186 compoundFlagMap = {
 187     'All'            : baseFlags,
 188     'DiskImageAll'   : [ 'DiskImage', 'DiskImageRead', 'DiskImageWrite' ],
 189     'EthernetAll'    : [ 'Ethernet', 'EthernetPIO', 'EthernetDMA',
 190                          'EthernetData' , 'EthernetDesc', 'EthernetIntr',
 191                          'EthernetSM', 'EthernetCksum' ],
 192     'EthernetNoData' : [ 'Ethernet', 'EthernetPIO', 'EthernetDesc',
 193                          'EthernetIntr', 'EthernetSM', 'EthernetCksum' ],
 194     'Exec'           : [ 'ExecEnable', 'ExecTicks', 'ExecOpClass',
 195                          'ExecThread', 'ExecEffAddr', 'ExecResult',
 196                          'ExecSymbol' ],
 197     'GDBAll'         : [ 'GDBMisc', 'GDBAcc', 'GDBRead', 'GDBWrite', 'GDBSend',
 198                          'GDBRecv', 'GDBExtra' ],
 199     'IdeAll'         : [ 'IdeCtrl', 'IdeDisk' ],
 200     'O3CPUAll'       : [ 'Fetch', 'Decode', 'Rename', 'IEW', 'Commit', 'IQ',
 201                          'ROB', 'FreeList', 'RenameMap', 'LSQ', 'LSQUnit',
 202                          'StoreSet', 'MemDepUnit', 'DynInst', 'FullCPU',
 203                          'O3CPU', 'Activity','Scoreboard','Writeback' ],
 204     'OzoneCPUAll'    : [ 'BE', 'FE', 'IBE', 'OzoneLSQ', 'OzoneCPU' ],
 205     'ScsiAll'        : [ 'ScsiDisk', 'ScsiCtrl', 'ScsiNone' ]
 206 }
 207
 208 # extract just the compound flag names into a list
 209 compoundFlags = []
 210 compoundFlags.extend(compoundFlagMap.keys())
 211 compoundFlags.sort()
 212
 213 allFlags = frozenset(baseFlags + compoundFlags)
 214
 215 #############################################################
 216 #
 217 # Everything below this point generates the appropriate C++
 218 # declarations and definitions for the trace flags.  If you are simply
 219 # adding or modifying flag definitions, you should not have to change
 220 # anything below.
 221 #
 222 def gen_hh(filename):
 223     #
 224     # First generate the header file.  This defines the Flag enum
 225     # and some extern declarations for the .cc file.
 226     #
 227     try:
 228         hhfile = file(filename, 'w')
 229     except IOError, e:
 230         sys.exit("can't open %s: %s" % (hhfilename, e))
 231
 232     # file header boilerplate
 233     print >>hhfile, '''
 234     /*
 235      * DO NOT EDIT THIS FILE!
 236      *
 237      * Automatically generated from traceflags.py
 238      */
 239
 240     #ifndef __BASE_TRACE_FLAGS_HH__
 241     #define __BASE_TRACE_FLAGS_HH__
 242
 243     namespace Trace {
 244
 245     enum Flags {
 246     ''',
 247
 248     # Generate the enum.  Base flags come first, then compound flags.
 249     idx = 0
 250     for flag in baseFlags:
 251         print >>hhfile, '    %s = %d,' % (flag, idx)
 252         idx += 1
 253
 254     numBaseFlags = idx
 255     print >>hhfile, '    NumFlags = %d,' % idx
 256
 257     # put a comment in here to separate base from compound flags
 258     print >>hhfile, '''
 259         // The remaining enum values are *not* valid indices for Trace::flags.
 260         // They are "compound" flags, which correspond to sets of base
 261         // flags, and are used by changeFlag.
 262     ''',
 263
 264     for flag in compoundFlags:
 265         print >>hhfile, '    %s = %d,' % (flag, idx)
 266         idx += 1
 267
 268     numCompoundFlags = idx - numBaseFlags
 269     print >>hhfile, '    NumCompoundFlags = %d' % numCompoundFlags
 270
 271     # trailer boilerplate
 272     print >>hhfile, '''\
 273     }; // enum Flags
 274
 275     // Array of strings for SimpleEnumParam
 276     extern const char *flagStrings[];
 277     extern const int numFlagStrings;
 278
 279     // Array of arraay pointers: for each compound flag, gives the list of
 280     // base flags to set.  Inidividual flag arrays are terminated by -1.
 281     extern const Flags *compoundFlags[];
 282
 283     /* namespace Trace */ }
 284
 285     #endif // __BASE_TRACE_FLAGS_HH__
 286     \n''',
 287
 288     hhfile.close()
 289
 290 def gen_cc(filename):
 291     '''Print out .cc file with array definitions.'''
 292
 293     try:
 294         ccfile = file(filename, 'w')
 295     except OSError, e:
 296         sys.exit("can't open %s: %s" % (ccfilename, e))
 297
 298     # file header
 299     print >>ccfile, '''
 300 /*
 301  * DO NOT EDIT THIS FILE!
 302  *
 303  * Automatically generated from traceflags.pl.
 304  */
 305
 306 #include "base/traceflags.hh"
 307
 308 using namespace Trace;
 309
 310 const char *Trace::flagStrings[] =
 311 {
 312 ''',
 313
 314     # The string array is used by SimpleEnumParam to map the strings
 315     # provided by the user to enum values.
 316     for flag in baseFlags:
 317         print >>ccfile, '    "%s",' % flag
 318
 319     for flag in compoundFlags:
 320         print >>ccfile, '    "%s",' % flag
 321
 322     print >>ccfile, '};\n'
 323
 324     numFlagStrings = len(baseFlags) + len(compoundFlags);
 325
 326     print >>ccfile, 'const int Trace::numFlagStrings = %d;' % numFlagStrings
 327     print >>ccfile
 328
 329     #
 330     # Now define the individual compound flag arrays.  There is an array
 331     # for each compound flag listing the component base flags.
 332     #
 333
 334     for flag in compoundFlags:
 335         flags = compoundFlagMap[flag]
 336         flags.append('(Flags)-1')
 337         print >>ccfile, 'static const Flags %sMap[] =' % flag
 338         print >>ccfile, '{ %s };' % (', '.join(flags))
 339         print >>ccfile
 340
 341     #
 342     # Finally the compoundFlags[] array maps the compound flags
 343     # to their individual arrays/
 344     #
 345     print >>ccfile, 'const Flags *Trace::compoundFlags[] ='
 346     print >>ccfile, '{'
 347
 348     for flag in compoundFlags:
 349         print >>ccfile, '    %sMap,' % flag
 350
 351     # file trailer
 352     print >>ccfile, '};'
 353
 354     ccfile.close()