Implement new multi-threading API
[openssl.git] / include / internal / threads.h
1 /* ====================================================================
2  * Copyright (c) 2016 The OpenSSL Project.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  *
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in
13  *    the documentation and/or other materials provided with the
14  *    distribution.
15  *
16  * 3. All advertising materials mentioning features or use of this
17  *    software must display the following acknowledgment:
18  *    "This product includes software developed by the OpenSSL Project
19  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
20  *
21  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
22  *    endorse or promote products derived from this software without
23  *    prior written permission. For written permission, please contact
24  *    licensing@OpenSSL.org.
25  *
26  * 5. Products derived from this software may not be called "OpenSSL"
27  *    nor may "OpenSSL" appear in their names without prior written
28  *    permission of the OpenSSL Project.
29  *
30  * 6. Redistributions of any form whatsoever must retain the following
31  *    acknowledgment:
32  *    "This product includes software developed by the OpenSSL Project
33  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
34  *
35  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
36  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
37  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
38  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
39  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
41  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
42  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
43  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
44  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
45  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
46  * OF THE POSSIBILITY OF SUCH DAMAGE.
47  */
48
49 #ifndef HEADER_INTERNAL_THREADS_H
50 # define HEADER_INTERNAL_THREADS_H
51
52 #include "e_os.h"
53
54 # if !defined(OPENSSL_THREADS) || defined(CRYPTO_TDEBUG)
55 typedef unsigned int CRYPTO_ONCE;
56 typedef unsigned int CRYPTO_THREAD_LOCAL;
57 typedef unsigned int CRYPTO_THREAD_ID;
58
59 #  define CRYPTO_ONCE_STATIC_INIT 0
60 # elif defined(OPENSSL_SYS_WINDOWS)
61 #  include <windows.h>
62 typedef DWORD CRYPTO_THREAD_LOCAL;
63 typedef DWORD CRYPTO_THREAD_ID;
64
65 #  if _WIN32_WINNT < 0x0600
66 typedef LONG CRYPTO_ONCE;
67 #   define CRYPTO_ONCE_STATIC_INIT 0
68 #  else
69 typedef INIT_ONCE CRYPTO_ONCE;
70 #   define CRYPTO_ONCE_STATIC_INIT INIT_ONCE_STATIC_INIT
71 #  endif
72
73 # else
74 #  include <pthread.h>
75 typedef pthread_once_t CRYPTO_ONCE;
76 typedef pthread_key_t CRYPTO_THREAD_LOCAL;
77 typedef pthread_t CRYPTO_THREAD_ID;
78
79 #  define CRYPTO_ONCE_STATIC_INIT PTHREAD_ONCE_INIT
80 # endif
81
82 int CRYPTO_THREAD_run_once(CRYPTO_ONCE *once, void (*init)(void));
83
84 int CRYPTO_THREAD_init_local(CRYPTO_THREAD_LOCAL *key, void (*cleanup)(void *));
85 void *CRYPTO_THREAD_get_local(CRYPTO_THREAD_LOCAL *key);
86 int CRYPTO_THREAD_set_local(CRYPTO_THREAD_LOCAL *key, void *val);
87 int CRYPTO_THREAD_cleanup_local(CRYPTO_THREAD_LOCAL *key);
88
89 CRYPTO_THREAD_ID CRYPTO_THREAD_get_current_id(void);
90 int CRYPTO_THREAD_compare_id(CRYPTO_THREAD_ID a, CRYPTO_THREAD_ID b);
91
92 #endif