2 * Written by Matt Caswell (matt@openssl.org) for the OpenSSL project.
4 /* ====================================================================
5 * Copyright (c) 2015 The OpenSSL Project. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
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
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/)"
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.
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.
33 * 6. Redistributions of any form whatsoever must retain the following
35 * "This product includes software developed by the OpenSSL Project
36 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
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 * ====================================================================
55 #ifndef HEADER_ASYNC_H
56 # define HEADER_ASYNC_H
60 #define OSSL_ASYNC_FD HANDLE
61 #define OSSL_BAD_ASYNC_FD INVALID_HANDLE_VALUE
63 #define OSSL_ASYNC_FD int
64 #define OSSL_BAD_ASYNC_FD -1
72 typedef struct async_job_st ASYNC_JOB;
73 typedef struct async_wait_ctx_st ASYNC_WAIT_CTX;
76 #define ASYNC_NO_JOBS 1
78 #define ASYNC_FINISH 3
80 int ASYNC_init_thread(size_t max_size, size_t init_size);
81 void ASYNC_cleanup_thread(void);
83 ASYNC_WAIT_CTX *ASYNC_WAIT_CTX_new(void);
84 void ASYNC_WAIT_CTX_free(ASYNC_WAIT_CTX *ctx);
85 int ASYNC_WAIT_CTX_set_wait_fd(ASYNC_WAIT_CTX *ctx, const void *key,
88 void (*cleanup)(ASYNC_WAIT_CTX *, const void *,
89 OSSL_ASYNC_FD, void *));
90 int ASYNC_WAIT_CTX_get_fd(ASYNC_WAIT_CTX *ctx, const void *key,
91 OSSL_ASYNC_FD *fd, void **custom_data);
92 int ASYNC_WAIT_CTX_get_all_fds(ASYNC_WAIT_CTX *ctx, OSSL_ASYNC_FD *fd,
94 int ASYNC_WAIT_CTX_get_changed_fds(ASYNC_WAIT_CTX *ctx, OSSL_ASYNC_FD *addfd,
95 size_t *numaddfds, OSSL_ASYNC_FD *delfd,
97 int ASYNC_WAIT_CTX_clear_fd(ASYNC_WAIT_CTX *ctx, const void *key);
99 int ASYNC_is_capable(void);
101 int ASYNC_start_job(ASYNC_JOB **job, ASYNC_WAIT_CTX *ctx, int *ret,
102 int (*func)(void *), void *args, size_t size);
103 int ASYNC_pause_job(void);
105 ASYNC_JOB *ASYNC_get_current_job(void);
106 ASYNC_WAIT_CTX *ASYNC_get_wait_ctx(ASYNC_JOB *job);
107 void ASYNC_block_pause(void);
108 void ASYNC_unblock_pause(void);
110 /* BEGIN ERROR CODES */
112 * The following lines are auto generated by the script mkerr.pl. Any changes
113 * made after this point may be overwritten when the script is next run.
115 void ERR_load_ASYNC_strings(void);
117 /* Error codes for the ASYNC functions. */
119 /* Function codes. */
120 # define ASYNC_F_ASYNC_CTX_NEW 100
121 # define ASYNC_F_ASYNC_INIT_THREAD 101
122 # define ASYNC_F_ASYNC_JOB_NEW 102
123 # define ASYNC_F_ASYNC_PAUSE_JOB 103
124 # define ASYNC_F_ASYNC_START_FUNC 104
125 # define ASYNC_F_ASYNC_START_JOB 105
128 # define ASYNC_R_CANNOT_CREATE_WAIT_PIPE 100
129 # define ASYNC_R_FAILED_TO_SET_POOL 101
130 # define ASYNC_R_FAILED_TO_SWAP_CONTEXT 102
131 # define ASYNC_R_INIT_FAILED 105
132 # define ASYNC_R_INVALID_POOL_SIZE 103
133 # define ASYNC_R_POOL_ALREADY_INITED 104