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