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 #include "vom/interface.hpp"
17 #include "vom/interface_cmds.hpp"
18 #include "vom/interface_factory.hpp"
19 #include "vom/l3_binding_cmds.hpp"
20 #include "vom/logger.hpp"
21 #include "vom/prefix.hpp"
25 * A DB of all the interfaces, key on the name
27 singular_db<const std::string, interface> interface::m_db;
30 * A DB of all the interfaces, key on VPP's handle
32 std::map<handle_t, std::weak_ptr<interface>> interface::m_hdl_db;
34 interface::event_handler interface::m_evh;
37 * Construct a new object matching the desried state
39 interface::interface(const std::string& name,
40 interface::type_t itf_type,
41 interface::admin_state_t itf_state)
42 : m_hdl(handle_t::INVALID)
46 , m_table_id(route::DEFAULT_TABLE)
47 , m_l2_address(l2_address_t::ZERO, rc_t::UNSET)
48 , m_oper(oper_state_t::DOWN)
52 interface::interface(const handle_t& handle,
53 const l2_address_t& l2_address,
54 const std::string& name,
55 interface::type_t type,
56 interface::admin_state_t state)
61 , m_table_id(route::DEFAULT_TABLE)
62 , m_l2_address(l2_address)
63 , m_oper(oper_state_t::DOWN)
67 interface::interface(const std::string& name,
68 interface::type_t itf_type,
69 interface::admin_state_t itf_state,
70 const route_domain& rd)
71 : m_hdl(handle_t::INVALID)
76 , m_table_id(m_rd->table_id())
77 , m_l2_address(l2_address_t::ZERO, rc_t::UNSET)
78 , m_oper(oper_state_t::DOWN)
82 interface::interface(const interface& o)
88 , m_table_id(o.m_table_id)
89 , m_l2_address(o.m_l2_address)
94 interface::event_listener::event_listener()
95 : m_status(rc_t::NOOP)
100 interface::event_listener::status()
105 interface::stat_listener::stat_listener()
106 : m_status(rc_t::NOOP)
111 interface::stat_listener::status()
117 * Return the interface type
119 const interface::type_t&
120 interface::type() const
126 interface::handle() const
128 return (singular()->handle_i());
132 interface::handle_i() const
134 return (m_hdl.data());
138 interface::l2_address() const
140 return (m_l2_address.data());
143 interface::const_iterator_t
146 return m_db.cbegin();
149 interface::const_iterator_t
158 if (m_table_id && (m_table_id.data() != route::DEFAULT_TABLE)) {
159 m_table_id.data() = route::DEFAULT_TABLE;
161 new interface_cmds::set_table_cmd(m_table_id, l3_proto_t::IPV4, m_hdl));
163 new interface_cmds::set_table_cmd(m_table_id, l3_proto_t::IPV6, m_hdl));
166 // If the interface is up, bring it down
167 if (m_state && interface::admin_state_t::UP == m_state.data()) {
168 m_state.data() = interface::admin_state_t::DOWN;
169 HW::enqueue(new interface_cmds::state_change_cmd(m_state, m_hdl));
172 std::queue<cmd*> cmds;
173 HW::enqueue(mk_delete_cmd(cmds));
182 std::queue<cmd*> cmds;
183 HW::enqueue(mk_create_cmd(cmds));
186 if (m_state && interface::admin_state_t::UP == m_state.data()) {
187 HW::enqueue(new interface_cmds::state_change_cmd(m_state, m_hdl));
190 if (m_table_id && (m_table_id.data() != route::DEFAULT_TABLE)) {
192 new interface_cmds::set_table_cmd(m_table_id, l3_proto_t::IPV4, m_hdl));
194 new interface_cmds::set_table_cmd(m_table_id, l3_proto_t::IPV6, m_hdl));
198 interface::~interface()
207 // not in the DB anymore.
208 m_db.release(m_name, this);
212 interface::to_string() const
214 std::ostringstream s;
215 s << "interface:[" << m_name << " type:" << m_type.to_string()
216 << " hdl:" << m_hdl.to_string()
217 << " l2-address:" << m_l2_address.to_string();
220 s << " rd:" << m_rd->to_string();
223 s << " admin-state:" << m_state.to_string()
224 << " oper-state:" << m_oper.to_string() << "]";
230 interface::name() const
235 const interface::key_type&
236 interface::key() const
242 interface::mk_create_cmd(std::queue<cmd*>& q)
244 if (type_t::LOOPBACK == m_type) {
245 q.push(new interface_cmds::loopback_create_cmd(m_hdl, m_name));
246 } else if (type_t::BVI == m_type) {
247 q.push(new interface_cmds::loopback_create_cmd(m_hdl, m_name));
248 q.push(new interface_cmds::set_tag(m_hdl, m_name));
249 } else if (type_t::AFPACKET == m_type) {
250 q.push(new interface_cmds::af_packet_create_cmd(m_hdl, m_name));
251 } else if (type_t::TAP == m_type) {
252 q.push(new interface_cmds::tap_create_cmd(m_hdl, m_name));
259 interface::mk_delete_cmd(std::queue<cmd*>& q)
261 if ((type_t::LOOPBACK == m_type) || (type_t::BVI == m_type)) {
262 q.push(new interface_cmds::loopback_delete_cmd(m_hdl));
263 } else if (type_t::AFPACKET == m_type) {
264 q.push(new interface_cmds::af_packet_delete_cmd(m_hdl, m_name));
265 } else if (type_t::TAP == m_type) {
266 q.push(new interface_cmds::tap_delete_cmd(m_hdl));
273 interface::update(const interface& desired)
276 * the desired state is always that the interface should be created
278 if (rc_t::OK != m_hdl.rc()) {
279 std::queue<cmd*> cmds;
280 HW::enqueue(mk_create_cmd(cmds));
284 * change the interface state to that which is deisred
286 if (m_state.update(desired.m_state)) {
287 HW::enqueue(new interface_cmds::state_change_cmd(m_state, m_hdl));
291 * change the interface state to that which is deisred
293 if (m_l2_address.update(desired.m_l2_address)) {
294 HW::enqueue(new interface_cmds::set_mac_cmd(m_l2_address, m_hdl));
298 * If the interface is mapped into a route domain, set VPP's
301 if (m_rd != desired.m_rd) {
303 * changing route domains. need to remove all L3 bindings, swap the table
304 * then reapply the bindings.
306 auto it = l3_binding::cbegin();
308 while (it != l3_binding::cend()) {
309 if (it->second.lock()->itf().key() == key())
310 it->second.lock()->sweep();
314 m_table_id.update(m_rd ? m_rd->table_id() : route::DEFAULT_TABLE);
316 new interface_cmds::set_table_cmd(m_table_id, l3_proto_t::IPV4, m_hdl));
318 new interface_cmds::set_table_cmd(m_table_id, l3_proto_t::IPV6, m_hdl));
321 it = l3_binding::cbegin();
322 while (it != l3_binding::cend()) {
323 if (it->second.lock()->itf().key() == key())
324 it->second.lock()->replay(); //(*it->second.lock());
327 } else if (!m_table_id && m_rd) {
329 new interface_cmds::set_table_cmd(m_table_id, l3_proto_t::IPV4, m_hdl));
331 new interface_cmds::set_table_cmd(m_table_id, l3_proto_t::IPV6, m_hdl));
336 interface::set(const l2_address_t& addr)
338 assert(rc_t::UNSET == m_l2_address.rc());
339 m_l2_address.set(rc_t::NOOP);
340 m_l2_address.update(addr);
344 interface::set(const oper_state_t& state)
349 std::shared_ptr<interface>
350 interface::singular_i() const
352 return (m_db.find_or_add(name(), *this));
355 std::shared_ptr<interface>
356 interface::singular() const
361 std::shared_ptr<interface>
362 interface::find(const std::string& name)
364 return (m_db.find(name));
367 std::shared_ptr<interface>
368 interface::find(const handle_t& handle)
370 return (m_hdl_db[handle].lock());
374 interface::add(const std::string& name, const HW::item<handle_t>& item)
376 std::shared_ptr<interface> sp = find(name);
379 m_hdl_db[item.data()] = sp;
384 interface::remove(const HW::item<handle_t>& item)
386 m_hdl_db.erase(item.data());
390 interface::dump(std::ostream& os)
396 interface::event_handler::handle_populate(const client_db::key_t& key)
399 * dump VPP current states
401 std::shared_ptr<interface_cmds::dump_cmd> cmd(new interface_cmds::dump_cmd());
406 for (auto& itf_record : *cmd) {
407 std::unique_ptr<interface> itf =
408 interface_factory::new_interface(itf_record.get_payload());
410 if (itf && interface::type_t::LOCAL != itf->type()) {
411 VOM_LOG(log_level_t::DEBUG) << "dump: " << itf->to_string();
413 * Write each of the discovered interfaces into the OM,
414 * but disable the HW Command q whilst we do, so that no
415 * commands are sent to VPP
417 OM::commit(key, *itf);
420 * Get the address configured on the interface
422 std::shared_ptr<l3_binding_cmds::dump_v4_cmd> dcmd =
423 std::make_shared<l3_binding_cmds::dump_v4_cmd>(
424 l3_binding_cmds::dump_v4_cmd(itf->handle()));
429 for (auto& l3_record : *dcmd) {
430 auto& payload = l3_record.get_payload();
431 const route::prefix_t pfx(payload.is_ipv6, payload.ip,
432 payload.prefix_length);
434 VOM_LOG(log_level_t::DEBUG) << "dump: " << pfx.to_string();
436 l3_binding l3(*itf, pfx);
443 interface::event_handler::event_handler()
445 OM::register_listener(this);
446 inspect::register_handler({ "interface", "intf" }, "interfaces", this);
450 interface::event_handler::handle_replay()
456 interface::event_handler::order() const
458 return (dependency_t::INTERFACE);
462 interface::event_handler::show(std::ostream& os)
468 * fd.io coding-style-patch-verification: ON
471 * eval: (c-set-style "mozilla")