extras/vom/vom/acl_ethertype_cmds.hpp

   1 /*
   2  * Copyright (c) 2018 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:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   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.
  14  */
  15
  16 #ifndef __VOM_ACL_ETHERTYPE_CMDS_H__
  17 #define __VOM_ACL_ETHERTYPE_CMDS_H__
  18
  19 #include "vom/acl_ethertype.hpp"
  20 #include "vom/dump_cmd.hpp"
  21 #include "vom/rpc_cmd.hpp"
  22
  23 #include <vapi/acl.api.vapi.hpp>
  24
  25 namespace VOM {
  26 namespace ACL {
  27 namespace acl_ethertype_cmds {
  28 /**
  29  * A command class that binds the ethertype list to the interface
  30  */
  31 class bind_cmd
  32   : public rpc_cmd<HW::item<bool>, vapi::Acl_interface_set_etype_whitelist>
  33 {
  34 public:
  35   /**
  36    * Constructor
  37    */
  38   bind_cmd(HW::item<bool>& item,
  39            const handle_t& itf,
  40            const acl_ethertype::ethertype_rules_t& le);
  41
  42   /**
  43    * Issue the command to VPP/HW
  44    */
  45   rc_t issue(connection& con);
  46   /**
  47    * convert to string format for debug purposes
  48    */
  49   std::string to_string() const;
  50
  51   /**
  52    * Comparison operator - only used for UT
  53    */
  54   bool operator==(const bind_cmd& i) const;
  55
  56 private:
  57   /**
  58    * Reference to the HW::item of the interface to bind
  59    */
  60   const handle_t& m_itf;
  61
  62   /**
  63    * Ethertype list applied to interface
  64    */
  65   const acl_ethertype::ethertype_rules_t& m_le;
  66 };
  67
  68 /**
  69  * A command class that unbinds the ethertype list to the interface
  70  */
  71 class unbind_cmd
  72   : public rpc_cmd<HW::item<bool>, vapi::Acl_interface_set_etype_whitelist>
  73 {
  74 public:
  75   /**
  76    * Constructor
  77    */
  78   unbind_cmd(HW::item<bool>& item, const handle_t& itf);
  79
  80   /**
  81    * Issue the command to VPP/HW
  82    */
  83   rc_t issue(connection& con);
  84   /**
  85    * convert to string format for debug purposes
  86    */
  87   std::string to_string() const;
  88
  89   /**
  90    * Comparison operator - only used for UT
  91    */
  92   bool operator==(const unbind_cmd& i) const;
  93
  94 private:
  95   /**
  96    * Reference to the HW::item of the interface to bind
  97    */
  98   const handle_t m_itf;
  99 };
 100
 101 /**
 102  * A cmd class that Dumps all the acl ethertypes on given interface
 103  */
 104 class dump_cmd : public VOM::dump_cmd<vapi::Acl_interface_etype_whitelist_dump>
 105 {
 106 public:
 107   /**
 108    * Constructor
 109    */
 110   dump_cmd(const handle_t& itf);
 111   dump_cmd(const dump_cmd& d);
 112
 113   /**
 114    * Issue the command to VPP/HW
 115    */
 116   rc_t issue(connection& con);
 117   /**
 118    * convert to string format for debug purposes
 119    */
 120   std::string to_string() const;
 121
 122   /**
 123    * Comparison operator - only used for UT
 124    */
 125   bool operator==(const dump_cmd& i) const;
 126
 127 private:
 128   /**
 129    * The interface to get the addresses for
 130    */
 131   const handle_t m_itf;
 132 };
 133 };
 134 };
 135 };
 136 /*
 137  * fd.io coding-style-patch-verification: ON
 138  *
 139  * Local Variables:
 140  * eval: (c-set-style "mozilla")
 141  * End:
 142  */
 143
 144 #endif