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_LIST_CMDS_H__
17 #define __VOM_ACL_LIST_CMDS_H__
19 #include "vom/acl_list.hpp"
20 #include "vom/dump_cmd.hpp"
21 #include "vom/rpc_cmd.hpp"
23 #include <vapi/acl.api.vapi.hpp>
29 * A command class that Create the list
31 template <typename RULE, typename UPDATE>
32 class update_cmd : public rpc_cmd<HW::item<handle_t>, UPDATE>
35 typedef typename list<RULE>::rules_t cmd_rules_t;
36 typedef typename list<RULE>::key_t cmd_key_t;
41 update_cmd(HW::item<handle_t>& item,
43 const cmd_rules_t& rules)
44 : rpc_cmd<HW::item<handle_t>, UPDATE>(item)
51 * Issue the command to VPP/HW
53 rc_t issue(connection& con);
56 * convert to string format for debug purposes
58 std::string to_string() const
61 s << "ACL-list-update:[ " << this->item().to_string() << " rule-list:[";
62 for (auto rule : m_rules) {
63 s << " " << rule.to_string();
71 * Comparison operator - only used for UT
73 bool operator==(const update_cmd& other) const
75 return ((m_key == other.m_key) && (m_rules == other.m_rules));
80 rpc_cmd<HW::item<handle_t>, UPDATE>::succeeded();
81 list<RULE>::add(m_key, this->item());
85 * A callback function for handling ACL creates
87 virtual vapi_error_e operator()(UPDATE& reply)
89 int acl_index = reply.get_response().get_payload().acl_index;
90 int retval = reply.get_response().get_payload().retval;
92 VOM_LOG(log_level_t::DEBUG) << this->to_string() << " retval:" << retval
93 << " acl_index:" << acl_index;
95 rc_t rc = rc_t::from_vpp_retval(retval);
96 handle_t handle(acl_index);
98 HW::item<handle_t> res(handle, rc);
107 * add the created acl to the DB
109 void insert_acl() { list<RULE>::add(m_key, this->item()); }
114 const cmd_key_t& m_key;
119 const cmd_rules_t& m_rules;
123 * A cmd class that Deletes an ACL
125 template <typename RULE, typename DELETE>
126 class delete_cmd : public rpc_cmd<HW::item<handle_t>, DELETE>
132 delete_cmd(HW::item<handle_t>& item)
133 : rpc_cmd<HW::item<handle_t>, DELETE>(item)
138 * Issue the command to VPP/HW
140 rc_t issue(connection& con) { return (rc_t::INVALID); }
143 * convert to string format for debug purposes
145 std::string to_string() const
147 std::ostringstream s;
148 s << "ACL-list-delete: " << this->item().to_string();
154 * Comparison operator - only used for UT
156 bool operator==(const delete_cmd& other) const
158 return (this->item().data() == other.item().data());
163 * remove the acl from the DB
165 void remove_acl() { list<RULE>::remove(this->item()); }
169 * A cmd class that Dumps all the ACLs
171 template <typename DUMP>
172 class dump_cmd : public VOM::dump_cmd<DUMP>
178 dump_cmd() = default;
181 * Issue the command to VPP/HW
183 rc_t issue(connection& con);
186 * convert to string format for debug purposes
188 std::string to_string() const { return ("acl-list-dump"); }
191 * Comparison operator - only used for UT
193 bool operator==(const dump_cmd& i) const { return true; }
197 * Typedef the L3 ACL commands
199 typedef update_cmd<l3_rule, vapi::Acl_add_replace> l3_update_cmd;
200 typedef delete_cmd<l3_rule, vapi::Acl_del> l3_delete_cmd;
201 typedef dump_cmd<vapi::Acl_dump> l3_dump_cmd;
204 * Typedef the L2 ACL commands
206 typedef update_cmd<l2_rule, vapi::Macip_acl_add> l2_update_cmd;
207 typedef delete_cmd<l2_rule, vapi::Macip_acl_del> l2_delete_cmd;
208 typedef dump_cmd<vapi::Macip_acl_dump> l2_dump_cmd;
210 }; // namespace list_cmds
215 * fd.io coding-style-patch-verification: ON
218 * eval: (c-set-style "mozilla")