VPP Object Model (VOM)

The VOM is a C++ library for use by clients/agents of VPP for programming
state. It uses the binary APIs to do so. Various other common client side
functions are also provided. Please see om.hpp for a more detailed description.

Change-Id: Ib756bfe99817093815a9e26ccf464aa5583fc523
Signed-off-by: Neale Ranns <neale.ranns@cisco.com>
Co-authored-by: Mohsin Kazmi <sykazmi@cisco.com>

1 files changed, 337 insertions, 0 deletions

diff --git a/src/vpp-api/vom/hw.cpp b/src/vpp-api/vom/hw.cpp
new file mode 100644
index 00000000000..56885525494
--- /dev/null
+++ b/src/vpp-api/vom/hw.cpp
@@ -0,0 +1,337 @@
+/*
+ * Copyright (c) 2017 Cisco and/or its affiliates.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "vom/hw.hpp"
+#include "vom/logger.hpp"
+
+#include <vapi/vpe.api.vapi.hpp>
+
+namespace VOM {
+HW::cmd_q::cmd_q()
+  : m_enabled(true)
+  , m_connected(false)
+  , m_conn()
+{
+}
+
+HW::cmd_q::~cmd_q()
+{
+  m_connected = false;
+
+  if (m_rx_thread && m_rx_thread->joinable()) {
+    m_rx_thread->join();
+  }
+}
+
+HW::cmd_q&
+HW::cmd_q::operator=(const HW::cmd_q& f)
+{
+  return (*this);
+}
+
+/**
+ * Run the connect/dispatch thread.
+ */
+void
+HW::cmd_q::rx_run()
+{
+  while (m_connected) {
+    m_conn.ctx().dispatch();
+  }
+}
+
+void
+HW::cmd_q::enqueue(cmd* c)
+{
+  std::shared_ptr<cmd> sp(c);
+
+  m_queue.push_back(sp);
+}
+
+void
+HW::cmd_q::enqueue(std::shared_ptr<cmd> c)
+{
+  m_queue.push_back(c);
+}
+
+void
+HW::cmd_q::enqueue(std::queue<cmd*>& cmds)
+{
+  while (cmds.size()) {
+    std::shared_ptr<cmd> sp(cmds.front());
+
+    m_queue.push_back(sp);
+    cmds.pop();
+  }
+}
+
+void
+HW::cmd_q::dequeue(cmd* c)
+{
+  c->retire(m_conn);
+  m_pending.erase(c);
+}
+
+void
+HW::cmd_q::dequeue(std::shared_ptr<cmd> c)
+{
+  c->retire(m_conn);
+  m_pending.erase(c.get());
+}
+
+void
+HW::cmd_q::connect()
+{
+  if (m_connected) {
+    m_conn.disconnect();
+  }
+
+  m_connected = false;
+
+  if (m_rx_thread && m_rx_thread->joinable()) {
+    m_rx_thread->join();
+  }
+
+  m_conn.connect();
+
+  m_connected = true;
+  m_rx_thread.reset(new std::thread(&HW::cmd_q::rx_run, this));
+}
+
+void
+HW::cmd_q::enable()
+{
+  m_enabled = true;
+}
+
+void
+HW::cmd_q::disable()
+{
+  m_enabled = false;
+}
+
+rc_t
+HW::cmd_q::write()
+{
+  rc_t rc = rc_t::OK;
+
+  /*
+ * The queue is enabled, Execute each command in the queue.
+ * If one execution fails, abort the rest
+ */
+  auto it = m_queue.begin();
+
+  while (it != m_queue.end()) {
+    std::shared_ptr<cmd> c = *it;
+
+    VOM_LOG(log_level_t::DEBUG) << *c;
+
+    if (m_enabled) {
+      /*
+ * before we issue the command we must move it to the pending
+ * store
+ * ince a async event can be recieved before the command
+ * completes
+ */
+      m_pending[c.get()] = c;
+
+      rc = c->issue(m_conn);
+
+      if (rc_t::INPROGRESS == rc) {
+        /*
+ * this command completes asynchronously
+ * leave the command in the pending store
+ */
+      } else {
+        /*
+ * the command completed, remove from the pending store
+ */
+        m_pending.erase(c.get());
+
+        if (rc_t::OK == rc) {
+          /*
+ * move to the next
+ */
+        } else {
+          /*
+ * barf out without issuing the rest
+ */
+          break;
+        }
+      }
+    } else {
+      /*
+ * The HW is disabled, so set each command as succeeded
+ */
+      c->succeeded();
+    }
+
+    ++it;
+  }
+
+  /*
+ * erase all objects in the queue
+ */
+  m_queue.erase(m_queue.begin(), m_queue.end());
+
+  return (rc);
+}
+
+/*
+ * The single Command Queue
+ */
+HW::cmd_q* HW::m_cmdQ;
+HW::item<bool> HW::m_poll_state;
+
+/**
+ * Initialse the connection to VPP
+ */
+void
+HW::init(HW::cmd_q* f)
+{
+  m_cmdQ = f;
+}
+
+/**
+ * Initialse the connection to VPP
+ */
+void
+HW::init()
+{
+  m_cmdQ = new cmd_q();
+}
+
+void
+HW::enqueue(cmd* cmd)
+{
+  m_cmdQ->enqueue(cmd);
+}
+
+void
+HW::enqueue(std::shared_ptr<cmd> cmd)
+{
+  m_cmdQ->enqueue(cmd);
+}
+
+void
+HW::enqueue(std::queue<cmd*>& cmds)
+{
+  m_cmdQ->enqueue(cmds);
+}
+
+void
+HW::dequeue(cmd* cmd)
+{
+  m_cmdQ->dequeue(cmd);
+}
+
+void
+HW::dequeue(std::shared_ptr<cmd> cmd)
+{
+  m_cmdQ->dequeue(cmd);
+}
+
+void
+HW::connect()
+{
+  m_cmdQ->connect();
+}
+
+void
+HW::enable()
+{
+  m_cmdQ->enable();
+}
+
+void
+HW::disable()
+{
+  m_cmdQ->disable();
+}
+
+rc_t
+HW::write()
+{
+  return (m_cmdQ->write());
+}
+
+bool
+HW::poll()
+{
+  std::shared_ptr<cmd> poll(new Poll(m_poll_state));
+
+  HW::enqueue(poll);
+  HW::write();
+
+  return (m_poll_state);
+}
+
+template <>
+std::string
+HW::item<bool>::to_string() const
+{
+  std::ostringstream os;
+
+  os << "hw-item:["
+     << "rc:" << item_rc.to_string() << " data:" << item_data << "]";
+  return (os.str());
+}
+
+template <>
+std::string
+HW::item<unsigned int>::to_string() const
+{
+  std::ostringstream os;
+
+  os << "hw-item:["
+     << "rc:" << item_rc.to_string() << " data:" << item_data << "]";
+  return (os.str());
+}
+
+HW::Poll::Poll(HW::item<bool>& item)
+  : rpc_cmd(item)
+{
+}
+
+rc_t
+HW::Poll::issue(connection& con)
+{
+  msg_t req(con.ctx(), std::ref(*this));
+
+  VAPI_CALL(req.execute());
+
+  m_hw_item.set(wait());
+
+  return (rc_t::OK);
+}
+
+std::string
+HW::Poll::to_string() const
+{
+  std::ostringstream s;
+
+  s << "poll: " << m_hw_item.to_string();
+
+  return (s.str());
+}
+}
+
+/*
+ * fd.io coding-style-patch-verification: ON
+ *
+ * Local Variables:
+ * eval: (c-set-style "mozilla")
+ * End:
+ */