FD.io VPP  v18.01.2-1-g9b554f3
Vector Packet Processing
bridge_domain.cpp
Go to the documentation of this file.
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"
18 #include "vom/interface.hpp"
19 #include "vom/l2_binding.hpp"
20 
21 namespace VOM {
22 
23 const bridge_domain::learning_mode_t bridge_domain::learning_mode_t::ON(1,
24  "on");
25 const bridge_domain::learning_mode_t bridge_domain::learning_mode_t::OFF(0,
26  "off");
27 
28 bridge_domain::learning_mode_t::learning_mode_t(int v, const std::string& s)
29  : enum_base<bridge_domain::learning_mode_t>(v, s)
30 {
31 }
32 
33 /**
34  * A DB of al the interfaces, key on the name
35  */
36 singular_db<uint32_t, bridge_domain> bridge_domain::m_db;
37 
38 bridge_domain::event_handler bridge_domain::m_evh;
39 
40 /**
41  * Construct a new object matching the desried state
42  */
44  : m_id(id)
45  , m_learning_mode(lmode)
46 {
47 }
48 
50  : m_id(o.m_id)
51  , m_learning_mode(o.m_learning_mode)
52 {
53 }
54 
57 {
58  return (m_id.data());
59 }
60 
61 uint32_t
63 {
64  return (m_id.data());
65 }
66 
67 bool
69 {
70  return ((m_learning_mode == b.m_learning_mode) && id() == b.id());
71 }
72 
73 void
74 bridge_domain::sweep()
75 {
76  if (rc_t::OK == m_id.rc()) {
78  }
79  HW::write();
80 }
81 
82 void
83 bridge_domain::replay()
84 {
85  if (rc_t::OK == m_id.rc()) {
86  HW::enqueue(new bridge_domain_cmds::create_cmd(m_id, m_learning_mode));
87  }
88 }
89 
91 {
92  sweep();
93 
94  // not in the DB anymore.
95  m_db.release(m_id.data(), this);
96 }
97 
98 std::string
100 {
101  std::ostringstream s;
102  s << "bridge-domain:[" << m_id.to_string()
103  << " learning-mode:" << m_learning_mode.to_string() << "]";
104 
105  return (s.str());
106 }
107 
108 std::shared_ptr<bridge_domain>
110 {
111  return (m_db.find(key));
112 }
113 
114 void
115 bridge_domain::update(const bridge_domain& desired)
116 {
117  /*
118  * the desired state is always that the interface should be created
119  */
120  if (rc_t::OK != m_id.rc()) {
121  HW::enqueue(new bridge_domain_cmds::create_cmd(m_id, m_learning_mode));
122  }
123 }
124 
125 std::shared_ptr<bridge_domain>
126 bridge_domain::find_or_add(const bridge_domain& temp)
127 {
128  return (m_db.find_or_add(temp.m_id.data(), temp));
129 }
130 
131 std::shared_ptr<bridge_domain>
133 {
134  return find_or_add(*this);
135 }
136 
137 void
138 bridge_domain::dump(std::ostream& os)
139 {
140  m_db.dump(os);
141 }
142 
143 void
144 bridge_domain::event_handler::handle_populate(const client_db::key_t& key)
145 {
146  /*
147  * dump VPP Bridge domains
148  */
149  std::shared_ptr<bridge_domain_cmds::dump_cmd> cmd =
150  std::make_shared<bridge_domain_cmds::dump_cmd>();
151 
152  HW::enqueue(cmd);
153  HW::write();
154 
155  for (auto& record : *cmd) {
156  auto& payload = record.get_payload();
157 
158  bridge_domain bd(payload.bd_id);
159 
160  VOM_LOG(log_level_t::DEBUG) << "dump: " << bd.to_string();
161 
162  /*
163  * Write each of the discovered bridge-domains into the OM,
164  * but disable the HW Command q whilst we do, so that no
165  * commands are sent to VPP
166  */
167  OM::commit(key, bd);
168 
169  /**
170  * For each interface in the BD construct an l2_binding
171  */
172  for (unsigned int ii = 0; ii < payload.n_sw_ifs; ii++) {
173  std::shared_ptr<interface> itf =
174  interface::find(payload.sw_if_details[ii].sw_if_index);
175  l2_binding l2(*itf, bd);
176  OM::commit(key, l2);
177  }
178  }
179 }
180 
181 bridge_domain::event_handler::event_handler()
182 {
183  OM::register_listener(this);
184  inspect::register_handler({ "bd", "bridge" }, "Bridge Domains", this);
185 }
186 
187 void
188 bridge_domain::event_handler::handle_replay()
189 {
190  m_db.replay();
191 }
192 
194 bridge_domain::event_handler::order() const
195 {
196  return (dependency_t::TABLE);
197 }
198 
199 void
200 bridge_domain::event_handler::show(std::ostream& os)
201 {
202  m_db.dump(os);
203 }
204 }
205 
206 /*
207  * fd.io coding-style-patch-verification: ON
208  *
209  * Local Variables:
210  * eval: (c-set-style "mozilla")
211  * End:
212  */
A Clas representing the binding of an L2 interface to a bridge-domain and the properties of that bind...
Definition: l2_binding.hpp:32
#define VOM_LOG(lvl)
Definition: logger.hpp:181
const std::string key_t
In the opflex world each entity is known by a URI which can be converted into a string.
Definition: client_db.hpp:51
static std::shared_ptr< interface > find(const handle_t &h)
The the singular instance of the interface in the DB by handle.
Definition: interface.cpp:402
static const learning_mode_t ON
static void register_handler(const std::vector< std::string > &cmds, const std::string &help, command_handler *ch)
Register a command handler for inspection.
Definition: inspect.cpp:85
static rc_t write()
Write/Execute all commands hitherto enqueued.
Definition: hw.cpp:225
static const log_level_t DEBUG
Definition: logger.hpp:32
static std::shared_ptr< bridge_domain > find(const key_t &key)
Static function to find the bridge_domain in the model.
static void dump(std::ostream &os)
Dump all bridge-doamin into the stream provided.
std::string to_string() const
convert to string format for debug purposes
Definition: hw.hpp:160
T & data()
Return the data read/written.
Definition: hw.hpp:108
rc_t rc() const
Get the HW return code.
Definition: hw.hpp:118
#define v
Definition: acl.c:341
static const learning_mode_t OFF
std::string to_string(void) const
convert to string format for debug purposes
uint32_t id() const
Return the bridge domain&#39;s VPP ID.
const key_t & key() const
Return the bridge domain&#39;s key.
Bridge Domain Learning mode.
A base class for all object_base in the VPP object_base-Model.
bool operator==(const bridge_domain &b) const
Comparison operator - for UT.
Tables in which entries are added, e.g bridge/route-domains.
static rc_t commit(const client_db::key_t &key, const OBJ &obj)
Make the State in VPP reflect the expressed desired state.
Definition: om.hpp:202
dependency_t
There needs to be a strict order in which object types are read from VPP (at boot time) and replayed ...
Definition: types.hpp:43
static const rc_t OK
The HW write was successfull.
Definition: types.hpp:106
static void enqueue(cmd *f)
Enqueue A command for execution.
Definition: hw.cpp:189
uint32_t key_t
Key Type for Bridge Domains in the sigular DB.
std::shared_ptr< bridge_domain > singular() const
Return the matchin &#39;singular&#39; instance of the bridge-domain.
The VPP Object Model (VOM) library.
Definition: acl_binding.cpp:19
A representation of a method call to VPP.
Definition: cmd.hpp:32
void show(char *chroot_path, int verbose)
Definition: svmtool.c:105
A command class that creates an Bridge-Domain.
const std::string & to_string() const
convert to string format for debug purposes
Definition: enum_base.hpp:36
bridge_domain(uint32_t id, const learning_mode_t &lmode=learning_mode_t::ON)
Construct a new object matching the desried state.
static bool register_listener(listener *listener)
Register a listener of events.
Definition: om.cpp:124
A cmd class that Delete an Bridge-Domain.
~bridge_domain()
Destructor.