52 lines
1.7 KiB

// This file is part of libfringe, a low-level green threading library.
// Copyright (c) edef <>
// Licensed under the Apache License, Version 2.0, <LICENSE-APACHE or
//> or the MIT license <LICENSE-MIT or
//>, at your option. This file may not be
// copied, modified, or distributed except according to those terms.
#![feature(llvm_asm, naked_functions, untagged_unions)]
#![cfg_attr(feature = "alloc", feature(alloc, allocator_api))]
#![cfg_attr(test, feature(test))]
//! libfringe is a library implementing safe, lightweight context switches,
//! without relying on kernel services. It can be used in hosted environments
//! (using `std`) as well as on bare metal (using `core`).
//! It provides the following safe abstractions:
//! * an implementation of generators,
//! [Generator](generator/struct.Generator.html).
//! It also provides the necessary low-level building blocks:
//! * a trait that can be implemented by stack allocators,
//! [Stack](struct.Stack.html);
//! * a wrapper for using slice references as stacks,
//! [SliceStack](struct.SliceStack.html);
//! * a stack allocator based on `Box<[u8]>`,
//! [OwnedStack](struct.OwnedStack.html);
//! * a stack allocator based on anonymous memory mappings with guard pages,
//! [OsStack](struct.OsStack.html).
extern crate std;
#[cfg(feature = "alloc")]
extern crate alloc;
pub use stack::*;
pub use generator::Generator;
mod arch;
/// Minimum alignment of a stack base address on the target platform.
pub const STACK_ALIGNMENT: usize = arch::STACK_ALIGNMENT;
mod debug;
pub mod generator;
mod stack;