Lua的hook机制及内存泄漏检测

最近突然有了对lua内存泄漏进行检测的需求,去研究了一下lua的说明书,发现lua的hook机制可以很好地满足要求。

1 hook机制

lua的hook属于debug库,可以在你的程序触发了某些事件的时候,调用你所注册的一个函数。
可以触发hook函数的事件有四种:

  1. call事件: lua调用了一个函数的时候
  2. return事件:lua的函数返回了
  3. line事件:当lua开始执行新的一行代码
  4. count事件:在指定的数字后执行?
    lua在调用hook函数的时候,将会带有一个参数,一个字符串来表示生成这次调用的类型,也就是"call", "return", "line", or "count"中的一种。特殊的是,对于line事件,他还会带第二个参数,行号。 当然,我们可以用debug.getinfo来获得hook中的更多信息。
    注册一个hook需要使用debug.sethook函数,带两个或者三个参数,第一个是hook的回调函数,也就是事件触发的时候需要调用的函数,第二个参数是一个用来标识我们需要监听的函数类型的字符串,还有一个可选的参数标识调用的频率。
    第二个参数,可以是c´,r´, or `l´来分别代表四个事件。
    如果sethook函数没有任何参数,就代表停用hook。

2 内存检测

核心在于

  1. collectgabage("count")将会返回当前所占用的内存,并进行一次GC
  2. debug.getinfo() 函数可以在调用的时候获取行号

使用方法:
将代码放到你的文件夹中,在addon_game_mode.lua或者你的入口处的文件中require对应的文件,之后你可以使用utilsMemoryLeakDetector:ShowRecord(count)函数,或者使用debug_dump_lua_memory_detail的控制台指令来查看当前的状态

local memory_state = {} -- 储存所有的内存调用
local current_memory = 0 -- 储存总内存状态

local function recordAlloc(event, line_no)
    local memory_increased = collectgarbage("count") - current_memory
    if (memory_increased < 1e-6) then return end

    local info = debug.getinfo(2, "S").source
    info = string.format("%s@%s", info, line_no - 1)

    local item = memory_state[info]
    if not item then
        memory_state[info] = {info, 1, memory_increased}
    else
        item[2] = item[2] + 1
        item[3] = item[3] + memory_increased
    end
    current_memory = collectgarbage("count")
end

utilsMemoryLeakDetector = {}

function utilsMemoryLeakDetector:StartRecord()
    if debug.gethook() then
        self:StopRecord()
        return
    end

    memory_state = {}
    current_memory = collectgarbage("count")
    debug.sethook(recordAlloc, "l")
end

function utilsMemoryLeakDetector:ShowRecord(count)
    if not memory_state then return end
    local sorted = {}

    for k, v in pairs(memory_state) do
        table.insert(sorted, v)
    end

    table.sort(sorted, function(a, b) return a[3] > b[3] end)

    for i = 1, count do
        local v = sorted[i]
        print(string.format("MemoryDump [MEM: %sK] [COUNT: %s ] [AVG: %s k] %s:", v[3], v[2], v[3] / v[2], v[1]))
    end
end

function utilsMemoryLeakDetector:EndRecord()
    debug.sethook()
end

utilsMemoryLeakDetector:StartRecord()

if IsInToolsMode() then
    Convars:RegisterCommand("debug_dump_lua_memory_detail",function(_, top_count)
        count = tonumber(top_count) or 30
        utilsMemoryLeakDetector:ShowRecord(count)
    end,"Dump lua usage",FCVAR_CHEAT)
end
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 196,099评论 5 462
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 82,473评论 2 373
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 143,229评论 0 325
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,570评论 1 267
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,427评论 5 358
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,335评论 1 273
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,737评论 3 386
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,392评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,693评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,730评论 2 312
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,512评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,349评论 3 314
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,750评论 3 299
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,017评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,290评论 1 251
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,706评论 2 342
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,904评论 2 335

推荐阅读更多精彩内容