FD.io VPP  v21.06-3-gbb25fbf28
Vector Packet Processing
qos_record_cmds.cpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2019 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/qos_record_cmds.hpp"
17 #include "vom/qos_types_api.hpp"
18 
19 namespace VOM {
20 namespace QoS {
21 namespace record_cmds {
22 
24  const handle_t& itf,
25  const source_t& s)
26  : rpc_cmd(item)
27  , m_itf(itf)
28  , m_src(s)
29 {
30 }
31 
32 bool
34 {
35  return ((m_itf == other.m_itf) && (m_src == other.m_src));
36 }
37 
38 rc_t
40 {
41  msg_t req(con.ctx(), std::ref(*this));
42 
43  auto& payload = req.get_request().get_payload();
44  payload.record.sw_if_index = m_itf.value();
45  payload.record.input_source = to_api(m_src);
46 
47  VAPI_CALL(req.execute());
48 
49  return (wait());
50 }
51 
54 {
55  std::ostringstream s;
56  s << "qos-record-create: " << m_hw_item.to_string() << " itf:" << m_itf
57  << " src:" << m_src.to_string();
58 
59  return (s.str());
60 }
61 
63  const handle_t& itf,
64  const source_t& s)
65  : rpc_cmd(item)
66  , m_itf(itf)
67  , m_src(s)
68 {
69 }
70 
71 bool
73 {
74  return (m_hw_item == other.m_hw_item && m_itf == other.m_itf &&
75  m_src == other.m_src);
76 }
77 
78 rc_t
80 {
81  msg_t req(con.ctx(), std::ref(*this));
82 
83  auto& payload = req.get_request().get_payload();
84  payload.record.sw_if_index = m_itf.value();
85  payload.record.input_source = to_api(m_src);
86 
87  VAPI_CALL(req.execute());
88 
89  return (wait());
90 }
91 
94 {
95  std::ostringstream s;
96  s << "qos-record-delete: " << m_hw_item.to_string();
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 ("qos-record-dump");
127 }
128 
129 }; // namespace record_cmds
130 }; // namespace QoS
131 }; // namespace VOM
132 
133 /*
134  * fd.io coding-style-patch-verification: OFF
135  *
136  * Local Variables:
137  * eval: (c-set-style "mozilla")
138  * End:
139  */
VOM::HW::item< bool >
VOM::QoS::record_cmds::delete_cmd::operator==
bool operator==(const delete_cmd &i) const
Comparison operator - only used for UT.
Definition: qos_record_cmds.cpp:72
VOM::dump_cmd< vapi::Qos_record_dump >::msg_t
vapi::Qos_record_dump msg_t
Definition: dump_cmd.hpp:46
VOM::rpc_cmd< HW::item< bool >, vapi::Qos_record_enable_disable >::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::QoS::record_cmds::delete_cmd::issue
rc_t issue(connection &con)
Issue the command to VPP/HW.
Definition: qos_record_cmds.cpp:79
VOM::handle_t::value
uint32_t value() const
get the value of the handle
Definition: types.cpp:93
VOM::QoS::record_cmds::dump_cmd
A cmd class that Dumps all the GBP endpoints.
Definition: qos_record_cmds.hpp:95
VOM::rpc_cmd
A base class for all RPC commands to VPP.
Definition: rpc_cmd.hpp:40
VOM::QoS::record_cmds::delete_cmd
A cmd class that deletes a GBP endpoint.
Definition: qos_record_cmds.hpp:63
qos_types_api.hpp
con
Connection con
Definition: vapi_cpp_test.cpp:56
VOM::QoS::record_cmds::dump_cmd::operator==
bool operator==(const dump_cmd &i) const
Comparison operator - only used for UT.
Definition: qos_record_cmds.cpp:106
VOM::rpc_cmd< HW::item< bool >, vapi::Qos_record_enable_disable >::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::Qos_record_dump >::m_dump
std::unique_ptr< vapi::Qos_record_dump > m_dump
The VAPI event registration.
Definition: dump_cmd.hpp:143
VOM::QoS::record_cmds::dump_cmd::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: qos_record_cmds.cpp:124
VOM::QoS::record_cmds::create_cmd::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: qos_record_cmds.cpp:53
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::Qos_record_dump >::wait
rc_t wait()
Wait for the issue of the command to complete.
Definition: dump_cmd.hpp:93
VOM::QoS::record_cmds::delete_cmd::delete_cmd
delete_cmd(HW::item< bool > &item, const handle_t &itf, const source_t &src)
Constructor.
Definition: qos_record_cmds.cpp:62
VOM::QoS::record_cmds::create_cmd
A command class that creates or updates the GBP endpoint.
Definition: qos_record_cmds.hpp:31
VOM::handle_t
A type declaration of an interface handle in VPP.
Definition: types.hpp:233
VOM::QoS::to_api
vapi_enum_qos_source to_api(const source_t &s)
Definition: qos_types_api.cpp:42
VOM::HW::item::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: hw.hpp:161
VOM::rpc_cmd< HW::item< bool >, vapi::Qos_record_enable_disable >::msg_t
vapi::Qos_record_enable_disable msg_t
convenient typedef
Definition: rpc_cmd.hpp:46
VOM::enum_base::to_string
const std::string & to_string() const
convert to string format for debug purposes
Definition: enum_base.hpp:36
item
cJSON * item
Definition: cJSON.h:222
VOM::QoS::record_cmds::create_cmd::create_cmd
create_cmd(HW::item< bool > &item, const handle_t &itf, const source_t &src)
Constructor.
Definition: qos_record_cmds.cpp:23
VOM::QoS::record_cmds::create_cmd::operator==
bool operator==(const create_cmd &i) const
Comparison operator - only used for UT.
Definition: qos_record_cmds.cpp:33
VOM::rc_t
Error codes that VPP will return during a HW write.
Definition: types.hpp:89
qos_record_cmds.hpp
VOM::QoS::record_cmds::dump_cmd::issue
rc_t issue(connection &con)
Issue the command to VPP/HW.
Definition: qos_record_cmds.cpp:112
VOM::QoS::record_cmds::create_cmd::issue
rc_t issue(connection &con)
Issue the command to VPP/HW.
Definition: qos_record_cmds.cpp:39
VOM::QoS::source_t
The Source of the QoS classification (i.e.
Definition: qos_types.hpp:33
VOM::QoS::record_cmds::delete_cmd::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: qos_record_cmds.cpp:93
VOM::QoS::record_cmds::dump_cmd::dump_cmd
dump_cmd()
Constructor.
Definition: qos_record_cmds.cpp:101
string
const char *const string
Definition: cJSON.h:172