]> git.sesse.net Git - ffmpeg/blob - libavutil/mem.c
avutil/bprint: Fix doxygen comments
[ffmpeg] / libavutil / mem.c
1 /*
2  * default memory allocator for libavutil
3  * Copyright (c) 2002 Fabrice Bellard
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 /**
23  * @file
24  * default memory allocator for libavutil
25  */
26
27 #define _XOPEN_SOURCE 600
28
29 #include "config.h"
30
31 #include <limits.h>
32 #include <stdint.h>
33 #include <stdlib.h>
34 #include <string.h>
35 #if HAVE_MALLOC_H
36 #include <malloc.h>
37 #endif
38
39 #include "avassert.h"
40 #include "avutil.h"
41 #include "intreadwrite.h"
42 #include "mem.h"
43
44 #ifdef MALLOC_PREFIX
45
46 #define malloc         AV_JOIN(MALLOC_PREFIX, malloc)
47 #define memalign       AV_JOIN(MALLOC_PREFIX, memalign)
48 #define posix_memalign AV_JOIN(MALLOC_PREFIX, posix_memalign)
49 #define realloc        AV_JOIN(MALLOC_PREFIX, realloc)
50 #define free           AV_JOIN(MALLOC_PREFIX, free)
51
52 void *malloc(size_t size);
53 void *memalign(size_t align, size_t size);
54 int   posix_memalign(void **ptr, size_t align, size_t size);
55 void *realloc(void *ptr, size_t size);
56 void  free(void *ptr);
57
58 #endif /* MALLOC_PREFIX */
59
60 #define ALIGN (HAVE_AVX ? 32 : 16)
61
62 /* NOTE: if you want to override these functions with your own
63  * implementations (not recommended) you have to link libav* as
64  * dynamic libraries and remove -Wl,-Bsymbolic from the linker flags.
65  * Note that this will cost performance. */
66
67 static size_t max_alloc_size= INT_MAX;
68
69 void av_max_alloc(size_t max){
70     max_alloc_size = max;
71 }
72
73 void *av_malloc(size_t size)
74 {
75     void *ptr = NULL;
76 #if CONFIG_MEMALIGN_HACK
77     long diff;
78 #endif
79
80     /* let's disallow possible ambiguous cases */
81     if (size > (max_alloc_size - 32))
82         return NULL;
83
84 #if CONFIG_MEMALIGN_HACK
85     ptr = malloc(size + ALIGN);
86     if (!ptr)
87         return ptr;
88     diff              = ((~(long)ptr)&(ALIGN - 1)) + 1;
89     ptr               = (char *)ptr + diff;
90     ((char *)ptr)[-1] = diff;
91 #elif HAVE_POSIX_MEMALIGN
92     if (size) //OS X on SDK 10.6 has a broken posix_memalign implementation
93     if (posix_memalign(&ptr, ALIGN, size))
94         ptr = NULL;
95 #elif HAVE_ALIGNED_MALLOC
96     ptr = _aligned_malloc(size, ALIGN);
97 #elif HAVE_MEMALIGN
98 #ifndef __DJGPP__
99     ptr = memalign(ALIGN, size);
100 #else
101     ptr = memalign(size, ALIGN);
102 #endif
103     /* Why 64?
104      * Indeed, we should align it:
105      *   on  4 for 386
106      *   on 16 for 486
107      *   on 32 for 586, PPro - K6-III
108      *   on 64 for K7 (maybe for P3 too).
109      * Because L1 and L2 caches are aligned on those values.
110      * But I don't want to code such logic here!
111      */
112     /* Why 32?
113      * For AVX ASM. SSE / NEON needs only 16.
114      * Why not larger? Because I did not see a difference in benchmarks ...
115      */
116     /* benchmarks with P3
117      * memalign(64) + 1          3071, 3051, 3032
118      * memalign(64) + 2          3051, 3032, 3041
119      * memalign(64) + 4          2911, 2896, 2915
120      * memalign(64) + 8          2545, 2554, 2550
121      * memalign(64) + 16         2543, 2572, 2563
122      * memalign(64) + 32         2546, 2545, 2571
123      * memalign(64) + 64         2570, 2533, 2558
124      *
125      * BTW, malloc seems to do 8-byte alignment by default here.
126      */
127 #else
128     ptr = malloc(size);
129 #endif
130     if(!ptr && !size) {
131         size = 1;
132         ptr= av_malloc(1);
133     }
134 #if CONFIG_MEMORY_POISONING
135     if (ptr)
136         memset(ptr, FF_MEMORY_POISON, size);
137 #endif
138     return ptr;
139 }
140
141 void *av_realloc(void *ptr, size_t size)
142 {
143 #if CONFIG_MEMALIGN_HACK
144     int diff;
145 #endif
146
147     /* let's disallow possible ambiguous cases */
148     if (size > (max_alloc_size - 32))
149         return NULL;
150
151 #if CONFIG_MEMALIGN_HACK
152     //FIXME this isn't aligned correctly, though it probably isn't needed
153     if (!ptr)
154         return av_malloc(size);
155     diff = ((char *)ptr)[-1];
156     av_assert0(diff>0 && diff<=ALIGN);
157     ptr = realloc((char *)ptr - diff, size + diff);
158     if (ptr)
159         ptr = (char *)ptr + diff;
160     return ptr;
161 #elif HAVE_ALIGNED_MALLOC
162     return _aligned_realloc(ptr, size + !size, ALIGN);
163 #else
164     return realloc(ptr, size + !size);
165 #endif
166 }
167
168 void *av_realloc_f(void *ptr, size_t nelem, size_t elsize)
169 {
170     size_t size;
171     void *r;
172
173     if (av_size_mult(elsize, nelem, &size)) {
174         av_free(ptr);
175         return NULL;
176     }
177     r = av_realloc(ptr, size);
178     if (!r && size)
179         av_free(ptr);
180     return r;
181 }
182
183 void av_free(void *ptr)
184 {
185 #if CONFIG_MEMALIGN_HACK
186     if (ptr) {
187         int v= ((char *)ptr)[-1];
188         av_assert0(v>0 && v<=ALIGN);
189         free((char *)ptr - v);
190     }
191 #elif HAVE_ALIGNED_MALLOC
192     _aligned_free(ptr);
193 #else
194     free(ptr);
195 #endif
196 }
197
198 void av_freep(void *arg)
199 {
200     void **ptr = (void **)arg;
201     av_free(*ptr);
202     *ptr = NULL;
203 }
204
205 void *av_mallocz(size_t size)
206 {
207     void *ptr = av_malloc(size);
208     if (ptr)
209         memset(ptr, 0, size);
210     return ptr;
211 }
212
213 void *av_calloc(size_t nmemb, size_t size)
214 {
215     if (size <= 0 || nmemb >= INT_MAX / size)
216         return NULL;
217     return av_mallocz(nmemb * size);
218 }
219
220 char *av_strdup(const char *s)
221 {
222     char *ptr = NULL;
223     if (s) {
224         int len = strlen(s) + 1;
225         ptr = av_malloc(len);
226         if (ptr)
227             memcpy(ptr, s, len);
228     }
229     return ptr;
230 }
231
232 void *av_memdup(const void *p, size_t size)
233 {
234     void *ptr = NULL;
235     if (p) {
236         ptr = av_malloc(size);
237         if (ptr)
238             memcpy(ptr, p, size);
239     }
240     return ptr;
241 }
242
243 void av_dynarray_add(void *tab_ptr, int *nb_ptr, void *elem)
244 {
245     /* see similar ffmpeg.c:grow_array() */
246     int nb, nb_alloc;
247     intptr_t *tab;
248
249     nb = *nb_ptr;
250     tab = *(intptr_t**)tab_ptr;
251     if ((nb & (nb - 1)) == 0) {
252         if (nb == 0) {
253             nb_alloc = 1;
254         } else {
255             if (nb > INT_MAX / (2 * sizeof(intptr_t)))
256                 goto fail;
257             nb_alloc = nb * 2;
258         }
259         tab = av_realloc(tab, nb_alloc * sizeof(intptr_t));
260         if (!tab)
261             goto fail;
262         *(intptr_t**)tab_ptr = tab;
263     }
264     tab[nb++] = (intptr_t)elem;
265     *nb_ptr = nb;
266     return;
267
268 fail:
269     av_freep(tab_ptr);
270     *nb_ptr = 0;
271 }
272
273 void *av_dynarray2_add(void **tab_ptr, int *nb_ptr, size_t elem_size,
274                        const uint8_t *elem_data)
275 {
276     int nb = *nb_ptr, nb_alloc;
277     uint8_t *tab = *tab_ptr, *tab_elem_data;
278
279     if ((nb & (nb - 1)) == 0) {
280         if (nb == 0) {
281             nb_alloc = 1;
282         } else {
283             if (nb > INT_MAX / (2 * elem_size))
284                 goto fail;
285             nb_alloc = nb * 2;
286         }
287         tab = av_realloc(tab, nb_alloc * elem_size);
288         if (!tab)
289             goto fail;
290         *tab_ptr = tab;
291     }
292     *nb_ptr = nb + 1;
293     tab_elem_data = tab + nb*elem_size;
294     if (elem_data)
295         memcpy(tab_elem_data, elem_data, elem_size);
296     else if (CONFIG_MEMORY_POISONING)
297         memset(tab_elem_data, FF_MEMORY_POISON, elem_size);
298     return tab_elem_data;
299
300 fail:
301     av_freep(tab_ptr);
302     *nb_ptr = 0;
303     return NULL;
304 }
305
306 static void fill16(uint8_t *dst, int len)
307 {
308     uint32_t v = AV_RN16(dst - 2);
309
310     v |= v << 16;
311
312     while (len >= 4) {
313         AV_WN32(dst, v);
314         dst += 4;
315         len -= 4;
316     }
317
318     while (len--) {
319         *dst = dst[-2];
320         dst++;
321     }
322 }
323
324 static void fill24(uint8_t *dst, int len)
325 {
326 #if HAVE_BIGENDIAN
327     uint32_t v = AV_RB24(dst - 3);
328     uint32_t a = v << 8  | v >> 16;
329     uint32_t b = v << 16 | v >> 8;
330     uint32_t c = v << 24 | v;
331 #else
332     uint32_t v = AV_RL24(dst - 3);
333     uint32_t a = v       | v << 24;
334     uint32_t b = v >> 8  | v << 16;
335     uint32_t c = v >> 16 | v << 8;
336 #endif
337
338     while (len >= 12) {
339         AV_WN32(dst,     a);
340         AV_WN32(dst + 4, b);
341         AV_WN32(dst + 8, c);
342         dst += 12;
343         len -= 12;
344     }
345
346     if (len >= 4) {
347         AV_WN32(dst, a);
348         dst += 4;
349         len -= 4;
350     }
351
352     if (len >= 4) {
353         AV_WN32(dst, b);
354         dst += 4;
355         len -= 4;
356     }
357
358     while (len--) {
359         *dst = dst[-3];
360         dst++;
361     }
362 }
363
364 static void fill32(uint8_t *dst, int len)
365 {
366     uint32_t v = AV_RN32(dst - 4);
367
368     while (len >= 4) {
369         AV_WN32(dst, v);
370         dst += 4;
371         len -= 4;
372     }
373
374     while (len--) {
375         *dst = dst[-4];
376         dst++;
377     }
378 }
379
380 void av_memcpy_backptr(uint8_t *dst, int back, int cnt)
381 {
382     const uint8_t *src = &dst[-back];
383     if (!back)
384         return;
385
386     if (back == 1) {
387         memset(dst, *src, cnt);
388     } else if (back == 2) {
389         fill16(dst, cnt);
390     } else if (back == 3) {
391         fill24(dst, cnt);
392     } else if (back == 4) {
393         fill32(dst, cnt);
394     } else {
395         if (cnt >= 16) {
396             int blocklen = back;
397             while (cnt > blocklen) {
398                 memcpy(dst, src, blocklen);
399                 dst       += blocklen;
400                 cnt       -= blocklen;
401                 blocklen <<= 1;
402             }
403             memcpy(dst, src, cnt);
404             return;
405         }
406         if (cnt >= 8) {
407             AV_COPY32U(dst,     src);
408             AV_COPY32U(dst + 4, src + 4);
409             src += 8;
410             dst += 8;
411             cnt -= 8;
412         }
413         if (cnt >= 4) {
414             AV_COPY32U(dst, src);
415             src += 4;
416             dst += 4;
417             cnt -= 4;
418         }
419         if (cnt >= 2) {
420             AV_COPY16U(dst, src);
421             src += 2;
422             dst += 2;
423             cnt -= 2;
424         }
425         if (cnt)
426             *dst = *src;
427     }
428 }
429