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