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