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