前端 详解epoll_events结构体

Epoll 作为一种 IO 复用机制多应用与高并发领域，网上有很多如何使用 epoll 的基础教程，但对于 epoll 中很重要的结构体 epoll_event 讲的都模棱两可，这篇文章将做深入解析

在解析之前，先回顾一下 epoll 的使用方法。

• 首先调用int epoll_create(int size);创建一个 epoll
• 调用int epoll_ctl(int epfd, int op, int fd, struct epoll_event *event);为 epoll 注册事件（如果是新建的 epoll 一般 op 选项是EPOLL_CTL_ADD添加事件）
• 调用int epoll_wait(int epfd, struct epoll_event *events, int maxevents, int timeout);等待事件的到来，得到的结果存储在 event 中
• 完全处理完毕后，再次调用int epoll_ctl(int epfd, int op, int fd, struct epoll_event *event);删除已经注册的事件（op 选项是EPOLL_CTL_DEL）

值得注意的是epoll_wait函数只能获取是否有注册事件发生，至于这个事件到底是什么、从哪个 socket 来、发送的时间、包的大小等等信息，统统不知道。这就好比一个人在黑黢黢的山洞里，只能听到声响，至于这个声音是谁发出的根本不知道。因此我们就需要struct epoll_event来帮助我们读取信息。

2.struct epoll_event 结构分析

typedef union epoll_data {
void *ptr;
int fd;
__uint32_t u32;
__uint64_t u64;
} epoll_data_t;

struct epoll_event { __uint32_t events; /* Epoll events / epoll_data_t data; / User data variable */ };

epoll_event 结构体的定义如上所示，分为 events 和 data 两个部分。

events 是 epoll 注册的事件，比如EPOLLIN、EPOLLOUT等等，这个参数在epoll_ctl注册事件时，可以明确告知注册事件的类型。

第二个参数 data 是一个联合体，很多人搞不清除 data 拿来干嘛，网上给的解释一般是传递参数，至于怎么传？有什么用？都不清不楚。下面一个小节将用实例的方式分析。

3.struct epoll_event 使用实例

下面将从两个实际案例中，分析 epoll_event 的作用。

3.1 示例 1：服务器侦听客户端连接

//创建socket
nSocketListen = socket(AF_INET, SOCK_STREAM, IPPROTO_TCP);
...
//绑定地址
struct sockaddr_in local;
memset(&local, 0, sizeof(local));
local.sin_family = AF_INET;
local.sin_addr.s_addr = htonl(INADDR_ANY);//0.0.0.0所有地址都合法
local.sin_port = htons(TCP_PORT);
bind(nSocketListen, (struct sockaddr*) & local, sizeof(local))

//创建epoll nListenEpoll = epoll_create(MAX_LISTEN_EVENTS); //注册事件 struct epoll_event Ev; memset(&Ev, 0, sizeof(epoll_event)); Ev.events= EPOLLIN | EPOLLET Ev.data.fd = nSocketListen;

epoll_ctl(nListenEpoll, EPOLL_CTL_ADD, nSocketListen, &Ev); //侦听 int nFdNumber = epoll_wait(nListenEpoll, lpListenEvents, MAX_LISTEN_EVENTS, -1); //处理侦听结果 for (int i = 0; i < nFdNumber; i++) { if (lpListenEvents[i].data.fd != nSocketListen) continue; ... }

上述代码是网上很常见的 demo 片段，作用是建立一个服务器，侦听所有客户端的连接。具体过程是先建立了一个 socket，地址设为设为 0.0.0.0（所有人都可以连接），然后将这个 socket 的句柄 nSocketListen 附加在注册事件Ev.data.fd上。在 wait 等到结果后做一个判断，看看接收到和预设的是否一致

if (lpListenEvents[i].data.fd != nSocketListen) 
    continue;

这里联合体 data 中的 fd 起到了传递 socket 句柄的作用，这样我们就知道：等到的事件是不是我们想要的 socket 产生的。但是这个网上很常见的 demo 其实并没有体现出 fd 传参的作用！

整个程序仅仅设置并注册了一个 socket 来连接所有 IP 地址htonl(INADDR_ANY);，因此 wait 收到的消息必然来自于这个唯一的 socket，所以这句判断根本是多此一举。

正确的使用方法是：我们可以建立三个 socket 管理不同的字段

Socket 句柄	管理的 IP 地址范围
101	100-120
102	121-191
103	192-255

将这三个 socket 都注册进 epoll 里面，当 wait 到来时，我们就可以根据Ev.data.fd传进来的 socket 句柄来进行处理。比如上午 8 点到 10 点这个时间段，服务器只允许 100-120 范围的 IP 连接进来，就可以做一个判断if (lpListenEvents[i].data.fd == 101),如果是再接受连接。

这个例子中，fd 传递了 socket 的句柄，帮助我们管理不同的网络连接。

3.2 示例 2：线程间通信

//线程A代码
struct epoll_event Ev;
memset(&Ev, 0, sizeof(Ev));
Ev.events= EPOLLOUT | EPOLLET | EPOLLERR | EPOLLHUP
Ev.data.ptr = lpCatList;

epoll_ctl(iClientEpoll, EPOLL_CTL_ADD, lpCatList->nClientSocket, &Ev);

//线程B代码
int nFdNumber = epoll_wait(iClientEpoll, lpEvent, MAX_CLIENT_EVENTS, -1);

IOPACKHEAD_LIST* RelpCatList = (IOPACKHEAD_LIST*)lpEvent[i].data.ptr;

上述 demo 展示了 epoll 在两个线程间协同工作。线程 A 功能相当于接线员，跟 3.1 节展示的服务器功能相同：监听客户的连接，accept 客户的请求，建立客户与服务器间的 socket 连接通道（此处的建立的 socket 句柄为 nClientSocket）。然后将这些客户连接注册到 iClientEpoll 中

这些通道建立后，客户一般不会时刻收发数据，也就是说客户可能不定时的使用为他们建立的 socket 连接通道，线程 B 的 iClientEpoll 就是用来监听有没有已经建立连接的客户需要收发数据的。

如果仅仅像 3.1 节所展示的那样用Ev.data.fd传一个客户 socket 的句柄，这样线程 B 能得到的信息太少了。所以我们需要使用结构体 lpCatList 来传参。

lpCatList 相当于一个令牌，他是一个指针，指向的地址存储了客户的信息（Socket 句柄，IP 地址，MAC 地址，请求时间等等），A 线程在接收客户连接后，将他们写到这个令牌中，一并注册到 iClientEpoll。B 线程就可以利用 Ev.data.ptr 包含的重要的地址信息。

这样 ptr 就相当于一个小纸条，A 线程通过 iClientEpoll 将这个小纸条交到 B 线程手中，B 线程就能了解 A 线程的信息，实现了线程间的通信。

下面我们打印一下线程 A 的 lpCatlist

(gdb) p lpCatList
$18 = (IOPACKHEAD_LIST *) 0x7ffff0001120

再打印一下线程 B 的 ptr，可以发现他们指向同一个地址 0x7ffff0001120，说明参数成功传递

(gdb) p lpEvent[0]
$14 = {events = 4, data = {ptr = 0x7ffff0001120, fd = -268431072, u32 = 4026536224, 
    u64 = 140737219924256}}

详解epoll_events结构体 · 大专栏 (dazhuanlan.com)