Transaction.h

/*********************************************************************************
*  Copyright (c) 2010-2011, Elliott Cooper-Balis
*                             Paul Rosenfeld
*                             Bruce Jacob
*                             University of Maryland 
*                             dramninjas [at] gmail [dot] com
*  All rights reserved.
*  
*  Redistribution and use in source and binary forms, with or without
*  modification, are permitted provided that the following conditions are met:
*  
*     * Redistributions of source code must retain the above copyright notice,
*        this list of conditions and the following disclaimer.
*  
*     * Redistributions in binary form must reproduce the above copyright notice,
*        this list of conditions and the following disclaimer in the documentation
*        and/or other materials provided with the distribution.
*  
*  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
*  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
*  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
*  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
*  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
*  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
*  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
*  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
*  OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
*  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*********************************************************************************/

#ifndef TRANSACTION_H
#define TRANSACTION_H

#include "SystemConfiguration.h"
#include "BusPacket.h"

using std::ostream; 

namespace DRAMSim {
enum TransactionType
{
  DATA_READ,
  DATA_WRITE,
  RETURN_DATA
};

class Transaction
{
  private:
    Transaction();

  public:
    friend ostream &operator<<(ostream &os, const Transaction &t);

    Transaction(TransactionType transType, uint64_t addr, void *data);
    Transaction(const Transaction &t);

    BusPacketType getBusPacketType()
    {
      BusPacketType busPacketType = INVALID;
      switch (transactionType) {
        case DATA_READ:
          if (rowBufferPolicy == ClosePage)
            busPacketType = READ_P;
          else if (rowBufferPolicy == OpenPage)
            busPacketType = READ; 
          break;

        case DATA_WRITE:
          if (rowBufferPolicy == ClosePage)
            busPacketType = WRITE_P;
          else if (rowBufferPolicy == OpenPage)
            busPacketType = WRITE; 
          break;

        default:
          ERROR("This transaction type doesn't have a corresponding bus packet type");
          abort();
          break;
      }

      return busPacketType;
    }

    TransactionType getTransactionType() { return transactionType; }
    uint64_t getAddress() { return address; }
    void *getData() { return data; }

    void setTimeAdded(uint64_t t) { timeAdded = t; }
    void setTimeReturned(uint64_t t) { timeReturned = t; }
    uint64_t getTimeAdded() { return timeAdded; }
    uint64_t getTImeReturned() { return timeReturned; }

  private:
    TransactionType transactionType;
    uint64_t address;
    void *data;
    uint64_t timeAdded;
    uint64_t timeReturned;
}; //class Transaction
} //namespace DRAMSim

#endif