Code Monkey home page Code Monkey logo

frenetic's Introduction

Build Status Rust Version 1.36+ Crate Docs License

Frenetic

Frenetic is an implementation of stackful coroutines. It is written in Rust and LLVM. Notably, this approach does not require any system calls or hand-crafted assembly at all.

Examples

use frenetic::{Coroutine, Generator, GeneratorState};
use core::pin::Pin;

// You'll need to create a stack before using Frenetic coroutines.
let mut stack = [0u8; 4096 * 8];

// Then, you can initialize with `Coroutine::new`.
let mut coro = Coroutine::new(&mut stack, |c| {
    let c = c.r#yield(1)?; // Yield an integer value.
    c.done("foo") // Return a string value.
});

// You can also interact with the yielded and returned values.
match Pin::new(&mut coro).resume() {
    GeneratorState::Yielded(1) => {}
    _ => panic!("unexpected return from resume"),
}
match Pin::new(&mut coro).resume() {
    GeneratorState::Complete("foo") => {}
    _ => panic!("unexpected return from resume"),
}

That's it!

API

The current API consists of a few basic primitives:

Coroutine::new

Spawns a new coroutine. Requires a stack and a function to be executed.

NOTE: The caller is responsible for properly allocating this stack. We recommend the stack includes a guard page.

Control::r#yield

Halts the current coroutine's execution and passes control back to the parent.

Control::done

Marks the current coroutine as done, and finishes.

Generator::resume

Resumes a halted coroutine.

frenetic's People

Contributors

frozencemetery avatar haraldh avatar mbestavros avatar npmccallum avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.