FD.io VPP  v21.06-3-gbb25fbf28
Vector Packet Processing
l2_xconnect_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/l2_xconnect_cmds.hpp"
17 
18 namespace VOM {
19 namespace l2_xconnect_cmds {
21  const handle_t& east_itf,
22  const handle_t& west_itf)
23  : rpc_cmd(item)
24  , m_east_itf(east_itf)
25  , m_west_itf(west_itf)
26 {
27 }
28 
29 bool
30 bind_cmd::operator==(const bind_cmd& other) const
31 {
32  return ((m_east_itf == other.m_east_itf) && (m_west_itf == other.m_west_itf));
33 }
34 
35 rc_t
37 {
38  msg_t req(con.ctx(), std::ref(*this));
39 
40  auto& payload = req.get_request().get_payload();
41  payload.rx_sw_if_index = m_east_itf.value();
42  payload.tx_sw_if_index = m_west_itf.value();
43  payload.enable = 1;
44 
45  VAPI_CALL(req.execute());
46 
47  wait();
48 
49  return (rc_t::OK);
50 }
51 
54 {
55  std::ostringstream s;
56  s << "L2-bind: " << m_hw_item.to_string()
57  << " east-itf:" << m_east_itf.to_string()
58  << " west-itf:" << m_west_itf.to_string();
59 
60  return (s.str());
61 }
62 
64  const handle_t& east_itf,
65  const handle_t& west_itf)
66  : rpc_cmd(item)
67  , m_east_itf(east_itf)
68  , m_west_itf(west_itf)
69 {
70 }
71 
72 bool
74 {
75  return ((m_east_itf == other.m_east_itf) && (m_west_itf == other.m_west_itf));
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.rx_sw_if_index = m_east_itf.value();
85  payload.tx_sw_if_index = m_west_itf.value();
86  payload.enable = 0;
87 
88  VAPI_CALL(req.execute());
89 
90  wait();
92 
93  return (rc_t::OK);
94 }
95 
98 {
99  std::ostringstream s;
100  s << "L2-unbind: " << m_hw_item.to_string()
101  << " east-itf:" << m_east_itf.to_string()
102  << " west-itf:" << m_west_itf.to_string();
103 
104  return (s.str());
105 }
106 
108 {
109 }
110 
111 bool
112 dump_cmd::operator==(const dump_cmd& other) const
113 {
114  return (true);
115 }
116 
117 rc_t
119 {
120  m_dump.reset(new msg_t(con.ctx(), std::ref(*this)));
121 
122  VAPI_CALL(m_dump->execute());
123 
124  wait();
125 
126  return rc_t::OK;
127 }
128 
131 {
132  return ("l2-xconnect-dump");
133 }
134 
135 }; // namespace l2_xconnect_cmds
136 }; // namespace VOM
137 
138 /*
139  * fd.io coding-style-patch-verification: OFF
140  *
141  * Local Variables:
142  * eval: (c-set-style "mozilla")
143  * End:
144  */
VOM::HW::item< bool >
VOM::l2_xconnect_cmds::dump_cmd::dump_cmd
dump_cmd()
Constructor.
Definition: l2_xconnect_cmds.cpp:107
VOM::dump_cmd< vapi::L2_xconnect_dump >::msg_t
vapi::L2_xconnect_dump msg_t
Definition: dump_cmd.hpp:46
VOM::l2_xconnect_cmds::bind_cmd
A functor class that binds L2 configuration to an interface.
Definition: l2_xconnect_cmds.hpp:32
VOM::rpc_cmd< HW::item< bool >, vapi::Sw_interface_set_l2_xconnect >::wait
rc_t wait()
Wait on the commands promise.
Definition: rpc_cmd.hpp:82
VOM::HW::item::set
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
VOM
The VPP Object Model (VOM) library.
Definition: acl_binding.cpp:19
VOM::l2_xconnect_cmds::dump_cmd::operator==
bool operator==(const dump_cmd &i) const
Comparison operator - only used for UT.
Definition: l2_xconnect_cmds.cpp:112
VOM::rc_t::OK
const static rc_t OK
The HW write was successfull.
Definition: types.hpp:109
VOM::l2_xconnect_cmds::unbind_cmd::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: l2_xconnect_cmds.cpp:97
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
VOM::l2_xconnect_cmds::bind_cmd::operator==
bool operator==(const bind_cmd &i) const
Comparison operator - only used for UT.
Definition: l2_xconnect_cmds.cpp:30
con
Connection con
Definition: vapi_cpp_test.cpp:56
VOM::l2_xconnect_cmds::dump_cmd::issue
rc_t issue(connection &con)
Issue the command to VPP/HW.
Definition: l2_xconnect_cmds.cpp:118
VOM::rpc_cmd< HW::item< bool >, vapi::Sw_interface_set_l2_xconnect >::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::L2_xconnect_dump >::m_dump
std::unique_ptr< vapi::L2_xconnect_dump > m_dump
The VAPI event registration.
Definition: dump_cmd.hpp:143
VOM::l2_xconnect_cmds::dump_cmd::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: l2_xconnect_cmds.cpp:130
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::l2_xconnect_cmds::unbind_cmd::operator==
bool operator==(const unbind_cmd &i) const
Comparison operator - only used for UT.
Definition: l2_xconnect_cmds.cpp:73
VOM::dump_cmd< vapi::L2_xconnect_dump >::wait
rc_t wait()
Wait for the issue of the command to complete.
Definition: dump_cmd.hpp:93
VOM::l2_xconnect_cmds::dump_cmd
A cmd class that Dumps all the bridge domains.
Definition: l2_xconnect_cmds.hpp:113
VOM::rc_t::NOOP
const static rc_t NOOP
The HW write/update action was/has not been attempted.
Definition: types.hpp:104
VOM::handle_t
A type declaration of an interface handle in VPP.
Definition: types.hpp:233
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::Sw_interface_set_l2_xconnect >::msg_t
vapi::Sw_interface_set_l2_xconnect msg_t
convenient typedef
Definition: rpc_cmd.hpp:46
VOM::handle_t::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: types.cpp:69
VOM::l2_xconnect_cmds::bind_cmd::bind_cmd
bind_cmd(HW::item< bool > &item, const handle_t &east_itf, const handle_t &west_itf)
Constructor.
Definition: l2_xconnect_cmds.cpp:20
VOM::l2_xconnect_cmds::unbind_cmd::unbind_cmd
unbind_cmd(HW::item< bool > &item, const handle_t &east_itf, const handle_t &west_itf)
Constructor.
Definition: l2_xconnect_cmds.cpp:63
VOM::l2_xconnect_cmds::bind_cmd::issue
rc_t issue(connection &con)
Issue the command to VPP/HW.
Definition: l2_xconnect_cmds.cpp:36
item
cJSON * item
Definition: cJSON.h:222
VOM::l2_xconnect_cmds::bind_cmd::to_string
std::string to_string() const
convert to string format for debug purposes
Definition: l2_xconnect_cmds.cpp:53
VOM::rc_t
Error codes that VPP will return during a HW write.
Definition: types.hpp:89
VOM::l2_xconnect_cmds::unbind_cmd::issue
rc_t issue(connection &con)
Issue the command to VPP/HW.
Definition: l2_xconnect_cmds.cpp:79
l2_xconnect_cmds.hpp
string
const char *const string
Definition: cJSON.h:172
VOM::l2_xconnect_cmds::unbind_cmd
A cmd class that Unbinds L2 configuration from an interface.
Definition: l2_xconnect_cmds.hpp:72