« 开发笔记(21) : 无锁消息队列 | 返回首页 | 在 C 中设置 Lua 回调函数引起的一处 bug »

Lua 5.2 如何实现 C 调用中的 Continuation

Lua 5.2 最重大的改进,莫过于 "yieldable pcall and metamethods" 。这需要克服一个难题:如何在 C 函数调用中,正确的 yield 回 resume 调用的位置。

resume 的发起总是通过一次 lua_resume 的调用,在 Lua 5.1 以前,yield 的调用必定结束于一次 lua_yield 调用,而调用它的 C 函数必须立刻返回。中间不能有任何 C 函数执行到中途的状态。这样,Lua VM 才能正常工作。

(C)lua_resume -> Lua functions -> coroutine.yield
   -> (C)lua_yield -> (C) return

在这个流程中,无论 Lua functions 有多少层,都被 lua state 中的 lua stack 管理。所以当最后 C return 返回到最初 resume 点 ,都不存在什么问题,可以让下一次 resume 正确继续。也就是说,在 yield 时,lua stack 上可以有没有执行完的 lua 函数,但不可以有没有执行完的 C 函数。

如果我们写了这么一个 C 扩展,在 C function 里回调了传入的一个 Lua 函数。情况就变得不一样了。

(C)lua_resume -> Lua function -> C function 
  -> (C) lua_call  -> Lua function 
  -> coroutine.yield -> (C)lua_yield 

C 通过 lua_call 调用的 Lua 函数中再调用 coroutine.yield 会导致在 yield 之后,再次 resume 时,不再可能从 lua_call 的下一行继续运行。lua 在遇到这种情况时,会抛出一个异常 "attempt to yield across metamethod/C-call boundary" 。

在 5.2 之前,有人试图解决这个问题,去掉 coroutine 的这些限制。比如 Coco 这个项目。它用操作系统的协程来解决这个问题 (例如,在 Windows 上使用 Fiber )。即给每个 lua coroutine 真的附在一个 C 协程上,独立一个 C 堆栈。

这样的方案开销较大,且依赖平台特性。到了 Lua 5.2 中,则换了一个更彻底的方案解决这个问题。


其实,需要解决的问题是在 C 和 Lua 的边界时,如果在 yield 之后,resume 如何继续运行 C 边界之后的 C 代码。

当只有一个 C 堆栈时,只能从调用深处跳出来(使用 longjmp),却无法回到那个位置(因为一旦跳出,堆栈就被破坏)。Lua 5.2 想了一个巧妙的方法来解决这个问题。

C 进入 Lua 的边界一共有四个 API :lua_call , lua_pcall , lua_resumelua_yield 。其中要解决的关键问题在于 call 一个 lua function 有两条返回路径。

lua function 的正常返回应该执行 lua_call 调用后面的 C 代码,而中途如果 yield 发生,回导致执行序回到前面 lua_resume 调用处的下一行 C 代码执行。对于后一种,在后续的某次 lua_resume 发生后,lua coroutine 结束,还需要回到 lua_call 之后完成后续的 C 执行逻辑。C 语言是不允许这样做的,因为当初的 C 堆栈已经不存在了。

Lua 5.2 提供了新的 API :lua_callk 来解决这个问题。既然无法在 yield 之后,C 的执行序无法回到 lua_callk 的下一行代码,那么就让 C 语言使用者自己提供一个 Continuation 函数 k 来继续。

我们可以这样理解 k 这个参数:当 lua_callk 调用的 lua 函数中没有发生 yield 时,它会正常返回。一旦发生 yield ,调用者要明白,C 代码无法正常延续,而 lua vm 会在需要延续时调用 k 来完成后续工作。

k 会得到正确的 L 保持正确的 lua state 状态,看起来就好像用一个新的 C 执行序替代掉原来的 C 执行序一样。

典型的用法就是在一个 C 函数调用的最后使用 callk :

  lua_callk(L, 0, LUA_MULTRET, 0, k);
  return k(L);

也就是把 callk 后面的执行逻辑放在一个独立 C 函数 k 中,分别在 callk 后调用它,或是传递给框架,让框架在 resume 后调用。

这里,lua 状态机的状态被正确保存在 L 中,而 C 函数堆栈会在 yield 后被破坏掉。如果我们需要在 k 中得到延续点前的 C 函数状态怎么办呢?lua 提供了 ctx 用于辅助记录 C 中的状态。

在 k 中,可以通过 lua_getctx 获得最近一次边界调用时传入的 k 。lua_getctx 返回两个参数,分别是 k 和当前所处的执行位置。是原始函数(没有被 yield 打断的),还是在被 yield 打断后的延续点函数中。这有一点点像 setjmp 或 fork 的接口设计。


其实在 Lua 5.2 的官方文档中,对以上已经做了详尽的说明。可以看 4.7 节 Handling Yields in C

或许,我们还可以参考这个接口设计,实现一个不需要独立堆栈的 C 版 Coroutine 库。只是用起来会很麻烦吧。

Comments

异常 "attempt to yield across metamethod/C-call boundary"

在 5.2 之前,有人试图解决这个问题,去掉 coroutine 的这些限制。比如 Coco 这个项目。

Coco这个项目在解决这个问题的时候,提供linux下相关的解决方案了么?遇到一个问题,同样的代码,在win平台下没有这样的错误,在linux下却有这样的错误,这个问题有没有什么经验给分享下,哥

lua5.2 我真心的想用, 不过之前用同样的代码测试, 5.2 上的运行效率竟然比 5.1.4 低很多. 我郁闷啊. 不懂其中原因, 要是能帮忙解答下就好了, 另外解答下, 为什么你要用 5.2呢? 我真心没发现好处.关于可以在任何地方挂起的优点, 因为我之前的系统已经使用了很多,也算知道解决方案了. 所以实在不知道为何要选 5.2

OK,表示还是看不懂云风的文章

讲的真好,实践一下

嗯,很不错,很有技术含量的博客,收藏

哇哦,很有深度哦,支持下

不懂lua的看懂了一点点

Post a comment

非这个主题相关的留言请到:留言本