aboutsummaryrefslogtreecommitdiffstats
path: root/src/vpp-api/vom/vxlan_tunnel.hpp
diff options
context:
space:
mode:
authorNeale Ranns <neale.ranns@cisco.com>2017-10-16 04:20:13 -0700
committerDamjan Marion <dmarion.lists@gmail.com>2017-11-01 09:28:06 +0000
commit812ed39f9da336310e815c361ab5a9f118657d94 (patch)
tree9d8cddc917acbb65b3dc401d880d5eb2a7f392c6 /src/vpp-api/vom/vxlan_tunnel.hpp
parent14edd97c20735ffd1c24000a7df78e154ac61478 (diff)
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>
Diffstat (limited to 'src/vpp-api/vom/vxlan_tunnel.hpp')
-rw-r--r--src/vpp-api/vom/vxlan_tunnel.hpp331
1 files changed, 331 insertions, 0 deletions
diff --git a/src/vpp-api/vom/vxlan_tunnel.hpp b/src/vpp-api/vom/vxlan_tunnel.hpp
new file mode 100644
index 00000000000..845cd6aee45
--- /dev/null
+++ b/src/vpp-api/vom/vxlan_tunnel.hpp
@@ -0,0 +1,331 @@
+/*
+ * 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_VXLAN_TUNNEL_H__
+#define __VOM_VXLAN_TUNNEL_H__
+
+#include "vom/hw.hpp"
+#include "vom/inspect.hpp"
+#include "vom/interface.hpp"
+#include "vom/object_base.hpp"
+#include "vom/om.hpp"
+#include "vom/prefix.hpp"
+#include "vom/route_domain.hpp"
+#include "vom/rpc_cmd.hpp"
+#include "vom/singular_db.hpp"
+
+#include <vapi/vxlan.api.vapi.hpp>
+
+namespace VOM {
+/**
+ * A representation of a VXLAN Tunnel in VPP
+ */
+class vxlan_tunnel : public interface
+{
+public:
+ /**
+ * Combaintion of attributes that are a unique key
+ * for a VXLAN tunnel
+ */
+ struct endpoint_t
+ {
+ /**
+ * Default constructor
+ */
+ endpoint_t();
+ /**
+ * Constructor taking endpoint values
+ */
+ endpoint_t(const boost::asio::ip::address& src,
+ const boost::asio::ip::address& dst,
+ uint32_t vni);
+
+ /**
+ * less-than operator for map storage
+ */
+ bool operator<(const endpoint_t& o) const;
+
+ /**
+ * Comparison operator
+ */
+ bool operator==(const endpoint_t& o) const;
+
+ /**
+ * Debug print function
+ */
+ std::string to_string() const;
+
+ /**
+ * The src IP address of the endpoint
+ */
+ boost::asio::ip::address src;
+
+ /**
+ * The destination IP address of the endpoint
+ */
+ boost::asio::ip::address dst;
+
+ /**
+ * The VNI of the endpoint
+ */
+ uint32_t vni;
+ };
+
+ /**
+ * Construct a new object matching the desried state
+ */
+ vxlan_tunnel(const boost::asio::ip::address& src,
+ const boost::asio::ip::address& dst,
+ uint32_t vni);
+
+ /**
+ * Construct a new object matching the desried state with a handle
+ * read from VPP
+ */
+ vxlan_tunnel(const handle_t& hdl,
+ const boost::asio::ip::address& src,
+ const boost::asio::ip::address& dst,
+ uint32_t vni);
+
+ /*
+ * Destructor
+ */
+ ~vxlan_tunnel();
+
+ /**
+ * Copy constructor
+ */
+ vxlan_tunnel(const vxlan_tunnel& o);
+
+ /**
+ * Return the matching 'singular instance'
+ */
+ std::shared_ptr<vxlan_tunnel> singular() const;
+
+ /**
+ * Debug rpint function
+ */
+ virtual std::string to_string() const;
+
+ /**
+ * Return VPP's handle to this object
+ */
+ const handle_t& handle() const;
+
+ /**
+ * Dump all L3Configs into the stream provided
+ */
+ static void dump(std::ostream& os);
+
+ /**
+ * A Command class that creates an VXLAN tunnel
+ */
+ class create_cmd : public interface::create_cmd<vapi::Vxlan_add_del_tunnel>
+ {
+ public:
+ /**
+ * Create command constructor taking HW item to update and the
+ * endpoint values
+ */
+ create_cmd(HW::item<handle_t>& item,
+ const std::string& name,
+ const endpoint_t& ep);
+
+ /**
+ * 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:
+ /**
+ * Enpoint values of the tunnel to be created
+ */
+ const endpoint_t m_ep;
+ };
+
+ /**
+ * A functor class that creates an VXLAN tunnel
+ */
+ class delete_cmd : public interface::delete_cmd<vapi::Vxlan_add_del_tunnel>
+ {
+ public:
+ /**
+ * delete command constructor taking HW item to update and the
+ * endpoint values
+ */
+ delete_cmd(HW::item<handle_t>& item, const endpoint_t& ep);
+
+ /**
+ * 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:
+ /**
+ * Enpoint values of the tunnel to be deleted
+ */
+ const endpoint_t m_ep;
+ };
+
+ /**
+ * A cmd class that Dumps all the Vpp interfaces
+ */
+ class dump_cmd : public VOM::dump_cmd<vapi::Vxlan_tunnel_dump>
+ {
+ public:
+ /**
+ * Default Constructor
+ */
+ dump_cmd();
+
+ /**
+ * 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 dump_cmd& i) const;
+ };
+
+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 handle to register with OM
+ */
+ static event_handler m_evh;
+
+ /**
+ * Commit the acculmulated changes into VPP. i.e. to a 'HW" write.
+ */
+ void update(const vxlan_tunnel& obj);
+
+ /**
+ * Return the matching 'instance' of the sub-interface
+ * over-ride from the base class
+ */
+ std::shared_ptr<interface> singular_i() const;
+
+ /**
+ * Find the VXLAN tunnel in the OM
+ */
+ static std::shared_ptr<vxlan_tunnel> find_or_add(const vxlan_tunnel& temp);
+
+ /*
+ * It's the VPPHW class that updates the objects in HW
+ */
+ friend class OM;
+
+ /**
+ * It's the singular_db class that calls replay()
+ */
+ friend class singular_db<endpoint_t, vxlan_tunnel>;
+
+ /**
+ * Sweep/reap the object if still stale
+ */
+ void sweep(void);
+
+ /**
+ * replay the object to create it in hardware
+ */
+ void replay(void);
+
+ /**
+ * Tunnel enpoint/key
+ */
+ endpoint_t m_tep;
+
+ /**
+ * A map of all VLAN tunnela against thier key
+ */
+ static singular_db<endpoint_t, vxlan_tunnel> m_db;
+
+ /**
+ * Construct a unique name for the tunnel
+ */
+ static std::string mk_name(const boost::asio::ip::address& src,
+ const boost::asio::ip::address& dst,
+ uint32_t vni);
+};
+
+/**
+ * Ostream output for a tunnel endpoint
+ */
+std::ostream& operator<<(std::ostream& os, const vxlan_tunnel::endpoint_t& ep);
+};
+
+/*
+ * fd.io coding-style-patch-verification: ON
+ *
+ * Local Variables:
+ * eval: (c-set-style "mozilla")
+ * End:
+ */
+
+#endif