misc: deprecate VOM
[vpp.git] / extras / vom / vom / interface.cpp
diff --git a/extras/vom/vom/interface.cpp b/extras/vom/vom/interface.cpp
deleted file mode 100644 (file)
index 7003564..0000000
+++ /dev/null
@@ -1,776 +0,0 @@
-/*
- * Copyright (c) 2017 Cisco and/or its affiliates.
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at:
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-#include "vom/interface.hpp"
-#include "vom/api_types.hpp"
-#include "vom/bond_group_binding.hpp"
-#include "vom/bond_group_binding_cmds.hpp"
-#include "vom/bond_interface_cmds.hpp"
-#include "vom/interface_cmds.hpp"
-#include "vom/interface_factory.hpp"
-#include "vom/l3_binding_cmds.hpp"
-#include "vom/logger.hpp"
-#include "vom/prefix.hpp"
-#include "vom/singular_db_funcs.hpp"
-#include "vom/stat_reader.hpp"
-#include "vom/tap_interface_cmds.hpp"
-
-namespace VOM {
-/**
- * A DB of all the interfaces, key on the name
- */
-singular_db<interface::key_t, interface> interface::m_db;
-
-/**
- * A DB of all the interfaces, key on VPP's handle
- */
-std::map<handle_t, std::weak_ptr<interface>> interface::m_hdl_db;
-
-interface::event_handler interface::m_evh;
-
-/**
- * the event enable command.
- */
-std::shared_ptr<interface_cmds::events_cmd> interface::m_events_cmd;
-
-/**
- * Construct a new object matching the desried state
- */
-interface::interface(const std::string& name,
-                     interface::type_t itf_type,
-                     interface::admin_state_t itf_state,
-                     const std::string& tag)
-  : m_hdl(handle_t::INVALID)
-  , m_name(name)
-  , m_type(itf_type)
-  , m_state(itf_state)
-  , m_table_id(route::DEFAULT_TABLE)
-  , m_l2_address(l2_address_t::ZERO, rc_t::UNSET)
-  , m_stats_type(stats_type_t::NORMAL)
-  , m_stats({})
-  , m_listener(nullptr)
-  , m_oper(oper_state_t::DOWN)
-  , m_tag(tag)
-{
-}
-
-interface::interface(const std::string& name,
-                     interface::type_t itf_type,
-                     interface::admin_state_t itf_state,
-                     const route_domain& rd,
-                     const std::string& tag)
-  : m_hdl(handle_t::INVALID)
-  , m_name(name)
-  , m_type(itf_type)
-  , m_rd(rd.singular())
-  , m_state(itf_state)
-  , m_table_id(m_rd->table_id())
-  , m_l2_address(l2_address_t::ZERO, rc_t::UNSET)
-  , m_stats_type(stats_type_t::NORMAL)
-  , m_stats({})
-  , m_listener(nullptr)
-  , m_oper(oper_state_t::DOWN)
-  , m_tag(tag)
-{
-}
-
-interface::interface(const interface& o)
-  : m_hdl(o.m_hdl)
-  , m_name(o.m_name)
-  , m_type(o.m_type)
-  , m_rd(o.m_rd)
-  , m_state(o.m_state)
-  , m_table_id(o.m_table_id)
-  , m_l2_address(o.m_l2_address)
-  , m_stats_type(o.m_stats_type)
-  , m_stats(o.m_stats)
-  , m_listener(o.m_listener)
-  , m_oper(o.m_oper)
-  , m_tag(o.m_tag)
-{
-}
-
-bool
-interface::operator==(const interface& i) const
-{
-  return ((key() == i.key()) &&
-          (m_l2_address.data() == i.m_l2_address.data()) &&
-          (m_state == i.m_state) && (m_rd == i.m_rd) && (m_type == i.m_type) &&
-          (m_oper == i.m_oper));
-}
-
-interface::event_listener::event_listener()
-  : m_status(rc_t::NOOP)
-{
-}
-
-HW::item<bool>&
-interface::event_listener::status()
-{
-  return (m_status);
-}
-
-interface::stat_listener::stat_listener()
-  : m_status(rc_t::NOOP)
-{
-}
-
-HW::item<bool>&
-interface::stat_listener::status()
-{
-  return (m_status);
-}
-
-/**
- * Return the interface type
- */
-const interface::type_t&
-interface::type() const
-{
-  return (m_type);
-}
-
-const handle_t&
-interface::handle() const
-{
-  return (singular()->handle_i());
-}
-
-const handle_t&
-interface::handle_i() const
-{
-  return (m_hdl.data());
-}
-
-const l2_address_t&
-interface::l2_address() const
-{
-  return (m_l2_address.data());
-}
-
-const interface::admin_state_t&
-interface::admin_state() const
-{
-  return (m_state.data());
-}
-
-interface::const_iterator_t
-interface::cbegin()
-{
-  return m_db.begin();
-}
-
-interface::const_iterator_t
-interface::cend()
-{
-  return m_db.end();
-}
-
-void
-interface::sweep()
-{
-  if (m_table_id && (m_table_id.data() != route::DEFAULT_TABLE)) {
-    m_table_id.data() = route::DEFAULT_TABLE;
-    HW::enqueue(
-      new interface_cmds::set_table_cmd(m_table_id, l3_proto_t::IPV4, m_hdl));
-    HW::enqueue(
-      new interface_cmds::set_table_cmd(m_table_id, l3_proto_t::IPV6, m_hdl));
-  }
-
-  if (m_listener) {
-    disable_stats_i();
-  }
-
-  // If the interface is up, bring it down
-  if (m_state && interface::admin_state_t::UP == m_state.data()) {
-    m_state.data() = interface::admin_state_t::DOWN;
-    HW::enqueue(new interface_cmds::state_change_cmd(m_state, m_hdl));
-  }
-
-  if (m_hdl) {
-    std::queue<cmd*> cmds;
-    HW::enqueue(mk_delete_cmd(cmds));
-  }
-  HW::write();
-}
-
-void
-interface::replay()
-{
-  if (m_hdl) {
-    std::queue<cmd*> cmds;
-    HW::enqueue(mk_create_cmd(cmds));
-  }
-
-  if (m_state && interface::admin_state_t::UP == m_state.data()) {
-    HW::enqueue(new interface_cmds::state_change_cmd(m_state, m_hdl));
-  }
-
-  if (m_listener) {
-    enable_stats(m_listener, m_stats_type.data());
-  }
-
-  if (m_table_id && (m_table_id.data() != route::DEFAULT_TABLE)) {
-    HW::enqueue(
-      new interface_cmds::set_table_cmd(m_table_id, l3_proto_t::IPV4, m_hdl));
-    HW::enqueue(
-      new interface_cmds::set_table_cmd(m_table_id, l3_proto_t::IPV6, m_hdl));
-  }
-}
-
-interface::~interface()
-{
-  sweep();
-  release();
-}
-
-void
-interface::release()
-{
-  // not in the DB anymore.
-  m_db.release(m_name, this);
-}
-
-std::string
-interface::to_string() const
-{
-  std::ostringstream s;
-  s << "interface:[" << m_name << " type:" << m_type.to_string()
-    << " hdl:" << m_hdl.to_string() << " l2-address:["
-    << m_l2_address.to_string() << "]";
-
-  if (m_rd) {
-    s << " rd:" << m_rd->to_string();
-  }
-
-  s << " admin-state:" << m_state.to_string()
-    << " oper-state:" << m_oper.to_string();
-
-  if (!m_tag.empty()) {
-    s << " tag:[" << m_tag << "]";
-  }
-
-  s << "]";
-
-  return (s.str());
-}
-
-const std::string&
-interface::name() const
-{
-  return (m_name);
-}
-
-const interface::key_t&
-interface::key() const
-{
-  return (name());
-}
-
-std::queue<cmd*>&
-interface::mk_create_cmd(std::queue<cmd*>& q)
-{
-  if (type_t::LOOPBACK == m_type) {
-    q.push(new interface_cmds::loopback_create_cmd(m_hdl, m_name));
-    q.push(new interface_cmds::set_tag(m_hdl, m_name));
-    /*
-     * set the m_tag for pretty-print
-     */
-    m_tag = m_name;
-  } else if (type_t::BVI == m_type) {
-    q.push(new interface_cmds::bvi_create_cmd(m_hdl, m_name));
-    q.push(new interface_cmds::set_tag(m_hdl, m_name));
-    m_tag = m_name;
-  } else if (type_t::AFPACKET == m_type) {
-    q.push(new interface_cmds::af_packet_create_cmd(m_hdl, m_name));
-    if (!m_tag.empty())
-      q.push(new interface_cmds::set_tag(m_hdl, m_tag));
-  } else if (type_t::TAPV2 == m_type) {
-    if (!m_tag.empty())
-      q.push(new interface_cmds::set_tag(m_hdl, m_tag));
-  } else if (type_t::VHOST == m_type) {
-    q.push(new interface_cmds::vhost_create_cmd(m_hdl, m_name, m_tag));
-  } else {
-    m_hdl.set(rc_t::OK);
-  }
-
-  return (q);
-}
-
-std::queue<cmd*>&
-interface::mk_delete_cmd(std::queue<cmd*>& q)
-{
-  if (type_t::LOOPBACK == m_type) {
-    q.push(new interface_cmds::loopback_delete_cmd(m_hdl));
-  } else if (type_t::BVI == m_type) {
-    q.push(new interface_cmds::bvi_delete_cmd(m_hdl));
-  } else if (type_t::AFPACKET == m_type) {
-    q.push(new interface_cmds::af_packet_delete_cmd(m_hdl, m_name));
-  } else if (type_t::VHOST == m_type) {
-    q.push(new interface_cmds::vhost_delete_cmd(m_hdl, m_name));
-  }
-
-  return (q);
-}
-
-void
-interface::update(const interface& desired)
-{
-  /*
-   * the desired state is always that the interface should be created
-   */
-  if (rc_t::OK != m_hdl.rc()) {
-    std::queue<cmd*> cmds;
-    HW::enqueue(mk_create_cmd(cmds));
-    /*
-     * interface create now, so we can barf early if it fails
-     */
-    HW::write();
-  }
-
-  /*
-   * If the interface is not created do other commands should be issued
-   */
-  if (rc_t::OK != m_hdl.rc())
-    return;
-
-  /*
-   * change the interface state to that which is deisred
-   */
-  if (m_state.update(desired.m_state)) {
-    HW::enqueue(new interface_cmds::state_change_cmd(m_state, m_hdl));
-  }
-
-  /*
-   * change the interface state to that which is deisred
-   */
-  if (m_l2_address.update(desired.m_l2_address)) {
-    HW::enqueue(new interface_cmds::set_mac_cmd(m_l2_address, m_hdl));
-  }
-
-  /*
-   * If the interface is mapped into a route domain, set VPP's
-   * table ID
-   */
-  if (m_rd != desired.m_rd) {
-    /*
-     * changing route domains. need to remove all L3 bindings, swap the table
-     * then reapply the bindings.
-     */
-    auto it = l3_binding::cbegin();
-
-    while (it != l3_binding::cend()) {
-      if (it->second.lock()->itf().key() == key())
-        it->second.lock()->sweep();
-      ++it;
-    }
-    m_rd = desired.m_rd;
-    m_table_id.update(m_rd ? m_rd->table_id() : route::DEFAULT_TABLE);
-    HW::enqueue(
-      new interface_cmds::set_table_cmd(m_table_id, l3_proto_t::IPV4, m_hdl));
-    HW::enqueue(
-      new interface_cmds::set_table_cmd(m_table_id, l3_proto_t::IPV6, m_hdl));
-    HW::write();
-
-    it = l3_binding::cbegin();
-    while (it != l3_binding::cend()) {
-      if (it->second.lock()->itf().key() == key())
-        it->second.lock()->replay(); //(*it->second.lock());
-      ++it;
-    }
-  } else if (!m_table_id && m_rd) {
-    HW::enqueue(
-      new interface_cmds::set_table_cmd(m_table_id, l3_proto_t::IPV4, m_hdl));
-    HW::enqueue(
-      new interface_cmds::set_table_cmd(m_table_id, l3_proto_t::IPV6, m_hdl));
-  }
-}
-
-void
-interface::set(const admin_state_t& state)
-{
-  m_state = state;
-}
-
-void
-interface::set(const l2_address_t& addr)
-{
-  m_l2_address = { addr, rc_t::NOOP };
-}
-
-void
-interface::set(const handle_t& hdl)
-{
-  m_hdl = hdl;
-}
-
-void
-interface::set(const oper_state_t& state)
-{
-  m_oper = state;
-}
-
-void
-interface::set(const std::string& tag)
-{
-  m_tag = tag;
-}
-
-void
-interface::set(const counter_t& count, const std::string& stat_type)
-{
-  if ("rx" == stat_type)
-    m_stats.m_rx = count;
-  else if ("tx" == stat_type)
-    m_stats.m_tx = count;
-  else if ("drops" == stat_type)
-    m_stats.m_drop = count;
-  else if ("rx-unicast" == stat_type)
-    m_stats.m_rx_unicast = count;
-  else if ("tx-unicast" == stat_type)
-    m_stats.m_tx_unicast = count;
-  else if ("rx-multicast" == stat_type)
-    m_stats.m_rx_multicast = count;
-  else if ("tx-multicast" == stat_type)
-    m_stats.m_tx_multicast = count;
-  else if ("rx-broadcast" == stat_type)
-    m_stats.m_rx_broadcast = count;
-  else if ("tx-broadcast" == stat_type)
-    m_stats.m_rx_broadcast = count;
-}
-
-const interface::stats_t&
-interface::get_stats(void) const
-{
-  return m_stats;
-}
-
-void
-interface::publish_stats()
-{
-  m_listener->handle_interface_stat(*this);
-}
-
-std::ostream&
-operator<<(std::ostream& os, const interface::stats_t& stats)
-{
-  os << "["
-     << "rx " << stats.m_rx << " rx-unicast " << stats.m_rx_unicast
-     << " rx-multicast " << stats.m_rx_multicast << " rx-broadcast "
-     << stats.m_rx_broadcast << " tx " << stats.m_tx << " tx-unicast "
-     << stats.m_tx_unicast << " tx-multicast " << stats.m_tx_multicast
-     << " tx-broadcast " << stats.m_tx_broadcast << " drops " << stats.m_drop
-     << "]" << std::endl;
-
-  return (os);
-}
-
-void
-interface::enable_stats_i(interface::stat_listener* el, const stats_type_t& st)
-{
-  if (el != NULL) {
-    if (stats_type_t::DETAILED == st) {
-      m_stats_type.set(rc_t::NOOP);
-      HW::enqueue(new interface_cmds::collect_detail_stats_change_cmd(
-        m_stats_type, handle_i(), true));
-    }
-    stat_reader::registers(*this);
-    m_listener = el;
-  }
-}
-
-void
-interface::enable_stats(interface::stat_listener* el, const stats_type_t& st)
-{
-  singular()->enable_stats_i(el, st);
-}
-
-void
-interface::disable_stats_i()
-{
-  if (m_listener != NULL) {
-    if (stats_type_t::DETAILED == m_stats_type) {
-      HW::enqueue(new interface_cmds::collect_detail_stats_change_cmd(
-        m_stats_type, handle_i(), false));
-    }
-    stat_reader::unregisters(*this);
-    m_listener = NULL;
-  }
-}
-
-void
-interface::disable_stats()
-{
-  singular()->disable_stats_i();
-}
-
-std::shared_ptr<interface>
-interface::singular_i() const
-{
-  return (m_db.find_or_add(key(), *this));
-}
-
-std::shared_ptr<interface>
-interface::singular() const
-{
-  return singular_i();
-}
-
-std::shared_ptr<interface>
-interface::find(const key_t& k)
-{
-  return (m_db.find(k));
-}
-
-std::shared_ptr<interface>
-interface::find(const handle_t& handle)
-{
-  return (m_hdl_db[handle].lock());
-}
-
-void
-interface::add(const key_t& key, const HW::item<handle_t>& item)
-{
-  std::shared_ptr<interface> sp = find(key);
-
-  if (sp && item) {
-    m_hdl_db[item.data()] = sp;
-  }
-}
-
-void
-interface::remove(const HW::item<handle_t>& item)
-{
-  m_hdl_db.erase(item.data());
-}
-
-void
-interface::dump(std::ostream& os)
-{
-  db_dump(m_db, os);
-}
-
-void
-interface::enable_events(interface::event_listener& el)
-{
-  m_events_cmd = std::make_shared<interface_cmds::events_cmd>(el);
-  HW::enqueue(m_events_cmd);
-  HW::write();
-}
-
-void
-interface::disable_events()
-{
-  m_events_cmd.reset();
-}
-
-void
-interface::event_handler::handle_populate(const client_db::key_t& key)
-{
-  /*
-   * dump VPP vhost-user interfaces
-   */
-  std::shared_ptr<interface_cmds::vhost_dump_cmd> vcmd =
-    std::make_shared<interface_cmds::vhost_dump_cmd>();
-
-  HW::enqueue(vcmd);
-  HW::write();
-
-  for (auto& vhost_itf_record : *vcmd) {
-    std::shared_ptr<interface> vitf =
-      interface_factory::new_vhost_user_interface(
-        vhost_itf_record.get_payload());
-    VOM_LOG(log_level_t::DEBUG) << " vhost-dump: " << vitf->to_string();
-    OM::commit(key, *vitf);
-  }
-
-  /*
-   * dump VPP af-packet interfaces
-   */
-  std::shared_ptr<interface_cmds::af_packet_dump_cmd> afcmd =
-    std::make_shared<interface_cmds::af_packet_dump_cmd>();
-
-  HW::enqueue(afcmd);
-  HW::write();
-
-  for (auto& af_packet_itf_record : *afcmd) {
-    std::shared_ptr<interface> afitf =
-      interface_factory::new_af_packet_interface(
-        af_packet_itf_record.get_payload());
-    VOM_LOG(log_level_t::DEBUG) << " af_packet-dump: " << afitf->to_string();
-    OM::commit(key, *afitf);
-  }
-
-  /*
-   * dump VPP tapv2 interfaces
-   */
-  std::shared_ptr<tap_interface_cmds::tapv2_dump_cmd> tapv2cmd =
-    std::make_shared<tap_interface_cmds::tapv2_dump_cmd>();
-
-  HW::enqueue(tapv2cmd);
-  HW::write();
-
-  for (auto& tapv2_record : *tapv2cmd) {
-    std::shared_ptr<tap_interface> tapv2itf =
-      interface_factory::new_tap_interface(tapv2_record.get_payload());
-    VOM_LOG(log_level_t::DEBUG) << "tapv2-dump: " << tapv2itf->to_string();
-
-    /*
-     * Write each of the discovered interfaces into the OM,
-     * but disable the HW Command q whilst we do, so that no
-     * commands are sent to VPP
-     */
-    OM::commit(key, *tapv2itf);
-  }
-
-  /*
-   * dump VPP interfaces
-   */
-  std::shared_ptr<interface_cmds::dump_cmd> cmd =
-    std::make_shared<interface_cmds::dump_cmd>();
-
-  HW::enqueue(cmd);
-  HW::write();
-
-  for (auto& itf_record : *cmd) {
-    auto payload = itf_record.get_payload();
-    VOM_LOG(log_level_t::DEBUG) << "dump: [" << payload.sw_if_index
-                                << " name:" << (char*)payload.interface_name
-                                << " tag:" << (char*)payload.tag << "]";
-
-    std::shared_ptr<interface> itf = interface_factory::new_interface(payload);
-
-    if (itf && interface::type_t::LOCAL != itf->type()) {
-      VOM_LOG(log_level_t::DEBUG) << "dump: " << itf->to_string();
-      /*
-       * Write each of the discovered interfaces into the OM,
-       * but disable the HW Command q whilst we do, so that no
-       * commands are sent to VPP
-       */
-      OM::commit(key, *itf);
-
-      /**
-       * Get the address configured on the interface
-       */
-      std::shared_ptr<l3_binding_cmds::dump_v4_cmd> dcmd =
-        std::make_shared<l3_binding_cmds::dump_v4_cmd>(
-          l3_binding_cmds::dump_v4_cmd(itf->handle()));
-
-      HW::enqueue(dcmd);
-      HW::write();
-
-      for (auto& l3_record : *dcmd) {
-        auto& payload = l3_record.get_payload();
-        const route::prefix_t pfx = from_api(payload.prefix);
-
-        VOM_LOG(log_level_t::DEBUG) << "dump: " << pfx.to_string();
-
-        l3_binding l3(*itf, pfx);
-        OM::commit(key, l3);
-      }
-    }
-  }
-
-  /*
-   * dump VPP bond interfaces
-   */
-  std::shared_ptr<bond_interface_cmds::dump_cmd> bcmd =
-    std::make_shared<bond_interface_cmds::dump_cmd>();
-
-  HW::enqueue(bcmd);
-  HW::write();
-
-  for (auto& bond_itf_record : *bcmd) {
-    std::shared_ptr<bond_interface> bond_itf =
-      interface_factory::new_bond_interface(bond_itf_record.get_payload());
-
-    VOM_LOG(log_level_t::DEBUG) << " bond-dump:" << bond_itf->to_string();
-
-    /*
-     * Write each of the discovered interfaces into the OM,
-     * but disable the HW Command q whilst we do, so that no
-     * commands are sent to VPP
-     */
-    OM::commit(key, *bond_itf);
-
-    std::shared_ptr<bond_group_binding_cmds::dump_cmd> scmd =
-      std::make_shared<bond_group_binding_cmds::dump_cmd>(
-        bond_group_binding_cmds::dump_cmd(bond_itf->handle()));
-
-    HW::enqueue(scmd);
-    HW::write();
-
-    bond_group_binding::enslaved_itf_t enslaved_itfs;
-
-    for (auto& slave_itf_record : *scmd) {
-      bond_member slave_itf = interface_factory::new_bond_member_interface(
-        slave_itf_record.get_payload());
-
-      VOM_LOG(log_level_t::DEBUG) << " slave-dump:" << slave_itf.to_string();
-
-      /*
-       * Write each of the discovered interfaces into the OM,
-       * but disable the HW Command q whilst we do, so that no
-       * commands are sent to VPP
-       */
-      //      OM::commit(slave_itf->key(), *slave_itf);
-      enslaved_itfs.insert(slave_itf);
-    }
-
-    if (!enslaved_itfs.empty()) {
-      bond_group_binding bid(*bond_itf, enslaved_itfs);
-      /*
-       * Write each of the discovered interfaces into the OM,
-       * but disable the HW Command q whilst we do, so that no
-       * commands are sent to VPP
-       */
-      OM::commit(key, bid);
-    }
-  }
-}
-
-interface::event_handler::event_handler()
-{
-  OM::register_listener(this);
-  inspect::register_handler({ "interface", "intf" }, "interfaces", this);
-}
-
-void
-interface::event_handler::handle_replay()
-{
-  m_db.replay();
-}
-
-dependency_t
-interface::event_handler::order() const
-{
-  return (dependency_t::INTERFACE);
-}
-
-void
-interface::event_handler::show(std::ostream& os)
-{
-  db_dump(m_db, os);
-}
-
-} // namespace VOM
-
-/*
- * fd.io coding-style-patch-verification: ON
- *
- * Local Variables:
- * eval: (c-set-style "mozilla")
- * End:
- */