diff options
Diffstat (limited to 'src/vpp-api/vom/acl_list.hpp')
-rw-r--r-- | src/vpp-api/vom/acl_list.hpp | 307 |
1 files changed, 0 insertions, 307 deletions
diff --git a/src/vpp-api/vom/acl_list.hpp b/src/vpp-api/vom/acl_list.hpp deleted file mode 100644 index eff5e1c5a52..00000000000 --- a/src/vpp-api/vom/acl_list.hpp +++ /dev/null @@ -1,307 +0,0 @@ -/* - * 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_LIST_H__ -#define __VOM_ACL_LIST_H__ - -#include <set> - -#include "vom/acl_l2_rule.hpp" -#include "vom/acl_l3_rule.hpp" -#include "vom/acl_types.hpp" -#include "vom/hw.hpp" -#include "vom/inspect.hpp" -#include "vom/om.hpp" -#include "vom/singular_db.hpp" - -namespace VOM { -namespace ACL { -/** - * An ACL list comprises a set of match actions rules to be applied to - * packets. - * A list is bound to a given interface. - */ -template <typename RULE> -class list : public object_base -{ -public: - /** - * The KEY can be used to uniquely identify the ACL. - * (other choices for keys, like the summation of the properties - * of the rules, are rather too cumbersome to use - */ - typedef std::string key_t; - - /** - * The rule container type - */ - typedef std::multiset<RULE> rules_t; - - /** - * Construct a new object matching the desried state - */ - list(const key_t& key) - : m_hdl(handle_t::INVALID) - , m_key(key) - { - } - - list(const handle_t& hdl, const key_t& key) - : m_hdl(hdl) - , m_key(key) - { - } - - list(const key_t& key, const rules_t& rules) - : m_hdl(handle_t::INVALID) - , m_key(key) - , m_rules(rules) - { - } - - /** - * Copy Constructor - */ - list(const list& o) - : m_hdl(o.m_hdl) - , m_key(o.m_key) - , m_rules(o.m_rules) - { - } - - /** - * Destructor - */ - ~list() - { - sweep(); - m_db.release(m_key, this); - } - - /** - * Return the 'sigular instance' of the ACL that matches this object - */ - std::shared_ptr<list> singular() const { return find_or_add(*this); } - - /** - * Dump all ACLs into the stream provided - */ - static void dump(std::ostream& os) { m_db.dump(os); } - - /** - * convert to string format for debug purposes - */ - std::string to_string() const - { - std::ostringstream s; - s << "acl-list:[" << m_key << " " << m_hdl.to_string() << " rules:["; - - for (auto rule : m_rules) { - s << rule.to_string() << " "; - } - - s << "]]"; - - return (s.str()); - } - - /** - * Insert priority sorted a rule into the list - */ - void insert(const RULE& rule) { m_rules.insert(rule); } - - /** - * Remove a rule from the list - */ - void remove(const RULE& rule) { m_rules.erase(rule); } - - /** - * Return the VPP assign handle - */ - const handle_t& handle() const { return (singular()->handle_i()); } - - static std::shared_ptr<list> find(const handle_t& handle) - { - return (m_hdl_db[handle].lock()); - } - - static std::shared_ptr<list> find(const key_t& key) - { - return (m_db.find(key)); - } - - static void add(const key_t& key, const HW::item<handle_t>& item) - { - std::shared_ptr<list> sp = find(key); - - if (sp && item) { - m_hdl_db[item.data()] = sp; - } - } - - static void remove(const HW::item<handle_t>& item) - { - m_hdl_db.erase(item.data()); - } - - const key_t& key() const { return m_key; } - - const rules_t& rules() const { return m_rules; } - - /** - * Comparison operator - for UT - */ - bool operator==(const list& l) const - { - return (key() == l.key() && rules() == l.rules()); - } - -private: - /** - * Class definition for listeners to OM events - */ - class event_handler : public OM::listener, public inspect::command_handler - { - public: - event_handler(); - - 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); - - /** - * Get the sortable Id of the listener - */ - dependency_t order() const { return (dependency_t::ACL); } - }; - - /** - * event_handler to register with OM - */ - static event_handler m_evh; - - /** - * Enqueue commands to the VPP command Q for the update - */ - void update(const list& obj); - - /** - * HW assigned handle - */ - HW::item<handle_t> m_hdl; - - /** - * Find or add the sigular instance in the DB - */ - static std::shared_ptr<list> find_or_add(const list& temp) - { - return (m_db.find_or_add(temp.key(), temp)); - } - - /** - * return the acl-list's handle in the singular instance - */ - const handle_t& handle_i() const { return (m_hdl.data()); } - - /* - * It's the VOM::OM class that updates call update - */ - friend class VOM::OM; - - /** - * It's the VOM::singular_db class that calls replay() - */ - friend class singular_db<key_t, list>; - - /** - * Sweep/reap the object if still stale - */ - void sweep(void); - - /** - * Replay the objects state to HW - */ - void replay(void); - - /** - * A map of all ACL's against the client's key - */ - static singular_db<key_t, list> m_db; - - /** - * A map of all ACLs keyed against VPP's handle - */ - static std::map<handle_t, std::weak_ptr<list>> m_hdl_db; - - /** - * The Key is a user defined identifer for this ACL - */ - const key_t m_key; - - /** - * A sorted list of the rules - */ - rules_t m_rules; -}; - -/** - * Typedef the L3 ACL type - */ -typedef list<l3_rule> l3_list; - -/** - * Typedef the L2 ACL type - */ -typedef list<l2_rule> l2_list; - -/** - * Definition of the static singular_db for ACL Lists - */ -template <typename RULE> -singular_db<typename ACL::list<RULE>::key_t, ACL::list<RULE>> list<RULE>::m_db; - -/** - * Definition of the static per-handle DB for ACL Lists - */ -template <typename RULE> -std::map<handle_t, std::weak_ptr<ACL::list<RULE>>> list<RULE>::m_hdl_db; - -template <typename RULE> -typename ACL::list<RULE>::event_handler list<RULE>::m_evh; -}; -}; - -/* - * fd.io coding-style-patch-verification: ON - * - * Local Variables: - * eval: (c-set-style "mozilla") - * End: - */ - -#endif |