FD.io VPP  v21.10.1-2-g0a485f517
Vector Packet Processing
qos_mark_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_mark_cmds.hpp"
17 #include "vom/qos_types_api.hpp"
18 
19 namespace VOM {
20 namespace QoS {
21 namespace mark_cmds {
22 
24  const handle_t& itf,
25  uint32_t map_id,
26  const source_t& s)
27  : rpc_cmd(item)
28  , m_itf(itf)
29  , m_map_id(map_id)
30  , m_src(s)
31 {
32 }
33 
34 bool
36 {
37  return ((m_itf == other.m_itf) && (m_src == other.m_src) &&
38  (m_map_id == other.m_map_id));
39 }
40 
41 rc_t
43 {
44  msg_t req(con.ctx(), std::ref(*this));
45 
46  auto& payload = req.get_request().get_payload();
47  payload.mark.sw_if_index = m_itf.value();
48  payload.mark.map_id = m_map_id;
49  payload.mark.output_source = to_api(m_src);
50 
51  VAPI_CALL(req.execute());
52 
53  return (wait());
54 }
55 
58 {
59  std::ostringstream s;
60  s << "qos-mark-create: " << m_hw_item.to_string() << " itf:" << m_itf
61  << " src:" << m_src.to_string() << " map-id:" << m_map_id;
62 
63  return (s.str());
64 }
65 
67  const handle_t& itf,
68  const source_t& s)
69  : rpc_cmd(item)
70  , m_itf(itf)
71  , m_src(s)
72 {
73 }
74 
75 bool
77 {
78  return (m_hw_item == other.m_hw_item && m_itf == other.m_itf &&
79  m_src == other.m_src);
80 }
81 
82 rc_t
84 {
85  msg_t req(con.ctx(), std::ref(*this));
86 
87  auto& payload = req.get_request().get_payload();
88  payload.mark.sw_if_index = m_itf.value();
89  payload.mark.output_source = to_api(m_src);
90 
91  VAPI_CALL(req.execute());
92 
93  return (wait());
94 }
95 
98 {
99  std::ostringstream s;
100  s << "qos-mark-delete: " << m_hw_item.to_string();
101 
102  return (s.str());
103 }
104 
106 {
107 }
108 
109 bool
110 dump_cmd::operator==(const dump_cmd& other) const
111 {
112  return (true);
113 }
114 
115 rc_t
117 {
118  m_dump.reset(new msg_t(con.ctx(), std::ref(*this)));
119 
120  VAPI_CALL(m_dump->execute());
121 
122  wait();
123 
124  return rc_t::OK;
125 }
126 
129 {
130  return ("qos-mark-dump");
131 }
132 
133 }; // namespace mark_cmds
134 }; // namespace QoS
135 }; // namespace VOM
136 
137 /*
138  * fd.io coding-style-patch-verification: OFF
139  *
140  * Local Variables:
141  * eval: (c-set-style "mozilla")
142  * End:
143  */
VOM::HW::item< bool >
VOM::QoS::mark_cmds::delete_cmd::delete_cmd
delete_cmd(HW::item< bool > &item, const handle_t &itf, const source_t &src)
Constructor.
Definition: qos_mark_cmds.cpp:66
VOM::dump_cmd< vapi::Qos_mark_dump >::msg_t
vapi::Qos_mark_dump msg_t
Definition: dump_cmd.hpp:46
VOM::rpc_cmd< HW::item< bool >, vapi::Qos_mark_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::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
qos_types_api.hpp
VOM::QoS::mark_cmds::create_cmd::operator==
bool operator==(const create_cmd &i) const
Comparison operator - only used for UT.
Definition: qos_mark_cmds.cpp:35
con
Connection con
Definition: vapi_cpp_test.cpp:56
VOM::rpc_cmd< HW::item< bool >, vapi::Qos_mark_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_mark_dump >::m_dump
std::unique_ptr< vapi::Qos_mark_dump > m_dump
The VAPI event registration.
Definition: dump_cmd.hpp:143
qos_mark_cmds.hpp
VOM::QoS::mark_cmds::dump_cmd
A cmd class that Dumps all the GBP endpoints.
Definition: qos_mark_cmds.hpp:97
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::QoS::mark_cmds::delete_cmd::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: qos_mark_cmds.cpp:97
VOM::dump_cmd< vapi::Qos_mark_dump >::wait
rc_t wait()
Wait for the issue of the command to complete.
Definition: dump_cmd.hpp:93
VOM::handle_t
A type declaration of an interface handle in VPP.
Definition: types.hpp:233
VOM::QoS::mark_cmds::dump_cmd::operator==
bool operator==(const dump_cmd &i) const
Comparison operator - only used for UT.
Definition: qos_mark_cmds.cpp:110
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_mark_enable_disable >::msg_t
vapi::Qos_mark_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::mark_cmds::delete_cmd
A cmd class that deletes a GBP endpoint.
Definition: qos_mark_cmds.hpp:66
VOM::QoS::mark_cmds::delete_cmd::operator==
bool operator==(const delete_cmd &i) const
Comparison operator - only used for UT.
Definition: qos_mark_cmds.cpp:76
VOM::QoS::mark_cmds::dump_cmd::dump_cmd
dump_cmd()
Constructor.
Definition: qos_mark_cmds.cpp:105
map_id
u32 map_id
Definition: qos.api:214
VOM::rc_t
Error codes that VPP will return during a HW write.
Definition: types.hpp:89
VOM::QoS::source_t
The Source of the QoS classification (i.e.
Definition: qos_types.hpp:33
VOM::QoS::mark_cmds::dump_cmd::issue
rc_t issue(connection &con)
Issue the command to VPP/HW.
Definition: qos_mark_cmds.cpp:116
VOM::QoS::mark_cmds::create_cmd::create_cmd
create_cmd(HW::item< bool > &item, const handle_t &itf, uint32_t map_id, const source_t &src)
Constructor.
Definition: qos_mark_cmds.cpp:23
VOM::QoS::mark_cmds::create_cmd
A command class that creates or updates the GBP endpoint.
Definition: qos_mark_cmds.hpp:31
VOM::QoS::mark_cmds::dump_cmd::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: qos_mark_cmds.cpp:128
VOM::QoS::mark_cmds::delete_cmd::issue
rc_t issue(connection &con)
Issue the command to VPP/HW.
Definition: qos_mark_cmds.cpp:83
VOM::QoS::mark_cmds::create_cmd::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: qos_mark_cmds.cpp:57
string
const char *const string
Definition: cJSON.h:172
VOM::QoS::mark_cmds::create_cmd::issue
rc_t issue(connection &con)
Issue the command to VPP/HW.
Definition: qos_mark_cmds.cpp:42