FD.io VPP  v19.01.3-6-g70449b9b9
Vector Packet Processing
nat64.h
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  * @file
17  * @brief NAT64 global declarations
18  */
19 #ifndef __included_nat64_h__
20 #define __included_nat64_h__
21 
22 #include <nat/nat.h>
23 #include <nat/nat64_db.h>
24 
25 #define foreach_nat64_tcp_ses_state \
26  _(0, CLOSED, "closed") \
27  _(1, V4_INIT, "v4-init") \
28  _(2, V6_INIT, "v6-init") \
29  _(3, ESTABLISHED, "established") \
30  _(4, V4_FIN_RCV, "v4-fin-rcv") \
31  _(5, V6_FIN_RCV, "v6-fin-rcv") \
32  _(6, V6_FIN_V4_FIN_RCV, "v6-fin-v4-fin-rcv") \
33  _(7, TRANS, "trans")
34 
35 typedef enum
36 {
37 #define _(v, N, s) NAT64_TCP_STATE_##N = v,
39 #undef _
41 
42 enum
43 {
46 
47 typedef struct
48 {
54 
55 typedef struct
56 {
67 
68 typedef struct
69 {
70  /** Interface pool */
72 
73  /** Address pool vector */
75 
76  /** sw_if_indices whose interface addresses should be auto-added */
78 
79  /** Pref64 vector */
81 
82  /** BIB and session DB per thread */
84 
85  /** Worker handoff */
88 
89  /** Pool of static BIB entries to be added/deleted in worker threads */
91 
93 
94  /** config parameters */
99 
100  /** values of various timeouts */
105 
106  /* Total count of interfaces enabled */
108  /* The process node which orcherstrates the cleanup */
110 
111  /* counters/gauges */
114 
117 } nat64_main_t;
118 
119 extern nat64_main_t nat64_main;
122 
123 /**
124  * @brief Add/delete address to NAT64 pool.
125  *
126  * @param addr IPv4 address.
127  * @param vrf_id VRF id of tenant, ~0 means independent of VRF.
128  * @param is_add 1 if add, 0 if delete.
129  *
130  * @returns 0 on success, non-zero value otherwise.
131  */
132 int nat64_add_del_pool_addr (ip4_address_t * addr, u32 vrf_id, u8 is_add);
133 
134 /**
135  * @brief Call back function when walking addresses in NAT64 pool, non-zero
136  * return value stop walk.
137  */
139 
140 /**
141  * @brief Walk NAT64 pool.
142  *
143  * @param fn The function to invoke on each entry visited.
144  * @param ctx A context passed in the visit function.
145  */
147 
148 /**
149  * @brief NAT64 pool address from specific (DHCP addressed) interface.
150  *
151  * @param sw_if_index Index of the interface.
152  * @param is_add 1 if add, 0 if delete.
153  *
154  * @returns 0 on success, non-zero value otherwise.
155  */
157 
158 /**
159  * @brief Enable/disable NAT64 feature on the interface.
160  *
161  * @param sw_if_index Index of the interface.
162  * @param is_inside 1 if inside, 0 if outside.
163  * @param is_add 1 if add, 0 if delete.
164  *
165  * @returns 0 on success, non-zero value otherwise.
166  */
167 int nat64_add_del_interface (u32 sw_if_index, u8 is_inside, u8 is_add);
168 
169 /**
170  * @brief Call back function when walking interfaces with NAT64 feature,
171  * non-zero return value stop walk.
172  */
174 
175 /**
176  * @brief Walk NAT64 interfaces.
177  *
178  * @param fn The function to invoke on each entry visited.
179  * @param ctx A context passed in the visit function.
180  */
182 
183 /**
184  * @brief Initialize NAT64.
185  *
186  * @param vm vlib main.
187  *
188  * @return error code.
189  */
191 
192 /**
193  * @brief Add/delete static NAT64 BIB entry.
194  *
195  * @param in_addr Inside IPv6 address.
196  * @param out_addr Outside IPv4 address.
197  * @param in_port Inside port number.
198  * @param out_port Outside port number.
199  * @param proto L4 protocol.
200  * @param vrf_id VRF id of tenant.
201  * @param is_add 1 if add, 0 if delete.
202  *
203  * @returns 0 on success, non-zero value otherwise.
204  */
206  ip4_address_t * out_addr, u16 in_port,
207  u16 out_port, u8 proto, u32 vrf_id,
208  u8 is_add);
209 
210 /**
211  * @brief Alloce IPv4 address and port pair from NAT64 pool.
212  *
213  * @param fib_index FIB index of tenant.
214  * @param proto L4 protocol.
215  * @param addr Allocated IPv4 address.
216  * @param port Allocated port number.
217  * @param thread_index Thread index.
218  *
219  * @returns 0 on success, non-zero value otherwise.
220  */
222  ip4_address_t * addr, u16 * port,
223  u32 thread_index);
224 
225 /**
226  * @brief Set UDP session timeout.
227  *
228  * @param timeout Timeout value in seconds (if 0 reset to default value 300sec).
229  *
230  * @returns 0 on success, non-zero value otherwise.
231  */
232 int nat64_set_udp_timeout (u32 timeout);
233 
234 /**
235  * @brief Get UDP session timeout.
236  *
237  * @returns UDP session timeout in seconds.
238  */
240 
241 /**
242  * @brief Set ICMP session timeout.
243  *
244  * @param timeout Timeout value in seconds (if 0 reset to default value 60sec).
245  *
246  * @returns 0 on success, non-zero value otherwise.
247  */
248 int nat64_set_icmp_timeout (u32 timeout);
249 
250 /**
251  * @brief Get ICMP session timeout.
252  *
253  * @returns ICMP session timeout in seconds.
254  */
256 
257 /**
258  * @brief Set TCP session timeouts.
259  *
260  * @param trans Transitory timeout in seconds (if 0 reset to default value 240sec).
261  * @param est Established timeout in seconds (if 0 reset to default value 7440sec).
262  *
263  * @returns 0 on success, non-zero value otherwise.
264  */
265 int nat64_set_tcp_timeouts (u32 trans, u32 est);
266 
267 /**
268  * @brief Get TCP transitory timeout.
269  *
270  * @returns TCP transitory timeout in seconds.
271  */
273 
274 /**
275  * @brief Get TCP established timeout.
276  *
277  * @returns TCP established timeout in seconds.
278  */
280 
281 /**
282  * @brief Reset NAT64 session timeout.
283  *
284  * @param ste Session table entry.
285  * @param vm VLIB main.
286  **/
287 void nat64_session_reset_timeout (nat64_db_st_entry_t * ste,
288  vlib_main_t * vm);
289 
290 /**
291  * @brief Set NAT64 TCP session state.
292  *
293  * @param ste Session table entry.
294  * @param tcp TCP header.
295  * @param is_ip6 1 if IPv6 packet, 0 if IPv4.
296  */
297 void nat64_tcp_session_set_state (nat64_db_st_entry_t * ste,
298  tcp_header_t * tcp, u8 is_ip6);
299 
300 /**
301  * @brief Add/delete NAT64 prefix.
302  *
303  * @param prefix NAT64 prefix.
304  * @param plen Prefix length.
305  * @param vrf_id VRF id of tenant.
306  * @param is_add 1 if add, 0 if delete.
307  *
308  * @returns 0 on success, non-zero value otherwise.
309  */
310 int nat64_add_del_prefix (ip6_address_t * prefix, u8 plen, u32 vrf_id,
311  u8 is_add);
312 
313 /**
314  * @brief Call back function when walking addresses in NAT64 prefixes, non-zero
315  * return value stop walk.
316  */
317 typedef int (*nat64_prefix_walk_fn_t) (nat64_prefix_t * pref64, void *ctx);
318 
319 /**
320  * @brief Walk NAT64 prefixes.
321  *
322  * @param fn The function to invoke on each entry visited.
323  * @param ctx A context passed in the visit function.
324  */
326 
327 /**
328  * Compose IPv4-embedded IPv6 addresses.
329  * @param ip6 IPv4-embedded IPv6 addresses.
330  * @param ip4 IPv4 address.
331  * @param fib_index Tenant FIB index.
332  */
334  u32 fib_index);
335 
336 /**
337  * Extract IPv4 address from the IPv4-embedded IPv6 addresses.
338  *
339  * @param ip6 IPv4-embedded IPv6 addresses.
340  * @param ip4 IPv4 address.
341  * @param fib_index Tenant FIB index.
342  */
344  u32 fib_index);
345 
346 /**
347  * @brief Set NAT64 hash tables configuration.
348  *
349  * @param bib_buckets Number of BIB hash buckets.
350  * @param bib_memory_size Memory size of BIB hash.
351  * @param st_buckets Number of session table hash buckets.
352  * @param st_memory_size Memory size of session table hash.
353  */
354 void nat64_set_hash (u32 bib_buckets, u32 bib_memory_size, u32 st_buckets,
355  u32 st_memory_size);
356 
357 /**
358  * @brief Get worker thread index for NAT64 in2out.
359  *
360  * @param addr IPv6 src address.
361  *
362  * @returns worker thread index.
363  */
365 
366 /**
367  * @brief Get worker thread index for NAT64 out2in.
368  *
369  * @param ip IPv4 header.
370  *
371  * @returns worker thread index.
372  */
374 
375 #endif /* __included_nat64_h__ */
376 
377 /*
378  * fd.io coding-style-patch-verification: ON
379  *
380  * Local Variables:
381  * eval: (c-set-style "gnu")
382  * End:
383  */
nat64_db_t * db
BIB and session DB per thread.
Definition: nat64.h:83
u32 icmp_timeout
Definition: nat64.h:102
nat64_main_t nat64_main
Definition: nat64.c:28
ip6_address_t prefix
Definition: nat64.h:49
snat_address_t * addr_pool
Address pool vector.
Definition: nat64.h:74
int nat64_add_del_pool_addr(ip4_address_t *addr, u32 vrf_id, u8 is_add)
Add/delete address to NAT64 pool.
Definition: nat64.c:283
u32 st_buckets
Definition: nat64.h:97
u32 nat64_expire_walk_node_index
Definition: nat64.h:109
void nat64_set_hash(u32 bib_buckets, u32 bib_memory_size, u32 st_buckets, u32 st_memory_size)
Set NAT64 hash tables configuration.
Definition: nat64.c:261
int nat64_add_interface_address(u32 sw_if_index, int is_add)
NAT64 pool address from specific (DHCP addressed) interface.
Definition: nat64.c:378
u32 bib_memory_size
Definition: nat64.h:96
u32 nat64_get_worker_out2in(ip4_header_t *ip)
Get worker thread index for NAT64 out2in.
Definition: nat64.c:121
int i
int nat64_set_tcp_timeouts(u32 trans, u32 est)
Set TCP session timeouts.
Definition: nat64.c:827
u32 tcp_trans_timeout
Definition: nat64.h:103
struct _tcp_header tcp_header_t
vhost_vring_addr_t addr
Definition: vhost_user.h:121
u32 * auto_add_sw_if_indices
sw_if_indices whose interface addresses should be auto-added
Definition: nat64.h:77
unsigned char u8
Definition: types.h:56
enum @519 nat64_cleaner_process_event_e
int nat64_add_del_interface(u32 sw_if_index, u8 is_inside, u8 is_add)
Enable/disable NAT64 feature on the interface.
Definition: nat64.c:419
#define foreach_nat64_tcp_ses_state
Definition: nat64.h:25
u32 sw_if_index
Definition: vxlan_gbp.api:37
u32 total_enabled_count
Definition: nat64.h:107
u32 tcp_est_timeout
Definition: nat64.h:104
int nat64_add_del_static_bib_entry(ip6_address_t *in_addr, ip4_address_t *out_addr, u16 in_port, u16 out_port, u8 proto, u32 vrf_id, u8 is_add)
Add/delete static NAT64 BIB entry.
Definition: nat64.c:649
snat_main_t * sm
Definition: nat64.h:116
unsigned int u32
Definition: types.h:88
vlib_node_registration_t nat64_in2out_node
(constructor) VLIB_REGISTER_NODE (nat64_in2out_node)
A collection of simple counters.
Definition: counter.h:57
snat_interface_t * interfaces
Interface pool.
Definition: nat64.h:71
u32 fib_index
Definition: nat64.h:52
u32 udp_timeout
values of various timeouts
Definition: nat64.h:101
u32 nat64_get_icmp_timeout(void)
Get ICMP session timeout.
Definition: nat64.c:819
ip4_address_t out_addr
Definition: nat64.h:59
void nat64_tcp_session_set_state(nat64_db_st_entry_t *ste, tcp_header_t *tcp, u8 is_ip6)
Set NAT64 TCP session state.
Definition: nat64.c:900
nat64_prefix_t * pref64
Pref64 vector.
Definition: nat64.h:80
ip6_address_t in_addr
Definition: nat64.h:57
u32 nat64_get_worker_in2out(ip6_address_t *addr)
Get worker thread index for NAT64 in2out.
Definition: nat64.c:98
u32 st_memory_size
Definition: nat64.h:98
long ctx[MAX_CONNS]
Definition: main.c:144
unsigned short u16
Definition: types.h:57
int nat64_add_del_prefix(ip6_address_t *prefix, u8 plen, u32 vrf_id, u8 is_add)
Add/delete NAT64 prefix.
Definition: nat64.c:967
int nat64_set_udp_timeout(u32 timeout)
Set UDP session timeout.
Definition: nat64.c:785
nat64_tcp_ses_state_t
Definition: nat64.h:35
void nat64_pool_addr_walk(nat64_pool_addr_walk_fn_t fn, void *ctx)
Walk NAT64 pool.
Definition: nat64.c:363
vlib_simple_counter_main_t total_sessions
Definition: nat64.h:113
vlib_node_registration_t nat64_out2in_node
(constructor) VLIB_REGISTER_NODE (nat64_out2in_node)
Definition: nat64_out2in.c:576
u32 nat64_get_tcp_trans_timeout(void)
Get TCP transitory timeout.
Definition: nat64.c:845
vlib_main_t * vm
Definition: buffer.c:301
int nat64_alloc_out_addr_and_port(u32 fib_index, snat_protocol_t proto, ip4_address_t *addr, u16 *port, u32 thread_index)
Alloce IPv4 address and port pair from NAT64 pool.
Definition: nat64.c:518
u32 nat64_get_udp_timeout(void)
Get UDP session timeout.
Definition: nat64.c:798
u32 nat64_get_tcp_est_timeout(void)
Get TCP established timeout.
Definition: nat64.c:853
u32 bib_buckets
config parameters
Definition: nat64.h:95
void nat64_interfaces_walk(nat64_interface_walk_fn_t fn, void *ctx)
Walk NAT64 interfaces.
Definition: nat64.c:503
clib_error_t * nat64_init(vlib_main_t *vm)
Initialize NAT64.
Definition: nat64.c:212
u32 fq_out2in_index
Definition: nat64.h:87
u32 vrf_id
Definition: nat64.h:51
u32 fq_in2out_index
Worker handoff.
Definition: nat64.h:86
nat64_static_bib_to_update_t * static_bibs
Pool of static BIB entries to be added/deleted in worker threads.
Definition: nat64.h:90
IPv4 main type.
Definition: ip4.h:96
int nat64_set_icmp_timeout(u32 timeout)
Set ICMP session timeout.
Definition: nat64.c:806
struct _vlib_node_registration vlib_node_registration_t
ip4_main_t * ip4_main
Definition: nat64.h:115
snat_protocol_t
Definition: nat.h:133
u32 error_node_index
Definition: nat64.h:92
void nat64_session_reset_timeout(nat64_db_st_entry_t *ste, vlib_main_t *vm)
Reset NAT64 session timeout.
Definition: nat64.c:861
typedef prefix
Definition: ip_types.api:35
NAT64 DB.
void nat64_extract_ip4(ip6_address_t *ip6, ip4_address_t *ip4, u32 fib_index)
Extract IPv4 address from the IPv4-embedded IPv6 addresses.
Definition: nat64.c:1100
void nat64_prefix_walk(nat64_prefix_walk_fn_t fn, void *ctx)
Walk NAT64 prefixes.
Definition: nat64.c:1015
void nat64_compose_ip6(ip6_address_t *ip6, ip4_address_t *ip4, u32 fib_index)
Compose IPv4-embedded IPv6 addresses.
Definition: nat64.c:1030
int(* nat64_prefix_walk_fn_t)(nat64_prefix_t *pref64, void *ctx)
Call back function when walking addresses in NAT64 prefixes, non-zero return value stop walk...
Definition: nat64.h:317
int(* nat64_interface_walk_fn_t)(snat_interface_t *i, void *ctx)
Call back function when walking interfaces with NAT64 feature, non-zero return value stop walk...
Definition: nat64.h:173
vlib_simple_counter_main_t total_bibs
Definition: nat64.h:112
int(* nat64_pool_addr_walk_fn_t)(snat_address_t *addr, void *ctx)
Call back function when walking addresses in NAT64 pool, non-zero return value stop walk...
Definition: nat64.h:138