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