FD.io VPP  v18.04-17-g3a0d853
Vector Packet Processing
nat_binding.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_binding.hpp"
17 #include "vom/cmd.hpp"
18 #include "vom/nat_binding_cmds.hpp"
20 
21 namespace VOM {
22 singular_db<const nat_binding::key_t, nat_binding> nat_binding::m_db;
23 
24 nat_binding::event_handler nat_binding::m_evh;
25 
26 const nat_binding::zone_t nat_binding::zone_t::INSIDE(0, "inside");
27 const nat_binding::zone_t nat_binding::zone_t::OUTSIDE(0, "outside");
28 
29 nat_binding::zone_t::zone_t(int v, const std::string s)
30  : enum_base(v, s)
31 {
32 }
35 {
36  if (is_inside)
37  return zone_t::INSIDE;
38  return zone_t::OUTSIDE;
39 }
40 
41 /**
42  * Construct a new object matching the desried state
43  */
45  const direction_t& dir,
46  const l3_proto_t& proto,
47  const zone_t& zone)
48  : m_binding(false)
49  , m_itf(itf.singular())
50  , m_dir(dir)
51  , m_proto(proto)
52  , m_zone(zone)
53 {
54 }
55 
57  : m_binding(o.m_binding)
58  , m_itf(o.m_itf)
59  , m_dir(o.m_dir)
60  , m_proto(o.m_proto)
61  , m_zone(o.m_zone)
62 {
63 }
64 
66 {
67  sweep();
68  m_db.release(key(), this);
69 }
70 
73 {
74  return (make_tuple(m_itf->key(), m_dir, m_proto));
75 }
76 
77 bool
79 {
80  return ((key() == n.key()) && (m_zone == n.m_zone));
81 }
82 
83 void
84 nat_binding::sweep()
85 {
86  if (m_binding) {
87  if (direction_t::INPUT == m_dir) {
89  m_binding, m_itf->handle(), m_zone));
90  } else {
92  m_binding, m_itf->handle(), m_zone));
93  }
94  }
95  HW::write();
96 }
97 
98 void
99 nat_binding::replay()
100 {
101  if (m_binding) {
102  if (direction_t::INPUT == m_dir) {
104  m_binding, m_itf->handle(), m_zone));
105  } else {
107  m_binding, m_itf->handle(), m_zone));
108  }
109  }
110 }
111 
112 void
113 nat_binding::update(const nat_binding& desired)
114 {
115  /*
116  * the desired state is always that the interface should be created
117  */
118  if (!m_binding) {
119  if (direction_t::INPUT == m_dir) {
121  m_binding, m_itf->handle(), m_zone));
122  } else {
124  m_binding, m_itf->handle(), m_zone));
125  }
126  }
127 }
128 
129 std::string
131 {
132  std::ostringstream s;
133  s << "nat-binding:[" << m_itf->to_string()
134  << " direction:" << m_dir.to_string() << " proto:" << m_proto.to_string()
135  << " zone:" << m_zone.to_string() << "]";
136 
137  return (s.str());
138 }
139 
140 std::shared_ptr<nat_binding>
141 nat_binding::find_or_add(const nat_binding& temp)
142 {
143  return (m_db.find_or_add(temp.key(), temp));
144 }
145 
146 std::shared_ptr<nat_binding>
148 {
149  return (m_db.find(key));
150 }
151 
152 std::shared_ptr<nat_binding>
154 {
155  return find_or_add(*this);
156 }
157 
158 void
159 nat_binding::dump(std::ostream& os)
160 {
161  db_dump(m_db, os);
162 }
163 
164 std::ostream&
165 operator<<(std::ostream& os, const nat_binding::key_t& key)
166 {
167  os << "[" << std::get<0>(key) << ", " << std::get<1>(key) << ", "
168  << std::get<2>(key) << "]";
169 
170  return (os);
171 }
172 
173 nat_binding::event_handler::event_handler()
174 {
175  OM::register_listener(this);
176  inspect::register_handler({ "nat-binding" }, "NAT bindings", this);
177 }
178 
179 void
180 nat_binding::event_handler::handle_replay()
181 {
182  m_db.replay();
183 }
184 
185 void
186 nat_binding::event_handler::handle_populate(const client_db::key_t& key)
187 {
188  std::shared_ptr<nat_binding_cmds::dump_input_44_cmd> icmd =
189  std::make_shared<nat_binding_cmds::dump_input_44_cmd>();
190 
191  HW::enqueue(icmd);
192  HW::write();
193 
194  for (auto& record : *icmd) {
195  auto& payload = record.get_payload();
196 
197  std::shared_ptr<interface> itf = interface::find(payload.sw_if_index);
199  zone_t::from_vpp(payload.is_inside));
200  OM::commit(key, nb);
201  }
202 
203  std::shared_ptr<nat_binding_cmds::dump_output_44_cmd> ocmd =
204  std::make_shared<nat_binding_cmds::dump_output_44_cmd>();
205 
206  HW::enqueue(ocmd);
207  HW::write();
208 
209  for (auto& record : *ocmd) {
210  auto& payload = record.get_payload();
211 
212  std::shared_ptr<interface> itf = interface::find(payload.sw_if_index);
214  zone_t::from_vpp(payload.is_inside));
215  OM::commit(key, nb);
216  }
217 }
218 
220 nat_binding::event_handler::order() const
221 {
222  return (dependency_t::BINDING);
223 }
224 
225 void
226 nat_binding::event_handler::show(std::ostream& os)
227 {
228  db_dump(m_db, os);
229 }
230 }
231 
232 /*
233  * fd.io coding-style-patch-verification: ON
234  *
235  * Local Variables:
236  * eval: (c-set-style "mozilla")
237  * End:
238  */
~nat_binding()
Destructor.
Definition: nat_binding.cpp:65
static const zone_t OUTSIDE
Deny Zone.
Definition: nat_binding.hpp:56
void db_dump(const DB &db, std::ostream &os)
Print each of the objects in the DB into the stream provided.
A cmd class that unbinds a NAT configuration from an input interface.
A template base class for all enum types.
Definition: enum_base.hpp:30
const std::string key_t
In the opflex world each entity is known by a URI which can be converted into a string.
Definition: client_db.hpp:51
static std::shared_ptr< interface > find(const handle_t &h)
The the singular instance of the interface in the DB by handle.
Definition: interface.cpp:465
A functor class that binds a NAT configuration to an output interface.
static void register_handler(const std::vector< std::string > &cmds, const std::string &help, command_handler *ch)
Register a command handler for inspection.
Definition: inspect.cpp:85
static rc_t write()
Write/Execute all commands hitherto enqueued.
Definition: hw.cpp:236
An L3 protocol can be used to construct a prefix that is used to match packets are part of a route...
Definition: prefix.hpp:53
A Class representing the binding of an L2 interface to a bridge-domain and the properties of that bin...
Definition: nat_binding.hpp:30
static const direction_t INPUT
Permit Direction.
Definition: types.hpp:154
nat_binding(const interface &itf, const direction_t &dir, const l3_proto_t &proto, const zone_t &zone)
Construct a new object matching the desried state.
Definition: nat_binding.cpp:44
Feature Directions.
Definition: types.hpp:139
static const l3_proto_t IPV4
Definition: prefix.hpp:56
static const zone_t INSIDE
Permit Zone.
Definition: nat_binding.hpp:51
bool operator==(const nat_binding &n) const
Comparison operator - for UT.
Definition: nat_binding.cpp:78
const key_t key() const
Return the binding&#39;s key.
Definition: nat_binding.cpp:72
#define v
Definition: acl.c:495
zone_t(int v, const std::string s)
Constructor.
Definition: nat_binding.cpp:29
static void dump(std::ostream &os)
Dump all nat_bindings into the stream provided.
A functor class that binds a NAT configuration to an input interface.
A representation of an interface in VPP.
Definition: interface.hpp:41
std::string to_string() const
convert to string format for debug purposes
std::shared_ptr< nat_binding > singular() const
Return the &#39;singular instance&#39; of the L2 config that matches this object.
static rc_t commit(const client_db::key_t &key, const OBJ &obj)
Make the State in VPP reflect the expressed desired state.
Definition: om.hpp:202
dependency_t
There needs to be a strict order in which object types are read from VPP (at boot time) and replayed ...
Definition: types.hpp:43
static void enqueue(cmd *f)
Enqueue A command for execution.
Definition: hw.cpp:194
std::ostream & operator<<(std::ostream &os, const std::pair< direction_t, interface::key_t > &key)
Then L2/objects that bind to interfaces, BD, ACLS, etc.
The VPP Object Model (VOM) library.
Definition: acl_binding.cpp:19
static std::shared_ptr< nat_binding > find(const key_t &key)
Static function to find the bridge_domain in the model.
unsigned char u8
Definition: types.h:56
void show(char *chroot_path, int verbose)
Definition: svmtool.c:105
static const direction_t OUTPUT
Deny Direction.
Definition: types.hpp:159
const std::string & to_string() const
convert to string format for debug purposes
Definition: enum_base.hpp:36
std::tuple< interface::key_t, direction_t, l3_proto_t > key_t
The key for a NAT Binding.
Definition: nat_binding.hpp:66
A cmd class that unbinds a NAT configuration from an output interface.
static const zone_t & from_vpp(u8 is_inside)
Definition: nat_binding.cpp:34
static bool register_listener(listener *listener)
Register a listener of events.
Definition: om.cpp:127