1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50
// This file is part of libfringe, a low-level green threading library. // Copyright (c) edef <edef@edef.eu> // Licensed under the Apache License, Version 2.0, <LICENSE-APACHE or // http://apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT or // http://opensource.org/licenses/MIT>, at your option. This file may not be // copied, modified, or distributed except according to those terms. //! Traits for stacks. mod slice_stack; pub use stack::slice_stack::SliceStack; #[cfg(feature = "alloc")] mod owned_stack; #[cfg(feature = "alloc")] pub use stack::owned_stack::OwnedStack; #[cfg(unix)] mod os; #[cfg(unix)] pub use stack::os::OsStack; /// A trait for objects that hold ownership of a stack. /// /// To preserve memory safety, an implementation of this trait must fulfill /// the following contract: /// /// * The base address of the stack must be aligned to /// a [`STACK_ALIGNMENT`][align]-byte boundary. /// * Every address between the base and the limit must be readable and writable. /// /// [align]: constant.STACK_ALIGNMENT.html pub unsafe trait Stack { /// Returns the base address of the stack. /// On all modern architectures, the stack grows downwards, /// so this is the highest address. fn base(&self) -> *mut u8; /// Returns the limit address of the stack. /// On all modern architectures, the stack grows downwards, /// so this is the lowest address. fn limit(&self) -> *mut u8; } /// A marker trait for `Stack` objects with a guard page. /// /// To preserve memory safety, an implementation of this trait must fulfill /// the following contract, in addition to the [contract](trait.Stack.html) of `Stack`: /// /// * Any access of data at addresses `limit()` to `limit().offset(4096)` must /// abnormally terminate, at least, the thread that performs the access. pub unsafe trait GuardedStack {}