2 * Copyright 2015-2022 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the Apache License 2.0 (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
11 * Without this we start getting longjmp crashes because it thinks we're jumping
12 * up the stack when in fact we are jumping to an entirely different stack. The
13 * cost of this is not having certain buffer overrun/underrun checks etc for
14 * this source file :-(
16 #undef _FORTIFY_SOURCE
18 /* This must be the first #include file */
19 #include "async_local.h"
21 #include <openssl/err.h>
22 #include "crypto/cryptlib.h"
25 #define ASYNC_JOB_RUNNING 0
26 #define ASYNC_JOB_PAUSING 1
27 #define ASYNC_JOB_PAUSED 2
28 #define ASYNC_JOB_STOPPING 3
30 static CRYPTO_THREAD_LOCAL ctxkey;
31 static CRYPTO_THREAD_LOCAL poolkey;
33 static void async_delete_thread_state(void *arg);
35 static async_ctx *async_ctx_new(void)
39 if (!ossl_init_thread_start(NULL, NULL, async_delete_thread_state))
42 nctx = OPENSSL_malloc(sizeof(*nctx));
44 ERR_raise(ERR_LIB_ASYNC, ERR_R_MALLOC_FAILURE);
48 async_fibre_init_dispatcher(&nctx->dispatcher);
51 if (!CRYPTO_THREAD_set_local(&ctxkey, nctx))
61 async_ctx *async_get_ctx(void)
63 return (async_ctx *)CRYPTO_THREAD_get_local(&ctxkey);
66 static int async_ctx_free(void)
70 ctx = async_get_ctx();
72 if (!CRYPTO_THREAD_set_local(&ctxkey, NULL))
80 static ASYNC_JOB *async_job_new(void)
82 ASYNC_JOB *job = NULL;
84 job = OPENSSL_zalloc(sizeof(*job));
86 ERR_raise(ERR_LIB_ASYNC, ERR_R_MALLOC_FAILURE);
90 job->status = ASYNC_JOB_RUNNING;
95 static void async_job_free(ASYNC_JOB *job)
98 OPENSSL_free(job->funcargs);
99 async_fibre_free(&job->fibrectx);
104 static ASYNC_JOB *async_get_pool_job(void) {
108 pool = (async_pool *)CRYPTO_THREAD_get_local(&poolkey);
111 * Pool has not been initialised, so init with the defaults, i.e.
112 * no max size and no pre-created jobs
114 if (ASYNC_init_thread(0, 0) == 0)
116 pool = (async_pool *)CRYPTO_THREAD_get_local(&poolkey);
119 job = sk_ASYNC_JOB_pop(pool->jobs);
122 if ((pool->max_size != 0) && (pool->curr_size >= pool->max_size))
125 job = async_job_new();
127 if (! async_fibre_makecontext(&job->fibrectx)) {
137 static void async_release_job(ASYNC_JOB *job) {
140 pool = (async_pool *)CRYPTO_THREAD_get_local(&poolkey);
142 ERR_raise(ERR_LIB_ASYNC, ERR_R_INTERNAL_ERROR);
145 OPENSSL_free(job->funcargs);
146 job->funcargs = NULL;
147 sk_ASYNC_JOB_push(pool->jobs, job);
150 void async_start_func(void)
153 async_ctx *ctx = async_get_ctx();
156 ERR_raise(ERR_LIB_ASYNC, ERR_R_INTERNAL_ERROR);
162 job->ret = job->func(job->funcargs);
165 job->status = ASYNC_JOB_STOPPING;
166 if (!async_fibre_swapcontext(&job->fibrectx,
167 &ctx->dispatcher, 1)) {
169 * Should not happen. Getting here will close the thread...can't do
172 ERR_raise(ERR_LIB_ASYNC, ASYNC_R_FAILED_TO_SWAP_CONTEXT);
177 int ASYNC_start_job(ASYNC_JOB **job, ASYNC_WAIT_CTX *wctx, int *ret,
178 int (*func)(void *), void *args, size_t size)
181 OSSL_LIB_CTX *libctx;
183 if (!OPENSSL_init_crypto(OPENSSL_INIT_ASYNC, NULL))
186 ctx = async_get_ctx();
188 ctx = async_ctx_new();
196 if (ctx->currjob != NULL) {
197 if (ctx->currjob->status == ASYNC_JOB_STOPPING) {
198 *ret = ctx->currjob->ret;
199 ctx->currjob->waitctx = NULL;
200 async_release_job(ctx->currjob);
206 if (ctx->currjob->status == ASYNC_JOB_PAUSING) {
208 ctx->currjob->status = ASYNC_JOB_PAUSED;
213 if (ctx->currjob->status == ASYNC_JOB_PAUSED) {
219 * Restore the default libctx to what it was the last time the
222 libctx = OSSL_LIB_CTX_set0_default(ctx->currjob->libctx);
223 if (libctx == NULL) {
224 /* Failed to set the default context */
225 ERR_raise(ERR_LIB_ASYNC, ERR_R_INTERNAL_ERROR);
228 /* Resume previous job */
229 if (!async_fibre_swapcontext(&ctx->dispatcher,
230 &ctx->currjob->fibrectx, 1)) {
231 ctx->currjob->libctx = OSSL_LIB_CTX_set0_default(libctx);
232 ERR_raise(ERR_LIB_ASYNC, ASYNC_R_FAILED_TO_SWAP_CONTEXT);
236 * In case the fibre changed the default libctx we set it back
237 * again to what it was originally, and remember what it had
240 ctx->currjob->libctx = OSSL_LIB_CTX_set0_default(libctx);
244 /* Should not happen */
245 ERR_raise(ERR_LIB_ASYNC, ERR_R_INTERNAL_ERROR);
246 async_release_job(ctx->currjob);
252 /* Start a new job */
253 if ((ctx->currjob = async_get_pool_job()) == NULL)
254 return ASYNC_NO_JOBS;
257 ctx->currjob->funcargs = OPENSSL_malloc(size);
258 if (ctx->currjob->funcargs == NULL) {
259 ERR_raise(ERR_LIB_ASYNC, ERR_R_MALLOC_FAILURE);
260 async_release_job(ctx->currjob);
264 memcpy(ctx->currjob->funcargs, args, size);
266 ctx->currjob->funcargs = NULL;
269 ctx->currjob->func = func;
270 ctx->currjob->waitctx = wctx;
271 libctx = ossl_lib_ctx_get_concrete(NULL);
272 if (!async_fibre_swapcontext(&ctx->dispatcher,
273 &ctx->currjob->fibrectx, 1)) {
274 ERR_raise(ERR_LIB_ASYNC, ASYNC_R_FAILED_TO_SWAP_CONTEXT);
278 * In case the fibre changed the default libctx we set it back again
279 * to what it was, and remember what it had been changed to.
281 ctx->currjob->libctx = OSSL_LIB_CTX_set0_default(libctx);
285 async_release_job(ctx->currjob);
291 int ASYNC_pause_job(void)
294 async_ctx *ctx = async_get_ctx();
297 || ctx->currjob == NULL
300 * Could be we've deliberately not been started within a job so this is
301 * counted as success.
307 job->status = ASYNC_JOB_PAUSING;
309 if (!async_fibre_swapcontext(&job->fibrectx,
310 &ctx->dispatcher, 1)) {
311 ERR_raise(ERR_LIB_ASYNC, ASYNC_R_FAILED_TO_SWAP_CONTEXT);
314 /* Reset counts of added and deleted fds */
315 async_wait_ctx_reset_counts(job->waitctx);
320 static void async_empty_pool(async_pool *pool)
324 if (pool == NULL || pool->jobs == NULL)
328 job = sk_ASYNC_JOB_pop(pool->jobs);
335 if (!CRYPTO_THREAD_init_local(&ctxkey, NULL))
338 if (!CRYPTO_THREAD_init_local(&poolkey, NULL)) {
339 CRYPTO_THREAD_cleanup_local(&ctxkey);
343 return async_local_init();
346 void async_deinit(void)
348 CRYPTO_THREAD_cleanup_local(&ctxkey);
349 CRYPTO_THREAD_cleanup_local(&poolkey);
350 async_local_deinit();
353 int ASYNC_init_thread(size_t max_size, size_t init_size)
356 size_t curr_size = 0;
358 if (init_size > max_size) {
359 ERR_raise(ERR_LIB_ASYNC, ASYNC_R_INVALID_POOL_SIZE);
363 if (!OPENSSL_init_crypto(OPENSSL_INIT_ASYNC, NULL))
366 if (!ossl_init_thread_start(NULL, NULL, async_delete_thread_state))
369 pool = OPENSSL_zalloc(sizeof(*pool));
371 ERR_raise(ERR_LIB_ASYNC, ERR_R_MALLOC_FAILURE);
375 pool->jobs = sk_ASYNC_JOB_new_reserve(NULL, init_size);
376 if (pool->jobs == NULL) {
377 ERR_raise(ERR_LIB_ASYNC, ERR_R_MALLOC_FAILURE);
382 pool->max_size = max_size;
384 /* Pre-create jobs as required */
385 while (init_size--) {
387 job = async_job_new();
388 if (job == NULL || !async_fibre_makecontext(&job->fibrectx)) {
390 * Not actually fatal because we already created the pool, just
391 * skip creation of any more jobs
396 job->funcargs = NULL;
397 sk_ASYNC_JOB_push(pool->jobs, job); /* Cannot fail due to reserve */
400 pool->curr_size = curr_size;
401 if (!CRYPTO_THREAD_set_local(&poolkey, pool)) {
402 ERR_raise(ERR_LIB_ASYNC, ASYNC_R_FAILED_TO_SET_POOL);
408 async_empty_pool(pool);
409 sk_ASYNC_JOB_free(pool->jobs);
414 static void async_delete_thread_state(void *arg)
416 async_pool *pool = (async_pool *)CRYPTO_THREAD_get_local(&poolkey);
419 async_empty_pool(pool);
420 sk_ASYNC_JOB_free(pool->jobs);
422 CRYPTO_THREAD_set_local(&poolkey, NULL);
424 async_local_cleanup();
428 void ASYNC_cleanup_thread(void)
430 if (!OPENSSL_init_crypto(OPENSSL_INIT_ASYNC, NULL))
433 async_delete_thread_state(NULL);
436 ASYNC_JOB *ASYNC_get_current_job(void)
440 if (!OPENSSL_init_crypto(OPENSSL_INIT_ASYNC, NULL))
443 ctx = async_get_ctx();
450 ASYNC_WAIT_CTX *ASYNC_get_wait_ctx(ASYNC_JOB *job)
455 void ASYNC_block_pause(void)
459 if (!OPENSSL_init_crypto(OPENSSL_INIT_ASYNC, NULL))
462 ctx = async_get_ctx();
463 if (ctx == NULL || ctx->currjob == NULL) {
465 * We're not in a job anyway so ignore this
472 void ASYNC_unblock_pause(void)
476 if (!OPENSSL_init_crypto(OPENSSL_INIT_ASYNC, NULL))
479 ctx = async_get_ctx();
480 if (ctx == NULL || ctx->currjob == NULL) {
482 * We're not in a job anyway so ignore this
486 if (ctx->blocked > 0)