2 * Copyright (c) 2017 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 #ifndef __VOM_VXLAN_TUNNEL_H__
17 #define __VOM_VXLAN_TUNNEL_H__
20 #include "vom/inspect.hpp"
21 #include "vom/interface.hpp"
22 #include "vom/object_base.hpp"
24 #include "vom/prefix.hpp"
25 #include "vom/route_domain.hpp"
26 #include "vom/singular_db.hpp"
30 * A representation of a VXLAN Tunnel in VPP
32 class vxlan_tunnel : public interface
36 * Combaintion of attributes that are a unique key
46 * Constructor taking endpoint values
48 endpoint_t(const boost::asio::ip::address& src,
49 const boost::asio::ip::address& dst,
55 bool operator==(const endpoint_t& o) const;
58 * Debug print function
60 std::string to_string() const;
63 * The src IP address of the endpoint
65 boost::asio::ip::address src;
68 * The destination IP address of the endpoint
70 boost::asio::ip::address dst;
73 * The VNI of the endpoint
81 struct mode_t : public enum_base<mode_t>
84 const static mode_t STANDARD;
85 const static mode_t GBP;
86 const static mode_t GPE;
89 mode_t(int v, const std::string s);
94 * Construct a new object matching the desried state
96 vxlan_tunnel(const boost::asio::ip::address& src,
97 const boost::asio::ip::address& dst,
99 const mode_t& mode = mode_t::STANDARD);
102 * Construct a new object matching the desried state with a handle
105 vxlan_tunnel(const handle_t& hdl,
106 const boost::asio::ip::address& src,
107 const boost::asio::ip::address& dst,
109 const mode_t& mode = mode_t::STANDARD);
119 vxlan_tunnel(const vxlan_tunnel& o);
122 * Return the matching 'singular instance'
124 std::shared_ptr<vxlan_tunnel> singular() const;
127 * Debug rpint function
129 virtual std::string to_string() const;
132 * Return VPP's handle to this object
134 const handle_t& handle() const;
137 * Fond the singular instance of the interface in the DB by key
139 static std::shared_ptr<vxlan_tunnel> find(const interface::key_t& k);
143 * Class definition for listeners to OM events
145 class event_handler : public OM::listener, public inspect::command_handler
149 virtual ~event_handler() = default;
152 * Handle a populate event
154 void handle_populate(const client_db::key_t& key);
157 * Handle a replay event
159 void handle_replay();
162 * Show the object in the Singular DB
164 void show(std::ostream& os);
167 * Get the sortable Id of the listener
169 dependency_t order() const;
173 * Event handle to register with OM
175 static event_handler m_evh;
178 * Commit the acculmulated changes into VPP. i.e. to a 'HW" write.
180 void update(const vxlan_tunnel& obj);
183 * Return the matching 'instance' of the sub-interface
184 * over-ride from the base class
186 std::shared_ptr<interface> singular_i() const;
189 * Find the VXLAN tunnel in the OM
191 static std::shared_ptr<vxlan_tunnel> find_or_add(const vxlan_tunnel& temp);
194 * It's the VPPHW class that updates the objects in HW
199 * It's the singular_db class that calls replay()
201 friend class singular_db<endpoint_t, vxlan_tunnel>;
204 * Sweep/reap the object if still stale
209 * replay the object to create it in hardware
224 * Construct a unique name for the tunnel
226 static std::string mk_name(const boost::asio::ip::address& src,
227 const boost::asio::ip::address& dst,
233 * Ostream output for a tunnel endpoint
235 std::ostream& operator<<(std::ostream& os, const vxlan_tunnel::endpoint_t& ep);
240 * fd.io coding-style-patch-verification: ON
243 * eval: (c-set-style "mozilla")