root
/
openssl
mirror of https://github.com/openssl/openssl.git
1
0
Fork 0
Code Issues Actions 7 Packages Projects Releases Wiki Activity

doc/man3/OPENSSL_malloc: improve OPENSSL_MALLOC_FAILURES documentation 

Reflect its ability to accept floating point numbers in the failure
probability specification.

Complements: 3df5736cf3 "Improve Malloc Failure Test"
Signed-off-by: Eugene Syromiatnikov <esyr@openssl.org>

Reviewed-by: Neil Horman <nhorman@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Dmitry Belyavskiy <beldmit@gmail.com>
(Merged from https://github.com/openssl/openssl/pull/28025)
This commit is contained in:
Eugene Syromiatnikov 2025-07-11 14:24:59 +02:00 committed by Neil Horman
parent 1109bc1237
commit 63e526a4d8
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/man3/OPENSSL_malloc.pod
View File

@ -167,12 +167,13 @@ respectively. If a pointer is NULL, then the corresponding count is not stored.
The variable The variable
B<OPENSSL_MALLOC_FAILURES> controls how often allocations should fail. B<OPENSSL_MALLOC_FAILURES> controls how often allocations should fail.
It is a set of fields separated by semicolons, which each field is a count It is a set of fields separated by semicolons, which each field is a count
(defaulting to zero) and an optional atsign and percentage (defaulting (defaulting to zero) and an optional atsign and percentage (interpreted
to 100). If the count is zero, then it lasts forever. For example, as a floating point number that is rounded up to two decimal digits
C<100;@25> or C<100@0;0@25> means the first 100 allocations pass, then all of precision, defaulting to 100). If the count is zero, then it lasts forever.
other allocations (until the program exits or crashes) have a 25% chance of For example, C<100;@0.258> or C<100@0;0@0.258> means the first 100 allocations
failing. The length of the value of B<OPENSSL_MALLOC_FAILURES> must be 256 or pass, then all other allocations (until the program exits or crashes) have
fewer characters. a 0.26% chance of failing. The length of the value of B<OPENSSL_MALLOC_FAILURES>
must be 256 or fewer characters.
If the variable B<OPENSSL_MALLOC_FD> is parsed as a positive integer, then If the variable B<OPENSSL_MALLOC_FD> is parsed as a positive integer, then
it is taken as an open file descriptor. This is used in conjunction with it is taken as an open file descriptor. This is used in conjunction with