Nginx内存池（一）——类型和重要函数定义

相关宏定义

// 从池中可获得的最大内存数为4095，即一个页面的大小
#define NGX_MAX_ALLOC_FROM_POOL  (ngx_pagesize - 1)

#define NGX_DEFAULT_POOL_SIZE    (16 * 1024)

// 按16B对齐
#define NGX_POOL_ALIGNMENT       16
// ngx_align就是和SGI STL二级空间配置器的 _S_round_up函数相同，对齐到NGX_POOL_ALIGNMENT
#define NGX_MIN_POOL_SIZE                                                     \
    ngx_align((sizeof(ngx_pool_t) + 2 * sizeof(ngx_pool_large_t)),            \
              NGX_POOL_ALIGNMENT)

类型定义

// 内存池结构体定义
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;
};

// 大块内存类型定义
typedef struct ngx_pool_large_s  ngx_pool_large_t;

struct ngx_pool_large_s {
    ngx_pool_large_t     *next;
    void                 *alloc;
};

// 小块内存类型定义
typedef struct {
    u_char               *last;
    u_char               *end;
    ngx_pool_t           *next; // 指向下一个内存池（管理小块内存）
    ngx_uint_t            failed;
} ngx_pool_data_t;


// 清理操作的类型定义：
typedef void (*ngx_pool_cleanup_pt)(void *data);

typedef struct ngx_pool_cleanup_s  ngx_pool_cleanup_t;

struct ngx_pool_cleanup_s {
    ngx_pool_cleanup_pt   handler; // 自定义的资源释放函数
    void                 *data; // handler的参数
    ngx_pool_cleanup_t   *next; // 指向下一个清理操作（对象）
};

重要函数

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); // 内存分配，不支持内存对齐
void *ngx_pcalloc(ngx_pool_t *pool, size_t size); // 内存分配，支持内存初始化为0
ngx_int_t ngx_pfree(ngx_pool_t *pool, void *p); // 内存释放

// 内存池清理操作
ngx_pool_cleanup_t *ngx_pool_cleanup_add(ngx_pool_t *p, size_t size);

创建内存池剖析

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

    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);
    // 设置小块内存可分配的最大字节数，不超过一个页面即4095
    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;
}