Refactor the async wait fd logic
[openssl.git] / crypto / async / async_locl.h
1 /*
2  * Written by Matt Caswell (matt@openssl.org) for the OpenSSL project.
3  */
4 /* ====================================================================
5  * Copyright (c) 2015 The OpenSSL Project.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  *
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in
16  *    the documentation and/or other materials provided with the
17  *    distribution.
18  *
19  * 3. All advertising materials mentioning features or use of this
20  *    software must display the following acknowledgment:
21  *    "This product includes software developed by the OpenSSL Project
22  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
23  *
24  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
25  *    endorse or promote products derived from this software without
26  *    prior written permission. For written permission, please contact
27  *    licensing@OpenSSL.org.
28  *
29  * 5. Products derived from this software may not be called "OpenSSL"
30  *    nor may "OpenSSL" appear in their names without prior written
31  *    permission of the OpenSSL Project.
32  *
33  * 6. Redistributions of any form whatsoever must retain the following
34  *    acknowledgment:
35  *    "This product includes software developed by the OpenSSL Project
36  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
37  *
38  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
39  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
40  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
41  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
42  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
43  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
44  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
45  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
46  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
47  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
48  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
49  * OF THE POSSIBILITY OF SUCH DAMAGE.
50  * ====================================================================
51  */
52
53 /*
54  * Must do this before including any header files, because on MacOS/X <stlib.h>
55  * includes <signal.h> which includes <ucontext.h>
56  */
57 #if defined(__APPLE__) && defined(__MACH__) && !defined(_XOPEN_SOURCE)
58 # define _XOPEN_SOURCE          /* Otherwise incomplete ucontext_t structure */
59 # pragma GCC diagnostic ignored "-Wdeprecated-declarations"
60 #endif
61
62 #include <internal/async.h>
63 #include <openssl/crypto.h>
64
65 typedef struct async_ctx_st async_ctx;
66 typedef struct async_pool_st async_pool;
67
68 #include "arch/async_win.h"
69 #include "arch/async_posix.h"
70 #include "arch/async_null.h"
71
72 struct async_ctx_st {
73     async_fibre dispatcher;
74     ASYNC_JOB *currjob;
75     unsigned int blocked;
76 };
77
78 struct async_job_st {
79     async_fibre fibrectx;
80     int (*func) (void *);
81     void *funcargs;
82     int ret;
83     int status;
84     ASYNC_WAIT_CTX *waitctx;
85 };
86
87 struct fd_lookup_st {
88     const void *key;
89     OSSL_ASYNC_FD fd;
90     void *custom_data;
91     void (*cleanup)(ASYNC_WAIT_CTX *, const void *, OSSL_ASYNC_FD, void *);
92     int add;
93     int del;
94     struct fd_lookup_st *next;
95 };
96
97 struct async_wait_ctx_st {
98     struct fd_lookup_st *fds;
99     size_t numadd;
100     size_t numdel;
101 };
102
103 DEFINE_STACK_OF(ASYNC_JOB)
104
105 struct async_pool_st {
106     STACK_OF(ASYNC_JOB) *jobs;
107     size_t curr_size;
108     size_t max_size;
109 };
110
111 int async_global_init(void);
112 void async_local_cleanup(void);
113 void async_global_cleanup(void);
114 void async_start_func(void);
115
116 void async_wait_ctx_reset_counts(ASYNC_WAIT_CTX *ctx);
117