src/vpp-api/vom/bridge_domain.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_H__
  17 #define __VOM_BRIDGE_DOMAIN_H__
  18
  19 #include "vom/enum_base.hpp"
  20 #include "vom/hw.hpp"
  21 #include "vom/inspect.hpp"
  22 #include "vom/object_base.hpp"
  23 #include "vom/om.hpp"
  24 #include "vom/singular_db.hpp"
  25
  26 namespace VOM {
  27 /**
  28  * A base class for all object_base in the VPP object_base-Model.
  29  *  provides the abstract interface.
  30  */
  31 class bridge_domain : public object_base
  32 {
  33 public:
  34   /**
  35    * Key Type for Bridge Domains in the sigular DB
  36    */
  37   typedef uint32_t key_t;
  38
  39   /**
  40    * Bridge Domain Learning mode
  41    */
  42   struct learning_mode_t : enum_base<learning_mode_t>
  43   {
  44     const static learning_mode_t ON;
  45     const static learning_mode_t OFF;
  46
  47   private:
  48     /**
  49      * Private constructor taking the value and the string name
  50      */
  51     learning_mode_t(int v, const std::string& s);
  52   };
  53
  54   /**
  55    * Bridge Domain ARP termination mode
  56    */
  57   struct arp_term_mode_t : enum_base<arp_term_mode_t>
  58   {
  59     const static arp_term_mode_t ON;
  60     const static arp_term_mode_t OFF;
  61
  62   private:
  63     /**
  64      * Private constructor taking the value and the string name
  65      */
  66     arp_term_mode_t(int v, const std::string& s);
  67   };
  68
  69   /**
  70    * Bridge Domain MAC aging mode
  71    */
  72   struct mac_age_mode_t : enum_base<mac_age_mode_t>
  73   {
  74     const static mac_age_mode_t ON;
  75     const static mac_age_mode_t OFF;
  76
  77   private:
  78     /**
  79      * Private constructor taking the value and the string name
  80      */
  81     mac_age_mode_t(int v, const std::string& s);
  82   };
  83
  84   /**
  85    * Bridge Domain Learning mode
  86    */
  87   struct flood_mode_t : enum_base<flood_mode_t>
  88   {
  89     const static flood_mode_t ON;
  90     const static flood_mode_t OFF;
  91
  92   private:
  93     /**
  94      * Private constructor taking the value and the string name
  95      */
  96     flood_mode_t(int v, const std::string& s);
  97   };
  98
  99   /**
 100    * The value of the defaultbridge domain
 101    */
 102   const static uint32_t DEFAULT_TABLE = 0;
 103
 104   /**
 105    * Construct a new object matching the desried state
 106    */
 107   bridge_domain(uint32_t id,
 108                 const learning_mode_t& lmode = learning_mode_t::ON,
 109                 const arp_term_mode_t& amode = arp_term_mode_t::ON,
 110                 const flood_mode_t& fmode = flood_mode_t::ON,
 111                 const mac_age_mode_t& mmode = mac_age_mode_t::OFF);
 112
 113   /**
 114    * Copy Constructor
 115    */
 116   bridge_domain(const bridge_domain& o);
 117
 118   /**
 119    * Destructor
 120    */
 121   ~bridge_domain();
 122
 123   /**
 124    * Comparison operator - for UT
 125    */
 126   bool operator==(const bridge_domain& b) const;
 127
 128   /**
 129    * Return the bridge domain's VPP ID
 130    */
 131   uint32_t id() const;
 132
 133   /**
 134    * Return the bridge domain's key
 135    */
 136   const key_t& key() const;
 137
 138   /**
 139    * Return the matchin 'singular' instance of the bridge-domain
 140    */
 141   std::shared_ptr<bridge_domain> singular() const;
 142
 143   /**
 144    * convert to string format for debug purposes
 145    */
 146   std::string to_string(void) const;
 147
 148   /**
 149    * Static function to find the bridge_domain in the model
 150    */
 151   static std::shared_ptr<bridge_domain> find(const key_t& key);
 152
 153   /**
 154    * Dump all bridge-doamin into the stream provided
 155    */
 156   static void dump(std::ostream& os);
 157
 158 private:
 159   /**
 160    * Class definition for listeners to OM events
 161    */
 162   class event_handler : public OM::listener, public inspect::command_handler
 163   {
 164   public:
 165     event_handler();
 166     virtual ~event_handler() = default;
 167
 168     /**
 169      * Handle a populate event
 170      */
 171     void handle_populate(const client_db::key_t& key);
 172
 173     /**
 174      * Handle a replay event
 175      */
 176     void handle_replay();
 177
 178     /**
 179      * Show the object in the Singular DB
 180      */
 181     void show(std::ostream& os);
 182
 183     /**
 184      * Get the sortable Id of the listener
 185      */
 186     dependency_t order() const;
 187   };
 188
 189   /**
 190    * Instance of the event handler to register with OM
 191    */
 192   static event_handler m_evh;
 193
 194   /**
 195    * Commit the acculmulated changes into VPP. i.e. to a 'HW" write.
 196    */
 197   void update(const bridge_domain& obj);
 198
 199   /**
 200    * Find or add an singular of a Bridge-Domain in the object_base Model
 201    */
 202   static std::shared_ptr<bridge_domain> find_or_add(const bridge_domain& temp);
 203
 204   /*
 205    * It's the OM class that calls singular()
 206    */
 207   friend class OM;
 208
 209   /**
 210    * It's the singular_db class that calls replay()
 211    */
 212   friend class singular_db<key_t, bridge_domain>;
 213
 214   /**
 215    * Sweep/reap the object if still stale
 216    */
 217   void sweep(void);
 218
 219   /**
 220    * replay the object to create it in hardware
 221    */
 222   void replay(void);
 223
 224   /**
 225    * The ID we assign to this BD and the HW result in VPP
 226    */
 227   HW::item<uint32_t> m_id;
 228
 229   /**
 230    * The learning mode of the bridge
 231    */
 232   learning_mode_t m_learning_mode;
 233
 234   /**
 235    * The ARP termination mode of the bridge
 236    */
 237   arp_term_mode_t m_arp_term_mode;
 238
 239   /**
 240    * The flood mode of the bridge
 241    */
 242   flood_mode_t m_flood_mode;
 243
 244   /**
 245    * The MAC aging mode of the bridge
 246    */
 247   mac_age_mode_t m_mac_age_mode;
 248
 249   /**
 250    * A map of all interfaces key against the interface's name
 251    */
 252   static singular_db<key_t, bridge_domain> m_db;
 253 };
 254 };
 255
 256 /*
 257  * fd.io coding-style-patch-verification: ON
 258  *
 259  * Local Variables:
 260  * eval: (c-set-style "mozilla")
 261  * End:
 262  */
 263
 264 #endif