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     'MipsPRA',
 132     'O3CPU',
 133     'OzoneCPU',
 134     'OzoneLSQ',
 135     'PCEvent',
 136     'PCIA',
 137     'PCIDEV',
 138     'PciConfigAll',
 139     'Pipeline',
 140     'Printf',
 141     'Predecoder',
 142     'Quiesce',
 143     'ROB',
 144     'Regs',
 145     'Rename',
 146     'RenameMap',
 147     'SQL',
 148     'Sampler',
 149     'Scoreboard',
 150     'ScsiCtrl',
 151     'ScsiDisk',
 152     'ScsiNone',
 153     'Serialize',
 154     'SimpleCPU',
 155     'SimpleDisk',
 156     'SimpleDiskData',
 157     'Sparc',
 158     'Split',
 159     'Stack',
 160     'StatEvents',
 161     'Stats',
 162     'StoreSet',
 163     'Syscall',
 164     'SyscallVerbose',
 165     'TCPIP',
 166     'TLB',
 167     'Thread',
 168     'Timer',
 169     'Tsunami',
 170     'Uart',
 171     'VtoPhys',
 172     'WriteBarrier',
 173     'Writeback',
 174     'X86',
 175     ]
 176
 177 #
 178 # "Compound" flags correspond to a set of base flags.  These exist
 179 # solely for convenience in setting them via the command line: if a
 180 # compound flag is specified, all of the corresponding base flags are
 181 # set.  Compound flags cannot be used directly in DPRINTFs etc.
 182 # To define a new compound flag, add a new entry to this hash
 183 # following the existing examples.
 184 #
 185 compoundFlagMap = {
 186     'All'            : baseFlags,
 187     'DiskImageAll'   : [ 'DiskImage', 'DiskImageRead', 'DiskImageWrite' ],
 188     'EthernetAll'    : [ 'Ethernet', 'EthernetPIO', 'EthernetDMA',
 189                          'EthernetData' , 'EthernetDesc', 'EthernetIntr',
 190                          'EthernetSM', 'EthernetCksum' ],
 191     'EthernetNoData' : [ 'Ethernet', 'EthernetPIO', 'EthernetDesc',
 192                          'EthernetIntr', 'EthernetSM', 'EthernetCksum' ],
 193     'Exec'           : [ 'ExecEnable', 'ExecTicks', 'ExecOpClass',
 194                          'ExecThread', 'ExecEffAddr', 'ExecResult',
 195                          'ExecSymbol' ],
 196     'GDBAll'         : [ 'GDBMisc', 'GDBAcc', 'GDBRead', 'GDBWrite', 'GDBSend',
 197                          'GDBRecv', 'GDBExtra' ],
 198     'IdeAll'         : [ 'IdeCtrl', 'IdeDisk' ],
 199     'O3CPUAll'       : [ 'Fetch', 'Decode', 'Rename', 'IEW', 'Commit', 'IQ',
 200                          'ROB', 'FreeList', 'RenameMap', 'LSQ', 'LSQUnit',
 201                          'StoreSet', 'MemDepUnit', 'DynInst', 'FullCPU',
 202                          'O3CPU', 'Activity','Scoreboard','Writeback' ],
 203     'OzoneCPUAll'    : [ 'BE', 'FE', 'IBE', 'OzoneLSQ', 'OzoneCPU' ],
 204     'ScsiAll'        : [ 'ScsiDisk', 'ScsiCtrl', 'ScsiNone' ]
 205 }
 206
 207 # extract just the compound flag names into a list
 208 compoundFlags = []
 209 compoundFlags.extend(compoundFlagMap.keys())
 210 compoundFlags.sort()
 211
 212 allFlags = frozenset(baseFlags + compoundFlags)
 213
 214 #############################################################
 215 #
 216 # Everything below this point generates the appropriate C++
 217 # declarations and definitions for the trace flags.  If you are simply
 218 # adding or modifying flag definitions, you should not have to change
 219 # anything below.
 220 #
 221 def gen_hh(filename):
 222     #
 223     # First generate the header file.  This defines the Flag enum
 224     # and some extern declarations for the .cc file.
 225     #
 226     try:
 227         hhfile = file(filename, 'w')
 228     except IOError, e:
 229         sys.exit("can't open %s: %s" % (hhfilename, e))
 230
 231     # file header boilerplate
 232     print >>hhfile, '''
 233     /*
 234      * DO NOT EDIT THIS FILE!
 235      *
 236      * Automatically generated from traceflags.py
 237      */
 238
 239     #ifndef __BASE_TRACE_FLAGS_HH__
 240     #define __BASE_TRACE_FLAGS_HH__
 241
 242     namespace Trace {
 243
 244     enum Flags {
 245     ''',
 246
 247     # Generate the enum.  Base flags come first, then compound flags.
 248     idx = 0
 249     for flag in baseFlags:
 250         print >>hhfile, '    %s = %d,' % (flag, idx)
 251         idx += 1
 252
 253     numBaseFlags = idx
 254     print >>hhfile, '    NumFlags = %d,' % idx
 255
 256     # put a comment in here to separate base from compound flags
 257     print >>hhfile, '''
 258         // The remaining enum values are *not* valid indices for Trace::flags.
 259         // They are "compound" flags, which correspond to sets of base
 260         // flags, and are used by changeFlag.
 261     ''',
 262
 263     for flag in compoundFlags:
 264         print >>hhfile, '    %s = %d,' % (flag, idx)
 265         idx += 1
 266
 267     numCompoundFlags = idx - numBaseFlags
 268     print >>hhfile, '    NumCompoundFlags = %d' % numCompoundFlags
 269
 270     # trailer boilerplate
 271     print >>hhfile, '''\
 272     }; // enum Flags
 273
 274     // Array of strings for SimpleEnumParam
 275     extern const char *flagStrings[];
 276     extern const int numFlagStrings;
 277
 278     // Array of arraay pointers: for each compound flag, gives the list of
 279     // base flags to set.  Inidividual flag arrays are terminated by -1.
 280     extern const Flags *compoundFlags[];
 281
 282     /* namespace Trace */ }
 283
 284     #endif // __BASE_TRACE_FLAGS_HH__
 285     \n''',
 286
 287     hhfile.close()
 288
 289 def gen_cc(filename):
 290     '''Print out .cc file with array definitions.'''
 291
 292     try:
 293         ccfile = file(filename, 'w')
 294     except OSError, e:
 295         sys.exit("can't open %s: %s" % (ccfilename, e))
 296
 297     # file header
 298     print >>ccfile, '''
 299 /*
 300  * DO NOT EDIT THIS FILE!
 301  *
 302  * Automatically generated from traceflags.pl.
 303  */
 304
 305 #include "base/traceflags.hh"
 306
 307 using namespace Trace;
 308
 309 const char *Trace::flagStrings[] =
 310 {
 311 ''',
 312
 313     # The string array is used by SimpleEnumParam to map the strings
 314     # provided by the user to enum values.
 315     for flag in baseFlags:
 316         print >>ccfile, '    "%s",' % flag
 317
 318     for flag in compoundFlags:
 319         print >>ccfile, '    "%s",' % flag
 320
 321     print >>ccfile, '};\n'
 322
 323     numFlagStrings = len(baseFlags) + len(compoundFlags);
 324
 325     print >>ccfile, 'const int Trace::numFlagStrings = %d;' % numFlagStrings
 326     print >>ccfile
 327
 328     #
 329     # Now define the individual compound flag arrays.  There is an array
 330     # for each compound flag listing the component base flags.
 331     #
 332
 333     for flag in compoundFlags:
 334         flags = compoundFlagMap[flag]
 335         flags.append('(Flags)-1')
 336         print >>ccfile, 'static const Flags %sMap[] =' % flag
 337         print >>ccfile, '{ %s };' % (', '.join(flags))
 338         print >>ccfile
 339
 340     #
 341     # Finally the compoundFlags[] array maps the compound flags
 342     # to their individual arrays/
 343     #
 344     print >>ccfile, 'const Flags *Trace::compoundFlags[] ='
 345     print >>ccfile, '{'
 346
 347     for flag in compoundFlags:
 348         print >>ccfile, '    %sMap,' % flag
 349
 350     # file trailer
 351     print >>ccfile, '};'
 352
 353     ccfile.close()