Swoole 源碼分析——Reactor 模塊之 ReactorEpoll

leanxi 發布于2019-07-01 10:29 / 2961人閱讀

摘要：對象的創建在中，最為高效的機制就是。該數據結構中是的，用于在函數接受就緒的事件。為了能夠更為簡便在調用后獲取的類型，并不會僅僅向函數添加，而是會添加類型，該數據結構中包含文件描述符和文件類型。

Epoll 對象的創建

在 linux 中，最為高效的 reactor 機制就是 epoll。swReactor 的 object 會存儲 epoll 的對象 swReactorEpoll_s。該數據結構中 epfd 是 epoll 的 id，events 用于在 epoll_wait 函數接受就緒的事件。

該函數最重要的是 epoll_create，該函數會創建 epoll 對象

typedef struct swReactorEpoll_s swReactorEpoll;

struct swReactorEpoll_s
{
    int epfd;
    struct epoll_event *events;
};

int swReactorEpoll_create(swReactor *reactor, int max_event_num)
{
    //create reactor object
    swReactorEpoll *reactor_object = sw_malloc(sizeof(swReactorEpoll));
    if (reactor_object == NULL)
    {
        swWarn("malloc[0] failed.");
        return SW_ERR;
    }
    bzero(reactor_object, sizeof(swReactorEpoll));
    reactor->object = reactor_object;
    reactor->max_event_num = max_event_num;

    reactor_object->events = sw_calloc(max_event_num, sizeof(struct epoll_event));

    if (reactor_object->events == NULL)
    {
        swWarn("malloc[1] failed.");
        sw_free(reactor_object);
        return SW_ERR;
    }
    //epoll create
    reactor_object->epfd = epoll_create(512);
    if (reactor_object->epfd < 0)
    {
        swWarn("epoll_create failed. Error: %s[%d]", strerror(errno), errno);
        sw_free(reactor_object);
        return SW_ERR;
    }
    //binding method
    reactor->add = swReactorEpoll_add;
    reactor->set = swReactorEpoll_set;
    reactor->del = swReactorEpoll_del;
    reactor->wait = swReactorEpoll_wait;
    reactor->free = swReactorEpoll_free;

    return SW_OK;
}

Epoll 添加監聽

swReactorEpoll_event_set 函數用于轉化可讀(SW_EVENT_READ)、可寫(SW_EVENT_WRITE )的狀態為 epoll 函數可用的 EPOLLIN、EPOLLOUT、EPOLLERR

static sw_inline int swReactorEpoll_event_set(int fdtype)
{
    uint32_t flag = 0;
    if (swReactor_event_read(fdtype))
    {
        flag |= EPOLLIN;
    }
    if (swReactor_event_write(fdtype))
    {
        flag |= EPOLLOUT;
    }
    if (swReactor_event_error(fdtype))
    {
        //flag |= (EPOLLRDHUP);
        flag |= (EPOLLRDHUP | EPOLLHUP | EPOLLERR);
    }
    return flag;
}

swReactorEpoll_add 函數用于為 reactor 添加新的文件描述符進行監控

添加 fd 最為重要的的是利用 epoll_ctl 函數的 EPOLL_CTL_ADD 命令。為了能夠更為簡便在調用 epoll_wait 后獲取 fd 的類型，并不會僅僅向 epoll_ctl 函數添加 fd，而是會添加 swFd 類型，該數據結構中包含文件描述符和文件類型。

swReactor_add 函數用于更新 reactor->socket_list 的 fdtype 與 events

最后需要自增 event_num 的數值

typedef struct _swFd
{
    uint32_t fd;
    uint32_t fdtype;
} swFd;

static int swReactorEpoll_add(swReactor *reactor, int fd, int fdtype)
{
    swReactorEpoll *object = reactor->object;
    struct epoll_event e;
    swFd fd_;
    bzero(&e, sizeof(struct epoll_event));

    fd_.fd = fd;
    fd_.fdtype = swReactor_fdtype(fdtype);
    e.events = swReactorEpoll_event_set(fdtype);

    swReactor_add(reactor, fd, fdtype);

    memcpy(&(e.data.u64), &fd_, sizeof(fd_));
    if (epoll_ctl(object->epfd, EPOLL_CTL_ADD, fd, &e) < 0)
    {
        swSysError("add events[fd=%d#%d, type=%d, events=%d] failed.", fd, reactor->id, fd_.fdtype, e.events);
        swReactor_del(reactor, fd);
        return SW_ERR;
    }

    swTraceLog(SW_TRACE_EVENT, "add event[reactor_id=%d, fd=%d, events=%d]", reactor->id, fd, swReactor_events(fdtype));
    reactor->event_num++;

    return SW_OK;
}

static sw_inline void swReactor_add(swReactor *reactor, int fd, int type)
{
    swConnection *socket = swReactor_get(reactor, fd);
    socket->fdtype = swReactor_fdtype(type);
    socket->events = swReactor_events(type);
    socket->removed = 0;
}

Epoll 修改監聽

修改監聽主要調用 epoll_ctl 的 EPOLL_CTL_MOD 命令

static int swReactorEpoll_set(swReactor *reactor, int fd, int fdtype)
{
    swReactorEpoll *object = reactor->object;
    swFd fd_;
    struct epoll_event e;
    int ret;

    bzero(&e, sizeof(struct epoll_event));
    e.events = swReactorEpoll_event_set(fdtype);

    if (e.events & EPOLLOUT)
    {
        assert(fd > 2);
    }

    fd_.fd = fd;
    fd_.fdtype = swReactor_fdtype(fdtype);
    memcpy(&(e.data.u64), &fd_, sizeof(fd_));

    ret = epoll_ctl(object->epfd, EPOLL_CTL_MOD, fd, &e);
    if (ret < 0)
    {
        swSysError("reactor#%d->set(fd=%d|type=%d|events=%d) failed.", reactor->id, fd, fd_.fdtype, e.events);
        return SW_ERR;
    }
    swTraceLog(SW_TRACE_EVENT, "set event[reactor_id=%d, fd=%d, events=%d]", reactor->id, fd, swReactor_events(fdtype));
    //execute parent method
    swReactor_set(reactor, fd, fdtype);
    return SW_OK;
}

Epoll 刪除監聽

修改監聽主要調用 epoll_ctl 的 EPOLL_CTL_DEL 命令

最后需要更新 event_num

static int swReactorEpoll_del(swReactor *reactor, int fd)
{
    swReactorEpoll *object = reactor->object;
    if (epoll_ctl(object->epfd, EPOLL_CTL_DEL, fd, NULL) < 0)
    {
        swSysError("epoll remove fd[%d#%d] failed.", fd, reactor->id);
        return SW_ERR;
    }

    swTraceLog(SW_TRACE_REACTOR, "remove event[reactor_id=%d|fd=%d]", reactor->id, fd);
    reactor->event_num = reactor->event_num <= 0 ? 0 : reactor->event_num - 1;
    swReactor_del(reactor, fd);

    return SW_OK;
}

Epoll 監聽等待就緒

swReactorEpoll_wait 是 reactor 的核心，該函數最重要的就是調用 epoll_wait

首先需要通過 timeo 參數設置 msec，利用 object->events 設置 events

epoll_wait 函數返回之后，如果 n<0，那么需要先檢查 erron，如果是 EINTR，那么說明有信號觸發，此時需要進行信號的回調函數，然后再繼續事件循環。如果不是 EINTR，那么就要返回錯誤，結束事件循環

如果 n == 0，一般是由于 epoll_wait 已超時，此時需要調用超時回調函數

如果 n > 0，那么就要從 events 中取出已經就緒的 swFd 對象，并利用該對象的值初始化 event

接下來就要檢查 events[i].events 的值，來判斷具體是讀就緒、寫就緒還是發生了錯誤，值得注意的是 EPOLLRDHUP 事件，此事件代表著對端斷開連接，這個是 linux 自從 2.6.17 的新特性

利用 swReactor_getHandle 函數取出對應的文件描述符類型的事件回調函數

事件循環的最后調用 onFinish 函數

如果設置了 once，說明此 reactor 只會循環一次，立即退出；否則，繼續事件循環

typedef struct _swEvent
{
    int fd;
    int16_t from_id;
    uint8_t type;
    swConnection *socket;
} swEvent;

static int swReactorEpoll_wait(swReactor *reactor, struct timeval *timeo)
{
    swEvent event;
    swReactorEpoll *object = reactor->object;
    swReactor_handle handle;
    int i, n, ret, msec;

    int reactor_id = reactor->id;
    int epoll_fd = object->epfd;
    int max_event_num = reactor->max_event_num;
    struct epoll_event *events = object->events;

    if (reactor->timeout_msec == 0)
    {
        if (timeo == NULL)
        {
            reactor->timeout_msec = -1;
        }
        else
        {
            reactor->timeout_msec = timeo->tv_sec * 1000 + timeo->tv_usec / 1000;
        }
    }

    reactor->start = 1;

    while (reactor->running > 0)
    {
        if (reactor->onBegin != NULL)
        {
            reactor->onBegin(reactor);
        }
        msec = reactor->timeout_msec;
        n = epoll_wait(epoll_fd, events, max_event_num, msec);
        if (n < 0)
        {
            if (swReactor_error(reactor) < 0)
            {
                swWarn("[Reactor#%d] epoll_wait failed. Error: %s[%d]", reactor_id, strerror(errno), errno);
                return SW_ERR;
            }
            else
            {
                continue;
            }
        }
        else if (n == 0)
        {
            if (reactor->onTimeout != NULL)
            {
                reactor->onTimeout(reactor);
            }
            continue;
        }
        for (i = 0; i < n; i++)
        {
            event.fd = events[i].data.u64;
            event.from_id = reactor_id;
            event.type = events[i].data.u64 >> 32;
            event.socket = swReactor_get(reactor, event.fd);

            //read
            if ((events[i].events & EPOLLIN) && !event.socket->removed)
            {
                handle = swReactor_getHandle(reactor, SW_EVENT_READ, event.type);
                ret = handle(reactor, &event);
                if (ret < 0)
                {
                    swSysError("EPOLLIN handle failed. fd=%d.", event.fd);
                }
            }
            //write
            if ((events[i].events & EPOLLOUT) && !event.socket->removed)
            {
                handle = swReactor_getHandle(reactor, SW_EVENT_WRITE, event.type);
                ret = handle(reactor, &event);
                if (ret < 0)
                {
                    swSysError("EPOLLOUT handle failed. fd=%d.", event.fd);
                }
            }
            //error
#ifndef NO_EPOLLRDHUP
            if ((events[i].events & (EPOLLRDHUP | EPOLLERR | EPOLLHUP)) && !event.socket->removed)
#else
            if ((events[i].events & (EPOLLERR | EPOLLHUP)) && !event.socket->removed)
#endif
            {
                //ignore ERR and HUP, because event is already processed at IN and OUT handler.
                if ((events[i].events & EPOLLIN) || (events[i].events & EPOLLOUT))
                {
                    continue;
                }
                handle = swReactor_getHandle(reactor, SW_EVENT_ERROR, event.type);
                ret = handle(reactor, &event);
                if (ret < 0)
                {
                    swSysError("EPOLLERR handle failed. fd=%d.", event.fd);
                }
            }
        }

        if (reactor->onFinish != NULL)
        {
            reactor->onFinish(reactor);
        }
        if (reactor->once)
        {
            break;
        }
    }
    return 0;
}

static sw_inline int swReactor_error(swReactor *reactor)
{
    switch (errno)
    {
    case EINTR:
        if (reactor->singal_no)
        {
            swSignal_callback(reactor->singal_no);
            reactor->singal_no = 0;
        }
        return SW_OK;
    }
    return SW_ERR;
}

static sw_inline swReactor_handle swReactor_getHandle(swReactor *reactor, int event_type, int fdtype)
{
    if (event_type == SW_EVENT_WRITE)
    {
        return (reactor->write_handle[fdtype] != NULL) ? reactor->write_handle[fdtype] : reactor->handle[SW_FD_WRITE];
    }
    else if (event_type == SW_EVENT_ERROR)
    {
        return (reactor->error_handle[fdtype] != NULL) ? reactor->error_handle[fdtype] : reactor->handle[SW_FD_CLOSE];
    }
    return reactor->handle[fdtype];
}

GPU云服務器云服務器源碼中文說明之 ReactorEpoll 源碼編譯模塊 linux 模塊源碼

文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。

轉載請注明本文地址：http://specialneedsforspecialkids.com/yun/29217.html

Swoole 源碼分析——Client模塊之Send

摘要：當此時的套接字不可寫的時候，會自動放入緩沖區中。當大于高水線時，會自動調用回調函數。寫就緒狀態當監控到套接字進入了寫就緒狀態時，就會調用函數。如果為，說明此時異步客戶端雖然建立了連接，但是還沒有調用回調函數，因此這時要調用函數。前言上一章我們說了客戶端的連接 connect，對于同步客戶端來說，連接已經建立成功；但是對于異步客戶端來說，此時可能還在進行 DNS 的解析，on...

caozhijian 2019-07-01 10:48 評論0 收藏0
Swoole 源碼分析——Server模塊之Stream 模式

摘要：新建可以看到，自動采用包長檢測的方法該函數主要功能是設置各種回調函數值得注意的是第三個參數代表是否異步。發送數據函數并不是直接發送數據，而是將數據存儲在，等著寫事件就緒之后調用發送數據。 swReactorThread_dispatch 發送數據 reactor 線程會通過 swReactorThread_dispatch 發送數據，當采用 stream 發送數據的時候，會調用 sw...

wums 2019-07-01 10:32 評論0 收藏0
Swoole 源碼分析——Reactor模塊之ReactorBase

前言作為一個網絡框架，最為核心的就是消息的接受與發送。高效的 reactor 模式一直是眾多網絡框架的首要選擇，本節主要講解 swoole 中的 reactor 模塊。 UNP 學習筆記——IO 復用 Reactor 的數據結構 Reactor 的數據結構比較復雜，首先 object 是具體 Reactor 對象的首地址，ptr 是擁有 Reactor 對象的類的指針， event_nu...

baukh789 2019-07-01 10:29 評論0 收藏0
Swoole 源碼分析——基礎模塊之 Pipe 管道

摘要：并沒有使用命名管道。的創建創建匿名管道就是調用函數，程序自動設置管道為非阻塞式。函數同樣的獲取管道文件描述符根據來決定。模塊負責為進程創建與。當線程啟動的時候，會將加入的監控當中。前言管道是進程間通信 IPC 的最基礎的方式，管道有兩種類型：命名管道和匿名管道，匿名管道專門用于具有血緣關系的進程之間，完成數據傳遞，命名管道可以用于任何兩個進程之間。swoole 中的管道都是匿名管道...

Tikitoo 2019-07-01 12:30 評論0 收藏0
Swoole 源碼分析——Server模塊之Start

摘要：是緩存區高水位線，達到了說明緩沖區即將滿了創建線程函數用于將監控的存放于中向中添加監聽的文件描述符等待所有的線程開啟事件循環利用創建線程，線程啟動函數是保存監聽本函數將用于監聽的存放到當中，并設置相應的屬性 Server 的啟動在 server 啟動之前，swoole 首先要調用 php_swoole_register_callback 將 PHP 的回調函數注冊到 server...

3fuyu 2019-07-01 10:29 評論0 收藏0