base/traceflags.py

   1 #!/usr/bin/env python
   2
   3 # Copyright (c) 2004 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     'Dispatch',
 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     ]
 128
 129 #
 130 # "Compound" flags correspond to a set of base flags.  These exist
 131 # solely for convenience in setting them via the command line: if a
 132 # compound flag is specified, all of the corresponding base flags are
 133 # set.  Compound flags cannot be used directly in DPRINTFs etc.
 134 # To define a new compound flag, add a new entry to this hash
 135 # following the existing examples.
 136 #
 137 compoundFlagMap = {
 138     'GDBAll' : [ 'GDBMisc', 'GDBAcc', 'GDBRead', 'GDBWrite', 'GDBSend', 'GDBRecv', 'GDBExtra' ],
 139     'ScsiAll' : [ 'ScsiDisk', 'ScsiCtrl', 'ScsiNone' ],
 140     'DiskImageAll' : [ 'DiskImage', 'DiskImageRead', 'DiskImageWrite' ],
 141     'EthernetAll' : [ 'Ethernet', 'EthernetPIO', 'EthernetDMA', 'EthernetData' , 'EthernetDesc', 'EthernetIntr', 'EthernetSM', 'EthernetCksum' ],
 142     'IdeAll' : [ 'IdeCtrl', 'IdeDisk' ]
 143 }
 144
 145 #############################################################
 146 #
 147 # Everything below this point generates the appropriate C++
 148 # declarations and definitions for the trace flags.  If you are simply
 149 # adding or modifying flag definitions, you should not have to change
 150 # anything below.
 151 #
 152
 153 import sys
 154
 155 # extract just the compound flag names into a list
 156 compoundFlags = []
 157 compoundFlags.extend(compoundFlagMap.keys())
 158 compoundFlags.sort()
 159
 160 #
 161 # First generate the header file.  This defines the Flag enum
 162 # and some extern declarations for the .cc file.
 163 #
 164 try:
 165     hhfile = file(hhfilename, 'w')
 166 except IOError, e:
 167     sys.exit("can't open %s: %s" % (hhfilename, e))
 168
 169 # file header boilerplate
 170 print >>hhfile, '''/* $Id $ */
 171
 172 /*
 173  * Copyright (c) 2004
 174  * The Regents of The University of Michigan
 175  * All Rights Reserved
 176  *
 177  * This code is part of the M5 simulator, developed by Nathan Binkert,
 178  * Erik Hallnor, Steve Raasch, and Steve Reinhardt, with contributions
 179  * from Ron Dreslinski, Dave Greene, and Lisa Hsu.
 180  *
 181  * Permission is granted to use, copy, create derivative works and
 182  * redistribute this software and such derivative works for any
 183  * purpose, so long as the copyright notice above, this grant of
 184  * permission, and the disclaimer below appear in all copies made; and
 185  * so long as the name of The University of Michigan is not used in
 186  * any advertising or publicity pertaining to the use or distribution
 187  * of this software without specific, written prior authorization.
 188  *
 189  * THIS SOFTWARE IS PROVIDED AS IS, WITHOUT REPRESENTATION FROM THE
 190  * UNIVERSITY OF MICHIGAN AS TO ITS FITNESS FOR ANY PURPOSE, AND
 191  * WITHOUT WARRANTY BY THE UNIVERSITY OF MICHIGAN OF ANY KIND, EITHER
 192  * EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED
 193  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 194  * PURPOSE. THE REGENTS OF THE UNIVERSITY OF MICHIGAN SHALL NOT BE
 195  * LIABLE FOR ANY DAMAGES, INCLUDING DIRECT, SPECIAL, INDIRECT,
 196  * INCIDENTAL, OR CONSEQUENTIAL DAMAGES, WITH RESPECT TO ANY CLAIM
 197  * ARISING OUT OF OR IN CONNECTION WITH THE USE OF THE SOFTWARE, EVEN
 198  * IF IT HAS BEEN OR IS HEREAFTER ADVISED OF THE POSSIBILITY OF SUCH
 199  * DAMAGES.
 200  */
 201
 202 /*
 203  * DO NOT EDIT THIS FILE!
 204  *
 205  * Automatically generated from traceflags.py
 206  */
 207
 208 #ifndef __BASE_TRACE_FLAGS_HH__
 209 #define __BASE_TRACE_FLAGS_HH__
 210
 211 namespace Trace {
 212
 213 enum Flags {
 214 ''',
 215
 216 # Generate the enum.  Base flags come first, then compound flags.
 217 idx = 0
 218 for flag in baseFlags:
 219     print >>hhfile, '    %s = %d,' % (flag, idx)
 220     idx += 1
 221
 222 numBaseFlags = idx
 223 print >>hhfile, '    NumFlags = %d,' % idx
 224
 225 # put a comment in here to separate base from compound flags
 226 print >>hhfile, '''
 227     // The remaining enum values are *not* valid indices for Trace::flags.
 228     // They are "compound" flags, which correspond to sets of base
 229     // flags, and are used only by TraceParamContext::setFlags().
 230 ''',
 231
 232 for flag in compoundFlags:
 233     print >>hhfile, '    %s = %d,' % (flag, idx)
 234     idx += 1
 235
 236 numCompoundFlags = idx - numBaseFlags
 237 print >>hhfile, '    NumCompoundFlags = %d' % numCompoundFlags
 238
 239 # trailer boilerplate
 240 print >>hhfile, '''\
 241 }; // enum Flags
 242
 243 // Array of strings for SimpleEnumParam
 244 extern const char *flagStrings[];
 245 extern const int numFlagStrings;
 246
 247 // Array of arraay pointers: for each compound flag, gives the list of
 248 // base flags to set.  Inidividual flag arrays are terminated by -1.
 249 extern const Flags *compoundFlags[];
 250
 251 /* namespace Trace */ }
 252
 253 #endif // __BASE_TRACE_FLAGS_HH__
 254 ''',
 255
 256 hhfile.close()
 257
 258 #
 259 #
 260 # Print out .cc file with array definitions.
 261 #
 262 #
 263 try:
 264     ccfile = file(ccfilename, 'w')
 265 except OSError, e:
 266     sys.exit("can't open %s: %s" % (ccfilename, e))
 267
 268 # file header
 269 print >>ccfile, '''\
 270 /* $Id $ */
 271
 272 /*
 273  * Copyright (c) 2004
 274  * The Regents of The University of Michigan
 275  * All Rights Reserved
 276  *
 277  * This code is part of the M5 simulator, developed by Nathan Binkert,
 278  * Erik Hallnor, Steve Raasch, and Steve Reinhardt, with contributions
 279  * from Ron Dreslinski, Dave Greene, and Lisa Hsu.
 280  *
 281  * Permission is granted to use, copy, create derivative works and
 282  * redistribute this software and such derivative works for any
 283  * purpose, so long as the copyright notice above, this grant of
 284  * permission, and the disclaimer below appear in all copies made; and
 285  * so long as the name of The University of Michigan is not used in
 286  * any advertising or publicity pertaining to the use or distribution
 287  * of this software without specific, written prior authorization.
 288  *
 289  * THIS SOFTWARE IS PROVIDED AS IS, WITHOUT REPRESENTATION FROM THE
 290  * UNIVERSITY OF MICHIGAN AS TO ITS FITNESS FOR ANY PURPOSE, AND
 291  * WITHOUT WARRANTY BY THE UNIVERSITY OF MICHIGAN OF ANY KIND, EITHER
 292  * EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED
 293  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 294  * PURPOSE. THE REGENTS OF THE UNIVERSITY OF MICHIGAN SHALL NOT BE
 295  * LIABLE FOR ANY DAMAGES, INCLUDING DIRECT, SPECIAL, INDIRECT,
 296  * INCIDENTAL, OR CONSEQUENTIAL DAMAGES, WITH RESPECT TO ANY CLAIM
 297  * ARISING OUT OF OR IN CONNECTION WITH THE USE OF THE SOFTWARE, EVEN
 298  * IF IT HAS BEEN OR IS HEREAFTER ADVISED OF THE POSSIBILITY OF SUCH
 299  * DAMAGES.
 300  */
 301
 302 /*
 303  * DO NOT EDIT THIS FILE!
 304  *
 305  * Automatically generated from traceflags.pl.
 306  */
 307
 308 #include "base/traceflags.hh"
 309
 310 using namespace Trace;
 311
 312 const char *Trace::flagStrings[] =
 313 {
 314 ''',
 315
 316 # The string array is used by SimpleEnumParam to map the strings
 317 # provided by the user to enum values.
 318 for flag in baseFlags:
 319     print >>ccfile, '    "%s",' % flag
 320
 321 for flag in compoundFlags:
 322     print >>ccfile, '    "%s",' % flag
 323
 324 print >>ccfile, '};\n'
 325
 326 numFlagStrings = len(baseFlags) + len(compoundFlags);
 327
 328 print >>ccfile, 'const int Trace::numFlagStrings = %d;' % numFlagStrings
 329 print >>ccfile
 330
 331 #
 332 # Now define the individual compound flag arrays.  There is an array
 333 # for each compound flag listing the component base flags.
 334 #
 335
 336 for flag in compoundFlags:
 337     flags = compoundFlagMap[flag]
 338     flags.append('(Flags)-1')
 339     print >>ccfile, 'static const Flags %sMap[] =' % flag
 340     print >>ccfile, '{ %s };' % (', '.join(flags))
 341     print >>ccfile
 342
 343 #
 344 # Finally the compoundFlags[] array maps the compound flags
 345 # to their individual arrays/
 346 #
 347 print >>ccfile, 'const Flags *Trace::compoundFlags[] ='
 348 print >>ccfile, '{'
 349
 350 for flag in compoundFlags:
 351     print >>ccfile, '    %sMap,' % flag
 352
 353 # file trailer
 354 print >>ccfile, '};'
 355
 356 ccfile.close()
 357