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