Implement file_lock feature #130999

cberner · 2024-09-28T23:06:07Z

This adds lock(), lock_shared(), try_lock(), try_lock_shared(), and unlock() to File gated behind the file_lock feature flag

This is the initial implementation of #130994 for Unix and Windows platforms. I will follow it up with an implementation for WASI preview 2

rustbot · 2024-09-28T23:06:15Z

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @joboet (or someone else) some time within the next two weeks.

Please see the contribution instructions for more information. Namely, in order to ensure the minimum review times lag, PR authors and assigned reviewers should ensure that the review label (S-waiting-on-review and S-waiting-on-author) stays updated, invoking these commands when appropriate:

@rustbot author: the review is finished, PR author should check the comments and take action accordingly
@rustbot review: the author is ready for a review, this PR will be queued again in the reviewer's queue

Noratrieb · 2024-09-29T08:27:00Z

Thank you for the PR! This PR contains a public library API change, which should follow the proper process of creating an ACP first: https://std-dev-guide.rust-lang.org/development/feature-lifecycle.html
Use @rustbot ready when your ACP has been accepeted.
@rustbot author

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

deltragon · 2024-09-29T10:29:11Z

@Noratrieb If I understand correctly, this already has an accepted ACP in rust-lang/libs-team#412

cberner · 2024-09-29T18:26:58Z

@ChrisDenton ah thanks! I changed it

@Noratrieb Yep, it has already been accepted in rust-lang/libs-team#412

cberner · 2024-09-29T18:27:38Z

@rustbot ready

library/std/src/fs.rs

bjorn3 · 2024-09-29T19:17:10Z

Should this document which exact mechanism is used on each platform? I believe some platforms have multiple advisory lock mechanisms that don't affect each other. On such platforms switching mechanism in a future rust version would prevent the locks from being effective if you ever mix binaries compiled using different rustc versions.

cberner · 2024-09-29T20:00:13Z

Should this document which exact mechanism is used on each platform? I believe some platforms have multiple advisory lock mechanisms that don't affect each other. On such platforms switching mechanism in a future rust version would prevent the locks from being effective if you ever mix binaries compiled using different rustc versions.

Ah yes, good idea. I added that

bjorn3 · 2024-09-29T21:23:04Z

library/std/src/fs.rs

+    ///
+    /// This function currently corresponds to the `flock` function on Unix with the `LOCK_EX` flag,
+    /// and the `LockFileEx` function on Windows with the `LOCKFILE_EXCLUSIVE_LOCK` flag. Note that,
+    /// this [may change in the future][changes].


It must not change for programs compiled with different rustc versions to interoperate wrt locking, right?

I included may change in the future because that language is used in all the other places that Platform-specific behavior is documented, that I could find. Is there guidance on when to include or not include it?

It seems appropriate to include it to me, because the implementation can be changed and still interoperate. For example, LockFile can be called instead of LockFileEx in the case of lock() and lock_shared(). Similarly, you can imagine that a new syscall might be added to Unix and/or Windows which can be used as an alternative.

cberner · 2024-10-11T00:33:25Z

Just wanted to check in on this PR. @bjorn3 , @ChrisDenton anything I can do to help move it forward?

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

rustbot · 2024-10-13T23:01:58Z

These commits modify the library/Cargo.lock file. Unintentional changes to library/Cargo.lock can be introduced when switching branches and rebasing PRs.

If this was unintentional then you should revert the changes before this PR is merged.
Otherwise, you can ignore this comment.

This adds lock(), lock_shared(), try_lock(), try_lock_shared(), and unlock() to File gated behind the file_lock feature flag

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

cberner · 2024-11-08T04:12:16Z

Hey @joboet just wanted to checkin on this PR. Any additional changes/tests you'd like to see?

joboet

Sorry for the delay. This looks mostly fine!

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

Co-authored-by: Jonas Böttiger <[email protected]>

cberner · 2024-11-08T17:41:31Z

@joboet no worries, thanks for the comments! I've addressed them

joboet · 2024-11-11T13:58:13Z

Great, thank you!
@bors r+

bors · 2024-11-11T13:58:16Z

📌 Commit 9330786 has been approved by joboet

It is now in the queue for this repository.

…iaskrgr Rollup of 4 pull requests Successful merges: - rust-lang#129627 (Ensure that tail expr receive lifetime extension) - rust-lang#130999 (Implement file_lock feature) - rust-lang#132873 (handle separate prefixes in clippy rules) - rust-lang#132891 (Remove `rustc_session::config::rustc_short_optgroups`) r? `@ghost` `@rustbot` modify labels: rollup

Rollup merge of rust-lang#130999 - cberner:flock_pr, r=joboet Implement file_lock feature This adds lock(), lock_shared(), try_lock(), try_lock_shared(), and unlock() to File gated behind the file_lock feature flag This is the initial implementation of rust-lang#130994 for Unix and Windows platforms. I will follow it up with an implementation for WASI preview 2

Implement file_lock feature This adds lock(), lock_shared(), try_lock(), try_lock_shared(), and unlock() to File gated behind the file_lock feature flag This is the initial implementation of rust-lang#130994 for Unix and Windows platforms. I will follow it up with an implementation for WASI preview 2

…iaskrgr Rollup of 4 pull requests Successful merges: - rust-lang#129627 (Ensure that tail expr receive lifetime extension) - rust-lang#130999 (Implement file_lock feature) - rust-lang#132873 (handle separate prefixes in clippy rules) - rust-lang#132891 (Remove `rustc_session::config::rustc_short_optgroups`) r? `@ghost` `@rustbot` modify labels: rollup

rustbot assigned joboet Sep 28, 2024

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 29, 2024

ChrisDenton reviewed Sep 29, 2024

View reviewed changes

library/std/src/sys/pal/windows/c/windows_sys.rs Outdated Show resolved Hide resolved

cberner force-pushed the flock_pr branch from 6f55492 to 8aa6334 Compare September 29, 2024 18:27

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 29, 2024

bjorn3 reviewed Sep 29, 2024

View reviewed changes

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

bjorn3 reviewed Sep 29, 2024

View reviewed changes

library/std/src/fs.rs Show resolved Hide resolved

cberner force-pushed the flock_pr branch from 8aa6334 to cfad3d5 Compare September 29, 2024 19:59

bjorn3 reviewed Sep 29, 2024

View reviewed changes

joboet reviewed Oct 13, 2024

View reviewed changes

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

cberner force-pushed the flock_pr branch 2 times, most recently from 2744f79 to 84982e5 Compare October 13, 2024 23:01

Implement file_lock feature

d2cdc76

This adds lock(), lock_shared(), try_lock(), try_lock_shared(), and unlock() to File gated behind the file_lock feature flag

cberner force-pushed the flock_pr branch from 84982e5 to d2cdc76 Compare October 13, 2024 23:17

joboet reviewed Oct 18, 2024

View reviewed changes

library/std/src/sys/pal/windows/fs.rs Show resolved Hide resolved

Support lock() and lock_shared() on async IO Files

e0fdaa8

cberner requested a review from joboet November 8, 2024 04:11

joboet requested changes Nov 8, 2024

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 Nov 8, 2024

cberner and others added 2 commits November 8, 2024 08:09

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

5a156a7

Co-authored-by: Jonas Böttiger <[email protected]>

Address review comments

9330786

cberner requested a review from joboet November 8, 2024 17:41

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 Nov 8, 2024

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Nov 11, 2024

matthiaskrgr mentioned this pull request Nov 11, 2024

Rollup of 4 pull requests #132902

Merged

bors merged commit 95175f8 into rust-lang:master Nov 11, 2024
6 checks passed

rustbot added this to the 1.84.0 milestone Nov 11, 2024

psumbera mentioned this pull request Nov 11, 2024

Rust build fails on Solaris after: Implement file_lock feature #132921

Open

cberner mentioned this pull request Nov 13, 2024

Fix compilation error on Solaris due to flock usage #132977

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement file_lock feature #130999

Implement file_lock feature #130999

cberner commented Sep 28, 2024

rustbot commented Sep 28, 2024

Noratrieb commented Sep 29, 2024

deltragon commented Sep 29, 2024

cberner commented Sep 29, 2024

cberner commented Sep 29, 2024

bjorn3 commented Sep 29, 2024

cberner commented Sep 29, 2024

bjorn3 Sep 29, 2024

cberner Sep 29, 2024

cberner commented Oct 11, 2024

rustbot commented Oct 13, 2024

cberner commented Nov 8, 2024

joboet left a comment

cberner commented Nov 8, 2024

joboet commented Nov 11, 2024

bors commented Nov 11, 2024

Implement file_lock feature #130999

Implement file_lock feature #130999

Conversation

cberner commented Sep 28, 2024

rustbot commented Sep 28, 2024

Noratrieb commented Sep 29, 2024

deltragon commented Sep 29, 2024

cberner commented Sep 29, 2024

cberner commented Sep 29, 2024

bjorn3 commented Sep 29, 2024

cberner commented Sep 29, 2024

bjorn3 Sep 29, 2024

Choose a reason for hiding this comment

cberner Sep 29, 2024

Choose a reason for hiding this comment

cberner commented Oct 11, 2024

rustbot commented Oct 13, 2024

cberner commented Nov 8, 2024

joboet left a comment

Choose a reason for hiding this comment

cberner commented Nov 8, 2024

joboet commented Nov 11, 2024

bors commented Nov 11, 2024