src/libcore/intrinsics.rs

   1 //! Compiler intrinsics.
   2 //!
   3 //! The corresponding definitions are in `librustc_codegen_llvm/intrinsic.rs`.
   4 //!
   5 //! # Volatiles
   6 //!
   7 //! The volatile intrinsics provide operations intended to act on I/O
   8 //! memory, which are guaranteed to not be reordered by the compiler
   9 //! across other volatile intrinsics. See the LLVM documentation on
  10 //! [[volatile]].
  11 //!
  12 //! [volatile]: http://llvm.org/docs/LangRef.html#volatile-memory-accesses
  13 //!
  14 //! # Atomics
  15 //!
  16 //! The atomic intrinsics provide common atomic operations on machine
  17 //! words, with multiple possible memory orderings. They obey the same
  18 //! semantics as C++11. See the LLVM documentation on [[atomics]].
  19 //!
  20 //! [atomics]: http://llvm.org/docs/Atomics.html
  21 //!
  22 //! A quick refresher on memory ordering:
  23 //!
  24 //! * Acquire - a barrier for acquiring a lock. Subsequent reads and writes
  25 //!   take place after the barrier.
  26 //! * Release - a barrier for releasing a lock. Preceding reads and writes
  27 //!   take place before the barrier.
  28 //! * Sequentially consistent - sequentially consistent operations are
  29 //!   guaranteed to happen in order. This is the standard mode for working
  30 //!   with atomic types and is equivalent to Java's `volatile`.
  31
  32 #![unstable(feature = "core_intrinsics",
  33             reason = "intrinsics are unlikely to ever be stabilized, instead \
  34                       they should be used through stabilized interfaces \
  35                       in the rest of the standard library",
  36             issue = "0")]
  37 #![allow(missing_docs)]
  38
  39 #[stable(feature = "drop_in_place", since = "1.8.0")]
  40 #[rustc_deprecated(reason = "no longer an intrinsic - use `ptr::drop_in_place` directly",
  41                    since = "1.18.0")]
  42 pub use crate::ptr::drop_in_place;
  43
  44 extern "rust-intrinsic" {
  45     // N.B., these intrinsics take raw pointers because they mutate aliased
  46     // memory, which is not valid for either `&` or `&mut`.
  47
  48     /// Stores a value if the current value is the same as the `old` value.
  49     /// The stabilized version of this intrinsic is available on the
  50     /// `std::sync::atomic` types via the `compare_exchange` method by passing
  51     /// [`Ordering::SeqCst`](../../std/sync/atomic/enum.Ordering.html)
  52     /// as both the `success` and `failure` parameters. For example,
  53     /// [`AtomicBool::compare_exchange`][compare_exchange].
  54     ///
  55     /// [compare_exchange]: ../../std/sync/atomic/struct.AtomicBool.html#method.compare_exchange
  56     pub fn atomic_cxchg<T>(dst: *mut T, old: T, src: T) -> (T, bool);
  57     /// Stores a value if the current value is the same as the `old` value.
  58     /// The stabilized version of this intrinsic is available on the
  59     /// `std::sync::atomic` types via the `compare_exchange` method by passing
  60     /// [`Ordering::Acquire`](../../std/sync/atomic/enum.Ordering.html)
  61     /// as both the `success` and `failure` parameters. For example,
  62     /// [`AtomicBool::compare_exchange`][compare_exchange].
  63     ///
  64     /// [compare_exchange]: ../../std/sync/atomic/struct.AtomicBool.html#method.compare_exchange
  65     pub fn atomic_cxchg_acq<T>(dst: *mut T, old: T, src: T) -> (T, bool);
  66     /// Stores a value if the current value is the same as the `old` value.
  67     /// The stabilized version of this intrinsic is available on the
  68     /// `std::sync::atomic` types via the `compare_exchange` method by passing
  69     /// [`Ordering::Release`](../../std/sync/atomic/enum.Ordering.html)
  70     /// as the `success` and
  71     /// [`Ordering::Relaxed`](../../std/sync/atomic/enum.Ordering.html)
  72     /// as the `failure` parameters. For example,
  73     /// [`AtomicBool::compare_exchange`][compare_exchange].
  74     ///
  75     /// [compare_exchange]: ../../std/sync/atomic/struct.AtomicBool.html#method.compare_exchange
  76     pub fn atomic_cxchg_rel<T>(dst: *mut T, old: T, src: T) -> (T, bool);
  77     /// Stores a value if the current value is the same as the `old` value.
  78     /// The stabilized version of this intrinsic is available on the
  79     /// `std::sync::atomic` types via the `compare_exchange` method by passing
  80     /// [`Ordering::AcqRel`](../../std/sync/atomic/enum.Ordering.html)
  81     /// as the `success` and
  82     /// [`Ordering::Acquire`](../../std/sync/atomic/enum.Ordering.html)
  83     /// as the `failure` parameters. For example,
  84     /// [`AtomicBool::compare_exchange`][compare_exchange].
  85     ///
  86     /// [compare_exchange]: ../../std/sync/atomic/struct.AtomicBool.html#method.compare_exchange
  87     pub fn atomic_cxchg_acqrel<T>(dst: *mut T, old: T, src: T) -> (T, bool);
  88     /// Stores a value if the current value is the same as the `old` value.
  89     /// The stabilized version of this intrinsic is available on the
  90     /// `std::sync::atomic` types via the `compare_exchange` method by passing
  91     /// [`Ordering::Relaxed`](../../std/sync/atomic/enum.Ordering.html)
  92     /// as both the `success` and `failure` parameters. For example,
  93     /// [`AtomicBool::compare_exchange`][compare_exchange].
  94     ///
  95     /// [compare_exchange]: ../../std/sync/atomic/struct.AtomicBool.html#method.compare_exchange
  96     pub fn atomic_cxchg_relaxed<T>(dst: *mut T, old: T, src: T) -> (T, bool);
  97     /// Stores a value if the current value is the same as the `old` value.
  98     /// The stabilized version of this intrinsic is available on the
  99     /// `std::sync::atomic` types via the `compare_exchange` method by passing
 100     /// [`Ordering::SeqCst`](../../std/sync/atomic/enum.Ordering.html)
 101     /// as the `success` and
 102     /// [`Ordering::Relaxed`](../../std/sync/atomic/enum.Ordering.html)
 103     /// as the `failure` parameters. For example,
 104     /// [`AtomicBool::compare_exchange`][compare_exchange].
 105     ///
 106     /// [compare_exchange]: ../../std/sync/atomic/struct.AtomicBool.html#method.compare_exchange
 107     pub fn atomic_cxchg_failrelaxed<T>(dst: *mut T, old: T, src: T) -> (T, bool);
 108     /// Stores a value if the current value is the same as the `old` value.
 109     /// The stabilized version of this intrinsic is available on the
 110     /// `std::sync::atomic` types via the `compare_exchange` method by passing
 111     /// [`Ordering::SeqCst`](../../std/sync/atomic/enum.Ordering.html)
 112     /// as the `success` and
 113     /// [`Ordering::Acquire`](../../std/sync/atomic/enum.Ordering.html)
 114     /// as the `failure` parameters. For example,
 115     /// [`AtomicBool::compare_exchange`][compare_exchange].
 116     ///
 117     /// [compare_exchange]: ../../std/sync/atomic/struct.AtomicBool.html#method.compare_exchange
 118     pub fn atomic_cxchg_failacq<T>(dst: *mut T, old: T, src: T) -> (T, bool);
 119     /// Stores a value if the current value is the same as the `old` value.
 120     /// The stabilized version of this intrinsic is available on the
 121     /// `std::sync::atomic` types via the `compare_exchange` method by passing
 122     /// [`Ordering::Acquire`](../../std/sync/atomic/enum.Ordering.html)
 123     /// as the `success` and
 124     /// [`Ordering::Relaxed`](../../std/sync/atomic/enum.Ordering.html)
 125     /// as the `failure` parameters. For example,
 126     /// [`AtomicBool::compare_exchange`][compare_exchange].
 127     ///
 128     /// [compare_exchange]: ../../std/sync/atomic/struct.AtomicBool.html#method.compare_exchange
 129     pub fn atomic_cxchg_acq_failrelaxed<T>(dst: *mut T, old: T, src: T) -> (T, bool);
 130     /// Stores a value if the current value is the same as the `old` value.
 131     /// The stabilized version of this intrinsic is available on the
 132     /// `std::sync::atomic` types via the `compare_exchange` method by passing
 133     /// [`Ordering::AcqRel`](../../std/sync/atomic/enum.Ordering.html)
 134     /// as the `success` and
 135     /// [`Ordering::Relaxed`](../../std/sync/atomic/enum.Ordering.html)
 136     /// as the `failure` parameters. For example,
 137     /// [`AtomicBool::compare_exchange`][compare_exchange].
 138     ///
 139     /// [compare_exchange]: ../../std/sync/atomic/struct.AtomicBool.html#method.compare_exchange
 140     pub fn atomic_cxchg_acqrel_failrelaxed<T>(dst: *mut T, old: T, src: T) -> (T, bool);
 141
 142     /// Stores a value if the current value is the same as the `old` value.
 143     /// The stabilized version of this intrinsic is available on the
 144     /// `std::sync::atomic` types via the `compare_exchange_weak` method by passing
 145     /// [`Ordering::SeqCst`](../../std/sync/atomic/enum.Ordering.html)
 146     /// as both the `success` and `failure` parameters. For example,
 147     /// [`AtomicBool::compare_exchange_weak`][cew].
 148     ///
 149     /// [cew]: ../../std/sync/atomic/struct.AtomicBool.html#method.compare_exchange_weak
 150     pub fn atomic_cxchgweak<T>(dst: *mut T, old: T, src: T) -> (T, bool);
 151     /// Stores a value if the current value is the same as the `old` value.
 152     /// The stabilized version of this intrinsic is available on the
 153     /// `std::sync::atomic` types via the `compare_exchange_weak` method by passing
 154     /// [`Ordering::Acquire`](../../std/sync/atomic/enum.Ordering.html)
 155     /// as both the `success` and `failure` parameters. For example,
 156     /// [`AtomicBool::compare_exchange_weak`][cew].
 157     ///
 158     /// [cew]: ../../std/sync/atomic/struct.AtomicBool.html#method.compare_exchange_weak
 159     pub fn atomic_cxchgweak_acq<T>(dst: *mut T, old: T, src: T) -> (T, bool);
 160     /// Stores a value if the current value is the same as the `old` value.
 161     /// The stabilized version of this intrinsic is available on the
 162     /// `std::sync::atomic` types via the `compare_exchange_weak` method by passing
 163     /// [`Ordering::Release`](../../std/sync/atomic/enum.Ordering.html)
 164     /// as the `success` and
 165     /// [`Ordering::Relaxed`](../../std/sync/atomic/enum.Ordering.html)
 166     /// as the `failure` parameters. For example,
 167     /// [`AtomicBool::compare_exchange_weak`][cew].
 168     ///
 169     /// [cew]: ../../std/sync/atomic/struct.AtomicBool.html#method.compare_exchange_weak
 170     pub fn atomic_cxchgweak_rel<T>(dst: *mut T, old: T, src: T) -> (T, bool);
 171     /// Stores a value if the current value is the same as the `old` value.
 172     /// The stabilized version of this intrinsic is available on the
 173     /// `std::sync::atomic` types via the `compare_exchange_weak` method by passing
 174     /// [`Ordering::AcqRel`](../../std/sync/atomic/enum.Ordering.html)
 175     /// as the `success` and
 176     /// [`Ordering::Acquire`](../../std/sync/atomic/enum.Ordering.html)
 177     /// as the `failure` parameters. For example,
 178     /// [`AtomicBool::compare_exchange_weak`][cew].
 179     ///
 180     /// [cew]: ../../std/sync/atomic/struct.AtomicBool.html#method.compare_exchange_weak
 181     pub fn atomic_cxchgweak_acqrel<T>(dst: *mut T, old: T, src: T) -> (T, bool);
 182     /// Stores a value if the current value is the same as the `old` value.
 183     /// The stabilized version of this intrinsic is available on the
 184     /// `std::sync::atomic` types via the `compare_exchange_weak` method by passing
 185     /// [`Ordering::Relaxed`](../../std/sync/atomic/enum.Ordering.html)
 186     /// as both the `success` and `failure` parameters. For example,
 187     /// [`AtomicBool::compare_exchange_weak`][cew].
 188     ///
 189     /// [cew]: ../../std/sync/atomic/struct.AtomicBool.html#method.compare_exchange_weak
 190     pub fn atomic_cxchgweak_relaxed<T>(dst: *mut T, old: T, src: T) -> (T, bool);
 191     /// Stores a value if the current value is the same as the `old` value.
 192     /// The stabilized version of this intrinsic is available on the
 193     /// `std::sync::atomic` types via the `compare_exchange_weak` method by passing
 194     /// [`Ordering::SeqCst`](../../std/sync/atomic/enum.Ordering.html)
 195     /// as the `success` and
 196     /// [`Ordering::Relaxed`](../../std/sync/atomic/enum.Ordering.html)
 197     /// as the `failure` parameters. For example,
 198     /// [`AtomicBool::compare_exchange_weak`][cew].
 199     ///
 200     /// [cew]: ../../std/sync/atomic/struct.AtomicBool.html#method.compare_exchange_weak
 201     pub fn atomic_cxchgweak_failrelaxed<T>(dst: *mut T, old: T, src: T) -> (T, bool);
 202     /// Stores a value if the current value is the same as the `old` value.
 203     /// The stabilized version of this intrinsic is available on the
 204     /// `std::sync::atomic` types via the `compare_exchange_weak` method by passing
 205     /// [`Ordering::SeqCst`](../../std/sync/atomic/enum.Ordering.html)
 206     /// as the `success` and
 207     /// [`Ordering::Acquire`](../../std/sync/atomic/enum.Ordering.html)
 208     /// as the `failure` parameters. For example,
 209     /// [`AtomicBool::compare_exchange_weak`][cew].
 210     ///
 211     /// [cew]: ../../std/sync/atomic/struct.AtomicBool.html#method.compare_exchange_weak
 212     pub fn atomic_cxchgweak_failacq<T>(dst: *mut T, old: T, src: T) -> (T, bool);
 213     /// Stores a value if the current value is the same as the `old` value.
 214     /// The stabilized version of this intrinsic is available on the
 215     /// `std::sync::atomic` types via the `compare_exchange_weak` method by passing
 216     /// [`Ordering::Acquire`](../../std/sync/atomic/enum.Ordering.html)
 217     /// as the `success` and
 218     /// [`Ordering::Relaxed`](../../std/sync/atomic/enum.Ordering.html)
 219     /// as the `failure` parameters. For example,
 220     /// [`AtomicBool::compare_exchange_weak`][cew].
 221     ///
 222     /// [cew]: ../../std/sync/atomic/struct.AtomicBool.html#method.compare_exchange_weak
 223     pub fn atomic_cxchgweak_acq_failrelaxed<T>(dst: *mut T, old: T, src: T) -> (T, bool);
 224     /// Stores a value if the current value is the same as the `old` value.
 225     /// The stabilized version of this intrinsic is available on the
 226     /// `std::sync::atomic` types via the `compare_exchange_weak` method by passing
 227     /// [`Ordering::AcqRel`](../../std/sync/atomic/enum.Ordering.html)
 228     /// as the `success` and
 229     /// [`Ordering::Relaxed`](../../std/sync/atomic/enum.Ordering.html)
 230     /// as the `failure` parameters. For example,
 231     /// [`AtomicBool::compare_exchange_weak`][cew].
 232     ///
 233     /// [cew]: ../../std/sync/atomic/struct.AtomicBool.html#method.compare_exchange_weak
 234     pub fn atomic_cxchgweak_acqrel_failrelaxed<T>(dst: *mut T, old: T, src: T) -> (T, bool);
 235
 236     /// Loads the current value of the pointer.
 237     /// The stabilized version of this intrinsic is available on the
 238     /// `std::sync::atomic` types via the `load` method by passing
 239     /// [`Ordering::SeqCst`](../../std/sync/atomic/enum.Ordering.html)
 240     /// as the `order`. For example,
 241     /// [`AtomicBool::load`](../../std/sync/atomic/struct.AtomicBool.html#method.load).
 242     pub fn atomic_load<T>(src: *const T) -> T;
 243     /// Loads the current value of the pointer.
 244     /// The stabilized version of this intrinsic is available on the
 245     /// `std::sync::atomic` types via the `load` method by passing
 246     /// [`Ordering::Acquire`](../../std/sync/atomic/enum.Ordering.html)
 247     /// as the `order`. For example,
 248     /// [`AtomicBool::load`](../../std/sync/atomic/struct.AtomicBool.html#method.load).
 249     pub fn atomic_load_acq<T>(src: *const T) -> T;
 250     /// Loads the current value of the pointer.
 251     /// The stabilized version of this intrinsic is available on the
 252     /// `std::sync::atomic` types via the `load` method by passing
 253     /// [`Ordering::Relaxed`](../../std/sync/atomic/enum.Ordering.html)
 254     /// as the `order`. For example,
 255     /// [`AtomicBool::load`](../../std/sync/atomic/struct.AtomicBool.html#method.load).
 256     pub fn atomic_load_relaxed<T>(src: *const T) -> T;
 257     pub fn atomic_load_unordered<T>(src: *const T) -> T;
 258
 259     /// Stores the value at the specified memory location.
 260     /// The stabilized version of this intrinsic is available on the
 261     /// `std::sync::atomic` types via the `store` method by passing
 262     /// [`Ordering::SeqCst`](../../std/sync/atomic/enum.Ordering.html)
 263     /// as the `order`. For example,
 264     /// [`AtomicBool::store`](../../std/sync/atomic/struct.AtomicBool.html#method.store).
 265     pub fn atomic_store<T>(dst: *mut T, val: T);
 266     /// Stores the value at the specified memory location.
 267     /// The stabilized version of this intrinsic is available on the
 268     /// `std::sync::atomic` types via the `store` method by passing
 269     /// [`Ordering::Release`](../../std/sync/atomic/enum.Ordering.html)
 270     /// as the `order`. For example,
 271     /// [`AtomicBool::store`](../../std/sync/atomic/struct.AtomicBool.html#method.store).
 272     pub fn atomic_store_rel<T>(dst: *mut T, val: T);
 273     /// Stores the value at the specified memory location.
 274     /// The stabilized version of this intrinsic is available on the
 275     /// `std::sync::atomic` types via the `store` method by passing
 276     /// [`Ordering::Relaxed`](../../std/sync/atomic/enum.Ordering.html)
 277     /// as the `order`. For example,
 278     /// [`AtomicBool::store`](../../std/sync/atomic/struct.AtomicBool.html#method.store).
 279     pub fn atomic_store_relaxed<T>(dst: *mut T, val: T);
 280     pub fn atomic_store_unordered<T>(dst: *mut T, val: T);
 281
 282     /// Stores the value at the specified memory location, returning the old value.
 283     /// The stabilized version of this intrinsic is available on the
 284     /// `std::sync::atomic` types via the `swap` method by passing
 285     /// [`Ordering::SeqCst`](../../std/sync/atomic/enum.Ordering.html)
 286     /// as the `order`. For example,
 287     /// [`AtomicBool::swap`](../../std/sync/atomic/struct.AtomicBool.html#method.swap).
 288     pub fn atomic_xchg<T>(dst: *mut T, src: T) -> T;
 289     /// Stores the value at the specified memory location, returning the old value.
 290     /// The stabilized version of this intrinsic is available on the
 291     /// `std::sync::atomic` types via the `swap` method by passing
 292     /// [`Ordering::Acquire`](../../std/sync/atomic/enum.Ordering.html)
 293     /// as the `order`. For example,
 294     /// [`AtomicBool::swap`](../../std/sync/atomic/struct.AtomicBool.html#method.swap).
 295     pub fn atomic_xchg_acq<T>(dst: *mut T, src: T) -> T;
 296     /// Stores the value at the specified memory location, returning the old value.
 297     /// The stabilized version of this intrinsic is available on the
 298     /// `std::sync::atomic` types via the `swap` method by passing
 299     /// [`Ordering::Release`](../../std/sync/atomic/enum.Ordering.html)
 300     /// as the `order`. For example,
 301     /// [`AtomicBool::swap`](../../std/sync/atomic/struct.AtomicBool.html#method.swap).
 302     pub fn atomic_xchg_rel<T>(dst: *mut T, src: T) -> T;
 303     /// Stores the value at the specified memory location, returning the old value.
 304     /// The stabilized version of this intrinsic is available on the
 305     /// `std::sync::atomic` types via the `swap` method by passing
 306     /// [`Ordering::AcqRel`](../../std/sync/atomic/enum.Ordering.html)
 307     /// as the `order`. For example,
 308     /// [`AtomicBool::swap`](../../std/sync/atomic/struct.AtomicBool.html#method.swap).
 309     pub fn atomic_xchg_acqrel<T>(dst: *mut T, src: T) -> T;
 310     /// Stores the value at the specified memory location, returning the old value.
 311     /// The stabilized version of this intrinsic is available on the
 312     /// `std::sync::atomic` types via the `swap` method by passing
 313     /// [`Ordering::Relaxed`](../../std/sync/atomic/enum.Ordering.html)
 314     /// as the `order`. For example,
 315     /// [`AtomicBool::swap`](../../std/sync/atomic/struct.AtomicBool.html#method.swap).
 316     pub fn atomic_xchg_relaxed<T>(dst: *mut T, src: T) -> T;
 317
 318     /// Adds to the current value, returning the previous value.
 319     /// The stabilized version of this intrinsic is available on the
 320     /// `std::sync::atomic` types via the `fetch_add` method by passing
 321     /// [`Ordering::SeqCst`](../../std/sync/atomic/enum.Ordering.html)
 322     /// as the `order`. For example,
 323     /// [`AtomicIsize::fetch_add`](../../std/sync/atomic/struct.AtomicIsize.html#method.fetch_add).
 324     pub fn atomic_xadd<T>(dst: *mut T, src: T) -> T;
 325     /// Adds to the current value, returning the previous value.
 326     /// The stabilized version of this intrinsic is available on the
 327     /// `std::sync::atomic` types via the `fetch_add` method by passing
 328     /// [`Ordering::Acquire`](../../std/sync/atomic/enum.Ordering.html)
 329     /// as the `order`. For example,
 330     /// [`AtomicIsize::fetch_add`](../../std/sync/atomic/struct.AtomicIsize.html#method.fetch_add).
 331     pub fn atomic_xadd_acq<T>(dst: *mut T, src: T) -> T;
 332     /// Adds to the current value, returning the previous value.
 333     /// The stabilized version of this intrinsic is available on the
 334     /// `std::sync::atomic` types via the `fetch_add` method by passing
 335     /// [`Ordering::Release`](../../std/sync/atomic/enum.Ordering.html)
 336     /// as the `order`. For example,
 337     /// [`AtomicIsize::fetch_add`](../../std/sync/atomic/struct.AtomicIsize.html#method.fetch_add).
 338     pub fn atomic_xadd_rel<T>(dst: *mut T, src: T) -> T;
 339     /// Adds to the current value, returning the previous value.
 340     /// The stabilized version of this intrinsic is available on the
 341     /// `std::sync::atomic` types via the `fetch_add` method by passing
 342     /// [`Ordering::AcqRel`](../../std/sync/atomic/enum.Ordering.html)
 343     /// as the `order`. For example,
 344     /// [`AtomicIsize::fetch_add`](../../std/sync/atomic/struct.AtomicIsize.html#method.fetch_add).
 345     pub fn atomic_xadd_acqrel<T>(dst: *mut T, src: T) -> T;
 346     /// Adds to the current value, returning the previous value.
 347     /// The stabilized version of this intrinsic is available on the
 348     /// `std::sync::atomic` types via the `fetch_add` method by passing
 349     /// [`Ordering::Relaxed`](../../std/sync/atomic/enum.Ordering.html)
 350     /// as the `order`. For example,
 351     /// [`AtomicIsize::fetch_add`](../../std/sync/atomic/struct.AtomicIsize.html#method.fetch_add).
 352     pub fn atomic_xadd_relaxed<T>(dst: *mut T, src: T) -> T;
 353
 354     /// Subtract from the current value, returning the previous value.
 355     /// The stabilized version of this intrinsic is available on the
 356     /// `std::sync::atomic` types via the `fetch_sub` method by passing
 357     /// [`Ordering::SeqCst`](../../std/sync/atomic/enum.Ordering.html)
 358     /// as the `order`. For example,
 359     /// [`AtomicIsize::fetch_sub`](../../std/sync/atomic/struct.AtomicIsize.html#method.fetch_sub).
 360     pub fn atomic_xsub<T>(dst: *mut T, src: T) -> T;
 361     /// Subtract from the current value, returning the previous value.
 362     /// The stabilized version of this intrinsic is available on the
 363     /// `std::sync::atomic` types via the `fetch_sub` method by passing
 364     /// [`Ordering::Acquire`](../../std/sync/atomic/enum.Ordering.html)
 365     /// as the `order`. For example,
 366     /// [`AtomicIsize::fetch_sub`](../../std/sync/atomic/struct.AtomicIsize.html#method.fetch_sub).
 367     pub fn atomic_xsub_acq<T>(dst: *mut T, src: T) -> T;
 368     /// Subtract from the current value, returning the previous value.
 369     /// The stabilized version of this intrinsic is available on the
 370     /// `std::sync::atomic` types via the `fetch_sub` method by passing
 371     /// [`Ordering::Release`](../../std/sync/atomic/enum.Ordering.html)
 372     /// as the `order`. For example,
 373     /// [`AtomicIsize::fetch_sub`](../../std/sync/atomic/struct.AtomicIsize.html#method.fetch_sub).
 374     pub fn atomic_xsub_rel<T>(dst: *mut T, src: T) -> T;
 375     /// Subtract from the current value, returning the previous value.
 376     /// The stabilized version of this intrinsic is available on the
 377     /// `std::sync::atomic` types via the `fetch_sub` method by passing
 378     /// [`Ordering::AcqRel`](../../std/sync/atomic/enum.Ordering.html)
 379     /// as the `order`. For example,
 380     /// [`AtomicIsize::fetch_sub`](../../std/sync/atomic/struct.AtomicIsize.html#method.fetch_sub).
 381     pub fn atomic_xsub_acqrel<T>(dst: *mut T, src: T) -> T;
 382     /// Subtract from the current value, returning the previous value.
 383     /// The stabilized version of this intrinsic is available on the
 384     /// `std::sync::atomic` types via the `fetch_sub` method by passing
 385     /// [`Ordering::Relaxed`](../../std/sync/atomic/enum.Ordering.html)
 386     /// as the `order`. For example,
 387     /// [`AtomicIsize::fetch_sub`](../../std/sync/atomic/struct.AtomicIsize.html#method.fetch_sub).
 388     pub fn atomic_xsub_relaxed<T>(dst: *mut T, src: T) -> T;
 389
 390     /// Bitwise and with the current value, returning the previous value.
 391     /// The stabilized version of this intrinsic is available on the
 392     /// `std::sync::atomic` types via the `fetch_and` method by passing
 393     /// [`Ordering::SeqCst`](../../std/sync/atomic/enum.Ordering.html)
 394     /// as the `order`. For example,
 395     /// [`AtomicBool::fetch_and`](../../std/sync/atomic/struct.AtomicBool.html#method.fetch_and).
 396     pub fn atomic_and<T>(dst: *mut T, src: T) -> T;
 397     /// Bitwise and with the current value, returning the previous value.
 398     /// The stabilized version of this intrinsic is available on the
 399     /// `std::sync::atomic` types via the `fetch_and` method by passing
 400     /// [`Ordering::Acquire`](../../std/sync/atomic/enum.Ordering.html)
 401     /// as the `order`. For example,
 402     /// [`AtomicBool::fetch_and`](../../std/sync/atomic/struct.AtomicBool.html#method.fetch_and).
 403     pub fn atomic_and_acq<T>(dst: *mut T, src: T) -> T;
 404     /// Bitwise and with the current value, returning the previous value.
 405     /// The stabilized version of this intrinsic is available on the
 406     /// `std::sync::atomic` types via the `fetch_and` method by passing
 407     /// [`Ordering::Release`](../../std/sync/atomic/enum.Ordering.html)
 408     /// as the `order`. For example,
 409     /// [`AtomicBool::fetch_and`](../../std/sync/atomic/struct.AtomicBool.html#method.fetch_and).
 410     pub fn atomic_and_rel<T>(dst: *mut T, src: T) -> T;
 411     /// Bitwise and with the current value, returning the previous value.
 412     /// The stabilized version of this intrinsic is available on the
 413     /// `std::sync::atomic` types via the `fetch_and` method by passing
 414     /// [`Ordering::AcqRel`](../../std/sync/atomic/enum.Ordering.html)
 415     /// as the `order`. For example,
 416     /// [`AtomicBool::fetch_and`](../../std/sync/atomic/struct.AtomicBool.html#method.fetch_and).
 417     pub fn atomic_and_acqrel<T>(dst: *mut T, src: T) -> T;
 418     /// Bitwise and with the current value, returning the previous value.
 419     /// The stabilized version of this intrinsic is available on the
 420     /// `std::sync::atomic` types via the `fetch_and` method by passing
 421     /// [`Ordering::Relaxed`](../../std/sync/atomic/enum.Ordering.html)
 422     /// as the `order`. For example,
 423     /// [`AtomicBool::fetch_and`](../../std/sync/atomic/struct.AtomicBool.html#method.fetch_and).
 424     pub fn atomic_and_relaxed<T>(dst: *mut T, src: T) -> T;
 425
 426     /// Bitwise nand with the current value, returning the previous value.
 427     /// The stabilized version of this intrinsic is available on the
 428     /// `std::sync::atomic::AtomicBool` type via the `fetch_nand` method by passing
 429     /// [`Ordering::SeqCst`](../../std/sync/atomic/enum.Ordering.html)
 430     /// as the `order`. For example,
 431     /// [`AtomicBool::fetch_nand`](../../std/sync/atomic/struct.AtomicBool.html#method.fetch_nand).
 432     pub fn atomic_nand<T>(dst: *mut T, src: T) -> T;
 433     /// Bitwise nand with the current value, returning the previous value.
 434     /// The stabilized version of this intrinsic is available on the
 435     /// `std::sync::atomic::AtomicBool` type via the `fetch_nand` method by passing
 436     /// [`Ordering::Acquire`](../../std/sync/atomic/enum.Ordering.html)
 437     /// as the `order`. For example,
 438     /// [`AtomicBool::fetch_nand`](../../std/sync/atomic/struct.AtomicBool.html#method.fetch_nand).
 439     pub fn atomic_nand_acq<T>(dst: *mut T, src: T) -> T;
 440     /// Bitwise nand with the current value, returning the previous value.
 441     /// The stabilized version of this intrinsic is available on the
 442     /// `std::sync::atomic::AtomicBool` type via the `fetch_nand` method by passing
 443     /// [`Ordering::Release`](../../std/sync/atomic/enum.Ordering.html)
 444     /// as the `order`. For example,
 445     /// [`AtomicBool::fetch_nand`](../../std/sync/atomic/struct.AtomicBool.html#method.fetch_nand).
 446     pub fn atomic_nand_rel<T>(dst: *mut T, src: T) -> T;
 447     /// Bitwise nand with the current value, returning the previous value.
 448     /// The stabilized version of this intrinsic is available on the
 449     /// `std::sync::atomic::AtomicBool` type via the `fetch_nand` method by passing
 450     /// [`Ordering::AcqRel`](../../std/sync/atomic/enum.Ordering.html)
 451     /// as the `order`. For example,
 452     /// [`AtomicBool::fetch_nand`](../../std/sync/atomic/struct.AtomicBool.html#method.fetch_nand).
 453     pub fn atomic_nand_acqrel<T>(dst: *mut T, src: T) -> T;
 454     /// Bitwise nand with the current value, returning the previous value.
 455     /// The stabilized version of this intrinsic is available on the
 456     /// `std::sync::atomic::AtomicBool` type via the `fetch_nand` method by passing
 457     /// [`Ordering::Relaxed`](../../std/sync/atomic/enum.Ordering.html)
 458     /// as the `order`. For example,
 459     /// [`AtomicBool::fetch_nand`](../../std/sync/atomic/struct.AtomicBool.html#method.fetch_nand).
 460     pub fn atomic_nand_relaxed<T>(dst: *mut T, src: T) -> T;
 461
 462     /// Bitwise or with the current value, returning the previous value.
 463     /// The stabilized version of this intrinsic is available on the
 464     /// `std::sync::atomic` types via the `fetch_or` method by passing
 465     /// [`Ordering::SeqCst`](../../std/sync/atomic/enum.Ordering.html)
 466     /// as the `order`. For example,
 467     /// [`AtomicBool::fetch_or`](../../std/sync/atomic/struct.AtomicBool.html#method.fetch_or).
 468     pub fn atomic_or<T>(dst: *mut T, src: T) -> T;
 469     /// Bitwise or with the current value, returning the previous value.
 470     /// The stabilized version of this intrinsic is available on the
 471     /// `std::sync::atomic` types via the `fetch_or` method by passing
 472     /// [`Ordering::Acquire`](../../std/sync/atomic/enum.Ordering.html)
 473     /// as the `order`. For example,
 474     /// [`AtomicBool::fetch_or`](../../std/sync/atomic/struct.AtomicBool.html#method.fetch_or).
 475     pub fn atomic_or_acq<T>(dst: *mut T, src: T) -> T;
 476     /// Bitwise or with the current value, returning the previous value.
 477     /// The stabilized version of this intrinsic is available on the
 478     /// `std::sync::atomic` types via the `fetch_or` method by passing
 479     /// [`Ordering::Release`](../../std/sync/atomic/enum.Ordering.html)
 480     /// as the `order`. For example,
 481     /// [`AtomicBool::fetch_or`](../../std/sync/atomic/struct.AtomicBool.html#method.fetch_or).
 482     pub fn atomic_or_rel<T>(dst: *mut T, src: T) -> T;
 483     /// Bitwise or with the current value, returning the previous value.
 484     /// The stabilized version of this intrinsic is available on the
 485     /// `std::sync::atomic` types via the `fetch_or` method by passing
 486     /// [`Ordering::AcqRel`](../../std/sync/atomic/enum.Ordering.html)
 487     /// as the `order`. For example,
 488     /// [`AtomicBool::fetch_or`](../../std/sync/atomic/struct.AtomicBool.html#method.fetch_or).
 489     pub fn atomic_or_acqrel<T>(dst: *mut T, src: T) -> T;
 490     /// Bitwise or with the current value, returning the previous value.
 491     /// The stabilized version of this intrinsic is available on the
 492     /// `std::sync::atomic` types via the `fetch_or` method by passing
 493     /// [`Ordering::Relaxed`](../../std/sync/atomic/enum.Ordering.html)
 494     /// as the `order`. For example,
 495     /// [`AtomicBool::fetch_or`](../../std/sync/atomic/struct.AtomicBool.html#method.fetch_or).
 496     pub fn atomic_or_relaxed<T>(dst: *mut T, src: T) -> T;
 497
 498     /// Bitwise xor with the current value, returning the previous value.
 499     /// The stabilized version of this intrinsic is available on the
 500     /// `std::sync::atomic` types via the `fetch_xor` method by passing
 501     /// [`Ordering::SeqCst`](../../std/sync/atomic/enum.Ordering.html)
 502     /// as the `order`. For example,
 503     /// [`AtomicBool::fetch_xor`](../../std/sync/atomic/struct.AtomicBool.html#method.fetch_xor).
 504     pub fn atomic_xor<T>(dst: *mut T, src: T) -> T;
 505     /// Bitwise xor with the current value, returning the previous value.
 506     /// The stabilized version of this intrinsic is available on the
 507     /// `std::sync::atomic` types via the `fetch_xor` method by passing
 508     /// [`Ordering::Acquire`](../../std/sync/atomic/enum.Ordering.html)
 509     /// as the `order`. For example,
 510     /// [`AtomicBool::fetch_xor`](../../std/sync/atomic/struct.AtomicBool.html#method.fetch_xor).
 511     pub fn atomic_xor_acq<T>(dst: *mut T, src: T) -> T;
 512     /// Bitwise xor with the current value, returning the previous value.
 513     /// The stabilized version of this intrinsic is available on the
 514     /// `std::sync::atomic` types via the `fetch_xor` method by passing
 515     /// [`Ordering::Release`](../../std/sync/atomic/enum.Ordering.html)
 516     /// as the `order`. For example,
 517     /// [`AtomicBool::fetch_xor`](../../std/sync/atomic/struct.AtomicBool.html#method.fetch_xor).
 518     pub fn atomic_xor_rel<T>(dst: *mut T, src: T) -> T;
 519     /// Bitwise xor with the current value, returning the previous value.
 520     /// The stabilized version of this intrinsic is available on the
 521     /// `std::sync::atomic` types via the `fetch_xor` method by passing
 522     /// [`Ordering::AcqRel`](../../std/sync/atomic/enum.Ordering.html)
 523     /// as the `order`. For example,
 524     /// [`AtomicBool::fetch_xor`](../../std/sync/atomic/struct.AtomicBool.html#method.fetch_xor).
 525     pub fn atomic_xor_acqrel<T>(dst: *mut T, src: T) -> T;
 526     /// Bitwise xor with the current value, returning the previous value.
 527     /// The stabilized version of this intrinsic is available on the
 528     /// `std::sync::atomic` types via the `fetch_xor` method by passing
 529     /// [`Ordering::Relaxed`](../../std/sync/atomic/enum.Ordering.html)
 530     /// as the `order`. For example,
 531     /// [`AtomicBool::fetch_xor`](../../std/sync/atomic/struct.AtomicBool.html#method.fetch_xor).
 532     pub fn atomic_xor_relaxed<T>(dst: *mut T, src: T) -> T;
 533
 534     pub fn atomic_max<T>(dst: *mut T, src: T) -> T;
 535     pub fn atomic_max_acq<T>(dst: *mut T, src: T) -> T;
 536     pub fn atomic_max_rel<T>(dst: *mut T, src: T) -> T;
 537     pub fn atomic_max_acqrel<T>(dst: *mut T, src: T) -> T;
 538     pub fn atomic_max_relaxed<T>(dst: *mut T, src: T) -> T;
 539
 540     pub fn atomic_min<T>(dst: *mut T, src: T) -> T;
 541     pub fn atomic_min_acq<T>(dst: *mut T, src: T) -> T;
 542     pub fn atomic_min_rel<T>(dst: *mut T, src: T) -> T;
 543     pub fn atomic_min_acqrel<T>(dst: *mut T, src: T) -> T;
 544     pub fn atomic_min_relaxed<T>(dst: *mut T, src: T) -> T;
 545
 546     pub fn atomic_umin<T>(dst: *mut T, src: T) -> T;
 547     pub fn atomic_umin_acq<T>(dst: *mut T, src: T) -> T;
 548     pub fn atomic_umin_rel<T>(dst: *mut T, src: T) -> T;
 549     pub fn atomic_umin_acqrel<T>(dst: *mut T, src: T) -> T;
 550     pub fn atomic_umin_relaxed<T>(dst: *mut T, src: T) -> T;
 551
 552     pub fn atomic_umax<T>(dst: *mut T, src: T) -> T;
 553     pub fn atomic_umax_acq<T>(dst: *mut T, src: T) -> T;
 554     pub fn atomic_umax_rel<T>(dst: *mut T, src: T) -> T;
 555     pub fn atomic_umax_acqrel<T>(dst: *mut T, src: T) -> T;
 556     pub fn atomic_umax_relaxed<T>(dst: *mut T, src: T) -> T;
 557
 558     /// The `prefetch` intrinsic is a hint to the code generator to insert a prefetch instruction
 559     /// if supported; otherwise, it is a no-op.
 560     /// Prefetches have no effect on the behavior of the program but can change its performance
 561     /// characteristics.
 562     ///
 563     /// The `locality` argument must be a constant integer and is a temporal locality specifier
 564     /// ranging from (0) - no locality, to (3) - extremely local keep in cache
 565     pub fn prefetch_read_data<T>(data: *const T, locality: i32);
 566     /// The `prefetch` intrinsic is a hint to the code generator to insert a prefetch instruction
 567     /// if supported; otherwise, it is a no-op.
 568     /// Prefetches have no effect on the behavior of the program but can change its performance
 569     /// characteristics.
 570     ///
 571     /// The `locality` argument must be a constant integer and is a temporal locality specifier
 572     /// ranging from (0) - no locality, to (3) - extremely local keep in cache
 573     pub fn prefetch_write_data<T>(data: *const T, locality: i32);
 574     /// The `prefetch` intrinsic is a hint to the code generator to insert a prefetch instruction
 575     /// if supported; otherwise, it is a no-op.
 576     /// Prefetches have no effect on the behavior of the program but can change its performance
 577     /// characteristics.
 578     ///
 579     /// The `locality` argument must be a constant integer and is a temporal locality specifier
 580     /// ranging from (0) - no locality, to (3) - extremely local keep in cache
 581     pub fn prefetch_read_instruction<T>(data: *const T, locality: i32);
 582     /// The `prefetch` intrinsic is a hint to the code generator to insert a prefetch instruction
 583     /// if supported; otherwise, it is a no-op.
 584     /// Prefetches have no effect on the behavior of the program but can change its performance
 585     /// characteristics.
 586     ///
 587     /// The `locality` argument must be a constant integer and is a temporal locality specifier
 588     /// ranging from (0) - no locality, to (3) - extremely local keep in cache
 589     pub fn prefetch_write_instruction<T>(data: *const T, locality: i32);
 590 }
 591
 592 extern "rust-intrinsic" {
 593
 594     pub fn atomic_fence();
 595     pub fn atomic_fence_acq();
 596     pub fn atomic_fence_rel();
 597     pub fn atomic_fence_acqrel();
 598
 599     /// A compiler-only memory barrier.
 600     ///
 601     /// Memory accesses will never be reordered across this barrier by the
 602     /// compiler, but no instructions will be emitted for it. This is
 603     /// appropriate for operations on the same thread that may be preempted,
 604     /// such as when interacting with signal handlers.
 605     pub fn atomic_singlethreadfence();
 606     pub fn atomic_singlethreadfence_acq();
 607     pub fn atomic_singlethreadfence_rel();
 608     pub fn atomic_singlethreadfence_acqrel();
 609
 610     /// Magic intrinsic that derives its meaning from attributes
 611     /// attached to the function.
 612     ///
 613     /// For example, dataflow uses this to inject static assertions so
 614     /// that `rustc_peek(potentially_uninitialized)` would actually
 615     /// double-check that dataflow did indeed compute that it is
 616     /// uninitialized at that point in the control flow.
 617     pub fn rustc_peek<T>(_: T) -> T;
 618
 619     /// Aborts the execution of the process.
 620     ///
 621     /// The stabilized version of this intrinsic is
 622     /// [`std::process::abort`](../../std/process/fn.abort.html)
 623     pub fn abort() -> !;
 624
 625     /// Tells LLVM that this point in the code is not reachable, enabling
 626     /// further optimizations.
 627     ///
 628     /// N.B., this is very different from the `unreachable!()` macro: Unlike the
 629     /// macro, which panics when it is executed, it is *undefined behavior* to
 630     /// reach code marked with this function.
 631     ///
 632     /// The stabilized version of this intrinsic is
 633     /// [`std::hint::unreachable_unchecked`](../../std/hint/fn.unreachable_unchecked.html).
 634     pub fn unreachable() -> !;
 635
 636     /// Informs the optimizer that a condition is always true.
 637     /// If the condition is false, the behavior is undefined.
 638     ///
 639     /// No code is generated for this intrinsic, but the optimizer will try
 640     /// to preserve it (and its condition) between passes, which may interfere
 641     /// with optimization of surrounding code and reduce performance. It should
 642     /// not be used if the invariant can be discovered by the optimizer on its
 643     /// own, or if it does not enable any significant optimizations.
 644     pub fn assume(b: bool);
 645
 646     /// Hints to the compiler that branch condition is likely to be true.
 647     /// Returns the value passed to it.
 648     ///
 649     /// Any use other than with `if` statements will probably not have an effect.
 650     pub fn likely(b: bool) -> bool;
 651
 652     /// Hints to the compiler that branch condition is likely to be false.
 653     /// Returns the value passed to it.
 654     ///
 655     /// Any use other than with `if` statements will probably not have an effect.
 656     pub fn unlikely(b: bool) -> bool;
 657
 658     /// Executes a breakpoint trap, for inspection by a debugger.
 659     pub fn breakpoint();
 660
 661     /// The size of a type in bytes.
 662     ///
 663     /// More specifically, this is the offset in bytes between successive
 664     /// items of the same type, including alignment padding.
 665     ///
 666     /// The stabilized version of this intrinsic is
 667     /// [`std::mem::size_of`](../../std/mem/fn.size_of.html).
 668     pub fn size_of<T>() -> usize;
 669
 670     /// Moves a value to an uninitialized memory location.
 671     ///
 672     /// Drop glue is not run on the destination.
 673     pub fn move_val_init<T>(dst: *mut T, src: T);
 674
 675     pub fn min_align_of<T>() -> usize;
 676     pub fn pref_align_of<T>() -> usize;
 677
 678     /// The size of the referenced value in bytes.
 679     ///
 680     /// The stabilized version of this intrinsic is
 681     /// [`std::mem::size_of_val`](../../std/mem/fn.size_of_val.html).
 682     pub fn size_of_val<T: ?Sized>(_: &T) -> usize;
 683     pub fn min_align_of_val<T: ?Sized>(_: &T) -> usize;
 684
 685     /// Gets a static string slice containing the name of a type.
 686     pub fn type_name<T: ?Sized>() -> &'static str;
 687
 688     /// Gets an identifier which is globally unique to the specified type. This
 689     /// function will return the same value for a type regardless of whichever
 690     /// crate it is invoked in.
 691     pub fn type_id<T: ?Sized + 'static>() -> u64;
 692
 693     /// A guard for unsafe functions that cannot ever be executed if `T` is uninhabited:
 694     /// This will statically either panic, or do nothing.
 695     pub fn panic_if_uninhabited<T>();
 696
 697     /// Creates a value initialized to zero.
 698     ///
 699     /// `init` is unsafe because it returns a zeroed-out datum,
 700     /// which is unsafe unless `T` is `Copy`. Also, even if T is
 701     /// `Copy`, an all-zero value may not correspond to any legitimate
 702     /// state for the type in question.
 703     #[unstable(feature = "core_intrinsics",
 704                reason = "intrinsics are unlikely to ever be stabilized, instead \
 705                          they should be used through stabilized interfaces \
 706                          in the rest of the standard library",
 707                issue = "0")]
 708     #[rustc_deprecated(reason = "no longer used by rustc, will be removed - use MaybeUninit \
 709                                  instead",
 710                        since = "1.38.0")]
 711     pub fn init<T>() -> T;
 712
 713     /// Moves a value out of scope without running drop glue.
 714     pub fn forget<T: ?Sized>(_: T);
 715
 716     /// Reinterprets the bits of a value of one type as another type.
 717     ///
 718     /// Both types must have the same size. Neither the original, nor the result,
 719     /// may be an [invalid value](../../nomicon/what-unsafe-does.html).
 720     ///
 721     /// `transmute` is semantically equivalent to a bitwise move of one type
 722     /// into another. It copies the bits from the source value into the
 723     /// destination value, then forgets the original. It's equivalent to C's
 724     /// `memcpy` under the hood, just like `transmute_copy`.
 725     ///
 726     /// `transmute` is **incredibly** unsafe. There are a vast number of ways to
 727     /// cause [undefined behavior][ub] with this function. `transmute` should be
 728     /// the absolute last resort.
 729     ///
 730     /// The [nomicon](../../nomicon/transmutes.html) has additional
 731     /// documentation.
 732     ///
 733     /// [ub]: ../../reference/behavior-considered-undefined.html
 734     ///
 735     /// # Examples
 736     ///
 737     /// There are a few things that `transmute` is really useful for.
 738     ///
 739     /// Turning a pointer into a function pointer. This is *not* portable to
 740     /// machines where function pointers and data pointers have different sizes.
 741     ///
 742     /// ```
 743     /// fn foo() -> i32 {
 744     ///     0
 745     /// }
 746     /// let pointer = foo as *const ();
 747     /// let function = unsafe {
 748     ///     std::mem::transmute::<*const (), fn() -> i32>(pointer)
 749     /// };
 750     /// assert_eq!(function(), 0);
 751     /// ```
 752     ///
 753     /// Extending a lifetime, or shortening an invariant lifetime. This is
 754     /// advanced, very unsafe Rust!
 755     ///
 756     /// ```
 757     /// struct R<'a>(&'a i32);
 758     /// unsafe fn extend_lifetime<'b>(r: R<'b>) -> R<'static> {
 759     ///     std::mem::transmute::<R<'b>, R<'static>>(r)
 760     /// }
 761     ///
 762     /// unsafe fn shorten_invariant_lifetime<'b, 'c>(r: &'b mut R<'static>)
 763     ///                                              -> &'b mut R<'c> {
 764     ///     std::mem::transmute::<&'b mut R<'static>, &'b mut R<'c>>(r)
 765     /// }
 766     /// ```
 767     ///
 768     /// # Alternatives
 769     ///
 770     /// Don't despair: many uses of `transmute` can be achieved through other means.
 771     /// Below are common applications of `transmute` which can be replaced with safer
 772     /// constructs.
 773     ///
 774     /// Turning a pointer into a `usize`:
 775     ///
 776     /// ```
 777     /// let ptr = &0;
 778     /// let ptr_num_transmute = unsafe {
 779     ///     std::mem::transmute::<&i32, usize>(ptr)
 780     /// };
 781     ///
 782     /// // Use an `as` cast instead
 783     /// let ptr_num_cast = ptr as *const i32 as usize;
 784     /// ```
 785     ///
 786     /// Turning a `*mut T` into an `&mut T`:
 787     ///
 788     /// ```
 789     /// let ptr: *mut i32 = &mut 0;
 790     /// let ref_transmuted = unsafe {
 791     ///     std::mem::transmute::<*mut i32, &mut i32>(ptr)
 792     /// };
 793     ///
 794     /// // Use a reborrow instead
 795     /// let ref_casted = unsafe { &mut *ptr };
 796     /// ```
 797     ///
 798     /// Turning an `&mut T` into an `&mut U`:
 799     ///
 800     /// ```
 801     /// let ptr = &mut 0;
 802     /// let val_transmuted = unsafe {
 803     ///     std::mem::transmute::<&mut i32, &mut u32>(ptr)
 804     /// };
 805     ///
 806     /// // Now, put together `as` and reborrowing - note the chaining of `as`
 807     /// // `as` is not transitive
 808     /// let val_casts = unsafe { &mut *(ptr as *mut i32 as *mut u32) };
 809     /// ```
 810     ///
 811     /// Turning an `&str` into an `&[u8]`:
 812     ///
 813     /// ```
 814     /// // this is not a good way to do this.
 815     /// let slice = unsafe { std::mem::transmute::<&str, &[u8]>("Rust") };
 816     /// assert_eq!(slice, &[82, 117, 115, 116]);
 817     ///
 818     /// // You could use `str::as_bytes`
 819     /// let slice = "Rust".as_bytes();
 820     /// assert_eq!(slice, &[82, 117, 115, 116]);
 821     ///
 822     /// // Or, just use a byte string, if you have control over the string
 823     /// // literal
 824     /// assert_eq!(b"Rust", &[82, 117, 115, 116]);
 825     /// ```
 826     ///
 827     /// Turning a `Vec<&T>` into a `Vec<Option<&T>>`:
 828     ///
 829     /// ```
 830     /// let store = [0, 1, 2, 3];
 831     /// let mut v_orig = store.iter().collect::<Vec<&i32>>();
 832     ///
 833     /// // Using transmute: this is Undefined Behavior, and a bad idea.
 834     /// // However, it is no-copy.
 835     /// let v_transmuted = unsafe {
 836     ///     std::mem::transmute::<Vec<&i32>, Vec<Option<&i32>>>(
 837     ///         v_orig.clone())
 838     /// };
 839     ///
 840     /// // This is the suggested, safe way.
 841     /// // It does copy the entire vector, though, into a new array.
 842     /// let v_collected = v_orig.clone()
 843     ///                         .into_iter()
 844     ///                         .map(|r| Some(r))
 845     ///                         .collect::<Vec<Option<&i32>>>();
 846     ///
 847     /// // The no-copy, unsafe way, still using transmute, but not UB.
 848     /// // This is equivalent to the original, but safer, and reuses the
 849     /// // same `Vec` internals. Therefore, the new inner type must have the
 850     /// // exact same size, and the same alignment, as the old type.
 851     /// // The same caveats exist for this method as transmute, for
 852     /// // the original inner type (`&i32`) to the converted inner type
 853     /// // (`Option<&i32>`), so read the nomicon pages linked above.
 854     /// let v_from_raw = unsafe {
 855     ///     Vec::from_raw_parts(v_orig.as_mut_ptr() as *mut Option<&i32>,
 856     ///                         v_orig.len(),
 857     ///                         v_orig.capacity())
 858     /// };
 859     /// std::mem::forget(v_orig);
 860     /// ```
 861     ///
 862     /// Implementing `split_at_mut`:
 863     ///
 864     /// ```
 865     /// use std::{slice, mem};
 866     ///
 867     /// // There are multiple ways to do this, and there are multiple problems
 868     /// // with the following (transmute) way.
 869     /// fn split_at_mut_transmute<T>(slice: &mut [T], mid: usize)
 870     ///                              -> (&mut [T], &mut [T]) {
 871     ///     let len = slice.len();
 872     ///     assert!(mid <= len);
 873     ///     unsafe {
 874     ///         let slice2 = mem::transmute::<&mut [T], &mut [T]>(slice);
 875     ///         // first: transmute is not typesafe; all it checks is that T and
 876     ///         // U are of the same size. Second, right here, you have two
 877     ///         // mutable references pointing to the same memory.
 878     ///         (&mut slice[0..mid], &mut slice2[mid..len])
 879     ///     }
 880     /// }
 881     ///
 882     /// // This gets rid of the typesafety problems; `&mut *` will *only* give
 883     /// // you an `&mut T` from an `&mut T` or `*mut T`.
 884     /// fn split_at_mut_casts<T>(slice: &mut [T], mid: usize)
 885     ///                          -> (&mut [T], &mut [T]) {
 886     ///     let len = slice.len();
 887     ///     assert!(mid <= len);
 888     ///     unsafe {
 889     ///         let slice2 = &mut *(slice as *mut [T]);
 890     ///         // however, you still have two mutable references pointing to
 891     ///         // the same memory.
 892     ///         (&mut slice[0..mid], &mut slice2[mid..len])
 893     ///     }
 894     /// }
 895     ///
 896     /// // This is how the standard library does it. This is the best method, if
 897     /// // you need to do something like this
 898     /// fn split_at_stdlib<T>(slice: &mut [T], mid: usize)
 899     ///                       -> (&mut [T], &mut [T]) {
 900     ///     let len = slice.len();
 901     ///     assert!(mid <= len);
 902     ///     unsafe {
 903     ///         let ptr = slice.as_mut_ptr();
 904     ///         // This now has three mutable references pointing at the same
 905     ///         // memory. `slice`, the rvalue ret.0, and the rvalue ret.1.
 906     ///         // `slice` is never used after `let ptr = ...`, and so one can
 907     ///         // treat it as "dead", and therefore, you only have two real
 908     ///         // mutable slices.
 909     ///         (slice::from_raw_parts_mut(ptr, mid),
 910     ///          slice::from_raw_parts_mut(ptr.add(mid), len - mid))
 911     ///     }
 912     /// }
 913     /// ```
 914     #[stable(feature = "rust1", since = "1.0.0")]
 915     pub fn transmute<T, U>(e: T) -> U;
 916
 917     /// Returns `true` if the actual type given as `T` requires drop
 918     /// glue; returns `false` if the actual type provided for `T`
 919     /// implements `Copy`.
 920     ///
 921     /// If the actual type neither requires drop glue nor implements
 922     /// `Copy`, then may return `true` or `false`.
 923     ///
 924     /// The stabilized version of this intrinsic is
 925     /// [`std::mem::needs_drop`](../../std/mem/fn.needs_drop.html).
 926     pub fn needs_drop<T>() -> bool;
 927
 928     /// Calculates the offset from a pointer.
 929     ///
 930     /// This is implemented as an intrinsic to avoid converting to and from an
 931     /// integer, since the conversion would throw away aliasing information.
 932     ///
 933     /// # Safety
 934     ///
 935     /// Both the starting and resulting pointer must be either in bounds or one
 936     /// byte past the end of an allocated object. If either pointer is out of
 937     /// bounds or arithmetic overflow occurs then any further use of the
 938     /// returned value will result in undefined behavior.
 939     pub fn offset<T>(dst: *const T, offset: isize) -> *const T;
 940
 941     /// Calculates the offset from a pointer, potentially wrapping.
 942     ///
 943     /// This is implemented as an intrinsic to avoid converting to and from an
 944     /// integer, since the conversion inhibits certain optimizations.
 945     ///
 946     /// # Safety
 947     ///
 948     /// Unlike the `offset` intrinsic, this intrinsic does not restrict the
 949     /// resulting pointer to point into or one byte past the end of an allocated
 950     /// object, and it wraps with two's complement arithmetic. The resulting
 951     /// value is not necessarily valid to be used to actually access memory.
 952     pub fn arith_offset<T>(dst: *const T, offset: isize) -> *const T;
 953
 954     /// Equivalent to the appropriate `llvm.memcpy.p0i8.0i8.*` intrinsic, with
 955     /// a size of `count` * `size_of::<T>()` and an alignment of
 956     /// `min_align_of::<T>()`
 957     ///
 958     /// The volatile parameter is set to `true`, so it will not be optimized out
 959     /// unless size is equal to zero.
 960     pub fn volatile_copy_nonoverlapping_memory<T>(dst: *mut T, src: *const T,
 961                                                   count: usize);
 962     /// Equivalent to the appropriate `llvm.memmove.p0i8.0i8.*` intrinsic, with
 963     /// a size of `count` * `size_of::<T>()` and an alignment of
 964     /// `min_align_of::<T>()`
 965     ///
 966     /// The volatile parameter is set to `true`, so it will not be optimized out
 967     /// unless size is equal to zero.
 968     pub fn volatile_copy_memory<T>(dst: *mut T, src: *const T, count: usize);
 969     /// Equivalent to the appropriate `llvm.memset.p0i8.*` intrinsic, with a
 970     /// size of `count` * `size_of::<T>()` and an alignment of
 971     /// `min_align_of::<T>()`.
 972     ///
 973     /// The volatile parameter is set to `true`, so it will not be optimized out
 974     /// unless size is equal to zero.
 975     pub fn volatile_set_memory<T>(dst: *mut T, val: u8, count: usize);
 976
 977     /// Performs a volatile load from the `src` pointer.
 978     /// The stabilized version of this intrinsic is
 979     /// [`std::ptr::read_volatile`](../../std/ptr/fn.read_volatile.html).
 980     pub fn volatile_load<T>(src: *const T) -> T;
 981     /// Performs a volatile store to the `dst` pointer.
 982     /// The stabilized version of this intrinsic is
 983     /// [`std::ptr::write_volatile`](../../std/ptr/fn.write_volatile.html).
 984     pub fn volatile_store<T>(dst: *mut T, val: T);
 985
 986     /// Performs a volatile load from the `src` pointer
 987     /// The pointer is not required to be aligned.
 988     pub fn unaligned_volatile_load<T>(src: *const T) -> T;
 989     /// Performs a volatile store to the `dst` pointer.
 990     /// The pointer is not required to be aligned.
 991     pub fn unaligned_volatile_store<T>(dst: *mut T, val: T);
 992
 993     /// Returns the square root of an `f32`
 994     pub fn sqrtf32(x: f32) -> f32;
 995     /// Returns the square root of an `f64`
 996     pub fn sqrtf64(x: f64) -> f64;
 997
 998     /// Raises an `f32` to an integer power.
 999     pub fn powif32(a: f32, x: i32) -> f32;
1000     /// Raises an `f64` to an integer power.
1001     pub fn powif64(a: f64, x: i32) -> f64;
1002
1003     /// Returns the sine of an `f32`.
1004     pub fn sinf32(x: f32) -> f32;
1005     /// Returns the sine of an `f64`.
1006     pub fn sinf64(x: f64) -> f64;
1007
1008     /// Returns the cosine of an `f32`.
1009     pub fn cosf32(x: f32) -> f32;
1010     /// Returns the cosine of an `f64`.
1011     pub fn cosf64(x: f64) -> f64;
1012
1013     /// Raises an `f32` to an `f32` power.
1014     pub fn powf32(a: f32, x: f32) -> f32;
1015     /// Raises an `f64` to an `f64` power.
1016     pub fn powf64(a: f64, x: f64) -> f64;
1017
1018     /// Returns the exponential of an `f32`.
1019     pub fn expf32(x: f32) -> f32;
1020     /// Returns the exponential of an `f64`.
1021     pub fn expf64(x: f64) -> f64;
1022
1023     /// Returns 2 raised to the power of an `f32`.
1024     pub fn exp2f32(x: f32) -> f32;
1025     /// Returns 2 raised to the power of an `f64`.
1026     pub fn exp2f64(x: f64) -> f64;
1027
1028     /// Returns the natural logarithm of an `f32`.
1029     pub fn logf32(x: f32) -> f32;
1030     /// Returns the natural logarithm of an `f64`.
1031     pub fn logf64(x: f64) -> f64;
1032
1033     /// Returns the base 10 logarithm of an `f32`.
1034     pub fn log10f32(x: f32) -> f32;
1035     /// Returns the base 10 logarithm of an `f64`.
1036     pub fn log10f64(x: f64) -> f64;
1037
1038     /// Returns the base 2 logarithm of an `f32`.
1039     pub fn log2f32(x: f32) -> f32;
1040     /// Returns the base 2 logarithm of an `f64`.
1041     pub fn log2f64(x: f64) -> f64;
1042
1043     /// Returns `a * b + c` for `f32` values.
1044     pub fn fmaf32(a: f32, b: f32, c: f32) -> f32;
1045     /// Returns `a * b + c` for `f64` values.
1046     pub fn fmaf64(a: f64, b: f64, c: f64) -> f64;
1047
1048     /// Returns the absolute value of an `f32`.
1049     pub fn fabsf32(x: f32) -> f32;
1050     /// Returns the absolute value of an `f64`.
1051     pub fn fabsf64(x: f64) -> f64;
1052
1053     /// Returns the minimum of two `f32` values.
1054     pub fn minnumf32(x: f32, y: f32) -> f32;
1055     /// Returns the minimum of two `f64` values.
1056     pub fn minnumf64(x: f64, y: f64) -> f64;
1057     /// Returns the maximum of two `f32` values.
1058     pub fn maxnumf32(x: f32, y: f32) -> f32;
1059     /// Returns the maximum of two `f64` values.
1060     pub fn maxnumf64(x: f64, y: f64) -> f64;
1061
1062     /// Copies the sign from `y` to `x` for `f32` values.
1063     pub fn copysignf32(x: f32, y: f32) -> f32;
1064     /// Copies the sign from `y` to `x` for `f64` values.
1065     pub fn copysignf64(x: f64, y: f64) -> f64;
1066
1067     /// Returns the largest integer less than or equal to an `f32`.
1068     pub fn floorf32(x: f32) -> f32;
1069     /// Returns the largest integer less than or equal to an `f64`.
1070     pub fn floorf64(x: f64) -> f64;
1071
1072     /// Returns the smallest integer greater than or equal to an `f32`.
1073     pub fn ceilf32(x: f32) -> f32;
1074     /// Returns the smallest integer greater than or equal to an `f64`.
1075     pub fn ceilf64(x: f64) -> f64;
1076
1077     /// Returns the integer part of an `f32`.
1078     pub fn truncf32(x: f32) -> f32;
1079     /// Returns the integer part of an `f64`.
1080     pub fn truncf64(x: f64) -> f64;
1081
1082     /// Returns the nearest integer to an `f32`. May raise an inexact floating-point exception
1083     /// if the argument is not an integer.
1084     pub fn rintf32(x: f32) -> f32;
1085     /// Returns the nearest integer to an `f64`. May raise an inexact floating-point exception
1086     /// if the argument is not an integer.
1087     pub fn rintf64(x: f64) -> f64;
1088
1089     /// Returns the nearest integer to an `f32`.
1090     pub fn nearbyintf32(x: f32) -> f32;
1091     /// Returns the nearest integer to an `f64`.
1092     pub fn nearbyintf64(x: f64) -> f64;
1093
1094     /// Returns the nearest integer to an `f32`. Rounds half-way cases away from zero.
1095     pub fn roundf32(x: f32) -> f32;
1096     /// Returns the nearest integer to an `f64`. Rounds half-way cases away from zero.
1097     pub fn roundf64(x: f64) -> f64;
1098
1099     /// Float addition that allows optimizations based on algebraic rules.
1100     /// May assume inputs are finite.
1101     pub fn fadd_fast<T>(a: T, b: T) -> T;
1102
1103     /// Float subtraction that allows optimizations based on algebraic rules.
1104     /// May assume inputs are finite.
1105     pub fn fsub_fast<T>(a: T, b: T) -> T;
1106
1107     /// Float multiplication that allows optimizations based on algebraic rules.
1108     /// May assume inputs are finite.
1109     pub fn fmul_fast<T>(a: T, b: T) -> T;
1110
1111     /// Float division that allows optimizations based on algebraic rules.
1112     /// May assume inputs are finite.
1113     pub fn fdiv_fast<T>(a: T, b: T) -> T;
1114
1115     /// Float remainder that allows optimizations based on algebraic rules.
1116     /// May assume inputs are finite.
1117     pub fn frem_fast<T>(a: T, b: T) -> T;
1118
1119
1120     /// Returns the number of bits set in an integer type `T`
1121     pub fn ctpop<T>(x: T) -> T;
1122
1123     /// Returns the number of leading unset bits (zeroes) in an integer type `T`.
1124     ///
1125     /// # Examples
1126     ///
1127     /// ```
1128     /// #![feature(core_intrinsics)]
1129     ///
1130     /// use std::intrinsics::ctlz;
1131     ///
1132     /// let x = 0b0001_1100_u8;
1133     /// let num_leading = ctlz(x);
1134     /// assert_eq!(num_leading, 3);
1135     /// ```
1136     ///
1137     /// An `x` with value `0` will return the bit width of `T`.
1138     ///
1139     /// ```
1140     /// #![feature(core_intrinsics)]
1141     ///
1142     /// use std::intrinsics::ctlz;
1143     ///
1144     /// let x = 0u16;
1145     /// let num_leading = ctlz(x);
1146     /// assert_eq!(num_leading, 16);
1147     /// ```
1148     pub fn ctlz<T>(x: T) -> T;
1149
1150     /// Like `ctlz`, but extra-unsafe as it returns `undef` when
1151     /// given an `x` with value `0`.
1152     ///
1153     /// # Examples
1154     ///
1155     /// ```
1156     /// #![feature(core_intrinsics)]
1157     ///
1158     /// use std::intrinsics::ctlz_nonzero;
1159     ///
1160     /// let x = 0b0001_1100_u8;
1161     /// let num_leading = unsafe { ctlz_nonzero(x) };
1162     /// assert_eq!(num_leading, 3);
1163     /// ```
1164     pub fn ctlz_nonzero<T>(x: T) -> T;
1165
1166     /// Returns the number of trailing unset bits (zeroes) in an integer type `T`.
1167     ///
1168     /// # Examples
1169     ///
1170     /// ```
1171     /// #![feature(core_intrinsics)]
1172     ///
1173     /// use std::intrinsics::cttz;
1174     ///
1175     /// let x = 0b0011_1000_u8;
1176     /// let num_trailing = cttz(x);
1177     /// assert_eq!(num_trailing, 3);
1178     /// ```
1179     ///
1180     /// An `x` with value `0` will return the bit width of `T`:
1181     ///
1182     /// ```
1183     /// #![feature(core_intrinsics)]
1184     ///
1185     /// use std::intrinsics::cttz;
1186     ///
1187     /// let x = 0u16;
1188     /// let num_trailing = cttz(x);
1189     /// assert_eq!(num_trailing, 16);
1190     /// ```
1191     pub fn cttz<T>(x: T) -> T;
1192
1193     /// Like `cttz`, but extra-unsafe as it returns `undef` when
1194     /// given an `x` with value `0`.
1195     ///
1196     /// # Examples
1197     ///
1198     /// ```
1199     /// #![feature(core_intrinsics)]
1200     ///
1201     /// use std::intrinsics::cttz_nonzero;
1202     ///
1203     /// let x = 0b0011_1000_u8;
1204     /// let num_trailing = unsafe { cttz_nonzero(x) };
1205     /// assert_eq!(num_trailing, 3);
1206     /// ```
1207     pub fn cttz_nonzero<T>(x: T) -> T;
1208
1209     /// Reverses the bytes in an integer type `T`.
1210     pub fn bswap<T>(x: T) -> T;
1211
1212     /// Reverses the bits in an integer type `T`.
1213     pub fn bitreverse<T>(x: T) -> T;
1214
1215     /// Performs checked integer addition.
1216     /// The stabilized versions of this intrinsic are available on the integer
1217     /// primitives via the `overflowing_add` method. For example,
1218     /// [`std::u32::overflowing_add`](../../std/primitive.u32.html#method.overflowing_add)
1219     pub fn add_with_overflow<T>(x: T, y: T) -> (T, bool);
1220
1221     /// Performs checked integer subtraction
1222     /// The stabilized versions of this intrinsic are available on the integer
1223     /// primitives via the `overflowing_sub` method. For example,
1224     /// [`std::u32::overflowing_sub`](../../std/primitive.u32.html#method.overflowing_sub)
1225     pub fn sub_with_overflow<T>(x: T, y: T) -> (T, bool);
1226
1227     /// Performs checked integer multiplication
1228     /// The stabilized versions of this intrinsic are available on the integer
1229     /// primitives via the `overflowing_mul` method. For example,
1230     /// [`std::u32::overflowing_mul`](../../std/primitive.u32.html#method.overflowing_mul)
1231     pub fn mul_with_overflow<T>(x: T, y: T) -> (T, bool);
1232
1233     /// Performs an exact division, resulting in undefined behavior where
1234     /// `x % y != 0` or `y == 0` or `x == T::min_value() && y == -1`
1235     pub fn exact_div<T>(x: T, y: T) -> T;
1236
1237     /// Performs an unchecked division, resulting in undefined behavior
1238     /// where y = 0 or x = `T::min_value()` and y = -1
1239     pub fn unchecked_div<T>(x: T, y: T) -> T;
1240     /// Returns the remainder of an unchecked division, resulting in
1241     /// undefined behavior where y = 0 or x = `T::min_value()` and y = -1
1242     pub fn unchecked_rem<T>(x: T, y: T) -> T;
1243
1244     /// Performs an unchecked left shift, resulting in undefined behavior when
1245     /// y < 0 or y >= N, where N is the width of T in bits.
1246     pub fn unchecked_shl<T>(x: T, y: T) -> T;
1247     /// Performs an unchecked right shift, resulting in undefined behavior when
1248     /// y < 0 or y >= N, where N is the width of T in bits.
1249     pub fn unchecked_shr<T>(x: T, y: T) -> T;
1250
1251     /// Returns the result of an unchecked addition, resulting in
1252     /// undefined behavior when `x + y > T::max_value()` or `x + y < T::min_value()`.
1253     pub fn unchecked_add<T>(x: T, y: T) -> T;
1254
1255     /// Returns the result of an unchecked substraction, resulting in
1256     /// undefined behavior when `x - y > T::max_value()` or `x - y < T::min_value()`.
1257     pub fn unchecked_sub<T>(x: T, y: T) -> T;
1258
1259     /// Returns the result of an unchecked multiplication, resulting in
1260     /// undefined behavior when `x * y > T::max_value()` or `x * y < T::min_value()`.
1261     pub fn unchecked_mul<T>(x: T, y: T) -> T;
1262
1263     /// Performs rotate left.
1264     /// The stabilized versions of this intrinsic are available on the integer
1265     /// primitives via the `rotate_left` method. For example,
1266     /// [`std::u32::rotate_left`](../../std/primitive.u32.html#method.rotate_left)
1267     pub fn rotate_left<T>(x: T, y: T) -> T;
1268
1269     /// Performs rotate right.
1270     /// The stabilized versions of this intrinsic are available on the integer
1271     /// primitives via the `rotate_right` method. For example,
1272     /// [`std::u32::rotate_right`](../../std/primitive.u32.html#method.rotate_right)
1273     pub fn rotate_right<T>(x: T, y: T) -> T;
1274
1275     /// Returns (a + b) mod 2<sup>N</sup>, where N is the width of T in bits.
1276     /// The stabilized versions of this intrinsic are available on the integer
1277     /// primitives via the `wrapping_add` method. For example,
1278     /// [`std::u32::wrapping_add`](../../std/primitive.u32.html#method.wrapping_add)
1279     pub fn overflowing_add<T>(a: T, b: T) -> T;
1280     /// Returns (a - b) mod 2<sup>N</sup>, where N is the width of T in bits.
1281     /// The stabilized versions of this intrinsic are available on the integer
1282     /// primitives via the `wrapping_sub` method. For example,
1283     /// [`std::u32::wrapping_sub`](../../std/primitive.u32.html#method.wrapping_sub)
1284     pub fn overflowing_sub<T>(a: T, b: T) -> T;
1285     /// Returns (a * b) mod 2<sup>N</sup>, where N is the width of T in bits.
1286     /// The stabilized versions of this intrinsic are available on the integer
1287     /// primitives via the `wrapping_mul` method. For example,
1288     /// [`std::u32::wrapping_mul`](../../std/primitive.u32.html#method.wrapping_mul)
1289     pub fn overflowing_mul<T>(a: T, b: T) -> T;
1290
1291     /// Computes `a + b`, while saturating at numeric bounds.
1292     /// The stabilized versions of this intrinsic are available on the integer
1293     /// primitives via the `saturating_add` method. For example,
1294     /// [`std::u32::saturating_add`](../../std/primitive.u32.html#method.saturating_add)
1295     pub fn saturating_add<T>(a: T, b: T) -> T;
1296     /// Computes `a - b`, while saturating at numeric bounds.
1297     /// The stabilized versions of this intrinsic are available on the integer
1298     /// primitives via the `saturating_sub` method. For example,
1299     /// [`std::u32::saturating_sub`](../../std/primitive.u32.html#method.saturating_sub)
1300     pub fn saturating_sub<T>(a: T, b: T) -> T;
1301
1302     /// Returns the value of the discriminant for the variant in 'v',
1303     /// cast to a `u64`; if `T` has no discriminant, returns 0.
1304     pub fn discriminant_value<T>(v: &T) -> u64;
1305
1306     /// Rust's "try catch" construct which invokes the function pointer `f` with
1307     /// the data pointer `data`.
1308     ///
1309     /// The third pointer is a target-specific data pointer which is filled in
1310     /// with the specifics of the exception that occurred. For examples on Unix
1311     /// platforms this is a `*mut *mut T` which is filled in by the compiler and
1312     /// on MSVC it's `*mut [usize; 2]`. For more information see the compiler's
1313     /// source as well as std's catch implementation.
1314     pub fn r#try(f: fn(*mut u8), data: *mut u8, local_ptr: *mut u8) -> i32;
1315
1316     /// Emits a `!nontemporal` store according to LLVM (see their docs).
1317     /// Probably will never become stable.
1318     pub fn nontemporal_store<T>(ptr: *mut T, val: T);
1319 }
1320
1321 // Some functions are defined here because they accidentally got made
1322 // available in this module on stable. See <https://github.com/rust-lang/rust/issues/15702>.
1323 // (`transmute` also falls into this category, but it cannot be wrapped due to the
1324 // check that `T` and `U` have the same size.)
1325
1326 /// Copies `count * size_of::<T>()` bytes from `src` to `dst`. The source
1327 /// and destination must *not* overlap.
1328 ///
1329 /// For regions of memory which might overlap, use [`copy`] instead.
1330 ///
1331 /// `copy_nonoverlapping` is semantically equivalent to C's [`memcpy`], but
1332 /// with the argument order swapped.
1333 ///
1334 /// [`copy`]: ./fn.copy.html
1335 /// [`memcpy`]: https://en.cppreference.com/w/c/string/byte/memcpy
1336 ///
1337 /// # Safety
1338 ///
1339 /// Behavior is undefined if any of the following conditions are violated:
1340 ///
1341 /// * `src` must be [valid] for reads of `count * size_of::<T>()` bytes.
1342 ///
1343 /// * `dst` must be [valid] for writes of `count * size_of::<T>()` bytes.
1344 ///
1345 /// * Both `src` and `dst` must be properly aligned.
1346 ///
1347 /// * The region of memory beginning at `src` with a size of `count *
1348 ///   size_of::<T>()` bytes must *not* overlap with the region of memory
1349 ///   beginning at `dst` with the same size.
1350 ///
1351 /// Like [`read`], `copy_nonoverlapping` creates a bitwise copy of `T`, regardless of
1352 /// whether `T` is [`Copy`]. If `T` is not [`Copy`], using *both* the values
1353 /// in the region beginning at `*src` and the region beginning at `*dst` can
1354 /// [violate memory safety][read-ownership].
1355 ///
1356 /// Note that even if the effectively copied size (`count * size_of::<T>()`) is
1357 /// `0`, the pointers must be non-NULL and properly aligned.
1358 ///
1359 /// [`Copy`]: ../marker/trait.Copy.html
1360 /// [`read`]: ../ptr/fn.read.html
1361 /// [read-ownership]: ../ptr/fn.read.html#ownership-of-the-returned-value
1362 /// [valid]: ../ptr/index.html#safety
1363 ///
1364 /// # Examples
1365 ///
1366 /// Manually implement [`Vec::append`]:
1367 ///
1368 /// ```
1369 /// use std::ptr;
1370 ///
1371 /// /// Moves all the elements of `src` into `dst`, leaving `src` empty.
1372 /// fn append<T>(dst: &mut Vec<T>, src: &mut Vec<T>) {
1373 ///     let src_len = src.len();
1374 ///     let dst_len = dst.len();
1375 ///
1376 ///     // Ensure that `dst` has enough capacity to hold all of `src`.
1377 ///     dst.reserve(src_len);
1378 ///
1379 ///     unsafe {
1380 ///         // The call to offset is always safe because `Vec` will never
1381 ///         // allocate more than `isize::MAX` bytes.
1382 ///         let dst_ptr = dst.as_mut_ptr().offset(dst_len as isize);
1383 ///         let src_ptr = src.as_ptr();
1384 ///
1385 ///         // Truncate `src` without dropping its contents. We do this first,
1386 ///         // to avoid problems in case something further down panics.
1387 ///         src.set_len(0);
1388 ///
1389 ///         // The two regions cannot overlap because mutable references do
1390 ///         // not alias, and two different vectors cannot own the same
1391 ///         // memory.
1392 ///         ptr::copy_nonoverlapping(src_ptr, dst_ptr, src_len);
1393 ///
1394 ///         // Notify `dst` that it now holds the contents of `src`.
1395 ///         dst.set_len(dst_len + src_len);
1396 ///     }
1397 /// }
1398 ///
1399 /// let mut a = vec!['r'];
1400 /// let mut b = vec!['u', 's', 't'];
1401 ///
1402 /// append(&mut a, &mut b);
1403 ///
1404 /// assert_eq!(a, &['r', 'u', 's', 't']);
1405 /// assert!(b.is_empty());
1406 /// ```
1407 ///
1408 /// [`Vec::append`]: ../../std/vec/struct.Vec.html#method.append
1409 #[stable(feature = "rust1", since = "1.0.0")]
1410 #[inline]
1411 pub unsafe fn copy_nonoverlapping<T>(src: *const T, dst: *mut T, count: usize) {
1412     extern "rust-intrinsic" {
1413         fn copy_nonoverlapping<T>(src: *const T, dst: *mut T, count: usize);
1414     }
1415     copy_nonoverlapping(src, dst, count);
1416 }
1417
1418 /// Copies `count * size_of::<T>()` bytes from `src` to `dst`. The source
1419 /// and destination may overlap.
1420 ///
1421 /// If the source and destination will *never* overlap,
1422 /// [`copy_nonoverlapping`] can be used instead.
1423 ///
1424 /// `copy` is semantically equivalent to C's [`memmove`], but with the argument
1425 /// order swapped. Copying takes place as if the bytes were copied from `src`
1426 /// to a temporary array and then copied from the array to `dst`.
1427 ///
1428 /// [`copy_nonoverlapping`]: ./fn.copy_nonoverlapping.html
1429 /// [`memmove`]: https://en.cppreference.com/w/c/string/byte/memmove
1430 ///
1431 /// # Safety
1432 ///
1433 /// Behavior is undefined if any of the following conditions are violated:
1434 ///
1435 /// * `src` must be [valid] for reads of `count * size_of::<T>()` bytes.
1436 ///
1437 /// * `dst` must be [valid] for writes of `count * size_of::<T>()` bytes.
1438 ///
1439 /// * Both `src` and `dst` must be properly aligned.
1440 ///
1441 /// Like [`read`], `copy` creates a bitwise copy of `T`, regardless of
1442 /// whether `T` is [`Copy`]. If `T` is not [`Copy`], using both the values
1443 /// in the region beginning at `*src` and the region beginning at `*dst` can
1444 /// [violate memory safety][read-ownership].
1445 ///
1446 /// Note that even if the effectively copied size (`count * size_of::<T>()`) is
1447 /// `0`, the pointers must be non-NULL and properly aligned.
1448 ///
1449 /// [`Copy`]: ../marker/trait.Copy.html
1450 /// [`read`]: ../ptr/fn.read.html
1451 /// [read-ownership]: ../ptr/fn.read.html#ownership-of-the-returned-value
1452 /// [valid]: ../ptr/index.html#safety
1453 ///
1454 /// # Examples
1455 ///
1456 /// Efficiently create a Rust vector from an unsafe buffer:
1457 ///
1458 /// ```
1459 /// use std::ptr;
1460 ///
1461 /// # #[allow(dead_code)]
1462 /// unsafe fn from_buf_raw<T>(ptr: *const T, elts: usize) -> Vec<T> {
1463 ///     let mut dst = Vec::with_capacity(elts);
1464 ///     dst.set_len(elts);
1465 ///     ptr::copy(ptr, dst.as_mut_ptr(), elts);
1466 ///     dst
1467 /// }
1468 /// ```
1469 #[stable(feature = "rust1", since = "1.0.0")]
1470 #[inline]
1471 pub unsafe fn copy<T>(src: *const T, dst: *mut T, count: usize) {
1472     extern "rust-intrinsic" {
1473         fn copy<T>(src: *const T, dst: *mut T, count: usize);
1474     }
1475     copy(src, dst, count)
1476 }
1477
1478 /// Sets `count * size_of::<T>()` bytes of memory starting at `dst` to
1479 /// `val`.
1480 ///
1481 /// `write_bytes` is similar to C's [`memset`], but sets `count *
1482 /// size_of::<T>()` bytes to `val`.
1483 ///
1484 /// [`memset`]: https://en.cppreference.com/w/c/string/byte/memset
1485 ///
1486 /// # Safety
1487 ///
1488 /// Behavior is undefined if any of the following conditions are violated:
1489 ///
1490 /// * `dst` must be [valid] for writes of `count * size_of::<T>()` bytes.
1491 ///
1492 /// * `dst` must be properly aligned.
1493 ///
1494 /// Additionally, the caller must ensure that writing `count *
1495 /// size_of::<T>()` bytes to the given region of memory results in a valid
1496 /// value of `T`. Using a region of memory typed as a `T` that contains an
1497 /// invalid value of `T` is undefined behavior.
1498 ///
1499 /// Note that even if the effectively copied size (`count * size_of::<T>()`) is
1500 /// `0`, the pointer must be non-NULL and properly aligned.
1501 ///
1502 /// [valid]: ../ptr/index.html#safety
1503 ///
1504 /// # Examples
1505 ///
1506 /// Basic usage:
1507 ///
1508 /// ```
1509 /// use std::ptr;
1510 ///
1511 /// let mut vec = vec![0u32; 4];
1512 /// unsafe {
1513 ///     let vec_ptr = vec.as_mut_ptr();
1514 ///     ptr::write_bytes(vec_ptr, 0xfe, 2);
1515 /// }
1516 /// assert_eq!(vec, [0xfefefefe, 0xfefefefe, 0, 0]);
1517 /// ```
1518 ///
1519 /// Creating an invalid value:
1520 ///
1521 /// ```
1522 /// use std::ptr;
1523 ///
1524 /// let mut v = Box::new(0i32);
1525 ///
1526 /// unsafe {
1527 ///     // Leaks the previously held value by overwriting the `Box<T>` with
1528 ///     // a null pointer.
1529 ///     ptr::write_bytes(&mut v as *mut Box<i32>, 0, 1);
1530 /// }
1531 ///
1532 /// // At this point, using or dropping `v` results in undefined behavior.
1533 /// // drop(v); // ERROR
1534 ///
1535 /// // Even leaking `v` "uses" it, and hence is undefined behavior.
1536 /// // mem::forget(v); // ERROR
1537 ///
1538 /// // In fact, `v` is invalid according to basic type layout invariants, so *any*
1539 /// // operation touching it is undefined behavior.
1540 /// // let v2 = v; // ERROR
1541 ///
1542 /// unsafe {
1543 ///     // Let us instead put in a valid value
1544 ///     ptr::write(&mut v as *mut Box<i32>, Box::new(42i32));
1545 /// }
1546 ///
1547 /// // Now the box is fine
1548 /// assert_eq!(*v, 42);
1549 /// ```
1550 #[stable(feature = "rust1", since = "1.0.0")]
1551 #[inline]
1552 pub unsafe fn write_bytes<T>(dst: *mut T, val: u8, count: usize) {
1553     extern "rust-intrinsic" {
1554         fn write_bytes<T>(dst: *mut T, val: u8, count: usize);
1555     }
1556     write_bytes(dst, val, count)
1557 }