Coverage Report

Created: 2025-12-31 06:58

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/openssl30/crypto/async/async.c
Line
Count
Source
1
/*
2
 * Copyright 2015-2021 The OpenSSL Project Authors. All Rights Reserved.
3
 *
4
 * Licensed under the Apache License 2.0 (the "License").  You may not use
5
 * this file except in compliance with the License.  You can obtain a copy
6
 * in the file LICENSE in the source distribution or at
7
 * https://www.openssl.org/source/license.html
8
 */
9
10
/*
11
 * Without this we start getting longjmp crashes because it thinks we're jumping
12
 * up the stack when in fact we are jumping to an entirely different stack. The
13
 * cost of this is not having certain buffer overrun/underrun checks etc for
14
 * this source file :-(
15
 */
16
#undef _FORTIFY_SOURCE
17
18
/* This must be the first #include file */
19
#include "async_local.h"
20
21
#include <openssl/err.h>
22
#include "crypto/cryptlib.h"
23
#include <string.h>
24
25
0
#define ASYNC_JOB_RUNNING 0
26
0
#define ASYNC_JOB_PAUSING 1
27
0
#define ASYNC_JOB_PAUSED 2
28
0
#define ASYNC_JOB_STOPPING 3
29
30
static CRYPTO_THREAD_LOCAL ctxkey;
31
static CRYPTO_THREAD_LOCAL poolkey;
32
33
static void async_delete_thread_state(void *arg);
34
35
static async_ctx *async_ctx_new(void)
36
0
{
37
0
    async_ctx *nctx;
38
39
0
    if (!ossl_init_thread_start(NULL, NULL, async_delete_thread_state))
40
0
        return NULL;
41
42
0
    nctx = OPENSSL_malloc(sizeof(*nctx));
43
0
    if (nctx == NULL) {
44
0
        ERR_raise(ERR_LIB_ASYNC, ERR_R_MALLOC_FAILURE);
45
0
        goto err;
46
0
    }
47
48
0
    async_fibre_init_dispatcher(&nctx->dispatcher);
49
0
    nctx->currjob = NULL;
50
0
    nctx->blocked = 0;
51
0
    if (!CRYPTO_THREAD_set_local(&ctxkey, nctx))
52
0
        goto err;
53
54
0
    return nctx;
55
0
err:
56
0
    OPENSSL_free(nctx);
57
58
0
    return NULL;
59
0
}
60
61
async_ctx *async_get_ctx(void)
62
0
{
63
0
    return (async_ctx *)CRYPTO_THREAD_get_local(&ctxkey);
64
0
}
65
66
static int async_ctx_free(void)
67
0
{
68
0
    async_ctx *ctx;
69
70
0
    ctx = async_get_ctx();
71
72
0
    if (!CRYPTO_THREAD_set_local(&ctxkey, NULL))
73
0
        return 0;
74
75
0
    OPENSSL_free(ctx);
76
77
0
    return 1;
78
0
}
79
80
static ASYNC_JOB *async_job_new(void)
81
0
{
82
0
    ASYNC_JOB *job = NULL;
83
84
0
    job = OPENSSL_zalloc(sizeof(*job));
85
0
    if (job == NULL) {
86
0
        ERR_raise(ERR_LIB_ASYNC, ERR_R_MALLOC_FAILURE);
87
0
        return NULL;
88
0
    }
89
90
0
    job->status = ASYNC_JOB_RUNNING;
91
92
0
    return job;
93
0
}
94
95
static void async_job_free(ASYNC_JOB *job)
96
0
{
97
0
    if (job != NULL) {
98
0
        OPENSSL_free(job->funcargs);
99
0
        async_fibre_free(&job->fibrectx);
100
0
        OPENSSL_free(job);
101
0
    }
102
0
}
103
104
static ASYNC_JOB *async_get_pool_job(void)
105
0
{
106
0
    ASYNC_JOB *job;
107
0
    async_pool *pool;
108
109
0
    pool = (async_pool *)CRYPTO_THREAD_get_local(&poolkey);
110
0
    if (pool == NULL) {
111
        /*
112
         * Pool has not been initialised, so init with the defaults, i.e.
113
         * no max size and no pre-created jobs
114
         */
115
0
        if (ASYNC_init_thread(0, 0) == 0)
116
0
            return NULL;
117
0
        pool = (async_pool *)CRYPTO_THREAD_get_local(&poolkey);
118
0
    }
119
120
0
    job = sk_ASYNC_JOB_pop(pool->jobs);
121
0
    if (job == NULL) {
122
        /* Pool is empty */
123
0
        if ((pool->max_size != 0) && (pool->curr_size >= pool->max_size))
124
0
            return NULL;
125
126
0
        job = async_job_new();
127
0
        if (job != NULL) {
128
0
            if (!async_fibre_makecontext(&job->fibrectx)) {
129
0
                async_job_free(job);
130
0
                return NULL;
131
0
            }
132
0
            pool->curr_size++;
133
0
        }
134
0
    }
135
0
    return job;
136
0
}
137
138
static void async_release_job(ASYNC_JOB *job)
139
0
{
140
0
    async_pool *pool;
141
142
0
    pool = (async_pool *)CRYPTO_THREAD_get_local(&poolkey);
143
0
    if (pool == NULL) {
144
0
        ERR_raise(ERR_LIB_ASYNC, ERR_R_INTERNAL_ERROR);
145
0
        return;
146
0
    }
147
0
    OPENSSL_free(job->funcargs);
148
0
    job->funcargs = NULL;
149
0
    sk_ASYNC_JOB_push(pool->jobs, job);
150
0
}
151
152
void async_start_func(void)
153
0
{
154
0
    ASYNC_JOB *job;
155
0
    async_ctx *ctx = async_get_ctx();
156
157
0
    if (ctx == NULL) {
158
0
        ERR_raise(ERR_LIB_ASYNC, ERR_R_INTERNAL_ERROR);
159
0
        return;
160
0
    }
161
0
    while (1) {
162
        /* Run the job */
163
0
        job = ctx->currjob;
164
0
        job->ret = job->func(job->funcargs);
165
166
        /* Stop the job */
167
0
        job->status = ASYNC_JOB_STOPPING;
168
0
        if (!async_fibre_swapcontext(&job->fibrectx,
169
0
                &ctx->dispatcher, 1)) {
170
            /*
171
             * Should not happen. Getting here will close the thread...can't do
172
             * much about it
173
             */
174
0
            ERR_raise(ERR_LIB_ASYNC, ASYNC_R_FAILED_TO_SWAP_CONTEXT);
175
0
        }
176
0
    }
177
0
}
178
179
int ASYNC_start_job(ASYNC_JOB **job, ASYNC_WAIT_CTX *wctx, int *ret,
180
    int (*func)(void *), void *args, size_t size)
181
0
{
182
0
    async_ctx *ctx;
183
0
    OSSL_LIB_CTX *libctx;
184
185
0
    if (!OPENSSL_init_crypto(OPENSSL_INIT_ASYNC, NULL))
186
0
        return ASYNC_ERR;
187
188
0
    ctx = async_get_ctx();
189
0
    if (ctx == NULL)
190
0
        ctx = async_ctx_new();
191
0
    if (ctx == NULL)
192
0
        return ASYNC_ERR;
193
194
0
    if (*job != NULL)
195
0
        ctx->currjob = *job;
196
197
0
    for (;;) {
198
0
        if (ctx->currjob != NULL) {
199
0
            if (ctx->currjob->status == ASYNC_JOB_STOPPING) {
200
0
                *ret = ctx->currjob->ret;
201
0
                ctx->currjob->waitctx = NULL;
202
0
                async_release_job(ctx->currjob);
203
0
                ctx->currjob = NULL;
204
0
                *job = NULL;
205
0
                return ASYNC_FINISH;
206
0
            }
207
208
0
            if (ctx->currjob->status == ASYNC_JOB_PAUSING) {
209
0
                *job = ctx->currjob;
210
0
                ctx->currjob->status = ASYNC_JOB_PAUSED;
211
0
                ctx->currjob = NULL;
212
0
                return ASYNC_PAUSE;
213
0
            }
214
215
0
            if (ctx->currjob->status == ASYNC_JOB_PAUSED) {
216
0
                if (*job == NULL)
217
0
                    return ASYNC_ERR;
218
0
                ctx->currjob = *job;
219
220
                /*
221
                 * Restore the default libctx to what it was the last time the
222
                 * fibre ran
223
                 */
224
0
                libctx = OSSL_LIB_CTX_set0_default(ctx->currjob->libctx);
225
0
                if (libctx == NULL) {
226
                    /* Failed to set the default context */
227
0
                    ERR_raise(ERR_LIB_ASYNC, ERR_R_INTERNAL_ERROR);
228
0
                    goto err;
229
0
                }
230
                /* Resume previous job */
231
0
                if (!async_fibre_swapcontext(&ctx->dispatcher,
232
0
                        &ctx->currjob->fibrectx, 1)) {
233
0
                    ctx->currjob->libctx = OSSL_LIB_CTX_set0_default(libctx);
234
0
                    ERR_raise(ERR_LIB_ASYNC, ASYNC_R_FAILED_TO_SWAP_CONTEXT);
235
0
                    goto err;
236
0
                }
237
                /*
238
                 * In case the fibre changed the default libctx we set it back
239
                 * again to what it was originally, and remember what it had
240
                 * been changed to.
241
                 */
242
0
                ctx->currjob->libctx = OSSL_LIB_CTX_set0_default(libctx);
243
0
                continue;
244
0
            }
245
246
            /* Should not happen */
247
0
            ERR_raise(ERR_LIB_ASYNC, ERR_R_INTERNAL_ERROR);
248
0
            async_release_job(ctx->currjob);
249
0
            ctx->currjob = NULL;
250
0
            *job = NULL;
251
0
            return ASYNC_ERR;
252
0
        }
253
254
        /* Start a new job */
255
0
        if ((ctx->currjob = async_get_pool_job()) == NULL)
256
0
            return ASYNC_NO_JOBS;
257
258
        /* Check for size > 0 to avoid malloc(0) */
259
0
        if (args != NULL && size > 0) {
260
0
            ctx->currjob->funcargs = OPENSSL_malloc(size);
261
0
            if (ctx->currjob->funcargs == NULL) {
262
0
                ERR_raise(ERR_LIB_ASYNC, ERR_R_MALLOC_FAILURE);
263
0
                async_release_job(ctx->currjob);
264
0
                ctx->currjob = NULL;
265
0
                return ASYNC_ERR;
266
0
            }
267
0
            memcpy(ctx->currjob->funcargs, args, size);
268
0
        } else {
269
0
            ctx->currjob->funcargs = NULL;
270
0
        }
271
272
0
        ctx->currjob->func = func;
273
0
        ctx->currjob->waitctx = wctx;
274
0
        libctx = ossl_lib_ctx_get_concrete(NULL);
275
0
        if (!async_fibre_swapcontext(&ctx->dispatcher,
276
0
                &ctx->currjob->fibrectx, 1)) {
277
0
            ERR_raise(ERR_LIB_ASYNC, ASYNC_R_FAILED_TO_SWAP_CONTEXT);
278
0
            goto err;
279
0
        }
280
        /*
281
         * In case the fibre changed the default libctx we set it back again
282
         * to what it was, and remember what it had been changed to.
283
         */
284
0
        ctx->currjob->libctx = OSSL_LIB_CTX_set0_default(libctx);
285
0
    }
286
287
0
err:
288
0
    async_release_job(ctx->currjob);
289
0
    ctx->currjob = NULL;
290
0
    *job = NULL;
291
0
    return ASYNC_ERR;
292
0
}
293
294
int ASYNC_pause_job(void)
295
0
{
296
0
    ASYNC_JOB *job;
297
0
    async_ctx *ctx = async_get_ctx();
298
299
0
    if (ctx == NULL
300
0
        || ctx->currjob == NULL
301
0
        || ctx->blocked) {
302
        /*
303
         * Could be we've deliberately not been started within a job so this is
304
         * counted as success.
305
         */
306
0
        return 1;
307
0
    }
308
309
0
    job = ctx->currjob;
310
0
    job->status = ASYNC_JOB_PAUSING;
311
312
0
    if (!async_fibre_swapcontext(&job->fibrectx,
313
0
            &ctx->dispatcher, 1)) {
314
0
        ERR_raise(ERR_LIB_ASYNC, ASYNC_R_FAILED_TO_SWAP_CONTEXT);
315
0
        return 0;
316
0
    }
317
    /* Reset counts of added and deleted fds */
318
0
    async_wait_ctx_reset_counts(job->waitctx);
319
320
0
    return 1;
321
0
}
322
323
static void async_empty_pool(async_pool *pool)
324
0
{
325
0
    ASYNC_JOB *job;
326
327
0
    if (pool == NULL || pool->jobs == NULL)
328
0
        return;
329
330
0
    do {
331
0
        job = sk_ASYNC_JOB_pop(pool->jobs);
332
0
        async_job_free(job);
333
0
    } while (job);
334
0
}
335
336
int async_init(void)
337
54
{
338
54
    if (!CRYPTO_THREAD_init_local(&ctxkey, NULL))
339
0
        return 0;
340
341
54
    if (!CRYPTO_THREAD_init_local(&poolkey, NULL)) {
342
0
        CRYPTO_THREAD_cleanup_local(&ctxkey);
343
0
        return 0;
344
0
    }
345
346
54
    return 1;
347
54
}
348
349
void async_deinit(void)
350
72
{
351
72
    CRYPTO_THREAD_cleanup_local(&ctxkey);
352
72
    CRYPTO_THREAD_cleanup_local(&poolkey);
353
72
}
354
355
int ASYNC_init_thread(size_t max_size, size_t init_size)
356
0
{
357
0
    async_pool *pool;
358
0
    size_t curr_size = 0;
359
360
0
    if (init_size > max_size) {
361
0
        ERR_raise(ERR_LIB_ASYNC, ASYNC_R_INVALID_POOL_SIZE);
362
0
        return 0;
363
0
    }
364
365
0
    if (!OPENSSL_init_crypto(OPENSSL_INIT_ASYNC, NULL))
366
0
        return 0;
367
368
0
    if (!ossl_init_thread_start(NULL, NULL, async_delete_thread_state))
369
0
        return 0;
370
371
0
    pool = OPENSSL_zalloc(sizeof(*pool));
372
0
    if (pool == NULL) {
373
0
        ERR_raise(ERR_LIB_ASYNC, ERR_R_MALLOC_FAILURE);
374
0
        return 0;
375
0
    }
376
377
0
    pool->jobs = sk_ASYNC_JOB_new_reserve(NULL, init_size);
378
0
    if (pool->jobs == NULL) {
379
0
        ERR_raise(ERR_LIB_ASYNC, ERR_R_MALLOC_FAILURE);
380
0
        OPENSSL_free(pool);
381
0
        return 0;
382
0
    }
383
384
0
    pool->max_size = max_size;
385
386
    /* Pre-create jobs as required */
387
0
    while (init_size--) {
388
0
        ASYNC_JOB *job;
389
0
        job = async_job_new();
390
0
        if (job == NULL || !async_fibre_makecontext(&job->fibrectx)) {
391
            /*
392
             * Not actually fatal because we already created the pool, just
393
             * skip creation of any more jobs
394
             */
395
0
            async_job_free(job);
396
0
            break;
397
0
        }
398
0
        job->funcargs = NULL;
399
0
        sk_ASYNC_JOB_push(pool->jobs, job); /* Cannot fail due to reserve */
400
0
        curr_size++;
401
0
    }
402
0
    pool->curr_size = curr_size;
403
0
    if (!CRYPTO_THREAD_set_local(&poolkey, pool)) {
404
0
        ERR_raise(ERR_LIB_ASYNC, ASYNC_R_FAILED_TO_SET_POOL);
405
0
        goto err;
406
0
    }
407
408
0
    return 1;
409
0
err:
410
0
    async_empty_pool(pool);
411
0
    sk_ASYNC_JOB_free(pool->jobs);
412
0
    OPENSSL_free(pool);
413
0
    return 0;
414
0
}
415
416
static void async_delete_thread_state(void *arg)
417
0
{
418
0
    async_pool *pool = (async_pool *)CRYPTO_THREAD_get_local(&poolkey);
419
420
0
    if (pool != NULL) {
421
0
        async_empty_pool(pool);
422
0
        sk_ASYNC_JOB_free(pool->jobs);
423
0
        OPENSSL_free(pool);
424
0
        CRYPTO_THREAD_set_local(&poolkey, NULL);
425
0
    }
426
0
    async_local_cleanup();
427
0
    async_ctx_free();
428
0
}
429
430
void ASYNC_cleanup_thread(void)
431
0
{
432
0
    if (!OPENSSL_init_crypto(OPENSSL_INIT_ASYNC, NULL))
433
0
        return;
434
435
0
    async_delete_thread_state(NULL);
436
0
}
437
438
ASYNC_JOB *ASYNC_get_current_job(void)
439
0
{
440
0
    async_ctx *ctx;
441
442
0
    if (!OPENSSL_init_crypto(OPENSSL_INIT_ASYNC, NULL))
443
0
        return NULL;
444
445
0
    ctx = async_get_ctx();
446
0
    if (ctx == NULL)
447
0
        return NULL;
448
449
0
    return ctx->currjob;
450
0
}
451
452
ASYNC_WAIT_CTX *ASYNC_get_wait_ctx(ASYNC_JOB *job)
453
0
{
454
0
    return job->waitctx;
455
0
}
456
457
void ASYNC_block_pause(void)
458
0
{
459
0
    async_ctx *ctx;
460
461
0
    if (!OPENSSL_init_crypto(OPENSSL_INIT_ASYNC, NULL))
462
0
        return;
463
464
0
    ctx = async_get_ctx();
465
0
    if (ctx == NULL || ctx->currjob == NULL) {
466
        /*
467
         * We're not in a job anyway so ignore this
468
         */
469
0
        return;
470
0
    }
471
0
    ctx->blocked++;
472
0
}
473
474
void ASYNC_unblock_pause(void)
475
0
{
476
0
    async_ctx *ctx;
477
478
0
    if (!OPENSSL_init_crypto(OPENSSL_INIT_ASYNC, NULL))
479
0
        return;
480
481
0
    ctx = async_get_ctx();
482
0
    if (ctx == NULL || ctx->currjob == NULL) {
483
        /*
484
         * We're not in a job anyway so ignore this
485
         */
486
0
        return;
487
0
    }
488
0
    if (ctx->blocked > 0)
489
0
        ctx->blocked--;
490
0
}