openssl/crypto/async/async.c
Matt Caswell 9f078e1961 Optimise ASYNC_CTX handling
Don't recreate a new ASYNC_CTX every time we call ASYNC_start_job() - the
same one can be used for the life of the thread. Instead we only free it
up when we call ASYNC_free_pool().

Reviewed-by: Rich Salz <rsalz@openssl.org>
2015-11-20 23:34:35 +00:00

379 lines
9.8 KiB
C

/* 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.
*
* 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.
* ====================================================================
*/
#include <openssl/async.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 ASYNC_CTX *ASYNC_CTX_new(void)
{
ASYNC_CTX *nctx = NULL;
if(!(nctx = OPENSSL_malloc(sizeof (ASYNC_CTX)))) {
/* Error here */
goto err;
}
ASYNC_FIBRE_init_dispatcher(&nctx->dispatcher);
nctx->currjob = NULL;
if(!ASYNC_set_ctx(nctx))
goto err;
return nctx;
err:
if(nctx) {
OPENSSL_free(nctx);
}
return NULL;
}
static int ASYNC_CTX_free(void)
{
if(ASYNC_get_ctx()) {
OPENSSL_free(ASYNC_get_ctx());
}
if(!ASYNC_set_ctx(NULL))
return 0;
return 1;
}
static ASYNC_JOB *ASYNC_JOB_new(void)
{
ASYNC_JOB *job = NULL;
int pipefds[2];
if(!(job = OPENSSL_malloc(sizeof (ASYNC_JOB)))) {
return NULL;
}
if(!async_pipe(pipefds)) {
OPENSSL_free(job);
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 void ASYNC_JOB_free(ASYNC_JOB *job)
{
if(job) {
if(job->funcargs)
OPENSSL_free(job->funcargs);
ASYNC_FIBRE_free(&job->fibrectx);
OPENSSL_free(job);
}
}
static ASYNC_JOB *async_get_pool_job(void) {
ASYNC_JOB *job;
STACK_OF(ASYNC_JOB) *pool;
pool = async_get_pool();
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)
return NULL;
pool = async_get_pool();
}
job = sk_ASYNC_JOB_pop(pool);
if (job == NULL) {
/* Pool is empty */
if (!async_pool_can_grow())
return NULL;
job = ASYNC_JOB_new();
if (job) {
ASYNC_FIBRE_makecontext(&job->fibrectx);
async_increment_pool_size();
}
}
return job;
}
static void async_release_job(ASYNC_JOB *job) {
if(job->funcargs)
OPENSSL_free(job->funcargs);
job->funcargs = NULL;
/* Ignore error return */
async_release_job_to_pool(job);
}
void ASYNC_start_func(void)
{
ASYNC_JOB *job;
while (1) {
/* Run the job */
job = ASYNC_get_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)) {
/*
* 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)
{
if(!ASYNC_get_ctx() && !ASYNC_CTX_new()) {
return ASYNC_ERR;
}
if(*job) {
ASYNC_get_ctx()->currjob = *job;
}
for (;;) {
if(ASYNC_get_ctx()->currjob) {
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;
*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;
return ASYNC_PAUSE;
}
if(ASYNC_get_ctx()->currjob->status == ASYNC_JOB_PAUSED) {
ASYNC_get_ctx()->currjob = *job;
/* Resume previous job */
if(!ASYNC_FIBRE_swapcontext(&ASYNC_get_ctx()->dispatcher,
&ASYNC_get_ctx()->currjob->fibrectx, 1))
goto err;
continue;
}
/* Should not happen */
async_release_job(ASYNC_get_ctx()->currjob);
ASYNC_get_ctx()->currjob = NULL;
*job = NULL;
return ASYNC_ERR;
}
/* Start a new job */
if(!(ASYNC_get_ctx()->currjob = async_get_pool_job())) {
return ASYNC_NO_JOBS;
}
if(args != NULL) {
ASYNC_get_ctx()->currjob->funcargs = OPENSSL_malloc(size);
if(!ASYNC_get_ctx()->currjob->funcargs) {
async_release_job(ASYNC_get_ctx()->currjob);
ASYNC_get_ctx()->currjob = NULL;
return ASYNC_ERR;
}
memcpy(ASYNC_get_ctx()->currjob->funcargs, args, size);
} else {
ASYNC_get_ctx()->currjob->funcargs = NULL;
}
ASYNC_get_ctx()->currjob->func = func;
if(!ASYNC_FIBRE_swapcontext(&ASYNC_get_ctx()->dispatcher,
&ASYNC_get_ctx()->currjob->fibrectx, 1))
goto err;
}
err:
async_release_job(ASYNC_get_ctx()->currjob);
ASYNC_get_ctx()->currjob = NULL;
*job = NULL;
return ASYNC_ERR;
}
int ASYNC_pause_job(void)
{
ASYNC_JOB *job;
if(!ASYNC_get_ctx() || !ASYNC_get_ctx()->currjob)
return 0;
job = ASYNC_get_ctx()->currjob;
job->status = ASYNC_JOB_PAUSING;
if(!ASYNC_FIBRE_swapcontext(&job->fibrectx,
&ASYNC_get_ctx()->dispatcher, 1)) {
/* Error */
return 0;
}
return 1;
}
static void async_empty_pool(STACK_OF(ASYNC_JOB) *pool)
{
ASYNC_JOB *job;
do {
job = sk_ASYNC_JOB_pop(pool);
ASYNC_JOB_free(job);
} while (job);
}
int ASYNC_init_pool(size_t max_size, size_t init_size)
{
STACK_OF(ASYNC_JOB) *pool;
size_t curr_size = 0;
if (init_size > max_size)
return 0;
pool = sk_ASYNC_JOB_new_null();
if (pool == NULL) {
return 0;
}
/* Pre-create jobs as required */
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 {
/*
* Not actually fatal because we already created the pool, just skip
* creation of any more jobs
*/
init_size = 0;
}
}
if (!async_set_pool(pool, curr_size, max_size)) {
async_empty_pool(pool);
sk_ASYNC_JOB_free(pool);
return 0;
}
return 1;
}
void ASYNC_free_pool(void)
{
STACK_OF(ASYNC_JOB) *pool;
pool = async_get_pool();
if (pool == NULL)
return;
async_empty_pool(pool);
async_release_pool();
ASYNC_CTX_free();
}
ASYNC_JOB *ASYNC_get_current_job(void)
{
ASYNC_CTX *ctx;
if((ctx = ASYNC_get_ctx()) == NULL)
return NULL;
return ctx->currjob;
}
int ASYNC_get_wait_fd(ASYNC_JOB *job)
{
return job->wait_fd;
}
void ASYNC_wake(ASYNC_JOB *job)
{
char dummy = 0;
if (job->wake_set)
return;
async_write1(job->wake_fd, &dummy);
job->wake_set = 1;
}
void ASYNC_clear_wake(ASYNC_JOB *job)
{
char dummy = 0;
if (!job->wake_set)
return;
async_read1(job->wait_fd, &dummy);
job->wake_set = 0;
}