diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-17 12:02:58 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-17 12:02:58 +0000 |
commit | 698f8c2f01ea549d77d7dc3338a12e04c11057b9 (patch) | |
tree | 173a775858bd501c378080a10dca74132f05bc50 /vendor/fd-lock | |
parent | Initial commit. (diff) | |
download | rustc-698f8c2f01ea549d77d7dc3338a12e04c11057b9.tar.xz rustc-698f8c2f01ea549d77d7dc3338a12e04c11057b9.zip |
Adding upstream version 1.64.0+dfsg1.upstream/1.64.0+dfsg1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'vendor/fd-lock')
25 files changed, 1110 insertions, 0 deletions
diff --git a/vendor/fd-lock/.cargo-checksum.json b/vendor/fd-lock/.cargo-checksum.json new file mode 100644 index 000000000..34474fd2f --- /dev/null +++ b/vendor/fd-lock/.cargo-checksum.json @@ -0,0 +1 @@ +{"files":{"Cargo.toml":"8a0f86066c7666bf8979819be2020a5e21b80507518e1b75a09520a0168184d5","LICENSE-APACHE":"b00ec75cd7ef2a62ff1f26c0ddafbc508282d15dce149506f983ce6c8e7a4876","LICENSE-MIT":"ce688e08d0454a032063ff701c4e88051ed89f0c5c9c391cbe58e4099769ae5d","README.md":"ede6ce06722fa6bc718ef44ba9605ef1ff4f0d13551dfb648f889c2d08826f01","src/lib.rs":"1bb896e8d6be4e0a344132cd3cbfd89b08a8ee84414be2151fe1ecbdba88cb6d","src/read_guard.rs":"09dec78e58bc222b195122158c0164f5b03a0bbf4beebff3a9dfa6171cd3919b","src/rw_lock.rs":"a5360aba83a03e25d7fee58b4e56ce8e18aaa360f6458a7b45b4a9af8fc85f4f","src/sys/mod.rs":"af808ccf3e9a2e480b2113915a9018bc5698b1156eec16ced69131ff22010a04","src/sys/unix/mod.rs":"af44a486cd53b0367b2466cf4e4240ad9ebfb77274ed7dd73a8b722be9f1fb0d","src/sys/unix/read_guard.rs":"debf4cbdbbbf5d1f31b2f420e7ef85cadb56d5d63b6be0101ff60970aa23af4d","src/sys/unix/rw_lock.rs":"695cf947892b4f6cf24ed80151d485edfc3ae48d1111df7e028f1590000ce1cd","src/sys/unix/write_guard.rs":"8b1249e51aba8e6812277856cb449e27433ff14c1e761c53e43a4fc81d79324d","src/sys/unsupported/mod.rs":"da50072981243d69b2f3cd43d0d314184d9fe32f4d1f83f9d65ffa56be591d35","src/sys/unsupported/read_guard.rs":"996e4137fd5f6a4ee586d3988f399c01886a4ff517caf605b0b15b15ec1d1921","src/sys/unsupported/rw_lock.rs":"0ab0291a20cd802099e9330140ad81778f60656185df1b3bd35b1aaabcd3476d","src/sys/unsupported/utils.rs":"c0c608a32b8686f4242d3639b8d490efcfbc2385910f369e1dac741fb173e83d","src/sys/unsupported/write_guard.rs":"b2c02e43c4a939370a65ec33b949246d4486118631e1178b79d8d8c83fc59d13","src/sys/windows/mod.rs":"299c760cfd51ac2905750b29ae9662fb5c637ad43edd7f0d738955d52002faa3","src/sys/windows/read_guard.rs":"67789ae766d2e29688f1e580bccb1bd49cb046462f5b88d6cc7f5519a67d261f","src/sys/windows/rw_lock.rs":"715da53c6593d56d94e1ebd901369c7036e21ae5d43d1bea466cc289e869ecc8","src/sys/windows/utils.rs":"908f71e686f835ccddfb338fdea22e56b58685a6b90036aea60bcfa693d19f39","src/sys/windows/write_guard.rs":"e8bce84cb22476cc3468f45a278260b6299f753c91174f702cfeb86aa358f0b6","src/write_guard.rs":"67a8f4328620f2f4f5f373115cad1cb6372e56a841480f67d6a96bf6a151a9cc","tests/test.rs":"a4ac6ed7ca76556da0e324bf32b4f47dde15b9c818963f7a88f41e07bc72994b"},"package":"e11dcc7e4d79a8c89b9ab4c6f5c30b1fc4a83c420792da3542fd31179ed5f517"}
\ No newline at end of file diff --git a/vendor/fd-lock/Cargo.toml b/vendor/fd-lock/Cargo.toml new file mode 100644 index 000000000..81e663819 --- /dev/null +++ b/vendor/fd-lock/Cargo.toml @@ -0,0 +1,53 @@ +# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO +# +# When uploading crates to the registry Cargo will automatically +# "normalize" Cargo.toml files for maximal compatibility +# with all versions of Cargo and also rewrite `path` dependencies +# to registry (e.g., crates.io) dependencies. +# +# If you are reading this file be aware that the original Cargo.toml +# will likely look very different (and much more reasonable). +# See Cargo.toml.orig for the original contents. + +[package] +edition = "2018" +name = "fd-lock" +version = "3.0.6" +authors = ["Yoshua Wuyts <yoshuawuyts@gmail.com>"] +description = "Advisory cross-platform lock on a file using a file descriptor to it." +documentation = "https://docs.rs/fd-lock" +readme = "README.md" +keywords = [ + "file", + "fd", + "lock", + "windows", + "unix", +] +categories = [ + "filesystem", + "os", + "os::macos-apis", + "os::unix-apis", + "os::windows-apis", +] +license = "MIT OR Apache-2.0" +repository = "https://github.com/yoshuawuyts/fd-lock" + +[dependencies.cfg-if] +version = "1.0.0" + +[dev-dependencies.tempfile] +version = "3.0.8" + +[target."cfg(unix)".dependencies.rustix] +version = "0.35.6" +features = ["fs"] + +[target."cfg(windows)".dependencies.windows-sys] +version = "0.36.0" +features = [ + "Win32_Foundation", + "Win32_Storage_FileSystem", + "Win32_System_IO", +] diff --git a/vendor/fd-lock/LICENSE-APACHE b/vendor/fd-lock/LICENSE-APACHE new file mode 100644 index 000000000..1fe151fe5 --- /dev/null +++ b/vendor/fd-lock/LICENSE-APACHE @@ -0,0 +1,190 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + Copyright 2019 Yoshua Wuyts + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/vendor/fd-lock/LICENSE-MIT b/vendor/fd-lock/LICENSE-MIT new file mode 100644 index 000000000..645b57f69 --- /dev/null +++ b/vendor/fd-lock/LICENSE-MIT @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2019 Yoshua Wuyts + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/vendor/fd-lock/README.md b/vendor/fd-lock/README.md new file mode 100644 index 000000000..6720153af --- /dev/null +++ b/vendor/fd-lock/README.md @@ -0,0 +1,72 @@ +# fd-lock +[![crates.io version][1]][2] +[![downloads][5]][6] [![docs.rs docs][7]][8] + +Advisory cross-platform file locks using file descriptors. Adapted from +[mafintosh/fd-lock]. + +Note that advisory lock compliance is opt-in, and can freely be ignored by other +parties. This means this crate __should never be used for security purposes__, +but solely to coordinate file access. + +[mafintosh/fd-lock]: https://github.com/mafintosh/fd-lock + +- [Documentation][8] +- [Crates.io][2] +- [Releases][releases] + +## Examples +__Basic usage__ +```rust +use std::io::prelude::*; +use std::fs::File; +use fd_lock::RwLock; + +// Lock a file and write to it. +let mut f = RwLock::new(File::open("foo.txt")?); +write!(f.write()?, "chashu cat")?; + +// A lock can also be held across multiple operations. +let mut f = f.write()?; +write!(f, "nori cat")?; +write!(f, "bird!")?; +``` + +## Installation +```sh +$ cargo add fd-lock +``` + +## Safety +This crate uses `unsafe` on Windows to interface with `windows-sys`. All +invariants have been carefully checked, and are manually enforced. + +## Contributing +Want to join us? Check out our ["Contributing" guide][contributing] and take a +look at some of these issues: + +- [Issues labeled "good first issue"][good-first-issue] +- [Issues labeled "help wanted"][help-wanted] + +## References +- [LockFile function - WDC](https://docs.microsoft.com/en-us/windows/desktop/api/fileapi/nf-fileapi-lockfile) +- [flock(2) - Linux Man Page](https://man7.org/linux/man-pages/man2/flock.2.html) +- [`rustix::fs::flock`](https://docs.rs/rustix/*/rustix/fs/fn.flock.html) +- [`windows_sys::Win32::Storage::FileSystem::LockFile`](https://microsoft.github.io/windows-docs-rs/doc/windows/Win32/Storage/FileSystem/fn.LockFile.html) + +## License +[MIT](./LICENSE-MIT) OR [Apache-2.0](./LICENSE-APACHE) + +[1]: https://img.shields.io/crates/v/fd-lock.svg?style=flat-square +[2]: https://crates.io/crates/fd-lock +[3]: https://img.shields.io/travis/yoshuawuyts/fd-lock/master.svg?style=flat-square +[4]: https://travis-ci.org/yoshuawuyts/fd-lock +[5]: https://img.shields.io/crates/d/fd-lock.svg?style=flat-square +[6]: https://crates.io/crates/fd-lock +[7]: https://img.shields.io/badge/docs-latest-blue.svg?style=flat-square +[8]: https://docs.rs/fd-lock + +[releases]: https://github.com/yoshuawuyts/fd-lock/releases +[contributing]: https://github.com/yoshuawuyts/fd-lock/blob/master.github/CONTRIBUTING.md +[good-first-issue]: https://github.com/yoshuawuyts/fd-lock/labels/good%20first%20issue +[help-wanted]: https://github.com/yoshuawuyts/fd-lock/labels/help%20wanted diff --git a/vendor/fd-lock/src/lib.rs b/vendor/fd-lock/src/lib.rs new file mode 100644 index 000000000..9d3d6192b --- /dev/null +++ b/vendor/fd-lock/src/lib.rs @@ -0,0 +1,43 @@ +//! Advisory reader-writer locks for files. +//! +//! # Notes on Advisory Locks +//! +//! "advisory locks" are locks which programs must opt-in to adhere to. This +//! means that they can be used to coordinate file access, but not prevent +//! access. Use this to coordinate file access between multiple instances of the +//! same program. But do not use this to prevent actors from accessing or +//! modifying files. +//! +//! # Example +//! +//! ```no_run +//! # use std::io; +//! use std::io::prelude::*; +//! use std::fs::File; +//! use fd_lock::RwLock; +//! +//! # fn main() -> io::Result<()> { +//! // Lock a file and write to it. +//! let mut f = RwLock::new(File::open("foo.txt")?); +//! write!(f.write()?, "chashu cat")?; +//! +//! // A lock can also be held across multiple operations. +//! let mut f = f.write()?; +//! write!(f, "nori cat")?; +//! write!(f, "bird!")?; +//! # Ok(()) } +//! ``` + +#![forbid(future_incompatible)] +#![deny(missing_debug_implementations, nonstandard_style)] +#![cfg_attr(doc, warn(missing_docs, rustdoc::missing_doc_code_examples))] + +mod read_guard; +mod rw_lock; +mod write_guard; + +pub(crate) mod sys; + +pub use read_guard::RwLockReadGuard; +pub use rw_lock::RwLock; +pub use write_guard::RwLockWriteGuard; diff --git a/vendor/fd-lock/src/read_guard.rs b/vendor/fd-lock/src/read_guard.rs new file mode 100644 index 000000000..29ed06da3 --- /dev/null +++ b/vendor/fd-lock/src/read_guard.rs @@ -0,0 +1,43 @@ +use std::ops; + +use crate::sys; + +/// RAII structure used to release the shared read access of a lock when +/// dropped. +/// +/// This structure is created by the [`read`] and [`try_read`] methods on +/// [`RwLock`]. +/// +/// [`read`]: crate::RwLock::read +/// [`try_read`]: crate::RwLock::try_read +/// [`RwLock`]: crate::RwLock +/// +/// # Panics +/// +/// Dropping this type may panic if the lock fails to unlock. +#[must_use = "if unused the RwLock will immediately unlock"] +#[derive(Debug)] +pub struct RwLockReadGuard<'lock, T: sys::AsRaw> { + guard: sys::RwLockReadGuard<'lock, T>, +} + +impl<'lock, T: sys::AsRaw> RwLockReadGuard<'lock, T> { + pub(crate) fn new(guard: sys::RwLockReadGuard<'lock, T>) -> Self { + Self { guard } + } +} + +impl<T: sys::AsRaw> ops::Deref for RwLockReadGuard<'_, T> { + type Target = T; + + #[inline] + fn deref(&self) -> &Self::Target { + self.guard.deref() + } +} + +/// Release the lock. +impl<T: sys::AsRaw> Drop for RwLockReadGuard<'_, T> { + #[inline] + fn drop(&mut self) {} +} diff --git a/vendor/fd-lock/src/rw_lock.rs b/vendor/fd-lock/src/rw_lock.rs new file mode 100644 index 000000000..77f9d2231 --- /dev/null +++ b/vendor/fd-lock/src/rw_lock.rs @@ -0,0 +1,126 @@ +use crate::read_guard::RwLockReadGuard; +use crate::sys; +use crate::write_guard::RwLockWriteGuard; +use std::io; + +/// Advisory reader-writer lock for files. +/// +/// This type of lock allows a number of readers or at most one writer at any point +/// in time. The write portion of this lock typically allows modification of the +/// underlying data (exclusive access) and the read portion of this lock typically +/// allows for read-only access (shared access). +#[derive(Debug)] +pub struct RwLock<T: sys::AsRaw> { + lock: sys::RwLock<T>, +} + +impl<T: sys::AsRaw> RwLock<T> { + /// Create a new instance. + /// + /// # Examples + /// + /// ```no_run + /// use fd_lock::RwLock; + /// use std::fs::File; + /// + /// fn main() -> std::io::Result<()> { + /// let mut f = RwLock::new(File::open("foo.txt")?); + /// Ok(()) + /// } + /// ``` + #[inline] + pub fn new(inner: T) -> Self { + Self { + lock: sys::RwLock::new(inner), + } + } + + /// Locks this lock with shared read access, blocking the current thread + /// until it can be acquired. + /// + /// The calling thread will be blocked until there are no more writers which + /// hold the lock. There may be other readers currently inside the lock when + /// this method returns. This method does not provide any guarantees with + /// respect to the ordering of whether contentious readers or writers will + /// acquire the lock first. + /// + /// Returns an RAII guard which will release this thread's shared access + /// once it is dropped. + /// + /// # Errors + /// + /// On Unix this may return an `ErrorKind::Interrupted` if the operation was + /// interrupted by a signal handler. + #[inline] + pub fn read(&self) -> io::Result<RwLockReadGuard<'_, T>> { + let guard = self.lock.read()?; + Ok(RwLockReadGuard::new(guard)) + } + + /// Attempts to acquire this lock with shared read access. + /// + /// If the access could not be granted at this time, then `Err` is returned. + /// Otherwise, an RAII guard is returned which will release the shared access + /// when it is dropped. + /// + /// This function does not block. + /// + /// This function does not provide any guarantees with respect to the ordering + /// of whether contentious readers or writers will acquire the lock first. + /// + /// # Errors + /// + /// If the lock is already held and `ErrorKind::WouldBlock` error is returned. + /// On Unix this may return an `ErrorKind::Interrupted` if the operation was + /// interrupted by a signal handler. + #[inline] + pub fn try_read(&self) -> io::Result<RwLockReadGuard<'_, T>> { + let guard = self.lock.try_read()?; + Ok(RwLockReadGuard::new(guard)) + } + + /// Locks this lock with exclusive write access, blocking the current thread + /// until it can be acquired. + /// + /// This function will not return while other writers or other readers + /// currently have access to the lock. + /// + /// Returns an RAII guard which will drop the write access of this rwlock + /// when dropped. + /// + /// # Errors + /// + /// On Unix this may return an `ErrorKind::Interrupted` if the operation was + /// interrupted by a signal handler. + #[inline] + pub fn write(&mut self) -> io::Result<RwLockWriteGuard<'_, T>> { + let guard = self.lock.write()?; + Ok(RwLockWriteGuard::new(guard)) + } + + /// Attempts to lock this lock with exclusive write access. + /// + /// If the lock could not be acquired at this time, then `Err` is returned. + /// Otherwise, an RAII guard is returned which will release the lock when + /// it is dropped. + /// + /// # Errors + /// + /// If the lock is already held and `ErrorKind::WouldBlock` error is returned. + /// On Unix this may return an `ErrorKind::Interrupted` if the operation was + /// interrupted by a signal handler. + #[inline] + pub fn try_write(&mut self) -> io::Result<RwLockWriteGuard<'_, T>> { + let guard = self.lock.try_write()?; + Ok(RwLockWriteGuard::new(guard)) + } + + /// Consumes this `RwLock`, returning the underlying data. + #[inline] + pub fn into_inner(self) -> T + where + T: Sized, + { + self.lock.into_inner() + } +} diff --git a/vendor/fd-lock/src/sys/mod.rs b/vendor/fd-lock/src/sys/mod.rs new file mode 100644 index 000000000..3c6391e98 --- /dev/null +++ b/vendor/fd-lock/src/sys/mod.rs @@ -0,0 +1,17 @@ +use cfg_if::cfg_if; + +cfg_if! { + if #[cfg(unix)] { + mod unix; + pub use unix::*; + pub(crate) use std::os::unix::prelude::AsRawFd as AsRaw; + } else if #[cfg(windows)] { + mod windows; + pub use windows::*; + #[doc(no_inline)] + pub(crate) use std::os::windows::prelude::AsRawHandle as AsRaw; + } else { + mod unsupported; + pub use unsupported; + } +} diff --git a/vendor/fd-lock/src/sys/unix/mod.rs b/vendor/fd-lock/src/sys/unix/mod.rs new file mode 100644 index 000000000..023e69187 --- /dev/null +++ b/vendor/fd-lock/src/sys/unix/mod.rs @@ -0,0 +1,7 @@ +mod read_guard; +mod rw_lock; +mod write_guard; + +pub use read_guard::RwLockReadGuard; +pub use rw_lock::RwLock; +pub use write_guard::RwLockWriteGuard; diff --git a/vendor/fd-lock/src/sys/unix/read_guard.rs b/vendor/fd-lock/src/sys/unix/read_guard.rs new file mode 100644 index 000000000..6d6718789 --- /dev/null +++ b/vendor/fd-lock/src/sys/unix/read_guard.rs @@ -0,0 +1,32 @@ +use rustix::fs::{flock, FlockOperation}; +use std::ops; +use std::os::unix::io::AsRawFd; + +use super::RwLock; + +#[derive(Debug)] +pub struct RwLockReadGuard<'lock, T: AsRawFd> { + lock: &'lock RwLock<T>, +} + +impl<'lock, T: AsRawFd> RwLockReadGuard<'lock, T> { + pub(crate) fn new(lock: &'lock RwLock<T>) -> Self { + Self { lock } + } +} + +impl<T: AsRawFd> ops::Deref for RwLockReadGuard<'_, T> { + type Target = T; + + #[inline] + fn deref(&self) -> &Self::Target { + &self.lock.inner + } +} + +impl<T: AsRawFd> Drop for RwLockReadGuard<'_, T> { + #[inline] + fn drop(&mut self) { + let _ = flock(&self.lock.as_fd(), FlockOperation::Unlock).ok(); + } +} diff --git a/vendor/fd-lock/src/sys/unix/rw_lock.rs b/vendor/fd-lock/src/sys/unix/rw_lock.rs new file mode 100644 index 000000000..c33ce5c78 --- /dev/null +++ b/vendor/fd-lock/src/sys/unix/rw_lock.rs @@ -0,0 +1,70 @@ +use rustix::fd::BorrowedFd; +use rustix::fs::{flock, FlockOperation}; +use std::io::{self, Error, ErrorKind}; +use std::os::unix::io::AsRawFd; + +use super::{RwLockReadGuard, RwLockWriteGuard}; + +#[derive(Debug)] +pub struct RwLock<T: AsRawFd> { + pub(crate) inner: T, +} + +impl<T: AsRawFd> RwLock<T> { + #[inline] + pub fn new(inner: T) -> Self { + RwLock { inner } + } + + #[inline] + pub fn write(&mut self) -> io::Result<RwLockWriteGuard<'_, T>> { + flock(&self.as_fd(), FlockOperation::LockExclusive)?; + Ok(RwLockWriteGuard::new(self)) + } + + #[inline] + pub fn try_write(&mut self) -> Result<RwLockWriteGuard<'_, T>, Error> { + flock(&self.as_fd(), FlockOperation::NonBlockingLockExclusive).map_err(|err| match err + .kind() + { + ErrorKind::AlreadyExists => ErrorKind::WouldBlock.into(), + _ => Error::from(err), + })?; + Ok(RwLockWriteGuard::new(self)) + } + + #[inline] + pub fn read(&self) -> io::Result<RwLockReadGuard<'_, T>> { + flock(&self.as_fd(), FlockOperation::LockShared)?; + Ok(RwLockReadGuard::new(self)) + } + + #[inline] + pub fn try_read(&self) -> Result<RwLockReadGuard<'_, T>, Error> { + flock(&self.as_fd(), FlockOperation::NonBlockingLockShared).map_err(|err| { + match err.kind() { + ErrorKind::AlreadyExists => ErrorKind::WouldBlock.into(), + _ => Error::from(err), + } + })?; + Ok(RwLockReadGuard::new(self)) + } + + #[inline] + pub fn into_inner(self) -> T + where + T: Sized, + { + self.inner + } + + #[inline] + pub(crate) fn as_fd(&self) -> BorrowedFd<'_> { + // Safety: We assume that `self.inner`'s file descriptor is valid for + // at least the lifetime of `self`. + // + // Once I/O safety is stablized in std, we can switch the public API to + // use `AsFd` instead of `AsRawFd` and eliminate this `unsafe` block. + unsafe { BorrowedFd::borrow_raw(self.inner.as_raw_fd()) } + } +} diff --git a/vendor/fd-lock/src/sys/unix/write_guard.rs b/vendor/fd-lock/src/sys/unix/write_guard.rs new file mode 100644 index 000000000..a12bdf97a --- /dev/null +++ b/vendor/fd-lock/src/sys/unix/write_guard.rs @@ -0,0 +1,39 @@ +use rustix::fs::{flock, FlockOperation}; +use std::ops; +use std::os::unix::io::AsRawFd; + +use super::RwLock; + +#[derive(Debug)] +pub struct RwLockWriteGuard<'lock, T: AsRawFd> { + lock: &'lock mut RwLock<T>, +} + +impl<'lock, T: AsRawFd> RwLockWriteGuard<'lock, T> { + pub(crate) fn new(lock: &'lock mut RwLock<T>) -> Self { + Self { lock } + } +} + +impl<T: AsRawFd> ops::Deref for RwLockWriteGuard<'_, T> { + type Target = T; + + #[inline] + fn deref(&self) -> &Self::Target { + &self.lock.inner + } +} + +impl<T: AsRawFd> ops::DerefMut for RwLockWriteGuard<'_, T> { + #[inline] + fn deref_mut(&mut self) -> &mut Self::Target { + &mut self.lock.inner + } +} + +impl<T: AsRawFd> Drop for RwLockWriteGuard<'_, T> { + #[inline] + fn drop(&mut self) { + let _ = flock(&self.lock.as_fd(), FlockOperation::Unlock).ok(); + } +} diff --git a/vendor/fd-lock/src/sys/unsupported/mod.rs b/vendor/fd-lock/src/sys/unsupported/mod.rs new file mode 100644 index 000000000..9d7bd2cbd --- /dev/null +++ b/vendor/fd-lock/src/sys/unsupported/mod.rs @@ -0,0 +1,9 @@ +mod read_guard; +mod rw_lock; +mod write_guard; + +pub(crate) mod utils; + +pub use read_guard::RwLockReadGuard; +pub use rw_lock::RwLock; +pub use write_guard::RwLockWriteGuard; diff --git a/vendor/fd-lock/src/sys/unsupported/read_guard.rs b/vendor/fd-lock/src/sys/unsupported/read_guard.rs new file mode 100644 index 000000000..7d6b4c783 --- /dev/null +++ b/vendor/fd-lock/src/sys/unsupported/read_guard.rs @@ -0,0 +1,31 @@ +use std::ops; +use std::os::unix::io::AsRawFd; + +use super::RwLock; + +#[derive(Debug)] +pub struct RwLockReadGuard<'lock, T: AsRawFd> { + lock: &'lock RwLock<T>, +} + +impl<'lock, T: AsRawFd> RwLockReadGuard<'lock, T> { + pub(crate) fn new(lock: &'lock RwLock<T>) -> Self { + panic!("target unsupported") + } +} + +impl<T: AsRawFd> ops::Deref for RwLockReadGuard<'_, T> { + type Target = T; + + #[inline] + fn deref(&self) -> &Self::Target { + panic!("target unsupported") + } +} + +impl<T: AsRawFd> Drop for RwLockReadGuard<'_, T> { + #[inline] + fn drop(&mut self) { + panic!("target unsupported") + } +} diff --git a/vendor/fd-lock/src/sys/unsupported/rw_lock.rs b/vendor/fd-lock/src/sys/unsupported/rw_lock.rs new file mode 100644 index 000000000..fb11da84b --- /dev/null +++ b/vendor/fd-lock/src/sys/unsupported/rw_lock.rs @@ -0,0 +1,44 @@ +use std::io::{self, Error, ErrorKind}; +use std::os::unix::io::AsRawFd; + +use super::{RwLockReadGuard, RwLockWriteGuard}; + +#[derive(Debug)] +pub struct RwLock<T: AsRawFd> { + pub(crate) inner: T, +} + +impl<T: AsRawFd> RwLock<T> { + #[inline] + pub fn new(inner: T) -> Self { + panic!("target unsupported") + } + + #[inline] + pub fn write(&mut self) -> io::Result<RwLockWriteGuard<'_, T>> { + panic!("target unsupported") + } + + #[inline] + pub fn try_write(&mut self) -> Result<RwLockWriteGuard<'_, T>, Error> { + panic!("target unsupported") + } + + #[inline] + pub fn read(&self) -> io::Result<RwLockReadGuard<'_, T>> { + panic!("target unsupported") + } + + #[inline] + pub fn try_read(&self) -> Result<RwLockReadGuard<'_, T>, Error> { + panic!("target unsupported") + } + + #[inline] + pub fn into_inner(self) -> T + where + T: Sized, + { + panic!("target unsupported") + } +} diff --git a/vendor/fd-lock/src/sys/unsupported/utils.rs b/vendor/fd-lock/src/sys/unsupported/utils.rs new file mode 100644 index 000000000..191dd0c5c --- /dev/null +++ b/vendor/fd-lock/src/sys/unsupported/utils.rs @@ -0,0 +1,9 @@ +use std::io; +use std::os::raw::c_int; + +pub(crate) fn syscall(int: c_int) -> io::Result<()> { + match int { + 0 => Ok(()), + _ => Err(io::Error::last_os_error()), + } +} diff --git a/vendor/fd-lock/src/sys/unsupported/write_guard.rs b/vendor/fd-lock/src/sys/unsupported/write_guard.rs new file mode 100644 index 000000000..19727c307 --- /dev/null +++ b/vendor/fd-lock/src/sys/unsupported/write_guard.rs @@ -0,0 +1,38 @@ +use std::ops; +use std::os::unix::io::AsRawFd; + +use super::RwLock; + +#[derive(Debug)] +pub struct RwLockWriteGuard<'lock, T: AsRawFd> { + lock: &'lock mut RwLock<T>, +} + +impl<'lock, T: AsRawFd> RwLockWriteGuard<'lock, T> { + pub(crate) fn new(lock: &'lock mut RwLock<T>) -> Self { + panic!("target unsupported") + } +} + +impl<T: AsRawFd> ops::Deref for RwLockWriteGuard<'_, T> { + type Target = T; + + #[inline] + fn deref(&self) -> &Self::Target { + panic!("target unsupported") + } +} + +impl<T: AsRawFd> ops::DerefMut for RwLockWriteGuard<'_, T> { + #[inline] + fn deref_mut(&mut self) -> &mut Self::Target { + panic!("target unsupported") + } +} + +impl<T: AsRawFd> Drop for RwLockWriteGuard<'_, T> { + #[inline] + fn drop(&mut self) { + panic!("target unsupported") + } +} diff --git a/vendor/fd-lock/src/sys/windows/mod.rs b/vendor/fd-lock/src/sys/windows/mod.rs new file mode 100644 index 000000000..dafbd31ad --- /dev/null +++ b/vendor/fd-lock/src/sys/windows/mod.rs @@ -0,0 +1,8 @@ +mod read_guard; +mod rw_lock; +mod utils; +mod write_guard; + +pub use read_guard::RwLockReadGuard; +pub use rw_lock::RwLock; +pub use write_guard::RwLockWriteGuard; diff --git a/vendor/fd-lock/src/sys/windows/read_guard.rs b/vendor/fd-lock/src/sys/windows/read_guard.rs new file mode 100644 index 000000000..28f09bb95 --- /dev/null +++ b/vendor/fd-lock/src/sys/windows/read_guard.rs @@ -0,0 +1,31 @@ +use windows_sys::Win32::Foundation::HANDLE; +use windows_sys::Win32::Storage::FileSystem::UnlockFile; + +use std::ops; +use std::os::windows::prelude::*; + +use super::utils::syscall; +use super::RwLock; + +#[derive(Debug)] +pub struct RwLockReadGuard<'lock, T: AsRawHandle> { + pub(crate) lock: &'lock RwLock<T>, +} + +impl<T: AsRawHandle> ops::Deref for RwLockReadGuard<'_, T> { + type Target = T; + + #[inline] + fn deref(&self) -> &Self::Target { + &self.lock.inner + } +} + +impl<T: AsRawHandle> Drop for RwLockReadGuard<'_, T> { + #[inline] + fn drop(&mut self) { + let handle = self.lock.inner.as_raw_handle() as HANDLE; + syscall(unsafe { UnlockFile(handle, 0, 0, 1, 0) }) + .expect("Could not unlock the file descriptor"); + } +} diff --git a/vendor/fd-lock/src/sys/windows/rw_lock.rs b/vendor/fd-lock/src/sys/windows/rw_lock.rs new file mode 100644 index 000000000..778b79100 --- /dev/null +++ b/vendor/fd-lock/src/sys/windows/rw_lock.rs @@ -0,0 +1,72 @@ +use std::io::{self, Error, ErrorKind}; +use std::os::windows::io::AsRawHandle; + +use windows_sys::Win32::Foundation::HANDLE; +use windows_sys::Win32::Storage::FileSystem::{ + LockFileEx, LOCKFILE_EXCLUSIVE_LOCK, LOCKFILE_FAIL_IMMEDIATELY, +}; + +use super::utils::{syscall, Overlapped}; +use super::{RwLockReadGuard, RwLockWriteGuard}; + +#[derive(Debug)] +pub struct RwLock<T: AsRawHandle> { + pub(crate) inner: T, +} + +impl<T: AsRawHandle> RwLock<T> { + #[inline] + pub fn new(inner: T) -> Self { + RwLock { inner } + } + + #[inline] + pub fn read(&self) -> io::Result<RwLockReadGuard<'_, T>> { + // See: https://stackoverflow.com/a/9186532, https://docs.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-lockfileex + let handle = self.inner.as_raw_handle() as HANDLE; + let overlapped = Overlapped::zero(); + let flags = 0; + syscall(unsafe { LockFileEx(handle, flags, 0, 1, 0, overlapped.raw()) })?; + Ok(RwLockReadGuard { lock: self }) + } + + #[inline] + pub fn try_read(&self) -> io::Result<RwLockReadGuard<'_, T>> { + let handle = self.inner.as_raw_handle() as HANDLE; + let overlapped = Overlapped::zero(); + let flags = LOCKFILE_FAIL_IMMEDIATELY; + + syscall(unsafe { LockFileEx(handle, flags, 0, 1, 0, overlapped.raw()) }) + .map_err(|_| Error::from(ErrorKind::WouldBlock))?; + Ok(RwLockReadGuard { lock: self }) + } + + #[inline] + pub fn write(&mut self) -> io::Result<RwLockWriteGuard<'_, T>> { + // See: https://stackoverflow.com/a/9186532, https://docs.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-lockfileex + let handle = self.inner.as_raw_handle() as HANDLE; + let overlapped = Overlapped::zero(); + let flags = LOCKFILE_EXCLUSIVE_LOCK; + syscall(unsafe { LockFileEx(handle, flags, 0, 1, 0, overlapped.raw()) })?; + Ok(RwLockWriteGuard { lock: self }) + } + + #[inline] + pub fn try_write(&mut self) -> io::Result<RwLockWriteGuard<'_, T>> { + let handle = self.inner.as_raw_handle() as HANDLE; + let overlapped = Overlapped::zero(); + let flags = LOCKFILE_FAIL_IMMEDIATELY | LOCKFILE_EXCLUSIVE_LOCK; + + syscall(unsafe { LockFileEx(handle, flags, 0, 1, 0, overlapped.raw()) }) + .map_err(|_| Error::from(ErrorKind::WouldBlock))?; + Ok(RwLockWriteGuard { lock: self }) + } + + #[inline] + pub fn into_inner(self) -> T + where + T: Sized, + { + self.inner + } +} diff --git a/vendor/fd-lock/src/sys/windows/utils.rs b/vendor/fd-lock/src/sys/windows/utils.rs new file mode 100644 index 000000000..43656a083 --- /dev/null +++ b/vendor/fd-lock/src/sys/windows/utils.rs @@ -0,0 +1,33 @@ +use std::io; +use std::mem; + +use windows_sys::Win32::Foundation::BOOL; +use windows_sys::Win32::System::IO::OVERLAPPED; + +/// A wrapper around `OVERLAPPED` to provide "rustic" accessors and +/// initializers. +pub(crate) struct Overlapped(OVERLAPPED); + +impl Overlapped { + /// Creates a new zeroed out instance of an overlapped I/O tracking state. + /// + /// This is suitable for passing to methods which will then later get + /// notified via an I/O Completion Port. + pub(crate) fn zero() -> Overlapped { + Overlapped(unsafe { mem::zeroed() }) + } + + /// Gain access to the raw underlying data + pub(crate) fn raw(&self) -> *mut OVERLAPPED { + &self.0 as *const _ as *mut _ + } +} + +/// Convert a system call which returns a `BOOL` to an `io::Result`. +pub(crate) fn syscall(status: BOOL) -> std::io::Result<()> { + if status == 0 { + Err(io::Error::last_os_error()) + } else { + Ok(()) + } +} diff --git a/vendor/fd-lock/src/sys/windows/write_guard.rs b/vendor/fd-lock/src/sys/windows/write_guard.rs new file mode 100644 index 000000000..5494bd99e --- /dev/null +++ b/vendor/fd-lock/src/sys/windows/write_guard.rs @@ -0,0 +1,38 @@ +use windows_sys::Win32::Foundation::HANDLE; +use windows_sys::Win32::Storage::FileSystem::UnlockFile; + +use std::ops; +use std::os::windows::prelude::*; + +use super::utils::syscall; +use super::RwLock; + +#[derive(Debug)] +pub struct RwLockWriteGuard<'lock, T: AsRawHandle> { + pub(crate) lock: &'lock mut RwLock<T>, +} + +impl<T: AsRawHandle> ops::Deref for RwLockWriteGuard<'_, T> { + type Target = T; + + #[inline] + fn deref(&self) -> &Self::Target { + &self.lock.inner + } +} + +impl<T: AsRawHandle> ops::DerefMut for RwLockWriteGuard<'_, T> { + #[inline] + fn deref_mut(&mut self) -> &mut Self::Target { + &mut self.lock.inner + } +} + +impl<T: AsRawHandle> Drop for RwLockWriteGuard<'_, T> { + #[inline] + fn drop(&mut self) { + let handle = self.lock.inner.as_raw_handle() as HANDLE; + syscall(unsafe { UnlockFile(handle, 0, 0, 1, 0) }) + .expect("Could not unlock the file descriptor"); + } +} diff --git a/vendor/fd-lock/src/write_guard.rs b/vendor/fd-lock/src/write_guard.rs new file mode 100644 index 000000000..e218e3842 --- /dev/null +++ b/vendor/fd-lock/src/write_guard.rs @@ -0,0 +1,50 @@ +use std::ops; + +use crate::sys; + +/// RAII structure used to release the exclusive write access of a lock when +/// dropped. +/// +/// This structure is created by the [`write`] and [`try_write`] methods +/// on [`RwLock`]. +/// +/// [`write`]: crate::RwLock::write +/// [`try_write`]: crate::RwLock::try_write +/// [`RwLock`]: crate::RwLock +/// +/// # Panics +/// +/// Dropping this type may panic if the lock fails to unlock. +#[must_use = "if unused the RwLock will immediately unlock"] +#[derive(Debug)] +pub struct RwLockWriteGuard<'lock, T: sys::AsRaw> { + guard: sys::RwLockWriteGuard<'lock, T>, +} + +impl<'lock, T: sys::AsRaw> RwLockWriteGuard<'lock, T> { + pub(crate) fn new(guard: sys::RwLockWriteGuard<'lock, T>) -> Self { + Self { guard } + } +} + +impl<T: sys::AsRaw> ops::Deref for RwLockWriteGuard<'_, T> { + type Target = T; + + #[inline] + fn deref(&self) -> &Self::Target { + self.guard.deref() + } +} + +impl<T: sys::AsRaw> ops::DerefMut for RwLockWriteGuard<'_, T> { + #[inline] + fn deref_mut(&mut self) -> &mut Self::Target { + self.guard.deref_mut() + } +} + +/// Release the lock. +impl<T: sys::AsRaw> Drop for RwLockWriteGuard<'_, T> { + #[inline] + fn drop(&mut self) {} +} diff --git a/vendor/fd-lock/tests/test.rs b/vendor/fd-lock/tests/test.rs new file mode 100644 index 000000000..35fd5b33b --- /dev/null +++ b/vendor/fd-lock/tests/test.rs @@ -0,0 +1,33 @@ +use fd_lock::RwLock; +use std::fs::File; +use std::io::ErrorKind; + +use tempfile::tempdir; + +#[test] +fn double_read_lock() { + let dir = tempdir().unwrap(); + let path = dir.path().join("lockfile"); + + let l0 = RwLock::new(File::create(&path).unwrap()); + let l1 = RwLock::new(File::open(path).unwrap()); + + let _g0 = l0.try_read().unwrap(); + let _g1 = l1.try_read().unwrap(); +} + +#[test] +fn double_write_lock() { + let dir = tempdir().unwrap(); + let path = dir.path().join("lockfile"); + + let mut l0 = RwLock::new(File::create(&path).unwrap()); + let mut l1 = RwLock::new(File::open(path).unwrap()); + + let g0 = l0.try_write().unwrap(); + + let err = l1.try_write().unwrap_err(); + assert!(matches!(err.kind(), ErrorKind::WouldBlock)); + + drop(g0); +} |