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