include/openssl/async.h

   1 /* include/openssl/async.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 #ifndef HEADER_ASYNC_H
  55 # define HEADER_ASYNC_H
  56
  57 #include <stdlib.h>
  58
  59 #if defined(_WIN32) || defined(__CYGWIN__)
  60 #include <windows.h>
  61 #define OSSL_ASYNC_FD   HANDLE
  62 #else
  63 #define OSSL_ASYNC_FD   int
  64 #endif
  65
  66
  67 # ifdef  __cplusplus
  68 extern "C" {
  69 # endif
  70
  71 typedef struct async_job_st ASYNC_JOB;
  72
  73 #define ASYNC_ERR      0
  74 #define ASYNC_NO_JOBS  1
  75 #define ASYNC_PAUSE    2
  76 #define ASYNC_FINISH   3
  77
  78 int ASYNC_init(int init_thread, size_t max_size, size_t init_size);
  79 void ASYNC_cleanup(int cleanupthread);
  80 int ASYNC_init_thread(size_t max_size, size_t init_size);
  81 void ASYNC_cleanup_thread(void);
  82
  83 int ASYNC_start_job(ASYNC_JOB **job, int *ret, int (*func)(void *),
  84                          void *args, size_t size);
  85 int ASYNC_pause_job(void);
  86
  87 OSSL_ASYNC_FD ASYNC_get_wait_fd(ASYNC_JOB *job);
  88 ASYNC_JOB *ASYNC_get_current_job(void);
  89 void ASYNC_wake(ASYNC_JOB *job);
  90 void ASYNC_clear_wake(ASYNC_JOB *job);
  91 void ASYNC_block_pause(void);
  92 void ASYNC_unblock_pause(void);
  93
  94 /* BEGIN ERROR CODES */
  95 /*
  96  * The following lines are auto generated by the script mkerr.pl. Any changes
  97  * made after this point may be overwritten when the script is next run.
  98  */
  99 void ERR_load_ASYNC_strings(void);
 100
 101 /* Error codes for the ASYNC functions. */
 102
 103 /* Function codes. */
 104 # define ASYNC_F_ASYNC_CTX_NEW                            100
 105 # define ASYNC_F_ASYNC_INIT_THREAD                        101
 106 # define ASYNC_F_ASYNC_JOB_NEW                            102
 107 # define ASYNC_F_ASYNC_PAUSE_JOB                          103
 108 # define ASYNC_F_ASYNC_START_FUNC                         104
 109 # define ASYNC_F_ASYNC_START_JOB                          105
 110
 111 /* Reason codes. */
 112 # define ASYNC_R_CANNOT_CREATE_WAIT_PIPE                  100
 113 # define ASYNC_R_FAILED_TO_SET_POOL                       101
 114 # define ASYNC_R_FAILED_TO_SWAP_CONTEXT                   102
 115 # define ASYNC_R_INIT_FAILED                              105
 116 # define ASYNC_R_INVALID_POOL_SIZE                        103
 117 # define ASYNC_R_POOL_ALREADY_INITED                      104
 118
 119 #ifdef  __cplusplus
 120 }
 121 #endif
 122 #endif