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_BRIDGE_DOMAIN_H__
17 #define __VOM_GBP_BRIDGE_DOMAIN_H__
19 #include "vom/bridge_domain.hpp"
20 #include "vom/interface.hpp"
21 #include "vom/singular_db.hpp"
22 #include "vom/types.hpp"
27 * A entry in the ARP termination table of a Bridge Domain
29 class gbp_bridge_domain : public object_base
33 * The key for a bridge_domain is the pair of EPG-IDs
35 typedef bridge_domain::key_t key_t;
37 struct flags_t : enum_base<flags_t>
39 const static flags_t NONE;
40 const static flags_t DO_NOT_LEARN;
41 const static flags_t UU_FWD_DROP;
42 const static flags_t MCAST_DROP;
43 const static flags_t UCAST_ARP;
45 static const flags_t& from_vpp(int i);
48 flags_t(int v, const std::string& s);
53 * Construct a GBP bridge_domain
55 gbp_bridge_domain(const bridge_domain& bd,
57 const flags_t& flags = flags_t::NONE);
58 gbp_bridge_domain(const bridge_domain& bd,
60 const interface& uu_fwd,
61 const interface& bm_flood,
62 const flags_t& flags = flags_t::NONE);
63 gbp_bridge_domain(const bridge_domain& bd,
64 const std::shared_ptr<interface> bvi,
65 const std::shared_ptr<interface> uu_fwd,
66 const std::shared_ptr<interface> bm_flood,
67 const flags_t& flags = flags_t::NONE);
68 gbp_bridge_domain(const bridge_domain& bd,
70 const std::shared_ptr<interface> uu_fwd,
71 const std::shared_ptr<interface> bm_flood,
72 const flags_t& flags = flags_t::NONE);
77 gbp_bridge_domain(const gbp_bridge_domain& r);
85 * Return the object's key
87 const key_t key() const;
90 * Return the bridge domain's VPP ID
97 bool operator==(const gbp_bridge_domain& bdae) const;
100 * Return the matching 'singular instance'
102 std::shared_ptr<gbp_bridge_domain> singular() const;
105 * Find the instnace of the bridge_domain domain in the OM
107 static std::shared_ptr<gbp_bridge_domain> find(const key_t& k);
110 * Dump all bridge_domain-doamin into the stream provided
112 static void dump(std::ostream& os);
115 * replay the object to create it in hardware
120 * Convert to string for debugging
122 std::string to_string() const;
124 const std::shared_ptr<bridge_domain> get_bridge_domain() const;
125 const std::shared_ptr<interface> get_bvi() const;
129 * Class definition for listeners to OM events
131 class event_handler : public OM::listener, public inspect::command_handler
135 virtual ~event_handler() = default;
138 * Handle a populate event
140 void handle_populate(const client_db::key_t& key);
143 * Handle a replay event
145 void handle_replay();
148 * Show the object in the Singular DB
150 void show(std::ostream& os);
153 * Get the sortable Id of the listener
155 dependency_t order() const;
159 * event_handler to register with OM
161 static event_handler m_evh;
164 * Commit the acculmulated changes into VPP. i.e. to a 'HW" write.
166 void update(const gbp_bridge_domain& obj);
169 * Find or add the instance of the bridge_domain domain in the OM
171 static std::shared_ptr<gbp_bridge_domain> find_or_add(
172 const gbp_bridge_domain& temp);
175 * It's the VPPHW class that updates the objects in HW
180 * It's the singular_db class that calls replay()
182 friend class singular_db<key_t, gbp_bridge_domain>;
185 * Sweep/reap the object if still stale
190 * HW configuration for the result of creating the endpoint
192 HW::item<uint32_t> m_id;
194 std::shared_ptr<bridge_domain> m_bd;
195 std::shared_ptr<interface> m_bvi;
196 std::shared_ptr<interface> m_uu_fwd;
197 std::shared_ptr<interface> m_bm_flood;
198 const flags_t& m_flags;
201 * A map of all bridge_domains
203 static singular_db<key_t, gbp_bridge_domain> m_db;
209 * fd.io coding-style-patch-verification: ON
212 * eval: (c-set-style "mozilla")