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;
44 NAT64_CLEANER_RESCHEDULE = 1,
45 } nat64_cleaner_process_event_e;
57 ip6_address_t in_addr;
59 ip4_address_t out_addr;
66 } nat64_static_bib_to_update_t;
71 snat_interface_t *interfaces;
73 /** Address pool vector */
74 snat_address_t *addr_pool;
76 /** sw_if_indices whose interface addresses should be auto-added */
77 u32 *auto_add_sw_if_indices;
80 nat64_prefix_t *pref64;
82 /** BIB and session DB per thread */
89 /** Pool of static BIB entries to be added/deleted in worker threads */
90 nat64_static_bib_to_update_t *static_bibs;
94 /** config parameters */
100 /** values of various timeouts */
103 u32 tcp_trans_timeout;
106 /* Total count of interfaces enabled */
107 u32 total_enabled_count;
108 /* The process node which orcherstrates the cleanup */
109 u32 nat64_expire_walk_node_index;
111 /* counters/gauges */
112 vlib_simple_counter_main_t total_bibs;
113 vlib_simple_counter_main_t total_sessions;
115 ip4_main_t *ip4_main;
119 extern nat64_main_t nat64_main;
120 extern vlib_node_registration_t nat64_in2out_node;
121 extern vlib_node_registration_t nat64_out2in_node;
124 * @brief Add/delete address to NAT64 pool.
126 * @param thread_index Thread index.
127 * @param addr IPv4 address.
128 * @param vrf_id VRF id of tenant, ~0 means independent of VRF.
129 * @param is_add 1 if add, 0 if delete.
131 * @returns 0 on success, non-zero value otherwise.
133 int nat64_add_del_pool_addr (u32 thread_index,
134 ip4_address_t * addr, u32 vrf_id, u8 is_add);
137 * @brief Call back function when walking addresses in NAT64 pool, non-zero
138 * return value stop walk.
140 typedef int (*nat64_pool_addr_walk_fn_t) (snat_address_t * addr, void *ctx);
143 * @brief Walk NAT64 pool.
145 * @param fn The function to invoke on each entry visited.
146 * @param ctx A context passed in the visit function.
148 void nat64_pool_addr_walk (nat64_pool_addr_walk_fn_t fn, void *ctx);
151 * @brief NAT64 pool address from specific (DHCP addressed) interface.
153 * @param sw_if_index Index of the interface.
154 * @param is_add 1 if add, 0 if delete.
156 * @returns 0 on success, non-zero value otherwise.
158 int nat64_add_interface_address (u32 sw_if_index, int is_add);
161 * @brief Enable/disable NAT64 feature on the interface.
163 * @param sw_if_index Index of the interface.
164 * @param is_inside 1 if inside, 0 if outside.
165 * @param is_add 1 if add, 0 if delete.
167 * @returns 0 on success, non-zero value otherwise.
169 int nat64_add_del_interface (u32 sw_if_index, u8 is_inside, u8 is_add);
172 * @brief Call back function when walking interfaces with NAT64 feature,
173 * non-zero return value stop walk.
175 typedef int (*nat64_interface_walk_fn_t) (snat_interface_t * i, void *ctx);
178 * @brief Walk NAT64 interfaces.
180 * @param fn The function to invoke on each entry visited.
181 * @param ctx A context passed in the visit function.
183 void nat64_interfaces_walk (nat64_interface_walk_fn_t fn, void *ctx);
186 * @brief Initialize NAT64.
188 * @param vm vlib main.
190 * @return error code.
192 clib_error_t *nat64_init (vlib_main_t * vm);
195 * @brief Add/delete static NAT64 BIB entry.
197 * @param in_addr Inside IPv6 address.
198 * @param out_addr Outside IPv4 address.
199 * @param in_port Inside port number.
200 * @param out_port Outside port number.
201 * @param proto L4 protocol.
202 * @param vrf_id VRF id of tenant.
203 * @param is_add 1 if add, 0 if delete.
205 * @returns 0 on success, non-zero value otherwise.
207 int nat64_add_del_static_bib_entry (ip6_address_t * in_addr,
208 ip4_address_t * out_addr, u16 in_port,
209 u16 out_port, u8 proto, u32 vrf_id,
213 * @brief Alloce IPv4 address and port pair from NAT64 pool.
215 * @param fib_index FIB index of tenant.
216 * @param proto L4 protocol.
217 * @param addr Allocated IPv4 address.
218 * @param port Allocated port number.
219 * @param thread_index Thread index.
221 * @returns 0 on success, non-zero value otherwise.
223 int nat64_alloc_out_addr_and_port (u32 fib_index, snat_protocol_t proto,
224 ip4_address_t * addr, u16 * port,
228 * @brief Set UDP session timeout.
230 * @param timeout Timeout value in seconds (if 0 reset to default value 300sec).
232 * @returns 0 on success, non-zero value otherwise.
234 int nat64_set_udp_timeout (u32 timeout);
237 * @brief Get UDP session timeout.
239 * @returns UDP session timeout in seconds.
241 u32 nat64_get_udp_timeout (void);
244 * @brief Set ICMP session timeout.
246 * @param timeout Timeout value in seconds (if 0 reset to default value 60sec).
248 * @returns 0 on success, non-zero value otherwise.
250 int nat64_set_icmp_timeout (u32 timeout);
253 * @brief Get ICMP session timeout.
255 * @returns ICMP session timeout in seconds.
257 u32 nat64_get_icmp_timeout (void);
260 * @brief Set TCP session timeouts.
262 * @param trans Transitory timeout in seconds (if 0 reset to default value 240sec).
263 * @param est Established timeout in seconds (if 0 reset to default value 7440sec).
265 * @returns 0 on success, non-zero value otherwise.
267 int nat64_set_tcp_timeouts (u32 trans, u32 est);
270 * @brief Get TCP transitory timeout.
272 * @returns TCP transitory timeout in seconds.
274 u32 nat64_get_tcp_trans_timeout (void);
277 * @brief Get TCP established timeout.
279 * @returns TCP established timeout in seconds.
281 u32 nat64_get_tcp_est_timeout (void);
284 * @brief Reset NAT64 session timeout.
286 * @param ste Session table entry.
287 * @param vm VLIB main.
289 void nat64_session_reset_timeout (nat64_db_st_entry_t * ste,
293 * @brief Set NAT64 TCP session state.
295 * @param ste Session table entry.
296 * @param tcp TCP header.
297 * @param is_ip6 1 if IPv6 packet, 0 if IPv4.
299 void nat64_tcp_session_set_state (nat64_db_st_entry_t * ste,
300 tcp_header_t * tcp, u8 is_ip6);
303 * @brief Add/delete NAT64 prefix.
305 * @param prefix NAT64 prefix.
306 * @param plen Prefix length.
307 * @param vrf_id VRF id of tenant.
308 * @param is_add 1 if add, 0 if delete.
310 * @returns 0 on success, non-zero value otherwise.
312 int nat64_add_del_prefix (ip6_address_t * prefix, u8 plen, u32 vrf_id,
316 * @brief Call back function when walking addresses in NAT64 prefixes, non-zero
317 * return value stop walk.
319 typedef int (*nat64_prefix_walk_fn_t) (nat64_prefix_t * pref64, void *ctx);
322 * @brief Walk NAT64 prefixes.
324 * @param fn The function to invoke on each entry visited.
325 * @param ctx A context passed in the visit function.
327 void nat64_prefix_walk (nat64_prefix_walk_fn_t fn, void *ctx);
330 * Compose IPv4-embedded IPv6 addresses.
331 * @param ip6 IPv4-embedded IPv6 addresses.
332 * @param ip4 IPv4 address.
333 * @param fib_index Tenant FIB index.
335 void nat64_compose_ip6 (ip6_address_t * ip6, ip4_address_t * ip4,
339 * Extract IPv4 address from the IPv4-embedded IPv6 addresses.
341 * @param ip6 IPv4-embedded IPv6 addresses.
342 * @param ip4 IPv4 address.
343 * @param fib_index Tenant FIB index.
345 void nat64_extract_ip4 (ip6_address_t * ip6, ip4_address_t * ip4,
349 * @brief Set NAT64 hash tables configuration.
351 * @param bib_buckets Number of BIB hash buckets.
352 * @param bib_memory_size Memory size of BIB hash.
353 * @param st_buckets Number of session table hash buckets.
354 * @param st_memory_size Memory size of session table hash.
356 void nat64_set_hash (u32 bib_buckets, u32 bib_memory_size, u32 st_buckets,
360 * @brief Get worker thread index for NAT64 in2out.
362 * @param addr IPv6 src address.
364 * @returns worker thread index.
366 u32 nat64_get_worker_in2out (ip6_address_t * addr);
369 * @brief Get worker thread index for NAT64 out2in.
371 * @param ip IPv4 header.
373 * @returns worker thread index.
375 u32 nat64_get_worker_out2in (ip4_header_t * ip);
377 #endif /* __included_nat64_h__ */
380 * fd.io coding-style-patch-verification: ON
383 * eval: (c-set-style "gnu")