src/vpp-api/vom/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_ROUTE_DOMAIN_H__
  17 #define __VOM_ROUTE_DOMAIN_H__
  18
  19 #include "vom/object_base.hpp"
  20 #include "vom/om.hpp"
  21 #include "vom/prefix.hpp"
  22 #include "vom/singular_db.hpp"
  23
  24 #include <vapi/ip.api.vapi.hpp>
  25
  26 namespace VOM {
  27 /**
  28  * A route-domain is a VRF.
  29  *  creating a route-domain object will construct both an IPv4
  30  *  and IPv6 table.
  31  */
  32 class route_domain : public object_base
  33 {
  34 public:
  35   /**
  36    * The Key for a route-domain
  37    */
  38   typedef route::table_id_t key_t;
  39
  40   /**
  41    * Construct a new object matching the desried state
  42    */
  43   route_domain(route::table_id_t id);
  44
  45   /**
  46    * Copy Constructor
  47    */
  48   route_domain(const route_domain& o);
  49
  50   /**
  51    * Destructor
  52    */
  53   ~route_domain();
  54
  55   /**
  56    * Return the matching 'singular instance'
  57    */
  58   std::shared_ptr<route_domain> singular() const;
  59
  60   /**
  61    * Debug print function
  62    */
  63   std::string to_string() const;
  64
  65   /**
  66    * Get the table ID
  67    */
  68   route::table_id_t table_id() const;
  69
  70   /**
  71    * Get the route-domain's key
  72    */
  73   key_t key() const;
  74
  75   /**
  76    * Find the instnace of the route domain in the OM
  77    */
  78   static std::shared_ptr<route_domain> find(const route_domain& temp);
  79
  80   /**
  81    * Dump all route-doamin into the stream provided
  82    */
  83   static void dump(std::ostream& os);
  84
  85   /**
  86    * Return the sigular instance for the default table
  87    */
  88   static std::shared_ptr<route_domain> get_default();
  89
  90   /**
  91    * replay the object to create it in hardware
  92    */
  93   void replay(void);
  94
  95 private:
  96   /**
  97    * Commit the acculmulated changes into VPP. i.e. to a 'HW" write.
  98    */
  99   void update(const route_domain& obj);
 100
 101   /**
 102    * Find or add the instnace of the route domain in the OM
 103    */
 104   static std::shared_ptr<route_domain> find_or_add(const route_domain& temp);
 105
 106   /*
 107    * It's the OM class that updates the objects in HW
 108    */
 109   friend class OM;
 110
 111   /**
 112    * It's the singular_db class that calls replay()
 113    */
 114   friend class singular_db<route::table_id_t, route_domain>;
 115
 116   /**
 117    * Sweep/reap the object if still stale
 118    */
 119   void sweep(void);
 120
 121   /**
 122    * HW configuration for the result of creating the v4 table
 123    */
 124   HW::item<bool> m_hw_v4;
 125
 126   /**
 127    * HW configuration for the result of creating the v6 table
 128    */
 129   HW::item<bool> m_hw_v6;
 130
 131   /**
 132    * VPP understands Table-IDs not table names.
 133    *  The table IDs for V4 and V6 are the same.
 134    */
 135   route::table_id_t m_table_id;
 136
 137   /**
 138    * A map of all interfaces key against the interface's name
 139    */
 140   static singular_db<route::table_id_t, route_domain> m_db;
 141 };
 142 }; // namespace VOM
 143
 144 /*
 145  * fd.io coding-style-patch-verification: ON
 146  *
 147  * Local Variables:
 148  * eval: (c-set-style "mozilla")
 149  * End:
 150  */
 151
 152 #endif