2 * det44.h - deterministic NAT definitions
4 * Copyright (c) 2020 Cisco and/or its affiliates.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
20 * @brief Deterministic NAT (CGN) definitions
23 #ifndef __included_det44_h__
24 #define __included_det44_h__
26 #include <vnet/vnet.h>
27 #include <vnet/ip/ip.h>
28 #include <vnet/ethernet/ethernet.h>
29 #include <vnet/ip/icmp46_packet.h>
30 #include <vnet/api_errno.h>
31 #include <vnet/fib/fib_source.h>
32 #include <vppinfra/dlist.h>
33 #include <vppinfra/error.h>
34 #include <vlibapi/api.h>
36 #include <vnet/fib/fib_table.h>
37 #include <vnet/fib/ip4_fib.h>
38 #include <vnet/ip/reass/ip4_sv_reass.h>
40 #include <nat/lib/lib.h>
41 #include <nat/lib/inlines.h>
44 #define foreach_det44_session_state \
45 _(0, UNKNOWN, "unknown") \
46 _(1, UDP_ACTIVE, "udp-active") \
47 _(2, TCP_SYN_SENT, "tcp-syn-sent") \
48 _(3, TCP_ESTABLISHED, "tcp-established") \
49 _(4, TCP_FIN_WAIT, "tcp-fin-wait") \
50 _(5, TCP_CLOSE_WAIT, "tcp-close-wait") \
51 _(6, TCP_CLOSING, "tcp-closing") \
52 _(7, TCP_LAST_ACK, "tcp-last-ack") \
53 _(8, TCP_CLOSED, "tcp-closed") \
54 _(9, ICMP_ACTIVE, "icmp-active")
58 #define _(v, N, s) DET44_SESSION_##N = v,
59 foreach_det44_session_state
61 } det44_session_state_t;
63 #define DET44_SES_PER_USER 1000
73 u16 src_port, dst_port;
78 u32 cached_sw_if_index;
79 u32 cached_ip4_address;
82 typedef struct nat_timeouts_s
96 /* deterministic session outside key */
103 ip4_address_t ext_host_addr;
109 } snat_det_out_key_t;
113 /* Inside network port */
115 /* Outside network address and port */
116 snat_det_out_key_t out;
121 } snat_det_session_t;
125 /* inside IP address range */
126 ip4_address_t in_addr;
128 /* outside IP address range */
129 ip4_address_t out_addr;
131 /* inside IP addresses / outside IP addresses */
133 /* number of ports available to internal host */
135 /* session counter */
137 /* vector of sessions */
138 snat_det_session_t *sessions;
161 typedef struct det44_main_s
163 det44_config_t config;
165 u32 outside_fib_index;
166 u32 inside_fib_index;
168 /* Vector of outside fibs */
169 det44_fib_t *outside_fibs;
171 fib_source_t fib_src_hi;
172 fib_source_t fib_src_low;
174 u32 out2in_node_index;
175 u32 in2out_node_index;
177 /* Deterministic NAT mappings */
178 snat_det_map_t *det_maps;
180 /* TCP MSS clamping */
183 /* Protocol timeouts */
184 nat_timeouts_t timeouts;
186 /* Expire walk process node index */
187 u32 expire_walk_node_index;
191 /* API message ID base */
195 vlib_log_class_t log_class;
197 det44_interface_t *interfaces;
200 ip4_main_t *ip4_main;
202 vnet_main_t *vnet_main;
206 extern det44_main_t det44_main;
209 #define det44_log_err(...) \
210 vlib_log(VLIB_LOG_LEVEL_ERR, det44_main.log_class, __VA_ARGS__)
211 #define det44_log_warn(...) \
212 vlib_log(VLIB_LOG_LEVEL_WARNING, det44_main.log_class, __VA_ARGS__)
213 #define det44_log_notice(...) \
214 vlib_log(VLIB_LOG_LEVEL_NOTICE, det44_main.log_class, __VA_ARGS__)
215 #define det44_log_info(...) \
216 vlib_log(VLIB_LOG_LEVEL_INFO, det44_main.log_class, __VA_ARGS__)
217 #define det44_log_debug(...)\
218 vlib_log(VLIB_LOG_LEVEL_DEBUG, det44_main.log_class, __VA_ARGS__)
220 /* Deterministic NAT interface flags */
221 #define DET44_INTERFACE_FLAG_IS_INSIDE 1
222 #define DET44_INTERFACE_FLAG_IS_OUTSIDE 2
224 /** \brief Check if Deterministic NAT interface is inside.
225 @param i Deterministic NAT interface
226 @return 1 if inside interface
228 #define det44_interface_is_inside(i) i->flags & DET44_INTERFACE_FLAG_IS_INSIDE
230 /** \brief Check if Deterministic NAT interface is outside.
231 @param i Deterministic NAT interface
232 @return 1 if outside interface
234 #define det44_interface_is_outside(i) i->flags & DET44_INTERFACE_FLAG_IS_OUTSIDE
236 static_always_inline u8
239 det44_main_t *dm = &det44_main;
243 extern vlib_node_registration_t det44_in2out_node;
244 extern vlib_node_registration_t det44_out2in_node;
246 int det44_plugin_enable ();
247 int det44_plugin_disable ();
249 int det44_interface_add_del (u32 sw_if_index, u8 is_inside, int is_del);
251 int det44_set_timeouts (nat_timeouts_t * timeouts);
252 nat_timeouts_t det44_get_timeouts ();
253 void det44_reset_timeouts ();
255 /* format functions */
256 format_function_t format_det_map_ses;
258 int snat_det_add_map (ip4_address_t * in_addr, u8 in_plen,
259 ip4_address_t * out_addr, u8 out_plen, int is_add);
261 /* icmp session match functions */
262 u32 icmp_match_out2in_det (vlib_node_runtime_t * node,
263 u32 thread_index, vlib_buffer_t * b0,
264 ip4_header_t * ip0, ip4_address_t * addr,
265 u16 * port, u32 * fib_index,
266 nat_protocol_t * proto, void *d, void *e,
267 u8 * dont_translate);
268 u32 icmp_match_in2out_det (vlib_node_runtime_t * node,
269 u32 thread_index, vlib_buffer_t * b0,
270 ip4_header_t * ip0, ip4_address_t * addr,
271 u16 * port, u32 * fib_index,
272 nat_protocol_t * proto, void *d, void *e,
273 u8 * dont_translate);
274 u32 det44_icmp_in2out (vlib_buffer_t * b0, ip4_header_t * ip0,
275 icmp46_header_t * icmp0, u32 sw_if_index0,
276 u32 rx_fib_index0, vlib_node_runtime_t * node,
277 u32 next0, u32 thread_index, void *d, void *e);
278 u32 det44_icmp_out2in (vlib_buffer_t * b0, ip4_header_t * ip0,
279 icmp46_header_t * icmp0, u32 sw_if_index0,
280 u32 rx_fib_index0, vlib_node_runtime_t * node,
281 u32 next0, u32 thread_index, void *d, void *e);
283 static_always_inline int
284 is_addr_in_net (ip4_address_t * addr, ip4_address_t * net, u8 plen)
286 if (net->as_u32 == (addr->as_u32 & ip4_main.fib_masks[plen]))
291 static_always_inline snat_det_map_t *
292 snat_det_map_by_user (ip4_address_t * user_addr)
294 det44_main_t *dm = &det44_main;
297 pool_foreach (mp, dm->det_maps,
299 if (is_addr_in_net(user_addr, &mp->in_addr, mp->in_plen))
306 static_always_inline snat_det_map_t *
307 snat_det_map_by_out (ip4_address_t * out_addr)
309 det44_main_t *dm = &det44_main;
312 pool_foreach (mp, dm->det_maps,
314 if (is_addr_in_net(out_addr, &mp->out_addr, mp->out_plen))
321 static_always_inline void
322 snat_det_forward (snat_det_map_t * dm, ip4_address_t * in_addr,
323 ip4_address_t * out_addr, u16 * lo_port)
325 u32 in_offset, out_offset;
327 in_offset = clib_net_to_host_u32 (in_addr->as_u32) -
328 clib_net_to_host_u32 (dm->in_addr.as_u32);
329 out_offset = in_offset / dm->sharing_ratio;
331 clib_host_to_net_u32 (clib_net_to_host_u32 (dm->out_addr.as_u32) +
333 *lo_port = 1024 + dm->ports_per_host * (in_offset % dm->sharing_ratio);
336 static_always_inline void
337 snat_det_reverse (snat_det_map_t * dm, ip4_address_t * out_addr, u16 out_port,
338 ip4_address_t * in_addr)
340 u32 in_offset1, in_offset2, out_offset;
342 out_offset = clib_net_to_host_u32 (out_addr->as_u32) -
343 clib_net_to_host_u32 (dm->out_addr.as_u32);
344 in_offset1 = out_offset * dm->sharing_ratio;
345 in_offset2 = (out_port - 1024) / dm->ports_per_host;
347 clib_host_to_net_u32 (clib_net_to_host_u32 (dm->in_addr.as_u32) +
348 in_offset1 + in_offset2);
351 static_always_inline u32
352 snat_det_user_ses_offset (ip4_address_t * addr, u8 plen)
354 return (clib_net_to_host_u32 (addr->as_u32) & pow2_mask (32 - plen)) *
358 static_always_inline snat_det_session_t *
359 snat_det_get_ses_by_out (snat_det_map_t * dm, ip4_address_t * in_addr,
365 user_offset = snat_det_user_ses_offset (in_addr, dm->in_plen);
366 for (i = 0; i < DET44_SES_PER_USER; i++)
368 if (dm->sessions[i + user_offset].out.as_u64 == out_key)
369 return &dm->sessions[i + user_offset];
375 static_always_inline snat_det_session_t *
376 snat_det_find_ses_by_in (snat_det_map_t * dm, ip4_address_t * in_addr,
377 u16 in_port, snat_det_out_key_t out_key)
379 snat_det_session_t *ses;
383 user_offset = snat_det_user_ses_offset (in_addr, dm->in_plen);
384 for (i = 0; i < DET44_SES_PER_USER; i++)
386 ses = &dm->sessions[i + user_offset];
387 if (ses->in_port == in_port &&
388 ses->out.ext_host_addr.as_u32 == out_key.ext_host_addr.as_u32 &&
389 ses->out.ext_host_port == out_key.ext_host_port)
390 return &dm->sessions[i + user_offset];
396 static_always_inline snat_det_session_t *
397 snat_det_ses_create (u32 thread_index, snat_det_map_t * dm,
398 ip4_address_t * in_addr, u16 in_port,
399 snat_det_out_key_t * out)
404 user_offset = snat_det_user_ses_offset (in_addr, dm->in_plen);
406 for (i = 0; i < DET44_SES_PER_USER; i++)
408 if (!dm->sessions[i + user_offset].in_port)
410 if (clib_atomic_bool_cmp_and_swap
411 (&dm->sessions[i + user_offset].in_port, 0, in_port))
413 dm->sessions[i + user_offset].out.as_u64 = out->as_u64;
414 dm->sessions[i + user_offset].state = DET44_SESSION_UNKNOWN;
415 dm->sessions[i + user_offset].expire = 0;
416 clib_atomic_add_fetch (&dm->ses_num, 1);
417 return &dm->sessions[i + user_offset];
423 /*snat_ipfix_logging_max_entries_per_user (thread_index,
429 static_always_inline void
430 snat_det_ses_close (snat_det_map_t * dm, snat_det_session_t * ses)
432 if (clib_atomic_bool_cmp_and_swap (&ses->in_port, ses->in_port, 0))
435 clib_atomic_add_fetch (&dm->ses_num, -1);
439 clib_error_t *det44_api_hookup (vlib_main_t * vm);
441 #endif /* __included_det44_h__ */
444 * fd.io coding-style-patch-verification: ON
447 * eval: (c-set-style "gnu")