test/cpp/performance/writes_per_rpc_test.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 <grpc/support/log.h>
  20 #include <grpcpp/channel.h>
  21 #include <grpcpp/create_channel.h>
  22 #include <grpcpp/impl/grpc_library.h>
  23 #include <grpcpp/security/credentials.h>
  24 #include <grpcpp/security/server_credentials.h>
  25 #include <grpcpp/server.h>
  26 #include <grpcpp/server_builder.h>
  27 #include <gtest/gtest.h>
  28
  29 #include "src/core/ext/transport/chttp2/transport/chttp2_transport.h"
  30 #include "src/core/lib/channel/channel_args.h"
  31 #include "src/core/lib/iomgr/endpoint.h"
  32 #include "src/core/lib/iomgr/endpoint_pair.h"
  33 #include "src/core/lib/iomgr/exec_ctx.h"
  34 #include "src/core/lib/iomgr/tcp_posix.h"
  35 #include "src/core/lib/surface/channel.h"
  36 #include "src/core/lib/surface/completion_queue.h"
  37 #include "src/core/lib/surface/server.h"
  38 #include "test/core/util/passthru_endpoint.h"
  39 #include "test/core/util/port.h"
  40
  41 #include "src/cpp/client/create_channel_internal.h"
  42 #include "src/proto/grpc/testing/echo.grpc.pb.h"
  43 #include "test/core/util/test_config.h"
  44
  45 namespace grpc {
  46 namespace testing {
  47
  48 static void* tag(intptr_t x) { return reinterpret_cast<void*>(x); }
  49
  50 static void ApplyCommonServerBuilderConfig(ServerBuilder* b) {
  51   b->SetMaxReceiveMessageSize(INT_MAX);
  52   b->SetMaxSendMessageSize(INT_MAX);
  53 }
  54
  55 static void ApplyCommonChannelArguments(ChannelArguments* c) {
  56   c->SetInt(GRPC_ARG_MAX_RECEIVE_MESSAGE_LENGTH, INT_MAX);
  57   c->SetInt(GRPC_ARG_MAX_SEND_MESSAGE_LENGTH, INT_MAX);
  58 }
  59
  60 class EndpointPairFixture {
  61  public:
  62   EndpointPairFixture(Service* service, grpc_endpoint_pair endpoints) {
  63     ServerBuilder b;
  64     cq_ = b.AddCompletionQueue(true);
  65     b.RegisterService(service);
  66     ApplyCommonServerBuilderConfig(&b);
  67     server_ = b.BuildAndStart();
  68
  69     grpc_core::ExecCtx exec_ctx;
  70
  71     /* add server endpoint to server_ */
  72     {
  73       const grpc_channel_args* server_args =
  74           grpc_server_get_channel_args(server_->c_server());
  75       grpc_transport* transport = grpc_create_chttp2_transport(
  76           server_args, endpoints.server, false /* is_client */);
  77
  78       grpc_pollset** pollsets;
  79       size_t num_pollsets = 0;
  80       grpc_server_get_pollsets(server_->c_server(), &pollsets, &num_pollsets);
  81
  82       for (size_t i = 0; i < num_pollsets; i++) {
  83         grpc_endpoint_add_to_pollset(endpoints.server, pollsets[i]);
  84       }
  85
  86       grpc_server_setup_transport(server_->c_server(), transport, nullptr,
  87                                   server_args, nullptr);
  88       grpc_chttp2_transport_start_reading(transport, nullptr, nullptr);
  89     }
  90
  91     /* create channel */
  92     {
  93       ChannelArguments args;
  94       args.SetString(GRPC_ARG_DEFAULT_AUTHORITY, "test.authority");
  95       ApplyCommonChannelArguments(&args);
  96
  97       grpc_channel_args c_args = args.c_channel_args();
  98       grpc_transport* transport =
  99           grpc_create_chttp2_transport(&c_args, endpoints.client, true);
 100       GPR_ASSERT(transport);
 101       grpc_channel* channel = grpc_channel_create(
 102           "target", &c_args, GRPC_CLIENT_DIRECT_CHANNEL, transport);
 103       grpc_chttp2_transport_start_reading(transport, nullptr, nullptr);
 104
 105       channel_ = ::grpc::CreateChannelInternal(
 106           "", channel,
 107           std::vector<std::unique_ptr<
 108               experimental::ClientInterceptorFactoryInterface>>());
 109     }
 110   }
 111
 112   virtual ~EndpointPairFixture() {
 113     server_->Shutdown();
 114     cq_->Shutdown();
 115     void* tag;
 116     bool ok;
 117     while (cq_->Next(&tag, &ok)) {
 118     }
 119   }
 120
 121   ServerCompletionQueue* cq() { return cq_.get(); }
 122   std::shared_ptr<Channel> channel() { return channel_; }
 123
 124  private:
 125   std::unique_ptr<Server> server_;
 126   std::unique_ptr<ServerCompletionQueue> cq_;
 127   std::shared_ptr<Channel> channel_;
 128 };
 129
 130 class InProcessCHTTP2 : public EndpointPairFixture {
 131  public:
 132   InProcessCHTTP2(Service* service, grpc_passthru_endpoint_stats* stats)
 133       : EndpointPairFixture(service, MakeEndpoints(stats)), stats_(stats) {}
 134
 135   virtual ~InProcessCHTTP2() {
 136     if (stats_ != nullptr) {
 137       grpc_passthru_endpoint_stats_destroy(stats_);
 138     }
 139   }
 140
 141   int writes_performed() const { return stats_->num_writes; }
 142
 143  private:
 144   grpc_passthru_endpoint_stats* stats_;
 145
 146   static grpc_endpoint_pair MakeEndpoints(grpc_passthru_endpoint_stats* stats) {
 147     static grpc_resource_quota* rq = grpc_resource_quota_create("bm");
 148     grpc_endpoint_pair p;
 149     grpc_passthru_endpoint_create(&p.client, &p.server, rq, stats);
 150     return p;
 151   }
 152 };
 153
 154 static double UnaryPingPong(int request_size, int response_size) {
 155   const int kIterations = 10000;
 156
 157   EchoTestService::AsyncService service;
 158   std::unique_ptr<InProcessCHTTP2> fixture(
 159       new InProcessCHTTP2(&service, grpc_passthru_endpoint_stats_create()));
 160   EchoRequest send_request;
 161   EchoResponse send_response;
 162   EchoResponse recv_response;
 163   if (request_size > 0) {
 164     send_request.set_message(std::string(request_size, 'a'));
 165   }
 166   if (response_size > 0) {
 167     send_response.set_message(std::string(response_size, 'a'));
 168   }
 169   Status recv_status;
 170   struct ServerEnv {
 171     ServerContext ctx;
 172     EchoRequest recv_request;
 173     grpc::ServerAsyncResponseWriter<EchoResponse> response_writer;
 174     ServerEnv() : response_writer(&ctx) {}
 175   };
 176   uint8_t server_env_buffer[2 * sizeof(ServerEnv)];
 177   ServerEnv* server_env[2] = {
 178       reinterpret_cast<ServerEnv*>(server_env_buffer),
 179       reinterpret_cast<ServerEnv*>(server_env_buffer + sizeof(ServerEnv))};
 180   new (server_env[0]) ServerEnv;
 181   new (server_env[1]) ServerEnv;
 182   service.RequestEcho(&server_env[0]->ctx, &server_env[0]->recv_request,
 183                       &server_env[0]->response_writer, fixture->cq(),
 184                       fixture->cq(), tag(0));
 185   service.RequestEcho(&server_env[1]->ctx, &server_env[1]->recv_request,
 186                       &server_env[1]->response_writer, fixture->cq(),
 187                       fixture->cq(), tag(1));
 188   std::unique_ptr<EchoTestService::Stub> stub(
 189       EchoTestService::NewStub(fixture->channel()));
 190   for (int iteration = 0; iteration < kIterations; iteration++) {
 191     recv_response.Clear();
 192     ClientContext cli_ctx;
 193     std::unique_ptr<ClientAsyncResponseReader<EchoResponse>> response_reader(
 194         stub->AsyncEcho(&cli_ctx, send_request, fixture->cq()));
 195     void* t;
 196     bool ok;
 197     response_reader->Finish(&recv_response, &recv_status, tag(4));
 198     GPR_ASSERT(fixture->cq()->Next(&t, &ok));
 199     GPR_ASSERT(ok);
 200     GPR_ASSERT(t == tag(0) || t == tag(1));
 201     intptr_t slot = reinterpret_cast<intptr_t>(t);
 202     ServerEnv* senv = server_env[slot];
 203     senv->response_writer.Finish(send_response, Status::OK, tag(3));
 204     for (int i = (1 << 3) | (1 << 4); i != 0;) {
 205       GPR_ASSERT(fixture->cq()->Next(&t, &ok));
 206       GPR_ASSERT(ok);
 207       int tagnum = static_cast<int>(reinterpret_cast<intptr_t>(t));
 208       GPR_ASSERT(i & (1 << tagnum));
 209       i -= 1 << tagnum;
 210     }
 211     GPR_ASSERT(recv_status.ok());
 212
 213     senv->~ServerEnv();
 214     senv = new (senv) ServerEnv();
 215     service.RequestEcho(&senv->ctx, &senv->recv_request, &senv->response_writer,
 216                         fixture->cq(), fixture->cq(), tag(slot));
 217   }
 218
 219   double writes_per_iteration =
 220       static_cast<double>(fixture->writes_performed()) /
 221       static_cast<double>(kIterations);
 222
 223   fixture.reset();
 224   server_env[0]->~ServerEnv();
 225   server_env[1]->~ServerEnv();
 226
 227   return writes_per_iteration;
 228 }
 229
 230 TEST(WritesPerRpcTest, UnaryPingPong) {
 231   EXPECT_LT(UnaryPingPong(0, 0), 2.05);
 232   EXPECT_LT(UnaryPingPong(1, 0), 2.05);
 233   EXPECT_LT(UnaryPingPong(0, 1), 2.05);
 234   EXPECT_LT(UnaryPingPong(4096, 0), 2.5);
 235   EXPECT_LT(UnaryPingPong(0, 4096), 2.5);
 236 }
 237
 238 }  // namespace testing
 239 }  // namespace grpc
 240
 241 int main(int argc, char** argv) {
 242   ::testing::InitGoogleTest(&argc, argv);
 243   grpc::testing::TestEnvironment env(argc, argv);
 244   grpc_init();
 245   int ret = RUN_ALL_TESTS();
 246   grpc_shutdown();
 247   return ret;
 248 }