Lua5.1代码阅读（七）：lvm.h/lvm.c

一、概览

lvm.h/lvm.c的作用是提供底层的Lua虚拟机。

这个模块主要是用于循环读取并分解指令，

然后根据其操作码的枚举值进行处理或跳转到Lua的其它模块。

内部的函数引用图如下：

参考资料：

* A No-Frills Introduction to Lua 5.1 VM Instructions

http://luaforge.net/docman/83/98/ANoFrillsIntroToLua51VMInstructions.pdf

* 翻译Lua 5.1 VM Instructions(一)

http://blog.csdn.net/tm_wb/article/details/3453159

* 详解关于Lua源码分析学习教程

http://www.61ic.com/Mobile/iPhone/201108/36968.html

（Lua虚拟机的体系结构图，链接已废除，见

http://mobile.51cto.com/iphone-286631.htm）

* Lua VM 指令：导言

http://blog.csdn.net/chenyufei1013/article/details/4445803

* lua5.1.3编译器和虚拟机

http://blog.163.com/very_fyy/blog/static/2252168520083731434459/

* Lua 5.1.4 Annotated Source

http://stevedonovan.github.com/lua-5.1.4/

* Lua VM hack for execution time limits.

http://www.gammon.com.au/forum/?id=8453

* 详解如何实现Lua调试器案例

http://cnztech.com/html/mobile/iOS/2011/0924/46517.html

* Lua源代码分析顺序

http://wenku.baidu.com/view/24241ec4aa00b52acfc7caea.html

* 解析关于Lua调试器案例实现

http://mobile.51cto.com/iphone-288412.htm

* strange warnings

http://comments.gmane.org/gmane.comp.lang.lua.general/79521

* Lua GC 的源码剖析 (4)

http://blog.codingnow.com/2011/03/lua_gc_4.html

* 详解关于Lua源码分析学习教程

http://mobile.51cto.com/iphone-286631.htm

* Lua4虚拟机运行概述

http://blog.csdn.net/wondeful18/article/details/2982251

* Lua4

http://cjbskysea.blogbus.com/logs/84351473.html

二、头文件

#include "ldo.h"

#include "lobject.h"

#include "ltm.h"

#include <stdio.h>

#include <stdlib.h>

#include <string.h>

#include "lua.h"

#include "ldebug.h"

#include "ldo.h"

#include "lfunc.h"

#include "lgc.h"

#include "lopcodes.h"

#include "lstate.h"

#include "lstring.h"

#include "ltable.h"

#include "lvm.h"

三、公共或私有的宏定义

1. #define tostring(L,o) ((ttype(o) == LUA_TSTRING) || (luaV_tostring(L, o)))

转换o为LUA_TSTRING类型。

* 判断o（TValue*类型）是否为LUA_TSTRING类型。

* 如果不是，就用luaV_tostring把o（必须是LUA_TNUMBER类型）转换为字符串。

* 如果转换后o仍然不是LUA_TSTRING类型，那么返回0，否则返回1。

2. #define tonumber(o,n) (ttype(o) == LUA_TNUMBER || \

(((o) = luaV_tonumber(o,n)) != NULL))

转换o为LUA_TNUMBER类型。

* 判断o（TValue*类型）是否为LUA_TNUMBER类型。

* 如果不是，就用luaV_tonumber把o（必须是LUA_TSTRING而且可以转换为数字）转换为数。

* 如果转换后o仍然不是LUA_TNUMBER类型，那么返回0，否则返回1。

3. #define equalobj(L,o1,o2) \

(ttype(o1) == ttype(o2) && luaV_equalval(L, o1, o2))

判断o1和o2的类型和值是否都相等。

4. #define lvm_c

象征意味，表示当前在lvm.c中

5. #define LUA_CORE

象征意味，表示当前代码为Lua底层实现

6. #define MAXTAGLOOP 100

表的标签方法链的最大限制（避免死循环）。

这个宏定义在luaV_gettable和luaV_settable。

因为这两个函数在查询和修改表元素时，

如果__index和__newindex元方法的值本身也是一个table，

则可能出现迭代调用。

如果出现死循环，将调用luaG_runerror抛出异常。

7. #define runtime_check(L, c) { if (!(c)) break; }

在luaV_execute使用，

用于判断OP_SETLIST指令的RA值是否为table类型，如果不是就跳出switch。

（OP_SETLIST表示不带"="的表构造式，例如a={1}）

8. #define RA(i) (base+GETARG_A(i))

获得TValue*型的RA值（寄存器表基地址加上参数A偏移）

* 取出指令i中的参数A（栈偏移值），

* 把参数A作为偏移加上L->base（当前函数TValue数组的基）地址后算出指针。

9. #define RB(i) check_exp(getBMode(GET_OPCODE(i)) == OpArgR, base+GETARG_B(i))

获得TValue*型的RB值（寄存器表基地址加上参数B偏移）

* 取出指令i中的操作码

* 用lua_assert诊断操作码的B模式是OpArgR（通过查表判断，见getBMode和luaP_opmodes）。OpArgR表示参数是一个寄存器或跳转偏移。

* 取出指令i中的参数B（栈偏移值），

* 把参数B作为偏移加上L->base（当前函数TValue数组的基）地址后算出指针。

10. #define RC(i) check_exp(getCMode(GET_OPCODE(i)) == OpArgR, base+GETARG_C(i))

获得TValue*型的RC值（寄存器表加上参数C偏移，实际上没有任何代码使用此宏）

* 取出指令i中的操作码

* 用lua_assert诊断操作码的C模式是OpArgR（通过查表判断，见getCMode和luaP_opmodes）。OpArgR表示参数是一个寄存器或跳转偏移。

* 取出指令i中的参数C（栈偏移值），

* 把参数C作为偏移加上L->base（当前函数TValue数组的基）地址后算出指针。

11. #define RKB(i) check_exp(getBMode(GET_OPCODE(i)) == OpArgK, \

ISK(GETARG_B(i)) ? k+INDEXK(GETARG_B(i)) : base+GETARG_B(i))

获得TValue*型的RKB值（寄存器表或常量表基地址加上参数B偏移）

* 取出指令i中的操作码

* 用lua_assert诊断操作码的B模式是OpArgK（通过查表判断，见getBMode和luaP_opmodes）。OpArgK表示参数是一个常量或寄存器/常量。

* 取出指令i中的参数B（栈偏移值）

* 判断参数B（栈偏移值）是否为K型（常量），即它的最高位（参数B占二进制的9位）是否为1，

* 如果参数B是K型，那么参数B去掉最高位的1，然后作为偏移加上k（当前函数原型Proto结构体的k域指针）

* 否则，把参数B作为偏移加上L->base（当前函数TValue数组的基）地址后算出指针。

12. #define RKC(i) check_exp(getCMode(GET_OPCODE(i)) == OpArgK, \

ISK(GETARG_C(i)) ? k+INDEXK(GETARG_C(i)) : base+GETARG_C(i))

获得TValue*型的RKC值（寄存器表或常量表基地址加上参数C偏移）

* 取出指令i中的操作码

* 用lua_assert诊断操作码的C模式是OpArgK（通过查表判断，见getCMode和luaP_opmodes）。OpArgK表示参数是一个常量或寄存器/常量。

* 取出指令i中的参数C（栈偏移值）

* 判断参数C（栈偏移值）是否为K型（常量），即它的最高位（参数C占二进制的9位）是否为1，

* 如果参数C是K型，那么参数C去掉最高位的1，然后作为偏移加上k（当前函数原型Proto结构体的k域指针）

* 否则，把参数C作为偏移加上L->base（当前函数TValue数组的基）地址后算出指针。

13. #define KBx(i) check_exp(getBMode(GET_OPCODE(i)) == OpArgK, k+GETARG_Bx(i))

获得TValue*型的KBx值（常量表基地址加上参数Bx偏移）

* 取出指令i中的操作码

* 用lua_assert诊断操作码的B模式是OpArgK（通过查表判断，见getBMode和luaP_opmodes）。OpArgK表示参数是一个常量或寄存器/常量。

* 取出指令i中的参数Bx（栈偏移值）

* 把参数Bx作为偏移加上k（当前函数原型Proto结构体的k域指针）

14. #define dojump(L,pc,i) {(pc) += (i); luai_threadyield(L);}

增加程序计数器。

把pc值（即L->savedpc）递增i，然后用luai_threadyield挂起L栈以切换到其它系统级线程。

（默认luai_threadyield是无操作的）。

15. #define Protect(x) { L->savedpc = pc; {x;}; base = L->base; }

保护代码，同步L栈和luaV_execute函数栈两者之间的pc和base（？）

（貌似是因为luaV_execute函数太长，需要把部分代码分离到其它函数）

* 把临时的pc保存到L->savedpc

* 执行一段代码。

* 把最新的L->base同步到函数luaV_execute的局部变量base。

16. #define arith_op(op,tm) { \

TValue *rb = RKB(i); \

TValue *rc = RKC(i); \

if (ttisnumber(rb) && ttisnumber(rc)) { \

lua_Number nb = nvalue(rb), nc = nvalue(rc); \

setnvalue(ra, op(nb, nc)); \

} \

else \

Protect(Arith(L, ra, rb, rc, tm)); \

}

直接或用元方法执行算术运算（Arithmetic）

包括加、减、乘、除、取模和乘幂。

* 如果RKB和RKC都是LUA_TNUMBER型，那么用op宏或函数计算RKB和RKC，结果保存到RA

* 否则用提供的tm（元方法枚举量）调用Arith（查元表）进行算术运算。

四、私有的静态函数

1. static void traceexec (lua_State *L, const Instruction *pc) {

每次指令解析前调用钩子函数。

2. static void callTMres (lua_State *L, StkId res, const TValue *f,

const TValue *p1, const TValue *p2) {

调用元方法，用于__index、算术运算、大小比较的元方法值，

3. static void callTM (lua_State *L, const TValue *f, const TValue *p1,

const TValue *p2, const TValue *p3) {

调用元方法，用于function型的__newindex元方法值。

4. static int call_binTM (lua_State *L, const TValue *p1, const TValue *p2,

StkId res, TMS event) {

调用一元或二元的元方法，用于算术运算、取长度或拼接。

5. static const TValue *get_compTM (lua_State *L, Table *mt1, Table *mt2,

TMS event) {

从Table*对象的mt1和mt2中取出要使用的元方法的值。

用于判定要使用的元方法__eq的值。

6. static int call_orderTM (lua_State *L, const TValue *p1, const TValue *p2,

TMS event) {

对p1和p2执行用于比较操作的元方法。

7. static int l_strcmp (const TString *ls, const TString *rs) {

字符串TString*对象的大小比较。

8. static int lessequal (lua_State *L, const TValue *l, const TValue *r) {

判断同类型TValue对象l和r的值是否满足小于。

必要时调用元方法__lt和__le。

9. static void Arith (lua_State *L, StkId ra, const TValue *rb,

const TValue *rc, TMS op) {

算术运算ra := rb op rc或ra := op rb

* 尝试转换为Number型

* 如果两个操作数都转换成功，则执行默认操作luai_numadd，luai_numsub，luai_nummul，luai_numdiv，luai_nummod，luai_numpow和luai_numunm。

* 如果不成功，执行元方法__add，__sub，__mul，__div，__mod，__pow和__unm。

五、公开的导出函数

1. LUAI_FUNC const TValue *luaV_tonumber (const TValue *obj, TValue *n);

const TValue *luaV_tonumber (const TValue *obj, TValue *n) {

把obj转换为Number型。

2. LUAI_FUNC int luaV_tostring (lua_State *L, StkId obj);

int luaV_tostring (lua_State *L, StkId obj) {

把obj转换为string型。

3. LUAI_FUNC void luaV_gettable (lua_State *L, const TValue *t, TValue *key, StkId val);

void luaV_gettable (lua_State *L, const TValue *t, TValue *key, StkId val) {

表的get操作（查询）。

必要时调用元方法__index。

4. LUAI_FUNC void luaV_settable (lua_State *L, const TValue *t, TValue *key, StkId val);

void luaV_settable (lua_State *L, const TValue *t, TValue *key, StkId val) {

表的set操作（更新）。

必要时调用元方法__newindex。

5. LUAI_FUNC int luaV_lessthan (lua_State *L, const TValue *l, const TValue *r);

int luaV_lessthan (lua_State *L, const TValue *l, const TValue *r) {

判断两个同类型TValue对象l和r的值是否满足小于。

必要时调用元方法__lt。

6. LUAI_FUNC int luaV_equalval (lua_State *L, const TValue *t1, const TValue *t2);

int luaV_equalval (lua_State *L, const TValue *t1, const TValue *t2) {

判断两个同类型TValue对象t1和t2的值是否相等。

必要时调用元方法__eq。

7. LUAI_FUNC void luaV_concat (lua_State *L, int total, int last);

void luaV_concat (lua_State *L, int total, int last) {

默认的拼接操作，

必要时调用元方法__concat。

8. LUAI_FUNC void luaV_execute (lua_State *L, int nexeccalls);

void luaV_execute (lua_State *L, int nexeccalls) {

提取当前指令的操作码和参数，然后执行与操作码对应的switch跳转。

它是解释器（虚拟机）的主循环。

六、值得关注的函数

1. luaV_execute

虚拟机的核心。

七、补充：

Lua虚拟机的体系结构图

摘自

http://mobile.51cto.com/iphone-286631.htm