基于汇编的 C/C+协程-实现

背景说明

基于汇编的 C/C++ 协程(用于服务器),我之前已经在下面两篇文章中详细阐述了原理:

基于汇编的 C/C++ 协程 - 背景知识

基于汇编的 C/C++ 协程 - 切换上下文

而这篇文章,就终于是 C/C++ 协程的实现了。正如上面两篇文章所说的,我们需要实现的目标有两个:

有同步式服务器编程的顺序思路,便于功能设计和代码调试——我使用了 libco 中的协程部分

有异步 I/O 的性能——我使用了 libevent 中的 event I/O

结构上,就是将 libco 和 libevent 两者的功能糅合起来,所以我把我的工程,命名为 libcoevent,意为 “基于 libevent 的同步协程服务器编程框架”。名字中 co 的意思并不代表 libco,而是 coroutine。

编程语言上,我选择的是 C++,主要是因为 libco 只支持基于 x86 或 x64 架构的 Linux,而这样的架构,基本上都是 PC 机,或者是资源不缺、性能也不错的嵌入式系统,上 C++ 完全没有问题。本文解释代码实现的原理。

如果要使用该工程,请在链接选项中加入 三个选项。详情参考 目录。

本文章采用 知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议 进行许可。

本文地址:https://cloud.tencent.com/developer/article/1171032

类关系及基本功能

类关系

类继承关系

类的基本继承关系图如下:

在实际调用中,只有处于继承关系树的叶子结点上的类才会被实际使用到,其他类均视为虚类。

类从属关系

各类的实例在程序运行中是有从属关系的,除了作为顶层的 Base 类之外,其他树叶类都需依附于其他的类所在的运行环境中才能执行。从属关系图如下:

Base类提供最基本的运行环境,并管理Server对象;

Procedure对象管理Client对象。在图中体现为Server和Session对象均管理Client对象。

Server对象由应用程序创建并初始化到Base对象中运行。当服务器结束或当其从属的Base对象销毁时,可配置自动销毁Server对象。

Session对象由处于会话模式(session mode)的Server对象自动创建,并调用应用程序指定的程序入口运行;当会话结束时(函数调用 )或其从属的Server对象服务结束时,由Server对象自动销毁。

Client对象由应用程序调用Procedure对象的接口创建,用于与第三方服务交互。应用程序可提前调用接口要求销毁Client对象,也可以待Procedure服务结束时自动统一销毁。

Base 和 Event 类

Base类用于运行 libcoevent 的各个服务。每个 Base 类的实例应对应着一个线程,所有的服务以协程的方式在Base实例中运行。从上图可知,Base类包含一个 libevent 库的 对象和本协程库的一系列 Event 对象。

Event类其实是借用了 libevent 的 名称,因为每一个Event类的实例,对应着 libevent 的一个 对象。我们需要关注的重点,是Procedure和Client类。

Procedure 类

Procedure类有两个关键特点:

每个对象都拥有一个 libco 协程,即拥有自己独立的上下文信息,可以用于编写一个独立的服务器过程(procedure);

Procesure 的子类可以创建Client对象与第三方服务器通信和交互。

Procedure类拥有两个子类,分别是Server和Session。

Server 类

Server 类由应用程序创建并初始化到Base对象中运行。Server 类有三个子类:

SubRoutine:实际上不作为任何服务器程序,但提供了最基本的 函数,并支持 Procedure 类的创建 Client 对象的功能,因此应用程序可以用来作为临时创建或常驻的内部程序来使用。

UDPServer:应用程序创建并初始化 UDPServer 对象后,程序会自动绑定到一个数据报 socket 接口上。应用可以通过在网络接口中收发数据包来实现网络服务。UDPServer 同时提供普通模式和会话模式。

TCPServer:应用程序创建并初始化 TCPPServer 对象后,程序会自动绑定并监听流 socket。TCPServer 只支持会话模式。

所谓的 “普通模式”,也就是应用程序注册 Server 对象的入口函数,并且由应用程序操作 Server 对象的行为。

所谓的 “会话模式”,指的是 UDPServer 或 TCPServer 对象,在接收到传入数据后,自动区分客户端,并单独创建Session对象进行处理。每个 Session 对象只服务于一个客户端。

Session 类

Session 对象不能由应用主动创建,而是由处于会话模式的 Server 类自动按需创建。Session 对象的特点是,只能与单一一个客户端(相比起 UDPServer 对象而言)进行通信,因此没有 函数,只有 。

在头文件 声明的Session类及其子类均为纯虚类,目的是防止应用程序显式地构建Session对象并隐藏实现细节。

Client 类

Client对象由 Procedure 对象创建,并且由 Procedure 对象进行回收。Client 对象的作用是主动向远程服务器发起通信。由于从客户-服务结构的角度,这个动作属于客户端,所以命名为 Client。

DNSClient

Client 的子类中比较特别的是DNSClient类,这个类的存在是为了解决在异步 I/O 中的 阻塞问题。DNSClient 的实现原理请参见代码和我之前的文章《DNS报文结构和个人DNS解析代码实现》。

而对于 DNSClient 类而言,具体实现原理,就是封装了一个 UDPClient 对象,通过该对象完成 DNS 报文的收发,并在类中实现报文的解析。

UDPServer——基于 libevent 的协程实现

UDPServer类普通模式的原理,就是一个非常典型的基于 libevent 的同步协程服务器框架。其代码实现中,核心功能就是以下几个函数:

,协程的入口函数,使用这个函数,转化成为 liboevent 的统一服务入口函数

,libevent时间回调函数,在这个函数里,实现协程上下文的恢复。

,数据接收函数,在这个函数中,实现关键的数据等待功能,同时实现了协程上下文的保存

上述三个函数的代码总量,加上空行也不超过 200 行,我相信还是很容易看明白的。以下具体解释实现原理:

libco 协程接口

正如前文所说,我使用的是 libco 作为协程库。协程对于应用程序是透明的,但是对于库的实现而言,这才是核心。

下面解释一下 libco 的协程功能所提供的几个接口(libco 的文档数量简直 “感人”,这也是网上经常被吐槽的……):

创建和销毁协程

Libco使用结构体 保存协程,通过调用 可以创建协程对象;使用 销毁协程资源。

进入协程

创建了协程之后,调用 可以从协程函数的开头开始执行协程。

暂停协程

当协程到了需要交出 CPU 使用权的时候,可以调用 释放协程、切换掉上下文。调用之后,上下文会恢复到上一个调用 的协程中。调用 的位置可以视为一个 “断点”。

恢复协程

恢复协程和创建协程所用的函数都是 ,调用该函数,将当前堆栈切换为指定协程的上下文,协程会从上文提到的 “断点” 恢复执行。

协程调度实现

从上一小节可以看到,我们使用到的 libco 协程功能函数中,虽然包含了协程的切换函数,但什么时候切换、切换之后 CPU 如何分配,这是我们需要实现并封装起来的工作。

创建和销毁协程的时机,自然就是在UDPServer类初始化和析构的时候。下文重点解析进入、暂停和恢复协程的操作:

进入协程

进入 / 恢复协程的代码,是在 中,有这么一行:

// handle control to user applicationco_resume(arg->coroutine);

如果当前协程还没有被执行过,那么执行了这句代码之后,程序会切换到创建 libco 协程时指定的协程函数开始执行。对于UDPServer,也就是 函数。这个函数非常简单,只有三行:

staticvoid*_libco_routine(void*libco_arg){struct _EventArg*arg=(struct _EventArg*)libco_arg;(arg->worker_func)(arg->fd,arg->event,arg->user_arg);returnNULL;}

通过传入参数,将 libco 回调函数转换为应用程序指定的服务器函数执行。

但是如何实现第一次的 libevent 回调呢?这还是很简单的,只需要在调用 libevent 的 时,将超时时间设置为 0 即可,这会导致 libevent 事件立即超时。通过这个机制,我们也就实现了在Base运行之后立即执行各Procedure服务函数的目的。

暂停和恢复协程

在什么时候调用 是本协程实现的重点,调用 的位置,是一个可能会导致上下文切换的地方,也是将异步编程框架转换为同步框架的关键技术点。这里可以参照UDPServer的 函数。函数的基本逻辑如下:

其中最重要的分支,就是对 libevent 事件标志的判断;而最重要的逻辑,就是 和 函数的调用。函数片段如下:

struct timeval timeout_copy;timeout_copy.tv_sec=timeout.tv_sec;timeout_copy.tv_usec=timeout.tv_usec;...event_add(_event,&timeout_copy);co_yield(arg->coroutine);

这里,我们把 函数理解为一个断点,当程序执行到这里的时候,CPU 的使用权会被交出,程序回到调用 的上一级函数手中。这个 “上一级函数” 究竟是哪里呢?实际上就是前文提到的 函数。

从 的角度来看,程序会从 函数返回,并且继续往下执行。此时我们可以这么理解:协程的调度,实际上是借用了 来进行的。这里我们要关注一下 上方的几句:

// switch into the coroutineif(arg->libevent_what_ptr){*(arg->libevent_what_ptr)=(uint32_t)what;}

这里将libevent事件 flag 值传递给了协程,而这是前文进行事件判断的重要依据。当时间到来, 会在下面调用 的位置,将 CPU 使用权交回给协程。

销毁协程

除了 之外,协程函数调用 也会导致从 返回,所以在 中,我们还需要判断协程是否已经结束。如果协程结束,那么就应当销毁相关的协程资源了。参见 条件体内的代码。

会话模式(Session Mode)

在本工程的实现中,提供了被称为 “会话模式” 的一个服务器设计模式。会话模式指的是 UDPServer 或 TCPServer 对象,在接收到传入数据后,自动区分客户端,并单独创建Session对象进行处理。每个 Session 对象只服务于一个客户端。

对于TCPServer而言,实现上述的功能比较简单,因为监听一个 TCP socket 之后,当有传入连接的时候,只要调用 ,就可以获得一个新的文件描述符,为这个文件描述符创建一个新的Server的子类就行了——这就是TCPSession类。

但是UDPServer就比较麻烦了,因为 UDP 不能这么做。我们只能自行实现所谓的 session。

UDPSession 实现

设计目标

我们需要实现UDPSession类的如下效果:

类调用recv函数时,只会接收到对应的远程客户端发来的数据

类调用send函数(实际实现是 )时,可以使用UDPServer的端口进行回复

recv()

在工程中,UDPSession是抽象类,实际实现是UDPItnlSession。但是准确而言,UDPItnlSession的实现,密切依赖于UDPServer。这一部分,可以参照UDPServer的 函数中的 循环体代码。程序思路如下:

UDPServer维护一个UDPSession字典,以远程 IP + 端口名的组合作为 key。

当数据到来时,判断远程 IP + 端口的组合是否在字典中,如果在,那么就把数据复制给对应的 session;如果不存在,则创建 session

复制数据的代码,参见UDPItnlSession类的 函数实现。

reply()

发送数据其实就很简单,直接对UDPServer的 fd 进行 就可以了。

quit

对于 session mode 的Server对象,代码中提供了一个可以由其 session 调用的、要求 server 退出并销毁资源的函数:。实现原理是向 server 触发一个 事件。对于普通的 I/O 事件而言,这是不应当出现的,我们这里活用来作为退出信号。如果 server 发现了这个信号,则触发退出逻辑。

应用示例

本工程的示例代码分为 server 和 client 两部分,其中 server 用到了libcoevent,而 client 只是使用Python写的简单程序。本文就不说明 client 部分的代码了。

Server 的代码,分别针对 Server 类的三个子类做了应用示例。使用了包括空行、调试语句、错误判断等在内的逻辑,仅使用不到 300 行,就实现了一个过程和两个服务。应该说,逻辑还是很清晰的,而且也节省了大量代码。

SubRoutine

通过函数 ,展示了一个一次性的线性网络逻辑。程序中,routine 首先创建了一个DNSClient对象,向默认域名服务器请求了一个域名,然后 该服务器的 80 端口。成功后,直接返回。

这个函数展示了SubRoutine的使用场景,以及Client对象的使用方法,特别是DNSClient的简易使用方法。

UDPServer

UDPServer的入口函数是 ,功能是为客户端提供域名查询服务。Clients 发送一段字符串作为待查询域名,然后 server 通过DNSClient对象请求后,将查询结果返回给客户端。

这个函数展示了UDPSession对象和DNSClient的(比较复杂和完整的)使用方法。

TCPServer

入口函数是 ,逻辑比较简单,主要是展示TCPSession的用法。

后记

原理上,libcoevent已经开发完了,实现了必须的功能,完全可以用来编写服务器程序。当然由于这是初版,所以很多代码看起来还是有点乱。这个库的意义在于,可以从教学角度,仔细地说明 C/C++ 协程更为本源的实现原理,也可以作为一个可用的协程服务器库来使用。

欢迎读者针对这个库多多批判,也欢迎读者提出新需求——比如我就决定加几个需求,算是 TODO 吧:

实现HTTPServer,作为TCPServer的子类,提供 HTTP fcgi 服务;

实现SSLClient的类,处理对外的 SSL 请求。

至此,《基于汇编的 C/C++ 协程》三大内容,也就完成了。后续如果有时间,我会再写一篇产品使用文档(readme),不过估计就不发布在这里了,而是直接发布在我的 GitHub 上。请多关照~~

  • 发表于:
  • 原文链接https://kuaibao.qq.com/s/20190209A004KK00?refer=cp_1026
  • 腾讯「云+社区」是腾讯内容开放平台帐号(企鹅号)传播渠道之一,根据《腾讯内容开放平台服务协议》转载发布内容。
  • 如有侵权,请联系 yunjia_community@tencent.com 删除。

扫码关注云+社区

领取腾讯云代金券