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