Unity+Slua使用LuaProfiler进行真机调试

KaaPexei

LuaProfiler


项目的Github主页：Miku-LuaProfiler
Readme中介绍了基本使用方法，这里介绍一下工具的简要原理和如何进行真机调试
简要原理

实现了一套对Lua的内存、函数耗时进行数据收集、分析统计的基础模块。通过类似BeginSample/EndSample的函数对，进行数据采样。对所有加载到的代码进行语义分析，并且在函数开始结束部分(还有其它，细节不赘述)插入BeginSample和EndSample调用，来实现采样。工具为了适应众多Lua框架，采用Hook方式对LuaDLL的部分接口进行了替换，以自动调用步骤2的处理，比如luaL_loadbuffer。具体查看源码 LuaDLL.Install() 有关部分。

真机调试


该项目目前的easyhook、master分支默认都不支持真机调试，在master分支进行一些改造后可以达到真机调试的目的。
无法真机运行的原因


根本原因在于，il2cpp下对LuaDLL接口进行Hook的方式无法运行（据说mono可以但是意义不大，没有进行测试），设计上是支持真机调试的。
操作步骤

按照master分支的readme进行工具的部署和安装。

• 
  代码修改
  最简单的办法就是不用Hook，手动修改LuaDLL的函数调用，达到接口替换的目的，运行LuaProfiler的执行流程。
  以Slua为例：
  查看源码LuaDLL.Install部分，找到所有进行hook的函数，例如：
  

luaL_newstate_hooker = BindHook(oldType, replaceType, "luaL_newstate", "luaL_newstate_replace");
搜索源代码luaL_newstate，把全部替换为luaL_newstate_replace，例如：
            #if USE_LUA_PROFILER            L = MikuLuaProfiler.LuaDLL.luaL_newstate_replace();            #else            L = LuaDLL.luaL_newstate();            #endif
全部替换完毕，按照master分支Readme进行真机调试即可。

• 电脑使用Unity开启LuaProfilerServer工程，通过 Window->Lua Profiler Window打开窗口，然后单击 OpenService，等待客户端连接。
  出包必须设置宏 USE_LUA_PROFILER 以在App中注入探查器代码。
  Android：使用USB线连接Android手机。在cmd窗口中执行以下指令，设置IP：127.0.0.1 port:2333
  

adb reverse tcp:2333 tcp:2333
然后运行apk，正常的话LuaProfilerServer工程那边就可以看到数据了。
降低profiler本身对分析结果的影响


LuaProfiler使用中我们会发现程序运行比正常情况下卡很多，Profiler结果中很多函数的运行耗时也非常不正常，数据干扰比热点函数的开销还要打，导致对运行效率的分析没有意义。
这是因为Begin/EndSample调用后的自身开销对结果造成了干扰，同一帧他们调用的次数越多对结果的影响就越大。有一些底层接口调用非常频繁，比如Vector有关的lua实现部分，还有比如项目代码DataManager/ConfigsManager部分，等等很多。
处理思路，对需要分析的代码进行过滤，经过在项目中的实际尝试，最简单有效的方式是代码文件名白名单配置。

尝试了黑名单、白名单+函数白名单、黑名单+函数白/黑名单，等等，各有各的问题

简要代码：
修改Parse.cs文件，该文件进行lua语义分析和Sample插入。
        public static string InsertSample(string value, string name)        {            #if PROFILE_FILTER            if (!ProfileContent.Inst.IsMatchFile(name))            {                return value;            }            #endif
ProfileContent实现一个简单的ScriptableObject，最好实现一个buildAB和设备上配置下载的机制，能够快速把同步对过滤器的修改到手机。
比如要分析一个模块，把模块有关的代码都写入白名单配置，之后再进行Profiler会发现耗时干扰基本可以忽略了。