crypto: Add async crypto APIs

Type: feature

This adds api calls for the following CLIs:
* set sw_scheuduler worker <N> crypto on|off
* set crypto async dispatch polling|interrupt
* set crypto handler
* set crypto async handler

Change-Id: Ic701d149c440e42ea4575da42b9f69e4c8759602
Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>

src/plugins/crypto_sw_scheduler/CMakeLists.txt

@@ -14,4 +14,8 @@
 add_vpp_plugin(crypto_sw_scheduler
   SOURCES
   main.c
+  api.c
+
+  API_FILES
+  crypto_sw_scheduler.api
 )

src/plugins/crypto_sw_scheduler/api.c

@@ -0,0 +1,77 @@
+/*
+ * Copyright (c) 2020 Cisco and/or its affiliates.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include <stddef.h>
+
+#include <vnet/vnet.h>
+#include <vnet/plugin/plugin.h>
+
+#include <vnet/ip/ip_types_api.h>
+#include <vpp/app/version.h>
+
+#include <vlibapi/api.h>
+#include <vlibmemory/api.h>
+
+#include <crypto_sw_scheduler/crypto_sw_scheduler.h>
+
+/* define message IDs */
+#include <vnet/format_fns.h>
+#include <crypto_sw_scheduler/crypto_sw_scheduler.api_enum.h>
+#include <crypto_sw_scheduler/crypto_sw_scheduler.api_types.h>
+
+/**
+ * Base message ID fot the plugin
+ */
+static u32 crypto_sw_scheduler_base_msg_id;
+
+#define REPLY_MSG_ID_BASE crypto_sw_scheduler_base_msg_id
+
+#include <vlibapi/api_helper_macros.h>
+
+static void
+  vl_api_crypto_sw_scheduler_set_worker_t_handler
+  (vl_api_crypto_sw_scheduler_set_worker_t * mp)
+{
+  vl_api_crypto_sw_scheduler_set_worker_reply_t *rmp;
+  u32 worker_index;
+  u8 crypto_enable;
+  int rv;
+
+  worker_index = ntohl (mp->worker_index);
+  crypto_enable = mp->crypto_enable;
+
+  rv = crypto_sw_scheduler_set_worker_crypto (worker_index, crypto_enable);
+
+  REPLY_MACRO (VL_API_CRYPTO_SW_SCHEDULER_SET_WORKER_REPLY);
+}
+
+#include <crypto_sw_scheduler/crypto_sw_scheduler.api.c>
+
+clib_error_t *
+crypto_sw_scheduler_api_init (vlib_main_t * vm)
+{
+  /* Ask for a correctly-sized block of API message decode slots */
+  crypto_sw_scheduler_base_msg_id = setup_message_id_table ();
+
+  return 0;
+}
+
+/*
+ * fd.io coding-style-patch-verification: ON
+ *
+ * Local Variables:
+ * eval: (c-set-style "gnu")
+ * End:
+ */

src/plugins/crypto_sw_scheduler/crypto_sw_scheduler.api

@@ -0,0 +1,45 @@
+/* Hey Emacs use -*- mode: C -*- */
+/*
+ * Copyright (c) 2020 Cisco and/or its affiliates.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/** \file
+    This file defines the vpp control-plane API messages
+    used to control the crypto SW scheduler plugin
+*/
+
+option version = "0.1.0";
+
+
+ /** \brief crypto sw scheduler: Enable or disable workers
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param worker_index - Worker index to enable / disable
+    @param crypto_enable - On/Off
+*/
+autoreply define crypto_sw_scheduler_set_worker
+{
+  u32 client_index;
+  u32 context;
+  u32 worker_index;
+  bool crypto_enable;
+};
+
+/*
+ * fd.io coding-style-patch-verification: ON
+ *
+ * Local Variables:
+ * eval: (c-set-style "gnu")
+ * End:
+ */

src/plugins/crypto_sw_scheduler/crypto_sw_scheduler.h

@@ -50,6 +50,10 @@ typedef struct
 
 extern crypto_sw_scheduler_main_t crypto_sw_scheduler_main;
 
+extern int crypto_sw_scheduler_set_worker_crypto (u32 worker_idx, u8 enabled);
+
+extern clib_error_t *crypto_sw_scheduler_api_init (vlib_main_t * vm);
+
 #endif // __crypto_native_h__
 
 /*

src/plugins/crypto_sw_scheduler/main.c

@@ -659,6 +659,8 @@ crypto_sw_scheduler_init (vlib_main_t * vm)
   vnet_crypto_register_key_handler (vm, cm->crypto_engine_index,
 				    crypto_sw_scheduler_key_handler);
 
+  crypto_sw_scheduler_api_init (vm);
+
   /* *INDENT-OFF* */
 #define _(n, s, k, t, a)                                                      \
   vnet_crypto_register_async_handler (                                        \

src/vnet/CMakeLists.txt

@@ -568,6 +568,7 @@ list(APPEND VNET_SOURCES
   crypto/crypto.c
   crypto/format.c
   crypto/node.c
+  crypto/crypto_api.c
 )
 
 list(APPEND VNET_HEADERS
@@ -576,6 +577,8 @@ list(APPEND VNET_HEADERS
 
 list(APPEND VNET_MULTIARCH_SOURCES crypto/node.c)
 
+list(APPEND VNET_API_FILES crypto/crypto.api)
+
 ##############################################################################
 # Layer 3 protocol: IPSec
 ##############################################################################

src/vnet/crypto/cli.c

@@ -435,11 +435,21 @@ VLIB_CLI_COMMAND (set_crypto_async_handler_command, static) =
 };
 /* *INDENT-ON* */
 
+static inline void
+print_crypto_async_dispatch_warning ()
+{
+  clib_warning ("Switching dispatch mode might not work is some situations.");
+  clib_warning
+    ("Use 'show crypto async status' to verify that the nodes' states were set");
+  clib_warning ("and if not, set 'crypto async dispatch' mode again.");
+}
+
 static clib_error_t *
 set_crypto_async_dispatch_polling_command_fn (vlib_main_t * vm,
 					      unformat_input_t * input,
 					      vlib_cli_command_t * cmd)
 {
+  print_crypto_async_dispatch_warning ();
   vnet_crypto_set_async_dispatch_mode (VNET_CRYPTO_ASYNC_DISPATCH_POLLING);
   return 0;
 }
@@ -449,6 +459,7 @@ set_crypto_async_dispatch_interrupt_command_fn (vlib_main_t * vm,
 						unformat_input_t * input,
 						vlib_cli_command_t * cmd)
 {
+  print_crypto_async_dispatch_warning ();
   vnet_crypto_set_async_dispatch_mode (VNET_CRYPTO_ASYNC_DISPATCH_INTERRUPT);
   return 0;
 }

src/vnet/crypto/crypto.api

@@ -0,0 +1,67 @@
+/*
+ * Copyright (c) 2020 Cisco and/or its affiliates.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+option version = "1.0.1";
+
+enum crypto_dispatch_mode:u8
+{
+  CRYPTO_ASYNC_DISPATCH_POLLING = 0,
+  CRYPTO_ASYNC_DISPATCH_INTERRUPT = 1,
+};
+
+enum crypto_op_class_type:u8
+{
+  CRYPTO_API_OP_SIMPLE = 0,
+  CRYPTO_API_OP_CHAINED,
+  CRYPTO_API_OP_BOTH,
+};
+
+ /** \brief crypto: use polling or interrupt dispatch
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param mode - dispatch mode
+*/
+
+autoreply define crypto_set_async_dispatch
+{
+  u32 client_index;
+  u32 context;
+  vl_api_crypto_dispatch_mode_t mode;
+};
+
+ /** \brief crypto: use polling or interrupt dispatch
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param alg_name - Name of the algorithm to add
+    @param engine - Name of the engine to add
+    @param oct - Operation class type (simple, chained, both)
+    @param is_async - Asynchronous or not
+*/
+
+autoreply define crypto_set_handler
+{
+  u32 client_index;
+  u32 context;
+  string alg_name[32];
+  string engine[16];
+  vl_api_crypto_op_class_type_t oct;
+  u8 is_async;
+};
+
+ /*
+ * Local Variables:
+ * eval: (c-set-style "gnu")
+ * End:
+ */

src/vnet/crypto/crypto.c

@@ -620,10 +620,6 @@ vnet_crypto_set_async_dispatch_mode (u8 mode)
       if (state != vlib_node_get_state (vlib_mains[i], cm->crypto_node_index))
 	vlib_node_set_state (vlib_mains[i], cm->crypto_node_index, state);
     }
-  clib_warning ("Switching dispatch mode might not work is some situations.");
-  clib_warning
-    ("Use 'show crypto async status' to verify that the nodes' states were set");
-  clib_warning ("and if not, set 'crypto async dispatch' mode again.");
 }
 
 int

src/vnet/crypto/crypto.h

@@ -207,7 +207,6 @@ typedef enum
 } vnet_crypto_op_id_t;
 /* *INDENT-ON* */
 
-
 typedef enum
 {
   CRYPTO_OP_SIMPLE,

src/vnet/crypto/crypto_api.c

@@ -0,0 +1,94 @@
+/*
+ * Copyright (c) 2020 Cisco and/or its affiliates.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include <stddef.h>
+
+#include <vnet/vnet.h>
+
+#include <vnet/ip/ip_types_api.h>
+#include <vpp/app/version.h>
+
+#include <vlibapi/api.h>
+#include <vlibmemory/api.h>
+
+#include <vnet/crypto/crypto.h>
+
+/* define message IDs */
+#include <vnet/format_fns.h>
+#include <vnet/crypto/crypto.api_enum.h>
+#include <vnet/crypto/crypto.api_types.h>
+
+/**
+ * Base message ID fot the plugin
+ */
+static u32 crypto_base_msg_id;
+
+#define REPLY_MSG_ID_BASE crypto_base_msg_id
+
+#include <vlibapi/api_helper_macros.h>
+
+static void
+vl_api_crypto_set_async_dispatch_t_handler (vl_api_crypto_set_async_dispatch_t
+					    * mp)
+{
+  vl_api_crypto_set_async_dispatch_reply_t *rmp;
+  int rv = 0;
+
+  vnet_crypto_set_async_dispatch_mode ((u8) mp->mode);
+
+  REPLY_MACRO (VL_API_CRYPTO_SET_ASYNC_DISPATCH_REPLY);
+}
+
+static void
+vl_api_crypto_set_handler_t_handler (vl_api_crypto_set_handler_t * mp)
+{
+  vl_api_crypto_set_handler_reply_t *rmp;
+  int rv = 0;
+  char *engine;
+  char *alg_name;
+  crypto_op_class_type_t oct;
+
+  engine = (char *) mp->engine;
+  alg_name = (char *) mp->alg_name;
+  oct = (crypto_op_class_type_t) mp->oct;
+
+  if (mp->is_async)
+    rv = vnet_crypto_set_async_handler2 (alg_name, engine);
+  else
+    rv = vnet_crypto_set_handler2 (alg_name, engine, oct);
+
+  REPLY_MACRO (VL_API_CRYPTO_SET_HANDLER_REPLY);
+}
+
+#include <vnet/crypto/crypto.api.c>
+
+clib_error_t *
+crypto_api_hookup (vlib_main_t * vm)
+{
+  /* Ask for a correctly-sized block of API message decode slots */
+  crypto_base_msg_id = setup_message_id_table ();
+
+  return 0;
+}
+
+VLIB_API_INIT_FUNCTION (crypto_api_hookup);
+
+/*
+ * fd.io coding-style-patch-verification: ON
+ *
+ * Local Variables:
+ * eval: (c-set-style "gnu")
+ * End:
+ */