文章2：Nginx源码分析-ngx_array_t动态数组

目录

1、为什么要设计ngx_array_t动态数组

2、ngx_array_t的定义

3、操作动态数组的方法

1、为什么要设计ngx_array_t动态数组

数组使用一整块内存，可以根据下标直接寻址访问，因此访问速度快，但数组需要预分配一整块内存，因此可能会浪费内存，而动态数组具有数组访问速度快的优势，同时可以自动扩容，允许元素个数的不确定性，从而减小内存的浪费。

 

2、ngx_array_t的定义：

typedef struct ngx_array_s ngx_array_t;struct ngx_array_s {    void        *elts;     // 指向该动态数组的头地址    ngx_uint_t   nelts;     // 数组中已使用的元素个数    size_t       size;      // 每个数组元素占有的内存大小（字节）    ngx_uint_t   nalloc;    // 当前数组能够容纳的成员个数    ngx_pool_t  *pool;     // 内存池};

ngx_array_t内存图：

3、操作动态数组的方法

/* 函数名：ngx_array_create   参数：p是内存池，n为预分配的元素个数，size是每个元素所占内存的大小   函数功能：创建动态数组，预分配n个大小为size的内存空间*/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;    }    // 预分配n个大小为size的内存空间，首地址为a->elts    a->elts = ngx_palloc(p, n * size);    if (a->elts == NULL) {        return NULL;    }    a->nelts = 0;    a->size = size;    a->nalloc = n;    a->pool = p;        // 返回值为ngx_array_t结构体的指针，而不是动态数组的首地址return a;}/* 函数名：ngx_array_init   参数：array是已存在的动态数组结构体的指针，p是内存池，n是预分配的元素个数，size是每个元素所占内存的大小   函数功能：初始化已存在的动态数组，预分配n个size大小的内存空间*/static ngx_inline ngx_int_tngx_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;    // 预分配n个大小为size的内存空间，首地址为a->elts    array->elts = ngx_palloc(pool, n * size);    if (array->elts == NULL) {        return NGX_ERROR;    }    return NGX_OK;}/* 函数名：ngx_array_destroy   参数：a是动态数组结构体的指针   函数功能：销毁已分配的动态数组元素空间和ngx_array_t结构体本身占用的内存*/voidngx_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;    }    // 销毁ngx_array_t结构体本身占用的内存    if ((u_char *) a + sizeof(ngx_array_t) == p->d.last) {        p->d.last = (u_char *) a;    }}

当动态数组已存储的元素个数达到预分配的元素个数时，ngx_array_push方法将引起数组扩容，分下面两种情况：

（1）若内存池剩余的空间大于等于本次需要新增的空间，则只扩充新增的空间。

（2）若内存池剩余的空间小于本次需要新增的空间，新分配一个容量是之前两倍的数组。

/* 函数名：ngx_array_push   参数：a是动态数组结构体的指针   功能：向动态数组a中添加1个元素，返回新添加元素的地址*/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指向新数组头地址            a->elts = new;            a->nalloc *= 2;        }    }    elt = (u_char *) a->elts + a->size * a->nelts;    a->nelts++;    // 返回的是新添加的元素的地址return elt

 

当动态数组已存储的元素个数达到预分配的元素个数时，ngx_array_push方法将引起数组扩容，分下面两种情况：

（1）若内存池剩余的空间大于等于本次需要新增的空间，则只扩充新增的空间。

（2）若内存池剩余的空间小于本次需要新增的空间，a.若n小于原先数组的容量，将扩容一倍；b.若n大于原先数组的容量，扩容为2*n

/* 函数名：ngx_array_push_n    参数：a是动态数组结构体的指针，n是新增元素个数    功能：向动态数组a中添加n个元素，返回新添加元素的第一个元素地址 */  void *  ngx_array_push_n(ngx_array_t *a, ngx_uint_t n)  {      void        *elt, *new;      size_t       size;      ngx_uint_t   nalloc;      ngx_pool_t  *p;        size = n * a->size;        // 若预分配的空间不够存储新加的元素      if (a->nelts + n > a->nalloc) {            /* the array is full */            p = a->pool;            // 若内存池剩余的空间大于等于本次需要新增的空间，则只扩充新增的空间          if ((u_char *) a->elts + a->size * a->nalloc == p->d.last              && p->d.last + size <= p->d.end)          {              /*              * the array allocation is the last in the pool              * and there is space for new allocation              */                p->d.last += size;              a->nalloc += n;    /* 若内存池剩余的空间小于本次需要新增的空间 */          } else {              /* allocate a new array */              /* 若新增的元素个数大于之前预分配的，则新分配2倍n的空间，若小于，则新分配2倍nallloc的空间 */              nalloc = 2 * ((n >= a->nalloc) ? n : a->nalloc);                new = ngx_palloc(p, nalloc * a->size);              if (new == NULL) {                  return NULL;              }                ngx_memcpy(new, a->elts, a->nelts * a->size);              a->elts = new;              a->nalloc = nalloc;          }      }        elt = (u_char *) a->elts + a->size * a->nelts;      a->nelts += n;    return elt;  }  

 

参考文章：

陶辉《深入理解Nginx-模块开发与架构设计》