Lua_API lua_call & lua_callk

开篇

今天来简单了解一下 Lua 的函数调用:lua_call。

解析

函数调用协议

void lua_call (lua_State *L, int nargs, int nresults);

要调用一个函数请遵循以下协议:首先,要调用的函数应该被压入栈;接着,把需要传递给这个函数的参数按正序压栈; 这是指第一个参数首先压栈。最后调用一下 lua_callnargs 是你压入栈的参数个数。 当函数调用完毕后,所有的参数以及函数本身都会出栈。 而函数的返回值这时则被压栈。 返回值的个数将被调整为 nresults 个,除非 nresults 被设置成 LUA_MULTRET。 在这种情况下,所有的返回值都被压入堆栈中。 Lua 会保证返回值都放入栈空间中。 函数返回值将按正序压栈(第一个返回值首先压栈), 因此在调用结束后,最后一个返回值将被放在栈顶。

lua_call 的定义

/*
** 'load' and 'call' functions (load and run Lua code)
*/
LUA_API void  (lua_callk) (lua_State *L, int nargs, int nresults,
                           lua_KContext ctx, lua_KFunction k);

#define lua_call(L,n,r)     lua_callk(L, (n), (r), 0, NULL)

可以看出 lua_call 是一个宏定义,它的内部实现实际上是由 lua_callk 来完成的。

lua_callk

lua_callk 接收 5 个参数,其中:L 是线程状态,narg 是目标函数的参数个数,nresult 是目标函数返回值个数,ctxcontinuation-function 上下文环境,k 是一个 continuation-function。我们先看 lua_KContextlua_KFunction 类型的定义,再来说 continuation-function

  • lua_KContext
/* type for continuation-function contexts */
typedef LUA_KCONTEXT lua_KContext;

/*
@@ LUA_KCONTEXT is the type of the context ('ctx') for continuation
** functions.  It must be a numerical type; Lua will use 'intptr_t' if
** available, otherwise it will use 'ptrdiff_t' (the nearest thing to
** 'intptr_t' in C89)
*/
#define LUA_KCONTEXT    ptrdiff_t

#if !defined(LUA_USE_C89) && defined(__STDC_VERSION__) && \
    __STDC_VERSION__ >= 199901L
#include <stdint.h>
#if defined(INTPTR_MAX)  /* even in C99 this type is optional */
#undef LUA_KCONTEXT
#define LUA_KCONTEXT    intptr_t
#endif
#endif

lua_KContextLUA_KCONTEXT 的别名,Lua 首选采用 intptr_t 作为 LUA_KCONTEXT 的正身,其次是 ptrdiff_t;两者的区别可以参考文末的 intptr_t && ptrdiff_t 部分。总之,LUA_KCONTEXT 必须是数值类型,记住这点即可。

  • lua_KFunction
/*
** Type for continuation functions
*/
typedef int (*lua_KFunction) (lua_State *L, int status, lua_KContext ctx);

lua_KFunction 是一个函数指针类型,在 Lua 中它被用于定义一个 continuation-function。何谓 continuation-function?简单的理解,它类似于闭包,可以保存程序的执行环境,但在实现上却大相径庭;具体可以参考文末的 continuations 部分。

  • lua_callk

现在来看 lua_callk 的内部实现:

LUA_API void lua_callk (lua_State *L, int nargs, int nresults,
                        lua_KContext ctx, lua_KFunction k) {
  StkId func;
  lua_lock(L);
  api_check(L, k == NULL || !isLua(L->ci),
    "cannot use continuations inside hooks");
  api_checknelems(L, nargs+1);
  api_check(L, L->status == LUA_OK, "cannot do calls on non-normal thread");
  checkresults(L, nargs, nresults);
  func = L->top - (nargs+1);
  if (k != NULL && L->nny == 0) {  /* need to prepare continuation? */
    L->ci->u.c.k = k;  /* save continuation */
    L->ci->u.c.ctx = ctx;  /* save context */
    luaD_call(L, func, nresults);  /* do the call */
  }
  else  /* no continuation or no yieldable */
    luaD_callnoyield(L, func, nresults);  /* just do the call */
  adjustresults(L, nresults);
  lua_unlock(L);
}

api_check(L, k == NULL || !isLua(L->ci), "..."); 用于检查 continuation-function 是否可用。

api_checknelems(L, nargs+1) 检查栈中的元素是否足够,这里栈中元素数量参照是 nargs+11 指的是目标函数,也就是说,至少需要保证目标函数和目标参数已经被 push到栈中了,才能保证目标函数被正常地调用。

api_check(L, L->status == LUA_OK, "..."); 用于检查线程状态是否正常,只有处于正常状态下的线程才可以调用目标函数。

checkresults 被用于检查当前栈空间是否足够容纳目标函数返回的参数个数:

#define checkresults(L,na,nr) \
     api_check(L, (nr) == LUA_MULTRET || (L->ci->top - L->top >= (nr) - (na)), \
    "results from function overflow current stack size")

/* option for multiple returns in 'lua_pcall' and 'lua_call' */
#define LUA_MULTRET (-1)

func = L->top - (nargs+1); 操作试图从栈中取出目标函数。接下来,会检查线程 Lnny 域,nny 记录了调用栈上不能被挂起的次数,通过判断 nny 的值,就可以知道当前过程能否挂起:

LUA_API int lua_isyieldable (lua_State *L) {
  return (L->nny == 0);
}

对于可挂起的过程,会保存上下文环境和 cotinuation-function,然后使用 luaD_call 调用目标函数;对于不可挂起的过程,则使用 luaD_callnoyield 去调用目标函数。我们看两者实现的细节:

/*
** Call a function (C or Lua). The function to be called is at *func.
** The arguments are on the stack, right after the function.
** When returns, all the results are on the stack, starting at the original
** function position.
*/
void luaD_call (lua_State *L, StkId func, int nResults) {
  if (++L->nCcalls >= LUAI_MAXCCALLS)
    stackerror(L);
  if (!luaD_precall(L, func, nResults))  /* is a Lua function? */
    luaV_execute(L);  /* call it */
  L->nCcalls--;
}


/*
** Similar to 'luaD_call', but does not allow yields during the call
*/
void luaD_callnoyield (lua_State *L, StkId func, int nResults) {
  L->nny++;
  luaD_call(L, func, nResults);
  L->nny--;
}

可知,luaD_callnoyieldluaD_call 的基础上增加了对 nny 的操作,在调用目标函数之前,通过 nny 的自增保证在调用过程中不被挂起,而在调用完成之后需要 nny 的自减来恢复。

luaD_call 在调用目标函数之前需要先检查嵌套的C调用是否超过栈允许的瓶颈,否则会报出栈溢出错误。接着 luaD_call 会进行一次预调用 luaD_precallluaD_precall 会创建新的可调用环境,并针对 目标函数的类型对相关信息进行填充。如果目标函数是 C 函数,则在 luaD_precall 就可以完成目标函数的调用;如果目标函数是 Lua 函数,那么 luaD_precall 只会进行相关信息的填充,而后返回,由 luaV_execute 来完成对目标函数的调用。luaD_precallluaV_execute 的具体实现部分比较艰深,先搁置在案,以后再拨冗整理。)

目标函数被调用之后,栈中的内容被重新整理,也就是把目标函数和目标参数从栈中推出,再把返回参数压入栈中。adjustresults 确保返回值被全部压栈。

#define adjustresults(L,nres) \
    { if ((nres) == LUA_MULTRET && L->ci->top < L->top) L->ci->top = L->top; }

lua_call 总结

  • lua_call 的内部实现基于 lua_callklua_Statenny 标记;
  • lua_call 不需要 cotinuation-function,也就是说在调用目标函数的过程中,它不容许被挂起;
  • 借助 lua_Statenny 标记,可以判断一个函数是否可以被挂起;
  • 在调用目标函数之后,目标函数和其参数都会被出栈,而后会将目标函数的返回值全部入栈。

终了

  • 遇到了很多新的概念,脑袋瓜子被冲刷得七荤八素,晕。
  • 现在不懂没关系,以后茅塞顿开的可能性就水涨船高了,我时常这么安慰自己。

参考

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,732评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,496评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,264评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,807评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,806评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,675评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,029评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,683评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 41,704评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,666评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,773评论 1 332
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,413评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,016评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,978评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,204评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,083评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,503评论 2 343

推荐阅读更多精彩内容

  • 第一篇 语言 第0章 序言 Lua仅让你用少量的代码解决关键问题。 Lua所提供的机制是C不擅长的:高级语言,动态...
    testfor阅读 2,649评论 1 7
  • ¥开启¥ 【iAPP实现进入界面执行逐一显】 〖2017-08-25 15:22:14〗 《//首先开一个线程,因...
    小菜c阅读 6,357评论 0 17
  • 原文地址:C语言函数调用栈(一)C语言函数调用栈(二) 0 引言 程序的执行过程可看作连续的函数调用。当一个函数执...
    小猪啊呜阅读 4,585评论 1 19
  • 冥冥之中必有暗示,无心之举却带来一世执念 是什么让一个本应该好好安度老年的老人却从事这无关紧要的职业? 是无心之举...
    刺雪飞花阅读 1,117评论 2 23
  • 光明源于黑暗,黑暗涌现光明。——《魔兽》电影 快与慢 距离我们立项已经过去1个月又2周了,按照我们的制作计划,应该...
    阿甘跑呀阅读 1,005评论 2 5