Skip to content

add initial version of the planning document #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
adamsitnik wants to merge 8 commits into from
Closed

add initial version of the planning document #3

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
94a639f
add initial version of the planning document
adamsitnik Feb 8, 2021
ac7f49c
change priorities based on an offline discussion
adamsitnik Feb 8, 2021
e0bcda8
add Planning
adamsitnik Feb 9, 2021
3da8076
update TOC
adamsitnik Feb 9, 2021
107a973
I forgot about the header
adamsitnik Feb 9, 2021
cb235fc
custom anchors id test
adamsitnik Feb 12, 2021
ab0ab31
use anchors everywhere to simpify the IDs and make it easier to modif…
adamsitnik Feb 12, 2021
d61850d
update the planning document based on feedback from the last meeting
adamsitnik Feb 25, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
update the planning document based on feedback from the last meeting
  • Loading branch information
@adamsitnik
adamsitnik committed Feb 25, 2021
commit d61850dabc1feb0697feb9bf6d4c103d048ea7fa
32 changes: 18 additions & 14 deletions src/libraries/System.IO.FileSystem/FileStreamRewrite.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@
+ [SetCreationTime, SetLastAccessTime, SetLastWriteTime Should not open a new stream to obtain a SafeFileHandle](#20234)
+ [Support SeBackupPrivilege in System.IO.Filestream API](#27086)
- [Priorities](#priorities)
* [Must have](#must-have)
* [Great to have](#great-to-have)
* [Nice to have](#nice-to-have)
* [P0](#p0)
* [P1](#p1)
* [P2](#p2)
* [Future](#future)
- [Planning](#planning)

Expand Down Expand Up @@ -410,7 +410,9 @@ TODO: It needs further triage, but from a quick look it seems that the request i

Suggested work items (grouped and ordered by context, should be independent from each other):

### Must have
### P0

> Anything that includes a new API is not must have

* Gather API usage statistics and get a good understanding of how `FileStream` is used by our customers
* Introduce new abstraction layer and choose file strategy at runtime
Expand All @@ -420,43 +422,45 @@ Suggested work items (grouped and ordered by context, should be independent from
* [#27047](#27047) ReadAsync is slow: [#16354](#16354) and [#16341](#16341) and some additional profiling
* [#25905](#25905) FileStream.Windows useAsync WriteAsync calls blocking apis
* [#27643](#27643) FileStream.FlushAsync ends up doing synchronous writes
* File size preallocation:
* [#29666](#29666) File allocation inconsistency between Windows and Linux and sparse allocations (**possible breaking changes**)
* [#45946](#45946) FileStream file preallocation performance (**new API**)
* [#23196](#23196) File.WriteAllTextAsync performance issues (using the API from above and possibly tuning asyn Unix implementation)
* Linux:
* [#23196](#23196) File.WriteAllTextAsync performance issues
* add more `File` microbenchmarks (`File.ReadAll*`, `File.WriteAll*`, `File.CopyTo*`, `File.Open`)
* Memory allocations
* [#15088](#15088) Avoid unnecessary allocations when using FileStream (**new API**)
* Memory Profiling
* Stephen `IValueTaskSource` suggestion
* **Validation of new implementation with Windows Performance Team**
* **Blog post**
* **Best practices doc**
* check all existing code examples, make sure we recommend the best solutions

### Great to have
### P1

* Memory allocations
* [#15088](#15088) Avoid unnecessary allocations when using FileStream (**new API**)
* File size preallocation:
* [#29666](#29666) File allocation inconsistency between Windows and Linux and sparse allocations (**possible breaking changes**)
* [#45946](#45946) FileStream file preallocation performance (**new API**)
* Opening FileStream in async way (user experience improvement):
* [#25314](#25314) Do we need `File.OpenAsync`? Do we have a bug or the current behaviour is expected?
* [#24698](#24698) Add new APIs that allow for opening file for async IO (**new API**)
* we should start the API review process as soon as possible
* Trully asynchronous File IO on Windows:
* [#25074](#25074) micro optimization suggestion

### Nice to have
### P2

* Cancellation support
* [#1606](#1606) "Fully support cancellation on all FileStream operations that take CancellationToken"
* [#24052](#24052) "Linux: unable to cancel async read of /dev/input/input0 file"
* [#28583](#28583) "proc.StandardOutput.ReadAsync doesn't cancel properly if no output is sent from the process"
* Trully asynchronous File IO on Windows:
* [#24847](#24847) feature request (Async File IO APIs mimicking Win32 OVERLAPPED)
* #27408 NoBuffering:
* very likely to get rejected, but we need to understand customer needs first
* dependent on #33244 and #27146 which might add APIs for aligned memory allocation

### Future

* #27408 NoBuffering:
* very likely to get rejected, but we need to understand customer needs first
* dependent on #33244 and #27146 which might add APIs for aligned memory allocation
* #20234 New APIs for SetCreationTime, SetLastAccessTime, SetLastWriteTime etc
* #27086 Support SeBackupPrivilege in System.IO.Filestream API
* Locking:
Expand Down