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 * ====================================================================
54 #include <openssl/err.h>
55 #include <openssl/async.h>
57 #include "async_locl.h"
59 #define ASYNC_JOB_RUNNING 0
60 #define ASYNC_JOB_PAUSING 1
61 #define ASYNC_JOB_PAUSED 2
62 #define ASYNC_JOB_STOPPING 3
64 static async_ctx *async_ctx_new(void)
66 async_ctx *nctx = NULL;
68 if(!(nctx = OPENSSL_malloc(sizeof (async_ctx)))) {
69 ASYNCerr(ASYNC_F_ASYNC_CTX_NEW, ERR_R_MALLOC_FAILURE);
73 async_fibre_init_dispatcher(&nctx->dispatcher);
75 if(!async_set_ctx(nctx))
87 static int async_ctx_free(void)
90 OPENSSL_free(async_get_ctx());
93 if(!async_set_ctx(NULL))
99 static ASYNC_JOB *async_job_new(void)
101 ASYNC_JOB *job = NULL;
104 if(!(job = OPENSSL_malloc(sizeof (ASYNC_JOB)))) {
105 ASYNCerr(ASYNC_F_ASYNC_JOB_NEW, ERR_R_MALLOC_FAILURE);
109 if(!async_pipe(pipefds)) {
111 ASYNCerr(ASYNC_F_ASYNC_JOB_NEW, ASYNC_R_CANNOT_CREATE_WAIT_PIPE);
116 job->wait_fd = pipefds[0];
117 job->wake_fd = pipefds[1];
119 job->status = ASYNC_JOB_RUNNING;
120 job->funcargs = NULL;
125 static void async_job_free(ASYNC_JOB *job)
129 OPENSSL_free(job->funcargs);
130 async_fibre_free(&job->fibrectx);
135 static ASYNC_JOB *async_get_pool_job(void) {
137 STACK_OF(ASYNC_JOB) *pool;
139 pool = async_get_pool();
142 * Pool has not been initialised, so init with the defaults, i.e.
143 * no max size and no pre-created jobs
145 if (ASYNC_init_pool(0, 0) == 0)
147 pool = async_get_pool();
150 job = sk_ASYNC_JOB_pop(pool);
153 if (!async_pool_can_grow())
156 job = async_job_new();
158 async_fibre_makecontext(&job->fibrectx);
159 async_increment_pool_size();
165 static void async_release_job(ASYNC_JOB *job) {
167 OPENSSL_free(job->funcargs);
168 job->funcargs = NULL;
169 /* Ignore error return */
170 async_release_job_to_pool(job);
173 void async_start_func(void)
179 job = async_get_ctx()->currjob;
180 job->ret = job->func(job->funcargs);
183 job->status = ASYNC_JOB_STOPPING;
184 if(!async_fibre_swapcontext(&job->fibrectx,
185 &async_get_ctx()->dispatcher, 1)) {
187 * Should not happen. Getting here will close the thread...can't do
190 ASYNCerr(ASYNC_F_ASYNC_START_FUNC, ASYNC_R_FAILED_TO_SWAP_CONTEXT);
195 int ASYNC_start_job(ASYNC_JOB **job, int *ret, int (*func)(void *),
196 void *args, size_t size)
198 if(!async_get_ctx() && !async_ctx_new()) {
203 async_get_ctx()->currjob = *job;
207 if(async_get_ctx()->currjob) {
208 if(async_get_ctx()->currjob->status == ASYNC_JOB_STOPPING) {
209 *ret = async_get_ctx()->currjob->ret;
210 async_release_job(async_get_ctx()->currjob);
211 async_get_ctx()->currjob = NULL;
216 if(async_get_ctx()->currjob->status == ASYNC_JOB_PAUSING) {
217 *job = async_get_ctx()->currjob;
218 async_get_ctx()->currjob->status = ASYNC_JOB_PAUSED;
219 async_get_ctx()->currjob = NULL;
223 if(async_get_ctx()->currjob->status == ASYNC_JOB_PAUSED) {
224 async_get_ctx()->currjob = *job;
225 /* Resume previous job */
226 if(!async_fibre_swapcontext(&async_get_ctx()->dispatcher,
227 &async_get_ctx()->currjob->fibrectx, 1)) {
228 ASYNCerr(ASYNC_F_ASYNC_START_JOB,
229 ASYNC_R_FAILED_TO_SWAP_CONTEXT);
235 /* Should not happen */
236 ASYNCerr(ASYNC_F_ASYNC_START_JOB, ERR_R_INTERNAL_ERROR);
237 async_release_job(async_get_ctx()->currjob);
238 async_get_ctx()->currjob = NULL;
243 /* Start a new job */
244 if(!(async_get_ctx()->currjob = async_get_pool_job())) {
245 return ASYNC_NO_JOBS;
249 async_get_ctx()->currjob->funcargs = OPENSSL_malloc(size);
250 if(!async_get_ctx()->currjob->funcargs) {
251 ASYNCerr(ASYNC_F_ASYNC_START_JOB, ERR_R_MALLOC_FAILURE);
252 async_release_job(async_get_ctx()->currjob);
253 async_get_ctx()->currjob = NULL;
256 memcpy(async_get_ctx()->currjob->funcargs, args, size);
258 async_get_ctx()->currjob->funcargs = NULL;
261 async_get_ctx()->currjob->func = func;
262 if(!async_fibre_swapcontext(&async_get_ctx()->dispatcher,
263 &async_get_ctx()->currjob->fibrectx, 1)) {
264 ASYNCerr(ASYNC_F_ASYNC_START_JOB, ASYNC_R_FAILED_TO_SWAP_CONTEXT);
270 async_release_job(async_get_ctx()->currjob);
271 async_get_ctx()->currjob = NULL;
277 int ASYNC_pause_job(void)
281 if(!async_get_ctx() || !async_get_ctx()->currjob) {
283 * Could be we've deliberately not been started within a job so this is
284 * counted as success.
289 job = async_get_ctx()->currjob;
290 job->status = ASYNC_JOB_PAUSING;
292 if(!async_fibre_swapcontext(&job->fibrectx,
293 &async_get_ctx()->dispatcher, 1)) {
294 ASYNCerr(ASYNC_F_ASYNC_PAUSE_JOB, ASYNC_R_FAILED_TO_SWAP_CONTEXT);
301 static void async_empty_pool(STACK_OF(ASYNC_JOB) *pool)
306 job = sk_ASYNC_JOB_pop(pool);
311 int ASYNC_init_pool(size_t max_size, size_t init_size)
313 STACK_OF(ASYNC_JOB) *pool;
314 size_t curr_size = 0;
316 if (init_size > max_size) {
317 ASYNCerr(ASYNC_F_ASYNC_INIT_POOL, ASYNC_R_INVALID_POOL_SIZE);
321 pool = sk_ASYNC_JOB_new_null();
323 ASYNCerr(ASYNC_F_ASYNC_INIT_POOL, ERR_R_MALLOC_FAILURE);
326 /* Pre-create jobs as required */
329 job = async_job_new();
331 async_fibre_makecontext(&job->fibrectx);
332 job->funcargs = NULL;
333 sk_ASYNC_JOB_push(pool, job);
338 * Not actually fatal because we already created the pool, just skip
339 * creation of any more jobs
345 if (!async_set_pool(pool, curr_size, max_size)) {
346 ASYNCerr(ASYNC_F_ASYNC_INIT_POOL, ASYNC_R_FAILED_TO_SET_POOL);
347 async_empty_pool(pool);
348 sk_ASYNC_JOB_free(pool);
355 void ASYNC_free_pool(void)
357 STACK_OF(ASYNC_JOB) *pool;
359 pool = async_get_pool();
363 async_empty_pool(pool);
364 async_release_pool();
368 ASYNC_JOB *ASYNC_get_current_job(void)
371 if((ctx = async_get_ctx()) == NULL)
377 int ASYNC_get_wait_fd(ASYNC_JOB *job)
382 void ASYNC_wake(ASYNC_JOB *job)
388 async_write1(job->wake_fd, &dummy);
392 void ASYNC_clear_wake(ASYNC_JOB *job)
397 async_read1(job->wait_fd, &dummy);