summaryrefslogtreecommitdiffstats
path: root/doc/crypto/OPENSSL_secure_malloc.pod
diff options
context:
space:
mode:
authorRichard Levitte <levitte@openssl.org>2016-02-17 02:32:27 +0100
committerRichard Levitte <levitte@openssl.org>2016-02-17 10:12:49 +0100
commitfa9bb6201e1d16ba8ccab938833d140ef81a7f73 (patch)
treec985dc003afb3b70182607c05e6f3382b367cd84 /doc/crypto/OPENSSL_secure_malloc.pod
parent05c7b1631b4f6884b9ef5f0943a3d16d36383f52 (diff)
Update the documentation on heap allocators / deallocators
Reviewed-by: Rich Salz <rsalz@openssl.org>
Diffstat (limited to 'doc/crypto/OPENSSL_secure_malloc.pod')
-rw-r--r--doc/crypto/OPENSSL_secure_malloc.pod5
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/crypto/OPENSSL_secure_malloc.pod b/doc/crypto/OPENSSL_secure_malloc.pod
index a055f1dc95..3423eb0413 100644
--- a/doc/crypto/OPENSSL_secure_malloc.pod
+++ b/doc/crypto/OPENSSL_secure_malloc.pod
@@ -25,7 +25,7 @@ CYRPTO_secure_malloc_used - secure heap storage
void *CRYPTO_secure_zalloc(int num, const char *file, int line);
void OPENSSL_secure_free(void* ptr);
- void CRYPTO_secure_free(void *ptr);
+ void CRYPTO_secure_free(void *ptr, const char *, int);
size_t OPENSSL_secure_actual_size(const void *ptr);
int OPENSSL_secure_allocated(const void *ptr);
@@ -74,7 +74,8 @@ OPENSSL_secure_malloc().
If CRYPTO_secure_malloc_init() is not called, this is equivalent to
calling OPENSSL_free().
It exists for consistency with OPENSSL_secure_malloc() , and
-is a macro that expands to CRYPTO_secure_free().
+is a macro that expands to CRYPTO_secure_free() and adds the C<__FILE__>
+and C<__LINE__> parameters..
OPENSSL_secure_allocated() tells whether or not a pointer is within
the secure heap.