Initial commit of OpenSPARC T2 architecture model.

[OpenSPARC-T2-SAM] / sam-t2 / sam / cpus / vonk / ss / api / memsync / src / MemorySyncMessage.h

/*
* ========== Copyright Header Begin ==========================================
* 
* OpenSPARC T2 Processor File: MemorySyncMessage.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 _MEMSYNCMESSAGE_H
#define _MEMSYNCMESSAGE_H
/************************************************************************
**  
**  Copyright (C) 2002, Sun Microsystems, Inc.
**
**  Sun considers its source code as an unpublished, proprietary
**  trade secret and it is available only under strict license provisions.
**  This copyright notice is placed here only to protect Sun in the event 
**  the source is deemed a published work. Disassembly, decompilation,
**  or other means of reducing the object code to human readable form
**  is prohibited by the license agreement under which this code is
**  provided to the user or company in possession of this copy."
**
*************************************************************************/
#include <iostream>
#include <cstdlib>
// #include <stdio.h>
// #include <stdlib.h>

#define MS_ERROR( ... ) \
  if (MemorySyncMessage::skipCallback == 0) { \
          MemorySyncMessage::skipCallback = 1; \
  } \
  MemorySyncMessage::error( __VA_ARGS__ ); \
  cerr << MemorySyncMessage::dumpBuffers();

#define MSYNC_DEBUG( dbxLevel, ... ) \
   if (MemorySyncMessage::debugLevel >= dbxLevel) { \
       MemorySyncMessage::debug(dbxLevel, __VA_ARGS__ ); \
   } 


 class MemorySyncMessage {
 public:
     static std::string dumpBuffers();

 public:
   /**
    * Default constructor
    */
   MemorySyncMessage();
   
   /**
    * Copy constructor
    * 
    * @param orig The MemorySyncMessage object to copy.
    */
   MemorySyncMessage( const MemorySyncMessage &orig );
   
   /**
    * Destructor
    */
   virtual ~MemorySyncMessage();
   
   /**
    * Equality operator
    * 
    * @param rhs The right hand side of the equality operator
    * @return Return true if this objec and rhs are equal, 
    * otherwise return false
    */
   bool operator==( const MemorySyncMessage &rhs ) const;
   
   /**
    * Assignment operator
    * 
    * @param rhs The right hand side of the assignment operator.
    * @return The lvalue of the assignment.
    */
   const MemorySyncMessage & operator=( const MemorySyncMessage &rhs );
   
   /**
    * Return a string representation of this MemorySyncMessage object. 
    */
   std::string toString() const;
   
   static void msmAssert (const char *fmt, ...);
   static void warning (const char *fmt, ...);
   static void error   (const char *fmt, ...);
   static void debug   (uint level, const char *fmt, ...);
   
   static uint64_t rtlCycle;   
   static int      debugLevel;
   static int      skipCallback;

};

#endif /* _MEMSYNCMESSAGE_H */