-/* crypto/async/async.c */
/*
- * Written by Matt Caswell (matt@openssl.org) for the OpenSSL project.
- */
-/* ====================================================================
- * Copyright (c) 2015 The OpenSSL Project. All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- *
- * 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- *
- * 2. Redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in
- * the documentation and/or other materials provided with the
- * distribution.
- *
- * 3. All advertising materials mentioning features or use of this
- * software must display the following acknowledgment:
- * "This product includes software developed by the OpenSSL Project
- * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
- *
- * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
- * endorse or promote products derived from this software without
- * prior written permission. For written permission, please contact
- * licensing@OpenSSL.org.
+ * Copyright 2015-2018 The OpenSSL Project Authors. All Rights Reserved.
*
- * 5. Products derived from this software may not be called "OpenSSL"
- * nor may "OpenSSL" appear in their names without prior written
- * permission of the OpenSSL Project.
- *
- * 6. Redistributions of any form whatsoever must retain the following
- * acknowledgment:
- * "This product includes software developed by the OpenSSL Project
- * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
- *
- * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
- * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
- * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
- * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
- * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
- * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
- * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
- * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
- * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
- * OF THE POSSIBILITY OF SUCH DAMAGE.
- * ====================================================================
+ * Licensed under the Apache License 2.0 (the "License"). You may not use
+ * this file except in compliance with the License. You can obtain a copy
+ * in the file LICENSE in the source distribution or at
+ * https://www.openssl.org/source/license.html
*/
/*
*/
#undef _FORTIFY_SOURCE
+/* This must be the first #include file */
+#include "async_local.h"
+
#include <openssl/err.h>
-#include <openssl/async.h>
+#include "crypto/cryptlib.h"
#include <string.h>
-#include "async_locl.h"
#define ASYNC_JOB_RUNNING 0
#define ASYNC_JOB_PAUSING 1
#define ASYNC_JOB_PAUSED 2
#define ASYNC_JOB_STOPPING 3
+static CRYPTO_THREAD_LOCAL ctxkey;
+static CRYPTO_THREAD_LOCAL poolkey;
+
+static void async_delete_thread_state(void *arg);
+
static async_ctx *async_ctx_new(void)
{
- async_ctx *nctx = NULL;
+ async_ctx *nctx;
- nctx = OPENSSL_malloc(sizeof (async_ctx));
+ if (!ossl_init_thread_start(NULL, NULL, async_delete_thread_state))
+ return NULL;
+
+ nctx = OPENSSL_malloc(sizeof(*nctx));
if (nctx == NULL) {
ASYNCerr(ASYNC_F_ASYNC_CTX_NEW, ERR_R_MALLOC_FAILURE);
goto err;
async_fibre_init_dispatcher(&nctx->dispatcher);
nctx->currjob = NULL;
nctx->blocked = 0;
- if (!async_set_ctx(nctx))
+ if (!CRYPTO_THREAD_set_local(&ctxkey, nctx))
goto err;
return nctx;
return NULL;
}
+async_ctx *async_get_ctx(void)
+{
+ return (async_ctx *)CRYPTO_THREAD_get_local(&ctxkey);
+}
+
static int async_ctx_free(void)
{
async_ctx *ctx;
ctx = async_get_ctx();
- if (!async_set_ctx(NULL))
+ if (!CRYPTO_THREAD_set_local(&ctxkey, NULL))
return 0;
OPENSSL_free(ctx);
static ASYNC_JOB *async_job_new(void)
{
ASYNC_JOB *job = NULL;
- OSSL_ASYNC_FD pipefds[2];
- job = OPENSSL_malloc(sizeof (ASYNC_JOB));
+ job = OPENSSL_zalloc(sizeof(*job));
if (job == NULL) {
ASYNCerr(ASYNC_F_ASYNC_JOB_NEW, ERR_R_MALLOC_FAILURE);
return NULL;
}
- if (!async_pipe(pipefds)) {
- OPENSSL_free(job);
- ASYNCerr(ASYNC_F_ASYNC_JOB_NEW, ASYNC_R_CANNOT_CREATE_WAIT_PIPE);
- return NULL;
- }
-
- job->wake_set = 0;
- job->wait_fd = pipefds[0];
- job->wake_fd = pipefds[1];
-
job->status = ASYNC_JOB_RUNNING;
- job->funcargs = NULL;
return job;
}
static ASYNC_JOB *async_get_pool_job(void) {
ASYNC_JOB *job;
- STACK_OF(ASYNC_JOB) *pool;
+ async_pool *pool;
- pool = async_get_pool();
+ pool = (async_pool *)CRYPTO_THREAD_get_local(&poolkey);
if (pool == NULL) {
/*
* Pool has not been initialised, so init with the defaults, i.e.
* no max size and no pre-created jobs
*/
- if (ASYNC_init_pool(0, 0) == 0)
+ if (ASYNC_init_thread(0, 0) == 0)
return NULL;
- pool = async_get_pool();
+ pool = (async_pool *)CRYPTO_THREAD_get_local(&poolkey);
}
- job = sk_ASYNC_JOB_pop(pool);
+ job = sk_ASYNC_JOB_pop(pool->jobs);
if (job == NULL) {
/* Pool is empty */
- if (!async_pool_can_grow())
+ if ((pool->max_size != 0) && (pool->curr_size >= pool->max_size))
return NULL;
job = async_job_new();
- if (job) {
- async_fibre_makecontext(&job->fibrectx);
- async_increment_pool_size();
+ if (job != NULL) {
+ if (! async_fibre_makecontext(&job->fibrectx)) {
+ async_job_free(job);
+ return NULL;
+ }
+ pool->curr_size++;
}
}
return job;
}
static void async_release_job(ASYNC_JOB *job) {
+ async_pool *pool;
+
+ pool = (async_pool *)CRYPTO_THREAD_get_local(&poolkey);
OPENSSL_free(job->funcargs);
job->funcargs = NULL;
- /* Ignore error return */
- async_release_job_to_pool(job);
+ sk_ASYNC_JOB_push(pool->jobs, job);
}
void async_start_func(void)
{
ASYNC_JOB *job;
+ async_ctx *ctx = async_get_ctx();
while (1) {
/* Run the job */
- job = async_get_ctx()->currjob;
+ job = ctx->currjob;
job->ret = job->func(job->funcargs);
/* Stop the job */
job->status = ASYNC_JOB_STOPPING;
if (!async_fibre_swapcontext(&job->fibrectx,
- &async_get_ctx()->dispatcher, 1)) {
+ &ctx->dispatcher, 1)) {
/*
* Should not happen. Getting here will close the thread...can't do
* much about it
}
}
-int ASYNC_start_job(ASYNC_JOB **job, int *ret, int (*func)(void *),
- void *args, size_t size)
+int ASYNC_start_job(ASYNC_JOB **job, ASYNC_WAIT_CTX *wctx, int *ret,
+ int (*func)(void *), void *args, size_t size)
{
- if (async_get_ctx() == NULL && async_ctx_new() == NULL) {
+ async_ctx *ctx;
+ OPENSSL_CTX *libctx;
+
+ if (!OPENSSL_init_crypto(OPENSSL_INIT_ASYNC, NULL))
return ASYNC_ERR;
- }
- if (*job) {
- async_get_ctx()->currjob = *job;
- }
+ ctx = async_get_ctx();
+ if (ctx == NULL)
+ ctx = async_ctx_new();
+ if (ctx == NULL)
+ return ASYNC_ERR;
+
+ if (*job)
+ ctx->currjob = *job;
for (;;) {
- if (async_get_ctx()->currjob != NULL) {
- if (async_get_ctx()->currjob->status == ASYNC_JOB_STOPPING) {
- *ret = async_get_ctx()->currjob->ret;
- async_release_job(async_get_ctx()->currjob);
- async_get_ctx()->currjob = NULL;
+ if (ctx->currjob != NULL) {
+ if (ctx->currjob->status == ASYNC_JOB_STOPPING) {
+ *ret = ctx->currjob->ret;
+ ctx->currjob->waitctx = NULL;
+ async_release_job(ctx->currjob);
+ ctx->currjob = NULL;
*job = NULL;
return ASYNC_FINISH;
}
- if (async_get_ctx()->currjob->status == ASYNC_JOB_PAUSING) {
- *job = async_get_ctx()->currjob;
- async_get_ctx()->currjob->status = ASYNC_JOB_PAUSED;
- async_get_ctx()->currjob = NULL;
+ if (ctx->currjob->status == ASYNC_JOB_PAUSING) {
+ *job = ctx->currjob;
+ ctx->currjob->status = ASYNC_JOB_PAUSED;
+ ctx->currjob = NULL;
return ASYNC_PAUSE;
}
- if (async_get_ctx()->currjob->status == ASYNC_JOB_PAUSED) {
- async_get_ctx()->currjob = *job;
+ if (ctx->currjob->status == ASYNC_JOB_PAUSED) {
+ ctx->currjob = *job;
+ /*
+ * Restore the default libctx to what it was the last time the
+ * fibre ran
+ */
+ libctx = OPENSSL_CTX_set0_default(ctx->currjob->libctx);
/* Resume previous job */
- if (!async_fibre_swapcontext(&async_get_ctx()->dispatcher,
- &async_get_ctx()->currjob->fibrectx, 1)) {
+ if (!async_fibre_swapcontext(&ctx->dispatcher,
+ &ctx->currjob->fibrectx, 1)) {
ASYNCerr(ASYNC_F_ASYNC_START_JOB,
ASYNC_R_FAILED_TO_SWAP_CONTEXT);
goto err;
}
+ /*
+ * In case the fibre changed the default libctx we set it back
+ * again to what it was originally, and remember what it had
+ * been changed to.
+ */
+ ctx->currjob->libctx = OPENSSL_CTX_set0_default(libctx);
continue;
}
/* Should not happen */
ASYNCerr(ASYNC_F_ASYNC_START_JOB, ERR_R_INTERNAL_ERROR);
- async_release_job(async_get_ctx()->currjob);
- async_get_ctx()->currjob = NULL;
+ async_release_job(ctx->currjob);
+ ctx->currjob = NULL;
*job = NULL;
return ASYNC_ERR;
}
/* Start a new job */
- if ((async_get_ctx()->currjob = async_get_pool_job()) == NULL) {
+ if ((ctx->currjob = async_get_pool_job()) == NULL)
return ASYNC_NO_JOBS;
- }
if (args != NULL) {
- async_get_ctx()->currjob->funcargs = OPENSSL_malloc(size);
- if (async_get_ctx()->currjob->funcargs == NULL) {
+ ctx->currjob->funcargs = OPENSSL_malloc(size);
+ if (ctx->currjob->funcargs == NULL) {
ASYNCerr(ASYNC_F_ASYNC_START_JOB, ERR_R_MALLOC_FAILURE);
- async_release_job(async_get_ctx()->currjob);
- async_get_ctx()->currjob = NULL;
+ async_release_job(ctx->currjob);
+ ctx->currjob = NULL;
return ASYNC_ERR;
}
- memcpy(async_get_ctx()->currjob->funcargs, args, size);
+ memcpy(ctx->currjob->funcargs, args, size);
} else {
- async_get_ctx()->currjob->funcargs = NULL;
+ ctx->currjob->funcargs = NULL;
}
- async_get_ctx()->currjob->func = func;
- if (!async_fibre_swapcontext(&async_get_ctx()->dispatcher,
- &async_get_ctx()->currjob->fibrectx, 1)) {
+ ctx->currjob->func = func;
+ ctx->currjob->waitctx = wctx;
+ libctx = openssl_ctx_get_concrete(NULL);
+ if (!async_fibre_swapcontext(&ctx->dispatcher,
+ &ctx->currjob->fibrectx, 1)) {
ASYNCerr(ASYNC_F_ASYNC_START_JOB, ASYNC_R_FAILED_TO_SWAP_CONTEXT);
goto err;
}
+ /*
+ * In case the fibre changed the default libctx we set it back again
+ * to what it was, and remember what it had been changed to.
+ */
+ ctx->currjob->libctx = OPENSSL_CTX_set0_default(libctx);
}
err:
- async_release_job(async_get_ctx()->currjob);
- async_get_ctx()->currjob = NULL;
+ async_release_job(ctx->currjob);
+ ctx->currjob = NULL;
*job = NULL;
return ASYNC_ERR;
}
-
int ASYNC_pause_job(void)
{
ASYNC_JOB *job;
+ async_ctx *ctx = async_get_ctx();
- if (async_get_ctx() == NULL
- || async_get_ctx()->currjob == NULL
- || async_get_ctx()->blocked) {
+ if (ctx == NULL
+ || ctx->currjob == NULL
+ || ctx->blocked) {
/*
* Could be we've deliberately not been started within a job so this is
* counted as success.
return 1;
}
- job = async_get_ctx()->currjob;
+ job = ctx->currjob;
job->status = ASYNC_JOB_PAUSING;
if (!async_fibre_swapcontext(&job->fibrectx,
- &async_get_ctx()->dispatcher, 1)) {
+ &ctx->dispatcher, 1)) {
ASYNCerr(ASYNC_F_ASYNC_PAUSE_JOB, ASYNC_R_FAILED_TO_SWAP_CONTEXT);
return 0;
}
+ /* Reset counts of added and deleted fds */
+ async_wait_ctx_reset_counts(job->waitctx);
return 1;
}
-static void async_empty_pool(STACK_OF(ASYNC_JOB) *pool)
+static void async_empty_pool(async_pool *pool)
{
ASYNC_JOB *job;
+ if (pool == NULL || pool->jobs == NULL)
+ return;
+
do {
- job = sk_ASYNC_JOB_pop(pool);
+ job = sk_ASYNC_JOB_pop(pool->jobs);
async_job_free(job);
} while (job);
}
-int ASYNC_init_pool(size_t max_size, size_t init_size)
+int async_init(void)
+{
+ if (!CRYPTO_THREAD_init_local(&ctxkey, NULL))
+ return 0;
+
+ if (!CRYPTO_THREAD_init_local(&poolkey, NULL)) {
+ CRYPTO_THREAD_cleanup_local(&ctxkey);
+ return 0;
+ }
+
+ return 1;
+}
+
+void async_deinit(void)
+{
+ CRYPTO_THREAD_cleanup_local(&ctxkey);
+ CRYPTO_THREAD_cleanup_local(&poolkey);
+}
+
+int ASYNC_init_thread(size_t max_size, size_t init_size)
{
- STACK_OF(ASYNC_JOB) *pool;
+ async_pool *pool;
size_t curr_size = 0;
if (init_size > max_size) {
- ASYNCerr(ASYNC_F_ASYNC_INIT_POOL, ASYNC_R_INVALID_POOL_SIZE);
+ ASYNCerr(ASYNC_F_ASYNC_INIT_THREAD, ASYNC_R_INVALID_POOL_SIZE);
return 0;
}
- pool = sk_ASYNC_JOB_new_null();
+ if (!OPENSSL_init_crypto(OPENSSL_INIT_ASYNC, NULL))
+ return 0;
+
+ if (!ossl_init_thread_start(NULL, NULL, async_delete_thread_state))
+ return 0;
+
+ pool = OPENSSL_zalloc(sizeof(*pool));
if (pool == NULL) {
- ASYNCerr(ASYNC_F_ASYNC_INIT_POOL, ERR_R_MALLOC_FAILURE);
+ ASYNCerr(ASYNC_F_ASYNC_INIT_THREAD, ERR_R_MALLOC_FAILURE);
+ return 0;
+ }
+
+ pool->jobs = sk_ASYNC_JOB_new_reserve(NULL, init_size);
+ if (pool->jobs == NULL) {
+ ASYNCerr(ASYNC_F_ASYNC_INIT_THREAD, ERR_R_MALLOC_FAILURE);
+ OPENSSL_free(pool);
return 0;
}
+
+ pool->max_size = max_size;
+
/* Pre-create jobs as required */
- while (init_size) {
+ while (init_size--) {
ASYNC_JOB *job;
job = async_job_new();
- if (job) {
- async_fibre_makecontext(&job->fibrectx);
- job->funcargs = NULL;
- sk_ASYNC_JOB_push(pool, job);
- curr_size++;
- init_size--;
- } else {
+ if (job == NULL || !async_fibre_makecontext(&job->fibrectx)) {
/*
- * Not actually fatal because we already created the pool, just skip
- * creation of any more jobs
+ * Not actually fatal because we already created the pool, just
+ * skip creation of any more jobs
*/
- init_size = 0;
+ async_job_free(job);
+ break;
}
+ job->funcargs = NULL;
+ sk_ASYNC_JOB_push(pool->jobs, job); /* Cannot fail due to reserve */
+ curr_size++;
}
-
- if (!async_set_pool(pool, curr_size, max_size)) {
- ASYNCerr(ASYNC_F_ASYNC_INIT_POOL, ASYNC_R_FAILED_TO_SET_POOL);
- async_empty_pool(pool);
- sk_ASYNC_JOB_free(pool);
- return 0;
+ pool->curr_size = curr_size;
+ if (!CRYPTO_THREAD_set_local(&poolkey, pool)) {
+ ASYNCerr(ASYNC_F_ASYNC_INIT_THREAD, ASYNC_R_FAILED_TO_SET_POOL);
+ goto err;
}
return 1;
+err:
+ async_empty_pool(pool);
+ sk_ASYNC_JOB_free(pool->jobs);
+ OPENSSL_free(pool);
+ return 0;
}
-void ASYNC_free_pool(void)
+/* TODO(3.0): arg ignored for now */
+static void async_delete_thread_state(void *arg)
{
- STACK_OF(ASYNC_JOB) *pool;
+ async_pool *pool = (async_pool *)CRYPTO_THREAD_get_local(&poolkey);
- pool = async_get_pool();
- if (pool == NULL)
+ if (pool != NULL) {
+ async_empty_pool(pool);
+ sk_ASYNC_JOB_free(pool->jobs);
+ OPENSSL_free(pool);
+ CRYPTO_THREAD_set_local(&poolkey, NULL);
+ }
+ async_local_cleanup();
+ async_ctx_free();
+}
+
+void ASYNC_cleanup_thread(void)
+{
+ if (!OPENSSL_init_crypto(OPENSSL_INIT_ASYNC, NULL))
return;
- async_empty_pool(pool);
- async_release_pool();
- async_ctx_free();
+ async_delete_thread_state(NULL);
}
ASYNC_JOB *ASYNC_get_current_job(void)
{
async_ctx *ctx;
+ if (!OPENSSL_init_crypto(OPENSSL_INIT_ASYNC, NULL))
+ return NULL;
+
ctx = async_get_ctx();
- if(ctx == NULL)
+ if (ctx == NULL)
return NULL;
return ctx->currjob;
}
-OSSL_ASYNC_FD ASYNC_get_wait_fd(ASYNC_JOB *job)
+ASYNC_WAIT_CTX *ASYNC_get_wait_ctx(ASYNC_JOB *job)
{
- return job->wait_fd;
+ return job->waitctx;
}
-void ASYNC_wake(ASYNC_JOB *job)
+void ASYNC_block_pause(void)
{
- char dummy = 0;
-
- if (job->wake_set)
- return;
- async_write1(job->wake_fd, &dummy);
- job->wake_set = 1;
-}
+ async_ctx *ctx;
-void ASYNC_clear_wake(ASYNC_JOB *job)
-{
- char dummy = 0;
- if (!job->wake_set)
+ if (!OPENSSL_init_crypto(OPENSSL_INIT_ASYNC, NULL))
return;
- async_read1(job->wait_fd, &dummy);
- job->wake_set = 0;
-}
-void ASYNC_block_pause(void)
-{
- if (async_get_ctx() == NULL
- || async_get_ctx()->currjob == NULL) {
+ ctx = async_get_ctx();
+ if (ctx == NULL || ctx->currjob == NULL) {
/*
* We're not in a job anyway so ignore this
*/
return;
}
- async_get_ctx()->blocked++;
+ ctx->blocked++;
}
void ASYNC_unblock_pause(void)
{
- if (async_get_ctx() == NULL
- || async_get_ctx()->currjob == NULL) {
+ async_ctx *ctx;
+
+ if (!OPENSSL_init_crypto(OPENSSL_INIT_ASYNC, NULL))
+ return;
+
+ ctx = async_get_ctx();
+ if (ctx == NULL || ctx->currjob == NULL) {
/*
* We're not in a job anyway so ignore this
*/
return;
}
- if(async_get_ctx()->blocked > 0)
- async_get_ctx()->blocked--;
+ if (ctx->blocked > 0)
+ ctx->blocked--;
}
projects / openssl.git / blobdiff