Blender V5.3
mallocn.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2002-2023 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
10
11#include "MEM_guardedalloc.h"
12
13#include "PRF_profile.hh"
14/* To ensure strict conversions. */
15#include "../../source/blender/blenlib/BLI_strict_flags.hh"
16
17#include <cassert>
18
19#include "mallocn_intern.hh"
20
22
23using namespace mem_guarded::internal;
24
25/* NOTE: Keep in sync with MEM_use_lockfree_allocator(). */
26
27size_t (*MEM_allocN_len)(const void *vmemh) = MEM_lockfree_allocN_len;
29 DestructorType destructor_type) = MEM_lockfree_freeN;
30void *(*mem_guarded::internal::mem_dupallocN)(const void *vmemh) = MEM_lockfree_dupallocN;
31void *(*MEM_realloc_uninitialized_id)(void *vmemh,
32 size_t len,
33 const char *str) = MEM_lockfree_reallocN_id;
34void *(*MEM_realloc_zeroed_id)(void *vmemh,
35 size_t len,
36 const char *str) = MEM_lockfree_recallocN_id;
37void *(*mem_guarded::internal::mem_callocN)(size_t len, const char *str) = MEM_lockfree_callocN;
38void *(*mem_guarded::internal::mem_calloc_arrayN)(size_t len,
39 size_t size,
40 const char *str) = MEM_lockfree_calloc_arrayN;
41void *(*mem_guarded::internal::mem_mallocN)(size_t len, const char *str) = MEM_lockfree_mallocN;
42void *(*mem_guarded::internal::mem_malloc_arrayN)(size_t len,
43 size_t size,
44 const char *str) = MEM_lockfree_malloc_arrayN;
45void *(*mem_guarded::internal::mem_mallocN_aligned_ex)(size_t len,
46 size_t alignment,
47 const char *str,
48 DestructorType destructor_type) =
50void *(*MEM_new_array_uninitialized_aligned)(size_t len,
51 size_t size,
52 size_t alignment,
54void *(*MEM_new_array_zeroed_aligned)(size_t len,
55 size_t size,
56 size_t alignment,
60void (*MEM_callbackmemlist)(void (*func)(void *)) = MEM_lockfree_callbackmemlist;
62void (*MEM_set_error_callback)(void (*func)(const char *)) = MEM_lockfree_set_error_callback;
69
71
72#ifndef NDEBUG
73const char *(*MEM_name_ptr)(void *vmemh) = MEM_lockfree_name_ptr;
74void (*MEM_name_ptr_set)(void *vmemh, const char *str) = MEM_lockfree_name_ptr_set;
75#endif
76
77void *aligned_malloc(size_t size, size_t alignment)
78{
79 /* #posix_memalign requires alignment to be a multiple of `sizeof(void *)`. */
81
82#ifdef _WIN32
83 return _aligned_malloc(size, alignment);
84#elif defined(__APPLE__) || defined(__FreeBSD__) || defined(__NetBSD__) || defined(__OpenBSD__)
85 void *result;
86
87 if (posix_memalign(&result, alignment, size)) {
88 /* non-zero means allocation error
89 * either no allocation or bad alignment value
90 */
91 return NULL;
92 }
93 return result;
94#else /* This is for Linux. */
95 return memalign(alignment, size);
96#endif
97}
98
99void aligned_free(void *ptr)
100{
101 PRF_memory_free(ptr);
102#ifdef _WIN32
103 _aligned_free(ptr);
104#else
105 free(ptr);
106#endif
107}
108
109void MEM_delete_void(void *vmemh)
110{
112}
113
114void *MEM_new_zeroed(size_t len, const char *str)
115{
116 return mem_callocN(len, str);
117}
118
119void *MEM_new_array_zeroed(size_t len, size_t size, const char *str)
120{
121 return mem_calloc_arrayN(len, size, str);
122}
123
124void *MEM_new_uninitialized(size_t len, const char *str)
125{
126 return mem_mallocN(len, str);
127}
128
129void *MEM_new_array_uninitialized(size_t len, size_t size, const char *str)
130{
131 return mem_malloc_arrayN(len, size, str);
132}
133
134void *MEM_new_uninitialized_aligned(size_t len, size_t alignment, const char *str)
135{
137}
138
139void *MEM_dupalloc_void(const void *vmemh)
140{
141 return mem_dupallocN(vmemh);
142}
143
151{
152 /* NOTE: Assume that there is no "sticky" internal state which would make switching allocator
153 * type after all allocations are freed unsafe. In fact, it should be safe to change allocator
154 * type after all blocks has been freed: some regression tests do rely on this property of
155 * allocators. */
157}
158
160{
161 /* NOTE: Keep in sync with static initialization of the variables. */
162
163 /* TODO(sergey): Find a way to de-duplicate the logic. Maybe by requiring an explicit call
164 * to guarded allocator initialization at an application startup. */
165
167
191
193
194#ifndef NDEBUG
197#endif
198}
199
201{
203
227
229
230#ifndef NDEBUG
233#endif
234}
Read Blender memory allocation and freeing.
#define PRF_memory_free(ptr)
#define str(s)
#define assert(assertion)
void aligned_free(void *ptr)
Definition mallocn.cc:99
void *(*) MEM_realloc_uninitialized_id(void *vmemh, size_t len, const char *str)
Definition mallocn.cc:31
void MEM_use_lockfree_allocator()
Definition mallocn.cc:159
void(*) MEM_set_memory_debug(void)
Definition mallocn.cc:64
const char *(*) MEM_name_ptr(void *vmemh)
Definition mallocn.cc:73
size_t(*) MEM_allocN_len(const void *vmemh)
Definition mallocn.cc:27
bool(*) MEM_consistency_check(void)
Definition mallocn.cc:63
void MEM_delete_void(void *vmemh)
Definition mallocn.cc:109
size_t(*) MEM_get_memory_in_use(void)
Definition mallocn.cc:65
void(*) mem_clearmemlist(void)
Definition mallocn.cc:70
void * MEM_new_zeroed(size_t len, const char *str)
Definition mallocn.cc:114
void * MEM_new_array_zeroed(size_t len, size_t size, const char *str)
Definition mallocn.cc:119
void(*) MEM_printmemlist(void)
Definition mallocn.cc:59
void(*) MEM_printmemlist_pydict(void)
Definition mallocn.cc:58
void *(*) MEM_realloc_zeroed_id(void *vmemh, size_t len, const char *str)
Definition mallocn.cc:34
uint(*) MEM_get_memory_blocks_in_use(void)
Definition mallocn.cc:66
size_t(*) MEM_get_peak_memory(void)
Definition mallocn.cc:68
void MEM_use_guarded_allocator()
Definition mallocn.cc:200
void(*) MEM_name_ptr_set(void *vmemh, const char *str)
Definition mallocn.cc:74
void * MEM_new_uninitialized_aligned(size_t len, size_t alignment, const char *str)
Definition mallocn.cc:134
void(*) MEM_set_error_callback(void(*func)(const char *))
Definition mallocn.cc:62
void(*) MEM_reset_peak_memory(void)
Definition mallocn.cc:67
void *(*) MEM_new_array_uninitialized_aligned(size_t len, size_t size, size_t alignment, const char *str)
Definition mallocn.cc:50
void(*) MEM_callbackmemlist(void(*func)(void *))
Definition mallocn.cc:60
void * MEM_new_array_uninitialized(size_t len, size_t size, const char *str)
Definition mallocn.cc:129
void * aligned_malloc(size_t size, size_t alignment)
Definition mallocn.cc:77
void * MEM_dupalloc_void(const void *vmemh)
Definition mallocn.cc:139
static void assert_for_allocator_change()
Definition mallocn.cc:150
void * MEM_new_uninitialized(size_t len, const char *str)
Definition mallocn.cc:124
void *(*) MEM_new_array_zeroed_aligned(size_t len, size_t size, size_t alignment, const char *str)
Definition mallocn.cc:54
void(*) MEM_printmemlist_stats(void)
Definition mallocn.cc:61
void * MEM_guarded_calloc_arrayN_aligned(const size_t len, const size_t size, const size_t alignment, const char *str)
size_t MEM_guarded_allocN_len(const void *vmemh)
void * MEM_guarded_mallocN(size_t len, const char *str)
size_t MEM_guarded_get_peak_memory()
void MEM_guarded_freeN(void *vmemh, const DestructorType destructor_type)
void * MEM_guarded_calloc_arrayN(size_t len, size_t size, const char *str)
void MEM_guarded_reset_peak_memory()
void MEM_guarded_set_error_callback(void(*func)(const char *))
bool MEM_guarded_consistency_check()
void MEM_guarded_printmemlist_pydict()
void MEM_guarded_callbackmemlist(void(*func)(void *))
void MEM_guarded_printmemlist()
uint MEM_guarded_get_memory_blocks_in_use()
void * MEM_guarded_mallocN_aligned(size_t len, size_t alignment, const char *str, const DestructorType destructor_type)
void * MEM_guarded_callocN(size_t len, const char *str)
void * MEM_guarded_reallocN_id(void *vmemh, size_t len, const char *str)
void MEM_guarded_printmemlist_stats()
void * MEM_guarded_malloc_arrayN(size_t len, size_t size, const char *str)
void * MEM_guarded_dupallocN(const void *vmemh)
size_t MEM_guarded_get_memory_in_use()
void * MEM_guarded_recallocN_id(void *vmemh, size_t len, const char *str)
void MEM_guarded_name_ptr_set(void *vmemh, const char *str)
void MEM_guarded_set_memory_debug()
const char * MEM_guarded_name_ptr(void *vmemh)
void mem_guarded_clearmemlist()
void * MEM_guarded_malloc_arrayN_aligned(const size_t len, const size_t size, const size_t alignment, const char *str)
void * MEM_lockfree_malloc_arrayN(size_t len, size_t size, const char *str) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1
void * MEM_lockfree_dupallocN(const void *vmemh) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT
void MEM_lockfree_reset_peak_memory(void)
void mem_lockfree_clearmemlist(void)
void MEM_lockfree_name_ptr_set(void *vmemh, const char *str)
void * MEM_lockfree_calloc_arrayN(size_t len, size_t size, const char *str) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1
void MEM_lockfree_set_error_callback(void(*func)(const char *))
void MEM_lockfree_printmemlist_stats(void)
void MEM_lockfree_freeN(void *vmemh, mem_guarded::internal::DestructorType destructor_type)
void MEM_lockfree_set_memory_debug(void)
void * MEM_lockfree_reallocN_id(void *vmemh, size_t len, const char *str) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(2)
bool MEM_lockfree_consistency_check(void)
void * MEM_lockfree_callocN(size_t len, const char *str) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1) ATTR_NONNULL(2)
void * MEM_lockfree_mallocN_aligned(size_t len, size_t alignment, const char *str, mem_guarded::internal::DestructorType destructor_type) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1) ATTR_NONNULL(3)
void MEM_lockfree_printmemlist_pydict(void)
#define ALIGNED_MALLOC_MINIMUM_ALIGNMENT
void * MEM_lockfree_recallocN_id(void *vmemh, size_t len, const char *str) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(2)
void * MEM_lockfree_malloc_arrayN_aligned(size_t len, size_t size, size_t alignment, const char *str) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1
void * MEM_lockfree_mallocN(size_t len, const char *str) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1) ATTR_NONNULL(2)
void MEM_lockfree_printmemlist(void)
size_t MEM_lockfree_allocN_len(const void *vmemh) ATTR_WARN_UNUSED_RESULT
const char * MEM_lockfree_name_ptr(void *vmemh)
void MEM_lockfree_callbackmemlist(void(*func)(void *))
void * MEM_lockfree_calloc_arrayN_aligned(size_t len, size_t size, size_t alignment, const char *str) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1
size_t MEM_lockfree_get_memory_in_use(void)
unsigned int MEM_lockfree_get_memory_blocks_in_use(void)
size_t MEM_lockfree_get_peak_memory(void) ATTR_WARN_UNUSED_RESULT
ccl_device_inline dual1 len(const ccl_private dual< T > &a)
Definition math_dual.h:263
void *(*) mem_mallocN_aligned_ex(size_t len, size_t alignment, const char *str, DestructorType destructor_type)
Definition mallocn.cc:45
void(*) mem_freeN_ex(void *vmemh, DestructorType destructor_type)
Definition mallocn.cc:28
void *(*) mem_mallocN(size_t len, const char *str) ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1) ATTR_NONNULL(2)
Definition mallocn.cc:41
void *(*) mem_dupallocN(const void *vmemh) ATTR_WARN_UNUSED_RESULT
Definition mallocn.cc:30
void *(*) mem_malloc_arrayN(size_t len, size_t size, const char *str) ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1
Definition mallocn.cc:42
void *(*) mem_calloc_arrayN(size_t len, size_t size, const char *str) ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1
Definition mallocn.cc:38
void *(*) mem_callocN(size_t len, const char *str) ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1) ATTR_NONNULL(2)
Definition mallocn.cc:37