Import 'percore' crate
Request Document: go/android-rust-importing-crates
For CL Reviewers: go/android3p#cl-review
For Build Team: go/ab-third-party-imports
Bug: 354713044
Test: m libpercore
Change-Id: Ifb2d820da67717a03bf5d9da4de68102e69e6069
diff --git a/.cargo/config.toml b/.cargo/config.toml
new file mode 100644
index 0000000..724feba
--- /dev/null
+++ b/.cargo/config.toml
@@ -0,0 +1,2 @@
+[build]
+target = "aarch64-unknown-none"
diff --git a/.cargo_vcs_info.json b/.cargo_vcs_info.json
new file mode 100644
index 0000000..84d3c46
--- /dev/null
+++ b/.cargo_vcs_info.json
@@ -0,0 +1,6 @@
+{
+ "git": {
+ "sha1": "dea0c085d89dd0f2209e1cddeafa32ad409fc910"
+ },
+ "path_in_vcs": ""
+}
\ No newline at end of file
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
new file mode 100644
index 0000000..98e44ee
--- /dev/null
+++ b/.github/dependabot.yml
@@ -0,0 +1,10 @@
+version: 2
+updates:
+ - package-ecosystem: "cargo"
+ directory: "/"
+ schedule:
+ interval: "weekly"
+ - package-ecosystem: "github-actions"
+ directory: "/"
+ schedule:
+ interval: "weekly"
diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml
new file mode 100644
index 0000000..3025202
--- /dev/null
+++ b/.github/workflows/rust.yml
@@ -0,0 +1,37 @@
+name: Rust
+
+on:
+ push:
+ branches: [main]
+ pull_request:
+
+env:
+ CARGO_TERM_COLOR: always
+
+jobs:
+ build:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v4
+ - name: Install aarch64 toolchain
+ uses: actions-rs/toolchain@v1
+ with:
+ toolchain: stable
+ target: aarch64-unknown-none
+ - name: Build
+ run: cargo build
+ - name: Build for x68_64-unknown-linux-gnu
+ run: cargo build --target=x86_64-unknown-linux-gnu
+ - name: Run tests
+ run: cargo test --target=x86_64-unknown-linux-gnu
+ - name: Run clippy
+ uses: actions-rs/clippy-check@v1
+ with:
+ token: ${{ secrets.GITHUB_TOKEN }}
+
+ format:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v4
+ - name: Format Rust code
+ run: cargo fmt --all -- --check
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..2e0ed6d
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,2 @@
+/.vscode
+/target
diff --git a/AUTHORS b/AUTHORS
new file mode 100644
index 0000000..e5ce103
--- /dev/null
+++ b/AUTHORS
@@ -0,0 +1,7 @@
+# This is the list of percore's significant contributors.
+#
+# This does not necessarily list everyone who has contributed code,
+# especially since many employees of one corporation may be contributing.
+# To see the full list of contributors, see the revision history in
+# source control.
+Google LLC
diff --git a/Android.bp b/Android.bp
new file mode 100644
index 0000000..3495d19
--- /dev/null
+++ b/Android.bp
@@ -0,0 +1,43 @@
+// This file is generated by cargo_embargo.
+// Do not modify this file after the first "rust_*" or "genrule" module
+// because the changes will be overridden on upgrade.
+// Content before the first "rust_*" or "genrule" module is preserved.
+
+package {
+ default_applicable_licenses: [
+ "external_rust_crates_percore_license",
+ ],
+}
+
+license {
+ name: "external_rust_crates_percore_license",
+ visibility: [":__subpackages__"],
+ license_kinds: [
+ "SPDX-license-identifier-Apache-2.0",
+ "SPDX-license-identifier-MIT",
+ ],
+ license_text: [
+ "LICENSE",
+ ],
+}
+
+rust_library_rlib {
+ name: "libpercore",
+ crate_name: "percore",
+ cargo_env_compat: true,
+ cargo_pkg_version: "0.1.0",
+ crate_root: "src/lib.rs",
+ edition: "2021",
+ apex_available: [
+ "//apex_available:platform",
+ "//apex_available:anyapex",
+ ],
+ prefer_rlib: true,
+ no_stdlibs: true,
+ stdlibs: [
+ "libcompiler_builtins.rust_sysroot",
+ "libcore.rust_sysroot",
+ ],
+ product_available: true,
+ vendor_available: true,
+}
diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..e990334
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.1.0
+
+Initial release.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..c88469f
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,26 @@
+# How to Contribute
+
+We'd love to accept your patches and contributions to this project. There are just a few small
+guidelines you need to follow.
+
+## Contributor License Agreement
+
+Contributions to this project must be accompanied by a Contributor License Agreement (CLA). You (or
+your employer) retain the copyright to your contribution; this simply gives us permission to use and
+redistribute your contributions as part of the project. Head over to
+<https://cla.developers.google.com/> to see your current agreements on file or to sign a new one.
+
+You generally only need to submit a CLA once, so if you've already submitted one (even if it was for
+a different project), you probably don't need to do it again.
+
+## Code Reviews
+
+All submissions, including submissions by project members, require review. We use GitHub pull
+requests for this purpose. Consult
+[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more information on using
+pull requests.
+
+## Community Guidelines
+
+This project follows
+[Google's Open Source Community Guidelines](https://opensource.google/conduct/).
diff --git a/Cargo.toml b/Cargo.toml
new file mode 100644
index 0000000..0d696b9
--- /dev/null
+++ b/Cargo.toml
@@ -0,0 +1,34 @@
+# 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 = "2021"
+name = "percore"
+version = "0.1.0"
+authors = ["Andrew Walbran <qwandor@google.com>"]
+description = "Safe per-CPU core mutable state on no_std platforms through exception masking."
+readme = "README.md"
+keywords = [
+ "aarch64",
+ "exceptions",
+]
+categories = [
+ "embedded",
+ "no-std",
+ "rust-patterns",
+]
+license = "MIT OR Apache-2.0"
+repository = "https://github.com/google/percore"
+
+[package.metadata.docs.rs]
+default-target = "aarch64-unknown-none"
+
+[dependencies]
diff --git a/Cargo.toml.orig b/Cargo.toml.orig
new file mode 100644
index 0000000..b7c26e1
--- /dev/null
+++ b/Cargo.toml.orig
@@ -0,0 +1,15 @@
+[package]
+name = "percore"
+version = "0.1.0"
+edition = "2021"
+license = "MIT OR Apache-2.0"
+description = "Safe per-CPU core mutable state on no_std platforms through exception masking."
+authors = ["Andrew Walbran <qwandor@google.com>"]
+repository = "https://github.com/google/percore"
+keywords = ["aarch64", "exceptions"]
+categories = ["embedded", "no-std", "rust-patterns"]
+
+[dependencies]
+
+[package.metadata.docs.rs]
+default-target = "aarch64-unknown-none"
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..fad2434
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,229 @@
+This project is dual-licensed under Apache 2.0 and MIT terms.
+
+====
+
+MIT License
+
+Copyright (c) 2022 The aarch64-paging Authors.
+
+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.
+
+====
+
+ 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
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ 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/LICENSE-APACHE b/LICENSE-APACHE
new file mode 100644
index 0000000..d645695
--- /dev/null
+++ b/LICENSE-APACHE
@@ -0,0 +1,202 @@
+
+ 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
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ 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/LICENSE-MIT b/LICENSE-MIT
new file mode 100644
index 0000000..cc11d8a
--- /dev/null
+++ b/LICENSE-MIT
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 The aarch64-paging Authors.
+
+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/METADATA b/METADATA
new file mode 100644
index 0000000..e3cf932
--- /dev/null
+++ b/METADATA
@@ -0,0 +1,21 @@
+name: "percore"
+description: "Safe per-CPU core mutable state on no_std platforms through exception masking."
+third_party {
+ identifier {
+ type: "crates.io"
+ value: "percore"
+ }
+ identifier {
+ type: "Archive"
+ value: "https://static.crates.io/crates/percore/percore-0.1.0.crate"
+ primary_source: true
+ }
+ version: "0.1.0"
+ # Dual-licensed, using the least restrictive per go/thirdpartylicenses#same.
+ license_type: NOTICE
+ last_upgrade_date {
+ year: 2024
+ month: 7
+ day: 22
+ }
+}
diff --git a/MODULE_LICENSE_APACHE2 b/MODULE_LICENSE_APACHE2
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/MODULE_LICENSE_APACHE2
diff --git a/OWNERS b/OWNERS
new file mode 100644
index 0000000..48bea6e
--- /dev/null
+++ b/OWNERS
@@ -0,0 +1,2 @@
+# Bug component: 688011
+include platform/prebuilts/rust:main:/OWNERS
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c8a0143
--- /dev/null
+++ b/README.md
@@ -0,0 +1,76 @@
+# percore
+
+[](https://crates.io/crates/percore)
+[](https://docs.rs/percore)
+
+Safe per-CPU core mutable state on no_std platforms through exception masking.
+
+This crate provides two main wrapper types: `PerCore` to provide an instance of a value per
+CPU core, where each core can access only its instance, and `ExceptionLock` to guard a value
+so that it can only be accessed while exceptions are masked. These may be combined with
+`RefCell` to provide safe per-core mutable state.
+
+`ExceptionLock` may also be combined with a spinlock-based mutex (such as one provided by the
+[`spin`](https://crates.io/crates/spin) crate) to avoid deadlocks when accessing global mutable
+state from exception handlers.
+
+# Example
+
+```rust
+use core::cell::RefCell;
+use percore::{exception_free, Cores, ExceptionLock, PerCore};
+
+/// The total number of CPU cores in the target system.
+const CORE_COUNT: usize = 2;
+
+struct CoresImpl;
+
+unsafe impl Cores for CoresImpl {
+ fn core_index() -> usize {
+ todo!("Return the index of the current CPU core, 0 or 1")
+ }
+}
+
+struct CoreState {
+ // Your per-core mutable state goes here...
+ foo: u32,
+}
+
+const EMPTY_CORE_STATE: ExceptionLock<RefCell<CoreState>> =
+ ExceptionLock::new(RefCell::new(CoreState { foo: 0 }));
+static CORE_STATE: PerCore<ExceptionLock<RefCell<CoreState>>, CoresImpl, CORE_COUNT> =
+ PerCore::new([EMPTY_CORE_STATE; CORE_COUNT]);
+
+fn main() {
+ // Mask exceptions while accessing mutable state.
+ exception_free(|token| {
+ // `token` proves that interrupts are masked, so we can safely access per-core mutable
+ // state.
+ CORE_STATE.get().borrow_mut(token).foo = 42;
+ });
+}
+```
+
+This is not an officially supported Google product.
+
+## Supported architectures
+
+Currently only aarch64 is fully supported. The crate will build for other architectures, but you'll
+need to provide your own implementation of the `exception_free` function. Patches are welcome to add
+support for other architectures.
+
+## License
+
+Licensed under either of
+
+- Apache License, Version 2.0
+ ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
+- MIT license
+ ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
+
+at your option.
+
+## Contributing
+
+If you want to contribute to the project, see details of
+[how we accept contributions](CONTRIBUTING.md).
diff --git a/cargo_embargo.json b/cargo_embargo.json
new file mode 100644
index 0000000..c2b6aa8
--- /dev/null
+++ b/cargo_embargo.json
@@ -0,0 +1,10 @@
+{
+ "package": {
+ "percore": {
+ "force_rlib": true,
+ "host_supported": false,
+ "no_std": true
+ }
+ },
+ "run_cargo": false
+}
diff --git a/src/exceptions.rs b/src/exceptions.rs
new file mode 100644
index 0000000..15578bb
--- /dev/null
+++ b/src/exceptions.rs
@@ -0,0 +1,57 @@
+// Copyright 2024 The percore Authors.
+// This project is dual-licensed under Apache 2.0 and MIT terms.
+// See LICENSE-APACHE and LICENSE-MIT for details.
+
+#[cfg(target_arch = "aarch64")]
+mod aarch64;
+#[cfg(target_arch = "aarch64")]
+use aarch64::{mask, restore};
+
+use core::marker::PhantomData;
+
+/// Runs the given function with exceptions masked.
+///
+/// Only IRQs, FIQs and SErrors can be masked. Synchronous exceptions cannot be masked and so may
+/// still occur.
+#[cfg(target_arch = "aarch64")]
+pub fn exception_free<T>(f: impl FnOnce(ExceptionFree<'_>) -> T) -> T {
+ // Mask all exceptions and save previous mask state.
+ let prev = mask();
+ // SAFETY: We just masked exceptions.
+ let token = unsafe { ExceptionFree::new() };
+
+ let result = f(token);
+
+ // SAFETY: `token` has been dropped by now, as its lifetime prevents `f` from storing it.
+ unsafe {
+ // Restore previous exception mask state.
+ restore(prev);
+ }
+
+ result
+}
+
+/// A token proving that exceptions are currently masked.
+///
+/// Note that synchronous exceptions cannot be masked and so may still occur.
+#[derive(Clone, Copy, Debug)]
+pub struct ExceptionFree<'cs> {
+ _private: PhantomData<&'cs ()>,
+}
+
+impl<'cs> ExceptionFree<'cs> {
+ /// Constructs a new instance of `ExceptionFree`, promising that exceptions will remain masked
+ /// for at least its lifetime.
+ ///
+ /// This usually should not be called directly; instead use [`exception_free`].
+ ///
+ /// # Safety
+ ///
+ /// `ExceptionFree` must only be constructed while exceptions are masked, and they must not be
+ /// unmasked until after it is dropped.
+ pub unsafe fn new() -> Self {
+ Self {
+ _private: PhantomData,
+ }
+ }
+}
diff --git a/src/exceptions/aarch64.rs b/src/exceptions/aarch64.rs
new file mode 100644
index 0000000..d92a83d
--- /dev/null
+++ b/src/exceptions/aarch64.rs
@@ -0,0 +1,41 @@
+// Copyright 2024 The percore Authors.
+// This project is dual-licensed under Apache 2.0 and MIT terms.
+// See LICENSE-APACHE and LICENSE-MIT for details.
+
+use core::arch::asm;
+
+/// Masks IRQs, FIQs, SErrors and Debug exceptions.
+///
+/// Returns the previous mask value, to be passed to [`unmask`].
+pub fn mask() -> u64 {
+ let prev;
+
+ // SAFETY: Writing to this system register doesn't access memory in any way.
+ unsafe {
+ asm!(
+ "mrs {prev:x}, DAIF",
+ "msr DAIFSet, #0xf",
+ options(nostack),
+ prev = out(reg) prev,
+ );
+ }
+
+ prev
+}
+
+/// Restores the given previous exception mask value.
+///
+/// # Safety
+///
+/// Must not be called while a corresponding `ExceptionFree` token exists.
+pub unsafe fn restore(prev: u64) {
+ // SAFETY: Writing to this system register doesn't access memory in any way. The caller promised
+ // that there is no `ExceptionFree` token.
+ unsafe {
+ asm!(
+ "msr DAIF, {prev:x}",
+ options(nostack),
+ prev=in(reg)prev,
+ );
+ }
+}
diff --git a/src/lib.rs b/src/lib.rs
new file mode 100644
index 0000000..24f5cd6
--- /dev/null
+++ b/src/lib.rs
@@ -0,0 +1,113 @@
+// Copyright 2024 The percore Authors.
+// This project is dual-licensed under Apache 2.0 and MIT terms.
+// See LICENSE-APACHE and LICENSE-MIT for details.
+
+//! Safe per-CPU core mutable state on no_std platforms through exception masking.
+//!
+//! This crate provides two main wrapper types: [`PerCore`] to provide an instance of a value per
+//! CPU core, where each core can access only its instance, and [`ExceptionLock`] to guard a value
+//! so that it can only be accessed while exceptions are masked. These may be combined with
+//! `RefCell` to provide safe per-core mutable state.
+//!
+//! `ExceptionLock` may also be combined with a spinlock-based mutex (such as one provided by the
+//! [`spin`](https://crates.io/crates/spin) crate) to avoid deadlocks when accessing global mutable
+//! state from exception handlers.
+//!
+//! # Example
+//!
+//! ```
+//! use core::cell::RefCell;
+//! # #[cfg(target_arch = "aarch64")]
+//! use percore::{exception_free, Cores, ExceptionLock, PerCore};
+//! # #[cfg(not(target_arch = "aarch64"))]
+//! # use percore::{Cores, ExceptionLock, PerCore};
+//!
+//! /// The total number of CPU cores in the target system.
+//! const CORE_COUNT: usize = 2;
+//!
+//! struct CoresImpl;
+//!
+//! unsafe impl Cores for CoresImpl {
+//! fn core_index() -> usize {
+//! todo!("Return the index of the current CPU core, 0 or 1")
+//! }
+//! }
+//!
+//! struct CoreState {
+//! // Your per-core mutable state goes here...
+//! foo: u32,
+//! }
+//!
+//! const EMPTY_CORE_STATE: ExceptionLock<RefCell<CoreState>> =
+//! ExceptionLock::new(RefCell::new(CoreState { foo: 0 }));
+//! static CORE_STATE: PerCore<ExceptionLock<RefCell<CoreState>>, CoresImpl, CORE_COUNT> =
+//! PerCore::new([EMPTY_CORE_STATE; CORE_COUNT]);
+//!
+//! fn main() {
+//! // Mask exceptions while accessing mutable state.
+//! # #[cfg(target_arch = "aarch64")]
+//! exception_free(|token| {
+//! // `token` proves that interrupts are masked, so we can safely access per-core mutable
+//! // state.
+//! CORE_STATE.get().borrow_mut(token).foo = 42;
+//! });
+//! }
+//! ```
+
+#![no_std]
+
+mod exceptions;
+mod lock;
+
+#[cfg(target_arch = "aarch64")]
+pub use self::exceptions::exception_free;
+pub use self::{exceptions::ExceptionFree, lock::ExceptionLock};
+
+use core::marker::PhantomData;
+
+/// Trait abstracting how to get the index of the current CPU core.
+///
+/// # Safety
+///
+/// `core_index` must never return the same index on different CPU cores.
+pub unsafe trait Cores {
+ /// Returns the index of the current CPU core.
+ fn core_index() -> usize;
+}
+
+/// A type which allows values to be stored per CPU core. Only the value associated with the current
+/// CPU core can be accessed.
+///
+/// To use this type you must first implement the [`Cores`] trait for your platform.
+///
+/// `C::core_index()` must always return a value less than `CORE_COUNT` or there will be a runtime
+/// panic.
+pub struct PerCore<T, C: Cores, const CORE_COUNT: usize> {
+ values: [T; CORE_COUNT],
+ _cores: PhantomData<C>,
+}
+
+impl<T, C: Cores, const CORE_COUNT: usize> PerCore<T, C, CORE_COUNT> {
+ /// Creates a new set of per-core values.
+ pub const fn new(values: [T; CORE_COUNT]) -> Self {
+ Self {
+ values,
+ _cores: PhantomData,
+ }
+ }
+
+ /// Gets a shared reference to the value for the current CPU core.
+ pub fn get(&self) -> &T {
+ &self.values[C::core_index()]
+ }
+}
+
+// SAFETY: Both different CPU cores and different exception contexts must be treated as separate
+// 'threads' for the purposes of Rust's memory model. `PerCore` only allows access to the value for
+// the current core, and `ExceptionLock` requires exceptions to be disabled while accessing it which
+// prevents concurrent access to its contents from different exception contexts. The combination of
+// the two therefore prevents concurrent access to `T`.
+unsafe impl<T: Send, C: Cores, const CORE_COUNT: usize> Sync
+ for PerCore<ExceptionLock<T>, C, CORE_COUNT>
+{
+}
diff --git a/src/lock.rs b/src/lock.rs
new file mode 100644
index 0000000..ce25952
--- /dev/null
+++ b/src/lock.rs
@@ -0,0 +1,40 @@
+// Copyright 2024 The percore Authors.
+// This project is dual-licensed under Apache 2.0 and MIT terms.
+// See LICENSE-APACHE and LICENSE-MIT for details.
+
+use crate::ExceptionFree;
+use core::cell::{RefCell, RefMut};
+
+/// Allows access to the given value only while exceptions are masked, allowing it to be shared
+/// between exception contexts on a given core.
+pub struct ExceptionLock<T> {
+ value: T,
+}
+
+impl<T> ExceptionLock<T> {
+ /// Creates a new `ExceptionLock` containing the given value.
+ pub const fn new(value: T) -> Self {
+ Self { value }
+ }
+
+ /// Gets a unique reference to the contents of the cell, given a token proving that exceptions
+ /// are currently masked.
+ pub fn borrow<'cs>(&'cs self, _: ExceptionFree<'cs>) -> &'cs T {
+ &self.value
+ }
+}
+
+impl<T> ExceptionLock<RefCell<T>> {
+ /// Gets a unique reference to the contents of the `RefCell`, given a token proving that
+ /// exceptions are currently masked.
+ pub fn borrow_mut<'cs>(&'cs self, token: ExceptionFree<'cs>) -> RefMut<'cs, T> {
+ self.borrow(token).borrow_mut()
+ }
+
+ /// Returns a raw pointer to the contents of the cell.
+ ///
+ /// This must not be dereferenced while any `RefMut` to the same cell exists.
+ pub fn as_ptr(&self) -> *mut T {
+ self.value.as_ptr()
+ }
+}
