library/portable-simd/crates/core_simd/src/intrinsics.rs

   1 //! This module contains the LLVM intrinsics bindings that provide the functionality for this
   2 //! crate.
   3 //!
   4 //! The LLVM assembly language is documented here: <https://llvm.org/docs/LangRef.html>
   5
   6 /// These intrinsics aren't linked directly from LLVM and are mostly undocumented, however they are
   7 /// simply lowered to the matching LLVM instructions by the compiler.  The associated instruction
   8 /// is documented alongside each intrinsic.
   9 extern "platform-intrinsic" {
  10     /// add/fadd
  11     pub(crate) fn simd_add<T>(x: T, y: T) -> T;
  12
  13     /// sub/fsub
  14     pub(crate) fn simd_sub<T>(x: T, y: T) -> T;
  15
  16     /// mul/fmul
  17     pub(crate) fn simd_mul<T>(x: T, y: T) -> T;
  18
  19     /// udiv/sdiv/fdiv
  20     pub(crate) fn simd_div<T>(x: T, y: T) -> T;
  21
  22     /// urem/srem/frem
  23     pub(crate) fn simd_rem<T>(x: T, y: T) -> T;
  24
  25     /// shl
  26     pub(crate) fn simd_shl<T>(x: T, y: T) -> T;
  27
  28     /// lshr/ashr
  29     pub(crate) fn simd_shr<T>(x: T, y: T) -> T;
  30
  31     /// and
  32     pub(crate) fn simd_and<T>(x: T, y: T) -> T;
  33
  34     /// or
  35     pub(crate) fn simd_or<T>(x: T, y: T) -> T;
  36
  37     /// xor
  38     pub(crate) fn simd_xor<T>(x: T, y: T) -> T;
  39
  40     /// fptoui/fptosi/uitofp/sitofp
  41     pub(crate) fn simd_cast<T, U>(x: T) -> U;
  42     /// follows Rust's `T as U` semantics, including saturating float casts
  43     /// which amounts to the same as `simd_cast` for many cases
  44     #[cfg(not(bootstrap))]
  45     pub(crate) fn simd_as<T, U>(x: T) -> U;
  46
  47     /// neg/fneg
  48     pub(crate) fn simd_neg<T>(x: T) -> T;
  49
  50     /// fabs
  51     pub(crate) fn simd_fabs<T>(x: T) -> T;
  52
  53     // minnum/maxnum
  54     pub(crate) fn simd_fmin<T>(x: T, y: T) -> T;
  55     pub(crate) fn simd_fmax<T>(x: T, y: T) -> T;
  56
  57     pub(crate) fn simd_eq<T, U>(x: T, y: T) -> U;
  58     pub(crate) fn simd_ne<T, U>(x: T, y: T) -> U;
  59     pub(crate) fn simd_lt<T, U>(x: T, y: T) -> U;
  60     pub(crate) fn simd_le<T, U>(x: T, y: T) -> U;
  61     pub(crate) fn simd_gt<T, U>(x: T, y: T) -> U;
  62     pub(crate) fn simd_ge<T, U>(x: T, y: T) -> U;
  63
  64     // shufflevector
  65     pub(crate) fn simd_shuffle<T, U, V>(x: T, y: T, idx: U) -> V;
  66
  67     pub(crate) fn simd_gather<T, U, V>(val: T, ptr: U, mask: V) -> T;
  68     pub(crate) fn simd_scatter<T, U, V>(val: T, ptr: U, mask: V);
  69
  70     // {s,u}add.sat
  71     pub(crate) fn simd_saturating_add<T>(x: T, y: T) -> T;
  72
  73     // {s,u}sub.sat
  74     pub(crate) fn simd_saturating_sub<T>(x: T, y: T) -> T;
  75
  76     // reductions
  77     pub(crate) fn simd_reduce_add_ordered<T, U>(x: T, y: U) -> U;
  78     pub(crate) fn simd_reduce_mul_ordered<T, U>(x: T, y: U) -> U;
  79     #[allow(unused)]
  80     pub(crate) fn simd_reduce_all<T>(x: T) -> bool;
  81     #[allow(unused)]
  82     pub(crate) fn simd_reduce_any<T>(x: T) -> bool;
  83     pub(crate) fn simd_reduce_max<T, U>(x: T) -> U;
  84     pub(crate) fn simd_reduce_min<T, U>(x: T) -> U;
  85     pub(crate) fn simd_reduce_and<T, U>(x: T) -> U;
  86     pub(crate) fn simd_reduce_or<T, U>(x: T) -> U;
  87     pub(crate) fn simd_reduce_xor<T, U>(x: T) -> U;
  88
  89     // truncate integer vector to bitmask
  90     #[allow(unused)]
  91     pub(crate) fn simd_bitmask<T, U>(x: T) -> U;
  92
  93     // select
  94     pub(crate) fn simd_select<M, T>(m: M, a: T, b: T) -> T;
  95     #[allow(unused)]
  96     pub(crate) fn simd_select_bitmask<M, T>(m: M, a: T, b: T) -> T;
  97 }