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/bond_group_binding.hpp"
18 #include "vom/bond_group_binding_cmds.hpp"
19 #include "vom/bond_interface_cmds.hpp"
20 #include "vom/interface_cmds.hpp"
21 #include "vom/interface_factory.hpp"
22 #include "vom/l3_binding_cmds.hpp"
23 #include "vom/logger.hpp"
24 #include "vom/prefix.hpp"
25 #include "vom/singular_db_funcs.hpp"
26 #include "vom/stat_reader.hpp"
27 #include "vom/tap_interface_cmds.hpp"
31 * A DB of all the interfaces, key on the name
33 singular_db<interface::key_t, interface> interface::m_db;
36 * A DB of all the interfaces, key on VPP's handle
38 std::map<handle_t, std::weak_ptr<interface>> interface::m_hdl_db;
40 interface::event_handler interface::m_evh;
43 * the event enable command.
45 std::shared_ptr<interface_cmds::events_cmd> interface::m_events_cmd;
48 * Construct a new object matching the desried state
50 interface::interface(const std::string& name,
51 interface::type_t itf_type,
52 interface::admin_state_t itf_state,
53 const std::string& tag)
54 : m_hdl(handle_t::INVALID)
58 , m_table_id(route::DEFAULT_TABLE)
59 , m_l2_address(l2_address_t::ZERO, rc_t::UNSET)
60 , m_stats_type(stats_type_t::NORMAL)
61 , m_oper(oper_state_t::DOWN)
66 interface::interface(const std::string& name,
67 interface::type_t itf_type,
68 interface::admin_state_t itf_state,
69 const route_domain& rd,
70 const std::string& tag)
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_stats_type(stats_type_t::NORMAL)
79 , m_oper(oper_state_t::DOWN)
84 interface::interface(const interface& o)
90 , m_table_id(o.m_table_id)
91 , m_l2_address(o.m_l2_address)
92 , m_stats_type(o.m_stats_type)
99 interface::operator==(const interface& i) const
101 return ((key() == i.key()) &&
102 (m_l2_address.data() == i.m_l2_address.data()) &&
103 (m_state == i.m_state) && (m_rd == i.m_rd) && (m_type == i.m_type) &&
104 (m_oper == i.m_oper));
107 interface::event_listener::event_listener()
108 : m_status(rc_t::NOOP)
113 interface::event_listener::status()
118 interface::stat_listener::stat_listener()
119 : m_status(rc_t::NOOP)
124 interface::stat_listener::status()
130 * Return the interface type
132 const interface::type_t&
133 interface::type() const
139 interface::handle() const
141 return (singular()->handle_i());
145 interface::handle_i() const
147 return (m_hdl.data());
151 interface::l2_address() const
153 return (m_l2_address.data());
156 interface::const_iterator_t
162 interface::const_iterator_t
171 if (m_table_id && (m_table_id.data() != route::DEFAULT_TABLE)) {
172 m_table_id.data() = route::DEFAULT_TABLE;
174 new interface_cmds::set_table_cmd(m_table_id, l3_proto_t::IPV4, m_hdl));
176 new interface_cmds::set_table_cmd(m_table_id, l3_proto_t::IPV6, m_hdl));
183 // If the interface is up, bring it down
184 if (m_state && interface::admin_state_t::UP == m_state.data()) {
185 m_state.data() = interface::admin_state_t::DOWN;
186 HW::enqueue(new interface_cmds::state_change_cmd(m_state, m_hdl));
190 std::queue<cmd*> cmds;
191 HW::enqueue(mk_delete_cmd(cmds));
200 std::queue<cmd*> cmds;
201 HW::enqueue(mk_create_cmd(cmds));
204 if (m_state && interface::admin_state_t::UP == m_state.data()) {
205 HW::enqueue(new interface_cmds::state_change_cmd(m_state, m_hdl));
209 enable_stats(m_listener, m_stats_type.data());
212 if (m_table_id && (m_table_id.data() != route::DEFAULT_TABLE)) {
214 new interface_cmds::set_table_cmd(m_table_id, l3_proto_t::IPV4, m_hdl));
216 new interface_cmds::set_table_cmd(m_table_id, l3_proto_t::IPV6, m_hdl));
220 interface::~interface()
229 // not in the DB anymore.
230 m_db.release(m_name, this);
234 interface::to_string() const
236 std::ostringstream s;
237 s << "interface:[" << m_name << " type:" << m_type.to_string()
238 << " hdl:" << m_hdl.to_string() << " l2-address:["
239 << m_l2_address.to_string() << "]";
242 s << " rd:" << m_rd->to_string();
245 s << " admin-state:" << m_state.to_string()
246 << " oper-state:" << m_oper.to_string();
248 if (!m_tag.empty()) {
249 s << " tag:[" << m_tag << "]";
258 interface::name() const
263 const interface::key_t&
264 interface::key() const
270 interface::mk_create_cmd(std::queue<cmd*>& q)
272 if ((type_t::LOOPBACK == m_type) || (type_t::BVI == m_type)) {
273 q.push(new interface_cmds::loopback_create_cmd(m_hdl, m_name));
274 q.push(new interface_cmds::set_tag(m_hdl, m_name));
276 * set the m_tag for pretty-print
279 } else if (type_t::AFPACKET == m_type) {
280 q.push(new interface_cmds::af_packet_create_cmd(m_hdl, m_name));
282 q.push(new interface_cmds::set_tag(m_hdl, m_tag));
283 } else if (type_t::TAPV2 == m_type) {
285 q.push(new interface_cmds::set_tag(m_hdl, m_tag));
286 } else if (type_t::VHOST == m_type) {
287 q.push(new interface_cmds::vhost_create_cmd(m_hdl, m_name, m_tag));
296 interface::mk_delete_cmd(std::queue<cmd*>& q)
298 if ((type_t::LOOPBACK == m_type) || (type_t::BVI == m_type)) {
299 q.push(new interface_cmds::loopback_delete_cmd(m_hdl));
300 } else if (type_t::AFPACKET == m_type) {
301 q.push(new interface_cmds::af_packet_delete_cmd(m_hdl, m_name));
302 } else if (type_t::VHOST == m_type) {
303 q.push(new interface_cmds::vhost_delete_cmd(m_hdl, m_name));
310 interface::update(const interface& desired)
313 * the desired state is always that the interface should be created
315 if (rc_t::OK != m_hdl.rc()) {
316 std::queue<cmd*> cmds;
317 HW::enqueue(mk_create_cmd(cmds));
319 * interface create now, so we can barf early if it fails
325 * If the interface is not created do other commands should be issued
327 if (rc_t::OK != m_hdl.rc())
331 * change the interface state to that which is deisred
333 if (m_state.update(desired.m_state)) {
334 HW::enqueue(new interface_cmds::state_change_cmd(m_state, m_hdl));
338 * change the interface state to that which is deisred
340 if (m_l2_address.update(desired.m_l2_address)) {
341 HW::enqueue(new interface_cmds::set_mac_cmd(m_l2_address, m_hdl));
345 * If the interface is mapped into a route domain, set VPP's
348 if (m_rd != desired.m_rd) {
350 * changing route domains. need to remove all L3 bindings, swap the table
351 * then reapply the bindings.
353 auto it = l3_binding::cbegin();
355 while (it != l3_binding::cend()) {
356 if (it->second.lock()->itf().key() == key())
357 it->second.lock()->sweep();
361 m_table_id.update(m_rd ? m_rd->table_id() : route::DEFAULT_TABLE);
363 new interface_cmds::set_table_cmd(m_table_id, l3_proto_t::IPV4, m_hdl));
365 new interface_cmds::set_table_cmd(m_table_id, l3_proto_t::IPV6, m_hdl));
368 it = l3_binding::cbegin();
369 while (it != l3_binding::cend()) {
370 if (it->second.lock()->itf().key() == key())
371 it->second.lock()->replay(); //(*it->second.lock());
374 } else if (!m_table_id && m_rd) {
376 new interface_cmds::set_table_cmd(m_table_id, l3_proto_t::IPV4, m_hdl));
378 new interface_cmds::set_table_cmd(m_table_id, l3_proto_t::IPV6, m_hdl));
383 interface::set(const admin_state_t& state)
389 interface::set(const l2_address_t& addr)
391 assert(rc_t::UNSET == m_l2_address.rc());
392 m_l2_address.set(rc_t::NOOP);
393 m_l2_address.update(addr);
397 interface::set(const handle_t& hdl)
403 interface::set(const oper_state_t& state)
409 interface::set(const std::string& tag)
415 interface::set(counter_t count, const std::string& stat_type)
417 if ("rx" == stat_type)
418 m_stats.m_rx = count;
419 else if ("tx" == stat_type)
420 m_stats.m_tx = count;
421 else if ("rx-unicast" == stat_type)
422 m_stats.m_rx_unicast = count;
423 else if ("tx-unicast" == stat_type)
424 m_stats.m_tx_unicast = count;
425 else if ("rx-multicast" == stat_type)
426 m_stats.m_rx_multicast = count;
427 else if ("tx-multicast" == stat_type)
428 m_stats.m_tx_multicast = count;
429 else if ("rx-broadcast" == stat_type)
430 m_stats.m_rx_broadcast = count;
431 else if ("tx-broadcast" == stat_type)
432 m_stats.m_rx_broadcast = count;
435 const interface::stats_t&
436 interface::get_stats(void) const
442 interface::publish_stats()
444 m_listener->handle_interface_stat(*this);
448 operator<<(std::ostream& os, const interface::stats_t& stats)
451 << "rx [packets " << stats.m_rx.packets << ", bytes " << stats.m_rx.bytes
453 << " rx-unicast [packets " << stats.m_rx_unicast.packets << ", bytes "
454 << stats.m_rx_unicast.bytes << "]"
455 << " rx-multicast [packets " << stats.m_rx_multicast.packets << ", bytes "
456 << stats.m_rx_multicast.bytes << "]"
457 << " rx-broadcast [packets " << stats.m_rx_broadcast.packets << ", bytes "
458 << stats.m_rx_broadcast.bytes << "]"
459 << " tx [packets " << stats.m_tx.packets << ", bytes " << stats.m_tx.bytes
461 << " tx-unicast [packets " << stats.m_tx_unicast.packets << ", bytes "
462 << stats.m_tx_unicast.bytes << "]"
463 << " tx-multicast [packets " << stats.m_tx_multicast.packets << ", bytes "
464 << stats.m_tx_multicast.bytes << "]"
465 << " tx-broadcast [packets " << stats.m_tx_broadcast.packets << ", bytes "
466 << stats.m_tx_broadcast.bytes << "]]" << std::endl;
472 interface::enable_stats_i(interface::stat_listener* el, const stats_type_t& st)
475 if (stats_type_t::DETAILED == st) {
476 m_stats_type.set(rc_t::NOOP);
477 HW::enqueue(new interface_cmds::collect_detail_stats_change_cmd(
478 m_stats_type, handle_i(), true));
480 stat_reader::registers(*this);
486 interface::enable_stats(interface::stat_listener* el, const stats_type_t& st)
488 singular()->enable_stats_i(el, st);
492 interface::disable_stats_i()
494 if (m_listener != NULL) {
495 if (stats_type_t::DETAILED == m_stats_type) {
496 HW::enqueue(new interface_cmds::collect_detail_stats_change_cmd(
497 m_stats_type, handle_i(), false));
499 stat_reader::unregisters(*this);
505 interface::disable_stats()
507 singular()->disable_stats_i();
510 std::shared_ptr<interface>
511 interface::singular_i() const
513 return (m_db.find_or_add(key(), *this));
516 std::shared_ptr<interface>
517 interface::singular() const
522 std::shared_ptr<interface>
523 interface::find(const key_t& k)
525 return (m_db.find(k));
528 std::shared_ptr<interface>
529 interface::find(const handle_t& handle)
531 return (m_hdl_db[handle].lock());
535 interface::add(const key_t& key, const HW::item<handle_t>& item)
537 std::shared_ptr<interface> sp = find(key);
540 m_hdl_db[item.data()] = sp;
545 interface::remove(const HW::item<handle_t>& item)
547 m_hdl_db.erase(item.data());
551 interface::dump(std::ostream& os)
557 interface::enable_events(interface::event_listener& el)
559 m_events_cmd = std::make_shared<interface_cmds::events_cmd>(el);
560 HW::enqueue(m_events_cmd);
565 interface::disable_events()
567 m_events_cmd.reset();
571 interface::event_handler::handle_populate(const client_db::key_t& key)
574 * dump VPP vhost-user interfaces
576 std::shared_ptr<interface_cmds::vhost_dump_cmd> vcmd =
577 std::make_shared<interface_cmds::vhost_dump_cmd>();
582 for (auto& vhost_itf_record : *vcmd) {
583 std::shared_ptr<interface> vitf =
584 interface_factory::new_vhost_user_interface(
585 vhost_itf_record.get_payload());
586 VOM_LOG(log_level_t::DEBUG) << " vhost-dump: " << vitf->to_string();
587 OM::commit(key, *vitf);
591 * dump VPP af-packet interfaces
593 std::shared_ptr<interface_cmds::af_packet_dump_cmd> afcmd =
594 std::make_shared<interface_cmds::af_packet_dump_cmd>();
599 for (auto& af_packet_itf_record : *afcmd) {
600 std::shared_ptr<interface> afitf =
601 interface_factory::new_af_packet_interface(
602 af_packet_itf_record.get_payload());
603 VOM_LOG(log_level_t::DEBUG) << " af_packet-dump: " << afitf->to_string();
604 OM::commit(key, *afitf);
608 * dump VPP tapv2 interfaces
610 std::shared_ptr<tap_interface_cmds::tapv2_dump_cmd> tapv2cmd =
611 std::make_shared<tap_interface_cmds::tapv2_dump_cmd>();
613 HW::enqueue(tapv2cmd);
616 for (auto& tapv2_record : *tapv2cmd) {
617 std::shared_ptr<tap_interface> tapv2itf =
618 interface_factory::new_tap_interface(tapv2_record.get_payload());
619 VOM_LOG(log_level_t::DEBUG) << "tapv2-dump: " << tapv2itf->to_string();
622 * Write each of the discovered interfaces into the OM,
623 * but disable the HW Command q whilst we do, so that no
624 * commands are sent to VPP
626 OM::commit(key, *tapv2itf);
630 * dump VPP interfaces
632 std::shared_ptr<interface_cmds::dump_cmd> cmd =
633 std::make_shared<interface_cmds::dump_cmd>();
638 for (auto& itf_record : *cmd) {
639 auto payload = itf_record.get_payload();
640 VOM_LOG(log_level_t::DEBUG) << "dump: [" << payload.sw_if_index
641 << " name:" << (char*)payload.interface_name
642 << " tag:" << (char*)payload.tag << "]";
644 std::shared_ptr<interface> itf = interface_factory::new_interface(payload);
646 if (itf && interface::type_t::LOCAL != itf->type()) {
647 VOM_LOG(log_level_t::DEBUG) << "dump: " << itf->to_string();
649 * Write each of the discovered interfaces into the OM,
650 * but disable the HW Command q whilst we do, so that no
651 * commands are sent to VPP
653 OM::commit(key, *itf);
656 * Get the address configured on the interface
658 std::shared_ptr<l3_binding_cmds::dump_v4_cmd> dcmd =
659 std::make_shared<l3_binding_cmds::dump_v4_cmd>(
660 l3_binding_cmds::dump_v4_cmd(itf->handle()));
665 for (auto& l3_record : *dcmd) {
666 auto& payload = l3_record.get_payload();
667 const route::prefix_t pfx(payload.is_ipv6, payload.ip,
668 payload.prefix_length);
670 VOM_LOG(log_level_t::DEBUG) << "dump: " << pfx.to_string();
672 l3_binding l3(*itf, pfx);
679 * dump VPP bond interfaces
681 std::shared_ptr<bond_interface_cmds::dump_cmd> bcmd =
682 std::make_shared<bond_interface_cmds::dump_cmd>();
687 for (auto& bond_itf_record : *bcmd) {
688 std::shared_ptr<bond_interface> bond_itf =
689 interface_factory::new_bond_interface(bond_itf_record.get_payload());
691 VOM_LOG(log_level_t::DEBUG) << " bond-dump:" << bond_itf->to_string();
694 * Write each of the discovered interfaces into the OM,
695 * but disable the HW Command q whilst we do, so that no
696 * commands are sent to VPP
698 OM::commit(key, *bond_itf);
700 std::shared_ptr<bond_group_binding_cmds::dump_cmd> scmd =
701 std::make_shared<bond_group_binding_cmds::dump_cmd>(
702 bond_group_binding_cmds::dump_cmd(bond_itf->handle()));
707 bond_group_binding::enslaved_itf_t enslaved_itfs;
709 for (auto& slave_itf_record : *scmd) {
710 bond_member slave_itf = interface_factory::new_bond_member_interface(
711 slave_itf_record.get_payload());
713 VOM_LOG(log_level_t::DEBUG) << " slave-dump:" << slave_itf.to_string();
716 * Write each of the discovered interfaces into the OM,
717 * but disable the HW Command q whilst we do, so that no
718 * commands are sent to VPP
720 // OM::commit(slave_itf->key(), *slave_itf);
721 enslaved_itfs.insert(slave_itf);
724 if (!enslaved_itfs.empty()) {
725 bond_group_binding bid(*bond_itf, enslaved_itfs);
727 * Write each of the discovered interfaces into the OM,
728 * but disable the HW Command q whilst we do, so that no
729 * commands are sent to VPP
731 OM::commit(key, bid);
736 interface::event_handler::event_handler()
738 OM::register_listener(this);
739 inspect::register_handler({ "interface", "intf" }, "interfaces", this);
743 interface::event_handler::handle_replay()
749 interface::event_handler::order() const
751 return (dependency_t::INTERFACE);
755 interface::event_handler::show(std::ostream& os)
763 * fd.io coding-style-patch-verification: ON
766 * eval: (c-set-style "mozilla")