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（內存池數據塊結構）

typedef struct {
    u_char               *last;
    u_char               *end;
    ngx_pool_t           *next;
    ngx_uint_t            failed;
} ngx_pool_data_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_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進行了簡單的封裝）

void *ngx_alloc(size_t size, ngx_log_t *log)
{
    void  *p;

    p = malloc(size);
    if (p == NULL) {
        ngx_log_error(NGX_LOG_EMERG, log, ngx_errno,
                      "malloc(%uz) failed", size);
    }

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

    return p;
}

ngx_calloc：（調用malloc並初始化為0）

void *ngx_calloc(size_t size, ngx_log_t *log)
{
    void  *p;

    p = ngx_alloc(size, log);

    if (p) {
        ngx_memzero(p, size);
    }

    return p;
}

ngx_memzero：

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

ngx_free ：

#define ngx_free          free

ngx_memalign：

#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用於創建一個內存池，我們創建時，傳入我們的初始大小：

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指向ngx_pool_t結構體之后數據取起始位置
    p->d.end = (u_char *) p + size;//end指向分配的整個size大小的內存的末尾
    p->d.next = NULL;
    p->d.failed = 0;
    //#define NGX_MAX_ALLOC_FROM_POOL  (ngx_pagesize - 1)
    //內存池最大不超過4095，x86中頁的大小為4K
    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中的內存池是在創建的時候就設定好了大小，在以后分配小塊內存的時候，如果內存不夠，則是重新創建一塊內存串到內存池中，而不是將原有的內存池進行擴張。當要分配大塊內存是，則是在內存池外面再分配空間進行管理的，稱為大塊內存池。

2.2、內存申請

ngx_palloc

void *
ngx_palloc(ngx_pool_t *pool, size_t size)
{
    u_char      *m;
    ngx_pool_t  *p;

    if (size <= pool->max) {//如果申請的內存大小大於內存池的max值，則走另一條路，申請大內存

        p = pool->current;

        do {
            m = ngx_align_ptr(p->d.last, 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);
    }

    return ngx_palloc_large(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, *current;

    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;//設置新內存塊的end
    new->d.next = NULL;
    new->d.failed = 0;

    m += sizeof(ngx_pool_data_t);//將指針m移動到d后面的一個位置，作為起始位置
    m = ngx_align_ptr(m, NGX_ALIGNMENT);//對m指針按4字節對齊處理
    new->d.last = m + size;//設置新內存塊的last，即申請使用size大小的內存

    current = pool->current;
    //這里的循環用來找最后一個鏈表節點，這里failed用來控制循環的長度，如果分配失敗次數達到5次，
     //就忽略，不需要每次都從頭找起
    for (p = current; p->d.next; p = p->d.next) {
        if (p->d.failed++ > 4) {
            current = p->d.next;
        }
    }

    p->d.next = new;

    pool->current = current ? current : 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;
    // 查找到一個空的large區，如果有，則將剛才分配的空間交由它管理
    for (large = pool->large; large; large = large->next) {
        if (large->alloc == NULL) {
            large->alloc = p;
            return p;
        }

        if (n++ > 3) {
            break;
        }
    }
    //為了提高效率， 如果在三次內沒有找到空的large結構體，則創建一個
    large = ngx_palloc(pool, sizeof(ngx_pool_large_t));
    if (large == NULL) {
        ngx_free(p);
        return NULL;
    }

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

    return p;
}

2.3、內存池重置

ngx_reset_pool

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

    pool->large = NULL;
    // 重置所有小塊內存區
    for (p = pool; p; p = p->d.next) {
        p->d.last = (u_char *) p + sizeof(ngx_pool_t);
    }
}

2.4、內存池清理

ngx_pfree

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個內存塊進行檢查，否則就直接分配內存，所以大內存塊的釋放必須及時。

 

ngx_pool_cleanup_s

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：//指向下一個回調函數結構體；

如果我們需要添加自己的回調函數，則需要調用ngx_pool_cleanup_add來得到一個ngx_pool_cleanup_t，然后設置handler為我們的清理函數，並設置data為我們要清理的數據。這樣在ngx_destroy_pool中會循環調用handler清理數據；

比如：我們可以將一個開打的文件描述符作為資源掛載到內存池上，同時提供一個關閉文件描述的函數注冊到handler上，那么內存池在釋放的時候，就會調用我們提供的關閉文件函數來處理文件描述符資源了。

2.5、內存池銷毀

ngx_destroy_pool

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;

    //首先調用所有的數據清理函數
    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);
        }
    }

    //釋放所有的大塊內存
    for (l = pool->large; l; l = l->next) {

        ngx_log_debug1(NGX_LOG_DEBUG_ALLOC, pool->log, 0, "free: %p", l->alloc);

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