From 90f1d1cc611347fd105c0e369d1ca8f3c58d51ac Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Tue, 16 Apr 2024 12:27:13 +1000 Subject: [PATCH] Cleanup: use doxygen formatting for guarded-allocator --- intern/guardedalloc/MEM_guardedalloc.h | 31 +++++++++++++++++--------- intern/guardedalloc/intern/mallocn.cc | 15 ++++++++----- 2 files changed, 30 insertions(+), 16 deletions(-) diff --git a/intern/guardedalloc/MEM_guardedalloc.h b/intern/guardedalloc/MEM_guardedalloc.h index 08c187c55fa..76d1b60ee2b 100644 --- a/intern/guardedalloc/MEM_guardedalloc.h +++ b/intern/guardedalloc/MEM_guardedalloc.h @@ -206,7 +206,7 @@ extern size_t (*MEM_get_peak_memory)(void) ATTR_WARN_UNUSED_RESULT; } while (0) #endif -/* overhead for lockfree allocator (use to avoid slop-space) */ +/** 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) @@ -242,22 +242,26 @@ void MEM_use_memleak_detection(bool enabled); */ void MEM_enable_fail_on_memleak(void); -/* Switch allocator to fast mode, with less tracking. +/** + * 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. */ + * \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. +/** + * 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 * addition to the tracking of number of allocations and amount of allocated bytes). * - * NOTE: The switch between allocator types can only happen before any allocation did happen. */ + * \note The switch between allocator types can only happen before any allocation did happen. + */ void MEM_use_guarded_allocator(void); #ifdef __cplusplus @@ -270,9 +274,11 @@ void MEM_use_guarded_allocator(void); # include # include -/* Conservative value of memory alignment returned by non-aligned OS-level memory allocation +/** + * Conservative value of memory alignment returned by non-aligned OS-level memory allocation * functions. For alignments smaller than this value, using non-aligned versions of allocator API - * functions is okay, allowing use of calloc, for example. */ + * functions is okay, allowing use of `calloc`, for example. + */ # define MEM_MIN_CPP_ALIGNMENT \ (__STDCPP_DEFAULT_NEW_ALIGNMENT__ < alignof(void *) ? __STDCPP_DEFAULT_NEW_ALIGNMENT__ : \ alignof(void *)) @@ -307,7 +313,7 @@ template inline void MEM_delete(const T *ptr) /* Support #ptr being null, because C++ `delete` supports that as well. */ return; } - /* C++ allows destruction of const objects, so the pointer is allowed to be const. */ + /* C++ allows destruction of `const` objects, so the pointer is allowed to be `const`. */ ptr->~T(); MEM_freeN(const_cast(ptr)); } @@ -354,7 +360,7 @@ template inline T *MEM_cnew(const char *allocation_name, const T &ot return new_object; } -/* Allocation functions (for C++ only). */ +/** Allocation functions (for C++ only). */ # define MEM_CXX_CLASS_ALLOC_FUNCS(_id) \ public: \ void *operator new(size_t num_bytes) \ @@ -389,8 +395,11 @@ template inline T *MEM_cnew(const char *allocation_name, const T &ot { \ return ptr; \ } \ - /* 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. */ \ + /** \ + * 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*/) {} #endif /* __cplusplus */ diff --git a/intern/guardedalloc/intern/mallocn.cc b/intern/guardedalloc/intern/mallocn.cc index 81afeb88845..e6b22840173 100644 --- a/intern/guardedalloc/intern/mallocn.cc +++ b/intern/guardedalloc/intern/mallocn.cc @@ -10,7 +10,7 @@ #include "MEM_guardedalloc.h" -/* to ensure strict conversions */ +/* To ensure strict conversions. */ #include "../../source/blender/blenlib/BLI_strict_flags.h" #include @@ -18,14 +18,17 @@ #include "mallocn_intern.h" #ifdef WITH_JEMALLOC_CONF -/* If JEMALLOC is used, it reads this global variable and enables background +/** + * If JEMALLOC is used, it reads this global variable and enables background * threads to purge dirty pages. Otherwise we release memory too slowly or not - * at all if the thread that did the allocation stays inactive. */ + * at all if the thread that did the allocation stays inactive. + */ const char *malloc_conf = "background_thread:true,dirty_decay_ms:4000,thp:always,metadata_thp:always"; #endif /* NOTE: Keep in sync with MEM_use_lockfree_allocator(). */ + size_t (*MEM_allocN_len)(const void *vmemh) = MEM_lockfree_allocN_len; void (*MEM_freeN)(void *vmemh) = MEM_lockfree_freeN; void *(*MEM_dupallocN)(const void *vmemh) = MEM_lockfree_dupallocN; @@ -92,10 +95,12 @@ void aligned_free(void *ptr) #endif } -/* Perform assert checks on allocator type change. +/** + * Perform assert checks on allocator type change. * * Helps catching issues (in debug build) caused by an unintended allocator type change when there - * are allocation happened. */ + * are allocation happened. + */ static void assert_for_allocator_change(void) { /* NOTE: Assume that there is no "sticky" internal state which would make switching allocator