diff --git a/Benchmarking/Benchmark/Benchmark.csproj b/Benchmarking/Benchmark/Benchmark.csproj new file mode 100644 index 0000000..805886e --- /dev/null +++ b/Benchmarking/Benchmark/Benchmark.csproj @@ -0,0 +1,24 @@ + + + + Exe + netcoreapp3.1 + + + + + + + + + + all + runtime; build; native; contentfiles; analyzers; buildtransitive + + + + + + + + diff --git a/Benchmarking/Benchmark/CapnpBenchmark.cs b/Benchmarking/Benchmark/CapnpBenchmark.cs new file mode 100644 index 0000000..63f3f1d --- /dev/null +++ b/Benchmarking/Benchmark/CapnpBenchmark.cs @@ -0,0 +1,46 @@ +using BenchmarkDotNet.Attributes; +using BenchmarkDotNet.Jobs; +using Capnp.Rpc; +using CapnpGen; +using System; +using System.Collections.Generic; +using System.Text; + +namespace Benchmark +{ + public class CapnpBenchmark + { + [Params(20, 200, 2000, 20000, 200000, 2000000)] + public int PayloadBytes; + + TcpRpcClient _client; + IEchoer _echoer; + byte[] _payload; + + [GlobalSetup] + public void Setup() + { + _client = new TcpRpcClient("localhost", 5002); + _client.WhenConnected.Wait(); + _echoer = _client.GetMain(); + _payload = new byte[PayloadBytes]; + new Random().NextBytes(_payload); + } + + [GlobalCleanup] + public void Cleanup() + { + _echoer.Dispose(); + _client.Dispose(); + } + + [Benchmark] + public void Echo() + { + var t = _echoer.Echo(_payload); + t.Wait(); + if (t.Result?.Count != _payload.Length) + throw new InvalidOperationException("Echo server malfunction"); + } + } +} diff --git a/Benchmarking/Benchmark/GrpcBenchmark.cs b/Benchmarking/Benchmark/GrpcBenchmark.cs new file mode 100644 index 0000000..573d7c2 --- /dev/null +++ b/Benchmarking/Benchmark/GrpcBenchmark.cs @@ -0,0 +1,42 @@ +using BenchmarkDotNet.Attributes; +using BenchmarkDotNet.Jobs; +using Grpc.Net.Client; +using System; +using System.Collections.Generic; +using System.Text; + +namespace Benchmark +{ + public class GrpcBenchmark + { + [Params(20, 200, 2000, 20000, 200000, 2000000)] + public int PayloadBytes; + + GrpcChannel _channel; + Echoer.EchoerClient _echoer; + byte[] _payload; + + [GlobalSetup] + public void Setup() + { + _channel = GrpcChannel.ForAddress("https://localhost:5001"); + _echoer = new Echoer.EchoerClient(_channel); + _payload = new byte[PayloadBytes]; + new Random().NextBytes(_payload); + } + + [GlobalCleanup] + public void Teardown() + { + _channel.Dispose(); + } + + [Benchmark] + public void Echo() + { + var reply = _echoer.Echo(new EchoRequest { Payload = Google.Protobuf.ByteString.CopyFrom(_payload) }); + if (reply?.Payload?.Length != _payload.Length) + throw new InvalidOperationException("Echo server malfunction"); + } + } +} diff --git a/Benchmarking/Benchmark/Program.cs b/Benchmarking/Benchmark/Program.cs new file mode 100644 index 0000000..16a0924 --- /dev/null +++ b/Benchmarking/Benchmark/Program.cs @@ -0,0 +1,18 @@ +using BenchmarkDotNet.Running; +using Capnp.Rpc; +using Grpc.Net.Client; +using System; +using System.Diagnostics; +using System.Threading.Tasks; + +namespace Benchmark +{ + class Program + { + static void Main(string[] args) + { + BenchmarkRunner.Run(); + BenchmarkRunner.Run(); + } + } +} diff --git a/Benchmarking/Benchmark/Protos/Echo.capnp b/Benchmarking/Benchmark/Protos/Echo.capnp new file mode 100644 index 0000000..2af55d5 --- /dev/null +++ b/Benchmarking/Benchmark/Protos/Echo.capnp @@ -0,0 +1,5 @@ +@0x8c309c720de8cf7c; + +interface Echoer { + echo @0 (input : Data) -> (output : Data); +} diff --git a/Benchmarking/Benchmark/Protos/Echo.proto b/Benchmarking/Benchmark/Protos/Echo.proto new file mode 100644 index 0000000..ddbbaea --- /dev/null +++ b/Benchmarking/Benchmark/Protos/Echo.proto @@ -0,0 +1,13 @@ +syntax = "proto3"; + +service Echoer { + rpc Echo (EchoRequest) returns (EchoReply); +} + +message EchoRequest { + bytes payload = 1; +} + +message EchoReply { + bytes payload = 1; +} \ No newline at end of file diff --git a/Benchmarking/CapnpBench.sln b/Benchmarking/CapnpBench.sln new file mode 100644 index 0000000..061559d --- /dev/null +++ b/Benchmarking/CapnpBench.sln @@ -0,0 +1,37 @@ + +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio Version 16 +VisualStudioVersion = 16.0.29728.190 +MinimumVisualStudioVersion = 10.0.40219.1 +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "EchoServiceGrpc", "EchoServiceGrpc\EchoServiceGrpc.csproj", "{D59C7B71-3887-426B-A636-2DBDA0549817}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Benchmark", "Benchmark\Benchmark.csproj", "{7F7580CA-CCF0-4650-87BF-502D51A8F435}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "EchoServiceCapnp", "EchoServiceCapnp\EchoServiceCapnp.csproj", "{309A4A26-F29E-4F49-AB49-76BAE0FD7D62}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {D59C7B71-3887-426B-A636-2DBDA0549817}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {D59C7B71-3887-426B-A636-2DBDA0549817}.Debug|Any CPU.Build.0 = Debug|Any CPU + {D59C7B71-3887-426B-A636-2DBDA0549817}.Release|Any CPU.ActiveCfg = Release|Any CPU + {D59C7B71-3887-426B-A636-2DBDA0549817}.Release|Any CPU.Build.0 = Release|Any CPU + {7F7580CA-CCF0-4650-87BF-502D51A8F435}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {7F7580CA-CCF0-4650-87BF-502D51A8F435}.Debug|Any CPU.Build.0 = Debug|Any CPU + {7F7580CA-CCF0-4650-87BF-502D51A8F435}.Release|Any CPU.ActiveCfg = Release|Any CPU + {7F7580CA-CCF0-4650-87BF-502D51A8F435}.Release|Any CPU.Build.0 = Release|Any CPU + {309A4A26-F29E-4F49-AB49-76BAE0FD7D62}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {309A4A26-F29E-4F49-AB49-76BAE0FD7D62}.Debug|Any CPU.Build.0 = Debug|Any CPU + {309A4A26-F29E-4F49-AB49-76BAE0FD7D62}.Release|Any CPU.ActiveCfg = Release|Any CPU + {309A4A26-F29E-4F49-AB49-76BAE0FD7D62}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection + GlobalSection(ExtensibilityGlobals) = postSolution + SolutionGuid = {A6702BC8-8CC0-4BDA-8BD5-D5D268291E93} + EndGlobalSection +EndGlobal diff --git a/Benchmarking/EchoServiceCapnp/EchoServiceCapnp.csproj b/Benchmarking/EchoServiceCapnp/EchoServiceCapnp.csproj new file mode 100644 index 0000000..f50d2fa --- /dev/null +++ b/Benchmarking/EchoServiceCapnp/EchoServiceCapnp.csproj @@ -0,0 +1,13 @@ + + + + Exe + netcoreapp3.1 + + + + + + + + diff --git a/Benchmarking/EchoServiceCapnp/Program.cs b/Benchmarking/EchoServiceCapnp/Program.cs new file mode 100644 index 0000000..fb58c04 --- /dev/null +++ b/Benchmarking/EchoServiceCapnp/Program.cs @@ -0,0 +1,20 @@ +using Capnp.Rpc; +using EchoServiceCapnp.Services; +using System; +using System.Net; + +namespace EchoServiceCapnp +{ + class Program + { + static void Main(string[] args) + { + using (var server = new TcpRpcServer(IPAddress.Any, 5002)) + { + server.Main = new CapnpEchoService(); + Console.WriteLine("Press RETURN to stop listening"); + Console.ReadLine(); + } + } + } +} diff --git a/Benchmarking/EchoServiceCapnp/Protos/Echo.capnp b/Benchmarking/EchoServiceCapnp/Protos/Echo.capnp new file mode 100644 index 0000000..2af55d5 --- /dev/null +++ b/Benchmarking/EchoServiceCapnp/Protos/Echo.capnp @@ -0,0 +1,5 @@ +@0x8c309c720de8cf7c; + +interface Echoer { + echo @0 (input : Data) -> (output : Data); +} diff --git a/Benchmarking/EchoServiceCapnp/Services/CapnpEchoService.cs b/Benchmarking/EchoServiceCapnp/Services/CapnpEchoService.cs new file mode 100644 index 0000000..60e7afb --- /dev/null +++ b/Benchmarking/EchoServiceCapnp/Services/CapnpEchoService.cs @@ -0,0 +1,20 @@ +using System; +using System.Collections.Generic; +using System.Text; +using System.Threading; +using System.Threading.Tasks; + +namespace EchoServiceCapnp.Services +{ + public class CapnpEchoService : CapnpGen.IEchoer + { + public void Dispose() + { + } + + public Task> Echo(IReadOnlyList input, CancellationToken cancellationToken_ = default) + { + return Task.FromResult(input); + } + } +} diff --git a/Benchmarking/EchoServiceGrpc/EchoServiceGrpc.csproj b/Benchmarking/EchoServiceGrpc/EchoServiceGrpc.csproj new file mode 100644 index 0000000..861d83c --- /dev/null +++ b/Benchmarking/EchoServiceGrpc/EchoServiceGrpc.csproj @@ -0,0 +1,15 @@ + + + + netcoreapp3.1 + + + + + + + + + + + diff --git a/Benchmarking/EchoServiceGrpc/Program.cs b/Benchmarking/EchoServiceGrpc/Program.cs new file mode 100644 index 0000000..f24aee5 --- /dev/null +++ b/Benchmarking/EchoServiceGrpc/Program.cs @@ -0,0 +1,27 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Linq; +using System.Threading.Tasks; +using Microsoft.AspNetCore.Hosting; +using Microsoft.Extensions.Hosting; + +namespace EchoService +{ + public class Program + { + public static void Main(string[] args) + { + CreateHostBuilder(args).Build().Run(); + } + + // Additional configuration is required to successfully run gRPC on macOS. + // For instructions on how to configure Kestrel and gRPC clients on macOS, visit https://go.microsoft.com/fwlink/?linkid=2099682 + public static IHostBuilder CreateHostBuilder(string[] args) => + Host.CreateDefaultBuilder(args) + .ConfigureWebHostDefaults(webBuilder => + { + webBuilder.UseStartup(); + }); + } +} diff --git a/Benchmarking/EchoServiceGrpc/Protos/Echo.proto b/Benchmarking/EchoServiceGrpc/Protos/Echo.proto new file mode 100644 index 0000000..b1b0c0d --- /dev/null +++ b/Benchmarking/EchoServiceGrpc/Protos/Echo.proto @@ -0,0 +1,13 @@ +syntax = "proto3"; + +service Echoer { + rpc Echo (EchoRequest) returns (EchoReply); +} + +message EchoRequest { + bytes payload = 1; +} + +message EchoReply { + bytes payload = 1; +} \ No newline at end of file diff --git a/Benchmarking/EchoServiceGrpc/Services/GrpcEchoService.cs b/Benchmarking/EchoServiceGrpc/Services/GrpcEchoService.cs new file mode 100644 index 0000000..71a7ef9 --- /dev/null +++ b/Benchmarking/EchoServiceGrpc/Services/GrpcEchoService.cs @@ -0,0 +1,26 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Threading.Tasks; +using Grpc.Core; +using Microsoft.Extensions.Logging; + +namespace EchoService +{ + public class GrpcEchoService : Echoer.EchoerBase + { + private readonly ILogger _logger; + public GrpcEchoService(ILogger logger) + { + _logger = logger; + } + + public override Task Echo(EchoRequest request, ServerCallContext context) + { + return Task.FromResult(new EchoReply + { + Payload = request.Payload + }); + } + } +} diff --git a/Benchmarking/EchoServiceGrpc/Startup.cs b/Benchmarking/EchoServiceGrpc/Startup.cs new file mode 100644 index 0000000..b93a112 --- /dev/null +++ b/Benchmarking/EchoServiceGrpc/Startup.cs @@ -0,0 +1,43 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Threading.Tasks; +using Microsoft.AspNetCore.Builder; +using Microsoft.AspNetCore.Hosting; +using Microsoft.AspNetCore.Http; +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Hosting; + +namespace EchoService +{ + public class Startup + { + // This method gets called by the runtime. Use this method to add services to the container. + // For more information on how to configure your application, visit https://go.microsoft.com/fwlink/?LinkID=398940 + public void ConfigureServices(IServiceCollection services) + { + services.AddGrpc(); + } + + // This method gets called by the runtime. Use this method to configure the HTTP request pipeline. + public void Configure(IApplicationBuilder app, IWebHostEnvironment env) + { + if (env.IsDevelopment()) + { + app.UseDeveloperExceptionPage(); + } + + app.UseRouting(); + + app.UseEndpoints(endpoints => + { + endpoints.MapGrpcService(); + + endpoints.MapGet("/", async context => + { + await context.Response.WriteAsync("Communication with gRPC endpoints must be made through a gRPC client. To learn how to create a client, visit: https://go.microsoft.com/fwlink/?linkid=2086909"); + }); + }); + } + } +} diff --git a/Benchmarking/EchoServiceGrpc/appsettings.Development.json b/Benchmarking/EchoServiceGrpc/appsettings.Development.json new file mode 100644 index 0000000..1ca5366 --- /dev/null +++ b/Benchmarking/EchoServiceGrpc/appsettings.Development.json @@ -0,0 +1,10 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Warning", + "System": "Warning", + "Grpc": "Warning", + "Microsoft": "Warning" + } + } +} diff --git a/Benchmarking/EchoServiceGrpc/appsettings.json b/Benchmarking/EchoServiceGrpc/appsettings.json new file mode 100644 index 0000000..3110458 --- /dev/null +++ b/Benchmarking/EchoServiceGrpc/appsettings.json @@ -0,0 +1,15 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Warning", + "Microsoft": "Warning", + "Microsoft.Hosting.Lifetime": "Warning" + } + }, + "AllowedHosts": "*", + "Kestrel": { + "EndpointDefaults": { + "Protocols": "Http2" + } + } +} diff --git a/Capnp.Net.Runtime.Tests.Core21/Capnp.Net.Runtime.Tests.Core21.csproj b/Capnp.Net.Runtime.Tests.Core21/Capnp.Net.Runtime.Tests.Core21.csproj index 1541a85..30d40e2 100644 --- a/Capnp.Net.Runtime.Tests.Core21/Capnp.Net.Runtime.Tests.Core21.csproj +++ b/Capnp.Net.Runtime.Tests.Core21/Capnp.Net.Runtime.Tests.Core21.csproj @@ -22,6 +22,7 @@ + diff --git a/Capnp.Net.Runtime.Tests/ScatteringStream.cs b/Capnp.Net.Runtime.Tests/ScatteringStream.cs new file mode 100644 index 0000000..e6b44df --- /dev/null +++ b/Capnp.Net.Runtime.Tests/ScatteringStream.cs @@ -0,0 +1,58 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace Capnp.Net.Runtime.Tests +{ + /// + /// Imitates the behavior of a TCP connection by real hardware, which splits data transfer into multiple packets. + /// + class ScatteringStream : Stream + { + readonly Stream _baseStream; + readonly int _mtu; + + public ScatteringStream(Stream baseStream, int mtu) + { + _baseStream = baseStream; + _mtu = mtu; + } + + public override bool CanRead => _baseStream.CanRead; + + public override bool CanSeek => false; + + public override bool CanWrite => _baseStream.CanWrite; + + public override long Length => _baseStream.Length; + + public override long Position + { + get => _baseStream.Position; + set => throw new NotImplementedException(); + } + + public override void Flush() => _baseStream.Flush(); + + public override int Read(byte[] buffer, int offset, int count) => _baseStream.Read(buffer, offset, count); + + public override long Seek(long offset, SeekOrigin origin) => throw new NotImplementedException(); + + public override void SetLength(long value) => throw new NotImplementedException(); + + public override void Write(byte[] buffer, int offset, int count) + { + while (count > 0) + { + int amount = Math.Min(count, _mtu); + _baseStream.Write(buffer, offset, amount); + _baseStream.Flush(); + offset += amount; + count -= amount; + } + } + } +} diff --git a/Capnp.Net.Runtime.Tests/TcpRpcPorted.cs b/Capnp.Net.Runtime.Tests/TcpRpcPorted.cs index 3402ce9..db6a450 100644 --- a/Capnp.Net.Runtime.Tests/TcpRpcPorted.cs +++ b/Capnp.Net.Runtime.Tests/TcpRpcPorted.cs @@ -484,7 +484,7 @@ namespace Capnp.Net.Runtime.Tests } catch (AggregateException exception) when (exception.InnerException is RpcException rpcException && rpcException.Message == "Cannot access a disposed object.") { - Logger.Log(LogLevel.Information, $"Oops, object disposed. Counter = {cap.Count}, tx count = {client.SendCount}, rx count = {client.RecvCount}"); + Console.WriteLine($"Oops, object disposed. Counter = {cap.Count}, tx count = {client.SendCount}, rx count = {client.RecvCount}"); throw; } diff --git a/Capnp.Net.Runtime.Tests/TcpRpcStress.cs b/Capnp.Net.Runtime.Tests/TcpRpcStress.cs index d45c45c..8409ace 100644 --- a/Capnp.Net.Runtime.Tests/TcpRpcStress.cs +++ b/Capnp.Net.Runtime.Tests/TcpRpcStress.cs @@ -5,6 +5,7 @@ using Microsoft.Extensions.Logging; using Microsoft.VisualStudio.TestTools.UnitTesting; using System; using System.Collections.Generic; +using System.Net; using System.Text; using System.Threading; @@ -89,5 +90,48 @@ namespace Capnp.Net.Runtime.Tests var t = new TcpRpc(); Repeat(100, t.PipelineAfterReturn); } + + [TestMethod] + public void ScatteredTransfer() + { + + using (var server = new TcpRpcServer(IPAddress.Any, TcpPort)) + using (var client = new TcpRpcClient()) + { + server.OnConnectionChanged += (_, e) => + { + if (e.Connection.State == ConnectionState.Initializing) + { + e.Connection.InjectMidlayer(s => new ScatteringStream(s, 7)); + } + }; + + client.InjectMidlayer(s => new ScatteringStream(s, 10)); + client.Connect("localhost", TcpPort); + client.WhenConnected.Wait(); + + var counters = new Counters(); + server.Main = new TestInterfaceImpl(counters); + using (var main = client.GetMain()) + { + for (int i = 0; i < 100; i++) + { + var request1 = main.Foo(123, true, default); + var request3 = Assert.ThrowsExceptionAsync(() => main.Bar(default)); + var s = new TestAllTypes(); + Common.InitTestMessage(s); + var request2 = main.Baz(s, default); + + Assert.IsTrue(request1.Wait(MediumNonDbgTimeout)); + Assert.IsTrue(request2.Wait(MediumNonDbgTimeout)); + Assert.IsTrue(request3.Wait(MediumNonDbgTimeout)); + + Assert.AreEqual("foo", request1.Result); + Assert.AreEqual(2, counters.CallCount); + counters.CallCount = 0; + } + } + } + } } } diff --git a/Capnp.Net.Runtime/Capnp.Net.Runtime.csproj b/Capnp.Net.Runtime/Capnp.Net.Runtime.csproj index 3768715..3e741a9 100644 --- a/Capnp.Net.Runtime/Capnp.Net.Runtime.csproj +++ b/Capnp.Net.Runtime/Capnp.Net.Runtime.csproj @@ -20,7 +20,6 @@ MIT Git capnp "Cap'n Proto" RPC serialization cerealization - 1.3-local$([System.DateTime]::UtcNow.ToString(yyMMddHHmm)) Debug;Release true diff --git a/Capnp.Net.Runtime/Framing.cs b/Capnp.Net.Runtime/Framing.cs index 89e86a0..7d505ff 100644 --- a/Capnp.Net.Runtime/Framing.cs +++ b/Capnp.Net.Runtime/Framing.cs @@ -79,7 +79,10 @@ namespace Capnp return new WireFrame(buffers); } - + + static InvalidDataException StreamClosed() + => new InvalidDataException("Prematurely reached end of stream. Expected more bytes according to framing header."); + static void FillBuffersFromFrames(Memory[] buffers, uint segmentCount, BinaryReader reader) { for (uint i = 0; i < segmentCount; i++) @@ -90,7 +93,12 @@ namespace Capnp if (tmpBuffer.Length != buffer.Length) { - throw new InvalidDataException("Expected more bytes according to framing header"); + // Note w.r.t. issue #37: If there are temporarily less bytes available, + // this will NOT cause ReadBytes to return a shorter buffer. + // Only if the end of the stream is reached will we enter this branch. And this will be an error condition, + // since it would mean that the connection was closed in the middle of a frame transfer. + + throw StreamClosed(); } // Fastest way to do this without /unsafe @@ -101,7 +109,15 @@ namespace Capnp } #else var buffer = MemoryMarshal.Cast(buffers[i].Span); - reader.Read(buffer); + + do + { + int obtained = reader.Read(buffer); + if (obtained == 0) + throw StreamClosed(); + buffer = buffer.Slice(obtained); + } + while (buffer.Length > 0); #endif } } diff --git a/Capnp.Net.Runtime/Rpc/IConnection.cs b/Capnp.Net.Runtime/Rpc/IConnection.cs index 6ca724e..28311f3 100644 --- a/Capnp.Net.Runtime/Rpc/IConnection.cs +++ b/Capnp.Net.Runtime/Rpc/IConnection.cs @@ -1,5 +1,6 @@ using Capnp.FrameTracing; using System; +using System.IO; namespace Capnp.Rpc { @@ -51,6 +52,15 @@ namespace Capnp.Rpc /// Connection is not in state 'Initializing' void AttachTracer(IFrameTracer tracer); + /// + /// Installs a midlayer. A midlayer is a protocal layer that resides somewhere between capnp serialization and the raw TCP stream. + /// Thus, we have a hook mechanism for transforming data before it is sent to the TCP connection or after it was received + /// by the TCP connection, respectively. This mechanism may be used for integrating various (de-)compression algorithms. + /// + /// Callback for wrapping the midlayer around its underlying stream + /// is null + void InjectMidlayer(Func createFunc); + /// /// Prematurely closes this connection. Note that there is usually no need to close a connection manually. The typical use case /// of this method is to refuse an incoming connection in the TcpRpcServer.OnConnectionChanged callback. diff --git a/Capnp.Net.Runtime/Rpc/TcpRpcClient.cs b/Capnp.Net.Runtime/Rpc/TcpRpcClient.cs index 48298f0..163600b 100644 --- a/Capnp.Net.Runtime/Rpc/TcpRpcClient.cs +++ b/Capnp.Net.Runtime/Rpc/TcpRpcClient.cs @@ -40,6 +40,7 @@ namespace Capnp.Rpc readonly RpcEngine _rpcEngine; readonly TcpClient _client; + Func _createLayers = _ => _; RpcEngine.RpcEndpoint? _inboundEndpoint; OutboundTcpEndpoint? _outboundEndpoint; FramePump? _pump; @@ -78,7 +79,9 @@ namespace Capnp.Rpc await ConnectAsync(host, port); State = ConnectionState.Active; - _pump = new FramePump(_client.GetStream()); + + var stream = _createLayers(_client.GetStream()); + _pump = new FramePump(stream); _attachTracerAction?.Invoke(); _outboundEndpoint = new OutboundTcpEndpoint(this, _pump); _inboundEndpoint = _rpcEngine.AddEndpoint(_outboundEndpoint); @@ -218,6 +221,25 @@ namespace Capnp.Rpc }; } + /// + /// Installs a midlayer. A midlayer is a protocal layer that resides somewhere between capnp serialization and the raw TCP stream. + /// Thus, we have a hook mechanism for transforming data before it is sent to the TCP connection or after it was received + /// by the TCP connection, respectively. This mechanism may be used for integrating various (de-)compression algorithms. + /// + /// Callback for wrapping the midlayer around its underlying stream + /// is null + public void InjectMidlayer(Func createFunc) + { + if (createFunc == null) + throw new ArgumentNullException(nameof(createFunc)); + + if (State != ConnectionState.Initializing) + throw new InvalidOperationException("Connection is not in state 'Initializing'"); + + var last = _createLayers; + _createLayers = _ => createFunc(last(_)); + } + /// /// Prematurely closes this connection. Note that there is usually no need to close a connection manually. /// diff --git a/Capnp.Net.Runtime/Rpc/TcpRpcServer.cs b/Capnp.Net.Runtime/Rpc/TcpRpcServer.cs index 5260515..dcd05fc 100644 --- a/Capnp.Net.Runtime/Rpc/TcpRpcServer.cs +++ b/Capnp.Net.Runtime/Rpc/TcpRpcServer.cs @@ -2,6 +2,7 @@ using Microsoft.Extensions.Logging; using System; using System.Collections.Generic; +using System.IO; using System.Net; using System.Net.Sockets; using System.Threading; @@ -60,24 +61,29 @@ namespace Capnp.Rpc class Connection: IConnection { readonly TcpRpcServer _server; + Stream _stream; - public Connection(TcpRpcServer server, TcpClient client, FramePump pump, OutboundTcpEndpoint outboundEp, RpcEngine.RpcEndpoint inboundEp) + public Connection(TcpRpcServer server, TcpClient client) { _server = server; Client = client; - Pump = pump; - OutboundEp = outboundEp; - InboundEp = inboundEp; + _stream = client.GetStream(); } public void Start() { + Pump = new FramePump(_stream); + OutboundEp = new OutboundTcpEndpoint(_server, Pump); + InboundEp = _server._rpcEngine.AddEndpoint(OutboundEp); + Pump.FrameReceived += InboundEp.Forward; + + State = ConnectionState.Active; + PumpRunner = new Thread(o => { try { Thread.CurrentThread.Name = $"TCP RPC Server Thread {Thread.CurrentThread.ManagedThreadId}"; - State = ConnectionState.Active; Pump.Run(); } @@ -122,6 +128,24 @@ namespace Capnp.Rpc Pump.AttachTracer(tracer); } + /// + /// Installs a midlayer. A midlayer is a protocal layer that resides somewhere between capnp serialization and the raw TCP stream. + /// Thus, we have a hook mechanism for transforming data before it is sent to the TCP connection or after it was received + /// by the TCP connection, respectively. This mechanism may be used for integrating various (de-)compression algorithms. + /// + /// Callback for wrapping the midlayer around its underlying stream + /// is null + public void InjectMidlayer(Func createFunc) + { + if (createFunc == null) + throw new ArgumentNullException(nameof(createFunc)); + + if (State != ConnectionState.Initializing) + throw new InvalidOperationException("Connection is not in state 'Initializing'"); + + _stream = createFunc(_stream); + } + public void Close() { Client.Dispose(); @@ -149,12 +173,7 @@ namespace Capnp.Rpc while (true) { var client = _listener.AcceptTcpClient(); - var pump = new FramePump(client.GetStream()); - var outboundEndpoint = new OutboundTcpEndpoint(this, pump); - var inboundEndpoint = _rpcEngine.AddEndpoint(outboundEndpoint); - pump.FrameReceived += inboundEndpoint.Forward; - - var connection = new Connection(this, client, pump, outboundEndpoint, inboundEndpoint); + var connection = new Connection(this, client); lock (_reentrancyBlocker) { diff --git a/CapnpC.CSharp.MsBuild.Generation/CapnpC.CSharp.MsBuild.Generation.csproj b/CapnpC.CSharp.MsBuild.Generation/CapnpC.CSharp.MsBuild.Generation.csproj index c2aa0e7..92c5f3c 100644 --- a/CapnpC.CSharp.MsBuild.Generation/CapnpC.CSharp.MsBuild.Generation.csproj +++ b/CapnpC.CSharp.MsBuild.Generation/CapnpC.CSharp.MsBuild.Generation.csproj @@ -9,12 +9,8 @@ true true $(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb - 1.3.0.0 - 1.3.0.0 - 1.3-local$([System.DateTime]::UtcNow.ToString(yyMMddHHmm)) - + $(MSBuildThisFileDirectory)CapnpC.CSharp.MsBuild.Generation.nuspec - version=$(Version);configuration=$(Configuration) true ..\bin\$(Configuration) Debug;Release diff --git a/CapnpC.CSharp.MsBuild.Generation/CapnpC.CSharp.MsBuild.Generation.nuspec b/CapnpC.CSharp.MsBuild.Generation/CapnpC.CSharp.MsBuild.Generation.nuspec index e048bb9..e3ad91d 100644 --- a/CapnpC.CSharp.MsBuild.Generation/CapnpC.CSharp.MsBuild.Generation.nuspec +++ b/CapnpC.CSharp.MsBuild.Generation/CapnpC.CSharp.MsBuild.Generation.nuspec @@ -21,9 +21,9 @@ - - - + + + diff --git a/Directory.Build.props b/Directory.Build.props new file mode 100644 index 0000000..46af06b --- /dev/null +++ b/Directory.Build.props @@ -0,0 +1,9 @@ + + + + + 3.0.28 + all + + + \ No newline at end of file diff --git a/Directory.Build.targets b/Directory.Build.targets new file mode 100644 index 0000000..20033a9 --- /dev/null +++ b/Directory.Build.targets @@ -0,0 +1,23 @@ + + + + $(NuspecProperties);config=$(Configuration) + $(NuspecProperties);version=$(NuGetPackageVersion) + $(NuspecProperties);SolutionDir=$(SolutionDir) + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/MsBuildGenerationTest/MsBuildGenerationTest.csproj b/MsBuildGenerationTest/MsBuildGenerationTest.csproj index 5585778..773569e 100644 --- a/MsBuildGenerationTest/MsBuildGenerationTest.csproj +++ b/MsBuildGenerationTest/MsBuildGenerationTest.csproj @@ -5,7 +5,6 @@ netcoreapp3.0 8.0 Enable - 1.3-local Debug;Release $(Version)* diff --git a/README.md b/README.md index c9ecef5..0abcdcc 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,9 @@ choco install capnpc-csharp-win-x86 Both versions will also download and install the [Cap'n Proto tool set Chocolatey package](https://www.chocolatey.org/packages/capnproto). Note that the author does not maintain this package and has no influence on its contents. +*Announcement: There is currently an experimental branch for packaging the code generator back end as .NET Core CLI tool. If this approach turns out to be viable, it will probably be superior to the Chocolatey deployment. In that case, the CLI tool capnpc-csharp will be deployed on NuGet.org and the former Chocolatey package will be deprecated. capnpc-csharp-win-x86 will probably be kept (and also maintained).* + + ### Code generator back end: Other OSes Currently, you are on yourself. Compile the `capnpc-csharp` VS project and install the resulting .NET application manually on your system. This should not be that complicated, see also the [Wiki](https://github.com/c80k/capnproto-dotnetcore/wiki). It would be great to support other package managers, especially [APT](https://wiki.debian.org/Apt). Consider contributing? Author would be happy! diff --git a/appveyor.yml b/appveyor.yml index f1d2bdc..b8c4883 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -1,27 +1,21 @@ -version: '1.3.{build}' image: Visual Studio 2019 # branches: # only: # - master +version: '{build}' cache: - c:\Tools\vcpkg\installed -init: - # Good practise, because Windows line endings are different from Unix/Linux ones - - cmd: git config --global core.autocrlf true install: - cd c:\tools\vcpkg - vcpkg integrate install - vcpkg install capnproto - cd %APPVEYOR_BUILD_FOLDER% -dotnet_csproj: - patch: true - file: '**\*.csproj;**\*.props;**\*.fsproj;**\*.xml' - version: '{version}' - package_version: '{version}' - assembly_version: '{version}' - file_version: '{version}' - informational_version: '{version}' + - dotnet tool install -g nbgv +init: + # Good practise, because Windows line endings are different from Unix/Linux ones + - cmd: git config --global core.autocrlf true before_build: + - cmd: nbgv cloud - cmd: dotnet --version - cmd: msbuild -ver - cmd: dotnet restore ./Capnp.Net.Runtime/Capnp.Net.Runtime.csproj --verbosity m @@ -38,48 +32,54 @@ build_script: - cmd: msbuild ./Capnp.Net.sln /p:Configuration="Release" - cmd: msbuild ./CapnpCompatTest.sln /p:Configuration="Debug" - cmd: msbuild ./CapnpCompatTest.sln /p:Configuration="Release" - - ps: scripts\capnpc-csharp-pack.ps1 $env:appveyor_build_version + - ps: scripts\capnpc-csharp-pack.ps1 after_build: # For once the build has completed artifacts: - - path: bin\Release\Capnp.Net.Runtime.$(appveyor_build_version).nupkg + - path: bin\Release\Capnp.Net.Runtime.*.nupkg name: Capnp.Net.Runtime type: NuGetPackage - - path: bin\Release\CapnpC.CSharp.MsBuild.Generation.$(appveyor_build_version).nupkg + - path: bin\Release\CapnpC.CSharp.MsBuild.Generation.*.nupkg name: CapnpC.CSharp.MsBuild.Generation type: NuGetPackage - - path: chocolatey\install\capnpc-csharp-win-x86.$(appveyor_build_version).nupkg + - path: chocolatey\install\capnpc-csharp-win-x86.*.nupkg name: capnpc-csharp-win-x86 type: NuGetPackage - - path: chocolatey\install\capnpc-csharp.$(appveyor_build_version).nupkg + - path: chocolatey\install\capnpc-csharp.*-deprecated.nupkg + name: capnpc-csharp-deprecated + type: NuGetPackage + - path: capnpc-csharp\nupkg\*.nupkg name: capnpc-csharp type: NuGetPackage -clone_depth: 1 test_script: - - cmd: vstest.console /logger:Appveyor /inIsolation CapnpC.CSharp.Generator.Tests\bin\Release\netcoreapp3.0\CapnpC.CSharp.Generator.Tests.dll - - cmd: cd %APPVEYOR_BUILD_FOLDER%\chocolatey\install - - cmd: choco install capnpc-csharp --source=".;https://chocolatey.org/api/v2" --force -y - - cmd: cd %APPVEYOR_BUILD_FOLDER%\install-test - - cmd: compile-test - - cmd: cd %APPVEYOR_BUILD_FOLDER% - - cmd: vstest.console /logger:Appveyor /inIsolation CapnpC.CSharp.Generator.Tests\bin\Release\netcoreapp3.0\CapnpC.CSharp.Generator.Tests.dll - - cmd: choco uninstall capnpc-csharp -y - - cmd: cd %APPVEYOR_BUILD_FOLDER%\install-test - - cmd: notinstalled-test - - cmd: cd %APPVEYOR_BUILD_FOLDER%\chocolatey\install - - cmd: choco install capnpc-csharp-win-x86 --source=".;https://chocolatey.org/api/v2" --force -y - - cmd: cd %APPVEYOR_BUILD_FOLDER%\install-test - - cmd: compile-test - - cmd: choco uninstall capnpc-csharp-win-x86 -y - - cmd: notinstalled-test - - cmd: cd %APPVEYOR_BUILD_FOLDER% - - cmd: vstest.console /logger:Appveyor /inIsolation CapnpC.CSharp.MsBuild.Generation.Tests\bin\Release\netcoreapp3.0\CapnpC.CSharp.MsBuild.Generation.Tests.dll - - cmd: msbuild -t:restore ./MsBuildGenerationTest/MsBuildGenerationTest.csproj /p:Configuration="Debug" /p:PackageReferenceVersion="%APPVEYOR_BUILD_VERSION%" - - cmd: msbuild ./MsBuildGenerationTest/MsBuildGenerationTest.sln /p:Configuration="Debug" /p:PackageReferenceVersion="%APPVEYOR_BUILD_VERSION%" - - cmd: vstest.console /logger:Appveyor /inIsolation Capnp.Net.Runtime.Tests\bin\Debug\net471\Capnp.Net.Runtime.Tests.Std20.dll - - cmd: vstest.console /logger:Appveyor /inIsolation Capnp.Net.Runtime.Tests\bin\Release\net471\Capnp.Net.Runtime.Tests.Std20.dll - - cmd: vstest.console /logger:Appveyor /inIsolation Capnp.Net.Runtime.Tests.Core21\bin\Debug\netcoreapp2.1\Capnp.Net.Runtime.Tests.Core21.dll - - cmd: vstest.console /logger:Appveyor /inIsolation Capnp.Net.Runtime.Tests.Core21\bin\Release\netcoreapp2.1\Capnp.Net.Runtime.Tests.Core21.dll + - cmd: | + nbgv get-version -v NuGetPackageVersion >> version.txt + set /P VERSION=< version.txt + vstest.console /logger:Appveyor /inIsolation CapnpC.CSharp.Generator.Tests\bin\Release\netcoreapp3.0\CapnpC.CSharp.Generator.Tests.dll + choco install capnproto --source="https://chocolatey.org/api/v2" --force -y + cd %APPVEYOR_BUILD_FOLDER%\capnpc-csharp + dotnet tool install --global --add-source ./nupkg capnpc-csharp --version %VERSION% + cd %APPVEYOR_BUILD_FOLDER%\install-test + compile-test + cd %APPVEYOR_BUILD_FOLDER% + vstest.console /logger:Appveyor /inIsolation CapnpC.CSharp.Generator.Tests\bin\Release\netcoreapp3.0\CapnpC.CSharp.Generator.Tests.dll + dotnet tool uninstall --global capnpc-csharp + cd %APPVEYOR_BUILD_FOLDER%\install-test + notinstalled-test + cd %APPVEYOR_BUILD_FOLDER%\chocolatey\install + choco install capnpc-csharp-win-x86 --source=".;https://chocolatey.org/api/v2" --force -y --version %VERSION% --pre + cd %APPVEYOR_BUILD_FOLDER%\install-test + compile-test + choco uninstall capnpc-csharp-win-x86 -y + notinstalled-test + cd %APPVEYOR_BUILD_FOLDER% + vstest.console /logger:Appveyor /inIsolation CapnpC.CSharp.MsBuild.Generation.Tests\bin\Release\netcoreapp3.0\CapnpC.CSharp.MsBuild.Generation.Tests.dll + msbuild -t:restore ./MsBuildGenerationTest/MsBuildGenerationTest.csproj /p:Configuration="Debug" /p:PackageReferenceVersion="%VERSION%" + msbuild ./MsBuildGenerationTest/MsBuildGenerationTest.sln /p:Configuration="Debug" /p:PackageReferenceVersion="%VERSION%" + vstest.console /logger:Appveyor /inIsolation Capnp.Net.Runtime.Tests\bin\Debug\net471\Capnp.Net.Runtime.Tests.Std20.dll + vstest.console /logger:Appveyor /inIsolation Capnp.Net.Runtime.Tests\bin\Release\net471\Capnp.Net.Runtime.Tests.Std20.dll + vstest.console /logger:Appveyor /inIsolation Capnp.Net.Runtime.Tests.Core21\bin\Debug\netcoreapp2.1\Capnp.Net.Runtime.Tests.Core21.dll + vstest.console /logger:Appveyor /inIsolation Capnp.Net.Runtime.Tests.Core21\bin\Release\netcoreapp2.1\Capnp.Net.Runtime.Tests.Core21.dll on_finish : # any cleanup in here deploy: diff --git a/capnpc-csharp/capnpc-csharp.csproj b/capnpc-csharp/capnpc-csharp.csproj index f5088f0..090c3d4 100644 --- a/capnpc-csharp/capnpc-csharp.csproj +++ b/capnpc-csharp/capnpc-csharp.csproj @@ -5,7 +5,10 @@ netcoreapp2.1 CapnpC 7.1 - false + true + true + capnpc-csharp + ./nupkg MIT Christian Köllner and contributors Cap'n Proto C# code generator backend @@ -13,7 +16,6 @@ https://github.com/c80k/capnproto-dotnetcore Git capnp capnpc RPC serialization cerealization - 1.3.0 Debug;Release diff --git a/chocolatey/capnpc-csharp/capnpc-csharp.nuspec b/chocolatey/capnpc-csharp/capnpc-csharp.nuspec index 801c842..7a819d2 100644 --- a/chocolatey/capnpc-csharp/capnpc-csharp.nuspec +++ b/chocolatey/capnpc-csharp/capnpc-csharp.nuspec @@ -10,8 +10,11 @@ https://github.com/c80k/capnproto-dotnetcore/blob/master/LICENSE https://github.com/c80k/capnproto-dotnetcore - capnpc-csharp (Install) - Cap'n Proto C# code generator backend, portable .NET Core 2.1 + [Deprecated] capnpc-csharp (Install) + Cap'n Proto C# code generator backend, portable .NET Core 2.1 + This package is deprecated now. It was converted to a .NET Core CLI tool which is now hosted here: https://www.nuget.org/packages/capnpc-csharp + To install, type: dotnet tool install -g capnpc-csharp + Cap'n Proto C# code generator backend. This is the portable variant which depends on .NET Core 2.1 (as opposed to capnpc-csharp-win-x86) Christian Köllner and contributors https://github.com/c80k/capnproto-dotnetcore @@ -22,15 +25,7 @@ https://github.com/c80k/capnproto-dotnetcore/releases/tag/v$version$ - - - - - - - - - + \ No newline at end of file diff --git a/scripts/capnpc-csharp-pack.ps1 b/scripts/capnpc-csharp-pack.ps1 index 79935d5..6aadac5 100644 --- a/scripts/capnpc-csharp-pack.ps1 +++ b/scripts/capnpc-csharp-pack.ps1 @@ -1,5 +1,5 @@ -param($version = "1.0.0") - +$jversion = nbgv get-version -f json | ConvertFrom-Json +$version = $($jversion.NuGetPackageVersion) $id = "capnpc-csharp" $id_win_x86 = "capnpc-csharp-win-x86" $scriptDir = Split-Path -Parent $MyInvocation.MyCommand.Path @@ -10,7 +10,7 @@ $installDir = "$chocoDir\install" dotnet build -c Release "$scriptDir\..\Capnp.Net.sln" dotnet publish -c Release -r win-x86 --self-contained -o "$chocoDir\$id_win_x86\bin" "$csprojDir\$csprojFile" -dotnet publish -c Release -o "$chocoDir\$id\bin" "$csprojDir\$csprojFile" +# dotnet publish -c Release -o "$chocoDir\$id\bin" "$csprojDir\$csprojFile" If(!(test-path $installDir)) { @@ -21,3 +21,4 @@ Copy-Item "$scriptDir\..\LICENSE" -Destination "$chocoDir\LICENSE.txt" choco pack "$chocoDir\$id\$id.nuspec" --version $version --outputdirectory $installDir choco pack "$chocoDir\$id_win_x86\$id_win_x86.nuspec" --version $version --outputdirectory $installDir +Rename-Item -Path "$installDir\$id.$version.nupkg" -NewName "$id.$version-deprecated.nupkg" \ No newline at end of file diff --git a/version.json b/version.json new file mode 100644 index 0000000..b47b6b2 --- /dev/null +++ b/version.json @@ -0,0 +1,14 @@ +{ + "$schema": "https://raw.githubusercontent.com/AArnott/Nerdbank.GitVersioning/master/src/NerdBank.GitVersioning/version.schema.json", + "version": "1.3", + "publicReleaseRefSpec": [ + "^refs/heads/master$", + "^refs/heads/v\\d+(?:\\.\\d+)?$" + ], + "cloudBuild": { + "buildNumber": { + "enabled": true, + "setVersionVariables": true + } + } +} \ No newline at end of file