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