#include "vom/acl_l2_rule.hpp"
#include "vom/acl_l3_rule.hpp"
#include "vom/acl_types.hpp"
-#include "vom/dump_cmd.hpp"
#include "vom/hw.hpp"
#include "vom/inspect.hpp"
#include "vom/om.hpp"
-#include "vom/rpc_cmd.hpp"
#include "vom/singular_db.hpp"
-#include <vapi/acl.api.vapi.hpp>
-
namespace VOM {
namespace ACL {
/**
* packets.
* A list is bound to a given interface.
*/
-template <typename RULE, typename UPDATE, typename DELETE, typename DUMP>
+template <typename RULE>
class list : public object_base
{
public:
* Construct a new object matching the desried state
*/
list(const key_t& key)
- : m_key(key)
+ : m_hdl(handle_t::INVALID)
+ , m_key(key)
{
}
}
list(const key_t& key, const rules_t& rules)
- : m_key(key)
+ : m_hdl(handle_t::INVALID)
+ , m_key(key)
, m_rules(rules)
{
- m_evh.order();
}
/**
/**
* Return the VPP assign handle
*/
- const handle_t& handle() const { return m_hdl.data(); }
+ const handle_t& handle() const { return (singular()->handle_i()); }
- /**
- * A command class that Create the list
- */
- class update_cmd
- : public rpc_cmd<HW::item<handle_t>, HW::item<handle_t>, UPDATE>
+ static std::shared_ptr<list> find(const handle_t& handle)
{
- public:
- /**
- * Constructor
- */
- update_cmd(HW::item<handle_t>& item, const key_t& key, const rules_t& rules)
- : rpc_cmd<HW::item<handle_t>, HW::item<handle_t>, UPDATE>(item)
- , m_key(key)
- , m_rules(rules)
- {
- }
-
- /**
- * 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-list-update: " << this->item().to_string();
-
- return (s.str());
- }
-
- /**
- * Comparison operator - only used for UT
- */
- bool operator==(const update_cmd& other) const
- {
- return ((m_key == other.m_key) && (m_rules == other.m_rules));
- }
-
- void complete()
- {
- std::shared_ptr<list> sp = find(m_key);
- if (sp && this->item()) {
- list::add(this->item().data(), sp);
- }
- }
-
- void succeeded()
- {
- rpc_cmd<HW::item<handle_t>, HW::item<handle_t>, UPDATE>::succeeded();
- complete();
- }
-
- /**
- * A callback function for handling ACL creates
- */
- virtual vapi_error_e operator()(UPDATE& reply)
- {
- int acl_index = reply.get_response().get_payload().acl_index;
- int retval = reply.get_response().get_payload().retval;
-
- VOM_LOG(log_level_t::DEBUG) << this->to_string() << " " << retval;
+ return (m_hdl_db[handle].lock());
+ }
- HW::item<handle_t> res(acl_index, rc_t::from_vpp_retval(retval));
+ static std::shared_ptr<list> find(const key_t& key)
+ {
+ return (m_db.find(key));
+ }
- this->fulfill(res);
+ static void add(const key_t& key, const HW::item<handle_t>& item)
+ {
+ std::shared_ptr<list> sp = find(key);
- return (VAPI_OK);
+ if (sp && item) {
+ m_hdl_db[item.data()] = sp;
}
+ }
- private:
- /**
- * The key.
- */
- const key_t& m_key;
-
- /**
- * The rules
- */
- const rules_t& m_rules;
- };
-
- /**
- * A cmd class that Deletes an ACL
- */
- class delete_cmd : public rpc_cmd<HW::item<handle_t>, rc_t, DELETE>
+ static void remove(const HW::item<handle_t>& item)
{
- public:
- /**
- * Constructor
- */
- delete_cmd(HW::item<handle_t>& item)
- : rpc_cmd<HW::item<handle_t>, rc_t, DELETE>(item)
- {
- }
-
- /**
- * Issue the command to VPP/HW
- */
- rc_t issue(connection& con) { return (rc_t::INVALID); }
+ m_hdl_db.erase(item.data());
+ }
- /**
- * convert to string format for debug purposes
- */
- std::string to_string() const
- {
- std::ostringstream s;
- s << "ACL-list-delete: " << this->item().to_string();
+ const key_t& key() const { return m_key; }
- return (s.str());
- }
-
- /**
- * Comparison operator - only used for UT
- */
- bool operator==(const delete_cmd& other) const
- {
- return (this->item().data() == other.item().data());
- }
- };
+ const rules_t& rules() const { return m_rules; }
/**
- * A cmd class that Dumps all the ACLs
+ * Comparison operator - for UT
*/
- 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) { return rc_t::INVALID; }
-
- /**
- * convert to string format for debug purposes
- */
- std::string to_string() const { return ("acl-list-dump"); }
-
- private:
- /**
- * HW reutrn code
- */
- HW::item<bool> item;
- };
-
- static std::shared_ptr<list> find(const handle_t& handle)
+ bool operator==(const list& l) const
{
- return (m_hdl_db[handle].lock());
+ return (key() == l.key() && rules() == l.rules());
}
- static std::shared_ptr<list> find(const key_t& key)
- {
- return (m_db.find(key));
- }
-
- static void add(const handle_t& handle, std::shared_ptr<list> sp)
- {
- m_hdl_db[handle] = sp;
- }
-
- static void remove(const handle_t& handle) { m_hdl_db.erase(handle); }
-
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" }, "ACL lists", this);
- }
+ event_handler();
+
virtual ~event_handler() = default;
/**
/**
* Show the object in the Singular DB
*/
- void show(std::ostream& os) { m_db.dump(os); }
+ void show(std::ostream& os);
/**
* Get the sortable Id of the listener
static event_handler m_evh;
/**
- * Enquue commonds to the VPP command Q for the update
+ * Enqueue commands to the VPP command Q for the update
*/
- void update(const list& obj)
- {
- /*
- * always update the instance with the latest rule set
- */
- if (!m_hdl || obj.m_rules != m_rules) {
- HW::enqueue(new update_cmd(m_hdl, m_key, m_rules));
- }
- /*
- * We don't, can't, read the priority from VPP,
- * so the is equals check above does not include the priorty.
- * but we save it now.
- */
- m_rules = obj.m_rules;
- }
+ void update(const list& obj);
/**
* HW assigned handle
*/
static std::shared_ptr<list> find_or_add(const list& temp)
{
- return (m_db.find_or_add(temp.m_key, 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
*/
/**
* Sweep/reap the object if still stale
*/
- void sweep(void)
- {
- if (m_hdl) {
- HW::enqueue(new delete_cmd(m_hdl));
- }
- HW::write();
- }
+ void sweep(void);
/**
* Replay the objects state to HW
*/
- void replay(void)
- {
- if (m_hdl) {
- HW::enqueue(new update_cmd(m_hdl, m_key, m_rules));
- }
- }
+ void replay(void);
/**
* A map of all ACL's against the client's key
/**
* A map of all ACLs keyed against VPP's handle
*/
- static std::map<const handle_t, std::weak_ptr<list>> m_hdl_db;
+ static std::map<handle_t, std::weak_ptr<list>> m_hdl_db;
/**
* The Key is a user defined identifer for this ACL
/**
* Typedef the L3 ACL type
*/
-typedef list<l3_rule, vapi::Acl_add_replace, vapi::Acl_del, vapi::Acl_dump>
- l3_list;
+typedef list<l3_rule> l3_list;
/**
* Typedef the L2 ACL type
*/
-typedef list<l2_rule,
- vapi::Macip_acl_add,
- vapi::Macip_acl_del,
- vapi::Macip_acl_dump>
- l2_list;
+typedef list<l2_rule> l2_list;
/**
* Definition of the static singular_db for ACL Lists
*/
-template <typename RULE, typename UPDATE, typename DELETE, typename DUMP>
-singular_db<typename ACL::list<RULE, UPDATE, DELETE, DUMP>::key_t,
- ACL::list<RULE, UPDATE, DELETE, DUMP>>
- list<RULE, UPDATE, DELETE, DUMP>::m_db;
+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, typename UPDATE, typename DELETE, typename DUMP>
-std::map<const handle_t, std::weak_ptr<ACL::list<RULE, UPDATE, DELETE, DUMP>>>
- list<RULE, UPDATE, DELETE, DUMP>::m_hdl_db;
+template <typename RULE>
+std::map<handle_t, std::weak_ptr<ACL::list<RULE>>> list<RULE>::m_hdl_db;
-template <typename RULE, typename UPDATE, typename DELETE, typename DUMP>
-typename ACL::list<RULE, UPDATE, DELETE, DUMP>::event_handler
- list<RULE, UPDATE, DELETE, DUMP>::m_evh;
+template <typename RULE>
+typename ACL::list<RULE>::event_handler list<RULE>::m_evh;
};
};