src/liballoc/lib.rs

   1 // Copyright 2014 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 //! # The Rust core allocation library
  12 //!
  13 //! This is the lowest level library through which allocation in Rust can be
  14 //! performed.
  15 //!
  16 //! This library, like libcore, is not intended for general usage, but rather as
  17 //! a building block of other libraries. The types and interfaces in this
  18 //! library are reexported through the [standard library](../std/index.html),
  19 //! and should not be used through this library.
  20 //!
  21 //! Currently, there are four major definitions in this library.
  22 //!
  23 //! ## Boxed values
  24 //!
  25 //! The [`Box`](boxed/index.html) type is a smart pointer type. There can
  26 //! only be one owner of a `Box`, and the owner can decide to mutate the
  27 //! contents, which live on the heap.
  28 //!
  29 //! This type can be sent among threads efficiently as the size of a `Box` value
  30 //! is the same as that of a pointer. Tree-like data structures are often built
  31 //! with boxes because each node often has only one owner, the parent.
  32 //!
  33 //! ## Reference counted pointers
  34 //!
  35 //! The [`Rc`](rc/index.html) type is a non-threadsafe reference-counted pointer
  36 //! type intended for sharing memory within a thread. An `Rc` pointer wraps a
  37 //! type, `T`, and only allows access to `&T`, a shared reference.
  38 //!
  39 //! This type is useful when inherited mutability (such as using `Box`) is too
  40 //! constraining for an application, and is often paired with the `Cell` or
  41 //! `RefCell` types in order to allow mutation.
  42 //!
  43 //! ## Atomically reference counted pointers
  44 //!
  45 //! The [`Arc`](arc/index.html) type is the threadsafe equivalent of the `Rc`
  46 //! type. It provides all the same functionality of `Rc`, except it requires
  47 //! that the contained type `T` is shareable. Additionally, `Arc<T>` is itself
  48 //! sendable while `Rc<T>` is not.
  49 //!
  50 //! This types allows for shared access to the contained data, and is often
  51 //! paired with synchronization primitives such as mutexes to allow mutation of
  52 //! shared resources.
  53 //!
  54 //! ## Heap interfaces
  55 //!
  56 //! The [`heap`](heap/index.html) module defines the low-level interface to the
  57 //! default global allocator. It is not compatible with the libc allocator API.
  58
  59 // Do not remove on snapshot creation. Needed for bootstrap. (Issue #22364)
  60 #![cfg_attr(stage0, feature(custom_attribute))]
  61 #![crate_name = "alloc"]
  62 #![crate_type = "rlib"]
  63 #![staged_api]
  64 #![allow(unused_attributes)]
  65 #![unstable(feature = "alloc",
  66             reason = "this library is unlikely to be stabilized in its current \
  67                       form or name",
  68             issue = "27783")]
  69 #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
  70        html_favicon_url = "https://doc.rust-lang.org/favicon.ico",
  71        html_root_url = "https://doc.rust-lang.org/nightly/",
  72        issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/",
  73        test(no_crate_inject))]
  74 #![no_std]
  75 #![cfg_attr(not(stage0), needs_allocator)]
  76
  77 #![feature(allocator)]
  78 #![feature(box_syntax)]
  79 #![feature(coerce_unsized)]
  80 #![feature(core)]
  81 #![feature(core_intrinsics)]
  82 #![feature(core_slice_ext)]
  83 #![feature(custom_attribute)]
  84 #![feature(fundamental)]
  85 #![feature(lang_items)]
  86 #![feature(no_std)]
  87 #![feature(nonzero)]
  88 #![feature(num_bits_bytes)]
  89 #![feature(optin_builtin_traits)]
  90 #![feature(placement_in_syntax)]
  91 #![feature(placement_new_protocol)]
  92 #![feature(raw)]
  93 #![feature(staged_api)]
  94 #![feature(unboxed_closures)]
  95 #![feature(unique)]
  96 #![feature(unsafe_no_drop_flag, filling_drop)]
  97 #![feature(unsize)]
  98 #![feature(core_slice_ext)]
  99 #![feature(core_str_ext)]
 100 #![cfg_attr(stage0, feature(alloc_system))]
 101 #![cfg_attr(not(stage0), feature(needs_allocator))]
 102
 103 #![cfg_attr(test, feature(test, rustc_private, box_raw))]
 104
 105 #[cfg(stage0)]
 106 extern crate alloc_system;
 107
 108 // Allow testing this library
 109
 110 #[cfg(test)] #[macro_use] extern crate std;
 111 #[cfg(test)] #[macro_use] extern crate log;
 112
 113 // Heaps provided for low-level allocation strategies
 114
 115 pub mod heap;
 116
 117 // Primitive types using the heaps above
 118
 119 // Need to conditionally define the mod from `boxed.rs` to avoid
 120 // duplicating the lang-items when building in test cfg; but also need
 121 // to allow code to have `use boxed::HEAP;`
 122 // and `use boxed::Box;` declarations.
 123 #[cfg(not(test))]
 124 pub mod boxed;
 125 #[cfg(test)]
 126 mod boxed { pub use std::boxed::{Box, HEAP}; }
 127 #[cfg(test)]
 128 mod boxed_test;
 129 pub mod arc;
 130 pub mod rc;
 131 pub mod raw_vec;
 132
 133 /// Common out-of-memory routine
 134 #[cold]
 135 #[inline(never)]
 136 #[unstable(feature = "oom", reason = "not a scrutinized interface",
 137            issue = "27700")]
 138 pub fn oom() -> ! {
 139     // FIXME(#14674): This really needs to do something other than just abort
 140     //                here, but any printing done must be *guaranteed* to not
 141     //                allocate.
 142     unsafe { core::intrinsics::abort() }
 143 }