doc/man3/OPENSSL_malloc.pod: explicitly document freeptr value on failures

Explicitly document that it is set to NULL, so can be passed to free()
without additional checks.

Signed-off-by: Eugene Syromiatnikov <esyr@openssl.org>

Reviewed-by: Saša Nedvědický <sashan@openssl.org>
Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Paul Dale <ppzgs1@gmail.com>
Reviewed-by: Neil Horman <nhorman@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/28059)
This commit is contained in:
Eugene Syromiatnikov 2025-07-31 14:35:07 +02:00 committed by Neil Horman
parent 704ee1348c
commit 14a24fd14f
1 changed files with 3 additions and 0 deletions

View File

@ -259,6 +259,9 @@ CRYPTO_clear_realloc(), CRYPTO_clear_realloc_array(),
OPENSSL_strdup(), and OPENSSL_strndup()
return a pointer to allocated memory or NULL on error.
OPENSSL_aligned_alloc() and OPENSSL_aligned_alloc_array() set B<freeptr>
to NULL on error.
CRYPTO_set_mem_functions() returns 1 on success or 0 on failure (almost
always because allocations have already happened).