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