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;
92 /** config parameters */
98 /** values of various timeouts */
101 u32 tcp_trans_timeout;
104 /* Total count of interfaces enabled */
105 u32 total_enabled_count;
106 /* The process node which orcherstrates the cleanup */
107 u32 nat64_expire_walk_node_index;
109 /* counters/gauges */
110 vlib_simple_counter_main_t total_bibs;
111 vlib_simple_counter_main_t total_sessions;
114 u32 error_node_index;
116 u32 in2out_node_index;
117 u32 in2out_slowpath_node_index;
119 u32 out2in_node_index;
121 ip4_main_t *ip4_main;
125 extern nat64_main_t nat64_main;
126 extern vlib_node_registration_t nat64_in2out_node;
127 extern vlib_node_registration_t nat64_out2in_node;
130 * @brief Add/delete address to NAT64 pool.
132 * @param thread_index Thread index used by ipfix nat logging (not address per thread).
133 * @param addr IPv4 address.
134 * @param vrf_id VRF id of tenant, ~0 means independent of VRF.
135 * @param is_add 1 if add, 0 if delete.
137 * @returns 0 on success, non-zero value otherwise.
139 int nat64_add_del_pool_addr (u32 thread_index,
140 ip4_address_t * addr, u32 vrf_id, u8 is_add);
143 * @brief Call back function when walking addresses in NAT64 pool, non-zero
144 * return value stop walk.
146 typedef int (*nat64_pool_addr_walk_fn_t) (snat_address_t * addr, void *ctx);
149 * @brief Walk NAT64 pool.
151 * @param fn The function to invoke on each entry visited.
152 * @param ctx A context passed in the visit function.
154 void nat64_pool_addr_walk (nat64_pool_addr_walk_fn_t fn, void *ctx);
157 * @brief NAT64 pool address from specific (DHCP addressed) interface.
159 * @param sw_if_index Index of the interface.
160 * @param is_add 1 if add, 0 if delete.
162 * @returns 0 on success, non-zero value otherwise.
164 int nat64_add_interface_address (u32 sw_if_index, int is_add);
167 * @brief Enable/disable NAT64 feature on the interface.
169 * @param sw_if_index Index of the interface.
170 * @param is_inside 1 if inside, 0 if outside.
171 * @param is_add 1 if add, 0 if delete.
173 * @returns 0 on success, non-zero value otherwise.
175 int nat64_add_del_interface (u32 sw_if_index, u8 is_inside, u8 is_add);
178 * @brief Call back function when walking interfaces with NAT64 feature,
179 * non-zero return value stop walk.
181 typedef int (*nat64_interface_walk_fn_t) (snat_interface_t * i, void *ctx);
184 * @brief Walk NAT64 interfaces.
186 * @param fn The function to invoke on each entry visited.
187 * @param ctx A context passed in the visit function.
189 void nat64_interfaces_walk (nat64_interface_walk_fn_t fn, void *ctx);
192 * @brief Initialize NAT64.
194 * @param vm vlib main.
196 * @return error code.
198 clib_error_t *nat64_init (vlib_main_t * vm);
201 * @brief Add/delete static NAT64 BIB entry.
203 * @param in_addr Inside IPv6 address.
204 * @param out_addr Outside IPv4 address.
205 * @param in_port Inside port number.
206 * @param out_port Outside port number.
207 * @param proto L4 protocol.
208 * @param vrf_id VRF id of tenant.
209 * @param is_add 1 if add, 0 if delete.
211 * @returns 0 on success, non-zero value otherwise.
213 int nat64_add_del_static_bib_entry (ip6_address_t * in_addr,
214 ip4_address_t * out_addr, u16 in_port,
215 u16 out_port, u8 proto, u32 vrf_id,
219 * @brief Alloce IPv4 address and port pair from NAT64 pool.
221 * @param fib_index FIB index of tenant.
222 * @param proto L4 protocol.
223 * @param addr Allocated IPv4 address.
224 * @param port Allocated port number.
225 * @param thread_index Thread index.
227 * @returns 0 on success, non-zero value otherwise.
229 int nat64_alloc_out_addr_and_port (u32 fib_index, snat_protocol_t proto,
230 ip4_address_t * addr, u16 * port,
234 * @brief Set UDP session timeout.
236 * @param timeout Timeout value in seconds (if 0 reset to default value 300sec).
238 * @returns 0 on success, non-zero value otherwise.
240 int nat64_set_udp_timeout (u32 timeout);
243 * @brief Get UDP session timeout.
245 * @returns UDP session timeout in seconds.
247 u32 nat64_get_udp_timeout (void);
250 * @brief Set ICMP session timeout.
252 * @param timeout Timeout value in seconds (if 0 reset to default value 60sec).
254 * @returns 0 on success, non-zero value otherwise.
256 int nat64_set_icmp_timeout (u32 timeout);
259 * @brief Get ICMP session timeout.
261 * @returns ICMP session timeout in seconds.
263 u32 nat64_get_icmp_timeout (void);
266 * @brief Set TCP session timeouts.
268 * @param trans Transitory timeout in seconds (if 0 reset to default value 240sec).
269 * @param est Established timeout in seconds (if 0 reset to default value 7440sec).
271 * @returns 0 on success, non-zero value otherwise.
273 int nat64_set_tcp_timeouts (u32 trans, u32 est);
276 * @brief Get TCP transitory timeout.
278 * @returns TCP transitory timeout in seconds.
280 u32 nat64_get_tcp_trans_timeout (void);
283 * @brief Get TCP established timeout.
285 * @returns TCP established timeout in seconds.
287 u32 nat64_get_tcp_est_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 (vlib_buffer_t * b, ip4_header_t * ip);
383 #endif /* __included_nat64_h__ */
386 * fd.io coding-style-patch-verification: ON
389 * eval: (c-set-style "gnu")