9.Nginx数据结构之链表List

上一篇我们学习了Nginx的数组结构，这一篇学习链表结构List，链表和数组最大的不同在于，数组元素是存放在一块连续内存空间内的，链表则没有这个限制，链表的各个元素或者节点的存放是随机零散的。这两种结构的特性导致了它们各自的优缺点，我们需要根据应用场景进行灵活选择:

1.数组是顺序存储的，那么我们可以通过下标快速访问数组中任何元素, 也就是随机访问效率低; 但是我们在做插入和删除元素的操作时，需要对其他元素进行移动，效率低；

2.链表是随机存储的，只能顺序访问链表元素；但是插入和删除元素时，只需要修改指针即可，效率高

/* ngx_list.h */
typedef struct ngx_list_part_s  ngx_list_part_t;

/* 从下面的链表节点的定义, 我们可以发现Nginx链表节点的数据区其实是一个数组 */
struct ngx_list_part_s {          // 链表节点结构体
    void             *elts;       // 该节点数据区的首地址
    ngx_uint_t        nelts;      // 数据区已存放的元素个数
    ngx_list_part_t  *next;       // 指向下一个链表节点
};


typedef struct {                  // 链表结构体
    ngx_list_part_t  *last;       // 链表的尾节点指针
    ngx_list_part_t   part;       // 链表的头节点
    size_t            size;       // 存放元素的字节大小
    ngx_uint_t        nalloc;     // 每个链表节点的数据区的容量(即可以存放元素的个数)
    ngx_pool_t       *pool;       // 存放链表的内存池指针
} ngx_list_t;

/* 链表初始化
   param list: 待初始化的链表指针
         pool: 存放链表的内存池指针
           n: 链表节点的数据区的容量
        size: 存放元素的字节大小
*/
ngx_inline static ngx_int_t ngx_list_init(ngx_list_t *list, ngx_pool_t *pool,
                                          ngx_uint_t n, size_t size)
{
    // 在内存池中为链表part节点分配数据区, 数据区大小为 数据区容量 * 元素的字节大小
    if (!(list->part.elts = ngx_palloc(pool, n * size))) {
        return NGX_ERROR;
    }

    list->part.nelts = 0;       // 链表part节点的数据区的已存放元素个数为0
    list->part.next = NULL;     // 链表part节点的下一个节点为空
    list->last = &list->part;   // 链表part节点也就是尾节点
    list->size = size;          // 链表存放的元素字节大小为size
    list->nalloc = n;           // 链表节点的数据区的容量为n
    list->pool = pool;          // 存放链表的内存池指针为pool

    return NGX_OK;
}


/* ngx_list.c */

/* 链表插入元素
   param l: 待插入元素的链表指针
*/
void *ngx_list_push(ngx_list_t *l)
{
    void             *elt;
    ngx_list_part_t  *last;

    last = l->last;

    if (last->nelts == l->nalloc) {
        // 如果尾节点的已存放元素个数等于链表节点的元素容量, 那么说明链表节点的数据区已满,
        // 那么这个时候就应该考虑扩充链表节点了

        // 先从内存池申请存放新链表节点的内存空间
        if (!(last = ngx_palloc(l->pool, sizeof(ngx_list_part_t)))) {
            return NULL;
        }

        // 再从内存池为新链表节点申请数据区的内存空间
        if (!(last->elts = ngx_palloc(l->pool, l->nalloc * l->size))) {
            return NULL;
        }

        // 新链表节点的已存放元素个数为0, 下一个链表节点为空
        last->nelts = 0;
        last->next = NULL;

        // 新链表节点成为新的尾节点
        l->last->next = last;
        l->last = last;
    }

    // 在尾节点的数据区为元素分配内存空间
    elt = (char *) last->elts + l->size * last->nelts;
    last->nelts++;

    return elt;
}