為了使nginx支持windows服務，本文闡述以下主要的改進實現。
ngx_main函數 為了在SCM服務中復用main函數的邏輯，將其重命名為ngx_main，并添加第3個參數is_scm以兼容控制臺運行方式，聲明在core/nginx.h中。
1
#if (NGX_WIN32 && NGX_USE_SERVICE)
2extern int ngx_main(int argc,char *const *argv,int is_scm);
3#endif 定義在core/nginx.c中，供main函數和ServiceMain函數調用。
1int ngx_cdecl
2#if (NGX_WIN32 && NGX_USE_SERVICE)
3 ngx_main(int argc, char *const *argv, int is_scm)
4#else
5 main(int argc, char *const *argv)
6#endif is_scm為非0表示以SCM服務方式運行，否則以控制臺方式運行。宏NGX_USE_SERVICE用于支持SCM服務方式的條件編譯。相比老的main函數，ngx_main依次修改了以下幾方面：
不顯示版本和幫助 只有以控制臺方式運行時，才能查看版本和幫助，即這部分代碼當is_scm為0時才有效。
1
#if (NGX_WIN32 && NGX_USE_SERVICE)
2
if(!is_scm)
{
3
if (ngx_show_version) {
4
ngx_write_stderr("nginx version: " NGINX_VER NGX_LINEFEED);
5
6 if (ngx_show_help) {
7
8
}
9
10 if (ngx_show_configure) {
11
12 }
13
14 if (!ngx_test_config) {
15 return 0;
16 }
17 }
18
}
19#endif 增加服務初始化
1log = ngx_log_init(ngx_prefix);
2if (log == NULL) {
3 return 1;
4}
5
6#if (NGX_WIN32 && NGX_USE_SERVICE)
7if(is_scm){
8 ngx_service_init(log,argc,argv);
9}
10#endif 當is_scm為非0即nginx以服務方式運行時，調用外部函數ngx_service_init初始化。因為此時ngx_cycle還沒構造，而ngx_service_init須將錯誤記錄在log中，所以應在ngx_log_init完成后調用。
不測試配置和處理信號 與不顯示版本和幫助同理，只有以控制臺方式運行時，這部分處理才有效。
1#if (NGX_WIN32 && NGX_USE_SERVICE)
2 if(!is_scm){
3 if (ngx_test_config) {
4 if (!ngx_quiet_mode) {
5 ngx_log_stderr(0, "configuration file %s test is successful", cycle->conf_file.data);
6 }
7
8 return 0;
9 }
10
11 if (ngx_signal) {
12 return ngx_signal_process(cycle, ngx_signal);
13 }
14 }
15#endif 設置狀態為正在運行
1#if (NGX_WIN32 && NGX_USE_SERVICE)
2 if(is_scm && ngx_service_update_state(ngx_cycle->log,SERVICE_RUNNING,0,0)){
3 exit(1);
4 }
5#endif
6 ngx_use_stderr = 0;
7
8if (ngx_process == NGX_PROCESS_SINGLE) {
9 ngx_single_process_cycle(cycle);
10
11} else {
12 ngx_master_process_cycle(cycle);
13}
14
15 return 0; 為了準確報告服務正在運行的狀態，應在所有初始化完成后進行，所以在最后的主循環前調用ngx_service_update_state。
以下5個部分對應的實現函數，都定義在os/win32/ngx_service.c中。
main函數 nginx程序的啟動入口主函數，可被控制臺或SCM調用，當被SCM調用時，負責用SCM來注冊服務，以及啟動服務控制調度程序。
1void main(int argc, char *const *argv)
2{
3 SERVICE_TABLE_ENTRY st[] = {
4 { "nginx", ngx_service_main },
5 { NULL, NULL }
6 };
7
8 /* StartServiceCtrlDispatcher() should be called within 30 seconds */
9 if (StartServiceCtrlDispatcher(st) == 0) {
10 if(ERROR_FAILED_SERVICE_CONTROLLER_CONNECT==ngx_errno){
11 ngx_main(argc,argv,0);
12 }
13 }
14} 指定ServiceMain函數為ngx_service_main，有2種情況會以控制臺方式運行：1）在控制臺啟動nginx產生的master和worker進程，2）在SCM中啟動nginx產生的worker進程。當以控制臺方式運行時，StartServiceCtrlDispatcher失敗返回ERROR_FAILED_SERVICE_CONTROLLER_CONNECT錯誤，以is_scm為0調用ngx_main函數；當以SCM服務方式運行成功時，會調用到ServiceMain函數。
ServiceMain函數 由SCM生成的一個邏輯線程調用。
1static void WINAPI ngx_service_main(u_int argc, char **argv)
2{
3 ngx_main(argc,argv,1);
4 ngx_service_update_state(ngx_cycle->log,SERVICE_STOPPED,0,0);
5} 以is_scm為1調用ngx_main。當ngx_main異常退出時，會調用到ngx_exit_handler；當正常返回時直接更新服務狀態為已停止。
服務初始化 由ngx_main調用。
1void ngx_service_init(ngx_log_t *log,int argc,char *const *argv)
2{
3 atexit(ngx_exit_handler);
4
5 ngx_service = RegisterServiceCtrlHandlerEx("nginx", ngx_service_control, NULL);
6 if(ngx_service == INVALID_HANDLE_VALUE) {
7 ngx_log_error(NGX_LOG_EMERG,log,ngx_errno,"RegisterServiceCtrlHandlerEx fail");
8 exit(1);
9 }
10
11 ngx_status.dwServiceType = SERVICE_WIN32_OWN_PROCESS;
12 ngx_status.dwControlsAccepted = SERVICE_ACCEPT_STOP|SERVICE_ACCEPT_PARAMCHANGE;
13 ngx_status.dwWin32ExitCode = NO_ERROR;
14 ngx_status.dwServiceSpecificExitCode = 0;
15
16 /* SetServiceStatus() should be called within 80 seconds */
17 if(ngx_service_update_state(log,SERVICE_START_PENDING,1,2000)){
18 exit(1);
19 }
20} 先注冊退出回調ngx_exit_handler，再注冊服務控制處理器ngx_service_control，最后設置服務狀態為正在啟動。 由于在nginx實現中，有多處出現異常錯誤時直接調用exit，為了簡單方便，在退出時報告服務停止的狀態，因此首先使用atexit注冊了ngx_exit_handler。
1static void ngx_exit_handler(void)
2{
3 ngx_service_update_state(ngx_cycle->log,SERVICE_STOPPED,0,0);
4} 服務控制處理器 由SCM生成的一個邏輯線程調用。
1static u_long WINAPI ngx_service_control(u_long control, u_long type, void *data, void *ctx)
2{
3 switch(control) {
4 case SERVICE_CONTROL_STOP:
5 ngx_service_update_state(ngx_cycle->log, SERVICE_STOP_PENDING, 0, 0);
6 ngx_os_signal_process(ngx_cycle,"quit",ngx_pid);
7 break;
8 }
9
10 return NO_ERROR;
11} 當停止或重新啟動服務時會進入到SERVICE_CONTROL_STOP分支，設置服務狀態為正在停止，發送quit信號（在nginx中用命名event代替實現）給master進程。
設置服務狀態
1int ngx_service_update_state(ngx_log_t *log, u_long state, u_long checkpoint,u_long waithint)
2{
3 ngx_status.dwCurrentState = state;
4 ngx_status.dwCheckPoint = checkpoint;
5 ngx_status.dwWaitHint = waithint;
6
7 if(SetServiceStatus(ngx_service, &ngx_status) == 0) {
8 ngx_log_error(NGX_LOG_EMERG,log,ngx_errno,"SetServiceStatus fail");
9 return -1;
10 }
11
12 return 0;
13} 由ngx_service_init、ngx_main、ngx_service_control和ngx_exit_handler調用，分別設置正在啟動、正在運行、正在停止和已停止狀態。
posted on 2016-07-12 15:31
春秋十二月 閱讀(4525)
評論(0) 編輯 收藏 引用 所屬分類:
Opensrc