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