From 1fe948f48d7a578ed20d41e8068abf62dccb52f8 Mon Sep 17 00:00:00 2001 From: tomershafir Date: Tue, 26 Nov 2024 14:35:23 +0200 Subject: [PATCH] reserve-memory: document that seastar just doesnt use the reserves Regardless of who is using it, either the OS or other userspace processes. --- include/seastar/core/smp_options.hh | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/include/seastar/core/smp_options.hh b/include/seastar/core/smp_options.hh index 30e891133fb..8cbee25f082 100644 --- a/include/seastar/core/smp_options.hh +++ b/include/seastar/core/smp_options.hh @@ -51,7 +51,8 @@ struct smp_options : public program_options::option_group { program_options::value cpuset; /// Memory to use, in bytes (ex: 4G) (default: all). program_options::value memory; - /// Memory reserved to OS (if \ref memory not specified). + /// Memory reserved to the OS and other processes (if \ref memory not specified), + /// and is not used by seastar. program_options::value reserve_memory; /// Path to accessible hugetlbfs mount (typically /dev/hugepages/something). program_options::value hugepages; @@ -100,7 +101,8 @@ struct smp_options : public program_options::option_group { seastar::memory_allocator memory_allocator = memory_allocator::seastar; /// \cond internal - /// Additional memory reserved to OS for each shard (added to the default value or the value specified by \ref reserve_memory). + /// Additional memory reserved to the OS and other processes for each shard (added to the default value or the value specified by \ref reserve_memory), + /// and is not used by seastar. size_t reserve_additional_memory_per_shard = 0; /// \endcond public: