nginx学习十一 nginx启动流程

今天用了一天的时间看nginx的启动流程，流程还是非常复杂。基本的函数调用有十几个之多。通过看源代码和上网查资料，弄懂了一些函数。有些函数还在学习中，有些函数还待日后学习，这里记录一下今天所学。加油！

http://blog.csdn.net/xiaoliangsky/article/details/39856803

1nginx.c

启动的程序主要在src/core/nginx.c中。和普通函数一样，main函数是其入口函数：以下我们看看main函数的源码：

int ngx_cdecl
main(int argc, char *const *argv)
{
    ngx_int_t         i;
    ngx_log_t        *log;
    ngx_cycle_t      *cycle, init_cycle;
    ngx_core_conf_t  *ccf;

#if (NGX_FREEBSD)
    ngx_debug_init();
#endif
	//该函数的定义在文件src/os/unix/ngx_errno.c，初始化错误编码
    if (ngx_strerror_init() != NGX_OK) {
        return 1;
    }

    if (ngx_get_options(argc, argv) != NGX_OK) {//解析Nginx的启动參数
        return 1;
    }

    if (ngx_show_version) {
        ngx_write_stderr("nginx version: " NGINX_VER NGX_LINEFEED);

        if (ngx_show_help) {//启动配置參数
            ngx_write_stderr(
                "Usage: nginx [-?
hvVtq] [-s signal] [-c filename] "
                             "[-p prefix] [-g directives]" NGX_LINEFEED
                             NGX_LINEFEED
                "Options:" NGX_LINEFEED
                "  -?,-h         : this help" NGX_LINEFEED
                "  -v            : show version and exit" NGX_LINEFEED
                "  -V            : show version and configure options then exit"
                                   NGX_LINEFEED
                "  -t            : test configuration and exit" NGX_LINEFEED
                "  -q            : suppress non-error messages "
                                   "during configuration testing" NGX_LINEFEED
                "  -s signal     : send signal to a master process: "
                                   "stop, quit, reopen, reload" NGX_LINEFEED
#ifdef NGX_PREFIX
                "  -p prefix     : set prefix path (default: "
                                   NGX_PREFIX ")" NGX_LINEFEED
#else
                "  -p prefix     : set prefix path (default: NONE)" NGX_LINEFEED
#endif
                "  -c filename   : set configuration file (default: "
                                   NGX_CONF_PATH ")" NGX_LINEFEED
                "  -g directives : set global directives out of configuration "
                                   "file" NGX_LINEFEED NGX_LINEFEED
                );
        }

        if (ngx_show_configure) {
            ngx_write_stderr(
#ifdef NGX_COMPILER
                "built by " NGX_COMPILER NGX_LINEFEED
#endif
#if (NGX_SSL)
#ifdef SSL_CTRL_SET_TLSEXT_HOSTNAME
                "TLS SNI support enabled" NGX_LINEFEED
#else
                "TLS SNI support disabled" NGX_LINEFEED
#endif
#endif
                "configure arguments:" NGX_CONFIGURE NGX_LINEFEED);
        }

        if (!ngx_test_config) {
            return 0;
        }
    }

    /* TODO */ ngx_max_sockets = -1;

    ngx_time_init();//(core/ngx_time.h)初始化时间和更新系统时间

#if (NGX_PCRE)
    ngx_regex_init();//src/core/ngx_regex.c这个函数暂不介绍
#endif

    ngx_pid = ngx_getpid();//获得当前进程ID

    log = ngx_log_init(ngx_prefix);//初始化log日志。log是核心模块。以后在学
    if (log == NULL) {
        return 1;
    }

    /* STUB */
#if (NGX_OPENSSL)
    ngx_ssl_init(log);//src/event/ngx_event_openssl.c,这个函数暂不介绍，event模块
#endif

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

    ngx_memzero(&init_cycle, sizeof(ngx_cycle_t));
    init_cycle.log = log;
    ngx_cycle = &init_cycle;

    init_cycle.pool = ngx_create_pool(1024, log);//创建内存池
    if (init_cycle.pool == NULL) {
        return 1;
    }

    if (ngx_save_argv(&init_cycle, argc, argv) != NGX_OK) {//保存配置參数
        return 1;
    }
	//用old_cycle(init_cycle)先保存一些配置信息,然后这个init_cycle将会作为
	//ngx_init_cycle參数中的old_cycle
    if (ngx_process_options(&init_cycle) != NGX_OK) {
        return 1;
    }
	//调用ngx_os_init()初始化系统相关变量，如内存页面大小ngx_pagesize,ngx_cacheline_size,
	//最大连接数ngx_max_sockets等
    if (ngx_os_init(log) != NGX_OK) {
        return 1;
    }

    /*
     * ngx_crc32_table_init() requires ngx_cacheline_size set in ngx_os_init()
     */
	//调用ngx_crc32_table_init()初始化CRC表(兴许的CRC校验通过查表进行，效率高)
    if (ngx_crc32_table_init() != NGX_OK) {
        return 1;
    }
	//继续sockets,并把相关信息存储在init_cycle
    if (ngx_add_inherited_sockets(&init_cycle) != NGX_OK) {
        return 1;
    }
	//初始化各个模块的index
    ngx_max_module = 0;
    for (i = 0; ngx_modules[i]; i++) {
        ngx_modules[i]->index = ngx_max_module++;
    }
	//调用ngx_init_cycle，这个函数非常重要，大部分初始化操作都在这个函数里面,后面会具体学习
    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;
    }

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

        return 0;
    }
	//处理signal信号
    if (ngx_signal) {
        return ngx_signal_process(cycle, ngx_signal);
    }

    ngx_os_status(cycle->log);

    ngx_cycle = cycle;
	//ccf的创建creat_conf和初始化init_conf是在ngx_init_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)
	//调用ngx_init_signals()初始化信号；主要完毕信号处理程序的注冊
	//该函数定义在sorc/os/unix/ngx_process.c
    if (ngx_init_signals(cycle->log) != NGX_OK) {
        return 1;
    }
	//若无继承sockets，且设置了守护进程标识，则调用ngx_daemon()创建守护进程
    if (!ngx_inherited && ccf->daemon) {
        if (ngx_daemon(cycle->log) != NGX_OK) {
            return 1;
        }

        ngx_daemonized = 1;
    }

    if (ngx_inherited) {
        ngx_daemonized = 1;
    }

#endif
	//调用ngx_create_pidfile()创建进程记录文件,记录进程ID
    if (ngx_create_pidfile(&ccf->pid, cycle->log) != NGX_OK) {
        return 1;
    }

    if (cycle->log->file->fd != ngx_stderr) {

        if (ngx_set_stderr(cycle->log->file->fd) == NGX_FILE_ERROR) {
            ngx_log_error(NGX_LOG_EMERG, cycle->log, ngx_errno,
                          ngx_set_stderr_n " failed");
            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 {//master进程
        ngx_master_process_cycle(cycle);
    }

    return 0;
}

这里总结函数调用例如以下：

1 ngx_strerror_init()。该函数的定义在文件src/os/unix/ngx_errno.c中。该函数主要初始化系统中
错误编号相应的含义。这样初始化中进行相应的优点是，当出现错误。不用再去调用strerror()函数来获
取错误原因，而直接能够依据错误编号找到相应的错误原因，能够提高执行时的执行效率;
2 ngx_get_options() 解析Nginx的启动參数;
3 ngx_time_init() 该函数的定义在文件src/core/ngx_time.c中。

ngx_cached_err_log_time。
ngx_cached_http_time，ngx_cached_http_log_time，ngx_cached_http_log_iso8601均为
ngx_str_t类型的，用于记录错误日志时间，http缓存时间。http缓存log时间以及iso8061时间，初始化过程中
，先计算该时间表示的字符串的长度，这样能够省却在用到的时候再进行计算。

ngx_cached_time是nginx时间类
型的数据结构，他是volatile类型的，即防止编译器优化，每次都要从内存中读取，而不是用缓存值。这个函数
调用了ngx_time_update()该函数的定义在文件src/core/ngx_time.c中。函数用于更新系统时间;
4 ngx_regex_init() src/core/ngx_regex.c,假设启用了PCRE功能，则进行正則表達式的初始化工作。

Nginx中的pcre主要
是用来支持URL Rewrite的，URL Rewrite主要是为了满足代理模式下，对请求訪问的URL地址进行rewrite操作，来实
现定向訪问。这个函数如今不多介绍。以后学http模块在介绍;
5 ngx_log_init() src/core/ngx_log.c。初始化log日志，包含创建日志文件，log模块也是核心模块，以后在学习。
6 ngx_ssl_init() src/event/ngx_event_openssl.c,这个函数暂不介绍，event模块;
7 ngx_save_argv() 保存启动參数在ngx_argv数组里面，參数个数保存在ngx_argc里面;
8 ngx_process_options() 用old_cycle先保存一些配置信息：prefix,conf_prefix,conf_file, conf_param;
然后这个old_cycle将会作为ngx_init_cycle參数中的old_cycle;
9 ngx_os_init() 初始化系统相关变量。如内存页面大小ngx_pagesize,ngx_cacheline_size,最大连接数ngx_max_sockets等
10 ngx_crc32_table_init() 调用初始化CRC表,兴许的CRC校验通过查表进行，效率高;
11 ngx_add_inherited_sockets() 继承sockets,并把相关信息存储在init_cycle这个后面会具体介绍；
12 初始化各个模块的index  http://blog.csdn.net/xiaoliangsky/article/details/39856803
13 ngx_init_cycle() 调用ngx_init_cycle，这个函数非常重要。大部分初始化操作都在这个函数里面,后面会具体学习
14 假如有信号。就调用ngx_siganl_process处理信号
15 ngx_init_signal 初始化信号。主要完毕信号处理程序的注冊
16 若无继承sockets，且设置了守护进程标识，则调用ngx_daemon()创建守护进程
17 ngx_create_pidfile 调用ngx_create_pidfile()创建进程记录文件,记录进程ID
18 进入进程循环，假设ngx_process=1,就进入ngx_single_process_cycle
                                         ngx_process!=1,就进入ngx_master_process_cycle
    ngx_signale_process_cycle和ngx_master_process_cycle这两个函数后面会重点学习。

參考资料：

http://blog.csdn.net/livelylittlefish/article/details/7243718