2900cfa50a
Same thing as for `MEM_callocN<T>` and `MEM_freeN<T>` in dd168a35c5,
allows to reduce type verbosity, and increase type safety.
85 lines
3.4 KiB
C++
85 lines
3.4 KiB
C++
/* SPDX-FileCopyrightText: 2024 Blender Authors
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
|
|
/** \file
|
|
* \ingroup intern_mem
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
namespace mem_guarded::internal {
|
|
|
|
enum class AllocationType {
|
|
/** Allocation is handled through 'C type' alloc/free calls. */
|
|
ALLOC_FREE,
|
|
/** Allocation is handled through 'C++ type' new/delete calls. */
|
|
NEW_DELETE,
|
|
};
|
|
|
|
/** Internal implementation of #MEM_freeN, exposed because #MEM_delete needs access to it. */
|
|
extern void (*mem_freeN_ex)(void *vmemh, AllocationType allocation_type);
|
|
|
|
/**
|
|
* Internal implementation of #MEM_callocN, exposed because public #MEM_callocN cannot be a
|
|
* function pointer, to allow its overload by C++ template version.
|
|
*/
|
|
extern void *(*mem_callocN)(size_t len, const char *str) /* ATTR_MALLOC */ ATTR_WARN_UNUSED_RESULT
|
|
ATTR_ALLOC_SIZE(1) ATTR_NONNULL(2);
|
|
|
|
/**
|
|
* Internal implementation of #MEM_calloc_arrayN, exposed because public #MEM_calloc_arrayN cannot
|
|
* be a function pointer, to allow its overload by C++ template version.
|
|
*/
|
|
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);
|
|
|
|
/**
|
|
* Internal implementation of #MEM_mallocN, exposed because public #MEM_mallocN cannot be a
|
|
* function pointer, to allow its overload by C++ template version.
|
|
*/
|
|
extern void *(*mem_mallocN)(size_t len, const char *str) /* ATTR_MALLOC */ ATTR_WARN_UNUSED_RESULT
|
|
ATTR_ALLOC_SIZE(1) ATTR_NONNULL(2);
|
|
|
|
/**
|
|
* Internal implementation of #MEM_malloc_arrayN, exposed because public #MEM_malloc_arrayN cannot
|
|
* be a function pointer, to allow its overload by C++ template version.
|
|
*/
|
|
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);
|
|
|
|
/** Internal implementation of #MEM_mallocN_aligned, exposed because #MEM_new needs access to it.
|
|
*/
|
|
extern void *(*mem_mallocN_aligned_ex)(size_t len,
|
|
size_t alignment,
|
|
const char *str,
|
|
AllocationType allocation_type);
|
|
|
|
/**
|
|
* Internal implementation of #MEM_dupallocN, exposed because public #MEM_dupallocN cannot be a
|
|
* function pointer, to allow its overload by C++ template version.
|
|
*/
|
|
extern void *(*mem_dupallocN)(const void *vmemh) /* ATTR_MALLOC */ ATTR_WARN_UNUSED_RESULT;
|
|
|
|
/**
|
|
* Store a std::any into a static opaque storage vector. The only purpose of this call is to
|
|
* control the lifetime of the given data, there is no way to access it from here afterwards. User
|
|
* code is expected to keep its own reference to the data contained in the `std::any` as long as it
|
|
* needs it.
|
|
*
|
|
* Typically, this `any` should contain a `shared_ptr` to the actual data, to ensure that the data
|
|
* itself is not duplicated, and that the static storage does become an owner of it.
|
|
*
|
|
* That way, the memleak data does not get destructed before the static storage is. Since this
|
|
* storage is created before the memleak detection data (see the implementation of
|
|
* #MEM_init_memleak_detection), it is guaranteed to happen after the execution and destruction of
|
|
* the memleak detector.
|
|
*/
|
|
void add_memleak_data(std::any data);
|
|
|
|
} // namespace mem_guarded::internal
|