FD.io VPP  v18.07-rc0-415-g6c78436
Vector Packet Processing
acl_list_cmds.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_LIST_CMDS_H__
17 #define __VOM_ACL_LIST_CMDS_H__
18 
19 #include "vom/acl_list.hpp"
20 #include "vom/dump_cmd.hpp"
21 #include "vom/rpc_cmd.hpp"
22 
23 #include <vapi/acl.api.vapi.hpp>
24 
25 namespace VOM {
26 namespace ACL {
27 namespace list_cmds {
28 /**
29  * A command class that Create the list
30  */
31 template <typename RULE, typename UPDATE>
33  : public rpc_cmd<HW::item<handle_t>, HW::item<handle_t>, UPDATE>
34 {
35 public:
36  typedef typename list<RULE>::rules_t cmd_rules_t;
37  typedef typename list<RULE>::key_t cmd_key_t;
38 
39  /**
40  * Constructor
41  */
43  const cmd_key_t& key,
44  const cmd_rules_t& rules)
45  : rpc_cmd<HW::item<handle_t>, HW::item<handle_t>, UPDATE>(item)
46  , m_key(key)
47  , m_rules(rules)
48  {
49  }
50 
51  /**
52  * Issue the command to VPP/HW
53  */
54  rc_t issue(connection& con);
55 
56  /**
57  * convert to string format for debug purposes
58  */
59  std::string to_string() const
60  {
61  std::ostringstream s;
62  s << "ACL-list-update:[ " << this->item().to_string() << " rule-list:[";
63  for (auto rule : m_rules) {
64  s << " " << rule.to_string();
65  }
66  s << "]]";
67 
68  return (s.str());
69  }
70 
71  /**
72  * Comparison operator - only used for UT
73  */
74  bool operator==(const update_cmd& other) const
75  {
76  return ((m_key == other.m_key) && (m_rules == other.m_rules));
77  }
78 
79  void succeeded()
80  {
82  list<RULE>::add(m_key, this->item());
83  }
84 
85  /**
86  * A callback function for handling ACL creates
87  */
88  virtual vapi_error_e operator()(UPDATE& reply)
89  {
90  int acl_index = reply.get_response().get_payload().acl_index;
91  int retval = reply.get_response().get_payload().retval;
92 
93  VOM_LOG(log_level_t::DEBUG) << this->to_string() << " retval:" << retval
94  << " acl_index:" << acl_index;
95 
96  rc_t rc = rc_t::from_vpp_retval(retval);
97  handle_t handle(acl_index);
98 
99  HW::item<handle_t> res(handle, rc);
100 
101  this->fulfill(res);
102 
103  return (VAPI_OK);
104  }
105 
106 private:
107  /**
108  * add the created acl to the DB
109  */
110  void insert_acl() { list<RULE>::add(m_key, this->item()); }
111 
112  /**
113  * The key.
114  */
115  const cmd_key_t& m_key;
116 
117  /**
118  * The rules
119  */
120  const cmd_rules_t& m_rules;
121 };
122 
123 /**
124  * A cmd class that Deletes an ACL
125  */
126 template <typename RULE, typename DELETE>
127 class delete_cmd : public rpc_cmd<HW::item<handle_t>, rc_t, DELETE>
128 {
129 public:
130  /**
131  * Constructor
132  */
134  : rpc_cmd<HW::item<handle_t>, rc_t, DELETE>(item)
135  {
136  }
137 
138  /**
139  * Issue the command to VPP/HW
140  */
141  rc_t issue(connection& con) { return (rc_t::INVALID); }
142 
143  /**
144  * convert to string format for debug purposes
145  */
146  std::string to_string() const
147  {
148  std::ostringstream s;
149  s << "ACL-list-delete: " << this->item().to_string();
150 
151  return (s.str());
152  }
153 
154  /**
155  * Comparison operator - only used for UT
156  */
157  bool operator==(const delete_cmd& other) const
158  {
159  return (this->item().data() == other.item().data());
160  }
161 
162 private:
163  /**
164  * remove the acl from the DB
165  */
166  void remove_acl() { list<RULE>::remove(this->item()); }
167 };
168 
169 /**
170  * A cmd class that Dumps all the ACLs
171  */
172 template <typename DUMP>
173 class dump_cmd : public VOM::dump_cmd<DUMP>
174 {
175 public:
176  /**
177  * Constructor
178  */
179  dump_cmd() = default;
180 
181  /**
182  * Issue the command to VPP/HW
183  */
184  rc_t issue(connection& con);
185 
186  /**
187  * convert to string format for debug purposes
188  */
189  std::string to_string() const { return ("acl-list-dump"); }
190 
191  /**
192  * Comparison operator - only used for UT
193  */
194  bool operator==(const dump_cmd& i) const { return true; }
195 };
196 
197 /**
198  * Typedef the L3 ACL commands
199  */
203 
204 /**
205  * Typedef the L2 ACL commands
206  */
210 
211 }; // namespace list_cmds
212 }; // namespace ACL
213 }; // namespace VOM
214 
215 /*
216  * fd.io coding-style-patch-verification: ON
217  *
218  * Local Variables:
219  * eval: (c-set-style "mozilla")
220  * End:
221  */
222 
223 #endif
std::string to_string() const
convert to string format for debug purposes
update_cmd< l3_rule, vapi::Acl_add_replace > l3_update_cmd
Typedef the L3 ACL commands.
void succeeded()
Called by the HW Command Q when it is disabled to indicate the command can be considered successful w...
static const rc_t & from_vpp_retval(int32_t rv)
Get the rc_t from the VPP API value.
Definition: types.cpp:33
#define VOM_LOG(lvl)
Definition: logger.hpp:181
Definition: hw.hpp:33
update_cmd(HW::item< handle_t > &item, const cmd_key_t &key, const cmd_rules_t &rules)
Constructor.
int i
Error codes that VPP will return during a HW write.
Definition: types.hpp:90
static const log_level_t DEBUG
Definition: logger.hpp:32
void remove(const RULE &rule)
Remove a rule from the list.
Definition: acl_list.hpp:128
bool operator==(const update_cmd &other) const
Comparison operator - only used for UT.
std::string to_string() const
convert to string format for debug purposes
Definition: hw.hpp:160
T & data()
Return the data read/written.
Definition: hw.hpp:108
std::string key_t
The KEY can be used to uniquely identify the ACL.
Definition: acl_list.hpp:45
std::string to_string() const
convert to string format for debug purposes
rc_t issue(connection &con)
Issue the command to VPP/HW.
list< RULE >::rules_t cmd_rules_t
A cmd class that Dumps all the ACLs.
bool operator==(const dump_cmd &i) const
Comparison operator - only used for UT.
dump_cmd< vapi::Acl_dump > l3_dump_cmd
A representation of the connection to VPP.
Definition: connection.hpp:33
std::string to_string() const
convert to string format for debug purposes
A command class that Create the list.
HW::item< handle_t > & item()
return the HW item the command updates
Definition: rpc_cmd.hpp:64
A base class for all RPC commands to VPP.
Definition: rpc_cmd.hpp:38
A cmd class that Deletes an ACL.
delete_cmd< l3_rule, vapi::Acl_del > l3_delete_cmd
A type declaration of an interface handle in VPP.
Definition: types.hpp:236
success
Definition: vapi_common.h:27
virtual vapi_error_e operator()(UPDATE &reply)
A callback function for handling ACL creates.
dump_cmd< vapi::Macip_acl_dump > l2_dump_cmd
void fulfill(const HW::item< handle_t > &d)
Fulfill the commands promise.
Definition: rpc_cmd.hpp:74
static const rc_t INVALID
HW write reported invalid input.
Definition: types.hpp:117
The VPP Object Model (VOM) library.
Definition: acl_binding.cpp:19
delete_cmd< l2_rule, vapi::Macip_acl_del > l2_delete_cmd
update_cmd< l2_rule, vapi::Macip_acl_add > l2_update_cmd
Typedef the L2 ACL commands.
delete_cmd(HW::item< handle_t > &item)
Constructor.
std::multiset< RULE > rules_t
The rule container type.
Definition: acl_list.hpp:50
static void add(const key_t &key, const HW::item< handle_t > &item)
Definition: acl_list.hpp:145
bool operator==(const delete_cmd &other) const
Comparison operator - only used for UT.
rc_t issue(connection &con)
Issue the command to VPP/HW.
A base class for VPP dump commands.
Definition: dump_cmd.hpp:43
vapi_error_e
Definition: vapi_common.h:25