现在的位置: 首页 > 综合 > 正文

nginx源码

2018年04月12日 ⁄ 综合 ⁄ 共 6019字 ⁄ 字号 评论关闭
Nginx基本数据结构概览
来自于:服务端架构设计 作者:杭建 2014-08-26
21:10

引言

nginx实现中有很多结构体,一般命名为ngx_xxx_t。这些结构体分散在许多头文件中。src/core/ngx_core.h中把几乎所有的头文件都集合起来。也因此造成了nginx各部分源代码的耦合。但实际上nginx各个部分逻辑划分还是很明确的,整体上是一种松散的结构。

作者之所以重复造了这些轮子,无非是为了追求高效。查看这些数据结构的源码,的确是设计的比较精巧,也保证了对内存足够小的占用以及各种操作的高效。

数据结构

nginx实现中有很多结构体,一般命名为ngx_XXX_t。这些结构体分散在许多头文件中。src/core/ngx_core.h中把几乎所有的头文件都集合起来。也因此造成了nginx各部分源代码的耦合。但实际上nginx各个部分逻辑划分还是很明确的,整体上是一种松散的结构。

  • ngx_str_t

C代码  收藏代码
  1. typedef struct{  
  2.     size_t len;  
  3.     u_char *data;  
  4. }ngx_str_t;  

这是nginx对字符串的实现,源码在ngx_string.h中。len指的是字符串的长度(不包括\0),data指向字符串。这种设计一方面,在计算字符创长度时只需要读取len字段即可,另一方面可以重复引用一段字符串内存。

常用api:

C代码  收藏代码
  1. #define ngx_string(str) { sizof(str) - 1},(u_char *) str } //从一个普通字符串构造出一个nginx字符串,用sizeof计算长度,故参数必须是一个常量字符串。  
  2.   
  3. #define ngx_null_string {0,NULL}  
  4.   
  5. ngx_strncmp(s1,s2,n)  
  6.   
  7. ngx_strcm(s1,s2)  
  • ngx_pool_t

C代码  收藏代码
  1. struct ngx_pool_s {  
  2.       ngx_pool_data_t       d;  
  3.       size_t                max;  
  4.       ngx_pool_t           *current;  
  5.       ngx_chain_t          *chain;  
  6.       ngx_pool_large_t     *large;  
  7.       ngx_pool_cleanup_t   *cleanup;  
  8.       ngx_log_t            *log;  
  9.   };  

这个数据结构在nginx中是一个非常重要的数据结构。用来管理一系列的资源(如内存、文件等 ,使得对这些资源的使用和释放统一进行。这个是在c语言编程中值得借鉴的一个东西,代码中如果到处都是malloc和free的话,不仅会导致内存泄露,也会使代码难以阅读和维护。

  • ngx_array_t

C代码  收藏代码
  1.  struct ngx_array_s {  
  2.       void        *elts; //指向实际的存储区域  
  3.       ngx_uint_t   nelts; //数组实际元素个数  
  4.       size_t       size; //数组单个元素的大小,单位是字节  
  5.       ngx_uint_t   nalloc; //数组的容量  
  6.       ngx_pool_t  *pool; //该数组用来分配内存的内存池  
  7. };  
  • ngx_hash_t

    • ngx_hash_t不像其他的hash表的实现,可以插入删除元素,只能一次初始化。
    • 解决冲突使用的是开链法,但实际上是开了一段连续的存储空间,和数组差不多。 

C代码  收藏代码
  1. ngx_int_t ngx_hash_init(ngx_hash_init_t hinit, ngx_hash_key_t names,ngx_uint_t nelts);//ngx_hash_t的初始化,ngx_hash_init_t提供了初始化一个hash表所需要的一些基本信息  
  2.   
  3. typedef struct {  
  4.     ngx_hash_t       *hash; //指向hash表  
  5.     ngx_hash_key_pt   key; //指向从字符串生成hash值的hash函数。默认的实现为ngx_hash_key_lc  
  6.     ngx_uint_t        max_size; //hash表中的桶的个数  
  7.     ngx_uint_t        bucket_size; //每个桶的最大限制大小,单位是字节  
  8.     char             *name; //hash表的名字  
  9.     ngx_pool_t       *pool; //hash表分配内存使用的pool  
  10.     ngx_pool_t       *temp_pool; //使用的临时pool,初始化完成后,可以释放和销毁  
  11. } ngx_hash_init_t;  
  12.   
  13. typedef struct {                  
  14.     ngx_str_t         key;                
  15.     ngx_uint_t        key_hash;               
  16.     void             *value;              
  17. } ngx_hash_key_t;  
  18.   
  19. id *ngx_hash_find(ngx_hash_t *hash, ngx_uint_t key, u_char *name, size_t len); //在hash里面查找key对应的value。  
  • ngx_chain_t

nginx的filter模块在处理从别的filter模块或者是handler模块传递过来的数据,数据一个链表的形式(ngx_chain_t)进行传递。

C代码  收藏代码
  1. struct ngx_chain_s {  
  2.     ngx_buf_t    *buf;  
  3.     ngx_chain_t  *next;  
  4. };  

创建ngx_chain_t对象

C代码  收藏代码
  1. ngx_chain_t *ngx_alloc_chain_link(ngx_pool_t *pool);  

释放一个ngx_chain_t类型的对象。如果要释放整个chain,则迭代此链表,对每个节点使用此宏即可。

C代码  收藏代码
  1. #define ngx_free_chain(pool, cl)                                             \  
  2.     cl->next = pool->chain;                                                  \  
  3. pool->chain = cl  

对ngx_chaint_t类型的释放,并不是真的释放了内存,而仅仅是把这个对象挂在了这个pool对象的一个叫做chain的字段对应的chain上,以供下次从这个pool上分配ngx_chain_t类型对象的时候,快速的从这个pool->chain上取下链首元素就返回了,当然,如果这个链是空的,才会真的在这个pool上使用ngx_palloc函数进行分配。

  • ngx_buf_t

ngx_buf_t是ngx_chain_t的数据结点

C代码  收藏代码
  1. struct ngx_buf_s {  
  2.         u_char          *pos;  
  3.         u_char          *last;  
  4.         off_t            file_pos;  
  5.         off_t            file_last;  
  6.   
  7.         u_char          *start;         /* start of buffer */  
  8.         u_char          *end;           /* end of buffer */  
  9.         ngx_buf_tag_t    tag;  
  10.         ngx_file_t      *file;  
  11.         ngx_buf_t       *shadow;  
  12.   
  13.   
  14.         /* the buf's content could be changed */  
  15.         unsigned         temporary:1;  
  16.   
  17.         /* 
  18.         * the buf's content is in a memory cache or in a read only memory 
  19.         * and must not be changed 
  20.         */  
  21.         unsigned         memory:1;  
  22.   
  23.         /* the buf's content is mmap()ed and must not be changed */  
  24.         unsigned         mmap:1;  
  25.   
  26.         unsigned         recycled:1;  
  27.         unsigned         in_file:1;  
  28.         unsigned         flush:1;  
  29.         unsigned         sync:1;  
  30.         unsigned         last_buf:1;  
  31.         unsigned         last_in_chain:1;  
  32.   
  33.         unsigned         last_shadow:1;  
  34.         unsigned         temp_file:1;  
  35.   
  36.         /* STUB */ int   num;  
  37. };  
  • ngx_list_t

和普通的链表实现相比,它的节点是一个固定大小的数组。在初始化的时候,我们需要设定元素需要占用的空间大小,每个节点数组的容量大小。在添加元素到这个list里面的时候,会在最尾部的节点里的数组上添加元素,如果这个节点的数组存满了,就再增加一个新的节点到这个list里面去。

C代码  收藏代码
  1. typedef struct {  
  2.         ngx_list_part_t  *last; //指向该链表的最后一个节点  
  3.         ngx_list_part_t   part; //指向该链表首个存放具体元素的节点  
  4.         size_t            size; //链表中存放的具体元素所需内存大小  
  5.         ngx_uint_t        nalloc; //每个节点所含的固定大小的数组的容量  
  6.         ngx_pool_t       *pool; //该list使用的分配内存的pool  
  7.     } ngx_list_t;  
  8.   
  9.     struct ngx_list_part_s {  
  10.         void             *elts; //节点中存放具体元素的内存的开始地址     
  11.         ngx_uint_t        nelts; //节点中已有元素个数,不能大于 nalloc  
  12.         ngx_list_part_t  *next; //指向下一个节点  
  13.     };  
  14.   
  15.     ngx_list_t *ngx_list_create(ngx_pool_t *pool, ngx_uint_t n, size_t size); //创建一个ngx_list_t类型的对象,并对该list的第一个节点分配存放元素的内存空间。  
  16.   
  17.     pool:   分配内存使用的pool。  
  18.     n:  每个节点固定长度的数组的长度。  
  19.     size:   存放的具体元素的个数。  
  • ngx_queue_t

C代码  收藏代码
  1. struct ngx_queue_s {  
  2.       ngx_queue_t  *prev;  
  3.       ngx_queue_t  *next;  
  4. };  

 

链表节点的数据成员并没有生命在链表节点的结构体中,只是声明了前向和后向指针。使用的时候需要定义一个哨兵节点。具体存放数据的节点称之为数据节点。对于数据节点,需要在数据结构体中加入一个类型为ngx_queue_s的域。使用下面的函数进行数据插入,其中x为数据节点的queue_t域。

C代码  收藏代码
  1. #define ngx_queue_insert_head(h, x)                         \  
  2.     (x)->next = (h)->next;                                  \  
  3.     (x)->next->prev = x;                                    \  
  4.     (x)->prev = h;                                          \  
  5.     (h)->next = x  
  6.   
  7. #define ngx_queue_insert_after   ngx_queue_insert_head  
  8.   
  9. #define ngx_queue_insert_tail(h, x)                          \  
  10.     (x)->prev = (h)->prev;                                   \  
  11.     (x)->prev->next = x;                                     \  
  12.     (x)->next = h;                                           \  
  13.     (h)->prev = x  
  14. 获得数据时,使用ngx_queue_data()宏。  
  15. #define ngx_queue_data(q, type, link)                        \  
  16.     (type *) ((u_char *) q - offsetof(type, link))  
【上篇】
【下篇】

抱歉!评论已关闭.