extras/vom/vom/gbp_route_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_GBP_ROUTE_DOMAIN_H__
  17 #define __VOM_GBP_ROUTE_DOMAIN_H__
  18
  19 #include "vom/gbp_types.hpp"
  20 #include "vom/interface.hpp"
  21 #include "vom/route_domain.hpp"
  22 #include "vom/singular_db.hpp"
  23 #include "vom/types.hpp"
  24
  25 namespace VOM {
  26
  27 /**
  28  * A entry in the ARP termination table of a Route Domain
  29  */
  30 class gbp_route_domain : public object_base
  31 {
  32 public:
  33   /**
  34    * The key for a route_domain is the pair of EPG-IDs
  35    */
  36   typedef route_domain::key_t key_t;
  37
  38   /**
  39    * Construct a GBP route_domain
  40    */
  41   gbp_route_domain(const route_domain& rd, scope_t scope);
  42
  43   gbp_route_domain(const route_domain& rd,
  44                    scope_t scope,
  45                    const interface& ip4_uu_fwd,
  46                    const interface& ip6_uu_fwd);
  47   gbp_route_domain(const route_domain& rd,
  48                    scope_t scope,
  49                    const std::shared_ptr<interface> ip4_uu_fwd,
  50                    const std::shared_ptr<interface> ip6_uu_fwd);
  51
  52   /**
  53    * Copy Construct
  54    */
  55   gbp_route_domain(const gbp_route_domain& r);
  56
  57   /**
  58    * Destructor
  59    */
  60   ~gbp_route_domain();
  61
  62   /**
  63    * Return the object's key
  64    */
  65   const key_t key() const;
  66
  67   /**
  68    * Return the route domain's VPP ID
  69    */
  70   route::table_id_t id() const;
  71
  72   /**
  73    * comparison operator
  74    */
  75   bool operator==(const gbp_route_domain& rdae) const;
  76
  77   /**
  78    * Return the matching 'singular instance'
  79    */
  80   std::shared_ptr<gbp_route_domain> singular() const;
  81
  82   /**
  83    * Find the instnace of the route_domain domain in the OM
  84    */
  85   static std::shared_ptr<gbp_route_domain> find(const key_t& k);
  86
  87   /**
  88    * Dump all route_domain-doamin into the stream provided
  89    */
  90   static void dump(std::ostream& os);
  91
  92   /**
  93    * replay the object to create it in hardware
  94    */
  95   void replay(void);
  96
  97   /**
  98    * Convert to string for debugging
  99    */
 100   std::string to_string() const;
 101
 102   /**
 103    * Accessors for children
 104    */
 105   const std::shared_ptr<route_domain> get_route_domain() const;
 106   const std::shared_ptr<interface> get_ip4_uu_fwd() const;
 107   const std::shared_ptr<interface> get_ip6_uu_fwd() const;
 108
 109 private:
 110   /**
 111    * Class definition for listeners to OM events
 112    */
 113   class event_handler : public OM::listener, public inspect::command_handler
 114   {
 115   public:
 116     event_handler();
 117     virtual ~event_handler() = default;
 118
 119     /**
 120      * Handle a populate event
 121      */
 122     void handle_populate(const client_db::key_t& key);
 123
 124     /**
 125      * Handle a replay event
 126      */
 127     void handle_replay();
 128
 129     /**
 130      * Show the object in the Singular DB
 131      */
 132     void show(std::ostream& os);
 133
 134     /**
 135      * Get the sortable Id of the listener
 136      */
 137     dependency_t order() const;
 138   };
 139
 140   /**
 141    * event_handler to register with OM
 142    */
 143   static event_handler m_evh;
 144
 145   /**
 146    * Commit the acculmulated changes into VPP. i.e. to a 'HW" write.
 147    */
 148   void update(const gbp_route_domain& obj);
 149
 150   /**
 151    * Find or add the instance of the route_domain domain in the OM
 152    */
 153   static std::shared_ptr<gbp_route_domain> find_or_add(
 154     const gbp_route_domain& temp);
 155
 156   /*
 157    * It's the VPPHW class that updates the objects in HW
 158    */
 159   friend class OM;
 160
 161   /**
 162    * It's the singular_db class that calls replay()
 163    */
 164   friend class singular_db<key_t, gbp_route_domain>;
 165
 166   /**
 167    * Sweep/reap the object if still stale
 168    */
 169   void sweep(void);
 170
 171   /**
 172    * HW configuration for the result of creating the endpoint
 173    */
 174   HW::item<uint32_t> m_id;
 175
 176   std::shared_ptr<route_domain> m_rd;
 177   scope_t m_scope;
 178   std::shared_ptr<interface> m_ip4_uu_fwd;
 179   std::shared_ptr<interface> m_ip6_uu_fwd;
 180
 181   /**
 182    * A map of all route_domains
 183    */
 184   static singular_db<key_t, gbp_route_domain> m_db;
 185 };
 186
 187 }; // namespace
 188
 189 /*
 190  * fd.io coding-style-patch-verification: ON
 191  *
 192  * Local Variables:
 193  * eval: (c-set-style "mozilla")
 194  * End:
 195  */
 196
 197 #endif