Fix Windows SIZE_T_MAX definition.
[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 #include "share/compat.h"
49
50 #ifndef SIZE_MAX
51 # ifndef SIZE_T_MAX
52 #  ifdef _MSC_VER
53 #   ifdef _WIN64
54 #    define SIZE_T_MAX 0xffffffffffffffffui64
55 #   else
56 #    define SIZE_T_MAX 0xffffffff
57 #   endif
58 #  else
59 #   error
60 #  endif
61 # endif
62 # define SIZE_MAX SIZE_T_MAX
63 #endif
64
65 /* avoid malloc()ing 0 bytes, see:
66  * https://www.securecoding.cert.org/confluence/display/seccode/MEM04-A.+Do+not+make+assumptions+about+the+result+of+allocating+0+bytes?focusedCommentId=5407003
67 */
68 static inline void *safe_malloc_(size_t size)
69 {
70         /* malloc(0) is undefined; FLAC src convention is to always allocate */
71         if(!size)
72                 size++;
73         return malloc(size);
74 }
75
76 static inline void *safe_calloc_(size_t nmemb, size_t size)
77 {
78         if(!nmemb || !size)
79                 return malloc(1); /* malloc(0) is undefined; FLAC src convention is to always allocate */
80         return calloc(nmemb, size);
81 }
82
83 /*@@@@ there's probably a better way to prevent overflows when allocating untrusted sums but this works for now */
84
85 static inline void *safe_malloc_add_2op_(size_t size1, size_t size2)
86 {
87         size2 += size1;
88         if(size2 < size1)
89                 return 0;
90         return safe_malloc_(size2);
91 }
92
93 static inline void *safe_malloc_add_3op_(size_t size1, size_t size2, size_t size3)
94 {
95         size2 += size1;
96         if(size2 < size1)
97                 return 0;
98         size3 += size2;
99         if(size3 < size2)
100                 return 0;
101         return safe_malloc_(size3);
102 }
103
104 static inline void *safe_malloc_add_4op_(size_t size1, size_t size2, size_t size3, size_t size4)
105 {
106         size2 += size1;
107         if(size2 < size1)
108                 return 0;
109         size3 += size2;
110         if(size3 < size2)
111                 return 0;
112         size4 += size3;
113         if(size4 < size3)
114                 return 0;
115         return safe_malloc_(size4);
116 }
117
118 void *safe_malloc_mul_2op_(size_t size1, size_t size2) ;
119
120 static inline void *safe_malloc_mul_3op_(size_t size1, size_t size2, size_t size3)
121 {
122         if(!size1 || !size2 || !size3)
123                 return malloc(1); /* malloc(0) is undefined; FLAC src convention is to always allocate */
124         if(size1 > SIZE_MAX / size2)
125                 return 0;
126         size1 *= size2;
127         if(size1 > SIZE_MAX / size3)
128                 return 0;
129         return malloc(size1*size3);
130 }
131
132 /* size1*size2 + size3 */
133 static inline void *safe_malloc_mul2add_(size_t size1, size_t size2, size_t size3)
134 {
135         if(!size1 || !size2)
136                 return safe_malloc_(size3);
137         if(size1 > SIZE_MAX / size2)
138                 return 0;
139         return safe_malloc_add_2op_(size1*size2, size3);
140 }
141
142 /* size1 * (size2 + size3) */
143 static inline void *safe_malloc_muladd2_(size_t size1, size_t size2, size_t size3)
144 {
145         if(!size1 || (!size2 && !size3))
146                 return malloc(1); /* malloc(0) is undefined; FLAC src convention is to always allocate */
147         size2 += size3;
148         if(size2 < size3)
149                 return 0;
150         if(size1 > SIZE_MAX / size2)
151                 return 0;
152         return malloc(size1*size2);
153 }
154
155 static inline void *safe_realloc_add_2op_(void *ptr, size_t size1, size_t size2)
156 {
157         size2 += size1;
158         if(size2 < size1)
159                 return 0;
160         return realloc(ptr, size2);
161 }
162
163 static inline void *safe_realloc_add_3op_(void *ptr, size_t size1, size_t size2, size_t size3)
164 {
165         size2 += size1;
166         if(size2 < size1)
167                 return 0;
168         size3 += size2;
169         if(size3 < size2)
170                 return 0;
171         return realloc(ptr, size3);
172 }
173
174 static inline void *safe_realloc_add_4op_(void *ptr, size_t size1, size_t size2, size_t size3, size_t size4)
175 {
176         size2 += size1;
177         if(size2 < size1)
178                 return 0;
179         size3 += size2;
180         if(size3 < size2)
181                 return 0;
182         size4 += size3;
183         if(size4 < size3)
184                 return 0;
185         return realloc(ptr, size4);
186 }
187
188 static inline void *safe_realloc_mul_2op_(void *ptr, size_t size1, size_t size2)
189 {
190         if(!size1 || !size2)
191                 return realloc(ptr, 0); /* preserve POSIX realloc(ptr, 0) semantics */
192         if(size1 > SIZE_MAX / size2)
193                 return 0;
194         return realloc(ptr, size1*size2);
195 }
196
197 /* size1 * (size2 + size3) */
198 static inline void *safe_realloc_muladd2_(void *ptr, size_t size1, size_t size2, size_t size3)
199 {
200         if(!size1 || (!size2 && !size3))
201                 return realloc(ptr, 0); /* preserve POSIX realloc(ptr, 0) semantics */
202         size2 += size3;
203         if(size2 < size3)
204                 return 0;
205         return safe_realloc_mul_2op_(ptr, size1, size2);
206 }
207
208 #endif