尽管它的名字中有“debug”,但是debug库在很多非调试方面也很有用。常见的任务就是用于性能分析。用于时间的性能分析最好使用C接口:因为Lua代码的hook调用开销很大,所以用于测试时间毫无意义。然而用于性能分析,Lua代码很适合。在本章中,我们开发一个初版本的分析工具,用于统计每个函数的调用次数。
两个table是我们程序中用到的主要数据结构:一个记录函数调用次数,另一个记录对应的函数名。函数本身是两个table的索引。
local Counters = {}
local Names = {}
我们可在分析之后,再去检索函数名。但是当我们在函数处于活动状态时,去检索函数名,会得到更好的结果。因为Lua会查找代码,在调用此函数的时候获得这个函数的名称。
现在我们来定义hook函数。函数的任务是获取被调函数,并增加相应的计数器;同时也收集函数名:
local function hook()
local f = debug.getinfo(2, "f").func --2为此时调用的函数名
local count = Counter[f]
if count == nil then -- 第一次调用函数的时候
Counters[f] = 1
Names[f] = debug.getinfo(2, "Sn")
else -- 增加计数器
Counters[f] = count + 1
end
end
local f = debug.getinfo(2, "f").func --2为此时调用的函数名
local count = Counter[f]
if count == nil then -- 第一次调用函数的时候
Counters[f] = 1
Names[f] = debug.getinfo(2, "Sn")
else -- 增加计数器
Counters[f] = count + 1
end
end
下一步是运行Lua程序,并设置这个hook函数。假设主程序在一个文件里面,文件名以参数的形式传给分析器,就像:
% lua profiler main-prog
用这方法,分析器可以在arg[1]中得到文件名,接下来打开hook,运行文件:
local f = assert(loadfile(arg[1]))
debug.sethook(hook, "c") -- 开启hook用于函数调用
f() -- 运行主程序
debug.sethook() -- 关闭hook
最后一步输出结果。列表24.2中的函数getname,返回一个函数的名称。因为函数名在Lua中是不确定的,我们将函数出现的行号也标注出来,输出一对值“文件:行号”。如果一个函数没有名字,它就用位置表示。如果一个函数是C函数,我们只显示函数名(因为它没有位置)。如此定义以后,我们输出每个函数和它的计数器:
for func, count in pairs(Counters) do
print(getname(func), count)
end
function getname(func) local n = Name[func] if n.what = "C" then return n.name end local lc = string.format("[%s]:%d", n.short_src, n.linedfined) if n.what ~= "main" and n.namewhat ~= "" then return string.format("%s (%s)", lc, n.name) else return lc end end |
我们调用10.3节中的程序,然后输出结果如下:
结果的意思是第四行是一个匿名函数(所有字段中都定义了inerater)调用过了884723次,write (io.write) 函数调用了10000次,等等。
这个分析器还有可以改进的地方,如果输出结果排序。不管如何,这个分析工具已经很有用了,并且可以作为后续开发的基础。