FD.io VPP  v21.06-3-gbb25fbf28
Vector Packet Processing
gbp_subnet_cmds.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_cmds.hpp"
17 #include "vom/api_types.hpp"
18 
19 namespace VOM {
20 namespace gbp_subnet_cmds {
21 
24  const route::prefix_t& prefix,
25  const gbp_subnet::type_t& type,
26  const handle_t& itf,
28  : rpc_cmd(item)
29  , m_rd(rd)
30  , m_prefix(prefix)
31  , m_type(type)
32  , m_itf(itf)
33  , m_sclass(sclass)
34 {
35 }
36 
37 bool
39 {
40  return ((m_itf == other.m_itf) && (m_rd == other.m_rd) &&
41  (m_prefix == other.m_prefix) && (m_type == other.m_type) &&
42  (m_itf == other.m_itf) && (m_sclass == other.m_sclass));
43 }
44 
45 static vapi_enum_gbp_subnet_type
47 {
53  return (GBP_API_SUBNET_TRANSPORT);
55  return (GBP_API_SUBNET_L3_OUT);
56 
58 }
59 
60 rc_t
62 {
63  msg_t req(con.ctx(), std::ref(*this));
64 
65  auto& payload = req.get_request().get_payload();
66  payload.is_add = 1;
67  payload.subnet.type = gbp_subnet_type_to_api(m_type);
68  payload.subnet.rd_id = m_rd;
69  payload.subnet.sw_if_index = m_itf.value();
70  payload.subnet.sclass = m_sclass;
71  payload.subnet.prefix = to_api(m_prefix);
72 
73  VAPI_CALL(req.execute());
74 
75  return (wait());
76 }
77 
80 {
81  std::ostringstream s;
82  s << "gbp-subnet-create: " << m_hw_item.to_string() << "type:" << m_type
83  << ", " << m_rd << ":" << m_prefix.to_string() << " itf:" << m_itf
84  << " sclass:" << m_sclass;
85 
86  return (s.str());
87 }
88 
91  const route::prefix_t& prefix)
92  : rpc_cmd(item)
93  , m_rd(rd)
94  , m_prefix(prefix)
95 {
96 }
97 
98 bool
100 {
101  return ((m_rd == other.m_rd) && (m_prefix == other.m_prefix));
102 }
103 
104 rc_t
106 {
107  msg_t req(con.ctx(), std::ref(*this));
108 
109  auto& payload = req.get_request().get_payload();
110  payload.is_add = 0;
111  payload.subnet.rd_id = m_rd;
112  payload.subnet.prefix = to_api(m_prefix);
113 
114  VAPI_CALL(req.execute());
115 
116  return (wait());
117 }
118 
121 {
122  std::ostringstream s;
123  s << "gbp-subnet-delete: " << m_hw_item.to_string() << ", " << m_rd << ":"
124  << m_prefix.to_string();
125 
126  return (s.str());
127 }
128 
130 {
131 }
132 
133 bool
134 dump_cmd::operator==(const dump_cmd& other) const
135 {
136  return (true);
137 }
138 
139 rc_t
141 {
142  m_dump.reset(new msg_t(con.ctx(), std::ref(*this)));
143 
144  VAPI_CALL(m_dump->execute());
145 
146  wait();
147 
148  return rc_t::OK;
149 }
150 
153 {
154  return ("gbp-subnet-dump");
155 }
156 
157 }; // namespace gbp_subnet_cmds
158 }; // namespace VOM
159 
160 /*
161  * fd.io coding-style-patch-verification: OFF
162  *
163  * Local Variables:
164  * eval: (c-set-style "mozilla")
165  * End:
166  */
VOM::route::prefix_t
A prefix defintion.
Definition: prefix.hpp:131
VOM::HW::item< bool >
GBP_API_SUBNET_L3_OUT
@ GBP_API_SUBNET_L3_OUT
Definition: gbp.api:258
VOM::dump_cmd< vapi::Gbp_subnet_dump >::msg_t
vapi::Gbp_subnet_dump msg_t
Definition: dump_cmd.hpp:46
VOM::rpc_cmd< HW::item< bool >, vapi::Gbp_subnet_add_del >::wait
rc_t wait()
Wait on the commands promise.
Definition: rpc_cmd.hpp:82
VOM::gbp_subnet::type_t::STITCHED_INTERNAL
const static type_t STITCHED_INTERNAL
Internal subnet is reachable through the source EPG's uplink interface.
Definition: gbp_subnet.hpp:44
VOM
The VPP Object Model (VOM) library.
Definition: acl_binding.cpp:19
VOM::rc_t::OK
const static rc_t OK
The HW write was successfull.
Definition: types.hpp:109
VOM::handle_t::value
uint32_t value() const
get the value of the handle
Definition: types.cpp:93
VOM::rpc_cmd
A base class for all RPC commands to VPP.
Definition: rpc_cmd.hpp:40
VOM::gbp_subnet_cmds::delete_cmd::operator==
bool operator==(const delete_cmd &i) const
Comparison operator - only used for UT.
Definition: gbp_subnet_cmds.cpp:99
con
Connection con
Definition: vapi_cpp_test.cpp:56
VOM::sclass_t
uint16_t sclass_t
Definition: gbp_types.hpp:27
GBP_API_SUBNET_STITCHED_INTERNAL
@ GBP_API_SUBNET_STITCHED_INTERNAL
Definition: gbp.api:256
VOM::rpc_cmd< HW::item< bool >, vapi::Gbp_subnet_add_del >::m_hw_item
HW::item< bool > & m_hw_item
A reference to an object's HW::item that the command will update.
Definition: rpc_cmd.hpp:134
VOM::dump_cmd< vapi::Gbp_subnet_dump >::m_dump
std::unique_ptr< vapi::Gbp_subnet_dump > m_dump
The VAPI event registration.
Definition: dump_cmd.hpp:143
VOM::route::prefix_t::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: prefix.cpp:214
VAPI_CALL
#define VAPI_CALL(_stmt)
Convenince wrapper macro for error handling in VAPI sends.
Definition: types.hpp:29
VOM::connection
A representation of the connection to VPP.
Definition: connection.hpp:33
VOM::gbp_subnet_cmds::delete_cmd
A cmd class that deletes a GBP subnet.
Definition: gbp_subnet_cmds.hpp:69
VOM::dump_cmd< vapi::Gbp_subnet_dump >::wait
rc_t wait()
Wait for the issue of the command to complete.
Definition: dump_cmd.hpp:93
VOM::gbp_subnet_cmds::dump_cmd::operator==
bool operator==(const dump_cmd &i) const
Comparison operator - only used for UT.
Definition: gbp_subnet_cmds.cpp:134
VOM::gbp_subnet_cmds::dump_cmd::issue
rc_t issue(connection &con)
Issue the command to VPP/HW.
Definition: gbp_subnet_cmds.cpp:140
VOM::handle_t
A type declaration of an interface handle in VPP.
Definition: types.hpp:233
sclass
u16 sclass
Definition: gbp.api:131
VOM::HW::item::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: hw.hpp:161
GBP_API_SUBNET_STITCHED_EXTERNAL
@ GBP_API_SUBNET_STITCHED_EXTERNAL
Definition: gbp.api:257
VOM::gbp_subnet_cmds::delete_cmd::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: gbp_subnet_cmds.cpp:120
VOM::gbp_subnet_cmds::dump_cmd::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: gbp_subnet_cmds.cpp:152
VOM::gbp_subnet_cmds::create_cmd
A command class that creates or updates the GBP subnet.
Definition: gbp_subnet_cmds.hpp:30
VOM::gbp_subnet_cmds::delete_cmd::issue
rc_t issue(connection &con)
Issue the command to VPP/HW.
Definition: gbp_subnet_cmds.cpp:105
VOM::to_api
vapi_enum_ip_neighbor_flags to_api(const neighbour::flags_t &f)
Definition: api_types.cpp:21
VOM::gbp_subnet::type_t::STITCHED_EXTERNAL
const static type_t STITCHED_EXTERNAL
External subnet requires NAT translation before egress.
Definition: gbp_subnet.hpp:49
VOM::rpc_cmd< HW::item< bool >, vapi::Gbp_subnet_add_del >::msg_t
vapi::Gbp_subnet_add_del msg_t
convenient typedef
Definition: rpc_cmd.hpp:46
VOM::gbp_subnet_cmds::create_cmd::operator==
bool operator==(const create_cmd &i) const
Comparison operator - only used for UT.
Definition: gbp_subnet_cmds.cpp:38
VOM::gbp_subnet_cmds::gbp_subnet_type_to_api
static vapi_enum_gbp_subnet_type gbp_subnet_type_to_api(const gbp_subnet::type_t &type)
Definition: gbp_subnet_cmds.cpp:46
VOM::gbp_subnet_cmds::delete_cmd::delete_cmd
delete_cmd(HW::item< bool > &item, route::table_id_t rd, const route::prefix_t &prefix)
Constructor.
Definition: gbp_subnet_cmds.cpp:89
VOM::gbp_subnet::type_t::TRANSPORT
const static type_t TRANSPORT
A transport subnet, sent via the RD's UU-fwd interface.
Definition: gbp_subnet.hpp:54
item
cJSON * item
Definition: cJSON.h:222
VOM::gbp_subnet::type_t::L3_OUT
const static type_t L3_OUT
A L3-out subnet.
Definition: gbp_subnet.hpp:59
VOM::gbp_subnet_cmds::create_cmd::issue
rc_t issue(connection &con)
Issue the command to VPP/HW.
Definition: gbp_subnet_cmds.cpp:61
VOM::gbp_subnet_cmds::dump_cmd
A cmd class that Dumps all the GBP subnets.
Definition: gbp_subnet_cmds.hpp:102
VOM::gbp_subnet_cmds::dump_cmd::dump_cmd
dump_cmd()
Constructor.
Definition: gbp_subnet_cmds.cpp:129
VOM::route::table_id_t
uint32_t table_id_t
type def the table-id
Definition: prefix.hpp:121
VOM::rc_t
Error codes that VPP will return during a HW write.
Definition: types.hpp:89
VOM::gbp_subnet::type_t
Definition: gbp_subnet.hpp:38
gbp_subnet_cmds.hpp
VOM::gbp_subnet_cmds::create_cmd::create_cmd
create_cmd(HW::item< bool > &item, route::table_id_t rd, const route::prefix_t &prefix, const gbp_subnet::type_t &type, const handle_t &itf, sclass_t sclass)
Constructor.
Definition: gbp_subnet_cmds.cpp:22
api_types.hpp
VOM::gbp_subnet_cmds::create_cmd::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: gbp_subnet_cmds.cpp:79
type
vl_api_fib_path_type_t type
Definition: fib_types.api:123
GBP_API_SUBNET_TRANSPORT
@ GBP_API_SUBNET_TRANSPORT
Definition: gbp.api:255
prefix
vl_api_prefix_t prefix
Definition: ip.api:146
string
const char *const string
Definition: cJSON.h:172