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.
19 #ifndef __included_nat64_db_h__
20 #define __included_nat64_db_h__
22 #include <vppinfra/bihash_24_8.h>
23 #include <vppinfra/bihash_48_8.h>
41 } nat64_db_bib_entry_key_t;
44 typedef CLIB_PACKED(struct
46 ip6_address_t in_addr;
48 ip4_address_t out_addr;
54 }) nat64_db_bib_entry_t;
61 #define _(N, i, n, s) \
62 nat64_db_bib_entry_t *_##n##_bib;
66 nat64_db_bib_entry_t *_unk_proto_bib;
69 clib_bihash_24_8_t in2out;
70 clib_bihash_24_8_t out2in;
79 ip46_address_t l_addr;
80 ip46_address_t r_addr;
89 } nat64_db_st_entry_key_t;
92 typedef CLIB_PACKED(struct
94 ip6_address_t in_r_addr;
95 ip4_address_t out_r_addr;
101 }) nat64_db_st_entry_t;
108 #define _(N, i, n, s) \
109 nat64_db_st_entry_t *_##n##_st;
110 foreach_snat_protocol
113 nat64_db_st_entry_t *_unk_proto_st;
116 clib_bihash_48_8_t in2out;
117 clib_bihash_48_8_t out2in;
123 * @brief Call back function to free NAT64 pool address and port when BIB
126 typedef void (*nat64_db_free_addr_port_function_t) (struct nat64_db_s * db,
127 ip4_address_t * addr,
130 typedef struct nat64_db_s
134 nat64_db_free_addr_port_function_t free_addr_port_cb;
138 * @brief Initialize NAT64 DB.
140 * @param db NAT64 DB.
141 * @param bib_buckets Number of BIB hash buckets.
142 * @param bib_memory_size Memory size of BIB hash.
143 * @param st_buckets Number of session table hash buckets.
144 * @param st_memory_size Memory size of session table hash.
145 * @param free_addr_port_cb Call back function to free address and port.
147 * @returns 0 on success, non-zero value otherwise.
149 int nat64_db_init (nat64_db_t * db, u32 bib_buckets, u32 bib_memory_size,
150 u32 st_buckets, u32 st_memory_size,
151 nat64_db_free_addr_port_function_t free_addr_port_cb);
154 * @brief Create new NAT64 BIB entry.
156 * @param db NAT64 DB.
157 * @param in_addr Inside IPv6 address.
158 * @param out_addr Outside IPv4 address.
159 * @param in_port Inside port number.
160 * @param out_port Outside port number.
161 * @param fib_index FIB index.
162 * @param proto L4 protocol.
163 * @param is_static 1 if static, 0 if dynamic.
165 * @returns BIB entry on success, 0 otherwise.
167 nat64_db_bib_entry_t *nat64_db_bib_entry_create (nat64_db_t * db,
168 ip6_address_t * in_addr,
169 ip4_address_t * out_addr,
170 u16 in_port, u16 out_port,
172 u8 proto, u8 is_static);
175 * @brief Free NAT64 BIB entry.
177 * @param db NAT64 DB.
178 * @param bibe BIB entry.
180 void nat64_db_bib_entry_free (nat64_db_t * db, nat64_db_bib_entry_t * bibe);
183 * @brief Call back function when walking NAT64 BIB, non-zero
184 * return value stop walk.
186 typedef int (*nat64_db_bib_walk_fn_t) (nat64_db_bib_entry_t * bibe,
189 * @brief Walk NAT64 BIB.
191 * @param db NAT64 DB.
192 * @param proto BIB L4 protocol:
197 * - otherwise "unknown" protocol BIB
198 * @param fn The function to invoke on each entry visited.
199 * @param ctx A context passed in the visit function.
201 void nat64_db_bib_walk (nat64_db_t * db, u8 proto,
202 nat64_db_bib_walk_fn_t fn, void *ctx);
205 * @brief Find NAT64 BIB entry.
207 * @param db NAT64 DB.
208 * @param addr IP address.
209 * @param port Port number.
210 * @param proto L4 protocol.
211 * @param fib_index FIB index.
212 * @param is_ip6 1 if find by IPv6 (inside) address, 0 by IPv4 (outside).
214 * @return BIB entry if found.
216 nat64_db_bib_entry_t *nat64_db_bib_entry_find (nat64_db_t * db,
217 ip46_address_t * addr,
220 u32 fib_index, u8 is_ip6);
223 * @brief Get BIB entry by index and protocol.
225 * @param db NAT64 DB.
226 * @param proto L4 protocol.
227 * @param bibe_index BIB entry index.
229 * @return BIB entry if found.
231 nat64_db_bib_entry_t *nat64_db_bib_entry_by_index (nat64_db_t * db,
232 u8 proto, u32 bibe_index);
234 * @brief Create new NAT64 session table entry.
236 * @param db NAT64 DB.
237 * @param bibe Corresponding BIB entry.
238 * @param in_r_addr Inside IPv6 address of the remote host.
239 * @param out_r_addr Outside IPv4 address of the remote host.
240 * @param r_port Remote host port number.
242 * @returns BIB entry on success, 0 otherwise.
244 nat64_db_st_entry_t *nat64_db_st_entry_create (nat64_db_t * db,
245 nat64_db_bib_entry_t * bibe,
246 ip6_address_t * in_r_addr,
247 ip4_address_t * out_r_addr,
251 * @brief Free NAT64 session table entry.
253 * @param db NAT64 DB.
254 * @param ste Session table entry.
256 void nat64_db_st_entry_free (nat64_db_t * db, nat64_db_st_entry_t * ste);
259 * @brief Find NAT64 session table entry.
261 * @param db NAT64 DB.
262 * @param l_addr Local host address.
263 * @param r_addr Remote host address.
264 * @param l_port Local host port number.
265 * @param r_port Remote host port number.
266 * @param proto L4 protocol.
267 * @param fib_index FIB index.
268 * @param is_ip6 1 if find by IPv6 (inside) address, 0 by IPv4 (outside).
270 * @return BIB entry if found.
272 nat64_db_st_entry_t *nat64_db_st_entry_find (nat64_db_t * db,
273 ip46_address_t * l_addr,
274 ip46_address_t * r_addr,
275 u16 l_port, u16 r_port,
277 u32 fib_index, u8 is_ip6);
280 * @brief Call back function when walking NAT64 session table, non-zero
281 * return value stop walk.
283 typedef int (*nat64_db_st_walk_fn_t) (nat64_db_st_entry_t * ste, void *ctx);
286 * @brief Walk NAT64 session table.
288 * @param db NAT64 DB.
289 * @param proto L4 protocol:
290 * - 255 all session tables
291 * - 6 TCP session table
292 * - 17 UDP session table
293 * - 1/58 ICMP session table
294 * - otherwise "unknown" protocol session table
295 * @param fn The function to invoke on each entry visited.
296 * @param ctx A context passed in the visit function.
298 void nat64_db_st_walk (nat64_db_t * db, u8 proto,
299 nat64_db_st_walk_fn_t fn, void *ctx);
302 * @brief Free expired session entries in session tables.
304 * @param db NAT64 DB.
305 * @param now Current time.
307 void nad64_db_st_free_expired (nat64_db_t * db, u32 now);
310 * @brief Free sessions using specific outside address.
312 * @param db NAT64 DB.
313 * @param out_addr Outside address to match.
315 void nat64_db_free_out_addr (nat64_db_t * db, ip4_address_t * out_addr);
318 * @brief Get ST entry index.
320 * @param db NAT64 DB.
321 * @param ste ST entry.
323 * @return ST entry index on success, ~0 otherwise.
325 u32 nat64_db_st_entry_get_index (nat64_db_t * db, nat64_db_st_entry_t * ste);
328 * @brief Get ST entry by index and protocol.
330 * @param db NAT64 DB.
331 * @param proto L4 protocol.
332 * @param bibe_index ST entry index.
334 * @return BIB entry if found.
336 nat64_db_st_entry_t *nat64_db_st_entry_by_index (nat64_db_t * db,
337 u8 proto, u32 ste_index);
338 #endif /* __included_nat64_db_h__ */
341 * fd.io coding-style-patch-verification: ON
344 * eval: (c-set-style "gnu")