aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorPauli <paul.dale@oracle.com>2017-09-25 12:04:42 +1000
committerPauli <paul.dale@oracle.com>2017-10-10 08:45:52 +1000
commit94683b7acb62a5d99b8b4d66283e6d6dd0007f7a (patch)
tree10cec2abdb2f43af401d65c1060c083bb0865fdf /doc
parent338ead0ff9b22aecbc3b28e37ea05d142e13ee13 (diff)
downloadopenssl-94683b7acb62a5d99b8b4d66283e6d6dd0007f7a.tar.gz
Add a CRYPTO_atomic_read call which allows an int variable to be read
in an atomic fashion. Reviewed-by: Rich Salz <rsalz@openssl.org> (Merged from https://github.com/openssl/openssl/pull/4414)
Diffstat (limited to 'doc')
-rw-r--r--doc/man3/CRYPTO_THREAD_run_once.pod10
1 files changed, 9 insertions, 1 deletions
diff --git a/doc/man3/CRYPTO_THREAD_run_once.pod b/doc/man3/CRYPTO_THREAD_run_once.pod
index 9a4df1992c..bf4a2f2cef 100644
--- a/doc/man3/CRYPTO_THREAD_run_once.pod
+++ b/doc/man3/CRYPTO_THREAD_run_once.pod
@@ -4,7 +4,8 @@
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
+CRYPTO_THREAD_unlock, CRYPTO_THREAD_lock_free, CRYPTO_atomic_add,
+CRYPTO_atomic_read - OpenSSL thread support
=head1 SYNOPSIS
@@ -20,6 +21,7 @@ CRYPTO_THREAD_unlock, CRYPTO_THREAD_lock_free, CRYPTO_atomic_add - OpenSSL threa
void CRYPTO_THREAD_lock_free(CRYPTO_RWLOCK *lock);
int CRYPTO_atomic_add(int *val, int amount, int *ret, CRYPTO_RWLOCK *lock);
+ int CRYPTO_atomic_read(int *val, int *ret, CRYPTO_RWLOCK *lock);
=head1 DESCRIPTION
@@ -74,6 +76,12 @@ operations are supported on the specific platform. Because of this, if a
variable is modified by CRYPTO_atomic_add() then CRYPTO_atomic_add() must
be the only way that the variable is modified.
+=item *
+
+CRYPTO_atomic_read() atomically reads B<val> and returns the result of
+the operation in B<ret>. B<lock> will be locked, unless atomic operations
+are supported on the specific platform.
+
=back
=head1 RETURN VALUES