Add named pipes to benchmark apps

JamesNK · JamesNK · commit 517fce6baeec · 2023-01-17T12:06:35.000+08:00
diff --git a/perf/benchmarkapps/GrpcAspNetCoreServer/Program.cs b/perf/benchmarkapps/GrpcAspNetCoreServer/Program.cs
@@ -67,18 +67,9 @@ public static IHostBuilder CreateHostBuilder(string[] args)
                 {
                     var endPoint = config.CreateIPEndPoint();
                     var udsFileName = config["udsFileName"];
+                    var namedPipeName = config["namedPipeName"];
 
-                    if (string.IsNullOrEmpty(udsFileName))
-                    {
-                        // ListenAnyIP will work with IPv4 and IPv6.
-                        // Chosen over Listen+IPAddress.Loopback, which would have a 2 second delay when
-                        // creating a connection on a local Windows machine.
-                        options.ListenAnyIP(endPoint.Port, listenOptions =>
-                        {
-                            ConfigureListenOptions(listenOptions, config, endPoint);
-                        });
-                    }
-                    else
+                    if (!string.IsNullOrEmpty(udsFileName))
                     {
                         var socketPath = ResolveUdsPath(udsFileName);
                         if (File.Exists(socketPath))
@@ -93,6 +84,24 @@ public static IHostBuilder CreateHostBuilder(string[] args)
                             ConfigureListenOptions(listenOptions, config, endPoint);
                         });
                     }
+                    else if (!string.IsNullOrEmpty(namedPipeName))
+                    {
+                        Console.WriteLine($"Named pipe name: {namedPipeName}");
+                        options.ListenNamedPipe(namedPipeName, listenOptions =>
+                        {
+                            ConfigureListenOptions(listenOptions, config, endPoint);
+                        });
+                    }
+                    else
+                    {
+                        // ListenAnyIP will work with IPv4 and IPv6.
+                        // Chosen over Listen+IPAddress.Loopback, which would have a 2 second delay when
+                        // creating a connection on a local Windows machine.
+                        options.ListenAnyIP(endPoint.Port, listenOptions =>
+                        {
+                            ConfigureListenOptions(listenOptions, config, endPoint);
+                        });
+                    }
 
                     // Other gRPC servers don't include a server header
                     options.AddServerHeader = false;
diff --git a/perf/benchmarkapps/GrpcClient/ClientOptions.cs b/perf/benchmarkapps/GrpcClient/ClientOptions.cs
@@ -25,6 +25,7 @@ public class ClientOptions
     public Uri? Url { get; set; }
 #if NET5_0_OR_GREATER
     public string? UdsFileName { get; set; }
+    public string? NamedPipeName { get; set; }
 #endif
     public int Connections { get; set; }
     public int Warmup { get; set; }
diff --git a/perf/benchmarkapps/GrpcClient/NamedPipeConnectionFactory.cs b/perf/benchmarkapps/GrpcClient/NamedPipeConnectionFactory.cs
@@ -0,0 +1,60 @@
+﻿#region Copyright notice and license
+
+// Copyright 2019 The gRPC Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#endregion
+
+using System.IO.Pipes;
+using System.Security.Principal;
+
+#if NET5_0_OR_GREATER
+
+namespace GrpcClient;
+
+public class NamedPipeConnectionFactory
+{
+    private readonly string _pipeName;
+    private readonly TokenImpersonationLevel? _impersonationLevel;
+
+    public NamedPipeConnectionFactory(string pipeName, TokenImpersonationLevel? impersonationLevel = null)
+    {
+        _pipeName = pipeName;
+        _impersonationLevel = impersonationLevel;
+    }
+
+    public async ValueTask<Stream> ConnectAsync(SocketsHttpConnectionContext _,
+        CancellationToken cancellationToken = default)
+    {
+        var clientStream = new NamedPipeClientStream(
+            serverName: ".",
+            pipeName: _pipeName,
+            direction: PipeDirection.InOut,
+            options: PipeOptions.WriteThrough | PipeOptions.Asynchronous,
+            impersonationLevel: _impersonationLevel ?? TokenImpersonationLevel.Anonymous);
+
+        try
+        {
+            await clientStream.ConnectAsync(cancellationToken).ConfigureAwait(false);
+            return clientStream;
+        }
+        catch
+        {
+            clientStream.Dispose();
+            throw;
+        }
+    }
+}
+
+#endif
diff --git a/perf/benchmarkapps/GrpcClient/Program.cs b/perf/benchmarkapps/GrpcClient/Program.cs
@@ -63,6 +63,7 @@ public static async Task<int> Main(string[] args)
     {
         var urlOption = new Option<Uri>(new string[] { "-u", "--url" }, "The server url to request") { IsRequired = true };
         var udsFileNameOption = new Option<string>(new string[] { "--udsFileName" }, "The Unix Domain Socket file name");
+        var namedPipeNameOption = new Option<string>(new string[] { "--namedPipeName" }, "The Named Pipe name");
         var connectionsOption = new Option<int>(new string[] { "-c", "--connections" }, () => 1, "Total number of connections to keep open");
         var warmupOption = new Option<int>(new string[] { "-w", "--warmup" }, () => 5, "Duration of the warmup in seconds");
         var durationOption = new Option<int>(new string[] { "-d", "--duration" }, () => 10, "Duration of the test in seconds");
@@ -81,6 +82,7 @@ public static async Task<int> Main(string[] args)
         var rootCommand = new RootCommand();
         rootCommand.AddOption(urlOption);
         rootCommand.AddOption(udsFileNameOption);
+        rootCommand.AddOption(namedPipeNameOption);
         rootCommand.AddOption(connectionsOption);
         rootCommand.AddOption(warmupOption);
         rootCommand.AddOption(durationOption);
@@ -101,6 +103,7 @@ public static async Task<int> Main(string[] args)
             _options = new ClientOptions();
             _options.Url = context.ParseResult.GetValueForOption(urlOption);
             _options.UdsFileName = context.ParseResult.GetValueForOption(udsFileNameOption);
+            _options.NamedPipeName = context.ParseResult.GetValueForOption(namedPipeNameOption);
             _options.Connections = context.ParseResult.GetValueForOption(connectionsOption);
             _options.Warmup = context.ParseResult.GetValueForOption(warmupOption);
             _options.Duration = context.ParseResult.GetValueForOption(durationOption);
@@ -485,6 +488,11 @@ private static ChannelBase CreateChannel(string target)
                     var connectionFactory = new UnixDomainSocketConnectionFactory(new UnixDomainSocketEndPoint(ResolveUdsPath(_options.UdsFileName)));
                     httpClientHandler.ConnectCallback = connectionFactory.ConnectAsync;
                 }
+                else if (!string.IsNullOrEmpty(_options.NamedPipeName))
+                {
+                    var connectionFactory = new NamedPipeConnectionFactory(_options.NamedPipeName);
+                    httpClientHandler.ConnectCallback = connectionFactory.ConnectAsync;
+                }
 #endif
 
                 httpClientHandler.SslOptions.RemoteCertificateValidationCallback =
diff --git a/perf/benchmarkapps/README.md b/perf/benchmarkapps/README.md
@@ -8,13 +8,20 @@ View the latest results [here](https://msit.powerbi.com/view?r=eyJrIjoiYTZjMTk3Y
 
 The benchmark environment runs the tests using `qps_json_driver`. The driver is a C++ app in https://github.com/grpc/grpc repo that is only buildable on Unix based operating systems.
 
-Because the driver is challenging to get setup, the benchmarks can be run locally from the command line for quick testing. Note that there can be some differences in behavior. 
+Because the driver is challenging to get setup, the benchmarks can be run locally from the command line for quick testing. Note that there can be some differences in behavior.
 
-Example of running client using Grpc.Net.Client against Grpc.AspNetCore server:
+Examples of running client using Grpc.Net.Client against Grpc.AspNetCore server
+
+### TCP sockets
 
 1. **Launch server:** dotnet run -c Release --project .\perf\benchmarkapps\GrpcAspNetCoreServer\ --protocol h2c
 2. **Launch client:** dotnet run -c Release --project .\perf\benchmarkapps\GrpcClient\ -- -u http://localhost:5000 -c 10 --streams 50 -s unary -p h2c --grpcClientType grpcnetclient
 
+### Named pipes
+
+1. **Launch server:** dotnet run -c Release --project .\perf\benchmarkapps\GrpcAspNetCoreServer\ --protocol h2c --namedPipeName PerfPipe
+2. **Launch client:** dotnet run -c Release --project .\perf\benchmarkapps\GrpcClient\ -- -u http://localhost:5000 -c 10 --streams 50 -s unary -p h2c --grpcClientType grpcnetclient --namedPipeName PerfPipe
+
 ## QpsWorker
 
 The `QpsWorker` runs in the [gRPC benchmark environment](https://grpc.io/docs/guides/benchmarking/). The worker hosts gRPC services which are used to start a benchmark server or client.
