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_GBP_VXLAN_H__
17 #define __VOM_GBP_VXLAN_H__
19 #include "vom/gbp_bridge_domain.hpp"
20 #include "vom/gbp_route_domain.hpp"
22 #include "vom/inspect.hpp"
23 #include "vom/interface.hpp"
24 #include "vom/singular_db.hpp"
28 * A representation of a GBP_VXLAN Tunnel in VPP
30 class gbp_vxlan : public interface
36 typedef uint32_t key_t;
39 * Construct a new object matching the desried state
41 gbp_vxlan(uint32_t vni, const gbp_bridge_domain& gbd);
42 gbp_vxlan(uint32_t vni, const gbp_route_domain& grd);
52 gbp_vxlan(const gbp_vxlan& o);
54 bool operator==(const gbp_vxlan& vt) const;
57 * Return the matching 'singular instance'
59 std::shared_ptr<gbp_vxlan> singular() const;
62 * Return the object's key
64 const key_t key() const;
67 * Debug rpint function
69 virtual std::string to_string() const;
72 * Return VPP's handle to this object
74 const handle_t& handle() const;
77 * Dump all L3Configs into the stream provided
79 static void dump(std::ostream& os);
82 * Find the GBP_VXLAN tunnel in the OM
84 static std::shared_ptr<gbp_vxlan> find(const key_t k);
88 * Class definition for listeners to OM events
90 class event_handler : public OM::listener, public inspect::command_handler
94 virtual ~event_handler() = default;
97 * Handle a populate event
99 void handle_populate(const client_db::key_t& key);
102 * Handle a replay event
104 void handle_replay();
107 * Show the object in the Singular DB
109 void show(std::ostream& os);
112 * Get the sortable Id of the listener
114 dependency_t order() const;
118 * Event handle to register with OM
120 static event_handler m_evh;
123 * Commit the acculmulated changes into VPP. i.e. to a 'HW" write.
125 void update(const gbp_vxlan& obj);
128 * Return the matching 'instance' of the sub-interface
129 * over-ride from the base class
131 std::shared_ptr<interface> singular_i() const;
134 * Find the GBP_VXLAN tunnel in the OM
136 static std::shared_ptr<gbp_vxlan> find_or_add(const gbp_vxlan& temp);
139 * It's the VPPHW class that updates the objects in HW
144 * It's the singular_db class that calls replay()
146 friend class singular_db<key_t, gbp_vxlan>;
149 * Sweep/reap the object if still stale
154 * replay the object to create it in hardware
162 std::shared_ptr<gbp_bridge_domain> m_gbd;
163 std::shared_ptr<gbp_route_domain> m_grd;
166 * A map of all VLAN tunnela against thier key
168 static singular_db<key_t, gbp_vxlan> m_db;
171 * Construct a unique name for the tunnel
173 static std::string mk_name(uint32_t vni);
179 * fd.io coding-style-patch-verification: ON
182 * eval: (c-set-style "mozilla")