2 * Written by Matt Caswell (matt@openssl.org) for the OpenSSL project.
4 /* ====================================================================
5 * Copyright (c) 2015 The OpenSSL Project. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials provided with the
19 * 3. All advertising materials mentioning features or use of this
20 * software must display the following acknowledgment:
21 * "This product includes software developed by the OpenSSL Project
22 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
24 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
25 * endorse or promote products derived from this software without
26 * prior written permission. For written permission, please contact
27 * licensing@OpenSSL.org.
29 * 5. Products derived from this software may not be called "OpenSSL"
30 * nor may "OpenSSL" appear in their names without prior written
31 * permission of the OpenSSL Project.
33 * 6. Redistributions of any form whatsoever must retain the following
35 * "This product includes software developed by the OpenSSL Project
36 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
38 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
39 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
40 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
41 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
42 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
43 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
44 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
45 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
46 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
47 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
48 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
49 * OF THE POSSIBILITY OF SUCH DAMAGE.
50 * ====================================================================
54 * Without this we start getting longjmp crashes because it thinks we're jumping
55 * up the stack when in fact we are jumping to an entirely different stack. The
56 * cost of this is not having certain buffer overrun/underrun checks etc for
57 * this source file :-(
59 #undef _FORTIFY_SOURCE
61 /* This must be the first #include file */
62 #include "async_locl.h"
64 #include <openssl/err.h>
65 #include <internal/cryptlib_int.h>
68 #define ASYNC_JOB_RUNNING 0
69 #define ASYNC_JOB_PAUSING 1
70 #define ASYNC_JOB_PAUSED 2
71 #define ASYNC_JOB_STOPPING 3
73 static void async_free_pool_internal(async_pool *pool);
75 static async_ctx *async_ctx_new(void)
77 async_ctx *nctx = NULL;
79 nctx = OPENSSL_malloc(sizeof (async_ctx));
81 ASYNCerr(ASYNC_F_ASYNC_CTX_NEW, ERR_R_MALLOC_FAILURE);
85 async_fibre_init_dispatcher(&nctx->dispatcher);
88 if (!async_set_ctx(nctx))
98 static async_ctx *async_get_ctx(void)
100 if (!OPENSSL_init_crypto(OPENSSL_INIT_ASYNC, NULL))
102 return async_arch_get_ctx();
105 static int async_ctx_free(void)
109 ctx = async_get_ctx();
111 if (!async_set_ctx(NULL))
119 static ASYNC_JOB *async_job_new(void)
121 ASYNC_JOB *job = NULL;
122 OSSL_ASYNC_FD pipefds[2];
124 job = OPENSSL_malloc(sizeof (ASYNC_JOB));
126 ASYNCerr(ASYNC_F_ASYNC_JOB_NEW, ERR_R_MALLOC_FAILURE);
130 if (!async_pipe(pipefds)) {
132 ASYNCerr(ASYNC_F_ASYNC_JOB_NEW, ASYNC_R_CANNOT_CREATE_WAIT_PIPE);
137 job->wait_fd = pipefds[0];
138 job->wake_fd = pipefds[1];
140 job->status = ASYNC_JOB_RUNNING;
141 job->funcargs = NULL;
146 static void async_job_free(ASYNC_JOB *job)
149 OPENSSL_free(job->funcargs);
150 async_fibre_free(&job->fibrectx);
151 async_close_fd(job->wait_fd);
152 async_close_fd(job->wake_fd);
157 static ASYNC_JOB *async_get_pool_job(void) {
161 pool = async_get_pool();
164 * Pool has not been initialised, so init with the defaults, i.e.
165 * no max size and no pre-created jobs
167 if (ASYNC_init_thread(0, 0) == 0)
169 pool = async_get_pool();
172 job = sk_ASYNC_JOB_pop(pool->jobs);
175 if ((pool->max_size != 0) && (pool->curr_size >= pool->max_size))
178 job = async_job_new();
180 if (! async_fibre_makecontext(&job->fibrectx)) {
190 static void async_release_job(ASYNC_JOB *job) {
193 pool = async_get_pool();
194 OPENSSL_free(job->funcargs);
195 job->funcargs = NULL;
196 sk_ASYNC_JOB_push(pool->jobs, job);
199 void async_start_func(void)
202 async_ctx *ctx = async_get_ctx();
207 job->ret = job->func(job->funcargs);
210 job->status = ASYNC_JOB_STOPPING;
211 if (!async_fibre_swapcontext(&job->fibrectx,
212 &ctx->dispatcher, 1)) {
214 * Should not happen. Getting here will close the thread...can't do
217 ASYNCerr(ASYNC_F_ASYNC_START_FUNC, ASYNC_R_FAILED_TO_SWAP_CONTEXT);
222 int ASYNC_start_job(ASYNC_JOB **job, int *ret, int (*func)(void *),
223 void *args, size_t size)
225 async_ctx *ctx = async_get_ctx();
227 ctx = async_ctx_new();
237 if (ctx->currjob != NULL) {
238 if (ctx->currjob->status == ASYNC_JOB_STOPPING) {
239 *ret = ctx->currjob->ret;
240 async_release_job(ctx->currjob);
246 if (ctx->currjob->status == ASYNC_JOB_PAUSING) {
248 ctx->currjob->status = ASYNC_JOB_PAUSED;
253 if (ctx->currjob->status == ASYNC_JOB_PAUSED) {
255 /* Resume previous job */
256 if (!async_fibre_swapcontext(&ctx->dispatcher,
257 &ctx->currjob->fibrectx, 1)) {
258 ASYNCerr(ASYNC_F_ASYNC_START_JOB,
259 ASYNC_R_FAILED_TO_SWAP_CONTEXT);
265 /* Should not happen */
266 ASYNCerr(ASYNC_F_ASYNC_START_JOB, ERR_R_INTERNAL_ERROR);
267 async_release_job(ctx->currjob);
273 /* Start a new job */
274 if ((ctx->currjob = async_get_pool_job()) == NULL) {
275 return ASYNC_NO_JOBS;
279 ctx->currjob->funcargs = OPENSSL_malloc(size);
280 if (ctx->currjob->funcargs == NULL) {
281 ASYNCerr(ASYNC_F_ASYNC_START_JOB, ERR_R_MALLOC_FAILURE);
282 async_release_job(ctx->currjob);
286 memcpy(ctx->currjob->funcargs, args, size);
288 ctx->currjob->funcargs = NULL;
291 ctx->currjob->func = func;
292 if (!async_fibre_swapcontext(&ctx->dispatcher,
293 &ctx->currjob->fibrectx, 1)) {
294 ASYNCerr(ASYNC_F_ASYNC_START_JOB, ASYNC_R_FAILED_TO_SWAP_CONTEXT);
300 async_release_job(ctx->currjob);
307 int ASYNC_pause_job(void)
310 async_ctx *ctx = async_get_ctx();
313 || ctx->currjob == NULL
316 * Could be we've deliberately not been started within a job so this is
317 * counted as success.
323 job->status = ASYNC_JOB_PAUSING;
325 if (!async_fibre_swapcontext(&job->fibrectx,
326 &ctx->dispatcher, 1)) {
327 ASYNCerr(ASYNC_F_ASYNC_PAUSE_JOB, ASYNC_R_FAILED_TO_SWAP_CONTEXT);
334 static void async_empty_pool(async_pool *pool)
338 if (!pool || !pool->jobs)
342 job = sk_ASYNC_JOB_pop(pool->jobs);
349 if (!async_global_init())
355 int ASYNC_init_thread(size_t max_size, size_t init_size)
358 size_t curr_size = 0;
360 if (init_size > max_size) {
361 ASYNCerr(ASYNC_F_ASYNC_INIT_THREAD, ASYNC_R_INVALID_POOL_SIZE);
365 if (!OPENSSL_init_crypto(OPENSSL_INIT_ASYNC, NULL)) {
368 if (!ossl_init_thread_start(OPENSSL_INIT_THREAD_ASYNC)) {
372 pool = OPENSSL_zalloc(sizeof *pool);
374 ASYNCerr(ASYNC_F_ASYNC_INIT_THREAD, ERR_R_MALLOC_FAILURE);
378 pool->jobs = sk_ASYNC_JOB_new_null();
379 if (pool->jobs == NULL) {
380 ASYNCerr(ASYNC_F_ASYNC_INIT_THREAD, ERR_R_MALLOC_FAILURE);
385 pool->max_size = max_size;
387 /* Pre-create jobs as required */
388 while (init_size--) {
390 job = async_job_new();
391 if (job == NULL || !async_fibre_makecontext(&job->fibrectx)) {
393 * Not actually fatal because we already created the pool, just
394 * skip creation of any more jobs
399 job->funcargs = NULL;
400 sk_ASYNC_JOB_push(pool->jobs, job);
403 pool->curr_size = curr_size;
404 if (!async_set_pool(pool)) {
405 ASYNCerr(ASYNC_F_ASYNC_INIT_THREAD, ASYNC_R_FAILED_TO_SET_POOL);
411 async_free_pool_internal(pool);
415 static void async_free_pool_internal(async_pool *pool)
420 async_empty_pool(pool);
421 sk_ASYNC_JOB_free(pool->jobs);
423 (void)async_set_pool(NULL);
424 async_local_cleanup();
428 void ASYNC_cleanup_thread(void)
430 async_free_pool_internal(async_get_pool());
433 ASYNC_JOB *ASYNC_get_current_job(void)
437 ctx = async_get_ctx();
444 OSSL_ASYNC_FD ASYNC_get_wait_fd(ASYNC_JOB *job)
449 void ASYNC_wake(ASYNC_JOB *job)
455 async_write1(job->wake_fd, &dummy);
459 void ASYNC_clear_wake(ASYNC_JOB *job)
464 async_read1(job->wait_fd, &dummy);
468 void ASYNC_block_pause(void)
470 async_ctx *ctx = async_get_ctx();
471 if (ctx == NULL || ctx->currjob == NULL) {
473 * We're not in a job anyway so ignore this
480 void ASYNC_unblock_pause(void)
482 async_ctx *ctx = async_get_ctx();
483 if (ctx == NULL || ctx->currjob == NULL) {
485 * We're not in a job anyway so ignore this