Fix a couple of -Winline warnings.
[flac.git] / include / share / alloc.h
1 /* alloc - Convenience routines for safely allocating memory
2  * Copyright (C) 2007,2008,2009  Josh Coalson
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * - Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *
11  * - Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in the
13  * documentation and/or other materials provided with the distribution.
14  *
15  * - Neither the name of the Xiph.org Foundation nor the names of its
16  * contributors may be used to endorse or promote products derived from
17  * this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22  * A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
23  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
26  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31
32 #ifndef FLAC__SHARE__ALLOC_H
33 #define FLAC__SHARE__ALLOC_H
34
35 #if HAVE_CONFIG_H
36 #  include <config.h>
37 #endif
38
39 /* WATCHOUT: for c++ you may have to #define __STDC_LIMIT_MACROS 1 real early
40  * before #including this file,  otherwise SIZE_MAX might not be defined
41  */
42
43 #include <limits.h> /* for SIZE_MAX */
44 #if HAVE_STDINT_H
45 #include <stdint.h> /* for SIZE_MAX in case limits.h didn't get it */
46 #endif
47 #include <stdlib.h> /* for size_t, malloc(), etc */
48
49 #ifndef SIZE_MAX
50 # ifndef SIZE_T_MAX
51 #  ifdef _MSC_VER
52 #   define SIZE_T_MAX UINT_MAX
53 #  else
54 #   error
55 #  endif
56 # endif
57 # define SIZE_MAX SIZE_T_MAX
58 #endif
59
60 /* avoid malloc()ing 0 bytes, see:
61  * https://www.securecoding.cert.org/confluence/display/seccode/MEM04-A.+Do+not+make+assumptions+about+the+result+of+allocating+0+bytes?focusedCommentId=5407003
62 */
63 static inline void *safe_malloc_(size_t size)
64 {
65         /* malloc(0) is undefined; FLAC src convention is to always allocate */
66         if(!size)
67                 size++;
68         return malloc(size);
69 }
70
71 static inline void *safe_calloc_(size_t nmemb, size_t size)
72 {
73         if(!nmemb || !size)
74                 return malloc(1); /* malloc(0) is undefined; FLAC src convention is to always allocate */
75         return calloc(nmemb, size);
76 }
77
78 /*@@@@ there's probably a better way to prevent overflows when allocating untrusted sums but this works for now */
79
80 static inline void *safe_malloc_add_2op_(size_t size1, size_t size2)
81 {
82         size2 += size1;
83         if(size2 < size1)
84                 return 0;
85         return safe_malloc_(size2);
86 }
87
88 static inline void *safe_malloc_add_3op_(size_t size1, size_t size2, size_t size3)
89 {
90         size2 += size1;
91         if(size2 < size1)
92                 return 0;
93         size3 += size2;
94         if(size3 < size2)
95                 return 0;
96         return safe_malloc_(size3);
97 }
98
99 static inline void *safe_malloc_add_4op_(size_t size1, size_t size2, size_t size3, size_t size4)
100 {
101         size2 += size1;
102         if(size2 < size1)
103                 return 0;
104         size3 += size2;
105         if(size3 < size2)
106                 return 0;
107         size4 += size3;
108         if(size4 < size3)
109                 return 0;
110         return safe_malloc_(size4);
111 }
112
113 static inline void *safe_malloc_mul_2op_(size_t size1, size_t size2)
114 #if 0
115 needs support for cases where sizeof(size_t) != 4
116 {
117         /* could be faster #ifdef'ing off SIZEOF_SIZE_T */
118         if(sizeof(size_t) == 4) {
119                 if ((double)size1 * (double)size2 < 4294967296.0)
120                         return malloc(size1*size2);
121         }
122         return 0;
123 }
124 #else
125 /* better? */
126 {
127         if(!size1 || !size2)
128                 return malloc(1); /* malloc(0) is undefined; FLAC src convention is to always allocate */
129         if(size1 > SIZE_MAX / size2)
130                 return 0;
131         return malloc(size1*size2);
132 }
133 #endif
134
135 static inline void *safe_malloc_mul_3op_(size_t size1, size_t size2, size_t size3)
136 {
137         if(!size1 || !size2 || !size3)
138                 return malloc(1); /* malloc(0) is undefined; FLAC src convention is to always allocate */
139         if(size1 > SIZE_MAX / size2)
140                 return 0;
141         size1 *= size2;
142         if(size1 > SIZE_MAX / size3)
143                 return 0;
144         return malloc(size1*size3);
145 }
146
147 /* size1*size2 + size3 */
148 static inline void *safe_malloc_mul2add_(size_t size1, size_t size2, size_t size3)
149 {
150         if(!size1 || !size2)
151                 return safe_malloc_(size3);
152         if(size1 > SIZE_MAX / size2)
153                 return 0;
154         return safe_malloc_add_2op_(size1*size2, size3);
155 }
156
157 /* size1 * (size2 + size3) */
158 static inline void *safe_malloc_muladd2_(size_t size1, size_t size2, size_t size3)
159 {
160         if(!size1 || (!size2 && !size3))
161                 return malloc(1); /* malloc(0) is undefined; FLAC src convention is to always allocate */
162         size2 += size3;
163         if(size2 < size3)
164                 return 0;
165         return safe_malloc_mul_2op_(size1, size2);
166 }
167
168 static inline void *safe_realloc_add_2op_(void *ptr, size_t size1, size_t size2)
169 {
170         size2 += size1;
171         if(size2 < size1)
172                 return 0;
173         return realloc(ptr, size2);
174 }
175
176 static inline void *safe_realloc_add_3op_(void *ptr, size_t size1, size_t size2, size_t size3)
177 {
178         size2 += size1;
179         if(size2 < size1)
180                 return 0;
181         size3 += size2;
182         if(size3 < size2)
183                 return 0;
184         return realloc(ptr, size3);
185 }
186
187 static inline void *safe_realloc_add_4op_(void *ptr, size_t size1, size_t size2, size_t size3, size_t size4)
188 {
189         size2 += size1;
190         if(size2 < size1)
191                 return 0;
192         size3 += size2;
193         if(size3 < size2)
194                 return 0;
195         size4 += size3;
196         if(size4 < size3)
197                 return 0;
198         return realloc(ptr, size4);
199 }
200
201 static inline void *safe_realloc_mul_2op_(void *ptr, size_t size1, size_t size2)
202 {
203         if(!size1 || !size2)
204                 return realloc(ptr, 0); /* preserve POSIX realloc(ptr, 0) semantics */
205         if(size1 > SIZE_MAX / size2)
206                 return 0;
207         return realloc(ptr, size1*size2);
208 }
209
210 /* size1 * (size2 + size3) */
211 static inline void *safe_realloc_muladd2_(void *ptr, size_t size1, size_t size2, size_t size3)
212 {
213         if(!size1 || (!size2 && !size3))
214                 return realloc(ptr, 0); /* preserve POSIX realloc(ptr, 0) semantics */
215         size2 += size3;
216         if(size2 < size3)
217                 return 0;
218         return safe_realloc_mul_2op_(ptr, size1, size2);
219 }
220
221 #endif