2 * Copyright (c) 2020 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.
16 #ifndef __CNAT_TYPES_H__
17 #define __CNAT_TYPES_H__
19 #include <vppinfra/bihash_24_8.h>
20 #include <vnet/fib/fib_node.h>
21 #include <vnet/fib/fib_source.h>
22 #include <vnet/ip/ip_types.h>
23 #include <vnet/ip/ip.h>
24 #include <vnet/util/throttle.h>
26 /* only in the default table for v4 and v6 */
27 #define CNAT_FIB_TABLE 0
29 /* default lifetime of NAT sessions (seconds) */
30 #define CNAT_DEFAULT_SESSION_MAX_AGE 30
31 /* lifetime of TCP conn NAT sessions after SYNACK (seconds) */
32 #define CNAT_DEFAULT_TCP_MAX_AGE 3600
33 /* lifetime of TCP conn NAT sessions after RST/FIN (seconds) */
34 #define CNAT_DEFAULT_TCP_RST_TIMEOUT 5
35 #define CNAT_DEFAULT_SCANNER_TIMEOUT (1.0)
37 #define CNAT_DEFAULT_SESSION_BUCKETS 1024
38 #define CNAT_DEFAULT_TRANSLATION_BUCKETS 1024
39 #define CNAT_DEFAULT_CLIENT_BUCKETS 1024
40 #define CNAT_DEFAULT_SNAT_BUCKETS 1024
41 #define CNAT_DEFAULT_SNAT_IF_MAP_LEN 4096
43 #define CNAT_DEFAULT_SESSION_MEMORY (1 << 20)
44 #define CNAT_DEFAULT_TRANSLATION_MEMORY (256 << 10)
45 #define CNAT_DEFAULT_CLIENT_MEMORY (256 << 10)
46 #define CNAT_DEFAULT_SNAT_MEMORY (64 << 10)
48 /* Should be prime >~ 100 * numBackends */
49 #define CNAT_DEFAULT_MAGLEV_LEN 1009
51 /* This should be strictly lower than FIB_SOURCE_INTERFACE
52 * from fib_source.h */
53 #define CNAT_FIB_SOURCE_PRIORITY 0x02
55 /* Initial number of timestamps for a session
56 * this will be incremented when adding the reverse
57 * session in cnat_rsession_create */
58 #define CNAT_TIMESTAMP_INIT_REFCNT 1
60 #define MIN_SRC_PORT ((u16) 0xC000)
64 /* Source and destination port. */
65 u16 src_port, dst_port;
67 /* Random value to distinguish connections. */
73 typedef enum cnat_trk_flag_t_
75 /* Endpoint is active (static or dhcp resolved) */
76 CNAT_TRK_ACTIVE = (1 << 0),
77 /* Don't translate this endpoint, but still
78 * forward. Used by maglev for DSR */
79 CNAT_TRK_FLAG_NO_NAT = (1 << 1),
81 CNAT_TRK_FLAG_TEST_DISABLED = (1 << 7),
86 /* Endpoint addr has been resolved */
87 CNAT_EP_FLAG_RESOLVED = (1 << 0),
90 typedef struct cnat_endpoint_t_
98 typedef struct cnat_endpoint_tuple_t_
100 cnat_endpoint_t dst_ep;
101 cnat_endpoint_t src_ep;
102 u8 ep_flags; /* cnat_trk_flag_t */
103 } cnat_endpoint_tuple_t;
109 } cnat_echo_header_t;
111 typedef struct cnat_main_
113 /* Memory size of the session bihash */
114 uword session_hash_memory;
116 /* Number of buckets of the session bihash */
117 u32 session_hash_buckets;
119 /* Memory size of the translation bihash */
120 uword translation_hash_memory;
122 /* Number of buckets of the translation bihash */
123 u32 translation_hash_buckets;
125 /* Memory size of the client bihash */
126 uword client_hash_memory;
128 /* Number of buckets of the client bihash */
129 u32 client_hash_buckets;
131 /* Memory size of the source NAT prefix bihash */
132 uword snat_hash_memory;
134 /* Number of buckets of the source NAT prefix bihash */
135 u32 snat_hash_buckets;
137 /* Bit map for include / exclude sw_if_index
138 * so max number of expected interfaces */
139 u32 snat_if_map_length;
141 /* Timeout after which to clear sessions (in seconds) */
144 /* Timeout after which to clear an established TCP
145 * session (in seconds) */
148 /* delay in seconds between two scans of session/clients tables */
151 /* Index of the scanner process node */
152 uword scanner_node_index;
154 /* Did we do lazy init ? */
157 /* Enable or Disable the scanner on startup */
158 u8 default_scanner_state;
160 /* Number of buckets for maglev, should be a
161 * prime >= 100 * max num bakends */
165 typedef struct cnat_timestamp_t_
167 /* Last time said session was seen */
169 /* expire after N seconds */
171 /* Users refcount, initially 3 (session, rsession, dpo) */
175 /* Create the first pool with 1 << CNAT_TS_BASE_SIZE elts */
176 #define CNAT_TS_BASE_SIZE (8)
177 /* reserve the top CNAT_TS_MPOOL_BITS bits for finding the pool */
178 #define CNAT_TS_MPOOL_BITS (6)
180 typedef struct cnat_timestamp_mpool_t_
182 /* Increasing fixed size pools of timestamps */
183 cnat_timestamp_t *ts_pools[1 << CNAT_TS_MPOOL_BITS];
184 /* Bitmap of pools with free space */
186 /* Index of next pool to init */
187 u8 next_empty_pool_idx;
188 /* ts creation lock */
189 clib_spinlock_t ts_lock;
190 } cnat_timestamp_mpool_t;
192 typedef struct cnat_node_ctx_
196 ip_address_family_t af;
200 cnat_main_t *cnat_get_main ();
201 extern u8 *format_cnat_endpoint (u8 * s, va_list * args);
202 extern uword unformat_cnat_ep_tuple (unformat_input_t * input,
204 extern uword unformat_cnat_ep (unformat_input_t * input, va_list * args);
205 extern cnat_timestamp_mpool_t cnat_timestamps;
206 extern cnat_main_t cnat_main;
208 extern char *cnat_error_strings[];
212 #define cnat_error(n,s) CNAT_ERROR_##n,
213 #include <cnat/cnat_error.def>
218 typedef enum cnat_scanner_cmd_t_
222 } cnat_scanner_cmd_t;
225 * Lazy initialization when first adding a translation
228 extern void cnat_lazy_init ();
231 * Enable/Disable session cleanup
233 extern void cnat_enable_disable_scanner (cnat_scanner_cmd_t event_type);
236 * Resolve endpoint address
238 extern u8 cnat_resolve_ep (cnat_endpoint_t * ep);
239 extern u8 cnat_resolve_addr (u32 sw_if_index, ip_address_family_t af,
240 ip_address_t * addr);
244 * fd.io coding-style-patch-verification: ON
247 * eval: (c-set-style "gnu")