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

diff --git a/src/vpp-api/vom/route_domain.hpp b/src/vpp-api/vom/route_domain.hpp
new file mode 100644
index 00000000000..5d3b8914aca
--- /dev/null
+++ b/src/vpp-api/vom/route_domain.hpp
@@ -0,0 +1,230 @@
+/*
+ * 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.
+ */
+
+#ifndef __VOM_ROUTE_DOMAIN_H__
+#define __VOM_ROUTE_DOMAIN_H__
+
+#include "vom/object_base.hpp"
+#include "vom/om.hpp"
+#include "vom/prefix.hpp"
+#include "vom/singular_db.hpp"
+
+#include <vapi/ip.api.vapi.hpp>
+
+namespace VOM {
+/**
+ * A route-domain is a VRF.
+ *  creating a route-domain object will construct both an IPv4
+ *  and IPv6 table.
+ */
+class route_domain : public object_base
+{
+public:
+  /**
+   * The Key for a route-domain
+   */
+  typedef route::table_id_t key_t;
+
+  /**
+   * Construct a new object matching the desried state
+   */
+  route_domain(route::table_id_t id);
+
+  /**
+   * Copy Constructor
+   */
+  route_domain(const route_domain& o);
+
+  /**
+   * Destructor
+   */
+  ~route_domain();
+
+  /**
+   * Return the matching 'singular instance'
+   */
+  std::shared_ptr<route_domain> singular() const;
+
+  /**
+   * Debug print function
+   */
+  std::string to_string() const;
+
+  /**
+   * Get the table ID
+   */
+  route::table_id_t table_id() const;
+
+  /**
+   * Get the route-domain's key
+   */
+  key_t key() const;
+
+  /**
+   * Find the instnace of the route domain in the OM
+   */
+  static std::shared_ptr<route_domain> find(const route_domain& temp);
+
+  /**
+   * Dump all route-doamin into the stream provided
+   */
+  static void dump(std::ostream& os);
+
+  /**
+   * Return the sigular instance for the default table
+   */
+  static std::shared_ptr<route_domain> get_default();
+
+  /**
+   * replay the object to create it in hardware
+   */
+  void replay(void);
+
+  /**
+   * A command class that creates the IP table
+   */
+  class create_cmd
+    : public rpc_cmd<HW::item<bool>, rc_t, vapi::Ip_table_add_del>
+  {
+  public:
+    /**
+     * Constructor
+     */
+    create_cmd(HW::item<bool>& item, l3_proto_t proto, route::table_id_t id);
+
+    /**
+     * Issue the command to VPP/HW
+     */
+    rc_t issue(connection& con);
+
+    /**
+     * convert to string format for debug purposes
+     */
+    std::string to_string() const;
+
+    /**
+     * Comparison operator - only used for UT
+     */
+    bool operator==(const create_cmd& i) const;
+
+  private:
+    /**
+     * table-ID to create
+     */
+    route::table_id_t m_id;
+
+    /**
+     * L3 protocol of the table
+     */
+    l3_proto_t m_proto;
+  };
+
+  /**
+   * A cmd class that Deletes the IP Table
+   */
+  class delete_cmd
+    : public rpc_cmd<HW::item<bool>, rc_t, vapi::Ip_table_add_del>
+  {
+  public:
+    /**
+     * Constructor
+     */
+    delete_cmd(HW::item<bool>& item, l3_proto_t proto, route::table_id_t id);
+
+    /**
+     * Issue the command to VPP/HW
+     */
+    rc_t issue(connection& con);
+
+    /**
+     * convert to string format for debug purposes
+     */
+    std::string to_string() const;
+
+    /**
+     * Comparison operator - only used for UT
+     */
+    bool operator==(const delete_cmd& i) const;
+
+  private:
+    /**
+     * table-ID to create
+     */
+    route::table_id_t m_id;
+
+    /**
+     * L3 protocol of the table
+     */
+    l3_proto_t m_proto;
+  };
+
+private:
+  /**
+   * Commit the acculmulated changes into VPP. i.e. to a 'HW" write.
+   */
+  void update(const route_domain& obj);
+
+  /**
+   * Find or add the instnace of the route domain in the OM
+   */
+  static std::shared_ptr<route_domain> find_or_add(const route_domain& temp);
+
+  /*
+   * It's the OM class that updates the objects in HW
+   */
+  friend class OM;
+
+  /**
+   * It's the singular_db class that calls replay()
+   */
+  friend class singular_db<route::table_id_t, route_domain>;
+
+  /**
+   * Sweep/reap the object if still stale
+   */
+  void sweep(void);
+
+  /**
+   * HW configuration for the result of creating the v4 table
+   */
+  HW::item<bool> m_hw_v4;
+
+  /**
+   * HW configuration for the result of creating the v6 table
+   */
+  HW::item<bool> m_hw_v6;
+
+  /**
+   * VPP understands Table-IDs not table names.
+   *  The table IDs for V4 and V6 are the same.
+   */
+  route::table_id_t m_table_id;
+
+  /**
+   * A map of all interfaces key against the interface's name
+   */
+  static singular_db<route::table_id_t, route_domain> m_db;
+};
+};
+
+/*
+ * fd.io coding-style-patch-verification: ON
+ *
+ * Local Variables:
+ * eval: (c-set-style "mozilla")
+ * End:
+ */
+
+#endif