mirror of https://github.com/grpc/grpc.git
retry: fix memory leak due to not freeing cached send ops upon cancellation (#28945)
* retry: fix memory leak due to not freeing cached send ops upon cancellation * clang-format * attempt to fix proxy tests on windowspull/28951/head
Mark D. Roth
3 years ago
committed by
GitHub
parent
6b8a17d1ea
commit
f48c4f1f4b
9 changed files with 250 additions and 1 deletions
@ -0,0 +1,218 @@ |
|||||||
|
//
|
||||||
|
// Copyright 2017 gRPC authors.
|
||||||
|
//
|
||||||
|
// 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 <stdio.h> |
||||||
|
#include <string.h> |
||||||
|
|
||||||
|
#include <grpc/byte_buffer.h> |
||||||
|
#include <grpc/grpc.h> |
||||||
|
#include <grpc/support/alloc.h> |
||||||
|
#include <grpc/support/log.h> |
||||||
|
#include <grpc/support/string_util.h> |
||||||
|
#include <grpc/support/time.h> |
||||||
|
|
||||||
|
#include "src/core/lib/channel/channel_args.h" |
||||||
|
#include "src/core/lib/gpr/string.h" |
||||||
|
#include "src/core/lib/gpr/useful.h" |
||||||
|
#include "src/core/lib/iomgr/exec_ctx.h" |
||||||
|
#include "test/core/end2end/cq_verifier.h" |
||||||
|
#include "test/core/end2end/end2end_tests.h" |
||||||
|
#include "test/core/end2end/tests/cancel_test_helpers.h" |
||||||
|
|
||||||
|
static void* tag(intptr_t t) { return reinterpret_cast<void*>(t); } |
||||||
|
|
||||||
|
static grpc_end2end_test_fixture begin_test(grpc_end2end_test_config config, |
||||||
|
const char* test_name, |
||||||
|
grpc_channel_args* client_args, |
||||||
|
grpc_channel_args* server_args) { |
||||||
|
grpc_end2end_test_fixture f; |
||||||
|
gpr_log(GPR_INFO, "Running test: %s/%s", test_name, config.name); |
||||||
|
f = config.create_fixture(client_args, server_args); |
||||||
|
config.init_server(&f, server_args); |
||||||
|
config.init_client(&f, client_args); |
||||||
|
return f; |
||||||
|
} |
||||||
|
|
||||||
|
static gpr_timespec n_seconds_from_now(int n) { |
||||||
|
return grpc_timeout_seconds_to_deadline(n); |
||||||
|
} |
||||||
|
|
||||||
|
static gpr_timespec five_seconds_from_now(void) { |
||||||
|
return n_seconds_from_now(5); |
||||||
|
} |
||||||
|
|
||||||
|
static void drain_cq(grpc_completion_queue* cq) { |
||||||
|
grpc_event ev; |
||||||
|
do { |
||||||
|
ev = grpc_completion_queue_next(cq, five_seconds_from_now(), nullptr); |
||||||
|
} while (ev.type != GRPC_QUEUE_SHUTDOWN); |
||||||
|
} |
||||||
|
|
||||||
|
static void shutdown_server(grpc_end2end_test_fixture* f) { |
||||||
|
if (!f->server) return; |
||||||
|
grpc_server_shutdown_and_notify(f->server, f->shutdown_cq, tag(1000)); |
||||||
|
GPR_ASSERT(grpc_completion_queue_pluck(f->shutdown_cq, tag(1000), |
||||||
|
grpc_timeout_seconds_to_deadline(5), |
||||||
|
nullptr) |
||||||
|
.type == GRPC_OP_COMPLETE); |
||||||
|
grpc_server_destroy(f->server); |
||||||
|
f->server = nullptr; |
||||||
|
} |
||||||
|
|
||||||
|
static void shutdown_client(grpc_end2end_test_fixture* f) { |
||||||
|
if (!f->client) return; |
||||||
|
grpc_channel_destroy(f->client); |
||||||
|
f->client = nullptr; |
||||||
|
} |
||||||
|
|
||||||
|
static void end_test(grpc_end2end_test_fixture* f) { |
||||||
|
shutdown_server(f); |
||||||
|
shutdown_client(f); |
||||||
|
|
||||||
|
grpc_completion_queue_shutdown(f->cq); |
||||||
|
drain_cq(f->cq); |
||||||
|
grpc_completion_queue_destroy(f->cq); |
||||||
|
grpc_completion_queue_destroy(f->shutdown_cq); |
||||||
|
} |
||||||
|
|
||||||
|
// Tests that we can unref a call after the first attempt starts but
|
||||||
|
// before any ops complete. This should not cause a memory leak.
|
||||||
|
static void test_retry_cancel_after_first_attempt_starts( |
||||||
|
grpc_end2end_test_config config) { |
||||||
|
grpc_call* c; |
||||||
|
grpc_op ops[6]; |
||||||
|
grpc_op* op; |
||||||
|
grpc_metadata_array initial_metadata_recv; |
||||||
|
grpc_metadata_array trailing_metadata_recv; |
||||||
|
// Make sure to dynamically allocate the request payload slice, so
|
||||||
|
// that the test will fail under ASAN if we don't clean up properly.
|
||||||
|
const char request_string[] = "foo"; |
||||||
|
grpc_slice request_payload_slice = |
||||||
|
grpc_slice_malloc_large(sizeof(request_string)); |
||||||
|
memcpy(GRPC_SLICE_START_PTR(request_payload_slice), request_string, |
||||||
|
sizeof(request_string)); |
||||||
|
grpc_byte_buffer* request_payload = |
||||||
|
grpc_raw_byte_buffer_create(&request_payload_slice, 1); |
||||||
|
grpc_slice_unref(request_payload_slice); |
||||||
|
grpc_byte_buffer* response_payload_recv = nullptr; |
||||||
|
grpc_status_code status; |
||||||
|
grpc_slice details; |
||||||
|
grpc_call_error error; |
||||||
|
|
||||||
|
grpc_arg args[] = { |
||||||
|
grpc_channel_arg_string_create( |
||||||
|
const_cast<char*>(GRPC_ARG_SERVICE_CONFIG), |
||||||
|
const_cast<char*>( |
||||||
|
"{\n" |
||||||
|
" \"methodConfig\": [ {\n" |
||||||
|
" \"name\": [\n" |
||||||
|
" { \"service\": \"service\", \"method\": \"method\" }\n" |
||||||
|
" ],\n" |
||||||
|
" \"retryPolicy\": {\n" |
||||||
|
" \"maxAttempts\": 3,\n" |
||||||
|
" \"initialBackoff\": \"1s\",\n" |
||||||
|
" \"maxBackoff\": \"120s\",\n" |
||||||
|
" \"backoffMultiplier\": 1.6,\n" |
||||||
|
" \"retryableStatusCodes\": [ \"ABORTED\" ]\n" |
||||||
|
" }\n" |
||||||
|
" } ]\n" |
||||||
|
"}")), |
||||||
|
}; |
||||||
|
grpc_channel_args client_args = {GPR_ARRAY_SIZE(args), args}; |
||||||
|
grpc_end2end_test_fixture f = begin_test( |
||||||
|
config, "retry_cancel_after_first_attempt_starts", &client_args, nullptr); |
||||||
|
|
||||||
|
cq_verifier* cqv = cq_verifier_create(f.cq); |
||||||
|
|
||||||
|
gpr_timespec deadline = five_seconds_from_now(); |
||||||
|
c = grpc_channel_create_call(f.client, nullptr, GRPC_PROPAGATE_DEFAULTS, f.cq, |
||||||
|
grpc_slice_from_static_string("/service/method"), |
||||||
|
nullptr, deadline, nullptr); |
||||||
|
GPR_ASSERT(c); |
||||||
|
|
||||||
|
grpc_metadata_array_init(&initial_metadata_recv); |
||||||
|
grpc_metadata_array_init(&trailing_metadata_recv); |
||||||
|
|
||||||
|
// Client starts send ops.
|
||||||
|
memset(ops, 0, sizeof(ops)); |
||||||
|
op = ops; |
||||||
|
op->op = GRPC_OP_SEND_INITIAL_METADATA; |
||||||
|
op->data.send_initial_metadata.count = 0; |
||||||
|
op++; |
||||||
|
op->op = GRPC_OP_SEND_MESSAGE; |
||||||
|
op->data.send_message.send_message = request_payload; |
||||||
|
op++; |
||||||
|
op->op = GRPC_OP_SEND_CLOSE_FROM_CLIENT; |
||||||
|
op++; |
||||||
|
error = grpc_call_start_batch(c, ops, static_cast<size_t>(op - ops), tag(1), |
||||||
|
nullptr); |
||||||
|
GPR_ASSERT(GRPC_CALL_OK == error); |
||||||
|
|
||||||
|
// Client starts recv_initial_metadata and recv_message, but not
|
||||||
|
// recv_trailing_metadata.
|
||||||
|
memset(ops, 0, sizeof(ops)); |
||||||
|
op = ops; |
||||||
|
op->op = GRPC_OP_RECV_INITIAL_METADATA; |
||||||
|
op->data.recv_initial_metadata.recv_initial_metadata = &initial_metadata_recv; |
||||||
|
op++; |
||||||
|
op->op = GRPC_OP_RECV_MESSAGE; |
||||||
|
op->data.recv_message.recv_message = &response_payload_recv; |
||||||
|
op++; |
||||||
|
error = grpc_call_start_batch(c, ops, static_cast<size_t>(op - ops), tag(2), |
||||||
|
nullptr); |
||||||
|
GPR_ASSERT(GRPC_CALL_OK == error); |
||||||
|
|
||||||
|
// Client starts recv_trailing_metadata.
|
||||||
|
memset(ops, 0, sizeof(ops)); |
||||||
|
op = ops; |
||||||
|
op->op = GRPC_OP_RECV_STATUS_ON_CLIENT; |
||||||
|
op->data.recv_status_on_client.trailing_metadata = &trailing_metadata_recv; |
||||||
|
op->data.recv_status_on_client.status = &status; |
||||||
|
op->data.recv_status_on_client.status_details = &details; |
||||||
|
op++; |
||||||
|
error = grpc_call_start_batch(c, ops, static_cast<size_t>(op - ops), tag(3), |
||||||
|
nullptr); |
||||||
|
GPR_ASSERT(GRPC_CALL_OK == error); |
||||||
|
|
||||||
|
// Client unrefs the call without starting recv_trailing_metadata.
|
||||||
|
// This should trigger a cancellation.
|
||||||
|
grpc_call_unref(c); |
||||||
|
|
||||||
|
// The send ops batch and the first recv ops batch will fail in most
|
||||||
|
// fixtures but will pass in the proxy fixtures on some platforms.
|
||||||
|
CQ_EXPECT_COMPLETION_ANY_STATUS(cqv, tag(1)); |
||||||
|
CQ_EXPECT_COMPLETION_ANY_STATUS(cqv, tag(2)); |
||||||
|
CQ_EXPECT_COMPLETION(cqv, tag(3), true); |
||||||
|
cq_verify(cqv); |
||||||
|
|
||||||
|
grpc_slice_unref(details); |
||||||
|
grpc_metadata_array_destroy(&initial_metadata_recv); |
||||||
|
grpc_metadata_array_destroy(&trailing_metadata_recv); |
||||||
|
grpc_byte_buffer_destroy(request_payload); |
||||||
|
grpc_byte_buffer_destroy(response_payload_recv); |
||||||
|
|
||||||
|
cq_verifier_destroy(cqv); |
||||||
|
|
||||||
|
end_test(&f); |
||||||
|
config.tear_down_data(&f); |
||||||
|
} |
||||||
|
|
||||||
|
void retry_cancel_after_first_attempt_starts(grpc_end2end_test_config config) { |
||||||
|
GPR_ASSERT(config.feature_mask & FEATURE_MASK_SUPPORTS_CLIENT_CHANNEL); |
||||||
|
test_retry_cancel_after_first_attempt_starts(config); |
||||||
|
} |
||||||
|
|
||||||
|
void retry_cancel_after_first_attempt_starts_pre_init(void) {} |
||||||
Loading…
Reference in new issue