mem: Handle av_reallocp(..., 0) properly
[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     if (!size) {
145         av_freep(ptr);
146         return 0;
147     }
148     ret = av_realloc(*ptrptr, size);
149
150     if (!ret) {
151         av_freep(ptr);
152         return AVERROR(ENOMEM);
153     }
154
155     *ptrptr = ret;
156     return 0;
157 }
158
159 void *av_realloc_array(void *ptr, size_t nmemb, size_t size)
160 {
161     if (!size || nmemb >= INT_MAX / size)
162         return NULL;
163     return av_realloc(ptr, nmemb * size);
164 }
165
166 int av_reallocp_array(void *ptr, size_t nmemb, size_t size)
167 {
168     void **ptrptr = ptr;
169     void *ret;
170     if (!size || nmemb >= INT_MAX / size)
171         return AVERROR(ENOMEM);
172     if (!nmemb) {
173         av_freep(ptr);
174         return 0;
175     }
176     ret = av_realloc(*ptrptr, nmemb * size);
177     if (!ret) {
178         av_freep(ptr);
179         return AVERROR(ENOMEM);
180     }
181     *ptrptr = ret;
182     return 0;
183 }
184
185 void av_free(void *ptr)
186 {
187 #if CONFIG_MEMALIGN_HACK
188     if (ptr)
189         free((char *)ptr - ((char *)ptr)[-1]);
190 #elif HAVE_ALIGNED_MALLOC
191     _aligned_free(ptr);
192 #else
193     free(ptr);
194 #endif
195 }
196
197 void av_freep(void *arg)
198 {
199     void **ptr = (void **)arg;
200     av_free(*ptr);
201     *ptr = NULL;
202 }
203
204 void *av_mallocz(size_t size)
205 {
206     void *ptr = av_malloc(size);
207     if (ptr)
208         memset(ptr, 0, size);
209     return ptr;
210 }
211
212 char *av_strdup(const char *s)
213 {
214     char *ptr = NULL;
215     if (s) {
216         int len = strlen(s) + 1;
217         ptr = av_malloc(len);
218         if (ptr)
219             memcpy(ptr, s, len);
220     }
221     return ptr;
222 }
223
224 static void fill16(uint8_t *dst, int len)
225 {
226     uint32_t v = AV_RN16(dst - 2);
227
228     v |= v << 16;
229
230     while (len >= 4) {
231         AV_WN32(dst, v);
232         dst += 4;
233         len -= 4;
234     }
235
236     while (len--) {
237         *dst = dst[-2];
238         dst++;
239     }
240 }
241
242 static void fill24(uint8_t *dst, int len)
243 {
244 #if HAVE_BIGENDIAN
245     uint32_t v = AV_RB24(dst - 3);
246     uint32_t a = v << 8  | v >> 16;
247     uint32_t b = v << 16 | v >> 8;
248     uint32_t c = v << 24 | v;
249 #else
250     uint32_t v = AV_RL24(dst - 3);
251     uint32_t a = v       | v << 24;
252     uint32_t b = v >> 8  | v << 16;
253     uint32_t c = v >> 16 | v << 8;
254 #endif
255
256     while (len >= 12) {
257         AV_WN32(dst,     a);
258         AV_WN32(dst + 4, b);
259         AV_WN32(dst + 8, c);
260         dst += 12;
261         len -= 12;
262     }
263
264     if (len >= 4) {
265         AV_WN32(dst, a);
266         dst += 4;
267         len -= 4;
268     }
269
270     if (len >= 4) {
271         AV_WN32(dst, b);
272         dst += 4;
273         len -= 4;
274     }
275
276     while (len--) {
277         *dst = dst[-3];
278         dst++;
279     }
280 }
281
282 static void fill32(uint8_t *dst, int len)
283 {
284     uint32_t v = AV_RN32(dst - 4);
285
286     while (len >= 4) {
287         AV_WN32(dst, v);
288         dst += 4;
289         len -= 4;
290     }
291
292     while (len--) {
293         *dst = dst[-4];
294         dst++;
295     }
296 }
297
298 void av_memcpy_backptr(uint8_t *dst, int back, int cnt)
299 {
300     const uint8_t *src = &dst[-back];
301     if (!back)
302         return;
303
304     if (back == 1) {
305         memset(dst, *src, cnt);
306     } else if (back == 2) {
307         fill16(dst, cnt);
308     } else if (back == 3) {
309         fill24(dst, cnt);
310     } else if (back == 4) {
311         fill32(dst, cnt);
312     } else {
313         if (cnt >= 16) {
314             int blocklen = back;
315             while (cnt > blocklen) {
316                 memcpy(dst, src, blocklen);
317                 dst       += blocklen;
318                 cnt       -= blocklen;
319                 blocklen <<= 1;
320             }
321             memcpy(dst, src, cnt);
322             return;
323         }
324         if (cnt >= 8) {
325             AV_COPY32U(dst,     src);
326             AV_COPY32U(dst + 4, src + 4);
327             src += 8;
328             dst += 8;
329             cnt -= 8;
330         }
331         if (cnt >= 4) {
332             AV_COPY32U(dst, src);
333             src += 4;
334             dst += 4;
335             cnt -= 4;
336         }
337         if (cnt >= 2) {
338             AV_COPY16U(dst, src);
339             src += 2;
340             dst += 2;
341             cnt -= 2;
342         }
343         if (cnt)
344             *dst = *src;
345     }
346 }