Nginx 调试一

Nginx的main函数：

int ngx_cdecl
main(int argc, char *const *argv)
{
    ngx_buf_t        *b;
    ngx_log_t        *log;
    ngx_uint_t        i;
    ngx_cycle_t      *cycle, init_cycle;
    ngx_conf_dump_t  *cd;
    ngx_core_conf_t  *ccf;

    //linux环境，这是一个空的宏，mac系统下，是一个函数；目前只关注linux， 知道是空就行了
    ngx_debug_init();

    /**
     * 函数内部需要注意的地方:
     * len = NGX_SYS_NERR * sizeof(ngx_str_t); // NGX_SYS_NERR 可以在objs下的.h找到 (find objs/ -name "*.h" | xargs grep -in "NGX_SYS_NERR" )我的环境是135， ngx_str_t是16; NGX_SYS_NERR宏的具体生成：执行configure到58行时->auto/unix.c:702->auto/feature 会在objs下生成一个objs/autotest.c文件：
     * printf("%d", sys_nerr);核心的一句就是这个。sys_nerr的值就是135。 这个变量定义在哪里，没有找到，只在/usr/include/bits/sys_errlist.h找到一个extern 声明。
     * 结论： 该函数开辟内存， 将系统所有错误码对应的msg存储到ngx_sys_errlist数组中。
     */   
    if (ngx_strerror_init() != NGX_OK) {
        return 1;
    }

    /**
     * 判断命令行参数， 不解释
     */
    if (ngx_get_options(argc, argv) != NGX_OK) {
        return 1;
    }

    if (ngx_show_version) {
        ngx_show_version_info();

        if (!ngx_test_config) {
            return 0;
        }
    }

    /* TODO */ ngx_max_sockets = -1;

    /**
     * @see: http://blog.itpub.net/15480802/viewspace-1344713/
     * 有待进一步的研究。尤其是调试怎么进入内核态！！！！
     */
    ngx_time_init();

    /**
     * 暂时略过
     */
#if (NGX_PCRE)
    ngx_regex_init();
#endif

    // 获取nginx的进程号
    ngx_pid = ngx_getpid();

    // 初始化日志模块， 函数里主要是打开日志文件， 设置log的fd成员， 日志级别
    log = ngx_log_init(ngx_prefix);
    if (log == NULL) {
        return 1;
    }

    // 暂时略
    /* STUB */
#if (NGX_OPENSSL)
    ngx_ssl_init(log);
#endif

    /*
     * init_cycle->log is required for signal handlers and
     * ngx_process_options()
     */

    /**
     * 初始化init_cycle的log成员
     */
    ngx_memzero(&init_cycle, sizeof(ngx_cycle_t));
    init_cycle.log = log;
    ngx_cycle = &init_cycle;

    /**
     * 分配pool的空间（16 * 1024 B，即16KB）, 初始化init_cycle的pool成员
     * pool的结构有待进一步分析。 注意： 这里用到的分配空间的函数是：posix_memalign
     * posix_memalign: @see: http://linhan.blog.ustc.edu.cn/?p=617， 网上一搜一大堆
     * /
    init_cycle.pool = ngx_create_pool(1024, log);   // init the pool
    if (init_cycle.pool == NULL) {
        return 1;
    }

    /**
     * 初始化全局变量ngx_argv, ngx_argc(就是将argc， argv 保存到全局变量里)
     * 不必纠结为什么传入参数init_cycle, 这里只是打印日志的需要
     */
    if (ngx_save_argv(&init_cycle, argc, argv) != NGX_OK) {
        return 1;
    }

    /**
     * 这个函数主要是初始化init_cycle的conf_file的完全路径，初始化conf_prefix的值
     */
    if (ngx_process_options(&init_cycle) != NGX_OK) {
        return 1;
    }

    /**
     * 初始化全局linux信息： ngx_linux_kern_ostype（Linux）, ngx_linux_kern_osrelease， 和nginx的系统io： ngx_os_io=ngx_linux_io。
     * 备注： ngx_linux_io 是一个包含一系列回调函数的结构体， nginx对send, recv等进一步封装(主要是针对跨平台kqueue和epoll)， 详细的封装有待进一步研究 。 
     * 获取内存分页大小， ngx_cpu数目， 软硬件限制等， 设置随机数种子等
     */
    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_add_inherited_sockets主要是继承了socket的套接字。主要作用是热启动的时候需要平滑过渡）
     */
    if (ngx_add_inherited_sockets(&init_cycle) != NGX_OK) {
        return 1;
    }

    /**
     * 初始化模块， 这个ngx_module_names初始化， 有待进一步研究
     */
    if (ngx_preinit_modules() != NGX_OK) {
        return 1;
    }

    /**
     * ngx_init_cycle 忒长， 奶奶个腿的， 暂时看字面意思吧， 初始化init_cycle 结构体， 后面会深入研究这个这个cycle结构， 可以看下初始化后，里面的成员， 乖乖...
     * (gdb) p *cycle 略了
     */
    cycle = ngx_init_cycle(&init_cycle);
    if (cycle == NULL) {
        // ngx_test_config当执行./objs/ngx -T 时， 会置1， 这段的意思是： 如果是cycle初始化失败， 且此时是处于测试配置文件的功能， 那么这时候表示测试conf文件失败
        if (ngx_test_config) {
            ngx_log_stderr(0, "configuration file %s test failed",
                           init_cycle.conf_file.data);
        }

        return 1;
    }

    if (ngx_test_config) {
        if (!ngx_quiet_mode) {
            ngx_log_stderr(0, "configuration file %s test is successful",
                           cycle->conf_file.data);
        }

        // 会将configure文件的内容输出到屏幕
        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;
    }

    // ./objs/ngx -s xxx时， 会执行到这里，就是将信号发送给ngx主进程？ 暂时这么理解吧，后面会再次完善这个注释
    if (ngx_signal) {
        return ngx_signal_process(cycle, ngx_signal);
    }

    ngx_os_status(cycle->log);

    ngx_cycle = cycle;

    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)

    if (ngx_init_signals(cycle->log) != NGX_OK) {
        return 1;
    }

    if (!ngx_inherited && ccf->daemon) {
        if (ngx_daemon(cycle->log) != NGX_OK) {
            return 1;
        }

        ngx_daemonized = 1;
    }

    if (ngx_inherited) {
        ngx_daemonized = 1;
    }

#endif

    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;

    if (ngx_process == NGX_PROCESS_SINGLE) {
        ngx_single_process_cycle(cycle);

    } else {
        ngx_master_process_cycle(cycle);
    }

    return 0;
}