global allocators: add a few comments

This commit is contained in:
Ralf Jung 2018-11-12 09:00:39 +01:00
parent d1d79ae3ad
commit 075983c70b
2 changed files with 9 additions and 0 deletions

View File

@ -21,6 +21,10 @@ use core::usize;
pub use core::alloc::*;
extern "Rust" {
// These are the magic symbols to call the global allocator. rustc generates
// them from the `#[global_allocator]` attribute if there is one, or uses the
// default implementations in libstd (`__rdl_alloc` etc in `src/libstd/alloc.rs`)
// otherwise.
#[allocator]
#[rustc_allocator_nounwind]
fn __rust_alloc(size: usize, align: usize) -> *mut u8;

View File

@ -142,6 +142,7 @@ pub use alloc_crate::alloc::*;
#[derive(Debug, Copy, Clone)]
pub struct System;
// The Alloc impl just forwards to the GlobalAlloc impl, which is in `std::sys::*::alloc`.
#[unstable(feature = "allocator_api", issue = "32838")]
unsafe impl Alloc for System {
#[inline]
@ -226,6 +227,10 @@ pub fn rust_oom(layout: Layout) -> ! {
#[unstable(feature = "alloc_internals", issue = "0")]
pub mod __default_lib_allocator {
use super::{System, Layout, GlobalAlloc};
// These magic symbol names are used as a fallback for implementing the
// `__rust_alloc` etc symbols (see `src/liballoc/alloc.rs) when there is
// no `#[global_allocator]` attribute.
// for symbol names src/librustc/middle/allocator.rs
// for signatures src/librustc_allocator/lib.rs