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 //! Rust's core allocation library
  12 //!
  13 //! This is the lowest level library through which allocation in Rust can be
  14 //! performed where the allocation is assumed to succeed. This library will
  15 //! trigger a task failure when allocation fails.
  16 //!
  17 //! This library, like libcore, is not intended for general usage, but rather as
  18 //! a building block of other libraries. The types and interfaces in this
  19 //! library are reexported through the [standard library](../std/index.html),
  20 //! and should not be used through this library.
  21 //!
  22 //! Currently, there are four major definitions in this library.
  23 //!
  24 //! ## Owned pointers
  25 //!
  26 //! The [`Box`](owned/index.html) type is the core owned pointer type in rust.
  27 //! There can only be one owner of a `Box`, and the owner can decide to mutate
  28 //! the contents.
  29 //!
  30 //! This type can be sent among tasks efficiently as the size of a `Box` value
  31 //! is just a pointer. Tree-like data structures are often built on owned
  32 //! pointers because each node often has only one owner, the parent.
  33 //!
  34 //! ## Reference counted pointers
  35 //!
  36 //! The [`Rc`](rc/index.html) type is a non-threadsafe reference-counted pointer
  37 //! type intended for sharing memory within a task. An `Rc` pointer wraps a
  38 //! type, `T`, and only allows access to `&T`, a shared reference.
  39 //!
  40 //! This type is useful when inherited mutability is too constraining for an
  41 //! application (such as using `Box`), and is often paired with the `Cell` or
  42 //! `RefCell` types in order to allow mutation.
  43 //!
  44 //! ## Atomically reference counted pointers
  45 //!
  46 //! The [`Arc`](arc/index.html) type is the threadsafe equivalent of the `Rc`
  47 //! type. It provides all the same functionality of `Rc`, except it requires
  48 //! that the contained type `T` is shareable. Additionally, `Arc<T>` is itself
  49 //! sendable while `Rc<T>` is not.
  50 //!
  51 //! This types allows for shared access to the contained data, and is often
  52 //! paired with synchronization primitives such as mutexes to allow mutation of
  53 //! shared resources.
  54 //!
  55 //! ## Heap interfaces
  56 //!
  57 //! The [`heap`](heap/index.html) and [`libc_heap`](libc_heap/index.html)
  58 //! modules are the unsafe interfaces to the underlying allocation systems. The
  59 //! `heap` module is considered the default heap, and is not necessarily backed
  60 //! by libc malloc/free.  The `libc_heap` module is defined to be wired up to
  61 //! the system malloc/free.
  62
  63 #![crate_id = "alloc#0.11.0"]
  64 #![experimental]
  65 #![license = "MIT/ASL2"]
  66 #![crate_type = "rlib"]
  67 #![doc(html_logo_url = "http://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
  68        html_favicon_url = "http://www.rust-lang.org/favicon.ico",
  69        html_root_url = "http://doc.rust-lang.org/")]
  70
  71 #![no_std]
  72 #![feature(lang_items, phase, unsafe_destructor)]
  73 #![allow(unknown_features)] // NOTE: remove after a stage0 snap
  74
  75 #[phase(plugin, link)]
  76 extern crate core;
  77 extern crate libc;
  78
  79 // Allow testing this library
  80
  81 #[cfg(test)] extern crate debug;
  82 #[cfg(test)] extern crate native;
  83 #[cfg(test)] #[phase(plugin, link)] extern crate std;
  84 #[cfg(test)] #[phase(plugin, link)] extern crate log;
  85
  86 // Heaps provided for low-level allocation strategies
  87
  88 pub mod heap;
  89 pub mod libc_heap;
  90 pub mod util;
  91
  92 // Primitive types using the heaps above
  93
  94 #[cfg(not(test))]
  95 pub mod owned;
  96 pub mod arc;
  97 pub mod rc;
  98
  99 /// Common OOM routine used by liballoc
 100 fn oom() -> ! {
 101     // FIXME(#14674): This really needs to do something other than just abort
 102     //                here, but any printing done must be *guaranteed* to not
 103     //                allocate.
 104     unsafe { core::intrinsics::abort() }
 105 }
 106
 107 // FIXME(#14344): When linking liballoc with libstd, this library will be linked
 108 //                as an rlib (it only exists as an rlib). It turns out that an
 109 //                optimized standard library doesn't actually use *any* symbols
 110 //                from this library. Everything is inlined and optimized away.
 111 //                This means that linkers will actually omit the object for this
 112 //                file, even though it may be needed in the future.
 113 //
 114 //                To get around this for now, we define a dummy symbol which
 115 //                will never get inlined so the stdlib can call it. The stdlib's
 116 //                reference to this symbol will cause this library's object file
 117 //                to get linked in to libstd successfully (the linker won't
 118 //                optimize it out).
 119 #[doc(hidden)]
 120 pub fn fixme_14344_be_sure_to_link_to_collections() {}
 121
 122 #[cfg(not(test))]
 123 #[doc(hidden)]
 124 mod std {
 125     pub use core::fmt;
 126     pub use core::option;
 127 }