test/core/end2end/tests/keepalive_timeout.cc

   1 /*
   2  *
   3  * Copyright 2017 gRPC authors.
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  */
  18
  19 #include "test/core/end2end/end2end_tests.h"
  20
  21 #include <stdio.h>
  22 #include <string.h>
  23
  24 #include <grpc/byte_buffer.h>
  25 #include <grpc/support/alloc.h>
  26 #include <grpc/support/log.h>
  27 #include <grpc/support/time.h>
  28
  29 #include "src/core/ext/transport/chttp2/transport/frame_ping.h"
  30 #include "src/core/lib/channel/channel_args.h"
  31 #include "src/core/lib/gpr/env.h"
  32 #include "src/core/lib/gpr/useful.h"
  33 #include "src/core/lib/iomgr/exec_ctx.h"
  34 #include "test/core/end2end/cq_verifier.h"
  35
  36 static void* tag(intptr_t t) { return (void*)t; }
  37
  38 static grpc_end2end_test_fixture begin_test(grpc_end2end_test_config config,
  39                                             const char* test_name,
  40                                             grpc_channel_args* client_args,
  41                                             grpc_channel_args* server_args) {
  42   grpc_end2end_test_fixture f;
  43   gpr_log(GPR_INFO, "%s/%s", test_name, config.name);
  44   f = config.create_fixture(client_args, server_args);
  45   config.init_server(&f, server_args);
  46   config.init_client(&f, client_args);
  47   return f;
  48 }
  49
  50 static gpr_timespec n_seconds_from_now(int n) {
  51   return grpc_timeout_seconds_to_deadline(n);
  52 }
  53
  54 static gpr_timespec five_seconds_from_now(void) {
  55   return n_seconds_from_now(5);
  56 }
  57
  58 static void drain_cq(grpc_completion_queue* cq) {
  59   grpc_event ev;
  60   do {
  61     ev = grpc_completion_queue_next(cq, five_seconds_from_now(), nullptr);
  62   } while (ev.type != GRPC_QUEUE_SHUTDOWN);
  63 }
  64
  65 static void shutdown_server(grpc_end2end_test_fixture* f) {
  66   if (!f->server) return;
  67
  68   grpc_server_shutdown_and_notify(f->server, f->shutdown_cq, tag(1000));
  69   GPR_ASSERT(grpc_completion_queue_pluck(f->shutdown_cq, tag(1000),
  70                                          five_seconds_from_now(), nullptr)
  71                  .type == GRPC_OP_COMPLETE);
  72   grpc_server_destroy(f->server);
  73   f->server = nullptr;
  74 }
  75
  76 static void shutdown_client(grpc_end2end_test_fixture* f) {
  77   if (!f->client) return;
  78   grpc_channel_destroy(f->client);
  79   f->client = nullptr;
  80 }
  81
  82 static void end_test(grpc_end2end_test_fixture* f) {
  83   shutdown_server(f);
  84   shutdown_client(f);
  85
  86   grpc_completion_queue_shutdown(f->cq);
  87   drain_cq(f->cq);
  88   grpc_completion_queue_destroy(f->cq);
  89   grpc_completion_queue_destroy(f->shutdown_cq);
  90 }
  91
  92 /* Client sends a request, server replies with a payload, then waits for the
  93    keepalive watchdog timeouts before returning status. */
  94 static void test_keepalive_timeout(grpc_end2end_test_config config) {
  95   grpc_call* c;
  96   grpc_call* s;
  97   grpc_slice response_payload_slice =
  98       grpc_slice_from_copied_string("hello world");
  99   grpc_byte_buffer* response_payload =
 100       grpc_raw_byte_buffer_create(&response_payload_slice, 1);
 101
 102   grpc_arg keepalive_arg_elems[3];
 103   keepalive_arg_elems[0].type = GRPC_ARG_INTEGER;
 104   keepalive_arg_elems[0].key = const_cast<char*>(GRPC_ARG_KEEPALIVE_TIME_MS);
 105   keepalive_arg_elems[0].value.integer = 3500;
 106   keepalive_arg_elems[1].type = GRPC_ARG_INTEGER;
 107   keepalive_arg_elems[1].key = const_cast<char*>(GRPC_ARG_KEEPALIVE_TIMEOUT_MS);
 108   keepalive_arg_elems[1].value.integer = 0;
 109   keepalive_arg_elems[2].type = GRPC_ARG_INTEGER;
 110   keepalive_arg_elems[2].key = const_cast<char*>(GRPC_ARG_HTTP2_BDP_PROBE);
 111   keepalive_arg_elems[2].value.integer = 0;
 112   grpc_channel_args keepalive_args = {GPR_ARRAY_SIZE(keepalive_arg_elems),
 113                                       keepalive_arg_elems};
 114
 115   grpc_end2end_test_fixture f =
 116       begin_test(config, "keepalive_timeout", &keepalive_args, nullptr);
 117   cq_verifier* cqv = cq_verifier_create(f.cq);
 118   grpc_op ops[6];
 119   grpc_op* op;
 120   grpc_metadata_array initial_metadata_recv;
 121   grpc_metadata_array trailing_metadata_recv;
 122   grpc_metadata_array request_metadata_recv;
 123   grpc_byte_buffer* response_payload_recv = nullptr;
 124   grpc_call_details call_details;
 125   grpc_status_code status;
 126   grpc_call_error error;
 127   grpc_slice details;
 128
 129   /* Disable ping ack to trigger the keepalive timeout */
 130   grpc_set_disable_ping_ack(true);
 131
 132   gpr_timespec deadline = five_seconds_from_now();
 133   c = grpc_channel_create_call(f.client, nullptr, GRPC_PROPAGATE_DEFAULTS, f.cq,
 134                                grpc_slice_from_static_string("/foo"), nullptr,
 135                                deadline, nullptr);
 136   GPR_ASSERT(c);
 137
 138   grpc_metadata_array_init(&initial_metadata_recv);
 139   grpc_metadata_array_init(&trailing_metadata_recv);
 140   grpc_metadata_array_init(&request_metadata_recv);
 141   grpc_call_details_init(&call_details);
 142
 143   memset(ops, 0, sizeof(ops));
 144   op = ops;
 145   op->op = GRPC_OP_SEND_INITIAL_METADATA;
 146   op->data.send_initial_metadata.count = 0;
 147   op++;
 148   op->op = GRPC_OP_SEND_CLOSE_FROM_CLIENT;
 149   op++;
 150   op->op = GRPC_OP_RECV_INITIAL_METADATA;
 151   op->data.recv_initial_metadata.recv_initial_metadata = &initial_metadata_recv;
 152   op++;
 153   op->op = GRPC_OP_RECV_MESSAGE;
 154   op->data.recv_message.recv_message = &response_payload_recv;
 155   op++;
 156   error = grpc_call_start_batch(c, ops, static_cast<size_t>(op - ops), tag(1),
 157                                 nullptr);
 158   GPR_ASSERT(GRPC_CALL_OK == error);
 159
 160   GPR_ASSERT(GRPC_CALL_OK == grpc_server_request_call(
 161                                  f.server, &s, &call_details,
 162                                  &request_metadata_recv, f.cq, f.cq, tag(101)));
 163   CQ_EXPECT_COMPLETION(cqv, tag(101), 1);
 164   cq_verify(cqv);
 165
 166   memset(ops, 0, sizeof(ops));
 167   op = ops;
 168   op->op = GRPC_OP_SEND_INITIAL_METADATA;
 169   op->data.send_initial_metadata.count = 0;
 170   op++;
 171   op->op = GRPC_OP_SEND_MESSAGE;
 172   op->data.send_message.send_message = response_payload;
 173   op++;
 174   error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops), tag(102),
 175                                 nullptr);
 176   GPR_ASSERT(GRPC_CALL_OK == error);
 177
 178   CQ_EXPECT_COMPLETION(cqv, tag(102), 1);
 179   CQ_EXPECT_COMPLETION(cqv, tag(1), 1);
 180   cq_verify(cqv);
 181
 182   memset(ops, 0, sizeof(ops));
 183   op = ops;
 184   op->op = GRPC_OP_RECV_STATUS_ON_CLIENT;
 185   op->data.recv_status_on_client.trailing_metadata = &trailing_metadata_recv;
 186   op->data.recv_status_on_client.status = &status;
 187   op->data.recv_status_on_client.status_details = &details;
 188   op++;
 189   error = grpc_call_start_batch(c, ops, static_cast<size_t>(op - ops), tag(3),
 190                                 nullptr);
 191   GPR_ASSERT(GRPC_CALL_OK == error);
 192
 193   CQ_EXPECT_COMPLETION(cqv, tag(3), 1);
 194   cq_verify(cqv);
 195
 196   char* details_str = grpc_slice_to_c_string(details);
 197   char* method_str = grpc_slice_to_c_string(call_details.method);
 198   GPR_ASSERT(status == GRPC_STATUS_UNAVAILABLE);
 199   GPR_ASSERT(0 == grpc_slice_str_cmp(details, "keepalive watchdog timeout"));
 200   GPR_ASSERT(0 == grpc_slice_str_cmp(call_details.method, "/foo"));
 201
 202   gpr_free(details_str);
 203   gpr_free(method_str);
 204
 205   grpc_slice_unref(details);
 206   grpc_metadata_array_destroy(&initial_metadata_recv);
 207   grpc_metadata_array_destroy(&trailing_metadata_recv);
 208   grpc_metadata_array_destroy(&request_metadata_recv);
 209   grpc_call_details_destroy(&call_details);
 210
 211   grpc_call_unref(c);
 212   grpc_call_unref(s);
 213
 214   cq_verifier_destroy(cqv);
 215
 216   grpc_byte_buffer_destroy(response_payload);
 217   grpc_byte_buffer_destroy(response_payload_recv);
 218
 219   end_test(&f);
 220   config.tear_down_data(&f);
 221 }
 222
 223 /* Verify that reads reset the keepalive ping timer. The client sends 30 pings
 224  * with a sleep of 10ms in between. It has a configured keepalive timer of
 225  * 200ms. In the success case, each ping ack should reset the keepalive timer so
 226  * that the keepalive ping is never sent. */
 227 static void test_read_delays_keepalive(grpc_end2end_test_config config) {
 228   char* poller = gpr_getenv("GRPC_POLL_STRATEGY");
 229   /* It is hard to get the timing right for the polling engine poll. */
 230   if (poller != nullptr && (0 == strcmp(poller, "poll"))) {
 231     gpr_free(poller);
 232     return;
 233   }
 234   gpr_free(poller);
 235   const int kPingIntervalMS = 100;
 236   grpc_arg keepalive_arg_elems[3];
 237   keepalive_arg_elems[0].type = GRPC_ARG_INTEGER;
 238   keepalive_arg_elems[0].key = const_cast<char*>(GRPC_ARG_KEEPALIVE_TIME_MS);
 239   keepalive_arg_elems[0].value.integer = 20 * kPingIntervalMS;
 240   keepalive_arg_elems[1].type = GRPC_ARG_INTEGER;
 241   keepalive_arg_elems[1].key = const_cast<char*>(GRPC_ARG_KEEPALIVE_TIMEOUT_MS);
 242   keepalive_arg_elems[1].value.integer = 0;
 243   keepalive_arg_elems[2].type = GRPC_ARG_INTEGER;
 244   keepalive_arg_elems[2].key = const_cast<char*>(GRPC_ARG_HTTP2_BDP_PROBE);
 245   keepalive_arg_elems[2].value.integer = 0;
 246   grpc_channel_args keepalive_args = {GPR_ARRAY_SIZE(keepalive_arg_elems),
 247                                       keepalive_arg_elems};
 248   grpc_end2end_test_fixture f = begin_test(config, "test_read_delays_keepalive",
 249                                            &keepalive_args, nullptr);
 250   /* Disable ping ack to trigger the keepalive timeout */
 251   grpc_set_disable_ping_ack(true);
 252   grpc_call* c;
 253   grpc_call* s;
 254   cq_verifier* cqv = cq_verifier_create(f.cq);
 255   grpc_op ops[6];
 256   grpc_op* op;
 257   grpc_metadata_array initial_metadata_recv;
 258   grpc_metadata_array trailing_metadata_recv;
 259   grpc_metadata_array request_metadata_recv;
 260   grpc_call_details call_details;
 261   grpc_status_code status;
 262   grpc_call_error error;
 263   grpc_slice details;
 264   int was_cancelled = 2;
 265   grpc_byte_buffer* request_payload;
 266   grpc_byte_buffer* request_payload_recv;
 267   grpc_byte_buffer* response_payload;
 268   grpc_byte_buffer* response_payload_recv;
 269   int i;
 270   grpc_slice request_payload_slice =
 271       grpc_slice_from_copied_string("hello world");
 272   grpc_slice response_payload_slice =
 273       grpc_slice_from_copied_string("hello you");
 274
 275   gpr_timespec deadline = five_seconds_from_now();
 276   c = grpc_channel_create_call(f.client, nullptr, GRPC_PROPAGATE_DEFAULTS, f.cq,
 277                                grpc_slice_from_static_string("/foo"), nullptr,
 278                                deadline, nullptr);
 279   GPR_ASSERT(c);
 280
 281   grpc_metadata_array_init(&initial_metadata_recv);
 282   grpc_metadata_array_init(&trailing_metadata_recv);
 283   grpc_metadata_array_init(&request_metadata_recv);
 284   grpc_call_details_init(&call_details);
 285
 286   memset(ops, 0, sizeof(ops));
 287   op = ops;
 288   op->op = GRPC_OP_SEND_INITIAL_METADATA;
 289   op->data.send_initial_metadata.count = 0;
 290   op->flags = 0;
 291   op->reserved = nullptr;
 292   op++;
 293   op->op = GRPC_OP_RECV_INITIAL_METADATA;
 294   op->data.recv_initial_metadata.recv_initial_metadata = &initial_metadata_recv;
 295   op->flags = 0;
 296   op->reserved = nullptr;
 297   op++;
 298   op->op = GRPC_OP_RECV_STATUS_ON_CLIENT;
 299   op->data.recv_status_on_client.trailing_metadata = &trailing_metadata_recv;
 300   op->data.recv_status_on_client.status = &status;
 301   op->data.recv_status_on_client.status_details = &details;
 302   op->flags = 0;
 303   op->reserved = nullptr;
 304   op++;
 305   error = grpc_call_start_batch(c, ops, static_cast<size_t>(op - ops), tag(1),
 306                                 nullptr);
 307   GPR_ASSERT(GRPC_CALL_OK == error);
 308
 309   error =
 310       grpc_server_request_call(f.server, &s, &call_details,
 311                                &request_metadata_recv, f.cq, f.cq, tag(100));
 312   GPR_ASSERT(GRPC_CALL_OK == error);
 313   CQ_EXPECT_COMPLETION(cqv, tag(100), 1);
 314   cq_verify(cqv);
 315
 316   memset(ops, 0, sizeof(ops));
 317   op = ops;
 318   op->op = GRPC_OP_SEND_INITIAL_METADATA;
 319   op->data.send_initial_metadata.count = 0;
 320   op->flags = 0;
 321   op->reserved = nullptr;
 322   op++;
 323   op->op = GRPC_OP_RECV_CLOSE_ON_SERVER;
 324   op->data.recv_close_on_server.cancelled = &was_cancelled;
 325   op->flags = 0;
 326   op->reserved = nullptr;
 327   op++;
 328   error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops), tag(101),
 329                                 nullptr);
 330   GPR_ASSERT(GRPC_CALL_OK == error);
 331
 332   for (i = 0; i < 30; i++) {
 333     request_payload = grpc_raw_byte_buffer_create(&request_payload_slice, 1);
 334     response_payload = grpc_raw_byte_buffer_create(&response_payload_slice, 1);
 335
 336     memset(ops, 0, sizeof(ops));
 337     op = ops;
 338     op->op = GRPC_OP_SEND_MESSAGE;
 339     op->data.send_message.send_message = request_payload;
 340     op->flags = 0;
 341     op->reserved = nullptr;
 342     op++;
 343     op->op = GRPC_OP_RECV_MESSAGE;
 344     op->data.recv_message.recv_message = &response_payload_recv;
 345     op->flags = 0;
 346     op->reserved = nullptr;
 347     op++;
 348     error = grpc_call_start_batch(c, ops, static_cast<size_t>(op - ops), tag(2),
 349                                   nullptr);
 350     GPR_ASSERT(GRPC_CALL_OK == error);
 351
 352     memset(ops, 0, sizeof(ops));
 353     op = ops;
 354     op->op = GRPC_OP_RECV_MESSAGE;
 355     op->data.recv_message.recv_message = &request_payload_recv;
 356     op->flags = 0;
 357     op->reserved = nullptr;
 358     op++;
 359     error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops),
 360                                   tag(102), nullptr);
 361     GPR_ASSERT(GRPC_CALL_OK == error);
 362     CQ_EXPECT_COMPLETION(cqv, tag(102), 1);
 363     cq_verify(cqv);
 364
 365     memset(ops, 0, sizeof(ops));
 366     op = ops;
 367     op->op = GRPC_OP_SEND_MESSAGE;
 368     op->data.send_message.send_message = response_payload;
 369     op->flags = 0;
 370     op->reserved = nullptr;
 371     op++;
 372     error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops),
 373                                   tag(103), nullptr);
 374     GPR_ASSERT(GRPC_CALL_OK == error);
 375     CQ_EXPECT_COMPLETION(cqv, tag(103), 1);
 376     CQ_EXPECT_COMPLETION(cqv, tag(2), 1);
 377     cq_verify(cqv);
 378
 379     grpc_byte_buffer_destroy(request_payload);
 380     grpc_byte_buffer_destroy(response_payload);
 381     grpc_byte_buffer_destroy(request_payload_recv);
 382     grpc_byte_buffer_destroy(response_payload_recv);
 383     /* Sleep for a short interval to check if the client sends any pings */
 384     gpr_sleep_until(grpc_timeout_milliseconds_to_deadline(kPingIntervalMS));
 385   }
 386
 387   grpc_slice_unref(request_payload_slice);
 388   grpc_slice_unref(response_payload_slice);
 389
 390   memset(ops, 0, sizeof(ops));
 391   op = ops;
 392   op->op = GRPC_OP_SEND_CLOSE_FROM_CLIENT;
 393   op->flags = 0;
 394   op->reserved = nullptr;
 395   op++;
 396   error = grpc_call_start_batch(c, ops, static_cast<size_t>(op - ops), tag(3),
 397                                 nullptr);
 398   GPR_ASSERT(GRPC_CALL_OK == error);
 399
 400   memset(ops, 0, sizeof(ops));
 401   op = ops;
 402   op->op = GRPC_OP_SEND_STATUS_FROM_SERVER;
 403   op->data.send_status_from_server.trailing_metadata_count = 0;
 404   op->data.send_status_from_server.status = GRPC_STATUS_UNIMPLEMENTED;
 405   grpc_slice status_details = grpc_slice_from_static_string("xyz");
 406   op->data.send_status_from_server.status_details = &status_details;
 407   op->flags = 0;
 408   op->reserved = nullptr;
 409   op++;
 410   error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops), tag(104),
 411                                 nullptr);
 412   GPR_ASSERT(GRPC_CALL_OK == error);
 413
 414   CQ_EXPECT_COMPLETION(cqv, tag(1), 1);
 415   CQ_EXPECT_COMPLETION(cqv, tag(3), 1);
 416   CQ_EXPECT_COMPLETION(cqv, tag(101), 1);
 417   CQ_EXPECT_COMPLETION(cqv, tag(104), 1);
 418   cq_verify(cqv);
 419
 420   grpc_call_unref(c);
 421   grpc_call_unref(s);
 422
 423   cq_verifier_destroy(cqv);
 424
 425   grpc_metadata_array_destroy(&initial_metadata_recv);
 426   grpc_metadata_array_destroy(&trailing_metadata_recv);
 427   grpc_metadata_array_destroy(&request_metadata_recv);
 428   grpc_call_details_destroy(&call_details);
 429   grpc_slice_unref(details);
 430
 431   end_test(&f);
 432   config.tear_down_data(&f);
 433 }
 434
 435 void keepalive_timeout(grpc_end2end_test_config config) {
 436   test_keepalive_timeout(config);
 437   test_read_delays_keepalive(config);
 438 }
 439
 440 void keepalive_timeout_pre_init(void) {}