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

diff --git a/src/vpp-api/vom/arp_proxy_config.hpp b/src/vpp-api/vom/arp_proxy_config.hpp
new file mode 100644
index 00000000000..78fc81a894a
--- /dev/null
+++ b/src/vpp-api/vom/arp_proxy_config.hpp
@@ -0,0 +1,241 @@
+/*
+ * 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_ARP_PROXY_CONFIG_H__
+#define __VOM_ARP_PROXY_CONFIG_H__
+
+#include "vom/dump_cmd.hpp"
+#include "vom/hw.hpp"
+#include "vom/inspect.hpp"
+#include "vom/object_base.hpp"
+#include "vom/om.hpp"
+#include "vom/rpc_cmd.hpp"
+#include "vom/singular_db.hpp"
+
+#include <vapi/vpe.api.vapi.hpp>
+
+namespace VOM {
+/**
+ * A representation of LLDP client configuration on an interface
+ */
+class arp_proxy_config : public object_base
+{
+public:
+  /**
+   * Key type
+   */
+  typedef std::pair<boost::asio::ip::address_v4, boost::asio::ip::address_v4>
+    key_t;
+
+  /**
+   * Construct a new object matching the desried state
+   */
+  arp_proxy_config(const boost::asio::ip::address_v4& low,
+                   const boost::asio::ip::address_v4& high);
+
+  /**
+   * Copy Constructor
+   */
+  arp_proxy_config(const arp_proxy_config& o);
+
+  /**
+   * Destructor
+   */
+  ~arp_proxy_config();
+
+  /**
+   * Return the 'singular' of the LLDP config that matches this object
+   */
+  std::shared_ptr<arp_proxy_config> singular() const;
+
+  /**
+   * convert to string format for debug purposes
+   */
+  std::string to_string() const;
+
+  /**
+   * Dump all LLDP configs into the stream provided
+   */
+  static void dump(std::ostream& os);
+
+  /**
+   * A command class that adds the ARP Proxy config
+   */
+  class config_cmd
+    : public rpc_cmd<HW::item<bool>, rc_t, vapi::Proxy_arp_add_del>
+  {
+  public:
+    /**
+     * Constructor
+     */
+    config_cmd(HW::item<bool>& item,
+               const boost::asio::ip::address_v4& lo,
+               const boost::asio::ip::address_v4& high);
+
+    /**
+     * 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 config_cmd& i) const;
+
+  private:
+    /**
+     * Address range
+     */
+    const boost::asio::ip::address_v4 m_low;
+    const boost::asio::ip::address_v4 m_high;
+  };
+
+  /**
+   * A cmd class that Unconfigs ArpProxy Config from an interface
+   */
+  class unconfig_cmd
+    : public rpc_cmd<HW::item<bool>, rc_t, vapi::Proxy_arp_add_del>
+  {
+  public:
+    /**
+     * Constructor
+     */
+    unconfig_cmd(HW::item<bool>& item,
+                 const boost::asio::ip::address_v4& lo,
+                 const boost::asio::ip::address_v4& hig);
+
+    /**
+     * 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 unconfig_cmd& i) const;
+
+  private:
+    /**
+     * Address range
+     */
+    const boost::asio::ip::address_v4 m_low;
+    const boost::asio::ip::address_v4 m_high;
+  };
+
+private:
+  /**
+   * Class definition for listeners to OM events
+   */
+  class event_handler : public OM::listener, public inspect::command_handler
+  {
+  public:
+    event_handler();
+    virtual ~event_handler() = default;
+
+    /**
+     * Handle a populate event
+     */
+    void handle_populate(const client_db::key_t& key);
+
+    /**
+     * Handle a replay event
+     */
+    void handle_replay();
+
+    /**
+     * Show the object in the Singular DB
+     */
+    void show(std::ostream& os);
+
+    /**
+     * Get the sortable Id of the listener
+     */
+    dependency_t order() const;
+  };
+
+  /**
+   * event_handler to register with OM
+   */
+  static event_handler m_evh;
+
+  /**
+   * Enquue commonds to the VPP command Q for the update
+   */
+  void update(const arp_proxy_config& obj);
+
+  /**
+   * Find or add LLDP config to the OM
+   */
+  static std::shared_ptr<arp_proxy_config> find_or_add(
+    const arp_proxy_config& temp);
+
+  /*
+   * It's the OM class that calls singular()
+   */
+  friend class OM;
+
+  /**
+   * It's the singular_db class that calls replay()
+   */
+  friend class singular_db<arp_proxy_config::key_t, arp_proxy_config>;
+
+  /**
+   * Sweep/reap the object if still stale
+   */
+  void sweep(void);
+
+  /**
+   * replay the object to create it in hardware
+   */
+  void replay(void);
+
+  /**
+   * Address range
+   */
+  const boost::asio::ip::address_v4 m_low;
+  const boost::asio::ip::address_v4 m_high;
+
+  /**
+   * A map of all ArpProxy configs keyed against the interface.
+   */
+  static singular_db<arp_proxy_config::key_t, arp_proxy_config> m_db;
+
+  /**
+   * HW configuration for the config. The bool representing the
+   * do/don't configured/unconfigured.
+   */
+  HW::item<bool> m_config;
+};
+
+std::ostream& operator<<(std::ostream& os, const arp_proxy_config::key_t& key);
+};
+
+/*
+ * fd.io coding-style-patch-verification: ON
+ *
+ * Local Variables:
+ * eval: (c-set-style "mozilla")
+ * End:
+ */
+
+#endif