| /* |
| * |
| * Copyright 2017, Google Inc. |
| * All rights reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions are |
| * met: |
| * |
| * * Redistributions of source code must retain the above copyright |
| * notice, this list of conditions and the following disclaimer. |
| * * Redistributions in binary form must reproduce the above |
| * copyright notice, this list of conditions and the following disclaimer |
| * in the documentation and/or other materials provided with the |
| * distribution. |
| * * Neither the name of Google Inc. nor the names of its |
| * contributors may be used to endorse or promote products derived from |
| * this software without specific prior written permission. |
| * |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| * |
| */ |
| |
| #include "test/core/end2end/end2end_tests.h" |
| |
| #include <limits.h> |
| #include <string.h> |
| |
| #include <grpc/support/log.h> |
| #include <grpc/support/sync.h> |
| #include <grpc/support/time.h> |
| #include <grpc/support/useful.h> |
| |
| #include "test/core/end2end/cq_verifier.h" |
| |
| #define MAX_CONNECTION_AGE_MS 500 |
| #define MAX_CONNECTION_AGE_GRACE_MS 1000 |
| #define MAX_CONNECTION_IDLE_MS 9999 |
| |
| #define MAX_CONNECTION_AGE_JITTER_MULTIPLIER 1.1 |
| #define CALL_DEADLINE_S 10 |
| /* The amount of time we wait for the connection to time out, but after it the |
| connection should not use up its grace period. It should be a number between |
| MAX_CONNECTION_AGE_MS and MAX_CONNECTION_AGE_MS + |
| MAX_CONNECTION_AGE_GRACE_MS */ |
| #define CQ_MAX_CONNECTION_AGE_WAIT_TIME_S 1 |
| /* The amount of time we wait after the connection reaches its max age, it |
| should be shorter than CALL_DEADLINE_S - CQ_MAX_CONNECTION_AGE_WAIT_TIME_S */ |
| #define CQ_MAX_CONNECTION_AGE_GRACE_WAIT_TIME_S 2 |
| /* The grace period for the test to observe the channel shutdown process */ |
| #define IMMEDIATE_SHUTDOWN_GRACE_TIME_MS 3000 |
| |
| static void *tag(intptr_t t) { return (void *)t; } |
| |
| static void drain_cq(grpc_completion_queue *cq) { |
| grpc_event ev; |
| do { |
| ev = grpc_completion_queue_next(cq, grpc_timeout_seconds_to_deadline(5), |
| NULL); |
| } while (ev.type != GRPC_QUEUE_SHUTDOWN); |
| } |
| |
| static void shutdown_server(grpc_end2end_test_fixture *f) { |
| if (!f->server) return; |
| grpc_server_destroy(f->server); |
| f->server = NULL; |
| } |
| |
| static void shutdown_client(grpc_end2end_test_fixture *f) { |
| if (!f->client) return; |
| grpc_channel_destroy(f->client); |
| f->client = NULL; |
| } |
| |
| 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); |
| } |
| |
| static void test_max_age_forcibly_close(grpc_end2end_test_config config) { |
| grpc_end2end_test_fixture f = config.create_fixture(NULL, NULL); |
| cq_verifier *cqv = cq_verifier_create(f.cq); |
| grpc_arg server_a[] = {{.type = GRPC_ARG_INTEGER, |
| .key = GRPC_ARG_MAX_CONNECTION_AGE_MS, |
| .value.integer = MAX_CONNECTION_AGE_MS}, |
| {.type = GRPC_ARG_INTEGER, |
| .key = GRPC_ARG_MAX_CONNECTION_AGE_GRACE_MS, |
| .value.integer = MAX_CONNECTION_AGE_GRACE_MS}, |
| {.type = GRPC_ARG_INTEGER, |
| .key = GRPC_ARG_MAX_CONNECTION_IDLE_MS, |
| .value.integer = MAX_CONNECTION_IDLE_MS}}; |
| grpc_channel_args server_args = {.num_args = GPR_ARRAY_SIZE(server_a), |
| .args = server_a}; |
| |
| config.init_client(&f, NULL); |
| config.init_server(&f, &server_args); |
| |
| grpc_call *c; |
| grpc_call *s; |
| gpr_timespec deadline = grpc_timeout_seconds_to_deadline(CALL_DEADLINE_S); |
| grpc_op ops[6]; |
| grpc_op *op; |
| grpc_metadata_array initial_metadata_recv; |
| grpc_metadata_array trailing_metadata_recv; |
| grpc_metadata_array request_metadata_recv; |
| grpc_call_details call_details; |
| grpc_status_code status; |
| grpc_call_error error; |
| grpc_slice details; |
| int was_cancelled = 2; |
| |
| c = grpc_channel_create_call( |
| f.client, NULL, GRPC_PROPAGATE_DEFAULTS, f.cq, |
| grpc_slice_from_static_string("/foo"), |
| get_host_override_slice("foo.test.google.fr:1234", config), deadline, |
| NULL); |
| GPR_ASSERT(c); |
| |
| grpc_metadata_array_init(&initial_metadata_recv); |
| grpc_metadata_array_init(&trailing_metadata_recv); |
| grpc_metadata_array_init(&request_metadata_recv); |
| grpc_call_details_init(&call_details); |
| |
| memset(ops, 0, sizeof(ops)); |
| op = ops; |
| op->op = GRPC_OP_SEND_INITIAL_METADATA; |
| op->data.send_initial_metadata.count = 0; |
| op->data.send_initial_metadata.metadata = NULL; |
| op->flags = 0; |
| op->reserved = NULL; |
| op++; |
| op->op = GRPC_OP_SEND_CLOSE_FROM_CLIENT; |
| op->flags = 0; |
| op->reserved = NULL; |
| op++; |
| op->op = GRPC_OP_RECV_INITIAL_METADATA; |
| op->data.recv_initial_metadata.recv_initial_metadata = &initial_metadata_recv; |
| op->flags = 0; |
| op->reserved = NULL; |
| op++; |
| 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->flags = 0; |
| op->reserved = NULL; |
| op++; |
| error = grpc_call_start_batch(c, ops, (size_t)(op - ops), tag(1), NULL); |
| GPR_ASSERT(GRPC_CALL_OK == error); |
| |
| error = |
| grpc_server_request_call(f.server, &s, &call_details, |
| &request_metadata_recv, f.cq, f.cq, tag(101)); |
| GPR_ASSERT(GRPC_CALL_OK == error); |
| CQ_EXPECT_COMPLETION(cqv, tag(101), true); |
| cq_verify(cqv); |
| |
| gpr_timespec expect_shutdown_time = grpc_timeout_milliseconds_to_deadline( |
| (int)(MAX_CONNECTION_AGE_MS * MAX_CONNECTION_AGE_JITTER_MULTIPLIER) + |
| MAX_CONNECTION_AGE_GRACE_MS + IMMEDIATE_SHUTDOWN_GRACE_TIME_MS); |
| |
| /* Wait for the channel to reach its max age */ |
| cq_verify_empty_timeout(cqv, CQ_MAX_CONNECTION_AGE_WAIT_TIME_S); |
| |
| /* After the channel reaches its max age, we still do nothing here. And wait |
| for it to use up its max age grace period. */ |
| CQ_EXPECT_COMPLETION(cqv, tag(1), true); |
| cq_verify(cqv); |
| |
| gpr_timespec channel_shutdown_time = gpr_now(GPR_CLOCK_MONOTONIC); |
| GPR_ASSERT(gpr_time_cmp(channel_shutdown_time, expect_shutdown_time) < 0); |
| |
| memset(ops, 0, sizeof(ops)); |
| op = ops; |
| op->op = GRPC_OP_SEND_INITIAL_METADATA; |
| op->data.send_initial_metadata.count = 0; |
| op->flags = 0; |
| op->reserved = NULL; |
| op++; |
| op->op = GRPC_OP_SEND_STATUS_FROM_SERVER; |
| op->data.send_status_from_server.trailing_metadata_count = 0; |
| op->data.send_status_from_server.status = GRPC_STATUS_UNIMPLEMENTED; |
| grpc_slice status_details = grpc_slice_from_static_string("xyz"); |
| op->data.send_status_from_server.status_details = &status_details; |
| op->flags = 0; |
| op->reserved = NULL; |
| op++; |
| op->op = GRPC_OP_RECV_CLOSE_ON_SERVER; |
| op->data.recv_close_on_server.cancelled = &was_cancelled; |
| op->flags = 0; |
| op->reserved = NULL; |
| op++; |
| error = grpc_call_start_batch(s, ops, (size_t)(op - ops), tag(102), NULL); |
| GPR_ASSERT(GRPC_CALL_OK == error); |
| CQ_EXPECT_COMPLETION(cqv, tag(102), true); |
| cq_verify(cqv); |
| |
| grpc_server_shutdown_and_notify(f.server, f.cq, tag(0xdead)); |
| CQ_EXPECT_COMPLETION(cqv, tag(0xdead), true); |
| cq_verify(cqv); |
| |
| grpc_call_destroy(s); |
| |
| /* The connection should be closed immediately after the max age grace period, |
| the in-progress RPC should fail. */ |
| GPR_ASSERT(status == GRPC_STATUS_UNAVAILABLE); |
| GPR_ASSERT(0 == grpc_slice_str_cmp(details, "Endpoint read failed")); |
| GPR_ASSERT(0 == grpc_slice_str_cmp(call_details.method, "/foo")); |
| validate_host_override_string("foo.test.google.fr:1234", call_details.host, |
| config); |
| GPR_ASSERT(was_cancelled == 1); |
| |
| grpc_slice_unref(details); |
| grpc_metadata_array_destroy(&initial_metadata_recv); |
| grpc_metadata_array_destroy(&trailing_metadata_recv); |
| grpc_metadata_array_destroy(&request_metadata_recv); |
| grpc_call_details_destroy(&call_details); |
| grpc_call_destroy(c); |
| cq_verifier_destroy(cqv); |
| end_test(&f); |
| config.tear_down_data(&f); |
| } |
| |
| static void test_max_age_gracefully_close(grpc_end2end_test_config config) { |
| grpc_end2end_test_fixture f = config.create_fixture(NULL, NULL); |
| cq_verifier *cqv = cq_verifier_create(f.cq); |
| grpc_arg server_a[] = {{.type = GRPC_ARG_INTEGER, |
| .key = GRPC_ARG_MAX_CONNECTION_AGE_MS, |
| .value.integer = MAX_CONNECTION_AGE_MS}, |
| {.type = GRPC_ARG_INTEGER, |
| .key = GRPC_ARG_MAX_CONNECTION_AGE_GRACE_MS, |
| .value.integer = INT_MAX}, |
| {.type = GRPC_ARG_INTEGER, |
| .key = GRPC_ARG_MAX_CONNECTION_IDLE_MS, |
| .value.integer = MAX_CONNECTION_IDLE_MS}}; |
| grpc_channel_args server_args = {.num_args = GPR_ARRAY_SIZE(server_a), |
| .args = server_a}; |
| |
| config.init_client(&f, NULL); |
| config.init_server(&f, &server_args); |
| |
| grpc_call *c; |
| grpc_call *s; |
| gpr_timespec deadline = grpc_timeout_seconds_to_deadline(CALL_DEADLINE_S); |
| grpc_op ops[6]; |
| grpc_op *op; |
| grpc_metadata_array initial_metadata_recv; |
| grpc_metadata_array trailing_metadata_recv; |
| grpc_metadata_array request_metadata_recv; |
| grpc_call_details call_details; |
| grpc_status_code status; |
| grpc_call_error error; |
| grpc_slice details; |
| int was_cancelled = 2; |
| |
| c = grpc_channel_create_call( |
| f.client, NULL, GRPC_PROPAGATE_DEFAULTS, f.cq, |
| grpc_slice_from_static_string("/foo"), |
| get_host_override_slice("foo.test.google.fr:1234", config), deadline, |
| NULL); |
| GPR_ASSERT(c); |
| |
| grpc_metadata_array_init(&initial_metadata_recv); |
| grpc_metadata_array_init(&trailing_metadata_recv); |
| grpc_metadata_array_init(&request_metadata_recv); |
| grpc_call_details_init(&call_details); |
| |
| memset(ops, 0, sizeof(ops)); |
| op = ops; |
| op->op = GRPC_OP_SEND_INITIAL_METADATA; |
| op->data.send_initial_metadata.count = 0; |
| op->data.send_initial_metadata.metadata = NULL; |
| op->flags = 0; |
| op->reserved = NULL; |
| op++; |
| op->op = GRPC_OP_SEND_CLOSE_FROM_CLIENT; |
| op->flags = 0; |
| op->reserved = NULL; |
| op++; |
| op->op = GRPC_OP_RECV_INITIAL_METADATA; |
| op->data.recv_initial_metadata.recv_initial_metadata = &initial_metadata_recv; |
| op->flags = 0; |
| op->reserved = NULL; |
| op++; |
| 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->flags = 0; |
| op->reserved = NULL; |
| op++; |
| error = grpc_call_start_batch(c, ops, (size_t)(op - ops), tag(1), NULL); |
| GPR_ASSERT(GRPC_CALL_OK == error); |
| |
| error = |
| grpc_server_request_call(f.server, &s, &call_details, |
| &request_metadata_recv, f.cq, f.cq, tag(101)); |
| GPR_ASSERT(GRPC_CALL_OK == error); |
| CQ_EXPECT_COMPLETION(cqv, tag(101), true); |
| cq_verify(cqv); |
| |
| /* Wait for the channel to reach its max age */ |
| cq_verify_empty_timeout(cqv, CQ_MAX_CONNECTION_AGE_WAIT_TIME_S); |
| |
| /* The connection is shutting down gracefully. In-progress rpc should not be |
| closed, hence the completion queue should see nothing here. */ |
| cq_verify_empty_timeout(cqv, CQ_MAX_CONNECTION_AGE_GRACE_WAIT_TIME_S); |
| |
| memset(ops, 0, sizeof(ops)); |
| op = ops; |
| op->op = GRPC_OP_SEND_INITIAL_METADATA; |
| op->data.send_initial_metadata.count = 0; |
| op->flags = 0; |
| op->reserved = NULL; |
| op++; |
| op->op = GRPC_OP_SEND_STATUS_FROM_SERVER; |
| op->data.send_status_from_server.trailing_metadata_count = 0; |
| op->data.send_status_from_server.status = GRPC_STATUS_UNIMPLEMENTED; |
| grpc_slice status_details = grpc_slice_from_static_string("xyz"); |
| op->data.send_status_from_server.status_details = &status_details; |
| op->flags = 0; |
| op->reserved = NULL; |
| op++; |
| op->op = GRPC_OP_RECV_CLOSE_ON_SERVER; |
| op->data.recv_close_on_server.cancelled = &was_cancelled; |
| op->flags = 0; |
| op->reserved = NULL; |
| op++; |
| error = grpc_call_start_batch(s, ops, (size_t)(op - ops), tag(102), NULL); |
| GPR_ASSERT(GRPC_CALL_OK == error); |
| |
| CQ_EXPECT_COMPLETION(cqv, tag(102), true); |
| CQ_EXPECT_COMPLETION(cqv, tag(1), true); |
| cq_verify(cqv); |
| |
| grpc_server_shutdown_and_notify(f.server, f.cq, tag(0xdead)); |
| CQ_EXPECT_COMPLETION(cqv, tag(0xdead), true); |
| cq_verify(cqv); |
| |
| grpc_call_destroy(s); |
| |
| /* The connection is closed gracefully with goaway, the rpc should still be |
| completed. */ |
| GPR_ASSERT(status == GRPC_STATUS_UNIMPLEMENTED); |
| GPR_ASSERT(0 == grpc_slice_str_cmp(details, "xyz")); |
| GPR_ASSERT(0 == grpc_slice_str_cmp(call_details.method, "/foo")); |
| validate_host_override_string("foo.test.google.fr:1234", call_details.host, |
| config); |
| GPR_ASSERT(was_cancelled == 1); |
| |
| grpc_slice_unref(details); |
| grpc_metadata_array_destroy(&initial_metadata_recv); |
| grpc_metadata_array_destroy(&trailing_metadata_recv); |
| grpc_metadata_array_destroy(&request_metadata_recv); |
| grpc_call_details_destroy(&call_details); |
| grpc_call_destroy(c); |
| cq_verifier_destroy(cqv); |
| end_test(&f); |
| config.tear_down_data(&f); |
| } |
| |
| void max_connection_age(grpc_end2end_test_config config) { |
| test_max_age_forcibly_close(config); |
| test_max_age_gracefully_close(config); |
| } |
| |
| void max_connection_age_pre_init(void) {} |