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 async_ctx *async_ctx_new(void)
74 async_ctx *nctx = NULL;
76 nctx = OPENSSL_malloc(sizeof (async_ctx));
78 ASYNCerr(ASYNC_F_ASYNC_CTX_NEW, ERR_R_MALLOC_FAILURE);
82 async_fibre_init_dispatcher(&nctx->dispatcher);
85 if (!async_set_ctx(nctx))
95 static int async_ctx_free(void)
99 ctx = async_get_ctx();
101 if (!async_set_ctx(NULL))
109 static ASYNC_JOB *async_job_new(void)
111 ASYNC_JOB *job = NULL;
112 OSSL_ASYNC_FD pipefds[2];
114 job = OPENSSL_malloc(sizeof (ASYNC_JOB));
116 ASYNCerr(ASYNC_F_ASYNC_JOB_NEW, ERR_R_MALLOC_FAILURE);
120 if (!async_pipe(pipefds)) {
122 ASYNCerr(ASYNC_F_ASYNC_JOB_NEW, ASYNC_R_CANNOT_CREATE_WAIT_PIPE);
127 job->wait_fd = pipefds[0];
128 job->wake_fd = pipefds[1];
130 job->status = ASYNC_JOB_RUNNING;
131 job->funcargs = NULL;
136 static void async_job_free(ASYNC_JOB *job)
139 OPENSSL_free(job->funcargs);
140 async_fibre_free(&job->fibrectx);
145 static ASYNC_JOB *async_get_pool_job(void) {
147 STACK_OF(ASYNC_JOB) *pool;
149 pool = async_get_pool();
152 * Pool has not been initialised, so init with the defaults, i.e.
153 * no max size and no pre-created jobs
155 if (ASYNC_init_pool(0, 0) == 0)
157 pool = async_get_pool();
160 job = sk_ASYNC_JOB_pop(pool);
163 if (!async_pool_can_grow())
166 job = async_job_new();
168 async_fibre_makecontext(&job->fibrectx);
169 async_increment_pool_size();
175 static void async_release_job(ASYNC_JOB *job) {
176 OPENSSL_free(job->funcargs);
177 job->funcargs = NULL;
178 /* Ignore error return */
179 async_release_job_to_pool(job);
182 void async_start_func(void)
188 job = async_get_ctx()->currjob;
189 job->ret = job->func(job->funcargs);
192 job->status = ASYNC_JOB_STOPPING;
193 if (!async_fibre_swapcontext(&job->fibrectx,
194 &async_get_ctx()->dispatcher, 1)) {
196 * Should not happen. Getting here will close the thread...can't do
199 ASYNCerr(ASYNC_F_ASYNC_START_FUNC, ASYNC_R_FAILED_TO_SWAP_CONTEXT);
204 int ASYNC_start_job(ASYNC_JOB **job, int *ret, int (*func)(void *),
205 void *args, size_t size)
207 if (async_get_ctx() == NULL && async_ctx_new() == NULL) {
212 async_get_ctx()->currjob = *job;
216 if (async_get_ctx()->currjob != NULL) {
217 if (async_get_ctx()->currjob->status == ASYNC_JOB_STOPPING) {
218 *ret = async_get_ctx()->currjob->ret;
219 async_release_job(async_get_ctx()->currjob);
220 async_get_ctx()->currjob = NULL;
225 if (async_get_ctx()->currjob->status == ASYNC_JOB_PAUSING) {
226 *job = async_get_ctx()->currjob;
227 async_get_ctx()->currjob->status = ASYNC_JOB_PAUSED;
228 async_get_ctx()->currjob = NULL;
232 if (async_get_ctx()->currjob->status == ASYNC_JOB_PAUSED) {
233 async_get_ctx()->currjob = *job;
234 /* Resume previous job */
235 if (!async_fibre_swapcontext(&async_get_ctx()->dispatcher,
236 &async_get_ctx()->currjob->fibrectx, 1)) {
237 ASYNCerr(ASYNC_F_ASYNC_START_JOB,
238 ASYNC_R_FAILED_TO_SWAP_CONTEXT);
244 /* Should not happen */
245 ASYNCerr(ASYNC_F_ASYNC_START_JOB, ERR_R_INTERNAL_ERROR);
246 async_release_job(async_get_ctx()->currjob);
247 async_get_ctx()->currjob = NULL;
252 /* Start a new job */
253 if ((async_get_ctx()->currjob = async_get_pool_job()) == NULL) {
254 return ASYNC_NO_JOBS;
258 async_get_ctx()->currjob->funcargs = OPENSSL_malloc(size);
259 if (async_get_ctx()->currjob->funcargs == NULL) {
260 ASYNCerr(ASYNC_F_ASYNC_START_JOB, ERR_R_MALLOC_FAILURE);
261 async_release_job(async_get_ctx()->currjob);
262 async_get_ctx()->currjob = NULL;
265 memcpy(async_get_ctx()->currjob->funcargs, args, size);
267 async_get_ctx()->currjob->funcargs = NULL;
270 async_get_ctx()->currjob->func = func;
271 if (!async_fibre_swapcontext(&async_get_ctx()->dispatcher,
272 &async_get_ctx()->currjob->fibrectx, 1)) {
273 ASYNCerr(ASYNC_F_ASYNC_START_JOB, ASYNC_R_FAILED_TO_SWAP_CONTEXT);
279 async_release_job(async_get_ctx()->currjob);
280 async_get_ctx()->currjob = NULL;
286 int ASYNC_pause_job(void)
290 if (async_get_ctx() == NULL
291 || async_get_ctx()->currjob == NULL
292 || async_get_ctx()->blocked) {
294 * Could be we've deliberately not been started within a job so this is
295 * counted as success.
300 job = async_get_ctx()->currjob;
301 job->status = ASYNC_JOB_PAUSING;
303 if (!async_fibre_swapcontext(&job->fibrectx,
304 &async_get_ctx()->dispatcher, 1)) {
305 ASYNCerr(ASYNC_F_ASYNC_PAUSE_JOB, ASYNC_R_FAILED_TO_SWAP_CONTEXT);
312 static void async_empty_pool(STACK_OF(ASYNC_JOB) *pool)
317 job = sk_ASYNC_JOB_pop(pool);
322 int ASYNC_init_pool(size_t max_size, size_t init_size)
324 STACK_OF(ASYNC_JOB) *pool;
325 size_t curr_size = 0;
327 if (init_size > max_size) {
328 ASYNCerr(ASYNC_F_ASYNC_INIT_POOL, ASYNC_R_INVALID_POOL_SIZE);
332 pool = sk_ASYNC_JOB_new_null();
334 ASYNCerr(ASYNC_F_ASYNC_INIT_POOL, ERR_R_MALLOC_FAILURE);
337 /* Pre-create jobs as required */
340 job = async_job_new();
342 async_fibre_makecontext(&job->fibrectx);
343 job->funcargs = NULL;
344 sk_ASYNC_JOB_push(pool, job);
349 * Not actually fatal because we already created the pool, just skip
350 * creation of any more jobs
356 if (!async_set_pool(pool, curr_size, max_size)) {
357 ASYNCerr(ASYNC_F_ASYNC_INIT_POOL, ASYNC_R_FAILED_TO_SET_POOL);
358 async_empty_pool(pool);
359 sk_ASYNC_JOB_free(pool);
366 void ASYNC_free_pool(void)
368 STACK_OF(ASYNC_JOB) *pool;
370 pool = async_get_pool();
374 async_empty_pool(pool);
375 async_release_pool();
379 ASYNC_JOB *ASYNC_get_current_job(void)
383 ctx = async_get_ctx();
390 OSSL_ASYNC_FD ASYNC_get_wait_fd(ASYNC_JOB *job)
395 void ASYNC_wake(ASYNC_JOB *job)
401 async_write1(job->wake_fd, &dummy);
405 void ASYNC_clear_wake(ASYNC_JOB *job)
410 async_read1(job->wait_fd, &dummy);
414 void ASYNC_block_pause(void)
416 if (async_get_ctx() == NULL
417 || async_get_ctx()->currjob == NULL) {
419 * We're not in a job anyway so ignore this
423 async_get_ctx()->blocked++;
426 void ASYNC_unblock_pause(void)
428 if (async_get_ctx() == NULL
429 || async_get_ctx()->currjob == NULL) {
431 * We're not in a job anyway so ignore this
435 if(async_get_ctx()->blocked > 0)
436 async_get_ctx()->blocked--;