Skip to content

Latest commit

 

History

History
56 lines (36 loc) · 1.9 KB

README.md

File metadata and controls

56 lines (36 loc) · 1.9 KB
Raw

Hilolay

Hilolay (pronounced "Hilo Light") is a tiny user level (AKA light, AKA green) threads library, for education purposes.

How can I run it?

  • CLion: Import the project and take advantage of the "new" makefile format. Run -> run 'ults'
  • Your favorite editor: Just code, and run make clean && make. Then ./ults

Project structure

This is still a little green (pun intended), but for now:

  • ults.c is the main project
  • hilolay/hilolay.c is the actual library. It's supposed to contain all the code related to ULTs administration. The naming convention is lib_func for functions related to the library behavior, and th_func for thread functions. I'm eager to find a better one, submit an issue!
  • To document the code, please use /* */. To comment a few lines, please use // (and explain why is commented).

A small example of code:

#include "hilolay/hilolay.h"

void func() {
    puts('Do you have a photograph of John?');

    /* In case you want to make the library scheduling work */
    th_yield();
}


int main(void) {
    /* Inits the library */
    lib_init();

    /* Creates a thread that will run func. Right now, you can create up to 49 threads (50, including main). */
    th_create(func);

    /* Finishes the thread. The execution of the other threads won't stop until they finish */
    th_return(0);
}

The code of the library is well documented, but please consider adding whatever you feel it's needed

Contribute

  • Fork the repo
  • Check the issues. Add whatever you consider that can be useful
  • Assign yourself an issue and submit a PR with the changes.
  • Please consider avoiding refactors without coordinating with the rest of the team, in order to merge stuff smoothly. Don't be a lone wolf!

Green threads

image

(Originally forked from https://github.com/mpu/gthreads)