Skip to content
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.

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

chore: connection pipeline cache does not shrink #4491

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
44 changes: 32 additions & 12 deletions src/facade/dragonfly_connection.cc
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
#include <absl/strings/str_cat.h>
#include <mimalloc.h>

#include <chrono>
#include <numeric>
#include <variant>

Expand Down Expand Up @@ -93,7 +94,6 @@ using nonstd::make_unexpected;

namespace facade {


namespace {

void SendProtocolError(RedisParser::Result pres, SinkReplyBuilder* builder) {
Expand Down Expand Up @@ -266,8 +266,6 @@ void LogTraffic(uint32_t id, bool has_more, absl::Span<RespExpr> resp,

constexpr size_t kMinReadSize = 256;

thread_local uint32_t free_req_release_weight = 0;

const char* kPhaseName[Connection::NUM_PHASES] = {"SETUP", "READ", "PROCESS", "SHUTTING_DOWN",
"PRECLOSE"};

Expand Down Expand Up @@ -316,6 +314,36 @@ QueueBackpressure& GetQueueBackpressure() {

thread_local vector<Connection::PipelineMessagePtr> Connection::pipeline_req_pool_;

class PipelineCacheSizePaceMaker {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: maybe PipelineWatermarkTracker

public:
bool WatermarkReached(size_t pipeline_sz) {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: maybe CheckAndUpdateWatermark

const auto now = Clock::now();
const auto elapsed = now - last_check_;

const size_t max = Limits::max();
if (elapsed < std::chrono::milliseconds(10)) {
min_ = std::min(min_, pipeline_sz);
return false;
}

const bool watermark_reached = (min_ > 0) && (min_ != max);
min_ = max;
last_check_ = Clock::now();

return watermark_reached;
}

private:
using Tp = std::chrono::time_point<std::chrono::system_clock>;
using Clock = std::chrono::system_clock;
using Limits = std::numeric_limits<size_t>;

Tp last_check_ = Clock::now();
size_t min_ = Limits::max();
};

thread_local PipelineCacheSizePaceMaker tl_pipe_pace_maker;

void Connection::PipelineMessage::SetArgs(const RespVec& args) {
auto* next = storage.data();
for (size_t i = 0; i < args.size(); ++i) {
Expand Down Expand Up @@ -1589,14 +1617,7 @@ void Connection::ShrinkPipelinePool() {
if (pipeline_req_pool_.empty())
return;

// The request pool is shared by all the connections in the thread so we do not want
// to release it aggressively just because some connection is running in
// non-pipelined mode. So by using free_req_release_weight we wait at least N times,
// where N is the number of connections in the thread.
++free_req_release_weight;

if (free_req_release_weight > stats_->num_conns) {
free_req_release_weight = 0;
if (tl_pipe_pace_maker.WatermarkReached(pipeline_req_pool_.size())) {
stats_->pipeline_cmd_cache_bytes -= pipeline_req_pool_.back()->StorageCapacity();
pipeline_req_pool_.pop_back();
}
Expand All @@ -1606,7 +1627,6 @@ Connection::PipelineMessagePtr Connection::GetFromPipelinePool() {
if (pipeline_req_pool_.empty())
return nullptr;

free_req_release_weight = 0; // Reset the release weight.
auto ptr = std::move(pipeline_req_pool_.back());
stats_->pipeline_cmd_cache_bytes -= ptr->StorageCapacity();
pipeline_req_pool_.pop_back();
Expand Down
55 changes: 53 additions & 2 deletions tests/dragonfly/connection_test.py
Original file line number Diff line number Diff line change
Expand Up @@ -1061,7 +1061,7 @@ async def test_timeout(df_server: DflyInstance, async_client: aioredis.Redis):
assert len(clients) == 2

await asyncio.sleep(2)

@assert_eventually
async def wait_for_conn_drop():
clients = await async_client.client_list()
Expand All @@ -1070,4 +1070,55 @@ async def wait_for_conn_drop():

await wait_for_conn_drop()
info = await async_client.info("clients")
assert int(info["timeout_disconnects"]) >= 1
assert int(info["timeout_disconnects"]) >= 1


@dfly_args({"proactor_threads": 1})
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please add some comments on this test

async def test_pipeline_cache_size(df_factory):
server = df_factory.create(proactor_threads=1)
server.start()

# Start 1 client.
good_client = server.client()

await good_client.execute_command("set foo bar")

bad_actor_client = server.client()

info = await bad_actor_client.info()

# Cache is empty.
assert info["pipeline_cache_bytes"] == 0
assert info["dispatch_queue_bytes"] == 0

async def push_pipeline(bad_actor_client, size=1):
# Fill cache.
p = bad_actor_client.pipeline(transaction=True)
for i in range(size):
p.lpush(str(i), "V")
await p.execute()

await push_pipeline(bad_actor_client, 32)
info = await good_client.info()

old_pipeline_cache_bytes = info["pipeline_cache_bytes"]
assert old_pipeline_cache_bytes > 0
assert info["dispatch_queue_bytes"] == 0

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We cam drain the pipeline cache bytes once we stop dispatching async. But on large pool of connections only one command must dispatch async and then we need to internally reset the counter. If this pattern continues the size of the cache will remain constant and will not be released gradually.

for i in range(30):
await push_pipeline(bad_actor_client)
await good_client.execute_command(f"set foo{i} bar")

info = await good_client.info()

# Gradually release pipeline
assert old_pipeline_cache_bytes > info["pipeline_cache_bytes"]
assert info["dispatch_queue_bytes"] == 0

# Now drain it
async with async_timeout.timeout(5):
while info["pipeline_cache_bytes"] != 0:
await good_client.execute_command(f"set foo{i} bar")
info = await good_client.info()

assert info["dispatch_queue_bytes"] == 0
Loading