secure/lib/libcrypto/man/threads.3

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  | will give a
  29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
  32 .tr \(*W-|\(bv\*(Tr
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), 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 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "threads 3"
 132 .TH threads 3 "2006-11-19" "0.9.8d" "OpenSSL"
 133 .SH "NAME"
 134 CRYPTO_set_locking_callback, CRYPTO_set_id_callback, CRYPTO_num_locks,
 135 CRYPTO_set_dynlock_create_callback, CRYPTO_set_dynlock_lock_callback,
 136 CRYPTO_set_dynlock_destroy_callback, CRYPTO_get_new_dynlockid,
 137 CRYPTO_destroy_dynlockid, CRYPTO_lock \- OpenSSL thread support
 138 .SH "SYNOPSIS"
 139 .IX Header "SYNOPSIS"
 140 .Vb 1
 141 \& #include <openssl/crypto.h>
 142 .Ve
 143 .PP
 144 .Vb 2
 145 \& void CRYPTO_set_locking_callback(void (*locking_function)(int mode,
 146 \&        int n, const char *file, int line));
 147 .Ve
 148 .PP
 149 .Vb 1
 150 \& void CRYPTO_set_id_callback(unsigned long (*id_function)(void));
 151 .Ve
 152 .PP
 153 .Vb 1
 154 \& int CRYPTO_num_locks(void);
 155 .Ve
 156 .PP
 157 .Vb 2
 158 \& /* struct CRYPTO_dynlock_value needs to be defined by the user */
 159 \& struct CRYPTO_dynlock_value;
 160 .Ve
 161 .PP
 162 .Vb 7
 163 \& void CRYPTO_set_dynlock_create_callback(struct CRYPTO_dynlock_value *
 164 \&        (*dyn_create_function)(char *file, int line));
 165 \& void CRYPTO_set_dynlock_lock_callback(void (*dyn_lock_function)
 166 \&        (int mode, struct CRYPTO_dynlock_value *l,
 167 \&        const char *file, int line));
 168 \& void CRYPTO_set_dynlock_destroy_callback(void (*dyn_destroy_function)
 169 \&        (struct CRYPTO_dynlock_value *l, const char *file, int line));
 170 .Ve
 171 .PP
 172 .Vb 1
 173 \& int CRYPTO_get_new_dynlockid(void);
 174 .Ve
 175 .PP
 176 .Vb 1
 177 \& void CRYPTO_destroy_dynlockid(int i);
 178 .Ve
 179 .PP
 180 .Vb 1
 181 \& void CRYPTO_lock(int mode, int n, const char *file, int line);
 182 .Ve
 183 .PP
 184 .Vb 10
 185 \& #define CRYPTO_w_lock(type)    \e
 186 \&        CRYPTO_lock(CRYPTO_LOCK|CRYPTO_WRITE,type,__FILE__,__LINE__)
 187 \& #define CRYPTO_w_unlock(type)  \e
 188 \&        CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_WRITE,type,__FILE__,__LINE__)
 189 \& #define CRYPTO_r_lock(type)    \e
 190 \&        CRYPTO_lock(CRYPTO_LOCK|CRYPTO_READ,type,__FILE__,__LINE__)
 191 \& #define CRYPTO_r_unlock(type)  \e
 192 \&        CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_READ,type,__FILE__,__LINE__)
 193 \& #define CRYPTO_add(addr,amount,type)   \e
 194 \&        CRYPTO_add_lock(addr,amount,type,__FILE__,__LINE__)
 195 .Ve
 196 .SH "DESCRIPTION"
 197 .IX Header "DESCRIPTION"
 198 OpenSSL can safely be used in multi-threaded applications provided
 199 that at least two callback functions are set.
 200 .PP
 201 locking_function(int mode, int n, const char *file, int line) is
 202 needed to perform locking on shared data structures.
 203 (Note that OpenSSL uses a number of global data structures that
 204 will be implicitly shared whenever multiple threads use OpenSSL.)
 205 Multi-threaded applications will crash at random if it is not set.
 206 .PP
 207 \&\fIlocking_function()\fR must be able to handle up to \fICRYPTO_num_locks()\fR
 208 different mutex locks. It sets the \fBn\fR\-th lock if \fBmode\fR &
 209 \&\fB\s-1CRYPTO_LOCK\s0\fR, and releases it otherwise.
 210 .PP
 211 \&\fBfile\fR and \fBline\fR are the file number of the function setting the
 212 lock. They can be useful for debugging.
 213 .PP
 214 id_function(void) is a function that returns a thread \s-1ID\s0, for example
 215 \&\fIpthread_self()\fR if it returns an integer (see \s-1NOTES\s0 below).  It isn't
 216 needed on Windows nor on platforms where \fIgetpid()\fR returns a different
 217 \&\s-1ID\s0 for each thread (see \s-1NOTES\s0 below).
 218 .PP
 219 Additionally, OpenSSL supports dynamic locks, and sometimes, some parts
 220 of OpenSSL need it for better performance.  To enable this, the following
 221 is required:
 222 .IP "* Three additional callback function, dyn_create_function, dyn_lock_function and dyn_destroy_function." 4
 223 .IX Item "Three additional callback function, dyn_create_function, dyn_lock_function and dyn_destroy_function."
 224 .PD 0
 225 .IP "* A structure defined with the data that each lock needs to handle." 4
 226 .IX Item "A structure defined with the data that each lock needs to handle."
 227 .PD
 228 .PP
 229 struct CRYPTO_dynlock_value has to be defined to contain whatever structure
 230 is needed to handle locks.
 231 .PP
 232 dyn_create_function(const char *file, int line) is needed to create a
 233 lock.  Multi-threaded applications might crash at random if it is not set.
 234 .PP
 235 dyn_lock_function(int mode, CRYPTO_dynlock *l, const char *file, int line)
 236 is needed to perform locking off dynamic lock numbered n. Multi-threaded
 237 applications might crash at random if it is not set.
 238 .PP
 239 dyn_destroy_function(CRYPTO_dynlock *l, const char *file, int line) is
 240 needed to destroy the lock l. Multi-threaded applications might crash at
 241 random if it is not set.
 242 .PP
 243 \&\fICRYPTO_get_new_dynlockid()\fR is used to create locks.  It will call
 244 dyn_create_function for the actual creation.
 245 .PP
 246 \&\fICRYPTO_destroy_dynlockid()\fR is used to destroy locks.  It will call
 247 dyn_destroy_function for the actual destruction.
 248 .PP
 249 \&\fICRYPTO_lock()\fR is used to lock and unlock the locks.  mode is a bitfield
 250 describing what should be done with the lock.  n is the number of the
 251 lock as returned from \fICRYPTO_get_new_dynlockid()\fR.  mode can be combined
 252 from the following values.  These values are pairwise exclusive, with
 253 undefined behaviour if misused (for example, \s-1CRYPTO_READ\s0 and \s-1CRYPTO_WRITE\s0
 254 should not be used together):
 255 .PP
 256 .Vb 4
 257 \&        CRYPTO_LOCK     0x01
 258 \&        CRYPTO_UNLOCK   0x02
 259 \&        CRYPTO_READ     0x04
 260 \&        CRYPTO_WRITE    0x08
 261 .Ve
 262 .SH "RETURN VALUES"
 263 .IX Header "RETURN VALUES"
 264 \&\fICRYPTO_num_locks()\fR returns the required number of locks.
 265 .PP
 266 \&\fICRYPTO_get_new_dynlockid()\fR returns the index to the newly created lock.
 267 .PP
 268 The other functions return no values.
 269 .SH "NOTES"
 270 .IX Header "NOTES"
 271 You can find out if OpenSSL was configured with thread support:
 272 .PP
 273 .Vb 7
 274 \& #define OPENSSL_THREAD_DEFINES
 275 \& #include <openssl/opensslconf.h>
 276 \& #if defined(OPENSSL_THREADS)
 277 \&   // thread support enabled
 278 \& #else
 279 \&   // no thread support
 280 \& #endif
 281 .Ve
 282 .PP
 283 Also, dynamic locks are currently not used internally by OpenSSL, but
 284 may do so in the future.
 285 .PP
 286 Defining id_function(void) has it's own issues.  Generally speaking,
 287 \&\fIpthread_self()\fR should be used, even on platforms where \fIgetpid()\fR gives
 288 different answers in each thread, since that may depend on the machine
 289 the program is run on, not the machine where the program is being
 290 compiled.  For instance, Red Hat 8 Linux and earlier used
 291 LinuxThreads, whose \fIgetpid()\fR returns a different value for each
 292 thread.  Red Hat 9 Linux and later use \s-1NPTL\s0, which is
 293 Posix\-conformant, and has a \fIgetpid()\fR that returns the same value for
 294 all threads in a process.  A program compiled on Red Hat 8 and run on
 295 Red Hat 9 will therefore see \fIgetpid()\fR returning the same value for
 296 all threads.
 297 .PP
 298 There is still the issue of platforms where \fIpthread_self()\fR returns
 299 something other than an integer.  This is a bit unusual, and this
 300 manual has no cookbook solution for that case.
 301 .SH "EXAMPLES"
 302 .IX Header "EXAMPLES"
 303 \&\fBcrypto/threads/mttest.c\fR shows examples of the callback functions on
 304 Solaris, Irix and Win32.
 305 .SH "HISTORY"
 306 .IX Header "HISTORY"
 307 \&\fICRYPTO_set_locking_callback()\fR and \fICRYPTO_set_id_callback()\fR are
 308 available in all versions of SSLeay and OpenSSL.
 309 \&\fICRYPTO_num_locks()\fR was added in OpenSSL 0.9.4.
 310 All functions dealing with dynamic locks were added in OpenSSL 0.9.5b\-dev.
 311 .SH "SEE ALSO"
 312 .IX Header "SEE ALSO"
 313 \&\fIcrypto\fR\|(3)