minimal dirfd implementation (1/4) #146341

Qelxiros · 2025-09-08T17:32:07Z

This is the first of four smaller PRs that will eventually be equivalent to #139514.

A few notes:

I renamed new to open because open_dir takes &self and opens a subdirectory.
- I also renamed open to open_file.
I'm not sure how to impl AsRawFd and friends because the common implementation uses PathBufs. How should I proceed here?

The other PRs will be based on this one, so I'll make drafts and mark them ready as their predecessors get merged. They might take a bit though; I've never done this particular thing with git before.

Tracking issue: #120426

r? @tgross35

try-job: aarch64-apple
try-job: dist-various*
try-job: test-various*
try-job: x86_64-msvc-1
try-job: x86_64-mingw*

library/std/src/sys/fs/common.rs

library/std/src/sys/fs/uefi.rs

library/std/src/sys/fs/unsupported.rs

library/std/src/fs.rs

library/std/src/sys/fs/windows.rs

tgross35 · 2025-09-10T03:01:20Z

@ChrisDenton I'll need your help for the Windows review

library/std/src/sys/fs/unix.rs

Qelxiros · 2025-09-10T17:19:09Z

@rustbot ready

tgross35

Looks pretty good to me, just a few mechanical things here. There are a couple left over from the previous review, #146341 (comment), #146341 (comment), and (newly) #146341 (comment).

View changes since this review

library/std/src/sys/fs/unix/dir.rs

library/std/src/sys/fs/unsupported.rs

library/std/src/sys/fs/unix.rs

library/std/src/sys/fs/windows.rs

library/std/src/sys/fs/unix.rs

library/std/src/sys/fs/windows/dir.rs

tgross35 · 2025-09-10T21:19:14Z

library/std/src/sys/fs/windows/dir.rs

+    let mut handle = ptr::null_mut();
+    let mut io_status = c::IO_STATUS_BLOCK::PENDING;
+    let access = opts.get_access_mode()? | c::SYNCHRONIZE;
+    let options = create_options | c::FILE_SYNCHRONOUS_IO_NONALERT;


Could you add a note about why this flag is set?

I no longer remember why I chose this one, and looking at it now, I'm not sure whether we should set this one, FILE_SYNCHRONOUS_IO_ALERT, or neither. Maybe @ChrisDenton has thoughts?

Update, using neither causes an error, so I've added back FILE_SYNCHRONOUS_IO_NONALERT

Yeah, passing this flag is equivalent to not passing FILE_FLAG_OVERLAPPED to CreateFile. So if you don't pass this flag, other APIs using the handle need to follow the usual overlapped rules, otherwise they may behave improperly.

tgross35 · 2025-09-10T21:24:27Z

From the top post:

* I'm not sure how to `impl AsRawFd` and friends because the `common` implementation uses `PathBuf`s. How should I proceed here?

I think it would be fine to include the impl AsRawFd only in unix/dir so it's only implemented if we have dirfd. I'll add an unresolved question to the tracking issue.

The other PRs will be based on this one, so I'll make drafts and mark them ready as their predecessors get merged. They might take a bit though; I've never done this particular thing with git before.

That is quite alright, there is no hurry :) For reference, the --update-refs rebase flag can be pretty useful when you're working with a stack (e.g. https://andrewlock.net/working-with-stacked-branches-in-git-is-easier-with-update-refs/)

minimal dirfd implementation (1/4) try-job: aarch64-apple try-job: dist-various* try-job: test-various* try-job: x86_64-msvc* try-job: x86_64-mingw

minimal dirfd implementation (1/4) try-job: aarch64-apple try-job: dist-various* try-job: test-various* try-job: x86_64-msvc* try-job: x86_64-mingw*

minimal dirfd implementation (1/4) try-job: aarch64-apple try-job: dist-various* try-job: test-various* try-job: x86_64-msvc-1 try-job: x86_64-mingw*

rust-bors · 2025-09-15T23:24:01Z

☀️ Try build successful (CI)
Build commit: 6864db0 (6864db0e62c9a69c5b6b3a45634c65cedb96ff25, parent: f3fd3efe4f698ad9dc2ccd6b46a3b07e1bc911da)

tgross35 · 2025-09-19T07:03:54Z

library/std/src/fs/tests.rs

 use crate::test_helpers::{TempDir, tmpdir};
 use crate::time::{Duration, Instant, SystemTime};
-use crate::{env, str, thread};
+use crate::{env, io, str, thread};


io needs the cfg(not(miri)) gate as well

tgross35 · 2025-09-19T07:10:37Z

Status update: the current implementation looks pretty good to me, but I'd Chris or somebody more familiar with Windows to take a look at that bit.

It would still be good to add comments about the flags used to make the incantation a bit less magic without referring to the docs (e.g. FILE_SYNCHRONOUS_IO_NONALERT, FILE_FLAG_BACKUP_SEMANTICS).

tgross35 · 2025-09-24T04:51:29Z

@ChrisDenton would you be able to take a look at the windows impl here? Feel free to punt this bit to somebody else as well, just needs a second set of eyes since I'm not super familiar here.

Qelxiros · 2025-10-06T19:07:33Z

@ChrisDenton friendly ping

tgross35 · 2025-10-15T07:37:11Z

Heya @wesleywiser or @dpaoliello would one of you mind giving a quick look at the Windows bits here? To me it looks pretty reasonable, but I'm not very familiar with the winternl APIs so would appreciate a sanity check.

dpaoliello · 2025-10-15T22:58:56Z

I'll see if I can find an expert to help. I'm not familiar enough with these APIs to have any confidence reviewing.

neerajsi-msft

Looks reasonable.

View changes since this review

neerajsi-msft · 2025-10-16T17:15:42Z

library/std/src/sys/pal/windows/c/windows_sys.rs

 windows_targets::link!("ntdll.dll" "system" fn NtCreateFile(filehandle : *mut HANDLE, desiredaccess : FILE_ACCESS_RIGHTS, objectattributes : *const OBJECT_ATTRIBUTES, iostatusblock : *mut IO_STATUS_BLOCK, allocationsize : *const i64, fileattributes : FILE_FLAGS_AND_ATTRIBUTES, shareaccess : FILE_SHARE_MODE, createdisposition : NTCREATEFILE_CREATE_DISPOSITION, createoptions : NTCREATEFILE_CREATE_OPTIONS, eabuffer : *const core::ffi::c_void, ealength : u32) -> NTSTATUS);
 windows_targets::link!("ntdll.dll" "system" fn NtOpenFile(filehandle : *mut HANDLE, desiredaccess : u32, objectattributes : *const OBJECT_ATTRIBUTES, iostatusblock : *mut IO_STATUS_BLOCK, shareaccess : u32, openoptions : u32) -> NTSTATUS);
 windows_targets::link!("ntdll.dll" "system" fn NtReadFile(filehandle : HANDLE, event : HANDLE, apcroutine : PIO_APC_ROUTINE, apccontext : *const core::ffi::c_void, iostatusblock : *mut IO_STATUS_BLOCK, buffer : *mut core::ffi::c_void, length : u32, byteoffset : *const i64, key : *const u32) -> NTSTATUS);
+windows_targets::link!("ntdll.dll" "system" fn NtSetInformationFile(filehandle : HANDLE, iostatusblock : *mut IO_STATUS_BLOCK, fileinformation : *const core::ffi::c_void, length : u32, fileinformationclass : FILE_INFORMATION_CLASS) -> NTSTATUS);


nit: These changes to expose the NT rename APIs don't seem to be necessary for this PR. They probably should go in a later PR in the series.

bors · 2025-10-18T10:33:49Z

☔ The latest upstream changes (presumably #147838) made this pull request unmergeable. Please resolve the merge conflicts.

tgross35 · 2025-10-20T17:56:45Z

For the suggestion above and a rebase,

@rustbot author

rustbot · 2025-10-20T17:56:49Z

Reminder, once the PR becomes ready for a review, use @rustbot ready.

rustbot · 2025-10-20T18:27:10Z

This PR was rebased onto a different master commit. Here's a range-diff highlighting what actually changed.

Rebasing is a normal part of keeping PRs up to date, so no action is needed—this note is just to help reviewers.

Qelxiros · 2025-10-20T18:28:38Z

@rustbot ready

tgross35 · 2025-10-20T19:00:21Z

@bors2 try

minimal dirfd implementation (1/4) try-job: aarch64-apple try-job: dist-various* try-job: test-various* try-job: x86_64-msvc-1 try-job: x86_64-mingw*

rust-log-analyzer · 2025-10-20T21:05:05Z

The job x86_64-msvc-1 failed! Check out the build log: (web) (plain enhanced) (plain)

Click to see the possible cause of the failure (guessed by this bot)

failures:

---- fs::tests::test_dir_read_file stdout ----

thread 'fs::tests::test_dir_read_file' (7252) panicked at library\std\src\fs\tests.rs:2472:13:
dir.open_file("foo.txt") failed with: The filename, directory name, or volume label syntax is incorrect. (os error 123)
stack backtrace:
   0: __rustc::rust_begin_unwind
   1: core::panicking::panic_fmt
   2: <&T as core::fmt::Debug>::fmt
   3: test::convert_benchmarks_to_tests
---

error: test failed, to rerun pass `-p std --lib`
Bootstrap failed while executing `test --stage 2 --skip=compiler --skip=src`
Build completed unsuccessfully in 1:54:29
make: *** [Makefile:112: ci-msvc-py] Error 1
  local time: Mon Oct 20 21:04:36 CUT 2025
  network time: Mon, 20 Oct 2025 21:04:50 GMT
##[error]Process completed with exit code 2.
##[group]Run echo "disk usage:"
echo "disk usage:"

rust-bors · 2025-10-20T21:05:38Z

💔 Test for 7d804a8 failed: CI. Failed jobs:

try - x86_64-msvc-1 (web logs, extended logs)

rustbot assigned tgross35 Sep 8, 2025

rustbot added O-windows Operating system: Windows S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-libs Relevant to the library team, which will review and decide on the PR/issue. labels Sep 8, 2025

Qelxiros force-pushed the dirfd-minimum branch from c3278f6 to 6982a46 Compare September 8, 2025 17:37

This comment has been minimized.

Sign in to view

Qelxiros force-pushed the dirfd-minimum branch from 6982a46 to 313c731 Compare September 8, 2025 18:26

This comment has been minimized.

Sign in to view

Qelxiros force-pushed the dirfd-minimum branch from 313c731 to 1b3d7d6 Compare September 8, 2025 18:55

This comment has been minimized.

Sign in to view

Qelxiros force-pushed the dirfd-minimum branch from 1b3d7d6 to be0d761 Compare September 9, 2025 15:09

tgross35 requested changes Sep 10, 2025

View reviewed changes

rustbot added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Sep 10, 2025

tgross35 requested a review from ChrisDenton September 10, 2025 03:01

Qelxiros force-pushed the dirfd-minimum branch from be0d761 to 3083d58 Compare September 10, 2025 17:17

Qelxiros commented Sep 10, 2025

View reviewed changes

library/std/src/sys/fs/unix.rs Outdated Show resolved Hide resolved

rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Sep 10, 2025

tgross35 reviewed Sep 10, 2025

View reviewed changes

This comment was marked as outdated.

Sign in to view

rust-bors bot added a commit that referenced this pull request Sep 10, 2025

Auto merge of #146341 - Qelxiros:dirfd-minimum, r=<try>

0ac54d6

minimal dirfd implementation (1/4) try-job: aarch64-apple try-job: dist-various* try-job: test-various* try-job: x86_64-msvc* try-job: x86_64-mingw

This comment has been minimized.

Sign in to view

This comment was marked as outdated.

Sign in to view

rust-bors bot added a commit that referenced this pull request Sep 10, 2025

Auto merge of #146341 - Qelxiros:dirfd-minimum, r=<try>

ba649e4

minimal dirfd implementation (1/4) try-job: aarch64-apple try-job: dist-various* try-job: test-various* try-job: x86_64-msvc* try-job: x86_64-mingw*

rust-bors bot added a commit that referenced this pull request Sep 15, 2025

Auto merge of #146341 - Qelxiros:dirfd-minimum, r=<try>

6864db0

minimal dirfd implementation (1/4) try-job: aarch64-apple try-job: dist-various* try-job: test-various* try-job: x86_64-msvc-1 try-job: x86_64-mingw*

Qelxiros force-pushed the dirfd-minimum branch from a37578d to cfbcd8b Compare September 15, 2025 21:36

tgross35 reviewed Sep 19, 2025

View reviewed changes

Qelxiros force-pushed the dirfd-minimum branch from cfbcd8b to 18a93b3 Compare September 19, 2025 15:29

neerajsi-msft approved these changes Oct 16, 2025

View reviewed changes

rustbot added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Oct 20, 2025

Qelxiros force-pushed the dirfd-minimum branch from 18a93b3 to 70ea0df Compare October 20, 2025 18:19

This comment has been minimized.

Sign in to view

Qelxiros force-pushed the dirfd-minimum branch from 70ea0df to fedd376 Compare October 20, 2025 18:27

Add Dir::open(_file) and some trait impls

1624481

Qelxiros force-pushed the dirfd-minimum branch from fedd376 to 1624481 Compare October 20, 2025 18:28

rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Oct 20, 2025

rust-bors bot added a commit that referenced this pull request Oct 20, 2025

Auto merge of #146341 - Qelxiros:dirfd-minimum, r=<try>

7d804a8

minimal dirfd implementation (1/4) try-job: aarch64-apple try-job: dist-various* try-job: test-various* try-job: x86_64-msvc-1 try-job: x86_64-mingw*

This comment has been minimized.

Sign in to view

minimal dirfd implementation (1/4) #146341

Are you sure you want to change the base?

minimal dirfd implementation (1/4) #146341

Conversation

Qelxiros commented Sep 8, 2025 • edited by tgross35 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tgross35 commented Sep 10, 2025

Uh oh!

Uh oh!

Qelxiros commented Sep 10, 2025

Uh oh!

tgross35 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tgross35 Sep 10, 2025

Choose a reason for hiding this comment

Uh oh!

Qelxiros Sep 11, 2025

Choose a reason for hiding this comment

Uh oh!

Qelxiros Sep 15, 2025

Choose a reason for hiding this comment

Uh oh!

neerajsi-msft Oct 20, 2025

Choose a reason for hiding this comment

Uh oh!

tgross35 commented Sep 10, 2025

Uh oh!

This comment was marked as outdated.

This comment has been minimized.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

rust-bors bot commented Sep 15, 2025

Uh oh!

tgross35 Sep 19, 2025

Choose a reason for hiding this comment

Uh oh!

tgross35 commented Sep 19, 2025

Uh oh!

tgross35 commented Sep 24, 2025

Uh oh!

Qelxiros commented Oct 6, 2025

Uh oh!

tgross35 commented Oct 15, 2025

Uh oh!

dpaoliello commented Oct 15, 2025

Uh oh!

neerajsi-msft left a comment • edited by rustbot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

neerajsi-msft Oct 16, 2025

Choose a reason for hiding this comment

Uh oh!

bors commented Oct 18, 2025

Uh oh!

tgross35 commented Oct 20, 2025

Qelxiros commented Sep 8, 2025 •

edited by tgross35

Loading

tgross35 left a comment •

edited

Loading

neerajsi-msft left a comment •

edited by rustbot

Loading