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 #include "vom/acl_l3_list.hpp"
17 #include "vom/acl_list_cmds.hpp"
18 #include "vom/logger.hpp"
19 #include "vom/singular_db_funcs.hpp"
25 * Definition of the static singular_db for ACL Lists
27 singular_db<l3_list::key_t, l3_list> l3_list::m_db;
30 * Definition of the static per-handle DB for ACL Lists
32 std::map<handle_t, std::weak_ptr<l3_list>> l3_list::m_hdl_db;
34 l3_list::event_handler l3_list::m_evh;
36 l3_list::event_handler::event_handler()
38 OM::register_listener(this);
39 inspect::register_handler({ "l3-acl-list" }, "L3 ACL lists", this);
42 l3_list::l3_list(const key_t& key)
43 : m_hdl(handle_t::INVALID)
48 l3_list::l3_list(const handle_t& hdl, const key_t& key)
54 l3_list::l3_list(const key_t& key, const rules_t& rules)
55 : m_hdl(handle_t::INVALID)
61 l3_list::l3_list(const l3_list& o)
71 m_db.release(m_key, this);
74 std::shared_ptr<l3_list>
75 l3_list::singular() const
77 return find_or_add(*this);
81 * Dump all ACLs into the stream provided
84 l3_list::dump(std::ostream& os)
90 * convert to string format for debug purposes
93 l3_list::to_string() const
96 s << "acl-list:[" << m_key << " " << m_hdl.to_string() << " rules:[";
98 for (auto rule : m_rules) {
99 s << rule.to_string() << " ";
108 l3_list::insert(const l3_rule& rule)
110 m_rules.insert(rule);
114 l3_list::remove(const l3_rule& rule)
120 l3_list::handle() const
122 return (singular()->handle_i());
125 std::shared_ptr<l3_list>
126 l3_list::find(const handle_t& handle)
128 return (m_hdl_db[handle].lock());
131 std::shared_ptr<l3_list>
132 l3_list::find(const key_t& key)
134 return (m_db.find(key));
137 std::shared_ptr<l3_list>
138 l3_list::find_or_add(const l3_list& temp)
140 return (m_db.find_or_add(temp.key(), temp));
144 l3_list::handle_i() const
146 return (m_hdl.data());
150 l3_list::add(const key_t& key, const HW::item<handle_t>& item)
152 std::shared_ptr<l3_list> sp = find(key);
155 m_hdl_db[item.data()] = sp;
160 l3_list::remove(const HW::item<handle_t>& item)
162 m_hdl_db.erase(item.data());
165 const l3_list::key_t&
171 const l3_list::rules_t&
172 l3_list::rules() const
178 l3_list::operator==(const l3_list& l) const
180 return (key() == l.key() && rules() == l.rules());
184 l3_list::event_handler::handle_populate(const client_db::key_t& key)
187 * dump L3 ACLs Bridge domains
189 std::shared_ptr<list_cmds::l3_dump_cmd> cmd =
190 std::make_shared<list_cmds::l3_dump_cmd>();
195 for (auto& record : *cmd) {
196 auto& payload = record.get_payload();
198 const handle_t hdl(payload.acl_index);
199 l3_list acl(hdl, std::string(reinterpret_cast<const char*>(payload.tag)));
201 for (unsigned int ii = 0; ii < payload.count; ii++) {
202 const route::prefix_t src(payload.r[ii].is_ipv6,
203 payload.r[ii].src_ip_addr,
204 payload.r[ii].src_ip_prefix_len);
205 const route::prefix_t dst(payload.r[ii].is_ipv6,
206 payload.r[ii].dst_ip_addr,
207 payload.r[ii].dst_ip_prefix_len);
208 l3_rule rule(ii, action_t::from_int(payload.r[ii].is_permit), src, dst);
210 rule.set_proto(payload.r[ii].proto);
211 rule.set_src_from_port(payload.r[ii].srcport_or_icmptype_first);
212 rule.set_src_to_port(payload.r[ii].srcport_or_icmptype_last);
213 rule.set_dst_from_port(payload.r[ii].dstport_or_icmpcode_first);
214 rule.set_dst_to_port(payload.r[ii].dstport_or_icmpcode_last);
215 rule.set_tcp_flags_mask(payload.r[ii].tcp_flags_mask);
216 rule.set_tcp_flags_value(payload.r[ii].tcp_flags_value);
220 VOM_LOG(log_level_t::DEBUG) << "dump: " << acl.to_string();
223 * Write each of the discovered ACLs into the OM,
224 * but disable the HW Command q whilst we do, so that no
225 * commands are sent to VPP
227 OM::commit(key, acl);
232 l3_list::event_handler::show(std::ostream& os)
238 l3_list::event_handler::order() const
240 return (dependency_t::ACL);
244 l3_list::event_handler::handle_replay()
250 l3_list::update(const l3_list& obj)
253 * always update the instance with the latest rule set
255 if (rc_t::OK != m_hdl.rc() || obj.m_rules != m_rules) {
256 HW::enqueue(new list_cmds::l3_update_cmd(m_hdl, m_key, m_rules));
259 * We don't, can't, read the priority from VPP,
260 * so the is equals check above does not include the priorty.
261 * but we save it now.
263 m_rules = obj.m_rules;
267 * Sweep/reap the object if still stale
273 HW::enqueue(new list_cmds::l3_delete_cmd(m_hdl));
279 * Replay the objects state to HW
282 l3_list::replay(void)
285 m_hdl.data().reset();
286 HW::enqueue(new list_cmds::l3_update_cmd(m_hdl, m_key, m_rules));
294 * fd.io coding-style-patch-verification: ON
297 * eval: (c-set-style "mozilla")