FD.io VPP  v18.07.1-19-g511ce25
Vector Packet Processing
gbp_subnet.cpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018 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/gbp_subnet.hpp"
17 #include "vom/gbp_subnet_cmds.hpp"
19 
20 namespace VOM {
21 
22 gbp_subnet::type_t::type_t(int v, const std::string s)
23  : enum_base<gbp_subnet::type_t>(v, s)
24 {
25 }
26 
27 const gbp_subnet::type_t gbp_subnet::type_t::INTERNAL(0, "internal");
28 const gbp_subnet::type_t gbp_subnet::type_t::EXTERNAL(1, "external");
29 
30 singular_db<gbp_subnet::key_t, gbp_subnet> gbp_subnet::m_db;
31 
32 gbp_subnet::event_handler gbp_subnet::m_evh;
33 
35  : m_hw(false)
36  , m_rd(rd.singular())
37  , m_prefix(prefix)
38  , m_type(type_t::INTERNAL)
39  , m_recirc(nullptr)
40  , m_epg(nullptr)
41 {
42 }
43 
45  const route::prefix_t& prefix,
46  const gbp_recirc& recirc,
47  const gbp_endpoint_group& epg)
48  : m_hw(false)
49  , m_rd(rd.singular())
50  , m_prefix(prefix)
51  , m_type(type_t::EXTERNAL)
52  , m_recirc(recirc.singular())
53  , m_epg(epg.singular())
54 {
55 }
56 
58  : m_hw(o.m_hw)
59  , m_rd(o.m_rd)
60  , m_prefix(o.m_prefix)
61  , m_type(o.m_type)
62  , m_recirc(o.m_recirc)
63  , m_epg(o.m_epg)
64 {
65 }
66 
68 {
69  sweep();
70  m_db.release(key(), this);
71 }
72 
75 {
76  return (std::make_pair(m_rd->key(), m_prefix));
77 }
78 
79 bool
81 {
82  return ((key() == gs.key()) && (m_type == gs.m_type) &&
83  (m_recirc == gs.m_recirc) && (m_epg == gs.m_epg));
84 }
85 
86 void
87 gbp_subnet::sweep()
88 {
89  if (m_hw) {
91  new gbp_subnet_cmds::delete_cmd(m_hw, m_rd->table_id(), m_prefix));
92  }
93  HW::write();
94 }
95 
96 void
98 {
99  if (m_hw) {
101  m_hw, m_rd->table_id(), m_prefix, (m_type == type_t::INTERNAL),
102  (m_recirc ? m_recirc->handle() : handle_t::INVALID),
103  (m_epg ? m_epg->id() : ~0)));
104  }
105 }
106 
107 std::string
109 {
110  std::ostringstream s;
111  s << "gbp-subnet:[" << m_type.to_string() << ", " << m_rd->to_string() << ":"
112  << m_prefix.to_string();
113  if (m_recirc)
114  s << ", " << m_recirc->to_string();
115  if (m_epg)
116  s << ", " << m_epg->to_string();
117 
118  s << "]";
119 
120  return (s.str());
121 }
122 
123 void
124 gbp_subnet::update(const gbp_subnet& r)
125 {
126  if (rc_t::OK != m_hw.rc()) {
128  m_hw, m_rd->table_id(), m_prefix, (m_type == type_t::INTERNAL),
129  (m_recirc ? m_recirc->handle() : handle_t::INVALID),
130  (m_epg ? m_epg->id() : ~0)));
131  } else {
132  if (m_type != r.m_type) {
133  m_epg = r.m_epg;
134  m_recirc = r.m_recirc;
135  m_type = r.m_type;
136 
138  m_hw, m_rd->table_id(), m_prefix, (m_type == type_t::INTERNAL),
139  (m_recirc ? m_recirc->handle() : handle_t::INVALID),
140  (m_epg ? m_epg->id() : ~0)));
141  }
142  }
143 }
144 
145 std::shared_ptr<gbp_subnet>
146 gbp_subnet::find_or_add(const gbp_subnet& temp)
147 {
148  return (m_db.find_or_add(temp.key(), temp));
149 }
150 
151 std::shared_ptr<gbp_subnet>
153 {
154  return (m_db.find(k));
155 }
156 
157 std::shared_ptr<gbp_subnet>
159 {
160  return find_or_add(*this);
161 }
162 
163 void
164 gbp_subnet::dump(std::ostream& os)
165 {
166  db_dump(m_db, os);
167 }
168 
170 {
171  OM::register_listener(this);
172  inspect::register_handler({ "gbp-subnet" }, "GBP Subnets", this);
173 }
174 
175 void
176 gbp_subnet::event_handler::handle_replay()
177 {
178  m_db.replay();
179 }
180 
181 void
182 gbp_subnet::event_handler::handle_populate(const client_db::key_t& key)
183 {
184  std::shared_ptr<gbp_subnet_cmds::dump_cmd> cmd =
185  std::make_shared<gbp_subnet_cmds::dump_cmd>();
186 
187  HW::enqueue(cmd);
188  HW::write();
189 
190  for (auto& record : *cmd) {
191  auto& payload = record.get_payload();
192 
193  route::prefix_t pfx(payload.subnet.is_ip6, payload.subnet.address,
194  payload.subnet.address_length);
195  std::shared_ptr<route_domain> rd =
196  route_domain::find(payload.subnet.table_id);
197 
198  if (rd) {
199  if (payload.subnet.is_internal) {
200  gbp_subnet gs(*rd, pfx);
201  OM::commit(key, gs);
202  VOM_LOG(log_level_t::DEBUG) << "read: " << gs.to_string();
203  } else {
204  std::shared_ptr<interface> itf =
205  interface::find(payload.subnet.sw_if_index);
206  std::shared_ptr<gbp_endpoint_group> epg =
207  gbp_endpoint_group::find(payload.subnet.epg_id);
208 
209  if (itf && epg) {
210  std::shared_ptr<gbp_recirc> recirc = gbp_recirc::find(itf->key());
211 
212  if (recirc) {
213  gbp_subnet gs(*rd, pfx, *recirc, *epg);
214  OM::commit(key, gs);
215  VOM_LOG(log_level_t::DEBUG) << "read: " << gs.to_string();
216  }
217  }
218  }
219  }
220  }
221 }
222 
224 gbp_subnet::event_handler::order() const
225 {
226  return (dependency_t::ENTRY);
227 }
228 
229 void
230 gbp_subnet::event_handler::show(std::ostream& os)
231 {
232  db_dump(m_db, os);
233 }
234 } // namespace VOM
235 
236 /*
237  * fd.io coding-style-patch-verification: ON
238  *
239  * Local Variables:
240  * eval: (c-set-style "mozilla")
241  * End:
242  */
static std::shared_ptr< route_domain > find(const key_t &temp)
Find the instnace of the route domain in the OM.
#define VOM_LOG(lvl)
Definition: logger.hpp:181
void db_dump(const DB &db, std::ostream &os)
Print each of the objects in the DB into the stream provided.
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:461
std::shared_ptr< gbp_subnet > singular() const
Return the matching &#39;singular instance&#39;.
Definition: gbp_subnet.cpp:158
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:236
static const log_level_t DEBUG
Definition: logger.hpp:32
static const handle_t INVALID
A value of an interface handle_t that means the itf does not exist.
Definition: types.hpp:263
A route-domain is a VRF.
std::string to_string() const
Convert to string for debugging.
Definition: gbp_subnet.cpp:108
rc_t rc() const
Get the HW return code.
Definition: hw.hpp:118
void replay(void)
replay the object to create it in hardware
Definition: gbp_subnet.cpp:97
~gbp_subnet()
Destructor.
Definition: gbp_subnet.cpp:67
std::string to_string() const
convert to string format for debug purposes
Definition: prefix.cpp:183
#define v
Definition: acl.c:491
static void dump(std::ostream &os)
Dump all bridge_domain-doamin into the stream provided.
Definition: gbp_subnet.cpp:164
static std::shared_ptr< gbp_subnet > find(const key_t &k)
Find the instnace of the bridge_domain domain in the OM.
Definition: gbp_subnet.cpp:152
A recirculation interface for GBP use pre/post NAT.
Definition: gbp_recirc.hpp:27
A GBP Enpoint (i.e.
Definition: gbp_subnet.hpp:28
bool operator==(const gbp_subnet &bdae) const
comparison operator
Definition: gbp_subnet.cpp:80
gbp_subnet(const route_domain &rd, const route::prefix_t &prefix)
Construct an internal GBP subnet.
Definition: gbp_subnet.cpp:34
const key_t key() const
Return the object&#39;s key.
Definition: gbp_subnet.cpp:74
A cmd class that deletes a GBP subnet.
A entry in the ARP termination table of a Bridge Domain.
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
void event_handler(void *tls_async)
Definition: tls_async.c:311
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:104
static void enqueue(cmd *f)
Enqueue A command for execution.
Definition: hw.cpp:194
A command class that creates or updates the GBP subnet.
static std::shared_ptr< gbp_recirc > find(const key_t &k)
Find the instnace of the recirc interface in the OM.
Definition: gbp_recirc.cpp:121
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
typedef prefix
Definition: ip_types.api:40
std::pair< route_domain::key_t, route::prefix_t > key_t
The key for a GBP subnet; table and prefix.
Definition: gbp_subnet.hpp:34
Entries in Tables.
static std::shared_ptr< gbp_endpoint_group > find(const key_t &k)
Find the instnace of the bridge_domain domain in the OM.
static bool register_listener(listener *listener)
Register a listener of events.
Definition: om.cpp:127
A prefix defintion.
Definition: prefix.hpp:93