| blob | e6e698b39ebf2243952f4e9c126f22ab05c8893f |
1 .\" $NetBSD: openssl_threads.3,v 1.14 2015/06/12 17:01:15 christos Exp $
2 .\"
3 .\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
4 .\"
5 .\" Standard preamble:
6 .\" ========================================================================
7 .de Sp \" Vertical space (when we can't use .PP)
8 .if t .sp .5v
9 .if n .sp
10 ..
11 .de Vb \" Begin verbatim text
12 .ft CW
13 .nf
14 .ne \\$1
15 ..
16 .de Ve \" End verbatim text
17 .ft R
18 .fi
19 ..
20 .\" Set up some character translations and predefined strings. \*(-- will
21 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
22 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
23 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
24 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
25 .\" nothing in troff, for use with C<>.
26 .tr \(*W-
27 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
28 .ie n \{\
29 . ds -- \(*W-
30 . ds PI pi
31 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
32 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
33 . ds L" ""
34 . ds R" ""
35 . ds C` ""
36 . ds C' ""
37 'br\}
38 .el\{\
39 . ds -- \|\(em\|
40 . ds PI \(*p
41 . ds L" ``
42 . ds R" ''
43 . ds C`
44 . ds C'
45 'br\}
46 .\"
47 .\" Escape single quotes in literal strings from groff's Unicode transform.
48 .ie \n(.g .ds Aq \(aq
49 .el .ds Aq '
50 .\"
51 .\" If the F register is turned on, we'll generate index entries on stderr for
52 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
53 .\" entries marked with X<> in POD. Of course, you'll have to process the
54 .\" output yourself in some meaningful fashion.
55 .\"
56 .\" Avoid warning from groff about undefined register 'F'.
57 .de IX
58 ..
59 .nr rF 0
60 .if \n(.g .if rF .nr rF 1
61 .if (\n(rF:(\n(.g==0)) \{
62 . if \nF \{
63 . de IX
64 . tm Index:\\$1\t\\n%\t"\\$2"
65 ..
66 . if !\nF==2 \{
67 . nr % 0
68 . nr F 2
69 . \}
70 . \}
71 .\}
72 .rr rF
73 .\"
74 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
75 .\" Fear. Run. Save yourself. No user-serviceable parts.
76 . \" fudge factors for nroff and troff
77 .if n \{\
78 . ds #H 0
79 . ds #V .8m
80 . ds #F .3m
81 . ds #[ \f1
82 . ds #] \fP
83 .\}
84 .if t \{\
85 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
86 . ds #V .6m
87 . ds #F 0
88 . ds #[ \&
89 . ds #] \&
90 .\}
91 . \" simple accents for nroff and troff
92 .if n \{\
93 . ds ' \&
94 . ds ` \&
95 . ds ^ \&
96 . ds , \&
97 . ds ~ ~
98 . ds /
99 .\}
100 .if t \{\
101 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
102 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
103 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
104 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
105 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
106 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
107 .\}
108 . \" troff and (daisy-wheel) nroff accents
109 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
110 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
111 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
112 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
113 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
114 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
115 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
116 .ds ae a\h'-(\w'a'u*4/10)'e
117 .ds Ae A\h'-(\w'A'u*4/10)'E
118 . \" corrections for vroff
119 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
120 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
121 . \" for low resolution devices (crt and lpr)
122 .if \n(.H>23 .if \n(.V>19 \
123 \{\
124 . ds : e
125 . ds 8 ss
126 . ds o a
127 . ds d- d\h'-1'\(ga
128 . ds D- D\h'-1'\(hy
129 . ds th \o'bp'
130 . ds Th \o'LP'
131 . ds ae ae
132 . ds Ae AE
133 .\}
134 .rm #[ #] #H #V #F C
135 .\" ========================================================================
136 .\"
137 .IX Title "threads 3"
138 .TH threads 3 "2009-12-26" "1.0.1n" "OpenSSL"
139 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
140 .\" way too many mistakes in technical documents.
141 .if n .ad l
142 .nh
143 .SH "NAME"
144 CRYPTO_THREADID_set_callback, CRYPTO_THREADID_get_callback,
145 CRYPTO_THREADID_current, CRYPTO_THREADID_cmp, CRYPTO_THREADID_cpy,
146 CRYPTO_THREADID_hash, CRYPTO_set_locking_callback, CRYPTO_num_locks,
147 CRYPTO_set_dynlock_create_callback, CRYPTO_set_dynlock_lock_callback,
148 CRYPTO_set_dynlock_destroy_callback, CRYPTO_get_new_dynlockid,
149 CRYPTO_destroy_dynlockid, CRYPTO_lock \- OpenSSL thread support
150 .SH "LIBRARY"
151 libcrypto, -lcrypto
152 .SH "SYNOPSIS"
153 .IX Header "SYNOPSIS"
154 .Vb 1
155 \& #include <openssl/crypto.h>
156 \&
157 \& /* Don\*(Aqt use this structure directly. */
158 \& typedef struct crypto_threadid_st
159 \& {
160 \& void *ptr;
161 \& unsigned long val;
162 \& } CRYPTO_THREADID;
163 \& /* Only use CRYPTO_THREADID_set_[numeric|pointer]() within callbacks */
164 \& void CRYPTO_THREADID_set_numeric(CRYPTO_THREADID *id, unsigned long val);
165 \& void CRYPTO_THREADID_set_pointer(CRYPTO_THREADID *id, void *ptr);
166 \& int CRYPTO_THREADID_set_callback(void (*threadid_func)(CRYPTO_THREADID *));
167 \& void (*CRYPTO_THREADID_get_callback(void))(CRYPTO_THREADID *);
168 \& void CRYPTO_THREADID_current(CRYPTO_THREADID *id);
169 \& int CRYPTO_THREADID_cmp(const CRYPTO_THREADID *a,
170 \& const CRYPTO_THREADID *b);
171 \& void CRYPTO_THREADID_cpy(CRYPTO_THREADID *dest,
172 \& const CRYPTO_THREADID *src);
173 \& unsigned long CRYPTO_THREADID_hash(const CRYPTO_THREADID *id);
174 \&
175 \& int CRYPTO_num_locks(void);
176 \&
177 \& /* struct CRYPTO_dynlock_value needs to be defined by the user */
178 \& struct CRYPTO_dynlock_value;
179 \&
180 \& void CRYPTO_set_dynlock_create_callback(struct CRYPTO_dynlock_value *
181 \& (*dyn_create_function)(char *file, int line));
182 \& void CRYPTO_set_dynlock_lock_callback(void (*dyn_lock_function)
183 \& (int mode, struct CRYPTO_dynlock_value *l,
184 \& const char *file, int line));
185 \& void CRYPTO_set_dynlock_destroy_callback(void (*dyn_destroy_function)
186 \& (struct CRYPTO_dynlock_value *l, const char *file, int line));
187 \&
188 \& int CRYPTO_get_new_dynlockid(void);
189 \&
190 \& void CRYPTO_destroy_dynlockid(int i);
191 \&
192 \& void CRYPTO_lock(int mode, int n, const char *file, int line);
193 \&
194 \& #define CRYPTO_w_lock(type) \e
195 \& CRYPTO_lock(CRYPTO_LOCK|CRYPTO_WRITE,type,_\|_FILE_\|_,_\|_LINE_\|_)
196 \& #define CRYPTO_w_unlock(type) \e
197 \& CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_WRITE,type,_\|_FILE_\|_,_\|_LINE_\|_)
198 \& #define CRYPTO_r_lock(type) \e
199 \& CRYPTO_lock(CRYPTO_LOCK|CRYPTO_READ,type,_\|_FILE_\|_,_\|_LINE_\|_)
200 \& #define CRYPTO_r_unlock(type) \e
201 \& CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_READ,type,_\|_FILE_\|_,_\|_LINE_\|_)
202 \& #define CRYPTO_add(addr,amount,type) \e
203 \& CRYPTO_add_lock(addr,amount,type,_\|_FILE_\|_,_\|_LINE_\|_)
204 .Ve
205 .SH "DESCRIPTION"
206 .IX Header "DESCRIPTION"
207 OpenSSL can safely be used in multi-threaded applications provided
208 that at least two callback functions are set, locking_function and
209 threadid_func.
210 .PP
211 locking_function(int mode, int n, const char *file, int line) is
212 needed to perform locking on shared data structures.
213 (Note that OpenSSL uses a number of global data structures that
214 will be implicitly shared whenever multiple threads use OpenSSL.)
215 Multi-threaded applications will crash at random if it is not set.
216 .PP
217 \&\fIlocking_function()\fR must be able to handle up to \fICRYPTO_num_locks()\fR
218 different mutex locks. It sets the \fBn\fR\-th lock if \fBmode\fR &
219 \&\fB\s-1CRYPTO_LOCK\s0\fR, and releases it otherwise.
220 .PP
221 \&\fBfile\fR and \fBline\fR are the file number of the function setting the
222 lock. They can be useful for debugging.
223 .PP
224 threadid_func(\s-1CRYPTO_THREADID\s0 *id) is needed to record the currently-executing
225 thread's identifier into \fBid\fR. The implementation of this callback should not
226 fill in \fBid\fR directly, but should use \fICRYPTO_THREADID_set_numeric()\fR if thread
227 IDs are numeric, or \fICRYPTO_THREADID_set_pointer()\fR if they are pointer-based.
228 If the application does not register such a callback using
229 \&\fICRYPTO_THREADID_set_callback()\fR, then a default implementation is used \- on
230 Windows and BeOS this uses the system's default thread identifying APIs, and on
231 all other platforms it uses the address of \fBerrno\fR. The latter is satisfactory
232 for thread-safety if and only if the platform has a thread-local error number
233 facility.
234 .PP
235 Once \fIthreadid_func()\fR is registered, or if the built-in default implementation is
236 to be used;
237 .IP "\(bu" 4
238 \&\fICRYPTO_THREADID_current()\fR records the currently-executing thread \s-1ID\s0 into the
239 given \fBid\fR object.
240 .IP "\(bu" 4
241 \&\fICRYPTO_THREADID_cmp()\fR compares two thread IDs (returning zero for equality, ie.
242 the same semantics as \fImemcmp()\fR).
243 .IP "\(bu" 4
244 \&\fICRYPTO_THREADID_cpy()\fR duplicates a thread \s-1ID\s0 value,
245 .IP "\(bu" 4
246 \&\fICRYPTO_THREADID_hash()\fR returns a numeric value usable as a hash-table key. This
247 is usually the exact numeric or pointer-based thread \s-1ID\s0 used internally, however
248 this also handles the unusual case where pointers are larger than 'long'
249 variables and the platform's thread IDs are pointer-based \- in this case, mixing
250 is done to attempt to produce a unique numeric value even though it is not as
251 wide as the platform's true thread IDs.
252 .PP
253 Additionally, OpenSSL supports dynamic locks, and sometimes, some parts
254 of OpenSSL need it for better performance. To enable this, the following
255 is required:
256 .IP "\(bu" 4
257 Three additional callback function, dyn_create_function, dyn_lock_function
258 and dyn_destroy_function.
259 .IP "\(bu" 4
260 A structure defined with the data that each lock needs to handle.
261 .PP
262 struct CRYPTO_dynlock_value has to be defined to contain whatever structure
263 is needed to handle locks.
264 .PP
265 dyn_create_function(const char *file, int line) is needed to create a
266 lock. Multi-threaded applications might crash at random if it is not set.
267 .PP
268 dyn_lock_function(int mode, CRYPTO_dynlock *l, const char *file, int line)
269 is needed to perform locking off dynamic lock numbered n. Multi-threaded
270 applications might crash at random if it is not set.
271 .PP
272 dyn_destroy_function(CRYPTO_dynlock *l, const char *file, int line) is
273 needed to destroy the lock l. Multi-threaded applications might crash at
274 random if it is not set.
275 .PP
276 \&\fICRYPTO_get_new_dynlockid()\fR is used to create locks. It will call
277 dyn_create_function for the actual creation.
278 .PP
279 \&\fICRYPTO_destroy_dynlockid()\fR is used to destroy locks. It will call
280 dyn_destroy_function for the actual destruction.
281 .PP
282 \&\fICRYPTO_lock()\fR is used to lock and unlock the locks. mode is a bitfield
283 describing what should be done with the lock. n is the number of the
284 lock as returned from \fICRYPTO_get_new_dynlockid()\fR. mode can be combined
285 from the following values. These values are pairwise exclusive, with
286 undefined behaviour if misused (for example, \s-1CRYPTO_READ\s0 and \s-1CRYPTO_WRITE\s0
287 should not be used together):
288 .PP
289 .Vb 4
290 \& CRYPTO_LOCK 0x01
291 \& CRYPTO_UNLOCK 0x02
292 \& CRYPTO_READ 0x04
293 \& CRYPTO_WRITE 0x08
294 .Ve
295 .SH "RETURN VALUES"
296 .IX Header "RETURN VALUES"
297 \&\fICRYPTO_num_locks()\fR returns the required number of locks.
298 .PP
299 \&\fICRYPTO_get_new_dynlockid()\fR returns the index to the newly created lock.
300 .PP
301 The other functions return no values.
302 .SH "NOTES"
303 .IX Header "NOTES"
304 You can find out if OpenSSL was configured with thread support:
305 .PP
306 .Vb 7
307 \& #define OPENSSL_THREAD_DEFINES
308 \& #include <openssl/opensslconf.h>
309 \& #if defined(OPENSSL_THREADS)
310 \& // thread support enabled
311 \& #else
312 \& // no thread support
313 \& #endif
314 .Ve
315 .PP
316 Also, dynamic locks are currently not used internally by OpenSSL, but
317 may do so in the future.
318 .SH "EXAMPLES"
319 .IX Header "EXAMPLES"
320 \&\fBcrypto/threads/mttest.c\fR shows examples of the callback functions on
321 Solaris, Irix and Win32.
322 .SH "HISTORY"
323 .IX Header "HISTORY"
324 \&\fICRYPTO_set_locking_callback()\fR is
325 available in all versions of SSLeay and OpenSSL.
326 \&\fICRYPTO_num_locks()\fR was added in OpenSSL 0.9.4.
327 All functions dealing with dynamic locks were added in OpenSSL 0.9.5b\-dev.
328 \&\fB\s-1CRYPTO_THREADID\s0\fR and associated functions were introduced in OpenSSL 1.0.0
329 to replace (actually, deprecate) the previous \fICRYPTO_set_id_callback()\fR,
330 \&\fICRYPTO_get_id_callback()\fR, and \fICRYPTO_thread_id()\fR functions which assumed
331 thread IDs to always be represented by 'unsigned long'.
332 .SH "SEE ALSO"
333 .IX Header "SEE ALSO"
334 \&\fIcrypto\fR\|(3)