VOM: bridge-domain learning mode and route help commands
[vpp.git] / 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/inspect.hpp"
20 #include "vom/object_base.hpp"
21 #include "vom/om.hpp"
22 #include "vom/prefix.hpp"
23 #include "vom/singular_db.hpp"
24
25 #include <vapi/ip.api.vapi.hpp>
26
27 namespace VOM {
28 /**
29  * A route-domain is a VRF.
30  *  creating a route-domain object will construct both an IPv4
31  *  and IPv6 table.
32  */
33 class route_domain : public object_base
34 {
35 public:
36   /**
37    * The Key for a route-domain
38    */
39   typedef route::table_id_t key_t;
40
41   /**
42    * Construct a new object matching the desried state
43    */
44   route_domain(route::table_id_t id);
45
46   /**
47    * Copy Constructor
48    */
49   route_domain(const route_domain& o);
50
51   /**
52    * Destructor
53    */
54   ~route_domain();
55
56   /**
57    * Return the matching 'singular instance'
58    */
59   std::shared_ptr<route_domain> singular() const;
60
61   /**
62    * Debug print function
63    */
64   std::string to_string() const;
65
66   /**
67    * Get the table ID
68    */
69   route::table_id_t table_id() const;
70
71   /**
72    * Get the route-domain's key
73    */
74   key_t key() const;
75
76   /**
77    * Find the instnace of the route domain in the OM
78    */
79   static std::shared_ptr<route_domain> find(const route_domain& temp);
80
81   /**
82    * Dump all route-doamin into the stream provided
83    */
84   static void dump(std::ostream& os);
85
86   /**
87    * Return the sigular instance for the default table
88    */
89   static std::shared_ptr<route_domain> get_default();
90
91   /**
92    * replay the object to create it in hardware
93    */
94   void replay(void);
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    * Instance of the 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 route_domain& obj);
136
137   /**
138    * Find or add the instnace of the route domain in the OM
139    */
140   static std::shared_ptr<route_domain> find_or_add(const route_domain& temp);
141
142   /*
143    * It's the OM class that updates the objects in HW
144    */
145   friend class OM;
146
147   /**
148    * It's the singular_db class that calls replay()
149    */
150   friend class singular_db<route::table_id_t, route_domain>;
151
152   /**
153    * Sweep/reap the object if still stale
154    */
155   void sweep(void);
156
157   /**
158    * HW configuration for the result of creating the v4 table
159    */
160   HW::item<bool> m_hw_v4;
161
162   /**
163    * HW configuration for the result of creating the v6 table
164    */
165   HW::item<bool> m_hw_v6;
166
167   /**
168    * VPP understands Table-IDs not table names.
169    *  The table IDs for V4 and V6 are the same.
170    */
171   route::table_id_t m_table_id;
172
173   /**
174    * A map of all interfaces key against the interface's name
175    */
176   static singular_db<route::table_id_t, route_domain> m_db;
177 };
178 }; // namespace VOM
179
180 /*
181  * fd.io coding-style-patch-verification: ON
182  *
183  * Local Variables:
184  * eval: (c-set-style "mozilla")
185  * End:
186  */
187
188 #endif