summaryrefslogtreecommitdiffstats
path: root/src/vpp-api/vom/acl_ethertype.hpp
diff options
context:
space:
mode:
authorDamjan Marion <damarion@cisco.com>2018-04-25 19:11:15 +0200
committerNeale Ranns <nranns@cisco.com>2018-04-27 11:35:07 +0000
commit164e5f8c63652028ecb9c3570e1ea8618b163071 (patch)
tree7423f5abbc61b761df9a679c7974f17613736020 /src/vpp-api/vom/acl_ethertype.hpp
parentaa682a39b76ee043f65313f23e134bf18fe7a47e (diff)
Move VOM to extras/vom
Change-Id: Iea174f03dfba3bd06024db0f0cc373532300dcae Signed-off-by: Damjan Marion <damarion@cisco.com>
Diffstat (limited to 'src/vpp-api/vom/acl_ethertype.hpp')
-rw-r--r--src/vpp-api/vom/acl_ethertype.hpp247
1 files changed, 0 insertions, 247 deletions
diff --git a/src/vpp-api/vom/acl_ethertype.hpp b/src/vpp-api/vom/acl_ethertype.hpp
deleted file mode 100644
index 98d3ce20707..00000000000
--- a/src/vpp-api/vom/acl_ethertype.hpp
+++ /dev/null
@@ -1,247 +0,0 @@
-/*
- * Copyright (c) 2018 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_ETHERTYPE_H__
-#define __VOM_ACL_ETHERTYPE_H__
-
-#include <set>
-
-#include "vom/hw.hpp"
-#include "vom/inspect.hpp"
-#include "vom/interface.hpp"
-#include "vom/object_base.hpp"
-#include "vom/om.hpp"
-#include "vom/singular_db.hpp"
-
-namespace VOM {
-namespace ACL {
-/**
- * An ACL ethertype list comprises a set of inbound ether types and out bound
- * ether types
- * to be applied to packets.
- * A list is bound to a given interface.
- */
-
-struct ethertype_rule_t
-{
-public:
- /**
- * Constructor
- */
- ethertype_rule_t(const ethertype_t& eth, const direction_t& dir);
-
- /**
- * Destructor
- */
- ~ethertype_rule_t() = default;
-
- /**
- * convert to string
- */
- std::string to_string() const;
-
- /**
- * comparision operator
- */
- bool operator<(const ethertype_rule_t& other) const;
-
- /**
- * comparision operator (for testing)
- */
- bool operator==(const ethertype_rule_t& other) const;
-
- /**
- * get the ether value
- */
- uint16_t getEthertype(void) const;
-
- /**
- * get the direction
- */
- const direction_t& getDirection(void) const;
-
-private:
- /**
- * ethertype for this rule
- */
- const ethertype_t m_eth;
-
- /**
- * direction in which ethertype will be applied w.r.t. intf
- */
- const direction_t m_dir;
-};
-
-class acl_ethertype : public object_base
-{
-public:
- /**
- * The KEY can be used to uniquely identify the ACL ethertype.
- * (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 ethertype container
- */
- typedef std::multiset<ethertype_rule_t> ethertype_rules_t;
-
- /**
- * Construct a new object matching the desried state
- */
- acl_ethertype(const interface& itf, const ethertype_rules_t& le);
-
- /**
- * Copy Constructor
- */
- acl_ethertype(const acl_ethertype& o);
-
- /**
- * Destructor
- */
- ~acl_ethertype();
-
- /**
- * Return the binding's key
- */
- const key_t& key() const;
-
- /**
- * comparision operator (for testing)
- */
- bool operator==(const acl_ethertype& o) const;
-
- /**
- * Return the 'singular' of the acl ethertype that matches this object
- */
- std::shared_ptr<acl_ethertype> singular() const;
-
- /**
- * convert to string format for debug purposes
- */
- std::string to_string() const;
-
- /**
- * Dump all acl ethertype into the stream provided
- */
- static void dump(std::ostream& os);
-
- /**
- * Static function to find the acl_ethertype in the model
- */
- static std::shared_ptr<acl_ethertype> find(const key_t& key);
-
-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();
-
- /**
- * Show the object in the Singular DB
- */
- void show(std::ostream& os);
-
- /**
- * Get the sortable Id of the listener
- */
- dependency_t order() const;
- };
-
- /**
- * event_handler to register with OM
- */
- static event_handler m_evh;
-
- /**
- * Enque commands to the VPP command Q for the update
- */
- void update(const acl_ethertype& obj);
-
- /**
- * Find or add acl ethertype to the OM
- */
- static std::shared_ptr<acl_ethertype> find_or_add(const acl_ethertype& temp);
-
- /*
- * It's the OM class that calls singular()
- */
- friend class VOM::OM;
-
- /**
- * It's the singular_db class that calls replay()
- */
- friend class singular_db<interface::key_t, acl_ethertype>;
-
- /**
- * Sweep/reap the object if still stale
- */
- void sweep(void);
-
- /**
- * replay the object to create it in hardware
- */
- void replay(void);
-
- /**
- * A reference counting pointer to the interface on which acl ethertype
- * resides. By holding the reference here, we can guarantee that
- * this object will outlive the interface
- */
- const std::shared_ptr<interface> m_itf;
-
- /**
- * Inbound and outbound ethers list applied on given interface
- */
- ethertype_rules_t m_le;
-
- /**
- * HW configuration for the binding. The bool representing the
- * do/don't bind.
- */
- HW::item<bool> m_binding;
-
- /**
- * A map of all acl ethertype keyed against the interface.
- */
- static singular_db<interface::key_t, acl_ethertype> m_db;
-};
-};
-};
-
-/*
- * fd.io coding-style-patch-verification: ON
- *
- * Local Variables:
- * eval: (c-set-style "mozilla")
- * End:
- */
-
-#endif