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);
    }