导语:通过网上阅读查阅,尽量把nginx源码这一部分整理完善,让以后想要学习nginx的同学也可以快速上手。这一节涉及src/core/ngx_buf.h|c的数据结构,其次,看一些大牛文章时候 get 了一个好的画图工具- graphviz 和一个拍照app-扫描全能王,可以帮助理清源码的思路。
一、结构体、相关宏定义、函数声明梳理
分析采用nginx-1.6.2源码。在src/core/ngx_buf.h|c中的ngx_buf_t 结构体还是很重要,看源码的过程中遇到几次,确实有必要好好理理。ngx_buf_t 包含于ngx_chain_t 结构体中。
// 这个就是链表的形式,还是把ngx_buf_t串起来,
// 主要作用就是接受nginx服务器的http请求包头、包体、以及响应客户端的应答包头、包体
// 都会放在chain链表缓冲区
struct ngx_chain_s {
ngx_buf_t *buf;
ngx_chain_t *next;
};
接着是ngx_buf_t结构体,ngx_buf_t 就是ngx_chain_t链表每个节点的实际数据,缓冲区ngx_buf_t是nginx处理大数据的关键数据结构,它既可以应用于内存也可以用于磁盘数据注释。里面的参数设置,考虑的情况真多,而且最后标志位都只占1位,可以说对内存利用锱铢必较,值得借鉴学习。
typedef void * ngx_buf_tag_t;
typedef struct ngx_buf_s ngx_buf_t;
// ngx_buf_t 就是ngx_chain_t链表每个节点的实际数据,
// 缓冲区ngx_buf_t是nginx处理大数据的关键数据结构,它既可以应用于内存也可以用于磁盘数据
struct ngx_buf_s {
// pos指向的是这段数据在内存中的开始位置
u_char *pos;
// last指向的是这段数据在内存中的结束位置
u_char *last;
// file_pos指向这段数据的开始位置在文件中的偏移量
off_t file_pos;
// file_last指向这段数据的结束位置在文件中的偏移量
off_t file_last;
// 如果ngx_buf_t 缓冲区用于内存,那么start指向这段内存的起始地址
u_char *start; /* start of buffer */
// 如果ngx_buf_t 缓冲区用于内存,那么end指向这段内存的结束地址
u_char *end; /* end of buffer */
// 实际上就是一个void *类型的指针。使用者可以关联任何对象上去
// 由哪个模块使用就执行哪个模块的ngx_module_t结构
ngx_buf_tag_t tag;
// 当buf所包含的内容在文件中时,file字段指向对应的文件对象上去
ngx_file_t *file;
// 当这个buf完整copy了另外一个buf的所有字段的时候,那么这个两个buf指向的实际上是同一块内存,或者是
// 同一个文件的同一部分,此时这两个buf的shadow字段指向对方的。释放的时候特别注意。
ngx_buf_t *shadow;
// 为1表示该buf所包含的内容是一个用户创建的内存块中,并且可以被在filter处理的过程中进行变更,
// 不会造成问题
unsigned temporary:1;
/*the buf's content is in a memory cache or in a read only memory
* and must not be changed
*