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"
25 #include <vapi/ip.api.vapi.hpp>
29 * A route-domain is a VRF.
30 * creating a route-domain object will construct both an IPv4
33 class route_domain : public object_base
37 * The Key for a route-domain
39 typedef route::table_id_t key_t;
42 * Construct a new object matching the desried state
44 route_domain(route::table_id_t id);
49 route_domain(const route_domain& o);
57 * comparison operator - for UT
59 bool operator==(const route_domain& r) const;
62 * Return the matching 'singular instance'
64 std::shared_ptr<route_domain> singular() const;
67 * Debug print function
69 std::string to_string() const;
74 route::table_id_t table_id() const;
77 * Get the route-domain's key
82 * Find the instnace of the route domain in the OM
84 static std::shared_ptr<route_domain> find(const key_t& temp);
87 * Dump all route-doamin into the stream provided
89 static void dump(std::ostream& os);
92 * Return the sigular instance for the default table
94 static std::shared_ptr<route_domain> get_default();
97 * replay the object to create it in hardware
103 * Class definition for listeners to OM events
105 class event_handler : public OM::listener, public inspect::command_handler
109 virtual ~event_handler() = default;
112 * Handle a populate event
114 void handle_populate(const client_db::key_t& key);
117 * Handle a replay event
119 void handle_replay();
122 * Show the object in the Singular DB
124 void show(std::ostream& os);
127 * Get the sortable Id of the listener
129 dependency_t order() const;
133 * Instance of the event handler to register with OM
135 static event_handler m_evh;
138 * Commit the acculmulated changes into VPP. i.e. to a 'HW" write.
140 void update(const route_domain& obj);
143 * Find or add the instnace of the route domain in the OM
145 static std::shared_ptr<route_domain> find_or_add(const route_domain& temp);
148 * It's the OM class that updates the objects in HW
153 * It's the singular_db class that calls replay()
155 friend class singular_db<route::table_id_t, route_domain>;
158 * Sweep/reap the object if still stale
163 * HW configuration for the result of creating the v4 table
165 HW::item<bool> m_hw_v4;
168 * HW configuration for the result of creating the v6 table
170 HW::item<bool> m_hw_v6;
173 * VPP understands Table-IDs not table names.
174 * The table IDs for V4 and V6 are the same.
176 route::table_id_t m_table_id;
179 * A map of all interfaces key against the interface's name
181 static singular_db<route::table_id_t, route_domain> m_db;
186 * fd.io coding-style-patch-verification: ON
189 * eval: (c-set-style "mozilla")