nginx之list

一、简介

nginx实现了一套基于内存池的list基础组件。主要涉及文件ngx_list.h, ngx_list.c。

和普通的list不同，nginx的list是数组+链表的形式。

二、数据结构

typedef struct ngx_list_part_s  ngx_list_part_t;

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;

ngx_list_t:

• last指向最后一个节点（数组首地址），也是插入数据的节点
• part第一个节点（第一个数组信息）
• size每个元素的最大大小
• nalloc 每一个节点中元素的个数（一个数组中元素个数），初始化时决定的，不会改变
• pool使用的内存池

ngx_list_part_t:

• elts 数组首地址
• nelts 数组中已有的元素个数
• next 构成一个链表

2.1 逻辑结构图

2.2 实际内存结构图

三、相关API

3.1 创建list

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

    list = ngx_palloc(pool, sizeof(ngx_list_t));
    if (list == NULL) {
        return NULL;
    }

    if (ngx_list_init(list, pool, n, size) != NGX_OK) {
        return NULL;
    }

    return list;
}

static ngx_inline ngx_int_t
ngx_list_init(ngx_list_t *list, ngx_pool_t *pool, ngx_uint_t n, size_t size)
{
    list->part.elts = ngx_palloc(pool, n * size);
    if (list->part.elts == NULL) {
        return NGX_ERROR;
    }

    list->part.nelts = 0;
    list->part.next = NULL;
    list->last = &list->part;
    list->size = size;
    list->nalloc = n;
    list->pool = pool;

    return NGX_OK;
}

3.2 插入数据

void *
ngx_list_push(ngx_list_t *l)
{
    void             *elt;
    ngx_list_part_t  *last;

    last = l->last;

    if (last->nelts == l->nalloc) {

        /* the last part is full, allocate a new list part */

        last = ngx_palloc(l->pool, sizeof(ngx_list_part_t));
        if (last == NULL) {
            return NULL;
        }

        last->elts = ngx_palloc(l->pool, l->nalloc * l->size);
        if (last->elts == NULL) {
            return NULL;
        }

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

这个插入API和nginx_array类型的数组一样，只是返回了插入数据的地址，并没有填入数据，需要调用方来填数据。

当一个节点中的数组已经填满时，将从内存池中新分配一个节点（数组），然后挂在last后面，然后last指向新节点。

3.3 总结

整个nginx中更多的还是定义一个ngx_list_t结构体，然后调用ngx_list_init进行初始化的方式进行使用。并且size是一个结构体的大小，即节点中数组的元素是特定的一个结构体类型。

比如：

struct ngx_cycle_s {
   ...
    ngx_list_t                open_files;
    ngx_list_t                shared_memory;
   ...
};

if (ngx_list_init(&cycle->open_files, pool, n, sizeof(ngx_open_file_t))
    != NGX_OK)
{
    ngx_destroy_pool(pool);
    return NULL;
}

nginx使用数组+链表的形式（有点类似redis的quicklist），即保留了数组的优点也解决了数组扩容导致的数据拷贝问题。