neighbour.cpp

Go to the documentation of this file.

/*
 * 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/neighbour.hpp"
#include "vom/api_types.hpp"
#include "vom/neighbour_cmds.hpp"
#include "vom/singular_db_funcs.hpp"

namespace VOM {
singular_db<neighbour::key_t, neighbour> neighbour::m_db;
neighbour::event_handler neighbour::m_evh;

const neighbour::flags_t neighbour::flags_t::NONE(0, "");
const neighbour::flags_t neighbour::flags_t::STATIC(1, "static");
const neighbour::flags_t neighbour::flags_t::NO_FIB_ENTRY(2, "no-fib-entry");

neighbour::flags_t::flags_t(int v, const std::string s)
  : enum_base(v, s)
{
}

neighbour::neighbour(const interface& itf,
                     const boost::asio::ip::address& ip_addr,
                     const mac_address_t& mac,
                     const flags_t flags)
  : m_hw(false)
  , m_itf(itf.singular())
  , m_ip_addr(ip_addr)
  , m_mac(mac)
  , m_flags(flags)
{
}

neighbour::neighbour(const neighbour& n)
  : m_hw(n.m_hw)
  , m_itf(n.m_itf)
  , m_ip_addr(n.m_ip_addr)
  , m_mac(n.m_mac)
  , m_flags(n.m_flags)
{
}

neighbour::~neighbour()
{
  sweep();

  // not in the DB anymore.
  m_db.release(key(), this);
}

bool
neighbour::operator==(const neighbour& n) const
{
  return ((key() == n.key()) && (m_mac == n.m_mac));
}

const neighbour::key_t
neighbour::key() const
{
  return (std::make_pair(m_itf->key(), m_ip_addr));
}

void
neighbour::sweep()
{
  if (m_hw) {
    HW::enqueue(new neighbour_cmds::delete_cmd(m_hw, m_itf->handle(), m_mac,
                                               m_ip_addr, m_flags));
  }
  HW::write();
}

void
neighbour::replay()
{
  if (m_hw) {
    HW::enqueue(new neighbour_cmds::create_cmd(m_hw, m_itf->handle(), m_mac,
                                               m_ip_addr, m_flags));
  }
}

std::string
neighbour::to_string() const
{
  std::ostringstream s;
  s << "neighbour:[" << m_itf->to_string() << ", " << m_mac.to_string() << ", "
    << m_ip_addr.to_string() << " " << m_flags.to_string() << "]";

  return (s.str());
}

void
neighbour::update(const neighbour& r)
{
  /*
 * create the table if it is not yet created
 */
  if (rc_t::OK != m_hw.rc()) {
    HW::enqueue(new neighbour_cmds::create_cmd(m_hw, m_itf->handle(), m_mac,
                                               m_ip_addr, m_flags));
  }
}

std::shared_ptr<neighbour>
neighbour::find_or_add(const neighbour& temp)
{
  return (m_db.find_or_add(temp.key(), temp));
}

std::shared_ptr<neighbour>
neighbour::find(const key_t& k)
{
  return (m_db.find(k));
}

std::shared_ptr<neighbour>
neighbour::singular() const
{
  return find_or_add(*this);
}

void
neighbour::dump(std::ostream& os)
{
  db_dump(m_db, os);
}

std::ostream&
operator<<(std::ostream& os, const neighbour::key_t& key)
{
  os << "[" << key.first << ", " << key.second << "]";

  return (os);
}

neighbour::event_handler::event_handler()
{
  OM::register_listener(this);
  inspect::register_handler({ "neighbour" }, "Neighbours", this);
}

void
neighbour::event_handler::handle_replay()
{
  m_db.replay();
}

void
neighbour::populate_i(const client_db::key_t& key,
                      std::shared_ptr<interface> itf,
                      const l3_proto_t& proto)
{
  /*
   * dump VPP current states
   */
  std::shared_ptr<neighbour_cmds::dump_cmd> cmd =
    std::make_shared<neighbour_cmds::dump_cmd>(
      neighbour_cmds::dump_cmd(itf->handle(), proto));

  HW::enqueue(cmd);
  HW::write();

  for (auto& record : *cmd) {
    /*
     * construct a neighbour from each recieved record.
     */
    auto& payload = record.get_payload();

    mac_address_t mac = from_api(payload.neighbor.mac_address);
    boost::asio::ip::address ip_addr = from_api(payload.neighbor.ip_address);
    neighbour::flags_t f = from_api(payload.neighbor.flags);
    neighbour n(*itf, ip_addr, mac, f);
    ;

    VOM_LOG(log_level_t::DEBUG) << "neighbour-dump: " << itf->to_string() << " "
                                << mac.to_string() << " " << ip_addr.to_string()
                                << " " << f.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, n);
  }
}

void
neighbour::event_handler::handle_populate(const client_db::key_t& key)
{
  auto it = interface::cbegin();

  while (it != interface::cend()) {
    neighbour::populate_i(key, it->second.lock(), l3_proto_t::IPV4);
    neighbour::populate_i(key, it->second.lock(), l3_proto_t::IPV6);

    ++it;
  }
}

dependency_t
neighbour::event_handler::order() const
{
  return (dependency_t::ENTRY);
}

void
neighbour::event_handler::show(std::ostream& os)
{
  db_dump(m_db, os);
}
}

/*
 * fd.io coding-style-patch-verification: OFF
 *
 * Local Variables:
 * eval: (c-set-style "mozilla")
 * End:
 */