src/mem/ruby/common/Debug.py

   1 # Copyright (c) 2009 Advanced Micro Devices, Inc.
   2 # All rights reserved.
   3 #
   4 # Redistribution and use in source and binary forms, with or without
   5 # modification, are permitted provided that the following conditions are
   6 # met: redistributions of source code must retain the above copyright
   7 # notice, this list of conditions and the following disclaimer;
   8 # redistributions in binary form must reproduce the above copyright
   9 # notice, this list of conditions and the following disclaimer in the
  10 # documentation and/or other materials provided with the distribution;
  11 # neither the name of the copyright holders nor the names of its
  12 # contributors may be used to endorse or promote products derived from
  13 # this software without specific prior written permission.
  14 #
  15 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  16 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  17 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  18 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  19 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  20 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  21 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  22 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  23 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  25 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26 #
  27 # Authors: Steve Reinhardt
  28 #          Brad Beckmann
  29
  30 from m5.params import *
  31 from m5.SimObject import SimObject
  32
  33 class RubyDebug(SimObject):
  34     type = 'RubyDebug'
  35     cxx_class = 'Debug'
  36
  37     filter_string = Param.String('none',
  38         "a string for filtering debugging output (see Debug.h)")
  39     verbosity_string = Param.String('none',
  40         "filters debugging messages based on priority (low, med, high)")
  41     output_filename = Param.String('none',
  42         "sends debugging messages to a file")
  43     start_time = Param.Tick(1,
  44         "filters debugging messages based on a ruby time")
  45     # For debugging purposes, one can enable a trace of all the protocol
  46     # state machine changes. Unfortunately, the code to generate the
  47     # trace is protocol specific. To enable the code for some of the
  48     # standard protocols,
  49     #   1. change protocol_trace = true
  50     #   2. enable debug in the Ruby Makefile
  51     protocol_trace = Param.Bool(False,
  52         "enable protocol state machine trace")