when async operation fails with ERROR_OPERATION_ABORTED, we should ignore numBytes that can be != 0 #57229

adamsitnik · 2021-08-11T18:38:05Z

In #57212, I've validated that when async WriteFile operation fails with ERROR_OPERATION_ABORTED, the reported number of transferred bytes can be different than zero. Moreover, its value can be bigger than the number of bytes that we have requested to transfer when the operation was started, so we can assume that this value is always invalid in such case and just use zero instead.

Process terminated. Assertion failed.
Callback returned 995 error and 1547079704 bytes
   at Microsoft.Win32.SafeHandles.SafeFileHandle.OverlappedValueTaskSource.Complete(UInt32 errorCode, UInt32 numBytes) in /_/src/libraries/System.Private.CoreLib/src/Microsoft/Win32/SafeHandles/SafeFileHandle.OverlappedValueTaskSource.Windows.cs:line 198
   at System.Threading._IOCompletionCallback.PerformIOCompletionCallback(UInt32 errorCode, UInt32 numBytes, NativeOverlapped* pNativeOverlapped) in /_/src/coreclr/System.Private.CoreLib/src/System/Threading

System.IO.Tests.FileStream_WriteAsync_AsyncWrites.TriggerTheProblemAsync [FAIL]
  System.Exception : The error code was 995 and numBytes was 189216864
  Stack Trace:
    /_/src/libraries/System.Private.CoreLib/src/Microsoft/Win32/SafeHandles/SafeFileHandle.OverlappedValueTaskSource.Windows.cs(101,0): at Microsoft.Win32.SafeHandles.SafeFileHandle.OverlappedValueTaskSource.GetResult(Int16 token)
    /_/src/libraries/System.Private.CoreLib/src/Microsoft/Win32/SafeHandles/SafeFileHandle.OverlappedValueTaskSource.Windows.cs(96,0): at Microsoft.Win32.SafeHandles.SafeFileHandle.OverlappedValueTaskSource.System.Threading.Tasks.Sources.IValueTaskSource.GetResult(Int16 token)
    /_/src/libraries/System.Private.CoreLib/src/System/Threading/Tasks/ValueTask.cs(251,0): at System.Threading.Tasks.ValueTask.ValueTaskSourceAsTask.<>c.<.cctor>b__4_0(Object state)
    --- End of stack trace from previous location ---
    /_/src/libraries/System.IO.FileSystem/tests/FileStream/WriteAsync.cs(131,0): at System.IO.Tests.FileStream_AsyncWrites.WriteAsyncCancelledFile(Int32 bufferSize, FileOptions fileOptions)
    /_/src/libraries/System.IO.FileSystem/tests/FileStream/WriteAsync.cs(110,0): at System.IO.Tests.FileStream_AsyncWrites.TriggerTheProblemAsync()
    --- End of stack trace from previous location ---

fixes #56894

…nore numBytes that can be != 0

ghost · 2021-08-11T18:38:11Z

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

Issue Details

In #57212, I've validated that when async WriteFile operation fails with ERROR_OPERATION_ABORTED, the reported number of transferred bytes can be different than zero. Moreover, its value can be bigger than the number of bytes that we have requested to transfer when the operation was started, so we can assume that this value is always invalid in such case and just use zero instead.

Process terminated. Assertion failed.
Callback returned 995 error and 1547079704 bytes
   at Microsoft.Win32.SafeHandles.SafeFileHandle.OverlappedValueTaskSource.Complete(UInt32 errorCode, UInt32 numBytes) in /_/src/libraries/System.Private.CoreLib/src/Microsoft/Win32/SafeHandles/SafeFileHandle.OverlappedValueTaskSource.Windows.cs:line 198
   at System.Threading._IOCompletionCallback.PerformIOCompletionCallback(UInt32 errorCode, UInt32 numBytes, NativeOverlapped* pNativeOverlapped) in /_/src/coreclr/System.Private.CoreLib/src/System/Threading

System.IO.Tests.FileStream_WriteAsync_AsyncWrites.TriggerTheProblemAsync [FAIL]
  System.Exception : The error code was 995 and numBytes was 189216864
  Stack Trace:
    /_/src/libraries/System.Private.CoreLib/src/Microsoft/Win32/SafeHandles/SafeFileHandle.OverlappedValueTaskSource.Windows.cs(101,0): at Microsoft.Win32.SafeHandles.SafeFileHandle.OverlappedValueTaskSource.GetResult(Int16 token)
    /_/src/libraries/System.Private.CoreLib/src/Microsoft/Win32/SafeHandles/SafeFileHandle.OverlappedValueTaskSource.Windows.cs(96,0): at Microsoft.Win32.SafeHandles.SafeFileHandle.OverlappedValueTaskSource.System.Threading.Tasks.Sources.IValueTaskSource.GetResult(Int16 token)
    /_/src/libraries/System.Private.CoreLib/src/System/Threading/Tasks/ValueTask.cs(251,0): at System.Threading.Tasks.ValueTask.ValueTaskSourceAsTask.<>c.<.cctor>b__4_0(Object state)
    --- End of stack trace from previous location ---
    /_/src/libraries/System.IO.FileSystem/tests/FileStream/WriteAsync.cs(131,0): at System.IO.Tests.FileStream_AsyncWrites.WriteAsyncCancelledFile(Int32 bufferSize, FileOptions fileOptions)
    /_/src/libraries/System.IO.FileSystem/tests/FileStream/WriteAsync.cs(110,0): at System.IO.Tests.FileStream_AsyncWrites.TriggerTheProblemAsync()
    --- End of stack trace from previous location ---

fixes #56894

Author:	adamsitnik
Assignees:	-
Labels:	`area-System.IO`
Milestone:	6.0.0

ghost · 2021-08-11T18:49:35Z

Hello @adamsitnik!

Because this pull request has the auto-merge label, I will be glad to assist with helping to merge this pull request once all check-in policies pass.

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (`@msftbot`) and give me an instruction to get started! Learn more here.

carlossanlop

LGTM. Just a small optional suggestion to add a comment.

carlossanlop · 2021-08-11T18:49:14Z

....CoreLib/src/Microsoft/Win32/SafeHandles/SafeFileHandle.OverlappedValueTaskSource.Windows.cs

                        // Cancellation
                        CancellationToken ct = _cancellationRegistration.Token;
                        _source.SetException(ct.IsCancellationRequested ? new OperationCanceledException(ct) : new OperationCanceledException());
                        break;

                    default:
                        // Failure
+                        strategy?.OnIncompleteOperation(_bufferSize, 0);


Do we care to add a comment here explaining why 0 for the default case?

....CoreLib/src/Microsoft/Win32/SafeHandles/SafeFileHandle.OverlappedValueTaskSource.Windows.cs

carlossanlop · 2021-08-11T23:05:36Z

The code only affects Windows. The CI failure happened in an unrelated OSX unit test which @jozkee fixed in #57235. This is good to merge.

when async operation fails with ERROR_OPERATION_ABORTED, we should ig…

8a68386

…nore numBytes that can be != 0

adamsitnik added the area-System.IO label Aug 11, 2021

adamsitnik added this to the 6.0.0 milestone Aug 11, 2021

adamsitnik requested review from stephentoub and jozkee August 11, 2021 18:38

adamsitnik requested a review from carlossanlop August 11, 2021 18:40

stephentoub approved these changes Aug 11, 2021

View reviewed changes

adamsitnik added the auto-merge label Aug 11, 2021

carlossanlop approved these changes Aug 11, 2021

View reviewed changes

danmoseley reviewed Aug 11, 2021

View reviewed changes

....CoreLib/src/Microsoft/Win32/SafeHandles/SafeFileHandle.OverlappedValueTaskSource.Windows.cs Show resolved Hide resolved

jozkee mentioned this pull request Aug 11, 2021

PhysicalFileProvider: Avoid NullRef if ResolveLinkTarget returns null #57235

Merged

carlossanlop merged commit d839aac into dotnet:main Aug 11, 2021

carlossanlop deleted the numBytesIsNotAlwaysZeroOnError branch August 11, 2021 23:06

ghost locked as resolved and limited conversation to collaborators Sep 11, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

when async operation fails with ERROR_OPERATION_ABORTED, we should ignore numBytes that can be != 0 #57229

when async operation fails with ERROR_OPERATION_ABORTED, we should ignore numBytes that can be != 0 #57229

adamsitnik commented Aug 11, 2021

ghost commented Aug 11, 2021

ghost commented Aug 11, 2021

carlossanlop left a comment

carlossanlop Aug 11, 2021

carlossanlop commented Aug 11, 2021

when async operation fails with ERROR_OPERATION_ABORTED, we should ignore numBytes that can be != 0 #57229

when async operation fails with ERROR_OPERATION_ABORTED, we should ignore numBytes that can be != 0 #57229

Conversation

adamsitnik commented Aug 11, 2021

ghost commented Aug 11, 2021

ghost commented Aug 11, 2021

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (@msftbot) and give me an instruction to get started! Learn more here.

carlossanlop left a comment

Choose a reason for hiding this comment

carlossanlop Aug 11, 2021

Choose a reason for hiding this comment

carlossanlop commented Aug 11, 2021

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (`@msftbot`) and give me an instruction to get started! Learn more here.