skynet源码分析(9)--LUA C API

作者:shihuaping0918@163.com,转载请注明作者

这篇文章是分析skynet消息注册前的知识准备,skynet的消息注册,C服务和lua服务设置回调走的函数是不同的。C的回调可以直接调,但是lua的回调不行,它需要一个默认的回调C函数,将返回参数转换为lua能理解的格式,遵循lua的api协议,传递到lua层。这个回调的名字叫_cb。具体它是怎么工作的我们下一篇再分析,这一篇要先了解一些必要的lua api的规范,才能进行下一步。这个lua参考手册是随时需要翻的:http://www.lua.org/manual/5.3/manual.html

首先是lua调c,lua到C层的参数是按顺序来的,也就是说第一个参数就是1,第二个就是2....第n个就是n。从C层传递到lua层也是一样,但是会多一个参数个数。举个栗子吧,干讲是不好理解。能看懂英文的同学最好详细看一下,看不懂的呢,也没什么大碍。

In order to communicate properly with Lua, a C function must use the following protocol, 
which defines the way parameters and results are passed:
a C function receives its arguments from Lua in its stack in direct order (the first argument is pushed first). 
So, when the function starts, lua_gettop(L) returns the number of arguments received by the function. 
The first argument (if any) is at index 1 and its last argument is at index lua_gettop(L). 
To return values to Lua, a C function just pushes them onto the stack,
in direct order (the first result is pushed first), and returns the number of results.
Any other value in the stack below the results will be properly discarded by Lua. 
Like a Lua function, a C function called by Lua can also return many results.

As an example, the following function receives a variable number of numeric arguments and returns their average and their sum:

这是一个lua调C以后,C返回的例子
     static int foo (lua_State *L) {
       int n = lua_gettop(L);    /* number of arguments */  参数个数
       lua_Number sum = 0.0;
       int i;
       for (i = 1; i <= n; i++) {
         if (!lua_isnumber(L, i)) { //参数是不是数字
           lua_pushliteral(L, "incorrect argument"); //不是数字报错
           lua_error(L);
         }
         sum += lua_tonumber(L, i); //取第i个参数
       }
       lua_pushnumber(L, sum/n);        /* first result */ 第一个返回值
       lua_pushnumber(L, sum);         /* second result */ 第二个返回值
       return 2;                   /* number of results */ 一共两个返回值
     }

然后是C层调LUA的函数,它的具体过程就是把参数填好,然后调LUA的函数。为了防止异常导致服务不稳定,skynet中调用lua回调函数的时候使用的是lua_pcall,这个函数在lua层也是有的,LUA层就叫pcall。

lua_pcall的介绍请大家到参考手册里去找,我这里贴个参数列表就好了。

int lua_pcall (lua_State *L, int nargs, int nresults, int msgh);
lua_state就是lua环境了
nargs表示有多少个参数
nresults表示有多少个返回值
msgh为0表示返回初始错误对象,其它值表示消息处理函数所在的栈索引。

下面以skynet中的_cb函数来说明一下C调用lua函数的场景。

static int
_cb(struct skynet_context * context, void * ud, int type, int session, uint32_t source, const void * msg, size_t sz) {
    lua_State *L = ud;
    int trace = 1;
    int r;
    int top = lua_gettop(L); //获取栈参数个数
    if (top == 0) {
        lua_pushcfunction(L, traceback); //index为1,是一个错误处理函数
        lua_rawgetp(L, LUA_REGISTRYINDEX, _cb); //index为2,是lua的回调函数
    } else {
        assert(top == 2);
    }

    lua_pushvalue(L,2); //lua回调函数入栈
    lua_pushinteger(L, type);  //回调参数1,类型
    lua_pushlightuserdata(L, (void *)msg);  //回调参数2,消息体
    lua_pushinteger(L,sz); //回调参数3,消息长度
    lua_pushinteger(L, session); //回调参数4,session
    lua_pushinteger(L, source); //回调参数5,source

    //nargs为5,表示有5个参数
    //nresults为0,表示返回值为0
    //trace为1,表示出错时调用前面设置的traceback函数
    r = lua_pcall(L, 5, 0 , trace); 

    if (r == LUA_OK) {
        return 0;
    }
    const char * self = skynet_command(context, "REG", NULL);
    switch (r) {
    case LUA_ERRRUN:
        skynet_error(context, "lua call [%x to %s : %d msgsz = %d] error : " KRED "%s" KNRM, source , self, session, sz, lua_tostring(L,-1));
        break;
    case LUA_ERRMEM:
        skynet_error(context, "lua memory error : [%x to %s : %d]", source , self, session);
        break;
    case LUA_ERRERR:
        skynet_error(context, "lua error in error : [%x to %s : %d]", source , self, session);
        break;
    case LUA_ERRGCMM:
        skynet_error(context, "lua gc error : [%x to %s : %d]", source , self, session);
        break;
    };

    lua_pop(L,1);

    return 0;
}

根据上面的代码分析,当服务是lua实现的时候,skynet底层核心框架在处理完消息以后,回调lua层服务的回调函数时,要先经过一次lua api协议的处理,将参数准备好以后,然后调用lua服务中的回调函数。

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

推荐阅读更多精彩内容