From da47d52c79ec970a2e47812b1e8fae714c47010d Mon Sep 17 00:00:00 2001
From: antirez <antirez@gmail.com>
Date: Thu, 21 Nov 2019 10:01:49 +0100
Subject: [PATCH] Recomment PR #6346.
---
src/module.c | 20 ++++++++++++--------
1 file changed, 12 insertions(+), 8 deletions(-)
diff --git a/src/module.c b/src/module.c
index 77b885b00..4c609e4ff 100644
--- a/src/module.c
+++ b/src/module.c
@@ -5995,19 +5995,23 @@ int RM_CommandFilterArgDelete(RedisModuleCommandFilterCtx *fctx, int pos)
return REDISMODULE_OK;
}
-/*
- * For a given pointer, return The amount of memory
- * allocated for this pointer.
+/* For a given pointer allocated via RedisModule_Alloc() or
+ * RedisModule_Realloc(), return the amount of memory allocated for it.
+ * Note that this may be different (larger) than the memory we allocated
+ * with the allocation calls, since sometimes the underlying allocator
+ * will allocate more memory.
*/
size_t RM_MallocSize(void* ptr){
return zmalloc_size(ptr);
}
-/*
- * Return the a number between 0 to 1 indicating
- * the amount of memory currently used.
- * 0 - no memory limit
- * 1 and above, memory limit reached.
+/* Return the a number between 0 to 1 indicating the amount of memory
+ * currently used, relative to the Redis "maxmemory" configuration.
+ *
+ * 0 - No memory limit configured.
+ * Between 0 and 1 - The percentage of the memory used normalized in 0-1 range.
+ * Exactly 1 - Memory limit reached.
+ * Greater 1 - More memory used than the configured limit.
*/
float RM_GetUsedMemoryRatio(){
float level;