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, 434 insertions, 0 deletions

diff --git a/src/vpp-api/vom/interface.cpp b/src/vpp-api/vom/interface.cpp
new file mode 100644
index 00000000000..83da275f61f
--- /dev/null
+++ b/src/vpp-api/vom/interface.cpp
@@ -0,0 +1,434 @@
+/*
+ * 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/interface.hpp"
+#include "vom/cmd.hpp"
+#include "vom/l3_binding.hpp"
+#include "vom/logger.hpp"
+#include "vom/prefix.hpp"
+
+namespace VOM {
+/**
+ * A DB of all the interfaces, key on the name
+ */
+singular_db<const std::string, interface> interface::m_db;
+
+/**
+ * A DB of all the interfaces, key on VPP's handle
+ */
+std::map<handle_t, std::weak_ptr<interface>> interface::m_hdl_db;
+
+interface::event_handler interface::m_evh;
+
+/**
+ * Construct a new object matching the desried state
+ */
+interface::interface(const std::string& name,
+                     interface::type_t itf_type,
+                     interface::admin_state_t itf_state)
+  : m_hdl(handle_t::INVALID)
+  , m_name(name)
+  , m_type(itf_type)
+  , m_state(itf_state)
+  , m_table_id(route::DEFAULT_TABLE)
+  , m_l2_address(l2_address_t::ZERO, rc_t::UNSET)
+  , m_oper(oper_state_t::DOWN)
+{
+}
+
+interface::interface(const handle_t& handle,
+                     const l2_address_t& l2_address,
+                     const std::string& name,
+                     interface::type_t type,
+                     interface::admin_state_t state)
+  : m_hdl(handle)
+  , m_name(name)
+  , m_type(type)
+  , m_state(state)
+  , m_table_id(route::DEFAULT_TABLE)
+  , m_l2_address(l2_address)
+  , m_oper(oper_state_t::DOWN)
+{
+}
+
+interface::interface(const std::string& name,
+                     interface::type_t itf_type,
+                     interface::admin_state_t itf_state,
+                     const route_domain& rd)
+  : m_hdl(handle_t::INVALID)
+  , m_name(name)
+  , m_type(itf_type)
+  , m_rd(rd.singular())
+  , m_state(itf_state)
+  , m_table_id(m_rd->table_id())
+  , m_l2_address(l2_address_t::ZERO, rc_t::UNSET)
+  , m_oper(oper_state_t::DOWN)
+{
+}
+
+interface::interface(const interface& o)
+  : m_hdl(o.m_hdl)
+  , m_name(o.m_name)
+  , m_type(o.m_type)
+  , m_rd(o.m_rd)
+  , m_state(o.m_state)
+  , m_table_id(o.m_table_id)
+  , m_l2_address(o.m_l2_address)
+  , m_oper(o.m_oper)
+{
+}
+
+interface::event_listener::event_listener()
+  : m_status(rc_t::NOOP)
+{
+}
+
+HW::item<bool>&
+interface::event_listener::status()
+{
+  return (m_status);
+}
+
+interface::stat_listener::stat_listener()
+  : m_status(rc_t::NOOP)
+{
+}
+
+HW::item<bool>&
+interface::stat_listener::status()
+{
+  return (m_status);
+}
+
+/**
+ * Return the interface type
+ */
+const interface::type_t&
+interface::type() const
+{
+  return (m_type);
+}
+
+const handle_t&
+interface::handle() const
+{
+  return (m_hdl.data());
+}
+
+const l2_address_t&
+interface::l2_address() const
+{
+  return (m_l2_address.data());
+}
+
+interface::const_iterator_t
+interface::cbegin()
+{
+  return m_db.cbegin();
+}
+
+interface::const_iterator_t
+interface::cend()
+{
+  return m_db.cend();
+}
+
+void
+interface::sweep()
+{
+  if (m_table_id) {
+    m_table_id.data() = route::DEFAULT_TABLE;
+    HW::enqueue(new set_table_cmd(m_table_id, l3_proto_t::IPV4, m_hdl));
+    HW::enqueue(new set_table_cmd(m_table_id, l3_proto_t::IPV6, m_hdl));
+  }
+
+  // If the interface is up, bring it down
+  if (m_state && interface::admin_state_t::UP == m_state.data()) {
+    m_state.data() = interface::admin_state_t::DOWN;
+    HW::enqueue(new state_change_cmd(m_state, m_hdl));
+  }
+  if (m_hdl) {
+    std::queue<cmd*> cmds;
+    HW::enqueue(mk_delete_cmd(cmds));
+  }
+  HW::write();
+}
+
+void
+interface::replay()
+{
+  if (m_hdl) {
+    std::queue<cmd*> cmds;
+    HW::enqueue(mk_create_cmd(cmds));
+  }
+
+  if (m_state && interface::admin_state_t::UP == m_state.data()) {
+    HW::enqueue(new state_change_cmd(m_state, m_hdl));
+  }
+
+  if (m_table_id) {
+    HW::enqueue(new set_table_cmd(m_table_id, l3_proto_t::IPV4, m_hdl));
+    HW::enqueue(new set_table_cmd(m_table_id, l3_proto_t::IPV6, m_hdl));
+  }
+}
+
+interface::~interface()
+{
+  sweep();
+  release();
+}
+
+void
+interface::release()
+{
+  // not in the DB anymore.
+  m_db.release(m_name, this);
+}
+
+std::string
+interface::to_string() const
+{
+  std::ostringstream s;
+  s << "interface:[" << m_name << " type:" << m_type.to_string()
+    << " hdl:" << m_hdl.to_string()
+    << " l2-address:" << m_l2_address.to_string();
+
+  if (m_rd) {
+    s << " rd:" << m_rd->to_string();
+  }
+
+  s << " admin-state:" << m_state.to_string()
+    << " oper-state:" << m_oper.to_string() << "]";
+
+  return (s.str());
+}
+
+const std::string&
+interface::name() const
+{
+  return (m_name);
+}
+
+const interface::key_type&
+interface::key() const
+{
+  return (name());
+}
+
+std::queue<cmd*>&
+interface::mk_create_cmd(std::queue<cmd*>& q)
+{
+  if (type_t::LOOPBACK == m_type) {
+    q.push(new loopback_create_cmd(m_hdl, m_name));
+  } else if (type_t::BVI == m_type) {
+    q.push(new loopback_create_cmd(m_hdl, m_name));
+    q.push(new set_tag(m_hdl, m_name));
+  } else if (type_t::AFPACKET == m_type) {
+    q.push(new af_packet_create_cmd(m_hdl, m_name));
+  } else if (type_t::TAP == m_type) {
+    q.push(new tap_create_cmd(m_hdl, m_name));
+  }
+
+  return (q);
+}
+
+std::queue<cmd*>&
+interface::mk_delete_cmd(std::queue<cmd*>& q)
+{
+  if ((type_t::LOOPBACK == m_type) || (type_t::BVI == m_type)) {
+    q.push(new loopback_delete_cmd(m_hdl));
+  } else if (type_t::AFPACKET == m_type) {
+    q.push(new af_packet_delete_cmd(m_hdl, m_name));
+  } else if (type_t::TAP == m_type) {
+    q.push(new tap_delete_cmd(m_hdl));
+  }
+
+  return (q);
+}
+
+void
+interface::update(const interface& desired)
+{
+  /*
+ * the desired state is always that the interface should be created
+ */
+  if (rc_t::OK != m_hdl.rc()) {
+    std::queue<cmd*> cmds;
+    HW::enqueue(mk_create_cmd(cmds));
+  }
+
+  /*
+ * change the interface state to that which is deisred
+ */
+  if (m_state.update(desired.m_state)) {
+    HW::enqueue(new state_change_cmd(m_state, m_hdl));
+  }
+
+  /*
+ * change the interface state to that which is deisred
+ */
+  if (m_l2_address.update(desired.m_l2_address)) {
+    HW::enqueue(new set_mac_cmd(m_l2_address, m_hdl));
+  }
+
+  /*
+ * If the interface is mapped into a route domain, set VPP's
+ * table ID
+ */
+  if (!m_table_id && m_rd) {
+    HW::enqueue(new set_table_cmd(m_table_id, l3_proto_t::IPV4, m_hdl));
+    HW::enqueue(new set_table_cmd(m_table_id, l3_proto_t::IPV6, m_hdl));
+  }
+}
+
+void
+interface::set(const l2_address_t& addr)
+{
+  assert(rc_t::UNSET == m_l2_address.rc());
+  m_l2_address.set(rc_t::NOOP);
+  m_l2_address.update(addr);
+}
+
+void
+interface::set(const oper_state_t& state)
+{
+  m_oper = state;
+}
+
+std::shared_ptr<interface>
+interface::singular_i() const
+{
+  return (m_db.find_or_add(name(), *this));
+}
+
+std::shared_ptr<interface>
+interface::singular() const
+{
+  return singular_i();
+}
+
+std::shared_ptr<interface>
+interface::find(const std::string& name)
+{
+  return (m_db.find(name));
+}
+
+std::shared_ptr<interface>
+interface::find(const handle_t& handle)
+{
+  return (m_hdl_db[handle].lock());
+}
+
+void
+interface::add(const std::string& name, const HW::item<handle_t>& item)
+{
+  std::shared_ptr<interface> sp = find(name);
+
+  if (sp && item) {
+    m_hdl_db[item.data()] = sp;
+  }
+}
+
+void
+interface::remove(const HW::item<handle_t>& item)
+{
+  m_hdl_db.erase(item.data());
+}
+
+void
+interface::dump(std::ostream& os)
+{
+  m_db.dump(os);
+}
+
+void
+interface::event_handler::handle_populate(const client_db::key_t& key)
+{
+  /*
+ * dump VPP current states
+ */
+  std::shared_ptr<interface::dump_cmd> cmd(new interface::dump_cmd());
+
+  HW::enqueue(cmd);
+  HW::write();
+
+  for (auto& itf_record : *cmd) {
+    std::unique_ptr<interface> itf =
+      interface::new_interface(itf_record.get_payload());
+
+    if (itf && interface::type_t::LOCAL != itf->type()) {
+      VOM_LOG(log_level_t::DEBUG) << "dump: " << itf->to_string();
+      /*
+ * Write each of the discovered interfaces into the OM,
+ * but disable the HW Command q whilst we do, so that no
+ * commands are sent to VPP
+ */
+      OM::commit(key, *itf);
+
+      /**
+ * Get the address configured on the interface
+ */
+      std::shared_ptr<l3_binding::dump_v4_cmd> dcmd =
+        std::make_shared<l3_binding::dump_v4_cmd>(
+          l3_binding::dump_v4_cmd(itf->handle()));
+
+      HW::enqueue(dcmd);
+      HW::write();
+
+      for (auto& l3_record : *dcmd) {
+        auto& payload = l3_record.get_payload();
+        const route::prefix_t pfx(payload.is_ipv6, payload.ip,
+                                  payload.prefix_length);
+
+        VOM_LOG(log_level_t::DEBUG) << "dump: " << pfx.to_string();
+
+        l3_binding l3(*itf, pfx);
+        OM::commit(key, l3);
+      }
+    }
+  }
+}
+
+interface::event_handler::event_handler()
+{
+  OM::register_listener(this);
+  inspect::register_handler({ "interface", "intf" }, "interfaces", this);
+}
+
+void
+interface::event_handler::handle_replay()
+{
+  m_db.replay();
+}
+
+dependency_t
+interface::event_handler::order() const
+{
+  return (dependency_t::INTERFACE);
+}
+
+void
+interface::event_handler::show(std::ostream& os)
+{
+  m_db.dump(os);
+}
+}
+/*
+ * fd.io coding-style-patch-verification: ON
+ *
+ * Local Variables:
+ * eval: (c-set-style "mozilla")
+ * End:
+ */