ST源码分析-st_thread_join

SRS 的社群来了，想加入微信社群的朋友请购买《SRS原理》电子书，里有更高级的内容与答疑服务。

---

本文主要讲解， st_thread_join() 函数的使用 ，参考文档《st_thread_join》。下面用一个小的示例代码，演示一下 st_thread_join() 函数 的使用。

#include <stdio.h>
#include <memory.h>
#include "st.h"
#include "../common.h"
#include <stdlib.h>
​
int do_something(void *arg) {
    st_utime_t time_now = st_utime();
    printf("do_something %lld \r\n", time_now);
    return 8;
}
​
int main(int argc, char *argv[]) {
    if (st_init() < 0) {
        perror("st_init");
        exit(1);
    }
​
    st_utime_t time_now = st_utime();
    printf("start %lld\r\n", time_now);
​
    _st_thread_t *pid = st_thread_create((void *) do_something, NULL, 1, 0);
    if (pid == NULL) {
        perror("st_thread_create");
        exit(1);
    }
​
    void *return_num;
    st_thread_join(pid, &return_num);
    printf("get thread num %d\r\n", return_num);
​
    st_thread_exit(NULL);
​
    /* NOTREACHED */
    return 1;
}

运行结果如下图：

从上图可以看到，始祖协程 等待子协程运行结束，然后获取到子协程的退出码。

---

下面就来讲讲，这里面的原理。如下，st_thread_create() 的时候，要指定这个协程是否 可以 被别的协程 join。

从上图可以看到，创建协程的时候，同时创建了一个条件变量，不熟悉条件变量的请看《ST源码分析-协程通信》。

接下来看下 st_thread_join() 函数的实现。实际上到这里，结果已经很明显了，肯定是 st_thread_join()会等待那个条件变量，然后子协程退出就会调 st_cond_signal() 通知 始祖协程。

下面就看看看是否是上面猜测的那样。

从上图看来，果然如此， st_thread_join() 阻塞在 st_cond_timedwait() 里面了，下面就来看看什么时候会被激活。如下图，子协程执行到 st_thread_exit() 的时候就会激活 始祖协程的 st_thread_join()。

上图有几个重点：

1，st_thread_exit() 会把子协程变成 僵尸协程，然后 st_cond_signal() 唤醒 始祖协程。

2，始祖协程 醒来之后，就会把 子协程从 僵尸队列 剔除。

这里有一个情况要注意，如果 始祖协程，不执行 st_thread_join()，那子协程就会一直在僵尸协程队列里面，占用着内存。打印 ZOMBIEQ 就能查看当前系统有多少个僵尸协程。通常如果代码没写错，没有忘记写 st_thread_join()，是不会出现僵尸协程一直在队列的。

---

相关阅读：

1. 《st_thread_join》。

---

由于笔者的水平有限， 加之编写的同时还要参与开发工作，文中难免会出现一些错误或者不准确的地方，恳请读者批评指正。