FD.io VPP  v19.08.3-2-gbabecb413
Vector Packet Processing
interface_span_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 
19 
20 namespace VOM {
21 namespace interface_span_cmds {
22 
24  const handle_t& itf_from,
25  const handle_t& itf_to,
27  : rpc_cmd(item)
28  , m_itf_from(itf_from)
29  , m_itf_to(itf_to)
30  , m_state(state)
31 {
32 }
33 
34 bool
36 {
37  return ((m_itf_from == o.m_itf_from) && (m_itf_to == o.m_itf_to) &&
38  (m_state == o.m_state));
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.is_l2 = 0;
48  payload.sw_if_index_from = m_itf_from.value();
49  payload.sw_if_index_to = m_itf_to.value();
50  payload.state = m_state.value();
51 
52  VAPI_CALL(req.execute());
53 
54  return (wait());
55 }
56 
57 std::string
59 {
60  std::ostringstream s;
61  s << "itf-span-config: " << m_hw_item.to_string()
62  << " itf-from:" << m_itf_from.to_string()
63  << " itf-to:" << m_itf_to.to_string() << " state:" << m_state.to_string();
64 
65  return (s.str());
66 }
67 
69  const handle_t& itf_from,
70  const handle_t& itf_to)
71  : rpc_cmd(item)
72  , m_itf_from(itf_from)
73  , m_itf_to(itf_to)
74 {
75 }
76 
77 bool
79 {
80  return ((m_itf_from == o.m_itf_from) && (m_itf_to == o.m_itf_to));
81 }
82 
83 rc_t
85 {
86  msg_t req(con.ctx(), std::ref(*this));
87 
88  auto& payload = req.get_request().get_payload();
89  payload.is_l2 = 0;
90  payload.sw_if_index_from = m_itf_from.value();
91  payload.sw_if_index_to = m_itf_to.value();
92  payload.state = 0;
93 
94  VAPI_CALL(req.execute());
95 
96  wait();
98 
99  return rc_t::OK;
100 }
101 
102 std::string
104 {
105  std::ostringstream s;
106  s << "itf-span-unconfig: " << m_hw_item.to_string()
107  << " itf-from:" << m_itf_from.to_string()
108  << " itf-to:" << m_itf_to.to_string();
109 
110  return (s.str());
111 }
112 
114 {
115 }
116 
117 bool
118 dump_cmd::operator==(const dump_cmd& other) const
119 {
120  return (true);
121 }
122 
123 rc_t
125 {
126  m_dump.reset(new msg_t(con.ctx(), std::ref(*this)));
127 
128  auto& payload = m_dump->get_request().get_payload();
129  payload.is_l2 = 0;
130 
131  VAPI_CALL(m_dump->execute());
132 
133  wait();
134 
135  return rc_t::OK;
136 }
137 
138 std::string
140 {
141  return ("interface-span-dump");
142 }
143 
144 }; // namespace interface_span_cmds
145 }; // namespace VOM
146 
147 /*
148  * fd.io coding-style-patch-verification: ON
149  *
150  * Local Variables:
151  * eval: (c-set-style "mozilla")
152  * End:
153  */
static const rc_t NOOP
The HW write/update action was/has not been attempted.
Definition: types.hpp:104
uint32_t value() const
get the value of the handle
Definition: types.cpp:93
Error codes that VPP will return during a HW write.
Definition: types.hpp:89
bool operator==(const dump_cmd &i) const
Comparison operator - only used for UT.
int value() const
Return the value of the enum - same as integer conversion.
Definition: enum_base.hpp:88
std::string to_string() const
convert to string format for debug purposes
Definition: hw.hpp:161
A command class that configures the interface span.
A cmd class that Unconfigs interface span.
vhost_vring_state_t state
Definition: vhost_user.h:146
bool operator==(const config_cmd &i) const
Comparison operator - only used for UT.
A representation of the connection to VPP.
Definition: connection.hpp:33
config_cmd(HW::item< bool > &item, const handle_t &itf_from, const handle_t &itf_to, const interface_span::state_t &state)
Constructor.
A base class for all RPC commands to VPP.
Definition: rpc_cmd.hpp:40
A cmd class that Dumps all the interface spans.
#define VAPI_CALL(_stmt)
Convenince wrapper macro for error handling in VAPI sends.
Definition: types.hpp:29
unconfig_cmd(HW::item< bool > &item, const handle_t &itf_from, const handle_t &itf_to)
Constructor.
std::string to_string() const
convert to string format for debug purposes
Definition: types.cpp:69
A type declaration of an interface handle in VPP.
Definition: types.hpp:233
rc_t issue(connection &con)
Issue the command to VPP/HW.
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
std::string to_string() const
convert to string format for debug purposes
rc_t issue(connection &con)
Issue the command to VPP/HW.
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
void set(const rc_t &rc)
Set the HW return code - should only be called from the family of Command objects.
Definition: hw.hpp:125
std::string to_string() const
convert to string format for debug purposes
std::string to_string() const
convert to string format for debug purposes
HW::item< bool > & m_hw_item
A reference to an object&#39;s HW::item that the command will update.
Definition: rpc_cmd.hpp:134
bool operator==(const unconfig_cmd &i) const
Comparison operator - only used for UT.
The state of the interface - rx/tx or both to be mirrored.
HW::item< bool > & item()
return the HW item the command updates
Definition: rpc_cmd.hpp:66
vapi::Sw_interface_span_enable_disable msg_t
convenient typedef
Definition: rpc_cmd.hpp:46
DEFINE_VAPI_MSG_IDS_SPAN_API_JSON