handle SIZE_T_MAX
[flac.git] / include / share / alloc.h
1 /* alloc - Convenience routines for safely allocating memory
2  * Copyright (C) 2007  Josh Coalson
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
17  */
18
19 #ifndef FLAC__SHARE__ALLOC_H
20 #define FLAC__SHARE__ALLOC_H
21
22 /* WATCHOUT: for c++ you may have to #define __STDC_LIMIT_MACROS 1 real early
23  * before #including this file,  otherwise SIZE_MAX might not be defined
24  */
25
26 #include <limits.h> /* for SIZE_MAX */
27 #if !defined _MSC_VER && !defined __MINGW32__ && !defined __EMX__
28 #include <stdint.h> /* for SIZE_MAX in case limits.h didn't get it */
29 #endif
30 #include <stdlib.h> /* for size_t, malloc(), etc */
31
32 #ifndef SIZE_MAX
33 #ifndef SIZE_T_MAX
34 #error
35 #endif
36 #define SIZE_MAX SIZE_T_MAX
37 #endif
38
39 /* avoid malloc()ing 0 bytes, see:
40  * https://www.securecoding.cert.org/confluence/display/seccode/MEM04-A.+Do+not+make+assumptions+about+the+result+of+allocating+0+bytes?focusedCommentId=5407003
41 */
42 static void *safe_malloc_(size_t size)
43 {
44         /* malloc(0) is undefined; FLAC src convention is to always allocate */
45         if(!size)
46                 size++;
47         return malloc(size);
48 }
49
50 static void *safe_calloc_(size_t nmemb, size_t size)
51 {
52         if(!nmemb || !size)
53                 return malloc(1); /* malloc(0) is undefined; FLAC src convention is to always allocate */
54         return calloc(nmemb, size);
55 }
56
57 /*@@@@ there's probably a better way to prevent overflows when allocating untrusted sums but this works for now */
58
59 static void *safe_malloc_add_2op_(size_t size1, size_t size2)
60 {
61         size2 += size1;
62         if(size2 < size1)
63                 return 0;
64         return safe_malloc_(size2);
65 }
66
67 static void *safe_malloc_add_3op_(size_t size1, size_t size2, size_t size3)
68 {
69         size2 += size1;
70         if(size2 < size1)
71                 return 0;
72         size3 += size2;
73         if(size3 < size2)
74                 return 0;
75         return safe_malloc_(size3);
76 }
77
78 static void *safe_malloc_add_4op_(size_t size1, size_t size2, size_t size3, size_t size4)
79 {
80         size2 += size1;
81         if(size2 < size1)
82                 return 0;
83         size3 += size2;
84         if(size3 < size2)
85                 return 0;
86         size4 += size3;
87         if(size4 < size3)
88                 return 0;
89         return safe_malloc_(size4);
90 }
91
92 static void *safe_malloc_mul_2op_(size_t size1, size_t size2)
93 #if 0
94 needs support for cases where sizeof(size_t) != 4
95 {
96         /* could be faster #ifdef'ing off SIZEOF_SIZE_T */
97         if(sizeof(size_t) == 4) {
98                 if ((double)size1 * (double)size2 < 4294967296.0)
99                         return malloc(size1*size2);
100         }
101         return 0;
102 }
103 #else
104 /* better? */
105 {
106         if(!size1 || !size2)
107                 return malloc(1); /* malloc(0) is undefined; FLAC src convention is to always allocate */
108         if(size1 > SIZE_MAX / size2)
109                 return 0;
110         return malloc(size1*size2);
111 }
112 #endif
113
114 static void *safe_malloc_mul_3op_(size_t size1, size_t size2, size_t size3)
115 {
116         if(!size1 || !size2 || !size3)
117                 return malloc(1); /* malloc(0) is undefined; FLAC src convention is to always allocate */
118         if(size1 > SIZE_MAX / size2)
119                 return 0;
120         size1 *= size2;
121         if(size1 > SIZE_MAX / size3)
122                 return 0;
123         return malloc(size1*size3);
124 }
125
126 /* size1*size2 + size3 */
127 static void *safe_malloc_mul2add_(size_t size1, size_t size2, size_t size3)
128 {
129         if(!size1 || !size2)
130                 return safe_malloc_(size3);
131         if(size1 > SIZE_MAX / size2)
132                 return 0;
133         return safe_malloc_add_2op_(size1*size2, size3);
134 }
135
136 /* size1 * (size2 + size3) */
137 static void *safe_malloc_muladd2_(size_t size1, size_t size2, size_t size3)
138 {
139         if(!size1 || (!size2 && !size3))
140                 return malloc(1); /* malloc(0) is undefined; FLAC src convention is to always allocate */
141         size2 += size3;
142         if(size2 < size3)
143                 return 0;
144         return safe_malloc_mul_2op_(size1, size2);
145 }
146
147 static void *safe_realloc_add_2op_(void *ptr, size_t size1, size_t size2)
148 {
149         size2 += size1;
150         if(size2 < size1)
151                 return 0;
152         return realloc(ptr, size2);
153 }
154
155 static void *safe_realloc_add_3op_(void *ptr, size_t size1, size_t size2, size_t size3)
156 {
157         size2 += size1;
158         if(size2 < size1)
159                 return 0;
160         size3 += size2;
161         if(size3 < size2)
162                 return 0;
163         return realloc(ptr, size3);
164 }
165
166 static void *safe_realloc_add_4op_(void *ptr, size_t size1, size_t size2, size_t size3, size_t size4)
167 {
168         size2 += size1;
169         if(size2 < size1)
170                 return 0;
171         size3 += size2;
172         if(size3 < size2)
173                 return 0;
174         size4 += size3;
175         if(size4 < size3)
176                 return 0;
177         return realloc(ptr, size4);
178 }
179
180 static void *safe_realloc_mul_2op_(void *ptr, size_t size1, size_t size2)
181 {
182         if(!size1 || !size2)
183                 return realloc(ptr, 0); /* preserve POSIX realloc(ptr, 0) semantics */
184         if(size1 > SIZE_MAX / size2)
185                 return 0;
186         return realloc(ptr, size1*size2);
187 }
188
189 /* size1 * (size2 + size3) */
190 static void *safe_realloc_muladd2_(void *ptr, size_t size1, size_t size2, size_t size3)
191 {
192         if(!size1 || (!size2 && !size3))
193                 return realloc(ptr, 0); /* preserve POSIX realloc(ptr, 0) semantics */
194         size2 += size3;
195         if(size2 < size3)
196                 return 0;
197         return safe_realloc_mul_2op_(ptr, size1, size2);
198 }
199
200 #endif