菜鸟学习Nginx之ngx_array_t

版权声明：本文为博主原创文章，未经博主允许不得转载。 https://blog.csdn.net/xxb249/article/details/84342283

在上一篇介绍了ngx_list_t，本篇介绍一下ngx_array_t，其实有了上一篇的基础，在介绍ngx_array_t就比较简单了。

一、数据结构

在数据结构上与ngx_list_t有一点点重复，如下所示：

typedef struct {
    void        *elts; /* 数组的起始地址 */
    ngx_uint_t   nelts; /* 当前数组已存储元素量 即已经使用的 */
    size_t       size; /* 一个数组元素大小 */
    ngx_uint_t   nalloc; /* 分配n个元素 */
    ngx_pool_t  *pool; /* 代表从该内存池中分配数组 */
} ngx_array_t;

从数据结构上来看，不是太复杂，比较好理解。

二、相关接口

/**
 * 创建数组
 * @param p    内存池
 * @param n    数组元素个数
 * @param size 一个数组元素的大小
 */
ngx_array_t *
ngx_array_create(ngx_pool_t *p, ngx_uint_t n, size_t size)
{
    ngx_array_t *a;

    a = ngx_palloc(p, sizeof(ngx_array_t));//申请数组头
    if (a == NULL) {
        return NULL;
    }

    if (ngx_array_init(a, p, n, size) != NGX_OK) {//为数组元素申请内存
        return NULL;
    }

    return a;
}

/**
 * 数组初始化
 * @param array 数组
 * @param pool  内存池
 * @param n     数组包含元素个数
 * @param size  一个数组元素所占内存大小
 */
static ngx_inline ngx_int_t
ngx_array_init(ngx_array_t *array, ngx_pool_t *pool, ngx_uint_t n, size_t size)
{
    /*
     * 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);//分配内存
    if (array->elts == NULL) {
        return NGX_ERROR;
    }

    return NGX_OK;
}

/**
 * 销毁一个数组
 * @param a  数组
 * @describe 这个方法 是尽量回收
 */
void
ngx_array_destroy(ngx_array_t *a)
{
    ngx_pool_t  *p;

    p = a->pool;
    /* 回收数组元素所占用的内存 */
    if ((u_char *) a->elts + a->size * a->nalloc == p->d.last) {
        p->d.last -= a->size * a->nalloc;
    }
    /* 回收数组头所占内存 */
    if ((u_char *) a + sizeof(ngx_array_t) == p->d.last) {
        p->d.last = (u_char *) a;
    }
}

/**
 * 添加一个元素
 * @param a 数组
 * @return 返回可用地址  具体赋值操作由调用者负责
 */
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;
            a->nalloc++;

        } else {
            /* allocate a new array */

            new = ngx_palloc(p, 2 * size);//需要重新分配内存
            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;
}

三、总结

ngx_array_t相对简单，但是使用频率比较高，自己看一下代码就能搞定。

还有一些数据结构使用频率也很高，例如ngx_str_t，ngx_hash_t，ngx_rbtree_t等。其中ngx_rbtree_t阅读起来可能比较难于理解，不过好在网上有很多讲解红黑树原理。ngx_hash_t也是常见实现方式网上也有很多，所以不打算在深入介绍了。

后面打算介绍Nginx核心内容，《菜鸟学习nginx之模块定义》。