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              const handle_t bvi,
  39              const handle_t uu_fwd,
  40              const handle_t bm_flood,
  41              const gbp_bridge_domain::flags_t& flags);
  42
  43   /**
  44    * Issue the command to VPP/HW
  45    */
  46   rc_t issue(connection& con);
  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 handle_t m_bvi;
  59   const handle_t m_uu_fwd;
  60   const handle_t m_bm_flood;
  61   const gbp_bridge_domain::flags_t& m_flags;
  62 };
  63
  64 /**
  65  * A cmd class that Delete an Bridge-Domain
  66  */
  67 class delete_cmd
  68   : public rpc_cmd<HW::item<uint32_t>, vapi::Gbp_bridge_domain_del>
  69 {
  70 public:
  71   /**
  72    * Constructor
  73    */
  74   delete_cmd(HW::item<uint32_t>& item);
  75
  76   /**
  77    * Issue the command to VPP/HW
  78    */
  79   rc_t issue(connection& con);
  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
  91 /**
  92  * A cmd class that Dumps all the bridge domains
  93  */
  94 class dump_cmd : public VOM::dump_cmd<vapi::Gbp_bridge_domain_dump>
  95 {
  96 public:
  97   /**
  98    * Constructor
  99    */
 100   dump_cmd() = default;
 101   dump_cmd(const dump_cmd& d) = default;
 102
 103   /**
 104    * Issue the command to VPP/HW
 105    */
 106   rc_t issue(connection& con);
 107   /**
 108    * convert to string format for debug purposes
 109    */
 110   std::string to_string() const;
 111
 112   /**
 113    * Comparison operator - only used for UT
 114    */
 115   bool operator==(const dump_cmd& i) const;
 116
 117 private:
 118   /**
 119    * HW reutrn code
 120    */
 121   HW::item<bool> item;
 122 };
 123
 124 }; // gbp_bridge_domain_cmds
 125 }; // VOM
 126
 127 /*
 128  * fd.io coding-style-patch-verification: ON
 129  *
 130  * Local Variables:
 131  * eval: (c-set-style "mozilla")
 132  * End:
 133  */
 134
 135 #endif