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