sam-t2/sam/devices/common/regdef/include/Trace.h

/*
* ========== Copyright Header Begin ==========================================
*
* OpenSPARC T2 Processor File: Trace.h
* Copyright (c) 2006 Sun Microsystems, Inc.  All Rights Reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES.
*
* The above named program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public
* License version 2 as published by the Free Software Foundation.
*
* The above named program is distributed in the hope that it will be
* useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public
* License along with this work; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
*
* ========== Copyright Header End ============================================
*/
#ifndef __Trace_h
#define __Trace_h

#include "Datatype.h"

/** @file Trace.h
 *  Trace.h provides classes to assist tracing of model state.
 *
 *  @sa Trace_Module
 */

/** @defgroup Trace_Module The Trace Module
 *
 *  Trace.h provides two classes to assist tracing of model state.
 *  Trace defines constants to identify the different kinds of trace
 *  that are supported. Traceable is the base class for every class
 *  that can be traced
 *
 *  @{
 */

/** Trace defines constants to identify the different kinds of trace
 *  that are supported. These constants are used to filter the trace.
 *  Note that small register arrays can be traced if selected, but large
 *  register arrays are never traced. The break-point between whether a
 *  register array is considered small or large is specified in Register.h.
 *  This distinction is necessary because some simulation models use
 *  very large register arrays, and these are very inconvenient for the
 *  trace file format and trace file viewer.
 */

class Trace
{
public:
  static const unsigned PORTS = 0x1;           /**< Trace Ports. */
  static const unsigned SIGNALS = 0x2;         /**< Trace Signals. */
  static const unsigned REGISTERS = 0x4;       /**< Trace scalar Registers. */
  static const unsigned REGISTER_ARRAYS = 0x8; /**< Trace arrays of
                                                    Registers. */
  static const unsigned DEFAULT = 0xF;         /**< Trace the default set. */
  static const unsigned EVERYTHING = 0xF;      /**< Trace everything. */
};

/** Traceable is the base class for every class that can be traced. This
 *  class allocates unique Trace identifiers to each instance of a
 *  traceable class. These identifiers are used in the output trace file.
 */

class Traceable
{
public:
  /** Constructor for Traceable. It allocates the traceId for this object. */
  Traceable();

  /** Get the traceId for this object. */
  Identifier getTraceId() { return traceId; }

private:
  Identifier traceId;
  static Identifier nextTraceId;
};

/** @} */

#endif