Libuv中文文档之线程

转载 2016年08月31日 16:37:10

Libuv中文文档之线程

文章目录

等等, 我们为什么会提到线程? 事件循环不应该本身就可以应对高并发网络编程么? 不一定, 线程仍然可以在 CPU 处理任务时来执行一些计算量相对较小的子任务, 即使在编程多线程程序中你必须编写大量同步原语, 但它们在大多时候还是可以派上大用场的.

线程通常在 libuv 内部使用, 用于模拟系统调用的异步特性<?>(原文: Threads are used internally to fake the asynchronous nature of all the system calls). libuv 同样可以利用线程让你异步完成一项本可能阻塞的任务, 通常是创建子线程, 在子线程完成任务后获取其结果.

目前存在两个主流的线程库, Windows 线程库实现和 pthreads. libuv 的线程库 API 与 pthread API 相似, 因此两者具有相同的语义.

值得注意的是, libuv 中的线程库是自包含的. 而其他特性都直接依赖事件循环或者回调. 事件循环和回调中的基本原则在线程中是完全不受限制的. 线程会在必要的时候被阻塞, 信号错误直接通过返回值来确定, 正如例子所示 first example, 线程中并不需要运行事件循环.

libuv 的线程 API 也非常有限, 因为不同平台上线程库的语义和语法也不同, API 功能的完善程度也不尽相同.

本节做了如下假设: 一个线程里面(主线程)只有一个事件循环在运行**(**There is only one event loop, running in one thread (the main thread)). 没有其他的线程与事件循环交互 (除非使用 uv_async_send). 多路事件循环(Multiple event loops) 介绍了如何在多个线程中运行并管理事件循环.

线程核心操作(Core thread operations)

下面的例子程序并没有太多代码, 只是通过 uv_thread_create 创建了线程, 然后调用 uv_thread_join 等待线程退出.

thread-create/main.c

int main() {
    int tracklen = 10;
    uv_thread_t hare_id;
    uv_thread_t tortoise_id;
    uv_thread_create(&hare_id, hare, &tracklen);
    uv_thread_create(&tortoise_id, tortoise, &tracklen);

    uv_thread_join(&hare_id);
    uv_thread_join(&tortoise_id);
    return 0;
}

Tip

在 Unix 平台上 uv_thread_t 只是 pthread_t 的别名,但是在实现细节上也避免依赖 pthread.

第二个参数是线程执行任务的入口函数地址, 最后 void * 类型的参数用来向线程传递自定义参数. 函数 hare 现在可以在另外一个单独线程中运行, 并由操作系统进行调度.

thread-create/main.c

void hare(void *arg) {
    int tracklen = *((int *) arg);
    while (tracklen) {
        tracklen--;
        sleep(1);
        fprintf(stderr, "Hare ran another step\n");
    }
    fprintf(stderr, "Hare done running!\n");
}

pthread_join() 允许目标线程通过 pthread_join() 的第二个函数传回给调用线程一个返回值不同, uv_thread_join() 并不允许调用/被调用线程之间通过这样的方式传值. 你应该使用 线程间通信(Inter-thread communication).

同步原语(Synchronization Primitives)

本节为了简洁起见并不完整简述线程的有关内容, 我在此也只归纳出一些 libuv 线程 API 比较特殊的地方, 剩下的你可以参看 pthread 的帮助页面 pthreads.

互斥量(Mutexes)

libuv 中的互斥函数可以看作是 pthread 相关函数(pthread_mutex_*)的 直接 映射.

libuv mutex functions

UV_EXTERN int uv_mutex_init(uv_mutex_t* handle);
UV_EXTERN void uv_mutex_destroy(uv_mutex_t* handle);
UV_EXTERN void uv_mutex_lock(uv_mutex_t* handle);
UV_EXTERN int uv_mutex_trylock(uv_mutex_t* handle);
UV_EXTERN void uv_mutex_unlock(uv_mutex_t* handle);

uv_mutex_init()uv_mutex_trylock() 在调用成功时返回 0, 若出错则返回 -1.

如果 libuv 以调试(debugging)模式进行编译, uv_mutex_destroy(), uv_mutex_lock()uv_mutex_unlock() 函数在出错时将会调用 abort(). 同样地在调用 uv_mutex_trylock() 时, 除非错误码是 EAGAIN, 否则也会导致程序中止(abort).

某些平台支持递归锁, 但是你不应该依赖某个特定平台的实现. BSD 互斥锁的实现规定: 如果在一个线程已经锁住了互斥量以后再次试图对该互斥量进行上锁, 则程序会抛出错误. 举个例子, 如下代码:

uv_mutex_lock(a_mutex);
uv_thread_create(thread_id, entry, (void *)a_mutex);
uv_mutex_lock(a_mutex);
// more things here

原本可以等待另外一个线程初始化后解锁, 但是在调试模式下该段代码会使你的程序崩溃, 或者在第二次调用 uv_mutex_lock 时出错.

Note

Linux 平台的互斥锁支持递归, 但是 libuv 并没有暴露相关的 API.

锁(Locks)

读写锁是一种更细粒度的访问策略.两个线程可以同时访问共享内存区域, 当读线程拥有锁时, 写线程并不能获取到锁, 而当某个写线程拥有锁时其他读写线程都不能获得锁. 读写锁通常在数据库中用得比较多.以下是一个简单的例子:

locks/main.c – simple rwlocks

#include <stdio.h>
#include <uv.h>

uv_barrier_t blocker;
uv_rwlock_t numlock;
int shared_num;

void reader(void *n)
{
    int num = *(int *)n;
    int i;
    for (i = 0; i < 20; i++) {
        uv_rwlock_rdlock(&numlock);
        printf("Reader %d: acquired lock\n", num);
        printf("Reader %d: shared num = %d\n", num, shared_num);
        uv_rwlock_rdunlock(&numlock);
        printf("Reader %d: released lock\n", num);
    }
    uv_barrier_wait(&blocker);
}

void writer(void *n)
{
    int num = *(int *)n;
    int i;
    for (i = 0; i < 20; i++) {
        uv_rwlock_wrlock(&numlock);
        printf("Writer %d: acquired lock\n", num);
        shared_num++;
        printf("Writer %d: incremented shared num = %d\n", num, shared_num);
        uv_rwlock_wrunlock(&numlock);
        printf("Writer %d: released lock\n", num);
    }
    uv_barrier_wait(&blocker);
}

int main()
{
    uv_barrier_init(&blocker, 4);

    shared_num = 0;
    uv_rwlock_init(&numlock);

    uv_thread_t threads[3];

    int thread_nums[] = {1, 2, 1};
    uv_thread_create(&threads[0], reader, &thread_nums[0]);
    uv_thread_create(&threads[1], reader, &thread_nums[1]);

    uv_thread_create(&threads[2], writer, &thread_nums[2]);

    uv_barrier_wait(&blocker);
    uv_barrier_destroy(&blocker);

    uv_rwlock_destroy(&numlock);
    return 0;
}

运行该程序你会看到读线程有时候会相互重叠地执行, 但是在多个存在多个写线程时, 调度器会优先去调度写线程(写线程优先级更高), 因此, 如果你添加两个写线程, 你会看到只有当两个写线程都完成各自的任务后, 读线程才有机会获得锁.

其他

libuv 也支持信号量 semaphores, 条件变量 condition variables 和屏障 barriers, 相关的 API 也和 pthread 中的相似.

在使用条件变量时, libuv 也可以在等待上设置超时时间, 不同平台超时设置可能会有所不同 [1].

另外, libuv 也提供了一个便于使用的函数“uv_once()“ (不要和 uv_run_once() 混淆). 多个线程以指定的函数指针为参数调用 uv_once 时, 只有一个线程会成功调用, 并且仅被调用一次

/* Initialize guard */
static uv_once_t once_only = UV_ONCE_INIT;

int i = 0;

void increment() {
    i++;
}

void thread1() {
    /* ... work */
    uv_once(once_only, increment);
}

void thread2() {
    /* ... work */
    uv_once(once_only, increment);
}

int main() {
    /* ... spawn threads */
}

所有的线程都完成任务后, i == 1.

libuv 工作队列

uv_queue_work() 是一个辅助函数, 它可以使得应用程序在单独的线程中运行某一任务, 并在任务完成后触发回调函数. uv_queue_work 看似简单, 但是在某些情况下却很实用, 因为该函数使得第三方库可以以事件循环的方式在你的程序中被使用.当你使用事件循环时, 应该 确保在事件循环中运行的函数执行 I/O 任务时不被阻塞, 或者事件循环的回调函数不会占用太多 CPU 的计算能力. 因为一旦发生了上述情况, 则意味着事件循环的执行速度会减慢, 事件得不到及时的处理.

但是也有一些代码在线程的事件循环的回调中使用了阻塞函数(例如执行 I/O 任务), (典型的 ‘one thread per client’ 服务器模型), 并在单独的线程中运行某一任务. libuv 只是提供了一层抽象而已.

下面是一个简单的例子(原型为 node.js is cancer). 我们程序计算 fibonacci 数, 中途也会休眠一会,但是由于是在单独的线程中运行的, 所以阻塞和 CPU 计算密集型的任务(fibonacci 数的计算)并不会阻碍事件循环执行其它任务.

queue-work/main.c – lazy fibonacci

void fib(uv_work_t *req) {
    int n = *(int *) req->data;
    if (random() % 2)
        sleep(1);
    else
        sleep(3);
    long fib = fib_(n);
    fprintf(stderr, "%dth fibonacci is %lu\n", n, fib);
}

void after_fib(uv_work_t *req, int status) {
    fprintf(stderr, "Done calculating %dth fibonacci\n", *(int *) req->data);
}

真正的执行任务的函数比较简单, 只是在单独的线程中执行. uv_work_t 结构是线索, 你可以通过 void* date 传递任意数据, 并且利用该指针和执行线程通信(数据传递). 但注意, 如果在多个线程中同时修改某个变量, 就应该使用合适的锁来保护共享变量.

触发器uv_queue_work:

queue-work/main.c

int main() {
    loop = uv_default_loop();

    int data[FIB_UNTIL];
    uv_work_t req[FIB_UNTIL];
    int i;
    for (i = 0; i < FIB_UNTIL; i++) {
        data[i] = i;
        req[i].data = (void *) &data[i];
        uv_queue_work(loop, &req[i], fib, after_fib);
    }

    return uv_run(loop, UV_RUN_DEFAULT);
}

线程函数会在单独的线程中被启动, 并传入 uv_work_t 结构, 一旦函数返回, 就会调用 after_fib 函数, 同时也传入 uv_work_t 结构的指针.

如果需要封装程序库的接口, 请参考 pattern 一节如何向线程传递数据.

线程间通信(Inter-thread communication)

某些时候你想在同时运行的各个线程之间传递数据. 例如你可能在一个单独的线程中运行一个长时间任务(可能是通过 uv_queue_work), 但是需要向主线程汇报任务进度. 一个简单的例子是下载管理器向用户汇报当前的下载任务的状态.

progress/main.c

uv_loop_t *loop;
uv_async_t async;

int main() {
    loop = uv_default_loop();

    uv_work_t req;
    int size = 10240;
    req.data = (void*) &size;

    uv_async_init(loop, &async, print_progress);
    uv_queue_work(loop, &req, fake_download, after);

    return uv_run(loop, UV_RUN_DEFAULT);
}

异步线程通信是在事件循环上进行的, 因此尽管任何线程都可能成为消息发送者, 但是只有 libuv 事件循环的线程可以是接收者(或者事件循环本身是接收者). 在任何时候异步监视器接受到了一个消息后, libuv 就会调用(print_progress)回调函数.

Warning

应该注意: 消息的发送是异步的,回调函数应该在另外一个线程调用了 uv_async_send 后立即被调用, 或者在稍后的某个时刻被调用. libuv 也有可能多次调用 uv_async_send 而只调用了一次回调函数. libuv 可以保证: 线程在调用了 uv_async_send 之后回调函数可至少被调用一次. 如果你没有未调用的 uv_async_send, 那么回调函数也不会被调用. 如果你调用了两次(以上)的 uv_async_send, 而 libuv 暂时还没有机会运行回调函数, 则 libuv 可能 会在多次调用 uv_async_send只调用一次 回调函数, 你的回调函数绝对不会在一次事件中被调用两次(或多次).

progress/main.c

void fake_download(uv_work_t *req) {
    int size = *((int*) req->data);
    int downloaded = 0;
    double percentage;
    while (downloaded < size) {
        percentage = downloaded*100.0/size;
        async.data = (void*) &percentage;
        uv_async_send(&async);

        sleep(1);
        downloaded += (200+random())%1000; // can only download max 1000bytes/sec,
                                           // but at least a 200;
    }
}

在下载函数中我们修改下载进度指示器, 并将消息写入 uv_async_send 发送队列, 记住: uv_async_send 也是非阻塞的, 它会立即返回.

progress/main.c

void print_progress(uv_async_t *handle, int status /*UNUSED*/) {
    double percentage = *((double*) handle->data);
    fprintf(stderr, "Downloaded %.2f%%\n", percentage);
}

回调函数从监视器中提取数据, 这也是 libuv 的标准模式.

最后应记得清除监视器.

progress/main.c

void after(uv_work_t *req, int status) {
    fprintf(stderr, "Download complete\n");
    uv_close((uv_handle_t*) &async, NULL);
}

上面的例子滥用了 data 参数, bnoordhuis 指出使用 data 参数并不是线程安全的. uv_async_send() 实际上只会唤醒事件循环. 所以应该使用互斥量或者读写锁来保证对共享变量访问的顺序是正确的.

Warning

互斥量和读写锁 不能 在信号处理函数中正常工作, 但是 uv_async_send 却可以.

uv_async_send 的应用场景之一是不同功能的程序库之间需要线程级别的交互. 例如, node.js 的 v8 引擎实例, 上下文以及在 v8 示例启动时绑定的对象之间需要进行交互. 从另外一个线程直接访问 v8 执行引擎中的数据结构可能会导致程序不确定的行为. 考虑到 node.js 会绑定第三方库, 他们可能会如下工作:

  1. 在 node 中, 创建第三方库的对象实例时会设置一个 JavaScript 回调函数用于获取更多信息:
    var lib = require('lib');
    lib.on_progress(function() {
        console.log("Progress");
    });
    
    lib.do();
    
    // do other stuff
  2. lib.do 本来应该是非阻塞的, 但是第三方库却是阻塞的, 所以应该使用 uv_queue_work.
  3. 在单独线程中完成的工作需要调用 progress 回调函数. 但是不能通过 JavaScript 直接访问 v8 引擎, 以使用 uv_async_send 与 v8 进行交互.
  4. 在主线程(v8 线程)设置的异步回调函数就可以通过 JavaScript 回调函数和 v8 引擎进行通行.

[1] https://github.com/joyent/libuv/blob/master/include/uv.h#L1853

相关文章推荐

libuv多线程处理的简单示例

简介 libuv提供了多线程处理的封装,使用起来也非常简单,一个handle,即uv_thread_t,在linux环境下,就是pthread_t,也就是unsigned long类型。相关的三个函数...

libuv的线程池,即工作队列

1. 在使用libuv的时候,发现使用其提供的 uv_queue_work 的确可为用户的某一任务放在单独的线程中执行。但是只能同时执行4个。 2. 介绍一下libuv的工作队列,http://www...

libuv之线程池的坑,注意避免

libuv的uv_queue_work 使用,不能在fork的子进程中使用,原因未调查清楚,记录一下! 望有清楚的提点一下,谢谢...

libuv之async使用

libuv中async的使用比较难理解一些,我们来一起学习下 简介 vu_async_t是我们要用的handle,这个handle用来在线程间通信的。我们看一下官方的解释 /* * uv_async...

libuv 线程池的调度

原文:http://docs.libuv.org/en/latest/threadpool.html libuv提供threadpool可以用来在循环线程中运行用户代码和得到通知。这个内部线程池是用...

libuv学习笔记(24)

libuv学习笔记(24) 线程相关数据结构与函数(2)

libuv中文API手册(1)

官方文档URL官方文档链接点我点我点我1. 概述 libuv是一个支持多平台的异步IO库。它主要是为了node.js而开发的,但是也可以用于Luvit, Julia, pyuv及其他软件。 ...
  • gx_1983
  • gx_1983
  • 2016年04月02日 21:38
  • 1179

libuv 使用中的一些个人认识

--------------我会跟进纠正或补充,有错误的请各位指教!!! 1、如果用libuv,那就尽量都用它,循环,文件读写,线程等; 2、只有uv_async_t是线程安全的,配套uv_as...

libUV写TCPServer

libUV是一个网络接口,在Linux下集成了libev,在Windows下按linux风格封装了一下IOCP,不过使用起来方便多了。     用来写TCP Server,极大地简化了代码,比直接用...
  • dj0379
  • dj0379
  • 2013年01月18日 07:40
  • 4502

基于libuv封装的快速开发框架

最近在研究libuv的代码,觉得如果使用libuv作为开发库的话,缺少一个快速大规模开发的框架,所以自己倒腾了一个----simple_uv。 simple_uv是基于libuv封装跨平台库...
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:Libuv中文文档之线程
举报原因:
原因补充:

(最多只允许输入30个字)