Nginx 内存池源码解析

内存池是一种节省内存的技术方案，Nginx 实现的内存池代码精炼且实用，值得我们深入学习，一探究竟。

Nginx 使用内存池主要有以下原因：

• 内存管理

  Nginx 通过直接申请一整块内存的方式，来代替开发者主动去堆中申请内存块，开发者主动从堆中申请内存，所以申请的内存可以用内存池统一释放。这样的好处是开发者无需对自己申请的每一块内存都释放，可以由一个地方统一释放，这样能解决大部分的内存泄露问题。

• 内存碎片

  如果手动从堆中分配内存，且如果分配了大量的小内存块，则有内存碎片的情况。

• 频繁系统调用

  多次手动分配内存，会使得调用 brk 或者 mmap 多次的系统调用，频繁陷入内核。

数据结构

typedef ngx_pool_t ngx_pool_s;

struct ngx_pool_s {
    ngx_pool_data_t       d;
    size_t                max;
    ngx_pool_t           *current;
    ngx_chain_t          *chain;
    ngx_pool_large_t     *large;
    ngx_pool_cleanup_t   *cleanup;
    ngx_log_t            *log;
};

ngx_pool_t 是内存池的主体部分。

• d：小块内存分配区域，每次会申请一整块内存；
• max：该阈值用来判断内存块是属于大内存还是小内存；
• current：指向待分配的内存池；
• chain：作为链表节点，ngx_chain_t 结构；
• large：大块内存链表，分配空间超过 max 的会在这里分配；
• cleanup：析构函数链表，会在内存池销毁的时候依次调用；
• log：日志模块；

ngx_pool_data_t：

typedef struct {
    u_char 		*last;
    u_char 		*end;
    ngx_pool_t 	*next;
    ngx_uint_t 	failed;
} ngx_pool_data_t;

• last：指向当前内存池已分配部分的末位地址，即下一次分配从此处开始。
• end：内存池结束位置；
• next：内存池是一个链表结构，指向下一个内存池；
• failed：内存池分配失败次数。

内存池基本操作

创建内存池 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);

创建内存池

ngx_create_pool 接受 size 参数来决定每块内存池的大小

ngx_pool_t *
ngx_create_pool(size_t size, ngx_log_t *log)
{
    ngx_pool_t  *p;

    // 申请 16 字节对齐内存
    p = ngx_memalign(NGX_POOL_ALIGNMENT, size, log);
    if (p == NULL) {
        return NULL;
    }

    // 初始化数据部分
    p->d.last = (u_char *) p + sizeof(ngx_pool_t);
    p->d.end = (u_char *) p + size;
    p->d.next = NULL;
    p->d.failed = 0;

    // 大小为除去内存池头的大小
    size = size - sizeof(ngx_pool_t);
    p->max = (size < NGX_MAX_ALLOC_FROM_POOL) ? size : NGX_MAX_ALLOC_FROM_POOL;

    p->current = p;
    p->chain = NULL;
    p->large = NULL;
    p->cleanup = NULL;
    p->log = log;

    return p;
}

nginx对内存的管理分为大内存与小内存，当某一个申请的内存大于某一个值时，就需要从大内存中分配空间，否则从小内存中分配空间。

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

内存申请

void *
ngx_palloc(ngx_pool_t *pool, size_t size)
{
#if !(NGX_DEBUG_PALLOC)
    if (size <= pool->max) {
        return ngx_palloc_small(pool, size, 1);
    }
#endif
    return ngx_palloc_large(pool, size);
}

这里很明显能看出来大小块内存是通过 max 值确定的。

小块内存分配

static ngx_inline void *
ngx_palloc_small(ngx_pool_t *pool, size_t size, ngx_uint_t align)
{
    u_char      *m;
    ngx_pool_t  *p;

    // 每次都从 current 内存池开始
    p = pool->current;

    do {
        m = p->d.last;

        if (align) {
            m = ngx_align_ptr(m, NGX_ALIGNMENT);
        }

        // 剩下的部分是否足够分配
        if ((size_t) (p->d.end - m) >= size) {
            p->d.last = m + size;
			// 分配成功
            return m;
        }
		// 下一内存池
        p = p->d.next;

    } while (p);
	
    // 现有内存池不够分配 size 大小内存，需要新创建一块内存池
    return ngx_palloc_block(pool, size);
}

这里需要说明的几点：

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

#define ngx_align_ptr(p, a)                                                   \
    (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大小的内存；

static void *
ngx_palloc_block(ngx_pool_t *pool, size_t size)
{
    u_char      *m;
    size_t       psize;
    ngx_pool_t  *p, *new;

    psize = (size_t) (pool->d.end - (u_char *) pool);

    // 新分配一块内存
    m = ngx_memalign(NGX_POOL_ALIGNMENT, psize, pool->log);
    if (m == NULL) {
        return NULL;
    }

    new = (ngx_pool_t *) m;

    new->d.end = m + psize;
    new->d.next = NULL;
    new->d.failed = 0;

    m += sizeof(ngx_pool_data_t);
    m = ngx_align_ptr(m, NGX_ALIGNMENT);
    new->d.last = m + size;

    // 调整 current 指针，每块内存池有４次机会重试
    for (p = pool->current; p->d.next; p = p->d.next) {
        if (p->d.failed++ > 4) {
            pool->current = p->d.next;
        }
    }

    p->d.next = new;

    return m;
}

3. ngx_palloc_large(ngx_pool_t *pool, size_t size)

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

   需要注意大块内存的头需要在内存池中分配；

static void *
ngx_palloc_large(ngx_pool_t *pool, size_t size)
{
    void              *p;
    ngx_uint_t         n;
    ngx_pool_large_t  *large;

    // 分配大块内存
    p = ngx_alloc(size, pool->log);
    if (p == NULL) {
        return NULL;
    }

    n = 0;

    // 查找大块链表空闲的位置
    for (large = pool->large; large; large = large->next) {
        if (large->alloc == NULL) {
            large->alloc = p;
            return p;
        }

        // 前三个没有空闲直接退出
        if (n++ > 3) {
            break;
        }
    }

    // 大块内存头在小块内存池分配
    large = ngx_palloc_small(pool, sizeof(ngx_pool_large_t), 1);
    if (large == NULL) {
        ngx_free(p);
        return NULL;
    }

    // 头插法
    large->alloc = p;
    large->next = pool->large;
    pool->large = large;

    return p;
}

内存池重置

void
ngx_reset_pool(ngx_pool_t *pool)
{
    ngx_pool_t        *p;
    ngx_pool_large_t  *l;
	// 释放所有大块内存
    for (l = pool->large; l; l = l->next) {
        if (l->alloc) {
            ngx_free(l->alloc);
        }
    }
	// 重置所有小块内存，并不释放
    for (p = pool; p; p = p->d.next) {
        p->d.last = (u_char *) p + sizeof(ngx_pool_t);
        p->d.failed = 0;
    }

    pool->current = pool;
    pool->chain = NULL;
    pool->large = NULL;
}

内存池清理

ngx_int_t
ngx_pfree(ngx_pool_t *pool, void *p)
{
    ngx_pool_large_t  *l;
    //只释放大块内存
    for (l = pool->large; l; l = l->next) {
        if (p == l->alloc) {
            ngx_log_debug1(NGX_LOG_DEBUG_ALLOC, pool->log, 0,
                     "free: %p", l->alloc);
            ngx_free(l->alloc);
            l->alloc = NULL;

            return NGX_OK;
        }
    }  
    // 释放失败
    return NGX_DECLINED;
}

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

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

struct ngx_pool_cleanup_s {
	ngx_pool_cleanup_pt handler;
	void *data;
	ngx_pool_cleanup_t *next;
};

• handler：是回调函数指针；
• data：回调时，将此数据传入回调函数；
• next：指向下一个回调函数结构体；

我们也可以利用内存池的 cleanup 挂载我们的析构函数，使内存池销毁时调用。

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

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

内存池销毁

ngx_destroy_pool 用于销毁指定内存池，真正释放内存池中的所有内存。

void
ngx_destroy_pool(ngx_pool_t *pool)
{
    ngx_pool_t          *p, *n;
    ngx_pool_large_t    *l;
    ngx_pool_cleanup_t  *c;

    // 调用所有 cleanup 函数
    for (c = pool->cleanup; c; c = c->next) {
        if (c->handler) {
            ngx_log_debug1(NGX_LOG_DEBUG_ALLOC, pool->log, 0,
                           "run cleanup: %p", c);
            c->handler(c->data);
        }
    }

#if (NGX_DEBUG)

    /*
     * we could allocate the pool->log from this pool
     * so we cannot use this log while free()ing the pool
     */

    for (l = pool->large; l; l = l->next) {
        ngx_log_debug1(NGX_LOG_DEBUG_ALLOC, pool->log, 0, "free: %p", l->alloc);
    }

    for (p = pool, n = pool->d.next; /* void */; p = n, n = n->d.next) {
        ngx_log_debug2(NGX_LOG_DEBUG_ALLOC, pool->log, 0,
                       "free: %p, unused: %uz", p, p->d.end - p->d.last);

        if (n == NULL) {
            break;
        }
    }

#endif

    // 释放所有大内存块
    for (l = pool->large; l; l = l->next) {
        if (l->alloc) {
            ngx_free(l->alloc);
        }
    }

    // 释放所有小内存块
    for (p = pool, n = pool->d.next; /* void */; p = n, n = n->d.next) {
        ngx_free(p);

        if (n == NULL) {
            break;
        }
    }
}