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 #include <vnet/ip/ip.h>
17 #include <cnat/cnat_session.h>
18 #include <cnat/cnat_inline.h>
20 #include <vppinfra/bihash_template.h>
21 #include <vppinfra/bihash_template.c>
23 cnat_bihash_t cnat_session_db;
24 void (*cnat_free_port_cb) (u16 port, ip_protocol_t iproto);
26 typedef struct cnat_session_walk_ctx_t_
28 cnat_session_walk_cb_t cb;
30 } cnat_session_walk_ctx_t;
33 cnat_session_walk_cb (BVT (clib_bihash_kv) * kv, void *arg)
35 cnat_session_t *session = (cnat_session_t *) kv;
36 cnat_session_walk_ctx_t *ctx = arg;
38 ctx->cb (session, ctx->ctx);
40 return (BIHASH_WALK_CONTINUE);
44 cnat_session_walk (cnat_session_walk_cb_t cb, void *ctx)
46 cnat_session_walk_ctx_t wctx = {
50 BV (clib_bihash_foreach_key_value_pair) (&cnat_session_db,
51 cnat_session_walk_cb, &wctx);
54 typedef struct cnat_session_purge_walk_t_
56 cnat_bihash_kv_t *keys;
57 } cnat_session_purge_walk_ctx_t;
60 cnat_session_purge_walk (BVT (clib_bihash_kv) * key, void *arg)
62 cnat_session_purge_walk_ctx_t *ctx = arg;
64 vec_add1 (ctx->keys, *key);
66 return (BIHASH_WALK_CONTINUE);
70 format_cnat_session_location (u8 *s, va_list *args)
72 u8 location = va_arg (*args, int);
75 case CNAT_LOCATION_INPUT:
76 s = format (s, "input");
78 case CNAT_LOCATION_OUTPUT:
79 s = format (s, "output");
81 case CNAT_LOCATION_FIB:
82 s = format (s, "fib");
85 s = format (s, "unknown");
92 format_cnat_session (u8 * s, va_list * args)
94 cnat_session_t *sess = va_arg (*args, cnat_session_t *);
95 CLIB_UNUSED (int verbose) = va_arg (*args, int);
98 if (!cnat_ts_is_free_index (sess->value.cs_ts_index))
99 ts = cnat_timestamp_exp (sess->value.cs_ts_index);
102 s, "session:[%U;%d -> %U;%d, %U] => %U;%d -> %U;%d %U lb:%d age:%f",
103 format_ip46_address, &sess->key.cs_ip[VLIB_RX], IP46_TYPE_ANY,
104 clib_host_to_net_u16 (sess->key.cs_port[VLIB_RX]), format_ip46_address,
105 &sess->key.cs_ip[VLIB_TX], IP46_TYPE_ANY,
106 clib_host_to_net_u16 (sess->key.cs_port[VLIB_TX]), format_ip_protocol,
107 sess->key.cs_proto, format_ip46_address, &sess->value.cs_ip[VLIB_RX],
108 IP46_TYPE_ANY, clib_host_to_net_u16 (sess->value.cs_port[VLIB_RX]),
109 format_ip46_address, &sess->value.cs_ip[VLIB_TX], IP46_TYPE_ANY,
110 clib_host_to_net_u16 (sess->value.cs_port[VLIB_TX]),
111 format_cnat_session_location, sess->key.cs_loc, sess->value.cs_lbi, ts);
116 static clib_error_t *
117 cnat_session_show (vlib_main_t * vm,
118 unformat_input_t * input, vlib_cli_command_t * cmd)
121 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
123 if (unformat (input, "verbose"))
126 return (clib_error_return (0, "unknown input '%U'",
127 format_unformat_error, input));
130 vlib_cli_output (vm, "CNat Sessions: now:%f\n%U\n",
132 BV (format_bihash), &cnat_session_db, verbose);
137 VLIB_CLI_COMMAND (cnat_session_show_cmd_node, static) = {
138 .path = "show cnat session",
139 .function = cnat_session_show,
140 .short_help = "show cnat session",
145 cnat_session_free (cnat_session_t * session)
147 cnat_bihash_kv_t *bkey = (cnat_bihash_kv_t *) session;
149 if (session->value.flags & CNAT_SESSION_FLAG_ALLOC_PORT)
150 cnat_free_port_cb (session->value.cs_port[VLIB_RX],
151 session->key.cs_proto);
152 if (!(session->value.flags & CNAT_SESSION_FLAG_NO_CLIENT))
153 cnat_client_free_by_ip (&session->key.cs_ip[VLIB_TX], session->key.cs_af);
154 cnat_timestamp_free (session->value.cs_ts_index);
156 cnat_bihash_add_del (&cnat_session_db, bkey, 0 /* is_add */);
160 cnat_session_purge (void)
162 /* flush all the session from the DB */
163 cnat_session_purge_walk_ctx_t ctx = { };
164 cnat_bihash_kv_t *key;
166 BV (clib_bihash_foreach_key_value_pair) (&cnat_session_db,
167 cnat_session_purge_walk, &ctx);
169 vec_foreach (key, ctx.keys) cnat_session_free ((cnat_session_t *) key);
177 cnat_reverse_session_free (cnat_session_t *session)
179 cnat_bihash_kv_t bkey, bvalue;
180 cnat_session_t *rsession = (cnat_session_t *) &bkey;
183 ip46_address_copy (&rsession->key.cs_ip[VLIB_RX],
184 &session->value.cs_ip[VLIB_TX]);
185 ip46_address_copy (&rsession->key.cs_ip[VLIB_TX],
186 &session->value.cs_ip[VLIB_RX]);
187 rsession->key.cs_proto = session->key.cs_proto;
188 rsession->key.cs_loc = session->key.cs_loc == CNAT_LOCATION_OUTPUT ?
189 CNAT_LOCATION_INPUT :
190 CNAT_LOCATION_OUTPUT;
191 rsession->key.__cs_pad = 0;
192 rsession->key.cs_af = session->key.cs_af;
193 rsession->key.cs_port[VLIB_RX] = session->value.cs_port[VLIB_TX];
194 rsession->key.cs_port[VLIB_TX] = session->value.cs_port[VLIB_RX];
196 rv = cnat_bihash_search_i2 (&cnat_session_db, &bkey, &bvalue);
199 /* other session is in bihash */
200 cnat_session_t *rsession = (cnat_session_t *) &bvalue;
201 cnat_session_free (rsession);
206 cnat_session_scan (vlib_main_t * vm, f64 start_time, int i)
208 BVT (clib_bihash) * h = &cnat_session_db;
211 if (alloc_arena (h) == 0)
214 for ( /* caller saves starting point */ ; i < h->nbuckets; i++)
216 /* allow no more than 100us without a pause */
217 if ((vlib_time_now (vm) - start_time) > 10e-5)
220 if (i < (h->nbuckets - 3))
222 BVT (clib_bihash_bucket) * b =
223 BV (clib_bihash_get_bucket) (h, i + 3);
224 clib_prefetch_load (b);
225 b = BV (clib_bihash_get_bucket) (h, i + 1);
226 if (!BV (clib_bihash_bucket_is_empty) (b))
228 BVT (clib_bihash_value) * v =
229 BV (clib_bihash_get_value) (h, b->offset);
230 clib_prefetch_load (v);
234 BVT (clib_bihash_bucket) * b = BV (clib_bihash_get_bucket) (h, i);
235 if (BV (clib_bihash_bucket_is_empty) (b))
237 BVT (clib_bihash_value) * v = BV (clib_bihash_get_value) (h, b->offset);
238 for (j = 0; j < (1 << b->log2_pages); j++)
240 for (k = 0; k < BIHASH_KVP_PER_PAGE; k++)
242 if (BV (clib_bihash_is_free) (&v->kvp[k]))
245 cnat_session_t *session = (cnat_session_t *) & v->kvp[k];
248 cnat_timestamp_exp (session->value.cs_ts_index))
251 cnat_reverse_session_free (session);
252 /* this should be last as deleting the session memset it to
254 cnat_session_free (session);
257 * Note: we may have just freed the bucket's backing
258 * storage, so check right here...
260 if (BV (clib_bihash_bucket_is_empty) (b))
274 static clib_error_t *
275 cnat_session_init (vlib_main_t * vm)
277 cnat_main_t *cm = &cnat_main;
278 BV (clib_bihash_init) (&cnat_session_db,
279 "CNat Session DB", cm->session_hash_buckets,
280 cm->session_hash_memory);
281 BV (clib_bihash_set_kvp_format_fn) (&cnat_session_db, format_cnat_session);
283 cnat_timestamps.next_empty_pool_idx = 0;
284 clib_bitmap_alloc (cnat_timestamps.ts_free, 1 << CNAT_TS_MPOOL_BITS);
285 clib_bitmap_set_region (cnat_timestamps.ts_free, 0, 1,
286 1 << CNAT_TS_MPOOL_BITS);
287 clib_spinlock_init (&cnat_timestamps.ts_lock);
292 VLIB_INIT_FUNCTION (cnat_session_init);
294 static clib_error_t *
295 cnat_timestamp_show (vlib_main_t * vm,
296 unformat_input_t * input, vlib_cli_command_t * cmd)
298 cnat_timestamp_t *ts;
301 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
303 if (unformat (input, "verbose"))
306 return (clib_error_return (0, "unknown input '%U'",
307 format_unformat_error, input));
310 for (int i = 0; i < cnat_timestamps.next_empty_pool_idx; i++)
312 cnt = pool_elts (cnat_timestamps.ts_pools[i]);
314 vlib_cli_output (vm, "-- Pool %d [%d/%d]", i, cnt,
315 pool_header (cnat_timestamps.ts_pools[i])->max_elts);
318 pool_foreach (ts, cnat_timestamps.ts_pools[i])
319 vlib_cli_output (vm, "[%d] last_seen:%f lifetime:%u ref:%u",
320 ts - cnat_timestamps.ts_pools[i], ts->last_seen,
321 ts->lifetime, ts->refcnt);
323 vlib_cli_output (vm, "Total timestamps %d", ts_cnt);
327 VLIB_CLI_COMMAND (cnat_timestamp_show_cmd, static) = {
328 .path = "show cnat timestamp",
329 .function = cnat_timestamp_show,
330 .short_help = "show cnat timestamp [verbose]",
335 * fd.io coding-style-patch-verification: ON
338 * eval: (c-set-style "gnu")