summaryrefslogtreecommitdiffstats
path: root/vendor/cpufeatures/README.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-17 12:02:58 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-17 12:02:58 +0000
commit698f8c2f01ea549d77d7dc3338a12e04c11057b9 (patch)
tree173a775858bd501c378080a10dca74132f05bc50 /vendor/cpufeatures/README.md
parentInitial commit. (diff)
downloadrustc-698f8c2f01ea549d77d7dc3338a12e04c11057b9.tar.xz
rustc-698f8c2f01ea549d77d7dc3338a12e04c11057b9.zip
Adding upstream version 1.64.0+dfsg1.upstream/1.64.0+dfsg1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'vendor/cpufeatures/README.md')
-rw-r--r--vendor/cpufeatures/README.md90
1 files changed, 90 insertions, 0 deletions
diff --git a/vendor/cpufeatures/README.md b/vendor/cpufeatures/README.md
new file mode 100644
index 000000000..5a5bb4063
--- /dev/null
+++ b/vendor/cpufeatures/README.md
@@ -0,0 +1,90 @@
+# [RustCrypto]: CPU Feature Detection
+
+[![crate][crate-image]][crate-link]
+[![Docs][docs-image]][docs-link]
+![Apache2/MIT licensed][license-image]
+![Rust Version][rustc-image]
+[![Project Chat][chat-image]][chat-link]
+[![Build Status][build-image]][build-link]
+
+Lightweight and efficient runtime CPU feature detection for `aarch64` and
+`x86`/`x86_64` targets.
+
+Supports `no_std` as well as mobile targets including iOS and Android,
+providing an alternative to the `std`-dependent `is_x86_feature_detected!`
+macro.
+
+[Documentation][docs-link]
+
+## Supported architectures
+
+### `aarch64`: Android, iOS, Linux, and macOS/M4 only
+
+Note: ARM64 does not support OS-independent feature detection, so support must
+be implemented on an OS-by-OS basis.
+
+Target features:
+
+- `aes`
+- `sha2`
+- `sha3`
+
+Note: please open a GitHub Issue to request support for additional features.
+
+### `x86`/`x86_64`: OS independent and `no_std`-friendly
+
+Target features:
+
+- `adx`
+- `aes`
+- `avx`
+- `avx2`
+- `bmi1`
+- `bmi2`
+- `fma`
+- `mmx`
+- `pclmulqdq`
+- `popcnt`
+- `rdrand`
+- `rdseed`
+- `sgx`
+- `sha`
+- `sse`
+- `sse2`
+- `sse3`
+- `sse4.1`
+- `sse4.2`
+- `ssse3`
+
+## License
+
+Licensed under either of:
+
+ * [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)
+ * [MIT license](http://opensource.org/licenses/MIT)
+
+at your option.
+
+### Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally submitted
+for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
+dual licensed as above, without any additional terms or conditions.
+
+[//]: # (badges)
+
+[crate-image]: https://img.shields.io/crates/v/cpufeatures.svg
+[crate-link]: https://crates.io/crates/cpufeatures
+[docs-image]: https://docs.rs/cpufeatures/badge.svg
+[docs-link]: https://docs.rs/cpufeatures/
+[license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg
+[rustc-image]: https://img.shields.io/badge/rustc-1.40+-blue.svg
+[chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg
+[chat-link]: https://rustcrypto.zulipchat.com/#narrow/stream/260052-utils
+[build-image]: https://github.com/RustCrypto/utils/workflows/cpufeatures/badge.svg?branch=master&event=push
+[build-link]: https://github.com/RustCrypto/utils/actions/workflows/cpufeatures.yml
+
+[//]: # (general links)
+
+[RustCrypto]: https://github.com/rustcrypto
+[RustCrypto/utils#378]: https://github.com/RustCrypto/utils/issues/378