Nginx源碼學(xué)習(xí)(2) ---- 模塊化及配置

    nginx的大部分功能都采用模塊化的方式加載到主程序，通過配置文件實現(xiàn)模塊的各種加載和參數(shù)配置。模塊化架構(gòu)分析是nginx最關(guān)鍵的部分之一，本文作為參考文獻(xiàn)[1]的補(bǔ)充，深入分析nginx如何把配置文件和模塊管理聯(lián)系到一起的。
    可以說整個nginx都是由模塊來組成。nginx的模塊可以分為四種：core、 event、http和mail, core是核心模塊，event是事件處理模塊，本文重點以這兩個模塊為例進(jìn)行分析。在編譯配置的時候，由自動腳本生成的objs/ngx_modules.c，定義了要包含的哪些模塊，保存到全局變量ngx_modules[] 中，
   
  而ngx_core_module, ngx_events_module這些全局變量，則在模塊的實現(xiàn)文件中定義。ngx_module_t的結(jié)構(gòu)的主要成員見下圖。
 

commands是ngx_command_t的數(shù)組，表示該模塊支持的配置命令。
ctx是模塊上下文，保存著該模塊的關(guān)鍵的信息，比如event模塊上下文為ngx_event_module_t結(jié)構(gòu)，該結(jié)構(gòu)有一個ngx_event_actions_t成員，保存著事件處理函數(shù)，它把事件處理抽象成幾個函數(shù)（添加/刪除事件，查詢事件，事件響應(yīng)），具體的epoll, select, kqueue等API根據(jù)配置來填入，下文將詳細(xì)講述。 模塊上下文一般都有create_conf和init_conf兩個鉤子，由于每個模塊都有一個屬于自己的配置結(jié)構(gòu)體，用來保存該模塊的配置參數(shù)，這兩個函數(shù)鉤子就是創(chuàng)建和初始化該模塊的配置結(jié)構(gòu)體。

nginx的進(jìn)程啟動過程可參考文獻(xiàn)[1]，下面就一步步分析從配置文件到模塊載入和配置的整個過程。

nginx的配置文件示例如下圖


可以看到，nginx配置文件格式是：
   配置節(jié)名(也是命令的一種) {
       下一級配置節(jié)名{
           。。。 。。。
       }
       命令  值
   }

這里的命令就是上文的ngx_command_t結(jié)構(gòu)中的name字符串，最外層的是對應(yīng)ngx_core_module中的命令。整個配置過程如下：

main()
{
   ....
    // 所有模塊點一下數(shù), 初始化index
    ngx_max_module = 0;
    for (i = 0; ngx_modules[i]; i++) {
        ngx_modules[i]->index = ngx_max_module++;
    }
   ngx_init_cycle(); //初始化并設(shè)置全局變量
   ///..........
   ngx_master_process_cycle(); //啟動進(jìn)程，執(zhí)行主循環(huán)干活， 參見文檔[2]
   ///..........
}

//設(shè)置全局變量
ngx_init_cycle()
{
    for (i = 0; ngx_modules[i]; i++) {
        if (ngx_modules[i]->type != NGX_CORE_MODULE) {
            continue;
        }
        module = ngx_modules[i]->ctx;    //取得模塊上下文, 例如ngx_core_module中的ngx_core_module_ctx

        // 調(diào)度core類型模塊的鉤子create_conf，并且把創(chuàng)建的配置結(jié)構(gòu)體變量存放到cycle->conf_ctx中
        if (module->create_conf) {
            rv = module->create_conf(cycle);
            if (rv == NULL) {
                ngx_destroy_pool(pool);
                return NULL;
            }
            cycle->conf_ctx[ngx_modules[i]->index] = rv;   //這里是配置信息的結(jié)構(gòu)體
        }
    }
    /* 例如ngx_core_module模塊，create_conf鉤子是調(diào)用ngx_core_module_create_conf, 該函數(shù)創(chuàng)建一個ngx_core_conf_t結(jié)構(gòu)體，保存了全局的配置信息，比如子進(jìn)程數(shù)，連接數(shù)，文件路徑等頂層信息，并返回。之后保存在全局cycle的conf_ctx對應(yīng)位置(對應(yīng)于模塊index)。 */
    //....
    ngx_conf_parse(&conf, &cycle->conf_file);   //分析配置文件


    // 調(diào)度core模塊的鉤子init_conf，設(shè)置剛才創(chuàng)建的配置結(jié)構(gòu)體變量（用從配置文件中讀取的數(shù)據(jù)賦值）
    init_conf根據(jù)之前的conf_parse結(jié)果，填充配置結(jié)構(gòu)體數(shù)值


    // 調(diào)度所有模塊的init_module鉤子，初始化模塊
    for (i = 0; ngx_modules[i]; i++) {
        if (ngx_modules[i]->init_module) {   //調(diào)用模塊的初始化函數(shù)
            if (ngx_modules[i]->init_module(cycle) != NGX_OK) {

                exit(1);
            }
        }
    }
   .....
}

ngx_conf_parse()
{
   //循環(huán)對配置文件進(jìn)行語法分析
   ngx_conf_read_token(); //讀取下一個token
   //根據(jù){ }來設(shè)置ngx_conf_s中的變量，改變當(dāng)前的模塊配置節(jié)
   ngx_conf_handler();   //分析該配置節(jié)下的模塊命令.
}

ngx_conf_handler()
{
   //1. 遍歷模塊的command_s數(shù)組，strcmp來比對命令
   //2. 根據(jù)command_t的參數(shù)指定，讀取后續(xù)參數(shù)
   //3. 獲取該模塊的配置結(jié)構(gòu)體，以及該命令相關(guān)的參數(shù)在配置結(jié)構(gòu)體中的偏移量(根據(jù)command_t中的offset)
   //4. 調(diào)用command_t中的set鉤子，把讀到參數(shù)值賦值給配置結(jié)構(gòu)體
}

最后在模塊的init_conf函數(shù)中可以根據(jù)配置值，來做相應(yīng)的操作。
比如底層的事件處理庫，use指令指示用select還是epoll呢，比如use epoll
那么這些event模塊在init的時候，就會判斷配置結(jié)構(gòu)體中的use, 如果是自己，則把event_actions賦值給全局變量ngx_event_actions，
這樣，其他模塊就可以通過ngx_event_actions中的鉤子進(jìn)行事件處理操作, 隔離了底層實現(xiàn)。

參考文獻(xiàn)
[1] nginx源碼分析--模塊化(1) http://blog.sina.com.cn/s/blog_677be95b0100iive.html
[2] nginx的進(jìn)程模型。http://simohayha.javaeye.com/blog/467940

posted on 2010-06-18 16:15 Daly 閱讀(2519) 評論(0)  編輯 收藏 引用 所屬分類: C/C++ 、網(wǎng)絡(luò)編程