FD.io VPP  v20.05.1-6-gf53edbc3b
Vector Packet Processing
gbp_endpoint_cmds.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 
17 #include "vom/api_types.hpp"
18 
20 
21 namespace VOM {
22 namespace gbp_endpoint_cmds {
23 
24 static vapi_enum_gbp_endpoint_flags
26 {
27  vapi_enum_gbp_endpoint_flags out = GBP_API_ENDPOINT_FLAG_NONE;
28 
30  out = (vapi_enum_gbp_endpoint_flags)(out | GBP_API_ENDPOINT_FLAG_REMOTE);
32  out = (vapi_enum_gbp_endpoint_flags)(out | GBP_API_ENDPOINT_FLAG_BOUNCE);
34  out = (vapi_enum_gbp_endpoint_flags)(out | GBP_API_ENDPOINT_FLAG_LEARNT);
36  out = (vapi_enum_gbp_endpoint_flags)(out | GBP_API_ENDPOINT_FLAG_EXTERNAL);
37 
38  return (out);
39 }
40 
42  const handle_t& itf,
43  const std::vector<boost::asio::ip::address>& ip_addrs,
44  const mac_address_t& mac,
47  : rpc_cmd(item)
48  , m_itf(itf)
49  , m_ip_addrs(ip_addrs)
50  , m_mac(mac)
51  , m_sclass(sclass)
52  , m_flags(flags)
53 {
54 }
55 
56 bool
58 {
59  return ((m_itf == other.m_itf) && (m_ip_addrs == other.m_ip_addrs) &&
60  (m_mac == other.m_mac) && (m_sclass == other.m_sclass) &&
61  (m_flags == other.m_flags));
62 }
63 
64 rc_t
66 {
67  msg_t req(con.ctx(), m_ip_addrs.size() * sizeof(vapi_type_address),
68  std::ref(*this));
69  uint8_t n;
70 
71  auto& payload = req.get_request().get_payload();
72  payload.endpoint.sw_if_index = m_itf.value();
73  payload.endpoint.sclass = m_sclass;
74  payload.endpoint.n_ips = m_ip_addrs.size();
75  payload.endpoint.flags = to_api(m_flags);
76 
77  for (n = 0; n < payload.endpoint.n_ips; n++) {
78  VOM::to_api(m_ip_addrs[n], payload.endpoint.ips[n]);
79  }
80  to_api(m_mac, payload.endpoint.mac);
81 
82  VAPI_CALL(req.execute());
83 
84  return (wait());
85 }
86 
88 create_cmd::operator()(vapi::Gbp_endpoint_add& reply)
89 {
90  int handle = reply.get_response().get_payload().handle;
91  int retval = reply.get_response().get_payload().retval;
92 
93  VOM_LOG(log_level_t::DEBUG) << this->to_string() << " " << retval;
94 
95  rc_t rc = rc_t::from_vpp_retval(retval);
97 
98  if (rc_t::OK == rc) {
99  hdl = handle;
100  }
101 
102  this->fulfill(HW::item<handle_t>(hdl, rc));
103 
104  return (VAPI_OK);
105 }
106 
107 std::string
109 {
110  std::ostringstream s;
111  s << "gbp-endpoint-create: " << m_hw_item.to_string() << " itf:" << m_itf
112  << " ips:[";
113  for (auto ip : m_ip_addrs)
114  s << ip.to_string();
115 
116  s << "] mac:" << m_mac << " slcass:" << m_sclass
117  << " flags:" << m_flags.to_string();
118 
119  return (s.str());
120 }
121 
123  : rpc_cmd(item)
124 {
125 }
126 
127 bool
129 {
130  return (m_hw_item == other.m_hw_item);
131 }
132 
133 rc_t
135 {
136  msg_t req(con.ctx(), std::ref(*this));
137 
138  auto& payload = req.get_request().get_payload();
139  payload.handle = m_hw_item.data().value();
140 
141  VAPI_CALL(req.execute());
142 
143  return (wait());
144 }
145 
146 std::string
148 {
149  std::ostringstream s;
150  s << "gbp-endpoint-delete: " << m_hw_item.to_string();
151 
152  return (s.str());
153 }
154 
156 {
157 }
158 
159 bool
160 dump_cmd::operator==(const dump_cmd& other) const
161 {
162  return (true);
163 }
164 
165 rc_t
167 {
168  m_dump.reset(new msg_t(con.ctx(), std::ref(*this)));
169 
170  VAPI_CALL(m_dump->execute());
171 
172  wait();
173 
174  return rc_t::OK;
175 }
176 
177 std::string
179 {
180  return ("gbp-endpoint-dump");
181 }
182 
183 }; // namespace gbp_endpoint_cmds
184 }; // namespace VOM
185 
186 /*
187  * fd.io coding-style-patch-verification: ON
188  *
189  * Local Variables:
190  * eval: (c-set-style "mozilla")
191  * End:
192  */
static const flags_t LEARNT
static const flags_t BOUNCE
static const rc_t & from_vpp_retval(int32_t rv)
Get the rc_t from the VPP API value.
Definition: types.cpp:33
#define VOM_LOG(lvl)
Definition: logger.hpp:181
vl_api_mac_address_t mac
Definition: l2.api:502
uint16_t sclass_t
Definition: gbp_types.hpp:27
uint32_t value() const
get the value of the handle
Definition: types.cpp:93
bool operator==(const dump_cmd &i) const
Comparison operator - only used for UT.
std::string to_string() const
convert to string format for debug purposes
Error codes that VPP will return during a HW write.
Definition: types.hpp:89
static const log_level_t DEBUG
Definition: logger.hpp:32
rc_t issue(connection &con)
Issue the command to VPP/HW.
static const handle_t INVALID
A value of an interface handle_t that means the itf does not exist.
Definition: types.hpp:268
vapi_enum_ip_neighbor_flags to_api(const neighbour::flags_t &f)
Definition: api_types.cpp:21
A cmd class that deletes a GBP endpoint.
T & data()
Return the data read/written.
Definition: hw.hpp:109
std::string to_string() const
convert to string format for debug purposes
Definition: hw.hpp:161
A representation of the connection to VPP.
Definition: connection.hpp:33
A cmd class that Dumps all the GBP endpoints.
std::string to_string() const
convert to string format for debug purposes
u16 sclass
Definition: gbp.api:123
static const flags_t REMOTE
A command class that creates or updates the GBP endpoint.
A base class for all RPC commands to VPP.
Definition: rpc_cmd.hpp:40
virtual vapi_error_e operator()(vapi::Gbp_endpoint_add &reply)
call operator used as a callback by VAPI when the reply is available
static const flags_t EXTERNAL
#define VAPI_CALL(_stmt)
Convenince wrapper macro for error handling in VAPI sends.
Definition: types.hpp:29
delete_cmd(HW::item< handle_t > &item)
Constructor.
void fulfill(const HW::item< handle_t > &d)
Fulfill the commands promise.
Definition: rpc_cmd.hpp:76
u32 flags
Definition: vhost_user.h:248
DEFINE_VAPI_MSG_IDS_GBP_API_JSON
create_cmd(HW::item< handle_t > &item, const handle_t &itf, const std::vector< boost::asio::ip::address > &ip_addrs, const mac_address_t &mac, sclass_t sclass, const gbp_endpoint::flags_t &flags)
Constructor.
A type declaration of an interface handle in VPP.
Definition: types.hpp:233
const std::string & to_string() const
convert to string format for debug purposes
Definition: enum_base.hpp:36
static const rc_t OK
The HW write was successfull.
Definition: types.hpp:109
success
Definition: vapi_common.h:27
std::string to_string() const
convert to string format for debug purposes
rc_t issue(connection &con)
Issue the command to VPP/HW.
vapi::Connection & ctx()
Retrun the VAPI context the commands will use.
Definition: connection.cpp:49
The VPP Object Model (VOM) library.
Definition: acl_binding.cpp:19
vl_api_address_t ip
Definition: l2.api:501
bool operator==(const create_cmd &i) const
Comparison operator - only used for UT.
static vapi_enum_gbp_endpoint_flags to_api(const gbp_endpoint::flags_t &in)
bool operator==(const delete_cmd &i) const
Comparison operator - only used for UT.
Type def of a Ethernet address.
Definition: types.hpp:295
rc_t issue(connection &con)
Issue the command to VPP/HW.
HW::item< handle_t > & m_hw_item
A reference to an object&#39;s HW::item that the command will update.
Definition: rpc_cmd.hpp:134
HW::item< handle_t > & item()
return the HW item the command updates
Definition: rpc_cmd.hpp:66
vapi_error_e
Definition: vapi_common.h:25
vapi::Gbp_endpoint_add msg_t
convenient typedef
Definition: rpc_cmd.hpp:46