Message.hh revision 7973:e5550966464a 
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 "base/refcnt.hh"
35#include "mem/ruby/common/Global.hh"
36#include "mem/ruby/eventqueue/RubyEventQueue.hh"
37
38class Message;
39typedef RefCountingPtr<Message> MsgPtr;
40
41class Message : public RefCounted
42{
43  public:
44    Message()
45        : m_time(g_eventQueue_ptr->getTime()),
46          m_LastEnqueueTime(g_eventQueue_ptr->getTime()),
47          m_DelayedCycles(0)
48    { }
49
50    Message(const Message &other)
51        : m_time(other.m_time),
52          m_LastEnqueueTime(other.m_LastEnqueueTime),
53          m_DelayedCycles(other.m_DelayedCycles)
54    { }
55
56    virtual ~Message() { }
57
58    virtual Message* clone() const = 0;
59    virtual void print(std::ostream& out) const = 0;
60    virtual void setIncomingLink(int) {}
61    virtual void setVnet(int) {}
62
63    void setDelayedCycles(const int& cycles) { m_DelayedCycles = cycles; }
64    const int& getDelayedCycles() const {return m_DelayedCycles;}
65    int& getDelayedCycles() {return m_DelayedCycles;}
66    void setLastEnqueueTime(const Time& time) { m_LastEnqueueTime = time; }
67    const Time& getLastEnqueueTime() const {return m_LastEnqueueTime;}
68    Time& getLastEnqueueTime() {return m_LastEnqueueTime;}
69
70    const Time& getTime() const { return m_time; }
71    void setTime(const Time& new_time) { m_time = new_time; }
72
73  private:
74    Time m_time;
75    Time m_LastEnqueueTime; // my last enqueue time
76    int m_DelayedCycles; // my delayed cycles
77};
78
79inline std::ostream&
80operator<<(std::ostream& out, const Message& obj)
81{
82    obj.print(out);
83    out << std::flush;
84    return out;
85}
86
87#endif // __MEM_RUBY_SLICC_INTERFACE_MESSAGE_HH__
88