Nginx学习笔记---ngx_list_t数据结构

struct ngx_list_part_s {
    /* 指向数组的起始地址 */
    void            *elts;
    /* 表示数组中已经使用了多少个元素。nelts必须小于ngx_list_t结构体中的nalloc */
    ngx_uint_t       nelts;
    /* 下一个链表元素ngx_list_part_t的地址 */
    ngx_list_part_t *next;
}
typedef struct {
    /* 链表的首个数组元素 */
    ngx_list_part_t *last;
    /* 指向链表的最后一个数组元素 */
    ngx_list_part_t  part;
    /* 每个数组元素占用的空间大小，也就是用户要存储的一个数据所占用的字节数必须小于或等于size */
    size_t           size;
    /* 每个ngx_list_part_t数组的容量，即最多可存储多少个数据，链表的数组元素一旦分配后是不可更改的 */
    ngx_uint_t       nalloc;
    /* 链表中管理内存分配的内存池对象 */
    ngx_pool_t      *pool;
} ngx_list_t;

ngx_list_t是描述整个链表，ngx_list_part_t只描述链表的一个元素。ngx_list_t不是一个单纯的链表，而为存储数组的链表。也就是说每个链表元素ngx_list_part_t又是一个数组，拥有连续的内存，它既依赖于ngx_list_t里的size和nalloc来表示数组的容量，同时又依靠每个ngx_list_part_t成员中的nelts来表示数组当前已使用了多少容量。因此，ngx_list_t是一个链表容器，而链表中的元素又是一个数组，事实上，ngx_list_part_t数组中的元素才是用户想要存储的东西，ngx_list_t链表能够容纳的元素数量由ngx_list_part_t数组元素的个数与每个数组所能容纳的元素相乘得到。

ngx_list_t的内存分布：

上图由3个ngx_list_part_t数组元素组成的ngx_list_t链表可能拥有的一种内存分布结构，pool内存池为其分配了连续的内存，最前端内存存储的是ngx_list_t结构中的成员，紧接着是第一个ngx_list_part_t结构占用的内存，然后是ngx_list_part_t结构指向的数组，它们一共占用size * nalloc字节，表示数组中拥有nalloc个大小为size的元素。其后是第2个ngx_list_part_t结构以及它所指向的数组，依次类推。

一些接口函数：

/*

* 用于创建新的链表，pool参数是内存池对象，size是每个元素的大小，n是每个链表数组可容纳元素的个数

* ngx_list_create返回新创建的链表地址，如果创建失败，则返回NULL空指针。

* ngx_list_create被调用后至少会创建一个数组（不会创建空链表）

* 其中包含n个大小为size字节的连续内存块，也就是ngx_list_t结构中的part成员

*/

ngx_list_t *ngx_list_create(ngx_pool_t *pool, ngx_uint_t n, size_t size);

/* 用于初始化一个已有的链表,使用方法与ngx_list_create类似 */

static ngx_inline ngx_int_t

ngx_list_init(ngx_list_t *list, ngx_pool_t *pool, ngx_uint_t n, size_t size);

/*

* 用于添加新的元素，正常情况下，返回的是新分配的元素首地址。如果返回NULL空指针，则表示添加失败。

* 在使用它时通常先调用ngx_list_push得到返回的元素地址，再对返回的地址进行赋值。

*/

void *ngx_list_push(ngx_list_t *list);

样例代码：

ngx_list_t *testlist = ngx_list_creare(r->pool, 4, sizeof(ngx_str_t));
if (testlist == NULL) {
    return NGX_ERROR;
}

ngx_str_t *str = ngx_list_push(testlist);
if (str == NULL) {
    return NGX_ERROR;
}
str->len = sizeof("hello world");
str->value = "hello world";