Skip to content

Commit bf30a6e

Browse files
taiki-etaiki-e
committed
Add generic Atomic<T> type
1 parent 0887602 commit bf30a6e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+3690
-16
lines changed

‎.github/workflows/ci.yml

+3-1
Original file line numberDiff line numberDiff line change
@@ -93,9 +93,11 @@ jobs:
9393
- uses: taiki-e/github-actions/install-rust@main
9494
with:
9595
toolchain: ${{ matrix.rust }}
96-
component: rust-src
96+
component: rust-src,rustfmt
9797
- uses: taiki-e/install-action@cargo-hack
9898
- uses: taiki-e/install-action@cargo-minimal-versions
99+
- uses: dtolnay/install@cargo-expand
100+
if: startsWith(matrix.rust, 'nightly') && matrix.target == '' && matrix.os == ''
99101
- uses: taiki-e/setup-cross-toolchain-action@v1
100102
with:
101103
target: ${{ matrix.target }}

‎Cargo.toml

+22-5
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ keywords = ["atomic"]
99
categories = ["concurrency", "data-structures", "embedded", "hardware-support", "no-std"]
1010
exclude = ["/.*", "/tools"]
1111
description = """
12-
Portable atomic types including support for 128-bit atomics, atomic float, etc.
12+
Portable atomic types including support for 128-bit atomics, atomic float, generic atomic type, etc.
1313
"""
1414

1515
[package.metadata.docs.rs]
@@ -20,6 +20,7 @@ targets = ["x86_64-unknown-linux-gnu"]
2020
[workspace]
2121
members = [
2222
"bench",
23+
"portable-atomic-derive",
2324
"tests/asm-test",
2425
"tests/no-std",
2526
]
@@ -46,15 +47,28 @@ outline-atomics = []
4647
# Note that most of `fetch_*` operations of atomic floats are implemented using CAS loops, which can be slower than equivalent operations of atomic integers.
4748
float = []
4849

49-
# TODO
50-
# # Provides generic `atomic<t>` type.
51-
# generic = []
50+
# Provides generic `Atomic<T>` type.
51+
#
52+
# Note:
53+
# - This implicitly enables the `fallback` feature.
54+
generic = ["fallback"]
55+
56+
# Provide derive(Atomicable).
57+
derive = ["portable-atomic-derive"]
58+
59+
# Use `alloc`.
60+
alloc = []
5261

5362
# Use `std`.
54-
std = []
63+
#
64+
# Note:
65+
# - This implicitly enables the `alloc` feature.
66+
std = ["alloc"]
5567

5668
# Note: serde is public dependencies.
5769
[dependencies]
70+
portable-atomic-derive = { path = "portable-atomic-derive", version = "=0.2.1", optional = true }
71+
5872
# Implements serde::{Serialize,Deserialize} for atomic types.
5973
#
6074
# Note:
@@ -64,8 +78,11 @@ serde = { version = "1.0.103", optional = true, default-features = false }
6478
[dev-dependencies]
6579
crossbeam-utils = "0.8"
6680
fastrand = "1"
81+
macrotest = { git = "https://github.com/taiki-e/macrotest.git", rev = "779cfa5" } # https://github.com/eupn/macrotest/pull/69
6782
paste = "1"
6883
quickcheck = { default-features = false, git = "https://github.com/taiki-e/quickcheck.git", branch = "dev" } # https://github.com/BurntSushi/quickcheck/pull/304 + https://github.com/BurntSushi/quickcheck/pull/282 + lower MSRV
84+
rustversion = "1"
6985
serde = { version = "1", features = ["derive"] }
7086
serde_test = "1"
7187
static_assertions = "1"
88+
trybuild = "1"

‎README.md

+18-4
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@
77
[![build status](https://img.shields.io/github/workflow/status/taiki-e/portable-atomic/CI/main?style=flat-square&logo=github)](https://github.com/taiki-e/portable-atomic/actions)
88
[![build status](https://img.shields.io/cirrus/github/taiki-e/portable-atomic/main?style=flat-square&logo=cirrusci)](https://cirrus-ci.com/github/taiki-e/portable-atomic)
99

10-
Portable atomic types including support for 128-bit atomics, atomic float, etc.
10+
Portable atomic types including support for 128-bit atomics, atomic float, generic atomic type, etc.
1111

1212
- Provide all atomic integer types (`Atomic{I,U}{8,16,32,64}`) for all targets that can use atomic CAS. (i.e., all targets that can use `std`, and most no-std targets)
1313
- Provide `AtomicI128` and `AtomicU128`.
1414
- Provide `AtomicF32` and `AtomicF64`. (optional)
15-
<!-- - Provide generic `Atomic<T>` type. (optional) -->
15+
- Provide generic `Atomic<T>` type. (optional)
1616
- Provide atomic load/store for targets where atomic is not available at all in the standard library. (riscv without A-extension, msp430, avr)
1717
- Provide atomic CAS for targets where atomic CAS is not available in the standard library. (thumbv6m, riscv without A-extension, msp430, avr) (optional, [single-core only](#optional-cfg))
1818

@@ -22,6 +22,13 @@ Native 128-bit atomic operations are available on x86_64 and aarch64 at Rust 1.5
2222

2323
On x86_64, when the `outline-atomics` optional feature is not enabled and `cmpxchg16b` target feature is not enabled at compile-time, this uses the fallback implementation. `cmpxchg16b` target feature is enabled by default only on macOS.
2424

25+
## Generic Atomic\<T> type
26+
27+
- Support for various operations on `Copy` types and support for swap and store on non-`Copy` types.
28+
- Support for primitives, immutable references, function pointers, `NonNull`, `NoneZero`, etc.
29+
- Support for user-defined structs and enums, including those with multiple fields and padding. (via `#[derive(Atomicable)]`)
30+
- Support for user-defined unions. (via `#[derive(Atomicable)]`)
31+
2532
## Optional features
2633

2734
- **`fallback`** *(enabled by default)*<br>
@@ -43,14 +50,21 @@ On x86_64, when the `outline-atomics` optional feature is not enabled and `cmpxc
4350
Provide `AtomicF{32,64}`.
4451
Note that most of `fetch_*` operations of atomic floats are implemented using CAS loops, which can be slower than equivalent operations of atomic integers.
4552

46-
<!-- TODO
4753
- **`generic`**<br>
4854
Provides generic `Atomic<T>` type.
49-
-->
55+
56+
Note:
57+
- This implicitly enables the `fallback` feature.
58+
59+
- **`alloc`**<br>
60+
Use `alloc`.
5061

5162
- **`std`**<br>
5263
Use `std`.
5364

65+
Note:
66+
- This implicitly enables the `alloc` feature.
67+
5468
- **`serde`**<br>
5569
Implement `serde::{Serialize,Deserialize}` for atomic types.
5670

‎build.rs

+8
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,9 @@ fn main() {
119119
// Note that this is `no_`*, not `has_*`. This allows treating as the latest
120120
// stable rustc is used when the build script doesn't run. This is useful
121121
// for non-cargo build systems that don't run the build script.
122+
if version.minor < 36 {
123+
println!("cargo:rustc-cfg=portable_atomic_no_alloc");
124+
}
122125
if version.minor < 37 {
123126
println!("cargo:rustc-cfg=portable_atomic_no_underscore_consts");
124127
}
@@ -134,6 +137,11 @@ fn main() {
134137
if version.minor < 59 {
135138
println!("cargo:rustc-cfg=portable_atomic_no_asm");
136139
}
140+
// const_fn_trait_bound stabilized in Rust 1.61 (nightly-2022-03-08).
141+
if version.minor >= 61 && (!version.nightly || version.commit_date >= Date::new(2022, 3, 7)) {
142+
// TODO: invert cfg once Rust 1.61 became stable.
143+
println!("cargo:rustc-cfg=portable_atomic_const_fn_trait_bound");
144+
}
137145
// aarch64_target_feature stabilized in Rust 1.61 (nightly-2022-03-16).
138146
if version.minor >= 61 && (!version.nightly || version.commit_date >= Date::new(2022, 3, 15)) {
139147
// TODO: invert cfg once Rust 1.61 became stable.

‎portable-atomic-derive/Cargo.toml

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
[package]
2+
name = "portable-atomic-derive"
3+
version = "0.2.1"
4+
edition = "2018"
5+
rust-version = "1.34"
6+
license = "Apache-2.0 OR MIT"
7+
repository = "https://github.com/taiki-e/portable-atomic"
8+
keywords = ["atomic"]
9+
categories = ["concurrency", "data-structures", "embedded", "hardware-support", "no-std"]
10+
description = """
11+
Implementation detail of the `portable-atomic` crate.
12+
"""
13+
14+
[package.metadata.docs.rs]
15+
targets = ["x86_64-unknown-linux-gnu"]
16+
17+
[lib]
18+
proc-macro = true
19+
20+
[dependencies]
21+
proc-macro2 = "1.0"
22+
quote = "1.0"
23+
syn = { version = "1.0.60" }
24+
25+
[dev-dependencies]
26+
portable-atomic = { path = ".." }

‎portable-atomic-derive/LICENSE-APACHE

+177
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,177 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS

‎portable-atomic-derive/LICENSE-MIT

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
Permission is hereby granted, free of charge, to any
2+
person obtaining a copy of this software and associated
3+
documentation files (the "Software"), to deal in the
4+
Software without restriction, including without
5+
limitation the rights to use, copy, modify, merge,
6+
publish, distribute, sublicense, and/or sell copies of
7+
the Software, and to permit persons to whom the Software
8+
is furnished to do so, subject to the following
9+
conditions:
10+
11+
The above copyright notice and this permission notice
12+
shall be included in all copies or substantial portions
13+
of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
16+
ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
17+
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
18+
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
19+
SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
20+
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
22+
IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
23+
DEALINGS IN THE SOFTWARE.

0 commit comments

Comments
 (0)