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_CONTRACT_H__
17 #define __VOM_GBP_CONTRACT_H__
19 #include "vom/acl_l3_list.hpp"
20 #include "vom/gbp_rule.hpp"
21 #include "vom/gbp_types.hpp"
22 #include "vom/interface.hpp"
23 #include "vom/singular_db.hpp"
24 #include "vom/types.hpp"
29 * A entry in the ARP termination table of a Bridge Domain
31 class gbp_contract : public object_base
37 typedef std::set<gbp_rule> gbp_rules_t;
40 * The key for a contract is the pair of EPG-IDs
42 typedef std::tuple<scope_t, sclass_t, sclass_t> key_t;
45 * A set of allowed ethertypes
47 typedef std::set<ethertype_t> ethertype_set_t;
50 * Construct a GBP contract
52 gbp_contract(scope_t scope,
55 const ACL::l3_list& acl,
56 const gbp_rules_t& gpb_rules,
57 const ethertype_set_t& allowed_ethertypes);
62 gbp_contract(const gbp_contract& r);
70 * Return the object's key
72 const key_t key() const;
77 bool operator==(const gbp_contract& bdae) const;
80 * Return the matching 'singular instance'
82 std::shared_ptr<gbp_contract> singular() const;
85 * Find the instnace of the bridge_domain domain in the OM
87 static std::shared_ptr<gbp_contract> find(const key_t& k);
90 * Dump all bridge_domain-doamin into the stream provided
92 static void dump(std::ostream& os);
95 * replay the object to create it in hardware
100 * Convert to string for debugging
102 std::string to_string() const;
106 * Class definition for listeners to OM events
108 class event_handler : public OM::listener, public inspect::command_handler
112 virtual ~event_handler() = default;
115 * Handle a populate event
117 void handle_populate(const client_db::key_t& key);
120 * Handle a replay event
122 void handle_replay();
125 * Show the object in the Singular DB
127 void show(std::ostream& os);
130 * Get the sortable Id of the listener
132 dependency_t order() const;
136 * event_handler to register with OM
138 static event_handler m_evh;
141 * Commit the acculmulated changes into VPP. i.e. to a 'HW" write.
143 void update(const gbp_contract& obj);
146 * Find or add the instance of the contract domain in the OM
148 static std::shared_ptr<gbp_contract> find_or_add(const gbp_contract& temp);
151 * It's the VPPHW class that updates the objects in HW
156 * It's the singular_db class that calls replay()
158 friend class singular_db<key_t, gbp_contract>;
161 * Sweep/reap the object if still stale
166 * HW configuration for the result of creating the endpoint
168 HW::item<uint32_t> m_hw;
171 * The scope of the contract
181 * The destination EPG ID
186 * The ACL applied to traffic between the gourps
188 std::shared_ptr<ACL::l3_list> m_acl;
191 * The gbp rules applied to traffic between the gourps
193 gbp_rules_t m_gbp_rules;
196 * the set of Ether-types allowed by this contract
198 ethertype_set_t m_allowed_ethertypes;
201 * A map of all bridge_domains
203 static singular_db<key_t, gbp_contract> m_db;
206 std::ostream& operator<<(std::ostream& os, const gbp_contract::key_t& key);
210 * fd.io coding-style-patch-verification: ON
213 * eval: (c-set-style "mozilla")