src/vpp-api/vom/interface.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/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"
  22
  23 namespace VOM {
  24 /**
  25  * A DB of all the interfaces, key on the name
  26  */
  27 singular_db<const std::string, interface> interface::m_db;
  28
  29 /**
  30  * A DB of all the interfaces, key on VPP's handle
  31  */
  32 std::map<handle_t, std::weak_ptr<interface>> interface::m_hdl_db;
  33
  34 interface::event_handler interface::m_evh;
  35
  36 /**
  37  * Construct a new object matching the desried state
  38  */
  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)
  43   , m_name(name)
  44   , m_type(itf_type)
  45   , m_state(itf_state)
  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)
  49 {
  50 }
  51
  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)
  57   : m_hdl(handle)
  58   , m_name(name)
  59   , m_type(type)
  60   , m_state(state)
  61   , m_table_id(route::DEFAULT_TABLE)
  62   , m_l2_address(l2_address)
  63   , m_oper(oper_state_t::DOWN)
  64 {
  65 }
  66
  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)
  72   , m_name(name)
  73   , m_type(itf_type)
  74   , m_rd(rd.singular())
  75   , m_state(itf_state)
  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)
  79 {
  80 }
  81
  82 interface::interface(const interface& o)
  83   : m_hdl(o.m_hdl)
  84   , m_name(o.m_name)
  85   , m_type(o.m_type)
  86   , m_rd(o.m_rd)
  87   , m_state(o.m_state)
  88   , m_table_id(o.m_table_id)
  89   , m_l2_address(o.m_l2_address)
  90   , m_oper(o.m_oper)
  91 {
  92 }
  93
  94 interface::event_listener::event_listener()
  95   : m_status(rc_t::NOOP)
  96 {
  97 }
  98
  99 HW::item<bool>&
 100 interface::event_listener::status()
 101 {
 102   return (m_status);
 103 }
 104
 105 interface::stat_listener::stat_listener()
 106   : m_status(rc_t::NOOP)
 107 {
 108 }
 109
 110 HW::item<bool>&
 111 interface::stat_listener::status()
 112 {
 113   return (m_status);
 114 }
 115
 116 /**
 117  * Return the interface type
 118  */
 119 const interface::type_t&
 120 interface::type() const
 121 {
 122   return (m_type);
 123 }
 124
 125 const handle_t&
 126 interface::handle() const
 127 {
 128   return (m_hdl.data());
 129 }
 130
 131 const l2_address_t&
 132 interface::l2_address() const
 133 {
 134   return (m_l2_address.data());
 135 }
 136
 137 interface::const_iterator_t
 138 interface::cbegin()
 139 {
 140   return m_db.cbegin();
 141 }
 142
 143 interface::const_iterator_t
 144 interface::cend()
 145 {
 146   return m_db.cend();
 147 }
 148
 149 void
 150 interface::sweep()
 151 {
 152   if (m_table_id && (m_table_id.data() != route::DEFAULT_TABLE)) {
 153     m_table_id.data() = route::DEFAULT_TABLE;
 154     HW::enqueue(
 155       new interface_cmds::set_table_cmd(m_table_id, l3_proto_t::IPV4, m_hdl));
 156     HW::enqueue(
 157       new interface_cmds::set_table_cmd(m_table_id, l3_proto_t::IPV6, m_hdl));
 158   }
 159
 160   // If the interface is up, bring it down
 161   if (m_state && interface::admin_state_t::UP == m_state.data()) {
 162     m_state.data() = interface::admin_state_t::DOWN;
 163     HW::enqueue(new interface_cmds::state_change_cmd(m_state, m_hdl));
 164   }
 165   if (m_hdl) {
 166     std::queue<cmd*> cmds;
 167     HW::enqueue(mk_delete_cmd(cmds));
 168   }
 169   HW::write();
 170 }
 171
 172 void
 173 interface::replay()
 174 {
 175   if (m_hdl) {
 176     std::queue<cmd*> cmds;
 177     HW::enqueue(mk_create_cmd(cmds));
 178   }
 179
 180   if (m_state && interface::admin_state_t::UP == m_state.data()) {
 181     HW::enqueue(new interface_cmds::state_change_cmd(m_state, m_hdl));
 182   }
 183
 184   if (m_table_id && (m_table_id.data() != route::DEFAULT_TABLE)) {
 185     HW::enqueue(
 186       new interface_cmds::set_table_cmd(m_table_id, l3_proto_t::IPV4, m_hdl));
 187     HW::enqueue(
 188       new interface_cmds::set_table_cmd(m_table_id, l3_proto_t::IPV6, m_hdl));
 189   }
 190 }
 191
 192 interface::~interface()
 193 {
 194   sweep();
 195   release();
 196 }
 197
 198 void
 199 interface::release()
 200 {
 201   // not in the DB anymore.
 202   m_db.release(m_name, this);
 203 }
 204
 205 std::string
 206 interface::to_string() const
 207 {
 208   std::ostringstream s;
 209   s << "interface:[" << m_name << " type:" << m_type.to_string()
 210     << " hdl:" << m_hdl.to_string()
 211     << " l2-address:" << m_l2_address.to_string();
 212
 213   if (m_rd) {
 214     s << " rd:" << m_rd->to_string();
 215   }
 216
 217   s << " admin-state:" << m_state.to_string()
 218     << " oper-state:" << m_oper.to_string() << "]";
 219
 220   return (s.str());
 221 }
 222
 223 const std::string&
 224 interface::name() const
 225 {
 226   return (m_name);
 227 }
 228
 229 const interface::key_type&
 230 interface::key() const
 231 {
 232   return (name());
 233 }
 234
 235 std::queue<cmd*>&
 236 interface::mk_create_cmd(std::queue<cmd*>& q)
 237 {
 238   if (type_t::LOOPBACK == m_type) {
 239     q.push(new interface_cmds::loopback_create_cmd(m_hdl, m_name));
 240   } else if (type_t::BVI == m_type) {
 241     q.push(new interface_cmds::loopback_create_cmd(m_hdl, m_name));
 242     q.push(new interface_cmds::set_tag(m_hdl, m_name));
 243   } else if (type_t::AFPACKET == m_type) {
 244     q.push(new interface_cmds::af_packet_create_cmd(m_hdl, m_name));
 245   } else if (type_t::TAP == m_type) {
 246     q.push(new interface_cmds::tap_create_cmd(m_hdl, m_name));
 247   }
 248
 249   return (q);
 250 }
 251
 252 std::queue<cmd*>&
 253 interface::mk_delete_cmd(std::queue<cmd*>& q)
 254 {
 255   if ((type_t::LOOPBACK == m_type) || (type_t::BVI == m_type)) {
 256     q.push(new interface_cmds::loopback_delete_cmd(m_hdl));
 257   } else if (type_t::AFPACKET == m_type) {
 258     q.push(new interface_cmds::af_packet_delete_cmd(m_hdl, m_name));
 259   } else if (type_t::TAP == m_type) {
 260     q.push(new interface_cmds::tap_delete_cmd(m_hdl));
 261   }
 262
 263   return (q);
 264 }
 265
 266 void
 267 interface::update(const interface& desired)
 268 {
 269   /*
 270    * the desired state is always that the interface should be created
 271    */
 272   if (rc_t::OK != m_hdl.rc()) {
 273     std::queue<cmd*> cmds;
 274     HW::enqueue(mk_create_cmd(cmds));
 275   }
 276
 277   /*
 278    * change the interface state to that which is deisred
 279    */
 280   if (m_state.update(desired.m_state)) {
 281     HW::enqueue(new interface_cmds::state_change_cmd(m_state, m_hdl));
 282   }
 283
 284   /*
 285    * change the interface state to that which is deisred
 286    */
 287   if (m_l2_address.update(desired.m_l2_address)) {
 288     HW::enqueue(new interface_cmds::set_mac_cmd(m_l2_address, m_hdl));
 289   }
 290
 291   /*
 292    * If the interface is mapped into a route domain, set VPP's
 293    * table ID
 294    */
 295   if (m_rd != desired.m_rd) {
 296     /*
 297      * changing route domains. need to remove all L3 bindings, swap the table
 298      * then reapply the bindings.
 299      */
 300     auto it = l3_binding::cbegin();
 301
 302     while (it != l3_binding::cend()) {
 303       if (it->second.lock()->itf().key() == key())
 304         it->second.lock()->sweep();
 305       ++it;
 306     }
 307     m_rd = desired.m_rd;
 308     m_table_id.update(m_rd ? m_rd->table_id() : route::DEFAULT_TABLE);
 309     HW::enqueue(
 310       new interface_cmds::set_table_cmd(m_table_id, l3_proto_t::IPV4, m_hdl));
 311     HW::enqueue(
 312       new interface_cmds::set_table_cmd(m_table_id, l3_proto_t::IPV6, m_hdl));
 313     HW::write();
 314
 315     it = l3_binding::cbegin();
 316     while (it != l3_binding::cend()) {
 317       if (it->second.lock()->itf().key() == key())
 318         it->second.lock()->replay(); //(*it->second.lock());
 319       ++it;
 320     }
 321   } else if (!m_table_id && m_rd) {
 322     HW::enqueue(
 323       new interface_cmds::set_table_cmd(m_table_id, l3_proto_t::IPV4, m_hdl));
 324     HW::enqueue(
 325       new interface_cmds::set_table_cmd(m_table_id, l3_proto_t::IPV6, m_hdl));
 326   }
 327 }
 328
 329 void
 330 interface::set(const l2_address_t& addr)
 331 {
 332   assert(rc_t::UNSET == m_l2_address.rc());
 333   m_l2_address.set(rc_t::NOOP);
 334   m_l2_address.update(addr);
 335 }
 336
 337 void
 338 interface::set(const oper_state_t& state)
 339 {
 340   m_oper = state;
 341 }
 342
 343 std::shared_ptr<interface>
 344 interface::singular_i() const
 345 {
 346   return (m_db.find_or_add(name(), *this));
 347 }
 348
 349 std::shared_ptr<interface>
 350 interface::singular() const
 351 {
 352   return singular_i();
 353 }
 354
 355 std::shared_ptr<interface>
 356 interface::find(const std::string& name)
 357 {
 358   return (m_db.find(name));
 359 }
 360
 361 std::shared_ptr<interface>
 362 interface::find(const handle_t& handle)
 363 {
 364   return (m_hdl_db[handle].lock());
 365 }
 366
 367 void
 368 interface::add(const std::string& name, const HW::item<handle_t>& item)
 369 {
 370   std::shared_ptr<interface> sp = find(name);
 371
 372   if (sp && item) {
 373     m_hdl_db[item.data()] = sp;
 374   }
 375 }
 376
 377 void
 378 interface::remove(const HW::item<handle_t>& item)
 379 {
 380   m_hdl_db.erase(item.data());
 381 }
 382
 383 void
 384 interface::dump(std::ostream& os)
 385 {
 386   m_db.dump(os);
 387 }
 388
 389 void
 390 interface::event_handler::handle_populate(const client_db::key_t& key)
 391 {
 392   /*
 393  * dump VPP current states
 394  */
 395   std::shared_ptr<interface_cmds::dump_cmd> cmd(new interface_cmds::dump_cmd());
 396
 397   HW::enqueue(cmd);
 398   HW::write();
 399
 400   for (auto& itf_record : *cmd) {
 401     std::unique_ptr<interface> itf =
 402       interface_factory::new_interface(itf_record.get_payload());
 403
 404     if (itf && interface::type_t::LOCAL != itf->type()) {
 405       VOM_LOG(log_level_t::DEBUG) << "dump: " << itf->to_string();
 406       /*
 407  * Write each of the discovered interfaces into the OM,
 408  * but disable the HW Command q whilst we do, so that no
 409  * commands are sent to VPP
 410  */
 411       OM::commit(key, *itf);
 412
 413       /**
 414  * Get the address configured on the interface
 415  */
 416       std::shared_ptr<l3_binding_cmds::dump_v4_cmd> dcmd =
 417         std::make_shared<l3_binding_cmds::dump_v4_cmd>(
 418           l3_binding_cmds::dump_v4_cmd(itf->handle()));
 419
 420       HW::enqueue(dcmd);
 421       HW::write();
 422
 423       for (auto& l3_record : *dcmd) {
 424         auto& payload = l3_record.get_payload();
 425         const route::prefix_t pfx(payload.is_ipv6, payload.ip,
 426                                   payload.prefix_length);
 427
 428         VOM_LOG(log_level_t::DEBUG) << "dump: " << pfx.to_string();
 429
 430         l3_binding l3(*itf, pfx);
 431         OM::commit(key, l3);
 432       }
 433     }
 434   }
 435 }
 436
 437 interface::event_handler::event_handler()
 438 {
 439   OM::register_listener(this);
 440   inspect::register_handler({ "interface", "intf" }, "interfaces", this);
 441 }
 442
 443 void
 444 interface::event_handler::handle_replay()
 445 {
 446   m_db.replay();
 447 }
 448
 449 dependency_t
 450 interface::event_handler::order() const
 451 {
 452   return (dependency_t::INTERFACE);
 453 }
 454
 455 void
 456 interface::event_handler::show(std::ostream& os)
 457 {
 458   m_db.dump(os);
 459 }
 460 }
 461 /*
 462  * fd.io coding-style-patch-verification: ON
 463  *
 464  * Local Variables:
 465  * eval: (c-set-style "mozilla")
 466  * End:
 467  */