nginx内存池管理

发表于 更新于 分类于 阅读次数：
Nginx中的内存管理是通过内存池来实现的，nginx的内存池设计得非常巧妙，在我们的日常开发过程中，非常值得借鉴。

数据结构

定义

  • ngx_pool_s——内存池管理结构
1
2
3
4
5
6
7
8
9
struct ngx_pool_s {
    ngx_pool_data_t       d;         // 用于小内存分配的data域
    size_t                max;       // pool上单个节点的最大容量(不是可用容量)
    ngx_pool_t           *current;   // 指向当前pool用于内存分配的pool节点
    ngx_chain_t          *chain;
    ngx_pool_large_t     *large;     // 链表,保存开辟的大内存空间
    ngx_pool_cleanup_t   *cleanup;   // 需要回收的内存链表
    ngx_log_t            *log;
};
  • ngx_pool_data_t——管理用于内存分配的数据域
1
2
3
4
5
6
typedef struct {
    u_char               *last;       // 内存池下一次分配的起始地址
    u_char               *end;        // 内存池的结束地址
    ngx_pool_t           *next;       // 下一个内存池节点
    ngx_uint_t            failed;     // 分配内存失败的次数
} ngx_pool_data_t;
  • ngx_pool_large_s——大内存块
1
2
3
4
struct ngx_pool_large_s {
    ngx_pool_large_t     *next;
    void                 *alloc;      // 保存开辟的大内存块
};
  • ngx_pool_cleanup_s——自定义内存回收的结构
1
2
3
4
5
6
7
8
struct ngx_pool_cleanup_s {
    ngx_pool_cleanup_pt   handler;    // 用于回收内存的处理函数
    void                 *data;       // 待回收的内存
    ngx_pool_cleanup_t   *next;
};

// 进行自定义内存回收处理的回调函数
typedef void (*ngx_pool_cleanup_pt)(void *data);
  • ngx_pool_cleanup_file_t——进行文件清理的结构
1
2
3
4
5
typedef struct {
    ngx_fd_t              fd;	
    u_char               *name;
    ngx_log_t            *log;
} ngx_pool_cleanup_file_t;

图解

image-20220207132533893

分配流程

  • nginx中进行内存分配的流程大致如下

具体实现

接口函数

内存池操作

1
2
3
4
5
6
7
8
// 创建单个节点大小为size的内存池
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);

内存操作

1
2
3
4
5
6
7
8
9
10
11
12
13
14
// 通过内存池进行内存分配，并进行内存对齐
void *ngx_palloc(ngx_pool_t *pool, size_t size);

// 通过内存池进行内存分配，不进行内存对齐
void *ngx_pnalloc(ngx_pool_t *pool, size_t size);

// 通过内存池进行内存分配，进行内存对齐，并且将内存区域初始化为0
void *ngx_pcalloc(ngx_pool_t *pool, size_t size);

// 直接开辟size大小内存，并将该内存块保存在large链上
void *ngx_pmemalign(ngx_pool_t *pool, size_t size, size_t alignment);

// 内存释放，但是只会释放保存在large链上的大内存块，并且不会释放链表节点
ngx_int_t ngx_pfree(ngx_pool_t *pool, void *p);

特殊操作

1
2
3
4
5
6
7
8
9
10
11
12
13
14
// 在cleanup 链上添加一个节点并返回
ngx_pool_cleanup_t *ngx_pool_cleanup_add(ngx_pool_t *p, size_t size);

// 清理cleanup链上指定的fd
void ngx_pool_run_cleanup_file(ngx_pool_t *p, ngx_fd_t fd);


// 文件清理的处理函数
// 该函数作为cleanup链上的handler
void ngx_pool_cleanup_file(void *data);

// 通过内存池的cleanup链删除文件，以及清理文件描述符
// 该函数作为cleanup链上的handler
void ngx_pool_delete_file(void *data);

源码解析

内存池操作

ngx_create_pool

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
ngx_pool_t *
ngx_create_pool(size_t size, ngx_log_t *log)
{
    ngx_pool_t  *p;

    // 开辟 size 大小的内存(通过malloc实现)
    p = ngx_memalign(NGX_POOL_ALIGNMENT, size, log);
    if (p == NULL) {
        return NULL;
    }

    // 内存区域的首部预留  sizeof(ngx_pool_t) 的大小
    // 作为内存管理结构的内存空间
    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 最大只能为 pagesize -1 的大小
    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;
}

ngx_destroy_pool

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
void
ngx_destroy_pool(ngx_pool_t *pool)
{
    ngx_pool_t          *p, *n;
    ngx_pool_large_t    *l;
    ngx_pool_cleanup_t  *c;

    // 处理cleanup链上的数据,通过handler进行处理释放
    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
     */
    // 打印large链上的节点和地址
    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

    // 释放large链上的大内存
    for (l = pool->large; l; l = l->next) {
        if (l->alloc) {
            ngx_free(l->alloc);
        }
    }

    // 释放pool链
    for (p = pool, n = pool->d.next; /* void */; p = n, n = n->d.next) {
        ngx_free(p);

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

ngx_destroy_pool

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
// 重置内存池为初始状态
void
ngx_reset_pool(ngx_pool_t *pool)
{
    ngx_pool_t        *p;
    ngx_pool_large_t  *l;

    // 释放large链上的大内存空间
    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;
    }

    // current链指向第一个节点
    pool->current = pool;
    pool->chain = NULL;
    pool->large = NULL;
}

内存操作

ngx_palloc

1
2
3
4
5
6
7
8
9
10
11
12
13
14
// 通过内存池分配内存，进行内存对齐
void *
ngx_palloc(ngx_pool_t *pool, size_t size)
{
#if !(NGX_DEBUG_PALLOC)
    // 如果请求的内存大小小于 pool->max, 则视为小内存,并且设置内存对齐
    if (size <= pool->max) {
        return ngx_palloc_small(pool, size, 1);
    }
#endif

    // 否则视为大内存
    return ngx_palloc_large(pool, size);
}

ngx_pnalloc

1
2
3
4
5
6
7
8
9
10
11
12
// 通过内存池分配内存，不进行内存对齐
void *
ngx_pnalloc(ngx_pool_t *pool, size_t size)
{
#if !(NGX_DEBUG_PALLOC)
    if (size <= pool->max) {
        return ngx_palloc_small(pool, size, 0);
    }
#endif

    return ngx_palloc_large(pool, size);
}

ngx_pcalloc

1
2
3
4
5
6
7
8
9
10
11
12
13
// 通过内存池进行内存分配，进行内存对齐，并且将内存区域初始化为0
void *
ngx_pcalloc(ngx_pool_t *pool, size_t size)
{
    void *p;

    p = ngx_palloc(pool, size);
    if (p) {
        ngx_memzero(p, size);
    }
    
    return p;
}

ngx_pmemalign

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
// 直接开辟size大小内存，并将该内存块保存在large链上
void *
ngx_pmemalign(ngx_pool_t *pool, size_t size, size_t alignment)
{
    void              *p;
    ngx_pool_large_t  *large;

    // 开辟 size 大小的内存空间
    p = ngx_memalign(alignment, size, pool->log);
    if (p == NULL) {
        return NULL;
    }

    // 在小空间池上分配 sizeof(ngx_pool_large_t) 大小的空间，用于保存上面开辟的空间
    large = ngx_palloc_small(pool, sizeof(ngx_pool_large_t), 1);
    if (large == NULL) {
        ngx_free(p);
        return NULL;
    }

    // 将开辟的空间保存在large链上
    large->alloc = p;
    large->next = pool->large;
    pool->large = large;

    return p;
}

ngx_palloc_small

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
// 分配小块内存
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;

    // 获取当前正在使用的内存池
    p = pool->current;

    do {
        m = p->d.last;

        // 指定了内存对齐的情况下，按照 NGX_ALIGNMENT 对齐，调整待分配的首地址
        if (align) {
            m = ngx_align_ptr(m, NGX_ALIGNMENT);
        }

        // 如果剩余空间充足，则调整last指针后，直接返回 m 的地址
        if ((size_t) (p->d.end - m) >= size) {
            p->d.last = m + size;

            return m;
        }

        // 当前节点的空间不足，则移动到下一节点继续以上操作
        p = p->d.next;

    } while (p);

    // 如果从current节点开始，遍历完所有的节点后，均不能找到合适的内存池进行空间分配，
    // 则通过以下方法，在操作系统重新开辟一个新的内存池，进行内存分配
    return ngx_palloc_block(pool, size);
}

ngx_palloc_block

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
// 内存不足时，开辟新的内存池节点
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);

    // 通过malloc开辟psize大小的内存空间， 即传入的pool的内存大小
    m = ngx_memalign(NGX_POOL_ALIGNMENT, psize, pool->log);
    if (m == NULL) {
        return NULL;
    }

    // 初始化新开辟的pool
    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_ALIGNMENT 进行地址对齐
    // m的地址将作为返回地址，故new->d.last =  m + size，即下一次分配的起始地址
    m = ngx_align_ptr(m, NGX_ALIGNMENT);
    new->d.last = m + size;

    // 从current开始，查找 p->d.next 为NULL的pool节点
    for (p = pool->current; p->d.next; p = p->d.next) {

        // 如果当前pool节点被查找失败的次数超过了4次(小内存分配失败次数超过4次)，
        // 则直接将current设置为当前节点的next节点
        // 此举是为了提升性能，不用每次都从第一个节点遍历到最后一个节点
        if (p->d.failed++ > 4) {
            pool->current = p->d.next;
        }
    }

    // 将新分配的节点添加到next链的尾巴上
    p->d.next = new;

    return m;
}

ngx_palloc_large

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
// 分配大内存区域
static void *
ngx_palloc_large(ngx_pool_t *pool, size_t size)
{
    void              *p;
    ngx_uint_t         n;
    ngx_pool_large_t  *large;

    // 通过malloc开辟size大小内存
    p = ngx_alloc(size, pool->log);
    if (p == NULL) {
        return NULL;
    }

    n = 0;

    // 将开辟后的内存保存在 pool->large 链上
    for (large = pool->large; large; large = large->next) {
        if (large->alloc == NULL) {
            large->alloc = p;
            return p;
        }

        // TODO: 为啥在链表上查找三个节点，没找到就break了
        if (n++ > 3) {
            break;
        }
    }

    // 在pool上分配一个 ngx_pool_large_t 的内存大小，用于保存开辟的大内存空间
    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;
}

ngx_pfree

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
//  进行内存释放，但是只会释放大内存块
ngx_int_t
ngx_pfree(ngx_pool_t *pool, void *p)
{
    ngx_pool_large_t  *l;

    // 查找待释放的内存地址是否在large链上
    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;
}

特殊操作

ngx_pool_cleanup_add

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
// 在cleanup 链上添加一个节点并返回
ngx_pool_cleanup_t *
ngx_pool_cleanup_add(ngx_pool_t *p, size_t size)
{
    ngx_pool_cleanup_t  *c;

    // 在内存池上分配一个 ngx_pool_cleanup_t 结构体
    c = ngx_palloc(p, sizeof(ngx_pool_cleanup_t));
    if (c == NULL) {
        return NULL;
    }

    // 如果指定的size大小不为0
    if (size) {
        // 通过内存池分配 size 大小的空间
        c->data = ngx_palloc(p, size);
        if (c->data == NULL) {
            return NULL;
        }

    } else {
        // 指定的size大小为0则，将data域设置为NULL
        c->data = NULL;
    }

    // 将新分配的结构体以前插的方式，放在cleanup链的首端
    c->handler = NULL;
    c->next = p->cleanup;

    p->cleanup = c;

    ngx_log_debug1(NGX_LOG_DEBUG_ALLOC, p->log, 0, "add cleanup: %p", c);

    // 返回分配的cleanup结构体地址
    return c;
}

ngx_pool_run_cleanup_file

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
// 执行pool中的文件清理工作
void
ngx_pool_run_cleanup_file(ngx_pool_t *p, ngx_fd_t fd)
{
    ngx_pool_cleanup_t       *c;
    ngx_pool_cleanup_file_t  *cf;

    // 遍历cleanup链
    for (c = p->cleanup; c; c = c->next) {
        // 找到出事函数为 ngx_pool_cleanup_file 的节点
        if (c->handler == ngx_pool_cleanup_file) {

            cf = c->data;

            // 如果当前节点的文件描述符是指定的fd
            if (cf->fd == fd) {
                // 执行清理操作
                c->handler(cf);
                c->handler = NULL;
                return;
            }
        }
    }
}

ngx_pool_cleanup_file

1
2
3
4
5
6
7
8
9
10
11
12
13
14
// 文件清理操作处理函数，关闭文件描述符
void
ngx_pool_cleanup_file(void *data)
{
    ngx_pool_cleanup_file_t  *c = data;

    ngx_log_debug1(NGX_LOG_DEBUG_ALLOC, c->log, 0, "file cleanup: fd:%d",
                   c->fd);

    if (ngx_close_file(c->fd) == NGX_FILE_ERROR) {
        ngx_log_error(NGX_LOG_ALERT, c->log, ngx_errno,
                      ngx_close_file_n " \"%s\" failed", c->name);
    }
}

ngx_pool_delete_file

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
// 通过内存池的cleanup链删除文件，以及清理文件描述符
void
ngx_pool_delete_file(void *data)
{
    ngx_pool_cleanup_file_t  *c = data;

    ngx_err_t  err;

    ngx_log_debug2(NGX_LOG_DEBUG_ALLOC, c->log, 0, "file cleanup: fd:%d %s",
                   c->fd, c->name);

    // 删除文件
    if (ngx_delete_file(c->name) == NGX_FILE_ERROR) {
        err = ngx_errno;

        if (err != NGX_ENOENT) {
            ngx_log_error(NGX_LOG_CRIT, c->log, err,
                          ngx_delete_file_n " \"%s\" failed", c->name);
        }
    }

    // 关闭文件描述符
    if (ngx_close_file(c->fd) == NGX_FILE_ERROR) {
        ngx_log_error(NGX_LOG_ALERT, c->log, ngx_errno,
                      ngx_close_file_n " \"%s\" failed", c->name);
    }
}

参考文献

  • https://blog.csdn.net/initphp/article/details/50588790