crypto/openssl/doc/crypto/threads.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 CRYPTO_set_locking_callback, CRYPTO_set_id_callback, CRYPTO_num_locks,
   6 CRYPTO_set_dynlock_create_callback, CRYPTO_set_dynlock_lock_callback,
   7 CRYPTO_set_dynlock_destroy_callback, CRYPTO_get_new_dynlockid,
   8 CRYPTO_destroy_dynlockid, CRYPTO_lock - OpenSSL thread support
   9
  10 =head1 SYNOPSIS
  11
  12  #include <openssl/crypto.h>
  13
  14  void CRYPTO_set_locking_callback(void (*locking_function)(int mode,
  15         int n, const char *file, int line));
  16
  17  void CRYPTO_set_id_callback(unsigned long (*id_function)(void));
  18
  19  int CRYPTO_num_locks(void);
  20
  21
  22  /* struct CRYPTO_dynlock_value needs to be defined by the user */
  23  struct CRYPTO_dynlock_value;
  24
  25  void CRYPTO_set_dynlock_create_callback(struct CRYPTO_dynlock_value *
  26         (*dyn_create_function)(char *file, int line));
  27  void CRYPTO_set_dynlock_lock_callback(void (*dyn_lock_function)
  28         (int mode, struct CRYPTO_dynlock_value *l,
  29         const char *file, int line));
  30  void CRYPTO_set_dynlock_destroy_callback(void (*dyn_destroy_function)
  31         (struct CRYPTO_dynlock_value *l, const char *file, int line));
  32
  33  int CRYPTO_get_new_dynlockid(void);
  34
  35  void CRYPTO_destroy_dynlockid(int i);
  36
  37  void CRYPTO_lock(int mode, int n, const char *file, int line);
  38
  39  #define CRYPTO_w_lock(type)    \
  40         CRYPTO_lock(CRYPTO_LOCK|CRYPTO_WRITE,type,__FILE__,__LINE__)
  41  #define CRYPTO_w_unlock(type)  \
  42         CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_WRITE,type,__FILE__,__LINE__)
  43  #define CRYPTO_r_lock(type)    \
  44         CRYPTO_lock(CRYPTO_LOCK|CRYPTO_READ,type,__FILE__,__LINE__)
  45  #define CRYPTO_r_unlock(type)  \
  46         CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_READ,type,__FILE__,__LINE__)
  47  #define CRYPTO_add(addr,amount,type)   \
  48         CRYPTO_add_lock(addr,amount,type,__FILE__,__LINE__)
  49
  50 =head1 DESCRIPTION
  51
  52 OpenSSL can safely be used in multi-threaded applications provided
  53 that at least two callback functions are set.
  54
  55 locking_function(int mode, int n, const char *file, int line) is
  56 needed to perform locking on shared data structures.
  57 (Note that OpenSSL uses a number of global data structures that
  58 will be implicitly shared whenever multiple threads use OpenSSL.)
  59 Multi-threaded applications will crash at random if it is not set.
  60
  61 locking_function() must be able to handle up to CRYPTO_num_locks()
  62 different mutex locks. It sets the B<n>-th lock if B<mode> &
  63 B<CRYPTO_LOCK>, and releases it otherwise.
  64
  65 B<file> and B<line> are the file number of the function setting the
  66 lock. They can be useful for debugging.
  67
  68 id_function(void) is a function that returns a thread ID, for example
  69 pthread_self() if it returns an integer (see NOTES below).  It isn't
  70 needed on Windows nor on platforms where getpid() returns a different
  71 ID for each thread (see NOTES below).
  72
  73 Additionally, OpenSSL supports dynamic locks, and sometimes, some parts
  74 of OpenSSL need it for better performance.  To enable this, the following
  75 is required:
  76
  77 =over 4
  78
  79 =item *
  80 Three additional callback function, dyn_create_function, dyn_lock_function
  81 and dyn_destroy_function.
  82
  83 =item *
  84 A structure defined with the data that each lock needs to handle.
  85
  86 =back
  87
  88 struct CRYPTO_dynlock_value has to be defined to contain whatever structure
  89 is needed to handle locks.
  90
  91 dyn_create_function(const char *file, int line) is needed to create a
  92 lock.  Multi-threaded applications might crash at random if it is not set.
  93
  94 dyn_lock_function(int mode, CRYPTO_dynlock *l, const char *file, int line)
  95 is needed to perform locking off dynamic lock numbered n. Multi-threaded
  96 applications might crash at random if it is not set.
  97
  98 dyn_destroy_function(CRYPTO_dynlock *l, const char *file, int line) is
  99 needed to destroy the lock l. Multi-threaded applications might crash at
 100 random if it is not set.
 101
 102 CRYPTO_get_new_dynlockid() is used to create locks.  It will call
 103 dyn_create_function for the actual creation.
 104
 105 CRYPTO_destroy_dynlockid() is used to destroy locks.  It will call
 106 dyn_destroy_function for the actual destruction.
 107
 108 CRYPTO_lock() is used to lock and unlock the locks.  mode is a bitfield
 109 describing what should be done with the lock.  n is the number of the
 110 lock as returned from CRYPTO_get_new_dynlockid().  mode can be combined
 111 from the following values.  These values are pairwise exclusive, with
 112 undefined behaviour if misused (for example, CRYPTO_READ and CRYPTO_WRITE
 113 should not be used together):
 114
 115         CRYPTO_LOCK     0x01
 116         CRYPTO_UNLOCK   0x02
 117         CRYPTO_READ     0x04
 118         CRYPTO_WRITE    0x08
 119
 120 =head1 RETURN VALUES
 121
 122 CRYPTO_num_locks() returns the required number of locks.
 123
 124 CRYPTO_get_new_dynlockid() returns the index to the newly created lock.
 125
 126 The other functions return no values.
 127
 128 =head1 NOTES
 129
 130 You can find out if OpenSSL was configured with thread support:
 131
 132  #define OPENSSL_THREAD_DEFINES
 133  #include <openssl/opensslconf.h>
 134  #if defined(OPENSSL_THREADS)
 135    // thread support enabled
 136  #else
 137    // no thread support
 138  #endif
 139
 140 Also, dynamic locks are currently not used internally by OpenSSL, but
 141 may do so in the future.
 142
 143 Defining id_function(void) has it's own issues.  Generally speaking,
 144 pthread_self() should be used, even on platforms where getpid() gives
 145 different answers in each thread, since that may depend on the machine
 146 the program is run on, not the machine where the program is being
 147 compiled.  For instance, Red Hat 8 Linux and earlier used
 148 LinuxThreads, whose getpid() returns a different value for each
 149 thread.  Red Hat 9 Linux and later use NPTL, which is
 150 Posix-conformant, and has a getpid() that returns the same value for
 151 all threads in a process.  A program compiled on Red Hat 8 and run on
 152 Red Hat 9 will therefore see getpid() returning the same value for
 153 all threads.
 154
 155 There is still the issue of platforms where pthread_self() returns
 156 something other than an integer.  This is a bit unusual, and this
 157 manual has no cookbook solution for that case.
 158
 159 =head1 EXAMPLES
 160
 161 B<crypto/threads/mttest.c> shows examples of the callback functions on
 162 Solaris, Irix and Win32.
 163
 164 =head1 HISTORY
 165
 166 CRYPTO_set_locking_callback() and CRYPTO_set_id_callback() are
 167 available in all versions of SSLeay and OpenSSL.
 168 CRYPTO_num_locks() was added in OpenSSL 0.9.4.
 169 All functions dealing with dynamic locks were added in OpenSSL 0.9.5b-dev.
 170
 171 =head1 SEE ALSO
 172
 173 L<crypto(3)|crypto(3)>
 174
 175 =cut