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_ACL_BINDING_H__
17 #define __VOM_ACL_BINDING_H__
21 #include "vom/acl_list.hpp"
22 #include "vom/acl_types.hpp"
24 #include "vom/inspect.hpp"
25 #include "vom/interface.hpp"
26 #include "vom/object_base.hpp"
28 #include "vom/singular_db.hpp"
33 * A binding between an ACL and an interface.
34 * A representation of the application of the ACL to the interface.
36 template <typename LIST>
37 class binding : public object_base
41 * The key for a binding is the direction and the interface
43 typedef std::pair<direction_t, interface::key_t> key_t;
46 * Construct a new object matching the desried state
48 binding(const direction_t& direction, const interface& itf, const LIST& acl)
49 : m_direction(direction)
50 , m_itf(itf.singular())
51 , m_acl(acl.singular())
60 binding(const binding& o)
61 : m_direction(o.m_direction)
74 m_db.release(std::make_pair(m_direction, m_itf->key()), this);
78 * Return the 'singular instance' of the L2 config that matches this
81 std::shared_ptr<binding> singular() const { return find_or_add(*this); }
84 * convert to string format for debug purposes
86 std::string to_string() const
89 s << "acl-binding:[" << m_direction.to_string() << " " << m_itf->to_string()
90 << " " << m_acl->to_string() << " " << m_binding.to_string() << "]";
96 * Dump all bindings into the stream provided
98 static void dump(std::ostream& os) { m_db.dump(os); }
102 * Class definition for listeners to OM events
104 class event_handler : public OM::listener, public inspect::command_handler
109 OM::register_listener(this);
110 inspect::register_handler({ "acl-binding" }, "ACL bindings", this);
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() { m_db.replay(); }
125 * Show the object in the Singular DB
127 void show(std::ostream& os) { m_db.dump(os); }
130 * Get the sortable Id of the listener
132 dependency_t order() const { return (dependency_t::BINDING); }
136 * event_handler to register with OM
138 static event_handler m_evh;
141 * Enquue commonds to the VPP command Q for the update
143 void update(const binding& obj);
146 * Find or Add the instance in the DB
148 static std::shared_ptr<binding> find_or_add(const binding& temp)
150 return (m_db.find_or_add(
151 std::make_pair(temp.m_direction, temp.m_itf->key()), temp));
155 * It's the OM class that calls singular()
157 friend class VOM::OM;
160 * It's the singular_db class that calls replay()
162 friend class singular_db<key_t, binding>;
165 * Sweep/reap the object if still stale
170 * Replay the objects state to HW
175 * The direction the of the packets on which to apply the ACL
178 const direction_t m_direction;
181 * A reference counting pointer the interface that this L3 layer
182 * represents. By holding the reference here, we can guarantee that
183 * this object will outlive the interface
185 const std::shared_ptr<interface> m_itf;
188 * A reference counting pointer the ACL that this
189 * interface is bound to. By holding the reference here, we can
190 * guarantee that this object will outlive the BD.
192 const std::shared_ptr<LIST> m_acl;
195 * HW configuration for the binding. The bool representing the
198 HW::item<bool> m_binding;
201 * A map of all L2 interfaces key against the interface's handle_t
203 static singular_db<key_t, binding> m_db;
207 * Typedef the L3 binding type
209 typedef binding<l3_list> l3_binding;
212 * Typedef the L2 binding type
214 typedef binding<l2_list> l2_binding;
217 * Definition of the static Singular DB for ACL bindings
219 template <typename LIST>
220 singular_db<typename ACL::binding<LIST>::key_t, ACL::binding<LIST>>
223 template <typename LIST>
224 typename ACL::binding<LIST>::event_handler binding<LIST>::m_evh;
227 std::ostream& operator<<(std::ostream& os,
228 const std::pair<direction_t, interface::key_t>& key);
232 * fd.io coding-style-patch-verification: ON
235 * eval: (c-set-style "mozilla")