test/core/end2end/tests/high_initial_seqno.cc

   1 /*
   2  *
   3  * Copyright 2015 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 <string>
  25
  26 #include "absl/strings/str_cat.h"
  27
  28 #include <grpc/byte_buffer.h>
  29 #include <grpc/grpc.h>
  30 #include <grpc/support/alloc.h>
  31 #include <grpc/support/log.h>
  32 #include <grpc/support/time.h>
  33
  34 #include "src/core/lib/gpr/string.h"
  35 #include "test/core/end2end/cq_verifier.h"
  36
  37 static void* tag(intptr_t t) { return reinterpret_cast<void*>(t); }
  38
  39 static grpc_end2end_test_fixture begin_test(grpc_end2end_test_config config,
  40                                             const char* test_name,
  41                                             grpc_channel_args* client_args,
  42                                             grpc_channel_args* server_args) {
  43   grpc_end2end_test_fixture f;
  44   gpr_log(GPR_INFO, "Running test: %s/%s", test_name, config.name);
  45   f = config.create_fixture(client_args, server_args);
  46   config.init_server(&f, server_args);
  47   config.init_client(&f, client_args);
  48   return f;
  49 }
  50
  51 static gpr_timespec n_seconds_from_now(int n) {
  52   return grpc_timeout_seconds_to_deadline(n);
  53 }
  54
  55 static gpr_timespec five_seconds_from_now(void) {
  56   return n_seconds_from_now(5);
  57 }
  58
  59 static void drain_cq(grpc_completion_queue* cq) {
  60   grpc_event ev;
  61   do {
  62     ev = grpc_completion_queue_next(cq, five_seconds_from_now(), nullptr);
  63   } while (ev.type != GRPC_QUEUE_SHUTDOWN);
  64 }
  65
  66 static void shutdown_server(grpc_end2end_test_fixture* f) {
  67   if (!f->server) return;
  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                                          grpc_timeout_seconds_to_deadline(5),
  71                                          nullptr)
  72                  .type == GRPC_OP_COMPLETE);
  73   grpc_server_destroy(f->server);
  74   f->server = nullptr;
  75 }
  76
  77 static void shutdown_client(grpc_end2end_test_fixture* f) {
  78   if (!f->client) return;
  79   grpc_channel_destroy(f->client);
  80   f->client = nullptr;
  81 }
  82
  83 static void end_test(grpc_end2end_test_fixture* f) {
  84   shutdown_server(f);
  85   shutdown_client(f);
  86
  87   grpc_completion_queue_shutdown(f->cq);
  88   drain_cq(f->cq);
  89   grpc_completion_queue_destroy(f->cq);
  90   grpc_completion_queue_destroy(f->shutdown_cq);
  91 }
  92
  93 static void simple_request_body(grpc_end2end_test_config /*config*/,
  94                                 grpc_end2end_test_fixture f) {
  95   grpc_call* c;
  96   grpc_call* s;
  97   cq_verifier* cqv = cq_verifier_create(f.cq);
  98   grpc_op ops[6];
  99   grpc_op* op;
 100   grpc_metadata_array initial_metadata_recv;
 101   grpc_metadata_array trailing_metadata_recv;
 102   grpc_metadata_array request_metadata_recv;
 103   grpc_call_details call_details;
 104   grpc_status_code status;
 105   grpc_call_error error;
 106   grpc_slice details;
 107   int was_cancelled = 2;
 108
 109   gpr_timespec deadline = five_seconds_from_now();
 110   c = grpc_channel_create_call(f.client, nullptr, GRPC_PROPAGATE_DEFAULTS, f.cq,
 111                                grpc_slice_from_static_string("/foo"), nullptr,
 112                                deadline, nullptr);
 113   GPR_ASSERT(c);
 114
 115   grpc_metadata_array_init(&initial_metadata_recv);
 116   grpc_metadata_array_init(&trailing_metadata_recv);
 117   grpc_metadata_array_init(&request_metadata_recv);
 118   grpc_call_details_init(&call_details);
 119
 120   memset(ops, 0, sizeof(ops));
 121   op = ops;
 122   op->op = GRPC_OP_SEND_INITIAL_METADATA;
 123   op->data.send_initial_metadata.count = 0;
 124   op->flags = 0;
 125   op->reserved = nullptr;
 126   op++;
 127   op->op = GRPC_OP_SEND_CLOSE_FROM_CLIENT;
 128   op->flags = 0;
 129   op->reserved = nullptr;
 130   op++;
 131   op->op = GRPC_OP_RECV_INITIAL_METADATA;
 132   op->data.recv_initial_metadata.recv_initial_metadata = &initial_metadata_recv;
 133   op->flags = 0;
 134   op->reserved = nullptr;
 135   op++;
 136   op->op = GRPC_OP_RECV_STATUS_ON_CLIENT;
 137   op->data.recv_status_on_client.trailing_metadata = &trailing_metadata_recv;
 138   op->data.recv_status_on_client.status = &status;
 139   op->data.recv_status_on_client.status_details = &details;
 140   op->flags = 0;
 141   op->reserved = nullptr;
 142   op++;
 143   error = grpc_call_start_batch(c, ops, static_cast<size_t>(op - ops), tag(1),
 144                                 nullptr);
 145   GPR_ASSERT(GRPC_CALL_OK == error);
 146
 147   error =
 148       grpc_server_request_call(f.server, &s, &call_details,
 149                                &request_metadata_recv, f.cq, f.cq, tag(101));
 150   GPR_ASSERT(GRPC_CALL_OK == error);
 151   CQ_EXPECT_COMPLETION(cqv, tag(101), 1);
 152   cq_verify(cqv);
 153
 154   memset(ops, 0, sizeof(ops));
 155   op = ops;
 156   op->op = GRPC_OP_SEND_INITIAL_METADATA;
 157   op->data.send_initial_metadata.count = 0;
 158   op->flags = 0;
 159   op->reserved = nullptr;
 160   op++;
 161   op->op = GRPC_OP_SEND_STATUS_FROM_SERVER;
 162   op->data.send_status_from_server.trailing_metadata_count = 0;
 163   op->data.send_status_from_server.status = GRPC_STATUS_UNIMPLEMENTED;
 164   grpc_slice status_details = grpc_slice_from_static_string("xyz");
 165   op->data.send_status_from_server.status_details = &status_details;
 166   op->flags = 0;
 167   op->reserved = nullptr;
 168   op++;
 169   op->op = GRPC_OP_RECV_CLOSE_ON_SERVER;
 170   op->data.recv_close_on_server.cancelled = &was_cancelled;
 171   op->flags = 0;
 172   op->reserved = nullptr;
 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   GPR_ASSERT(status == GRPC_STATUS_UNIMPLEMENTED);
 183   GPR_ASSERT(0 == grpc_slice_str_cmp(details, "xyz"));
 184   GPR_ASSERT(0 == grpc_slice_str_cmp(call_details.method, "/foo"));
 185   GPR_ASSERT(was_cancelled == 0);
 186
 187   grpc_slice_unref(details);
 188   grpc_metadata_array_destroy(&initial_metadata_recv);
 189   grpc_metadata_array_destroy(&trailing_metadata_recv);
 190   grpc_metadata_array_destroy(&request_metadata_recv);
 191   grpc_call_details_destroy(&call_details);
 192
 193   grpc_call_unref(c);
 194   grpc_call_unref(s);
 195
 196   /* TODO(ctiller): this rate limits the test, and it should be removed when
 197                     retry has been implemented; until then cross-thread chatter
 198                     may result in some requests needing to be cancelled due to
 199                     seqno exhaustion. */
 200   cq_verify_empty(cqv);
 201
 202   cq_verifier_destroy(cqv);
 203 }
 204
 205 static void test_invoke_10_simple_requests(grpc_end2end_test_config config,
 206                                            int initial_sequence_number) {
 207   int i;
 208   grpc_end2end_test_fixture f;
 209   grpc_arg client_arg;
 210   grpc_channel_args client_args;
 211
 212   client_arg.type = GRPC_ARG_INTEGER;
 213   client_arg.key = const_cast<char*>(GRPC_ARG_HTTP2_INITIAL_SEQUENCE_NUMBER);
 214   client_arg.value.integer = initial_sequence_number;
 215
 216   client_args.num_args = 1;
 217   client_args.args = &client_arg;
 218
 219   std::string name = absl::StrCat("test_invoke_requests first_seqno=",
 220                                   initial_sequence_number);
 221   f = begin_test(config, name.c_str(), &client_args, nullptr);
 222   for (i = 0; i < 10; i++) {
 223     simple_request_body(config, f);
 224     gpr_log(GPR_INFO, "Running test: Passed simple request %d", i);
 225   }
 226   end_test(&f);
 227   config.tear_down_data(&f);
 228 }
 229
 230 void high_initial_seqno(grpc_end2end_test_config config) {
 231   test_invoke_10_simple_requests(config, 16777213);
 232   if (config.feature_mask & FEATURE_MASK_SUPPORTS_DELAYED_CONNECTION) {
 233     test_invoke_10_simple_requests(config, 2147483645);
 234   }
 235 }
 236
 237 void high_initial_seqno_pre_init(void) {}