一篇學會好玩的Lua
本文轉載自微信公眾號「編程雜技」，作者 theanarkh 。轉載本文請聯系編程雜技公眾號。
最近體驗了一下Openresty，了解到Openresty里使用lua語言來增強了Nginx的能力，所以又去了解了一下lua，lua語言小而精悍，lua引擎也值得學習。周末看了一下lua引擎的一些實現，也體驗了一下lua語言的一些東西，本文簡單介紹一下，后續有時間的話再寫文章分析引擎的實現。
1 在c語言中嵌入lua引擎
lua引擎本身是一個庫，類似V8一樣，我們可以把它嵌入到其他項目中，我們首先安裝相關文檔安裝lua(我安裝的是5.1.5)。然后寫個demo體驗一下。
- #include <lua.h>
- #include <lualib.h>
- #include <lauxlib.h>
- #include<stdio.h>
- int echo(lua_State *L) {
- printf("world");
- }
- int main(int argc, char *argv[]) {
- int s = 0;
- lua_State *L = lua_open();
- // 注冊個自定義的函數
- lua_register(L,"echo", echo);
- luaL_openlibs(L);
- // 執行lua腳本
- luaL_dofile(L, "hello.lua");
- lua_close(L);
- return 1;
- }
編譯上面的代碼
- gcc hello.c -llua -lm -ldl
然后寫個hello.lua腳本。
- print("hello");
- echo();
執行./a.out，我們看到輸出了hello world。這個是個簡單的體驗demo，和直接使用lua提供的命令行工具類似，只不過我們這里還拓展了一個自定義的echo函數給lua腳本調用。如果我們想動態地執行一段腳本，而不是執行一個lua文件，也是可以的。
- #include <lua.h>
- #include <lualib.h>
- #include <lauxlib.h>
- const char * script = "print('hi');";
- int main(int argc, char *argv[]) {
- lua_State *L = lua_open();
- luaL_openlibs(L);
- luaL_dostring(L, script);
- lua_close(L);
- return 1;
- }
編譯執行以上代碼我們會看到輸出hi。以上這些似乎沒什么大的作用，因為我們執行簡單地使用lua語言提供的能力。而lua的能力絕不止于此，lua稱為膠水語言，除了可以嵌入其他語言中，還支持拓展。下面我們看如果拓展lua的能力。
2 基于lua的demo運行時
雖然這里只是簡單地拓展lua，但是這里稱之為運行時是因為類似Node.js基于V8一樣，我們也可以通過拓展lua來實現一個基于lua的運行時。下面我們看看怎么拓展(也就是怎么調用其他語言的代碼，這里是c)。新建一個test.c文件。
- #include <lua.h>
- #include <lualib.h
- >#include <lauxlib.h>
- static int test(lua_State* L){
- //取棧第一個參數
- const char *a = luaL_checkstring(L, 1);
- //返回值入棧
- lua_pushstring(L, (const char *)"hi");
- return 1;
- }
- static const struct luaL_Reg reg_test[] = {
- {"test", test},
- {NULL, NULL}
- };
- int luaopen_test(lua_State *L) {
- const char* libName = "test";
- luaL_register(L, libName, reg_test);
- return 1;
- }
lua和c是通過一個棧進行通信的，lua調用c函數的時候，c函數可以從棧中獲取lua的參數，也可也從棧中返回執行結果給lua。我們把以上代碼編譯成一個動態庫。
- gcc test.c -fPIC -shared -o test.so
然后寫個測試lua demo。
- local test = require "test"
- a = test.test("hello world!")
- print(a)
我們可以看到在lua中成功調用了test模塊的test函數，并輸出hi。當我們require"test"的時候，lua會去當前目錄找test.o，并且執行其中的luaopen_test函數。luaopen_前綴是約定，test則是模塊名稱。當前去哪里找需要加載的模塊這個我們可以設置。我們分析一下c文件的代碼，看看拓展lua時的一些內容。首先看luaL_register。
- LUALIB_API void (luaL_register) (lua_State *L, const char *libname, const luaL_Reg *l) {
- luaI_openlib(L, libname, l, 0);
- }
我們主要關注luaL_register的第二第三個參數libname和luaL_Reg。因為知道這個參數的格式，我們才知道怎么寫c代碼。其中name是庫名稱，也就是我們require時傳的字符串。luaL_Reg的定義如下
- typedef int (*lua_CFunction) (lua_State *L);
- typedef struct luaL_Reg {
- const char *name;
- lua_CFunction func;
- } luaL_Reg;
luaL_Reg是封裝了kv的一個結構體，。name是導出的函數名稱，即在lua中可以調用的函數。func則是對應的函數，當在lua執行name函數時就會執行func的代碼。
3 lua變量存儲的設計
lua是動態類型的語言，意味著一個變量的值的類型是可以改變的，下面看一下lua中是如何設計底層的存儲的。lua所有變量都使用TValue結構體來表示。
- #define TValuefields Value value; int tt
- typedef struct lua_TValue {
- TValuefields;
- } TValue;
里面只有兩個字段。tt是表示變量類型。lua的類型比較簡單。如下
- #define LUA_TNIL 0
- #define LUA_TBOOLEAN 1
- #define LUA_TLIGHTUSERDATA 2
- #define LUA_TNUMBER 3
- #define LUA_TSTRING 4
- // 數組和對象都使用一種類型
- #define LUA_TTABLE 5
- #define LUA_TFUNCTION 6
- #define LUA_TUSERDATA 7
- #define LUA_TTHREAD 8
接下來我們看看Value的定義。
- typedef union {
- GCObject *gc;
- void *p;
- lua_Number n;
- int b;
- } Value;
Value里分為兩種類型，一種是不需要gc的，比如數字，一種是需要gc的，比如數組，lua是帶gc的語言。我們繼續看GCObject。
- union GCObject {
- GCheader gch;
- union TString ts;
- union Udata u;
- union Closure cl;
- struct Table h;
- struct Proto p;
- struct UpVal uv;
- struct lua_State th; /* thread */
- };
我們看到GCObject是一個聯合體，可以存儲不同類型的變量。我們再看看TString的定義。
- typedef union TString {
- L_Umaxalign dummy; /* 內存對齊，性能優化 */
- struct {
- CommonHeader;
- lu_byte reserved;
- unsigned int hash;
- size_t len;
- } tsv;
- } TString;
字符串結構體里面主要的字段時len和hash，len就是字符串的長度，hash類似一個索引，lua中的字符串不是存儲在結構體本身的，而是統一管理起來，主要是為了復用，比如有兩個變量的值都是同一個字符串，那么lua中，只會存儲一個字符串值，而這兩個變量都會通過hash指向這個字符串的值。我們可以看一下一段代碼大概了解一下。
- // 新建字符串，如果存在則直接復用
- TString *luaS_newlstr (lua_State *L, const char *str, size_t l) {
- GCObject *o;
- unsigned int h = cast(unsigned int, l); /* seed */
- size_t step = (l>>5)+1;
- size_t l1;
- // 計算字符串的哈希值
- for (l1=l; l1>=step; l1-=step) /* compute hash */
- h = h ^ ((h<<5)+(h>>2)+cast(unsigned char, str[l1-1]));
- // 判斷是否有一樣的字符串存在了，是則共享，直接返回，否則新建
- for (o = G(L)->strt.hash[lmod(h, G(L)->strt.size)];
- o != NULL;
- o = o->gch.next) {
- TString *ts = rawgco2ts(o);
- if (ts->tsv.len == l && (memcmp(str, getstr(ts), l) == 0)) {
- if (isdead(G(L), o)) changewhite(o);
- return ts;
- }
- }
- // 找不到則新建
- return newlstr(L, str, l, h); /* not found */
- }
我們看到lua的變量存儲設計中是一種樹狀結構，通過上層的變量類型，再進行不同的存取操作。從而我們也可以了解到動態語言在變量存儲中的一些設計思想。
后記：這是周末學習lua的一些內容，后續有時間會繼續更新，lua是一個非常有意思的項目。
