Blame crypto/async/async.c

Packit c4476c
/*
Packit c4476c
 * Copyright 2015-2018 The OpenSSL Project Authors. All Rights Reserved.
Packit c4476c
 *
Packit c4476c
 * Licensed under the OpenSSL license (the "License").  You may not use
Packit c4476c
 * this file except in compliance with the License.  You can obtain a copy
Packit c4476c
 * in the file LICENSE in the source distribution or at
Packit c4476c
 * https://www.openssl.org/source/license.html
Packit c4476c
 */
Packit c4476c
Packit c4476c
/*
Packit c4476c
 * Without this we start getting longjmp crashes because it thinks we're jumping
Packit c4476c
 * up the stack when in fact we are jumping to an entirely different stack. The
Packit c4476c
 * cost of this is not having certain buffer overrun/underrun checks etc for
Packit c4476c
 * this source file :-(
Packit c4476c
 */
Packit c4476c
#undef _FORTIFY_SOURCE
Packit c4476c
Packit c4476c
/* This must be the first #include file */
Packit c4476c
#include "async_local.h"
Packit c4476c
Packit c4476c
#include <openssl/err.h>
Packit c4476c
#include "crypto/cryptlib.h"
Packit c4476c
#include <string.h>
Packit c4476c
Packit c4476c
#define ASYNC_JOB_RUNNING   0
Packit c4476c
#define ASYNC_JOB_PAUSING   1
Packit c4476c
#define ASYNC_JOB_PAUSED    2
Packit c4476c
#define ASYNC_JOB_STOPPING  3
Packit c4476c
Packit c4476c
static CRYPTO_THREAD_LOCAL ctxkey;
Packit c4476c
static CRYPTO_THREAD_LOCAL poolkey;
Packit c4476c
Packit c4476c
static async_ctx *async_ctx_new(void)
Packit c4476c
{
Packit c4476c
    async_ctx *nctx;
Packit c4476c
Packit c4476c
    if (!ossl_init_thread_start(OPENSSL_INIT_THREAD_ASYNC))
Packit c4476c
        return NULL;
Packit c4476c
Packit c4476c
    nctx = OPENSSL_malloc(sizeof(*nctx));
Packit c4476c
    if (nctx == NULL) {
Packit c4476c
        ASYNCerr(ASYNC_F_ASYNC_CTX_NEW, ERR_R_MALLOC_FAILURE);
Packit c4476c
        goto err;
Packit c4476c
    }
Packit c4476c
Packit c4476c
    async_fibre_init_dispatcher(&nctx->dispatcher);
Packit c4476c
    nctx->currjob = NULL;
Packit c4476c
    nctx->blocked = 0;
Packit c4476c
    if (!CRYPTO_THREAD_set_local(&ctxkey, nctx))
Packit c4476c
        goto err;
Packit c4476c
Packit c4476c
    return nctx;
Packit c4476c
err:
Packit c4476c
    OPENSSL_free(nctx);
Packit c4476c
Packit c4476c
    return NULL;
Packit c4476c
}
Packit c4476c
Packit c4476c
async_ctx *async_get_ctx(void)
Packit c4476c
{
Packit c4476c
    return (async_ctx *)CRYPTO_THREAD_get_local(&ctxkey);
Packit c4476c
}
Packit c4476c
Packit c4476c
static int async_ctx_free(void)
Packit c4476c
{
Packit c4476c
    async_ctx *ctx;
Packit c4476c
Packit c4476c
    ctx = async_get_ctx();
Packit c4476c
Packit c4476c
    if (!CRYPTO_THREAD_set_local(&ctxkey, NULL))
Packit c4476c
        return 0;
Packit c4476c
Packit c4476c
    OPENSSL_free(ctx);
Packit c4476c
Packit c4476c
    return 1;
Packit c4476c
}
Packit c4476c
Packit c4476c
static ASYNC_JOB *async_job_new(void)
Packit c4476c
{
Packit c4476c
    ASYNC_JOB *job = NULL;
Packit c4476c
Packit c4476c
    job = OPENSSL_zalloc(sizeof(*job));
Packit c4476c
    if (job == NULL) {
Packit c4476c
        ASYNCerr(ASYNC_F_ASYNC_JOB_NEW, ERR_R_MALLOC_FAILURE);
Packit c4476c
        return NULL;
Packit c4476c
    }
Packit c4476c
Packit c4476c
    job->status = ASYNC_JOB_RUNNING;
Packit c4476c
Packit c4476c
    return job;
Packit c4476c
}
Packit c4476c
Packit c4476c
static void async_job_free(ASYNC_JOB *job)
Packit c4476c
{
Packit c4476c
    if (job != NULL) {
Packit c4476c
        OPENSSL_free(job->funcargs);
Packit c4476c
        async_fibre_free(&job->fibrectx);
Packit c4476c
        OPENSSL_free(job);
Packit c4476c
    }
Packit c4476c
}
Packit c4476c
Packit c4476c
static ASYNC_JOB *async_get_pool_job(void) {
Packit c4476c
    ASYNC_JOB *job;
Packit c4476c
    async_pool *pool;
Packit c4476c
Packit c4476c
    pool = (async_pool *)CRYPTO_THREAD_get_local(&poolkey);
Packit c4476c
    if (pool == NULL) {
Packit c4476c
        /*
Packit c4476c
         * Pool has not been initialised, so init with the defaults, i.e.
Packit c4476c
         * no max size and no pre-created jobs
Packit c4476c
         */
Packit c4476c
        if (ASYNC_init_thread(0, 0) == 0)
Packit c4476c
            return NULL;
Packit c4476c
        pool = (async_pool *)CRYPTO_THREAD_get_local(&poolkey);
Packit c4476c
    }
Packit c4476c
Packit c4476c
    job = sk_ASYNC_JOB_pop(pool->jobs);
Packit c4476c
    if (job == NULL) {
Packit c4476c
        /* Pool is empty */
Packit c4476c
        if ((pool->max_size != 0) && (pool->curr_size >= pool->max_size))
Packit c4476c
            return NULL;
Packit c4476c
Packit c4476c
        job = async_job_new();
Packit c4476c
        if (job != NULL) {
Packit c4476c
            if (! async_fibre_makecontext(&job->fibrectx)) {
Packit c4476c
                async_job_free(job);
Packit c4476c
                return NULL;
Packit c4476c
            }
Packit c4476c
            pool->curr_size++;
Packit c4476c
        }
Packit c4476c
    }
Packit c4476c
    return job;
Packit c4476c
}
Packit c4476c
Packit c4476c
static void async_release_job(ASYNC_JOB *job) {
Packit c4476c
    async_pool *pool;
Packit c4476c
Packit c4476c
    pool = (async_pool *)CRYPTO_THREAD_get_local(&poolkey);
Packit c4476c
    OPENSSL_free(job->funcargs);
Packit c4476c
    job->funcargs = NULL;
Packit c4476c
    sk_ASYNC_JOB_push(pool->jobs, job);
Packit c4476c
}
Packit c4476c
Packit c4476c
void async_start_func(void)
Packit c4476c
{
Packit c4476c
    ASYNC_JOB *job;
Packit c4476c
    async_ctx *ctx = async_get_ctx();
Packit c4476c
Packit c4476c
    while (1) {
Packit c4476c
        /* Run the job */
Packit c4476c
        job = ctx->currjob;
Packit c4476c
        job->ret = job->func(job->funcargs);
Packit c4476c
Packit c4476c
        /* Stop the job */
Packit c4476c
        job->status = ASYNC_JOB_STOPPING;
Packit c4476c
        if (!async_fibre_swapcontext(&job->fibrectx,
Packit c4476c
                                     &ctx->dispatcher, 1)) {
Packit c4476c
            /*
Packit c4476c
             * Should not happen. Getting here will close the thread...can't do
Packit c4476c
             * much about it
Packit c4476c
             */
Packit c4476c
            ASYNCerr(ASYNC_F_ASYNC_START_FUNC, ASYNC_R_FAILED_TO_SWAP_CONTEXT);
Packit c4476c
        }
Packit c4476c
    }
Packit c4476c
}
Packit c4476c
Packit c4476c
int ASYNC_start_job(ASYNC_JOB **job, ASYNC_WAIT_CTX *wctx, int *ret,
Packit c4476c
                    int (*func)(void *), void *args, size_t size)
Packit c4476c
{
Packit c4476c
    async_ctx *ctx;
Packit c4476c
Packit c4476c
    if (!OPENSSL_init_crypto(OPENSSL_INIT_ASYNC, NULL))
Packit c4476c
        return ASYNC_ERR;
Packit c4476c
Packit c4476c
    ctx = async_get_ctx();
Packit c4476c
    if (ctx == NULL)
Packit c4476c
        ctx = async_ctx_new();
Packit c4476c
    if (ctx == NULL)
Packit c4476c
        return ASYNC_ERR;
Packit c4476c
Packit c4476c
    if (*job)
Packit c4476c
        ctx->currjob = *job;
Packit c4476c
Packit c4476c
    for (;;) {
Packit c4476c
        if (ctx->currjob != NULL) {
Packit c4476c
            if (ctx->currjob->status == ASYNC_JOB_STOPPING) {
Packit c4476c
                *ret = ctx->currjob->ret;
Packit c4476c
                ctx->currjob->waitctx = NULL;
Packit c4476c
                async_release_job(ctx->currjob);
Packit c4476c
                ctx->currjob = NULL;
Packit c4476c
                *job = NULL;
Packit c4476c
                return ASYNC_FINISH;
Packit c4476c
            }
Packit c4476c
Packit c4476c
            if (ctx->currjob->status == ASYNC_JOB_PAUSING) {
Packit c4476c
                *job = ctx->currjob;
Packit c4476c
                ctx->currjob->status = ASYNC_JOB_PAUSED;
Packit c4476c
                ctx->currjob = NULL;
Packit c4476c
                return ASYNC_PAUSE;
Packit c4476c
            }
Packit c4476c
Packit c4476c
            if (ctx->currjob->status == ASYNC_JOB_PAUSED) {
Packit c4476c
                ctx->currjob = *job;
Packit c4476c
                /* Resume previous job */
Packit c4476c
                if (!async_fibre_swapcontext(&ctx->dispatcher,
Packit c4476c
                        &ctx->currjob->fibrectx, 1)) {
Packit c4476c
                    ASYNCerr(ASYNC_F_ASYNC_START_JOB,
Packit c4476c
                             ASYNC_R_FAILED_TO_SWAP_CONTEXT);
Packit c4476c
                    goto err;
Packit c4476c
                }
Packit c4476c
                continue;
Packit c4476c
            }
Packit c4476c
Packit c4476c
            /* Should not happen */
Packit c4476c
            ASYNCerr(ASYNC_F_ASYNC_START_JOB, ERR_R_INTERNAL_ERROR);
Packit c4476c
            async_release_job(ctx->currjob);
Packit c4476c
            ctx->currjob = NULL;
Packit c4476c
            *job = NULL;
Packit c4476c
            return ASYNC_ERR;
Packit c4476c
        }
Packit c4476c
Packit c4476c
        /* Start a new job */
Packit c4476c
        if ((ctx->currjob = async_get_pool_job()) == NULL)
Packit c4476c
            return ASYNC_NO_JOBS;
Packit c4476c
Packit c4476c
        if (args != NULL) {
Packit c4476c
            ctx->currjob->funcargs = OPENSSL_malloc(size);
Packit c4476c
            if (ctx->currjob->funcargs == NULL) {
Packit c4476c
                ASYNCerr(ASYNC_F_ASYNC_START_JOB, ERR_R_MALLOC_FAILURE);
Packit c4476c
                async_release_job(ctx->currjob);
Packit c4476c
                ctx->currjob = NULL;
Packit c4476c
                return ASYNC_ERR;
Packit c4476c
            }
Packit c4476c
            memcpy(ctx->currjob->funcargs, args, size);
Packit c4476c
        } else {
Packit c4476c
            ctx->currjob->funcargs = NULL;
Packit c4476c
        }
Packit c4476c
Packit c4476c
        ctx->currjob->func = func;
Packit c4476c
        ctx->currjob->waitctx = wctx;
Packit c4476c
        if (!async_fibre_swapcontext(&ctx->dispatcher,
Packit c4476c
                &ctx->currjob->fibrectx, 1)) {
Packit c4476c
            ASYNCerr(ASYNC_F_ASYNC_START_JOB, ASYNC_R_FAILED_TO_SWAP_CONTEXT);
Packit c4476c
            goto err;
Packit c4476c
        }
Packit c4476c
    }
Packit c4476c
Packit c4476c
err:
Packit c4476c
    async_release_job(ctx->currjob);
Packit c4476c
    ctx->currjob = NULL;
Packit c4476c
    *job = NULL;
Packit c4476c
    return ASYNC_ERR;
Packit c4476c
}
Packit c4476c
Packit c4476c
int ASYNC_pause_job(void)
Packit c4476c
{
Packit c4476c
    ASYNC_JOB *job;
Packit c4476c
    async_ctx *ctx = async_get_ctx();
Packit c4476c
Packit c4476c
    if (ctx == NULL
Packit c4476c
            || ctx->currjob == NULL
Packit c4476c
            || ctx->blocked) {
Packit c4476c
        /*
Packit c4476c
         * Could be we've deliberately not been started within a job so this is
Packit c4476c
         * counted as success.
Packit c4476c
         */
Packit c4476c
        return 1;
Packit c4476c
    }
Packit c4476c
Packit c4476c
    job = ctx->currjob;
Packit c4476c
    job->status = ASYNC_JOB_PAUSING;
Packit c4476c
Packit c4476c
    if (!async_fibre_swapcontext(&job->fibrectx,
Packit c4476c
                                 &ctx->dispatcher, 1)) {
Packit c4476c
        ASYNCerr(ASYNC_F_ASYNC_PAUSE_JOB, ASYNC_R_FAILED_TO_SWAP_CONTEXT);
Packit c4476c
        return 0;
Packit c4476c
    }
Packit c4476c
    /* Reset counts of added and deleted fds */
Packit c4476c
    async_wait_ctx_reset_counts(job->waitctx);
Packit c4476c
Packit c4476c
    return 1;
Packit c4476c
}
Packit c4476c
Packit c4476c
static void async_empty_pool(async_pool *pool)
Packit c4476c
{
Packit c4476c
    ASYNC_JOB *job;
Packit c4476c
Packit c4476c
    if (!pool || !pool->jobs)
Packit c4476c
        return;
Packit c4476c
Packit c4476c
    do {
Packit c4476c
        job = sk_ASYNC_JOB_pop(pool->jobs);
Packit c4476c
        async_job_free(job);
Packit c4476c
    } while (job);
Packit c4476c
}
Packit c4476c
Packit c4476c
int async_init(void)
Packit c4476c
{
Packit c4476c
    if (!CRYPTO_THREAD_init_local(&ctxkey, NULL))
Packit c4476c
        return 0;
Packit c4476c
Packit c4476c
    if (!CRYPTO_THREAD_init_local(&poolkey, NULL)) {
Packit c4476c
        CRYPTO_THREAD_cleanup_local(&ctxkey);
Packit c4476c
        return 0;
Packit c4476c
    }
Packit c4476c
Packit c4476c
    return 1;
Packit c4476c
}
Packit c4476c
Packit c4476c
void async_deinit(void)
Packit c4476c
{
Packit c4476c
    CRYPTO_THREAD_cleanup_local(&ctxkey);
Packit c4476c
    CRYPTO_THREAD_cleanup_local(&poolkey);
Packit c4476c
}
Packit c4476c
Packit c4476c
int ASYNC_init_thread(size_t max_size, size_t init_size)
Packit c4476c
{
Packit c4476c
    async_pool *pool;
Packit c4476c
    size_t curr_size = 0;
Packit c4476c
Packit c4476c
    if (init_size > max_size) {
Packit c4476c
        ASYNCerr(ASYNC_F_ASYNC_INIT_THREAD, ASYNC_R_INVALID_POOL_SIZE);
Packit c4476c
        return 0;
Packit c4476c
    }
Packit c4476c
Packit c4476c
    if (!OPENSSL_init_crypto(OPENSSL_INIT_ASYNC, NULL))
Packit c4476c
        return 0;
Packit c4476c
Packit c4476c
    if (!ossl_init_thread_start(OPENSSL_INIT_THREAD_ASYNC))
Packit c4476c
        return 0;
Packit c4476c
Packit c4476c
    pool = OPENSSL_zalloc(sizeof(*pool));
Packit c4476c
    if (pool == NULL) {
Packit c4476c
        ASYNCerr(ASYNC_F_ASYNC_INIT_THREAD, ERR_R_MALLOC_FAILURE);
Packit c4476c
        return 0;
Packit c4476c
    }
Packit c4476c
Packit c4476c
    pool->jobs = sk_ASYNC_JOB_new_reserve(NULL, init_size);
Packit c4476c
    if (pool->jobs == NULL) {
Packit c4476c
        ASYNCerr(ASYNC_F_ASYNC_INIT_THREAD, ERR_R_MALLOC_FAILURE);
Packit c4476c
        OPENSSL_free(pool);
Packit c4476c
        return 0;
Packit c4476c
    }
Packit c4476c
Packit c4476c
    pool->max_size = max_size;
Packit c4476c
Packit c4476c
    /* Pre-create jobs as required */
Packit c4476c
    while (init_size--) {
Packit c4476c
        ASYNC_JOB *job;
Packit c4476c
        job = async_job_new();
Packit c4476c
        if (job == NULL || !async_fibre_makecontext(&job->fibrectx)) {
Packit c4476c
            /*
Packit c4476c
             * Not actually fatal because we already created the pool, just
Packit c4476c
             * skip creation of any more jobs
Packit c4476c
             */
Packit c4476c
            async_job_free(job);
Packit c4476c
            break;
Packit c4476c
        }
Packit c4476c
        job->funcargs = NULL;
Packit c4476c
        sk_ASYNC_JOB_push(pool->jobs, job); /* Cannot fail due to reserve */
Packit c4476c
        curr_size++;
Packit c4476c
    }
Packit c4476c
    pool->curr_size = curr_size;
Packit c4476c
    if (!CRYPTO_THREAD_set_local(&poolkey, pool)) {
Packit c4476c
        ASYNCerr(ASYNC_F_ASYNC_INIT_THREAD, ASYNC_R_FAILED_TO_SET_POOL);
Packit c4476c
        goto err;
Packit c4476c
    }
Packit c4476c
Packit c4476c
    return 1;
Packit c4476c
err:
Packit c4476c
    async_empty_pool(pool);
Packit c4476c
    sk_ASYNC_JOB_free(pool->jobs);
Packit c4476c
    OPENSSL_free(pool);
Packit c4476c
    return 0;
Packit c4476c
}
Packit c4476c
Packit c4476c
void async_delete_thread_state(void)
Packit c4476c
{
Packit c4476c
    async_pool *pool = (async_pool *)CRYPTO_THREAD_get_local(&poolkey);
Packit c4476c
Packit c4476c
    if (pool != NULL) {
Packit c4476c
        async_empty_pool(pool);
Packit c4476c
        sk_ASYNC_JOB_free(pool->jobs);
Packit c4476c
        OPENSSL_free(pool);
Packit c4476c
        CRYPTO_THREAD_set_local(&poolkey, NULL);
Packit c4476c
    }
Packit c4476c
    async_local_cleanup();
Packit c4476c
    async_ctx_free();
Packit c4476c
}
Packit c4476c
Packit c4476c
void ASYNC_cleanup_thread(void)
Packit c4476c
{
Packit c4476c
    if (!OPENSSL_init_crypto(OPENSSL_INIT_ASYNC, NULL))
Packit c4476c
        return;
Packit c4476c
Packit c4476c
    async_delete_thread_state();
Packit c4476c
}
Packit c4476c
Packit c4476c
ASYNC_JOB *ASYNC_get_current_job(void)
Packit c4476c
{
Packit c4476c
    async_ctx *ctx;
Packit c4476c
Packit c4476c
    if (!OPENSSL_init_crypto(OPENSSL_INIT_ASYNC, NULL))
Packit c4476c
        return NULL;
Packit c4476c
Packit c4476c
    ctx = async_get_ctx();
Packit c4476c
    if (ctx == NULL)
Packit c4476c
        return NULL;
Packit c4476c
Packit c4476c
    return ctx->currjob;
Packit c4476c
}
Packit c4476c
Packit c4476c
ASYNC_WAIT_CTX *ASYNC_get_wait_ctx(ASYNC_JOB *job)
Packit c4476c
{
Packit c4476c
    return job->waitctx;
Packit c4476c
}
Packit c4476c
Packit c4476c
void ASYNC_block_pause(void)
Packit c4476c
{
Packit c4476c
    async_ctx *ctx;
Packit c4476c
Packit c4476c
    if (!OPENSSL_init_crypto(OPENSSL_INIT_ASYNC, NULL))
Packit c4476c
        return;
Packit c4476c
Packit c4476c
    ctx = async_get_ctx();
Packit c4476c
    if (ctx == NULL || ctx->currjob == NULL) {
Packit c4476c
        /*
Packit c4476c
         * We're not in a job anyway so ignore this
Packit c4476c
         */
Packit c4476c
        return;
Packit c4476c
    }
Packit c4476c
    ctx->blocked++;
Packit c4476c
}
Packit c4476c
Packit c4476c
void ASYNC_unblock_pause(void)
Packit c4476c
{
Packit c4476c
    async_ctx *ctx;
Packit c4476c
Packit c4476c
    if (!OPENSSL_init_crypto(OPENSSL_INIT_ASYNC, NULL))
Packit c4476c
        return;
Packit c4476c
Packit c4476c
    ctx = async_get_ctx();
Packit c4476c
    if (ctx == NULL || ctx->currjob == NULL) {
Packit c4476c
        /*
Packit c4476c
         * We're not in a job anyway so ignore this
Packit c4476c
         */
Packit c4476c
        return;
Packit c4476c
    }
Packit c4476c
    if (ctx->blocked > 0)
Packit c4476c
        ctx->blocked--;
Packit c4476c
}