mem: Introduce av_reallocp
[ffmpeg.git] / libavutil / mem.c
1 /*
2  * default memory allocator for libavutil
3  * Copyright (c) 2002 Fabrice Bellard
4  *
5  * This file is part of Libav.
6  *
7  * Libav 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  * Libav 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 Libav; 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 #include "config.h"
28
29 #include <limits.h>
30 #include <stdint.h>
31 #include <stdlib.h>
32 #include <string.h>
33 #if HAVE_MALLOC_H
34 #include <malloc.h>
35 #endif
36
37 #include "avutil.h"
38 #include "intreadwrite.h"
39 #include "mem.h"
40
41 #ifdef MALLOC_PREFIX
42
43 #define malloc         AV_JOIN(MALLOC_PREFIX, malloc)
44 #define memalign       AV_JOIN(MALLOC_PREFIX, memalign)
45 #define posix_memalign AV_JOIN(MALLOC_PREFIX, posix_memalign)
46 #define realloc        AV_JOIN(MALLOC_PREFIX, realloc)
47 #define free           AV_JOIN(MALLOC_PREFIX, free)
48
49 void *malloc(size_t size);
50 void *memalign(size_t align, size_t size);
51 int   posix_memalign(void **ptr, size_t align, size_t size);
52 void *realloc(void *ptr, size_t size);
53 void  free(void *ptr);
54
55 #endif /* MALLOC_PREFIX */
56
57 /* You can redefine av_malloc and av_free in your project to use your
58  * memory allocator. You do not need to suppress this file because the
59  * linker will do it automatically. */
60
61 void *av_malloc(size_t size)
62 {
63     void *ptr = NULL;
64 #if CONFIG_MEMALIGN_HACK
65     long diff;
66 #endif
67
68     /* let's disallow possibly ambiguous cases */
69     if (size > (INT_MAX - 32) || !size)
70         return NULL;
71
72 #if CONFIG_MEMALIGN_HACK
73     ptr = malloc(size + 32);
74     if (!ptr)
75         return ptr;
76     diff              = ((-(long)ptr - 1) & 31) + 1;
77     ptr               = (char *)ptr + diff;
78     ((char *)ptr)[-1] = diff;
79 #elif HAVE_POSIX_MEMALIGN
80     if (posix_memalign(&ptr, 32, size))
81         ptr = NULL;
82 #elif HAVE_ALIGNED_MALLOC
83     ptr = _aligned_malloc(size, 32);
84 #elif HAVE_MEMALIGN
85     ptr = memalign(32, size);
86     /* Why 64?
87      * Indeed, we should align it:
88      *   on  4 for 386
89      *   on 16 for 486
90      *   on 32 for 586, PPro - K6-III
91      *   on 64 for K7 (maybe for P3 too).
92      * Because L1 and L2 caches are aligned on those values.
93      * But I don't want to code such logic here!
94      */
95     /* Why 32?
96      * For AVX ASM. SSE / NEON needs only 16.
97      * Why not larger? Because I did not see a difference in benchmarks ...
98      */
99     /* benchmarks with P3
100      * memalign(64) + 1          3071, 3051, 3032
101      * memalign(64) + 2          3051, 3032, 3041
102      * memalign(64) + 4          2911, 2896, 2915
103      * memalign(64) + 8          2545, 2554, 2550
104      * memalign(64) + 16         2543, 2572, 2563
105      * memalign(64) + 32         2546, 2545, 2571
106      * memalign(64) + 64         2570, 2533, 2558
107      *
108      * BTW, malloc seems to do 8-byte alignment by default here.
109      */
110 #else
111     ptr = malloc(size);
112 #endif
113     return ptr;
114 }
115
116 void *av_realloc(void *ptr, size_t size)
117 {
118 #if CONFIG_MEMALIGN_HACK
119     int diff;
120 #endif
121
122     /* let's disallow possibly ambiguous cases */
123     if (size > (INT_MAX - 16))
124         return NULL;
125
126 #if CONFIG_MEMALIGN_HACK
127     //FIXME this isn't aligned correctly, though it probably isn't needed
128     if (!ptr)
129         return av_malloc(size);
130     diff = ((char *)ptr)[-1];
131     return (char *)realloc((char *)ptr - diff, size + diff) + diff;
132 #elif HAVE_ALIGNED_MALLOC
133     return _aligned_realloc(ptr, size, 32);
134 #else
135     return realloc(ptr, size);
136 #endif
137 }
138
139 int av_reallocp(void *ptr, size_t size)
140 {
141     void **ptrptr = ptr;
142     void *ret;
143
144     ret = av_realloc(*ptrptr, size);
145
146     if (!ret) {
147         av_freep(ptr);
148         return AVERROR(ENOMEM);
149     }
150
151     *ptrptr = ret;
152     return 0;
153 }
154
155 void *av_realloc_array(void *ptr, size_t nmemb, size_t size)
156 {
157     if (!size || nmemb >= INT_MAX / size)
158         return NULL;
159     return av_realloc(ptr, nmemb * size);
160 }
161
162 int av_reallocp_array(void *ptr, size_t nmemb, size_t size)
163 {
164     void **ptrptr = ptr;
165     void *ret;
166     if (!size || nmemb >= INT_MAX / size)
167         return AVERROR(ENOMEM);
168     if (!nmemb) {
169         av_freep(ptr);
170         return 0;
171     }
172     ret = av_realloc(*ptrptr, nmemb * size);
173     if (!ret) {
174         av_freep(ptr);
175         return AVERROR(ENOMEM);
176     }
177     *ptrptr = ret;
178     return 0;
179 }
180
181 void av_free(void *ptr)
182 {
183 #if CONFIG_MEMALIGN_HACK
184     if (ptr)
185         free((char *)ptr - ((char *)ptr)[-1]);
186 #elif HAVE_ALIGNED_MALLOC
187     _aligned_free(ptr);
188 #else
189     free(ptr);
190 #endif
191 }
192
193 void av_freep(void *arg)
194 {
195     void **ptr = (void **)arg;
196     av_free(*ptr);
197     *ptr = NULL;
198 }
199
200 void *av_mallocz(size_t size)
201 {
202     void *ptr = av_malloc(size);
203     if (ptr)
204         memset(ptr, 0, size);
205     return ptr;
206 }
207
208 char *av_strdup(const char *s)
209 {
210     char *ptr = NULL;
211     if (s) {
212         int len = strlen(s) + 1;
213         ptr = av_malloc(len);
214         if (ptr)
215             memcpy(ptr, s, len);
216     }
217     return ptr;
218 }
219
220 static void fill16(uint8_t *dst, int len)
221 {
222     uint32_t v = AV_RN16(dst - 2);
223
224     v |= v << 16;
225
226     while (len >= 4) {
227         AV_WN32(dst, v);
228         dst += 4;
229         len -= 4;
230     }
231
232     while (len--) {
233         *dst = dst[-2];
234         dst++;
235     }
236 }
237
238 static void fill24(uint8_t *dst, int len)
239 {
240 #if HAVE_BIGENDIAN
241     uint32_t v = AV_RB24(dst - 3);
242     uint32_t a = v << 8  | v >> 16;
243     uint32_t b = v << 16 | v >> 8;
244     uint32_t c = v << 24 | v;
245 #else
246     uint32_t v = AV_RL24(dst - 3);
247     uint32_t a = v       | v << 24;
248     uint32_t b = v >> 8  | v << 16;
249     uint32_t c = v >> 16 | v << 8;
250 #endif
251
252     while (len >= 12) {
253         AV_WN32(dst,     a);
254         AV_WN32(dst + 4, b);
255         AV_WN32(dst + 8, c);
256         dst += 12;
257         len -= 12;
258     }
259
260     if (len >= 4) {
261         AV_WN32(dst, a);
262         dst += 4;
263         len -= 4;
264     }
265
266     if (len >= 4) {
267         AV_WN32(dst, b);
268         dst += 4;
269         len -= 4;
270     }
271
272     while (len--) {
273         *dst = dst[-3];
274         dst++;
275     }
276 }
277
278 static void fill32(uint8_t *dst, int len)
279 {
280     uint32_t v = AV_RN32(dst - 4);
281
282     while (len >= 4) {
283         AV_WN32(dst, v);
284         dst += 4;
285         len -= 4;
286     }
287
288     while (len--) {
289         *dst = dst[-4];
290         dst++;
291     }
292 }
293
294 void av_memcpy_backptr(uint8_t *dst, int back, int cnt)
295 {
296     const uint8_t *src = &dst[-back];
297     if (!back)
298         return;
299
300     if (back == 1) {
301         memset(dst, *src, cnt);
302     } else if (back == 2) {
303         fill16(dst, cnt);
304     } else if (back == 3) {
305         fill24(dst, cnt);
306     } else if (back == 4) {
307         fill32(dst, cnt);
308     } else {
309         if (cnt >= 16) {
310             int blocklen = back;
311             while (cnt > blocklen) {
312                 memcpy(dst, src, blocklen);
313                 dst       += blocklen;
314                 cnt       -= blocklen;
315                 blocklen <<= 1;
316             }
317             memcpy(dst, src, cnt);
318             return;
319         }
320         if (cnt >= 8) {
321             AV_COPY32U(dst,     src);
322             AV_COPY32U(dst + 4, src + 4);
323             src += 8;
324             dst += 8;
325             cnt -= 8;
326         }
327         if (cnt >= 4) {
328             AV_COPY32U(dst, src);
329             src += 4;
330             dst += 4;
331             cnt -= 4;
332         }
333         if (cnt >= 2) {
334             AV_COPY16U(dst, src);
335             src += 2;
336             dst += 2;
337             cnt -= 2;
338         }
339         if (cnt)
340             *dst = *src;
341     }
342 }