内存池源码剖析

static ngx_inline void *ngx_palloc_small(ngx_pool_t *pool, size_t size,
    ngx_uint_t align);
static void *ngx_palloc_block(ngx_pool_t *pool, size_t size);
static void *ngx_palloc_large(ngx_pool_t *pool, 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);//last指向的是第一个内存块的头信息尾部
    p->d.end = (u_char *) p + size;//end指向的是第一个内存块的尾部
    p->d.next = NULL;//因为没有第二个内存块，所以为空
    p->d.failed = 0;//初始化为0，内存块分配失败的次数

    //以上信息是每一个内存块都含有的信息

    size = size - sizeof(ngx_pool_t);//能分配出去的内存
    p->max = (size < NGX_MAX_ALLOC_FROM_POOL) ? size : NGX_MAX_ALLOC_FROM_POOL;

    //大块内存和小块内存的分界线是max

    p->current = p;//指向能分配内存的第一个内存块
    p->chain = NULL;//这个暂时不用考虑
    p->large = NULL;//大块内存
    p->cleanup = NULL;//用来清理外部资源
    p->log = log;//不用考虑,就是一个日志

    return p;
}

//销毁内存池
void
ngx_destroy_pool(ngx_pool_t *pool)
{
    ngx_pool_t          *p, *n;
    ngx_pool_large_t    *l;
    ngx_pool_cleanup_t  *c;

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

重置内存池
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;//由于设计的目的，小块内存不用释放，只用改变last的位置
    }

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

向内存池申请内存
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);
}

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

小块内存申请
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;

        if (align) {
            m = ngx_align_ptr(m, NGX_ALIGNMENT);//内存对齐，使得m成为 NGX_ALIGNMENT的最小倍数
        }

        if ((size_t) (p->d.end - m) >= size) {
            p->d.last = m + size;//如果当前内存块够分配的话

            return m;
        }

        p = p->d.next;//当前内存块不够分配，就指向下一个内存块

    } while (p);

    return ngx_palloc_block(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);//因为除了第一个内存块外其他内存块都只有一个data的头部信息
    m = ngx_align_ptr(m, NGX_ALIGNMENT);
    new->d.last = m + size;

    for (p = pool->current; p->d.next; p = p->d.next) {//从current指向的内存块开始遍历每一个内存块
        if (p->d.failed++ > 4) {//因为没有一个内存块能分配出内存，所以失败次数都+1
            pool->current = p->d.next;//如果失败次数大于4，就将current指向当前内存块的下一个
        }                                                 //以后分配内存就不会从这个失败次数多的开始分配了
    }

    p->d.next = new;//链接新内存块

    return m;
}

大块内存分配
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);//大块内存实际上是用malloc来分配的，这个函数就是malloc来实现
    if (p == NULL) {
        return NULL;
    }

    n = 0;

    for (large = pool->large; large; large = large->next) {//找一个空闲的large块
        if (large->alloc == NULL) {//alloc就是指向的分配的大块内存
            large->alloc = p;
            return p;
        }

        if (n++ > 3) {//如果3次都没找到空闲的large块，就创建一个
            break;
        }
    }

    large = ngx_palloc_small(pool, sizeof(ngx_pool_large_t), 1);//用的是内存池的小块内存来分配large块
    if (large == NULL) {
        ngx_free(p);
        return NULL;
    }

    large->alloc = p;
    large->next = pool->large;
    pool->large = large;

    return p;
}

void *
ngx_pmemalign(ngx_pool_t *pool, size_t size, size_t alignment)
{//有内存对齐的分配大块内存
    void              *p;
    ngx_pool_large_t  *large;

    p = ngx_memalign(alignment, size, pool->log);
    if (p == NULL) {
        return NULL;
    }

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

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

//需要自己写一个释放外部资源的函数（回调函数），参数就是data指向的外部资源地址
ngx_pool_cleanup_t *
ngx_pool_cleanup_add(ngx_pool_t *p, size_t size)//size代表外部资源的大小
{
    ngx_pool_cleanup_t  *c;

    c = ngx_palloc(p, sizeof(ngx_pool_cleanup_t));//分配清理块头信息
    if (c == NULL) {
        return NULL;
    }

    if (size) {               //分配外部资源
        c->data = ngx_palloc(p, size);data保存外部资源地址
        if (c->data == NULL) {
            return NULL;
        }

    } else {
        c->data = NULL;
    }

    c->handler = NULL;//handler指向回调函数
    c->next = p->cleanup;

    p->cleanup = c;

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

    return c;
}