-
Notifications
You must be signed in to change notification settings - Fork 31
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add bufferPool for nimble parallel writer (#103)
Summary: change the buffer class to a bufferPool to handle multihreaded buffers without mutexes Differential Revision: D64774959
- Loading branch information
1 parent
c81d292
commit b9cbd3a
Showing
8 changed files
with
335 additions
and
38 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,191 @@ | ||
/* | ||
* Copyright (c) Meta Platforms, Inc. and its affiliates. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
#include <gtest/gtest.h> | ||
#include "dwio/nimble/common/Buffer.h" | ||
#include "dwio/nimble/common/Exceptions.h" | ||
#include "folly/executors/CPUThreadPoolExecutor.h" | ||
#include "velox/common/memory/Memory.h" | ||
#include "velox/dwio/common/ExecutorBarrier.h" | ||
|
||
namespace facebook::nimble::test { | ||
using MemoryPool = velox::memory::MemoryPool; | ||
using ExecutorBarrier = velox::dwio::common::ExecutorBarrier; | ||
|
||
class BufferPoolTest : public ::testing::Test { | ||
protected: | ||
static void SetUpTestCase() {} | ||
|
||
void SetUp() override { | ||
memPool_ = velox::memory::deprecatedAddDefaultLeafMemoryPool(); | ||
} | ||
|
||
std::shared_ptr<velox::memory::MemoryPool> memPool_; | ||
}; | ||
|
||
TEST_F(BufferPoolTest, CreateBufferPool) { | ||
auto bufferPool = BufferPool{*memPool_}; | ||
EXPECT_NO_THROW(bufferPool); | ||
} | ||
|
||
TEST_F(BufferPoolTest, CreateBufferPoolWithInitialSize) { | ||
auto bufferPool = | ||
BufferPool{*memPool_, std::chrono::milliseconds{10}, 10, 10}; | ||
EXPECT_EQ(bufferPool.size(), 10); | ||
} | ||
|
||
TEST_F(BufferPoolTest, CreateBufferPoolBadTimeout) { | ||
auto throwLambda = [&]() { | ||
auto bufferPool = BufferPool{*memPool_, std::chrono::milliseconds{0}}; | ||
}; | ||
EXPECT_THROW(throwLambda(), NimbleUserError); | ||
|
||
try { | ||
throwLambda(); | ||
} catch (const NimbleUserError& e) { | ||
EXPECT_EQ(e.errorMessage(), "timeout must be > 0"); | ||
} | ||
} | ||
|
||
TEST_F(BufferPoolTest, CreateBufferPoolBadMaxPool) { | ||
auto throwLambda = [&]() { | ||
auto bufferPool = BufferPool{*memPool_, std::chrono::milliseconds{1}, 0}; | ||
}; | ||
EXPECT_THROW(throwLambda(), NimbleUserError); | ||
|
||
try { | ||
throwLambda(); | ||
} catch (const NimbleUserError& e) { | ||
EXPECT_EQ(e.errorMessage(), "max pool size must be > 0"); | ||
} | ||
} | ||
|
||
TEST_F(BufferPoolTest, CreateBufferPoolBadInitialSize) { | ||
auto throwLambda = [&]() { | ||
auto bufferPool = | ||
BufferPool{*memPool_, std::chrono::milliseconds{1}, 10, 0}; | ||
}; | ||
EXPECT_THROW(throwLambda(), NimbleUserError); | ||
try { | ||
throwLambda(); | ||
} catch (const NimbleUserError& e) { | ||
EXPECT_EQ(e.errorMessage(), "initial pool size must be > 0"); | ||
} | ||
} | ||
|
||
TEST_F(BufferPoolTest, CreateBufferPoolBadInitialSizeMaxSize) { | ||
auto throwLambda = [&]() { | ||
auto bufferPool = BufferPool{*memPool_, std::chrono::milliseconds{1}, 1, 2}; | ||
}; | ||
EXPECT_THROW(throwLambda(), NimbleUserError); | ||
|
||
try { | ||
throwLambda(); | ||
} catch (const NimbleUserError& e) { | ||
EXPECT_EQ(e.errorMessage(), "initial pool size must be <= max pool size"); | ||
} | ||
} | ||
|
||
TEST_F(BufferPoolTest, ReserveBuffer) { | ||
auto bufferPool = BufferPool{*memPool_}; | ||
auto buffer = bufferPool.reserveBuffer(); | ||
EXPECT_NE(buffer, nullptr); | ||
} | ||
|
||
TEST_F(BufferPoolTest, AddBuffer) { | ||
auto bufferPool = BufferPool{*memPool_}; | ||
auto buffer = bufferPool.reserveBuffer(); | ||
EXPECT_NE(buffer, nullptr); | ||
EXPECT_EQ(bufferPool.size(), 0); | ||
bufferPool.addBuffer(std::move(buffer)); | ||
EXPECT_EQ(bufferPool.size(), 1); | ||
} | ||
|
||
TEST_F(BufferPoolTest, DestroyBufferPool) { | ||
auto bufferPoolPtr = std::make_unique<BufferPool>(*memPool_); | ||
bufferPoolPtr.reset(); | ||
EXPECT_NO_THROW(); | ||
} | ||
|
||
TEST_F(BufferPoolTest, emptyBufferPool) { | ||
auto bufferPool = BufferPool{*memPool_, std::chrono::milliseconds{10}, 1}; | ||
EXPECT_EQ(bufferPool.size(), 1); | ||
|
||
auto buffer1 = bufferPool.reserveBuffer(); | ||
EXPECT_EQ(bufferPool.size(), 0); | ||
} | ||
|
||
TEST_F(BufferPoolTest, OverfillBufferPool) { | ||
// not guarenteed to fail at size of 2 due to DMPMCQueue | ||
auto bufferPool = BufferPool{*memPool_, std::chrono::milliseconds{10}, 1}; | ||
auto throwLambda = [&]() { | ||
for (auto i = 0; i < 5; i++) { | ||
auto buffer = std::make_unique<Buffer>(*memPool_); | ||
bufferPool.addBuffer(std::move(buffer)); | ||
} | ||
}; | ||
|
||
EXPECT_THROW(throwLambda(), NimbleInternalError); | ||
} | ||
|
||
TEST_F(BufferPoolTest, FillEmptyFillBufferPool) { | ||
size_t iterations = 10; | ||
std::vector<BufferPtr> buffers; | ||
|
||
auto bufferPool = | ||
BufferPool{*memPool_, std::chrono::milliseconds{10}, iterations}; | ||
for (auto i = 0; i < iterations; i++) { | ||
auto buffer = bufferPool.reserveBuffer(); | ||
buffers.push_back(std::move(buffer)); | ||
} | ||
EXPECT_EQ(bufferPool.size(), 0); | ||
EXPECT_EQ(buffers.size(), iterations); | ||
for (auto& buffer : buffers) { | ||
bufferPool.addBuffer(std::move(buffer)); | ||
} | ||
EXPECT_EQ(bufferPool.size(), iterations); | ||
buffers.clear(); | ||
|
||
for (auto i = 0; i < iterations; i++) { | ||
auto buffer = bufferPool.reserveBuffer(); | ||
buffers.push_back(std::move(buffer)); | ||
} | ||
EXPECT_EQ(bufferPool.size(), 0); | ||
EXPECT_EQ(buffers.size(), iterations); | ||
} | ||
|
||
TEST_F(BufferPoolTest, ParallelFillPool) { | ||
folly::CPUThreadPoolExecutor executor{10}; | ||
ExecutorBarrier barrier{executor}; | ||
auto bufferPool = | ||
BufferPool{*memPool_, std::chrono::milliseconds{1000 * 10}, 100}; | ||
auto fillPool = [&]() { | ||
for (auto i = 0; i < 10; i++) { | ||
EXPECT_NO_THROW( | ||
auto buffer = bufferPool.reserveBuffer(); | ||
std::this_thread::sleep_for(std::chrono::milliseconds{1000}); | ||
bufferPool.addBuffer(std::move(buffer));); | ||
} | ||
}; | ||
|
||
for (auto i = 0; i < 10; i++) { | ||
barrier.add(fillPool); | ||
} | ||
|
||
barrier.waitAll(); | ||
} | ||
|
||
} // namespace facebook::nimble::test |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.