/src/openssl31/crypto/async/async.c
Line | Count | Source (jump to first uncovered line) |
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 | 0 | static ASYNC_JOB *async_get_pool_job(void) { |
105 | 0 | ASYNC_JOB *job; |
106 | 0 | async_pool *pool; |
107 | |
|
108 | 0 | pool = (async_pool *)CRYPTO_THREAD_get_local(&poolkey); |
109 | 0 | if (pool == NULL) { |
110 | | /* |
111 | | * Pool has not been initialised, so init with the defaults, i.e. |
112 | | * no max size and no pre-created jobs |
113 | | */ |
114 | 0 | if (ASYNC_init_thread(0, 0) == 0) |
115 | 0 | return NULL; |
116 | 0 | pool = (async_pool *)CRYPTO_THREAD_get_local(&poolkey); |
117 | 0 | } |
118 | | |
119 | 0 | job = sk_ASYNC_JOB_pop(pool->jobs); |
120 | 0 | if (job == NULL) { |
121 | | /* Pool is empty */ |
122 | 0 | if ((pool->max_size != 0) && (pool->curr_size >= pool->max_size)) |
123 | 0 | return NULL; |
124 | | |
125 | 0 | job = async_job_new(); |
126 | 0 | if (job != NULL) { |
127 | 0 | if (! async_fibre_makecontext(&job->fibrectx)) { |
128 | 0 | async_job_free(job); |
129 | 0 | return NULL; |
130 | 0 | } |
131 | 0 | pool->curr_size++; |
132 | 0 | } |
133 | 0 | } |
134 | 0 | return job; |
135 | 0 | } |
136 | | |
137 | 0 | static void async_release_job(ASYNC_JOB *job) { |
138 | 0 | async_pool *pool; |
139 | |
|
140 | 0 | pool = (async_pool *)CRYPTO_THREAD_get_local(&poolkey); |
141 | 0 | if (pool == NULL) { |
142 | 0 | ERR_raise(ERR_LIB_ASYNC, ERR_R_INTERNAL_ERROR); |
143 | 0 | return; |
144 | 0 | } |
145 | 0 | OPENSSL_free(job->funcargs); |
146 | 0 | job->funcargs = NULL; |
147 | 0 | sk_ASYNC_JOB_push(pool->jobs, job); |
148 | 0 | } |
149 | | |
150 | | void async_start_func(void) |
151 | 0 | { |
152 | 0 | ASYNC_JOB *job; |
153 | 0 | async_ctx *ctx = async_get_ctx(); |
154 | |
|
155 | 0 | if (ctx == NULL) { |
156 | 0 | ERR_raise(ERR_LIB_ASYNC, ERR_R_INTERNAL_ERROR); |
157 | 0 | return; |
158 | 0 | } |
159 | 0 | while (1) { |
160 | | /* Run the job */ |
161 | 0 | job = ctx->currjob; |
162 | 0 | job->ret = job->func(job->funcargs); |
163 | | |
164 | | /* Stop the job */ |
165 | 0 | job->status = ASYNC_JOB_STOPPING; |
166 | 0 | if (!async_fibre_swapcontext(&job->fibrectx, |
167 | 0 | &ctx->dispatcher, 1)) { |
168 | | /* |
169 | | * Should not happen. Getting here will close the thread...can't do |
170 | | * much about it |
171 | | */ |
172 | 0 | ERR_raise(ERR_LIB_ASYNC, ASYNC_R_FAILED_TO_SWAP_CONTEXT); |
173 | 0 | } |
174 | 0 | } |
175 | 0 | } |
176 | | |
177 | | int ASYNC_start_job(ASYNC_JOB **job, ASYNC_WAIT_CTX *wctx, int *ret, |
178 | | int (*func)(void *), void *args, size_t size) |
179 | 0 | { |
180 | 0 | async_ctx *ctx; |
181 | 0 | OSSL_LIB_CTX *libctx; |
182 | |
|
183 | 0 | if (!OPENSSL_init_crypto(OPENSSL_INIT_ASYNC, NULL)) |
184 | 0 | return ASYNC_ERR; |
185 | | |
186 | 0 | ctx = async_get_ctx(); |
187 | 0 | if (ctx == NULL) |
188 | 0 | ctx = async_ctx_new(); |
189 | 0 | if (ctx == NULL) |
190 | 0 | return ASYNC_ERR; |
191 | | |
192 | 0 | if (*job != NULL) |
193 | 0 | ctx->currjob = *job; |
194 | |
|
195 | 0 | for (;;) { |
196 | 0 | if (ctx->currjob != NULL) { |
197 | 0 | if (ctx->currjob->status == ASYNC_JOB_STOPPING) { |
198 | 0 | *ret = ctx->currjob->ret; |
199 | 0 | ctx->currjob->waitctx = NULL; |
200 | 0 | async_release_job(ctx->currjob); |
201 | 0 | ctx->currjob = NULL; |
202 | 0 | *job = NULL; |
203 | 0 | return ASYNC_FINISH; |
204 | 0 | } |
205 | | |
206 | 0 | if (ctx->currjob->status == ASYNC_JOB_PAUSING) { |
207 | 0 | *job = ctx->currjob; |
208 | 0 | ctx->currjob->status = ASYNC_JOB_PAUSED; |
209 | 0 | ctx->currjob = NULL; |
210 | 0 | return ASYNC_PAUSE; |
211 | 0 | } |
212 | | |
213 | 0 | if (ctx->currjob->status == ASYNC_JOB_PAUSED) { |
214 | 0 | if (*job == NULL) |
215 | 0 | return ASYNC_ERR; |
216 | 0 | ctx->currjob = *job; |
217 | | |
218 | | /* |
219 | | * Restore the default libctx to what it was the last time the |
220 | | * fibre ran |
221 | | */ |
222 | 0 | libctx = OSSL_LIB_CTX_set0_default(ctx->currjob->libctx); |
223 | 0 | if (libctx == NULL) { |
224 | | /* Failed to set the default context */ |
225 | 0 | ERR_raise(ERR_LIB_ASYNC, ERR_R_INTERNAL_ERROR); |
226 | 0 | goto err; |
227 | 0 | } |
228 | | /* Resume previous job */ |
229 | 0 | if (!async_fibre_swapcontext(&ctx->dispatcher, |
230 | 0 | &ctx->currjob->fibrectx, 1)) { |
231 | 0 | ctx->currjob->libctx = OSSL_LIB_CTX_set0_default(libctx); |
232 | 0 | ERR_raise(ERR_LIB_ASYNC, ASYNC_R_FAILED_TO_SWAP_CONTEXT); |
233 | 0 | goto err; |
234 | 0 | } |
235 | | /* |
236 | | * In case the fibre changed the default libctx we set it back |
237 | | * again to what it was originally, and remember what it had |
238 | | * been changed to. |
239 | | */ |
240 | 0 | ctx->currjob->libctx = OSSL_LIB_CTX_set0_default(libctx); |
241 | 0 | continue; |
242 | 0 | } |
243 | | |
244 | | /* Should not happen */ |
245 | 0 | ERR_raise(ERR_LIB_ASYNC, ERR_R_INTERNAL_ERROR); |
246 | 0 | async_release_job(ctx->currjob); |
247 | 0 | ctx->currjob = NULL; |
248 | 0 | *job = NULL; |
249 | 0 | return ASYNC_ERR; |
250 | 0 | } |
251 | | |
252 | | /* Start a new job */ |
253 | 0 | if ((ctx->currjob = async_get_pool_job()) == NULL) |
254 | 0 | return ASYNC_NO_JOBS; |
255 | | |
256 | 0 | if (args != NULL) { |
257 | 0 | ctx->currjob->funcargs = OPENSSL_malloc(size); |
258 | 0 | if (ctx->currjob->funcargs == NULL) { |
259 | 0 | ERR_raise(ERR_LIB_ASYNC, ERR_R_MALLOC_FAILURE); |
260 | 0 | async_release_job(ctx->currjob); |
261 | 0 | ctx->currjob = NULL; |
262 | 0 | return ASYNC_ERR; |
263 | 0 | } |
264 | 0 | memcpy(ctx->currjob->funcargs, args, size); |
265 | 0 | } else { |
266 | 0 | ctx->currjob->funcargs = NULL; |
267 | 0 | } |
268 | | |
269 | 0 | ctx->currjob->func = func; |
270 | 0 | ctx->currjob->waitctx = wctx; |
271 | 0 | libctx = ossl_lib_ctx_get_concrete(NULL); |
272 | 0 | if (!async_fibre_swapcontext(&ctx->dispatcher, |
273 | 0 | &ctx->currjob->fibrectx, 1)) { |
274 | 0 | ERR_raise(ERR_LIB_ASYNC, ASYNC_R_FAILED_TO_SWAP_CONTEXT); |
275 | 0 | goto err; |
276 | 0 | } |
277 | | /* |
278 | | * In case the fibre changed the default libctx we set it back again |
279 | | * to what it was, and remember what it had been changed to. |
280 | | */ |
281 | 0 | ctx->currjob->libctx = OSSL_LIB_CTX_set0_default(libctx); |
282 | 0 | } |
283 | | |
284 | 0 | err: |
285 | 0 | async_release_job(ctx->currjob); |
286 | 0 | ctx->currjob = NULL; |
287 | 0 | *job = NULL; |
288 | 0 | return ASYNC_ERR; |
289 | 0 | } |
290 | | |
291 | | int ASYNC_pause_job(void) |
292 | 0 | { |
293 | 0 | ASYNC_JOB *job; |
294 | 0 | async_ctx *ctx = async_get_ctx(); |
295 | |
|
296 | 0 | if (ctx == NULL |
297 | 0 | || ctx->currjob == NULL |
298 | 0 | || ctx->blocked) { |
299 | | /* |
300 | | * Could be we've deliberately not been started within a job so this is |
301 | | * counted as success. |
302 | | */ |
303 | 0 | return 1; |
304 | 0 | } |
305 | | |
306 | 0 | job = ctx->currjob; |
307 | 0 | job->status = ASYNC_JOB_PAUSING; |
308 | |
|
309 | 0 | if (!async_fibre_swapcontext(&job->fibrectx, |
310 | 0 | &ctx->dispatcher, 1)) { |
311 | 0 | ERR_raise(ERR_LIB_ASYNC, ASYNC_R_FAILED_TO_SWAP_CONTEXT); |
312 | 0 | return 0; |
313 | 0 | } |
314 | | /* Reset counts of added and deleted fds */ |
315 | 0 | async_wait_ctx_reset_counts(job->waitctx); |
316 | |
|
317 | 0 | return 1; |
318 | 0 | } |
319 | | |
320 | | static void async_empty_pool(async_pool *pool) |
321 | 0 | { |
322 | 0 | ASYNC_JOB *job; |
323 | |
|
324 | 0 | if (pool == NULL || pool->jobs == NULL) |
325 | 0 | return; |
326 | | |
327 | 0 | do { |
328 | 0 | job = sk_ASYNC_JOB_pop(pool->jobs); |
329 | 0 | async_job_free(job); |
330 | 0 | } while (job); |
331 | 0 | } |
332 | | |
333 | | int async_init(void) |
334 | 32 | { |
335 | 32 | if (!CRYPTO_THREAD_init_local(&ctxkey, NULL)) |
336 | 0 | return 0; |
337 | | |
338 | 32 | if (!CRYPTO_THREAD_init_local(&poolkey, NULL)) { |
339 | 0 | CRYPTO_THREAD_cleanup_local(&ctxkey); |
340 | 0 | return 0; |
341 | 0 | } |
342 | | |
343 | 32 | return 1; |
344 | 32 | } |
345 | | |
346 | | void async_deinit(void) |
347 | 32 | { |
348 | 32 | CRYPTO_THREAD_cleanup_local(&ctxkey); |
349 | 32 | CRYPTO_THREAD_cleanup_local(&poolkey); |
350 | 32 | } |
351 | | |
352 | | int ASYNC_init_thread(size_t max_size, size_t init_size) |
353 | 0 | { |
354 | 0 | async_pool *pool; |
355 | 0 | size_t curr_size = 0; |
356 | |
|
357 | 0 | if (init_size > max_size) { |
358 | 0 | ERR_raise(ERR_LIB_ASYNC, ASYNC_R_INVALID_POOL_SIZE); |
359 | 0 | return 0; |
360 | 0 | } |
361 | | |
362 | 0 | if (!OPENSSL_init_crypto(OPENSSL_INIT_ASYNC, NULL)) |
363 | 0 | return 0; |
364 | | |
365 | 0 | if (!ossl_init_thread_start(NULL, NULL, async_delete_thread_state)) |
366 | 0 | return 0; |
367 | | |
368 | 0 | pool = OPENSSL_zalloc(sizeof(*pool)); |
369 | 0 | if (pool == NULL) { |
370 | 0 | ERR_raise(ERR_LIB_ASYNC, ERR_R_MALLOC_FAILURE); |
371 | 0 | return 0; |
372 | 0 | } |
373 | | |
374 | 0 | pool->jobs = sk_ASYNC_JOB_new_reserve(NULL, init_size); |
375 | 0 | if (pool->jobs == NULL) { |
376 | 0 | ERR_raise(ERR_LIB_ASYNC, ERR_R_MALLOC_FAILURE); |
377 | 0 | OPENSSL_free(pool); |
378 | 0 | return 0; |
379 | 0 | } |
380 | | |
381 | 0 | pool->max_size = max_size; |
382 | | |
383 | | /* Pre-create jobs as required */ |
384 | 0 | while (init_size--) { |
385 | 0 | ASYNC_JOB *job; |
386 | 0 | job = async_job_new(); |
387 | 0 | if (job == NULL || !async_fibre_makecontext(&job->fibrectx)) { |
388 | | /* |
389 | | * Not actually fatal because we already created the pool, just |
390 | | * skip creation of any more jobs |
391 | | */ |
392 | 0 | async_job_free(job); |
393 | 0 | break; |
394 | 0 | } |
395 | 0 | job->funcargs = NULL; |
396 | 0 | sk_ASYNC_JOB_push(pool->jobs, job); /* Cannot fail due to reserve */ |
397 | 0 | curr_size++; |
398 | 0 | } |
399 | 0 | pool->curr_size = curr_size; |
400 | 0 | if (!CRYPTO_THREAD_set_local(&poolkey, pool)) { |
401 | 0 | ERR_raise(ERR_LIB_ASYNC, ASYNC_R_FAILED_TO_SET_POOL); |
402 | 0 | goto err; |
403 | 0 | } |
404 | | |
405 | 0 | return 1; |
406 | 0 | err: |
407 | 0 | async_empty_pool(pool); |
408 | 0 | sk_ASYNC_JOB_free(pool->jobs); |
409 | 0 | OPENSSL_free(pool); |
410 | 0 | return 0; |
411 | 0 | } |
412 | | |
413 | | static void async_delete_thread_state(void *arg) |
414 | 0 | { |
415 | 0 | async_pool *pool = (async_pool *)CRYPTO_THREAD_get_local(&poolkey); |
416 | |
|
417 | 0 | if (pool != NULL) { |
418 | 0 | async_empty_pool(pool); |
419 | 0 | sk_ASYNC_JOB_free(pool->jobs); |
420 | 0 | OPENSSL_free(pool); |
421 | 0 | CRYPTO_THREAD_set_local(&poolkey, NULL); |
422 | 0 | } |
423 | 0 | async_local_cleanup(); |
424 | 0 | async_ctx_free(); |
425 | 0 | } |
426 | | |
427 | | void ASYNC_cleanup_thread(void) |
428 | 0 | { |
429 | 0 | if (!OPENSSL_init_crypto(OPENSSL_INIT_ASYNC, NULL)) |
430 | 0 | return; |
431 | | |
432 | 0 | async_delete_thread_state(NULL); |
433 | 0 | } |
434 | | |
435 | | ASYNC_JOB *ASYNC_get_current_job(void) |
436 | 0 | { |
437 | 0 | async_ctx *ctx; |
438 | |
|
439 | 0 | if (!OPENSSL_init_crypto(OPENSSL_INIT_ASYNC, NULL)) |
440 | 0 | return NULL; |
441 | | |
442 | 0 | ctx = async_get_ctx(); |
443 | 0 | if (ctx == NULL) |
444 | 0 | return NULL; |
445 | | |
446 | 0 | return ctx->currjob; |
447 | 0 | } |
448 | | |
449 | | ASYNC_WAIT_CTX *ASYNC_get_wait_ctx(ASYNC_JOB *job) |
450 | 0 | { |
451 | 0 | return job->waitctx; |
452 | 0 | } |
453 | | |
454 | | void ASYNC_block_pause(void) |
455 | 0 | { |
456 | 0 | async_ctx *ctx; |
457 | |
|
458 | 0 | if (!OPENSSL_init_crypto(OPENSSL_INIT_ASYNC, NULL)) |
459 | 0 | return; |
460 | | |
461 | 0 | ctx = async_get_ctx(); |
462 | 0 | if (ctx == NULL || ctx->currjob == NULL) { |
463 | | /* |
464 | | * We're not in a job anyway so ignore this |
465 | | */ |
466 | 0 | return; |
467 | 0 | } |
468 | 0 | ctx->blocked++; |
469 | 0 | } |
470 | | |
471 | | void ASYNC_unblock_pause(void) |
472 | 0 | { |
473 | 0 | async_ctx *ctx; |
474 | |
|
475 | 0 | if (!OPENSSL_init_crypto(OPENSSL_INIT_ASYNC, NULL)) |
476 | 0 | return; |
477 | | |
478 | 0 | ctx = async_get_ctx(); |
479 | 0 | if (ctx == NULL || ctx->currjob == NULL) { |
480 | | /* |
481 | | * We're not in a job anyway so ignore this |
482 | | */ |
483 | 0 | return; |
484 | 0 | } |
485 | 0 | if (ctx->blocked > 0) |
486 | 0 | ctx->blocked--; |
487 | 0 | } |