add alloc.h
[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 /* avoid malloc()ing 0 bytes, see:
33  * https://www.securecoding.cert.org/confluence/display/seccode/MEM04-A.+Do+not+make+assumptions+about+the+result+of+allocating+0+bytes?focusedCommentId=5407003
34 */
35 static void *safe_malloc_(size_t size)
36 {
37         /* malloc(0) is undefined; FLAC src convention is to always allocate */
38         if(!size)
39                 size++;
40         return malloc(size);
41 }
42
43 static void *safe_calloc_(size_t nmemb, size_t size)
44 {
45         if(!nmemb || !size)
46                 return malloc(1); /* malloc(0) is undefined; FLAC src convention is to always allocate */
47         return calloc(nmemb, size);
48 }
49
50 /*@@@@ there's probably a better way to prevent overflows when allocating untrusted sums but this works for now */
51
52 static void *safe_malloc_add_2op_(size_t size1, size_t size2)
53 {
54         size2 += size1;
55         if(size2 < size1)
56                 return 0;
57         return safe_malloc_(size2);
58 }
59
60 static void *safe_malloc_add_3op_(size_t size1, size_t size2, size_t size3)
61 {
62         size2 += size1;
63         if(size2 < size1)
64                 return 0;
65         size3 += size2;
66         if(size3 < size2)
67                 return 0;
68         return safe_malloc_(size3);
69 }
70
71 static void *safe_malloc_add_4op_(size_t size1, size_t size2, size_t size3, size_t size4)
72 {
73         size2 += size1;
74         if(size2 < size1)
75                 return 0;
76         size3 += size2;
77         if(size3 < size2)
78                 return 0;
79         size4 += size3;
80         if(size4 < size3)
81                 return 0;
82         return safe_malloc_(size4);
83 }
84
85 static void *safe_malloc_mul_2op_(size_t size1, size_t size2)
86 #if 0
87 needs support for cases where sizeof(size_t) != 4
88 {
89         /* could be faster #ifdef'ing off SIZEOF_SIZE_T */
90         if(sizeof(size_t) == 4) {
91                 if ((double)size1 * (double)size2 < 4294967296.0)
92                         return malloc(size1*size2);
93         }
94         return 0;
95 }
96 #else
97 /* better? */
98 {
99         if(!size1 || !size2)
100                 return malloc(1); /* malloc(0) is undefined; FLAC src convention is to always allocate */
101         if(size1 > SIZE_MAX / size2)
102                 return 0;
103         return malloc(size1*size2);
104 }
105 #endif
106
107 static void *safe_malloc_mul_3op_(size_t size1, size_t size2, size_t size3)
108 {
109         if(!size1 || !size2 || !size3)
110                 return malloc(1); /* malloc(0) is undefined; FLAC src convention is to always allocate */
111         if(size1 > SIZE_MAX / size2)
112                 return 0;
113         size1 *= size2;
114         if(size1 > SIZE_MAX / size3)
115                 return 0;
116         return malloc(size1*size3);
117 }
118
119 /* size1*size2 + size3 */
120 static void *safe_malloc_mul2add_(size_t size1, size_t size2, size_t size3)
121 {
122         if(!size1 || !size2)
123                 return safe_malloc_(size3);
124         if(size1 > SIZE_MAX / size2)
125                 return 0;
126         return safe_malloc_add_2op_(size1*size2, size3);
127 }
128
129 static void *safe_realloc_add_2op_(void *ptr, size_t size1, size_t size2)
130 {
131         size2 += size1;
132         if(size2 < size1)
133                 return 0;
134         return realloc(ptr, size2);
135 }
136
137 static void *safe_realloc_add_3op_(void *ptr, size_t size1, size_t size2, size_t size3)
138 {
139         size2 += size1;
140         if(size2 < size1)
141                 return 0;
142         size3 += size2;
143         if(size3 < size2)
144                 return 0;
145         return realloc(ptr, size3);
146 }
147
148 static void *safe_realloc_add_4op_(void *ptr, size_t size1, size_t size2, size_t size3, size_t size4)
149 {
150         size2 += size1;
151         if(size2 < size1)
152                 return 0;
153         size3 += size2;
154         if(size3 < size2)
155                 return 0;
156         size4 += size3;
157         if(size4 < size3)
158                 return 0;
159         return realloc(ptr, size4);
160 }
161
162 static void *safe_realloc_mul_2op_(void *ptr, size_t size1, size_t size2)
163 {
164         if(!size1 || !size2)
165                 return realloc(ptr, 0); /* preserve POSIX realloc(ptr, 0) semantics */
166         if(size1 > SIZE_MAX / size2)
167                 return 0;
168         return realloc(ptr, size1*size2);
169 }
170
171 #endif