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