aboutsummaryrefslogtreecommitdiffstats
path: root/src/vpp-api/vom/acl_binding.hpp
blob: faf9b245cae6d9b7c668a6d7cc7ac3c88f3c1994 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
/*
 * Copyright (c) 2017 Cisco and/or its affiliates.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef __VOM_ACL_BINDING_H__
#define __VOM_ACL_BINDING_H__

#include <ostream>

#include "vom/acl_list.hpp"
#include "vom/acl_types.hpp"
#include "vom/hw.hpp"
#include "vom/inspect.hpp"
#include "vom/interface.hpp"
#include "vom/object_base.hpp"
#include "vom/om.hpp"
#include "vom/rpc_cmd.hpp"
#include "vom/singular_db.hpp"

namespace VOM {
namespace ACL {
/**
 * A binding between an ACL and an interface.
 * A representation of the application of the ACL to the interface.
 */
template <typename LIST, typename BIND, typename DUMP>
class binding : public object_base
{
public:
  /**
   * The key for a binding is the direction and the interface
   */
  typedef std::pair<direction_t, interface::key_type> key_t;

  /**
   * Construct a new object matching the desried state
   */
  binding(const direction_t& direction, const interface& itf, const LIST& acl)
    : m_direction(direction)
    , m_itf(itf.singular())
    , m_acl(acl.singular())
    , m_binding(0)
  {
    m_evh.order();
  }

  /**
   * Copy Constructor
   */
  binding(const binding& o)
    : m_direction(o.m_direction)
    , m_itf(o.m_itf)
    , m_acl(o.m_acl)
    , m_binding(0)
  {
  }

  /**
   * Destructor
   */
  ~binding()
  {
    sweep();
    m_db.release(std::make_pair(m_direction, m_itf->key()), this);
  }

  /**
   * Return the 'singular instance' of the L2 config that matches this
   * object
   */
  std::shared_ptr<binding> singular() const { return find_or_add(*this); }

  /**
   * convert to string format for debug purposes
   */
  std::string to_string() const
  {
    std::ostringstream s;
    s << "acl-binding:[" << m_direction.to_string() << " " << m_itf->to_string()
      << " " << m_acl->to_string() << " " << m_binding.to_string() << "]";

    return (s.str());
  }

  /**
   * Dump all bindings into the stream provided
   */
  static void dump(std::ostream& os) { m_db.dump(os); }

  /**
   * A command class that binds the ACL to the interface
   */
  class bind_cmd : public rpc_cmd<HW::item<bool>, rc_t, BIND>
  {
  public:
    /**
     * Constructor
     */
    bind_cmd(HW::item<bool>& item,
             const direction_t& direction,
             const handle_t& itf,
             const handle_t& acl)
      : rpc_cmd<HW::item<bool>, rc_t, BIND>(item)
      , m_direction(direction)
      , m_itf(itf)
      , m_acl(acl)
    {
    }

    /**
     * Issue the command to VPP/HW
     */
    rc_t issue(connection& con);

    /**
     * convert to string format for debug purposes
     */
    std::string to_string() const
    {
      std::ostringstream s;
      s << "acl-bind:[" << m_direction.to_string()
        << " itf:" << m_itf.to_string() << " acl:" << m_acl.to_string() << "]";

      return (s.str());
    }

    /**
     * Comparison operator - only used for UT
     */
    bool operator==(const bind_cmd& other) const
    {
      return ((m_itf == other.m_itf) && (m_acl == m_acl));
    }

  private:
    /**
     * The direction of the binding
     */
    const direction_t m_direction;

    /**
     * The interface to bind to
     */
    const handle_t m_itf;

    /**
     * The ACL to bind
     */
    const handle_t m_acl;
  };

  /**
   * A command class that binds the ACL to the interface
   */
  class unbind_cmd : public rpc_cmd<HW::item<bool>, rc_t, BIND>
  {
  public:
    /**
     * Constructor
     */
    unbind_cmd(HW::item<bool>& item,
               const direction_t& direction,
               const handle_t& itf,
               const handle_t& acl)
      : rpc_cmd<HW::item<bool>, rc_t, BIND>(item)
      , m_direction(direction)
      , m_itf(itf)
      , m_acl(acl)
    {
    }

    /**
     * Issue the command to VPP/HW
     */
    rc_t issue(connection& con);

    /**
     * convert to string format for debug purposes
     */
    std::string to_string() const
    {
      std::ostringstream s;
      s << "acl-unbind:[" << m_direction.to_string()
        << " itf:" << m_itf.to_string() << " acl:" << m_acl.to_string() << "]";

      return (s.str());
    }

    /**
     * Comparison operator - only used for UT
     */
    bool operator==(const unbind_cmd& other) const
    {
      return ((m_itf == other.m_itf) && (m_acl == m_acl));
    }

  private:
    /**
     * The direction of the binding
     */
    const direction_t m_direction;

    /**
     * The interface to bind to
     */
    const handle_t m_itf;

    /**
     * The ACL to bind
     */
    const handle_t m_acl;
  };

  /**
   * A cmd class that Dumps all the ACLs
   */
  class dump_cmd : public VOM::dump_cmd<DUMP>
  {
  public:
    /**
     * Constructor
     */
    dump_cmd() = default;
    dump_cmd(const dump_cmd& d) = default;

    /**
     * Issue the command to VPP/HW
     */
    rc_t issue(connection& con);

    /**
     * convert to string format for debug purposes
     */
    std::string to_string() const { return ("acl-bind-dump"); }

  private:
    /**
     * HW reutrn code
     */
    HW::item<bool> item;
  };

private:
  /**
   * Class definition for listeners to OM events
   */
  class event_handler : public OM::listener, public inspect::command_handler
  {
  public:
    event_handler()
    {
      OM::register_listener(this);
      inspect::register_handler({ "acl-binding" }, "ACL bindings", this);
    }
    virtual ~event_handler() = default;

    /**
     * Handle a populate event
     */
    void handle_populate(const client_db::key_t& key);

    /**
     * Handle a replay event
     */
    void handle_replay() { m_db.replay(); }

    /**
     * Show the object in the Singular DB
     */
    void show(std::ostream& os) { m_db.dump(os); }

    /**
     * Get the sortable Id of the listener
     */
    dependency_t order() const { return (dependency_t::BINDING); }
  };

  /**
   * event_handler to register with OM
   */
  static event_handler m_evh;

  /**
   * Enquue commonds to the VPP command Q for the update
   */
  void update(const binding& obj)
  {
    if (!m_binding) {
      HW::enqueue(
        new bind_cmd(m_binding, m_direction, m_itf->handle(), m_acl->handle()));
    }
    HW::write();
  }

  /**
   * Find or Add the instance in the DB
   */
  static std::shared_ptr<binding> find_or_add(const binding& temp)
  {
    return (m_db.find_or_add(
      std::make_pair(temp.m_direction, temp.m_itf->key()), temp));
  }

  /*
   * It's the OM class that calls singular()
   */
  friend class VOM::OM;

  /**
   * It's the singular_db class that calls replay()
   */
  friend class singular_db<key_t, binding>;

  /**
   * Sweep/reap the object if still stale
   */
  void sweep(void)
  {
    if (m_binding) {
      HW::enqueue(new unbind_cmd(m_binding, m_direction, m_itf->handle(),
                                 m_acl->handle()));
    }
    HW::write();
  }

  /**
   * Replay the objects state to HW
   */
  void replay(void)
  {
    if (m_binding) {
      HW::enqueue(
        new bind_cmd(m_binding, m_direction, m_itf->handle(), m_acl->handle()));
    }
  }

  /**
   * The direction the of the packets on which to apply the ACL
   * input or output
   */
  const direction_t m_direction;

  /**
   * A reference counting pointer the interface that this L3 layer
   * represents. By holding the reference here, we can guarantee that
   * this object will outlive the interface
   */
  const std::shared_ptr<interface> m_itf;

  /**
   * A reference counting pointer the ACL that this
   * interface is bound to. By holding the reference here, we can
   * guarantee that this object will outlive the BD.
   */
  const std::shared_ptr<LIST> m_acl;

  /**
   * HW configuration for the binding. The bool representing the
   * do/don't bind.
   */
  HW::item<bool> m_binding;

  /**
   * A map of all L2 interfaces key against the interface's handle_t
   */
  static singular_db<key_t, binding> m_db;
};

/**
 * Typedef the L3 binding type
 */
typedef binding<l3_list,
                vapi::Acl_interface_add_del,
                vapi::Acl_interface_list_dump>
  l3_binding;

/**
 * Typedef the L2 binding type
 */
typedef binding<l2_list,
                vapi::Macip_acl_interface_add_del,
                vapi::Macip_acl_interface_list_dump>
  l2_binding;

/**
 * Definition of the static Singular DB for ACL bindings
 */
template <typename LIST, typename BIND, typename DUMP>
singular_db<typename ACL::binding<LIST, BIND, DUMP>::key_t,
            ACL::binding<LIST, BIND, DUMP>>
  binding<LIST, BIND, DUMP>::m_db;

template <typename LIST, typename BIND, typename DUMP>
typename ACL::binding<LIST, BIND, DUMP>::event_handler
  binding<LIST, BIND, DUMP>::m_evh;
};

std::ostream& operator<<(
  std::ostream& os,
  const std::pair<direction_t, interface::key_type>& key);
};

/*
 * fd.io coding-style-patch-verification: ON
 *
 * Local Variables:
 * eval: (c-set-style "mozilla")
 * End:
 */

#endif