extras/vom/vom/gbp_bridge_domain_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_BRIDGE_DOMAIN_CMDS_H__
  17 #define __VOM_GBP_BRIDGE_DOMAIN_CMDS_H__
  18
  19 #include "vom/dump_cmd.hpp"
  20 #include "vom/gbp_bridge_domain.hpp"
  21 #include "vom/rpc_cmd.hpp"
  22
  23 #include <vapi/gbp.api.vapi.hpp>
  24
  25 namespace VOM {
  26 namespace gbp_bridge_domain_cmds {
  27 /**
  28  * A command class that creates an Bridge-Domain
  29  */
  30 class create_cmd
  31   : public rpc_cmd<HW::item<uint32_t>, vapi::Gbp_bridge_domain_add>
  32 {
  33 public:
  34   /**
  35    * Constructor
  36    */
  37   create_cmd(HW::item<uint32_t>& item,
  38              u32 rd_id,
  39              const handle_t bvi,
  40              const handle_t uu_fwd,
  41              const handle_t bm_flood,
  42              const gbp_bridge_domain::flags_t& flags);
  43
  44   /**
  45    * Issue the command to VPP/HW
  46    */
  47   rc_t issue(connection& con);
  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   u32 m_rd_id;
  60   const handle_t m_bvi;
  61   const handle_t m_uu_fwd;
  62   const handle_t m_bm_flood;
  63   const gbp_bridge_domain::flags_t& m_flags;
  64 };
  65
  66 /**
  67  * A cmd class that Delete an Bridge-Domain
  68  */
  69 class delete_cmd
  70   : public rpc_cmd<HW::item<uint32_t>, vapi::Gbp_bridge_domain_del>
  71 {
  72 public:
  73   /**
  74    * Constructor
  75    */
  76   delete_cmd(HW::item<uint32_t>& item);
  77
  78   /**
  79    * Issue the command to VPP/HW
  80    */
  81   rc_t issue(connection& con);
  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
  93 /**
  94  * A cmd class that Dumps all the bridge domains
  95  */
  96 class dump_cmd : public VOM::dump_cmd<vapi::Gbp_bridge_domain_dump>
  97 {
  98 public:
  99   /**
 100    * Constructor
 101    */
 102   dump_cmd() = default;
 103   dump_cmd(const dump_cmd& d) = default;
 104
 105   /**
 106    * Issue the command to VPP/HW
 107    */
 108   rc_t issue(connection& con);
 109   /**
 110    * convert to string format for debug purposes
 111    */
 112   std::string to_string() const;
 113
 114   /**
 115    * Comparison operator - only used for UT
 116    */
 117   bool operator==(const dump_cmd& i) const;
 118
 119 private:
 120   /**
 121    * HW reutrn code
 122    */
 123   HW::item<bool> item;
 124 };
 125
 126 }; // gbp_bridge_domain_cmds
 127 }; // 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