ngx_unix_recv

1 定义ngx_unix_recv 函数 定义在 ./nginx-1.24.0/src/os/unix/ngx_recv.cssize_tngx_unix_recv(ngx_connection_t*c,u_char*buf,size_tsize){ssize_tn;ngx_err_terr;ngx_event_t*rev;revc-read;#if(NGX_HAVE_KQUEUE)if(ngx_event_flagsNGX_USE_KQUEUE_EVENT){ngx_log_debug3(NGX_LOG_DEBUG_EVENT,c-log,0,recv: eof:%d, avail:%d, err:%d,rev-pending_eof,rev-available,rev-kq_errno);if(rev-available0){if(rev-pending_eof){rev-ready0;rev-eof1;if(rev-kq_errno){rev-error1;ngx_set_socket_errno(rev-kq_errno);returnngx_connection_error(c,rev-kq_errno,kevent() reported about an closed connection);}return0;}else{rev-ready0;returnNGX_AGAIN;}}}#endif#if(NGX_HAVE_EPOLLRDHUP)if((ngx_event_flagsNGX_USE_EPOLL_EVENT)ngx_use_epoll_rdhup){ngx_log_debug2(NGX_LOG_DEBUG_EVENT,c-log,0,recv: eof:%d, avail:%d,rev-pending_eof,rev-available);if(rev-available0!rev-pending_eof){rev-ready0;returnNGX_AGAIN;}}#endifdo{nrecv(c-fd,buf,size,0);ngx_log_debug3(NGX_LOG_DEBUG_EVENT,c-log,0,recv: fd:%d %z of %uz,c-fd,n,size);if(n0){rev-ready0;rev-eof1;#if(NGX_HAVE_KQUEUE)/* * on FreeBSD recv() may return 0 on closed socket * even if kqueue reported about available data */if(ngx_event_flagsNGX_USE_KQUEUE_EVENT){rev-available0;}#endifreturn0;}if(n0){#if(NGX_HAVE_KQUEUE)if(ngx_event_flagsNGX_USE_KQUEUE_EVENT){rev-available-n;/* * rev-available may be negative here because some additional * bytes may be received between kevent() and recv() */if(rev-available0){if(!rev-pending_eof){rev-ready0;}rev-available0;}returnn;}#endif#if(NGX_HAVE_FIONREAD)if(rev-available0){rev-available-n;/* * negative rev-available means some additional bytes * were received between kernel notification and recv(), * and therefore ev-ready can be safely reset even for * edge-triggered event methods */if(rev-available0){rev-available0;rev-ready0;}ngx_log_debug1(NGX_LOG_DEBUG_EVENT,c-log,0,recv: avail:%d,rev-available);}elseif((size_t)nsize){if(ngx_socket_nread(c-fd,rev-available)-1){nngx_connection_error(c,ngx_socket_errno,ngx_socket_nread_n failed);break;}ngx_log_debug1(NGX_LOG_DEBUG_EVENT,c-log,0,recv: avail:%d,rev-available);}#endif#if(NGX_HAVE_EPOLLRDHUP)if((ngx_event_flagsNGX_USE_EPOLL_EVENT)ngx_use_epoll_rdhup){if((size_t)nsize){if(!rev-pending_eof){rev-ready0;}rev-available0;}returnn;}#endifif((size_t)nsize!(ngx_event_flagsNGX_USE_GREEDY_EVENT)){rev-ready0;}returnn;}errngx_socket_errno;if(errNGX_EAGAIN||errNGX_EINTR){ngx_log_debug0(NGX_LOG_DEBUG_EVENT,c-log,err,recv() not ready);nNGX_AGAIN;}else{nngx_connection_error(c,err,recv() failed);break;}}while(errNGX_EINTR);rev-ready0;if(nNGX_ERROR){rev-error1;}returnn;}ngx_unix_recv 函数 是 Nginx 在 Unix/Linux 系统上从套接字接收数据的核心底层函数。 它封装了 recv() 系统调用 并根据当前使用的 I/O 多路复用机制及触发模式边缘/水平 动态管理读事件的 ready、available可读字节数、eof 和 error 等状态。 同时该函数处理信号中断EINTR重试、无数据可读EAGAIN 返回 NGX_AGAIN、正常关闭返回 0 以及异常错误返回 NGX_ERROR 为上层事件驱动模型提供一致且高效的数据接收接口。2 详解1 函数签名ssize_tngx_unix_recv(ngx_connection_t*c,u_char*buf,size_tsize)返回值 0成功读取的字节数可能小于等于 size。 0对端已关闭连接EOF此时函数会将读事件的 eof 标志置为 1。 负值表示特殊情况或错误具体由 Nginx 定义的宏控制 NGX_AGAIN通常为 -2 表示非阻塞套接字当前无数据可读或事件尚未就绪调用者应将读事件重新加入事件循环等待通知。 NGX_ERROR通常为 -1 表示发生不可恢复的错误函数已处理连接错误并设置事件错误标志。参数1 ngx_connection_t *c 指向一个连接对象 c-fd套接字文件描述符是 recv() 操作的目标 参数2 u_char *buf 接收数据的存储区由调用者预先分配大小至少为 size 字节 参数3 size_t size 指定了接收缓冲区的容量即本次调用最多能读取的字节数2 逻辑流程1 局部变量 2 Kqueue 处理 3 无需调用 recv 4 接收循环 5 循环后统一状态更新与返回1 局部变量{ssize_tn;ngx_err_terr;ngx_event_t*rev;revc-read;初始化 rev获取连接 c 的读事件对象2 Kqueue 处理#if(NGX_HAVE_KQUEUE)if(ngx_event_flagsNGX_USE_KQUEUE_EVENT){ngx_log_debug3(NGX_LOG_DEBUG_EVENT,c-log,0,recv: eof:%d, avail:%d, err:%d,rev-pending_eof,rev-available,rev-kq_errno);if(rev-available0){if(rev-pending_eof){rev-ready0;rev-eof1;if(rev-kq_errno){rev-error1;ngx_set_socket_errno(rev-kq_errno);returnngx_connection_error(c,rev-kq_errno,kevent() reported about an closed connection);}return0;}else{rev-ready0;returnNGX_AGAIN;}}}#endif3 无需调用 recv#if(NGX_HAVE_EPOLLRDHUP)if((ngx_event_flagsNGX_USE_EPOLL_EVENT)ngx_use_epoll_rdhup){ngx_log_debug2(NGX_LOG_DEBUG_EVENT,c-log,0,recv: eof:%d, avail:%d,rev-pending_eof,rev-available);if(rev-available0!rev-pending_eof){rev-ready0;returnNGX_AGAIN;}}#endif#1 当前事件模块是 epoll 配置启用了 epoll_rdhup 允许使用 EPOLLRDHUP 检测对端半关闭。 #2 调试日志 #3 判断是否需要真正调用 recv() 若 epoll 指示没有数据可读available 0 且并未因对端关闭而触发!pending_eof 则直接避免无意义的 recv() 调用。 返回 NGX_AGAIN清除 ready 标志重新等待事件。 这是边缘触发模式下的重要优化可以减少系统调用开销。4 接收循环do{nrecv(c-fd,buf,size,0);ngx_log_debug3(NGX_LOG_DEBUG_EVENT,c-log,0,recv: fd:%d %z of %uz,c-fd,n,size);if(n0){rev-ready0;rev-eof1;#if(NGX_HAVE_KQUEUE)/* * on FreeBSD recv() may return 0 on closed socket * even if kqueue reported about available data */if(ngx_event_flagsNGX_USE_KQUEUE_EVENT){rev-available0;}#endifreturn0;}if(n0){#if(NGX_HAVE_KQUEUE)if(ngx_event_flagsNGX_USE_KQUEUE_EVENT){rev-available-n;/* * rev-available may be negative here because some additional * bytes may be received between kevent() and recv() */if(rev-available0){if(!rev-pending_eof){rev-ready0;}rev-available0;}returnn;}#endif#if(NGX_HAVE_FIONREAD)if(rev-available0){rev-available-n;/* * negative rev-available means some additional bytes * were received between kernel notification and recv(), * and therefore ev-ready can be safely reset even for * edge-triggered event methods */if(rev-available0){rev-available0;rev-ready0;}ngx_log_debug1(NGX_LOG_DEBUG_EVENT,c-log,0,recv: avail:%d,rev-available);}elseif((size_t)nsize){if(ngx_socket_nread(c-fd,rev-available)-1){nngx_connection_error(c,ngx_socket_errno,ngx_socket_nread_n failed);break;}ngx_log_debug1(NGX_LOG_DEBUG_EVENT,c-log,0,recv: avail:%d,rev-available);}#endif#if(NGX_HAVE_EPOLLRDHUP)if((ngx_event_flagsNGX_USE_EPOLL_EVENT)ngx_use_epoll_rdhup){if((size_t)nsize){if(!rev-pending_eof){rev-ready0;}rev-available0;}returnn;}#endifif((size_t)nsize!(ngx_event_flagsNGX_USE_GREEDY_EVENT)){rev-ready0;}returnn;}errngx_socket_errno;if(errNGX_EAGAIN||errNGX_EINTR){ngx_log_debug0(NGX_LOG_DEBUG_EVENT,c-log,err,recv() not ready);nNGX_AGAIN;}else{nngx_connection_error(c,err,recv() failed);break;}}while(errNGX_EINTR);#1 系统调用 recv 从连接套接字 c-fd 读取数据到 buf 最多 size 字节flags 为 0无特殊标志。 返回值存入 n。#2-1 情况一n 0 —— 对端关闭连接 检查返回值是否 0 recv() 返回 0 表示对端已执行了关闭写入发送了 FINTCP 连接半关闭或完全关闭。 更新事件状态清除 ready 置 eof 1保证上层逻辑能正确处理 EOF。#2-2 Kqueue 特化清理kqueue 模型下 可能还存在残留的 available 值这里强行归零避免状态错乱。#2-3 返回 0通知上层连接已关闭。#3-1 情况二n 0 —— 成功读取数据#3-2 Kqueue 机制下的 available 更新#3-3 条件编译支持 FIONREAD ioctl如 Linux、FreeBSD 等 可以查询套接字接收缓冲区中待读字节数。 如果已知 available 进入基于该值的递减逻辑。 递减可用字节数 处理负值情况 若 available 变成负数说明有额外数据到达 因此清 available 并置 ready 0边缘触发下表示本次通知数据已被取完。 记录剩余量便于调试。available 未知初始为 -1且本次读满了 说明缓冲区可能还有更多数据但之前没有获取 available 现在需要主动探测。 通过 ioctl 查询 调用 ngx_socket_nread 获取套接字接收缓冲区未读字节数存入 rev-available。 如果 ioctl 失败调用 ngx_connection_error 记录错误设置 n NGX_ERROR 然后 break 跳出循环最终由尾部统一处理返回。#3-4 EPOLLRDHUP 模式下的就绪状态管理 epoll EPOLLRDHUP 环境下 判断本次读取是否未填满缓冲区 若 n size通常表示内核缓冲区已被读空已完成本次事件通知的所有数据。 更新状态 若没有挂起的 EOF则清除 ready边缘触发下已无数据可读不再就绪。 将 available 强制置 0表示无剩余数据。 返回实际读取字节数 跳过后续通用的 ready 调整因为 epoll 路径已完成专门处理。#3-5 基于 GREEDY_EVENT 的就绪处理 (size_t) n size 读取量小于请求量暗示内核缓冲区已空。 !(ngx_event_flags NGX_USE_GREEDY_EVENT) 当前事件模块不是“贪心”模式。 在 Nginx 中水平触发如 select通常也设为非贪心 表示单次事件通知只读取一次而不在循环中直到 EAGAIN 因此这里清除 ready让事件循环下次再次通知。 返回实际读取字节数#4 情况三n 0 —— recv() 返回错误 获取错误码#4-1 判断是否为可恢复错误 NGX_EAGAIN非阻塞套接字无数据可读等同于 EWOULDBLOCK。 NGX_EINTR系统调用被信号中断。 设置返回值为 NGX_AGAIN告诉上层需要再次等待事件 while (err NGX_EINTR) 会判断 如果是 EINTRerr NGX_EINTR 成立循环会回到 do 开头重新执行 recv()。 如果是 EAGAINerr NGX_EINTR 不成立循环退出保留 n NGX_AGAIN 作为最终返回值。#4-2 不可恢复的其他错误 ngx_connection_error 会记录错误日志并返回 NGX_ERROR。 n 被赋值为 NGX_ERROR内部通常为 -1。 break 退出 do-while 循环。循环条件仅当错误是 EINTR信号中断时继续循环重新调用 recv()。 对于 EAGAIN 或已通过 break 退出的错误循环终止。5 循环后统一状态更新与返回rev-ready0;if(nNGX_ERROR){rev-error1;}returnn;}#! 循环后统一状态更新与返回 清除 ready 标志无论因 EAGAIN 退出还是出现错误 此时套接字已无数据可读必须置零防止事件循环误认为仍然就绪。#2 标记错误状态 若最终返回值为 NGX_ERROR不可恢复错误 在读事件上设置 error 1以便上层销毁连接或进行清理。#3 返回最终结果 n 0成功读取的字节数。 0正常 EOF在前面的 if (n 0) 分支已提前返回不会执行到这里但逻辑完备。 NGX_AGAIN暂时无数据需重新等待。 NGX_ERROR连接发生致命错误。