使用C API的弱表和GC终结器

时间:2014-06-06 17:51:37

标签: c lua garbage-collection lua-api

我试图通过使用C API将其存储在弱表中来为函数值创建GC终结器。

我开始在纯Lua 5.2中编写原型:

local function myfinalizer()
   print 'Called finalizer'
end

function myfunc()
   print 'Called myfunc'
end

local sentinels = setmetatable({}, { __mode='k' })
sentinels[myfunc] = setmetatable({}, { __gc=myfinalizer })

myfunc()
myfunc = nil
collectgarbage 'collect'

print 'Closing Lua'

结果输出:

Called myfunc
Called finalizer
Closing Lua

原型似乎按预期工作。以下是C版:

#include <stdlib.h>
#include <stdio.h>
#include "lua.h"
#include "lualib.h"
#include "lauxlib.h"

static int my_finalizer(lua_State *L)
{
    puts("Called finalizer");
    return 0;
}

static int my_func(lua_State *L)
{
    puts("Called myfunc");
    return 0;
}

int main(void)
{
    lua_State *L = luaL_newstate();
    luaL_openlibs(L);

    // create sentinels table (weak keys) in registry
    lua_newtable(L);                                    // t
    lua_newtable(L);                                    // t mt
    lua_pushstring(L, "k");                             // t mt v
    lua_setfield(L, -2, "__mode");                      // t mt
    lua_setmetatable(L, -2);                            // t
    lua_setfield(L, LUA_REGISTRYINDEX, "sentinels");    //

    // push global function and register as sentinel
    lua_pushcfunction(L, my_func);                      // f
    lua_getfield(L, LUA_REGISTRYINDEX, "sentinels");    // f t
    lua_pushvalue(L, 1);                                // f t k
    lua_newuserdata(L, 0);                              // f t k v
    lua_newtable(L);                                    // f t k v mt
    lua_pushcfunction(L, my_finalizer);                 // f t k v mt v
    lua_setfield(L, -2, "__gc");                        // f t k v mt
    lua_setmetatable(L, -2);                            // f t k v
    lua_settable(L, -3);                                // f t
    lua_pop(L, 1);                                      // f
    lua_setglobal(L, "myfunc");                         //

    // execute test script and exit
    if (luaL_dostring(L, "myfunc(); myfunc=nil; collectgarbage'collect'")) {
        printf("Error: %s\n", lua_tostring(L, -1));
    }
    lua_gc(L, LUA_GCCOLLECT, 0);    // suggestion: two full gc cycles
    fflush(stdout);                 // suggestion: immediate flush
    puts("Closing Lua");
    lua_close(L);

    fflush(stdout);
    return EXIT_SUCCESS;
}

使用编译:

$ gcc -std=c99 -Wall -Werror -pedantic -O2 -o main main.c -ldl -llua52 -lm

结果输出:

Called myfunc
Closing Lua
Called finalizer

C版本有一些细微差别:

  1. 而不是我存储在注册表中的本地sentinels表。
  2. 使用零大小的用户数据而非使用__gc元方法的标记值表。
  3. 我很困惑为什么在C版本中myfunc终结器在运行完整的收集周期后没有执行。我做错了什么?

1 个答案:

答案 0 :(得分:5)

作为Lua手册states

  

仅从弱表中删除具有显式构造的对象。诸如数字和轻C函数之类的值不受垃圾收集的影响,因此不会从弱表中删除(除非收集其相关值)。

你的my_func被推送没有任何upvalues,因此它是一个轻量级C函数,并且在垃圾收集期间它不会从弱表中删除,因此关闭之前关联的userdata不会变成垃圾Lua州。如果您使用Lua函数而不是my_func,或者如果您使用upvalues推送my_func(并且如果您在lua_gc调用中修复参数的顺序!),则代码应该有效。

总而言之,以下值类型 not 从弱表中删除(假设它们的关联键/值也未被删除):

  • 布尔值
  • 字符串
  • light userdata
  • 灯光C功能(仅限Lua 5.2)

因此,您的程序应该可以正常使用Lua 5.1,因为没有简单的C函数(您仍然必须修复lua_gc调用)。