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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 #ifndef __VOM_ROUTE_DOMAIN_H__
17 #define __VOM_ROUTE_DOMAIN_H__
19 #include "vom/inspect.hpp"
20 #include "vom/object_base.hpp"
22 #include "vom/prefix.hpp"
23 #include "vom/singular_db.hpp"
27 * A route-domain is a VRF.
28 * creating a route-domain object will construct both an IPv4
31 class route_domain : public object_base
35 * The Key for a route-domain
37 typedef route::table_id_t key_t;
42 typedef singular_db<const key_t, route_domain>::const_iterator
45 static const_iterator_t cbegin();
46 static const_iterator_t cend();
49 * Construct a new object matching the desried state
51 route_domain(route::table_id_t id);
56 route_domain(const route_domain& o);
64 * comparison operator - for UT
66 bool operator==(const route_domain& r) const;
69 * Return the matching 'singular instance'
71 std::shared_ptr<route_domain> singular() const;
74 * Debug print function
76 std::string to_string() const;
81 route::table_id_t table_id() const;
84 * Get the route-domain's key
89 * Find the instnace of the route domain in the OM
91 static std::shared_ptr<route_domain> find(const key_t& temp);
94 * Dump all route-doamin into the stream provided
96 static void dump(std::ostream& os);
99 * Return the sigular instance for the default table
101 static std::shared_ptr<route_domain> get_default();
104 * replay the object to create it in hardware
110 * Class definition for listeners to OM events
112 class event_handler : public OM::listener, public inspect::command_handler
116 virtual ~event_handler() = default;
119 * Handle a populate event
121 void handle_populate(const client_db::key_t& key);
124 * Handle a replay event
126 void handle_replay();
129 * Show the object in the Singular DB
131 void show(std::ostream& os);
134 * Get the sortable Id of the listener
136 dependency_t order() const;
140 * Instance of the event handler to register with OM
142 static event_handler m_evh;
145 * Commit the acculmulated changes into VPP. i.e. to a 'HW" write.
147 void update(const route_domain& obj);
150 * Find or add the instnace of the route domain in the OM
152 static std::shared_ptr<route_domain> find_or_add(const route_domain& temp);
155 * It's the OM class that updates the objects in HW
160 * It's the singular_db class that calls replay()
162 friend class singular_db<route::table_id_t, route_domain>;
165 * Sweep/reap the object if still stale
170 * HW configuration for the result of creating the v4 table
172 HW::item<bool> m_hw_v4;
175 * HW configuration for the result of creating the v6 table
177 HW::item<bool> m_hw_v6;
180 * VPP understands Table-IDs not table names.
181 * The table IDs for V4 and V6 are the same.
183 route::table_id_t m_table_id;
186 * A map of all interfaces key against the interface's name
188 static singular_db<route::table_id_t, route_domain> m_db;
193 * fd.io coding-style-patch-verification: ON
196 * eval: (c-set-style "mozilla")