extras/vom/vom/bridge_domain.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/bridge_domain.hpp"
  17 #include "vom/bridge_domain_cmds.hpp"
  18 #include "vom/interface.hpp"
  19 #include "vom/l2_binding.hpp"
  20 #include "vom/singular_db_funcs.hpp"
  21
  22 namespace VOM {
  23
  24 const bridge_domain::learning_mode_t bridge_domain::learning_mode_t::ON(1,
  25                                                                         "on");
  26 const bridge_domain::learning_mode_t bridge_domain::learning_mode_t::OFF(0,
  27                                                                          "off");
  28
  29 bridge_domain::learning_mode_t::learning_mode_t(int v, const std::string& s)
  30   : enum_base<bridge_domain::learning_mode_t>(v, s)
  31 {
  32 }
  33
  34 const bridge_domain::flood_mode_t bridge_domain::flood_mode_t::ON(1, "on");
  35 const bridge_domain::flood_mode_t bridge_domain::flood_mode_t::OFF(0, "off");
  36
  37 bridge_domain::flood_mode_t::flood_mode_t(int v, const std::string& s)
  38   : enum_base<bridge_domain::flood_mode_t>(v, s)
  39 {
  40 }
  41
  42 const bridge_domain::mac_age_mode_t bridge_domain::mac_age_mode_t::ON(1, "on");
  43 const bridge_domain::mac_age_mode_t bridge_domain::mac_age_mode_t::OFF(0,
  44                                                                        "off");
  45
  46 bridge_domain::mac_age_mode_t::mac_age_mode_t(int v, const std::string& s)
  47   : enum_base<bridge_domain::mac_age_mode_t>(v, s)
  48 {
  49 }
  50
  51 const bridge_domain::arp_term_mode_t bridge_domain::arp_term_mode_t::ON(1,
  52                                                                         "on");
  53 const bridge_domain::arp_term_mode_t bridge_domain::arp_term_mode_t::OFF(0,
  54                                                                          "off");
  55
  56 bridge_domain::arp_term_mode_t::arp_term_mode_t(int v, const std::string& s)
  57   : enum_base<bridge_domain::arp_term_mode_t>(v, s)
  58 {
  59 }
  60
  61 const bridge_domain::arp_ufwd_mode_t bridge_domain::arp_ufwd_mode_t::ON(1,
  62                                                                         "on");
  63 const bridge_domain::arp_ufwd_mode_t bridge_domain::arp_ufwd_mode_t::OFF(0,
  64                                                                          "off");
  65
  66 bridge_domain::arp_ufwd_mode_t::arp_ufwd_mode_t(int v, const std::string& s)
  67   : enum_base<bridge_domain::arp_ufwd_mode_t>(v, s)
  68 {
  69 }
  70
  71 /**
  72  * A DB of al the interfaces, key on the name
  73  */
  74 singular_db<uint32_t, bridge_domain> bridge_domain::m_db;
  75
  76 bridge_domain::event_handler bridge_domain::m_evh;
  77
  78 /**
  79  * Construct a new object matching the desried state
  80  */
  81 bridge_domain::bridge_domain(uint32_t id,
  82                              const learning_mode_t& lmode,
  83                              const arp_term_mode_t& amode,
  84                              const arp_ufwd_mode_t& aumode,
  85                              const flood_mode_t& fmode,
  86                              const mac_age_mode_t& mmode)
  87   : m_id(id)
  88   , m_learning_mode(lmode)
  89   , m_arp_term_mode(amode)
  90   , m_arp_ufwd_mode(aumode)
  91   , m_flood_mode(fmode)
  92   , m_mac_age_mode(mmode)
  93 {
  94 }
  95
  96 bridge_domain::bridge_domain(const bridge_domain& o)
  97   : m_id(o.m_id)
  98   , m_learning_mode(o.m_learning_mode)
  99   , m_arp_term_mode(o.m_arp_term_mode)
 100   , m_arp_ufwd_mode(o.m_arp_ufwd_mode)
 101   , m_flood_mode(o.m_flood_mode)
 102   , m_mac_age_mode(o.m_mac_age_mode)
 103 {
 104 }
 105
 106 const bridge_domain::key_t&
 107 bridge_domain::key() const
 108 {
 109   return (m_id.data());
 110 }
 111
 112 uint32_t
 113 bridge_domain::id() const
 114 {
 115   return (m_id.data());
 116 }
 117
 118 bool
 119 bridge_domain::operator==(const bridge_domain& b) const
 120 {
 121   return ((m_learning_mode == b.m_learning_mode) &&
 122           (m_flood_mode == b.m_flood_mode) &&
 123           (m_mac_age_mode == b.m_mac_age_mode) &&
 124           (m_arp_term_mode == b.m_arp_term_mode) &&
 125           (m_arp_ufwd_mode == b.m_arp_ufwd_mode) && id() == b.id());
 126 }
 127
 128 void
 129 bridge_domain::sweep()
 130 {
 131   if (rc_t::OK == m_id.rc()) {
 132     HW::enqueue(new bridge_domain_cmds::delete_cmd(m_id));
 133   }
 134   HW::write();
 135 }
 136
 137 void
 138 bridge_domain::replay()
 139 {
 140   if (rc_t::OK == m_id.rc()) {
 141     HW::enqueue(new bridge_domain_cmds::create_cmd(
 142       m_id, m_learning_mode, m_arp_term_mode, m_arp_ufwd_mode, m_flood_mode,
 143       m_mac_age_mode));
 144   }
 145 }
 146
 147 bridge_domain::~bridge_domain()
 148 {
 149   sweep();
 150
 151   // not in the DB anymore.
 152   m_db.release(m_id.data(), this);
 153 }
 154
 155 std::string
 156 bridge_domain::to_string() const
 157 {
 158   std::ostringstream s;
 159   s << "bridge-domain:[" << m_id.to_string()
 160     << " learning-mode:" << m_learning_mode.to_string() << "]";
 161
 162   return (s.str());
 163 }
 164
 165 std::shared_ptr<bridge_domain>
 166 bridge_domain::find(const key_t& key)
 167 {
 168   return (m_db.find(key));
 169 }
 170
 171 void
 172 bridge_domain::update(const bridge_domain& desired)
 173 {
 174   /*
 175    * the desired state is always that the interface should be created
 176    */
 177   if (rc_t::OK != m_id.rc()) {
 178     HW::enqueue(new bridge_domain_cmds::create_cmd(
 179       m_id, m_learning_mode, m_arp_term_mode, m_arp_ufwd_mode, m_flood_mode,
 180       m_mac_age_mode));
 181   }
 182 }
 183
 184 std::shared_ptr<bridge_domain>
 185 bridge_domain::find_or_add(const bridge_domain& temp)
 186 {
 187   return (m_db.find_or_add(temp.m_id.data(), temp));
 188 }
 189
 190 std::shared_ptr<bridge_domain>
 191 bridge_domain::singular() const
 192 {
 193   return find_or_add(*this);
 194 }
 195
 196 void
 197 bridge_domain::dump(std::ostream& os)
 198 {
 199   db_dump(m_db, os);
 200 }
 201
 202 void
 203 bridge_domain::event_handler::handle_populate(const client_db::key_t& key)
 204 {
 205   /*
 206    * dump VPP Bridge domains
 207    */
 208   std::shared_ptr<bridge_domain_cmds::dump_cmd> cmd =
 209     std::make_shared<bridge_domain_cmds::dump_cmd>();
 210
 211   HW::enqueue(cmd);
 212   HW::write();
 213
 214   for (auto& record : *cmd) {
 215     auto& payload = record.get_payload();
 216
 217     bridge_domain bd(payload.bd_id);
 218
 219     VOM_LOG(log_level_t::DEBUG) << "dump: " << bd.to_string();
 220
 221     /*
 222      * Write each of the discovered bridge-domains into the OM,
 223      * but disable the HW Command q whilst we do, so that no
 224      * commands are sent to VPP
 225      */
 226     OM::commit(key, bd);
 227
 228     std::shared_ptr<interface> uu_fwd_itf =
 229       interface::find(payload.uu_fwd_sw_if_index);
 230     if (uu_fwd_itf) {
 231       l2_binding l2(*uu_fwd_itf, bd,
 232                     l2_binding::l2_port_type_t::L2_PORT_TYPE_UU_FWD);
 233       OM::commit(key, l2);
 234     } else {
 235       VOM_LOG(log_level_t::ERROR) << "no uu-fwd interface:"
 236                                   << payload.uu_fwd_sw_if_index;
 237     }
 238
 239     /**
 240      * For each interface in the BD construct an l2_binding
 241      */
 242     for (unsigned int ii = 0; ii < payload.n_sw_ifs; ii++) {
 243       std::shared_ptr<interface> itf =
 244         interface::find(payload.sw_if_details[ii].sw_if_index);
 245       if (itf) {
 246         l2_binding l2(*itf, bd);
 247         OM::commit(key, l2);
 248       } else {
 249         VOM_LOG(log_level_t::ERROR) << "no interface:"
 250                                     << payload.sw_if_details[ii].sw_if_index;
 251       }
 252     }
 253   }
 254 }
 255
 256 bridge_domain::event_handler::event_handler()
 257 {
 258   OM::register_listener(this);
 259   inspect::register_handler({ "bd", "bridge" }, "Bridge Domains", this);
 260 }
 261
 262 void
 263 bridge_domain::event_handler::handle_replay()
 264 {
 265   m_db.replay();
 266 }
 267
 268 dependency_t
 269 bridge_domain::event_handler::order() const
 270 {
 271   return (dependency_t::TABLE);
 272 }
 273
 274 void
 275 bridge_domain::event_handler::show(std::ostream& os)
 276 {
 277   db_dump(m_db, os);
 278 }
 279 }
 280
 281 /*
 282  * fd.io coding-style-patch-verification: ON
 283  *
 284  * Local Variables:
 285  * eval: (c-set-style "mozilla")
 286  * End:
 287  */