This serves to showcase an example of building a project which relies on the cocoOS cooperative scheduler. Building with CMake is supported (and indeed encouraged) but you can also simply include the OS directly into your project (shown here by using a git submodule).

The user is expected to provide 6 macros via a header file named user_os_config.h and provide it to their build. Examples are provided in this repo on how to do that. Below is an example header.

// user_os_config.h
#ifndef USER_OS_CONFIG_H
#define USER_OS_CONFIG_H

#define N_TASKS      3
#define N_QUEUES     0
#define N_SEMAPHORES 0
#define N_EVENTS     0
#define ROUND_ROBIN  0
#define Mem_t        uint32_t

#endif

If building with cmake, users should provide the include file via a library interface as such:

add_library(user_os_config INTERFACE)
target_include_directories(user_os_config
    INTERFACE
        # Path to directory containing user_os_config.h
        c/include
)

You will need docker isntalled, although if you have the required cmake version (or you are not building with cmake) and gcc compiler you can build locally and skip this step.

Get and drop into the docker container

make container.pull
make container.start

Refer to the CMakeLists.txt file in this directory. The relevant sections to add to your CMake project are shown below:

include(FetchContent)
FetchContent_Declare(
    cocoOS
    GIT_REPOSITORY https://github.com/MitchellThompkins/cocoOS
    GIT_TAG        test_user_dependency
)

FetchContent_MakeAvailable(cocoOS)

add_library(user_os_config INTERFACE)
target_include_directories(user_os_config
    INTERFACE
        c/include
)

add_executable(cocoOS_example_c
    c/src/main.c
)

target_link_libraries(cocoOS_example_c
    pthread
    cocoOs
)

To build this example with CMake execute the below function.

make build.cmake

You will need to specify all of the source and include files. The makefile in this directory has an example of how to do this.

To build this example with just a makefile execute the below function.

make build.makefile

sh-4.4$ ./cmake_build/cocoOS_example_c.elf
+ ./cmake_build/cocoOS_example_c.elf

hello world
bar
foo
foobar
global_time: 0
global_time: 1
global_time: 2
global_time: 3
after foobar
global_time: 4
global_time: 5

sh-4.4$ ./makefile_build/cocoOS_example_c.elf
+ ./makefile_build/cocoOS_example_c.elf

hello world
bar
foo
foobar
global_time: 0
global_time: 1
global_time: 2
global_time: 3
after foobar
global_time: 4
global_time: 5