Override ReadAsync and WriteAsync methods on ConsoleStream. by eerhardt · Pull Request #71971 · dotnet/runtime

eerhardt · 2022-07-11T20:42:32Z

The base Stream class implements these overloads by renting a buffer,
creating a ReadWriteTask, and copying data as necessary.

Instead, ConsoleStreams can just override these Async methods and synchronously
call the underlying OS API.

Benchmark

publicclassConsoleStreamsBenchmark{staticbyte[]_bytes=Encoding.ASCII.GetBytes("Hello, World!");staticStream_stream=Console.OpenStandardOutput();staticNativeMemoryManager_nativeMemoryManager=CreateNativeMemory();privateunsafestaticNativeMemoryManagerCreateNativeMemory(){byte*mem=(byte*)NativeMemory.Alloc((nuint)_bytes.Length);_bytes.AsSpan().CopyTo(newSpan<byte>(mem,_bytes.Length));returnnewNativeMemoryManager(mem,_bytes.Length);}[Benchmark]publicasyncTaskWriteToStream(){await_stream.WriteAsync(_bytes);}[Benchmark]publicasyncTaskWriteNativeMemoryToStream(){await_stream.WriteAsync(_nativeMemoryManager.Memory);}unsafeclassNativeMemoryManager:MemoryManager<byte>{privatebyte*_pointer;privateint_length;internalNativeMemoryManager(byte*pointer,intlength){_pointer=pointer;_length=length;}publicoverrideSpan<byte>GetSpan()=>newSpan<byte>(_pointer,_length);publicoverrideMemoryHandlePin(intelementIndex=0)=>default;publicoverridevoidUnpin(){}protectedoverridevoidDispose(booldisposing){}}}

Results

Method	Job	Toolchain	Mean	Error	StdDev	Ratio	RatioSD
WriteToStream	Job-AMXSLA	\main\corerun.exe	6.221 us	0.6849 us	0.7888 us	1.00	0.00
WriteToStream	Job-CRTAYW	\pr\corerun.exe	4.602 us	0.6634 us	0.7374 us	0.74	0.08

WriteNativeMemoryToStream	Job-AMXSLA	\main\corerun.exe	6.549 us	0.8117 us	0.8685 us	1.00	0.00
WriteNativeMemoryToStream	Job-CRTAYW	\pr\corerun.exe	4.575 us	0.6448 us	0.7426 us	0.69	0.07

The base Stream class implements these overloads by renting a buffer, creating a ReadWriteTask, and copying data as necessary. Instead, ConsoleStreams can just override these Async methods and synchronously call the underlying OS API. Add tests to verify that input and output console streams behave correctly.

ghost · 2022-07-11T20:42:44Z

Tagging subscribers to this area: @dotnet/area-system-console
See info in area-owners.md if you want to be subscribed.

Issue Details

The base Stream class implements these overloads by renting a buffer,
creating a ReadWriteTask, and copying data as necessary.

Instead, ConsoleStreams can just override these Async methods and synchronously
call the underlying OS API.

Benchmark

publicclassConsoleStreamsBenchmark{staticbyte[]_bytes=Encoding.ASCII.GetBytes("Hello, World!");staticStream_stream=Console.OpenStandardOutput();staticNativeMemoryManager_nativeMemoryManager=CreateNativeMemory();privateunsafestaticNativeMemoryManagerCreateNativeMemory(){byte*mem=(byte*)NativeMemory.Alloc((nuint)_bytes.Length);_bytes.AsSpan().CopyTo(newSpan<byte>(mem,_bytes.Length));returnnewNativeMemoryManager(mem,_bytes.Length);}[Benchmark]publicasyncTaskWriteToStream(){await_stream.WriteAsync(_bytes);}[Benchmark]publicasyncTaskWriteNativeMemoryToStream(){await_stream.WriteAsync(_nativeMemoryManager.Memory);}unsafeclassNativeMemoryManager:MemoryManager<byte>{privatebyte*_pointer;privateint_length;internalNativeMemoryManager(byte*pointer,intlength){_pointer=pointer;_length=length;}publicoverrideSpan<byte>GetSpan()=>newSpan<byte>(_pointer,_length);publicoverrideMemoryHandlePin(intelementIndex=0)=>default;publicoverridevoidUnpin(){}protectedoverridevoidDispose(booldisposing){}}}

Results

Method	Job	Toolchain	Mean	Error	StdDev	Ratio	RatioSD
WriteToStream	Job-AMXSLA	\main\corerun.exe	6.221 us	0.6849 us	0.7888 us	1.00	0.00
WriteToStream	Job-CRTAYW	\pr\corerun.exe	4.602 us	0.6634 us	0.7374 us	0.74	0.08

WriteNativeMemoryToStream	Job-AMXSLA	\main\corerun.exe	6.549 us	0.8117 us	0.8685 us	1.00	0.00
WriteNativeMemoryToStream	Job-CRTAYW	\pr\corerun.exe	4.575 us	0.6448 us	0.7426 us	0.69	0.07

Author:	eerhardt
Assignees:	-
Labels:	`area-System.Console`
Milestone:	-

stephentoub

Thanks.

eerhardt · 2022-07-12T13:55:40Z

The new "OpenStandardInput" tests need to be skipped on platforms that don't support standard input - like wasm, ios, and android. Fixing...

adamsitnik

LGTM, thank you @eerhardt !

adamsitnik · 2022-07-12T16:14:03Z

/azp list

azure-pipelines · 2022-07-12T16:14:09Z

CI/CD Pipelines for this repository: runtime-coreclr outerloop runtime-coreclr jitstress runtime-coreclr jitstressregs runtime-coreclr jitstress2-jitstressregs runtime-coreclr gcstress0x3-gcstress0xc runtime-coreclr gcstress-extra runtime-coreclr r2r-extra runtime-coreclr jitstress-isas-x86 runtime-coreclr jitstress-isas-arm runtime-coreclr jitstressregs-x86 runtime-coreclr libraries-jitstressregs runtime-coreclr libraries-jitstress2-jitstressregs runtime-coreclr r2r runtime-coreclr runincontext runtime-coreclr crossgen2 runtime-libraries-coreclr outerloop runtime-libraries-coreclr outerloop-windows runtime-libraries-coreclr outerloop-linux runtime-libraries-coreclr outerloop-osx runtime runtime-libraries enterprise-linux runtime-libraries stress-http runtime-libraries stress-ssl runtime-dev-innerloop runtime-coreclr crossgen2 outerloop coreclr-release-outerloop-nightly sync-runtime-to-mono runtime-coreclr crossgen2-composite runtime-jit-experimental runtime-coreclr libraries-jitstress dotnet-linker-tests runtime-coreclr ilasm runtime-coreclr crossgen2-composite gcstress runtime-libraries-mono outerloop runtime-staging runtime-coreclr pgo runtime-coreclr libraries-pgo coreclr-gc-regions Antigen runtime-community Fuzzlyn runtime-coreclr superpmi-replay runtime-wasm runtime-coreclr superpmi-diffs runtime-coreclr superpmi-asmdiffs-checked-release runtime-manual runtime-extra-platforms jit-cfg perf-wasm runtime-llvm

adamsitnik · 2022-07-12T16:14:46Z

/azp run runtime-extra-platforms

azure-pipelines · 2022-07-12T16:15:10Z

Azure Pipelines successfully started running 1 pipeline(s).

eerhardt · 2022-07-12T20:03:52Z

All the runtime-extra-platforms failures are unrelated to System.Console.

ghost added the area-System.Console label Jul 11, 2022

ghost assigned eerhardt Jul 11, 2022

eerhardt requested review from adamsitnik and stephentoub July 11, 2022 20:42

stephentoub reviewed Jul 11, 2022
View reviewed changes

Comment threadsrc/libraries/System.Console/src/System/IO/ConsoleStream.cs Outdated

stephentoub reviewed Jul 11, 2022
View reviewed changes

Comment threadsrc/libraries/System.Console/src/System/IO/ConsoleStream.cs Outdated

stephentoub reviewed Jul 11, 2022
View reviewed changes

Comment threadsrc/libraries/System.Console/src/System/IO/ConsoleStream.cs Outdated

stephentoub reviewed Jul 11, 2022
View reviewed changes

Comment threadsrc/libraries/System.Console/src/System/IO/ConsoleStream.cs

PR feedback
27f8a58

runfoappBot mentioned this pull request Jul 12, 2022
System.Runtime.InteropServices.JavaScript.Tests.JSImportExportTest.JSImportObject #71990
Closed

stephentoub approved these changes Jul 12, 2022
View reviewed changes

Fix stdin tests to only run on supported platforms.
f755f6e

adamsitnik approved these changes Jul 12, 2022
View reviewed changes

eerhardt merged commit 8cb4e93 into dotnet:mainJul 12, 2022

eerhardt deleted the ConsoleStreams branch July 12, 2022 20:04

This was referenced Jul 14, 2022
matrix4x4createfromaxisangletest failing on NativeAOT #72149
Closed
System.Net.Http.Function.Tests and System.Net.Websockets.Client.Tests work items failing on runtime-extra-platforms Mono_Release runs #72209
Closed

runfoappBot mentioned this pull request Jul 22, 2022
System.Text.Json.SourceGeneration intermittent failures #72101
Closed

ghost locked as resolved and limited conversation to collaborators Aug 12, 2022

Navigation Menu

Uh oh!

Override ReadAsync and WriteAsync methods on ConsoleStream. - #71971

Override ReadAsync and WriteAsync methods on ConsoleStream.#71971
eerhardt merged 3 commits into
dotnet:mainfrom
eerhardt:ConsoleStreams

eerhardt commented Jul 11, 2022

Uh oh!

ghost commented Jul 11, 2022

Benchmark

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stephentoub left a comment

Uh oh!

eerhardt commented Jul 12, 2022

Uh oh!

adamsitnik left a comment

Uh oh!

adamsitnik commented Jul 12, 2022

Uh oh!

azure-pipelinesBot commented Jul 12, 2022

Uh oh!

adamsitnik commented Jul 12, 2022

Uh oh!

azure-pipelinesBot commented Jul 12, 2022

Uh oh!

eerhardt commented Jul 12, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

eerhardt commented Jul 11, 2022

Benchmark

Uh oh!

ghost commented Jul 11, 2022

Benchmark

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stephentoub left a comment

Choose a reason for hiding this comment

Uh oh!

eerhardt commented Jul 12, 2022

Uh oh!

adamsitnik left a comment

Choose a reason for hiding this comment

Uh oh!

adamsitnik commented Jul 12, 2022

Uh oh!

azure-pipelinesBot commented Jul 12, 2022

Uh oh!

adamsitnik commented Jul 12, 2022

Uh oh!

azure-pipelinesBot commented Jul 12, 2022

Uh oh!

eerhardt commented Jul 12, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants