FD.io VPP  v21.06-3-gbb25fbf28
Vector Packet Processing
gbp_recirc_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_recirc_cmds.hpp"
17 
18 namespace VOM {
19 namespace gbp_recirc_cmds {
20 
22  const handle_t& itf,
23  bool is_ext,
25  : rpc_cmd(item)
26  , m_itf(itf)
27  , m_is_ext(is_ext)
28  , m_sclass(sclass)
29 {
30 }
31 
32 bool
34 {
35  return ((m_itf == other.m_itf) && (m_is_ext == other.m_is_ext) &&
36  (m_sclass == other.m_sclass));
37 }
38 
39 rc_t
41 {
42  msg_t req(con.ctx(), std::ref(*this));
43 
44  auto& payload = req.get_request().get_payload();
45  payload.is_add = 1;
46  payload.recirc.sw_if_index = m_itf.value();
47  payload.recirc.sclass = m_sclass;
48  payload.recirc.is_ext = m_is_ext;
49 
50  VAPI_CALL(req.execute());
51 
52  return (wait());
53 }
54 
57 {
58  std::ostringstream s;
59  s << "gbp-recirc-create: " << m_hw_item.to_string() << " itf:" << m_itf
60  << " ext:" << m_is_ext << " sclass:" << m_sclass;
61 
62  return (s.str());
63 }
64 
66  : rpc_cmd(item)
67  , m_itf(itf)
68 {
69 }
70 
71 bool
73 {
74  return (m_itf == other.m_itf);
75 }
76 
77 rc_t
79 {
80  msg_t req(con.ctx(), std::ref(*this));
81 
82  auto& payload = req.get_request().get_payload();
83  payload.is_add = 0;
84  payload.recirc.sw_if_index = m_itf.value();
85  payload.recirc.sclass = ~0;
86 
87  VAPI_CALL(req.execute());
88 
89  return (wait());
90 }
91 
94 {
95  std::ostringstream s;
96  s << "gbp-recirc-delete: " << m_hw_item.to_string() << " itf:" << m_itf;
97 
98  return (s.str());
99 }
100 
102 {
103 }
104 
105 bool
106 dump_cmd::operator==(const dump_cmd& other) const
107 {
108  return (true);
109 }
110 
111 rc_t
113 {
114  m_dump.reset(new msg_t(con.ctx(), std::ref(*this)));
115 
116  VAPI_CALL(m_dump->execute());
117 
118  wait();
119 
120  return rc_t::OK;
121 }
122 
125 {
126  return ("gbp-recirc-dump");
127 }
128 
129 }; // namespace gbp_recirc_cmds
130 }; // namespace VOM
131 
132 /*
133  * fd.io coding-style-patch-verification: OFF
134  *
135  * Local Variables:
136  * eval: (c-set-style "mozilla")
137  * End:
138  */
VOM::HW::item< bool >
VOM::dump_cmd< vapi::Gbp_recirc_dump >::msg_t
vapi::Gbp_recirc_dump msg_t
Definition: dump_cmd.hpp:46
VOM::rpc_cmd< HW::item< bool >, vapi::Gbp_recirc_add_del >::wait
rc_t wait()
Wait on the commands promise.
Definition: rpc_cmd.hpp:82
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::gbp_recirc_cmds::delete_cmd::delete_cmd
delete_cmd(HW::item< bool > &item, const handle_t &itf)
Constructor.
Definition: gbp_recirc_cmds.cpp:65
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
con
Connection con
Definition: vapi_cpp_test.cpp:56
VOM::sclass_t
uint16_t sclass_t
Definition: gbp_types.hpp:27
is_ext
bool is_ext
Definition: gbp.api:227
VOM::rpc_cmd< HW::item< bool >, vapi::Gbp_recirc_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_recirc_dump >::m_dump
std::unique_ptr< vapi::Gbp_recirc_dump > m_dump
The VAPI event registration.
Definition: dump_cmd.hpp:143
VOM::gbp_recirc_cmds::create_cmd::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: gbp_recirc_cmds.cpp:56
VOM::gbp_recirc_cmds::dump_cmd::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: gbp_recirc_cmds.cpp:124
VOM::gbp_recirc_cmds::dump_cmd::issue
rc_t issue(connection &con)
Issue the command to VPP/HW.
Definition: gbp_recirc_cmds.cpp:112
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::dump_cmd< vapi::Gbp_recirc_dump >::wait
rc_t wait()
Wait for the issue of the command to complete.
Definition: dump_cmd.hpp:93
VOM::gbp_recirc_cmds::delete_cmd::operator==
bool operator==(const delete_cmd &i) const
Comparison operator - only used for UT.
Definition: gbp_recirc_cmds.cpp:72
VOM::gbp_recirc_cmds::dump_cmd::dump_cmd
dump_cmd()
Constructor.
Definition: gbp_recirc_cmds.cpp:101
VOM::handle_t
A type declaration of an interface handle in VPP.
Definition: types.hpp:233
VOM::gbp_recirc_cmds::delete_cmd::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: gbp_recirc_cmds.cpp:93
sclass
u16 sclass
Definition: gbp.api:131
VOM::gbp_recirc_cmds::create_cmd::create_cmd
create_cmd(HW::item< bool > &item, const handle_t &itf, bool is_ext, sclass_t sclass)
Constructor.
Definition: gbp_recirc_cmds.cpp:21
VOM::HW::item::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: hw.hpp:161
VOM::gbp_recirc_cmds::create_cmd::operator==
bool operator==(const create_cmd &i) const
Comparison operator - only used for UT.
Definition: gbp_recirc_cmds.cpp:33
VOM::rpc_cmd< HW::item< bool >, vapi::Gbp_recirc_add_del >::msg_t
vapi::Gbp_recirc_add_del msg_t
convenient typedef
Definition: rpc_cmd.hpp:46
VOM::gbp_recirc_cmds::delete_cmd::issue
rc_t issue(connection &con)
Issue the command to VPP/HW.
Definition: gbp_recirc_cmds.cpp:78
VOM::gbp_recirc_cmds::delete_cmd
A cmd class that deletes a GBP recirc.
Definition: gbp_recirc_cmds.hpp:65
gbp_recirc_cmds.hpp
VOM::gbp_recirc_cmds::dump_cmd::operator==
bool operator==(const dump_cmd &i) const
Comparison operator - only used for UT.
Definition: gbp_recirc_cmds.cpp:106
VOM::gbp_recirc_cmds::create_cmd
A command class that creates or updates the GBP recirc.
Definition: gbp_recirc_cmds.hpp:30
item
cJSON * item
Definition: cJSON.h:222
VOM::gbp_recirc_cmds::dump_cmd
A cmd class that Dumps all the GBP recircs.
Definition: gbp_recirc_cmds.hpp:95
VOM::gbp_recirc_cmds::create_cmd::issue
rc_t issue(connection &con)
Issue the command to VPP/HW.
Definition: gbp_recirc_cmds.cpp:40
VOM::rc_t
Error codes that VPP will return during a HW write.
Definition: types.hpp:89
string
const char *const string
Definition: cJSON.h:172