1 /* crypto/async/async.c */
3 * Written by Matt Caswell (matt@openssl.org) for the OpenSSL project.
5 /* ====================================================================
6 * Copyright (c) 2015 The OpenSSL Project. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in
17 * the documentation and/or other materials provided with the
20 * 3. All advertising materials mentioning features or use of this
21 * software must display the following acknowledgment:
22 * "This product includes software developed by the OpenSSL Project
23 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
25 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26 * endorse or promote products derived from this software without
27 * prior written permission. For written permission, please contact
28 * licensing@OpenSSL.org.
30 * 5. Products derived from this software may not be called "OpenSSL"
31 * nor may "OpenSSL" appear in their names without prior written
32 * permission of the OpenSSL Project.
34 * 6. Redistributions of any form whatsoever must retain the following
36 * "This product includes software developed by the OpenSSL Project
37 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
39 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
43 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50 * OF THE POSSIBILITY OF SUCH DAMAGE.
51 * ====================================================================
55 * Without this we start getting longjmp crashes because it thinks we're jumping
56 * up the stack when in fact we are jumping to an entirely different stack. The
57 * cost of this is not having certain buffer overrun/underrun checks etc for
58 * this source file :-(
60 #undef _FORTIFY_SOURCE
62 #include <openssl/err.h>
63 #include <openssl/async.h>
65 #include "async_locl.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_pool(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 async_fibre_makecontext(&job->fibrectx);
179 static void async_release_job(ASYNC_JOB *job) {
182 pool = async_get_pool();
183 OPENSSL_free(job->funcargs);
184 job->funcargs = NULL;
185 sk_ASYNC_JOB_push(pool->jobs, job);
188 void async_start_func(void)
194 job = async_get_ctx()->currjob;
195 job->ret = job->func(job->funcargs);
198 job->status = ASYNC_JOB_STOPPING;
199 if (!async_fibre_swapcontext(&job->fibrectx,
200 &async_get_ctx()->dispatcher, 1)) {
202 * Should not happen. Getting here will close the thread...can't do
205 ASYNCerr(ASYNC_F_ASYNC_START_FUNC, ASYNC_R_FAILED_TO_SWAP_CONTEXT);
210 int ASYNC_start_job(ASYNC_JOB **job, int *ret, int (*func)(void *),
211 void *args, size_t size)
213 if (async_get_ctx() == NULL && async_ctx_new() == NULL) {
218 async_get_ctx()->currjob = *job;
222 if (async_get_ctx()->currjob != NULL) {
223 if (async_get_ctx()->currjob->status == ASYNC_JOB_STOPPING) {
224 *ret = async_get_ctx()->currjob->ret;
225 async_release_job(async_get_ctx()->currjob);
226 async_get_ctx()->currjob = NULL;
231 if (async_get_ctx()->currjob->status == ASYNC_JOB_PAUSING) {
232 *job = async_get_ctx()->currjob;
233 async_get_ctx()->currjob->status = ASYNC_JOB_PAUSED;
234 async_get_ctx()->currjob = NULL;
238 if (async_get_ctx()->currjob->status == ASYNC_JOB_PAUSED) {
239 async_get_ctx()->currjob = *job;
240 /* Resume previous job */
241 if (!async_fibre_swapcontext(&async_get_ctx()->dispatcher,
242 &async_get_ctx()->currjob->fibrectx, 1)) {
243 ASYNCerr(ASYNC_F_ASYNC_START_JOB,
244 ASYNC_R_FAILED_TO_SWAP_CONTEXT);
250 /* Should not happen */
251 ASYNCerr(ASYNC_F_ASYNC_START_JOB, ERR_R_INTERNAL_ERROR);
252 async_release_job(async_get_ctx()->currjob);
253 async_get_ctx()->currjob = NULL;
258 /* Start a new job */
259 if ((async_get_ctx()->currjob = async_get_pool_job()) == NULL) {
260 return ASYNC_NO_JOBS;
264 async_get_ctx()->currjob->funcargs = OPENSSL_malloc(size);
265 if (async_get_ctx()->currjob->funcargs == NULL) {
266 ASYNCerr(ASYNC_F_ASYNC_START_JOB, ERR_R_MALLOC_FAILURE);
267 async_release_job(async_get_ctx()->currjob);
268 async_get_ctx()->currjob = NULL;
271 memcpy(async_get_ctx()->currjob->funcargs, args, size);
273 async_get_ctx()->currjob->funcargs = NULL;
276 async_get_ctx()->currjob->func = func;
277 if (!async_fibre_swapcontext(&async_get_ctx()->dispatcher,
278 &async_get_ctx()->currjob->fibrectx, 1)) {
279 ASYNCerr(ASYNC_F_ASYNC_START_JOB, ASYNC_R_FAILED_TO_SWAP_CONTEXT);
285 async_release_job(async_get_ctx()->currjob);
286 async_get_ctx()->currjob = NULL;
292 int ASYNC_pause_job(void)
296 if (async_get_ctx() == NULL
297 || async_get_ctx()->currjob == NULL
298 || async_get_ctx()->blocked) {
300 * Could be we've deliberately not been started within a job so this is
301 * counted as success.
306 job = async_get_ctx()->currjob;
307 job->status = ASYNC_JOB_PAUSING;
309 if (!async_fibre_swapcontext(&job->fibrectx,
310 &async_get_ctx()->dispatcher, 1)) {
311 ASYNCerr(ASYNC_F_ASYNC_PAUSE_JOB, ASYNC_R_FAILED_TO_SWAP_CONTEXT);
318 static void async_empty_pool(async_pool *pool)
322 if (!pool || !pool->jobs)
326 job = sk_ASYNC_JOB_pop(pool->jobs);
331 int ASYNC_init_pool(size_t max_size, size_t init_size)
334 size_t curr_size = 0;
336 if (init_size > max_size || max_size == 0) {
337 ASYNCerr(ASYNC_F_ASYNC_INIT_POOL, ASYNC_R_INVALID_POOL_SIZE);
341 if(async_get_pool() != NULL) {
342 ASYNCerr(ASYNC_F_ASYNC_INIT_POOL, ASYNC_R_POOL_ALREADY_INITED);
346 pool = OPENSSL_zalloc(sizeof *pool);
348 ASYNCerr(ASYNC_F_ASYNC_INIT_POOL, ERR_R_MALLOC_FAILURE);
352 pool->jobs = sk_ASYNC_JOB_new_null();
353 if (pool->jobs == NULL) {
354 ASYNCerr(ASYNC_F_ASYNC_INIT_POOL, ERR_R_MALLOC_FAILURE);
359 pool->max_size = max_size;
361 /* Pre-create jobs as required */
364 job = async_job_new();
366 async_fibre_makecontext(&job->fibrectx);
367 job->funcargs = NULL;
368 sk_ASYNC_JOB_push(pool->jobs, job);
373 * Not actually fatal because we already created the pool, just skip
374 * creation of any more jobs
379 pool->curr_size = curr_size;
381 if (!async_set_pool(pool)) {
382 ASYNCerr(ASYNC_F_ASYNC_INIT_POOL, ASYNC_R_FAILED_TO_SET_POOL);
388 async_free_pool_internal(pool);
392 static void async_free_pool_internal(async_pool *pool)
397 async_empty_pool(pool);
398 sk_ASYNC_JOB_free(pool->jobs);
400 async_set_pool(NULL);
404 void ASYNC_free_pool(void)
406 async_free_pool_internal(async_get_pool());
409 ASYNC_JOB *ASYNC_get_current_job(void)
413 ctx = async_get_ctx();
420 OSSL_ASYNC_FD ASYNC_get_wait_fd(ASYNC_JOB *job)
425 void ASYNC_wake(ASYNC_JOB *job)
431 async_write1(job->wake_fd, &dummy);
435 void ASYNC_clear_wake(ASYNC_JOB *job)
440 async_read1(job->wait_fd, &dummy);
444 void ASYNC_block_pause(void)
446 if (async_get_ctx() == NULL
447 || async_get_ctx()->currjob == NULL) {
449 * We're not in a job anyway so ignore this
453 async_get_ctx()->blocked++;
456 void ASYNC_unblock_pause(void)
458 if (async_get_ctx() == NULL
459 || async_get_ctx()->currjob == NULL) {
461 * We're not in a job anyway so ignore this
465 if(async_get_ctx()->blocked > 0)
466 async_get_ctx()->blocked--;