extras/vom/vom/bridge_domain_entry_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_BRIDGE_DOMAIN_ENTRY_CMDS_H__
  17 #define __VOM_BRIDGE_DOMAIN_ENTRY_CMDS_H__
  18
  19 #include "vom/bridge_domain_entry.hpp"
  20 #include "vom/dump_cmd.hpp"
  21 #include "vom/rpc_cmd.hpp"
  22
  23 #include <vapi/l2.api.vapi.hpp>
  24
  25 namespace VOM {
  26 namespace bridge_domain_entry_cmds {
  27
  28 /**
  29 * A command class that creates or updates the bridge_domain
  30 */
  31 class create_cmd : public rpc_cmd<HW::item<bool>, vapi::L2fib_add_del>
  32 {
  33 public:
  34   /**
  35    * Constructor
  36    */
  37   create_cmd(HW::item<bool>& item,
  38              const mac_address_t& mac,
  39              uint32_t id,
  40              handle_t tx_intf,
  41              bool is_bvi);
  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   mac_address_t m_mac;
  60   uint32_t m_bd;
  61   handle_t m_tx_itf;
  62   bool m_is_bvi;
  63 };
  64
  65 /**
  66  * A cmd class that deletes a bridge_domain
  67  */
  68 class delete_cmd : public rpc_cmd<HW::item<bool>, vapi::L2fib_add_del>
  69 {
  70 public:
  71   /**
  72    * Constructor
  73    */
  74   delete_cmd(HW::item<bool>& item,
  75              const mac_address_t& mac,
  76              uint32_t id,
  77              bool is_bvi);
  78
  79   /**
  80    * Issue the command to VPP/HW
  81    */
  82   rc_t issue(connection& con);
  83
  84   /**
  85    * convert to string format for debug purposes
  86    */
  87   std::string to_string() const;
  88
  89   /**
  90    * Comparison operator - only used for UT
  91    */
  92   bool operator==(const delete_cmd& i) const;
  93
  94 private:
  95   mac_address_t m_mac;
  96   uint32_t m_bd;
  97   bool m_is_bvi;
  98 };
  99
 100 /**
 101  * A cmd class that Dumps all the interface spans
 102  */
 103 class dump_cmd : public VOM::dump_cmd<vapi::L2_fib_table_dump>
 104 {
 105 public:
 106   /**
 107    * Constructor
 108    */
 109   dump_cmd();
 110   dump_cmd(const dump_cmd& d);
 111
 112   /**
 113    * Issue the command to VPP/HW
 114    */
 115   rc_t issue(connection& con);
 116   /**
 117    * convert to string format for debug purposes
 118    */
 119   std::string to_string() const;
 120
 121   /**
 122    * Comparison operator - only used for UT
 123    */
 124   bool operator==(const dump_cmd& i) const;
 125
 126 private:
 127   /**
 128    * HW reutrn code
 129    */
 130   HW::item<bool> item;
 131 };
 132 };
 133 };
 134
 135 /*
 136  * fd.io coding-style-patch-verification: ON
 137  *
 138  * Local Variables:
 139  * eval: (c-set-style "mozilla")
 140  * End:
 141  */
 142
 143 #endif