cannam@86: /* alloc - Convenience routines for safely allocating memory
cannam@86:  * Copyright (C) 2007  Josh Coalson
cannam@86:  *
cannam@86:  * This library is free software; you can redistribute it and/or
cannam@86:  * modify it under the terms of the GNU Lesser General Public
cannam@86:  * License as published by the Free Software Foundation; either
cannam@86:  * version 2.1 of the License, or (at your option) any later version.
cannam@86:  *
cannam@86:  * This library is distributed in the hope that it will be useful,
cannam@86:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
cannam@86:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
cannam@86:  * Lesser General Public License for more details.
cannam@86:  *
cannam@86:  * You should have received a copy of the GNU Lesser General Public
cannam@86:  * License along with this library; if not, write to the Free Software
cannam@86:  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
cannam@86:  */
cannam@86: 
cannam@86: #ifndef FLAC__SHARE__ALLOC_H
cannam@86: #define FLAC__SHARE__ALLOC_H
cannam@86: 
cannam@86: #if HAVE_CONFIG_H
cannam@86: #  include <config.h>
cannam@86: #endif
cannam@86: 
cannam@86: /* WATCHOUT: for c++ you may have to #define __STDC_LIMIT_MACROS 1 real early
cannam@86:  * before #including this file,  otherwise SIZE_MAX might not be defined
cannam@86:  */
cannam@86: 
cannam@86: #include <limits.h> /* for SIZE_MAX */
cannam@89: #if !defined _MSC_VER && !defined __EMX__
cannam@86: #include <stdint.h> /* for SIZE_MAX in case limits.h didn't get it */
cannam@86: #endif
cannam@86: #include <stdlib.h> /* for size_t, malloc(), etc */
cannam@86: 
cannam@86: #ifndef SIZE_MAX
cannam@86: # ifndef SIZE_T_MAX
cannam@86: #  ifdef _MSC_VER
cannam@86: #   define SIZE_T_MAX UINT_MAX
cannam@86: #  else
cannam@86: #   error
cannam@86: #  endif
cannam@86: # endif
cannam@86: # define SIZE_MAX SIZE_T_MAX
cannam@86: #endif
cannam@86: 
cannam@86: #ifndef FLaC__INLINE
cannam@86: #define FLaC__INLINE
cannam@86: #endif
cannam@86: 
cannam@86: /* avoid malloc()ing 0 bytes, see:
cannam@86:  * https://www.securecoding.cert.org/confluence/display/seccode/MEM04-A.+Do+not+make+assumptions+about+the+result+of+allocating+0+bytes?focusedCommentId=5407003
cannam@86: */
cannam@86: static FLaC__INLINE void *safe_malloc_(size_t size)
cannam@86: {
cannam@86: 	/* malloc(0) is undefined; FLAC src convention is to always allocate */
cannam@86: 	if(!size)
cannam@86: 		size++;
cannam@86: 	return malloc(size);
cannam@86: }
cannam@86: 
cannam@86: static FLaC__INLINE void *safe_calloc_(size_t nmemb, size_t size)
cannam@86: {
cannam@86: 	if(!nmemb || !size)
cannam@86: 		return malloc(1); /* malloc(0) is undefined; FLAC src convention is to always allocate */
cannam@86: 	return calloc(nmemb, size);
cannam@86: }
cannam@86: 
cannam@86: /*@@@@ there's probably a better way to prevent overflows when allocating untrusted sums but this works for now */
cannam@86: 
cannam@86: static FLaC__INLINE void *safe_malloc_add_2op_(size_t size1, size_t size2)
cannam@86: {
cannam@86: 	size2 += size1;
cannam@86: 	if(size2 < size1)
cannam@86: 		return 0;
cannam@86: 	return safe_malloc_(size2);
cannam@86: }
cannam@86: 
cannam@86: static FLaC__INLINE void *safe_malloc_add_3op_(size_t size1, size_t size2, size_t size3)
cannam@86: {
cannam@86: 	size2 += size1;
cannam@86: 	if(size2 < size1)
cannam@86: 		return 0;
cannam@86: 	size3 += size2;
cannam@86: 	if(size3 < size2)
cannam@86: 		return 0;
cannam@86: 	return safe_malloc_(size3);
cannam@86: }
cannam@86: 
cannam@86: static FLaC__INLINE void *safe_malloc_add_4op_(size_t size1, size_t size2, size_t size3, size_t size4)
cannam@86: {
cannam@86: 	size2 += size1;
cannam@86: 	if(size2 < size1)
cannam@86: 		return 0;
cannam@86: 	size3 += size2;
cannam@86: 	if(size3 < size2)
cannam@86: 		return 0;
cannam@86: 	size4 += size3;
cannam@86: 	if(size4 < size3)
cannam@86: 		return 0;
cannam@86: 	return safe_malloc_(size4);
cannam@86: }
cannam@86: 
cannam@86: static FLaC__INLINE void *safe_malloc_mul_2op_(size_t size1, size_t size2)
cannam@86: #if 0
cannam@86: needs support for cases where sizeof(size_t) != 4
cannam@86: {
cannam@86: 	/* could be faster #ifdef'ing off SIZEOF_SIZE_T */
cannam@86: 	if(sizeof(size_t) == 4) {
cannam@86: 		if ((double)size1 * (double)size2 < 4294967296.0)
cannam@86: 			return malloc(size1*size2);
cannam@86: 	}
cannam@86: 	return 0;
cannam@86: }
cannam@86: #else
cannam@86: /* better? */
cannam@86: {
cannam@86: 	if(!size1 || !size2)
cannam@86: 		return malloc(1); /* malloc(0) is undefined; FLAC src convention is to always allocate */
cannam@86: 	if(size1 > SIZE_MAX / size2)
cannam@86: 		return 0;
cannam@86: 	return malloc(size1*size2);
cannam@86: }
cannam@86: #endif
cannam@86: 
cannam@86: static FLaC__INLINE void *safe_malloc_mul_3op_(size_t size1, size_t size2, size_t size3)
cannam@86: {
cannam@86: 	if(!size1 || !size2 || !size3)
cannam@86: 		return malloc(1); /* malloc(0) is undefined; FLAC src convention is to always allocate */
cannam@86: 	if(size1 > SIZE_MAX / size2)
cannam@86: 		return 0;
cannam@86: 	size1 *= size2;
cannam@86: 	if(size1 > SIZE_MAX / size3)
cannam@86: 		return 0;
cannam@86: 	return malloc(size1*size3);
cannam@86: }
cannam@86: 
cannam@86: /* size1*size2 + size3 */
cannam@86: static FLaC__INLINE void *safe_malloc_mul2add_(size_t size1, size_t size2, size_t size3)
cannam@86: {
cannam@86: 	if(!size1 || !size2)
cannam@86: 		return safe_malloc_(size3);
cannam@86: 	if(size1 > SIZE_MAX / size2)
cannam@86: 		return 0;
cannam@86: 	return safe_malloc_add_2op_(size1*size2, size3);
cannam@86: }
cannam@86: 
cannam@86: /* size1 * (size2 + size3) */
cannam@86: static FLaC__INLINE void *safe_malloc_muladd2_(size_t size1, size_t size2, size_t size3)
cannam@86: {
cannam@86: 	if(!size1 || (!size2 && !size3))
cannam@86: 		return malloc(1); /* malloc(0) is undefined; FLAC src convention is to always allocate */
cannam@86: 	size2 += size3;
cannam@86: 	if(size2 < size3)
cannam@86: 		return 0;
cannam@86: 	return safe_malloc_mul_2op_(size1, size2);
cannam@86: }
cannam@86: 
cannam@86: static FLaC__INLINE void *safe_realloc_add_2op_(void *ptr, size_t size1, size_t size2)
cannam@86: {
cannam@86: 	size2 += size1;
cannam@86: 	if(size2 < size1)
cannam@86: 		return 0;
cannam@86: 	return realloc(ptr, size2);
cannam@86: }
cannam@86: 
cannam@86: static FLaC__INLINE void *safe_realloc_add_3op_(void *ptr, size_t size1, size_t size2, size_t size3)
cannam@86: {
cannam@86: 	size2 += size1;
cannam@86: 	if(size2 < size1)
cannam@86: 		return 0;
cannam@86: 	size3 += size2;
cannam@86: 	if(size3 < size2)
cannam@86: 		return 0;
cannam@86: 	return realloc(ptr, size3);
cannam@86: }
cannam@86: 
cannam@86: static FLaC__INLINE void *safe_realloc_add_4op_(void *ptr, size_t size1, size_t size2, size_t size3, size_t size4)
cannam@86: {
cannam@86: 	size2 += size1;
cannam@86: 	if(size2 < size1)
cannam@86: 		return 0;
cannam@86: 	size3 += size2;
cannam@86: 	if(size3 < size2)
cannam@86: 		return 0;
cannam@86: 	size4 += size3;
cannam@86: 	if(size4 < size3)
cannam@86: 		return 0;
cannam@86: 	return realloc(ptr, size4);
cannam@86: }
cannam@86: 
cannam@86: static FLaC__INLINE void *safe_realloc_mul_2op_(void *ptr, size_t size1, size_t size2)
cannam@86: {
cannam@86: 	if(!size1 || !size2)
cannam@86: 		return realloc(ptr, 0); /* preserve POSIX realloc(ptr, 0) semantics */
cannam@86: 	if(size1 > SIZE_MAX / size2)
cannam@86: 		return 0;
cannam@86: 	return realloc(ptr, size1*size2);
cannam@86: }
cannam@86: 
cannam@86: /* size1 * (size2 + size3) */
cannam@86: static FLaC__INLINE void *safe_realloc_muladd2_(void *ptr, size_t size1, size_t size2, size_t size3)
cannam@86: {
cannam@86: 	if(!size1 || (!size2 && !size3))
cannam@86: 		return realloc(ptr, 0); /* preserve POSIX realloc(ptr, 0) semantics */
cannam@86: 	size2 += size3;
cannam@86: 	if(size2 < size3)
cannam@86: 		return 0;
cannam@86: 	return safe_realloc_mul_2op_(ptr, size1, size2);
cannam@86: }
cannam@86: 
cannam@86: #endif