FD.io VPP  v19.08.3-2-gbabecb413
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 typedef 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 
92  /** config parameters */
97 
98  /** values of various timeouts */
103 
104  /* Total count of interfaces enabled */
106  /* The process node which orcherstrates the cleanup */
108 
109  /* counters/gauges */
112 
113  /** node index **/
115 
119 
122 
125 } nat64_main_t;
126 
127 extern nat64_main_t nat64_main;
130 
131 /**
132  * @brief Add/delete address to NAT64 pool.
133  *
134  * @param thread_index Thread index used by ipfix nat logging (not address per thread).
135  * @param addr IPv4 address.
136  * @param vrf_id VRF id of tenant, ~0 means independent of VRF.
137  * @param is_add 1 if add, 0 if delete.
138  *
139  * @returns 0 on success, non-zero value otherwise.
140  */
141 int nat64_add_del_pool_addr (u32 thread_index,
142  ip4_address_t * addr, u32 vrf_id, u8 is_add);
143 
144 /**
145  * @brief Call back function when walking addresses in NAT64 pool, non-zero
146  * return value stop walk.
147  */
149 
150 /**
151  * @brief Walk NAT64 pool.
152  *
153  * @param fn The function to invoke on each entry visited.
154  * @param ctx A context passed in the visit function.
155  */
157 
158 /**
159  * @brief NAT64 pool address from specific (DHCP addressed) interface.
160  *
161  * @param sw_if_index Index of the interface.
162  * @param is_add 1 if add, 0 if delete.
163  *
164  * @returns 0 on success, non-zero value otherwise.
165  */
167 
168 /**
169  * @brief Enable/disable NAT64 feature on the interface.
170  *
171  * @param sw_if_index Index of the interface.
172  * @param is_inside 1 if inside, 0 if outside.
173  * @param is_add 1 if add, 0 if delete.
174  *
175  * @returns 0 on success, non-zero value otherwise.
176  */
177 int nat64_add_del_interface (u32 sw_if_index, u8 is_inside, u8 is_add);
178 
179 /**
180  * @brief Call back function when walking interfaces with NAT64 feature,
181  * non-zero return value stop walk.
182  */
184 
185 /**
186  * @brief Walk NAT64 interfaces.
187  *
188  * @param fn The function to invoke on each entry visited.
189  * @param ctx A context passed in the visit function.
190  */
192 
193 /**
194  * @brief Initialize NAT64.
195  *
196  * @param vm vlib main.
197  *
198  * @return error code.
199  */
201 
202 /**
203  * @brief Add/delete static NAT64 BIB entry.
204  *
205  * @param in_addr Inside IPv6 address.
206  * @param out_addr Outside IPv4 address.
207  * @param in_port Inside port number.
208  * @param out_port Outside port number.
209  * @param proto L4 protocol.
210  * @param vrf_id VRF id of tenant.
211  * @param is_add 1 if add, 0 if delete.
212  *
213  * @returns 0 on success, non-zero value otherwise.
214  */
216  ip4_address_t * out_addr, u16 in_port,
217  u16 out_port, u8 proto, u32 vrf_id,
218  u8 is_add);
219 
220 /**
221  * @brief Alloce IPv4 address and port pair from NAT64 pool.
222  *
223  * @param fib_index FIB index of tenant.
224  * @param proto L4 protocol.
225  * @param addr Allocated IPv4 address.
226  * @param port Allocated port number.
227  * @param thread_index Thread index.
228  *
229  * @returns 0 on success, non-zero value otherwise.
230  */
232  ip4_address_t * addr, u16 * port,
233  u32 thread_index);
234 
235 /**
236  * @brief Set UDP session timeout.
237  *
238  * @param timeout Timeout value in seconds (if 0 reset to default value 300sec).
239  *
240  * @returns 0 on success, non-zero value otherwise.
241  */
242 int nat64_set_udp_timeout (u32 timeout);
243 
244 /**
245  * @brief Get UDP session timeout.
246  *
247  * @returns UDP session timeout in seconds.
248  */
250 
251 /**
252  * @brief Set ICMP session timeout.
253  *
254  * @param timeout Timeout value in seconds (if 0 reset to default value 60sec).
255  *
256  * @returns 0 on success, non-zero value otherwise.
257  */
258 int nat64_set_icmp_timeout (u32 timeout);
259 
260 /**
261  * @brief Get ICMP session timeout.
262  *
263  * @returns ICMP session timeout in seconds.
264  */
266 
267 /**
268  * @brief Set TCP session timeouts.
269  *
270  * @param trans Transitory timeout in seconds (if 0 reset to default value 240sec).
271  * @param est Established timeout in seconds (if 0 reset to default value 7440sec).
272  *
273  * @returns 0 on success, non-zero value otherwise.
274  */
275 int nat64_set_tcp_timeouts (u32 trans, u32 est);
276 
277 /**
278  * @brief Get TCP transitory timeout.
279  *
280  * @returns TCP transitory timeout in seconds.
281  */
283 
284 /**
285  * @brief Get TCP established timeout.
286  *
287  * @returns TCP established timeout in seconds.
288  */
290 
291 /**
292  * @brief Reset NAT64 session timeout.
293  *
294  * @param ste Session table entry.
295  * @param vm VLIB main.
296  **/
297 void nat64_session_reset_timeout (nat64_db_st_entry_t * ste,
298  vlib_main_t * vm);
299 
300 /**
301  * @brief Set NAT64 TCP session state.
302  *
303  * @param ste Session table entry.
304  * @param tcp TCP header.
305  * @param is_ip6 1 if IPv6 packet, 0 if IPv4.
306  */
307 void nat64_tcp_session_set_state (nat64_db_st_entry_t * ste,
308  tcp_header_t * tcp, u8 is_ip6);
309 
310 /**
311  * @brief Add/delete NAT64 prefix.
312  *
313  * @param prefix NAT64 prefix.
314  * @param plen Prefix length.
315  * @param vrf_id VRF id of tenant.
316  * @param is_add 1 if add, 0 if delete.
317  *
318  * @returns 0 on success, non-zero value otherwise.
319  */
320 int nat64_add_del_prefix (ip6_address_t * prefix, u8 plen, u32 vrf_id,
321  u8 is_add);
322 
323 /**
324  * @brief Call back function when walking addresses in NAT64 prefixes, non-zero
325  * return value stop walk.
326  */
327 typedef int (*nat64_prefix_walk_fn_t) (nat64_prefix_t * pref64, void *ctx);
328 
329 /**
330  * @brief Walk NAT64 prefixes.
331  *
332  * @param fn The function to invoke on each entry visited.
333  * @param ctx A context passed in the visit function.
334  */
336 
337 /**
338  * Compose IPv4-embedded IPv6 addresses.
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  * Extract IPv4 address from the IPv4-embedded IPv6 addresses.
348  *
349  * @param ip6 IPv4-embedded IPv6 addresses.
350  * @param ip4 IPv4 address.
351  * @param fib_index Tenant FIB index.
352  */
354  u32 fib_index);
355 
356 /**
357  * @brief Set NAT64 hash tables configuration.
358  *
359  * @param bib_buckets Number of BIB hash buckets.
360  * @param bib_memory_size Memory size of BIB hash.
361  * @param st_buckets Number of session table hash buckets.
362  * @param st_memory_size Memory size of session table hash.
363  */
364 void nat64_set_hash (u32 bib_buckets, u32 bib_memory_size, u32 st_buckets,
365  u32 st_memory_size);
366 
367 /**
368  * @brief Get worker thread index for NAT64 in2out.
369  *
370  * @param addr IPv6 src address.
371  *
372  * @returns worker thread index.
373  */
375 
376 /**
377  * @brief Get worker thread index for NAT64 out2in.
378  *
379  * @param ip IPv4 header.
380  *
381  * @returns worker thread index.
382  */
384 
385 #endif /* __included_nat64_h__ */
386 
387 /*
388  * fd.io coding-style-patch-verification: ON
389  *
390  * Local Variables:
391  * eval: (c-set-style "gnu")
392  * End:
393  */
u32 in2out_reass_node_index
Definition: nat64.h:118
nat64_db_t * db
BIB and session DB per thread.
Definition: nat64.h:83
u32 icmp_timeout
Definition: nat64.h:100
u32 out2in_node_index
Definition: nat64.h:120
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
u32 st_buckets
Definition: nat64.h:95
u32 nat64_expire_walk_node_index
Definition: nat64.h:107
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:293
int nat64_add_interface_address(u32 sw_if_index, int is_add)
NAT64 pool address from specific (DHCP addressed) interface.
Definition: nat64.c:411
u32 bib_memory_size
Definition: nat64.h:94
u32 nat64_get_worker_out2in(ip4_header_t *ip)
Get worker thread index for NAT64 out2in.
Definition: nat64.c:123
int i
int nat64_set_tcp_timeouts(u32 trans, u32 est)
Set TCP session timeouts.
Definition: nat64.c:862
u32 tcp_trans_timeout
Definition: nat64.h:101
u32 in2out_node_index
Definition: nat64.h:116
vl_api_mprefix_t prefix
Definition: ip.api:456
struct _tcp_header tcp_header_t
vhost_vring_addr_t addr
Definition: vhost_user.h:147
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
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:453
#define foreach_nat64_tcp_ses_state
Definition: nat64.h:25
vl_api_interface_index_t sw_if_index
Definition: gre.api:50
u32 total_enabled_count
Definition: nat64.h:105
u32 tcp_est_timeout
Definition: nat64.h:102
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:684
snat_main_t * sm
Definition: nat64.h:124
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 in2out_slowpath_node_index
Definition: nat64.h:117
u32 fib_index
Definition: nat64.h:52
u32 udp_timeout
values of various timeouts
Definition: nat64.h:99
u32 nat64_get_icmp_timeout(void)
Get ICMP session timeout.
Definition: nat64.c:854
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:935
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:100
u32 st_memory_size
Definition: nat64.h:96
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:1002
int nat64_set_udp_timeout(u32 timeout)
Set UDP session timeout.
Definition: nat64.c:820
nat64_tcp_ses_state_t
Definition: nat64.h:35
u16 port
Definition: punt.api:40
void nat64_pool_addr_walk(nat64_pool_addr_walk_fn_t fn, void *ctx)
Walk NAT64 pool.
Definition: nat64.c:396
vlib_simple_counter_main_t total_sessions
Definition: nat64.h:111
vlib_node_registration_t nat64_out2in_node
(constructor) VLIB_REGISTER_NODE (nat64_out2in_node)
Definition: nat64_out2in.c:577
u32 nat64_get_tcp_trans_timeout(void)
Get TCP transitory timeout.
Definition: nat64.c:880
vlib_main_t * vm
Definition: buffer.c:323
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:552
u32 nat64_get_udp_timeout(void)
Get UDP session timeout.
Definition: nat64.c:833
u32 nat64_get_tcp_est_timeout(void)
Get TCP established timeout.
Definition: nat64.c:888
u32 bib_buckets
config parameters
Definition: nat64.h:93
u32 out2in_reass_node_index
Definition: nat64.h:121
void nat64_interfaces_walk(nat64_interface_walk_fn_t fn, void *ctx)
Walk NAT64 interfaces.
Definition: nat64.c:537
clib_error_t * nat64_init(vlib_main_t *vm)
Initialize NAT64.
Definition: nat64.c:229
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
int nat64_add_del_pool_addr(u32 thread_index, ip4_address_t *addr, u32 vrf_id, u8 is_add)
Add/delete address to NAT64 pool.
Definition: nat64.c:315
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:105
int nat64_set_icmp_timeout(u32 timeout)
Set ICMP session timeout.
Definition: nat64.c:841
nat64_cleaner_process_event_e
Definition: nat64.h:42
struct _vlib_node_registration vlib_node_registration_t
ip4_main_t * ip4_main
Definition: nat64.h:123
vl_api_address_t ip
Definition: l2.api:489
snat_protocol_t
Definition: nat.h:191
u32 error_node_index
node index
Definition: nat64.h:114
void nat64_session_reset_timeout(nat64_db_st_entry_t *ste, vlib_main_t *vm)
Reset NAT64 session timeout.
Definition: nat64.c:896
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:1135
void nat64_prefix_walk(nat64_prefix_walk_fn_t fn, void *ctx)
Walk NAT64 prefixes.
Definition: nat64.c:1050
void nat64_compose_ip6(ip6_address_t *ip6, ip4_address_t *ip4, u32 fib_index)
Compose IPv4-embedded IPv6 addresses.
Definition: nat64.c:1065
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:327
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:183
vl_api_fib_path_nh_proto_t proto
Definition: fib_types.api:125
vlib_simple_counter_main_t total_bibs
Definition: nat64.h:110
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:148