ngx源码分析--core模块以及callback

叁歲伎倆 2022-08-25 13:56 173阅读 0赞

链接： [http://blog.csdn.net/livelylittlefish/article/details/7262750][http_blog.csdn.net_livelylittlefish_article_details_7262750]

Content  
0. 序  
1. Core模块的配置结构  
2. create\_conf分析  
3. init\_conf分析  
4. 小结

#### 0. 序 ####

在[<nginx源码分析—全局变量ngx\_cycle的初始化>][nginx_ngx_cycle]中，简单介绍了如何调用core模块的callback，并简单列出其定义及其初始化，本文将重点阐述callback做什么。

#### 1. Core模块的配置结构 ####

如前文所述，core模块的callback有两个create\_conf()和init\_conf()，从名字就可以看出，一个创建配置结构，另一个初始化该配置结构。core模块的配置结构如下，存放配置文件中的核心指令，如deamon，master等。

./src/core/ngx\_cycle.h

**\[cpp\]** [ view plain][view plain] [copy][view plain]

1.  typedef struct \{  
2.       ngx\_flag\_t               daemon;  
3.       ngx\_flag\_t               master;  
4.    
5.       ngx\_msec\_t               timer\_resolution;  
6.    
7.       ngx\_int\_t                worker\_processes;  
8.       ngx\_int\_t                debug\_points;  
9.    
10.      ngx\_int\_t                rlimit\_nofile;  
11.      ngx\_int\_t                rlimit\_sigpending;  
12.      off\_t                    rlimit\_core;  
13.   
14.      int                      priority;  
15.   
16.      ngx\_uint\_t               cpu\_affinity\_n;  
17.      u\_long                  \*cpu\_affinity;  
18.   
19.      char                    \*username;            /\* 用户名 \*/  
20.      ngx\_uid\_t                user;                /\* user ID \*/  
21.      ngx\_gid\_t                group;               /\* group ID\*/  
22.   
23.      ngx\_str\_t                working\_directory;   /\*  \*/  
24.      ngx\_str\_t                lock\_file;           /\* 用户名 \*/  
25.   
26.      ngx\_str\_t                pid;  
27.      ngx\_str\_t                oldpid;              /\* 以'.oldbin'结尾 \*/  
28.   
29.      ngx\_array\_t              env;  
30.      char                   \*\*environment;  
31.   
32. \#if (NGX\_THREADS)  
33.      ngx\_int\_t                worker\_threads;  
34.      size\_t                   thread\_stack\_size;  
35. \#endif  
36.   
37. \} ngx\_core\_conf\_t;

#### 2. create\_conf分析 ####

create\_conf只是指针，CORE模块的create\_conf指向ngx\_core\_module\_init\_conf()函数，该函数创建ngx\_core\_conf\_t配置结构。

**\[cpp\]** [ view plain][view plain] [copy][view plain]

1.  static void \*  
2.  ngx\_core\_module\_create\_conf(ngx\_cycle\_t \*cycle)  
3.  \{  
4.      ngx\_core\_conf\_t  \*ccf;  
5.    
6.      ccf = ngx\_pcalloc(cycle->pool, sizeof(ngx\_core\_conf\_t));  
7.      if (ccf == NULL) \{  
8.          return NULL;  
9.      \}  
10.   
11.     /\* 
12.      \* set by ngx\_pcalloc() 
13.      \* 
14.      \*     ccf->pid = NULL; 
15.      \*     ccf->oldpid = NULL; 
16.      \*     ccf->priority = 0; 
17.      \*     ccf->cpu\_affinity\_n = 0; 
18.      \*     ccf->cpu\_affinity = NULL; 
19.      \*/  
20.   
21.     ccf->daemon = NGX\_CONF\_UNSET;  
22.     ccf->master = NGX\_CONF\_UNSET;  
23.     ccf->timer\_resolution = NGX\_CONF\_UNSET\_MSEC;  
24.   
25.     ccf->worker\_processes = NGX\_CONF\_UNSET;  
26.     ccf->debug\_points = NGX\_CONF\_UNSET;  
27.   
28.     ccf->rlimit\_nofile = NGX\_CONF\_UNSET;  
29.     ccf->rlimit\_core = NGX\_CONF\_UNSET;  
30.     ccf->rlimit\_sigpending = NGX\_CONF\_UNSET;  
31.   
32.     ccf->user = (ngx\_uid\_t) NGX\_CONF\_UNSET\_UINT;  
33.     ccf->group = (ngx\_gid\_t) NGX\_CONF\_UNSET\_UINT;  
34.   
35. \#if (NGX\_THREADS)  
36.     ccf->worker\_threads = NGX\_CONF\_UNSET;  
37.     ccf->thread\_stack\_size = NGX\_CONF\_UNSET\_SIZE;  
38. \#endif  
39.   
40.     if (ngx\_array\_init(&ccf->env, cycle->pool, 1, sizeof(ngx\_str\_t))  
41.         != NGX\_OK)  
42.     \{  
43.         return NULL;  
44.     \}  
45.   
46.     return ccf;  
47. \}

该函数很简单，即将配置结构的各个字段初始化为未设置的值。如下。

**\[cpp\]** [ view plain][view plain] [copy][view plain]

1.  \#define NGX\_CONF\_UNSET       -1  
2.  \#define NGX\_CONF\_UNSET\_UINT  (ngx\_uint\_t) -1  
3.  \#define NGX\_CONF\_UNSET\_PTR   (void \*) -1  
4.  \#define NGX\_CONF\_UNSET\_SIZE  (size\_t) -1  
5.  \#define NGX\_CONF\_UNSET\_MSEC  (ngx\_msec\_t) -1

#### 3. init\_conf分析 ####

init\_conf才是真正的初始化该结构。

(1) 初始化daemon、master等

直接赋值。

(2) 初始化pid、oldpid

调用ngx\_conf\_full\_name()函数初始化pid，实际上就是在pid字符串前加上NGX\_PREFIX获取pid全路径，NGX\_PREFIX定义如下。

**\[cpp\]** [ view plain][view plain] [copy][view plain]

1.  \#ifndef NGX\_PREFIX  
2.  \#define NGX\_PREFIX  "/usr/local/nginx/"  
3.  \#endif

例如，ngx\_conf\_full\_name()被调用前ccf->pid的内容如下。

**\[plain\]** [ view plain][view plain] [copy][view plain]

1.  (gdb) p ccf->pid   
2.  $2 = \{  
3.    len = 14,   
4.    data = 0x4727ff "logs/nginx.pid"  
5.  \}

ngx\_conf\_full\_name()被调用后ccf->pid的内容如下。

**\[plain\]** [ view plain][view plain] [copy][view plain]

1.  (gdb) p ccf->pid   
2.  $3 = \{  
3.    len = 31,   
4.    data = 0x6cce78 "/usr/local/nginx/logs/nginx.pid"  
5.  \}

(3)初始化username,user,group

该初始化通过调用系统函数getpwnam()和getgrnam()完成。相关数据结构如下。

*The getpwnam() function returns a pointer to a structure containing the broken-out fields of the record in the password database (e.g., the local password file /etc/passwd, NIS, and LDAP) that matches the username name.  
       The passwd structure is defined in <pwd.h> as follows:  
           struct passwd \{  
               char   \*pw\_name;       /\* username \*/  
               char   \*pw\_passwd;     /\* user password \*/  
               uid\_t   pw\_uid;        /\* user ID \*/  
               gid\_t   pw\_gid;        /\* group ID \*/  
               char   \*pw\_gecos;      /\* user information \*/  
               char   \*pw\_dir;        /\* home directory \*/  
               char   \*pw\_shell;      /\* shell program \*/  
           \};*

*The getgrnam() function returns a pointer to a structure containing the broken-out fields of the record in the group database (e.g., the local group file /etc/group, NIS, and LDAP) that matches the group name name.  
      The group structure is defined in <grp.h> as follows:  
           struct group \{  
               char   \*gr\_name;       /\* group name \*/  
               char   \*gr\_passwd;     /\* group password \*/  
               gid\_t   gr\_gid;        /\* group ID \*/  
               char  \*\*gr\_mem;        /\* group members \*/  
           \};*

获得的数据如下。

**\[plain\]** [ view plain][view plain] [copy][view plain]

1.  (gdb) p \*pwd  
2.  $5 = \{  
3.    pw\_name = 0x6b82a0 "nobody",   
4.    pw\_passwd = 0x6b82a7 "x",   
5.    pw\_uid = 99,   
6.    pw\_gid = 99,   
7.    pw\_gecos = 0x6b82af "Nobody",   
8.    pw\_dir = 0x6b82b6 "/",   
9.    pw\_shell = 0x6b82b8 "/sbin/nologin"  
10. \}  
11.   
12. (gdb) p \*grp  
13. $6 = \{  
14.   gr\_name = 0x6c3bf0 "nobody",   
15.   gr\_passwd = 0x6c3bf7 "x",   
16.   gr\_gid = 99,   
17.   gr\_mem = 0x6c3c00  
18. \}

(4) 初始化lock\_file

同初始化pid，调用ngx\_conf\_full\_name()函数初始化lock\_file，即在lock\_file字符串前加上NGX\_PREFIX获取其全路径，其全路径如下。

**\[plain\]** [ view plain][view plain] [copy][view plain]

1.  (gdb) p ccf->lock\_file   
2.  $6 = \{  
3.    len = 32,   
4.    data = 0x6ccebf "/usr/local/nginx/logs/nginx.lock"  
5.  \}

(5) 初始化ngx\_cycle->lock\_file

ngx\_cycle->lock\_file的初始化是复制ccf->lock\_file的内容并在其后链接".accept"。

(6) ngx\_cpymem与ngx\_memcpy

ngx\_cpymem(dst,src,n):将src内容拷贝n个到dst，且返回地址dst+n

ngx\_memcpy(dst,src,n):将src内容拷贝n个到dst

(7) 配置结构初始化后的内容

跟踪调试即可获得ngx\_core\_module这个CORE模块的配置结构，如下。

**\[plain\]** [ view plain][view plain] [copy][view plain]

1.  (gdb) p \*ccf  
2.  $12 = \{  
3.    daemon = 1,   
4.    master = 1,   
5.    timer\_resolution = 0,   
6.    worker\_processes = 1,   
7.    debug\_points = 0,   
8.    rlimit\_nofile = -1,   
9.    rlimit\_sigpending = -1,   
10.   rlimit\_core = -1,   
11.   priority = 0,   
12.   cpu\_affinity\_n = 0,   
13.   cpu\_affinity = 0x0,   
14.   username = 0x47280e "nobody",   
15.   user = 99,   
16.   group = 99,   
17.   working\_directory = \{  
18.     len = 0,   
19.     data = 0x0  
20.   \},   
21.   lock\_file = \{  
22.     len = 32,   
23.     data = 0x6ccebf "/usr/local/nginx/logs/nginx.lock"  
24.   \},   
25.   pid = \{  
26.     len = 31,   
27.     data = 0x6cce78 "/usr/local/nginx/logs/nginx.pid"  
28.   \},   
29.   oldpid = \{  
30.     len = 39,   
31.     data = 0x6cce98 "/usr/local/nginx/logs/nginx.pid.oldbin"  
32.   \},   
33.   env = \{  
34.     elts = 0x6b12a0,   
35.     nelts = 0,   
36.     size = 16,   
37.     nalloc = 1,   
38.     pool = 0x6b0280  
39.   \},   
40.   environment = 0x0  
41. \}

#### 4. 小结 ####

本文主要分析core模块的callback，后文继续分析配置文件解析等。

阅读、分析优秀的开源代码，一定要亲自操刀运行、调试，才能深刻理解调用路径，数据流向。当然笔者还没有开始分析nginx的核心功能代码，我想那将是非常享受的代码之旅。

**Reference**

\# man getpwnam

\# man getgrnam

[http_blog.csdn.net_livelylittlefish_article_details_7262750]: http://blog.csdn.net/livelylittlefish/article/details/7262750
[nginx_ngx_cycle]: http://blog.csdn.net/livelylittlefish/article/details/7247080
[view plain]: http://blog.csdn.net/livelylittlefish/article/details/7262750#