secure/lib/libcrypto/man/threads.3

   1 .\" Automatically generated by Pod::Man 2.12 (Pod::Simple 3.05)
   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.  \*(C+ will
  29 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  30 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  31 .\" nothing in troff, for use with C<>.
  32 .tr \(*W-
  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 .\" 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 "2007-10-24" "0.9.8g" "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_set_locking_callback, CRYPTO_set_id_callback, CRYPTO_num_locks,
 134 CRYPTO_set_dynlock_create_callback, CRYPTO_set_dynlock_lock_callback,
 135 CRYPTO_set_dynlock_destroy_callback, CRYPTO_get_new_dynlockid,
 136 CRYPTO_destroy_dynlockid, CRYPTO_lock \- OpenSSL thread support
 137 .SH "SYNOPSIS"
 138 .IX Header "SYNOPSIS"
 139 .Vb 1
 140 \& #include <openssl/crypto.h>
 141 \&
 142 \& void CRYPTO_set_locking_callback(void (*locking_function)(int mode,
 143 \&        int n, const char *file, int line));
 144 \&
 145 \& void CRYPTO_set_id_callback(unsigned long (*id_function)(void));
 146 \&
 147 \& int CRYPTO_num_locks(void);
 148 \&
 149 \&
 150 \& /* struct CRYPTO_dynlock_value needs to be defined by the user */
 151 \& struct CRYPTO_dynlock_value;
 152 \&
 153 \& void CRYPTO_set_dynlock_create_callback(struct CRYPTO_dynlock_value *
 154 \&        (*dyn_create_function)(char *file, int line));
 155 \& void CRYPTO_set_dynlock_lock_callback(void (*dyn_lock_function)
 156 \&        (int mode, struct CRYPTO_dynlock_value *l,
 157 \&        const char *file, int line));
 158 \& void CRYPTO_set_dynlock_destroy_callback(void (*dyn_destroy_function)
 159 \&        (struct CRYPTO_dynlock_value *l, const char *file, int line));
 160 \&
 161 \& int CRYPTO_get_new_dynlockid(void);
 162 \&
 163 \& void CRYPTO_destroy_dynlockid(int i);
 164 \&
 165 \& void CRYPTO_lock(int mode, int n, const char *file, int line);
 166 \&
 167 \& #define CRYPTO_w_lock(type)    \e
 168 \&        CRYPTO_lock(CRYPTO_LOCK|CRYPTO_WRITE,type,_\|_FILE_\|_,_\|_LINE_\|_)
 169 \& #define CRYPTO_w_unlock(type)  \e
 170 \&        CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_WRITE,type,_\|_FILE_\|_,_\|_LINE_\|_)
 171 \& #define CRYPTO_r_lock(type)    \e
 172 \&        CRYPTO_lock(CRYPTO_LOCK|CRYPTO_READ,type,_\|_FILE_\|_,_\|_LINE_\|_)
 173 \& #define CRYPTO_r_unlock(type)  \e
 174 \&        CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_READ,type,_\|_FILE_\|_,_\|_LINE_\|_)
 175 \& #define CRYPTO_add(addr,amount,type)   \e
 176 \&        CRYPTO_add_lock(addr,amount,type,_\|_FILE_\|_,_\|_LINE_\|_)
 177 .Ve
 178 .SH "DESCRIPTION"
 179 .IX Header "DESCRIPTION"
 180 OpenSSL can safely be used in multi-threaded applications provided
 181 that at least two callback functions are set.
 182 .PP
 183 locking_function(int mode, int n, const char *file, int line) is
 184 needed to perform locking on shared data structures.
 185 (Note that OpenSSL uses a number of global data structures that
 186 will be implicitly shared whenever multiple threads use OpenSSL.)
 187 Multi-threaded applications will crash at random if it is not set.
 188 .PP
 189 \&\fIlocking_function()\fR must be able to handle up to \fICRYPTO_num_locks()\fR
 190 different mutex locks. It sets the \fBn\fR\-th lock if \fBmode\fR &
 191 \&\fB\s-1CRYPTO_LOCK\s0\fR, and releases it otherwise.
 192 .PP
 193 \&\fBfile\fR and \fBline\fR are the file number of the function setting the
 194 lock. They can be useful for debugging.
 195 .PP
 196 id_function(void) is a function that returns a thread \s-1ID\s0, for example
 197 \&\fIpthread_self()\fR if it returns an integer (see \s-1NOTES\s0 below).  It isn't
 198 needed on Windows nor on platforms where \fIgetpid()\fR returns a different
 199 \&\s-1ID\s0 for each thread (see \s-1NOTES\s0 below).
 200 .PP
 201 Additionally, OpenSSL supports dynamic locks, and sometimes, some parts
 202 of OpenSSL need it for better performance.  To enable this, the following
 203 is required:
 204 .IP "\(bu" 4
 205 Three additional callback function, dyn_create_function, dyn_lock_function
 206 and dyn_destroy_function.
 207 .IP "\(bu" 4
 208 A structure defined with the data that each lock needs to handle.
 209 .PP
 210 struct CRYPTO_dynlock_value has to be defined to contain whatever structure
 211 is needed to handle locks.
 212 .PP
 213 dyn_create_function(const char *file, int line) is needed to create a
 214 lock.  Multi-threaded applications might crash at random if it is not set.
 215 .PP
 216 dyn_lock_function(int mode, CRYPTO_dynlock *l, const char *file, int line)
 217 is needed to perform locking off dynamic lock numbered n. Multi-threaded
 218 applications might crash at random if it is not set.
 219 .PP
 220 dyn_destroy_function(CRYPTO_dynlock *l, const char *file, int line) is
 221 needed to destroy the lock l. Multi-threaded applications might crash at
 222 random if it is not set.
 223 .PP
 224 \&\fICRYPTO_get_new_dynlockid()\fR is used to create locks.  It will call
 225 dyn_create_function for the actual creation.
 226 .PP
 227 \&\fICRYPTO_destroy_dynlockid()\fR is used to destroy locks.  It will call
 228 dyn_destroy_function for the actual destruction.
 229 .PP
 230 \&\fICRYPTO_lock()\fR is used to lock and unlock the locks.  mode is a bitfield
 231 describing what should be done with the lock.  n is the number of the
 232 lock as returned from \fICRYPTO_get_new_dynlockid()\fR.  mode can be combined
 233 from the following values.  These values are pairwise exclusive, with
 234 undefined behaviour if misused (for example, \s-1CRYPTO_READ\s0 and \s-1CRYPTO_WRITE\s0
 235 should not be used together):
 236 .PP
 237 .Vb 4
 238 \&        CRYPTO_LOCK     0x01
 239 \&        CRYPTO_UNLOCK   0x02
 240 \&        CRYPTO_READ     0x04
 241 \&        CRYPTO_WRITE    0x08
 242 .Ve
 243 .SH "RETURN VALUES"
 244 .IX Header "RETURN VALUES"
 245 \&\fICRYPTO_num_locks()\fR returns the required number of locks.
 246 .PP
 247 \&\fICRYPTO_get_new_dynlockid()\fR returns the index to the newly created lock.
 248 .PP
 249 The other functions return no values.
 250 .SH "NOTES"
 251 .IX Header "NOTES"
 252 You can find out if OpenSSL was configured with thread support:
 253 .PP
 254 .Vb 7
 255 \& #define OPENSSL_THREAD_DEFINES
 256 \& #include <openssl/opensslconf.h>
 257 \& #if defined(OPENSSL_THREADS)
 258 \&   // thread support enabled
 259 \& #else
 260 \&   // no thread support
 261 \& #endif
 262 .Ve
 263 .PP
 264 Also, dynamic locks are currently not used internally by OpenSSL, but
 265 may do so in the future.
 266 .PP
 267 Defining id_function(void) has it's own issues.  Generally speaking,
 268 \&\fIpthread_self()\fR should be used, even on platforms where \fIgetpid()\fR gives
 269 different answers in each thread, since that may depend on the machine
 270 the program is run on, not the machine where the program is being
 271 compiled.  For instance, Red Hat 8 Linux and earlier used
 272 LinuxThreads, whose \fIgetpid()\fR returns a different value for each
 273 thread.  Red Hat 9 Linux and later use \s-1NPTL\s0, which is
 274 Posix-conformant, and has a \fIgetpid()\fR that returns the same value for
 275 all threads in a process.  A program compiled on Red Hat 8 and run on
 276 Red Hat 9 will therefore see \fIgetpid()\fR returning the same value for
 277 all threads.
 278 .PP
 279 There is still the issue of platforms where \fIpthread_self()\fR returns
 280 something other than an integer.  This is a bit unusual, and this
 281 manual has no cookbook solution for that case.
 282 .SH "EXAMPLES"
 283 .IX Header "EXAMPLES"
 284 \&\fBcrypto/threads/mttest.c\fR shows examples of the callback functions on
 285 Solaris, Irix and Win32.
 286 .SH "HISTORY"
 287 .IX Header "HISTORY"
 288 \&\fICRYPTO_set_locking_callback()\fR and \fICRYPTO_set_id_callback()\fR are
 289 available in all versions of SSLeay and OpenSSL.
 290 \&\fICRYPTO_num_locks()\fR was added in OpenSSL 0.9.4.
 291 All functions dealing with dynamic locks were added in OpenSSL 0.9.5b\-dev.
 292 .SH "SEE ALSO"
 293 .IX Header "SEE ALSO"
 294 \&\fIcrypto\fR\|(3)