2 * Copyright (c) 2018 Intel 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.
15 #include <vnet/vnet.h>
16 #include <vnet/ip/ip.h>
17 #include <vnet/api_errno.h>
18 #include <vlib/node_funcs.h>
19 #include <openssl/engine.h>
20 #include <tlsopenssl/tls_openssl.h>
22 #define MAX_SESSION 4096
23 #define MAX_VECTOR_ASYNC 256
25 #define SSL_ASYNC_INFLIGHT 1
26 #define SSL_ASYNC_PENDING 2
27 #define SSL_ASYNC_READY 3
29 #define EMPTY_STRUCT {0}
31 typedef struct openssl_tls_callback_arg_
35 } openssl_tls_callback_arg_t;
37 typedef struct openssl_event_
44 openssl_resume_handler *handler;
45 openssl_tls_callback_t engine_callback;
46 openssl_tls_callback_arg_t cb_args;
51 typedef struct openssl_async_status_
57 } openssl_async_status_t;
59 typedef struct openssl_async_
61 openssl_evt_t ***evt_pool;
62 openssl_async_status_t *status;
63 void (*polling) (void);
64 void (*polling_conf) (void);
72 void qat_polling_config ();
73 void dasync_polling ();
78 void (*polling) (void);
79 void (*pre_init) (void);
80 void (*polling_conf) (void);
83 struct engine_polling engine_list[] = {
84 {"qat", qat_polling, qat_pre_init, qat_polling_config},
85 {"dasync", dasync_polling, NULL, NULL}
88 openssl_async_t openssl_async_main;
89 static vlib_node_registration_t tls_async_process_node;
91 /* to avoid build warning */
92 void session_send_rpc_evt_to_thread (u32 thread_index, void *fp,
96 evt_pool_init (vlib_main_t * vm)
98 vlib_thread_main_t *vtm = vlib_get_thread_main ();
99 openssl_async_t *om = &openssl_async_main;
102 num_threads = 1 /* main thread */ + vtm->n_threads;
104 TLS_DBG (2, "Totally there is %d thread\n", num_threads);
106 vec_validate (om->evt_pool, num_threads - 1);
107 vec_validate (om->status, num_threads - 1);
109 om->start_polling = 0;
112 for (i = 0; i < num_threads; i++)
114 om->status[i].evt_run_head = -1;
115 om->status[i].evt_run_tail = -1;
116 om->status[i].evt_pending_head = -1;
120 openssl_async_node_enable_disable (0);
126 openssl_engine_register (char *engine_name, char *algorithm)
128 int i, registered = -1;
129 openssl_async_t *om = &openssl_async_main;
133 for (i = 0; i < ARRAY_LEN (engine_list); i++)
135 if (!strcmp (engine_list[i].engine, engine_name))
137 om->polling = engine_list[i].polling;
138 om->polling_conf = engine_list[i].polling_conf;
148 ENGINE_load_builtin_engines ();
149 ENGINE_load_dynamic ();
150 engine = ENGINE_by_id (engine_name);
159 p = engine_list[registered].pre_init;
165 if (!ENGINE_set_default_string (engine, algorithm))
167 clib_warning ("Failed to set engine %s algorithm %s\n",
168 engine_name, algorithm);
174 if (!ENGINE_set_default (engine, ENGINE_METHOD_ALL))
176 clib_warning ("Failed to set engine %s to all algorithm",
182 om->start_polling = 1;
188 static openssl_evt_t *
189 openssl_evt_get (u32 evt_index)
193 pool_elt_at_index (openssl_async_main.evt_pool[vlib_get_thread_index ()],
198 static openssl_evt_t *
199 openssl_evt_get_w_thread (int evt_index, u8 thread_index)
204 pool_elt_at_index (openssl_async_main.evt_pool[thread_index], evt_index);
209 openssl_evt_free (int event_idx, u8 thread_index)
212 openssl_async_t *om = &openssl_async_main;
213 int *evt_run_tail = &om->status[thread_index].evt_run_tail;
218 evt = openssl_evt_get_w_thread (event_idx, thread_index);
223 pool_put_index (om->evt_pool[thread_index], event_idx);
225 if (*evt_run_tail == event_idx)
232 openssl_evt_alloc (void)
234 u8 thread_index = vlib_get_thread_index ();
235 openssl_async_t *tm = &openssl_async_main;
238 pool_get (tm->evt_pool[thread_index], evt);
240 *evt = clib_mem_alloc (sizeof (openssl_evt_t));
242 clib_memset (*evt, 0, sizeof (openssl_evt_t));
243 (*evt)->event_index = evt - tm->evt_pool[thread_index];
244 return ((*evt)->event_index);
248 openssl_async_run (void *evt)
250 openssl_evt_t *event, *event_tail;
251 openssl_async_t *om = &openssl_async_main;
252 openssl_tls_callback_arg_t *args = (openssl_tls_callback_arg_t *) evt;
253 int thread_index = args->thread_index;
254 int event_index = args->event_index;
255 int *evt_run_tail = &om->status[thread_index].evt_run_tail;
256 int *evt_run_head = &om->status[thread_index].evt_run_head;
258 TLS_DBG (2, "Set event %d to run\n", event_index);
260 event = openssl_evt_get_w_thread (event_index, thread_index);
262 if (event->status == SSL_ASYNC_READY)
265 event->status = SSL_ASYNC_READY;
269 if (*evt_run_tail >= 0)
271 event_tail = openssl_evt_get_w_thread (*evt_run_tail, thread_index);
272 event_tail->next = event_index;
274 *evt_run_tail = event_index;
275 if (*evt_run_head < 0)
277 *evt_run_head = event_index;
283 openssl_tls_callback_t *
284 vpp_add_async_pending_event (tls_ctx_t * ctx,
285 openssl_resume_handler * handler)
288 openssl_evt_t *event;
289 openssl_async_t *om = &openssl_async_main;
290 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
291 int *evt_pending_head;
292 u32 thread_id = ctx->c_thread_index;
294 eidx = openssl_evt_alloc ();
295 event = openssl_evt_get (eidx);
297 event->ctx_index = oc->openssl_ctx_index;
298 event->status = SSL_ASYNC_PENDING;
299 event->handler = handler;
300 event->cb_args.event_index = eidx;
301 event->cb_args.thread_index = thread_id;
302 event->engine_callback.callback = openssl_async_run;
303 event->engine_callback.arg = &event->cb_args;
305 /* add to pending list */
306 evt_pending_head = &om->status[thread_id].evt_pending_head;
307 event->next = *evt_pending_head;
308 *evt_pending_head = eidx;
310 return &event->engine_callback;
314 vpp_add_async_run_event (tls_ctx_t * ctx, openssl_resume_handler * handler)
317 openssl_evt_t *event;
318 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
319 u32 thread_id = ctx->c_thread_index;
321 eidx = openssl_evt_alloc ();
322 event = openssl_evt_get (eidx);
324 event->ctx_index = oc->openssl_ctx_index;
325 event->status = SSL_ASYNC_PENDING;
326 event->handler = handler;
327 event->cb_args.event_index = eidx;
328 event->cb_args.thread_index = thread_id;
329 event->engine_callback.callback = openssl_async_run;
330 event->engine_callback.arg = &event->cb_args;
332 /* This is a retry event, and need to put to ring to make it run again */
333 return openssl_async_run (&event->cb_args);
338 event_handler (void *tls_async)
341 openssl_resume_handler *handler;
342 openssl_evt_t *callback;
343 stream_session_t *tls_session;
347 callback = (openssl_evt_t *) tls_async;
348 thread_index = callback->cb_args.thread_index;
349 ctx = openssl_ctx_get_w_thread (callback->ctx_index, thread_index);
350 handler = callback->handler;
351 tls_session = session_get_from_handle (ctx->tls_session_handle);
355 (*handler) (ctx, tls_session);
358 /* Need to free the event */
359 openssl_evt_free (callback->cb_args.event_index, thread_index);
364 /* engine specific code to polling the response ring */
368 openssl_async_t *om = &openssl_async_main;
369 openssl_evt_t *event;
371 openssl_tls_callback_t *engine_cb;
372 u8 thread_index = vlib_get_thread_index ();
374 /* POC code here to simulate the engine to call callback */
375 evt_pending = &om->status[thread_index].evt_pending_head;
376 while (*evt_pending >= 0)
378 TLS_DBG (2, "polling... current head = %d\n", *evt_pending);
379 event = openssl_evt_get_w_thread (*evt_pending, thread_index);
380 *evt_pending = event->next;
381 if (event->status == SSL_ASYNC_PENDING)
383 engine_cb = &event->engine_callback;
384 (*engine_cb->callback) (engine_cb->arg);
393 openssl_async_t *om = &openssl_async_main;
395 ENGINE_ctrl_cmd (om->engine, "ENABLE_EXTERNAL_POLLING", 0, NULL, NULL, 0);
398 /* Below code is spefic to QAT engine, and other vendors can refer to this code to enable a new engine */
400 qat_polling_config ()
402 openssl_async_t *om = &openssl_async_main;
403 u8 thread_index = vlib_get_thread_index ();
406 config = &om->status[thread_index].poll_config;
407 if (PREDICT_TRUE (*config))
410 ENGINE_ctrl_cmd (om->engine, "SET_INSTANCE_FOR_THREAD", thread_index,
414 TLS_DBG (2, "set thread %d and instance %d mapping\n", thread_index,
422 openssl_async_t *om = &openssl_async_main;
425 if (om->start_polling)
427 ENGINE_ctrl_cmd (om->engine, "POLL", 0, &poll_status, NULL, 0);
432 openssl_async_polling ()
434 openssl_async_t *om = &openssl_async_main;
442 openssl_async_node_enable_disable (u8 is_en)
444 u8 state = is_en ? VLIB_NODE_STATE_POLLING : VLIB_NODE_STATE_DISABLED;
446 foreach_vlib_main (({
447 vlib_node_set_state (this_vlib_main, tls_async_process_node.index,
454 tls_async_do_job (int eidx, u32 thread_index)
457 openssl_evt_t *event;
459 /* do the real job */
460 event = openssl_evt_get_w_thread (eidx, thread_index);
461 ctx = openssl_ctx_get_w_thread (event->ctx_index, thread_index);
466 session_send_rpc_evt_to_thread (thread_index, event_handler, event);
472 tls_resume_from_crypto (int thread_index)
476 openssl_async_t *om = &openssl_async_main;
477 openssl_evt_t *event;
478 int *evt_run_head = &om->status[thread_index].evt_run_head;
480 if (*evt_run_head < 0)
483 for (i = 0; i < MAX_VECTOR_ASYNC; i++)
485 if (*evt_run_head >= 0)
487 event = openssl_evt_get_w_thread (*evt_run_head, thread_index);
488 TLS_DBG (2, "event run = %d\n", *evt_run_head);
489 tls_async_do_job (*evt_run_head, thread_index);
491 *evt_run_head = event->next;
504 static clib_error_t *
505 tls_async_init (vlib_main_t * vm)
513 tls_async_process (vlib_main_t * vm, vlib_node_runtime_t * rt,
517 openssl_async_t *om = &openssl_async_main;
519 if (om->polling_conf)
520 (*om->polling_conf) ();
521 thread_index = vlib_get_thread_index ();
522 if (pool_elts (om->evt_pool[thread_index]) > 0)
524 openssl_async_polling ();
525 tls_resume_from_crypto (thread_index);
531 VLIB_INIT_FUNCTION (tls_async_init);
534 VLIB_REGISTER_NODE (tls_async_process_node,static) = {
535 .function = tls_async_process,
536 .type = VLIB_NODE_TYPE_INPUT,
537 .name = "tls-async-process",
544 * fd.io coding-style-patch-verification: ON
547 * eval: (c-set-style "gnu")