mem: Use shared_ptr for Ruby Message classes

This patch transitions the Ruby Message and its derived classes from
the ad-hoc RefCountingPtr to the c++11 shared_ptr. There are no
changes in behaviour, and the code modifications are mainly replacing
"new" with "make_shared".

The cloning of derived messages is slightly changed as they previously
relied on overriding the base-class through covariant return types.

src/mem/ruby/slicc_interface/Message.hh

@@ -30,14 +30,14 @@
 #define __MEM_RUBY_SLICC_INTERFACE_MESSAGE_HH__
 
 #include <iostream>
+#include <memory>
 
-#include "base/refcnt.hh"
 #include "mem/packet.hh"
 
 class Message;
-typedef RefCountingPtr<Message> MsgPtr;
+typedef std::shared_ptr<Message> MsgPtr;
 
-class Message : public RefCounted
+class Message
 {
   public:
     Message(Tick curTime)
@@ -54,7 +54,7 @@ class Message : public RefCounted
 
     virtual ~Message() { }
 
-    virtual Message* clone() const = 0;
+    virtual MsgPtr clone() const = 0;
     virtual void print(std::ostream& out) const = 0;
     virtual void setIncomingLink(int) {}
     virtual void setVnet(int) {}

src/mem/ruby/slicc_interface/NetworkMessage.hh

@@ -30,13 +30,14 @@
 #define __MEM_RUBY_SLICC_INTERFACE_NETWORKMESSAGE_HH__
 
 #include <iostream>
+#include <memory>
 
 #include "mem/protocol/MessageSizeType.hh"
 #include "mem/ruby/common/NetDest.hh"
 #include "mem/ruby/slicc_interface/Message.hh"
 
 class NetworkMessage;
-typedef RefCountingPtr<NetworkMessage> NetMsgPtr;
+typedef std::shared_ptr<NetworkMessage> NetMsgPtr;
 
 class NetworkMessage : public Message
 {

src/mem/ruby/slicc_interface/RubyRequest.hh

@@ -71,7 +71,8 @@ class RubyRequest : public Message
     }
 
     RubyRequest(Tick curTime) : Message(curTime) {}
-    RubyRequest* clone() const { return new RubyRequest(*this); }
+    MsgPtr clone() const
+    { return std::shared_ptr<Message>(new RubyRequest(*this)); }
 
     const Address& getLineAddress() const { return m_LineAddress; }
     const Address& getPhysicalAddress() const { return m_PhysicalAddress; }

src/mem/ruby/system/DMASequencer.cc

@@ -26,6 +26,8 @@
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
+#include <memory>
+
 #include "debug/RubyDma.hh"
 #include "debug/RubyStats.hh"
 #include "mem/protocol/SequencerMsg.hh"
@@ -69,7 +71,8 @@ DMASequencer::makeRequest(PacketPtr pkt)
     active_request.bytes_issued = 0;
     active_request.pkt = pkt;
 
-    SequencerMsg *msg = new SequencerMsg(clockEdge());
+    std::shared_ptr<SequencerMsg> msg =
+        std::make_shared<SequencerMsg>(clockEdge());
     msg->getPhysicalAddress() = Address(paddr);
     msg->getLineAddress() = line_address(msg->getPhysicalAddress());
     msg->getType() = write ? SequencerRequestType_ST : SequencerRequestType_LD;
@@ -107,7 +110,8 @@ DMASequencer::issueNext()
         return;
     }
 
-    SequencerMsg *msg = new SequencerMsg(clockEdge());
+    std::shared_ptr<SequencerMsg> msg =
+        std::make_shared<SequencerMsg>(clockEdge());
     msg->getPhysicalAddress() = Address(active_request.start_paddr +
                                        active_request.bytes_completed);
 

src/mem/ruby/system/DMASequencer.hh

@@ -30,6 +30,7 @@
 #define __MEM_RUBY_SYSTEM_DMASEQUENCER_HH__
 
 #include <ostream>
+#include <memory>
 
 #include "mem/protocol/DMASequencerRequestType.hh"
 #include "mem/ruby/common/DataBlock.hh"

src/mem/ruby/system/Sequencer.cc

@@ -679,11 +679,12 @@ Sequencer::issueRequest(PacketPtr pkt, RubyRequestType secondary_type)
         pc = pkt->req->getPC();
     }
 
-    RubyRequest *msg = new RubyRequest(clockEdge(), pkt->getAddr(),
-                                       pkt->getPtr<uint8_t>(true),
-                                       pkt->getSize(), pc, secondary_type,
-                                       RubyAccessMode_Supervisor, pkt,
-                                       PrefetchBit_No, proc_id);
+    std::shared_ptr<RubyRequest> msg =
+        std::make_shared<RubyRequest>(clockEdge(), pkt->getAddr(),
+                                      pkt->getPtr<uint8_t>(true),
+                                      pkt->getSize(), pc, secondary_type,
+                                      RubyAccessMode_Supervisor, pkt,
+                                      PrefetchBit_No, proc_id);
 
     DPRINTFR(ProtocolTrace, "%15s %3s %10s%20s %6s>%-6s %s %s\n",
             curTick(), m_version, "Seq", "Begin", "", "",

src/mem/slicc/ast/EnqueueStatementAST.py

@@ -54,8 +54,8 @@ class EnqueueStatementAST(StatementAST):
         self.symtab.newSymbol(v)
 
         # Declare message
-        code("${{msg_type.ident}} *out_msg = "\
-             "new ${{msg_type.ident}}(clockEdge());")
+        code("std::shared_ptr<${{msg_type.ident}}> out_msg = "\
+             "std::make_shared<${{msg_type.ident}}>(clockEdge());")
 
         # The other statements
         t = self.statements.generate(code, None)

src/mem/slicc/symbols/Type.py

@@ -283,7 +283,16 @@ $klass ${{self.c_ident}}$parent
             code('}')
 
         # create a clone member
-        code('''
+        if self.isMessage:
+            code('''
+MsgPtr
+clone() const
+{
+     return std::shared_ptr<Message>(new ${{self.c_ident}}(*this));
+}
+''')
+        else:
+            code('''
 ${{self.c_ident}}*
 clone() const
 {
@@ -391,6 +400,7 @@ operator<<(std::ostream& out, const ${{self.c_ident}}& obj)
  */
 
 #include <iostream>
+#include <memory>
 
 #include "mem/protocol/${{self.c_ident}}.hh"
 #include "mem/ruby/common/Global.hh"