ngx_output_chain_add_copy

1 定义ngx_output_chain_add_copy 函数 定义在 src/core/ngx_output_chain.cstaticngx_int_tngx_output_chain_add_copy(ngx_pool_t*pool,ngx_chain_t**chain,ngx_chain_t*in){ngx_chain_t*cl,**ll;#if(NGX_SENDFILE_LIMIT)ngx_buf_t*b,*buf;#endifllchain;for(cl*chain;cl;clcl-next){llcl-next;}while(in){clngx_alloc_chain_link(pool);if(clNULL){returnNGX_ERROR;}#if(NGX_SENDFILE_LIMIT)bufin-buf;if(buf-in_filebuf-file_posNGX_SENDFILE_LIMITbuf-file_lastNGX_SENDFILE_LIMIT){/* split a file buf on two bufs by the sendfile limit */bngx_calloc_buf(pool);if(bNULL){returnNGX_ERROR;}ngx_memcpy(b,buf,sizeof(ngx_buf_t));if(ngx_buf_in_memory(buf)){buf-pos(ssize_t)(NGX_SENDFILE_LIMIT-buf-file_pos);b-lastbuf-pos;}buf-file_posNGX_SENDFILE_LIMIT;b-file_lastNGX_SENDFILE_LIMIT;cl-bufb;}else{cl-bufbuf;inin-next;}#elsecl-bufin-buf;inin-next;#endifcl-nextNULL;*llcl;llcl-next;}returnNGX_OK;}2 目的1 设计意图ngx_output_chain_add_copy将上游传入的缓冲区链表in中的所有节点以浅拷贝方式追加到目标输出链chain的尾部并在需要时sendfile 跨限自动拆分文件缓冲区。该函数是ngx_output_chain核心引擎的入口适配器——它位于数据流入ctx-in积压队列的第一道关口。在ngx_output_chain主函数中当快速路径不适用时上下文已有积压数据或缓冲区需要拷贝处理所有新到达的in链都通过本函数追加到ctx-in链的尾部。这种设计实现了生产与消费的解耦上游的 body filter 可以随时将任意长度、任意数量的缓冲区链表交给输出链引擎而引擎内部按照自己的节奏受输出缓冲区容量限制逐批消费。函数名称中的add_copy反映了核心语义add将数据追加到已有链表的末尾FIFO 顺序copy此处是浅拷贝链节新分配ngx_chain_t节点但共享底层ngx_buf_t而非深拷贝缓冲区数据——这是性能关键。真正的数据拷贝发生在后续的ngx_output_chain_copy_buf中。3 详解1 函数签名staticngx_int_tngx_output_chain_add_copy(ngx_pool_t*pool,ngx_chain_t**chain,ngx_chain_t*in)1 返回值ngx_int_t返回值值含义NGX_OK0所有链节成功追加到目标链NGX_ERROR-1内存分配失败2 函数名ngx_output_chain_add_copy词段含义ngxNginx 源码前缀output_chain属于输出链子系统add将新数据追加到已有链表尾部copy分配新链节进行浅拷贝共享底层ngx_buf_t而非深拷贝数据3 参数列表参数类型含义来源约束poolngx_pool_t *内存池用于分配链节和临时缓冲区调用方从ctx-pool传入非 NULL与请求生命周期绑定chainngx_chain_t **指向目标链头指针的二级指针调用方传入ctx-in非 NULL函数可能修改*chain当目标链原本为空时inngx_chain_t *待追加的输入缓冲区链表上游 body filter 传入可为 NULL但调用方已在in ! NULL时才调用2 逻辑流程ngx_output_chain_add_copy(pool, chain, in) ├─ [1] 初始化定位目标链尾部 │ └─ 遍历 chain 链表找到最后一个节点ll 指向其 next 字段 └─ [2] 遍历 in 链逐节点追加到目标链 ├─ [2.1] 分配新链节 → 失败则返回 NGX_ERROR ├─ [2.2] 文件缓冲区跨 sendfile 限制检测仅当 NGX_SENDFILE_LIMIT 定义时 │ ├─ [2.2.A] 需要拆分file_pos LIMIT file_last │ │ ├─ [2.2.A.1] 分配新缓冲区 bmemcpy 复制原 buf 的元数据 │ │ ├─ [2.2.A.2] 若 buf 在内存中调整 pos/last 指针拆分内存数据 │ │ ├─ [2.2.A.3] 设置拆分点buf→file_pos LIMITb→file_last LIMIT │ │ └─ [2.2.A.4] 新链节挂接拆分出的前半部分 bin 不推进 │ └─ [2.2.B] 无需拆分直接浅拷贝 bufin 推进到下一节点 └─ [2.3] 没有 NGX_SENDFILE_LIMIT 时直接浅拷贝 bufin 推进 └─ [2.4] 新链节追加到目标链尾部ll 更新为新的尾部指针{ngx_chain_t*cl,**ll;#if(NGX_SENDFILE_LIMIT)ngx_buf_t*b,*buf;#endif局部变量声明1 定位目标链尾部llchain;for(cl*chain;cl;clcl-next){llcl-next;}进入条件无条件每次调用都需要先定位尾部。处理逻辑这是一个经典的找到链表最后一个节点的next字段地址的遍历模式ll初始化为chain即指向头指针的二级指针从头开始遍历*chain链表每次迭代将ll更新为cl-next当前节点的next字段地址遍历结束后ll始终指向链表尾部的next字段即最后一个节点的next地址若链表为空则指向头指针本身ll二级指针的作用如果目标链为空*ll就是*chain头指针写入*ll cl相当于设置链表头如果目标链非空*ll就是最后一个节点的next字段写入*ll cl相当于尾部追加这种二级指针模式避免了判断链表是否为空的分支统一了头插和尾插的逻辑2 遍历 in 链逐节点追加while(in){进入条件in ! NULL有数据需要追加。处理逻辑while 循环遍历in链表的每一个节点。2.1 分配新链节clngx_alloc_chain_link(pool);if(clNULL){returnNGX_ERROR;}ngx_alloc_chain_link函数概述定义在src/core/ngx_buf.c。该函数从内存池中分配一个ngx_chain_t链节。优先从pool-chain空闲链表中复用已回收的链节LIFO 方式如果空闲链表为空则调用ngx_palloc从内存池中分配新的内存。返回 NULL 表示内存耗尽。处理逻辑为当前in链节分配一个新链节容器。这里只是分配链节壳子ngx_chain_t不分配缓冲区——缓冲区要么共享原in-buf浅拷贝要么在 sendfile 拆分时才分配新ngx_buf_t。错误处理如果pool-chain空闲链表和ngx_palloc都失败内存池耗尽返回NGX_ERROR。上层ngx_output_chain会将此错误向上传递给 body filter 链最终导致请求失败。2.2 文件缓冲区跨 sendfile 限制拆分条件编译#if(NGX_SENDFILE_LIMIT)bufin-buf;if(buf-in_filebuf-file_posNGX_SENDFILE_LIMITbuf-file_lastNGX_SENDFILE_LIMIT){/* split a file buf on two bufs by the sendfile limit */进入条件三个条件同时满足buf-in_file缓冲区是文件映射类型从磁盘文件读取非纯内存缓冲区buf-file_pos NGX_SENDFILE_LIMIT缓冲区的文件起始偏移在 2GB 以下buf-file_last NGX_SENDFILE_LIMIT缓冲区的文件结束偏移在 2GB 以上只有同时满足这三个条件才说明同一个文件缓冲区跨越了 2GB 边界必须拆分。bngx_calloc_buf(pool);if(bNULL){returnNGX_ERROR;}ngx_memcpy(b,buf,sizeof(ngx_buf_t));if(ngx_buf_in_memory(buf)){buf-pos(ssize_t)(NGX_SENDFILE_LIMIT-buf-file_pos);b-lastbuf-pos;}buf-file_posNGX_SENDFILE_LIMIT;b-file_lastNGX_SENDFILE_LIMIT;cl-bufb;}else{cl-bufbuf;inin-next;}2.3 无 sendfile 限制时的直接浅拷贝#elsecl-bufin-buf;inin-next;#endif进入条件NGX_SENDFILE_LIMIT未定义非 Linux 系统无 sendfile 2GB 限制问题。处理逻辑与 2.2.B 完全一致——直接浅拷贝缓冲区指针推进in。所有平台上的非拆分场景都走这条统一路径。2.4 追加到目标链尾部cl-nextNULL;*llcl;llcl-next;}returnNGX_OK;处理逻辑cl-next NULL新链节作为尾部节点next设为 NULL*ll cl通过二级指针ll将新链节挂接到目标链的尾部——如果目标链原本为空*ll cl会设置头指针如果目标链非空*ll就是最后一个节点的next字段实现尾部追加ll cl-next更新ll指向新尾节点的next字段地址为下一次追加做准备最终返回NGX_OK所有节点处理完毕无错误发生。上层ngx_output_chain收到此返回值后进入主循环开始逐缓冲区处理ctx-in链表。