epoll反应堆

关于epoll 反应堆

学到黑马的epoll反应堆,感觉代码挺长的,来回跳转看比较不方便,主要是对代码调用的一个回顾,下面是源代码。

/*
 *epoll基于非阻塞I/O事件驱动
 */
#include <stdio.h>
#include <sys/socket.h>
#include <sys/epoll.h>
#include <arpa/inet.h>
#include <fcntl.h>
#include <unistd.h>
#include <errno.h>
#include <string.h>
#include <stdlib.h>
#include <time.h>

#define MAX_EVENTS  1024                                    //监听上限数
#define BUFLEN 4096
#define SERV_PORT   8080

void recvdata(int fd, int events, void *arg);
void senddata(int fd, int events, void *arg);

/* 描述就绪文件描述符相关信息 */

struct myevent_s {
    int fd;                                                 //要监听的文件描述符
    int events;                                             //对应的监听事件
    void *arg;                                              //泛型参数
    void (*call_back)(int fd, int events, void *arg);       //回调函数
    int status;                                             //是否在监听:1->在红黑树上(监听), 0->不在(不监听)
    char buf[BUFLEN];
    int len;
    long last_active;                                       //记录每次加入红黑树 g_efd 的时间值
};

int g_efd;                                                  //全局变量, 保存epoll_create返回的文件描述符
struct myevent_s g_events[MAX_EVENTS+1];                    //自定义结构体类型数组. +1-->listen fd


/*将结构体 myevent_s 成员变量 初始化*/

void eventset(struct myevent_s *ev, int fd, void (*call_back)(int, int, void *), void *arg)
{
    ev->fd = fd;
    ev->call_back = call_back;
    ev->events = 0;
    ev->arg = arg;
    ev->status = 0;
    memset(ev->buf, 0, sizeof(ev->buf));
    ev->len = 0;
    ev->last_active = time(NULL);                       //调用eventset函数的时间

    return;
}

/* 向 epoll监听的红黑树 添加一个 文件描述符 */

//eventadd(efd, EPOLLIN, &g_events[MAX_EVENTS]);
void eventadd(int efd, int events, struct myevent_s *ev)
{
    struct epoll_event epv = {0, {0}};
    int op;
    epv.data.ptr = ev;
    epv.events = ev->events = events;       //EPOLLIN 或 EPOLLOUT

    if (ev->status == 0) {                                          //已经在红黑树 g_efd 里
        op = EPOLL_CTL_ADD;                 //将其加入红黑树 g_efd, 并将status置1
        ev->status = 1;
    }

    if (epoll_ctl(efd, op, ev->fd, &epv) < 0)                       //实际添加/修改
        printf("event add failed [fd=%d], events[%d]\n", ev->fd, events);
    else
        printf("event add OK [fd=%d], op=%d, events[%0X]\n", ev->fd, op, events);

    return ;
}

/* 从epoll 监听的 红黑树中删除一个 文件描述符*/

void eventdel(int efd, struct myevent_s *ev)
{
    struct epoll_event epv = {0, {0}};

    if (ev->status != 1)                                        //不在红黑树上
        return ;

    //epv.data.ptr = ev;
    epv.data.ptr = NULL;
    ev->status = 0;                                             //修改状态
    epoll_ctl(efd, EPOLL_CTL_DEL, ev->fd, &epv);                //从红黑树 efd 上将 ev->fd 摘除

    return ;
}

/*  当有文件描述符就绪, epoll返回, 调用该函数 与客户端建立链接 */

void acceptconn(int lfd, int events, void *arg)
{
    struct sockaddr_in cin;
    socklen_t len = sizeof(cin);
    int cfd, i;

    if ((cfd = accept(lfd, (struct sockaddr *)&cin, &len)) == -1) {
        if (errno != EAGAIN && errno != EINTR) {
            /* 暂时不做出错处理 */
        }
        printf("%s: accept, %s\n", __func__, strerror(errno));
        return ;
    }

    do {
        for (i = 0; i < MAX_EVENTS; i++)                                //从全局数组g_events中找一个空闲元素
            if (g_events[i].status == 0)                                //类似于select中找值为-1的元素
                break;                                                  //跳出 for

        if (i == MAX_EVENTS) {
            printf("%s: max connect limit[%d]\n", __func__, MAX_EVENTS);
            break;                                                      //跳出do while(0) 不执行后续代码
        }

        int flag = 0;
        if ((flag = fcntl(cfd, F_SETFL, O_NONBLOCK)) < 0) {             //将cfd也设置为非阻塞
            printf("%s: fcntl nonblocking failed, %s\n", __func__, strerror(errno));
            break;
        }

        /* 给cfd设置一个 myevent_s 结构体, 回调函数 设置为 recvdata */
        eventset(&g_events[i], cfd, recvdata, &g_events[i]);   
        eventadd(g_efd, EPOLLIN, &g_events[i]);                         //将cfd添加到红黑树g_efd中,监听读事件

    } while(0);

    printf("new connect [%s:%d][time:%ld], pos[%d]\n", 
            inet_ntoa(cin.sin_addr), ntohs(cin.sin_port), g_events[i].last_active, i);
    return ;
}

void recvdata(int fd, int events, void *arg)
{
    struct myevent_s *ev = (struct myevent_s *)arg;
    int len;

    len = recv(fd, ev->buf, sizeof(ev->buf), 0);            //读文件描述符, 数据存入myevent_s成员buf中

    eventdel(g_efd, ev);        //将该节点从红黑树上摘除

    if (len > 0) {

        ev->len = len;
        ev->buf[len] = '\0';                                //手动添加字符串结束标记
        printf("C[%d]:%s\n", fd, ev->buf);

        eventset(ev, fd, senddata, ev);                     //设置该 fd 对应的回调函数为 senddata
        eventadd(g_efd, EPOLLOUT, ev);                      //将fd加入红黑树g_efd中,监听其写事件

    } else if (len == 0) {
        close(ev->fd);
        /* ev-g_events 地址相减得到偏移元素位置 */
        printf("[fd=%d] pos[%ld], closed\n", fd, ev-g_events);
    } else {
        close(ev->fd);
        printf("recv[fd=%d] error[%d]:%s\n", fd, errno, strerror(errno));
    }

    return;
}

void senddata(int fd, int events, void *arg)
{
    struct myevent_s *ev = (struct myevent_s *)arg;
    int len;

    len = send(fd, ev->buf, ev->len, 0);                    //直接将数据 回写给客户端。未作处理

    eventdel(g_efd, ev);                                //从红黑树g_efd中移除

    if (len > 0) {

        printf("send[fd=%d], [%d]%s\n", fd, len, ev->buf);
        eventset(ev, fd, recvdata, ev);                     //将该fd的 回调函数改为 recvdata
        eventadd(g_efd, EPOLLIN, ev);                       //从新添加到红黑树上, 设为监听读事件

    } else {
        close(ev->fd);                                      //关闭链接
        printf("send[fd=%d] error %s\n", fd, strerror(errno));
    }

    return ;
}

/*创建 socket, 初始化lfd */

void initlistensocket(int efd, short port)
{
    struct sockaddr_in sin;

    int lfd = socket(AF_INET, SOCK_STREAM, 0);
    fcntl(lfd, F_SETFL, O_NONBLOCK);                                            //将socket设为非阻塞

	memset(&sin, 0, sizeof(sin));                                               //bzero(&sin, sizeof(sin))
	sin.sin_family = AF_INET;
	sin.sin_addr.s_addr = INADDR_ANY;
	sin.sin_port = htons(port);

	bind(lfd, (struct sockaddr *)&sin, sizeof(sin));

	listen(lfd, 20);

    /* void eventset(struct myevent_s *ev, int fd, void (*call_back)(int, int, void *), void *arg);  */
    eventset(&g_events[MAX_EVENTS], lfd, acceptconn, &g_events[MAX_EVENTS]);

    /* void eventadd(int efd, int events, struct myevent_s *ev) */
    eventadd(efd, EPOLLIN, &g_events[MAX_EVENTS]);

    return ;
}

int main(int argc, char *argv[])
{
    unsigned short port = SERV_PORT;

    if (argc == 2)
        port = atoi(argv[1]);                           //使用用户指定端口.如未指定,用默认端口

    g_efd = epoll_create(MAX_EVENTS+1);                 //创建红黑树,返回给全局 g_efd 
    if (g_efd <= 0)
        printf("create efd in %s err %s\n", __func__, strerror(errno));

    initlistensocket(g_efd, port);                      //初始化监听socket

    struct epoll_event events[MAX_EVENTS+1];            //保存已经满足就绪事件的文件描述符数组 
	printf("server running:port[%d]\n", port);

    int checkpos = 0, i;
    while (1) {
        /* 超时验证,每次测试100个链接,不测试listenfd 当客户端60秒内没有和服务器通信,则关闭此客户端链接 */

        long now = time(NULL);                          //当前时间
        for (i = 0; i < 100; i++, checkpos++) {         //一次循环检测100个。 使用checkpos控制检测对象
            if (checkpos == MAX_EVENTS)
                checkpos = 0;
            if (g_events[checkpos].status != 1)         //不在红黑树 g_efd 上
                continue;

            long duration = now - g_events[checkpos].last_active;       //客户端不活跃的世间

            if (duration >= 60) {
                close(g_events[checkpos].fd);                           //关闭与该客户端链接
                printf("[fd=%d] timeout\n", g_events[checkpos].fd);
                eventdel(g_efd, &g_events[checkpos]);                   //将该客户端 从红黑树 g_efd移除
            }
        }

        /*监听红黑树g_efd, 将满足的事件的文件描述符加至events数组中, 1秒没有事件满足, 返回 0*/
        int nfd = epoll_wait(g_efd, events, MAX_EVENTS+1, 1000);
        if (nfd < 0) {
            printf("epoll_wait error, exit\n");
            break;
        }

        for (i = 0; i < nfd; i++) {
            /*使用自定义结构体myevent_s类型指针, 接收 联合体data的void *ptr成员*/
            struct myevent_s *ev = (struct myevent_s *)events[i].data.ptr;  

            if ((events[i].events & EPOLLIN) && (ev->events & EPOLLIN)) {           //读就绪事件
                ev->call_back(ev->fd, events[i].events, ev->arg);
                //lfd  EPOLLIN  
            }
            if ((events[i].events & EPOLLOUT) && (ev->events & EPOLLOUT)) {         //写就绪事件
                ev->call_back(ev->fd, events[i].events, ev->arg);
            }
        }
    }

    /* 退出前释放所有资源 */
    return 0;
}

这些东西是怎么互相调用,运行的呢?

核心是:主循环负责等待事件,具体处理通过回调函数在 acceptconn / recvdata / senddata 之间切换。

flowchart TD A[main] --> B[epoll_create] A --> C[initlistensocket] C --> C1[socket] C1 --> C2[fcntl 设置非阻塞] C2 --> C3[bind] C3 --> C4[listen] C4 --> C5[eventset 设置监听fd回调为 acceptconn] C5 --> C6[eventadd 注册 EPOLLIN] A --> D[主事件循环] D --> D1[扫描超时连接] D1 --> D2[epoll_wait] D2 --> E{是否有就绪事件} E -->|监听fd可读| F[acceptconn] E -->|客户端fd可读| G[recvdata] E -->|客户端fd可写| H[senddata] F --> F1[accept] F1 --> F2[fcntl 设置新连接为非阻塞] F2 --> F3[eventset 设置 cfd 回调为 recvdata] F3 --> F4[eventadd 注册 EPOLLIN] G --> G1[recv] G1 --> G2[eventdel] G2 -->|读取成功| G3[eventset 设置 fd 回调为 senddata] G3 --> G4[eventadd 注册 EPOLLOUT] G2 -->|对端关闭| G5[close] G2 -->|读取错误| G6[close] H --> H1[send] H1 --> H2[eventdel] H2 -->|发送成功| H3[eventset 设置 fd 回调为 recvdata] H3 --> H4[eventadd 注册 EPOLLIN] H2 -->|发送失败| H5[close]

为了更好的理解状态转换,下面是一个事件驱动状态图

stateDiagram-v2 [*] --> 监听中 监听中 --> 接受连接: lfd 上 EPOLLIN\nacceptconn() 接受连接 --> 等待读: 新 cfd 注册 EPOLLIN\n回调=recvdata 等待读 --> 处理读: cfd 上 EPOLLIN\nrecvdata() 处理读 --> 等待写: 收到数据 len>0\n注册 EPOLLOUT\n回调=senddata 处理读 --> 关闭连接: len==0 或 len<0 等待写 --> 处理写: cfd 上 EPOLLOUT\nsenddata() 处理写 --> 等待读: 发送成功\n重新注册 EPOLLIN\n回调=recvdata 处理写 --> 关闭连接: 发送失败 等待读 --> 超时关闭: 60秒不活跃 等待写 --> 超时关闭: 60秒不活跃 关闭连接 --> [*]

下面的来自AI

1)关键函数之间的关系

main

入口函数,负责三件事:

  1. 创建 epoll 实例:g_efd = epoll_create(...)
  2. 初始化监听 socket:initlistensocket(g_efd, port)
  3. 进入死循环:
    • 扫描超时连接
    • epoll_wait 等待事件
    • 根据事件类型调用回调函数 ev->call_back(...)

对应代码位置:main 中先初始化监听 socket,再通过 epoll_wait 分发到 acceptconn / recvdata / senddata


initlistensocket

职责是把监听 socket 建起来,并挂到 epoll 上:

  • socket
  • fcntl(... O_NONBLOCK) 设为非阻塞
  • bind
  • listen
  • eventset(..., acceptconn, ...)
  • eventadd(..., EPOLLIN, ...)

也就是说,监听 fd 的读事件一旦就绪,就会触发 acceptconn


acceptconn

当监听 socket 可读时执行,表示有新连接到来

  • accept 拿到客户端 fd
  • 找到 g_events 中一个空闲槽位
  • 把客户端 fd 设为非阻塞
  • eventset(..., recvdata, ...)
  • eventadd(..., EPOLLIN, ...)

这一步完成后,新客户端进入“等待读”状态。


recvdata

当客户端 fd 可读时执行:

  • recv(fd, ev->buf, ...)
  • eventdel,把当前 fd 从 epoll 里摘掉
  • 如果收到数据 len > 0
    • 保存长度
    • 回调切换为 senddata
    • 重新注册 EPOLLOUT
  • 如果 len == 0
    • 对端关闭,close
  • 如果 len < 0
    • 出错,close

这说明它是一个读完后切到写的回显服务器。


senddata

当客户端 fd 可写时执行:

  • send(fd, ev->buf, ev->len, 0)
  • eventdel
  • 如果发送成功
    • 回调切回 recvdata
    • 重新注册 EPOLLIN
  • 否则关闭连接

所以这个连接在运行期间会不断在这两个状态之间切换:

  • recvdata 等待读
  • senddata 等待写

eventset / eventadd / eventdel

这三个函数是“事件管理层”:

eventset

初始化 myevent_s

  • fd
  • 回调函数
  • 事件类型
  • 参数
  • 缓冲区
  • 最后活跃时间 last_active

eventadd

把 fd 加入 epoll 红黑树,监听 EPOLLINEPOLLOUT
本代码中通常用于:

  • 新建监听 socket 后加入监听
  • 新连接加入读监听
  • 读完后改为写监听
  • 写完后改回读监听

eventdel

把 fd 从 epoll 中摘除。
recvdatasenddata 中,都是先摘除,再切换状态,再重新添加


2)主循环的实际分发逻辑

你可以把 main 里的事件分发理解成下面这段伪代码:

while (1) {
    扫描超时连接;
    nfd = epoll_wait(...);

    for (每个就绪事件) {
        ev = events[i].data.ptr;

        if (读事件就绪 && ev本来监听的是读)
            ev->call_back(...);   // 可能是 acceptconn 或 recvdata

        if (写事件就绪 && ev本来监听的是写)
            ev->call_back(...);   // 可能是 senddata
    }
}

这里最关键的是:

ev->call_back(ev->fd, events[i].events, ev->arg);

也就是说,真正的处理逻辑不写死在主循环里,而是通过 myevent_s 中保存的回调函数动态决定。


3)myevent_s 在这段代码里的作用

这个结构体相当于每个 fd 的“上下文对象”:

struct myevent_s {
    int fd;
    int events;
    void *arg;
    void (*call_back)(int fd, int events, void *arg);
    int status;
    char buf[BUFLEN];
    int len;
    long last_active;
};

它同时保存了:

  • 当前 fd 是谁
  • 当前监听什么事件
  • 事件来了调哪个函数
  • 收到的数据缓冲区
  • 数据长度
  • 最近活跃时间

所以可以理解成:
epoll_event.data.ptr 挂的不是裸 fd,而是这个 fd 对应的完整运行上下文。


4)一条连接从创建到回显的完整路径

sequenceDiagram participant Client as 客户端 participant Main as main/epoll_wait participant Listen as acceptconn participant R as recvdata participant S as senddata Client->>Main: 发起 TCP 连接 Main->>Listen: 监听fd EPOLLIN Listen->>Listen: accept() Listen->>Listen: 新 cfd 设非阻塞 Listen->>Main: 注册 cfd 的 EPOLLIN\n回调=recvdata Client->>Main: 发送数据 Main->>R: cfd EPOLLIN R->>R: recv() R->>Main: 切换为 EPOLLOUT\n回调=senddata Main->>S: cfd EPOLLOUT S->>S: send() S->>Main: 切回 EPOLLIN\n回调=recvdata

5)这段代码最值得注意的设计点

优点

  • 结构清晰,适合教学
  • 把 fd、事件、回调、缓冲区封装在 myevent_s
  • 用回调切换读写状态,逻辑直观
  • 主循环只做分发,职责单一

需要注意的问题

1. eventadd()op 变量有风险

这里:

if (ev->status == 0) {
    op = EPOLL_CTL_ADD;
    ev->status = 1;
}
epoll_ctl(efd, op, ev->fd, &epv);

如果 ev->status != 0op 没有赋值。
虽然当前代码基本是 eventdel 后再 eventadd,通常会走 ADD,但写法上不严谨,容易出 bug。更稳妥应显式区分 ADDMOD

2. recvev->buf[len] = '\0' 有越界风险

因为 recv 最多可能读满 sizeof(ev->buf),这时 buf[len] 就越界了。
应当给 recv 留一个字节,或只在 len < sizeof(buf) 时补 \0

3. last_active 没有在收发成功后更新

代码注释说它记录活跃时间,但实际上主要在 eventset 时更新。
如果长连接持续通信,最好在 recvdata / senddata 成功后更新一次。否则超时逻辑可能不够准确。


6)一句话总结这个程序

这是一个基于 epoll + 非阻塞 socket + 回调函数单进程事件驱动回显服务器

  • main 负责等待和分发事件
  • acceptconn 负责接入新连接
  • recvdata 负责读客户端数据
  • senddata 负责回写数据
  • 每个连接通过 myevent_s 保存自己的状态,并在“读/写”之间切换
posted @ 2026-04-15 17:24  BuerH  阅读(10)  评论(0)    收藏  举报