mirrors/dragonfly
1
0
Fork 0
mirror of https://github.com/dragonflydb/dragonfly.git synced 2025-05-11 10:25:47 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

feat(server): Add MEMORY TRACK ADDRESS command (#2513)

Browse source 
* feat(server): Add `MEMORY TRACK ADDRESS` command

Given a hex address, it replies with whether or not this address is
currently allocated by mimalloc's backing heap.

* init!

* Add HELP message
This commit is contained in:
Shahar Mike 2024-02-01 21:31:08 +02:00 • committed by GitHub
parent c987e64332
commit b71d0f6383
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 41 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

62
src/server/memory_cmd.cc
View file

@ -101,6 +101,24 @@ void MemoryCmd::Run(CmdArgList args) {
" Show memory usage of a key.",
"DECOMMIT",
" Force decommit the memory freed by the server back to OS.",
"TRACK",
" Allow tracking of memory allocation via `new` and `delete` based on input criteria.",
" USE WITH CAUTIOUS! This command is designed for Dragonfly developers.",
" ADD <lower-bound> <upper-bound> <sample-odds>",
" Sets up tracking memory allocations in the (inclusive) range [lower, upper]",
" sample-odds indicates how many of the allocations will be logged, there 0 means "
"none, 1 means all, and everything in between is linear",
" There could be at most 4 tracking placed in parallel",
" REMOVE <lower-bound> <upper-bound>",
" Removes all memory tracking added which match bounds",
" Could remove 0, 1 or more",
" CLEAR",
" Removes all memory tracking",
" GET",
" Returns an array with all active tracking",
" ADDRESS <address>",
" Returns whether <address> is known to be allocated internally by any of the "
"backing heaps",
};
auto* rb = static_cast<RedisReplyBuilder*>(cntx_->reply_builder());
return rb->SendSimpleStrArr(help_arr);
@ -301,25 +319,6 @@ void MemoryCmd::Usage(std::string_view key) {
rb->SendLong(memory_usage);
}
// Allow tracking of memory allocation via `new` and `delete` based on input criteria.
//
// MEMORY TRACK ADD <lower-bound> <upper-bound> <sample-odds>
// - Sets up tracking memory allocations in the (inclusive) range [lower, upper]
// - sample-odds indicates how many of the allocations will be logged, there 0 means none, 1 means
// all, and everything in between is linear
// - There could be at most 4 tracking placed in parallel
//
// MEMORY TRACK REMOVE <lower-bound> <upper-bound>
// - Removes all memory tracking added which match bounds
// - Could remove 0, 1 or more
//
// MEMORY TRACK CLEAR
// - Removes all memory tracking
//
// MEMORY TRACK GET
// - Returns an array with all active tracking
//
// This command is not documented in `MEMORY HELP` because it's meant to be used internally.
void MemoryCmd::Track(CmdArgList args) {
#ifndef DFLY_ENABLE_MEMORY_TRACKING
return cntx_->SendError("MEMORY TRACK must be enabled at build time.");
@ -338,7 +337,7 @@ void MemoryCmd::Track(CmdArgList args) {
return cntx_->SendError(parser.Error()->MakeReply());
}
atomic_bool error;
atomic_bool error{false};
shard_set->pool()->Await([&](unsigned index, auto*) {
if (!AllocationTracker::Get().Add(
{.lower_bound = lower_bound, .upper_bound = upper_bound, .sample_odds = odds})) {
@ -359,7 +358,7 @@ void MemoryCmd::Track(CmdArgList args) {
return cntx_->SendError(parser.Error()->MakeReply());
}
atomic_bool error;
atomic_bool error{false};
shard_set->pool()->Await([&](unsigned index, auto*) {
if (!AllocationTracker::Get().Remove(lower_bound, upper_bound)) {
error.store(true);
@ -389,6 +388,27 @@ void MemoryCmd::Track(CmdArgList args) {
return;
}
if (sub_cmd == "ADDRESS") {
string_view ptr_str = parser.Next();
if (parser.HasError()) {
return cntx_->SendError(parser.Error()->MakeReply());
}
size_t ptr = 0;
if (!absl::SimpleHexAtoi(ptr_str, &ptr)) {
return cntx_->SendError("Address must be hex number");
}
atomic_bool found{false};
shard_set->pool()->Await([&](unsigned index, auto*) {
if (mi_heap_check_owned(mi_heap_get_backing(), (void*)ptr)) {
found.store(true);
}
});
return cntx_->SendSimpleString(found.load() ? "FOUND" : "NOT-FOUND");
}
return cntx_->SendError(kSyntaxErrType);
}