]>
Commit | Line | Data |
---|---|---|
a3667c31 | 1 | /* |
6ec5fce2 | 2 | * Copyright 2015-2018 The OpenSSL Project Authors. All Rights Reserved. |
a3667c31 | 3 | * |
f3a95349 | 4 | * Licensed under the Apache License 2.0 (the "License"). You may not use |
62867571 RS |
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 | |
a3667c31 MC |
8 | */ |
9 | ||
4abc7681 MC |
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 | ||
6e8ac508 VD |
18 | /* This must be the first #include file */ |
19 | #include "async_locl.h" | |
20 | ||
079a1a90 | 21 | #include <openssl/err.h> |
176db6dc | 22 | #include "internal/cryptlib_int.h" |
a3667c31 MC |
23 | #include <string.h> |
24 | ||
25 | #define ASYNC_JOB_RUNNING 0 | |
26 | #define ASYNC_JOB_PAUSING 1 | |
27 | #define ASYNC_JOB_PAUSED 2 | |
28 | #define ASYNC_JOB_STOPPING 3 | |
29 | ||
224905f8 MC |
30 | static CRYPTO_THREAD_LOCAL ctxkey; |
31 | static CRYPTO_THREAD_LOCAL poolkey; | |
32 | ||
da747958 | 33 | static void async_delete_thread_state(void *arg); |
242f84d0 | 34 | |
636ca4ff | 35 | static async_ctx *async_ctx_new(void) |
a3667c31 | 36 | { |
74a8acbd BE |
37 | async_ctx *nctx; |
38 | ||
6913f5fe | 39 | if (!ossl_init_thread_start(NULL, NULL, async_delete_thread_state)) |
74a8acbd | 40 | return NULL; |
a3667c31 | 41 | |
cbe29648 | 42 | nctx = OPENSSL_malloc(sizeof(*nctx)); |
e38565f5 | 43 | if (nctx == NULL) { |
079a1a90 | 44 | ASYNCerr(ASYNC_F_ASYNC_CTX_NEW, ERR_R_MALLOC_FAILURE); |
a3667c31 MC |
45 | goto err; |
46 | } | |
47 | ||
636ca4ff | 48 | async_fibre_init_dispatcher(&nctx->dispatcher); |
a3667c31 | 49 | nctx->currjob = NULL; |
e8dfb5bf | 50 | nctx->blocked = 0; |
224905f8 | 51 | if (!CRYPTO_THREAD_set_local(&ctxkey, nctx)) |
9ec1e031 | 52 | goto err; |
a3667c31 MC |
53 | |
54 | return nctx; | |
55 | err: | |
e38565f5 | 56 | OPENSSL_free(nctx); |
a3667c31 MC |
57 | |
58 | return NULL; | |
59 | } | |
60 | ||
224905f8 | 61 | async_ctx *async_get_ctx(void) |
7b9f8f7f | 62 | { |
224905f8 | 63 | return (async_ctx *)CRYPTO_THREAD_get_local(&ctxkey); |
7b9f8f7f MC |
64 | } |
65 | ||
636ca4ff | 66 | static int async_ctx_free(void) |
a3667c31 | 67 | { |
e38565f5 | 68 | async_ctx *ctx; |
a3667c31 | 69 | |
e38565f5 MC |
70 | ctx = async_get_ctx(); |
71 | ||
224905f8 | 72 | if (!CRYPTO_THREAD_set_local(&ctxkey, NULL)) |
9ec1e031 | 73 | return 0; |
a3667c31 | 74 | |
e38565f5 MC |
75 | OPENSSL_free(ctx); |
76 | ||
a3667c31 MC |
77 | return 1; |
78 | } | |
79 | ||
636ca4ff | 80 | static ASYNC_JOB *async_job_new(void) |
a3667c31 MC |
81 | { |
82 | ASYNC_JOB *job = NULL; | |
a3667c31 | 83 | |
cbe29648 | 84 | job = OPENSSL_zalloc(sizeof(*job)); |
e38565f5 | 85 | if (job == NULL) { |
079a1a90 | 86 | ASYNCerr(ASYNC_F_ASYNC_JOB_NEW, ERR_R_MALLOC_FAILURE); |
50108304 | 87 | return NULL; |
a3667c31 MC |
88 | } |
89 | ||
a3667c31 | 90 | job->status = ASYNC_JOB_RUNNING; |
a3667c31 MC |
91 | |
92 | return job; | |
a3667c31 MC |
93 | } |
94 | ||
636ca4ff | 95 | static void async_job_free(ASYNC_JOB *job) |
a3667c31 | 96 | { |
e38565f5 MC |
97 | if (job != NULL) { |
98 | OPENSSL_free(job->funcargs); | |
636ca4ff | 99 | async_fibre_free(&job->fibrectx); |
a3667c31 MC |
100 | OPENSSL_free(job); |
101 | } | |
102 | } | |
103 | ||
252d6d3a | 104 | static ASYNC_JOB *async_get_pool_job(void) { |
a3667c31 | 105 | ASYNC_JOB *job; |
27949c35 | 106 | async_pool *pool; |
a3667c31 | 107 | |
224905f8 | 108 | pool = (async_pool *)CRYPTO_THREAD_get_local(&poolkey); |
252d6d3a | 109 | if (pool == NULL) { |
50108304 | 110 | /* |
252d6d3a | 111 | * Pool has not been initialised, so init with the defaults, i.e. |
9f078e19 | 112 | * no max size and no pre-created jobs |
50108304 | 113 | */ |
68487a9b | 114 | if (ASYNC_init_thread(0, 0) == 0) |
252d6d3a | 115 | return NULL; |
224905f8 | 116 | pool = (async_pool *)CRYPTO_THREAD_get_local(&poolkey); |
252d6d3a MC |
117 | } |
118 | ||
27949c35 | 119 | job = sk_ASYNC_JOB_pop(pool->jobs); |
252d6d3a MC |
120 | if (job == NULL) { |
121 | /* Pool is empty */ | |
27949c35 | 122 | if ((pool->max_size != 0) && (pool->curr_size >= pool->max_size)) |
252d6d3a | 123 | return NULL; |
0ff2b9ac | 124 | |
636ca4ff | 125 | job = async_job_new(); |
6e8ac508 VD |
126 | if (job != NULL) { |
127 | if (! async_fibre_makecontext(&job->fibrectx)) { | |
128 | async_job_free(job); | |
129 | return NULL; | |
130 | } | |
27949c35 | 131 | pool->curr_size++; |
252d6d3a MC |
132 | } |
133 | } | |
134 | return job; | |
135 | } | |
136 | ||
137 | static void async_release_job(ASYNC_JOB *job) { | |
27949c35 MC |
138 | async_pool *pool; |
139 | ||
224905f8 | 140 | pool = (async_pool *)CRYPTO_THREAD_get_local(&poolkey); |
e38565f5 | 141 | OPENSSL_free(job->funcargs); |
252d6d3a | 142 | job->funcargs = NULL; |
27949c35 | 143 | sk_ASYNC_JOB_push(pool->jobs, job); |
252d6d3a MC |
144 | } |
145 | ||
636ca4ff | 146 | void async_start_func(void) |
252d6d3a MC |
147 | { |
148 | ASYNC_JOB *job; | |
7b9f8f7f | 149 | async_ctx *ctx = async_get_ctx(); |
252d6d3a MC |
150 | |
151 | while (1) { | |
152 | /* Run the job */ | |
7b9f8f7f | 153 | job = ctx->currjob; |
252d6d3a MC |
154 | job->ret = job->func(job->funcargs); |
155 | ||
156 | /* Stop the job */ | |
157 | job->status = ASYNC_JOB_STOPPING; | |
e38565f5 | 158 | if (!async_fibre_swapcontext(&job->fibrectx, |
7b9f8f7f | 159 | &ctx->dispatcher, 1)) { |
252d6d3a | 160 | /* |
079a1a90 MC |
161 | * Should not happen. Getting here will close the thread...can't do |
162 | * much about it | |
252d6d3a | 163 | */ |
079a1a90 | 164 | ASYNCerr(ASYNC_F_ASYNC_START_FUNC, ASYNC_R_FAILED_TO_SWAP_CONTEXT); |
252d6d3a | 165 | } |
50108304 | 166 | } |
a3667c31 MC |
167 | } |
168 | ||
ff75a257 MC |
169 | int ASYNC_start_job(ASYNC_JOB **job, ASYNC_WAIT_CTX *wctx, int *ret, |
170 | int (*func)(void *), void *args, size_t size) | |
a3667c31 | 171 | { |
74a8acbd BE |
172 | async_ctx *ctx; |
173 | ||
174 | if (!OPENSSL_init_crypto(OPENSSL_INIT_ASYNC, NULL)) | |
175 | return ASYNC_ERR; | |
176 | ||
177 | ctx = async_get_ctx(); | |
7b9f8f7f MC |
178 | if (ctx == NULL) |
179 | ctx = async_ctx_new(); | |
74a8acbd | 180 | if (ctx == NULL) |
a3667c31 | 181 | return ASYNC_ERR; |
a3667c31 | 182 | |
74a8acbd | 183 | if (*job) |
7b9f8f7f | 184 | ctx->currjob = *job; |
a3667c31 | 185 | |
50108304 | 186 | for (;;) { |
7b9f8f7f MC |
187 | if (ctx->currjob != NULL) { |
188 | if (ctx->currjob->status == ASYNC_JOB_STOPPING) { | |
189 | *ret = ctx->currjob->ret; | |
ff75a257 | 190 | ctx->currjob->waitctx = NULL; |
7b9f8f7f MC |
191 | async_release_job(ctx->currjob); |
192 | ctx->currjob = NULL; | |
82676094 | 193 | *job = NULL; |
50108304 MC |
194 | return ASYNC_FINISH; |
195 | } | |
196 | ||
7b9f8f7f MC |
197 | if (ctx->currjob->status == ASYNC_JOB_PAUSING) { |
198 | *job = ctx->currjob; | |
199 | ctx->currjob->status = ASYNC_JOB_PAUSED; | |
200 | ctx->currjob = NULL; | |
50108304 MC |
201 | return ASYNC_PAUSE; |
202 | } | |
203 | ||
7b9f8f7f MC |
204 | if (ctx->currjob->status == ASYNC_JOB_PAUSED) { |
205 | ctx->currjob = *job; | |
50108304 | 206 | /* Resume previous job */ |
7b9f8f7f MC |
207 | if (!async_fibre_swapcontext(&ctx->dispatcher, |
208 | &ctx->currjob->fibrectx, 1)) { | |
079a1a90 MC |
209 | ASYNCerr(ASYNC_F_ASYNC_START_JOB, |
210 | ASYNC_R_FAILED_TO_SWAP_CONTEXT); | |
50108304 | 211 | goto err; |
079a1a90 | 212 | } |
50108304 MC |
213 | continue; |
214 | } | |
215 | ||
216 | /* Should not happen */ | |
079a1a90 | 217 | ASYNCerr(ASYNC_F_ASYNC_START_JOB, ERR_R_INTERNAL_ERROR); |
7b9f8f7f MC |
218 | async_release_job(ctx->currjob); |
219 | ctx->currjob = NULL; | |
82676094 | 220 | *job = NULL; |
50108304 | 221 | return ASYNC_ERR; |
a3667c31 MC |
222 | } |
223 | ||
50108304 | 224 | /* Start a new job */ |
74a8acbd | 225 | if ((ctx->currjob = async_get_pool_job()) == NULL) |
252d6d3a | 226 | return ASYNC_NO_JOBS; |
a3667c31 | 227 | |
e38565f5 | 228 | if (args != NULL) { |
7b9f8f7f MC |
229 | ctx->currjob->funcargs = OPENSSL_malloc(size); |
230 | if (ctx->currjob->funcargs == NULL) { | |
079a1a90 | 231 | ASYNCerr(ASYNC_F_ASYNC_START_JOB, ERR_R_MALLOC_FAILURE); |
7b9f8f7f MC |
232 | async_release_job(ctx->currjob); |
233 | ctx->currjob = NULL; | |
50108304 MC |
234 | return ASYNC_ERR; |
235 | } | |
7b9f8f7f | 236 | memcpy(ctx->currjob->funcargs, args, size); |
50108304 | 237 | } else { |
7b9f8f7f | 238 | ctx->currjob->funcargs = NULL; |
a3667c31 MC |
239 | } |
240 | ||
7b9f8f7f | 241 | ctx->currjob->func = func; |
ff75a257 | 242 | ctx->currjob->waitctx = wctx; |
7b9f8f7f MC |
243 | if (!async_fibre_swapcontext(&ctx->dispatcher, |
244 | &ctx->currjob->fibrectx, 1)) { | |
079a1a90 | 245 | ASYNCerr(ASYNC_F_ASYNC_START_JOB, ASYNC_R_FAILED_TO_SWAP_CONTEXT); |
50108304 | 246 | goto err; |
079a1a90 | 247 | } |
a3667c31 MC |
248 | } |
249 | ||
50108304 | 250 | err: |
7b9f8f7f MC |
251 | async_release_job(ctx->currjob); |
252 | ctx->currjob = NULL; | |
82676094 | 253 | *job = NULL; |
a3667c31 MC |
254 | return ASYNC_ERR; |
255 | } | |
256 | ||
a3667c31 MC |
257 | int ASYNC_pause_job(void) |
258 | { | |
259 | ASYNC_JOB *job; | |
7b9f8f7f | 260 | async_ctx *ctx = async_get_ctx(); |
a3667c31 | 261 | |
7b9f8f7f MC |
262 | if (ctx == NULL |
263 | || ctx->currjob == NULL | |
264 | || ctx->blocked) { | |
079a1a90 | 265 | /* |
05a6347f MC |
266 | * Could be we've deliberately not been started within a job so this is |
267 | * counted as success. | |
079a1a90 | 268 | */ |
05a6347f | 269 | return 1; |
079a1a90 | 270 | } |
a3667c31 | 271 | |
7b9f8f7f | 272 | job = ctx->currjob; |
a3667c31 MC |
273 | job->status = ASYNC_JOB_PAUSING; |
274 | ||
e8dfb5bf | 275 | if (!async_fibre_swapcontext(&job->fibrectx, |
7b9f8f7f | 276 | &ctx->dispatcher, 1)) { |
079a1a90 | 277 | ASYNCerr(ASYNC_F_ASYNC_PAUSE_JOB, ASYNC_R_FAILED_TO_SWAP_CONTEXT); |
a3667c31 MC |
278 | return 0; |
279 | } | |
ff75a257 MC |
280 | /* Reset counts of added and deleted fds */ |
281 | async_wait_ctx_reset_counts(job->waitctx); | |
a3667c31 MC |
282 | |
283 | return 1; | |
284 | } | |
285 | ||
27949c35 | 286 | static void async_empty_pool(async_pool *pool) |
d63de0eb MC |
287 | { |
288 | ASYNC_JOB *job; | |
289 | ||
27949c35 MC |
290 | if (!pool || !pool->jobs) |
291 | return; | |
292 | ||
d63de0eb | 293 | do { |
27949c35 | 294 | job = sk_ASYNC_JOB_pop(pool->jobs); |
636ca4ff | 295 | async_job_free(job); |
d63de0eb MC |
296 | } while (job); |
297 | } | |
298 | ||
7b9f8f7f | 299 | int async_init(void) |
68487a9b | 300 | { |
224905f8 MC |
301 | if (!CRYPTO_THREAD_init_local(&ctxkey, NULL)) |
302 | return 0; | |
303 | ||
304 | if (!CRYPTO_THREAD_init_local(&poolkey, NULL)) { | |
305 | CRYPTO_THREAD_cleanup_local(&ctxkey); | |
68487a9b | 306 | return 0; |
224905f8 | 307 | } |
68487a9b | 308 | |
68487a9b MC |
309 | return 1; |
310 | } | |
311 | ||
224905f8 MC |
312 | void async_deinit(void) |
313 | { | |
314 | CRYPTO_THREAD_cleanup_local(&ctxkey); | |
315 | CRYPTO_THREAD_cleanup_local(&poolkey); | |
316 | } | |
317 | ||
68487a9b | 318 | int ASYNC_init_thread(size_t max_size, size_t init_size) |
252d6d3a | 319 | { |
27949c35 | 320 | async_pool *pool; |
0ff2b9ac MC |
321 | size_t curr_size = 0; |
322 | ||
68487a9b MC |
323 | if (init_size > max_size) { |
324 | ASYNCerr(ASYNC_F_ASYNC_INIT_THREAD, ASYNC_R_INVALID_POOL_SIZE); | |
27949c35 MC |
325 | return 0; |
326 | } | |
327 | ||
74a8acbd | 328 | if (!OPENSSL_init_crypto(OPENSSL_INIT_ASYNC, NULL)) |
0fc32b07 | 329 | return 0; |
74a8acbd | 330 | |
6913f5fe | 331 | if (!ossl_init_thread_start(NULL, NULL, async_delete_thread_state)) |
22a34c2f | 332 | return 0; |
7b9f8f7f | 333 | |
cbe29648 | 334 | pool = OPENSSL_zalloc(sizeof(*pool)); |
252d6d3a | 335 | if (pool == NULL) { |
68487a9b | 336 | ASYNCerr(ASYNC_F_ASYNC_INIT_THREAD, ERR_R_MALLOC_FAILURE); |
252d6d3a MC |
337 | return 0; |
338 | } | |
27949c35 | 339 | |
7a908204 | 340 | pool->jobs = sk_ASYNC_JOB_new_reserve(NULL, init_size); |
27949c35 | 341 | if (pool->jobs == NULL) { |
68487a9b | 342 | ASYNCerr(ASYNC_F_ASYNC_INIT_THREAD, ERR_R_MALLOC_FAILURE); |
27949c35 MC |
343 | OPENSSL_free(pool); |
344 | return 0; | |
345 | } | |
346 | ||
347 | pool->max_size = max_size; | |
348 | ||
252d6d3a | 349 | /* Pre-create jobs as required */ |
6e8ac508 | 350 | while (init_size--) { |
252d6d3a | 351 | ASYNC_JOB *job; |
636ca4ff | 352 | job = async_job_new(); |
6e8ac508 | 353 | if (job == NULL || !async_fibre_makecontext(&job->fibrectx)) { |
252d6d3a | 354 | /* |
6e8ac508 VD |
355 | * Not actually fatal because we already created the pool, just |
356 | * skip creation of any more jobs | |
252d6d3a | 357 | */ |
6e8ac508 VD |
358 | async_job_free(job); |
359 | break; | |
252d6d3a | 360 | } |
6e8ac508 | 361 | job->funcargs = NULL; |
e431363f | 362 | sk_ASYNC_JOB_push(pool->jobs, job); /* Cannot fail due to reserve */ |
6e8ac508 | 363 | curr_size++; |
252d6d3a | 364 | } |
27949c35 | 365 | pool->curr_size = curr_size; |
224905f8 | 366 | if (!CRYPTO_THREAD_set_local(&poolkey, pool)) { |
68487a9b | 367 | ASYNCerr(ASYNC_F_ASYNC_INIT_THREAD, ASYNC_R_FAILED_TO_SET_POOL); |
27949c35 | 368 | goto err; |
d63de0eb | 369 | } |
0ff2b9ac | 370 | |
252d6d3a | 371 | return 1; |
27949c35 | 372 | err: |
74a8acbd BE |
373 | async_empty_pool(pool); |
374 | sk_ASYNC_JOB_free(pool->jobs); | |
375 | OPENSSL_free(pool); | |
27949c35 | 376 | return 0; |
252d6d3a MC |
377 | } |
378 | ||
da747958 MC |
379 | /* TODO(3.0): arg ignored for now */ |
380 | static void async_delete_thread_state(void *arg) | |
252d6d3a | 381 | { |
74a8acbd | 382 | async_pool *pool = (async_pool *)CRYPTO_THREAD_get_local(&poolkey); |
d63de0eb | 383 | |
74a8acbd BE |
384 | if (pool != NULL) { |
385 | async_empty_pool(pool); | |
386 | sk_ASYNC_JOB_free(pool->jobs); | |
387 | OPENSSL_free(pool); | |
388 | CRYPTO_THREAD_set_local(&poolkey, NULL); | |
389 | } | |
22a34c2f | 390 | async_local_cleanup(); |
636ca4ff | 391 | async_ctx_free(); |
252d6d3a | 392 | } |
f4da39d2 | 393 | |
68487a9b | 394 | void ASYNC_cleanup_thread(void) |
27949c35 | 395 | { |
74a8acbd BE |
396 | if (!OPENSSL_init_crypto(OPENSSL_INIT_ASYNC, NULL)) |
397 | return; | |
398 | ||
242f84d0 | 399 | async_delete_thread_state(NULL); |
27949c35 MC |
400 | } |
401 | ||
f4da39d2 MC |
402 | ASYNC_JOB *ASYNC_get_current_job(void) |
403 | { | |
636ca4ff | 404 | async_ctx *ctx; |
e38565f5 | 405 | |
74a8acbd BE |
406 | if (!OPENSSL_init_crypto(OPENSSL_INIT_ASYNC, NULL)) |
407 | return NULL; | |
408 | ||
e38565f5 | 409 | ctx = async_get_ctx(); |
e8aa8b6c | 410 | if (ctx == NULL) |
f4da39d2 MC |
411 | return NULL; |
412 | ||
413 | return ctx->currjob; | |
414 | } | |
415 | ||
ff75a257 | 416 | ASYNC_WAIT_CTX *ASYNC_get_wait_ctx(ASYNC_JOB *job) |
f4da39d2 | 417 | { |
ff75a257 | 418 | return job->waitctx; |
f4da39d2 | 419 | } |
e8dfb5bf MC |
420 | |
421 | void ASYNC_block_pause(void) | |
422 | { | |
74a8acbd BE |
423 | async_ctx *ctx; |
424 | ||
425 | if (!OPENSSL_init_crypto(OPENSSL_INIT_ASYNC, NULL)) | |
426 | return; | |
427 | ||
428 | ctx = async_get_ctx(); | |
7b9f8f7f | 429 | if (ctx == NULL || ctx->currjob == NULL) { |
e8dfb5bf MC |
430 | /* |
431 | * We're not in a job anyway so ignore this | |
432 | */ | |
433 | return; | |
434 | } | |
7b9f8f7f | 435 | ctx->blocked++; |
e8dfb5bf MC |
436 | } |
437 | ||
438 | void ASYNC_unblock_pause(void) | |
439 | { | |
74a8acbd BE |
440 | async_ctx *ctx; |
441 | ||
442 | if (!OPENSSL_init_crypto(OPENSSL_INIT_ASYNC, NULL)) | |
443 | return; | |
444 | ||
445 | ctx = async_get_ctx(); | |
7b9f8f7f | 446 | if (ctx == NULL || ctx->currjob == NULL) { |
e8dfb5bf MC |
447 | /* |
448 | * We're not in a job anyway so ignore this | |
449 | */ | |
450 | return; | |
451 | } | |
e8aa8b6c | 452 | if (ctx->blocked > 0) |
7b9f8f7f | 453 | ctx->blocked--; |
e8dfb5bf | 454 | } |