Weakyon Blog

由于twemproxy的多进程改造计划，所以对教科书一般的nginx的管理方式做了分析

nginx的-s指令可以对进程执行多个命令。

这些命令由主进程接受信号然后在循环中对状态进行判断，然后通过unix socket或者信号的方式传达给子进程。

从代码里面可以看到如下状态。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

for()
{
    if (delay) {}
    sigsuspend();
    ngx_time_update();
    if (ngx_reap) {} //需要重启工作进程
    if (!live && (ngx_terminate || ngx_quit)) {} //工作进程都结束，自己也设定了结束，那么退出
    if (ngx_terminate) {} //强制退出状态
    if (ngx_quit) {} //优雅退出状态
    if (ngx_reconfigure) {} //配置热加载
    if (ngx_restart) {} //重启(配置不变)
    if (ngx_reopen) {} //重新打开日志
    if (ngx_change_binary) {} //二进制文件改变
    if (ngx_noaccept) {} //不再接受新连接
}

twemproxy的多进程改造计划中参考了nginx的设计，然而nginx有一段让我看不太明白。

这篇文章总结的很好

sigsuspend sigprocmask函数的使用方法

sigsuspend将新的信号集阻塞操作和pause操作组合在一起成为原子操作

做了以下的操作

nginx的文件缓存分为两种，内存缓存和硬盘缓存。

内存缓存指文件句柄等信息进行缓存，减少使用open等的系统调用。

硬盘缓存指文件被缓存到硬盘上，一般是因为当作反向代理用才会有这种需求。

内存缓存是全模块都可以调用的，因为封装在core/ngx_open_file_cache.c中。

而硬盘缓存只有http模块可以调用，因为封装在http/ngx_http_file_cache.c中，最常见的就是upstream模块的cache了。

C的内存管理难已经成为了共识。记得我那时候写ydfs，第一次接触全异步编程这种模式，没有考虑到内存的统一管理，导致溢出泄漏问题层出不穷。最终搞定没BUG了，那代码的阅读质量也是让人不敢恭维。那么来看看nginx是怎么做的吧。

nginx的内存池分为池(pool)和块(block)两个概念

这是nginx使用到的内存结构

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

typedef struct ngx_pool_large_s  ngx_pool_large_t;

struct ngx_pool_large_s {
    ngx_pool_large_t     *next;
    void                 *alloc;
};

//块
typedef struct {
    u_char               *last;//块目前已分配内存的末尾
    u_char               *end;//块总共可分配内存的末尾
    ngx_pool_t           *next;//下个块的指针（注意这里虽然是池类型，\
	//但是实际上的使用中池的一些数据结构并没有全部用到，基本上是当块来用的）
    ngx_uint_t            failed;//在该块上尝试分配内存的错误次数
} ngx_pool_data_t;

//池
struct ngx_pool_s {
    ngx_pool_data_t       d;//内存池的第一个块
    size_t                max;//池中块支持的最大大小，大于该大小将分配在large结构中
    ngx_pool_t           *current;//指向当前的块
    ngx_chain_t          *chain;//
    ngx_pool_large_t     *large;//大内存链表
    ngx_pool_cleanup_t   *cleanup;//清理数据的回调
    ngx_log_t            *log;//日志指针
};


typedef struct {
    ngx_fd_t              fd; 
    u_char               *name;
    ngx_log_t            *log;
} ngx_pool_cleanup_file_t;

池中以链表的形式保存许多块以及large链表。这是从数据结构中能大致看出的东西。

Why

nginx把整个时间的系统调用都封装了一遍。

其中有两个原因

1 不谈其他平台，至少在linux上，很多时间相关的系统调用不是async-signal-safe或thread-safe的。

例如local_time_r虽然是thread-safe的但不是async-signal-safe的，当然local_time两个都不是。

现象一：

昨天DBA反应线上存在某个redis slave 状态为down,反复重启无效

观察slave日志：

发现出现多次全同步，并且报出connect lost同步失败。

nginx源码本来应该放在nginx源码学习这一块。但是考虑到多进程下accept的处理可以单独拿出来讨论。所以还是单独一篇博客会比较好。

## nginx的结构

简单提一下nginx的启动流程

核心文件当然是core/nginx.c，main函数就在这里。

而在main函数中，最重要的我认为是nginx_init_cycle和ngx_master_process_cycle这两个函数。前者负责解析配置文件，按配置文件进行配置初始化。后者将进入总事件循环中。

解析配置大致是按照nginx_init_cycle->ngx_conf_parse->ngx_conf_handler这样的顺序进行的，这里很重要是因为模块的配置命令函数都由这里来运行，并且设定了一系列回调来执行响应事件后的函数。nginx的模块化就是依赖这个。

而进入总事件循环大致是按照ngx_master_process_cycle->ngx_start_worker_processes->(fork)->ngx_worker_process_cycle->ngx_process_events_and_time->ngx_process_events(epoll时实际上就是ngx_epoll_process_events)->epoll_wait的顺序进行的。

从调用顺序就能看得出来nginx是master-worker这样的设计结构。

master只是负责启动，监控worker。由worker来进行事件响应式的事件循环。

ngx_process_events_and_timers函数基本流程是这样的：先判断accept锁是否闲置，闲置就占有该锁，然后运行ngx_process_events时，把epoll_wait收集到的活跃描述字组成事件分别放入ngx_posted_accept_events(假如占有了accept锁的话)和ngx_posted_events队列中。而后运行ngx_event_process_posted来调用这两个队列的回调。运行完ngx_posted_accept_events队列后就会释放accept锁，防止accept锁长时间被占用。这是为了提高高并发能力的。

由于将触发事件放入队列延后处理，这里就不得不提到nginx关于stale event的处理了。

### stale event

stale event在nginx中存在有两种，一种是由于某连接同时存在read事件和write事件。因此会按顺序先运行read事件回调后执行write回调，如果read回调因为出错而把描述符关闭，那么此时执行write事件回调就会出错。因此需要对stale event做处理。这种处理比较常见，在大多数的epoll构成的事件库中都能看到。

另外一种是主要存在于event cache中前一个对象可能使得后一个对象失效的场景。例如队列中存在事件A,B,C。如果C的fd是由于A的upstream产生的，那么当运行A回调出错时关闭C的连接后。如果B upstream执行了ngx_get_connection从连接池拿取连接时，很有可能就是使用了之前释放的那个连接。如果执行C的事件时，只是通过判断连接的fd是否被设置为-1。那么显然是无效的。这时就需要一种手段来解决stale event了。

epoll给的建议是当释放一个描述符时，使用一个数据结构来存储这些描述符，这样就不会乱了。在这里也是适用的，相对的改成存储释放过的连接，或者把队列里的这个连接删除就行了。但是这样显然是低效的。涉及到操作最快也是O(nlgn)时间复杂度的。

redis使用了一个mask标记位来处理。

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 static int aeApiPoll(aeEventLoop *eventLoop, struct timeval *tvp) { aeApiState *state = eventLoop->apidata; int retval, numevents = 0; retval = epoll_wait(state->epfd,state->events,AE_SETSIZE, tvp ? (tvp->tv_sec*1000 + tvp->tv_usec/1000) : -1); if (retval > 0) { int j; numevents = retval; for (j = 0; j < numevents; j++) { int mask = 0; struct epoll_event *e = state->events+j; if (e->events & EPOLLIN) mask |= AE_READABLE; if (e->events & EPOLLOUT) mask |= AE_WRITABLE; eventLoop->fired[j].fd = e->data.fd; eventLoop->fired[j].mask = mask; } } return numevents; } ``` 可以看到eventLoop->fired数组记录了被epoll_wait触发的一轮中所有的mask值 ```c aeFileEvent *fe = &eventLoop->events[eventLoop->fired[j].fd]; int mask = eventLoop->fired[j].mask; int rfired = 0; /* note the fe->mask & mask & ... code: maybe an already processed * event removed an element that fired and we still didn't * processed, so we check if the event is still valid. */ if (fe->mask & mask & AE_READABLE) { rfired = 1; fe->rfileProc(eventLoop,fd,fe->clientData,mask); } if (fe->mask & mask & AE_WRITABLE) { if (!rfired || fe->wfileProc != fe->rfileProc) fe->wfileProc(eventLoop,fd,fe->clientData,mask); }

此时将对fe->mask & mask & AE_READABLE以及fe->mask & mask & AE_WRITABLE判断，假如不同说明缓存的event已经过期了

另外当同时存在读事件和写事件时，通过rfired值，只会运行读事件的回调，防止读事件释放连接而使得写事件过期

可以看到，这种方式很清晰。

然而，nginx使用了非常精巧的一种办法去处理。它利用了内存对齐的一字节冗余信息来判断，节省空间。

在ngx_get_connection函数中，连接的读事件和写事件都对一个 instance变量取反。

而在ngx_epoll_add_event和ngx_epoll_add_connection函数中

c ee.data.ptr = (void *) ((uintptr_t) c | c->read->instance);

由于连接的地址变量第一位始终为0，因此可以用来存储instance变量的值。

而后在ngx_epoll_process_events中，将会进行

c c->fd == -1 || rev->instance != instance

这样的判断，如果一个连接的intance被两次取反以后，当然就会和一开始存储在epoll结构中的指针中的instance不同了。也就能判断出stale event了。

然而这里依然有两个点没有说明，举实例来说明吧。

例如队列中存在事件A,B,C,D,E。A事件会关闭E，B,C,D都是接受连接事件，但是B,C再刚获取到连接时都失败了，此时instance被两次取反，然后E接受连接成功了，fd不为-1，这时stale event就无法分辨了。但是这种情况不会出现，因为accept事件和其他事件是不同的队列，accept事件在一轮epoll后会优先执行。也就是说实际的执行顺序是B,C,D,A,E。因此这一点不需要担心。

另外一点是类似的，唯一的区别是此时B,C,D并非被动接受连接，而是主动发起连接，也就是使用upstream模块。我翻阅了代码的流程，这种情况理论上的确可能是会出现的。但是实际上不会出现。因为正常来说异步的connect调用会直接返回NGX_AGAIN。因此一次upstream后进行connect操作后立刻就会返回，在同一轮的epoll处理中没有机会去释放连接。

当然，第二点这种情况只是我个人的猜测，查阅了资料，并没有人对这种理论可能出现stale event做讨论。如果有人有更好的解读，那么请为我解惑。

nginx关于大并发的tricks还是很多的，不过我还没全看完，后面会继续分析。不过我觉得这个应该是比较有意思的了。

## 多进程下accept的处理方式

下面就聊聊我所知道的方式吧。这些方式都是主从结构的。

这些方法要解决的核心问题是如何在多进程/线程的情况下hold住更多的连接，这些都是半异步半同步模型变种的一种实际应用方式。

各个模型区别其实不是很大。当然我所读的开源项目较少，以后会继续完善这篇文章。

### nginx方式

master只是管理worker

每个worker都可以accept，都有独立的事件循环，通过负载均衡锁（实质是共享内存）来实现各个进程的均衡。

### ONESHOT方式

master进行epoll_wait且为唯一的事件循环，并且对listen的fd触发后进行accept。在add事件时加入EPOLLONESHOT标记，使得该描述符虽然加入epoll，但是在标记位没有被重置时只会触发一次。而后通过管道分发到worker线程

worker线程实质是个线程池，在回调执行完毕后重置EPOLLONESHOT标记，以触发下一次事件。

EPOLLONESHOT的使用，在我看来是由于事件循环和回调是异步处理而需要使用的，由于事件循环和回调异步，在不采取任何同步手段下，可能存在多个回调并行执行的可能，假如这些回调都是有状态的，例如下载时并未记录文件偏移量，而是靠回调的先后顺序来分别append在文件末尾。那么这样的过程就会出错。EPOLLONESHOT是epoll的同步手段。

### 我的方式

这种方式在我的分布式文件系统项目ydfs可以看到https://github.com/tedcy/ydfs

master是一个accept的死循环，同时管理worker线程。当描述符被accept到时，使用负载均衡算法选择管道数组中的一个压入accept到的描述符，这个管道的另一端是某个worker线程。

worker线程的epoll_wait感知到管道的活跃，将描述符读出，加入该线程的事件循环，然后就欢快的run handle了。

小结

这三种方式各有优劣。

nginx方式的优点是多个进程进行accept，系统的最大吞吐量是和核数成正比（性能好百万也不在话下），缺点是当所有进程恰好handle耗时较长时，accept可能得不到处理。另外就是实现上需要使用一些手段，比如accept锁,事件缓存等等，而使用事件缓存就得考虑到stale event了。

ONESHOT方式是我在书上看到的理论方式，似乎没看到开源实现。（这个优点缺点不好说，汗）

fastdfs有nginx模块，在上面做一些缩略图缓存的功能。我当时总是觉得lua-nginx这种方式太重了，因此就入了nginx模块开发这个坑。

nginx模块开发的资料网上还是比较多的，《nginx模块开发与架构解析》这一本就不错，推荐入手实体书。我看PDF看的有点烦躁，因为很多东西要来回对照着看。

很多基础东西书里写的很细，就不谈了，就说说自己开发时候的过程和遇到的坑吧。

nginx模块是存在http module和http filter module的。

http module依次处理，最后输出内容，输出的内容再由http filter module依次过滤内容输出。

原文

原文

直接看原文有些糊涂，所以翻译一下看，也为了和朋友分享一下。能力有限，所以翻译的会很蠢，求指点0.0

看完译文以后可以按照顺序浏览以下几篇博文。感觉讲的很透彻。

LSM树存储模型

nginx真是博大精深，最近写fastdfs的动态缩略图模块，刚好能有时间研究下，真是满心欢喜。

学习主要是靠两本书，其他的稍微搜搜也就能解惑了。

《Nginx模块开发与架构解析》这个我看的电子PDF

《Nginx开发从入门到精通》这个有网页版本的，挺好的：

Nginx开发从入门到精通