diff options
| author | Richard Levitte <levitte@openssl.org> | 2017-01-12 23:13:17 +0100 |
|---|---|---|
| committer | Richard Levitte <levitte@openssl.org> | 2017-01-13 13:10:59 +0100 |
| commit | ba2efdc9ed75659a75d8b8c3cd4ae5bd3c181c65 (patch) | |
| tree | ab115817d396b565966169c218f9ee9d0c850ac8 /include | |
| parent | 08c2da0d6a19b5b9a501ff93641cb2ece5b6b6f0 (diff) | |
Clarify what RUN_ONCE returns
RUN_ONCE really just returns 0 on failure or whatever the init
function returned. By convention, however, the init function must
return 0 on failure and 1 on success. This needed to be clarified.
Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/2225)
(cherry picked from commit 37b8f1e21c56996644afa38816f575b05eb483ae)
Diffstat (limited to 'include')
| -rw-r--r-- | include/internal/thread_once.h | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/include/internal/thread_once.h b/include/internal/thread_once.h index 74f6ccb238..224244353a 100644 --- a/include/internal/thread_once.h +++ b/include/internal/thread_once.h @@ -34,9 +34,12 @@ * RUN_ONCE - use CRYPTO_THREAD_run_once, and check if the init succeeded * @once: pointer to static object of type CRYPTO_ONCE * @init: function name that was previously given to DEFINE_RUN_ONCE, - * DEFINE_RUN_ONCE_STATIC or DECLARE_RUN_ONCE. + * DEFINE_RUN_ONCE_STATIC or DECLARE_RUN_ONCE. This function + * must return 1 for success or 0 for failure. * - * The return value is 1 on success or 0 in case of error. + * The return value is 1 on success (*) or 0 in case of error. + * + * (*) by convention, since the init function must return 1 on success. */ #define RUN_ONCE(once, init) \ (CRYPTO_THREAD_run_once(once, init##_ossl_) ? init##_ossl_ret_ : 0) |