nginx源码分析

nginx源码分析nginx源码分析（1）-缘起nginx是一个开源的高性能web服务器系统，事件驱动的请求处理方式和极其苛刻的资源使用方式，使得nginx成为名副其实的高性能服务器。nginx的源码质量也相当高，作者“家酿”了许多代码，自造了不少轮子，诸如内存池、缓冲区、字符串、链表、红黑树等经典数据结构，事件驱动模型，http解析，各种子处理模块，甚至是自动编译脚本都是作者根据自己的理解写出来的，也正因为这样，才使得nginx比其他的web服务器更加高效。nginx的代码相当精巧和紧凑，虽然全部代码仅有10万行，但功能毫不逊色于几十万行的apache。不过各个部分之间耦合的比较厉害，很难把其中某个部分的实现拆出来使用。对于这样一个中大型的复杂系统源码进行分析，是有一定的难度的，刚开始也很难找到下手的入口，所以做这样的事情就必须首先明确目标和计划。最初决定做这件事情是为了给自己一些挑战，让生活更有意思。但看了几天之后，觉得这件事情不该这么简单看待，这里面有太多吸引人的东西了，值得有计划的系统学习和分析。首先这个系统中几乎涵盖了实现高性能服务器的各种必杀技，epoll、kqueue、master－workers、pool、buffer……，也涵盖了很多web服务开发方面的技术，ssi、ssl、proxy、gzip、regex、loadbalancing、reconfiguration、hotcodeswapping……，还有一些常用的精巧的数据结构实现，所有的东西很主流；其次是一流的代码组织结构和干净简洁的代码风格，尤其是整个系统的命名恰到好处，可读性相当高，很kiss，这种风格值得学习和模仿；第三是通过阅读源码可以感受到作者严谨的作风和卓越的能力，可以给自己增加动力，树立榜样的力量。另一方面，要达到这些目标难度很高，必须要制定详细的计划和采取一定有效的方法。对于这么大的一个系统，想一口气知晓全部的细节是不可能的，并且nginx各个部分的实现之间关系紧密，不可能做到窥一斑而知全身，合适的做法似乎应该是从main开始，先了解nginx的启动过程的顺序，然后进行问题分解，再逐个重点分析每一个重要的部分。对每个理解的关键部分进行详细的记录和整理也是很重要的，这也是这个源码分析日志系列所要完成的任务。为了更深刻的理解代码实现的关键，修改代码和写一些测试用例是不可避免的，这就需要搭建一个方便调试的环境，这也比较容易，因为使用的linux系统本身就是一个天然的开发调试环境。个人的能力是有限的，幸运的是互联网上还有一帮同好也在孜孜不倦的做着同样的事情，与他们的交流会帮助少走一些弯路，也会互相促进，更深入和准确的理解源码的本实。开始一次愉快的旅行，go！nginx源码分析（2）-概览源码分析是一个逐步取精的过程，最开始是一个大概了解的过程，各种认识不会太深刻，但是把这些真实的感受也记录下来，觉得挺有意思的，可能有些认识是片面或者是不正确的，但可以通过后面更深入细致的分析过程，不断的纠正错误和深化理解。源码分析是一个过程，经验是逐步累积起来的，希望文字可以把这种累积的感觉也准确记录下来。现在就看看对nginx源码的第一印象吧。源码包解压之后，根目录下有几个子目录和几个文件，最重要的子目录是auto和src，最重要的文件是configure脚本，不同于绝大多数的开源代码，nginx的configure脚本是作者手工编写的，没有使用autoconf之类的工具去自动生成，configure脚本会引用auto目录下面的脚本文件来干活。根据不同的用途，auto目录下面的脚本各司其职，有检查编译器版本的，有检查操作系统版本的，有检查标准库版本的，有检查模块依赖情况的，有关于安装的，有关于初始化的，有关于多线程检查的等等。configure作为一个总驱动，调用这些脚本去生成版本信息头文件、默认被包含的模块的声明代码和Makefile文件，版本信息头文件(ngx_auto_config.h,ngx_auto_headers.h)和默认被包含的模块的声明代码(ngx_modules.c)被放置在新创建的objs目录下。要注意的是，这几个生成的文件和src下面的源代码一样重要，对于理解源码是不可忽略的重要部分。src是源码存放的目录，configure创建的objs/src目录是用来存放生成的.o文件的，注意区分一下。src按照功能特性划分为几个部分，对应着是几个不同的子目录。src/core存放着主干部分、基础数据结构和基础设施的源码，main函数在src/core/nginx.c中，这是分析源码的一个很好的起点。src/event存放着事件驱动模型和相关模块的源码。src/http存放着httpserver和相关模块的源码。src/mail存放着邮件代理和相关模块的源码。src/misc存放着C＋＋兼容性测试和googleperftools模块的源码。src/os存放着依赖于操作系统实现的源码，nginx启动过程中最重要的master和workers创建代码就在这个目录下，多少让人觉得有点意外。nginx的实现中有非常多的结构体，一般命名为ngx_XXX_t，这些结构体分散在许多头文件中，而在src/core/ngx_core.h中把几乎所有的头文件都集合起来，所有的实现文件都会包含这个ngx_core.h头文件，说nginx的各部分源码耦合厉害就是这个原因，但实际上nginx各个部分之间逻辑上是划分的很清晰的，整体上是一种松散的结构。nginx实现了一些精巧的基础数据结构，例如ngx_string_t,ngx_list_t,ngx_array_t,ngx_pool_t,ngx_buf_t,ngx_queue_t,ngx_rbtree_t,ngx_radix_tree_t等等，还有一些重要的基础设施，比如log,configurefile,time等等，这些数据结构和基础设施频繁的被使用在许多地方，这会让人感觉nginx逻辑上的联系比较紧密，但熟悉了这些基础数据结构的实现代码就会感觉到这些数据结构都是清晰分明的，并没有真正的耦合在一起，只是有些多而已，不过nginx中“家酿”的代码也正是它的一个很明显的亮点。nginx是高度模块化的，可以根据自己的需要定制模块，也可以自己根据一定的标准开发需要的模块，已经定制的模块会在objs/ngx_modules.c中声明，这个文件是由configure生成的。nginx启动过程中，很重要的一步就是加载和初始化模块，这是在ngx_init_cycle中完成的，ngx_init_cycle会调用模块的hook接口（init_module）对模块初始化，ngx_init_cycle还会调用ngx_open_listening_sockets初始化socket，如果是多进程方式启动，就会调用ngx_master_process_cycle完成最后的启动动作，ngx_master_process_cycle调用ngx_start_worker_processes生成多个工作子进程，ngx_start_worker_processes调用ngx_worker_process_cycle创建工作内容，如果进程有多个子线程，这里也会初始化线程和创建线程工作内容，初始化完成之后，ngx_worker_process_cycle会进入处理循环，调用ngx_process_events_and_timers，该函数调用ngx_process_events监听事件，并把事件投递到事件队列ngx_posted_events中，最终会在ngx_event_thread_process_posted中处理事件。事件机制是nginx中很关键的一个部分，linux下使用了epool，freebsd下使用了kqueue管理事件。最后附上Joshua友情提供的源码大图一张，感谢：）nginx源码分析（3）-自动脚本nginx的自动脚本指的是configure脚本程序和auto子目录下面的脚本程序。自动脚本完成两件事情，其一是检查环境，其二是生成文件。生成的文件有两类，一类是编译代码需要的Makefile文件，一类是根据环境检查结果生成的c代码。生成的Makefile很干净，也很容易阅读。生成的c代码有三个文件，ngx_auto_config.h是根据环境检查的结果声明的一些宏定义，这个头文件被include进ngx_core.h中，所以会被所有的源码引用到，这确保了源码是可移植的；ngx_auto_headers.h中也是一些宏定义，不过是关于系统头文件存在性的声明；ngx_modules.c是默认被包含进系统中的模块的声明，如果想去掉一些模块，只要修改这个文件即可。configure是自动脚本的总驱动，它通过组合auto目录下不同功能的脚本程序完成环境检查和生成文件的任务。环境检查主要是三个部分：编译器版本及支持特性、操作系统版本及支持特性、第三方库支持，检查的脚本程序分别存放在auto/cc、auto/os、auto/lib三个子目录中。检查的方法很有趣，通过自动编译用于检查某个特性的代码片段，根据编译器的输出情况判定是否支持该种特性。根据检查的情况，如果环境足以支持运行一个简单版本的nginx，就会生成Makefile和c代码，这些文件会存放在新创建的objs目录下。当然，也可能会失败，假如系统不支持pcre和ssh，如果没有屏蔽掉相关的模块，自动脚本就会失败。auto目录下的脚本职能划分非常清晰，有检查环境的，有检查模块的，有提供帮助信息的(./configure–help)，有处理脚本参数的，也有一些脚本纯粹是为了模块化自动脚本而设计出来的，比如feature脚本是用于检查单一特性的，其他的环境检查脚本都会调用这个脚本去检查某个特性。还有一些脚本是用来输出信息到生成文件的，比如have、nohave、make、install等。之所以要在源码分析中专门谈及自动脚本，是因为nginx的自动脚本不是用autoconf之类的工具生成的，而是作者手工编写的，并且包含一定的设计成分，对于需要编写自动脚本的人来说，有很高的参考价值。这里也仅仅是粗略的介绍一下，需要详细了解最好是读一下这些脚本，这些脚本并没有使用多少生僻的语法，可读性是不错的。btw，后面开始进入真正的源码分析阶段，nginx的源码中有非常多的结构体，这些结构体之间引用也很频繁，很难用文字表述清楚之间的关系，觉得用图表是最好的方式，因此需要掌握一种高效灵活的作图方法，我选择的是graphviz，这是at&t贡献的跨平台的图形生成工具，通过写一种称为“thedotlanguage”的脚本语言，然后用dot命令就可以直接生成指定格式的图，很方便。nginx源码分析（4）-方法（1）看了几天的源码，进度很慢，过于关注代码实现的细节了，反而很难看清整体结构。于是问诸google寻找方法。大体上分析源代码都要经历三遍过程，第一遍是浏览，通过阅读源码的文档和注释，阅读接口，先弄清楚每个模块是干什么的而不关心它是怎么做的，画出架构草图；第二遍是精读，根据架构草图把系统分为小部分，每个部分从源码实现自底向上的阅读，更深入细致的理解每个模块的实现方式以及与模块外部的接口方式等，弄明白模块是怎么做的，为什么这样做，有没有更好的方式，自己会如何实现等等问题；第三遍是总结回顾，完善架构图，把架构图中那些模糊的或者空着的模块重新补充完善，把一些可复用的实现放入自己的代码库中。现在是浏览阶段，并不适合过早涉及代码的实现细节，要借助nginx的文档理解其整体架构和模块划分。经过几年的发展，nginx现在的文档已经是很丰富了，nginx的英文wiki上包含了各个模块的详细文档，faq也涵盖了很丰富的论题，利用这些文档足以建立nginx的架构草图。所以浏览阶段主要的工作就是阅读文档和画架构草图了。对于源码分析，工具是相当关键的。这几天阅读源码的过程，熟悉了三个杀手级的工具：scrapbook离线文件管理小程序、