FD.io VPP  v18.01.2-1-g9b554f3
Vector Packet Processing
acl_binding.hpp
Go to the documentation of this file.
1 /*
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:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
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.
14  */
15 
16 #ifndef __VOM_ACL_BINDING_H__
17 #define __VOM_ACL_BINDING_H__
18 
19 #include <ostream>
20 
21 #include "vom/acl_list.hpp"
22 #include "vom/acl_types.hpp"
23 #include "vom/hw.hpp"
24 #include "vom/inspect.hpp"
25 #include "vom/interface.hpp"
26 #include "vom/object_base.hpp"
27 #include "vom/om.hpp"
28 #include "vom/singular_db.hpp"
29 
30 namespace VOM {
31 namespace ACL {
32 /**
33  * A binding between an ACL and an interface.
34  * A representation of the application of the ACL to the interface.
35  */
36 template <typename LIST>
37 class binding : public object_base
38 {
39 public:
40  /**
41  * The key for a binding is the direction and the interface
42  */
43  typedef std::pair<direction_t, interface::key_t> key_t;
44 
45  /**
46  * Construct a new object matching the desried state
47  */
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())
52  , m_binding(0)
53  {
54  m_evh.order();
55  }
56 
57  /**
58  * Copy Constructor
59  */
60  binding(const binding& o)
61  : m_direction(o.m_direction)
62  , m_itf(o.m_itf)
63  , m_acl(o.m_acl)
64  , m_binding(0)
65  {
66  }
67 
68  /**
69  * Destructor
70  */
72  {
73  sweep();
74  m_db.release(std::make_pair(m_direction, m_itf->key()), this);
75  }
76 
77  /**
78  * Return the 'singular instance' of the L2 config that matches this
79  * object
80  */
81  std::shared_ptr<binding> singular() const { return find_or_add(*this); }
82 
83  /**
84  * convert to string format for debug purposes
85  */
86  std::string to_string() const
87  {
88  std::ostringstream s;
89  s << "acl-binding:[" << m_direction.to_string() << " " << m_itf->to_string()
90  << " " << m_acl->to_string() << " " << m_binding.to_string() << "]";
91 
92  return (s.str());
93  }
94 
95  /**
96  * Dump all bindings into the stream provided
97  */
98  static void dump(std::ostream& os) { m_db.dump(os); }
99 
100 private:
101  /**
102  * Class definition for listeners to OM events
103  */
104  class event_handler : public OM::listener, public inspect::command_handler
105  {
106  public:
107  event_handler()
108  {
109  OM::register_listener(this);
110  inspect::register_handler({ "acl-binding" }, "ACL bindings", this);
111  }
112  virtual ~event_handler() = default;
113 
114  /**
115  * Handle a populate event
116  */
117  void handle_populate(const client_db::key_t& key);
118 
119  /**
120  * Handle a replay event
121  */
122  void handle_replay() { m_db.replay(); }
123 
124  /**
125  * Show the object in the Singular DB
126  */
127  void show(std::ostream& os) { m_db.dump(os); }
128 
129  /**
130  * Get the sortable Id of the listener
131  */
132  dependency_t order() const { return (dependency_t::BINDING); }
133  };
134 
135  /**
136  * event_handler to register with OM
137  */
138  static event_handler m_evh;
139 
140  /**
141  * Enquue commonds to the VPP command Q for the update
142  */
143  void update(const binding& obj);
144 
145  /**
146  * Find or Add the instance in the DB
147  */
148  static std::shared_ptr<binding> find_or_add(const binding& temp)
149  {
150  return (m_db.find_or_add(
151  std::make_pair(temp.m_direction, temp.m_itf->key()), temp));
152  }
153 
154  /*
155  * It's the OM class that calls singular()
156  */
157  friend class VOM::OM;
158 
159  /**
160  * It's the singular_db class that calls replay()
161  */
162  friend class singular_db<key_t, binding>;
163 
164  /**
165  * Sweep/reap the object if still stale
166  */
167  void sweep(void);
168 
169  /**
170  * Replay the objects state to HW
171  */
172  void replay(void);
173 
174  /**
175  * The direction the of the packets on which to apply the ACL
176  * input or output
177  */
178  const direction_t m_direction;
179 
180  /**
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
184  */
185  const std::shared_ptr<interface> m_itf;
186 
187  /**
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.
191  */
192  const std::shared_ptr<LIST> m_acl;
193 
194  /**
195  * HW configuration for the binding. The bool representing the
196  * do/don't bind.
197  */
198  HW::item<bool> m_binding;
199 
200  /**
201  * A map of all L2 interfaces key against the interface's handle_t
202  */
203  static singular_db<key_t, binding> m_db;
204 };
205 
206 /**
207  * Typedef the L3 binding type
208  */
210 
211 /**
212  * Typedef the L2 binding type
213  */
215 
216 /**
217  * Definition of the static Singular DB for ACL bindings
218  */
219 template <typename LIST>
222 
223 template <typename LIST>
225 };
226 
227 std::ostream& operator<<(std::ostream& os,
228  const std::pair<direction_t, interface::key_t>& key);
229 };
230 
231 /*
232  * fd.io coding-style-patch-verification: ON
233  *
234  * Local Variables:
235  * eval: (c-set-style "mozilla")
236  * End:
237  */
238 
239 #endif
binding< l2_list > l2_binding
Typedef the L2 binding type.
std::shared_ptr< binding > singular() const
Return the &#39;singular instance&#39; of the L2 config that matches this object.
Definition: acl_binding.hpp:81
std::pair< direction_t, interface::key_t > key_t
The key for a binding is the direction and the interface.
Definition: acl_binding.hpp:43
const std::string key_t
In the opflex world each entity is known by a URI which can be converted into a string.
Definition: client_db.hpp:51
static void register_handler(const std::vector< std::string > &cmds, const std::string &help, command_handler *ch)
Register a command handler for inspection.
Definition: inspect.cpp:85
static void dump(std::ostream &os)
Dump all bindings into the stream provided.
Definition: acl_binding.hpp:98
std::string to_string() const
convert to string format for debug purposes
Definition: hw.hpp:160
Feature Directions.
Definition: types.hpp:133
binding(const binding &o)
Copy Constructor.
Definition: acl_binding.hpp:60
A Database to store the unique &#39;singular&#39; instances of a single object type.
Definition: singular_db.hpp:32
A representation of an interface in VPP.
Definition: interface.hpp:41
Class definition for listeners to OM events.
Definition: om.hpp:284
inspect command handler Handler
Definition: inspect.hpp:54
dependency_t
There needs to be a strict order in which object types are read from VPP (at boot time) and replayed ...
Definition: types.hpp:43
binding< l3_list > l3_binding
Typedef the L3 binding type.
~binding()
Destructor.
Definition: acl_binding.hpp:71
The interface to writing objects into VPP OM.
Definition: om.hpp:140
A base class for all object_base in the VPP object_base-Model.
Definition: object_base.hpp:29
std::ostream & operator<<(std::ostream &os, const std::pair< direction_t, interface::key_t > &key)
Then L2/objects that bind to interfaces, BD, ACLS, etc.
The VPP Object Model (VOM) library.
Definition: acl_binding.cpp:19
std::string to_string() const
convert to string format for debug purposes
Definition: acl_binding.hpp:86
void show(char *chroot_path, int verbose)
Definition: svmtool.c:105
const std::string & to_string() const
convert to string format for debug purposes
Definition: enum_base.hpp:36
A binding between an ACL and an interface.
Definition: acl_binding.hpp:37
static bool register_listener(listener *listener)
Register a listener of events.
Definition: om.cpp:124
binding(const direction_t &direction, const interface &itf, const LIST &acl)
Construct a new object matching the desried state.
Definition: acl_binding.hpp:48