src/vpp-api/vom/neighbour.cpp

   1 /*
   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:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   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.
  14  */
  15
  16 #include "vom/neighbour.hpp"
  17 #include "vom/neighbour_cmds.hpp"
  18
  19 namespace VOM {
  20 singular_db<neighbour::key_t, neighbour> neighbour::m_db;
  21 neighbour::event_handler neighbour::m_evh;
  22
  23 neighbour::neighbour(const interface& itf,
  24                      const boost::asio::ip::address& ip_addr,
  25                      const mac_address_t& mac)
  26   : m_hw(false)
  27   , m_itf(itf.singular())
  28   , m_ip_addr(ip_addr)
  29   , m_mac(mac)
  30 {
  31 }
  32
  33 neighbour::neighbour(const neighbour& bde)
  34   : m_hw(bde.m_hw)
  35   , m_itf(bde.m_itf)
  36   , m_ip_addr(bde.m_ip_addr)
  37   , m_mac(bde.m_mac)
  38 {
  39 }
  40
  41 neighbour::~neighbour()
  42 {
  43   sweep();
  44
  45   // not in the DB anymore.
  46   m_db.release(key(), this);
  47 }
  48
  49 bool
  50 neighbour::operator==(const neighbour& n) const
  51 {
  52   return ((key() == n.key()) && (m_mac == n.m_mac));
  53 }
  54
  55 const neighbour::key_t
  56 neighbour::key() const
  57 {
  58   return (std::make_pair(m_itf->key(), m_ip_addr));
  59 }
  60
  61 void
  62 neighbour::sweep()
  63 {
  64   if (m_hw) {
  65     HW::enqueue(
  66       new neighbour_cmds::delete_cmd(m_hw, m_itf->handle(), m_mac, m_ip_addr));
  67   }
  68   HW::write();
  69 }
  70
  71 void
  72 neighbour::replay()
  73 {
  74   if (m_hw) {
  75     HW::enqueue(
  76       new neighbour_cmds::create_cmd(m_hw, m_itf->handle(), m_mac, m_ip_addr));
  77   }
  78 }
  79
  80 std::string
  81 neighbour::to_string() const
  82 {
  83   std::ostringstream s;
  84   s << "neighbour:[" << m_itf->to_string() << ", " << m_mac.to_string() << ", "
  85     << m_ip_addr.to_string() << "]";
  86
  87   return (s.str());
  88 }
  89
  90 void
  91 neighbour::update(const neighbour& r)
  92 {
  93   /*
  94  * create the table if it is not yet created
  95  */
  96   if (rc_t::OK != m_hw.rc()) {
  97     HW::enqueue(
  98       new neighbour_cmds::create_cmd(m_hw, m_itf->handle(), m_mac, m_ip_addr));
  99   }
 100 }
 101
 102 std::shared_ptr<neighbour>
 103 neighbour::find_or_add(const neighbour& temp)
 104 {
 105   return (m_db.find_or_add(temp.key(), temp));
 106 }
 107
 108 std::shared_ptr<neighbour>
 109 neighbour::find(const key_t& k)
 110 {
 111   return (m_db.find(k));
 112 }
 113
 114 std::shared_ptr<neighbour>
 115 neighbour::singular() const
 116 {
 117   return find_or_add(*this);
 118 }
 119
 120 void
 121 neighbour::dump(std::ostream& os)
 122 {
 123   m_db.dump(os);
 124 }
 125
 126 std::ostream&
 127 operator<<(std::ostream& os, const neighbour::key_t& key)
 128 {
 129   os << "[" << key.first << ", " << key.second << "]";
 130
 131   return (os);
 132 }
 133
 134 neighbour::event_handler::event_handler()
 135 {
 136   OM::register_listener(this);
 137   inspect::register_handler({ "neighbour" }, "Neighbours", this);
 138 }
 139
 140 void
 141 neighbour::event_handler::handle_replay()
 142 {
 143   m_db.replay();
 144 }
 145
 146 void
 147 neighbour::populate_i(const client_db::key_t& key,
 148                       std::shared_ptr<interface> itf,
 149                       const l3_proto_t& proto)
 150 {
 151   /*
 152    * dump VPP current states
 153    */
 154   std::shared_ptr<neighbour_cmds::dump_cmd> cmd =
 155     std::make_shared<neighbour_cmds::dump_cmd>(
 156       neighbour_cmds::dump_cmd(itf->handle(), proto));
 157
 158   HW::enqueue(cmd);
 159   HW::write();
 160
 161   for (auto& record : *cmd) {
 162     /*
 163      * construct a neighbour from each recieved record.
 164      */
 165     auto& payload = record.get_payload();
 166
 167     mac_address_t mac(payload.mac_address);
 168     boost::asio::ip::address ip_addr =
 169       from_bytes(payload.is_ipv6, payload.ip_address);
 170     neighbour n(*itf, ip_addr, mac);
 171
 172     VOM_LOG(log_level_t::DEBUG) << "neighbour-dump: " << itf->to_string()
 173                                 << mac.to_string() << ip_addr.to_string();
 174
 175     /*
 176      * Write each of the discovered interfaces into the OM,
 177      * but disable the HW Command q whilst we do, so that no
 178      * commands are sent to VPP
 179      */
 180     OM::commit(key, n);
 181   }
 182 }
 183
 184 void
 185 neighbour::event_handler::handle_populate(const client_db::key_t& key)
 186 {
 187   auto it = interface::cbegin();
 188
 189   while (it != interface::cend()) {
 190     neighbour::populate_i(key, it->second.lock(), l3_proto_t::IPV4);
 191     neighbour::populate_i(key, it->second.lock(), l3_proto_t::IPV6);
 192
 193     ++it;
 194   }
 195 }
 196
 197 dependency_t
 198 neighbour::event_handler::order() const
 199 {
 200   return (dependency_t::ENTRY);
 201 }
 202
 203 void
 204 neighbour::event_handler::show(std::ostream& os)
 205 {
 206   m_db.dump(os);
 207 }
 208 }
 209
 210 /*
 211  * fd.io coding-style-patch-verification: ON
 212  *
 213  * Local Variables:
 214  * eval: (c-set-style "mozilla")
 215  * End:
 216  */