lib-zo,C语言另一个协程库,协程锁,协程条件,协程信号

lib-zo,C语言另一个协程库,协程锁,协程条件,协程信号

另一个 C 协程库 https://blog.csdn.net/eli960/article/details/146802313

协程锁

基本含义请参考Linux平台线程锁

// 创建协程锁
zcoroutine_mutex_t * zcoroutine_mutex_create();
void zcoroutine_mutex_free(zcoroutine_mutex_t *);

// 锁
void zcoroutine_mutex_lock(zcoroutine_mutex_t *);

// 解锁
void zcoroutine_mutex_unlock(zcoroutine_mutex_t *);

协程条件

基本含义请参考Linux平台线程条件

// 创建条件
zcoroutine_cond_t * zcoroutine_cond_create();
void zcoroutine_cond_free(zcoroutine_cond_t *);

// 条件等待, 参考 pthread_cond_wait
void zcoroutine_cond_wait(zcoroutine_cond_t *, zcoroutine_mutex_t *);

// 条件信号, 参考 pthread_cond_signal
void zcoroutine_cond_signal(zcoroutine_cond_t *);

// 条件广播, 参考 pthread_cond_broadcast
void zcoroutine_cond_broadcast(zcoroutine_cond_t *);

例子

#include "coroutine.h"

#include <stdio.h>
#include <unistd.h>

// 定义一个协程条件变量指针
zcoroutine_cond_t *cond;
// 定义一个协程互斥锁指针
zcoroutine_mutex_t *mutex;

/**
 * @brief 等待协程条件变量信号，然后执行一些操作
 * 
 * 该函数会在一个循环中等待协程条件变量的信号，每次接收到信号后打印相关信息。
 * 循环会执行2次。
 * 
 * @param context 传递给函数的上下文信息，用于标识协程的ID
 * @return void* 返回传入的上下文信息
 */
static void *wait_cond_then_do_something(void *context)
{
    // 循环2次等待条件变量信号
    for (int i = 0; i < 2; i++) {
        // 尝试加锁协程互斥锁
        /* zcoroutine_mutex_lock(mutex); */
        // 等待协程条件变量的信号，同时释放互斥锁，被唤醒后重新加锁
        zcoroutine_cond_wait(cond, mutex);
        // 打印接收到信号的协程ID和循环次数
        printf("get signal, id=%d, loop=%d\n", (int)(long)context, i+1);
        // 应该解锁协程互斥锁
        // zcoroutine_mutex_unlock(mutex);
    }
    /* 原注释：应该在这里执行解锁操作 */
    /* 原注释：当一个协程退出时，会自动释放所有互斥锁 */
    return context;
}

/**
 * @brief 开始协程条件变量测试
 * 
 * 该函数会创建协程条件变量和互斥锁，启动10个协程等待条件变量信号，
 * 然后依次发送信号、广播信号，并在适当的时候释放条件变量和互斥锁，
 * 最后通知协程调度器停止运行。
 * 
 * @param context 传递给函数的上下文信息，在本函数中未使用
 * @return void* 固定返回0
 */
static void *begin_my_test(void *context)
{
    // 创建一个协程条件变量
    cond  = zcoroutine_cond_create();
    // 创建一个协程互斥锁
    mutex  = zcoroutine_mutex_create();
    // 打印提示信息，表明将启动10个协程等待条件变量
    printf("start 10 coroutine to wait cond.\n");
    // 启动10个协程，每个协程执行 wait_cond_then_do_something 函数
    for (int i = 0; i < 10; i++) {
        zcoroutine_go(wait_cond_then_do_something, (void *)(long)i, 0);
    }
    // 打印提示信息，表明将等待1秒
    printf("waiting 1 second ...\n");

    // 打印提示信息，表明将发送条件变量信号并等待1秒
    printf("\n\ncoroutine_cond_signal, then sleep 1s  ... \n");
    // 发送一个条件变量信号，唤醒一个等待的协程
    zcoroutine_cond_signal(cond);
    // 线程休眠1秒
    sleep(1);

    // 打印提示信息，表明将广播条件变量信号
    printf("\n\ncoroutine_cond_broadcast ... \n");
    // 广播条件变量信号，唤醒所有等待的协程
    zcoroutine_cond_broadcast(cond);

    // 打印提示信息，表明将广播条件变量信号并等待1秒
    printf("\n\ncoroutine_cond_broadcast, then sleep 1s ... \n");
    // 广播条件变量信号，唤醒所有等待的协程
    zcoroutine_cond_broadcast(cond);
    // 线程休眠1秒
    sleep(1);

    // 打印提示信息，表明将广播条件变量信号
    printf("\n\ncoroutine_cond_broadcast ... \n");
    // 广播条件变量信号，唤醒所有等待的协程
    zcoroutine_cond_broadcast(cond);

    // 打印提示信息，表明将释放条件变量和互斥锁并等待1秒
    printf("\n\ncoroutine_cond_free, coroutine_mutex_free then sleep 1s ... \n");
    // 释放协程条件变量
    zcoroutine_cond_free(cond);
    // 释放协程互斥锁
    zcoroutine_mutex_free(mutex);
    // 线程休眠1秒
    sleep(1);

    // 打印提示信息，表明将通知协程调度器停止运行
    printf("\n\nnotify stop ... \n");
    // 通知协程调度器停止运行
    zcoroutine_base_stop_notify(0);

    return 0;
}

int main(int argc, char **argv)
{
    // 初始化协程基础环境
    zcoroutine_base_init();
    // 启动一个协程执行 begin_my_test 函数
    zcoroutine_go(begin_my_test, 0, 0);
    // 启动协程调度器
    zcoroutine_base_run();
    // 打印提示信息，表明协程调度器运行结束，将清理协程环境
    printf("\n\nzcoroutine_base_run over, then zcoroutine_base_fini \n");
    // 清理协程基础环境
    zcoroutine_base_fini();
    // 打印换行符
    printf("\n");
    return 0;
}