Add OPENSSL_hexstr2buf_ex() and OPENSSL_buf2hexstr_ex()
[openssl.git] / doc / man3 / OPENSSL_malloc.pod
1 =pod
2
3 =head1 NAME
4
5 OPENSSL_malloc_init,
6 OPENSSL_malloc, OPENSSL_zalloc, OPENSSL_realloc, OPENSSL_free,
7 OPENSSL_clear_realloc, OPENSSL_clear_free, OPENSSL_cleanse,
8 CRYPTO_malloc, CRYPTO_zalloc, CRYPTO_realloc, CRYPTO_free,
9 OPENSSL_strdup, OPENSSL_strndup,
10 OPENSSL_memdup, OPENSSL_strlcpy, OPENSSL_strlcat,
11 CRYPTO_strdup, CRYPTO_strndup,
12 OPENSSL_mem_debug_push, OPENSSL_mem_debug_pop,
13 CRYPTO_mem_debug_push, CRYPTO_mem_debug_pop,
14 CRYPTO_clear_realloc, CRYPTO_clear_free,
15 CRYPTO_get_mem_functions, CRYPTO_set_mem_functions,
16 CRYPTO_get_alloc_counts,
17 CRYPTO_set_mem_debug, CRYPTO_mem_ctrl,
18 CRYPTO_mem_leaks, CRYPTO_mem_leaks_fp, CRYPTO_mem_leaks_cb,
19 OPENSSL_MALLOC_FAILURES,
20 OPENSSL_MALLOC_FD
21 - Memory allocation functions
22
23 =head1 SYNOPSIS
24
25  #include <openssl/crypto.h>
26
27  int OPENSSL_malloc_init(void)
28
29  void *OPENSSL_malloc(size_t num)
30  void *OPENSSL_zalloc(size_t num)
31  void *OPENSSL_realloc(void *addr, size_t num)
32  void OPENSSL_free(void *addr)
33  char *OPENSSL_strdup(const char *str)
34  char *OPENSSL_strndup(const char *str, size_t s)
35  size_t OPENSSL_strlcat(char *dst, const char *src, size_t size);
36  size_t OPENSSL_strlcpy(char *dst, const char *src, size_t size);
37  void *OPENSSL_memdup(void *data, size_t s)
38  void *OPENSSL_clear_realloc(void *p, size_t old_len, size_t num)
39  void OPENSSL_clear_free(void *str, size_t num)
40  void OPENSSL_cleanse(void *ptr, size_t len);
41
42  void *CRYPTO_malloc(size_t num, const char *file, int line)
43  void *CRYPTO_zalloc(size_t num, const char *file, int line)
44  void *CRYPTO_realloc(void *p, size_t num, const char *file, int line)
45  void CRYPTO_free(void *str, const char *, int)
46  char *CRYPTO_strdup(const char *p, const char *file, int line)
47  char *CRYPTO_strndup(const char *p, size_t num, const char *file, int line)
48  void *CRYPTO_clear_realloc(void *p, size_t old_len, size_t num,
49                             const char *file, int line)
50  void CRYPTO_clear_free(void *str, size_t num, const char *, int)
51
52  void CRYPTO_get_mem_functions(
53          void *(**m)(size_t, const char *, int),
54          void *(**r)(void *, size_t, const char *, int),
55          void (**f)(void *, const char *, int))
56  int CRYPTO_set_mem_functions(
57          void *(*m)(size_t, const char *, int),
58          void *(*r)(void *, size_t, const char *, int),
59          void (*f)(void *, const char *, int))
60
61  void CRYPTO_get_alloc_counts(int *m, int *r, int *f)
62
63  int CRYPTO_set_mem_debug(int onoff)
64
65  env OPENSSL_MALLOC_FAILURES=... <application>
66  env OPENSSL_MALLOC_FD=... <application>
67
68  int CRYPTO_mem_ctrl(int mode);
69
70  int CRYPTO_mem_leaks(BIO *b);
71  int CRYPTO_mem_leaks_fp(FILE *fp);
72  int CRYPTO_mem_leaks_cb(int (*cb)(const char *str, size_t len, void *u),
73                          void *u);
74
75 Deprecated:
76
77  int OPENSSL_mem_debug_push(const char *info)
78  int OPENSSL_mem_debug_pop(void);
79  int CRYPTO_mem_debug_push(const char *info, const char *file, int line);
80  int CRYPTO_mem_debug_pop(void);
81
82 =head1 DESCRIPTION
83
84 OpenSSL memory allocation is handled by the B<OPENSSL_xxx> API. These are
85 generally macro's that add the standard C B<__FILE__> and B<__LINE__>
86 parameters and call a lower-level B<CRYPTO_xxx> API.
87 Some functions do not add those parameters, but exist for consistency.
88
89 OPENSSL_malloc_init() does nothing and does not need to be called. It is
90 included for compatibility with older versions of OpenSSL.
91
92 OPENSSL_malloc(), OPENSSL_realloc(), and OPENSSL_free() are like the
93 C malloc(), realloc(), and free() functions.
94 OPENSSL_zalloc() calls memset() to zero the memory before returning.
95
96 OPENSSL_clear_realloc() and OPENSSL_clear_free() should be used
97 when the buffer at B<addr> holds sensitive information.
98 The old buffer is filled with zero's by calling OPENSSL_cleanse()
99 before ultimately calling OPENSSL_free().
100
101 OPENSSL_cleanse() fills B<ptr> of size B<len> with a string of 0's.
102 Use OPENSSL_cleanse() with care if the memory is a mapping of a file.
103 If the storage controller uses write compression, then its possible
104 that sensitive tail bytes will survive zeroization because the block of
105 zeros will be compressed. If the storage controller uses wear leveling,
106 then the old sensitive data will not be overwritten; rather, a block of
107 0's will be written at a new physical location.
108
109 OPENSSL_strdup(), OPENSSL_strndup() and OPENSSL_memdup() are like the
110 equivalent C functions, except that memory is allocated by calling the
111 OPENSSL_malloc() and should be released by calling OPENSSL_free().
112
113 OPENSSL_strlcpy(),
114 OPENSSL_strlcat() and OPENSSL_strnlen() are equivalents of the common C
115 library functions and are provided for portability.
116
117 If no allocations have been done, it is possible to "swap out" the default
118 implementations for OPENSSL_malloc(), OPENSSL_realloc and OPENSSL_free()
119 and replace them with alternate versions (hooks).
120 CRYPTO_get_mem_functions() function fills in the given arguments with the
121 function pointers for the current implementations.
122 With CRYPTO_set_mem_functions(), you can specify a different set of functions.
123 If any of B<m>, B<r>, or B<f> are NULL, then the function is not changed.
124
125 The default implementation can include some debugging capability (if enabled
126 at build-time).
127 This adds some overhead by keeping a list of all memory allocations, and
128 removes items from the list when they are free'd.
129 This is most useful for identifying memory leaks.
130 CRYPTO_set_mem_debug() turns this tracking on and off.  In order to have
131 any effect, is must be called before any of the allocation functions
132 (e.g., CRYPTO_malloc()) are called, and is therefore normally one of the
133 first lines of main() in an application.
134 CRYPTO_mem_ctrl() provides fine-grained control of memory leak tracking.
135 To enable tracking call CRYPTO_mem_ctrl() with a B<mode> argument of
136 the B<CRYPTO_MEM_CHECK_ON>.
137 To disable tracking call CRYPTO_mem_ctrl() with a B<mode> argument of
138 the B<CRYPTO_MEM_CHECK_OFF>.
139
140 At the end of the program, calling CRYPTO_mem_leaks() or
141 CRYPTO_mem_leaks_fp() will report all "leaked" memory, writing it
142 to the specified BIO B<b> or FILE B<fp>. These functions return 1 if
143 there are no leaks, 0 if there are leaks and -1 if an error occurred.
144
145 CRYPTO_mem_leaks_cb() does the same as CRYPTO_mem_leaks(), but instead
146 of writing to a given BIO, the callback function is called for each
147 output string with the string, length, and userdata B<u> as the callback
148 parameters.
149
150 If the library is built with the C<crypto-mdebug> option, then one
151 function, CRYPTO_get_alloc_counts(), and two additional environment
152 variables, B<OPENSSL_MALLOC_FAILURES> and B<OPENSSL_MALLOC_FD>,
153 are available.
154
155 The function CRYPTO_get_alloc_counts() fills in the number of times
156 each of CRYPTO_malloc(), CRYPTO_realloc(), and CRYPTO_free() have been
157 called, into the values pointed to by B<mcount>, B<rcount>, and B<fcount>,
158 respectively.  If a pointer is NULL, then the corresponding count is not stored.
159
160 The variable
161 B<OPENSSL_MALLOC_FAILURES> controls how often allocations should fail.
162 It is a set of fields separated by semicolons, which each field is a count
163 (defaulting to zero) and an optional atsign and percentage (defaulting
164 to 100).  If the count is zero, then it lasts forever.  For example,
165 C<100;@25> or C<100@0;0@25> means the first 100 allocations pass, then all
166 other allocations (until the program exits or crashes) have a 25% chance of
167 failing.
168
169 If the variable B<OPENSSL_MALLOC_FD> is parsed as a positive integer, then
170 it is taken as an open file descriptor, and a record of all allocations is
171 written to that descriptor.  If an allocation will fail, and the platform
172 supports it, then a backtrace will be written to the descriptor.  This can
173 be useful because a malloc may fail but not be checked, and problems will
174 only occur later.  The following example in classic shell syntax shows how
175 to use this (will not work on all platforms):
176
177   OPENSSL_MALLOC_FAILURES='200;@10'
178   export OPENSSL_MALLOC_FAILURES
179   OPENSSL_MALLOC_FD=3
180   export OPENSSL_MALLOC_FD
181   ...app invocation... 3>/tmp/log$$
182
183 OPENSSL_mem_debug_push(), OPENSSL_mem_debug_pop(),
184 CRYPTO_mem_debug_push(), and CRYPTO_mem_debug_pop()
185 have been deprecated and replaced with functions that only return zero.
186
187 =head1 RETURN VALUES
188
189 OPENSSL_malloc_init(), OPENSSL_free(), OPENSSL_clear_free()
190 CRYPTO_free(), CRYPTO_clear_free() and CRYPTO_get_mem_functions()
191 return no value.
192
193 CRYPTO_mem_leaks(), CRYPTO_mem_leaks_fp() and CRYPTO_mem_leaks_cb() return 1 if
194 there are no leaks, 0 if there are leaks and -1 if an error occurred.
195
196 OPENSSL_malloc(), OPENSSL_zalloc(), OPENSSL_realloc(),
197 OPENSSL_clear_realloc(),
198 CRYPTO_malloc(), CRYPTO_zalloc(), CRYPTO_realloc(),
199 CRYPTO_clear_realloc(),
200 OPENSSL_strdup(), and OPENSSL_strndup()
201 return a pointer to allocated memory or NULL on error.
202
203 CRYPTO_set_mem_functions() and CRYPTO_set_mem_debug()
204 return 1 on success or 0 on failure (almost
205 always because allocations have already happened).
206
207 CRYPTO_mem_ctrl() returns -1 if an error occurred, otherwise the
208 previous value of the mode.
209
210 =head1 NOTES
211
212 While it's permitted to swap out only a few and not all the functions
213 with CRYPTO_set_mem_functions(), it's recommended to swap them all out
214 at once, especially if OpenSSL was built with the
215 configuration option> C<crypto-mdebug>.
216
217 =head1 HISTORY
218
219 OPENSSL_mem_debug_push(), OPENSSL_mem_debug_pop(),
220 CRYPTO_mem_debug_push(), and CRYPTO_mem_debug_pop()
221 were deprecated in OpenSSL 3.0.
222
223
224 =head1 COPYRIGHT
225
226 Copyright 2016-2018 The OpenSSL Project Authors. All Rights Reserved.
227
228 Licensed under the Apache License 2.0 (the "License").  You may not use
229 this file except in compliance with the License.  You can obtain a copy
230 in the file LICENSE in the source distribution or at
231 L<https://www.openssl.org/source/license.html>.
232
233 =cut