added unit test to demonstrate Jack <->Multiconnector problem
[senf.git] / senf / PPI / Connectors.cc
index debe7ec..9b0232d 100644 (file)
 #include "Connectors.ih"
 
 // Custom includes
-#include "Route.hh"
-#include "Module.hh"
 #include "ModuleManager.hh"
-#include <senf/Utils/Console/Console.hh>
+#include <senf/Utils/Console/ParsedCommand.hh>
 
 //#include "Connectors.mpp"
 #define prefix_
-///////////////////////////////cc.p////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 
-///////////////////////////////////////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 // senf::ppi::connector::Connector
 
+prefix_ senf::ppi::connector::Connector::~Connector()
+{
+    if (connected()) {
+        Connector & peer (*peer_);
+        peer_->peer_ = 0;
+        if (! peer.initializationScheduled())
+            peer.enqueueInitializable();
+        peer.v_disconnected();
+    }
+}
+
 prefix_ void senf::ppi::connector::Connector::connect(Connector & target)
 {
     // The connector is not registered -> route() or noroute() statement missing
-    SENF_ASSERT( module_ && 
+    SENF_ASSERT( module_,
                  "senf::ppi::connector::Connector::connect(): (source) "
                  "Missing route() or noroute()" );
     // The connector is already connected
-    SENF_ASSERT( ! peer_ &&
+    SENF_ASSERT( ! peer_,
                  "senf::ppi::connector::Connector::connect(): (source) "
                  "duplicate connection" );
     // The target connector is not registered -> route() or noroute() statement missing
-    SENF_ASSERT( target.module_ &&
+    SENF_ASSERT( target.module_,
                  "senf::ppi::connector::Connector::connect(): (target) "
                  "Missing route() or noroute()" );
     // The target connector is already connected
-    SENF_ASSERT( ! target.peer_ &&
+    SENF_ASSERT( ! target.peer_,
                  "senf::ppi::connector::Connector::connect(): (target) "
                  "duplicate connection" );
+
     if (! (packetTypeID() == typeid(void) ||
-           target.packetTypeID() == typeid(void) || 
+           target.packetTypeID() == typeid(void) ||
            packetTypeID() == target.packetTypeID()) )
-        throw IncompatibleConnectorsException() 
-            << ": " << prettyName(packetTypeID()) 
+        throw IncompatibleConnectorsException()
+            << ": " << prettyName(packetTypeID())
             << " [in module " << prettyName(typeid(*module_))  << "] "
             << ", " << prettyName(target.packetTypeID())
             << " [in module " << prettyName(typeid(*target.module_)) << "]";
-            
+
     peer_ = & target;
     target.peer_ = this;
 
@@ -73,6 +83,10 @@ prefix_ void senf::ppi::connector::Connector::connect(Connector & target)
         enqueueInitializable();
     if (! peer().initializationScheduled())
         peer().enqueueInitializable();
+
+    v_connected();
+    peer_->v_connected();
+
 }
 
 senf::ppi::connector::Connector::TraceState senf::ppi::connector::Connector::traceState_ (
@@ -80,12 +94,12 @@ senf::ppi::connector::Connector::TraceState senf::ppi::connector::Connector::tra
 
 prefix_ void senf::ppi::connector::Connector::trace(Packet const & p, char const * label)
 {
-    if (traceState_ ==  NO_TRACING)
+    if (traceState_ == NO_TRACING)
         return;
     SENF_LOG_BLOCK(({
                 std::string type (prettyName(p.typeId().id()));
-                log << "PPI packet trace: " << label << " 0x" << std::hex << p.id() << " " 
-                    << type.substr(21, type.size()-22) << " on " << & module() << " " 
+                log << "PPI packet trace: " << label << " 0x" << std::hex << p.id() << " "
+                    << type.substr(21, type.size()-22) << " on " << & module() << " "
                     << prettyName(typeid(module())) << " connector 0x" << this << "\n";
                 if (traceState_ == TRACE_CONTENTS)
                     p.dump(log);
@@ -98,14 +112,14 @@ prefix_ void senf::ppi::connector::Connector::throttleTrace(char const * label,
     if (traceState_ == NO_TRACING)
         return;
     SENF_LOG_BLOCK(({
-                log << "PPI throttling trace: " << label << " " << type << " on " << & module() 
+                log << "PPI throttling trace: " << label << " " << type << " on " << & module()
                     << " " << prettyName(typeid(module())) << " connector 0x" << this << "\n";
             }));
 }
 
 namespace senf { namespace ppi { namespace connector {
 
-    SENF_CONSOLE_REGISTER_ENUM_MEMBER( 
+    SENF_CONSOLE_REGISTER_ENUM_MEMBER(
         Connector, TraceState, (NO_TRACING)(TRACE_IDS)(TRACE_CONTENTS) );
 
 }}}
@@ -119,41 +133,47 @@ namespace {
 
     ConsoleRegister::ConsoleRegister()
     {
+#ifndef SENF_PPI_NOTRACE
         senf::ppi::ModuleManager::instance().consoleDir()
-            .add("tracing", SENF_FNP(senf::ppi::connector::Connector::TraceState,
-                                     senf::ppi::connector::Connector::tracing, ()))
-            .doc("Log every packet sent or received by any module.\n"
-                 "There are three different tracing levels:\n"
-                 "\n"
-                 "    NO_TRACING      don't output any tracing information\n"
-                 "    TRACE_IDS       trace packet id's but do not show packet contents\n"
-                 "    TRACE_CONTENTS  trace complete packet contents\n"
-                 "\n"
-                 "A log message is generated whenever the packet traverses a connector. The\n"
-                 "TRACE_IDS log message has the following format:\n"
-                 "\n"
-                 "    PPI packet trace: <direction> <packet-id> <packet-type>\n"
-                 "                      on <module-id> <module-type> connector <connector-id>\n"
-                 "    PPI throttling trace: <direction> <throttle-msg>\n"
-                 "                      on <module-id> <module-type> connector <connector-id>\n"
-                 "\n"
-                 "The fields are:\n"
-                 "\n"
-                 "    direction       'IN' for packets/throttle notifications entering the module,\n"
-                 "                    'OUT' for packets/throttle notifications leaving it\n"
-                 "    packet-id       Numeric unique packet id. This value is unique for packets\n"
-                 "                    alive at the same time, packets at different times may (and\n"
-                 "                    will) share id's\n"
-                 "    packet-type     The type of the packet header\n"
-                 "    module-id       Unique module id\n"
-                 "    module-type     Type of the module the packet is sent to/from\n"
-                 "    connector-id    Unique connector id\n"
-                 "    throttle-msg    Type of throttling event\n");
+            .add("tracing", senf::console::factory::Command(
+                     SENF_FNP(senf::ppi::connector::Connector::TraceState,
+                              senf::ppi::connector::Connector::tracing, ()))
+                 .doc("Log every packet sent or received by any module.\n"
+                      "There are three different tracing levels:\n"
+                      "\n"
+                      "    NO_TRACING      don't output any tracing information\n"
+                      "    TRACE_IDS       trace packet id's but do not show packet contents\n"
+                      "    TRACE_CONTENTS  trace complete packet contents\n"
+                      "\n"
+                      "A log message is generated whenever the packet traverses a connector. The\n"
+                      "TRACE_IDS log message has the following format:\n"
+                      "\n"
+                      "    PPI packet trace: <direction> <packet-id> <packet-type>\n"
+                      "                      on <module-id> <module-type> connector <connector-id>\n"
+                      "    PPI throttling trace: <direction> <throttle-msg>\n"
+                      "                      on <module-id> <module-type> connector <connector-id>\n"
+                      "\n"
+                      "The fields are:\n"
+                      "\n"
+                      "    direction       'IN' for packets/throttle notifications entering the module,\n"
+                      "                    'OUT' for packets/throttle notifications leaving it\n"
+                      "    packet-id       Numeric unique packet id. This value is unique for packets\n"
+                      "                    alive at the same time, packets at different times may (and\n"
+                      "                    will) share id's\n"
+                      "    packet-type     The type of the packet header\n"
+                      "    module-id       Unique module id\n"
+                      "    module-type     Type of the module the packet is sent to/from\n"
+                      "    connector-id    Unique connector id\n"
+                      "    throttle-msg    Type of throttling event\n")
+                );
 
         senf::ppi::ModuleManager::instance().consoleDir()
-            .add("tracing", SENF_FNP(void, senf::ppi::connector::Connector::tracing,
-                                     (senf::ppi::connector::Connector::TraceState)))
-            .arg("state", "new tracing state");
+            .add("tracing", senf::console::factory::Command(
+                     SENF_FNP(void, senf::ppi::connector::Connector::tracing,
+                              (senf::ppi::connector::Connector::TraceState)))
+                 .arg("state", "new tracing state")
+                );
+#endif
     }
 
     ConsoleRegister consoleRegister;
@@ -163,7 +183,7 @@ namespace {
 prefix_ void senf::ppi::connector::Connector::disconnect()
 {
     // Cannot disconnected a non-connected connector
-    SENF_ASSERT( peer_ &&
+    SENF_ASSERT( peer_,
                  "senf::ppi::connector::Connector::disconnect(): Not connected" );
 
     Connector & peer (*peer_);
@@ -184,14 +204,45 @@ prefix_ std::type_info const & senf::ppi::connector::Connector::packetTypeID()
     return typeid(void);
 }
 
+prefix_ void senf::ppi::connector::Connector::unregisterConnector()
+{
+    if (module_)
+        module_->unregisterConnector(*this);
+}
+
+prefix_ void senf::ppi::connector::Connector::setModule(module::Module & module)
+{
+    module_ = &module;
+}
+
 prefix_ void senf::ppi::connector::Connector::v_disconnected()
-    const
 {}
 
-///////////////////////////////////////////////////////////////////////////
+prefix_ void senf::ppi::connector::Connector::v_connected()
+{}
+
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 // senf::ppi::connector::PassiveConnector
 
-////////////////////////////////////////
+prefix_ senf::ppi::connector::PassiveConnector::~PassiveConnector()
+{
+    // Must be here and NOT in base so it is called before destructing the routes_ member
+    unregisterConnector();
+}
+
+prefix_ void senf::ppi::connector::PassiveConnector::v_disconnected()
+{
+    Connector::v_disconnected();
+    peer_ = 0;
+}
+
+prefix_ void senf::ppi::connector::PassiveConnector::v_connected()
+{
+    Connector::v_connected();
+    peer_ = & dynamic_cast<ActiveConnector&>(Connector::peer());
+}
+
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 // private members
 
 prefix_ void senf::ppi::connector::PassiveConnector::v_init()
@@ -209,24 +260,54 @@ prefix_ void senf::ppi::connector::PassiveConnector::v_init()
         emitUnthrottle();
 }
 
+prefix_ void senf::ppi::connector::PassiveConnector::registerRoute(ForwardingRoute & route)
+{
+    routes_.push_back(&route);
+}
+
+prefix_ void senf::ppi::connector::PassiveConnector::unregisterRoute(ForwardingRoute & route)
+{
+    Routes::iterator i (std::find(routes_.begin(), routes_.end(), &route));
+    if (i != routes_.end())
+        routes_.erase(i);
+}
+
 prefix_ void senf::ppi::connector::PassiveConnector::v_unthrottleEvent()
 {}
 
 prefix_ void senf::ppi::connector::PassiveConnector::notifyUnthrottle()
 {
-    if (std::find_if(routes_.begin(), routes_.end(), 
+    if (std::find_if(routes_.begin(), routes_.end(),
                      boost::bind(&ForwardingRoute::throttled, _1)) == routes_.end()) {
         remoteThrottled_ = false;
         if (!nativeThrottled_)
             emitUnthrottle();
     } else
-        throttleTrace("OUT", "not forwarding unthrottle event");
+        SENF_PPI_THROTTLE_TRACE("OUT", "not forwarding unthrottle event");
 }
 
-///////////////////////////////////////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 // senf::ppi::connector::ActiveConnector
 
-////////////////////////////////////////
+prefix_ senf::ppi::connector::ActiveConnector::~ActiveConnector()
+{
+    // Must be here and NOT in base so it is called before destructing the routes_ member
+    unregisterConnector();
+}
+
+prefix_ void senf::ppi::connector::ActiveConnector::v_disconnected()
+{
+    Connector::v_disconnected();
+    peer_ = 0;
+}
+
+prefix_ void senf::ppi::connector::ActiveConnector::v_connected()
+{
+    Connector::v_connected();
+    peer_ = & dynamic_cast<PassiveConnector&>(Connector::peer());
+}
+
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 // private members
 
 prefix_ void senf::ppi::connector::ActiveConnector::v_init()
@@ -237,7 +318,7 @@ prefix_ void senf::ppi::connector::ActiveConnector::v_init()
 
 prefix_ void senf::ppi::connector::ActiveConnector::notifyThrottle()
 {
-    throttleTrace("IN ", "throttle");
+    SENF_PPI_THROTTLE_TRACE("IN ", "throttle");
     if (! throttled_) {
         throttled_ = true;
         if (throttleCallback_)
@@ -251,7 +332,7 @@ prefix_ void senf::ppi::connector::ActiveConnector::notifyThrottle()
 
 prefix_ void senf::ppi::connector::ActiveConnector::notifyUnthrottle()
 {
-    throttleTrace("IN ", "unthrottle");
+    SENF_PPI_THROTTLE_TRACE("IN ", "unthrottle");
     if (throttled_) {
         throttled_ = false;
         if (unthrottleCallback_)
@@ -268,24 +349,45 @@ prefix_ void senf::ppi::connector::ActiveConnector::registerRoute(ForwardingRout
     notifyRoutes_.push_back(&route);
 }
 
-///////////////////////////////////////////////////////////////////////////
+prefix_ void senf::ppi::connector::ActiveConnector::unregisterRoute(ForwardingRoute & route)
+{
+    NotifyRoutes::iterator i (std::find(notifyRoutes_.begin(), notifyRoutes_.end(), &route));
+    if (i != notifyRoutes_.end())
+        notifyRoutes_.erase(i);
+}
+
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 // senf::ppi::connector::InputConnector
 
 prefix_ senf::Packet senf::ppi::connector::InputConnector::operator()()
 {
     if (empty())
         v_requestEvent();
-    Packet p;
     if (! empty()) {
-        p = peek();
+        Packet p ( queue_.back());
         queue_.pop_back();
         v_dequeueEvent();
+        SENF_PPI_TRACE(p, "IN ");
+        return p;
+    } else {
+        SENF_PPI_TRACE(Packet(), "IN ");
+        return Packet();
     }
-    trace(p, "IN ");
-    return p;
 }
 
-////////////////////////////////////////
+prefix_ void senf::ppi::connector::InputConnector::v_disconnected()
+{
+    Connector::v_disconnected();
+    peer_ = 0;
+}
+
+prefix_ void senf::ppi::connector::InputConnector::v_connected()
+{
+    Connector::v_connected();
+    peer_ = & dynamic_cast<OutputConnector&>(Connector::peer());
+}
+
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 // private members
 
 prefix_ void senf::ppi::connector::InputConnector::v_requestEvent()
@@ -297,10 +399,25 @@ prefix_ void senf::ppi::connector::InputConnector::v_enqueueEvent()
 prefix_ void senf::ppi::connector::InputConnector::v_dequeueEvent()
 {}
 
-///////////////////////////////////////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
+// senf::ppi::connector::OutputConnector
+
+prefix_ void senf::ppi::connector::OutputConnector::v_disconnected()
+{
+    Connector::v_disconnected();
+    peer_ = 0;
+}
+
+prefix_ void senf::ppi::connector::OutputConnector::v_connected()
+{
+    Connector::v_connected();
+    peer_ = & dynamic_cast<InputConnector&>(Connector::peer());
+}
+
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 // senf::ppi::connector::GenericActiveInput
 
-////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 // private members
 
 prefix_ void senf::ppi::connector::GenericActiveInput::v_requestEvent()
@@ -308,21 +425,42 @@ prefix_ void senf::ppi::connector::GenericActiveInput::v_requestEvent()
     request();
 }
 
-///////////////////////////////////////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 // senf::ppi::connector::GenericPassiveInput
 
-////////////////////////////////////////
-// private members 
+prefix_ void senf::ppi::connector::GenericPassiveInput::v_disconnected()
+{
+    PassiveConnector::v_disconnected();
+    InputConnector::v_disconnected();
+    peer_ = 0;
+}
+
+prefix_ void senf::ppi::connector::GenericPassiveInput::v_connected()
+{
+    PassiveConnector::v_connected();
+    InputConnector::v_connected();
+    peer_ = & dynamic_cast<GenericActiveOutput&>(Connector::peer());
+}
+
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
+// private members
 
 prefix_ void senf::ppi::connector::GenericPassiveInput::v_enqueueEvent()
 {
     emit();
-    qdisc_->update(*this, QueueingDiscipline::ENQUEUE);
+    if (qdisc_)
+        qdisc_->update(*this, QueueingDiscipline::ENQUEUE);
 }
 
 prefix_ void senf::ppi::connector::GenericPassiveInput::v_dequeueEvent()
 {
-    qdisc_->update(*this, QueueingDiscipline::DEQUEUE);
+    if (qdisc_)
+        qdisc_->update(*this, QueueingDiscipline::DEQUEUE);
+}
+
+prefix_ void senf::ppi::connector::GenericPassiveInput::qdisc(QueueingDiscipline::None_t)
+{
+    qdisc_.reset( 0);
 }
 
 prefix_ void senf::ppi::connector::GenericPassiveInput::v_unthrottleEvent()
@@ -337,7 +475,59 @@ prefix_ void senf::ppi::connector::GenericPassiveInput::v_unthrottleEvent()
     }
 }
 
-///////////////////////////////cc.e////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
+// senf::ppi::connector::GenericPassiveOutput
+
+prefix_ void senf::ppi::connector::GenericPassiveOutput::v_disconnected()
+{
+    PassiveConnector::v_disconnected();
+    OutputConnector::v_disconnected();
+    peer_ = 0;
+}
+
+prefix_ void senf::ppi::connector::GenericPassiveOutput::v_connected()
+{
+    PassiveConnector::v_connected();
+    OutputConnector::v_connected();
+    peer_ = & dynamic_cast<GenericActiveInput&>(Connector::peer());
+}
+
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
+// senf::ppi::connector::GenericActiveInput
+
+prefix_ void senf::ppi::connector::GenericActiveInput::v_disconnected()
+{
+    ActiveConnector::v_disconnected();
+    InputConnector::v_disconnected();
+    peer_ = 0;
+}
+
+prefix_ void senf::ppi::connector::GenericActiveInput::v_connected()
+{
+    ActiveConnector::v_connected();
+    InputConnector::v_connected();
+    peer_ = & dynamic_cast<GenericPassiveOutput&>(Connector::peer());
+}
+
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
+// senf::ppi::connector::GenericActiveOutput
+
+prefix_ void senf::ppi::connector::GenericActiveOutput::v_disconnected()
+{
+    ActiveConnector::v_disconnected();
+    OutputConnector::v_disconnected();
+    peer_ = 0;
+}
+
+prefix_ void senf::ppi::connector::GenericActiveOutput::v_connected()
+{
+    ActiveConnector::v_connected();
+    OutputConnector::v_connected();
+    peer_ = & dynamic_cast<GenericPassiveInput&>(Connector::peer());
+}
+
+
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 #undef prefix_
 //#include "Connectors.mpp"