FD.io VPP  v19.04.2-12-g66b1689
Vector Packet Processing
tap_interface_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 
18 #include <vapi/tapv2.api.vapi.hpp>
19 
21 
22 namespace VOM {
23 namespace tap_interface_cmds {
24 /*
25  * TAPV2
26  */
28  const std::string& name,
29  const route::prefix_t& prefix,
30  const l2_address_t& l2_address)
31  : interface::create_cmd<vapi::Tap_create_v2>(item, name)
32  , m_prefix(prefix)
33  , m_l2_address(l2_address)
34 {
35 }
36 
37 rc_t
39 {
40  msg_t req(con.ctx(), std::ref(*this));
41 
42  auto& payload = req.get_request().get_payload();
43  memset(payload.host_if_name, 0, sizeof(payload.host_if_name));
44  memcpy(payload.host_if_name, m_name.c_str(),
45  std::min(m_name.length(), sizeof(payload.host_if_name)));
46  payload.host_if_name_set = 1;
47 
48  if (m_prefix != route::prefix_t::ZERO) {
49  if (m_prefix.address().is_v6()) {
50  m_prefix.to_vpp(&payload.host_ip6_addr_set, payload.host_ip6_addr,
51  &payload.host_ip6_prefix_len);
52  } else {
53  m_prefix.to_vpp(&payload.host_ip4_addr_set, payload.host_ip4_addr,
54  &payload.host_ip4_prefix_len);
55  payload.host_ip4_addr_set = 1;
56  }
57  }
58 
59  if (m_l2_address != l2_address_t::ZERO) {
60  m_l2_address.to_bytes(payload.host_mac_addr, 6);
61  payload.host_mac_addr_set = 1;
62  }
63 
64  payload.id = 0xffffffff;
65  payload.use_random_mac = 1;
66  payload.tx_ring_sz = 1024;
67  payload.rx_ring_sz = 1024;
68 
69  VAPI_CALL(req.execute());
70 
71  wait();
72 
73  if (m_hw_item.rc() == rc_t::OK) {
75  }
76 
77  return rc_t::OK;
78 }
79 
80 std::string
82 {
83  std::ostringstream s;
84  s << "tapv2-intf-create: " << m_hw_item.to_string()
85  << " ip-prefix:" << m_prefix.to_string();
86 
87  return (s.str());
88 }
89 
91  : interface::delete_cmd<vapi::Tap_delete_v2>(item)
92 {
93 }
94 
95 rc_t
97 {
98 
99  msg_t req(con.ctx(), std::ref(*this));
100 
101  auto& payload = req.get_request().get_payload();
102 
103  payload.sw_if_index = m_hw_item.data().value();
104 
105  VAPI_CALL(req.execute());
106 
107  wait();
109 
111  return rc_t::OK;
112 }
113 std::string
115 {
116  std::ostringstream s;
117  s << "tapv2-itf-delete: " << m_hw_item.to_string();
118 
119  return (s.str());
120 }
121 
123 {
124 }
125 
126 bool
128 {
129  return (true);
130 }
131 
132 rc_t
134 {
135  m_dump.reset(new msg_t(con.ctx(), std::ref(*this)));
136 
137  VAPI_CALL(m_dump->execute());
138 
139  wait();
140 
141  return rc_t::OK;
142 }
143 
144 std::string
146 {
147  return ("tapv2-itf-dump");
148 }
149 
150 } // namespace tap_interface_cmds
151 } // namespace VOM
152 
153 /*
154  * fd.io coding-style-patch-verification: ON
155  *
156  * Local Variables:
157  * eval: (c-set-style "mozilla")
158  * End:
159  */
static const rc_t NOOP
The HW write/update action was/has not been attempted.
Definition: types.hpp:104
void remove_interface()
remove the deleted interface from the DB
Definition: interface.hpp:407
uint32_t value() const
get the value of the handle
Definition: types.cpp:93
void to_bytes(uint8_t *array, uint8_t len) const
Convert to byte array.
Definition: types.cpp:208
rc_t issue(connection &con)
Issue the command to VPP/HW.
Error codes that VPP will return during a HW write.
Definition: types.hpp:89
static const l2_address_t ZERO
An all 0&#39;s L2 address.
Definition: types.hpp:358
std::string to_string() const
convert to string format for debug purposes
Definition: hw.hpp:161
Type def of a L2 address as read from VPP.
Definition: types.hpp:339
rc_t wait()
Wait on the commands promise.
Definition: rpc_cmd.hpp:82
T & data()
Return the data read/written.
Definition: hw.hpp:109
Forward declarations.
Definition: vapi.hpp:44
std::string to_string() const
convert to string format for debug purposes
A cmd class that Dumps all the Vpp Interfaces.
rc_t rc() const
Get the HW return code.
Definition: hw.hpp:119
const std::string & m_name
The name of the interface to be created.
Definition: interface.hpp:364
A representation of the connection to VPP.
Definition: connection.hpp:33
rc_t issue(connection &con)
Issue the command to VPP/HW.
std::string to_string() const
convert to string format for debug purposes
Definition: prefix.cpp:183
bool operator==(const tapv2_dump_cmd &i) const
Comparison operator - only used for UT.
u8 name[64]
Definition: memclnt.api:152
#define VAPI_CALL(_stmt)
Convenince wrapper macro for error handling in VAPI sends.
Definition: types.hpp:29
void to_vpp(uint8_t *is_ip6, uint8_t *addr, uint8_t *len) const
Convert the prefix into VPP API parameters.
Definition: prefix.cpp:251
A representation of an interface in VPP.
Definition: interface.hpp:41
static const rc_t OK
The HW write was successfull.
Definition: types.hpp:109
DEFINE_VAPI_MSG_IDS_TAPV2_API_JSON
tapv2_delete_cmd(HW::item< handle_t > &item)
vapi::Connection & ctx()
Retrun the VAPI context the commands will use.
Definition: connection.cpp:49
std::string to_string() const
convert to string format for debug purposes
void insert_interface()
add the created interface to the DB
Definition: interface.hpp:338
The VPP Object Model (VOM) library.
Definition: acl_binding.cpp:19
rc_t issue(connection &con)
Issue the command to VPP/HW.
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
static const prefix_t ZERO
The all Zeros prefix.
Definition: prefix.hpp:166
typedef prefix
Definition: ip_types.api:35
std::string to_string() const
convert to string format for debug purposes
const boost::asio::ip::address & address() const
Get the address.
Definition: prefix.cpp:149
tapv2_create_cmd(HW::item< handle_t > &item, const std::string &name, const route::prefix_t &prefix, const l2_address_t &l2_address)
A prefix defintion.
Definition: prefix.hpp:92
HW::item< handle_t > & m_hw_item
A reference to an object&#39;s HW::item that the command will update.
Definition: rpc_cmd.hpp:134
HW::item< handle_t > & item()
return the HW item the command updates
Definition: rpc_cmd.hpp:66
vapi::Tap_create_v2 msg_t
convenient typedef
Definition: rpc_cmd.hpp:46