Message.hh revision 7039:bc0b6ea676b5 
1/*
2 * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met: redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer;
9 * redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution;
12 * neither the name of the copyright holders nor the names of its
13 * contributors may be used to endorse or promote products derived from
14 * this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29#ifndef __MEM_RUBY_SLICC_INTERFACE_MESSAGE_HH__
30#define __MEM_RUBY_SLICC_INTERFACE_MESSAGE_HH__
31
32#include <iostream>
33
34#include "mem/gems_common/RefCnt.hh"
35#include "mem/gems_common/RefCountable.hh"
36#include "mem/ruby/common/Global.hh"
37#include "mem/ruby/eventqueue/RubyEventQueue.hh"
38
39class Message;
40typedef RefCnt<Message> MsgPtr;
41
42class Message : public RefCountable
43{
44  public:
45    Message()
46        : RefCountable()
47    {
48        m_time = g_eventQueue_ptr->getTime();
49        m_LastEnqueueTime = g_eventQueue_ptr->getTime();
50        m_DelayedCycles = 0;
51    }
52
53    virtual ~Message() { }
54
55    virtual Message* clone() const = 0;
56    virtual void destroy() = 0;
57    virtual void print(std::ostream& out) const = 0;
58
59    void setDelayedCycles(const int& cycles) { m_DelayedCycles = cycles; }
60    const int& getDelayedCycles() const {return m_DelayedCycles;}
61    int& getDelayedCycles() {return m_DelayedCycles;}
62    void setLastEnqueueTime(const Time& time) { m_LastEnqueueTime = time; }
63    const Time& getLastEnqueueTime() const {return m_LastEnqueueTime;}
64    Time& getLastEnqueueTime() {return m_LastEnqueueTime;}
65
66    const Time& getTime() const { return m_time; }
67    void setTime(const Time& new_time) { m_time = new_time; }
68
69  private:
70    Time m_time;
71    Time m_LastEnqueueTime; // my last enqueue time
72    int m_DelayedCycles; // my delayed cycles
73};
74
75inline std::ostream&
76operator<<(std::ostream& out, const Message& obj)
77{
78    obj.print(out);
79    out << std::flush;
80    return out;
81}
82
83#endif // __MEM_RUBY_SLICC_INTERFACE_MESSAGE_HH__
84