nginx源码学习----内存池

转自：http://www.cnblogs.com/xiekeli/archive/2012/10/17/2727432.html

本人的理解：内存管理的主要目的是（1）减少内存碎片；（2）减少缺页中断次数；（3）减少内存泄露。

第一篇

Nginx的内存池实现得很精巧，代码也很简洁。总的来说，所有的内存池基本都一个宗旨：申请大块内存，避免“细水长流”。

一、创建一个内存池

nginx内存池主要有下面两个结构来维护，他们分别维护了内存池的头部和数据部。此处数据部就是供用户分配小块内存的地方。

//该结构用来维护内存池的数据块，供用户分配之用。 typedef struct { u_char *last; //当前内存分配结束位置，即下一段可分配内存的起始位置 u_char *end; //内存池结束位置 ngx_pool_t *next; //链接到下一个内存池 ngx_uint_t failed; //统计该内存池不能满足分配请求的次数 } ngx_pool_data_t; //该结构维护整个内存池的头部信息。 struct ngx_pool_s { ngx_pool_data_t d; //数据块 size_t max;	 //数据块的大小，即小块内存的最大值 ngx_pool_t *current;	//保存当前内存池 ngx_chain_t *chain;	//可以挂一个chain结构 ngx_pool_large_t *large;	//分配大块内存用，即超过max的内存请求 ngx_pool_cleanup_t *cleanup;	//挂载一些内存池释放的时候，同时释放的资源。 ngx_log_t *log; }; 

有了上面的两个结构，就可以创建一个内存池了，nginx用来创建一个内存池的接口是：ngx_pool_t *ngx_create_pool(size_t size, ngx_log_t *log)（位于src/core/ngx_palloc.c中）;调用这个函数就可以创建一个大小为size的内存池了。这里，我用内存池的结构图来展示，就不做具体的代码分析了。

ngx_create_pool接口函数就是分配上图这样的一大块内存，然后初始化好各个头部字段（上图中的彩色部分）。红色表示的四个字段就是来自于上述的第一个结构，维护数据部分，由图可知：last是用户从内存池分配新内存的开始位置，end是这块内存池的结束位置，所有分配的内存都不能超过end。蓝色表示的max字段的值等于整个数据部分的长度，用户请求的内存大于max时，就认为用户请求的是一个大内存，此时需要在紫色表示的large字段下面单独分配；用户请求的内存不大于max的话，就是小内存申请，直接在数据部分分配，此时将会移动last指针。

二、分配小块内存(size <= max)

上面创建好了一个可用的内存池了，也提到了小块内存的分配问题。nginx提供给用户使用的内存分配接口有：
void *ngx_palloc(ngx_pool_t *pool, size_t size);
void *ngx_pnalloc(ngx_pool_t *pool, size_t size);
void *ngx_pcalloc(ngx_pool_t *pool, size_t size);
void *ngx_pmemalign(ngx_pool_t *pool, size_t size, size_t alignment);

ngx_palloc和ngx_pnalloc都是从内存池里分配size大小内存，至于分得的是小块内存还是大块内存，将取决于size的大小；他们的不同之处在于，palloc取得的内存是对齐的，pnalloc则否。ngx_pcalloc是直接调用palloc分配好内存，然后进行一次0初始化操作。ngx_pmemalign将在分配size大小的内存并按alignment对齐，然后挂到large字段下，当做大块内存处理。下面用图形展示一下分配小块内存的模型：

上图这个内存池模型是由上3个小内存池构成的，由于第一个内存池上剩余的内存不够分配了，于是就创建了第二个新的内存池，第三个内存池是由于前面两个内存池的剩余部分都不够分配，所以创建了第三个内存池来满足用户的需求。由图可见：所有的小内存池是由一个单向链表维护在一起的。这里还有两个字段需要关注，failed和current字段。failed表示的是当前这个内存池的剩余可用内存不能满足用户分配请求的次数，即是说：一个分配请求到来后，在这个内存池上分配不到想要的内存，那么就failed就会增加1；这个分配请求将会递交给下一个内存池去处理，如果下一个内存池也不能满足，那么它的failed也会加1，然后将请求继续往下传递，直到满足请求为止（如果没有现成的内存池来满足，会再创建一个新的内存池）。current字段会随着failed的增加而发生改变，如果current指向的内存池的failed达到了4的话，current就指向下一个内存池了。猜测：4这个值应该是作者的经验值，或者是一个统计值。

三、大块内存的分配(size > max)

大块内存的分配请求不会直接在内存池上分配内存来满足，而是直接向操作系统申请这么一块内存（就像直接使用malloc分配内存一样），然后将这块内存挂到内存池头部的large字段下。内存池的作用在于解决小块内存池的频繁申请问题，对于这种大块内存，是可以忍受直接申请的。同样，用图形展示大块内存申请模型：

注意每块大内存都对应有一个头部结构（next&alloc），这个头部结构是用来将所有大内存串成一个链表用的。这个头部结构不是直接向操作系统申请的，而是当做小块内存（头部结构没几个字节）直接在内存池里申请的。这样的大块内存在使用完后，可能需要第一时间释放，节省内存空间，因此nginx提供了接口函数：ngx_int_t ngx_pfree(ngx_pool_t *pool, void *p)；此函数专门用来释放某个内存池上的某个大块内存，p就是大内存的地址。ngx_pfree只会释放大内存，不会释放其对应的头部结构，毕竟头部结构是当做小内存在内存池里申请的；遗留下来的头部结构会作下一次申请大内存之用。

四、cleanup资源

可以看到所有挂载在内存池上的资源将形成一个循环链表，一路走来，发现链表这种看似简单的数据结构却被频繁使用。由图可知，每个需要清理的资源都对应有一个头部结构，这个结构中有一个关键的字段handler，handler是一个函数指针，在挂载一个资源到内存池上的时候，同时也会注册一个清理资源的函数到这个handler上。即是说，内存池在清理cleanup的时候，就是调用这个handler来清理对应的资源。比如：我们可以将一个开打的文件描述符作为资源挂载到内存池上，同时提供一个关闭文件描述的函数注册到handler上，那么内存池在释放的时候，就会调用我们提供的关闭文件函数来处理文件描述符资源了。

五、内存的释放

nginx只提供给了用户申请内存的接口，却没有释放内存的接口，那么nginx是如何完成内存释放的呢？总不能一直申请，用不释放啊。针对这个问题，nginx利用了web server应用的特殊场景来完成；一个web server总是不停的接受connection和request，所以nginx就将内存池分了不同的等级，有进程级的内存池、connection级的内存池、request级的内存池。也就是说，创建好一个worker进程的时候，同时为这个worker进程创建一个内存池，待有新的连接到来后，就在worker进程的内存池上为该连接创建起一个内存池；连接上到来一个request后，又在连接的内存池上为request创建起一个内存池。这样，在request被处理完后，就会释放request的整个内存池，连接断开后，就会释放连接的内存池。因而，就保证了内存有分配也有释放。

总结：通过内存的分配和释放可以看出，nginx只是将小块内存的申请聚集到一起申请，然后一起释放。避免了频繁申请小内存，降低内存碎片的产生等问题

第二篇

最近在进行监控平台的设计，之前一直觉得C/C++中最棘手的部分是内存的管理上，远不止new/delete、malloc/free这么简单。随着代码量的递增，程序结构复杂度的提高。各种内存方面的问题悄然滋生。而且作为平台，后期的插件扩展在所难免。长时间运行的采集平台的特性更是提出了对稳定性的高要求。不是c#、java，没有虚拟机为你管理内存，一切都要靠自己。于是想看看nginx、python、lua这些C的经典之作在内存管理这块“要地”又是如何处理的。

先来看看nginx吧，因为网上都说nginx的内存池设计的非常精巧：

1、基本结构

先来学习一下nginx内存池的几个主要数据结构：[见：./src/core/ngx_palloc.h/.c]

    ngx_pool_data_t（内存池数据块结构）

   1: typedef struct {

   2:     u_char *last;

   3:     u_char *end;

   4:     ngx_pool_t *next;

   5:     ngx_uint_t failed;

   6: } ngx_pool_data_t;

 

ngx_pool_s（内存池头部结构）

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

可以说，ngx_pool_data_t和ngx_pool_s基本构成了nginx内存池的主体结构，下面详细介绍一下nginx内存池的主体结构：

如上图，nginx的内存池实际是一个由ngx_pool_data_t和ngx_pool_s构成的链表，其中：

ngx_pool_data_t中：

last：是一个unsigned char 类型的指针，保存的是/当前内存池分配到末位地址，即下一次分配从此处开始。

end：内存池结束位置；

next：内存池里面有很多块内存，这些内存块就是通过该指针连成链表的，next指向下一块内存。

failed：内存池分配失败次数。

 

ngx_pool_s

d：内存池的数据块；

max：内存池数据块的最大值；

current：指向当前内存池；

chain：该指针挂接一个ngx_chain_t结构；

large：大块内存链表，即分配空间超过max的情况使用；

cleanup：释放内存池的callback

log：日志信息

 

以上是内存池涉及的主要数据结构，为了尽量简化，其他涉及的数据结构将在下面实际用到时候再做介绍。

 

2、内存池基本操作

内存池对外的主要方法有：

创建内存池	ngx_pool_t *  ngx_create_pool(size_t size, ngx_log_t *log);
销毁内存池	void ngx_destroy_pool(ngx_pool_t *pool);
重置内存池	void ngx_reset_pool(ngx_pool_t *pool);
内存申请（对齐）	void *  ngx_palloc(ngx_pool_t *pool, size_t size);
内存申请（不对齐）	void *  ngx_pnalloc(ngx_pool_t *pool, size_t size);
内存清除	ngx_int_t  ngx_pfree(ngx_pool_t *pool, void *p);

注：

在分析内存池方法前，需要对几个主要的内存相关函数作一下介绍（见：./src/Os/Unix（Win32）/ngx_alloc.h/.c）

这里仅对Win32的作介绍：

ngx_alloc：（只是对malloc进行了简单的封装）

   1: void *ngx_alloc(size_t size, ngx_log_t *log) {

   3:     void  *p;

   4:  

   5:     p = malloc(size);

   6:     if (p == NULL) {

   7:         ngx_log_error(NGX_LOG_EMERG, log, ngx_errno, "malloc(%uz) failed", size);

   9:     }

  10:  

  11:     ngx_log_debug2(NGX_LOG_DEBUG_ALLOC, log, 0, "malloc: %p:%uz", p, size);

  12:  

  13:     return p;

  14: }

ngx_calloc：（调用malloc并初始化为0）

   1: void *ngx_calloc(size_t size, ngx_log_t *log) {

   3:     void  *p;

   4:  

   5:     p = ngx_alloc(size, log);

   7:     if (p) {

   8:         ngx_memzero(p, size);

   9:     }

  10:  

  11:     return p;

  12: }

ngx_memzero：

   1: #define ngx_memzero(buf, n)       (void) memset(buf, 0, n)

ngx_free ：

   1: #define ngx_free          free

ngx_memalign：

   1: #define ngx_memalign(alignment, size, log)  ngx_alloc(size, log)

这里alignment主要是针对部分unix平台需要动态的对齐，对POSIX 1003.1d提供的posix_memalign( )进行封装，在大多数情况下，编译器和C库透明地帮你处理对齐问题。nginx中通过宏NGX_HAVE_POSIX_MEMALIGN来控制；

2.1、内存池创建（ngx_create_pool）

ngx_create_pool用于创建一个内存池，我们创建时，传入我们的初始大小：

   1: ngx_pool_t *ngx_create_pool(size_t size, ngx_log_t *log) {

   4:     ngx_pool_t *p;

   5:  

   6:     p = ngx_memalign(NGX_POOL_ALIGNMENT, size, log);

   7:     if (p == NULL) {

   8:         return NULL;

   9:     }

  11:     p->d.last = (u_char *) p + sizeof(ngx_pool_t);//初始状态：last指向ngx_pool_t结构体之后数据取起始位置

  12:     p->d.end = (u_char *) p + size;//end指向分配的整个size大小的内存的末尾

  13:     p->d.next = NULL;

  14:     p->d.failed = 0;

  15:     //#define NGX_MAX_ALLOC_FROM_POOL  (ngx_pagesize - 1)

  16:     //内存池最大不超过4095，x86中页的大小为4K

  17:     size = size - sizeof(ngx_pool_t);

  18:     p->max = (size < NGX_MAX_ALLOC_FROM_POOL) ? size : NGX_MAX_ALLOC_FROM_POOL;

  19:  

  20:     p->current = p;

  21:     p->chain = NULL;

  22:     p->large = NULL;

  23:     p->cleanup = NULL;

  24:     p->log = log;

  25:  

  26:     return p;

  27: }

nginx对内存的管理分为大内存与小内存，当某一个申请的内存大于某一个值时，就需要从大内存中分配空间，否则从小内存中分配空间。 
nginx中的内存池是在创建的时候就设定好了大小，在以后分配小块内存的时候，如果内存不够，则是重新创建一块内存串到内存池中，而不是将原有的内存池进行扩张。当要分配大块内存是，则是在内存池外面再分配空间进行管理的，称为大块内存池。

2.2、内存申请

ngx_palloc

   1: void *ngx_palloc(ngx_pool_t *pool, size_t size) {

   4:     u_char *m;

   5:     ngx_pool_t *p;

   6:  

   7:     if (size <= pool->max) {//如果申请的内存大小大于内存池的max值，则走另一条路，申请大内存

   9:         p = pool->current;

  10:  

  11:         do {

  12:             m = ngx_align_ptr(p->d.last, NGX_ALIGNMENT);//对内存地址进行对齐处理

  13:  

  14:             if ((size_t) (p->d.end - m) >= size) {//如果在当前内存块有效范围内，进行内存指针的移动

  15:                 p->d.last = m + size;

  17:                 return m;

  18:             }

  19:  

  20:             p = p->d.next;//如果当前内存块有效容量不够分配，则移动到下一个内存块进行分配

  21:  

  22:         } while (p);

  23:  

  24:         return ngx_palloc_block(pool, size);

  25:     }

  26:  

  27:     return ngx_palloc_large(pool, size);

  28: }

这里需要说明的几点：

1、ngx_align_ptr，这是一个用来内存地址取整的宏，非常精巧，一句话就搞定了。作用不言而喻，取整可以降低CPU读取内存的次数，提高性能。因为这里并没有真正意义调用malloc等函数申请内存，而是移动指针标记而已，所以内存对齐的活，C编译器帮不了你了，得自己动手。

   1: #define ngx_align_ptr(p, a) \

   2:     (u_char *) (((uintptr_t) (p) + ((uintptr_t) a - 1)) & ~((uintptr_t) a - 1))

 

2、ngx_palloc_block(ngx_pool_t *pool, size_t size)

这个函数是用来分配新的内存块，为pool内存池开辟一个新的内存块，并申请使用size大小的内存；

   1: static void *ngx_palloc_block(ngx_pool_t *pool, size_t size) {

   4:     u_char *m;

   5:     size_t psize;

   6:     ngx_pool_t *p, *new, *current;

   7:  

   8:     psize = (size_t)(pool->d.end - (u_char *)pool);//计算内存池第一个内存块的大小

   9:  

  10:     m = ngx_memalign(NGX_POOL_ALIGNMENT, psize, pool->log);//分配和第一个内存块同样大小的内存块

  11:     if (m == NULL) {

  12:         return NULL;

  13:     }

  14:  

  15:     new = (ngx_pool_t *)m;

  16:  

  17:     new->d.end = m + psize;//设置新内存块的end

  18:     new->d.next = NULL;

  19:     new->d.failed = 0;

  20:  

  21:     m += sizeof(ngx_pool_data_t);//将指针m移动到d后面的一个位置，作为起始位置

  22:     m = ngx_align_ptr(m, NGX_ALIGNMENT);//对m指针按4字节对齐处理

  23:     new->d.last = m + size;//设置新内存块的last，即申请使用size大小的内存

  24:  

  25:     current = pool->current;

  26:     //这里的循环用来找最后一个链表节点，这里failed用来控制循环的长度，如果分配失败次数达到5次，

  27:      //就忽略，不需要每次都从头找起

  28:     for (p = current; p->d.next; p = p->d.next) {

  29:         if (p->d.failed++ > 4) {

  30:             current = p->d.next;

  31:         }

  32:     }

  33:  

  34:     p->d.next = new;

  35:  

  36:     pool->current = current ? current : new;

  37:  

  38:     return m;

  39: }

3、ngx_palloc_large(ngx_pool_t *pool, size_t size)

在ngx_palloc中首先会判断申请的内存大小是否超过内存块的最大限值，如果超过，则直接调用ngx_palloc_large，进入大内存块的分配流程；

   1: static void *ngx_palloc_large(ngx_pool_t *pool, size_t size) {

   4:     void *p;

   5:     ngx_uint_t n;

   6:     ngx_pool_large_t *large;

   7:     // 直接在系统堆中分配一块空间  

   8:     p = ngx_alloc(size, pool->log);

   9:     if (p == NULL) {

  10:         return NULL;

  11:     }

  12:  

  13:     n = 0;

  14:     // 查找到一个空的large区，如果有，则将刚才分配的空间交由它管理  

  15:     for (large = pool->large; large; large = large->next) {

  16:         if (large->alloc == NULL) {

  17:             large->alloc = p;

  18:             return p;

  19:         }

  20:  

  21:         if (n++ > 3) {

  22:             break;

  23:         }

  24:     }

  25:     //为了提高效率， 如果在三次内没有找到空的large结构体，则创建一个

  26:     large = ngx_palloc(pool, sizeof(ngx_pool_large_t));

  27:     if (large == NULL) {

  28:         ngx_free(p);

  29:         return NULL;

  30:     }

  31:  

  32:     large->alloc = p;

  33:     large->next = pool->large;

  34:     pool->large = large;

  35:  

  36:     return p;

  37: }

2.3、内存池重置

ngx_reset_pool

   1: void ngx_reset_pool(ngx_pool_t *pool) {

   4:     ngx_pool_t *p;

   5:     ngx_pool_large_t *l;

   6:     //释放所有大块内存

   7:     for (l = pool->large; l; l = l->next) {

   8:         if (l->alloc) {

   9:             ngx_free(l->alloc);

  10:         }

  11:     }

  12:  

  13:     pool->large = NULL;

  14:     // 重置所有小块内存区  

  15:     for (p = pool; p; p = p->d.next) {

  16:         p->d.last = (u_char *) p + sizeof(ngx_pool_t);

  17:     }

  18: }

2.4、内存池清理

ngx_pfree

   1: ngx_int_t ngx_pfree(ngx_pool_t *pool, void *p) {

   4:     ngx_pool_large_t  *l;

   5:     //只检查是否是大内存块，如果是大内存块则释放

   6:     for (l = pool->large; l; l = l->next) {

   7:         if (p == l->alloc) {

   8:             ngx_log_debug1(NGX_LOG_DEBUG_ALLOC, pool->log, 0,

   9:                            "free: %p", l->alloc);

  10:             ngx_free(l->alloc);

  11:             l->alloc = NULL;

  12:  

  13:             return NGX_OK;

  14:         }

  15:     }

  16:  

  17:     return NGX_DECLINED;

  18: }

所以说Nginx内存池中大内存块和小内存块的分配与释放是不一样的。我们在使用内存池时，可以使用ngx_palloc进行分配，使用ngx_pfree释放。而对于大内存，这样做是没有问题的，而对于小内存就不一样了，分配的小内存，不会进行释放。因为大内存块的分配只对前3个内存块进行检查，否则就直接分配内存，所以大内存块的释放必须及时。

 

ngx_pool_cleanup_s

Nginx内存池支持通过回调函数，对外部资源的清理。ngx_pool_cleanup_t是回调函数结构体，它在内存池中以链表形式保存，在内存池进行销毁时，循环调用这些回调函数对数据进行清理。

   1: struct ngx_pool_cleanup_s {

   2:     ngx_pool_cleanup_pt handler;

   3:     void *data;

   4:     ngx_pool_cleanup_t *next;

   5: };

其中

handler：是回调函数指针；

data：回调时，将此数据传入回调函数；

next：//指向下一个回调函数结构体；

如果我们需要添加自己的回调函数，则需要调用ngx_pool_cleanup_add来得到一个ngx_pool_cleanup_t，然后设置handler为我们的清理函数，并设置data为我们要清理的数据。这样在ngx_destroy_pool中会循环调用handler清理数据；

比如：我们可以将一个开打的文件描述符作为资源挂载到内存池上，同时提供一个关闭文件描述的函数注册到handler上，那么内存池在释放的时候，就会调用我们提供的关闭文件函数来处理文件描述符资源了。

2.5、内存池销毁

ngx_destroy_pool

ngx_destroy_pool这个函数用于销毁一个内存池：

  
   1: void ngx_destroy_pool(ngx_pool_t *pool) {
   4:     ngx_pool_t *p, *n;
   5:     ngx_pool_large_t *l;
   6:     ngx_pool_cleanup_t *c;
   7:  
   8:     //首先调用所有的数据清理函数
   9:     for (c = pool->cleanup; c; c = c->next) {
  10:         if (c->handler) {
  11:             ngx_log_debug1(NGX_LOG_DEBUG_ALLOC, pool->log, 0, "run cleanup: %p", c);
  13:             c->handler(c->data);
  14:         }
  15:     }
  16:  
  17:     //释放所有的大块内存
  18:     for (l = pool->large; l; l = l->next) {
  20:         ngx_log_debug1(NGX_LOG_DEBUG_ALLOC, pool->log, 0, "free: %p", l->alloc);
  22:         if (l->alloc) {
  23:             ngx_free(l->alloc);
  24:         }
  25:     }
  26:  
  27:     //最后释放所有内存池中的内存块
  28:     for (p = pool, n = pool->d.next; /* void */; p = n, n = n->d.next) {
  29:         ngx_free(p);
  31:         if (n == NULL) {
  32:             break;
  33:         }
  34:     }
  35: }