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 NAT plugin virtual fragmentation reassembly
19 #ifndef __included_nat_reass_h__
20 #define __included_nat_reass_h__
22 #include <vnet/vnet.h>
23 #include <vnet/ip/ip.h>
24 #include <vppinfra/bihash_16_8.h>
25 #include <vppinfra/bihash_48_8.h>
26 #include <vppinfra/dlist.h>
28 #define NAT_REASS_TIMEOUT_DEFAULT 2
29 #define NAT_MAX_REASS_DEAFULT 1024
30 #define NAT_MAX_FRAG_DEFAULT 5
31 #define NAT_REASS_HT_LOAD_FACTOR (0.75)
41 /* align by making this 4 octets even though its a 2 octets field */
43 /* align by making this 4 octets even though its a 1 octet field */
48 } nat_reass_ip4_key_t;
51 typedef CLIB_PACKED(struct
53 nat_reass_ip4_key_t key;
58 u32 frags_per_reass_list_head_index;
72 /* align by making this 4 octets even though its a 1 octet field */
78 } nat_reass_ip6_key_t;
81 typedef CLIB_PACKED(struct
83 nat_reass_ip6_key_t key;
87 u32 frags_per_reass_list_head_index;
107 nat_reass_ip4_t *ip4_reass_pool;
108 clib_bihash_16_8_t ip4_reass_hash;
109 dlist_elt_t *ip4_reass_lru_list_pool;
110 dlist_elt_t *ip4_frags_list_pool;
111 u32 ip4_reass_head_index;
113 clib_spinlock_t ip4_reass_lock;
116 nat_reass_ip6_t *ip6_reass_pool;
117 clib_bihash_48_8_t ip6_reass_hash;
118 dlist_elt_t *ip6_reass_lru_list_pool;
119 dlist_elt_t *ip6_frags_list_pool;
120 u32 ip6_reass_head_index;
122 clib_spinlock_t ip6_reass_lock;
125 vlib_main_t *vlib_main;
126 vnet_main_t *vnet_main;
130 * @brief Set NAT virtual fragmentation reassembly configuration.
132 * @param timeout Reassembly timeout.
133 * @param max_reass Maximum number of concurrent reassemblies.
134 * @param max_frag Maximum number of fragmets per reassembly
135 * @param drop_frag If zero translate fragments, otherwise drop fragments.
136 * @param is_ip6 1 if IPv6, 0 if IPv4.
138 * @returns 0 on success, non-zero value otherwise.
140 int nat_reass_set (u32 timeout, u16 max_reass, u8 max_frag, u8 drop_frag,
144 * @brief Get reassembly timeout.
146 * @param is_ip6 1 if IPv6, 0 if IPv4.
148 * @returns reassembly timeout.
150 u32 nat_reass_get_timeout (u8 is_ip6);
153 * @brief Get maximum number of concurrent reassemblies.
155 * @param is_ip6 1 if IPv6, 0 if IPv4.
157 * @returns maximum number of concurrent reassemblies.
159 u16 nat_reass_get_max_reass (u8 is_ip6);
162 * @brief Get maximum number of fragmets per reassembly.
164 * @param is_ip6 1 if IPv6, 0 if IPv4.
166 * @returns maximum number of fragmets per reassembly.
168 u8 nat_reass_get_max_frag (u8 is_ip6);
171 * @brief Get status of virtual fragmentation reassembly.
173 * @param is_ip6 1 if IPv6, 0 if IPv4.
175 * @returns zero if translate fragments, non-zero value if drop fragments.
177 u8 nat_reass_is_drop_frag (u8 is_ip6);
180 * @brief Initialize NAT virtual fragmentation reassembly.
182 * @param vm vlib main.
184 * @return error code.
186 clib_error_t *nat_reass_init (vlib_main_t * vm);
189 * @brief Find reassembly.
191 * @param src Source IPv4 address.
192 * @param dst Destination IPv4 address.
193 * @param frag_id Fragment ID.
194 * @param proto L4 protocol.
196 * @returns Reassembly data or 0 if not found.
198 nat_reass_ip4_t *nat_ip4_reass_find (ip4_address_t src,
200 u16 frag_id, u8 proto);
203 * @brief Find or create reassembly.
205 * @param src Source IPv4 address.
206 * @param dst Destination IPv4 address.
207 * @param frag_id Fragment ID.
208 * @param proto L4 protocol.
209 * @param reset_timeout If non-zero value reset timeout.
210 * @param bi_to_drop Fragments to drop.
212 * @returns Reassembly data or 0 on failure.
214 nat_reass_ip4_t *nat_ip4_reass_find_or_create (ip4_address_t src,
216 u16 frag_id, u8 proto,
221 * @brief Cache fragment.
223 * @param reass Reassembly data.
224 * @param bi Buffer index.
226 * @returns 0 on success, non-zero value otherwise.
228 int nat_ip4_reass_add_fragment (nat_reass_ip4_t * reass, u32 bi);
231 * @brief Get cached fragments.
233 * @param reass Reassembly data.
234 * @param bi Vector of buffer indexes.
236 void nat_ip4_reass_get_frags (nat_reass_ip4_t * reass, u32 ** bi);
239 * @breif Call back function when walking IPv4 reassemblies, non-zero return
242 typedef int (*nat_ip4_reass_walk_fn_t) (nat_reass_ip4_t * reass, void *ctx);
245 * @brief Walk IPv4 reassemblies.
247 * @param fn The function to invoke on each entry visited.
248 * @param ctx A context passed in the visit function.
250 void nat_ip4_reass_walk (nat_ip4_reass_walk_fn_t fn, void *ctx);
253 * @brief Find or create reassembly.
255 * @param src Source IPv6 address.
256 * @param dst Destination IPv6 address.
257 * @param frag_id Fragment ID.
258 * @param proto L4 protocol.
259 * @param reset_timeout If non-zero value reset timeout.
260 * @param bi_to_drop Fragments to drop.
262 * @returns Reassembly data or 0 on failure.
264 nat_reass_ip6_t *nat_ip6_reass_find_or_create (ip6_address_t src,
266 u32 frag_id, u8 proto,
270 * @brief Cache fragment.
272 * @param reass Reassembly data.
273 * @param bi Buffer index.
275 * @returns 0 on success, non-zero value otherwise.
277 int nat_ip6_reass_add_fragment (nat_reass_ip6_t * reass, u32 bi);
280 * @brief Get cached fragments.
282 * @param reass Reassembly data.
283 * @param bi Vector of buffer indexes.
285 void nat_ip6_reass_get_frags (nat_reass_ip6_t * reass, u32 ** bi);
288 * @breif Call back function when walking IPv6 reassemblies, non-zero return
291 typedef int (*nat_ip6_reass_walk_fn_t) (nat_reass_ip6_t * reass, void *ctx);
294 * @brief Walk IPv6 reassemblies.
296 * @param fn The function to invoke on each entry visited.
297 * @param ctx A context passed in the visit function.
299 void nat_ip6_reass_walk (nat_ip6_reass_walk_fn_t fn, void *ctx);
301 #endif /* __included_nat_reass_h__ */
304 * fd.io coding-style-patch-verification: ON
307 * eval: (c-set-style "gnu")