云风的 BLOG: Lua 中 userdata 的反向映射

lua 中，我们可以用 userdata 保存一个 C 结构。当我们为 lua 写扩展时，C 函数中可以利用 lua_touserdata 将 userdata 转换为一个 C 结构指针。

但是，有时候我们却需要把一个指针转换回 lua 中的 userdata 对象。用到它的最常见的地方是封装 GUI ，通常 GUI 的底层是用 C 编码的。当 engine 把鼠标位置或是别的消息拦截到以后，消息会被传递到一个 C 对象中。这个时候，我们需要从 C 对象中得到对应的 lua 对象，并触发事件。

常见的方法是在 C 对象中保留一个 lua 对应对象的 reference ， lua 利用注册表中的数字 key 制作了一个简易的 reference 系统。可以让 C 对象保留一个对 lua 中某对象的引用，使得 lua 的 gc 系统不会错误的回收掉它。

效率略高的方法是，直接让 lua 的 userdata 为 C 对象分配内存，这样，可以更直接的利用 lua 的 gc 系统。而我们在 C 中则可以直接保存 userdata 的数据指针。这是有点点 tricky 的方法，因为 lua 并不保证 userdata 分配出来的内存不会因为 gc 而移动。不过我向 lua 作者求证过，在很长一段时间里，lua 都没有计划实现一个带移动的 gc 。（实际上，移动的 gc 会导致大量的 lua 已有代码不能使用）

这样，只要你能保证 userdata 不会被回收，就可以直接保留 userdata 内的数据指针并使用它。

接下来，我们便有了更简单的反向映射方法。就是直接在 lua 的注册表中创建一个弱表，用它来保存指针和 userdata 的 pair 。需要反向映射的时候，直接用指针作为一个 lightuserdata 当 key 去查这张表就可以了。

由于我们把这些映射信息放在一个弱表中，那么也就不需要关心解引用的问题了。

因为我们一定是 C 函数来操作 userdata ，这个映射表完全可以放在 C 函数的 upvalue 或是环境中，而不需要每次都从注册表拿到。

ps. 如果嫌查表的方法得到反向映射对象的效率不高，云风曾经还做过一个 lua api 的扩展，仿造 lua_pushlightuserdata 加了一个 api 为 lua_pushuserdata （就是调整一下内部指针就可以了，避免表查询），可以直接把一个你认为一定是 userdata 的数据指针，转换为 lua object 压回堆栈。不过这个被评价为 unsafe and think local 。好象大家都公认为了一点效率提高而加一个不太安全的 api 没有价值。如果你都需要回调脚本了，在 C 里多做一次表查询对效率的影响已经微乎其微了。

我自己写完了也是觉得意义不大，这里就不贴了。