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>
67 #define ASYNC_JOB_RUNNING 0
68 #define ASYNC_JOB_PAUSING 1
69 #define ASYNC_JOB_PAUSED 2
70 #define ASYNC_JOB_STOPPING 3
72 static void async_free_pool_internal(async_pool *pool);
74 static async_ctx *async_ctx_new(void)
76 async_ctx *nctx = NULL;
78 nctx = OPENSSL_malloc(sizeof (async_ctx));
80 ASYNCerr(ASYNC_F_ASYNC_CTX_NEW, ERR_R_MALLOC_FAILURE);
84 async_fibre_init_dispatcher(&nctx->dispatcher);
87 if (!async_set_ctx(nctx))
97 static int async_ctx_free(void)
101 ctx = async_get_ctx();
103 if (!async_set_ctx(NULL))
111 static ASYNC_JOB *async_job_new(void)
113 ASYNC_JOB *job = NULL;
114 OSSL_ASYNC_FD pipefds[2];
116 job = OPENSSL_malloc(sizeof (ASYNC_JOB));
118 ASYNCerr(ASYNC_F_ASYNC_JOB_NEW, ERR_R_MALLOC_FAILURE);
122 if (!async_pipe(pipefds)) {
124 ASYNCerr(ASYNC_F_ASYNC_JOB_NEW, ASYNC_R_CANNOT_CREATE_WAIT_PIPE);
129 job->wait_fd = pipefds[0];
130 job->wake_fd = pipefds[1];
132 job->status = ASYNC_JOB_RUNNING;
133 job->funcargs = NULL;
138 static void async_job_free(ASYNC_JOB *job)
141 OPENSSL_free(job->funcargs);
142 async_fibre_free(&job->fibrectx);
143 async_close_fd(job->wait_fd);
144 async_close_fd(job->wake_fd);
149 static ASYNC_JOB *async_get_pool_job(void) {
153 pool = async_get_pool();
156 * Pool has not been initialised, so init with the defaults, i.e.
157 * no max size and no pre-created jobs
159 if (ASYNC_init_thread(0, 0) == 0)
161 pool = async_get_pool();
164 job = sk_ASYNC_JOB_pop(pool->jobs);
167 if ((pool->max_size != 0) && (pool->curr_size >= pool->max_size))
170 job = async_job_new();
172 if (! async_fibre_makecontext(&job->fibrectx)) {
182 static void async_release_job(ASYNC_JOB *job) {
185 pool = async_get_pool();
186 OPENSSL_free(job->funcargs);
187 job->funcargs = NULL;
188 sk_ASYNC_JOB_push(pool->jobs, job);
191 void async_start_func(void)
197 job = async_get_ctx()->currjob;
198 job->ret = job->func(job->funcargs);
201 job->status = ASYNC_JOB_STOPPING;
202 if (!async_fibre_swapcontext(&job->fibrectx,
203 &async_get_ctx()->dispatcher, 1)) {
205 * Should not happen. Getting here will close the thread...can't do
208 ASYNCerr(ASYNC_F_ASYNC_START_FUNC, ASYNC_R_FAILED_TO_SWAP_CONTEXT);
213 int ASYNC_start_job(ASYNC_JOB **job, int *ret, int (*func)(void *),
214 void *args, size_t size)
216 if (async_get_ctx() == NULL && async_ctx_new() == NULL) {
221 async_get_ctx()->currjob = *job;
225 if (async_get_ctx()->currjob != NULL) {
226 if (async_get_ctx()->currjob->status == ASYNC_JOB_STOPPING) {
227 *ret = async_get_ctx()->currjob->ret;
228 async_release_job(async_get_ctx()->currjob);
229 async_get_ctx()->currjob = NULL;
234 if (async_get_ctx()->currjob->status == ASYNC_JOB_PAUSING) {
235 *job = async_get_ctx()->currjob;
236 async_get_ctx()->currjob->status = ASYNC_JOB_PAUSED;
237 async_get_ctx()->currjob = NULL;
241 if (async_get_ctx()->currjob->status == ASYNC_JOB_PAUSED) {
242 async_get_ctx()->currjob = *job;
243 /* Resume previous job */
244 if (!async_fibre_swapcontext(&async_get_ctx()->dispatcher,
245 &async_get_ctx()->currjob->fibrectx, 1)) {
246 ASYNCerr(ASYNC_F_ASYNC_START_JOB,
247 ASYNC_R_FAILED_TO_SWAP_CONTEXT);
253 /* Should not happen */
254 ASYNCerr(ASYNC_F_ASYNC_START_JOB, ERR_R_INTERNAL_ERROR);
255 async_release_job(async_get_ctx()->currjob);
256 async_get_ctx()->currjob = NULL;
261 /* Start a new job */
262 if ((async_get_ctx()->currjob = async_get_pool_job()) == NULL) {
263 return ASYNC_NO_JOBS;
267 async_get_ctx()->currjob->funcargs = OPENSSL_malloc(size);
268 if (async_get_ctx()->currjob->funcargs == NULL) {
269 ASYNCerr(ASYNC_F_ASYNC_START_JOB, ERR_R_MALLOC_FAILURE);
270 async_release_job(async_get_ctx()->currjob);
271 async_get_ctx()->currjob = NULL;
274 memcpy(async_get_ctx()->currjob->funcargs, args, size);
276 async_get_ctx()->currjob->funcargs = NULL;
279 async_get_ctx()->currjob->func = func;
280 if (!async_fibre_swapcontext(&async_get_ctx()->dispatcher,
281 &async_get_ctx()->currjob->fibrectx, 1)) {
282 ASYNCerr(ASYNC_F_ASYNC_START_JOB, ASYNC_R_FAILED_TO_SWAP_CONTEXT);
288 async_release_job(async_get_ctx()->currjob);
289 async_get_ctx()->currjob = NULL;
295 int ASYNC_pause_job(void)
299 if (async_get_ctx() == NULL
300 || async_get_ctx()->currjob == NULL
301 || async_get_ctx()->blocked) {
303 * Could be we've deliberately not been started within a job so this is
304 * counted as success.
309 job = async_get_ctx()->currjob;
310 job->status = ASYNC_JOB_PAUSING;
312 if (!async_fibre_swapcontext(&job->fibrectx,
313 &async_get_ctx()->dispatcher, 1)) {
314 ASYNCerr(ASYNC_F_ASYNC_PAUSE_JOB, ASYNC_R_FAILED_TO_SWAP_CONTEXT);
321 static void async_empty_pool(async_pool *pool)
325 if (!pool || !pool->jobs)
329 job = sk_ASYNC_JOB_pop(pool->jobs);
334 int ASYNC_init(int init_thread, size_t max_size, size_t init_size)
336 if (!async_global_init())
340 return ASYNC_init_thread(max_size, init_size);
345 int ASYNC_init_thread(size_t max_size, size_t init_size)
348 size_t curr_size = 0;
350 if (init_size > max_size) {
351 ASYNCerr(ASYNC_F_ASYNC_INIT_THREAD, ASYNC_R_INVALID_POOL_SIZE);
355 if (!async_local_init()) {
356 ASYNCerr(ASYNC_F_ASYNC_INIT_THREAD, ASYNC_R_INIT_FAILED);
359 pool = OPENSSL_zalloc(sizeof *pool);
361 ASYNCerr(ASYNC_F_ASYNC_INIT_THREAD, ERR_R_MALLOC_FAILURE);
365 pool->jobs = sk_ASYNC_JOB_new_null();
366 if (pool->jobs == NULL) {
367 ASYNCerr(ASYNC_F_ASYNC_INIT_THREAD, ERR_R_MALLOC_FAILURE);
372 pool->max_size = max_size;
374 /* Pre-create jobs as required */
375 while (init_size--) {
377 job = async_job_new();
378 if (job == NULL || !async_fibre_makecontext(&job->fibrectx)) {
380 * Not actually fatal because we already created the pool, just
381 * skip creation of any more jobs
386 job->funcargs = NULL;
387 sk_ASYNC_JOB_push(pool->jobs, job);
390 pool->curr_size = curr_size;
391 if (!async_set_pool(pool)) {
392 ASYNCerr(ASYNC_F_ASYNC_INIT_THREAD, ASYNC_R_FAILED_TO_SET_POOL);
398 async_free_pool_internal(pool);
402 static void async_free_pool_internal(async_pool *pool)
407 async_empty_pool(pool);
408 sk_ASYNC_JOB_free(pool->jobs);
410 (void)async_set_pool(NULL);
411 async_local_cleanup();
415 void ASYNC_cleanup_thread(void)
417 async_free_pool_internal(async_get_pool());
420 void ASYNC_cleanup(int cleanupthread)
423 * We don't actually have any global cleanup at the moment so just cleanup
427 ASYNC_cleanup_thread();
430 ASYNC_JOB *ASYNC_get_current_job(void)
434 ctx = async_get_ctx();
441 OSSL_ASYNC_FD ASYNC_get_wait_fd(ASYNC_JOB *job)
446 void ASYNC_wake(ASYNC_JOB *job)
452 async_write1(job->wake_fd, &dummy);
456 void ASYNC_clear_wake(ASYNC_JOB *job)
461 async_read1(job->wait_fd, &dummy);
465 void ASYNC_block_pause(void)
467 if (async_get_ctx() == NULL
468 || async_get_ctx()->currjob == NULL) {
470 * We're not in a job anyway so ignore this
474 async_get_ctx()->blocked++;
477 void ASYNC_unblock_pause(void)
479 if (async_get_ctx() == NULL
480 || async_get_ctx()->currjob == NULL) {
482 * We're not in a job anyway so ignore this
486 if(async_get_ctx()->blocked > 0)
487 async_get_ctx()->blocked--;