Skip to content

Commit 532d4af

Browse files
mkroeningmkroening
committed
Initial commit
0 parents  commit 532d4af

File tree

14 files changed

+852
-0
lines changed

14 files changed

+852
-0
lines changed

‎.github/workflows/ci.yml‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
pull_request:
6+
merge_group:
7+
8+
env:
9+
RUSTFLAGS: -Dwarnings
10+
RUSTDOCFLAGS: -Dwarnings
11+
12+
jobs:
13+
clippy:
14+
name: Clippy
15+
runs-on: ubuntu-latest
16+
steps:
17+
- uses: actions/checkout@v5
18+
- uses: dtolnay/rust-toolchain@stable
19+
with:
20+
targets: aarch64-unknown-none-softfloat,i586-unknown-linux-musl,riscv32imac-unknown-none-elf,riscv64gc-unknown-none-elf,x86_64-unknown-none
21+
components: clippy
22+
- uses: taiki-e/install-action@cargo-hack
23+
- run: |
24+
cargo hack clippy --feature-powerset --no-dev-deps --exclude-features nightly
25+
cargo hack clippy --feature-powerset --no-dev-deps --exclude-features nightly --target aarch64-unknown-none-softfloat
26+
cargo hack clippy --feature-powerset --no-dev-deps --exclude-features nightly --target i586-unknown-linux-musl
27+
cargo hack clippy --feature-powerset --no-dev-deps --exclude-features nightly --target riscv32imac-unknown-none-elf
28+
cargo hack clippy --feature-powerset --no-dev-deps --exclude-features nightly --target riscv64gc-unknown-none-elf
29+
cargo hack clippy --feature-powerset --no-dev-deps --exclude-features nightly --target x86_64-unknown-none
30+
31+
build:
32+
name: Build
33+
runs-on: ubuntu-latest
34+
strategy:
35+
matrix:
36+
toolchain: [stable, nightly]
37+
include:
38+
- toolchain: stable
39+
args: --exclude-features nightly
40+
steps:
41+
- uses: actions/checkout@v5
42+
- uses: dtolnay/rust-toolchain@master
43+
with:
44+
toolchain: ${{ matrix.toolchain }}
45+
targets: aarch64-unknown-none-softfloat,i586-unknown-linux-musl,riscv32imac-unknown-none-elf,riscv64gc-unknown-none-elf,x86_64-unknown-none
46+
- uses: taiki-e/install-action@cargo-hack
47+
- run: |
48+
cargo hack build --feature-powerset --examples ${{ matrix.args }}
49+
cargo hack build --feature-powerset --examples ${{ matrix.args }} --target aarch64-unknown-none-softfloat
50+
cargo hack build --feature-powerset --examples ${{ matrix.args }} --target i586-unknown-linux-musl
51+
cargo hack build --feature-powerset --examples ${{ matrix.args }} --target riscv32imac-unknown-none-elf
52+
cargo hack build --feature-powerset --examples ${{ matrix.args }} --target riscv64gc-unknown-none-elf
53+
cargo hack build --feature-powerset --examples ${{ matrix.args }} --target x86_64-unknown-none
54+
55+
doc:
56+
name: Doc
57+
runs-on: ubuntu-latest
58+
steps:
59+
- uses: actions/checkout@v5
60+
- uses: dtolnay/rust-toolchain@stable
61+
- run: cargo doc --all-features
62+
63+
fmt:
64+
name: Format
65+
runs-on: ubuntu-latest
66+
steps:
67+
- uses: actions/checkout@v5
68+
- uses: dtolnay/rust-toolchain@nightly
69+
with:
70+
components: rustfmt
71+
- run: cargo fmt --all --check
72+
73+
test:
74+
name: Test
75+
runs-on: ubuntu-latest
76+
steps:
77+
- uses: actions/checkout@v5
78+
- uses: dtolnay/rust-toolchain@stable
79+
- run: cargo test --all-features

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/target

‎Cargo.lock‎

Lines changed: 16 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎Cargo.toml‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
[package]
2+
name = "mem-barrier"
3+
version = "0.1.0"
4+
authors = ["Martin Kröning <mkroening@posteo.net>"]
5+
edition = "2024"
6+
description = "Cross-architecture, no-std memory barriers."
7+
repository = "https://github.com/rust-osdev/mem-barrier"
8+
license = "MIT OR Apache-2.0"
9+
keywords = ["memory-barrier", "mb", "dsb", "fence", "mfence"]
10+
categories = ["concurrency", "embedded", "hardware-support", "no-std::no-alloc"]
11+
12+
[features]
13+
default = ["stdarch"]
14+
nightly = []
15+
stdarch = []
16+
17+
[dependencies]
18+
cfg-if = "1"

‎LICENSE-APACHE‎

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

‎LICENSE-MIT‎

Lines changed: 23 additions & 0 deletions
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.

‎README.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# mem-barrier
2+
3+
[![Crates.io](https://img.shields.io/crates/v/mem-barrier)](https://crates.io/crates/mem-barrier)
4+
[![docs.rs](https://img.shields.io/docsrs/mem-barrier)](https://docs.rs/mem-barrier)
5+
[![CI](https://github.com/rust-osdev/mem-barrier/actions/workflows/ci.yml/badge.svg)](https://github.com/rust-osdev/mem-barrier/actions/workflows/ci.yml)
6+
7+
This crate provides cross-architecture, no-std memory barriers.
8+
9+
For API documentation, see the [docs].
10+
11+
[docs]: https://docs.rs/mem-barrier
12+
13+
## Examples
14+
15+
```rust
16+
use mem_barrier::{mem_barrier, BarrierKind, BarrierType};
17+
18+
mem_barrier(BarrierKind::Mmio, BarrierType::General);
19+
```
20+
21+
## License
22+
23+
Licensed under either of
24+
25+
- Apache License, Version 2.0
26+
([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
27+
- MIT license
28+
([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
29+
30+
at your option.
31+
32+
### Contribution
33+
34+
Unless you explicitly state otherwise, any contribution intentionally submitted
35+
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
36+
dual licensed as above, without any additional terms or conditions.

‎examples/build.rs‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
#![cfg_attr(target_os = "none", no_std)]
2+
#![cfg_attr(target_os = "none", no_main)]
3+
4+
use mem_barrier::{BarrierKind, BarrierType, mem_barrier};
5+
6+
fn main() {
7+
for kind in [
8+
BarrierKind::Mmio,
9+
BarrierKind::Smp,
10+
BarrierKind::Dma,
11+
BarrierKind::Compiler,
12+
] {
13+
for ty in [BarrierType::General, BarrierType::Read, BarrierType::Write] {
14+
mem_barrier(kind, ty);
15+
}
16+
}
17+
}
18+
19+
#[cfg(target_os = "none")]
20+
#[unsafe(no_mangle)]
21+
extern "C" fn _start() -> ! {
22+
main();
23+
24+
loop {}
25+
}
26+
27+
#[cfg(target_os = "none")]
28+
#[panic_handler]
29+
fn panic(_info: &core::panic::PanicInfo) -> ! {
30+
loop {}
31+
}

‎rustfmt.toml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
format_code_in_doc_comments = true
2+
group_imports = "StdExternalCrate"
3+
imports_granularity = "Module"

0 commit comments

Comments
 (0)