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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 * @brief NAT64 global declarations
19 #ifndef __included_nat64_h__
20 #define __included_nat64_h__
23 #include <nat/nat64_db.h>
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") \
37 #define _(v, N, s) NAT64_TCP_STATE_##N = v,
38 foreach_nat64_tcp_ses_state
40 } nat64_tcp_ses_state_t;
52 ip6_address_t in_addr;
54 ip4_address_t out_addr;
61 } nat64_static_bib_to_update_t;
66 snat_interface_t *interfaces;
68 /** Address pool vector */
69 snat_address_t *addr_pool;
71 /** sw_if_indices whose interface addresses should be auto-added */
72 u32 *auto_add_sw_if_indices;
75 nat64_prefix_t *pref64;
77 /** BIB and session DB per thread */
84 /** Pool of static BIB entries to be added/deleted in worker threads */
85 nat64_static_bib_to_update_t *static_bibs;
89 /** config parameters */
95 /** values of various timeouts */
98 u32 tcp_trans_timeout;
100 u32 tcp_incoming_syn_timeout;
102 ip4_main_t *ip4_main;
106 extern nat64_main_t nat64_main;
107 extern vlib_node_registration_t nat64_in2out_node;
108 extern vlib_node_registration_t nat64_out2in_node;
111 * @brief Add/delete address to NAT64 pool.
113 * @param addr IPv4 address.
114 * @param vrf_id VRF id of tenant, ~0 means independent of VRF.
115 * @param is_add 1 if add, 0 if delete.
117 * @returns 0 on success, non-zero value otherwise.
119 int nat64_add_del_pool_addr (ip4_address_t * addr, u32 vrf_id, u8 is_add);
122 * @brief Call back function when walking addresses in NAT64 pool, non-zero
123 * return value stop walk.
125 typedef int (*nat64_pool_addr_walk_fn_t) (snat_address_t * addr, void *ctx);
128 * @brief Walk NAT64 pool.
130 * @param fn The function to invoke on each entry visited.
131 * @param ctx A context passed in the visit function.
133 void nat64_pool_addr_walk (nat64_pool_addr_walk_fn_t fn, void *ctx);
136 * @brief NAT64 pool address from specific (DHCP addressed) interface.
138 * @param sw_if_index Index of the interface.
139 * @param is_add 1 if add, 0 if delete.
141 * @returns 0 on success, non-zero value otherwise.
143 int nat64_add_interface_address (u32 sw_if_index, int is_add);
146 * @brief Enable/disable NAT64 feature on the interface.
148 * @param sw_if_index Index of the interface.
149 * @param is_inside 1 if inside, 0 if outside.
150 * @param is_add 1 if add, 0 if delete.
152 * @returns 0 on success, non-zero value otherwise.
154 int nat64_add_del_interface (u32 sw_if_index, u8 is_inside, u8 is_add);
157 * @brief Call back function when walking interfaces with NAT64 feature,
158 * non-zero return value stop walk.
160 typedef int (*nat64_interface_walk_fn_t) (snat_interface_t * i, void *ctx);
163 * @brief Walk NAT64 interfaces.
165 * @param fn The function to invoke on each entry visited.
166 * @param ctx A context passed in the visit function.
168 void nat64_interfaces_walk (nat64_interface_walk_fn_t fn, void *ctx);
171 * @brief Initialize NAT64.
173 * @param vm vlib main.
175 * @return error code.
177 clib_error_t *nat64_init (vlib_main_t * vm);
180 * @brief Add/delete static NAT64 BIB entry.
182 * @param in_addr Inside IPv6 address.
183 * @param out_addr Outside IPv4 address.
184 * @param in_port Inside port number.
185 * @param out_port Outside port number.
186 * @param proto L4 protocol.
187 * @param vrf_id VRF id of tenant.
188 * @param is_add 1 if add, 0 if delete.
190 * @returns 0 on success, non-zero value otherwise.
192 int nat64_add_del_static_bib_entry (ip6_address_t * in_addr,
193 ip4_address_t * out_addr, u16 in_port,
194 u16 out_port, u8 proto, u32 vrf_id,
198 * @brief Alloce IPv4 address and port pair from NAT64 pool.
200 * @param fib_index FIB index of tenant.
201 * @param proto L4 protocol.
202 * @param addr Allocated IPv4 address.
203 * @param port Allocated port number.
204 * @param thread_index Thread index.
206 * @returns 0 on success, non-zero value otherwise.
208 int nat64_alloc_out_addr_and_port (u32 fib_index, snat_protocol_t proto,
209 ip4_address_t * addr, u16 * port,
213 * @brief Free IPv4 address and port pair from NAT64 pool.
215 * @param addr IPv4 address to free.
216 * @param port Port number to free.
217 * @param proto L4 protocol.
218 * @param thread_index Thread index.
220 * @returns 0 on success, non-zero value otherwise.
222 void nat64_free_out_addr_and_port (ip4_address_t * addr, u16 port,
223 snat_protocol_t proto, u32 thread_index);
226 * @brief Set UDP session timeout.
228 * @param timeout Timeout value in seconds (if 0 reset to default value 300sec).
230 * @returns 0 on success, non-zero value otherwise.
232 int nat64_set_udp_timeout (u32 timeout);
235 * @brief Get UDP session timeout.
237 * @returns UDP session timeout in seconds.
239 u32 nat64_get_udp_timeout (void);
242 * @brief Set ICMP session timeout.
244 * @param timeout Timeout value in seconds (if 0 reset to default value 60sec).
246 * @returns 0 on success, non-zero value otherwise.
248 int nat64_set_icmp_timeout (u32 timeout);
251 * @brief Get ICMP session timeout.
253 * @returns ICMP session timeout in seconds.
255 u32 nat64_get_icmp_timeout (void);
258 * @brief Set TCP session timeouts.
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 * @param incoming_syn Incoming SYN timeout in seconds (if 0 reset to default value 6sec).
264 * @returns 0 on success, non-zero value otherwise.
266 int nat64_set_tcp_timeouts (u32 trans, u32 est, u32 incoming_syn);
269 * @brief Get TCP transitory timeout.
271 * @returns TCP transitory timeout in seconds.
273 u32 nat64_get_tcp_trans_timeout (void);
276 * @brief Get TCP established timeout.
278 * @returns TCP established timeout in seconds.
280 u32 nat64_get_tcp_est_timeout (void);
283 * @brief Get TCP incoming SYN timeout.
285 * @returns TCP incoming SYN timeout in seconds.
287 u32 nat64_get_tcp_incoming_syn_timeout (void);
290 * @brief Reset NAT64 session timeout.
292 * @param ste Session table entry.
293 * @param vm VLIB main.
295 void nat64_session_reset_timeout (nat64_db_st_entry_t * ste,
299 * @brief Set NAT64 TCP session state.
301 * @param ste Session table entry.
302 * @param tcp TCP header.
303 * @param is_ip6 1 if IPv6 packet, 0 if IPv4.
305 void nat64_tcp_session_set_state (nat64_db_st_entry_t * ste,
306 tcp_header_t * tcp, u8 is_ip6);
309 * @brief Add/delete NAT64 prefix.
311 * @param prefix NAT64 prefix.
312 * @param plen Prefix length.
313 * @param vrf_id VRF id of tenant.
314 * @param is_add 1 if add, 0 if delete.
316 * @returns 0 on success, non-zero value otherwise.
318 int nat64_add_del_prefix (ip6_address_t * prefix, u8 plen, u32 vrf_id,
322 * @brief Call back function when walking addresses in NAT64 prefixes, non-zero
323 * return value stop walk.
325 typedef int (*nat64_prefix_walk_fn_t) (nat64_prefix_t * pref64, void *ctx);
328 * @brief Walk NAT64 prefixes.
330 * @param fn The function to invoke on each entry visited.
331 * @param ctx A context passed in the visit function.
333 void nat64_prefix_walk (nat64_prefix_walk_fn_t fn, void *ctx);
336 * Compose IPv4-embedded IPv6 addresses.
337 * @param ip6 IPv4-embedded IPv6 addresses.
338 * @param ip4 IPv4 address.
339 * @param fib_index Tenant FIB index.
341 void nat64_compose_ip6 (ip6_address_t * ip6, ip4_address_t * ip4,
345 * Extract IPv4 address from the IPv4-embedded IPv6 addresses.
347 * @param ip6 IPv4-embedded IPv6 addresses.
348 * @param ip4 IPv4 address.
349 * @param fib_index Tenant FIB index.
351 void nat64_extract_ip4 (ip6_address_t * ip6, ip4_address_t * ip4,
355 * @brief Set NAT64 hash tables configuration.
357 * @param bib_buckets Number of BIB hash buckets.
358 * @param bib_memory_size Memory size of BIB hash.
359 * @param st_buckets Number of session table hash buckets.
360 * @param st_memory_size Memory size of session table hash.
362 void nat64_set_hash (u32 bib_buckets, u32 bib_memory_size, u32 st_buckets,
366 * @brief Get worker thread index for NAT64 in2out.
368 * @param addr IPv6 src address.
370 * @returns worker thread index.
372 u32 nat64_get_worker_in2out (ip6_address_t * addr);
375 * @brief Get worker thread index for NAT64 out2in.
377 * @param ip IPv4 header.
379 * @returns worker thread index.
381 u32 nat64_get_worker_out2in (ip4_header_t * ip);
383 #define u8_ptr_add(ptr, index) (((u8 *)ptr) + index)
384 #define u16_net_add(u, val) clib_host_to_net_u16(clib_net_to_host_u16(u) + (val))
386 #endif /* __included_nat64_h__ */
389 * fd.io coding-style-patch-verification: ON
392 * eval: (c-set-style "gnu")