mirror of
https://github.com/bertptrs/tracing-mutex.git
synced 2025-12-25 20:50:32 +01:00
141 lines
5.4 KiB
Markdown
141 lines
5.4 KiB
Markdown
# Changelog
|
|
All notable changes to this project will be documented in this file.
|
|
|
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project
|
|
adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
|
|
## [Unreleased]
|
|
|
|
## [0.3.1]
|
|
|
|
### Added
|
|
|
|
- On Rust 1.80 or newer, a wrapper for `std::sync::LazyLock` is now available. The MSRV has not been
|
|
changed; older versions simply don't get this wrapper.
|
|
|
|
- Added missing const-initialisation wrappers for `parking_lot`. The API interface for
|
|
`tracing_mutex::parkinglot` is now identical to `parking_lot`, and an example showing how to use
|
|
it as a drop-in replacement was added.
|
|
|
|
- Introduced `experimental` feature, which will be used going forward to help evolve the API outside
|
|
the normal stability guarantees. APIs under this feature are not subject to semver or MSRV
|
|
guarantees.
|
|
|
|
- Added experimental api `tracing_mutex::util::reset_dependencies`, which can be used to reset the
|
|
ordering information of a specific mutex when you need to reorder them. This API is unsafe, as its
|
|
use invalidates any of the deadlock prevention guarantees made.
|
|
|
|
### Changed
|
|
|
|
- Reworked CI to better test continued support for the minimum supported Rust version
|
|
|
|
### Fixed
|
|
|
|
- Support for `parking_lot` and `lock_api` can now be enabled properly with the matching feature
|
|
names.
|
|
|
|
### Deprecated
|
|
|
|
- The `parkinglot` and `lockapi` features have been deprecated. They will be removed in version 0.4.
|
|
To fix it, you can use the `parking_lot` and `lock_api` features respectively.
|
|
|
|
## [0.3.0] - 2023-09-09
|
|
|
|
### Added
|
|
|
|
- The minimum supported Rust version is now defined as 1.70. Previously it was undefined.
|
|
- Wrappers for `std::sync` primitives can now be `const` constructed.
|
|
- Add support for `std::sync::OnceLock`
|
|
- Added backtraces of mutex allocations to the cycle report. Capturing backtraces does incur some
|
|
overhead, this can be mitigated by disabling the `backtraces` feature which is enabled by default.
|
|
|
|
### Breaking
|
|
|
|
- Update [`parking_lot`][parking_lot] dependency to `0.12`.
|
|
- Restructured the crate to reduce typename verbosity. Wrapper names now match the name of the
|
|
primitive they wrap. Specific always/debug tracing versions have now moved to separate modules.
|
|
For example, `tracing_mutex::stdsync::TracingMutex` is now
|
|
`tracing_mutex::stdsync::tracing::Mutex`, and `tracing_mutex::stdsync::DebugMutex` is now called
|
|
`tracing_mutex::stdsync::Mutex`. This hopefully reduces the visual noise while reading code that
|
|
uses this in practice. Unwrapped primitives are reexported under `tracing_mutex::stdsync::raw` for
|
|
convenience.
|
|
|
|
### Fixed
|
|
|
|
- Enforce that all internal mutex guards are `!Send`. They already should be according to other
|
|
reasons, but this adds extra security through the type system.
|
|
|
|
## [0.2.1] - 2022-05-23
|
|
|
|
### Added
|
|
|
|
- Build [docs.rs] documentation with all features enabled for completeness.
|
|
- Add support for `std::sync::Condvar`
|
|
|
|
### Fixed
|
|
|
|
- The `parkinglot` module is now correctly enabled by the `parkinglot` feature rather than the
|
|
`lockapi` feature.
|
|
|
|
## [0.2.0] - 2022-05-07
|
|
|
|
### Added
|
|
- Generic support for wrapping mutexes that implement the traits provided by the
|
|
[`lock_api`][lock_api] crate. This can be used for creating support for other mutex providers that
|
|
implement it.
|
|
|
|
- Support for [`parking_lot`][parking_lot] mutexes. Support includes type aliases for all
|
|
provided mutex types as well as a dedicated `Once` wrapper.
|
|
|
|
- Simple benchmark to track the rough performance penalty incurred by dependency tracking.
|
|
|
|
### Breaking
|
|
|
|
- The library now requires edition 2021.
|
|
|
|
- The `Mutex`- and `RwLockGuards` now dereference to `T` rather than the lock guard they wrap. This
|
|
is technically a bugfix but can theoretically break existing code.
|
|
|
|
- Self-cycles are no longer allowed for lock dependencies. They previously were because it usually
|
|
isn't a problem, but it can create RWR deadlocks with `RwLocks`.
|
|
|
|
### Changed
|
|
|
|
- The project now targets edition 2021
|
|
|
|
## [0.1.2] - 2021-05-27
|
|
|
|
### Added
|
|
- Added missing type aliases for the guards returned by `DebugMutex` and `DebugRwLock`. These new
|
|
type aliases function the same as the ones they belong to, resolving to either the tracing
|
|
versions when debug assertions are enabled or the standard one when they're not.
|
|
|
|
### Fixed
|
|
- Fixed a corruption error where deallocating a previously cyclic mutex could result in a panic.
|
|
|
|
## [0.1.1] - 2021-05-24
|
|
|
|
### Changed
|
|
- New data structure for interal dependency graph, resulting in quicker graph updates.
|
|
|
|
### Fixed
|
|
- Fixed an issue where internal graph ordering indices were exponential rather than sequential. This
|
|
caused the available IDs to run out way more quickly than intended.
|
|
|
|
## [0.1.0] - 2021-05-16 [YANKED]
|
|
|
|
Initial release.
|
|
|
|
[Unreleased]: https://github.com/bertptrs/tracing-mutex/compare/v0.3.1...HEAD
|
|
[0.3.1]: https://github.com/bertptrs/tracing-mutex/compare/v0.3.0...v0.3.1
|
|
[0.3.0]: https://github.com/bertptrs/tracing-mutex/compare/v0.2.1...v0.3.0
|
|
[0.2.1]: https://github.com/bertptrs/tracing-mutex/compare/v0.2.0...v0.2.1
|
|
[0.2.0]: https://github.com/bertptrs/tracing-mutex/compare/v0.1.2...v0.2.0
|
|
[0.1.2]: https://github.com/bertptrs/tracing-mutex/compare/v0.1.1...v0.1.2
|
|
[0.1.1]: https://github.com/bertptrs/tracing-mutex/compare/v0.1.0...v0.1.1
|
|
[0.1.0]: https://github.com/bertptrs/tracing-mutex/releases/tag/v0.1.0
|
|
|
|
[docs.rs]: https://docs.rs/tracing-mutex/latest/tracing_mutex/
|
|
[lock_api]: https://docs.rs/lock_api/
|
|
[parking_lot]: https://docs.rs/parking_lot/
|