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_INTERFACE_IP6_ND_H__
17 #define __VOM_INTERFACE_IP6_ND_H__
19 #include "vom/dump_cmd.hpp"
21 #include "vom/inspect.hpp"
22 #include "vom/interface.hpp"
23 #include "vom/object_base.hpp"
25 #include "vom/ra_config.hpp"
26 #include "vom/ra_prefix.hpp"
27 #include "vom/rpc_cmd.hpp"
28 #include "vom/singular_db.hpp"
32 * A representation of L3 configuration on an interface
34 template <typename CLASS, typename CMD>
35 class interface_ip6_nd : public object_base
38 typedef CLASS class_t;
40 * Construct a new object matching the desried state
42 interface_ip6_nd(const interface& itf, const class_t cls)
43 : m_itf(itf.singular())
52 interface_ip6_nd(const interface_ip6_nd& o)
55 , m_config(o.m_config)
65 m_db.release(m_itf->key(), this);
69 * Return the 'singular instance' of the interface ip6nd that matches
72 std::shared_ptr<interface_ip6_nd> singular() const
74 return find_or_add(*this);
78 * convert to string format for debug purposes
80 std::string to_string() const
83 s << "interface-ip6-nd:["
84 << " itf:" << m_itf->to_string() << " " << m_cls.to_string() << " "
85 << m_config.to_string() << "]";
91 * Dump all config into the stream provided
93 static void dump(std::ostream& os) { m_db.dump(os); }
96 * The key type for interface ip6 nd
98 typedef interface::key_t key_t;
101 * Find an singular instance in the DB for the interface passed
103 static std::shared_ptr<interface_ip6_nd> find(const interface& i)
106 * Loop throught the entire map looking for matching interface.
107 * not the most efficient algorithm, but it will do for now. The
108 * number of ra configs is low.
110 std::deque<std::shared_ptr<interface_ip6_nd>> rac;
112 auto it = m_db.cbegin();
114 while (it != m_db.cend()) {
116 * The key in the DB is a pair of the interface's name.
117 * If the keys match, save the ra-config
119 auto key = it->first;
121 if (i.key() == key.first) {
122 rac.push_back(it->second.lock());
132 * A functor class that binds the ra config to the interface
134 class config_cmd : public rpc_cmd<HW::item<bool>, CMD>
140 config_cmd(HW::item<bool>& item, const handle_t& itf, const class_t& cls)
141 : rpc_cmd<HW::item<bool>, CMD>(item)
148 * Issue the command to VPP/HW
150 rc_t issue(connection& con);
153 * convert to string format for debug purposes
155 std::string to_string() const
157 std::ostringstream s;
158 s << "interface-ip6-nd: " << this->item().to_string()
159 << " itf:" << m_itf.to_string() << " " << m_cls.to_string();
165 * Comparison operator - only used for UT
167 bool operator==(const config_cmd& other) const
169 return ((m_itf == other.m_itf) && (m_cls == other.m_cls));
174 * Reference to the interface to bind to
176 const handle_t& m_itf;
179 * Reference to the config class
181 const class_t& m_cls;
185 * A cmd class that Unbinds L3 Config from an interface
187 class unconfig_cmd : public rpc_cmd<HW::item<bool>, CMD>
193 unconfig_cmd(HW::item<bool>& item, const handle_t& itf, const class_t& cls)
194 : rpc_cmd<HW::item<bool>, CMD>(item)
201 * Issue the command to VPP/HW
203 rc_t issue(connection& con);
206 * convert to string format for debug purposes
208 std::string to_string() const
210 std::ostringstream s;
211 s << "interface-ip6-nd: " << this->item().to_string()
212 << " itf:" << m_itf.to_string() << " " << m_cls.to_string();
218 * Comparison operator - only used for UT
220 bool operator==(const unconfig_cmd& other) const
222 return ((m_itf == other.m_itf) && (m_cls == other.m_cls));
227 * Reference to the interface to unbind fomr
229 const handle_t& m_itf;
232 * Reference to the config class to undo configurations
234 const class_t& m_cls;
239 * Class definition for listeners to OM events
241 class event_handler : public OM::listener, public inspect::command_handler
246 OM::register_listener(this);
247 inspect::register_handler({ "ip6_nd " }, "interface ip6 nd", this);
250 virtual ~event_handler() = default;
253 * Handle a populate event
255 void handle_populate(const client_db::key_t& key)
258 * VPP provides no dump for ra config
263 * Handle a replay event
265 void handle_replay() { m_db.replay(); }
268 * Show the object in the Singular DB
270 void show(std::ostream& os) { m_db.dump(os); }
273 * Get the sortable Id of the listener
275 dependency_t order() const { return (dependency_t::BINDING); }
279 * event_handler to register with OM
281 static event_handler m_evh;
284 * Enqueue commands to the VPP for the update
286 void update(const interface_ip6_nd& obj)
289 HW::enqueue(new config_cmd(m_config, m_itf->handle(), m_cls));
296 HW::enqueue(new unconfig_cmd(m_config, m_itf->handle(), m_cls));
302 * Replay the objects state to HW
307 HW::enqueue(new config_cmd(m_config, m_itf->handle(), m_cls));
312 * Find or add the singular instance in the DB
314 static std::shared_ptr<interface_ip6_nd> find_or_add(
315 const interface_ip6_nd& temp)
317 return (m_db.find_or_add(temp.m_itf->key(), temp));
321 * It's the VPPHW class that updates the objects in HW
326 * It's the singular_db class that calls replay()
328 friend class singular_db<key_t, interface_ip6_nd>;
330 const std::shared_ptr<interface> m_itf;
337 * HW configuration for the binding. The bool representing the
340 HW::item<bool> m_config;
343 * A map of all interface ip6 nd keyed against a combination of the
344 * interface and subnet's keys.
346 static singular_db<key_t, interface_ip6_nd> m_db;
350 * Typedef the ip6nd_ra_config
352 typedef interface_ip6_nd<ra_config, vapi::Sw_interface_ip6nd_ra_config>
356 * Typedef the ip6nd_ra_prefix
358 typedef interface_ip6_nd<ra_prefix, vapi::Sw_interface_ip6nd_ra_prefix>
362 * Definition of the static singular_db for ACL Lists
364 template <typename CLASS, typename CMD>
365 singular_db<typename interface_ip6_nd<CLASS, CMD>::key_t,
366 interface_ip6_nd<CLASS, CMD>>
367 interface_ip6_nd<CLASS, CMD>::m_db;
369 template <typename CLASS, typename CMD>
370 typename interface_ip6_nd<CLASS, CMD>::event_handler
371 interface_ip6_nd<CLASS, CMD>::m_evh;
375 * fd.io coding-style-patch-verification: ON
378 * eval: (c-set-style "mozilla")