1 /* alloc - Convenience routines for safely allocating memory
2 * Copyright (C) 2007-2009 Josh Coalson
3 * Copyright (C) 2011-2013 Xiph.Org Foundation
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
9 * - Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
12 * - Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * - Neither the name of the Xiph.org Foundation nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR
24 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
27 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 #ifndef FLAC__SHARE__ALLOC_H
34 #define FLAC__SHARE__ALLOC_H
40 /* WATCHOUT: for c++ you may have to #define __STDC_LIMIT_MACROS 1 real early
41 * before #including this file, otherwise SIZE_MAX might not be defined
44 #include <limits.h> /* for SIZE_MAX */
46 #include <stdint.h> /* for SIZE_MAX in case limits.h didn't get it */
48 #include <stdlib.h> /* for size_t, malloc(), etc */
49 #include "share/compat.h"
55 # define SIZE_T_MAX 0xffffffffffffffffui64
57 # define SIZE_T_MAX 0xffffffff
63 # define SIZE_MAX SIZE_T_MAX
66 /* avoid malloc()ing 0 bytes, see:
67 * https://www.securecoding.cert.org/confluence/display/seccode/MEM04-A.+Do+not+make+assumptions+about+the+result+of+allocating+0+bytes?focusedCommentId=5407003
69 static inline void *safe_malloc_(size_t size)
71 /* malloc(0) is undefined; FLAC src convention is to always allocate */
77 static inline void *safe_calloc_(size_t nmemb, size_t size)
80 return malloc(1); /* malloc(0) is undefined; FLAC src convention is to always allocate */
81 return calloc(nmemb, size);
84 /*@@@@ there's probably a better way to prevent overflows when allocating untrusted sums but this works for now */
86 static inline void *safe_malloc_add_2op_(size_t size1, size_t size2)
91 return safe_malloc_(size2);
94 static inline void *safe_malloc_add_3op_(size_t size1, size_t size2, size_t size3)
102 return safe_malloc_(size3);
105 static inline void *safe_malloc_add_4op_(size_t size1, size_t size2, size_t size3, size_t size4)
116 return safe_malloc_(size4);
119 void *safe_malloc_mul_2op_(size_t size1, size_t size2) ;
121 static inline void *safe_malloc_mul_3op_(size_t size1, size_t size2, size_t size3)
123 if(!size1 || !size2 || !size3)
124 return malloc(1); /* malloc(0) is undefined; FLAC src convention is to always allocate */
125 if(size1 > SIZE_MAX / size2)
128 if(size1 > SIZE_MAX / size3)
130 return malloc(size1*size3);
133 /* size1*size2 + size3 */
134 static inline void *safe_malloc_mul2add_(size_t size1, size_t size2, size_t size3)
137 return safe_malloc_(size3);
138 if(size1 > SIZE_MAX / size2)
140 return safe_malloc_add_2op_(size1*size2, size3);
143 /* size1 * (size2 + size3) */
144 static inline void *safe_malloc_muladd2_(size_t size1, size_t size2, size_t size3)
146 if(!size1 || (!size2 && !size3))
147 return malloc(1); /* malloc(0) is undefined; FLAC src convention is to always allocate */
151 if(size1 > SIZE_MAX / size2)
153 return malloc(size1*size2);
156 static inline void *safe_realloc_add_2op_(void *ptr, size_t size1, size_t size2)
161 return realloc(ptr, size2);
164 static inline void *safe_realloc_add_3op_(void *ptr, size_t size1, size_t size2, size_t size3)
172 return realloc(ptr, size3);
175 static inline void *safe_realloc_add_4op_(void *ptr, size_t size1, size_t size2, size_t size3, size_t size4)
186 return realloc(ptr, size4);
189 static inline void *safe_realloc_mul_2op_(void *ptr, size_t size1, size_t size2)
192 return realloc(ptr, 0); /* preserve POSIX realloc(ptr, 0) semantics */
193 if(size1 > SIZE_MAX / size2)
195 return realloc(ptr, size1*size2);
198 /* size1 * (size2 + size3) */
199 static inline void *safe_realloc_muladd2_(void *ptr, size_t size1, size_t size2, size_t size3)
201 if(!size1 || (!size2 && !size3))
202 return realloc(ptr, 0); /* preserve POSIX realloc(ptr, 0) semantics */
206 return safe_realloc_mul_2op_(ptr, size1, size2);