nginx代码分析-基本结构-动态数组ngx_array_t

2019独角兽企业重金招聘Python工程师标准>>>

作用	函数名
创建初始长度为n的动态数组, 数组元素大小为size	ngx_array_t * ngx_array_create(ngx_pool_t *p, ngx_uint_t n, size_t size)
释放动态数组空间	void ngx_array_destroy(ngx_array_t *a)
在动态数组中取1个未分配元素空间返回	void * ngx_array_push(ngx_array_t *a)
在动态数组中取n个未分配元素空间返回	void * ngx_array_push_n(ngx_array_t *a, ngx_uint_t n)

一. 数据结构

typedef struct {
    void        *elts;  //  实际数据
    ngx_uint_t   nelts; //  elts指向的空间已分配元素数
    size_t       size;  //  elts指向的空间数据大小
    ngx_uint_t   nalloc; // elts指向的空间可存储最多元素数
    ngx_pool_t  *pool;   // 数据所在的内存池
} ngx_array_t;

动态数组头中void指针elts指向实际数据区, 因此遍历取元素时需要参考size来取数据, nelts为实际有效数据个数.

二. 数组创建, 删除

ngx_array_t *
ngx_array_create(ngx_pool_t *p, ngx_uint_t n, size_t size)
{
    ngx_array_t *a;
    // 创建ngx_array_t数组头
    a = ngx_palloc(p, sizeof(ngx_array_t));
    if (a == NULL) {
        return NULL;
    }

    if (ngx_array_init(a, p, n, size) != NGX_OK) { // 初始化数组, n个size大小的空间
        return NULL;
    }

    return a;
}


void
ngx_array_destroy(ngx_array_t *a)
{
    ngx_pool_t  *p;

    p = a->pool;  // 获取array所在内存池

    if ((u_char *) a->elts + a->size * a->nalloc == p->d.last) {
        p->d.last -= a->size * a->nalloc; // pool的已分配后半部分为数组数据, lazy release
    }

    if ((u_char *) a + sizeof(ngx_array_t) == p->d.last) {
        p->d.last = (u_char *) a;   //lazy release 数组头空间
    }
}

static ngx_inline ngx_int_t
ngx_array_init(ngx_array_t *array, ngx_pool_t *pool, ngx_uint_t n, size_t size)
{  // 初始化创建的ngx_array_t结构
    /*
     * set "array->nelts" before "array->elts", otherwise MSVC thinks
     * that "array->nelts" may be used without having been initialized
     */

    array->nelts = 0;
    array->size = size;
    array->nalloc = n; 
    array->pool = pool;

    array->elts = ngx_palloc(pool, n * size); // 分配n个size大小的空间
    if (array->elts == NULL) {
        return NGX_ERROR;
    }

    return NGX_OK;
}

动态数组的创建很方便, ngx_array_create创建一个初始长度为n的动态数组空间.

个人比较疑问的是ngx_array_destroy的作用,看作者思路是如果array在pool的末尾则释放, 因为pool的剩余空间是由p.d->last和p.d->end决定的, 释放空间也只是移动last指针 (lazy release), 如果待释放对象末尾不是last显然没有办法释放, 只有等整个内存池pool销毁时才能释放. 但pool中可以有多个节点, palloc时并不确定是分配在pool的哪个节点上, 是否销毁时应该遍历查找一下? 此外如果n*size > 4095, 会分配在pool的大内存区域, 这样的释放方式是否还有意义?

三. 数组元素操作

void *
ngx_array_push(ngx_array_t *a)
{
    void        *elt, *new;
    size_t       size;
    ngx_pool_t  *p;

    if (a->nelts == a->nalloc) {

        /* the array is full */

        size = a->size * a->nalloc; // 已使用空间大小

        p = a->pool;

        if ((u_char *) a->elts + size == p->d.last
            && p->d.last + a->size <= p->d.end)
        {
            /*
             * the array allocation is the last in the pool
             * and there is space for new allocation
             */

            p->d.last += a->size; // 直接在数组末尾(pool中)分配一个元素大小的空间
            a->nalloc++;

        } else {
            /* allocate a new array */

            new = ngx_palloc(p, 2 * size); // 分配原始2倍空间大小
            if (new == NULL) {
                return NULL;
            }

            ngx_memcpy(new, a->elts, size); // 旧的空间不释放,拷贝数据
            a->elts = new;                 //  指向新的数据空间
            a->nalloc *= 2;
        }
    }

    elt = (u_char *) a->elts + a->size * a->nelts;
    a->nelts++;

    return elt;
}

void * ngx_array_push_n(ngx_array_t *a, ngx_uint_t n)
//连续获得array的n个元素空间

需要在数组中分配1个(n个)元素时, 调用ngx_array_push(ngx_array_push_n), 返回该数据的其实地址. 发现代码中大部分动态数组初始化时nalloc为1,2,4, 因此ngx_array_push多次调用, 原始空间是不够用的, 此外内存池单个节点最大空间为4095, 扩容并重新拷贝数据的情况时而发生(自己猜测, 没有实证), 数组太长了就分配到大内存large区域去了. 每次扩容(分配2倍空间并拷贝数据), 会损失掉原始的内存空间. 对于一个当前长度为n的数组, 浪费的空间上限是n-1 (n/2+n/4+n/8+…+1)

粗看这个结构的用法应该很局限, 适用于(待证实) 总空间可能较小的分配请求. 具体这个结构的应用场景与使用特点, 在之后看其他代码和模块时再补充修改…

转载于:https://my.oschina.net/chenzhuo/blog/175937