Skip to content

Make number of threads for the permutation writer configurable #2696

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
RobinTF wants to merge 2 commits into
base: master
Choose a base branch
from
+39 −1
Open

Make number of threads for the permutation writer configurable #2696

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
412638b
Make number of threads for the permutation writer configurable
RobinTF Feb 4, 2026
4018548
Add constraints and proper unit tests
RobinTF Feb 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions src/global/RuntimeParameters.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ RuntimeParameters::RuntimeParameters() {
add(materializedViewWriterMemory_);
add(defaultQueryTimeout_);
add(sortInMemoryThreshold_);
add(threadsForPermutationWriter_);

defaultQueryTimeout_.setParameterConstraint(
[](std::chrono::seconds value, std::string_view parameterName) {
Expand All @@ -60,6 +61,14 @@ RuntimeParameters::RuntimeParameters() {
value.count(), "s")};
}
});

threadsForPermutationWriter_.setParameterConstraint(
[](size_t value, std::string_view parameterName) {
if (value == 0) {
throw std::runtime_error{
absl::StrCat("Parameter ", parameterName, " must be non-zero")};
}
});
}

// _____________________________________________________________________________
Expand Down
4 changes: 4 additions & 0 deletions src/global/RuntimeParameters.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,10 @@ struct RuntimeParameters {
MemorySizeParameter sortInMemoryThreshold_{
ad_utility::MemorySize::gigabytes(5), "sort-in-memory-threshold"};

// Configure the amount of threads to compress and write blocks per
// permutation.
SizeT threadsForPermutationWriter_{10, "threads-for-permutation-writer"};

// ___________________________________________________________________________
// IMPORTANT NOTE: IF YOU ADD PARAMETERS ABOVE, ALSO REGISTER THEM IN THE
// CONSTRUCTOR, S.T. THEY CAN ALSO BE ACCESSED VIA THE RUNTIME INTERFACE.
Expand Down
6 changes: 6 additions & 0 deletions src/index/CompressedRelation.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1528,6 +1528,12 @@ CompressedRelationMetadata CompressedRelationWriter::finishLargeRelation(
return md;
}

// _____________________________________________________________________________
uint32_t CompressedRelationWriter::numThreadsForWriting() {
return static_cast<uint32_t>(
getRuntimeParameter<&RuntimeParameters::threadsForPermutationWriter_>());
}

// _____________________________________________________________________________
void CompressedRelationWriter::addBlockForLargeRelation(Id col0Id,
IdTable relation) {
Expand Down
6 changes: 5 additions & 1 deletion src/index/CompressedRelation.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -303,7 +303,8 @@ class CompressedRelationWriter {
Id currentCol0Id_ = Id::makeUndefined();
size_t currentRelationPreviousSize_ = 0;

ad_utility::TaskQueue<false> blockWriteQueue_{20, 10};
ad_utility::TaskQueue<false> blockWriteQueue_{numThreadsForWriting() * 2,
numThreadsForWriting()};
ad_utility::timer::ThreadSafeTimer blockWriteQueueTimer_;

// This callback is invoked for each block of small relations (which share the
Expand Down Expand Up @@ -521,6 +522,9 @@ class CompressedRelationWriter {
std::vector<CompressedRelationMetadata>>
compressedRelationTestWriteCompressedRelations(
T inputs, std::string filename, ad_utility::MemorySize blocksize);

// Return the number of threads to be used for writing compressed blocks.
static uint32_t numThreadsForWriting();
};

using namespace std::string_view_literals;
Expand Down
15 changes: 15 additions & 0 deletions test/ConstantsTest.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
#include "global/Constants.h"
#include "global/RuntimeParameters.h"
#include "util/GTestHelpers.h"
#include "util/RuntimeParametersTestHelpers.h"

using namespace ad_utility;
using namespace std::chrono_literals;
Expand All @@ -15,6 +16,9 @@ using ::testing::AllOf;
using ::testing::HasSubstr;

TEST(Constants, testDefaultQueryTimeoutIsStriclyPositive) {
auto reset =
setRuntimeParameterForTest<&RuntimeParameters::defaultQueryTimeout_>(
1337s);
AD_EXPECT_THROW_WITH_MESSAGE_AND_TYPE(
setRuntimeParameter<&RuntimeParameters::defaultQueryTimeout_>(0s),
AllOf(HasSubstr("default-query-timeout"), HasSubstr("0s")),
Expand All @@ -27,6 +31,17 @@ TEST(Constants, testDefaultQueryTimeoutIsStriclyPositive) {
setRuntimeParameter<&RuntimeParameters::defaultQueryTimeout_>(1s));
}

// _____________________________________________________________________________
TEST(Constants, testThreadsForPermutationWriterIsStriclyPositive) {
auto reset = setRuntimeParameterForTest<
&RuntimeParameters::threadsForPermutationWriter_>(1337);
AD_EXPECT_THROW_WITH_MESSAGE_AND_TYPE(
setRuntimeParameter<&RuntimeParameters::threadsForPermutationWriter_>(0),
HasSubstr("threads-for-permutation-writer"), std::runtime_error);
EXPECT_NO_THROW(
setRuntimeParameter<&RuntimeParameters::threadsForPermutationWriter_>(1));
}

namespace {
constexpr std::string_view hi = "hi";
constexpr std::string_view bye = "-bye";
Expand Down
Loading