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_ENDPOINT_GROUP_H__
17 #define __VOM_GBP_ENDPOINT_GROUP_H__
19 #include "vom/interface.hpp"
20 #include "vom/singular_db.hpp"
21 #include "vom/types.hpp"
23 #include "vom/gbp_bridge_domain.hpp"
24 #include "vom/gbp_route_domain.hpp"
29 * EPG IDs are 32 bit integers
31 typedef uint32_t epg_id_t;
34 * A entry in the ARP termination table of a Bridge Domain
36 class gbp_endpoint_group : public object_base
40 * The key for a GBP endpoint group is its ID
42 typedef epg_id_t key_t;
45 * Construct a GBP endpoint_group
47 gbp_endpoint_group(epg_id_t epg_id,
49 const gbp_route_domain& rd,
50 const gbp_bridge_domain& bd);
51 gbp_endpoint_group(epg_id_t epg_id,
52 const gbp_route_domain& rd,
53 const gbp_bridge_domain& bd);
54 gbp_endpoint_group(epg_id_t epg_id,
57 const gbp_route_domain& rd,
58 const gbp_bridge_domain& bd);
59 gbp_endpoint_group(epg_id_t epg_id,
61 const gbp_route_domain& rd,
62 const gbp_bridge_domain& bd);
67 gbp_endpoint_group(const gbp_endpoint_group& r);
72 ~gbp_endpoint_group();
75 * Return the object's key
77 const key_t key() const;
82 bool operator==(const gbp_endpoint_group& bdae) const;
85 * Return the matching 'singular instance'
87 std::shared_ptr<gbp_endpoint_group> singular() const;
90 * Find the instnace of the bridge_domain domain in the OM
92 static std::shared_ptr<gbp_endpoint_group> find(const key_t& k);
95 * Dump all bridge_domain-doamin into the stream provided
97 static void dump(std::ostream& os);
100 * replay the object to create it in hardware
105 * Convert to string for debugging
107 std::string to_string() const;
110 * Get the ID of the EPG
114 const std::shared_ptr<gbp_route_domain> get_route_domain() const;
115 const std::shared_ptr<gbp_bridge_domain> get_bridge_domain() const;
119 * Class definition for listeners to OM events
121 class event_handler : public OM::listener, public inspect::command_handler
125 virtual ~event_handler() = default;
128 * Handle a populate event
130 void handle_populate(const client_db::key_t& key);
133 * Handle a replay event
135 void handle_replay();
138 * Show the object in the Singular DB
140 void show(std::ostream& os);
143 * Get the sortable Id of the listener
145 dependency_t order() const;
149 * event_handler to register with OM
151 static event_handler m_evh;
154 * Commit the acculmulated changes into VPP. i.e. to a 'HW" write.
156 void update(const gbp_endpoint_group& obj);
159 * Find or add the instnace of the bridge_domain domain in the OM
161 static std::shared_ptr<gbp_endpoint_group> find_or_add(
162 const gbp_endpoint_group& temp);
165 * It's the VPPHW class that updates the objects in HW
170 * It's the singular_db class that calls replay()
172 friend class singular_db<key_t, gbp_endpoint_group>;
175 * Sweep/reap the object if still stale
180 * HW configuration for the result of creating the endpoint_group
190 * The SClass on the wire
195 * The uplink interface for the endpoint group
197 std::shared_ptr<interface> m_itf;
200 * The route-domain the EPG uses
202 std::shared_ptr<gbp_route_domain> m_rd;
205 * The bridge-domain the EPG uses
207 std::shared_ptr<gbp_bridge_domain> m_bd;
210 * A map of all bridge_domains
212 static singular_db<key_t, gbp_endpoint_group> m_db;
218 * fd.io coding-style-patch-verification: ON
221 * eval: (c-set-style "mozilla")