C++ 高性能服务器网络框架设计细节

释放双眼,带上耳机,听听看~!

前言

这篇文章我们将介绍服务器的开发,并从多个方面探究如何开发一款高性能高并发的服务器程序。需要注意的是一般大型服务器,其复杂程度在于其业务,而不是在于其代码工程的基本框架。

大型服务器一般有多个服务组成,可能会支持CDN,或者支持所谓的“分布式”等,这篇文章不会介绍这些东西,因为不管结构多么复杂的服务器,都是由单个服务器组成的。所以这篇文章的侧重点是讨论单个服务程序的结构,而且这里的结构指的也是单个服务器的网络通信层结构,如果你能真正地理解了我所说的,那么在这个基础的结构上面开展任何业务都是可以的,也可以将这种结构扩展成复杂的多个服务器组,例如“分布式”服务。

文中的代码示例虽然是以C++为例,但同样适合Java(我本人也是Java开发者),原理都是一样的,只不过Java可能在基本的操作系统网络通信API的基础上用虚拟机包裹了一层接口而已(Java甚至可能基于一些常用的网络通信框架思想提供了一些现成的API,例如NIO)。有鉴于此,这篇文章不讨论那些大而空、泛泛而谈的技术术语,而是讲的是实实在在的能指导读者在实际工作中实践的编码方案或优化已有编码的方法。另外这里讨论的技术同时涉及windows和linux两个平台。

所谓高性能就是服务器能流畅地处理各个客户端的连接并尽量低延迟地应答客户端的请求;所谓高并发,不仅指的是服务器可以同时支持多的客户端连接,而且这些客户端在连接期间内会不断与服务器有数据来往。网络上经常有各种网络库号称单个服务能同时支持百万甚至千万的并发,然后我实际去看了下,结果发现只是能同时支持很多的连接而已。

如果一个服务器能单纯地接受n个连接(n可能很大),但是不能有条不紊地处理与这些连接之间的数据来往也没有任何意义,这种服务器框架只是“玩具型”的,对实际生产和应用没有任何意义。

这篇文章将从两个方面来介绍,一个是服务器中的基础的网络通信部件;另外一个是,如何利用这些基础通信部件整合成一个完整的高效的服务器框架。注意:本文以下内容中的客户端是相对概念,指的是连接到当前讨论的服务程序的终端,所以这里的客户端既可能是我们传统意义上的客户端程序,也可能是连接该服务的其他服务器程序。

一、网络通信部件

按上面介绍的思路,我们先从服务程序的网络通信部件开始介绍。

需要解决的问题

既然是服务器程序肯定会涉及到网络通信部分,那么服务器程序的网络通信模块要解决哪些问题?目前,网络上有很多网络通信框架,如libevent、boost asio、ACE,但都网络通信的常见的技术手段都大同小异,至少要解决以下问题:

  • 如何检测有新客户端连接?

  • 如何接受客户端连接?

  • 如何检测客户端是否有数据发来?

  • 如何收取客户端发来的数据?

  • 如何检测连接异常?发现连接异常之后,如何处理?

  • 如何给客户端发送数据?

  • 如何在给客户端发完数据后关闭连接?

稍微有点网络基础的人,都能回答上面说的其中几个问题,比如接收客户端连接用socket API的accept函数,收取客户端数据用recv函数,给客户端发送数据用send函数,检测客户端是否有新连接和客户端是否有新数据可以用IO multiplexing技术(IO复用)的select、poll、epoll等socket API。确实是这样的,这些基础的socket API构成了服务器网络通信的地基,不管网络通信框架设计的如何巧妙,都是在这些基础的socket API的基础上构建的。但是如何巧妙地组织这些基础的socket API,才是问题的关键。我们说服务器很高效,支持高并发,实际上只是一个技术实现手段,不管怎样,从软件开发的角度来讲无非就是一个程序而已,所以,只要程序能最大可能地满足“尽量减少等待或者不等待”这一原则就是高效的,也就是说高效不是“忙的忙死,闲的闲死”,而是大家都可以闲着,但是如果有活要干,大家尽量一起干,而不是一部分忙着依次做事情123456789,另外一部分闲在那里无所事事。说的可能有点抽象,下面我们来举一些例子具体来说明一下。
例如:

  • 默认情况下,recv函数如果没有数据的时候,线程就会阻塞在那里;

  • 默认情况下,send函数,如果tcp窗口不是足够大,数据发不出去也会阻塞在那里;

  • connect函数默认连接另外一端的时候,也会阻塞在那里;

  • 又或者是给对端发送一份数据,需要等待对端回答,如果对方一直不应答,当前线程就阻塞在这里。

以上都不是高效服务器的开发思维方式,因为上面的例子都不满足“尽量减少等待”的原则,为什么一定要等待呢?有没用一种方法,这些过程不需要等待,最好是不仅不需要等待,而且这些事情完成之后能通知我。这样在这些本来用于等待的cpu时间片内,我就可以做一些其他的事情。有,也就是我们下文要讨论的IO Multiplexing技术(IO复用技术)。

几种IO复用机制的比较

目前windows系统支持select、WSAAsyncSelect、WSAEventSelect、完成端口(IOCP),linux系统支持select、poll、epoll。这里我们不具体介绍每个具体的函数的用法,我们来讨论一点深层次的东西,以上列举的API函数可以分为两个层次:

层次一: select和poll

层次二: WSAAsyncSelect、WSAEventSelect、完成端口(IOCP)、epoll

为什么这么分呢?先来介绍第一层次,select和poll函数本质上还是在一定时间内主动去查询socket句柄(可能是一个也可能是多个)上是否有事件,比如可读事件,可写事件或者出错事件,也就是说我们还是需要每隔一段时间内去主动去做这些检测,如果在这段时间内检测出一些事件来,我们这段时间就算没白花,但是倘若这段时间内没有事件呢?我们只能是做无用功了,说白了,还是在浪费时间,因为假如一个服务器有多个连接,在cpu时间片有限的情况下,我们花费了一定的时间检测了一部分socket连接,却发现它们什么事件都没有,而在这段时间内我们却有一些事情需要处理,那我们为什么要花时间去做这个检测呢?把这个时间用在做我们需要做的事情不好吗?所以对于服务器程序来说,要想高效,我们应该尽量避免花费时间主动去查询一些socket是否有事件,而是等这些socket有事件的时候告诉我们去处理。这也就是层次二的各个函数做的事情,它们实际相当于变主动查询是否有事件为当有事件时,系统会告诉我们,此时我们再去处理,也就是“好钢用在刀刃”上了。只不过层次二的函数通知我们的方式是各不相同,比如WSAAsyncSelect是利用windows窗口消息队列的事件机制来通知我们设定的窗口过程函数,IOCP是利用GetQueuedCompletionStatus返回正确的状态,epoll是epoll_wait函数返回而已。

例如,connect函数连接另外一端,如果用于连接socket是非阻塞的,那么connect虽然不能立刻连接完成,但是也是会立刻返回,无需等待,等连接完成之后,WSAAsyncSelect会返回FD_CONNECT事件告诉我们连接成功,epoll会产生EPOLLOUT事件,我们也能知道连接完成。甚至socket有数据可读时,WSAAsyncSelect产生FD_READ事件,epoll产生EPOLLIN事件,等等。所以有了上面的讨论,我们就可以得到网络通信检测可读可写或者出错事件的正确姿势。这是我这里提出的第二个原则:尽量减少做无用功的时间。这个在服务程序资源够用的情况下可能体现不出来什么优势,但是如果有大量的任务要处理,这里就成了性能的一个瓶颈。

检测网络事件的正确姿势

根据上面的介绍,第一,为了避免无意义的等待时间,第二,不采用主动查询各个socket的事件,而是采用等待操作系统通知我们有事件的状态的策略。我们的socket都要设置成非阻塞的。在此基础上我们回到栏目(一)中提到的七个问题:

如何检测有新客户端连接?

如何接受客户端连接?

默认accept函数会阻塞在那里,如果epoll检测到侦听socket上有EPOLLIN事件,或者WSAAsyncSelect检测到有FD_ACCEPT事件,那么就表明此时有新连接到来,这个时候调用accept函数,就不会阻塞了。当然产生的新socket你应该也设置成非阻塞的。这样我们就能在新socket上收发数据了。

如何检测客户端是否有数据发来?

如何收取客户端发来的数据?

同理,我们也应该在socket上有可读事件的时候才去收取数据,这样我们调用recv或者read函数时不用等待,至于一次性收多少数据好呢?我们可以根据自己的需求来决定,甚至你可以在一个循环里面反复recv或者read,对于非阻塞模式的socket,如果没有数据了,recv或者read也会立刻返回,错误码EWOULDBLOCK会表明当前已经没有数据了。示例:


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
1bool CIUSocket::Recv()
2{
3int nRet = 0;
4
5while(true)
6{
7    char buff[512];
8    nRet = ::recv(m_hSocket, buff, 512, 0);
9    if(nRet == SOCKET_ERROR)                //一旦出现错误就立刻关闭Socket
10    {
11        if (::WSAGetLastError() == WSAEWOULDBLOCK)
12           break;
13        else
14            return false;
15    }
16    else if(nRet < 1)
17        return false;
18
19        m_strRecvBuf.append(buff, nRet);
20
21        ::Sleep(1);
22    }
23
24    return true;
25}
26

如何检测连接异常?发现连接异常之后,如何处理?

同样当我们收到异常事件后例如EPOLLERR或关闭事件FD_CLOSE,我们就知道了有异常产生,我们对异常的处理一般就是关闭对应的socket。另外,如果send/recv或者read/write函数对一个socket进行操作时,如果返回0,那说明对端已经关闭了socket,此时这路连接也没必要存在了,我们也可以关闭对应的socket。

如何给客户端发送数据?

这也是一道常见的网络通信面试题,某一年的腾讯后台开发职位就问到过这样的问题。给客户端发送数据,比收数据要稍微麻烦一点,也是需要讲点技巧的。首先我们不能像注册检测数据可读事件一样一开始就注册检测数据可写事件,因为如果检测可写的话,一般情况下只要对端正常收取数据,我们的socket就都是可写的,如果我们设置监听可写事件,会导致频繁地触发可写事件,但是我们此时并不一定有数据需要发送。所以正确的做法是:如果有数据要发送,则先尝试着去发送,如果发送不了或者只发送出去部分,剩下的我们需要将其缓存起来,然后再设置检测该socket上可写事件,下次可写事件产生时,再继续发送,如果还是不能完全发出去,则继续设置侦听可写事件,如此往复,一直到所有数据都发出去为止。一旦所有数据都发出去以后,我们要移除侦听可写事件,避免无用的可写事件通知。不知道你注意到没有,如果某次只发出去部分数据,剩下的数据应该暂且存起来,这个时候我们就需要一个缓冲区来存放这部分数据,这个缓冲区我们称为“发送缓冲区”。发送缓冲区不仅存放本次没有发完的数据,还用来存放在发送过程中,上层又传来的新的需要发送的数据。为了保证顺序,新的数据应该追加在当前剩下的数据的后面,发送的时候从发送缓冲区的头部开始发送。也就是说先来的先发送,后来的后发送。

如何在给客户端发完数据后关闭连接?

这个问题比较难处理,因为这里的“发送完”不一定是真正的发送完,我们调用send或者write函数即使成功,也只是向操作系统的协议栈里面成功写入数据,至于能否被发出去、何时被发出去很难判断,发出去对方是否收到就更难判断了。所以,我们目前只能简单地认为send或者write返回我们发出数据的字节数大小,我们就认为“发完数据”了。然后调用close等socket API关闭连接。当然,你也可以调用shutdown函数来实现所谓的“半关闭”。关于关闭连接的话题,我们再单独开一个小的标题来专门讨论一下。

被动关闭连接和主动关闭连接

在实际的应用中,被动关闭连接是由于我们检测到了连接的异常事件,比如EPOLLERR,或者对端关闭连接,send或recv返回0,这个时候这路连接已经没有存在必要的意义了,我们被迫关闭连接。

而主动关闭连接,是我们主动调用close/closesocket来关闭连接。比如客户端给我们发送非法的数据,比如一些网络攻击的尝试性数据包。这个时候出于安全考虑,我们关闭socket连接。

发送缓冲区和接收缓冲区

上面已经介绍了发送缓冲区了,并说明了其存在的意义。接收缓冲区也是一样的道理,当收到数据以后,我们可以直接进行解包,但是这样并不好,理由一:除非一些约定俗称的协议格式,比如http协议,大多数服务器的业务的协议都是不同的,也就是说一个数据包里面的数据格式的解读应该是业务层的事情,和网络通信层应该解耦,为了网络层更加通用,我们无法知道上层协议长成什么样子,因为不同的协议格式是不一样的,它们与具体的业务有关。理由二:即使知道协议格式,我们在网络层进行解包处理对应的业务,如果这个业务处理比较耗时,比如需要进行复杂的运算,或者连接数据库进行账号密码验证,那么我们的网络线程会需要大量时间来处理这些任务,这样其它网络事件可能没法及时处理。鉴于以上二点,我们确实需要一个接收缓冲区,将收取到的数据放到该缓冲区里面去,并由专门的业务线程或者业务逻辑去从接收缓冲区中取出数据,并解包处理业务。

说了这么多,那发送缓冲区和接收缓冲区该设计成多大的容量?这是一个老生常谈的问题了,因为我们经常遇到这样的问题:预分配的内存太小不够用,太大的话可能会造成浪费。怎么办呢?答案就是像string、vector一样,设计出一个可以动态增长的缓冲区,按需分配,不够还可以扩展。

需要特别注意的是,这里说的发送缓冲区和接收缓冲区是每一个socket连接都存在一个。这是我们最常见的设计方案。

协议的设计

除了一些通用的协议,如http、ftp协议以外,大多数服务器协议都是根据业务制定的。协议设计好了,数据包的格式就根据协议来设置。我们知道tcp/ip协议是流式数据,所以流式数据就是像流水一样,数据包与数据包之间没有明显的界限。比如A端给B端连续发了三个数据包,每个数据包都是50个字节,B端可能先收到10个字节,再收到140个字节;或者先收到20个字节,再收到20个字节,再收到110个字节;也可能一次性收到150个字节。这150个字节可以以任何字节数目组合和次数被B收到。所以我们讨论协议的设计第一个问题就是如何界定包的界限,也就是接收端如何知道每个包数据的大小。目前常用有如下三种方法:

固定大小,这种方法就是假定每一个包的大小都是固定字节数目,例如上文中讨论的每个包大小都是50个字节,接收端每收气50个字节就当成一个包。

指定包结束符,例如以一个\r\n(换行符和回车符)结束,这样对端只要收到这样的结束符,就可以认为收到了一个包,接下来的数据是下一个包的内容。

指定包的大小,这种方法结合了上述两种方法,一般包头是固定大小,包头中有一个字段指定包
体或者整个大的大小,对端收到数据以后先解析包头中的字段得到包体或者整个包的大小,然后根据这个大小去界定数据的界线。

协议要讨论的第二个问题是,设计协议的时候要尽量方便解包,也就是说协议的格式字段应该尽量清晰明了。

协议要讨论的第三个问题是,根据协议组装的单个数据包应该尽量小,注意这里指的是单个数据包,这样有如下好处:第一、对于一些移动端设备来说,其数据处理能力和带宽能力有限,小的数据不仅能加快处理速度,同时节省大量流量费用;第二、如果单个数据包足够小的话,对频繁进行网络通信的服务器端来说,可以大大减小其带宽压力,其所在的系统也能使用更少的内存。试想:假如一个股票服务器,如果一只股票的数据包是100个字节或者1000个字节,那同样是10000只股票区别呢?

协议要讨论的第四个问题是,对于数值类型,我们应该显式地指定数值的长度,比如long型,在32位机器上是32位4个字节,但是如果在64位机器上,就变成了64位8个字节了。这样同样是一个long型,发送方和接收方可能因为机器位数的不同会用不同的长度去解码。所以建议最好,在涉及到跨平台使用的协议最好显式地指定协议中整型字段的长度,比如int32、int64等等。下面是一个协议的接口的例子,当然java程序员应该很熟悉这样的接口:


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
1    class BinaryReadStream
2{
3    private:
4        const char* const ptr;
5        const size_t      len;
6        const char*       cur;
7        BinaryReadStream(const BinaryReadStream&);
8        BinaryReadStream& operator=(const BinaryReadStream&);
9
10    public:
11        BinaryReadStream(const char* ptr, size_t len);
12        virtual const char* GetData() const;
13        virtual size_t GetSize() const;
14        bool IsEmpty() const;
15        bool ReadString(string* str, size_t maxlen, size_t& outlen);
16        bool ReadCString(char* str, size_t strlen, size_t& len);
17        bool ReadCCString(const char** str, size_t maxlen, size_t& outlen);
18        bool ReadInt32(int32_t& i);
19        bool ReadInt64(int64_t& i);
20        bool ReadShort(short& i);
21        bool ReadChar(char& c);
22        size_t ReadAll(char* szBuffer, size_t iLen) const;
23        bool IsEnd() const;
24        const char* GetCurrent() const{ return cur; }
25
26    public:
27        bool ReadLength(size_t & len);
28        bool ReadLengthWithoutOffset(size_t &headlen, size_t & outlen);
29    };
30
31    class BinaryWriteStream
32    {
33    public:
34        BinaryWriteStream(string* data);
35        virtual const char* GetData() const;
36        virtual size_t GetSize() const;
37        bool WriteCString(const char* str, size_t len);
38        bool WriteString(const string& str);
39        bool WriteDouble(double value, bool isNULL = false);
40        bool WriteInt64(int64_t value, bool isNULL = false);
41        bool WriteInt32(int32_t i, bool isNULL = false);
42        bool WriteShort(short i, bool isNULL = false);
43        bool WriteChar(char c, bool isNULL = false);
44        size_t GetCurrentPos() const{ return m_data->length(); }
45        void Flush();
46        void Clear();
47    private:
48        string* m_data;
49    };
50

其中BinaryWriteStream是编码协议的类,BinaryReadStream是解码协议的类。可以按下面这种方式来编码和解码。

编码:


1
2
3
4
5
6
7
1std::string outbuf;
2BinaryWriteStream writeStream(&outbuf);
3writeStream.WriteInt32(msg_type_register);
4writeStream.WriteInt32(m_seq);
5writeStream.WriteString(retData);
6writeStream.Flush();
7

解码:


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
1BinaryReadStream readStream(strMsg.c_str(), strMsg.length());
2int32_t cmd;
3if (!readStream.ReadInt32(cmd))
4{
5return false;
6}
7
8//int seq;
9if (!readStream.ReadInt32(m_seq))
10{
11        return false;
12}
13
14std::string data;
15size_t datalength;
16if (!readStream.ReadString(&data, 0, datalength))
17{
18        return false;
19}
20
21

二、服务器程序结构的组织

上面的六个标题,我们讨论了很多具体的细节问题,现在是时候讨论将这些细节组织起来了。根据我的个人经验,目前主流的思想是one thread one loop+reactor模式(也有proactor模式)的策略。通俗点说就是一个线程一个循环,即在一个线程的函数里面不断地循环依次做一些事情,这些事情包括检测网络事件、解包数据产生业务逻辑。我们先从最简单地来说,设定一些线程在一个循环里面做网络通信相关的事情,伪码如下:


1
2
3
4
5
6
7
8
9
10
11
12
13
1while(退出标志)  
2{  
3  //IO复用技术检测socket可读事件、出错事件  
4       //(如果有数据要发送,则也检测可写事件)  
5
6     //如果有可读事件,对于侦听socket则接收新连接;  
7      //对于普通socket则收取该socket上的数据,收取的数据存入对应的接收缓冲区,如果出错则关闭连接;  
8
9     //如果有数据要发送,有可写事件,则发送数据  
10
11     //如果有出错事件,关闭该连接  
12}  
13

另外设定一些线程去处理接收到的数据,并解包处理业务逻辑,这些线程可以认为是业务线程了,伪码如下:


1
2
3
1//从接收缓冲区中取出数据解包,分解成不同的业务来处理  
2
3

上面的结构是目前最通用的服务器逻辑结构,但是能不能再简化一下或者说再综合一下呢?我们试试,你想过这样的问题没有:假如现在的机器有两个cpu(准确的来说应该是两个核),我们的网络线程数量是2个,业务逻辑线程也是2个,这样可能存在的情况就是:业务线程运行的时候,网络线程并没有运行,它们必须等待,如果是这样的话,干嘛要多建两个线程呢?除了程序结构上可能稍微清楚一点,对程序性能没有任何实质性提高,而且白白浪费cpu时间片在线程上下文切换上。所以,我们可以将网络线程与业务逻辑线程合并,合并后的伪码看起来是这样子的:


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
1while(退出标志)  
2{  
3       //IO复用技术检测socket可读事件、出错事件  
4       //(如果有数据要发送,则也检测可写事件)  
5
6      //如果有可读事件,对于侦听socket则接收新连接;  
7      //对于普通socket则收取该socket上的数据,收取的数据存入对应的接收缓冲区,如果出错则关闭连接;  
8
9      //如果有数据要发送,有可写事件,则发送数据  
10
11      //如果有出错事件,关闭该连接  
12
13      //从接收缓冲区中取出数据解包,分解成不同的业务来处理  
14}  
15

你没看错,其实就是简单的合并,合并之后和不仅可以达到原来合并前的效果,而且在没有网络IO事件的时候,可以及时处理我们想处理的一些业务逻辑,并且减少了不必要的线程上下文切换时间。

我们再更进一步,甚至我们可以在这个while循环增加其它的一些任务的处理,比如程序的逻辑任务队列、定时器事件等等,伪码如下:


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
1    while(退出标志)  
2{  
3          //定时器事件处理  
4
5    //IO复用技术检测socket可读事件、出错事件  
6    //(如果有数据要发送,则也检测可写事件)  
7
8    //如果有可读事件,对于侦听socket则接收新连接;  
9    //对于普通socket则收取该socket上的数据,收取的数据存入对应的接收缓冲区,如果出错则关闭连接;  
10
11    //如果有数据要发送,有可写事件,则发送数据  
12
13    //如果有出错事件,关闭该连接  
14
15    //从接收缓冲区中取出数据解包,分解成不同的业务来处理  
16
17    //程序自定义任务1  
18
19    //程序自定义任务2  
20}
21

注意:之所以将定时器事件的处理放在网络IO事件的检测之前,是因为避免定时器事件过期时间太长。假如放在后面的话,可能前面的处理耗费了一点时间,等到处理定时器事件时,时间间隔已经过去了不少时间。虽然这样处理,也没法保证定时器事件百分百精确,但是能尽量保证。当然linux系统下提供eventfd这样的定时器对象,所有的定时器对象就能像处理socket这样的fd一样统一成处理。这也是网络库libevent的思想很像,libevent将socket、定时器、信号封装成统一的对象进行处理。

说了这么多理论性的东西,我们来一款流行的开源网络库muduo来说明吧(作者:陈硕),原库是基于boost的,我改成了C++11的版本,并修改了一些bug,在此感谢原作者陈硕。

上文介绍的核心线程函数的while循环位于eventloop.cpp中:


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
1void EventLoop::loop()
2{
3    assert(!looping_);
4    assertInLoopThread();
5    looping_ = true;
6    quit_ = false;  // FIXME: what if someone calls quit() before loop() ?
7    LOG_TRACE << "EventLoop " << this << " start looping";
8
9    while (!quit_)
10    {
11        activeChannels_.clear();
12        pollReturnTime_ = poller_->poll(kPollTimeMs, &activeChannels_);
13        ++iteration_;
14        if (Logger::logLevel() <= Logger::TRACE)
15        {
16            printActiveChannels();
17        }
18        // TODO sort channel by priority
19        eventHandling_ = true;
20        for (ChannelList::iterator it = activeChannels_.begin();
21            it != activeChannels_.end(); ++it)
22        {
23            currentActiveChannel_ = *it;
24            currentActiveChannel_->handleEvent(pollReturnTime_);
25        }
26        currentActiveChannel_ = NULL;
27        eventHandling_ = false;
28        doPendingFunctors();
29
30        if (frameFunctor_)
31        {
32            frameFunctor_();
33        }      
34    }
35
36    LOG_TRACE << "EventLoop " << this << " stop looping";
37    looping_ = false;
38}
39

poller_->poll利用epoll分离网络事件,然后接着处理分离出来的网络事件,每一个客户端socket对应一个连接,即一个TcpConnection和Channel通道对象。currentActiveChannel_->handleEvent(pollReturnTime_)根据是可读、可写、出错事件来调用对应的处理函数,这些函数都是回调函数,程序初始化阶段设置进来的:


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
1    void Channel::handleEvent(Timestamp receiveTime)  
2{  
3    std::shared_ptr<void> guard;  
4    if (tied_)  
5    {  
6        guard = tie_.lock();  
7        if (guard)  
8        {  
9            handleEventWithGuard(receiveTime);  
10        }  
11    }  
12    else  
13    {  
14        handleEventWithGuard(receiveTime);  
15    }  
16}  
17
18void Channel::handleEventWithGuard(Timestamp receiveTime)  
19{  
20    eventHandling_ = true;  
21    LOG_TRACE << reventsToString();  
22    if ((revents_ & POLLHUP) && !(revents_ & POLLIN))  
23    {  
24        if (logHup_)  
25        {  
26            LOG_WARN << "Channel::handle_event() POLLHUP";  
27        }  
28        if (closeCallback_) closeCallback_();  
29    }  
30
31    if (revents_ & POLLNVAL)  
32    {  
33        LOG_WARN << "Channel::handle_event() POLLNVAL";  
34    }  
35
36    if (revents_ & (POLLERR | POLLNVAL))  
37    {  
38        if (errorCallback_) errorCallback_();  
39    }  
40    if (revents_ & (POLLIN | POLLPRI | POLLRDHUP))  
41    {  
42        //当是侦听socket时,readCallback_指向Acceptor::handleRead  
43        //当是客户端socket时,调用TcpConnection::handleRead  
44        if (readCallback_) readCallback_(receiveTime);  
45    }  
46    if (revents_ & POLLOUT)  
47    {  
48        //如果是连接状态服的socket,则writeCallback_指向Connector::handleWrite()  
49        if (writeCallback_) writeCallback_();  
50    }  
51    eventHandling_ = false;  
52}
53

当然,这里利用了Channel对象的“多态性”,如果是普通socket,可读事件就会调用预先设置的回调函数;但是如果是侦听socket,则调用Aceptor对象的handleRead()
来接收新连接:


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
1 void Acceptor::handleRead()  
2{  
3    loop_->assertInLoopThread();  
4    InetAddress peerAddr;  
5    //FIXME loop until no more  
6    int connfd = acceptSocket_.accept(&peerAddr);  
7    if (connfd >= 0)  
8    {  
9        // string hostport = peerAddr.toIpPort();  
10        // LOG_TRACE << "Accepts of " << hostport;  
11        //newConnectionCallback_实际指向TcpServer::newConnection(int sockfd, const InetAddress& peerAddr)  
12        if (newConnectionCallback_)  
13        {  
14            newConnectionCallback_(connfd, peerAddr);  
15        }  
16        else  
17        {  
18            sockets::close(connfd);  
19        }  
20    }  
21    else  
22    {  
23        LOG_SYSERR << "in Acceptor::handleRead";  
24        // Read the section named "The special problem of  
25        // accept()ing when you can't" in libev's doc.  
26        // By Marc Lehmann, author of livev.  
27        if (errno == EMFILE)  
28        {  
29            ::close(idleFd_);  
30            idleFd_ = ::accept(acceptSocket_.fd(), NULL, NULL);  
31            ::close(idleFd_);  
32            idleFd_ = ::open("/dev/null", O_RDONLY | O_CLOEXEC);  
33        }  
34    }  
35}  
36

主循环里面的业务逻辑处理对应:


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
1    doPendingFunctors();  
2
3if (frameFunctor_)  
4{  
5   frameFunctor_();  
6}        
7
8[cpp] view plain copy
9void EventLoop::doPendingFunctors()  
10{  
11    std::vector<Functor> functors;  
12    callingPendingFunctors_ = true;  
13
14    {  
15        std::unique_lock<std::mutex> lock(mutex_);  
16        functors.swap(pendingFunctors_);  
17    }  
18
19    for (size_t i = 0; i < functors.size(); ++i)  
20    {  
21        functors[i]();  
22    }  
23    callingPendingFunctors_ = false;  
24}  
25

这里增加业务逻辑是增加执行任务的函数指针的,增加的任务保存在成员变量pendingFunctors_中,这个变量是一个函数指针数组(vector对象),执行的时候,调用每个函数就可以了。上面的代码先利用一个栈变量将成员变量pendingFunctors_里面的函数指针换过来,接下来对这个栈变量进行操作就可以了,这样减少了锁的粒度。因为成员变量pendingFunctors_在增加任务的时候,也会被用到,设计到多个线程操作,所以要加锁,增加任务的地方是:


1
2
3
4
5
6
7
8
9
10
11
12
13
1void EventLoop::queueInLoop(const Functor& cb)  
2{  
3         {  
4            std::unique_lock<std::mutex> lock(mutex_);  
5            pendingFunctors_.push_back(cb);  
6        }  
7
8    if (!isInLoopThread() || callingPendingFunctors_)  
9    {  
10        wakeup();  
11    }  
12}  
13

而frameFunctor_就更简单了,就是通过设置一个函数指针就可以了。当然这里有个技巧性的东西,即增加任务的时候,为了能够立即执行,使用唤醒机制,通过往一个fd里面写入简单的几个字节,来唤醒epoll,使其立刻返回,因为此时没有其它的socke有事件,这样接下来就执行刚才添加的任务了。

我们看一下数据收取的逻辑:


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
1void TcpConnection::handleRead(Timestamp receiveTime)  
2{  
3    loop_->assertInLoopThread();  
4    int savedErrno = 0;  
5    ssize_t n = inputBuffer_.readFd(channel_->fd(), &savedErrno);  
6    if (n > 0)  
7    {  
8        //messageCallback_指向CTcpSession::OnRead(const std::shared_ptr<TcpConnection>& conn, Buffer* pBuffer, Timestamp receiveTime)  
9        messageCallback_(shared_from_this(), &inputBuffer_, receiveTime);  
10    }  
11    else if (n == 0)  
12    {  
13        handleClose();  
14    }  
15    else  
16    {  
17        errno = savedErrno;  
18        LOG_SYSERR << "TcpConnection::handleRead";  
19        handleError();  
20    }  
21}  
22

将收到的数据放到接收缓冲区里面,将来我们来解包:


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
1void ClientSession::OnRead(const std::shared_ptr<TcpConnection>& conn, Buffer* pBuffer, Timestamp receivTime)  
2{  
3    while (true)  
4    {  
5        //不够一个包头大小  
6        if (pBuffer->readableBytes() < (size_t)sizeof(msg))  
7        {  
8            LOG_INFO << "buffer is not enough for a package header, pBuffer->readableBytes()=" << pBuffer->readableBytes() << ", sizeof(msg)=" << sizeof(msg);  
9            return;  
10        }  
11
12        //不够一个整包大小  
13        msg header;  
14        memcpy(&header, pBuffer->peek(), sizeof(msg));  
15        if (pBuffer->readableBytes() < (size_t)header.packagesize + sizeof(msg))  
16            return;  
17
18        pBuffer->retrieve(sizeof(msg));  
19        std::string inbuf;  
20        inbuf.append(pBuffer->peek(), header.packagesize);  
21        pBuffer->retrieve(header.packagesize);  
22        if (!Process(conn, inbuf.c_str(), inbuf.length()))  
23        {  
24            LOG_WARN << "Process error, close TcpConnection";  
25            conn->forceClose();  
26        }  
27    }// end while-loop  
28
29}  
30

先判断接收缓冲区里面的数据是否够一个包头大小,如果够再判断够不够包头指定的包体大小,如果还是够的话,接着在Process函数里面处理该包。

再看看发送数据的逻辑:


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
1void TcpConnection::sendInLoop(const void* data, size_t len)  
2{  
3    loop_->assertInLoopThread();  
4    ssize_t nwrote = 0;  
5    size_t remaining = len;  
6    bool faultError = false;  
7    if (state_ == kDisconnected)  
8    {  
9        LOG_WARN << "disconnected, give up writing";  
10        return;  
11    }  
12    // if no thing in output queue, try writing directly  
13    if (!channel_->isWriting() && outputBuffer_.readableBytes() == 0)  
14    {  
15        nwrote = sockets::write(channel_->fd(), data, len);  
16        if (nwrote >= 0)  
17        {  
18            remaining = len - nwrote;  
19            if (remaining == 0 && writeCompleteCallback_)  
20            {  
21                loop_->queueInLoop(std::bind(writeCompleteCallback_, shared_from_this()));  
22            }  
23        }  
24        else // nwrote < 0  
25        {  
26            nwrote = 0;  
27            if (errno != EWOULDBLOCK)  
28            {  
29                LOG_SYSERR << "TcpConnection::sendInLoop";  
30                if (errno == EPIPE || errno == ECONNRESET) // FIXME: any others?  
31                {  
32                    faultError = true;  
33                }  
34            }  
35        }  
36    }  
37
38    assert(remaining <= len);  
39    if (!faultError && remaining > 0)  
40    {  
41        size_t oldLen = outputBuffer_.readableBytes();  
42        if (oldLen + remaining >= highWaterMark_                          
43            && oldLen < highWaterMark_  
44            && highWaterMarkCallback_)  
45        {  
46            loop_->queueInLoop(std::bind(highWaterMarkCallback_, shared_from_this(), oldLen + remaining));  
47        }  
48        outputBuffer_.append(static_cast<const char*>(data)+nwrote, remaining);  
49        if (!channel_->isWriting())  
50        {  
51            channel_->enableWriting();  
52        }  
53    }  
54}  
55

如果剩余的数据remaining大于则调用channel_->enableWriting();开始监听可写事件,可写事件处理如下:


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
1[cpp] view plain copy
2void TcpConnection::handleWrite()  
3{  
4    loop_->assertInLoopThread();  
5    if (channel_->isWriting())  
6    {  
7        ssize_t n = sockets::write(channel_->fd(),  
8            outputBuffer_.peek(),  
9            outputBuffer_.readableBytes());  
10        if (n > 0)  
11        {  
12            outputBuffer_.retrieve(n);  
13            if (outputBuffer_.readableBytes() == 0)  
14            {  
15                channel_->disableWriting();  
16                if (writeCompleteCallback_)  
17                {  
18                    loop_->queueInLoop(std::bind(writeCompleteCallback_, shared_from_this()));  
19                }  
20                if (state_ == kDisconnecting)  
21                {  
22                    shutdownInLoop();  
23                }  
24            }  
25        }  
26        else  
27        {  
28            LOG_SYSERR << "TcpConnection::handleWrite";  
29            // if (state_ == kDisconnecting)  
30            // {  
31            //   shutdownInLoop();  
32            // }  
33        }  
34    }  
35    else  
36    {  
37        LOG_TRACE << "Connection fd = " << channel_->fd()  
38            << " is down, no more writing";  
39    }  
40}  
41

如果发送完数据以后调用channel_->disableWriting();移除监听可写事件。

很多读者可能一直想问,文中不是说解包数据并处理逻辑是业务代码而非网络通信的代码,你这里貌似都混在一起了,其实没有,这里实际的业务代码处理都是框架曾提供的回调函数里面处理的,具体怎么处理,由框架使用者——业务层自己定义。

总结起来,实际上就是一个线程函数里一个loop那么点事情,不信你再看我曾经工作上的一个交易系统服务器项目代码:


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
1void CEventDispatcher::Run()  
2{  
3    m_bShouldRun = true;  
4    while(m_bShouldRun)  
5    {  
6        DispatchIOs();        
7        SyncTime();  
8        CheckTimer();  
9        DispatchEvents();  
10    }  
11}  
12
13void CEpollReactor::DispatchIOs()  
14{  
15    DWORD dwSelectTimeOut = SR_DEFAULT_EPOLL_TIMEOUT;  
16    if (HandleOtherTask())  
17    {  
18        dwSelectTimeOut = 0;  
19    }  
20
21    struct epoll_event ev;  
22    CEventHandlerIdMap::iterator itor = m_mapEventHandlerId.begin();  
23    for(; itor!=m_mapEventHandlerId.end(); itor++)  
24    {  
25        CEventHandler *pEventHandler = (CEventHandler *)(*itor).first;  
26        if(pEventHandler == NULL){  
27            continue;  
28        }  
29        ev.data.ptr = pEventHandler;  
30        ev.events = 0;  
31        int nReadID, nWriteID;  
32        pEventHandler->GetIds(&nReadID, &nWriteID);    
33        if (nReadID > 0)  
34        {  
35            ev.events |= EPOLLIN;  
36        }  
37        if (nWriteID > 0)  
38        {  
39            ev.events |= EPOLLOUT;  
40        }  
41
42        epoll_ctl(m_fdEpoll, EPOLL_CTL_MOD, (*itor).second, &ev);  
43    }  
44
45    struct epoll_event events[EPOLL_MAX_EVENTS];  
46
47    int nfds = epoll_wait(m_fdEpoll, events, EPOLL_MAX_EVENTS, dwSelectTimeOut/1000);  
48
49    for (int i=0; i<nfds; i++)  
50    {  
51        struct epoll_event &evref = events[i];  
52        CEventHandler *pEventHandler = (CEventHandler *)evref.data.ptr;  
53        if ((evref.events|EPOLLIN)!=0 && m_mapEventHandlerId.find(pEventHandler)!=m_mapEventHandlerId.end())  
54        {  
55            pEventHandler->HandleInput();  
56        }  
57        if ((evref.events|EPOLLOUT)!=0 && m_mapEventHandlerId.find(pEventHandler)!=m_mapEventHandlerId.end())  
58        {  
59            pEventHandler->HandleOutput();  
60        }  
61    }    
62}  
63
64void CEventDispatcher::DispatchEvents()  
65{  
66    CEvent event;  
67    CSyncEvent *pSyncEvent;  
68    while(m_queueEvent.PeekEvent(event))  
69    {  
70        int nRetval;  
71
72        if(event.pEventHandler != NULL)  
73        {  
74            nRetval = event.pEventHandler->HandleEvent(event.nEventID, event.dwParam, event.pParam);  
75        }  
76        else  
77        {  
78            nRetval = HandleEvent(event.nEventID, event.dwParam, event.pParam);  
79        }  
80
81        if(event.pAdd != NULL)      //同步消息  
82        {  
83            pSyncEvent=(CSyncEvent *)event.pAdd;  
84            pSyncEvent->nRetval = nRetval;  
85            pSyncEvent->sem.UnLock();  
86        }  
87    }  
88}  
89

再看看蘑菇街开源的TeamTalk的源码(代码下载地址:https://github.com/baloonwj/TeamTalk):


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
1    void CEventDispatch::StartDispatch(uint32_t wait_timeout)  
2{  
3    fd_set read_set, write_set, excep_set;  
4    timeval timeout;  
5    timeout.tv_sec = 0;  
6    timeout.tv_usec = wait_timeout * 1000;  // 10 millisecond  
7
8    if(running)  
9        return;  
10    running = true;  
11
12    while (running)  
13   {  
14                      _CheckTimer();  
15              _CheckLoop();  
16
17        if (!m_read_set.fd_count && !m_write_set.fd_count && !m_excep_set.fd_count)  
18        {  
19            Sleep(MIN_TIMER_DURATION);  
20            continue;  
21        }  
22
23        m_lock.lock();  
24        memcpy(&read_set, &m_read_set, sizeof(fd_set));  
25        memcpy(&write_set, &m_write_set, sizeof(fd_set));  
26        memcpy(&excep_set, &m_excep_set, sizeof(fd_set));  
27        m_lock.unlock();  
28
29        int nfds = select(0, &read_set, &write_set, &excep_set, &timeout);  
30
31        if (nfds == SOCKET_ERROR)  
32        {  
33            log("select failed, error code: %d", GetLastError());  
34            Sleep(MIN_TIMER_DURATION);  
35            continue;           // select again  
36        }  
37
38        if (nfds == 0)  
39        {  
40            continue;  
41        }  
42
43        for (u_int i = 0; i < read_set.fd_count; i++)  
44        {  
45            //log("select return read count=%d\n", read_set.fd_count);  
46            SOCKET fd = read_set.fd_array[i];  
47            CBaseSocket* pSocket = FindBaseSocket((net_handle_t)fd);  
48            if (pSocket)  
49            {  
50                pSocket->OnRead();  
51                pSocket->ReleaseRef();  
52            }  
53        }  
54
55        for (u_int i = 0; i < write_set.fd_count; i++)  
56        {  
57            //log("select return write count=%d\n", write_set.fd_count);  
58            SOCKET fd = write_set.fd_array[i];  
59            CBaseSocket* pSocket = FindBaseSocket((net_handle_t)fd);  
60            if (pSocket)  
61            {  
62                pSocket->OnWrite();  
63                pSocket->ReleaseRef();  
64            }  
65        }  
66
67        for (u_int i = 0; i < excep_set.fd_count; i++)  
68        {  
69            //log("select return exception count=%d\n", excep_set.fd_count);  
70            SOCKET fd = excep_set.fd_array[i];  
71            CBaseSocket* pSocket = FindBaseSocket((net_handle_t)fd);  
72            if (pSocket)  
73            {  
74                pSocket->OnClose();  
75                pSocket->ReleaseRef();  
76            }  
77        }  
78
79    }  
80}  
81
82

再看filezilla,一款ftp工具的服务器端,它采用的是Windows的WSAAsyncSelect模型(代码下载地址:
https://github.com/baloonwj/filezilla):


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
1    //Processes event notifications sent by the sockets or the layers
2    static LRESULT CALLBACK WindowProc(HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam)
3    {
4        if (message>=WM_SOCKETEX_NOTIFY)
5        {
6            //Verify parameters
7            ASSERT(hWnd);
8            CAsyncSocketExHelperWindow *pWnd=(CAsyncSocketExHelperWindow *)GetWindowLongPtr(hWnd, GWLP_USERDATA);
9            ASSERT(pWnd);
10            if (!pWnd)
11                return 0;
12
13            if (message < static_cast<UINT>(WM_SOCKETEX_NOTIFY+pWnd->m_nWindowDataSize)) //Index is within socket storage
14            {
15                //Lookup socket and verify if it's valid
16                CAsyncSocketEx *pSocket=pWnd->m_pAsyncSocketExWindowData[message - WM_SOCKETEX_NOTIFY].m_pSocket;
17                SOCKET hSocket = wParam;
18                if (!pSocket)
19                    return 0;
20                if (hSocket == INVALID_SOCKET)
21                    return 0;
22                if (pSocket->m_SocketData.hSocket != hSocket)
23                    return 0;
24
25                int nEvent = lParam & 0xFFFF;
26                int nErrorCode = lParam >> 16;
27
28                //Dispatch notification
29                if (!pSocket->m_pFirstLayer) {
30                    //Dispatch to CAsyncSocketEx instance
31                    switch (nEvent)
32                    {
33                    case FD_READ:
34 #ifndef NOSOCKETSTATES
35                        if (pSocket->GetState() == connecting && !nErrorCode)
36                        {
37                            pSocket->m_nPendingEvents |= FD_READ;
38                            break;
39                        }
40                        else if (pSocket->GetState() == attached)
41                            pSocket->SetState(connected);
42                        if (pSocket->GetState() != connected)
43                            break;
44
45                        // Ignore further FD_READ events after FD_CLOSE has been received
46                        if (pSocket->m_SocketData.onCloseCalled)
47                            break;
48 #endif //NOSOCKETSTATES
49
50 #ifndef NOSOCKETSTATES
51                        if (nErrorCode)
52                            pSocket->SetState(aborted);
53 #endif //NOSOCKETSTATES
54                        if (pSocket->m_lEvent & FD_READ) {
55                            pSocket->OnReceive(nErrorCode);
56                        }
57                        break;
58                    case FD_FORCEREAD: //Forceread does not check if there's data waiting
59 #ifndef NOSOCKETSTATES
60                        if (pSocket->GetState() == connecting && !nErrorCode)
61                        {
62                            pSocket->m_nPendingEvents |= FD_FORCEREAD;
63                            break;
64                        }
65                        else if (pSocket->GetState() == attached)
66                            pSocket->SetState(connected);
67                        if (pSocket->GetState() != connected)
68                            break;
69 #endif //NOSOCKETSTATES
70                        if (pSocket->m_lEvent & FD_READ)
71                        {
72 #ifndef NOSOCKETSTATES
73                            if (nErrorCode)
74                                pSocket->SetState(aborted);
75 #endif //NOSOCKETSTATES
76                            pSocket->OnReceive(nErrorCode);
77                        }
78                        break;
79                    case FD_WRITE:
80 #ifndef NOSOCKETSTATES
81                        if (pSocket->GetState() == connecting && !nErrorCode)
82                        {
83                            pSocket->m_nPendingEvents |= FD_WRITE;
84                            break;
85                        }
86                        else if (pSocket->GetState() == attached && !nErrorCode)
87                            pSocket->SetState(connected);
88                        if (pSocket->GetState() != connected)
89                            break;
90 #endif //NOSOCKETSTATES
91                        if (pSocket->m_lEvent & FD_WRITE)
92                        {
93 #ifndef NOSOCKETSTATES
94                            if (nErrorCode)
95                                pSocket->SetState(aborted);
96 #endif //NOSOCKETSTATES
97                            pSocket->OnSend(nErrorCode);
98                        }
99                        break;
100                    case FD_CONNECT:
101 #ifndef NOSOCKETSTATES
102                        if (pSocket->GetState() == connecting)
103                        {
104                            if (nErrorCode && pSocket->m_SocketData.nextAddr)
105                            {
106                                if (pSocket->TryNextProtocol())
107                                    break;
108                            }
109                            pSocket->SetState(connected);
110                        }
111                        else if (pSocket->GetState() == attached && !nErrorCode)
112                            pSocket->SetState(connected);
113 #endif //NOSOCKETSTATES
114                        if (pSocket->m_lEvent & FD_CONNECT)
115                            pSocket->OnConnect(nErrorCode);
116 #ifndef NOSOCKETSTATES
117                        if (!nErrorCode)
118                        {
119                            if ((pSocket->m_nPendingEvents&FD_READ) && pSocket->GetState() == connected)
120                                pSocket->OnReceive(0);
121                            if ((pSocket->m_nPendingEvents&FD_FORCEREAD) && pSocket->GetState() == connected)
122                                pSocket->OnReceive(0);
123                            if ((pSocket->m_nPendingEvents&FD_WRITE) && pSocket->GetState() == connected)
124                                pSocket->OnSend(0);
125                        }
126                        pSocket->m_nPendingEvents = 0;
127 #endif
128                        break;
129                    case FD_ACCEPT:
130 #ifndef NOSOCKETSTATES
131                        if (pSocket->GetState() != listening && pSocket->GetState() != attached)
132                            break;
133 #endif //NOSOCKETSTATES
134                        if (pSocket->m_lEvent & FD_ACCEPT)
135                            pSocket->OnAccept(nErrorCode);
136                        break;
137                    case FD_CLOSE:
138 #ifndef NOSOCKETSTATES
139                        if (pSocket->GetState() != connected && pSocket->GetState() != attached)
140                            break;
141
142                        // If there are still bytes left to read, call OnReceive instead of
143                        // OnClose and trigger a new OnClose
144                        DWORD nBytes = 0;
145                        if (!nErrorCode && pSocket->IOCtl(FIONREAD, &nBytes))
146                        {
147                            if (nBytes > 0)
148                            {
149                                // Just repeat message.
150                                pSocket->ResendCloseNotify();
151                                pSocket->m_SocketData.onCloseCalled = true;
152                                pSocket->OnReceive(WSAESHUTDOWN);
153                                break;
154                            }
155                        }
156
157                        pSocket->SetState(nErrorCode ? aborted : closed);
158
159 #endif //NOSOCKETSTATES
160
161                        pSocket->OnClose(nErrorCode);
162                        break;
163                    }
164                }
165                else //Dispatch notification to the lowest layer
166                {
167                    if (nEvent == FD_READ)
168                    {
169                        // Ignore further FD_READ events after FD_CLOSE has been received
170                        if (pSocket->m_SocketData.onCloseCalled)
171                            return 0;
172
173                        DWORD nBytes;
174                        if (!pSocket->IOCtl(FIONREAD, &nBytes))
175                            nErrorCode = WSAGetLastError();
176                        if (pSocket->m_pLastLayer)
177                            pSocket->m_pLastLayer->CallEvent(nEvent, nErrorCode);
178                    }
179                    else if (nEvent == FD_CLOSE)
180                    {
181                        // If there are still bytes left to read, call OnReceive instead of
182                        // OnClose and trigger a new OnClose
183                        DWORD nBytes = 0;
184                        if (!nErrorCode && pSocket->IOCtl(FIONREAD, &nBytes))
185                        {
186                            if (nBytes > 0)
187                            {
188                                // Just repeat message.
189                                pSocket->ResendCloseNotify();
190                                if (pSocket->m_pLastLayer)
191                                    pSocket->m_pLastLayer->CallEvent(FD_READ, 0);
192                                return 0;
193                            }
194                        }
195                        pSocket->m_SocketData.onCloseCalled = true;
196                        if (pSocket->m_pLastLayer)
197                            pSocket->m_pLastLayer->CallEvent(nEvent, nErrorCode);
198                    }
199                    else if (pSocket->m_pLastLayer)
200                        pSocket->m_pLastLayer->CallEvent(nEvent, nErrorCode);
201                }
202            }
203            return 0;
204        }
205        else if (message == WM_USER) //Notification event sent by a layer
206        {
207            //Verify parameters, lookup socket and notification message
208            //Verify parameters
209            ASSERT(hWnd);
210            CAsyncSocketExHelperWindow *pWnd=(CAsyncSocketExHelperWindow *)GetWindowLongPtr(hWnd, GWLP_USERDATA);
211            ASSERT(pWnd);
212            if (!pWnd)
213                return 0;
214
215            if (wParam >= static_cast<UINT>(pWnd->m_nWindowDataSize)) //Index is within socket storage
216            {
217                return 0;
218            }
219
220            CAsyncSocketEx *pSocket = pWnd->m_pAsyncSocketExWindowData[wParam].m_pSocket;
221            CAsyncSocketExLayer::t_LayerNotifyMsg *pMsg = (CAsyncSocketExLayer::t_LayerNotifyMsg *)lParam;
222            if (!pMsg || !pSocket || pSocket->m_SocketData.hSocket != pMsg->hSocket)
223            {
224                delete pMsg;
225                return 0;
226            }
227            int nEvent=pMsg->lEvent&0xFFFF;
228            int nErrorCode=pMsg->lEvent>>16;
229
230            //Dispatch to layer
231            if (pMsg->pLayer)
232                pMsg->pLayer->CallEvent(nEvent, nErrorCode);
233            else
234            {
235                //Dispatch to CAsyncSocketEx instance
236                switch (nEvent)
237                {
238                case FD_READ:
239
240 #ifndef NOSOCKETSTATES
241                    if (pSocket->GetState() == connecting && !nErrorCode)
242                    {
243                        pSocket->m_nPendingEvents |= FD_READ;
244                        break;
245                    }
246                    else if (pSocket->GetState() == attached && !nErrorCode)
247                        pSocket->SetState(connected);
248                    if (pSocket->GetState() != connected)
249                        break;
250#endif //NOSOCKETSTATES
251                    if (pSocket->m_lEvent & FD_READ)
252                    {
253#ifndef NOSOCKETSTATES
254                        if (nErrorCode)
255                            pSocket->SetState(aborted);
256#endif //NOSOCKETSTATES
257                        pSocket->OnReceive(nErrorCode);
258                    }
259                    break;
260                case FD_FORCEREAD: //Forceread does not check if there's data waiting
261#ifndef NOSOCKETSTATES
262                    if (pSocket->GetState() == connecting && !nErrorCode)
263                    {
264                        pSocket->m_nPendingEvents |= FD_FORCEREAD;
265                        break;
266                    }
267                    else if (pSocket->GetState() == attached && !nErrorCode)
268                        pSocket->SetState(connected);
269                    if (pSocket->GetState() != connected)
270                        break;
271#endif //NOSOCKETSTATES
272                    if (pSocket->m_lEvent & FD_READ)
273                    {
274#ifndef NOSOCKETSTATES
275                        if (nErrorCode)
276                            pSocket->SetState(aborted);
277#endif //NOSOCKETSTATES
278                        pSocket->OnReceive(nErrorCode);
279                    }
280                    break;
281                case FD_WRITE:
282#ifndef NOSOCKETSTATES
283                    if (pSocket->GetState() == connecting && !nErrorCode)
284                    {
285                        pSocket->m_nPendingEvents |= FD_WRITE;
286                        break;
287                    }
288                    else if (pSocket->GetState() == attached && !nErrorCode)
289                        pSocket->SetState(connected);
290                    if (pSocket->GetState() != connected)
291                        break;
292#endif //NOSOCKETSTATES
293                    if (pSocket->m_lEvent & FD_WRITE)
294                    {
295#ifndef NOSOCKETSTATES
296                        if (nErrorCode)
297                            pSocket->SetState(aborted);
298#endif //NOSOCKETSTATES
299                        pSocket->OnSend(nErrorCode);
300                    }
301                    break;
302                case FD_CONNECT:
303#ifndef NOSOCKETSTATES
304                    if (pSocket->GetState() == connecting)
305                        pSocket->SetState(connected);
306                    else if (pSocket->GetState() == attached && !nErrorCode)
307                        pSocket->SetState(connected);
308#endif //NOSOCKETSTATES
309                    if (pSocket->m_lEvent & FD_CONNECT)
310                        pSocket->OnConnect(nErrorCode);
311#ifndef NOSOCKETSTATES
312                    if (!nErrorCode)
313                    {
314                        if (((pSocket->m_nPendingEvents&FD_READ) && pSocket->GetState() == connected) && (pSocket->m_lEvent & FD_READ))
315                            pSocket->OnReceive(0);
316                        if (((pSocket->m_nPendingEvents&FD_FORCEREAD) && pSocket->GetState() == connected) && (pSocket->m_lEvent & FD_READ))
317                            pSocket->OnReceive(0);
318                        if (((pSocket->m_nPendingEvents&FD_WRITE) && pSocket->GetState() == connected) && (pSocket->m_lEvent & FD_WRITE))
319                            pSocket->OnSend(0);
320                    }
321                    pSocket->m_nPendingEvents = 0;
322#endif //NOSOCKETSTATES
323                    break;
324                case FD_ACCEPT:
325#ifndef NOSOCKETSTATES
326                    if ((pSocket->GetState() == listening || pSocket->GetState() == attached) && (pSocket->m_lEvent & FD_ACCEPT))
327#endif //NOSOCKETSTATES
328                    {
329                        pSocket->OnAccept(nErrorCode);
330                    }
331                    break;
332                case FD_CLOSE:
333#ifndef NOSOCKETSTATES
334                    if ((pSocket->GetState() == connected || pSocket->GetState() == attached) && (pSocket->m_lEvent & FD_CLOSE))
335                    {
336                        pSocket->SetState(nErrorCode?aborted:closed);
337#else
338                    {
339#endif //NOSOCKETSTATES
340                        pSocket->OnClose(nErrorCode);
341                    }
342                    break;
343                }
344            }
345            delete pMsg;
346            return 0;
347        }
348        else if (message == WM_USER+1)
349        {
350            // WSAAsyncGetHostByName reply
351
352            // Verify parameters
353            ASSERT(hWnd);
354            CAsyncSocketExHelperWindow *pWnd = (CAsyncSocketExHelperWindow *)GetWindowLongPtr(hWnd, GWLP_USERDATA);
355            ASSERT(pWnd);
356            if (!pWnd)
357                return 0;
358
359            CAsyncSocketEx *pSocket = NULL;
360            for (int i = 0; i < pWnd->m_nWindowDataSize; ++i) {
361                pSocket = pWnd->m_pAsyncSocketExWindowData[i].m_pSocket;
362                if (pSocket && pSocket->m_hAsyncGetHostByNameHandle &&
363                    pSocket->m_hAsyncGetHostByNameHandle == (HANDLE)wParam &&
364                    pSocket->m_pAsyncGetHostByNameBuffer)
365                    break;
366            }
367            if (!pSocket || !pSocket->m_pAsyncGetHostByNameBuffer)
368                return 0;
369
370            int nErrorCode = lParam >> 16;
371            if (nErrorCode) {
372                pSocket->OnConnect(nErrorCode);
373                return 0;
374            }
375
376            SOCKADDR_IN sockAddr{};
377            sockAddr.sin_family = AF_INET;
378            sockAddr.sin_addr.s_addr = ((LPIN_ADDR)((LPHOSTENT)pSocket->m_pAsyncGetHostByNameBuffer)->h_addr)->s_addr;
379
380            sockAddr.sin_port = htons(pSocket->m_nAsyncGetHostByNamePort);
381
382            BOOL res = pSocket->Connect((SOCKADDR*)&sockAddr, sizeof(sockAddr));
383            delete [] pSocket->m_pAsyncGetHostByNameBuffer;
384            pSocket->m_pAsyncGetHostByNameBuffer = 0;
385            pSocket->m_hAsyncGetHostByNameHandle = 0;
386
387            if (!res)
388                if (GetLastError() != WSAEWOULDBLOCK)
389                    pSocket->OnConnect(GetLastError());
390            return 0;
391        }
392        else if (message == WM_USER + 2)
393        {
394            //Verify parameters, lookup socket and notification message
395            //Verify parameters
396            if (!hWnd)
397                return 0;
398
399            CAsyncSocketExHelperWindow *pWnd=(CAsyncSocketExHelperWindow *)GetWindowLongPtr(hWnd, GWLP_USERDATA);
400            if (!pWnd)
401                return 0;
402
403            if (wParam >= static_cast<UINT>(pWnd->m_nWindowDataSize)) //Index is within socket storage
404                return 0;
405
406            CAsyncSocketEx *pSocket = pWnd->m_pAsyncSocketExWindowData[wParam].m_pSocket;
407            if (!pSocket)
408                return 0;
409
410            // Process pending callbacks
411            std::list<t_callbackMsg> tmp;
412            tmp.swap(pSocket->m_pendingCallbacks);
413            pSocket->OnLayerCallback(tmp);
414
415            for (auto & cb : tmp) {
416                delete [] cb.str;
417            }
418        }
419        else if (message == WM_TIMER)
420        {
421            if (wParam != 1)
422                return 0;
423
424            ASSERT(hWnd);
425            CAsyncSocketExHelperWindow *pWnd=(CAsyncSocketExHelperWindow *)GetWindowLongPtr(hWnd, GWLP_USERDATA);
426            ASSERT(pWnd && pWnd->m_pThreadData);
427            if (!pWnd || !pWnd->m_pThreadData)
428                return 0;
429
430            if (pWnd->m_pThreadData->layerCloseNotify.empty())
431            {
432                KillTimer(hWnd, 1);
433                return 0;
434            }
435            CAsyncSocketEx* socket = pWnd->m_pThreadData->layerCloseNotify.front();
436            pWnd->m_pThreadData->layerCloseNotify.pop_front();
437            if (pWnd->m_pThreadData->layerCloseNotify.empty())
438                KillTimer(hWnd, 1);
439
440            if (socket)
441                PostMessage(hWnd, socket->m_SocketData.nSocketIndex + WM_SOCKETEX_NOTIFY, socket->m_SocketData.hSocket, FD_CLOSE);
442            return 0;
443        }
444        return DefWindowProc(hWnd, message, wParam, lParam);
445    }
446

上面截取的代码段,如果你对这些项目不是很熟悉的话,估计你也没有任何兴趣去细细看每一行代码逻辑。但是你一定要明白我所说的这个结构的逻辑,基本上目前主流的网络框架都是这套原理。比如filezilla的网络通信层同样也被用在大名鼎鼎的电驴(easyMule)中。

关于单个服务程序的框架,我已经介绍完了,如果你能完全理解我要表达的意思,我相信你也能构建出一套高性能服务程序来。

另外,服务器框架也可以在上面的设计思路的基础上增加很多有意思的细节,比如流量控制。举另外 一个我实际做过的项目中的例子吧:

一般实际项目中,当客户端连接数目比较多的时候,服务器在处理网络数据的时候,如果同时有多个socket上有数据要处理,由于cpu核数有限,根据上面先检测iO事件再处理IO事件可能会出现工作线程一直处理前几个socket的事件,直到前几个socket处理完毕后再处理后面几个socket的数据。这就相当于,你去饭店吃饭,大家都点了菜,但是有些桌子上一直在上菜,而有些桌子上一直没有菜。这样肯定不好,我们来看下如何避免这种现象:


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
1int CFtdEngine::HandlePackage(CFTDCPackage *pFTDCPackage, CFTDCSession *pSession)
2{
3    //NET_IO_LOG0("CFtdEngine::HandlePackage\n");
4    FTDC_PACKAGE_DEBUG(pFTDCPackage);
5
6    if (pFTDCPackage->GetTID() != FTD_TID_ReqUserLogin)
7    {
8        if (!IsSessionLogin(pSession->GetSessionID()))
9        {
10            SendErrorRsp(pFTDCPackage, pSession, 1, "客户未登录");
11            return 0;
12        }
13    }
14
15    CalcFlux(pSession, pFTDCPackage->Length()); //统计流量
16
17    REPORT_EVENT(LOG_DEBUG, "Front/Fgateway", "登录请求%0x", pFTDCPackage->GetTID());
18
19    int nRet = 0;
20    switch(pFTDCPackage->GetTID())
21    {
22
23    case FTD_TID_ReqUserLogin:
24        ///huwp:20070608:检查过高版本的API将被禁止登录
25        if (pFTDCPackage->GetVersion()>FTD_VERSION)
26        {
27            SendErrorRsp(pFTDCPackage, pSession, 1, "Too High FTD Version");
28            return 0;
29        }
30        nRet = OnReqUserLogin(pFTDCPackage, (CFTDCSession *)pSession);
31        FTDRequestIndex.incValue();
32        break;
33    case FTD_TID_ReqCheckUserLogin:
34        nRet = OnReqCheckUserLogin(pFTDCPackage, (CFTDCSession *)pSession);
35        FTDRequestIndex.incValue();
36        break;
37    case FTD_TID_ReqSubscribeTopic:
38        nRet = OnReqSubscribeTopic(pFTDCPackage, (CFTDCSession *)pSession);
39        FTDRequestIndex.incValue();
40        break;  
41    }
42
43    return 0;
44}
45

当有某个socket上有数据可读时,接着接收该socket上的数据,对接收到的数据进行解包,然后调用CalcFlux(pSession, pFTDCPackage->Length())进行流量统计:


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
1void CFrontEngine::CalcFlux(CSession *pSession, const int nFlux)
2{
3    TFrontSessionInfo *pSessionInfo = m_mapSessionInfo.Find(pSession->GetSessionID());
4    if (pSessionInfo != NULL)
5    {
6        //流量控制改为计数
7        pSessionInfo->nCommFlux ++;
8        ///若流量超过规定,则挂起该会话的读操作
9        if (pSessionInfo->nCommFlux >= pSessionInfo->nMaxCommFlux)
10        {
11            pSession->SuspendRead(true);
12        }
13    }
14}
15

该函数会先让某个连接会话(Session)处理的包数量递增,接着判断是否超过最大包数量,则设置读挂起标志:


1
2
3
4
5
1 void CSession::SuspendRead(bool bSuspend)  
2{  
3    m_bSuspendRead = bSuspend;  
4}  
5

这样下次将会从检测的socket列表中排除该socket:


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
1 void CEpollReactor::RegisterIO(CEventHandler *pEventHandler)  
2{  
3    int nReadID, nWriteID;  
4    pEventHandler->GetIds(&nReadID, &nWriteID);  
5    if (nWriteID != 0 && nReadID ==0)  
6    {  
7        nReadID = nWriteID;  
8    }  
9    if (nReadID != 0)  
10    {  
11        m_mapEventHandlerId[pEventHandler] = nReadID;  
12        struct epoll_event ev;  
13        ev.data.ptr = pEventHandler;  
14        if(epoll_ctl(m_fdEpoll, EPOLL_CTL_ADD, nReadID, &ev) != 0)  
15        {  
16            perror("epoll_ctl EPOLL_CTL_ADD");  
17        }  
18    }  
19}  
20
21void CSession::GetIds(int *pReadId, int *pWriteId)  
22{  
23    m_pChannelProtocol->GetIds(pReadId,pWriteId);  
24    if (m_bSuspendRead)  
25    {  
26        *pReadId = 0;  
27    }  
28}  
29

也就是说不再检测该socket上是否有数据可读。然后在定时器里1秒后重置该标志,这样这个socket上有数据的话又可以重新检测到了:


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
1const int SESSION_CHECK_TIMER_ID    = 9;  
2const int SESSION_CHECK_INTERVAL    = 1000;  
3
4SetTimer(SESSION_CHECK_TIMER_ID, SESSION_CHECK_INTERVAL);  
5
6void CFrontEngine::OnTimer(int nIDEvent)  
7{  
8    if (nIDEvent == SESSION_CHECK_TIMER_ID)  
9    {  
10        CSessionMap::iterator itor = m_mapSession.Begin();  
11        while (!itor.IsEnd())  
12        {  
13            TFrontSessionInfo *pFind = m_mapSessionInfo.Find((*itor)->GetSessionID());  
14            if (pFind != NULL)  
15            {  
16                CheckSession(*itor, pFind);  
17            }  
18            itor++;  
19        }  
20    }  
21}  
22
23void CFrontEngine::CheckSession(CSession *pSession, TFrontSessionInfo *pSessionInfo)  
24{  
25    ///重新开始计算流量  
26    pSessionInfo->nCommFlux -= pSessionInfo->nMaxCommFlux;  
27    if (pSessionInfo->nCommFlux < 0)  
28    {  
29        pSessionInfo->nCommFlux = 0;  
30    }  
31    ///若流量超过规定,则挂起该会话的读操作  
32    pSession->SuspendRead(pSessionInfo->nCommFlux >= pSessionInfo->nMaxCommFlux);  
33}  
34

这就相当与饭店里面先给某一桌客人上一些菜,让他们先吃着,等上了一些菜之后不会再给这桌继续上菜了,而是给其它空桌上菜,大家都吃上后,继续回来给原先的桌子继续上菜。实际上我们的饭店都是这么做的。上面的例子是单服务流量控制的实现的一个非常好的思路,它保证了每个客户端都能均衡地得到服务,而不是一些客户端等很久才有响应。当然,这样的技术不能适用于有顺序要求的业务,例如销售系统,这些系统一般是先下单先得到的。

另外现在的服务器为了加快IO操作,大量使用缓存技术,缓存实际上是以空间换取时间的策略。对于一些反复使用的,但是不经常改变的信息,如果从原始地点加载这些信息就比较耗时的数据(比如从磁盘中、从数据库中),我们就可以使用缓存。所以时下像redis、leveldb、fastdb等各种内存数据库大行其道。如果你要从事服务器开发,你至少需要掌握它们中的几种。

这是我在gitchat上的首篇文章,限于篇幅有限,很多细节不可能展开来叙述,同时这里就不再讲述分布式的服务器的设计技巧了,后面如果条件允许会给大家带来更多的技术分享。同时感谢gitchat提供这样一个与大家交流的平台。

给TA打赏
共{{data.count}}人
人已打赏
安全技术

详解Node.js API系列 Crypto加密模块(2) Hmac

2021-12-21 16:36:11

安全技术

从零搭建自己的SpringBoot后台框架(二十三)

2022-1-12 12:36:11

个人中心
购物车
优惠劵
今日签到
有新私信 私信列表
搜索