afa45cd76cdaea221fae73bce0e09ea89b7c8554
[openssl.git] / 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. It is not
69 needed on Windows nor on platforms where getpid() returns a different
70 ID for each thread (most notably Linux).
71
72 Additionally, OpenSSL supports dynamic locks, and sometimes, some parts
73 of OpenSSL need it for better performance.  To enable this, the following
74 is required:
75
76 =over 4
77
78 =item *
79 Three additional callback function, dyn_create_function, dyn_lock_function
80 and dyn_destroy_function.
81
82 =item *
83 A structure defined with the data that each lock needs to handle.
84
85 =back
86
87 struct CRYPTO_dynlock_value has to be defined to contain whatever structure
88 is needed to handle locks.
89
90 dyn_create_function(const char *file, int line) is needed to create a
91 lock.  Multi-threaded applications might crash at random if it is not set.
92
93 dyn_lock_function(int mode, CRYPTO_dynlock *l, const char *file, int line)
94 is needed to perform locking off dynamic lock numbered n. Multi-threaded
95 applications might crash at random if it is not set.
96
97 dyn_destroy_function(CRYPTO_dynlock *l, const char *file, int line) is
98 needed to destroy the lock l. Multi-threaded applications might crash at
99 random if it is not set.
100
101 CRYPTO_get_new_dynlockid() is used to create locks.  It will call
102 dyn_create_function for the actual creation.
103
104 CRYPTO_destroy_dynlockid() is used to destroy locks.  It will call
105 dyn_destroy_function for the actual destruction.
106
107 CRYPTO_lock() is used to lock and unlock the locks.  mode is a bitfield
108 describing what should be done with the lock.  n is the number of the
109 lock as returned from CRYPTO_get_new_dynlockid().  mode can be combined
110 from the following values.  These values are pairwise exclusive, with
111 undefined behaviour if misused (for example, CRYPTO_READ and CRYPTO_WRITE
112 should not be used together):
113
114         CRYPTO_LOCK     0x01
115         CRYPTO_UNLOCK   0x02
116         CRYPTO_READ     0x04
117         CRYPTO_WRITE    0x08
118
119 =head1 RETURN VALUES
120
121 CRYPTO_num_locks() returns the required number of locks.
122
123 CRYPTO_get_new_dynlockid() returns the index to the newly created lock.
124
125 The other functions return no values.
126
127 =head1 NOTE
128
129 You can find out if OpenSSL was configured with thread support:
130
131  #define OPENSSL_THREAD_DEFINES
132  #include <openssl/opensslconf.h>
133  #if defined(THREADS)
134    // thread support enabled
135  #else
136    // no thread support
137  #endif
138
139 Also, dynamic locks are currently not used internally by OpenSSL, but
140 may do so in the future.
141
142 =head1 EXAMPLES
143
144 B<crypto/threads/mttest.c> shows examples of the callback functions on
145 Solaris, Irix and Win32.
146
147 =head1 HISTORY
148
149 CRYPTO_set_locking_callback() and CRYPTO_set_id_callback() are
150 available in all versions of SSLeay and OpenSSL.
151 CRYPTO_num_locks() was added in OpenSSL 0.9.4.
152 All functions dealing with dynamic locks were added in OpenSSL 0.9.5b-dev.
153
154 =head1 SEE ALSO
155
156 L<crypto(3)|crypto(3)>
157
158 =cut