mirror/openssl
2
0
Fork 0
mirror of https://github.com/openssl/openssl.git synced 2025-04-06 20:20:50 +08:00
Code Issues Packages Projects Releases Wiki Activity

Document OSSL_get_thread_support_flags()

Browse Source 
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/21905)
This commit is contained in:
Hugo Landau 2023-08-30 13:19:40 +01:00
parent d2e9e12b23
commit cc50b44e55
2 changed files with 21 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
doc/man3/CRYPTO_THREAD_run_once.pod
View File

@ -8,7 +8,8 @@ CRYPTO_THREAD_unlock, CRYPTO_THREAD_lock_free,
CRYPTO_atomic_add, CRYPTO_atomic_or, CRYPTO_atomic_load,
CRYPTO_atomic_load_int,
OSSL_set_max_threads, OSSL_get_max_threads,
OSSL_get_thread_support_flags - OpenSSL thread support
OSSL_get_thread_support_flags, OSSL_THREAD_SUPPORT_FLAG_THREAD_POOL,
OSSL_THREAD_SUPPORT_FLAG_DEFAULT_SPAWN - OpenSSL thread support
=head1 SYNOPSIS
@ -33,6 +34,9 @@ OSSL_get_thread_support_flags - OpenSSL thread support
uint64_t OSSL_get_max_threads(OSSL_LIB_CTX *ctx);
uint32_t OSSL_get_thread_support_flags(void);
#define OSSL_THREAD_SUPPORT_FLAG_THREAD_POOL
#define OSSL_THREAD_SUPPORT_FLAG_DEFAULT_SPAWN
=head1 DESCRIPTION
OpenSSL can be safely used in multi-threaded applications provided that
@ -121,6 +125,17 @@ spawned unless (and until) there is demand. Thread polling is disabled by
default. To enable threading you must call OSSL_set_max_threads() explicitly.
Under no circumstances is this done for you.
=item *
OSSL_get_thread_support_flags() determines what thread pool functionality
OpenSSL is compiled with and is able to support in the current run time
environment. B<OSSL_THREAD_SUPPORT_FLAG_THREAD_POOL> indicates that the base
thread pool functionality is available, and
B<OSSL_THREAD_SUPPORT_FLAG_DEFAULT_SPAWN> indicates that the default thread pool
model is available. The default thread pool model is currently the only model
available, therefore both of these flags must be set for thread pool
functionality to be used.
=back
=head1 RETURN VALUES
@ -140,6 +155,9 @@ OSSL_get_max_threads() returns the maximum number of threads currently allowed
to be used by the thread pool. If thread pooling is disabled or not available,
returns 0.
OSSL_get_thread_support_flags() returns zero or more B<OSSL_THREAD_SUPPORT_FLAG>
values.
The other functions return 1 on success, or 0 on error.
=head1 NOTES

2
util/other.syms
View File

@ -697,6 +697,8 @@ OSSL_TRACE_CANCEL define
OSSL_TRACE1 define
OSSL_TRACE2 define
OSSL_TRACE9 define
OSSL_THREAD_SUPPORT_FLAG_THREAD_POOL define
OSSL_THREAD_SUPPORT_FLAG_DEFAULT_SPAWN define
TS_VERIFY_CTS_set_certs define deprecated 3.0.0
EVP_PKEY_get1_tls_encodedpoint define deprecated 3.0.0
EVP_PKEY_set1_tls_encodedpoint define deprecated 3.0.0