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

diff --git a/src/vpp-api/vom/l3_binding.cpp b/src/vpp-api/vom/l3_binding.cpp
new file mode 100644
index 00000000000..0d5f4149e26
--- /dev/null
+++ b/src/vpp-api/vom/l3_binding.cpp
@@ -0,0 +1,187 @@
+/*
+ * 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/l3_binding.hpp"
+#include "vom/cmd.hpp"
+
+namespace VOM {
+singular_db<l3_binding::key_type_t, l3_binding> l3_binding::m_db;
+
+l3_binding::event_handler l3_binding::m_evh;
+
+/**
+ * Construct a new object matching the desried state
+ */
+l3_binding::l3_binding(const interface& itf, const route::prefix_t& pfx)
+  : m_itf(itf.singular())
+  , m_pfx(pfx)
+  , m_binding(true)
+{
+}
+
+l3_binding::l3_binding(const l3_binding& o)
+  : m_itf(o.m_itf)
+  , m_pfx(o.m_pfx)
+  , m_binding(true)
+{
+}
+
+l3_binding::~l3_binding()
+{
+  sweep();
+
+  // not in the DB anymore.
+  m_db.release(make_pair(m_itf->key(), m_pfx), this);
+}
+
+void
+l3_binding::sweep()
+{
+  if (m_binding) {
+    HW::enqueue(new unbind_cmd(m_binding, m_itf->handle(), m_pfx));
+  }
+  HW::write();
+}
+
+void
+l3_binding::replay()
+{
+  if (m_binding) {
+    HW::enqueue(new bind_cmd(m_binding, m_itf->handle(), m_pfx));
+  }
+}
+
+const route::prefix_t&
+l3_binding::prefix() const
+{
+  return (m_pfx);
+}
+
+std::string
+l3_binding::to_string() const
+{
+  std::ostringstream s;
+  s << "L3-config:[" << m_itf->to_string() << " prefix:" << m_pfx.to_string()
+    << " " << m_binding.to_string() << "]";
+
+  return (s.str());
+}
+
+void
+l3_binding::update(const l3_binding& desired)
+{
+  /*
+ * the desired state is always that the interface should be created
+ */
+  if (!m_binding) {
+    HW::enqueue(new bind_cmd(m_binding, m_itf->handle(), m_pfx));
+  }
+}
+
+std::shared_ptr<l3_binding>
+l3_binding::find_or_add(const l3_binding& temp)
+{
+  return (m_db.find_or_add(make_pair(temp.m_itf->key(), temp.m_pfx), temp));
+}
+
+std::shared_ptr<l3_binding>
+l3_binding::singular() const
+{
+  return find_or_add(*this);
+}
+
+void
+l3_binding::dump(std::ostream& os)
+{
+  m_db.dump(os);
+}
+
+std::ostream&
+operator<<(std::ostream& os, const l3_binding::key_type_t& key)
+{
+  os << "[" << key.first << ", " << key.second << "]";
+
+  return (os);
+}
+
+std::deque<std::shared_ptr<l3_binding>>
+l3_binding::find(const interface& i)
+{
+  /*
+ * Loop throught the entire map looking for matching interface.
+ * not the most efficient algorithm, but it will do for now. The
+ * number of L3 configs is low and this is only called during bootup
+ */
+  std::deque<std::shared_ptr<l3_binding>> l3s;
+
+  auto it = m_db.cbegin();
+
+  while (it != m_db.cend()) {
+    /*
+ * The key in the DB is a pair of the interface's name and prefix.
+ * If the keys match, save the L3-config
+ */
+    auto key = it->first;
+
+    if (i.key() == key.first) {
+      l3s.push_back(it->second.lock());
+    }
+
+    ++it;
+  }
+
+  return (l3s);
+}
+
+l3_binding::event_handler::event_handler()
+{
+  OM::register_listener(this);
+  inspect::register_handler({ "l3" }, "L3 bindings", this);
+}
+
+void
+l3_binding::event_handler::handle_replay()
+{
+  m_db.replay();
+}
+
+void
+l3_binding::event_handler::handle_populate(const client_db::key_t& key)
+{
+  /**
+ * This is done while populating the interfaces
+ */
+}
+
+dependency_t
+l3_binding::event_handler::order() const
+{
+  return (dependency_t::BINDING);
+}
+
+void
+l3_binding::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:
+ */