src/plugins/cnat/cnat_session.c

   1 /*
   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:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   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.
  14  */
  15
  16 #include <vnet/ip/ip.h>
  17 #include <cnat/cnat_session.h>
  18 #include <cnat/cnat_inline.h>
  19
  20 #include <vppinfra/bihash_template.h>
  21 #include <vppinfra/bihash_template.c>
  22
  23 cnat_bihash_t cnat_session_db;
  24 void (*cnat_free_port_cb) (u16 port, ip_protocol_t iproto);
  25
  26 typedef struct cnat_session_walk_ctx_t_
  27 {
  28   cnat_session_walk_cb_t cb;
  29   void *ctx;
  30 } cnat_session_walk_ctx_t;
  31
  32 static int
  33 cnat_session_walk_cb (BVT (clib_bihash_kv) * kv, void *arg)
  34 {
  35   cnat_session_t *session = (cnat_session_t *) kv;
  36   cnat_session_walk_ctx_t *ctx = arg;
  37
  38   ctx->cb (session, ctx->ctx);
  39
  40   return (BIHASH_WALK_CONTINUE);
  41 }
  42
  43 void
  44 cnat_session_walk (cnat_session_walk_cb_t cb, void *ctx)
  45 {
  46   cnat_session_walk_ctx_t wctx = {
  47     .cb = cb,
  48     .ctx = ctx,
  49   };
  50   BV (clib_bihash_foreach_key_value_pair) (&cnat_session_db,
  51                                            cnat_session_walk_cb, &wctx);
  52 }
  53
  54 typedef struct cnat_session_purge_walk_t_
  55 {
  56   cnat_bihash_kv_t *keys;
  57 } cnat_session_purge_walk_ctx_t;
  58
  59 static int
  60 cnat_session_purge_walk (BVT (clib_bihash_kv) * key, void *arg)
  61 {
  62   cnat_session_purge_walk_ctx_t *ctx = arg;
  63
  64   vec_add1 (ctx->keys, *key);
  65
  66   return (BIHASH_WALK_CONTINUE);
  67 }
  68
  69 u8 *
  70 format_cnat_session_location (u8 *s, va_list *args)
  71 {
  72   u8 location = va_arg (*args, int);
  73   switch (location)
  74     {
  75     case CNAT_LOCATION_INPUT:
  76       s = format (s, "input");
  77       break;
  78     case CNAT_LOCATION_OUTPUT:
  79       s = format (s, "output");
  80       break;
  81     case CNAT_LOCATION_FIB:
  82       s = format (s, "fib");
  83       break;
  84     default:
  85       s = format (s, "unknown");
  86       break;
  87     }
  88   return (s);
  89 }
  90
  91 u8 *
  92 format_cnat_session (u8 * s, va_list * args)
  93 {
  94   cnat_session_t *sess = va_arg (*args, cnat_session_t *);
  95   CLIB_UNUSED (int verbose) = va_arg (*args, int);
  96   f64 ts = 0;
  97   if (!pool_is_free_index (cnat_timestamps, sess->value.cs_ts_index))
  98     ts = cnat_timestamp_exp (sess->value.cs_ts_index);
  99
 100   s = format (
 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);
 111
 112   return (s);
 113 }
 114
 115 static clib_error_t *
 116 cnat_session_show (vlib_main_t * vm,
 117                    unformat_input_t * input, vlib_cli_command_t * cmd)
 118 {
 119   u8 verbose = 0;
 120   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 121     {
 122       if (unformat (input, "verbose"))
 123         verbose = 1;
 124       else
 125         return (clib_error_return (0, "unknown input '%U'",
 126                                    format_unformat_error, input));
 127     }
 128
 129   vlib_cli_output (vm, "CNat Sessions: now:%f\n%U\n",
 130                    vlib_time_now (vm),
 131                    BV (format_bihash), &cnat_session_db, verbose);
 132
 133   return (NULL);
 134 }
 135
 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",
 140   .is_mp_safe = 1,
 141 };
 142
 143 void
 144 cnat_session_free (cnat_session_t * session)
 145 {
 146   cnat_bihash_kv_t *bkey = (cnat_bihash_kv_t *) session;
 147   /* age it */
 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);
 154
 155   cnat_bihash_add_del (&cnat_session_db, bkey, 0 /* is_add */);
 156 }
 157
 158 int
 159 cnat_session_purge (void)
 160 {
 161   /* flush all the session from the DB */
 162   cnat_session_purge_walk_ctx_t ctx = { };
 163   cnat_bihash_kv_t *key;
 164
 165   BV (clib_bihash_foreach_key_value_pair) (&cnat_session_db,
 166                                            cnat_session_purge_walk, &ctx);
 167
 168   vec_foreach (key, ctx.keys) cnat_session_free ((cnat_session_t *) key);
 169
 170   vec_free (ctx.keys);
 171
 172   return (0);
 173 }
 174
 175 u64
 176 cnat_session_scan (vlib_main_t * vm, f64 start_time, int i)
 177 {
 178   BVT (clib_bihash) * h = &cnat_session_db;
 179   int j, k;
 180
 181   /* Don't scan the l2 fib if it hasn't been instantiated yet */
 182   if (alloc_arena (h) == 0)
 183     return 0.0;
 184
 185   for ( /* caller saves starting point */ ; i < h->nbuckets; i++)
 186     {
 187       /* allow no more than 100us without a pause */
 188       if ((vlib_time_now (vm) - start_time) > 10e-5)
 189         return (i);
 190
 191       if (i < (h->nbuckets - 3))
 192         {
 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))
 198             {
 199               BVT (clib_bihash_value) * v =
 200                 BV (clib_bihash_get_value) (h, b->offset);
 201               CLIB_PREFETCH (v, CLIB_CACHE_LINE_BYTES, LOAD);
 202             }
 203         }
 204
 205       BVT (clib_bihash_bucket) * b = BV (clib_bihash_get_bucket) (h, i);
 206       if (BV (clib_bihash_bucket_is_empty) (b))
 207         continue;
 208       BVT (clib_bihash_value) * v = BV (clib_bihash_get_value) (h, b->offset);
 209       for (j = 0; j < (1 << b->log2_pages); j++)
 210         {
 211           for (k = 0; k < BIHASH_KVP_PER_PAGE; k++)
 212             {
 213               if (v->kvp[k].key[0] == ~0ULL && v->kvp[k].value[0] == ~0ULL)
 214                 continue;
 215
 216               cnat_session_t *session = (cnat_session_t *) & v->kvp[k];
 217
 218               if (start_time >
 219                   cnat_timestamp_exp (session->value.cs_ts_index))
 220                 {
 221                   /* age it */
 222                   cnat_session_free (session);
 223
 224                   /*
 225                    * Note: we may have just freed the bucket's backing
 226                    * storage, so check right here...
 227                    */
 228                   if (BV (clib_bihash_bucket_is_empty) (b))
 229                     goto doublebreak;
 230                 }
 231             }
 232           v++;
 233         }
 234     doublebreak:
 235       ;
 236     }
 237
 238   /* start again */
 239   return (0);
 240 }
 241
 242 static clib_error_t *
 243 cnat_session_init (vlib_main_t * vm)
 244 {
 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);
 250
 251   return (NULL);
 252 }
 253
 254 VLIB_INIT_FUNCTION (cnat_session_init);
 255
 256 static clib_error_t *
 257 cnat_timestamp_show (vlib_main_t * vm,
 258                      unformat_input_t * input, vlib_cli_command_t * cmd)
 259 {
 260   cnat_timestamp_t *ts;
 261   clib_rwlock_reader_lock (&cnat_main.ts_lock);
 262   pool_foreach (ts, cnat_timestamps)
 263     {
 264       vlib_cli_output (vm, "[%d] last_seen:%f lifetime:%u ref:%u",
 265                        ts - cnat_timestamps, ts->last_seen, ts->lifetime,
 266                        ts->refcnt);
 267     }
 268   clib_rwlock_reader_unlock (&cnat_main.ts_lock);
 269   return (NULL);
 270 }
 271
 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",
 276   .is_mp_safe = 1,
 277 };
 278
 279 /*
 280  * fd.io coding-style-patch-verification: ON
 281  *
 282  * Local Variables:
 283  * eval: (c-set-style "gnu")
 284  * End:
 285  */