src/vnet/crypto/cli.c

   1 /*
   2  * Copyright (c) 2019 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 <stdbool.h>
  17 #include <vlib/vlib.h>
  18 #include <vnet/crypto/crypto.h>
  19
  20 static clib_error_t *
  21 show_crypto_engines_command_fn (vlib_main_t * vm,
  22                                 unformat_input_t * input,
  23                                 vlib_cli_command_t * cmd)
  24 {
  25   unformat_input_t _line_input, *line_input = &_line_input;
  26   vnet_crypto_main_t *cm = &crypto_main;
  27   vnet_crypto_engine_t *p;
  28
  29   if (unformat_user (input, unformat_line_input, line_input))
  30     unformat_free (line_input);
  31
  32   if (vec_len (cm->engines) == 0)
  33     {
  34       vlib_cli_output (vm, "No crypto engines registered");
  35       return 0;
  36     }
  37
  38   vlib_cli_output (vm, "%-20s%-8s%s", "Name", "Prio", "Description");
  39   /* *INDENT-OFF* */
  40   vec_foreach (p, cm->engines)
  41     {
  42       vlib_cli_output (vm, "%-20s%-8u%s", p->name, p->priority, p->desc);
  43     }
  44   /* *INDENT-ON* */
  45   return 0;
  46 }
  47
  48 /* *INDENT-OFF* */
  49 VLIB_CLI_COMMAND (show_crypto_engines_command, static) =
  50 {
  51   .path = "show crypto engines",
  52   .short_help = "show crypto engines",
  53   .function = show_crypto_engines_command_fn,
  54 };
  55
  56 static u8 *
  57 format_vnet_crypto_engine_candidates (u8 * s, va_list * args)
  58 {
  59   vnet_crypto_engine_t *e;
  60   vnet_crypto_main_t *cm = &crypto_main;
  61   u32 id = va_arg (*args, u32);
  62   u32 ei = va_arg (*args, u32);
  63   int is_chained = va_arg (*args, int);
  64   int is_async = va_arg (*args, int);
  65
  66   if (is_async)
  67     {
  68       vec_foreach (e, cm->engines)
  69         {
  70           if (e->enqueue_handlers[id] && e->dequeue_handlers[id])
  71             {
  72               s = format (s, "%U", format_vnet_crypto_engine, e - cm->engines);
  73               if (ei == e - cm->engines)
  74                 s = format (s, "%c ", '*');
  75               else
  76                 s = format (s, " ");
  77             }
  78         }
  79
  80       return s;
  81     }
  82   else
  83     {
  84       vec_foreach (e, cm->engines)
  85         {
  86           void * h = is_chained ? (void *) e->chained_ops_handlers[id]
  87             : (void *) e->ops_handlers[id];
  88
  89           if (h)
  90             {
  91               s = format (s, "%U", format_vnet_crypto_engine, e - cm->engines);
  92               if (ei == e - cm->engines)
  93                 s = format (s, "%c ", '*');
  94               else
  95                 s = format (s, " ");
  96             }
  97         }
  98       return s;
  99     }
 100 }
 101
 102 static u8 *
 103 format_vnet_crypto_handlers (u8 * s, va_list * args)
 104 {
 105   vnet_crypto_alg_t alg = va_arg (*args, vnet_crypto_alg_t);
 106   vnet_crypto_main_t *cm = &crypto_main;
 107   vnet_crypto_alg_data_t *d = vec_elt_at_index (cm->algs, alg);
 108   u32 indent = format_get_indent (s);
 109   int i, first = 1;
 110
 111   for (i = 0; i < VNET_CRYPTO_OP_N_TYPES; i++)
 112     {
 113       vnet_crypto_op_data_t *od;
 114       vnet_crypto_op_id_t id = d->op_by_type[i];
 115
 116       if (id == 0)
 117         continue;
 118
 119       od = cm->opt_data + id;
 120       if (first == 0)
 121         s = format (s, "\n%U", format_white_space, indent);
 122       s = format (s, "%-16U", format_vnet_crypto_op_type, od->type);
 123
 124       s = format (s, "%-28U", format_vnet_crypto_engine_candidates, id,
 125           od->active_engine_index_simple, 0, 0);
 126       s = format (s, "%U", format_vnet_crypto_engine_candidates, id,
 127           od->active_engine_index_chained, 1, 0);
 128       first = 0;
 129     }
 130   return s;
 131 }
 132
 133
 134 static clib_error_t *
 135 show_crypto_handlers_command_fn (vlib_main_t * vm,
 136                         unformat_input_t * input, vlib_cli_command_t * cmd)
 137 {
 138   unformat_input_t _line_input, *line_input = &_line_input;
 139   int i;
 140
 141   if (unformat_user (input, unformat_line_input, line_input))
 142     unformat_free (line_input);
 143
 144   vlib_cli_output (vm, "%-16s%-16s%-28s%s", "Algo", "Type", "Simple",
 145       "Chained");
 146
 147   for (i = 0; i < VNET_CRYPTO_N_ALGS; i++)
 148     vlib_cli_output (vm, "%-16U%U", format_vnet_crypto_alg, i,
 149                      format_vnet_crypto_handlers, i);
 150
 151   return 0;
 152 }
 153
 154 /* *INDENT-OFF* */
 155 VLIB_CLI_COMMAND (show_crypto_handlers_command, static) =
 156 {
 157   .path = "show crypto handlers",
 158   .short_help = "show crypto handlers",
 159   .function = show_crypto_handlers_command_fn,
 160 };
 161 /* *INDENT-ON* */
 162
 163 static clib_error_t *
 164 set_crypto_handler_command_fn (vlib_main_t * vm,
 165                                unformat_input_t * input,
 166                                vlib_cli_command_t * cmd)
 167 {
 168   unformat_input_t _line_input, *line_input = &_line_input;
 169   vnet_crypto_main_t *cm = &crypto_main;
 170   int rc = 0;
 171   char **args = 0, *s, **arg, *engine = 0;
 172   int all = 0;
 173   clib_error_t *error = 0;
 174   crypto_op_class_type_t oct = CRYPTO_OP_BOTH;
 175
 176   if (!unformat_user (input, unformat_line_input, line_input))
 177     return 0;
 178
 179   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
 180     {
 181       if (unformat (line_input, "all"))
 182         all = 1;
 183       else if (unformat (line_input, "simple"))
 184         oct = CRYPTO_OP_SIMPLE;
 185       else if (unformat (line_input, "chained"))
 186         oct = CRYPTO_OP_CHAINED;
 187       else if (unformat (line_input, "both"))
 188         oct = CRYPTO_OP_BOTH;
 189       else if (unformat (line_input, "%s", &s))
 190         vec_add1 (args, s);
 191       else
 192         {
 193           error = clib_error_return (0, "invalid params");
 194           goto done;
 195         }
 196     }
 197
 198   if ((vec_len (args) < 2 && !all) || (vec_len (args) == 0 && all))
 199     {
 200       error = clib_error_return (0, "missing cipher or engine!");
 201       goto done;
 202     }
 203
 204   engine = vec_elt_at_index (args, vec_len (args) - 1)[0];
 205   vec_del1 (args, vec_len (args) - 1);
 206
 207   if (all)
 208     {
 209       char *key;
 210       u8 *value;
 211
 212       /* *INDENT-OFF* */
 213       hash_foreach_mem (key, value, cm->alg_index_by_name,
 214       ({
 215         (void) value;
 216         rc += vnet_crypto_set_handler2 (key, engine, oct);
 217       }));
 218       /* *INDENT-ON* */
 219
 220       if (rc)
 221         vlib_cli_output (vm, "failed to set crypto engine!");
 222     }
 223   else
 224     {
 225       vec_foreach (arg, args)
 226       {
 227         rc = vnet_crypto_set_handler2 (arg[0], engine, oct);
 228         if (rc)
 229           {
 230             vlib_cli_output (vm, "failed to set engine %s for %s!",
 231                              engine, arg[0]);
 232           }
 233       }
 234     }
 235
 236 done:
 237   vec_free (engine);
 238   vec_foreach (arg, args) vec_free (arg[0]);
 239   vec_free (args);
 240   unformat_free (line_input);
 241   return error;
 242 }
 243
 244 /* *INDENT-OFF* */
 245 VLIB_CLI_COMMAND (set_crypto_handler_command, static) =
 246 {
 247   .path = "set crypto handler",
 248   .short_help = "set crypto handler cipher [cipher2 cipher3 ...] engine"
 249     " [simple|chained]",
 250   .function = set_crypto_handler_command_fn,
 251 };
 252 /* *INDENT-ON* */
 253
 254 static u8 *
 255 format_vnet_crypto_async_handlers (u8 * s, va_list * args)
 256 {
 257   vnet_crypto_async_alg_t alg = va_arg (*args, vnet_crypto_async_alg_t);
 258   vnet_crypto_main_t *cm = &crypto_main;
 259   vnet_crypto_async_alg_data_t *d = vec_elt_at_index (cm->async_algs, alg);
 260   u32 indent = format_get_indent (s);
 261   int i, first = 1;
 262
 263   for (i = 0; i < VNET_CRYPTO_ASYNC_OP_N_TYPES; i++)
 264     {
 265       vnet_crypto_async_op_data_t *od;
 266       vnet_crypto_async_op_id_t id = d->op_by_type[i];
 267
 268       if (id == 0)
 269         continue;
 270
 271       od = cm->async_opt_data + id;
 272       if (first == 0)
 273         s = format (s, "\n%U", format_white_space, indent);
 274       s = format (s, "%-16U", format_vnet_crypto_async_op_type, od->type);
 275
 276       s = format (s, "%U", format_vnet_crypto_engine_candidates, id,
 277                   od->active_engine_index_async, 0, 1);
 278       first = 0;
 279     }
 280   return s;
 281 }
 282
 283 static clib_error_t *
 284 show_crypto_async_handlers_command_fn (vlib_main_t * vm,
 285                                        unformat_input_t * input,
 286                                        vlib_cli_command_t * cmd)
 287 {
 288   unformat_input_t _line_input, *line_input = &_line_input;
 289   int i;
 290
 291   if (unformat_user (input, unformat_line_input, line_input))
 292     unformat_free (line_input);
 293
 294   vlib_cli_output (vm, "%-28s%-16s%s", "Algo", "Type", "Handler");
 295
 296   for (i = 0; i < VNET_CRYPTO_N_ASYNC_ALGS; i++)
 297     vlib_cli_output (vm, "%-28U%U", format_vnet_crypto_async_alg, i,
 298                      format_vnet_crypto_async_handlers, i);
 299
 300   return 0;
 301 }
 302
 303 /* *INDENT-OFF* */
 304 VLIB_CLI_COMMAND (show_crypto_async_handlers_command, static) =
 305 {
 306   .path = "show crypto async handlers",
 307   .short_help = "show crypto async handlers",
 308   .function = show_crypto_async_handlers_command_fn,
 309 };
 310 /* *INDENT-ON* */
 311
 312
 313 static clib_error_t *
 314 show_crypto_async_status_command_fn (vlib_main_t * vm,
 315                                      unformat_input_t * input,
 316                                      vlib_cli_command_t * cmd)
 317 {
 318   vnet_crypto_main_t *cm = &crypto_main;
 319   u32 skip_master = vlib_num_workers () > 0;
 320   vlib_thread_main_t *tm = vlib_get_thread_main ();
 321   unformat_input_t _line_input, *line_input = &_line_input;
 322   int i;
 323
 324   if (unformat_user (input, unformat_line_input, line_input))
 325     unformat_free (line_input);
 326
 327   vlib_cli_output (vm, "Crypto async dispatch mode: %s",
 328                    cm->dispatch_mode ==
 329                    VNET_CRYPTO_ASYNC_DISPATCH_POLLING ? "POLLING" :
 330                    "INTERRUPT");
 331
 332   for (i = skip_master; i < tm->n_vlib_mains; i++)
 333     {
 334       vlib_node_state_t state =
 335         vlib_node_get_state (vlib_mains[i], cm->crypto_node_index);
 336       if (state == VLIB_NODE_STATE_POLLING)
 337         vlib_cli_output (vm, "threadId: %-6d POLLING", i);
 338       if (state == VLIB_NODE_STATE_INTERRUPT)
 339         vlib_cli_output (vm, "threadId: %-6d INTERRUPT", i);
 340       if (state == VLIB_NODE_STATE_DISABLED)
 341         vlib_cli_output (vm, "threadId: %-6d DISABLED", i);
 342     }
 343   return 0;
 344 }
 345
 346 /* *INDENT-OFF* */
 347 VLIB_CLI_COMMAND (show_crypto_async_status_command, static) =
 348 {
 349   .path = "show crypto async status",
 350   .short_help = "show crypto async status",
 351   .function = show_crypto_async_status_command_fn,
 352 };
 353 /* *INDENT-ON* */
 354
 355 static clib_error_t *
 356 set_crypto_async_handler_command_fn (vlib_main_t * vm,
 357                                      unformat_input_t * input,
 358                                      vlib_cli_command_t * cmd)
 359 {
 360   unformat_input_t _line_input, *line_input = &_line_input;
 361   vnet_crypto_main_t *cm = &crypto_main;
 362   int rc = 0;
 363   char **args = 0, *s, **arg, *engine = 0;
 364   int all = 0;
 365   clib_error_t *error = 0;
 366
 367   if (!unformat_user (input, unformat_line_input, line_input))
 368     return 0;
 369
 370   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
 371     {
 372       if (unformat (line_input, "all"))
 373         all = 1;
 374       else if (unformat (line_input, "%s", &s))
 375         vec_add1 (args, s);
 376       else
 377         {
 378           error = clib_error_return (0, "invalid params");
 379           goto done;
 380         }
 381     }
 382
 383   if ((vec_len (args) < 2 && !all) || (vec_len (args) == 0 && all))
 384     {
 385       error = clib_error_return (0, "missing cipher or engine!");
 386       goto done;
 387     }
 388
 389   engine = vec_elt_at_index (args, vec_len (args) - 1)[0];
 390   vec_del1 (args, vec_len (args) - 1);
 391
 392   if (all)
 393     {
 394       char *key;
 395       u8 *value;
 396
 397       /* *INDENT-OFF* */
 398       hash_foreach_mem (key, value, cm->async_alg_index_by_name,
 399       ({
 400         (void) value;
 401         rc += vnet_crypto_set_async_handler2 (key, engine);
 402       }));
 403       /* *INDENT-ON* */
 404
 405       if (rc)
 406         vlib_cli_output (vm, "failed to set crypto engine!");
 407     }
 408   else
 409     {
 410       vec_foreach (arg, args)
 411       {
 412         rc = vnet_crypto_set_async_handler2 (arg[0], engine);
 413         if (rc)
 414           {
 415             vlib_cli_output (vm, "failed to set engine %s for %s!",
 416                              engine, arg[0]);
 417           }
 418       }
 419     }
 420
 421 done:
 422   vec_free (engine);
 423   vec_foreach (arg, args) vec_free (arg[0]);
 424   vec_free (args);
 425   unformat_free (line_input);
 426   return error;
 427 }
 428
 429 /* *INDENT-OFF* */
 430 VLIB_CLI_COMMAND (set_crypto_async_handler_command, static) =
 431 {
 432   .path = "set crypto async handler",
 433   .short_help = "set crypto async handler type [type2 type3 ...] engine",
 434   .function = set_crypto_async_handler_command_fn,
 435 };
 436 /* *INDENT-ON* */
 437
 438 static inline void
 439 print_crypto_async_dispatch_warning ()
 440 {
 441   clib_warning ("Switching dispatch mode might not work is some situations.");
 442   clib_warning
 443     ("Use 'show crypto async status' to verify that the nodes' states were set");
 444   clib_warning ("and if not, set 'crypto async dispatch' mode again.");
 445 }
 446
 447 static clib_error_t *
 448 set_crypto_async_dispatch_polling_command_fn (vlib_main_t * vm,
 449                                               unformat_input_t * input,
 450                                               vlib_cli_command_t * cmd)
 451 {
 452   print_crypto_async_dispatch_warning ();
 453   vnet_crypto_set_async_dispatch_mode (VNET_CRYPTO_ASYNC_DISPATCH_POLLING);
 454   return 0;
 455 }
 456
 457 static clib_error_t *
 458 set_crypto_async_dispatch_interrupt_command_fn (vlib_main_t * vm,
 459                                                 unformat_input_t * input,
 460                                                 vlib_cli_command_t * cmd)
 461 {
 462   print_crypto_async_dispatch_warning ();
 463   vnet_crypto_set_async_dispatch_mode (VNET_CRYPTO_ASYNC_DISPATCH_INTERRUPT);
 464   return 0;
 465 }
 466
 467 /* *INDENT-OFF* */
 468 VLIB_CLI_COMMAND (set_crypto_async_dispatch_polling_command, static) =
 469 {
 470   .path = "set crypto async dispatch polling",
 471   .short_help = "set crypto async dispatch polling|interrupt",
 472   .function = set_crypto_async_dispatch_polling_command_fn,
 473 };
 474 VLIB_CLI_COMMAND (set_crypto_async_dispatch_interrupt_command, static) =
 475 {
 476   .path = "set crypto async dispatch interrupt",
 477   .short_help = "set crypto async dispatch polling|interrupt",
 478   .function = set_crypto_async_dispatch_interrupt_command_fn,
 479 };
 480 /*
 481  * fd.io coding-style-patch-verification: ON
 482  *
 483  * Local Variables:
 484  * eval: (c-set-style "gnu")
 485  * End:
 486  */