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);
97 if (!pool_is_free_index (cnat_timestamps, sess->value.cs_ts_index))
98 ts = cnat_timestamp_exp (sess->value.cs_ts_index);
101 s, "session:[%U;%d -> %U;%d, %U] => %U;%d -> %U;%d %U lb:%d age:%f",
102 format_ip46_address, &sess->key.cs_ip[VLIB_RX], IP46_TYPE_ANY,
103 clib_host_to_net_u16 (sess->key.cs_port[VLIB_RX]), format_ip46_address,
104 &sess->key.cs_ip[VLIB_TX], IP46_TYPE_ANY,
105 clib_host_to_net_u16 (sess->key.cs_port[VLIB_TX]), format_ip_protocol,
106 sess->key.cs_proto, format_ip46_address, &sess->value.cs_ip[VLIB_RX],
107 IP46_TYPE_ANY, clib_host_to_net_u16 (sess->value.cs_port[VLIB_RX]),
108 format_ip46_address, &sess->value.cs_ip[VLIB_TX], IP46_TYPE_ANY,
109 clib_host_to_net_u16 (sess->value.cs_port[VLIB_TX]),
110 format_cnat_session_location, sess->key.cs_loc, sess->value.cs_lbi, ts);
115 static clib_error_t *
116 cnat_session_show (vlib_main_t * vm,
117 unformat_input_t * input, vlib_cli_command_t * cmd)
120 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
122 if (unformat (input, "verbose"))
125 return (clib_error_return (0, "unknown input '%U'",
126 format_unformat_error, input));
129 vlib_cli_output (vm, "CNat Sessions: now:%f\n%U\n",
131 BV (format_bihash), &cnat_session_db, verbose);
136 VLIB_CLI_COMMAND (cnat_session_show_cmd_node, static) = {
137 .path = "show cnat session",
138 .function = cnat_session_show,
139 .short_help = "show cnat session",
144 cnat_session_free (cnat_session_t * session)
146 cnat_bihash_kv_t *bkey = (cnat_bihash_kv_t *) session;
148 if (session->value.flags & CNAT_SESSION_FLAG_ALLOC_PORT)
149 cnat_free_port_cb (session->value.cs_port[VLIB_RX],
150 session->key.cs_proto);
151 if (!(session->value.flags & CNAT_SESSION_FLAG_NO_CLIENT))
152 cnat_client_free_by_ip (&session->key.cs_ip[VLIB_TX], session->key.cs_af);
153 cnat_timestamp_free (session->value.cs_ts_index);
155 cnat_bihash_add_del (&cnat_session_db, bkey, 0 /* is_add */);
159 cnat_session_purge (void)
161 /* flush all the session from the DB */
162 cnat_session_purge_walk_ctx_t ctx = { };
163 cnat_bihash_kv_t *key;
165 BV (clib_bihash_foreach_key_value_pair) (&cnat_session_db,
166 cnat_session_purge_walk, &ctx);
168 vec_foreach (key, ctx.keys) cnat_session_free ((cnat_session_t *) key);
176 cnat_session_scan (vlib_main_t * vm, f64 start_time, int i)
178 BVT (clib_bihash) * h = &cnat_session_db;
181 /* Don't scan the l2 fib if it hasn't been instantiated yet */
182 if (alloc_arena (h) == 0)
185 for ( /* caller saves starting point */ ; i < h->nbuckets; i++)
187 /* allow no more than 100us without a pause */
188 if ((vlib_time_now (vm) - start_time) > 10e-5)
191 if (i < (h->nbuckets - 3))
193 BVT (clib_bihash_bucket) * b =
194 BV (clib_bihash_get_bucket) (h, i + 3);
195 CLIB_PREFETCH (b, CLIB_CACHE_LINE_BYTES, LOAD);
196 b = BV (clib_bihash_get_bucket) (h, i + 1);
197 if (!BV (clib_bihash_bucket_is_empty) (b))
199 BVT (clib_bihash_value) * v =
200 BV (clib_bihash_get_value) (h, b->offset);
201 CLIB_PREFETCH (v, CLIB_CACHE_LINE_BYTES, LOAD);
205 BVT (clib_bihash_bucket) * b = BV (clib_bihash_get_bucket) (h, i);
206 if (BV (clib_bihash_bucket_is_empty) (b))
208 BVT (clib_bihash_value) * v = BV (clib_bihash_get_value) (h, b->offset);
209 for (j = 0; j < (1 << b->log2_pages); j++)
211 for (k = 0; k < BIHASH_KVP_PER_PAGE; k++)
213 if (v->kvp[k].key[0] == ~0ULL && v->kvp[k].value[0] == ~0ULL)
216 cnat_session_t *session = (cnat_session_t *) & v->kvp[k];
219 cnat_timestamp_exp (session->value.cs_ts_index))
222 cnat_session_free (session);
225 * Note: we may have just freed the bucket's backing
226 * storage, so check right here...
228 if (BV (clib_bihash_bucket_is_empty) (b))
242 static clib_error_t *
243 cnat_session_init (vlib_main_t * vm)
245 cnat_main_t *cm = &cnat_main;
246 BV (clib_bihash_init) (&cnat_session_db,
247 "CNat Session DB", cm->session_hash_buckets,
248 cm->session_hash_memory);
249 BV (clib_bihash_set_kvp_format_fn) (&cnat_session_db, format_cnat_session);
254 VLIB_INIT_FUNCTION (cnat_session_init);
256 static clib_error_t *
257 cnat_timestamp_show (vlib_main_t * vm,
258 unformat_input_t * input, vlib_cli_command_t * cmd)
260 cnat_timestamp_t *ts;
261 clib_rwlock_reader_lock (&cnat_main.ts_lock);
262 pool_foreach (ts, cnat_timestamps)
264 vlib_cli_output (vm, "[%d] last_seen:%f lifetime:%u ref:%u",
265 ts - cnat_timestamps, ts->last_seen, ts->lifetime,
268 clib_rwlock_reader_unlock (&cnat_main.ts_lock);
272 VLIB_CLI_COMMAND (cnat_timestamp_show_cmd, static) = {
273 .path = "show cnat timestamp",
274 .function = cnat_timestamp_show,
275 .short_help = "show cnat timestamp",
280 * fd.io coding-style-patch-verification: ON
283 * eval: (c-set-style "gnu")