2011-02-21 09:23:34 +00:00
|
|
|
/*
|
2002-10-12 11:37:38 +00:00
|
|
|
* This program is free software; you can redistribute it and/or
|
|
|
|
* modify it under the terms of the GNU General Public License
|
|
|
|
* as published by the Free Software Foundation; either version 2
|
2008-04-16 22:40:48 +00:00
|
|
|
* of the License, or (at your option) any later version.
|
2002-10-12 11:37:38 +00:00
|
|
|
*
|
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU General Public License
|
|
|
|
* along with this program; if not, write to the Free Software Foundation,
|
2010-02-12 13:34:04 +00:00
|
|
|
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
2002-10-12 11:37:38 +00:00
|
|
|
*
|
|
|
|
* The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
|
|
|
|
* All rights reserved.
|
|
|
|
*/
|
|
|
|
|
2019-02-17 21:08:12 +00:00
|
|
|
/** \file
|
|
|
|
* \ingroup MEM
|
2012-07-14 15:29:45 +00:00
|
|
|
*
|
|
|
|
* \brief Read \ref MEMPage
|
2002-10-12 11:37:38 +00:00
|
|
|
*
|
2011-02-22 16:12:12 +00:00
|
|
|
* \page MEMPage Guarded memory(de)allocation
|
2002-10-12 11:37:38 +00:00
|
|
|
*
|
2011-02-21 09:23:34 +00:00
|
|
|
* \section aboutmem c-style guarded memory allocation
|
|
|
|
*
|
2011-02-22 16:12:12 +00:00
|
|
|
* \subsection memabout About the MEM module
|
2002-10-12 11:37:38 +00:00
|
|
|
*
|
|
|
|
* MEM provides guarded malloc/calloc calls. All memory is enclosed by
|
|
|
|
* pads, to detect out-of-bound writes. All blocks are placed in a
|
|
|
|
* linked list, so they remain reachable at all times. There is no
|
|
|
|
* back-up in case the linked-list related data is lost.
|
|
|
|
*
|
2011-02-22 16:12:12 +00:00
|
|
|
* \subsection memissues Known issues with MEM
|
2002-10-12 11:37:38 +00:00
|
|
|
*
|
|
|
|
* There are currently no known issues with MEM. Note that there is a
|
|
|
|
* second intern/ module with MEM_ prefix, for use in c++.
|
2019-01-24 05:20:16 +00:00
|
|
|
*
|
2011-02-22 16:12:12 +00:00
|
|
|
* \subsection memdependencies Dependencies
|
2002-10-12 11:37:38 +00:00
|
|
|
* - stdlib
|
|
|
|
* - stdio
|
2019-01-24 05:20:16 +00:00
|
|
|
*
|
2011-02-22 16:12:12 +00:00
|
|
|
* \subsection memdocs API Documentation
|
|
|
|
* See \ref MEM_guardedalloc.h
|
2011-02-21 09:23:34 +00:00
|
|
|
*/
|
2002-10-12 11:37:38 +00:00
|
|
|
|
2012-02-17 18:59:41 +00:00
|
|
|
#ifndef __MEM_GUARDEDALLOC_H__
|
|
|
|
#define __MEM_GUARDEDALLOC_H__
|
2002-10-12 11:37:38 +00:00
|
|
|
|
2012-07-14 12:47:49 +00:00
|
|
|
#include <stdio.h> /* needed for FILE* */
|
2013-05-28 19:35:26 +00:00
|
|
|
|
2013-10-10 11:58:01 +00:00
|
|
|
/* needed for uintptr_t and attributes, exception, dont use BLI anywhere else in MEM_* */
|
|
|
|
#include "../../source/blender/blenlib/BLI_compiler_attrs.h"
|
2020-03-19 08:33:03 +00:00
|
|
|
#include "../../source/blender/blenlib/BLI_sys_types.h"
|
2012-07-31 15:05:09 +00:00
|
|
|
|
2002-10-12 11:37:38 +00:00
|
|
|
#ifdef __cplusplus
|
|
|
|
extern "C" {
|
|
|
|
#endif
|
|
|
|
|
2010-07-25 01:45:53 +00:00
|
|
|
/** Returns the length of the allocated memory segment pointed at
|
2019-05-01 10:50:02 +00:00
|
|
|
* by vmemh. If the pointer was not previously allocated by this
|
|
|
|
* module, the result is undefined.*/
|
2013-10-10 11:58:01 +00:00
|
|
|
extern size_t (*MEM_allocN_len)(const void *vmemh) ATTR_WARN_UNUSED_RESULT;
|
2019-04-17 04:17:24 +00:00
|
|
|
|
2002-10-12 11:37:38 +00:00
|
|
|
/**
|
2019-05-01 10:50:02 +00:00
|
|
|
* Release memory previously allocated by this module.
|
|
|
|
*/
|
2013-10-10 11:58:01 +00:00
|
|
|
extern void (*MEM_freeN)(void *vmemh);
|
2019-04-17 04:17:24 +00:00
|
|
|
|
2013-05-12 05:54:33 +00:00
|
|
|
#if 0 /* UNUSED */
|
2019-04-17 06:16:53 +00:00
|
|
|
/**
|
2009-11-11 03:45:26 +00:00
|
|
|
* Return zero if memory is not in allocated list
|
|
|
|
*/
|
2019-04-17 06:16:53 +00:00
|
|
|
extern short (*MEM_testN)(void *vmemh);
|
2013-05-12 05:54:33 +00:00
|
|
|
#endif
|
2009-11-11 03:45:26 +00:00
|
|
|
|
2002-10-12 11:37:38 +00:00
|
|
|
/**
|
2019-05-01 10:50:02 +00:00
|
|
|
* Duplicates a block of memory, and returns a pointer to the
|
|
|
|
* newly allocated block. */
|
2013-10-10 11:58:01 +00:00
|
|
|
extern void *(*MEM_dupallocN)(const void *vmemh) /* ATTR_MALLOC */ ATTR_WARN_UNUSED_RESULT;
|
2019-04-17 04:17:24 +00:00
|
|
|
|
2010-02-08 14:59:59 +00:00
|
|
|
/**
|
2019-05-01 10:50:02 +00:00
|
|
|
* Reallocates a block of memory, and returns pointer to the newly
|
|
|
|
* allocated block, the old one is freed. this is not as optimized
|
|
|
|
* as a system realloc but just makes a new allocation and copies
|
|
|
|
* over from existing memory. */
|
2013-10-10 11:58:01 +00:00
|
|
|
extern void *(*MEM_reallocN_id)(void *vmemh,
|
|
|
|
size_t len,
|
|
|
|
const char *str) /* ATTR_MALLOC */ ATTR_WARN_UNUSED_RESULT
|
|
|
|
ATTR_ALLOC_SIZE(2);
|
2019-04-17 04:17:24 +00:00
|
|
|
|
2002-10-12 11:37:38 +00:00
|
|
|
/**
|
2019-05-01 10:50:02 +00:00
|
|
|
* A variant of realloc which zeros new bytes
|
|
|
|
*/
|
2013-10-10 11:58:01 +00:00
|
|
|
extern void *(*MEM_recallocN_id)(void *vmemh,
|
|
|
|
size_t len,
|
|
|
|
const char *str) /* ATTR_MALLOC */ ATTR_WARN_UNUSED_RESULT
|
|
|
|
ATTR_ALLOC_SIZE(2);
|
2012-08-11 12:16:09 +00:00
|
|
|
|
2013-08-04 03:00:04 +00:00
|
|
|
#define MEM_reallocN(vmemh, len) MEM_reallocN_id(vmemh, len, __func__)
|
|
|
|
#define MEM_recallocN(vmemh, len) MEM_recallocN_id(vmemh, len, __func__)
|
|
|
|
|
2012-08-11 12:16:09 +00:00
|
|
|
/**
|
2019-05-01 10:50:02 +00:00
|
|
|
* Allocate a block of memory of size len, with tag name str. The
|
|
|
|
* memory is cleared. The name must be static, because only a
|
|
|
|
* pointer to it is stored ! */
|
2013-10-10 11:58:01 +00:00
|
|
|
extern void *(*MEM_callocN)(size_t len, const char *str) /* ATTR_MALLOC */ ATTR_WARN_UNUSED_RESULT
|
|
|
|
ATTR_ALLOC_SIZE(1) ATTR_NONNULL(2);
|
2019-04-17 04:17:24 +00:00
|
|
|
|
2018-01-14 20:53:32 +00:00
|
|
|
/**
|
2019-05-01 10:50:02 +00:00
|
|
|
* Allocate a block of memory of size (len * size), with tag name
|
|
|
|
* str, aborting in case of integer overflows to prevent vulnerabilities.
|
|
|
|
* The memory is cleared. The name must be static, because only a
|
|
|
|
* pointer to it is stored ! */
|
2018-01-14 20:53:32 +00:00
|
|
|
extern void *(*MEM_calloc_arrayN)(size_t len,
|
|
|
|
size_t size,
|
|
|
|
const char *str) /* ATTR_MALLOC */ ATTR_WARN_UNUSED_RESULT
|
|
|
|
ATTR_ALLOC_SIZE(1, 2) ATTR_NONNULL(3);
|
2019-04-17 04:17:24 +00:00
|
|
|
|
2012-07-14 15:29:45 +00:00
|
|
|
/**
|
2019-05-01 10:50:02 +00:00
|
|
|
* Allocate a block of memory of size len, with tag name str. The
|
|
|
|
* name must be a static, because only a pointer to it is stored !
|
|
|
|
* */
|
2013-10-10 11:58:01 +00:00
|
|
|
extern void *(*MEM_mallocN)(size_t len, const char *str) /* ATTR_MALLOC */ ATTR_WARN_UNUSED_RESULT
|
|
|
|
ATTR_ALLOC_SIZE(1) ATTR_NONNULL(2);
|
2019-04-17 04:17:24 +00:00
|
|
|
|
2018-01-14 20:53:32 +00:00
|
|
|
/**
|
2019-05-01 10:50:02 +00:00
|
|
|
* Allocate a block of memory of size (len * size), with tag name str,
|
|
|
|
* aborting in case of integer overflow to prevent vulnerabilities. The
|
|
|
|
* name must be a static, because only a pointer to it is stored !
|
|
|
|
* */
|
2018-01-14 20:53:32 +00:00
|
|
|
extern void *(*MEM_malloc_arrayN)(size_t len,
|
|
|
|
size_t size,
|
|
|
|
const char *str) /* ATTR_MALLOC */ ATTR_WARN_UNUSED_RESULT
|
|
|
|
ATTR_ALLOC_SIZE(1, 2) ATTR_NONNULL(3);
|
2019-04-17 04:17:24 +00:00
|
|
|
|
2014-06-13 18:30:13 +00:00
|
|
|
/**
|
2019-05-01 10:50:02 +00:00
|
|
|
* Allocate an aligned block of memory of size len, with tag name str. The
|
|
|
|
* name must be a static, because only a pointer to it is stored !
|
|
|
|
* */
|
2014-06-13 18:30:13 +00:00
|
|
|
extern void *(*MEM_mallocN_aligned)(size_t len,
|
|
|
|
size_t alignment,
|
|
|
|
const char *str) /* ATTR_MALLOC */ ATTR_WARN_UNUSED_RESULT
|
|
|
|
ATTR_ALLOC_SIZE(1) ATTR_NONNULL(3);
|
2019-04-17 04:17:24 +00:00
|
|
|
|
2008-01-03 14:53:44 +00:00
|
|
|
/** Print a list of the names and sizes of all allocated memory
|
2019-05-01 10:50:02 +00:00
|
|
|
* blocks. as a python dict for easy investigation */
|
2013-10-10 11:58:01 +00:00
|
|
|
extern void (*MEM_printmemlist_pydict)(void);
|
2019-04-17 04:17:24 +00:00
|
|
|
|
2002-10-12 11:37:38 +00:00
|
|
|
/** Print a list of the names and sizes of all allocated memory
|
2019-05-01 10:50:02 +00:00
|
|
|
* blocks. */
|
2013-10-10 11:58:01 +00:00
|
|
|
extern void (*MEM_printmemlist)(void);
|
2019-04-17 04:17:24 +00:00
|
|
|
|
2009-11-10 21:33:53 +00:00
|
|
|
/** calls the function on all allocated memory blocks. */
|
2013-10-10 11:58:01 +00:00
|
|
|
extern void (*MEM_callbackmemlist)(void (*func)(void *));
|
2019-04-17 04:17:24 +00:00
|
|
|
|
2008-02-01 12:14:15 +00:00
|
|
|
/** Print statistics about memory usage */
|
2013-10-10 11:58:01 +00:00
|
|
|
extern void (*MEM_printmemlist_stats)(void);
|
2019-04-17 04:17:24 +00:00
|
|
|
|
2005-07-22 16:40:26 +00:00
|
|
|
/** Set the callback function for error output. */
|
2013-10-10 11:58:01 +00:00
|
|
|
extern void (*MEM_set_error_callback)(void (*func)(const char *));
|
2019-04-17 04:17:24 +00:00
|
|
|
|
2002-10-12 11:37:38 +00:00
|
|
|
/**
|
2019-05-01 10:50:02 +00:00
|
|
|
* Are the start/end block markers still correct ?
|
|
|
|
*
|
2020-09-07 23:10:17 +00:00
|
|
|
* \retval true for correct memory, false for corrupted memory. */
|
2018-03-20 15:51:33 +00:00
|
|
|
extern bool (*MEM_consistency_check)(void);
|
2019-04-17 04:17:24 +00:00
|
|
|
|
2006-11-27 13:59:55 +00:00
|
|
|
/** Attempt to enforce OSX (or other OS's) to have malloc and stack nonzero */
|
2013-10-10 11:58:01 +00:00
|
|
|
extern void (*MEM_set_memory_debug)(void);
|
2019-04-17 04:17:24 +00:00
|
|
|
|
2020-05-19 22:24:26 +00:00
|
|
|
/** Memory usage stats. */
|
2014-10-14 14:11:20 +00:00
|
|
|
extern size_t (*MEM_get_memory_in_use)(void);
|
2011-02-21 09:23:34 +00:00
|
|
|
/** Get amount of memory blocks in use. */
|
2013-10-10 11:58:01 +00:00
|
|
|
extern unsigned int (*MEM_get_memory_blocks_in_use)(void);
|
2019-04-17 04:17:24 +00:00
|
|
|
|
2011-02-21 09:23:34 +00:00
|
|
|
/** Reset the peak memory statistic to zero. */
|
2013-10-10 11:58:01 +00:00
|
|
|
extern void (*MEM_reset_peak_memory)(void);
|
2019-04-17 04:17:24 +00:00
|
|
|
|
2011-02-21 09:23:34 +00:00
|
|
|
/** Get the peak memory usage in bytes, including mmap allocations. */
|
2013-10-10 11:58:01 +00:00
|
|
|
extern size_t (*MEM_get_peak_memory)(void) ATTR_WARN_UNUSED_RESULT;
|
2010-05-04 12:31:24 +00:00
|
|
|
|
2015-02-28 03:41:15 +00:00
|
|
|
#ifdef __GNUC__
|
|
|
|
# define MEM_SAFE_FREE(v) \
|
|
|
|
do { \
|
|
|
|
typeof(&(v)) _v = &(v); \
|
|
|
|
if (*_v) { \
|
2020-06-24 12:08:49 +00:00
|
|
|
/* Cast so we can free constant arrays. */ \
|
|
|
|
MEM_freeN((void *)*_v); \
|
2015-02-28 03:41:15 +00:00
|
|
|
*_v = NULL; \
|
|
|
|
} \
|
|
|
|
} while (0)
|
|
|
|
#else
|
|
|
|
# define MEM_SAFE_FREE(v) \
|
|
|
|
do { \
|
|
|
|
void **_v = (void **)&(v); \
|
|
|
|
if (*_v) { \
|
|
|
|
MEM_freeN(*_v); \
|
|
|
|
*_v = NULL; \
|
|
|
|
} \
|
|
|
|
} while (0)
|
|
|
|
#endif
|
2013-08-04 03:00:04 +00:00
|
|
|
|
2013-10-10 18:18:13 +00:00
|
|
|
/* overhead for lockfree allocator (use to avoid slop-space) */
|
|
|
|
#define MEM_SIZE_OVERHEAD sizeof(size_t)
|
|
|
|
#define MEM_SIZE_OPTIMAL(size) ((size)-MEM_SIZE_OVERHEAD)
|
|
|
|
|
2010-10-18 00:25:32 +00:00
|
|
|
#ifndef NDEBUG
|
2013-10-10 11:58:01 +00:00
|
|
|
extern const char *(*MEM_name_ptr)(void *vmemh);
|
2010-10-18 00:25:32 +00:00
|
|
|
#endif
|
2012-06-25 09:14:37 +00:00
|
|
|
|
2020-07-24 10:26:11 +00:00
|
|
|
/** This should be called as early as possible in the program. When it has been called, information
|
|
|
|
* about memory leaks will be printed on exit. */
|
2020-08-01 03:02:21 +00:00
|
|
|
void MEM_init_memleak_detection(void);
|
2020-07-24 10:26:11 +00:00
|
|
|
|
2020-09-15 03:23:06 +00:00
|
|
|
/**
|
|
|
|
* Use this if we want to call #exit during argument parsing for example,
|
|
|
|
* without having to free all data.
|
|
|
|
*/
|
|
|
|
void MEM_use_memleak_detection(bool enabled);
|
|
|
|
|
2020-08-26 20:02:02 +00:00
|
|
|
/** When this has been called and memory leaks have been detected, the process will have an exit
|
|
|
|
* code that indicates failure. This can be used for when checking for memory leaks with automated
|
|
|
|
* tests. */
|
|
|
|
void MEM_enable_fail_on_memleak(void);
|
|
|
|
|
2020-11-17 10:33:47 +00:00
|
|
|
/* Switch allocator to fast mode, with less tracking.
|
|
|
|
*
|
|
|
|
* Use in the production code where performance is the priority, and exact details about allocation
|
|
|
|
* is not. This allocator keeps track of number of allocation and amount of allocated bytes, but it
|
|
|
|
* does not track of names of allocated blocks.
|
|
|
|
*
|
|
|
|
* NOTE: The switch between allocator types can only happen before any allocation did happen. */
|
|
|
|
void MEM_use_lockfree_allocator(void);
|
|
|
|
|
|
|
|
/* Switch allocator to slow fully guarded mode.
|
|
|
|
*
|
|
|
|
* Use for debug purposes. This allocator contains lock section around every allocator call, which
|
|
|
|
* makes it slow. What is gained with this is the ability to have list of allocated blocks (in an
|
2020-11-20 00:39:03 +00:00
|
|
|
* addition to the tracking of number of allocations and amount of allocated bytes).
|
2020-11-17 10:33:47 +00:00
|
|
|
*
|
|
|
|
* NOTE: The switch between allocator types can only happen before any allocation did happen. */
|
2013-10-10 11:58:01 +00:00
|
|
|
void MEM_use_guarded_allocator(void);
|
|
|
|
|
2020-01-26 15:38:18 +00:00
|
|
|
#ifdef __cplusplus
|
|
|
|
}
|
|
|
|
#endif /* __cplusplus */
|
|
|
|
|
2012-06-25 09:14:37 +00:00
|
|
|
#ifdef __cplusplus
|
2020-11-20 00:39:03 +00:00
|
|
|
/* Allocation functions (for C++ only). */
|
2012-06-25 09:14:37 +00:00
|
|
|
# define MEM_CXX_CLASS_ALLOC_FUNCS(_id) \
|
|
|
|
public: \
|
|
|
|
void *operator new(size_t num_bytes) \
|
|
|
|
{ \
|
|
|
|
return MEM_mallocN(num_bytes, _id); \
|
|
|
|
} \
|
|
|
|
void operator delete(void *mem) \
|
|
|
|
{ \
|
2020-09-19 06:01:32 +00:00
|
|
|
if (mem) { \
|
2012-06-25 11:43:12 +00:00
|
|
|
MEM_freeN(mem); \
|
2020-09-19 06:01:32 +00:00
|
|
|
} \
|
2012-06-25 09:14:37 +00:00
|
|
|
} \
|
|
|
|
void *operator new[](size_t num_bytes) \
|
|
|
|
{ \
|
|
|
|
return MEM_mallocN(num_bytes, _id "[]"); \
|
|
|
|
} \
|
|
|
|
void operator delete[](void *mem) \
|
|
|
|
{ \
|
2020-09-19 06:01:32 +00:00
|
|
|
if (mem) { \
|
2012-06-25 11:43:12 +00:00
|
|
|
MEM_freeN(mem); \
|
2020-09-19 06:01:32 +00:00
|
|
|
} \
|
2020-07-03 10:21:05 +00:00
|
|
|
} \
|
|
|
|
void *operator new(size_t /*count*/, void *ptr) \
|
|
|
|
{ \
|
|
|
|
return ptr; \
|
2020-07-07 09:52:45 +00:00
|
|
|
} \
|
2020-07-07 10:31:10 +00:00
|
|
|
/* This is the matching delete operator to the placement-new operator above. Both parameters \
|
|
|
|
* will have the same value. Without this, we get the warning C4291 on windows. */ \
|
|
|
|
void operator delete(void * /*ptr_to_free*/, void * /*ptr*/) \
|
2020-07-07 09:52:45 +00:00
|
|
|
{ \
|
2012-06-25 09:14:37 +00:00
|
|
|
}
|
2019-04-17 04:17:24 +00:00
|
|
|
|
2020-01-26 15:38:18 +00:00
|
|
|
/* Needed when type includes a namespace, then the namespace should not be
|
|
|
|
* specified after ~, so using a macro fails. */
|
|
|
|
template<class T> inline void OBJECT_GUARDED_DESTRUCTOR(T *what)
|
|
|
|
{
|
|
|
|
what->~T();
|
|
|
|
}
|
|
|
|
|
2017-09-29 09:10:08 +00:00
|
|
|
# if defined __GNUC__
|
2013-10-09 08:46:02 +00:00
|
|
|
# define OBJECT_GUARDED_NEW(type, args...) new (MEM_mallocN(sizeof(type), __func__)) type(args)
|
|
|
|
# else
|
|
|
|
# define OBJECT_GUARDED_NEW(type, ...) \
|
|
|
|
new (MEM_mallocN(sizeof(type), __FUNCTION__)) type(__VA_ARGS__)
|
|
|
|
# endif
|
|
|
|
# define OBJECT_GUARDED_DELETE(what, type) \
|
|
|
|
{ \
|
|
|
|
if (what) { \
|
2020-01-26 15:38:18 +00:00
|
|
|
OBJECT_GUARDED_DESTRUCTOR((type *)what); \
|
2013-10-09 08:46:02 +00:00
|
|
|
MEM_freeN(what); \
|
|
|
|
} \
|
|
|
|
} \
|
|
|
|
(void)0
|
2020-01-23 16:35:16 +00:00
|
|
|
# define OBJECT_GUARDED_SAFE_DELETE(what, type) \
|
|
|
|
{ \
|
|
|
|
if (what) { \
|
|
|
|
OBJECT_GUARDED_DESTRUCTOR((type *)what); \
|
|
|
|
MEM_freeN(what); \
|
|
|
|
what = NULL; \
|
|
|
|
} \
|
|
|
|
} \
|
|
|
|
(void)0
|
2012-07-14 12:47:49 +00:00
|
|
|
#endif /* __cplusplus */
|
2012-06-25 09:14:37 +00:00
|
|
|
|
2012-07-14 12:47:49 +00:00
|
|
|
#endif /* __MEM_GUARDEDALLOC_H__ */
|