【Nginx 源码学习】内存池 及 优秀案例赏析：Nginx内存池设计

typedef struct {
	u_char *last; // 当前内存池分配到此处，即下一次分配从此处开始
	u_char *end; // 内存池结束位置
	ngx_pool_t *next; // 内存池里面有很多块内存，这些内存块就是通过该指针连成链表的
	ngx_uint_t failed; // 内存池分配失败次数
} ngx_pool_data_t;

struct ngx_pool_s {
	ngx_pool_data_t d; // 指向内存池的第一个数据块
	size_t max; // 内存池数据块的最大值(数目)
	ngx_pool_t *current; // 指向当前内存池
	ngx_chain_t *chain; // 该指针挂接一个ngx_chain_t结构
	ngx_pool_large_t *large; // 大块内存链表，即分配空间超过max的内存
	ngx_pool_cleanup_t *cleanup; // 释放内存池的callback
	ngx_log_t *log; // 主要用于记录日志信息
};

struct ngx_pool_large_s {
	ngx_pool_large_t *next; // 指向下一个large内存
	void *alloc; // 指向分配的large内存
};

struct ngx_pool_cleanup_s {
	ngx_pool_cleanup_pt handler; // 指向用于cleanup本cleanup内存
	void *data; // 指向分配的cleanup内存
	ngx_pool_cleanup_t *next; // 指向下一个cleanup内存
};

#define ngx_memalign(alignment, size, log)  ngx_alloc(size, log)
//ngx_alloc：对malloc进行了简单封装

ngx_pool_t *ngx_create_pool(size_t size, ngx_log_t *log)
{
	ngx_pool_t *p;
	p = ngx_memalign(NGX_POOL_ALIGNMENT, size, log);
	if (p == NULL) {
		return NULL;
	}
	// 可以看到 last 指向 pool 之后的位置，即下一个pool块分配的位置
	p->d.last = (u_char *) p + sizeof(ngx_pool_t);
	// end 指向pool的size的最后，即当前pool可容纳的最大尺寸的结束位置
	p->d.end = (u_char *) p + size;
	p->d.next = NULL;
	p->d.failed = 0;
	size = size - sizeof(ngx_pool_t);
	p->max = (size < NGX_MAX_ALLOC_FROM_POOL) ? size : NGX_MAX_ALLOC_FROM_POOL;
	/*
		nginx对内存的管理分为大内存与小内存，
		当某一个申请的内存大于某一个值时，就需要从大内存中分配空间，否则从小内存中分配空间。
		nginx中的内存池是在创建的时候就设定好了大小，
		在以后分配小块内存的时候，如果内存不够，则是重新创建一块内存串到内存池中，而不是将原有的内存池进行扩张。
		当要分配大块内存时，则是在内存池外面再分配空间进行管理的，称为大块内存池。
	*/
	p->current = p;
	p->chain = NULL;
	p->large = NULL;
	p->cleanup = NULL;
	p->log = log;
	return p;
}

void ngx_destroy_pool(ngx_pool_t *pool)
{
	ngx_pool_t *p, *n;
	ngx_pool_large_t *l;
	ngx_pool_cleanup_t *c;
	
	for (c = pool->cleanup; c; c = c->next) {
		if (c->handler) {
			ngx_log_debug1(NGX_LOG_DEBUG_ALLOC, pool->log, 0,
			"run cleanup: %p", c);
			c->handler(c->data);
		}
	}
	
	for (l = pool->large; l; l = l->next) {
		ngx_log_debug1(NGX_LOG_DEBUG_ALLOC, pool->log, 0, "free: %p", l->alloc);
		
		if (l->alloc) {
			ngx_free(l->alloc);
		}
	}
	
	#if (NGX_DEBUG)
	… …
	#endif
	
	for (p = pool, n = pool->d.next; ; p = n, n = n->d.next) {
		ngx_free(p);
		
		if (n == NULL) {
			break;
		}
	}
}

void ngx_reset_pool(ngx_pool_t *pool)
{
	ngx_pool_t *p;
	ngx_pool_large_t *l;
	
	// 先遍历large链表，释放large内存
	for (l = pool->large; l; l = l->next) {
		if (l->alloc) {
			ngx_free(l->alloc);
		}
	}
	
	pool->large = NULL;
	
	//重置所有小块内存区
	for (p = pool; p; p = p->d.next) {
		p->d.last = (u_char *) p + sizeof(ngx_pool_t);
	}
}

#define ngx_align_ptr(p, a)                                                   \
    (u_char *) (((uintptr_t) (p) + ((uintptr_t) a - 1)) & ~((uintptr_t) a - 1))

void *ngx_palloc(ngx_pool_t *pool, size_t size)
{
	u_char *m;
	ngx_pool_t *p;
	
	if (size <= pool->max) { // 如果需要分配的size大于max，则使用palloc_large来分配
		p = pool->current; // 小于max，则从current开始遍历pool链表
		do {
			// 每次从last处开始分配aligned内存
			m = ngx_align_ptr(p->d.last, NGX_ALIGNMENT);
			
			if ((size_t) (p->d.end - m) >= size) {
				// 如果分配的内存够用，则就从此处分配，并调整last
				p->d.last = m + size;
				return m;
			}
			
			p = p->d.next;
		} while (p);
		// 表示链表里没有能够分配size大小的内存节点
		// 则生成一个新的节点，并在其中分配内存
		return ngx_palloc_block(pool, size);
	}
	// 大于max的，就在large中进行分配
	return ngx_palloc_large(pool, size);
}

static void *ngx_palloc_block(ngx_pool_t *pool, size_t size)
{
	u_char *m;
	size_t psize;
	ngx_pool_t *p,*new,*current;
	
	psize = (size_t) (pool->d.end - (u_char *) pool);//计算内存池第一个内存块的大小
	m = ngx_memalign(NGX_POOL_ALIGNMENT, psize, pool->log);//分配和第一个内存块同样大小的内存块
	if (m == NULL) {
		return NULL;
	}

	new = (ngx_pool_t *) m;
	new->d.end = m + psize;//设置新内存块的end
	new->d.next = NULL;
	new->d.failed = 0;

	m += sizeof(ngx_pool_data_t);//将指针m移动到d后面的一个位置，作为起始位置
	m = ngx_align_ptr(m, NGX_ALIGNMENT);//对m指针按4字节对齐处理
	new->d.last = m + size;//设置新内存块的last，即申请使用size大小的内存

	current = pool->current;
  //这里的循环用来找最后一个链表节点，这里failed用来控制循环的长度，如果分配失败次数达到5次，
  //就忽略，不需要每次都从头找起
	for (p = current; p->d.next; p = p->d.next) {
		if(p->d.failed++ > 4) {	//这儿咋总觉得哪里怪怪的
			current = p->d.next;
		}
	}

	p->d.next = new;
  pool->current = current ? current : new;
	return m;
}

/*
 * 1）判断pool->large链表上查询是否有NULL的，只在链表上往下查询3次，主要判断大数据块是否有被释放的，有就给它赋值，如果没有则只能跳出。
 * 2）然后往下新创建一个pool->large结构体，将刚开辟的空间赋给该新结构体管理。
*/

static void *ngx_palloc_large(ngx_pool_t *pool, size_t size)
{
    void              *p;
    ngx_uint_t         n;
    ngx_pool_large_t  *large;

    p = ngx_alloc(size, pool->log);//注意该函数是单独调用malloc，所以它的内存与内存池链表的内存是不连续的或者叫无关。
    if (p == NULL) {
        return NULL;
    }

    n = 0;

	// 1）判断pool->large链表上查询是否有NULL的，只在链表上往下查询3次，主要判断大数据块是否有被释放的，有就给它赋值，如果没有则只能跳出
    for (large = pool->large; large; large = large->next) {
        if (large->alloc == NULL) {
            large->alloc = p;
            return p;
        }

        if (n++ > 3) {
            break;
        }
    }

	// 2）新建pool->large结构体管理新内存，注意：是创建结构体的大小，属于小内存块(不要以为调用ngx_palloc_small后会造成递归调用)
    large = ngx_palloc_small(pool, sizeof(ngx_pool_large_t), 1);
    if (large == NULL) {
        ngx_free(p);
        return NULL;
    }

    large->alloc = p;//刚开辟的内存交给pool->large链表管理
    large->next = pool->large;//插入新的pool->large结构体。注：插法是每次新的pool->large结构体插进第一个pool->large的后面。即pool->large->la3->la2->la1->NULL
    pool->large = large;

    return p;
}

/**
 * 指定释放大内存块链表的某一块大内存。
 * 这里可以看到大内存的管理是支持释放某一块大内存的，所以上面的ngx_palloc_large函数每一次都检查前三个是否为空，
 * 确保前三个有内存空间可用，至于后面是否为空就只能不怎么关心了。
 */
ngx_int_t ngx_pfree(ngx_pool_t *pool, void *p)
{
    ngx_pool_large_t  *l;

	//遍历大内存链表，若找到想要释放的大内存则释放，否则返回错误NGX_DECLINED
    for (l = pool->large; l; l = l->next) {
        if (p == l->alloc) {
            ngx_log_debug1(NGX_LOG_DEBUG_ALLOC, pool->log, 0,
                           "free: %p", l->alloc);
            ngx_free(l->alloc);
            l->alloc = NULL;

            return NGX_OK;
        }
    }

    return NGX_DECLINED;
}

/**
 * 1）创建一个新的ngx_pool_cleanup_t结构体并给其内部成员开辟内存空间。
 * 2）使用头插法将新的结构体插入清理链表。
 * 
 * 注意：初始化时回调c->handler设为NULL，并且返回值为返回当前结构体，所以该内存可以由用户自定义并且自行处理，非常灵活。
 * 
 * 实际上该函数注意是用来添加以下两个内容：
 * 1. 文件描述符
 * 2. 外部自定义回调函数可以来清理内存
 */
 */
ngx_pool_cleanup_t *ngx_pool_cleanup_add(ngx_pool_t *p, size_t size)
{
    ngx_pool_cleanup_t  *c;

	// 1）创建新的清理结构体和开辟空间
    c = ngx_palloc(p, sizeof(ngx_pool_cleanup_t));
    if (c == NULL) {
        return NULL;
    }

    if (size) {
        c->data = ngx_palloc(p, size);//该函数调用samll或者large，所以内存块仍旧在p->d或p->large上
        if (c->data == NULL) {
            return NULL;
        }
    } else {
        c->data = NULL;
    }

	// 2）使用头插法插入清理链表，并且回调设为NULL等待用户设置。
    c->handler = NULL;
    c->next = p->cleanup;

    p->cleanup = c;

    ngx_log_debug1(NGX_LOG_DEBUG_ALLOC, p->log, 0, "add cleanup: %p", c);

    return c;
}

void ngx_pool_run_cleanup_file(ngx_pool_t *p, ngx_fd_t fd) {
	ngx_pool_cleanup_t *c;
	ngx_pool_cleanup_file_t *cf;
 
 	// 遍历清理链表
	for (c = p->cleanup; c; c = c->next) {
		if (c->handler == ngx_pool_cleanup_file) {
 
			cf = c->data;//因为为清理文件描述符，此时的c->data应为ngx_pool_cleanup_file_t的结构体类型
 			
 			// 判断是否是指定要删除的fd
			if (cf->fd == fd) {
				c->handler(cf); /* 调用ngx_pool_cleanup_file回调函数清理指定内存cf */
				c->handler = NULL;
				return;
			}
		}
	}
}

void ngx_pool_cleanup_file(void *data) {
	ngx_pool_cleanup_file_t *c = data;
 
	ngx_log_debug1(NGX_LOG_DEBUG_ALLOC, c->log, 0, "file cleanup: fd:%d",
			c->fd);
 
	if (ngx_close_file(c->fd) == NGX_FILE_ERROR) {
		ngx_log_error(NGX_LOG_ALERT, c->log, ngx_errno,
				ngx_close_file_n " \"%s\" failed", c->name);
	}
}

/*
 * #define ngx_delete_file(name)    unlink((const char *) name)
 * #define ngx_close_file           close
 * 
 * 该函数调用了ngx_delete_file和ngx_close_file进行删除文件。
 * 1）调用了ngx_delete_file宏，而该宏调用底层的unlink删除文件。
 * 2）调用了ngx_close_file宏，而该宏调用底层的close删除文件
 * 
*/
void ngx_pool_delete_file(void *data)
{
    ngx_pool_cleanup_file_t  *c = data;

    ngx_err_t  err;

    ngx_log_debug2(NGX_LOG_DEBUG_ALLOC, c->log, 0, "file cleanup: fd:%d %s",
                   c->fd, c->name);

    if (ngx_delete_file(c->name) == NGX_FILE_ERROR) {
        err = ngx_errno;

        if (err != NGX_ENOENT) {
            ngx_log_error(NGX_LOG_CRIT, c->log, err,
                          ngx_delete_file_n " \"%s\" failed", c->name);
        }
    }

    if (ngx_close_file(c->fd) == NGX_FILE_ERROR) {
        ngx_log_error(NGX_LOG_ALERT, c->log, ngx_errno,
                      ngx_close_file_n " \"%s\" failed", c->name);
    }
}