/*
 * Copyright (c) 2009 Mark D. Hill and David A. Wood
 * 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;
 * neither the name of the copyright holders nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * 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
 * OWNER 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 __MEM_RUBY_SLICC_INTERFACE_RUBY_REQUEST_HH__
#define __MEM_RUBY_SLICC_INTERFACE_RUBY_REQUEST_HH__

#include <ostream>

#include "mem/protocol/Message.hh"
#include "mem/protocol/PrefetchBit.hh"
#include "mem/protocol/RubyAccessMode.hh"
#include "mem/protocol/RubyRequestType.hh"
#include "mem/ruby/common/Address.hh"
#include "mem/packet.hh"

typedef void* RubyPortHandle;

class RubyRequest : public Message
{
  public:
    Address m_PhysicalAddress;
    Address m_LineAddress;
    RubyRequestType m_Type;
    Address m_ProgramCounter;
    RubyAccessMode m_AccessMode;
    int m_Size;
    PrefetchBit m_Prefetch;
    uint8_t* data;
    PacketPtr pkt;
    unsigned m_contextId;

    RubyRequest() {}
    RubyRequest(uint64_t _paddr, uint8_t* _data, int _len, uint64_t _pc,
                RubyRequestType _type, RubyAccessMode _access_mode,
                PacketPtr _pkt, PrefetchBit _pb = PrefetchBit_No,
                 unsigned _proc_id = 100)
        : m_PhysicalAddress(_paddr),
          m_Type(_type),
          m_ProgramCounter(_pc),
          m_AccessMode(_access_mode),
          m_Size(_len),
          m_Prefetch(_pb),
          data(_data),
          pkt(_pkt),
          m_contextId(_proc_id)
    {
      m_LineAddress = m_PhysicalAddress;
      m_LineAddress.makeLineAddress();
    }

    static RubyRequest*
    create()
    {
        return new RubyRequest();
    }

    RubyRequest*
    clone() const
    {
        return new RubyRequest(*this);
    }

    const Address&
    getLineAddress() const
    {
        return m_LineAddress;
    }

    const Address&
    getPhysicalAddress() const
    {
        return m_PhysicalAddress;
    }

    const RubyRequestType&
    getType() const
    {
        return m_Type;
    }

    const Address&
    getProgramCounter() const
    {
        return m_ProgramCounter;
    }

    const RubyAccessMode&
    getAccessMode() const
    {
      return m_AccessMode;
    }

    const int&
    getSize() const
    {
      return m_Size;
    }

    const PrefetchBit&
    getPrefetch() const
    {
      return m_Prefetch;
    }

    void print(std::ostream& out) const;
};

inline std::ostream&
operator<<(std::ostream& out, const RubyRequest& obj)
{
  obj.print(out);
  out << std::flush;
  return out;
}

#endif
