include/openssl/async.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 #include <stdlib.h>
  54
  55 #ifndef HEADER_ASYNC_H
  56 # define HEADER_ASYNC_H
  57
  58 #if defined(_WIN32)
  59 #include <windows.h>
  60 #define OSSL_ASYNC_FD       HANDLE
  61 #define OSSL_BAD_ASYNC_FD   INVALID_HANDLE_VALUE
  62 #else
  63 #define OSSL_ASYNC_FD       int
  64 #define OSSL_BAD_ASYNC_FD   -1
  65 #endif
  66
  67
  68 # ifdef  __cplusplus
  69 extern "C" {
  70 # endif
  71
  72 typedef struct async_job_st ASYNC_JOB;
  73 typedef struct async_wait_ctx_st ASYNC_WAIT_CTX;
  74
  75 #define ASYNC_ERR      0
  76 #define ASYNC_NO_JOBS  1
  77 #define ASYNC_PAUSE    2
  78 #define ASYNC_FINISH   3
  79
  80 int ASYNC_init_thread(size_t max_size, size_t init_size);
  81 void ASYNC_cleanup_thread(void);
  82
  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,
  86                                OSSL_ASYNC_FD fd,
  87                                void *custom_data,
  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,
  93                                size_t *numfds);
  94 int ASYNC_WAIT_CTX_get_changed_fds(ASYNC_WAIT_CTX *ctx, OSSL_ASYNC_FD *addfd,
  95                                    size_t *numaddfds, OSSL_ASYNC_FD *delfd,
  96                                    size_t *numdelfds);
  97 int ASYNC_WAIT_CTX_clear_fd(ASYNC_WAIT_CTX *ctx, const void *key);
  98
  99 int ASYNC_start_job(ASYNC_JOB **job, ASYNC_WAIT_CTX *ctx, int *ret,
 100                     int (*func)(void *), void *args, size_t size);
 101 int ASYNC_pause_job(void);
 102
 103 ASYNC_JOB *ASYNC_get_current_job(void);
 104 ASYNC_WAIT_CTX *ASYNC_get_wait_ctx(ASYNC_JOB *job);
 105 void ASYNC_block_pause(void);
 106 void ASYNC_unblock_pause(void);
 107
 108 /* BEGIN ERROR CODES */
 109 /*
 110  * The following lines are auto generated by the script mkerr.pl. Any changes
 111  * made after this point may be overwritten when the script is next run.
 112  */
 113 void ERR_load_ASYNC_strings(void);
 114
 115 /* Error codes for the ASYNC functions. */
 116
 117 /* Function codes. */
 118 # define ASYNC_F_ASYNC_CTX_NEW                            100
 119 # define ASYNC_F_ASYNC_INIT_THREAD                        101
 120 # define ASYNC_F_ASYNC_JOB_NEW                            102
 121 # define ASYNC_F_ASYNC_PAUSE_JOB                          103
 122 # define ASYNC_F_ASYNC_START_FUNC                         104
 123 # define ASYNC_F_ASYNC_START_JOB                          105
 124
 125 /* Reason codes. */
 126 # define ASYNC_R_CANNOT_CREATE_WAIT_PIPE                  100
 127 # define ASYNC_R_FAILED_TO_SET_POOL                       101
 128 # define ASYNC_R_FAILED_TO_SWAP_CONTEXT                   102
 129 # define ASYNC_R_INIT_FAILED                              105
 130 # define ASYNC_R_INVALID_POOL_SIZE                        103
 131 # define ASYNC_R_POOL_ALREADY_INITED                      104
 132
 133 #ifdef  __cplusplus
 134 }
 135 #endif
 136 #endif