FD.io VPP  v19.01.2-3-gf61a1a8
Vector Packet Processing
l2_binding_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 
16 #include "vom/l2_binding_cmds.hpp"
17 
18 namespace VOM {
19 namespace l2_binding_cmds {
21  const handle_t& itf,
22  uint32_t bd,
23  const l2_binding::l2_port_type_t& port_type)
24  : rpc_cmd(item)
25  , m_itf(itf)
26  , m_bd(bd)
27  , m_port_type(port_type)
28 {
29 }
30 
31 bool
32 bind_cmd::operator==(const bind_cmd& other) const
33 {
34  return ((m_itf == other.m_itf) && (m_bd == other.m_bd) &&
35  (m_port_type == other.m_port_type));
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.rx_sw_if_index = m_itf.value();
45  payload.bd_id = m_bd;
46  payload.shg = 0;
48  payload.port_type = L2_API_PORT_TYPE_BVI;
50  payload.port_type = L2_API_PORT_TYPE_UU_FWD;
51  else
52  payload.port_type = L2_API_PORT_TYPE_NORMAL;
53 
54  payload.enable = 1;
55 
56  VAPI_CALL(req.execute());
57 
58  return (wait());
59 }
60 
61 std::string
63 {
64  std::ostringstream s;
65  s << "L2-bind: " << m_hw_item.to_string() << " itf:" << m_itf.to_string()
66  << " bd:" << m_bd << " port-type:" << m_port_type.to_string();
67 
68  return (s.str());
69 }
70 
72  const handle_t& itf,
73  uint32_t bd,
74  const l2_binding::l2_port_type_t& port_type)
75  : rpc_cmd(item)
76  , m_itf(itf)
77  , m_bd(bd)
78  , m_port_type(port_type)
79 {
80 }
81 
82 bool
84 {
85  return ((m_itf == other.m_itf) && (m_bd == other.m_bd) &&
86  (m_port_type == other.m_port_type));
87 }
88 
89 rc_t
91 {
92  msg_t req(con.ctx(), std::ref(*this));
93 
94  auto& payload = req.get_request().get_payload();
95  payload.rx_sw_if_index = m_itf.value();
96  payload.bd_id = m_bd;
97  payload.shg = 0;
99  payload.port_type = L2_API_PORT_TYPE_BVI;
100  else if (m_port_type == l2_binding::l2_port_type_t::L2_PORT_TYPE_UU_FWD)
101  payload.port_type = L2_API_PORT_TYPE_UU_FWD;
102  else
103  payload.port_type = L2_API_PORT_TYPE_NORMAL;
104 
105  payload.enable = 0;
106 
107  VAPI_CALL(req.execute());
108 
109  wait();
111 
112  return (rc_t::OK);
113 }
114 
115 std::string
117 {
118  std::ostringstream s;
119  s << "L2-unbind: " << m_hw_item.to_string() << " itf:" << m_itf.to_string()
120  << " bd:" << m_bd << " port-type:" << m_port_type;
121 
122  return (s.str());
123 }
124 
126  const handle_t& itf,
127  uint16_t tag)
128  : rpc_cmd(item)
129  , m_itf(itf)
130  , m_tag(tag)
131 {
132 }
133 
134 bool
136 {
137  return (
138  (m_hw_item.data() == other.m_hw_item.data() && m_itf == other.m_itf) &&
139  (m_tag == other.m_tag));
140 }
141 
142 rc_t
144 {
145  msg_t req(con.ctx(), std::ref(*this));
146 
147  auto& payload = req.get_request().get_payload();
148  payload.sw_if_index = m_itf.value();
149  payload.vtr_op = m_hw_item.data().value();
150  payload.push_dot1q = 1;
151  payload.tag1 = m_tag;
152 
153  VAPI_CALL(req.execute());
154 
155  return (wait());
156 }
157 
158 std::string
160 {
161  std::ostringstream s;
162  s << "L2-set-vtr-op: " << m_hw_item.to_string()
163  << " itf:" << m_itf.to_string() << " tag:" << m_tag;
164 
165  return (s.str());
166 }
167 
168 }; // namespace l2_binding_cmds
169 }; // namespace VOM
170 
171 /*
172  * fd.io coding-style-patch-verification: ON
173  *
174  * Local Variables:
175  * eval: (c-set-style "mozilla")
176  * End:
177  */
static const rc_t NOOP
The HW write/update action was/has not been attempted.
Definition: types.hpp:104
std::string to_string() const
convert to string format for debug purposes
int value() const
Return the value of the enum - same as integer conversion.
Definition: enum_base.hpp:67
uint32_t value() const
get the value of the handle
Definition: types.cpp:93
bool operator==(const set_vtr_op_cmd &i) const
Comparison operator - only used for UT.
Error codes that VPP will return during a HW write.
Definition: types.hpp:89
std::string to_string() const
convert to string format for debug purposes
Definition: hw.hpp:161
T & data()
Return the data read/written.
Definition: hw.hpp:109
std::string to_string() const
convert to string format for debug purposes
Definition: types.cpp:69
A functor class that binds L2 configuration to an interface.
rc_t issue(connection &con)
Issue the command to VPP/HW.
A representation of the connection to VPP.
Definition: connection.hpp:33
A base class for all RPC commands to VPP.
Definition: rpc_cmd.hpp:40
unbind_cmd(HW::item< bool > &item, const handle_t &itf, uint32_t bd, const l2_binding::l2_port_type_t &port_type)
Constructor.
static const l2_port_type_t L2_PORT_TYPE_UU_FWD
Definition: l2_binding.hpp:66
#define VAPI_CALL(_stmt)
Convenince wrapper macro for error handling in VAPI sends.
Definition: types.hpp:29
rc_t issue(connection &con)
Issue the command to VPP/HW.
A type declaration of an interface handle in VPP.
Definition: types.hpp:233
static const l2_port_type_t L2_PORT_TYPE_BVI
Definition: l2_binding.hpp:65
bool operator==(const unbind_cmd &i) const
Comparison operator - only used for UT.
A cmd class that Unbinds L2 configuration from an interface.
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
bool operator==(const bind_cmd &i) const
Comparison operator - only used for UT.
vapi::Connection & ctx()
Retrun the VAPI context the commands will use.
Definition: connection.cpp:49
bind_cmd(HW::item< bool > &item, const handle_t &itf, uint32_t bd, const l2_binding::l2_port_type_t &port_type)
Constructor.
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
set_vtr_op_cmd(HW::item< l2_binding::l2_vtr_op_t > &item, const handle_t &itf, uint16_t tag)
Constructor.
A cmd class sets the VTR operation.
const std::string & to_string() const
convert to string format for debug purposes
Definition: enum_base.hpp:36
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
HW::item< bool > & item()
return the HW item the command updates
Definition: rpc_cmd.hpp:66
vapi::Sw_interface_set_l2_bridge msg_t
convenient typedef
Definition: rpc_cmd.hpp:46
rc_t issue(connection &con)
Issue the command to VPP/HW.