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