Merge pull request #716 from AndrewGoodrich/issue110

Issue110: tlm hierarchical binding

Author: lmailletcontoz

src/sysc/communication/sc_communication_ids.h

@@ -101,8 +101,8 @@ SC_DEFINE_MESSAGE( SC_ID_ATTEMPT_TO_WRITE_TO_CLOCK_,  125,
    "attempt to write the value of an sc_clock instance" )
 SC_DEFINE_MESSAGE( SC_ID_SC_EXPORT_ALREADY_BOUND_,  126,
     "sc_export instance already bound" )
-SC_DEFINE_MESSAGE( SC_ID_OPERATION_ON_NON_SPECIALIZED_SIGNAL_,  127,
-    "attempted specalized signal operation on non-specialized signal" )
+SC_DEFINE_MESSAGE( SC_ID_INVALID_HIERARCHICAL_BIND_,  127,
+    "attempt to bind a multi-target socket to a non-multi-target socket" )
 SC_DEFINE_MESSAGE( SC_ID_ATTEMPT_TO_BIND_CLOCK_TO_OUTPUT_,  128,
     "attempted to bind sc_clock instance to sc_inout or sc_out" )
 SC_DEFINE_MESSAGE( SC_ID_INSERT_STUB_,  129,

src/sysc/utils/sc_report_handler.cpp

@@ -788,14 +788,14 @@ sc_actions sc_report_handler::get_catch_actions()
 // predefined messages
 //
 
-const char SC_ID_REGISTER_ID_FAILED_[] = "register_id failed";
-const char SC_ID_UNKNOWN_ERROR_[]      = "unknown error";
-const char SC_ID_WITHOUT_MESSAGE_[]    = "";
-const char SC_ID_NOT_IMPLEMENTED_[]    = "not implemented";
-const char SC_ID_INTERNAL_ERROR_[]     = "internal error";
-const char SC_ID_ASSERTION_FAILED_[]   = "assertion failed";
-const char SC_ID_OUT_OF_BOUNDS_[]      = "out of bounds";
-const char SC_ID_ABORT_[]              = "simulation aborted";
+const char SC_ID_REGISTER_ID_FAILED_[]  = "register_id failed";
+const char SC_ID_UNKNOWN_ERROR_[]       = "unknown error";
+const char SC_ID_WITHOUT_MESSAGE_[]     = "";
+const char SC_ID_NOT_IMPLEMENTED_[]     = "not implemented";
+const char SC_ID_INTERNAL_ERROR_[]      = "internal error";
+const char SC_ID_ASSERTION_FAILED_[]    = "assertion failed";
+const char SC_ID_OUT_OF_BOUNDS_[]       = "out of bounds";
+const char SC_ID_ABORT_[]               = "simulation aborted";
 
 #define DEFINE_MSG(id,n)                                                     \
     {                                                                        \

src/tlm_core/tlm_2/tlm_sockets/tlm_target_socket.h

@@ -22,7 +22,7 @@
 
 #include "tlm_core/tlm_2/tlm_sockets/tlm_base_socket_if.h"
 #include "tlm_core/tlm_2/tlm_2_interfaces/tlm_fw_bw_ifs.h"
-
+#include "sysc/communication/sc_communication_ids.h"
 
 namespace tlm {
 
@@ -123,15 +123,38 @@ class tlm_base_target_socket : public tlm_base_target_socket_b<BUSWIDTH, FW_IF,
     bind(s);
   }
 
+  
+  // "tlm_base_target_socket<>::bind(tlm_base_target_socket<>)"
+  //
+  // Bind a target socket to this object instance (target socket), a hierarchical bind. 
+  // The bind is done to both the port and export.
   //
-  // Bind target socket to target socket (hierarchical bind)
-  // - Binds both the export and the port
+  // Arguments:
+  //   s = socket to be bound to this object instance.
   //
+  // Notes:
+  //   (1) IEEE 1666 forbids the hierarchical bind of a multi-target socket to a non-multi-target
+  //       socket, so we check if the object to be bound is multi-target and this object instance 
+  //       is not multi-target.
+  //   (2) The opposite hierarchical bind, a non-multi-target socket to a multi-target socket 
+  //       will result in a compiler error, so we don't need to check that case.
+
   virtual void bind(base_type& s)
   {
-    // export
+    // Look for an illegal bind (see note 1 above.)
+
+    if ( s.get_socket_category() == tlm::TLM_MULTI_TARGET_SOCKET ) {
+      if ( tlm::TLM_MULTI_TARGET_SOCKET != get_socket_category() ) {
+        SC_REPORT_ERROR(sc_core::SC_ID_INVALID_HIERARCHICAL_BIND_, this->name());
+      }
+    }
+
+    // bind the exports
+
     (get_base_export())(s.get_base_export());
-    // port
+
+    // bind the ports
+
     (s.get_base_port())(get_base_port());
   }