FD.io VPP  v18.01.1-37-g7ea3975
Vector Packet Processing
nat_static_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/nat_static_cmds.hpp"
17 
19 
20 namespace VOM {
21 namespace nat_static_cmds {
22 
25  const boost::asio::ip::address_v4& inside,
26  const boost::asio::ip::address_v4& outside)
27  : rpc_cmd(item)
28  , m_id(id)
29  , m_inside(inside)
30  , m_outside(outside)
31 {
32 }
33 
34 bool
36 {
37  return ((m_id == other.m_id) && (m_inside == other.m_inside) &&
38  (m_outside == other.m_outside));
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_add = 1;
48  payload.addr_only = 1;
49  payload.local_port = 0;
50  payload.external_port = 0;
51  payload.vrf_id = m_id;
52  payload.external_sw_if_index = ~0;
53  to_bytes(m_inside, payload.local_ip_address);
54  to_bytes(m_outside, payload.external_ip_address);
55 
56  VAPI_CALL(req.execute());
57 
58  m_hw_item.set(wait());
59 
60  return rc_t::OK;
61 }
62 
63 std::string
65 {
66  std::ostringstream s;
67  s << "nat-44-static-create: " << m_hw_item.to_string() << " table:" << m_id
68  << " inside:" << m_inside.to_string()
69  << " outside:" << m_outside.to_string();
70 
71  return (s.str());
72 }
73 
76  const boost::asio::ip::address_v4& inside,
77  const boost::asio::ip::address_v4& outside)
78  : rpc_cmd(item)
79  , m_id(id)
80  , m_inside(inside)
81  , m_outside(outside)
82 {
83 }
84 
85 bool
87 {
88  return ((m_id == other.m_id) && (m_inside == other.m_inside) &&
89  (m_outside == other.m_outside));
90 }
91 
92 rc_t
94 {
95  msg_t req(con.ctx(), std::ref(*this));
96 
97  auto& payload = req.get_request().get_payload();
98  payload.is_add = 0;
99  payload.addr_only = 1;
100  payload.local_port = 0;
101  payload.external_port = 0;
102  payload.vrf_id = m_id;
103  payload.external_sw_if_index = ~0;
104  to_bytes(m_inside, payload.local_ip_address);
105  to_bytes(m_outside, payload.external_ip_address);
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 << "nat-44-static-delete: " << m_hw_item.to_string() << " table:" << m_id
120  << " inside:" << m_inside.to_string()
121  << " outside:" << m_outside.to_string();
122 
123  return (s.str());
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 ("nat-static-dump");
148 }
149 
150 }; // namespace nat_static_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  */
std::string to_string() const
convert to string format for debug purposes
A cmd class that deletes a NAT 44 static mapping.
uint32_t table_id_t
type def the table-id
Definition: prefix.hpp:81
static const rc_t NOOP
The HW write/update action was/has not been attempted.
Definition: types.hpp:101
HW::item< bool > & m_hw_item
A reference to an object&#39;s HW::item that the command will update.
Definition: rpc_cmd.hpp:131
A command class that creates NAT 44 static mapping.
rc_t issue(connection &con)
Issue the command to VPP/HW.
create_44_cmd(HW::item< bool > &item, route::table_id_t id, const boost::asio::ip::address_v4 &inside, const boost::asio::ip::address_v4 &outside)
Constructor.
Error codes that VPP will return during a HW write.
Definition: types.hpp:84
std::string to_string() const
convert to string format for debug purposes
bool operator==(const dump_44_cmd &i) const
Comparison operator - only used for UT.
std::string to_string() const
convert to string format for debug purposes
Definition: hw.hpp:160
bool operator==(const delete_44_cmd &i) const
Comparison operator - only used for UT.
void to_bytes(const boost::asio::ip::address_v6 &addr, uint8_t *array)
Definition: prefix.cpp:205
A representation of the connection to VPP.
Definition: connection.hpp:33
std::string to_string() const
convert to string format for debug purposes
HW::item< bool > & item()
return the HW item the command updates
Definition: rpc_cmd.hpp:64
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
delete_44_cmd(HW::item< bool > &item, route::table_id_t id, const boost::asio::ip::address_v4 &inside, const boost::asio::ip::address_v4 &outside)
Constructor.
rc_t issue(connection &con)
Issue the command to VPP/HW.
static const rc_t OK
The HW write was successfull.
Definition: types.hpp:106
bool operator==(const create_44_cmd &i) const
Comparison operator - only used for UT.
A cmd class that Dumps all the nat_statics.
vapi::Connection & ctx()
Retrun the VAPI context the commands will use.
Definition: connection.cpp:51
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:124
vapi::Nat44_add_del_static_mapping msg_t
convenient typedef
Definition: rpc_cmd.hpp:44
DEFINE_VAPI_MSG_IDS_NAT_API_JSON