十九、Nginx 过滤模块的分析

过滤模块的分析

相关结构体

ngx_chain_t 结构非常简单，是一个单向链表：

typedef struct ngx_chain_s ngx_chain_t;
struct ngx_chain_s {
    ngx_buf_t    *buf;
    ngx_chain_t  *next;
};

在过滤模块中，所有输出的内容都是通过一条单向链表所组成。这种单向链表的设计，正好应和了 Nginx 流式的输出模式。每次 Nginx 都是读到一部分的内容，就放到链表，然后输出出去。这种设计的好处是简单，非阻塞，但是相应的问题就是跨链表的内容操作非常麻烦，如果需要跨链表，很多时候都只能缓存链表的内容。

单链表负载的就是 ngx_buf_t，这个结构体使用非常广泛，先让我们看下该结构体的代码：

struct ngx_buf_s {
    u_char          *pos;       /* 当前buffer真实内容的起始位置 */
    u_char          *last;      /* 当前buffer真实内容的结束位置 */
    off_t            file_pos;  /* 在文件中真实内容的起始位置   */
    off_t            file_last; /* 在文件中真实内容的结束位置   */
    u_char          *start;    /* buffer内存的开始分配的位置 */
    u_char          *end;      /* buffer内存的结束分配的位置 */
    ngx_buf_tag_t    tag;      /* buffer属于哪个模块的标志 */
    ngx_file_t      *file;     /* buffer所引用的文件 */
    /* 用来引用替换过后的buffer，以便当所有buffer输出以后，
     * 这个影子buffer可以被释放。
     */
    ngx_buf_t       *shadow; 
    /* the buf's content could be changed */
    unsigned         temporary:1;
    /*
     * the buf's content is in a memory cache or in a read only memory
     * and must not be changed
     */
    unsigned         memory:1;
    /* the buf's content is mmap()ed and must not be changed */
    unsigned         mmap:1;
    unsigned         recycled:1; /* 内存可以被输出并回收 */
    unsigned         in_file:1;  /* buffer的内容在文件中 */
    /* 马上全部输出buffer的内容, gzip模块里面用得比较多 */
    unsigned         flush:1;
    /* 基本上是一段输出链的最后一个buffer带的标志，标示可以输出，
     * 有些零长度的buffer也可以置该标志
     */
    unsigned         sync:1;
    /* 所有请求里面最后一块buffer，包含子请求 */
    unsigned         last_buf:1;
    /* 当前请求输出链的最后一块buffer         */
    unsigned         last_in_chain:1;
    /* shadow链里面的最后buffer，可以释放buffer了 */
    unsigned         last_shadow:1;
    /* 是否是暂存文件 */
    unsigned         temp_file:1;
    /* 统计用，表示使用次数 */
    /* STUB */ int   num;
};