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