2 * copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at>
4 * This file is part of FFmpeg.
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24 * Memory handling functions
33 #include "attributes.h"
38 * @addtogroup lavu_mem
39 * Utilities for manipulating memory.
41 * FFmpeg has several applications of memory that are not required of a typical
42 * program. For example, the computing-heavy components like video decoding and
43 * encoding can be sped up significantly through the use of aligned memory.
45 * However, for each of FFmpeg's applications of memory, there might not be a
46 * recognized or standardized API for that specific use. Memory alignment, for
47 * instance, varies wildly depending on operating systems, architectures, and
48 * compilers. Hence, this component of @ref libavutil is created to make
49 * dealing with memory consistently possible on all platforms.
53 * @defgroup lavu_mem_macros Alignment Macros
54 * Helper macros for declaring aligned variables.
59 * @def DECLARE_ALIGNED(n,t,v)
60 * Declare a variable that is aligned in memory.
63 * DECLARE_ALIGNED(16, uint16_t, aligned_int) = 42;
64 * DECLARE_ALIGNED(32, uint8_t, aligned_array)[128];
66 * // The default-alignment equivalent would be
67 * uint16_t aligned_int = 42;
68 * uint8_t aligned_array[128];
71 * @param n Minimum alignment in bytes
72 * @param t Type of the variable (or array element)
73 * @param v Name of the variable
77 * @def DECLARE_ASM_CONST(n,t,v)
78 * Declare a static constant aligned variable appropriate for use in inline
82 * DECLARE_ASM_CONST(16, uint64_t, pw_08) = UINT64_C(0x0008000800080008);
85 * @param n Minimum alignment in bytes
86 * @param t Type of the variable (or array element)
87 * @param v Name of the variable
90 #if defined(__INTEL_COMPILER) && __INTEL_COMPILER < 1110 || defined(__SUNPRO_C)
91 #define DECLARE_ALIGNED(n,t,v) t __attribute__ ((aligned (n))) v
92 #define DECLARE_ASM_CONST(n,t,v) const t __attribute__ ((aligned (n))) v
93 #elif defined(__TI_COMPILER_VERSION__)
94 #define DECLARE_ALIGNED(n,t,v) \
95 AV_PRAGMA(DATA_ALIGN(v,n)) \
96 t __attribute__((aligned(n))) v
97 #define DECLARE_ASM_CONST(n,t,v) \
98 AV_PRAGMA(DATA_ALIGN(v,n)) \
99 static const t __attribute__((aligned(n))) v
100 #elif defined(__GNUC__) || defined(__clang__)
101 #define DECLARE_ALIGNED(n,t,v) t __attribute__ ((aligned (n))) v
102 #define DECLARE_ASM_CONST(n,t,v) static const t av_used __attribute__ ((aligned (n))) v
103 #elif defined(_MSC_VER)
104 #define DECLARE_ALIGNED(n,t,v) __declspec(align(n)) t v
105 #define DECLARE_ASM_CONST(n,t,v) __declspec(align(n)) static const t v
107 #define DECLARE_ALIGNED(n,t,v) t v
108 #define DECLARE_ASM_CONST(n,t,v) static const t v
116 * @defgroup lavu_mem_attrs Function Attributes
117 * Function attributes applicable to memory handling functions.
119 * These function attributes can help compilers emit more useful warnings, or
120 * generate better code.
125 * @def av_malloc_attrib
126 * Function attribute denoting a malloc-like function.
128 * @see <a href="https://gcc.gnu.org/onlinedocs/gcc/Common-Function-Attributes.html#index-g_t_0040code_007bmalloc_007d-function-attribute-3251">Function attribute `malloc` in GCC's documentation</a>
131 #if AV_GCC_VERSION_AT_LEAST(3,1)
132 #define av_malloc_attrib __attribute__((__malloc__))
134 #define av_malloc_attrib
138 * @def av_alloc_size(...)
139 * Function attribute used on a function that allocates memory, whose size is
140 * given by the specified parameter(s).
143 * void *av_malloc(size_t size) av_alloc_size(1);
144 * void *av_calloc(size_t nmemb, size_t size) av_alloc_size(1, 2);
147 * @param ... One or two parameter indexes, separated by a comma
149 * @see <a href="https://gcc.gnu.org/onlinedocs/gcc/Common-Function-Attributes.html#index-g_t_0040code_007balloc_005fsize_007d-function-attribute-3220">Function attribute `alloc_size` in GCC's documentation</a>
152 #if AV_GCC_VERSION_AT_LEAST(4,3)
153 #define av_alloc_size(...) __attribute__((alloc_size(__VA_ARGS__)))
155 #define av_alloc_size(...)
163 * @defgroup lavu_mem_funcs Heap Management
164 * Functions responsible for allocating, freeing, and copying memory.
166 * All memory allocation functions have a built-in upper limit of `INT_MAX`
167 * bytes. This may be changed with av_max_alloc(), although exercise extreme
168 * caution when doing so.
174 * Allocate a memory block with alignment suitable for all memory accesses
175 * (including vectors if available on the CPU).
177 * @param size Size in bytes for the memory block to be allocated
178 * @return Pointer to the allocated block, or `NULL` if the block cannot
182 void *av_malloc(size_t size) av_malloc_attrib av_alloc_size(1);
185 * Allocate a memory block with alignment suitable for all memory accesses
186 * (including vectors if available on the CPU) and zero all the bytes of the
189 * @param size Size in bytes for the memory block to be allocated
190 * @return Pointer to the allocated block, or `NULL` if it cannot be allocated
193 void *av_mallocz(size_t size) av_malloc_attrib av_alloc_size(1);
196 * Allocate a memory block for an array with av_malloc().
198 * The allocated memory will have size `size * nmemb` bytes.
200 * @param nmemb Number of element
201 * @param size Size of a single element
202 * @return Pointer to the allocated block, or `NULL` if the block cannot
206 av_alloc_size(1, 2) static inline void *av_malloc_array(size_t nmemb, size_t size)
208 if (!size || nmemb >= INT_MAX / size)
210 return av_malloc(nmemb * size);
214 * Allocate a memory block for an array with av_mallocz().
216 * The allocated memory will have size `size * nmemb` bytes.
218 * @param nmemb Number of elements
219 * @param size Size of the single element
220 * @return Pointer to the allocated block, or `NULL` if the block cannot
224 * @see av_malloc_array()
226 av_alloc_size(1, 2) static inline void *av_mallocz_array(size_t nmemb, size_t size)
228 if (!size || nmemb >= INT_MAX / size)
230 return av_mallocz(nmemb * size);
234 * Non-inlined equivalent of av_mallocz_array().
236 * Created for symmetry with the calloc() C function.
238 void *av_calloc(size_t nmemb, size_t size) av_malloc_attrib;
241 * Allocate, reallocate, or free a block of memory.
243 * If `ptr` is `NULL` and `size` > 0, allocate a new block. If `size` is
244 * zero, free the memory block pointed to by `ptr`. Otherwise, expand or
245 * shrink that block of memory according to `size`.
247 * @param ptr Pointer to a memory block already allocated with
248 * av_realloc() or `NULL`
249 * @param size Size in bytes of the memory block to be allocated or
252 * @return Pointer to a newly-reallocated block or `NULL` if the block
253 * cannot be reallocated or the function is used to free the memory block
255 * @warning Unlike av_malloc(), the returned pointer is not guaranteed to be
257 * @see av_fast_realloc()
260 void *av_realloc(void *ptr, size_t size) av_alloc_size(2);
263 * Allocate, reallocate, or free a block of memory through a pointer to a
266 * If `*ptr` is `NULL` and `size` > 0, allocate a new block. If `size` is
267 * zero, free the memory block pointed to by `*ptr`. Otherwise, expand or
268 * shrink that block of memory according to `size`.
270 * @param[in,out] ptr Pointer to a pointer to a memory block already allocated
271 * with av_realloc(), or a pointer to `NULL`. The pointer
272 * is updated on success, or freed on failure.
273 * @param[in] size Size in bytes for the memory block to be allocated or
276 * @return Zero on success, an AVERROR error code on failure
278 * @warning Unlike av_malloc(), the allocated memory is not guaranteed to be
281 av_warn_unused_result
282 int av_reallocp(void *ptr, size_t size);
285 * Allocate, reallocate, or free a block of memory.
287 * This function does the same thing as av_realloc(), except:
288 * - It takes two size arguments and allocates `nelem * elsize` bytes,
289 * after checking the result of the multiplication for integer overflow.
290 * - It frees the input block in case of failure, thus avoiding the memory
291 * leak with the classic
293 * buf = realloc(buf);
299 void *av_realloc_f(void *ptr, size_t nelem, size_t elsize);
302 * Allocate, reallocate, or free an array.
304 * If `ptr` is `NULL` and `nmemb` > 0, allocate a new block. If
305 * `nmemb` is zero, free the memory block pointed to by `ptr`.
307 * @param ptr Pointer to a memory block already allocated with
308 * av_realloc() or `NULL`
309 * @param nmemb Number of elements in the array
310 * @param size Size of the single element of the array
312 * @return Pointer to a newly-reallocated block or NULL if the block
313 * cannot be reallocated or the function is used to free the memory block
315 * @warning Unlike av_malloc(), the allocated memory is not guaranteed to be
317 * @see av_reallocp_array()
319 av_alloc_size(2, 3) void *av_realloc_array(void *ptr, size_t nmemb, size_t size);
322 * Allocate, reallocate, or free an array through a pointer to a pointer.
324 * If `*ptr` is `NULL` and `nmemb` > 0, allocate a new block. If `nmemb` is
325 * zero, free the memory block pointed to by `*ptr`.
327 * @param[in,out] ptr Pointer to a pointer to a memory block already
328 * allocated with av_realloc(), or a pointer to `NULL`.
329 * The pointer is updated on success, or freed on failure.
330 * @param[in] nmemb Number of elements
331 * @param[in] size Size of the single element
333 * @return Zero on success, an AVERROR error code on failure
335 * @warning Unlike av_malloc(), the allocated memory is not guaranteed to be
338 av_alloc_size(2, 3) int av_reallocp_array(void *ptr, size_t nmemb, size_t size);
341 * Reallocate the given buffer if it is not large enough, otherwise do nothing.
343 * If the given buffer is `NULL`, then a new uninitialized buffer is allocated.
345 * If the given buffer is not large enough, and reallocation fails, `NULL` is
346 * returned and `*size` is set to 0, but the original buffer is not changed or
349 * A typical use pattern follows:
352 * uint8_t *buf = ...;
353 * uint8_t *new_buf = av_fast_realloc(buf, ¤t_size, size_needed);
355 * // Allocation failed; clean up original buffer
357 * return AVERROR(ENOMEM);
361 * @param[in,out] ptr Already allocated buffer, or `NULL`
362 * @param[in,out] size Pointer to current size of buffer `ptr`. `*size` is
363 * changed to `min_size` in case of success or 0 in
365 * @param[in] min_size New size of buffer `ptr`
366 * @return `ptr` if the buffer is large enough, a pointer to newly reallocated
367 * buffer if the buffer was not large enough, or `NULL` in case of
370 * @see av_fast_malloc()
372 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
375 * Allocate a buffer, reusing the given one if large enough.
377 * Contrary to av_fast_realloc(), the current buffer contents might not be
378 * preserved and on error the old buffer is freed, thus no special handling to
379 * avoid memleaks is necessary.
381 * `*ptr` is allowed to be `NULL`, in which case allocation always happens if
382 * `size_needed` is greater than 0.
385 * uint8_t *buf = ...;
386 * av_fast_malloc(&buf, ¤t_size, size_needed);
388 * // Allocation failed; buf already freed
389 * return AVERROR(ENOMEM);
393 * @param[in,out] ptr Pointer to pointer to an already allocated buffer.
394 * `*ptr` will be overwritten with pointer to new
395 * buffer on success or `NULL` on failure
396 * @param[in,out] size Pointer to current size of buffer `*ptr`. `*size` is
397 * changed to `min_size` in case of success or 0 in
399 * @param[in] min_size New size of buffer `*ptr`
401 * @see av_fast_mallocz()
403 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
406 * Allocate and clear a buffer, reusing the given one if large enough.
408 * Like av_fast_malloc(), but all newly allocated space is initially cleared.
409 * Reused buffer is not cleared.
411 * `*ptr` is allowed to be `NULL`, in which case allocation always happens if
412 * `size_needed` is greater than 0.
414 * @param[in,out] ptr Pointer to pointer to an already allocated buffer.
415 * `*ptr` will be overwritten with pointer to new
416 * buffer on success or `NULL` on failure
417 * @param[in,out] size Pointer to current size of buffer `*ptr`. `*size` is
418 * changed to `min_size` in case of success or 0 in
420 * @param[in] min_size New size of buffer `*ptr`
421 * @see av_fast_malloc()
423 void av_fast_mallocz(void *ptr, unsigned int *size, size_t min_size);
426 * Free a memory block which has been allocated with a function of av_malloc()
427 * or av_realloc() family.
429 * @param ptr Pointer to the memory block which should be freed.
431 * @note `ptr = NULL` is explicitly allowed.
432 * @note It is recommended that you use av_freep() instead, to prevent leaving
433 * behind dangling pointers.
436 void av_free(void *ptr);
439 * Free a memory block which has been allocated with a function of av_malloc()
440 * or av_realloc() family, and set the pointer pointing to it to `NULL`.
443 * uint8_t *buf = av_malloc(16);
445 * // buf now contains a dangling pointer to freed memory, and accidental
446 * // dereference of buf will result in a use-after-free, which may be a
449 * uint8_t *buf = av_malloc(16);
451 * // buf is now NULL, and accidental dereference will only result in a
452 * // NULL-pointer dereference.
455 * @param ptr Pointer to the pointer to the memory block which should be freed
456 * @note `*ptr = NULL` is safe and leads to no action.
459 void av_freep(void *ptr);
462 * Duplicate a string.
464 * @param s String to be duplicated
465 * @return Pointer to a newly-allocated string containing a
466 * copy of `s` or `NULL` if the string cannot be allocated
469 char *av_strdup(const char *s) av_malloc_attrib;
472 * Duplicate a substring of a string.
474 * @param s String to be duplicated
475 * @param len Maximum length of the resulting string (not counting the
477 * @return Pointer to a newly-allocated string containing a
478 * substring of `s` or `NULL` if the string cannot be allocated
480 char *av_strndup(const char *s, size_t len) av_malloc_attrib;
483 * Duplicate a buffer with av_malloc().
485 * @param p Buffer to be duplicated
486 * @param size Size in bytes of the buffer copied
487 * @return Pointer to a newly allocated buffer containing a
488 * copy of `p` or `NULL` if the buffer cannot be allocated
490 void *av_memdup(const void *p, size_t size);
493 * Overlapping memcpy() implementation.
495 * @param dst Destination buffer
496 * @param back Number of bytes back to start copying (i.e. the initial size of
497 * the overlapping window); must be > 0
498 * @param cnt Number of bytes to copy; must be >= 0
500 * @note `cnt > back` is valid, this will copy the bytes we just copied,
501 * thus creating a repeating pattern with a period length of `back`.
503 void av_memcpy_backptr(uint8_t *dst, int back, int cnt);
510 * @defgroup lavu_mem_dynarray Dynamic Array
512 * Utilities to make an array grow when needed.
514 * Sometimes, the programmer would want to have an array that can grow when
515 * needed. The libavutil dynamic array utilities fill that need.
517 * libavutil supports two systems of appending elements onto a dynamically
518 * allocated array, the first one storing the pointer to the value in the
519 * array, and the second storing the value directly. In both systems, the
520 * caller is responsible for maintaining a variable containing the length of
521 * the array, as well as freeing of the array after use.
523 * The first system stores pointers to values in a block of dynamically
524 * allocated memory. Since only pointers are stored, the function does not need
525 * to know the size of the type. Both av_dynarray_add() and
526 * av_dynarray_add_nofree() implement this system.
529 * type **array = NULL; //< an array of pointers to values
530 * int nb = 0; //< a variable to keep track of the length of the array
532 * type to_be_added = ...;
533 * type to_be_added2 = ...;
535 * av_dynarray_add(&array, &nb, &to_be_added);
537 * return AVERROR(ENOMEM);
539 * av_dynarray_add(&array, &nb, &to_be_added2);
541 * return AVERROR(ENOMEM);
545 * // &to_be_added == array[0]
546 * // &to_be_added2 == array[1]
551 * The second system stores the value directly in a block of memory. As a
552 * result, the function has to know the size of the type. av_dynarray2_add()
553 * implements this mechanism.
556 * type *array = NULL; //< an array of values
557 * int nb = 0; //< a variable to keep track of the length of the array
559 * type to_be_added = ...;
560 * type to_be_added2 = ...;
562 * type *addr = av_dynarray2_add((void **)&array, &nb, sizeof(*array), NULL);
564 * return AVERROR(ENOMEM);
565 * memcpy(addr, &to_be_added, sizeof(to_be_added));
567 * // Shortcut of the above.
568 * type *addr = av_dynarray2_add((void **)&array, &nb, sizeof(*array),
569 * (const void *)&to_be_added2);
571 * return AVERROR(ENOMEM);
575 * // to_be_added == array[0]
576 * // to_be_added2 == array[1]
585 * Add the pointer to an element to a dynamic array.
587 * The array to grow is supposed to be an array of pointers to
588 * structures, and the element to add must be a pointer to an already
589 * allocated structure.
591 * The array is reallocated when its size reaches powers of 2.
592 * Therefore, the amortized cost of adding an element is constant.
594 * In case of success, the pointer to the array is updated in order to
595 * point to the new grown array, and the number pointed to by `nb_ptr`
597 * In case of failure, the array is freed, `*tab_ptr` is set to `NULL` and
598 * `*nb_ptr` is set to 0.
600 * @param[in,out] tab_ptr Pointer to the array to grow
601 * @param[in,out] nb_ptr Pointer to the number of elements in the array
602 * @param[in] elem Element to add
603 * @see av_dynarray_add_nofree(), av_dynarray2_add()
605 void av_dynarray_add(void *tab_ptr, int *nb_ptr, void *elem);
608 * Add an element to a dynamic array.
610 * Function has the same functionality as av_dynarray_add(),
611 * but it doesn't free memory on fails. It returns error code
612 * instead and leave current buffer untouched.
614 * @return >=0 on success, negative otherwise
615 * @see av_dynarray_add(), av_dynarray2_add()
617 av_warn_unused_result
618 int av_dynarray_add_nofree(void *tab_ptr, int *nb_ptr, void *elem);
621 * Add an element of size `elem_size` to a dynamic array.
623 * The array is reallocated when its number of elements reaches powers of 2.
624 * Therefore, the amortized cost of adding an element is constant.
626 * In case of success, the pointer to the array is updated in order to
627 * point to the new grown array, and the number pointed to by `nb_ptr`
629 * In case of failure, the array is freed, `*tab_ptr` is set to `NULL` and
630 * `*nb_ptr` is set to 0.
632 * @param[in,out] tab_ptr Pointer to the array to grow
633 * @param[in,out] nb_ptr Pointer to the number of elements in the array
634 * @param[in] elem_size Size in bytes of an element in the array
635 * @param[in] elem_data Pointer to the data of the element to add. If
636 * `NULL`, the space of the newly added element is
637 * allocated but left uninitialized.
639 * @return Pointer to the data of the element to copy in the newly allocated
641 * @see av_dynarray_add(), av_dynarray_add_nofree()
643 void *av_dynarray2_add(void **tab_ptr, int *nb_ptr, size_t elem_size,
644 const uint8_t *elem_data);
651 * @defgroup lavu_mem_misc Miscellaneous Functions
653 * Other functions related to memory allocation.
659 * Multiply two `size_t` values checking for overflow.
661 * @param[in] a,b Operands of multiplication
662 * @param[out] r Pointer to the result of the operation
663 * @return 0 on success, AVERROR(EINVAL) on overflow
665 static inline int av_size_mult(size_t a, size_t b, size_t *r)
668 /* Hack inspired from glibc: don't try the division if nelem and elsize
669 * are both less than sqrt(SIZE_MAX). */
670 if ((a | b) >= ((size_t)1 << (sizeof(size_t) * 4)) && a && t / a != b)
671 return AVERROR(EINVAL);
677 * Set the maximum size that may be allocated in one block.
679 * The value specified with this function is effective for all libavutil's @ref
680 * lavu_mem_funcs "heap management functions."
682 * By default, the max value is defined as `INT_MAX`.
684 * @param max Value to be set as the new maximum size
686 * @warning Exercise extreme caution when using this function. Don't touch
687 * this if you do not understand the full consequence of doing so.
689 void av_max_alloc(size_t max);
696 #endif /* AVUTIL_MEM_H */