Nginx学习之路（二）NginX的main函数基本流程

之前介绍了nginx的由来和基本操作，现在开始深入学习nginx，本人觉得学习这种工程类的优秀作品一定要从源码学习才能学得深入，而学习c语言编写的代码个人感觉尽量从main函数入手，因为main()中一般会将整个软件的框架的大致思路表现出来，了解了整体框架然后再针对某一块深入学习效率可能就会更高一些，今天就来聊一聊nginx中的main()，也就是说一下main函数到底做了哪些工作。

再分享一点我的学习方法，我觉得光看代码是不够的，一定要以调试的方法去一步一步看下每个函数到底大致处理了什么东西，返回了什么东西，对于nginx我是用gdb方式来进行调试的。

这里要提一下用gdb调试nginx的一些关键方法，nginx是reactors in process的模式，会有一个master进程来负责分配，然后worker进程来进行业务处理，这种多进程势必会用到fork()（这里再简单说一下fork()函数，一个进程调用fork（）函数后，系统先给新的进程分配资源，例如存储数据和代码的空间。然后把原来的进程的所有值都复制到新的新进程中，只有少数值与原来的进程的值不同。相当于克隆了一个自己。对于子进程，fork()函数返回0，而在父进程中，fork返回新创建子进程的进程ID），而在gdb默认的调试模式下是附着在父进程上的，而nginx的部分函数会利用子进程来做接下来的业务处理，于是你可能需要根据情况调整gdb的跟踪fork的模式，改变附着模式代码如下：

set follow-fork-mode child   命令设置gdb在fork之后跟踪子进程。

set follow-fork-mode parent  设置跟踪父进程。

基本的操作有了，下面就开始来详细阐述main()做了哪些工作吧。

首先，main()定义了一些数据结构

ngx_buf_t        *b;//缓冲区
ngx_log_t        *log;//日志相关数据结构
ngx_cycle_t      *cycle, init_cycle;//时间循环的基本数据，基于事件驱动的模式基本就以这个实现，关于这个结构体我会在后面详细介绍
ngx_conf_dump_t  *cd;//配置文件dump相关结构体
ngx_core_conf_t  *ccf;//核心配置文件相关结构体

然后读取nginx的操作命令，nginx中的操作命令是以signal的方式来进行处理的

 if (ngx_get_options(argc, argv) != NGX_OK) { //将操作保存到全局变量ngx_test_config，ngx_dump_config，ngx_conf_file，ngx_signal中
        return 1;
    }

然后初始化一些基本参数

     ngx_time_init();//初始化时间

#if (NGX_PCRE)
    ngx_regex_init();
#endif

    ngx_pid = ngx_getpid();//获得当前进程PID
    ngx_parent = ngx_getppid();//获得当前进程的父进程PID，这时暂时没什么用，ngx_parent和ngx_pid都是全局变量

    log = ngx_log_init(ngx_prefix);//初始化日志
    if (log == NULL) {
        return 1;
    }

    /* STUB */
#if (NGX_OPENSSL)
    ngx_ssl_init(log);//初始化ssl证书相关
#endif

    /*
     * init_cycle->log is required for signal handlers and
     * ngx_process_options()
     */
	//下面部分代码作用是初始化init_cycle结构体，以及处理一些基本操作
    ngx_memzero(&init_cycle, sizeof(ngx_cycle_t));
    init_cycle.log = log;
    ngx_cycle = &init_cycle;

    init_cycle.pool = ngx_create_pool(1024, log);//为cycle分配内存池
	if (init_cycle.pool == NULL) {
		return 1;
	}
	//保存参数
	if (ngx_save_argv(&init_cycle, argc, argv) != NGX_OK) {
		return 1;
	}
	//处理之前输入的操作
	if (ngx_process_options(&init_cycle) != NGX_OK) {
		return 1;
	}
	//主要初始化操作系统级的资源限制到一些全局的变量中， 比如ngx_pagesize, ngx_cacheline_size, ngx_max_sockets, ngx_inherited_nonblocking等
    if (ngx_os_init(log) != NGX_OK) {
        return 1;
    }

    /*
     * ngx_crc32_table_init() requires ngx_cacheline_size set in ngx_os_init()
     */
	//其主要功能是初始化一个做循环冗余校验的表，由此可以看出后续的循环冗余校验将采用高效的查表法。
    if (ngx_crc32_table_init() != NGX_OK) {
        return 1;
    }

    /*
     * ngx_slab_sizes_init() requires ngx_pagesize set in ngx_os_init()
     */
	//初始化nginx的slab的内存管理相关参数到全局变量中，关于slab的相关细节会在后面说明
    ngx_slab_sizes_init();
	//如果在环境变量中有继承的NGINX_VAR,则将继承的服务器监听套接字的相关参数封装到cycle中。
    if (ngx_add_inherited_sockets(&init_cycle) != NGX_OK) {
        return 1;
    }

    if (ngx_preinit_modules() != NGX_OK) {
        return 1;
    }
    //完成cycle中一些其他参数的初始化，完成bind(),listen()等操作
    cycle = ngx_init_cycle(&init_cycle);
    if (cycle == NULL) {
        if (ngx_test_config) {
            ngx_log_stderr(0, "configuration file %s test failed",
                           init_cycle.conf_file.data);
        }

        return 1;
    }

然后处理伴随nginx启动时输入的相应命令参数

//如果有ngx_test_config == 1则表示需要测试配置文件，做相应的处理
    if (ngx_test_config) {
        if (!ngx_quiet_mode) {
            ngx_log_stderr(0, "configuration file %s test is successful",
                           cycle->conf_file.data);
        }

        if (ngx_dump_config) {
            cd = cycle->config_dump.elts;

            for (i = 0; i < cycle->config_dump.nelts; i++) {

                ngx_write_stdout("# configuration file ");
                (void) ngx_write_fd(ngx_stdout, cd[i].name.data,
                                    cd[i].name.len);
                ngx_write_stdout(":" NGX_LINEFEED);

                b = cd[i].buffer;

                (void) ngx_write_fd(ngx_stdout, b->pos, b->last - b->pos);
                ngx_write_stdout(NGX_LINEFEED);
            }
        }

        return 0;
    }
//处理之前ngx_get_options()保存的ngx_signal
    if (ngx_signal) {
        return ngx_signal_process(cycle, ngx_signal);
    }

然后是记录一些资源参数到log中，然后获取配置文件以及将nginx设置为守护进程等一些配置操作

	//记录ngx中操作系统级的资源参数到log中
    ngx_os_status(cycle->log);

    ngx_cycle = cycle;
	//得到核心模块ngx_core_conf_t的配置文件指针
    ccf = (ngx_core_conf_t *) ngx_get_conf(cycle->conf_ctx, ngx_core_module);

    if (ccf->master && ngx_process == NGX_PROCESS_SINGLE) {
        ngx_process = NGX_PROCESS_MASTER;
    }

#if !(NGX_WIN32)
	//设置signals[]数组中每个信号的action(即常说的注册、安装等)
    if (ngx_init_signals(cycle->log) != NGX_OK) {
        return 1;
    }
	
    if (!ngx_inherited && ccf->daemon) {
		//这里如果你是用gdb调试要注意，父进程在这里会变为守护进程，要set follow-fork-mode child才能继续往后观察逻辑
		//函数功能就是将nginx设置为守护进程
		//在这里复习一下设置进程为守护进程的方法：
		//1.调用fork来创建一个子进程，并使父进程终止，然后子进程自动转化为守护进程
		//2.调用setsid来创建新会话，并使子进程成为会话组长，以此来脱离控制终端
		//3.调用umask来设置创建新文件的权限掩码
		//4.调用dup2重定向stdin、stdout和stderr到/dev/null（黑洞）
		//5.关闭stdin、stdout和stderr以外的文件描述符
        if (ngx_daemon(cycle->log) != NGX_OK) {
            return 1;
        }

        ngx_daemonized = 1;
    }

    if (ngx_inherited) {
        ngx_daemonized = 1;
    }

#endif
	//创建pid文件
    if (ngx_create_pidfile(&ccf->pid, cycle->log) != NGX_OK) {
        return 1;
    }
	//重定向日志错误的标准输出
    if (ngx_log_redirect_stderr(cycle) != NGX_OK) {
        return 1;
    }

    if (log->file->fd != ngx_stderr) {
        if (ngx_close_file(log->file->fd) == NGX_FILE_ERROR) {
            ngx_log_error(NGX_LOG_ALERT, cycle->log, ngx_errno,
                          ngx_close_file_n " built-in log failed");
        }
    }

    ngx_use_stderr = 0;

最后，也是最关键的一步，就是生成worker进程和master进程（默认模式，也可设置成单进程处理模式），并且让它们进入工作循环中

if (ngx_process == NGX_PROCESS_SINGLE) {
	//如果设置为单进程模式，则进入单进程模式的主循环
        ngx_single_process_cycle(cycle);

    } else {
	//进入master-worker工作模式，开始创建多个Nginx的子进程。并进入进程循环。
        ngx_master_process_cycle(cycle);
    }