mem: Document the non-compatibility of av_realloc() and av_malloc()
[ffmpeg.git] / libavutil / mem.h
1 /*
2  * copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at>
3  *
4  * This file is part of Libav.
5  *
6  * Libav 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.
10  *
11  * Libav 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.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with Libav; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 /**
22  * @file
23  * memory handling functions
24  */
25
26 #ifndef AVUTIL_MEM_H
27 #define AVUTIL_MEM_H
28
29 #include <limits.h>
30 #include <stdint.h>
31
32 #include "attributes.h"
33 #include "avutil.h"
34
35 /**
36  * @addtogroup lavu_mem
37  * @{
38  */
39
40
41 #if defined(__ICC) && __ICC < 1200 || defined(__SUNPRO_C)
42     #define DECLARE_ALIGNED(n,t,v)      t __attribute__ ((aligned (n))) v
43     #define DECLARE_ASM_CONST(n,t,v)    const t __attribute__ ((aligned (n))) v
44 #elif defined(__TI_COMPILER_VERSION__)
45     #define DECLARE_ALIGNED(n,t,v)                      \
46         AV_PRAGMA(DATA_ALIGN(v,n))                      \
47         t __attribute__((aligned(n))) v
48     #define DECLARE_ASM_CONST(n,t,v)                    \
49         AV_PRAGMA(DATA_ALIGN(v,n))                      \
50         static const t __attribute__((aligned(n))) v
51 #elif defined(__GNUC__)
52     #define DECLARE_ALIGNED(n,t,v)      t __attribute__ ((aligned (n))) v
53     #define DECLARE_ASM_CONST(n,t,v)    static const t av_used __attribute__ ((aligned (n))) v
54 #elif defined(_MSC_VER)
55     #define DECLARE_ALIGNED(n,t,v)      __declspec(align(n)) t v
56     #define DECLARE_ASM_CONST(n,t,v)    __declspec(align(n)) static const t v
57 #else
58     #define DECLARE_ALIGNED(n,t,v)      t v
59     #define DECLARE_ASM_CONST(n,t,v)    static const t v
60 #endif
61
62 #if AV_GCC_VERSION_AT_LEAST(3,1)
63     #define av_malloc_attrib __attribute__((__malloc__))
64 #else
65     #define av_malloc_attrib
66 #endif
67
68 #if AV_GCC_VERSION_AT_LEAST(4,3)
69     #define av_alloc_size(...) __attribute__((alloc_size(__VA_ARGS__)))
70 #else
71     #define av_alloc_size(...)
72 #endif
73
74 /**
75  * Allocate a block of size bytes with alignment suitable for all
76  * memory accesses (including vectors if available on the CPU).
77  * @param size Size in bytes for the memory block to be allocated.
78  * @return Pointer to the allocated block, NULL if the block cannot
79  * be allocated.
80  * @see av_mallocz()
81  */
82 void *av_malloc(size_t size) av_malloc_attrib av_alloc_size(1);
83
84 /**
85  * Allocate a block of size * nmemb bytes with av_malloc().
86  * @param nmemb Number of elements
87  * @param size Size of the single element
88  * @return Pointer to the allocated block, NULL if the block cannot
89  * be allocated.
90  * @see av_malloc()
91  */
92 av_alloc_size(1, 2) static inline void *av_malloc_array(size_t nmemb, size_t size)
93 {
94     if (size <= 0 || nmemb >= INT_MAX / size)
95         return NULL;
96     return av_malloc(nmemb * size);
97 }
98
99 /**
100  * Allocate or reallocate a block of memory.
101  * If ptr is NULL and size > 0, allocate a new block. If
102  * size is zero, free the memory block pointed to by ptr.
103  * @param ptr Pointer to a memory block already allocated with
104  * av_realloc() or NULL.
105  * @param size Size in bytes of the memory block to be allocated or
106  * reallocated.
107  * @return Pointer to a newly-reallocated block or NULL if the block
108  * cannot be reallocated or the function is used to free the memory block.
109  * @warning Pointers originating from the av_malloc() family of functions must
110  *          not be passed to av_realloc(). The former can be implemented using
111  *          memalign() (or other functions), and there is no guarantee that
112  *          pointers from such functions can be passed to realloc() at all.
113  *          The situation is undefined according to POSIX and may crash with
114  *          some libc implementations.
115  * @see av_fast_realloc()
116  */
117 void *av_realloc(void *ptr, size_t size) av_alloc_size(2);
118
119 /**
120  * Allocate or reallocate an array.
121  * If ptr is NULL and nmemb > 0, allocate a new block. If
122  * nmemb is zero, free the memory block pointed to by ptr.
123  * @param ptr Pointer to a memory block already allocated with
124  * av_realloc() or NULL.
125  * @param nmemb Number of elements
126  * @param size Size of the single element
127  * @return Pointer to a newly-reallocated block or NULL if the block
128  * cannot be reallocated or the function is used to free the memory block.
129  * @warning Pointers originating from the av_malloc() family of functions must
130  *          not be passed to av_realloc(). The former can be implemented using
131  *          memalign() (or other functions), and there is no guarantee that
132  *          pointers from such functions can be passed to realloc() at all.
133  *          The situation is undefined according to POSIX and may crash with
134  *          some libc implementations.
135  */
136 av_alloc_size(2, 3) void *av_realloc_array(void *ptr, size_t nmemb, size_t size);
137
138 /**
139  * Allocate or reallocate an array through a pointer to a pointer.
140  * If *ptr is NULL and nmemb > 0, allocate a new block. If
141  * nmemb is zero, free the memory block pointed to by ptr.
142  * @param ptr Pointer to a pointer to a memory block already allocated
143  * with av_realloc(), or pointer to a pointer to NULL.
144  * The pointer is updated on success, or freed on failure.
145  * @param nmemb Number of elements
146  * @param size Size of the single element
147  * @return Zero on success, an AVERROR error code on failure.
148  * @warning Pointers originating from the av_malloc() family of functions must
149  *          not be passed to av_realloc(). The former can be implemented using
150  *          memalign() (or other functions), and there is no guarantee that
151  *          pointers from such functions can be passed to realloc() at all.
152  *          The situation is undefined according to POSIX and may crash with
153  *          some libc implementations.
154  */
155 av_alloc_size(2, 3) int av_reallocp_array(void *ptr, size_t nmemb, size_t size);
156
157 /**
158  * Free a memory block which has been allocated with av_malloc(z)() or
159  * av_realloc().
160  * @param ptr Pointer to the memory block which should be freed.
161  * @note ptr = NULL is explicitly allowed.
162  * @note It is recommended that you use av_freep() instead.
163  * @see av_freep()
164  */
165 void av_free(void *ptr);
166
167 /**
168  * Allocate a block of size bytes with alignment suitable for all
169  * memory accesses (including vectors if available on the CPU) and
170  * zero all the bytes of the block.
171  * @param size Size in bytes for the memory block to be allocated.
172  * @return Pointer to the allocated block, NULL if it cannot be allocated.
173  * @see av_malloc()
174  */
175 void *av_mallocz(size_t size) av_malloc_attrib av_alloc_size(1);
176
177 /**
178  * Allocate a block of size * nmemb bytes with av_mallocz().
179  * @param nmemb Number of elements
180  * @param size Size of the single element
181  * @return Pointer to the allocated block, NULL if the block cannot
182  * be allocated.
183  * @see av_mallocz()
184  * @see av_malloc_array()
185  */
186 av_alloc_size(1, 2) static inline void *av_mallocz_array(size_t nmemb, size_t size)
187 {
188     if (size <= 0 || nmemb >= INT_MAX / size)
189         return NULL;
190     return av_mallocz(nmemb * size);
191 }
192
193 /**
194  * Duplicate the string s.
195  * @param s string to be duplicated
196  * @return Pointer to a newly-allocated string containing a
197  * copy of s or NULL if the string cannot be allocated.
198  */
199 char *av_strdup(const char *s) av_malloc_attrib;
200
201 /**
202  * Free a memory block which has been allocated with av_malloc(z)() or
203  * av_realloc() and set the pointer pointing to it to NULL.
204  * @param ptr Pointer to the pointer to the memory block which should
205  * be freed.
206  * @see av_free()
207  */
208 void av_freep(void *ptr);
209
210 /**
211  * deliberately overlapping memcpy implementation
212  * @param dst destination buffer
213  * @param back how many bytes back we start (the initial size of the overlapping window)
214  * @param cnt number of bytes to copy, must be >= 0
215  *
216  * cnt > back is valid, this will copy the bytes we just copied,
217  * thus creating a repeating pattern with a period length of back.
218  */
219 void av_memcpy_backptr(uint8_t *dst, int back, int cnt);
220
221 /**
222  * @}
223  */
224
225 #endif /* AVUTIL_MEM_H */