extras/vom/vom/gbp_contract_cmds.hpp

   1 /*
   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:
   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_GBP_CONTRACT_CMDS_H__
  17 #define __VOM_GBP_CONTRACT_CMDS_H__
  18
  19 #include "vom/dump_cmd.hpp"
  20 #include "vom/gbp_contract.hpp"
  21
  22 #include <vapi/gbp.api.vapi.hpp>
  23
  24 namespace VOM {
  25 namespace gbp_contract_cmds {
  26
  27 /**
  28  * A command class that creates or updates the GBP contract
  29  */
  30 class create_cmd : public rpc_cmd<HW::item<bool>, vapi::Gbp_contract_add_del>
  31 {
  32 public:
  33   /**
  34    * Constructor
  35    */
  36   create_cmd(HW::item<bool>& item,
  37              epg_id_t src_epg_id,
  38              epg_id_t dst_epg_id,
  39              const handle_t& acl,
  40              const gbp_contract::gbp_rules_t& gbp_rules,
  41              const gbp_contract::ethertype_set_t& allowed_ethertypes);
  42
  43   /**
  44    * Issue the command to VPP/HW
  45    */
  46   rc_t issue(connection& con);
  47
  48   /**
  49    * convert to string format for debug purposes
  50    */
  51   std::string to_string() const;
  52
  53   /**
  54    * Comparison operator - only used for UT
  55    */
  56   bool operator==(const create_cmd& i) const;
  57
  58 private:
  59   const epg_id_t m_src_epg_id;
  60   const epg_id_t m_dst_epg_id;
  61   const handle_t m_acl;
  62   const gbp_contract::gbp_rules_t& m_gbp_rules;
  63   const gbp_contract::ethertype_set_t& m_allowed_ethertypes;
  64 };
  65
  66 /**
  67  * A cmd class that deletes a GBP contract
  68  */
  69 class delete_cmd : public rpc_cmd<HW::item<bool>, vapi::Gbp_contract_add_del>
  70 {
  71 public:
  72   /**
  73    * Constructor
  74    */
  75   delete_cmd(HW::item<bool>& item, epg_id_t src_epg_id, epg_id_t dst_epg_id);
  76
  77   /**
  78    * Issue the command to VPP/HW
  79    */
  80   rc_t issue(connection& con);
  81
  82   /**
  83    * convert to string format for debug purposes
  84    */
  85   std::string to_string() const;
  86
  87   /**
  88    * Comparison operator - only used for UT
  89    */
  90   bool operator==(const delete_cmd& i) const;
  91
  92 private:
  93   const epg_id_t m_src_epg_id;
  94   const epg_id_t m_dst_epg_id;
  95 };
  96
  97 /**
  98  * A cmd class that Dumps all the GBP contracts
  99  */
 100 class dump_cmd : public VOM::dump_cmd<vapi::Gbp_contract_dump>
 101 {
 102 public:
 103   /**
 104    * Constructor
 105    */
 106   dump_cmd() = default;
 107
 108   /**
 109    * Issue the command to VPP/HW
 110    */
 111   rc_t issue(connection& con);
 112   /**
 113    * convert to string format for debug purposes
 114    */
 115   std::string to_string() const;
 116
 117   /**
 118    * Comparison operator - only used for UT
 119    */
 120   bool operator==(const dump_cmd& i) const;
 121
 122 private:
 123   /**
 124    * HW reutrn code
 125    */
 126   HW::item<bool> item;
 127 };
 128 }; // namespace gbp_contract_cmds
 129 }; // namespace VOM
 130
 131 /*
 132  * fd.io coding-style-patch-verification: ON
 133  *
 134  * Local Variables:
 135  * eval: (c-set-style "mozilla")
 136  * End:
 137  */
 138
 139 #endif