FD.io VPP  v18.04-17-g3a0d853
Vector Packet Processing
acl_ethertype_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 
17 
18 namespace VOM {
19 namespace ACL {
20 namespace acl_ethertype_cmds {
21 
23  const handle_t& itf,
25  : rpc_cmd(item)
26  , m_itf(itf)
27  , m_le(le)
28 {
29 }
30 
31 bool
32 bind_cmd::operator==(const bind_cmd& other) const
33 {
34  return (m_itf == other.m_itf && m_le == other.m_le);
35 }
36 
37 rc_t
39 {
40  msg_t req(con.ctx(), m_le.size(), std::ref(*this));
41  uint32_t i = 0;
42  uint8_t n_input = 0;
43 
44  auto& payload = req.get_request().get_payload();
45  payload.sw_if_index = m_itf.value();
46  payload.count = m_le.size();
47 
48  auto it = m_le.cbegin();
49  while (it != m_le.cend()) {
50  payload.whitelist[i] = it->getEthertype();
51  if (it->getDirection() == direction_t::INPUT)
52  n_input++;
53  ++it;
54  ++i;
55  }
56 
57  payload.n_input = n_input;
58 
59  VAPI_CALL(req.execute());
60 
61  m_hw_item.set(wait());
62 
63  return rc_t::OK;
64 }
65 
66 std::string
68 {
69  std::ostringstream s;
70  s << "ACL-Ethertype: " << m_hw_item.to_string()
71  << " itf:" << m_itf.to_string() << " ethertype-rules:";
72  auto it = m_le.cbegin();
73  while (it != m_le.cend()) {
74  s << it->to_string();
75  ++it;
76  }
77 
78  s << " rules-size:" << m_le.size();
79 
80  return (s.str());
81 }
82 
84  : rpc_cmd(item)
85  , m_itf(itf)
86 {
87 }
88 
89 bool
91 {
92  return (m_itf == other.m_itf);
93 }
94 
95 rc_t
97 {
98  msg_t req(con.ctx(), 0, std::ref(*this));
99 
100  auto& payload = req.get_request().get_payload();
101  payload.sw_if_index = m_itf.value();
102  payload.count = 0;
103 
104  payload.n_input = 0;
105 
106  VAPI_CALL(req.execute());
107 
108  wait();
110 
111  return rc_t::OK;
112 }
113 
114 std::string
116 {
117  std::ostringstream s;
118  s << "ACL-Ethertype-Unbind: " << m_hw_item.to_string()
119  << " itf:" << m_itf.to_string();
120  return (s.str());
121 }
122 
124  : m_itf(hdl)
125 {
126 }
127 
129  : m_itf(d.m_itf)
130 {
131 }
132 
133 bool
134 dump_cmd::operator==(const dump_cmd& other) const
135 {
136  return (true);
137 }
138 
139 rc_t
141 {
142  m_dump.reset(new msg_t(con.ctx(), std::ref(*this)));
143 
144  auto& payload = m_dump->get_request().get_payload();
145  payload.sw_if_index = m_itf.value();
146 
147  VAPI_CALL(m_dump->execute());
148 
149  wait();
150 
151  return rc_t::OK;
152 }
153 
154 std::string
156 {
157  return ("acl-ethertype-dump");
158 }
159 }; // namespace acl_ethertype_cmds
160 }; // namespace ACL
161 }; // namespace VOM
162 
163 /*
164  * fd.io coding-style-patch-verification: ON
165  *
166  * Local Variables:
167  * eval: (c-set-style "mozilla")
168  * End:
169  */
rc_t issue(connection &con)
Issue the command to VPP/HW.
static const rc_t NOOP
The HW write/update action was/has not been attempted.
Definition: types.hpp:107
HW::item< bool > & m_hw_item
A reference to an object&#39;s HW::item that the command will update.
Definition: rpc_cmd.hpp:135
std::string to_string() const
convert to string format for debug purposes
uint32_t value() const
get the value of the handle
Definition: types.cpp:96
int i
Error codes that VPP will return during a HW write.
Definition: types.hpp:90
static const direction_t INPUT
Permit Direction.
Definition: types.hpp:154
vapi::Acl_interface_etype_whitelist_dump msg_t
Definition: dump_cmd.hpp:46
std::string to_string() const
convert to string format for debug purposes
Definition: hw.hpp:160
A command class that binds the ethertype list to the interface.
A cmd class that Dumps all the acl ethertypes on given interface.
std::string to_string() const
convert to string format for debug purposes
Definition: types.cpp:72
A representation of the connection to VPP.
Definition: connection.hpp:33
std::string to_string() const
convert to string format for debug purposes
unbind_cmd(HW::item< bool > &item, const handle_t &itf)
Constructor.
HW::item< bool > & item()
return the HW item the command updates
Definition: rpc_cmd.hpp:64
std::string to_string() const
convert to string format for debug purposes
A base class for all RPC commands to VPP.
Definition: rpc_cmd.hpp:38
#define VAPI_CALL(_stmt)
Convenince wrapper macro for error handling in VAPI sends.
Definition: types.hpp:29
A command class that unbinds the ethertype list to the interface.
std::multiset< ethertype_rule_t > ethertype_rules_t
The ethertype container.
rc_t issue(connection &con)
Issue the command to VPP/HW.
A type declaration of an interface handle in VPP.
Definition: types.hpp:236
static const rc_t OK
The HW write was successfull.
Definition: types.hpp:112
bind_cmd(HW::item< bool > &item, const handle_t &itf, const acl_ethertype::ethertype_rules_t &le)
Constructor.
rc_t wait()
Wait for the issue of the command to complete.
Definition: dump_cmd.hpp:93
vapi::Connection & ctx()
Retrun the VAPI context the commands will use.
Definition: connection.cpp:49
bool operator==(const unbind_cmd &i) const
Comparison operator - only used for UT.
The VPP Object Model (VOM) library.
Definition: acl_binding.cpp:19
bool operator==(const bind_cmd &i) const
Comparison operator - only used for UT.
void set(const rc_t &rc)
Set the HW return code - should only be called from the family of Command objects.
Definition: hw.hpp:124
std::unique_ptr< vapi::Acl_interface_etype_whitelist_dump > m_dump
The VAPI event registration.
Definition: dump_cmd.hpp:143
rc_t issue(connection &con)
Issue the command to VPP/HW.
vapi::Acl_interface_set_etype_whitelist msg_t
convenient typedef
Definition: rpc_cmd.hpp:44
bool operator==(const dump_cmd &i) const
Comparison operator - only used for UT.