secure/lib/libcrypto/man/CRYPTO_THREAD_run_once.3

   1 .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
   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 >0, 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 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  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 "CRYPTO_THREAD_RUN_ONCE 3"
 132 .TH CRYPTO_THREAD_RUN_ONCE 3 "2018-11-20" "1.1.1a" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 CRYPTO_THREAD_run_once, CRYPTO_THREAD_lock_new, CRYPTO_THREAD_read_lock, CRYPTO_THREAD_write_lock, CRYPTO_THREAD_unlock, CRYPTO_THREAD_lock_free, CRYPTO_atomic_add \- OpenSSL thread support
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/crypto.h>
 143 \&
 144 \& CRYPTO_ONCE CRYPTO_ONCE_STATIC_INIT;
 145 \& int CRYPTO_THREAD_run_once(CRYPTO_ONCE *once, void (*init)(void));
 146 \&
 147 \& CRYPTO_RWLOCK *CRYPTO_THREAD_lock_new(void);
 148 \& int CRYPTO_THREAD_read_lock(CRYPTO_RWLOCK *lock);
 149 \& int CRYPTO_THREAD_write_lock(CRYPTO_RWLOCK *lock);
 150 \& int CRYPTO_THREAD_unlock(CRYPTO_RWLOCK *lock);
 151 \& void CRYPTO_THREAD_lock_free(CRYPTO_RWLOCK *lock);
 152 \&
 153 \& int CRYPTO_atomic_add(int *val, int amount, int *ret, CRYPTO_RWLOCK *lock);
 154 .Ve
 155 .SH "DESCRIPTION"
 156 .IX Header "DESCRIPTION"
 157 OpenSSL can be safely used in multi-threaded applications provided that
 158 support for the underlying \s-1OS\s0 threading \s-1API\s0 is built-in. Currently, OpenSSL
 159 supports the pthread and Windows APIs. OpenSSL can also be built without
 160 any multi-threading support, for example on platforms that don't provide
 161 any threading support or that provide a threading \s-1API\s0 that is not yet
 162 supported by OpenSSL.
 163 .PP
 164 The following multi-threading function are provided:
 165 .IP "\(bu" 2
 166 \&\fICRYPTO_THREAD_run_once()\fR can be used to perform one-time initialization.
 167 The \fBonce\fR argument must be a pointer to a static object of type
 168 \&\fB\s-1CRYPTO_ONCE\s0\fR that was statically initialized to the value
 169 \&\fB\s-1CRYPTO_ONCE_STATIC_INIT\s0\fR.
 170 The \fBinit\fR argument is a pointer to a function that performs the desired
 171 exactly once initialization.
 172 In particular, this can be used to allocate locks in a thread-safe manner,
 173 which can then be used with the locking functions below.
 174 .IP "\(bu" 2
 175 \&\fICRYPTO_THREAD_lock_new()\fR allocates, initializes and returns a new read/write
 176 lock.
 177 .IP "\(bu" 2
 178 \&\fICRYPTO_THREAD_read_lock()\fR locks the provided \fBlock\fR for reading.
 179 .IP "\(bu" 2
 180 \&\fICRYPTO_THREAD_write_lock()\fR locks the provided \fBlock\fR for writing.
 181 .IP "\(bu" 2
 182 \&\fICRYPTO_THREAD_unlock()\fR unlocks the previously locked \fBlock\fR.
 183 .IP "\(bu" 2
 184 \&\fICRYPTO_THREAD_lock_free()\fR frees the provided \fBlock\fR.
 185 .IP "\(bu" 2
 186 \&\fICRYPTO_atomic_add()\fR atomically adds \fBamount\fR to \fBval\fR and returns the
 187 result of the operation in \fBret\fR. \fBlock\fR will be locked, unless atomic
 188 operations are supported on the specific platform. Because of this, if a
 189 variable is modified by \fICRYPTO_atomic_add()\fR then \fICRYPTO_atomic_add()\fR must
 190 be the only way that the variable is modified.
 191 .SH "RETURN VALUES"
 192 .IX Header "RETURN VALUES"
 193 \&\fICRYPTO_THREAD_run_once()\fR returns 1 on success, or 0 on error.
 194 .PP
 195 \&\fICRYPTO_THREAD_lock_new()\fR returns the allocated lock, or \s-1NULL\s0 on error.
 196 .PP
 197 \&\fICRYPTO_THREAD_lock_free()\fR returns no value.
 198 .PP
 199 The other functions return 1 on success, or 0 on error.
 200 .SH "NOTES"
 201 .IX Header "NOTES"
 202 On Windows platforms the CRYPTO_THREAD_* types and functions in the
 203 openssl/crypto.h header are dependent on some of the types customarily
 204 made available by including windows.h. The application developer is
 205 likely to require control over when the latter is included, commonly as
 206 one of the first included headers. Therefore it is defined as an
 207 application developer's responsibility to include windows.h prior to
 208 crypto.h where use of CRYPTO_THREAD_* types and functions is required.
 209 .SH "EXAMPLE"
 210 .IX Header "EXAMPLE"
 211 This example safely initializes and uses a lock.
 212 .PP
 213 .Vb 4
 214 \& #ifdef _WIN32
 215 \& # include <windows.h>
 216 \& #endif
 217 \& #include <openssl/crypto.h>
 218 \&
 219 \& static CRYPTO_ONCE once = CRYPTO_ONCE_STATIC_INIT;
 220 \& static CRYPTO_RWLOCK *lock;
 221 \&
 222 \& static void myinit(void)
 223 \& {
 224 \&     lock = CRYPTO_THREAD_lock_new();
 225 \& }
 226 \&
 227 \& static int mylock(void)
 228 \& {
 229 \&     if (!CRYPTO_THREAD_run_once(&once, void init) || lock == NULL)
 230 \&         return 0;
 231 \&     return CRYPTO_THREAD_write_lock(lock);
 232 \& }
 233 \&
 234 \& static int myunlock(void)
 235 \& {
 236 \&     return CRYPTO_THREAD_unlock(lock);
 237 \& }
 238 \&
 239 \& int serialized(void)
 240 \& {
 241 \&     int ret = 0;
 242 \&
 243 \&     if (mylock()) {
 244 \&         /* Your code here, do not return without releasing the lock! */
 245 \&         ret = ... ;
 246 \&     }
 247 \&     myunlock();
 248 \&     return ret;
 249 \& }
 250 .Ve
 251 .PP
 252 Finalization of locks is an advanced topic, not covered in this example.
 253 This can only be done at process exit or when a dynamically loaded library is
 254 no longer in use and is unloaded.
 255 The simplest solution is to just \*(L"leak\*(R" the lock in applications and not
 256 repeatedly load/unload shared libraries that allocate locks.
 257 .SH "NOTES"
 258 .IX Header "NOTES"
 259 You can find out if OpenSSL was configured with thread support:
 260 .PP
 261 .Vb 6
 262 \& #include <openssl/opensslconf.h>
 263 \& #if defined(OPENSSL_THREADS)
 264 \&     /* thread support enabled */
 265 \& #else
 266 \&     /* no thread support */
 267 \& #endif
 268 .Ve
 269 .SH "SEE ALSO"
 270 .IX Header "SEE ALSO"
 271 \&\fIcrypto\fR\|(7)
 272 .SH "COPYRIGHT"
 273 .IX Header "COPYRIGHT"
 274 Copyright 2000\-2018 The OpenSSL Project Authors. All Rights Reserved.
 275 .PP
 276 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 277 this file except in compliance with the License.  You can obtain a copy
 278 in the file \s-1LICENSE\s0 in the source distribution or at
 279 <https://www.openssl.org/source/license.html>.