25 KiB
Changelog
All notable changes to this project will be documented in this file.
This project adheres to Semantic Versioning.
Unreleased
1.6.0 - 2023-12-06
-
Add
cfg_{has,no}_atomic_{8,16,32,64,128,ptr}
macros to enable code when the corresponding atomic implementation is available/unavailable. -
Add
cfg_{has,no}_atomic_cas
macros to enable code when atomic CAS/RMW implementation is available/unavailable. -
Improve support for RISC-V targets without atomic CAS.
1.5.1 - 2023-10-29
-
Fix bug in
i{8,16}
fetch_{or,xor}
on RISC-V without A-extension whereunsafe-assume-single-core
andforce-amo
are enabled. -
Optimize
swap
for targets that do not have native atomic CAS instructions.
1.5.0 - 2023-10-23
Note: This release has been yanked due to a bug fixed in 1.5.1.
-
Add
from_ptr
. -
Add
force-amo
feature (portable_atomic_force_amo
cfg) for single-core RISC-V without A-extension. (#124) -
Support run-time detection on AArch64 on pre-1.61 rustc. (#98)
This also solves a compatibility issue with rustc_codegen_cranelift.
-
Support run-time detection of FEAT_LSE2. (#126)
-
Support run-time detection of FEAT_LSE on AArch64 NetBSD. (#66)
-
Acknowledge ESP-IDF targets' 64-bit atomics are not lock-free. See #122 for more.
-
Optimize 128-bit weak CAS on powerpc64.
-
Optimize interrupt disable on no-std pre-v6 ARM where
unsafe-assume-single-core
anddisable-fiq
are enabled. (771c45d) -
Improve detection of Apple hardware. (5c3a43b)
-
Improve compatibility with the future version of Miri.
1.4.3 - 2023-08-25
-
Optimize AArch64 128-bit atomic store/swap/fetch_and/fetch_or when the
lse128
target feature is enabled at compile-time. (#68) -
Optimize AArch64 128-bit atomic load/store when the
rcpc3
target feature is enabled at compile-time. (#68) -
Optimize inline assemblies on ARM, AArch64, and MSP430.
1.4.2 - 2023-07-27
- Optimize
AtomicBool
on RISC-V/LoongArch64. This is the same as rust-lang/rust#114034, but is available for all rustc versions.
1.4.1 - 2023-07-15
- Improve compatibility with the future version of Miri.
1.4.0 - 2023-07-11
-
Allow using embedded-related cfgs as Cargo features. (#94, thanks @Dirbaio)
Originally, we were providing these as cfgs instead of features, but based on a strong request from the embedded ecosystem, we have agreed to provide them as features as well. See #94 for more.
cfgs are kept and can be used as aliases for features.
-
Acknowledge all x86_64 Apple targets support 128-bit atomics.
Our code already recognizes this via
cfg(target_feature)
, so this only affects docs and users using pre-1.69 stable rustc.See also rust-lang/rust#112150.
-
Optimize 128-bit atomics on aarch64/s390x.
1.3.3 - 2023-05-31
-
Fix build error on aarch64 ILP32 ABI targets (tier 3).
-
Optimize 128-bit atomics on s390x.
1.3.2 - 2023-05-09
-
Fix bug in powerpc64/s390x 128-bit atomic RMWs on old nightly.
-
Optimize 128-bit atomics on powerpc64/s390x.
1.3.1 - 2023-05-07
- Documentation improvements.
1.3.0 - 2023-05-06
-
Add
require-cas
feature. (#100)If your crate supports no-std environment and requires atomic CAS, enabling this feature will allow the
portable-atomic
to display helpful error messages to users on targets requiring additional action on the user side to provide atomic CAS.[dependencies] portable-atomic = { version = "1.3", default-features = false, features = ["require-cas"] }
See #100 for more.
-
Support
portable_atomic_unsafe_assume_single_core
cfg on Xtensa targets without atomic CAS. (#86) -
Fix bug in AArch64 128-bit SeqCst load when FEAT_LSE2 is enabled at compile-time. This is the same bug that was fixed in the recently released GCC 13.1. LLVM also has the same bug, which had not yet been fixed when the patch was created; I will open a bug report if necessary after looking into the situation in LLVM. (a29154b)
-
Fix compile error on
bpf{eb,el}-unknown-none
(tier 3) andmipsel-sony-psx
(tier 3) whencritical-section
feature is disabled. -
Various optimizations
- Optimize x86_64 128-bit outline-atomics. This improves performance by up to 15% in concurrent RMW/store for cases where the
cmpxchg16b
target feature is not available at compile-time. (40c4cd4) - Optimize x86_64 128-bit load that uses cmpxchg16b. (40c4cd4)
- Optimize aarch64 128-bit load that uses FEAT_LSE. (40c4cd4)
- Optimize pre-ARMv6 Linux/Android 64-bit atomics. (efacc89)
- Support outline-atomics for powerpc64 128-bit atomics. This is currently disabled by default, and can be enabled by
--cfg portable_atomic_outline_atomics
. (#90) - Optimize aarch64 outline-atomics on linux-musl. On linux-musl, outline-atomics is enabled by default only when dynamic linking is enabled. When static linking is enabled, this can be enabled by
--cfg portable_atomic_outline_atomics
. See theatomic128
module's readme for more. (8418235, 31d0862)
- Optimize x86_64 128-bit outline-atomics. This improves performance by up to 15% in concurrent RMW/store for cases where the
1.2.0 - 2023-03-25
-
Make 64-bit atomics lock-free on ARM Linux/Android targets that do not have 64-bit atomics (e.g., armv5te-unknown-linux-gnueabi, arm-linux-androideabi, etc.) when the kernel version is 3.1 or later. (#82)
-
Fix aarch64 128-bit atomics performance regression on Apple hardware. (#89)
-
Optimize 128-bit atomics on aarch64, x86_64, powerpc64, and s390x.
1.1.0 - 2023-03-24
-
Add
Atomic{I,U}*::bit_{set,clear,toggle}
andAtomicPtr::bit_{set,clear,toggle}
. (#72)They correspond to x86's
lock bt{s,r,c}
, and the implementation calls them on x86/x86_64. -
Add
AtomicU*::{fetch_neg,neg}
methods. Previously it was only available onAtomicI*
andAtomicF*
. -
Add
as_ptr
method to all atomic types. (#79) -
Make
AtomicF{32,64}::as_bits
const on Rust 1.58+. (#79) -
Relax ordering in
Serialize
impl to reflect the upstream change. -
Optimize x86_64 outline-atomics for 128-bit atomics.
- Support outline-atomics for cmpxchg16b on Rust 1.69+ (i.e., on Rust 1.69+, x86_64 128-bit atomics is lock-free on all Intel chips and almost all AMD chips, even if cmpxchg16b is not available at compile-time.). Previously it was only nightly. (#80)
- portable-atomic no longer enables outline-atomics on target where run-time feature detection is not available. (#80)
-
Optimize aarch64 outline-atomics for 128-bit atomics.
- Support more targets and improve performance. (#63, #64, #67, #69, #75, #76, #77)
See the
atomic128
module's readme for a list of platforms that support outline-atomics. Most of these improvements have already been submitted and accepted in rust-lang/stdarch and will soon be available instd::arch::is_aarch64_feature_detected
. - portable-atomic no longer enables outline-atomics on target where run-time feature detection is not available.
- Support more targets and improve performance. (#63, #64, #67, #69, #75, #76, #77)
See the
-
Performance improvements. (#70, #81, 6c189ae, 13c92b0, etc.)
-
Documentation improvements.
1.0.1 - 2023-01-21
- Optimize
Atomic{I,U}*::{fetch_not,not}
methods. (#62)
1.0.0 - 2023-01-15
-
Add
critical-section
feature to use critical-section on targets where atomic CAS is not natively available. (#51, thanks @Dirbaio)This is useful to get atomic CAS when
--cfg portable_atomic_unsafe_assume_single_core
can't be used, such as multi-core targets, unprivileged code running under some RTOS, or environments where disabling interrupts needs extra care due to e.g. real-time requirements.See documentation for more.
-
Remove
outline-atomics
feature. This was no-op since 0.3.19. -
Documentation improvements.
0.3.20 - 2023-05-07
The latest version of portable-atomic is 1.x. This release makes portable-atomic 0.3 is built on top of portable-atomic 1.x to make bug fixes and improvements such as support for new targets in 1.x available to the ecosystem that depends on older portable-atomic. portable-atomic 0.3 is still maintained passively, but upgrading to portable-atomic 1.x is recommended. (There are no breaking changes from 0.3, except that a deprecated no-op outline-atomics
Cargo feature has been removed.) (#99)
0.3.19 - 2022-12-25
-
Add
AtomicI*::{fetch_neg,neg}
andAtomicF*::fetch_neg
methods. (#54)AtomicI*::neg
are equivalent to the correspondingfetch_*
methods, but do not return the previous value. They are intended for optimization on platforms that have atomic instructions for the corresponding operation, such as x86'slock neg
.Currently, optimizations by these methods (
neg
) are only guaranteed for x86/x86_64. -
Add
Atomic{I,U}*::{fetch_not,not}
methods. (#54)Atomic{I,U}*::not
are equivalent to the correspondingfetch_*
methods, but do not return the previous value. They are intended for optimization on platforms that have atomic instructions for the corresponding operation, such as x86'slock not
, MSP430'sinv
.Currently, optimizations by these methods (
not
) are only guaranteed for x86/x86_64 and MSP430.(Note:
AtomicBool
already hasfetch_not
andnot
methods.) -
Enable outline-atomics for 128-bit atomics by default. (#57) See #57 for more.
-
Improve support for old nightly compilers.
0.3.18 - 2022-12-15
-
Fix build error when not using
portable_atomic_unsafe_assume_single_core
cfg on AVR and MSP430 custom targets. (#50)Since 0.3.11, atomic CAS was supported without the cfg on AVR and MSP430 builtin targets, but that change was not applied to custom targets.
0.3.17 - 2022-12-14
-
Optimize x86_64 128-bit atomic load/store on AMD CPU with AVX. (#49)
-
Improve support for custom targets on old rustc.
0.3.16 - 2022-12-09
-
Add
Atomic{I,U}*::{add,sub,and,or,xor}
andAtomicBool::{and,or,xor}
methods. (#47)They are equivalent to the corresponding
fetch_*
methods, but do not return the previous value. They are intended for optimization on platforms that implement atomics using inline assembly, such as the MSP430.Currently, optimizations by these methods (
add
,sub
,and
,or
,xor
) are only guaranteed for MSP430; on x86/x86_64, LLVM can optimize in most cases, so cases, where this would improve things, should be rare. -
Various improvements to
portable_atomic_unsafe_assume_single_core
cfg. (#44, #40)- Support disabling FIQs on pre-v6 ARM under
portable_atomic_disable_fiq
cfg. - Support RISC-V supervisor mode under
portable_atomic_s_mode
cfg. - Optimize interrupt restore on AVR and MSP430. (#40)
- Documentation improvements.
See #44 for more.
- Support disabling FIQs on pre-v6 ARM under
0.3.15 - 2022-09-09
-
Implement workaround for std cpuid bug due to LLVM bug (rust-lang/rust#101346, llvm/llvm-project#57550).
- Our use case is likely not affected, but we implement this just in case.
- We've confirmed that the uses of inline assembly in this crate are not affected by this LLVM bug.
0.3.14 - 2022-09-04
-
Optimize atomic load/store on no-std pre-v6 ARM when
portable_atomic_unsafe_assume_single_core
cfg is used. (#36) -
Support pre-power8 powerpc64le. powerpc64le's default cpu version is power8, but you can technically compile it for the old cpu using the unsafe
-C target-cpu
rustc flag.
0.3.13 - 2022-08-15
-
Use track_caller when debug assertions are enabled on Rust 1.46+.
-
Make powerpc64 128-bit atomics compatible with Miri and ThreadSanitizer on LLVM 15+.
-
Document that 128-bit atomics are compatible with Miri and ThreadSanitizer on recent nightly.
0.3.12 - 2022-08-13
- Support atomic CAS on no-std pre-v6 ARM targets (e.g., thumbv4t-none-eabi) under unsafe cfg
portable_atomic_unsafe_assume_single_core
. (#28)
0.3.11 - 2022-08-12
-
Always provide atomic CAS for MSP430 and AVR. (#31)
This previously required unsafe cfg
portable_atomic_unsafe_assume_single_core
, but since all MSP430 and AVR are single-core, we can safely provide atomic CAS based on disabling interrupts. -
Support
fence
andcompiler_fence
on MSP430. (On MSP430, the standard library's fences are currently unavailable due to LLVM errors.) -
Update safety requirements for unsafe cfg
portable_atomic_unsafe_assume_single_core
to mention use of privileged instructions to disable interrupts. -
Atomic operations based on disabling interrupts on single-core systems are now considered lock-free.
The previous behavior was inconsistent because we consider the pre-v6 ARM Linux's atomic operations provided in a similar way by the Linux kernel to be lock-free.
-
Respect
-Z allow-features
.
0.3.10 - 2022-08-03
- Optimize AArch64 128-bit atomic load when the
lse
target feature is enabled at compile-time. (#20)
0.3.9 - 2022-08-03
-
Fix build error on old Miri.
-
Documentation improvements.
0.3.8 - 2022-08-02
- Make AArch64 and s390x 128-bit atomics compatible with Miri and ThreadSanitizer.
0.3.7 - 2022-07-31
-
Provide stable equivalent of
#![feature(strict_provenance_atomic_ptr)]
. (#23)AtomicPtr::fetch_ptr_{add,sub}
AtomicPtr::fetch_byte_{add,sub}
AtomicPtr::fetch_{or,and,xor}
These APIs are compatible with strict-provenance on
cfg(miri)
. Otherwise, they are compatible with permissive-provenance. Once#![feature(strict_provenance_atomic_ptr)]
is stabilized, these APIs will be strict-provenance compatible in all cases from the version in which it is stabilized. -
Provide stable equivalent of
#![feature(atomic_bool_fetch_not)]
. (#24)AtomicBool::fetch_not
-
Optimize x86_64 128-bit RMWs. (#22)
-
Optimize x86_64 outline-atomics.
-
Optimize inline assemblies on ARM and AArch64.
-
Revert thumbv6m atomic load/store changes made in 0.3.5. This is because rust-lang/rust#99595 has been reverted, so this is no longer needed.
0.3.6 - 2022-07-26
-
Fix build failure due to the existence of the
specs
directory. -
Documentation improvements.
-
Optimize inline assemblies on x86_64, RISC-V, and MSP430.
0.3.5 - 2022-07-23
Note: This release has been yanked due to a bug fixed in 0.3.6.
-
Provide thumbv6m atomic load/store which is planned to be removed from the standard library in rust-lang/rust#99595. (#18)
-
Optimize inline assemblies on AArch64, RISC-V, and powerpc64.
0.3.4 - 2022-06-25
- Optimize x86_64 128-bit atomic store.
0.3.3 - 2022-06-24
- Allow CAS failure ordering stronger than success ordering. (#17)
0.3.2 - 2022-06-19
-
Optimize x86_64 128-bit atomic load/store on Intel CPU with AVX. (#16)
-
Support native 128-bit atomic operations for powerpc64 (le or pwr8+, currently nightly-only).
-
Fix behavior differences between stable and nightly. (#15)
0.3.1 - 2022-06-16
-
Optimize AArch64 128-bit atomic load/store when the
lse2
target feature is enabled at compile-time. (#11) -
Relax ordering in
Debug
impl to reflect std changes. (#12)
0.3.0 - 2022-03-25
-
Support native 128-bit atomic operations for s390x (currently nightly-only).
-
Add
AtomicF{32,64}::fetch_abs
. -
Add
#[must_use]
to constructors. -
Use 128-bit atomic operation mappings same as LLVM on AArch64.
-
Remove
parking_lot
optional feature to allow the use of this crate within global allocators.
0.2.1 - 2022-03-17
- Implement AArch64 outline-atomics.
0.2.0 - 2022-03-10
-
Remove
i128
feature.Atomic{I,U}128
are now always enabled. -
Add
outline-atomics
feature. Currently, this is the same as the 0.1'si128-dynamic
, except thatfallback
feature is not implicitly enabled. -
Remove
i128-dynamic
feature in favor ofoutline-atomics
feature. -
Add
AtomicF{32,64}::as_bits
.
0.1.4 - 2022-03-02
- Support native 128-bit atomic operations for AArch64 at Rust 1.59+. This was previously supported only on nightly. (#6)
0.1.3 - 2022-02-28
- Fix inline assembly for RISC-V without A-extension.
0.1.2 - 2022-02-26
Note: This release has been yanked due to a bug fixed in 0.1.3.
-
Add
parking_lot
feature to use parking_lot in global locks of fallback implementation. -
Fix bug in cmpxchg16b support. (#5)
0.1.1 - 2022-02-25
Note: This release has been yanked due to a bug fixed in 0.1.3.
- Fix doc cfg on
Atomic{I,U}128
.
0.1.0 - 2022-02-24
Note: This release has been yanked due to a bug fixed in 0.1.3.
Initial release