Cnumber 补丁

wiki

介绍

CNUMBER 补丁（可在 LuaPowerPatches 获取）提供了一种更有效的机制，用于从 Lua 访问数值 C 变量。例如，考虑以下 C 变量

  double foo = 10.0;

  foo = foo + 1

另一种方法是公开来自 C 的 getter 和 setter 访问器函数（或方法），并让 Lua 代码直接调用这些函数

  set_foo(get_foo() + 1)

另一种建议的方法可能是将数值 C 变量实现为重量级用户数据，并附加一个带有适当事件的元表，以便它们的行为像普通值一样。但是，这也没有提供有效的或语法上干净的解决方案。您可以使用元表事件更改值的行為，但您不能使它们的行为完全像普通值一样。例如，没有“赋值”元表事件可以允许此类值充当左值（与 C++ 不同）。

此补丁通过提供所谓的“CNUMBER”来解决这些问题。CNUMBER 是在 Lua 中公开的变量，它是在 C 中实现的。在某种程度上，它类似于 Lua CFUNCTION，它是在 Lua 中公开并在 C 中实现的函数。对 CNUMBER 的访问几乎与对 Lua 局部变量的访问一样快，这并不奇怪，因为 CNUMBER 的处理方式与局部变量类似（忽略闭包和作用域）。

用法

要将 CNUMBER 注册到 Lua，您必须定义三个函数，如下所示

double foo = 0.0;
double foo2 = 0.0;
double foo3 = 0.0;

    int
iscnumber(lua_State * L, const char * varname, int * id) {
    if(strcmp(varname, "foo") == 0) {
        *id = 1; return 1; /* yes */
    }
    else if(strcmp(varname, "foo2") == 0) {
        *id = 2; return 1; /* yes */
    }
    else if(strcmp(varname, "foo3") == 0) {
        *id = 3; return 1; /* yes */
    }
    else {
        return 0; /* no */
    }
}

    double
getcnumber(lua_State *L, int id) {
    switch(id) {
        case 1: { return foo; }
        case 2: { return foo2; }
        case 3: { return foo3; }
        default: assert(0);
    }
    return 0;  /* should not occur */
}

    void
setcnumber(lua_State *L, int id, double value) {
    switch(id) {
        case 1: { foo  = value;  break; }
        case 2: { foo2 = value;  break; }
        case 3: { foo3 = value;  break; }
        default: assert(0);
    }
}

getcnumber 和 setcnumber 函数在运行时处理这两个操作码时被调用，分别用于获取或设置变量。每个函数都传递前面提到的 ID。这些函数可以使用对该 ID 的简单查找，如上所述，或者它可以是更复杂的东西（例如，索引到数组）。C 代码中不一定实际存在 double 变量。

这三个函数必须在解析之前注册，如下所示

  lua_setcnumberhandler(L, iscnumber, getcnumber, setcnumber);

您可以通过将它们全部设置为 NULL 来取消注册它们。

基准测试

基准测试是在此简单示例的 10 次迭代中提供的

  for n=1,10000000 do
    foo = foo + 1
  end

  Linux 2.4.20 (virtualized) / GCC / Intel(R) Xeon(TM) 3 GHz
  == Run Times (sec)
  LOOP           : 8.100000
  CNUMBER        : 23.490000 *
  LOCAL          : 15.200000
  GLOBAL         : 37.150000
  METATABLELOCAL : 99.980000
  METATABLETABLE : 198.790000
  CFUNCTION      : 72.010000

  WinXP / GCC Ming / Intel(R) P4 3 GHz
  == Run Times (sec)
  LOOP           : 3.361000
  CNUMBER        : 13.702000 *
  LOCAL          : 8.579000
  GLOBAL         : 25.640000
  METATABLELOCAL : 72.858000
  METATABLETABLE : 150.266000
  CFUNCTION      : 52.672000

• LOOP - 只做循环的时间
• CNUMBER - foo 是一个 CNUMBER
• LOCAL - foo 是一个局部 Lua 变量
• GLOBAL - foo 是一个全局 Lua 变量
• METATABLELOCAL - foo 是通过元表访问的局部 Lua 变量
• METATABLETABLE - foo 在通过元表访问的查找表中找到
• CFUNCION - foo 通过 CFUNCTION（get_foo 和 set_foo）访问。

如所示，CNUMBER 几乎与 Lua 局部变量一样快，并且比 Lua 全局变量更快。它们比 METATABLETABLE 和 CFUNCTION 方法快得多，否则需要从 Lua 公开 C 变量。METATABLELOCAL 是 METATABLETABLE 的一个更简单的版本（省略了第二个表查找），但实际上没有用，仅用于比较。此基准程序包含在补丁中（cnumber.c）。

在某个“现实生活”应用程序中，CFUNCTION 将运行时减少了约 40%。

设计说明

CNUMBER 实现具有一些重要特性

• 接口相当通用。它使用 get/set 函数，而不是指向实际的 C double 变量。实际的 C double 变量并不一定存在。自定义代码也可以附加到 get/set 操作。
• CNUMBER ID 的语义仅对 C 程序已知（对 Lua 不知）。这也提供了灵活性。ID 的最大数量为 2^18。
• CNUMBER 可以被认为是最高级别的局部变量。CNUMBER 覆盖全局变量，但会被局部变量覆盖。由于 CNUMBER 始终处于最高级别，因此它们永远不会超出范围，因此不需要特殊处理来处理闭包（就像局部变量一样）。
• 虽然 CNUMBER 在范围内处于最高级别（全局），但可以通过在词法分析的某些阶段让 getisnumber 返回 0 来对该范围进行词法限制（就像局部变量一样）。一种方法可能是将 LexState? 指针传递给 iscnumber。但是，如果允许 CNUMBER 超出范围，它们将不会被闭包复制（就像局部变量一样），除非此补丁以某种方式扩展。不过，这种功能是否实用尚不确定。
• CNUMBER（就像局部变量一样）在编译时解析，并且（与全局变量不同）在运行时不会存储在 Lua 表中。这提供了效率，但也降低了灵活性。
• CNUMBER 的 C 实现与 Lua 中的名称绑定，而不是与值绑定。因此，如果您执行“x = foo”，则 x 被分配 foo 的值，但 x 本身不会成为 CNUMBER。这与 CFUNCTION 不同，CFUNCTION 与值绑定。
• Lua 不知道所有可用的 CNUMBER 的完整列表。Lua 只是为它想要测试的每个标识符调用 iscnumber 函数。这可能更灵活（例如，如果您有大量变量），但可能的缺点是 Lua 无法在编译时或运行时真正枚举它们（例如，反射），即使有这种需求。
• Lua VM 中添加了两个额外的操作码：GETCNUMBER 和 SETCNUMBER。它们在本质上与 GETLOCAL 和 SETLOCAL 操作码非常相似。

此补丁的可能扩展包括以下内容

• 支持除数字以外的其他基本数据类型（例如，CBOOLEAN、CSTRING 和 CFUNCTION）。（我不确定 nil、userdata、thread 和 table，但这似乎也还可以。）此补丁的扩展形式可以更一般地重命名为 CVARIABLE 或 CLOCAL。
• 在 LuaJIT 上进行测试。

--DavidManura