Skip to content

Commit

Permalink
reserve-memory: document that seastar just doesnt use the reserves
Browse files Browse the repository at this point in the history
Regardless of who is using it, either the OS or other userspace processes.
  • Loading branch information
tomershafir authored and avikivity committed Nov 27, 2024
1 parent 59dbb71 commit 1fe948f
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions include/seastar/core/smp_options.hh
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,8 @@ struct smp_options : public program_options::option_group {
program_options::value<resource::cpuset> cpuset;
/// Memory to use, in bytes (ex: 4G) (default: all).
program_options::value<std::string> 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<std::string> reserve_memory;
/// Path to accessible hugetlbfs mount (typically /dev/hugepages/something).
program_options::value<std::string> hugepages;
Expand Down Expand Up @@ -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:
Expand Down

0 comments on commit 1fe948f

Please sign in to comment.