crypto/thr_id.c

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