projects / rustc.git / blame
| Commit | Line | Data |
|---|---|---|
| 9fa01778 XL |
1 | `core::arch` - Rust's core library architecture-specific intrinsics |
| 2 | ======= | |
| 3 | ||
| 74b04a01 | 4 | [![core_arch_crate_badge]][core_arch_crate_link] [![core_arch_docs_badge]][core_arch_docs_link] |
| 9fa01778 XL |
5 | |
| 6 | ||
| 7 | The `core::arch` module implements architecture-dependent intrinsics (e.g. SIMD). | |
| 8 | ||
| 9 | # Usage | |
| 10 | ||
| 11 | `core::arch` is available as part of `libcore` and it is re-exported by | |
| 12 | `libstd`. Prefer using it via `core::arch` or `std::arch` than via this crate. | |
| 13 | Unstable features are often available in nightly Rust via the | |
| 14 | `feature(stdsimd)`. | |
| 15 | ||
| 16 | Using `core::arch` via this crate requires nightly Rust, and it can (and does) | |
| 17 | break often. The only cases in which you should consider using it via this crate | |
| 18 | are: | |
| 19 | ||
| 20 | * if you need to re-compile `core::arch` yourself, e.g., with particular | |
| 21 | target-features enabled that are not enabled for `libcore`/`libstd`. Note: if | |
| 22 | you need to re-compile it for a non-standard target, please prefer using | |
| 23 | `xargo` and re-compiling `libcore`/`libstd` as appropriate instead of using | |
| 24 | this crate. | |
| 25 | ||
| 26 | * using some features that might not be available even behind unstable Rust | |
| 27 | features. We try to keep these to a minimum. If you need to use some of these | |
| 28 | features, please open an issue so that we can expose them in nightly Rust and | |
| 29 | you can use them from there. | |
| 30 | ||
| 31 | # Documentation | |
| 32 | ||
| 33 | * [Documentation - i686][i686] | |
| 34 | * [Documentation - x86\_64][x86_64] | |
| 35 | * [Documentation - arm][arm] | |
| 36 | * [Documentation - aarch64][aarch64] | |
| 37 | * [Documentation - powerpc][powerpc] | |
| 38 | * [Documentation - powerpc64][powerpc64] | |
| 39 | * [How to get started][contrib] | |
| 40 | * [How to help implement intrinsics][help-implement] | |
| 41 | ||
| 416331ca XL |
42 | [contrib]: https://github.com/rust-lang/stdarch/blob/master/CONTRIBUTING.md |
| 43 | [help-implement]: https://github.com/rust-lang/stdarch/issues/40 | |
| 44 | [i686]: https://rust-lang.github.io/stdarch/i686/core_arch/ | |
| 45 | [x86_64]: https://rust-lang.github.io/stdarch/x86_64/core_arch/ | |
| 46 | [arm]: https://rust-lang.github.io/stdarch/arm/core_arch/ | |
| 47 | [aarch64]: https://rust-lang.github.io/stdarch/aarch64/core_arch/ | |
| 48 | [powerpc]: https://rust-lang.github.io/stdarch/powerpc/core_arch/ | |
| 49 | [powerpc64]: https://rust-lang.github.io/stdarch/powerpc64/core_arch/ | |
| 9fa01778 XL |
50 | |
| 51 | # License | |
| 52 | ||
| 53 | `core_arch` is primarily distributed under the terms of both the MIT license and | |
| 54 | the Apache License (Version 2.0), with portions covered by various BSD-like | |
| 55 | licenses. | |
| 56 | ||
| 57 | See LICENSE-APACHE, and LICENSE-MIT for details. | |
| 58 | ||
| 59 | # Contribution | |
| 60 | ||
| 61 | Unless you explicitly state otherwise, any contribution intentionally submitted | |
| 62 | for inclusion in `core_arch` by you, as defined in the Apache-2.0 license, | |
| 63 | shall be dual licensed as above, without any additional terms or conditions. | |
| 64 | ||
| 9fa01778 XL |
65 | [core_arch_crate_badge]: https://img.shields.io/crates/v/core_arch.svg |
| 66 | [core_arch_crate_link]: https://crates.io/crates/core_arch | |
| 67 | [core_arch_docs_badge]: https://docs.rs/core_arch/badge.svg | |
| 68 | [core_arch_docs_link]: https://docs.rs/core_arch/ |