Backwards-compatibility subject to OPENSSL_API_COMPAT
[openssl.git] / crypto / thr_id.c
1 /* crypto/cryptlib.c */
2 /* ====================================================================
3  * Copyright (c) 1998-2006 The OpenSSL Project.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  *
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in
14  *    the documentation and/or other materials provided with the
15  *    distribution.
16  *
17  * 3. All advertising materials mentioning features or use of this
18  *    software must display the following acknowledgment:
19  *    "This product includes software developed by the OpenSSL Project
20  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
21  *
22  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
23  *    endorse or promote products derived from this software without
24  *    prior written permission. For written permission, please contact
25  *    openssl-core@openssl.org.
26  *
27  * 5. Products derived from this software may not be called "OpenSSL"
28  *    nor may "OpenSSL" appear in their names without prior written
29  *    permission of the OpenSSL Project.
30  *
31  * 6. Redistributions of any form whatsoever must retain the following
32  *    acknowledgment:
33  *    "This product includes software developed by the OpenSSL Project
34  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
35  *
36  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
37  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
38  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
39  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
40  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
42  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
43  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
44  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
45  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
46  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
47  * OF THE POSSIBILITY OF SUCH DAMAGE.
48  * ====================================================================
49  *
50  * This product includes cryptographic software written by Eric Young
51  * (eay@cryptsoft.com).  This product includes software written by Tim
52  * Hudson (tjh@cryptsoft.com).
53  *
54  */
55 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
56  * All rights reserved.
57  *
58  * This package is an SSL implementation written
59  * by Eric Young (eay@cryptsoft.com).
60  * The implementation was written so as to conform with Netscapes SSL.
61  *
62  * This library is free for commercial and non-commercial use as long as
63  * the following conditions are aheared to.  The following conditions
64  * apply to all code found in this distribution, be it the RC4, RSA,
65  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
66  * included with this distribution is covered by the same copyright terms
67  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
68  *
69  * Copyright remains Eric Young's, and as such any Copyright notices in
70  * the code are not to be removed.
71  * If this package is used in a product, Eric Young should be given attribution
72  * as the author of the parts of the library used.
73  * This can be in the form of a textual message at program startup or
74  * in documentation (online or textual) provided with the package.
75  *
76  * Redistribution and use in source and binary forms, with or without
77  * modification, are permitted provided that the following conditions
78  * are met:
79  * 1. Redistributions of source code must retain the copyright
80  *    notice, this list of conditions and the following disclaimer.
81  * 2. Redistributions in binary form must reproduce the above copyright
82  *    notice, this list of conditions and the following disclaimer in the
83  *    documentation and/or other materials provided with the distribution.
84  * 3. All advertising materials mentioning features or use of this software
85  *    must display the following acknowledgement:
86  *    "This product includes cryptographic software written by
87  *     Eric Young (eay@cryptsoft.com)"
88  *    The word 'cryptographic' can be left out if the rouines from the library
89  *    being used are not cryptographic related :-).
90  * 4. If you include any Windows specific code (or a derivative thereof) from
91  *    the apps directory (application code) you must include an acknowledgement:
92  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
93  *
94  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
95  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
96  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
97  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
98  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
99  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
100  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
101  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
102  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
103  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
104  * SUCH DAMAGE.
105  *
106  * The licence and distribution terms for any publically available version or
107  * derivative of this code cannot be changed.  i.e. this code cannot simply be
108  * copied and put under another distribution licence
109  * [including the GNU Public Licence.]
110  */
111 /* ====================================================================
112  * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
113  * ECDH support in OpenSSL originally developed by
114  * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
115  */
116
117 #include "internal/cryptlib.h"
118 #include <openssl/opensslconf.h>
119
120 #if OPENSSL_API_COMPAT < 0x10000000L
121 static unsigned long (*id_callback) (void) = 0;
122 #endif
123 static void (*threadid_callback) (CRYPTO_THREADID *) = 0;
124
125 /*
126  * the memset() here and in set_pointer() seem overkill, but for the sake of
127  * CRYPTO_THREADID_cmp() this avoids any platform silliness that might cause
128  * two "equal" THREADID structs to not be memcmp()-identical.
129  */
130 void CRYPTO_THREADID_set_numeric(CRYPTO_THREADID *id, unsigned long val)
131 {
132     memset(id, 0, sizeof(*id));
133     id->val = val;
134 }
135
136 static const unsigned char hash_coeffs[] = { 3, 5, 7, 11, 13, 17, 19, 23 };
137
138 void CRYPTO_THREADID_set_pointer(CRYPTO_THREADID *id, void *ptr)
139 {
140     unsigned char *dest = (void *)&id->val;
141     unsigned int accum = 0;
142     unsigned char dnum = sizeof(id->val);
143
144     memset(id, 0, sizeof(*id));
145     id->ptr = ptr;
146     if (sizeof(id->val) >= sizeof(id->ptr)) {
147         /*
148          * 'ptr' can be embedded in 'val' without loss of uniqueness
149          */
150         id->val = (size_t)id->ptr;
151         return;
152     }
153     /*
154      * hash ptr ==> val. Each byte of 'val' gets the mod-256 total of a
155      * linear function over the bytes in 'ptr', the co-efficients of which
156      * are a sequence of low-primes (hash_coeffs is an 8-element cycle) - the
157      * starting prime for the sequence varies for each byte of 'val' (unique
158      * polynomials unless pointers are >64-bit). For added spice, the totals
159      * accumulate rather than restarting from zero, and the index of the
160      * 'val' byte is added each time (position dependence). If I was a
161      * black-belt, I'd scan big-endian pointers in reverse to give low-order
162      * bits more play, but this isn't crypto and I'd prefer nobody mistake it
163      * as such. Plus I'm lazy.
164      */
165     while (dnum--) {
166         const unsigned char *src = (void *)&id->ptr;
167         unsigned char snum = sizeof(id->ptr);
168         while (snum--)
169             accum += *(src++) * hash_coeffs[(snum + dnum) & 7];
170         accum += dnum;
171         *(dest++) = accum & 255;
172     }
173 }
174
175 int CRYPTO_THREADID_set_callback(void (*func) (CRYPTO_THREADID *))
176 {
177     if (threadid_callback)
178         return 0;
179     threadid_callback = func;
180     return 1;
181 }
182
183 void (*CRYPTO_THREADID_get_callback(void)) (CRYPTO_THREADID *) {
184     return threadid_callback;
185 }
186
187 void CRYPTO_THREADID_current(CRYPTO_THREADID *id)
188 {
189     if (threadid_callback) {
190         threadid_callback(id);
191         return;
192     }
193 #if OPENSSL_API_COMPAT < 0x10000000L
194     /* If the deprecated callback was set, fall back to that */
195     if (id_callback) {
196         CRYPTO_THREADID_set_numeric(id, id_callback());
197         return;
198     }
199 #endif
200     /* Else pick a backup */
201 #if defined(OPENSSL_SYS_WIN32)
202     CRYPTO_THREADID_set_numeric(id, (unsigned long)GetCurrentThreadId());
203 #else
204     /* For everything else, default to using the address of 'errno' */
205     CRYPTO_THREADID_set_pointer(id, (void *)&errno);
206 #endif
207 }
208
209 int CRYPTO_THREADID_cmp(const CRYPTO_THREADID *a, const CRYPTO_THREADID *b)
210 {
211     return memcmp(a, b, sizeof(*a));
212 }
213
214 void CRYPTO_THREADID_cpy(CRYPTO_THREADID *dest, const CRYPTO_THREADID *src)
215 {
216     memcpy(dest, src, sizeof(*src));
217 }
218
219 unsigned long CRYPTO_THREADID_hash(const CRYPTO_THREADID *id)
220 {
221     return id->val;
222 }
223
224 #if OPENSSL_API_COMPAT < 0x10000000L
225 unsigned long (*CRYPTO_get_id_callback(void)) (void) {
226     return (id_callback);
227 }
228
229 void CRYPTO_set_id_callback(unsigned long (*func) (void))
230 {
231     id_callback = func;
232 }
233
234 unsigned long CRYPTO_thread_id(void)
235 {
236     unsigned long ret = 0;
237
238     if (id_callback == NULL) {
239 # if defined(OPENSSL_SYS_WIN32)
240         ret = (unsigned long)GetCurrentThreadId();
241 # elif defined(GETPID_IS_MEANINGLESS)
242         ret = 1L;
243 # else
244         ret = (unsigned long)getpid();
245 # endif
246     } else
247         ret = id_callback();
248     return (ret);
249 }
250 #endif