Using `GetFileInformationByName` in Windows for file stat/metadata operations
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 119k
- Forks
- 16.1k
- PR merge metrics
- PR metrics pending
Description
Continuing discussion from https://github.com/rust-lang/rust/pull/128256...
Currently, window's fs.rs uses the GetFileInformationByHandle api which requires opening and closing a file handle. A new API will be available in future builds of Windows (from documentation it should be around 24H2/26052) called GetFileInformationByName which does not require opening a file handle. This reduces 2-3 syscalls in this code path which can have a reasonable performance gain.
There are a few design considerations however,
- Not all file-system drivers support this API, for example FAT32
- Backwards compatibility stops at 1709, i.e. (basically this feature would be
#[cfg(not(target_vendor = "win7")] )
Currently, this change would support tier-1 support for https://github.com/rust-lang/rust/issues/121478 since it includes all the fields needed in one call. In addition to removing the additional syscall for handling reparse points.
Prior Art:
- https://github.com/libuv/libuv/pull/4327
- https://github.com/python/cpython/commit/0f175766e27642108c65bba04bbd54dcf8799b0e
Links:
- GetInformationByHandle - https://learn.microsoft.com/windows/win32/api/winbase/nf-winbase-getfileinformationbyname
- Blog post - https://blogs.windows.com/windows-insider/2024/02/08/announcing-windows-11-insider-preview-build-26052-canary-and-dev-channels/
cc: @ChrisDenton
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in Windows fs.rs and read the discussion in PR 128256, then compare the libuv and CPython prior art and the Windows API documentation linked in the issue. The work is complete when file stat/metadata operations use GetFileInformationByName where supported while preserving compatibility for older Windows builds and file-system drivers that lack the API.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- operating-systems
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100