Lua 调试(Debug)

(1)

Lua 调试(Debug)

https://www.jianshu.com/p/93bbad44ad6a

Lua 提供了 debug 库用于提供创建我们自定义调速器的功能。Lua 本身并未有内置的调速器，但很多开发者共享了他们的 Lua 调速器代码。

Lua 中 debug 库包含以下函数：

sethook ([thread,] hook, mask [, count]):

上表列出了我们常用的调试函数，接下来我们可以看些简单的例子：

执行以上代码输出结果为：

在以实例中，我们使用到了 debug 库的 traceback 和 getinfo 函数， getinfo 函数用于返回函数信息的表。

另一个实例

我们经常需要调试函数的内的局部变量。我们可以使用 getupvalue 函数来设置这些局部变量。实例如下：

执行以上代码输出结果为：

在以上实例中，计数器在每次调用时都会自增1。实例中我们使用了 getupvalue 函数查看局部变量的当前状态。我们可以设置局部变量为新值。实例中，在设置前 n 的值为 2,使用 setupvalue 函数将其设置为 10。现在我们调用函数，执行后输出为 11 而不是 3。

---

调试类型

命令行调试

图形界面调试

命令行调试器有：RemDebug、clidebugger、ctrace、xdbLua、LuaInterface - Debugger、Rldb、ModDebug。

图形界调试器有：SciTE、Decoda、ZeroBrane Studio、akdebugger、luaedit。

---

作者：谁说我是小小云
链接：https://www.jianshu.com/p/93bbad44ad6a
来源：简书
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。

(2)

Lua 调试(Debug)

https://www.runoob.com/lua/lua-debug.html

Lua 调试(Debug)

Lua 提供了 debug 库用于提供创建我们自定义调试器的功能。Lua 本身并未有内置的调试器，但很多开发者共享了他们的 Lua 调试器代码。

Lua 中 debug 库包含以下函数：

序号	方法 & 用途
1.	debug(): 进入一个用户交互模式，运行用户输入的每个字符串。 使用简单的命令以及其它调试设置，用户可以检阅全局变量和局部变量， 改变变量的值，计算一些表达式，等等。 输入一行仅包含 cont 的字符串将结束这个函数， 这样调用者就可以继续向下运行。
2.	getfenv(object): 返回对象的环境变量。
3.	gethook(optional thread): 返回三个表示线程钩子设置的值： 当前钩子函数，当前钩子掩码，当前钩子计数
4.	getinfo ([thread,] f [, what]): 返回关于一个函数信息的表。 你可以直接提供该函数， 也可以用一个数字 f 表示该函数。 数字 f 表示运行在指定线程的调用栈对应层次上的函数： 0 层表示当前函数（getinfo 自身）； 1 层表示调用 getinfo 的函数 （除非是尾调用，这种情况不计入栈）；等等。 如果 f 是一个比活动函数数量还大的数字， getinfo 返回 nil。
5.	debug.getlocal ([thread,] f, local): 此函数返回在栈的 f 层处函数的索引为 local 的局部变量 的名字和值。 这个函数不仅用于访问显式定义的局部变量，也包括形参、临时变量等。
6.	getmetatable(value): 把给定索引指向的值的元表压入堆栈。如果索引无效，或是这个值没有元表，函数将返回 0 并且不会向栈上压任何东西。
7.	getregistry(): 返回注册表表，这是一个预定义出来的表， 可以用来保存任何 C 代码想保存的 Lua 值。
8.	getupvalue (f, up) 此函数返回函数 f 的第 up 个上值的名字和值。 如果该函数没有那个上值，返回 nil 。 以 '(' （开括号）打头的变量名表示没有名字的变量 （去除了调试信息的代码块）。
10.	sethook ([thread,] hook, mask [, count]): 将一个函数作为钩子函数设入。 字符串 mask 以及数字 count 决定了钩子将在何时调用。 掩码是由下列字符组合成的字符串，每个字符有其含义： 'c': 每当 Lua 调用一个函数时，调用钩子； 'r': 每当 Lua 从一个函数内返回时，调用钩子； 'l': 每当 Lua 进入新的一行时，调用钩子。
11.	setlocal ([thread,] level, local, value): 这个函数将 value 赋给 栈上第 level 层函数的第 local 个局部变量。 如果没有那个变量，函数返回 nil 。 如果 level 越界，抛出一个错误。
12.	setmetatable (value, table): 将 value 的元表设为 table （可以是 nil）。 返回 value。
13.	setupvalue (f, up, value): 这个函数将 value 设为函数 f 的第 up 个上值。 如果函数没有那个上值，返回 nil 否则，返回该上值的名字。
14.	traceback ([thread,] [message [, level]]): 如果 message 有，且不是字符串或 nil， 函数不做任何处理直接返回 message。 否则，它返回调用栈的栈回溯信息。 字符串可选项 message 被添加在栈回溯信息的开头。 数字可选项 level 指明从栈的哪一层开始回溯 （默认为 1 ，即调用 traceback 的那里）。

上表列出了我们常用的调试函数，接下来我们可以看些简单的例子：

实例

function myfunction ()
print(debug.traceback("Stack trace"))
print(debug.getinfo(1))
print("Stack trace end")
        return 10
end
myfunction ()
print(debug.getinfo(1))

执行以上代码输出结果为：

Stack trace
stack traceback:
    test2.lua:2: in function 'myfunction'
    test2.lua:8: in main chunk
    [C]: ?
table: 0054C6C8
Stack trace end

在以实例中，我们使用到了 debug 库的 traceback 和 getinfo 函数， getinfo 函数用于返回函数信息的表。

另一个实例

我们经常需要调试函数的内的局部变量。我们可以使用 getupvalue 函数来设置这些局部变量。实例如下：

实例

function newCounter ()
  local n = 0
  local k = 0
  return function ()
    k = n
    n = n + 1
    return n
    end
end

counter = newCounter ()
print(counter())
print(counter())

local i = 1

repeat
  name, val = debug.getupvalue(counter, i)
  if name then
    print ("index", i, name, "=", val)
        if(name == "n") then
                debug.setupvalue (counter,2,10)
        end
    i = i + 1
  end -- if
until not name

print(counter())

执行以上代码输出结果为：

1
2
index    1    k    =    1
index    2    n    =    2
11

在以上实例中，计数器在每次调用时都会自增1。实例中我们使用了 getupvalue 函数查看局部变量的当前状态。我们可以设置局部变量为新值。实例中，在设置前 n 的值为 2,使用 setupvalue 函数将其设置为 10。现在我们调用函数，执行后输出为 11 而不是 3。

---

调试类型

• 命令行调试
• 图形界面调试

命令行调试器有：RemDebug、clidebugger、ctrace、xdbLua、LuaInterface - Debugger、Rldb、ModDebug。

图形界调试器有：SciTE、Decoda、ZeroBrane Studio、akdebugger、luaedit。

Lua 错误处理

Lua 垃圾回收

(3)

lua debug库的一些玩法

https://blog.csdn.net/q_yang1987/article/details/52462842

lua一直是游戏领域广泛使用的脚步语言，但从整个IT行业来说确实特别小众，所以和python比起来网络上使用lua的“奇技淫巧”特别少，本文简单介绍一些对debug的一些奇妙用法。

本文对debug的一些用法大部分是从mobdebug（https://github.com/pkulchenko/MobDebug）总结来，推荐大家看看mobdebug的实现源码，里面把coroutine用的特别奇妙，简化了很多实现思路。（里面用源代码方式内嵌了serpent，用来序列化以及反序列化lua数据，作者能写一行就绝对不写两行，特别难看懂）

    get/setfenv实现

    过了lua5.2之后就没有这两个函数了，替代方式是_ENV，下面给出实现方式

    （实在不愿意用csdn的代码片功能了）

    if not setfenv then

        local function findenv(f)

            local index = 1

            repeat

                local name, value = debug.getupvalue(f, index)

                if name == "_ENV" then

                    return index, value

                end

                index = index + 1

            until name == nil

            return nil

        end

        getfenv = function (f) return (select(2, findenv(f)) or _G) end

        setfenv = function (f, t)

            local index = findenv(f)

            if index then debug.setupvalue(f, index, t) end

            return f

        end

    end

    其实就是找到_ENV变量提取出来，或者设置回去，可以用来实现跟复杂的沙盒功能

    实现沙盒

lua一个特别实用的功能就是他可以简单的嵌入到别的程序中，特别容易执行字符串代码片段（load*函数），这样也带来了安全性问题，如果可以将代码放在沙盒中执行，而不污染全局环境最好。下面给出一个简单的实现：

local function create_sandbox()

    return merge(_G, _ENV)

end

local function call_inbox(func, env)

    if not env then env = create_sandbox() end

    local old_env = getfenv(func)

    setfenv(func, env)

    pcall(func)

    setfenv(func, old_env)

end

有一个缺陷就是不能对输入参数做赋值（当然是可以通过getlocal 负值索引来做，不过就有点太hack了）

可以这么用：

local function t2()
    for k, v in pairs(_G) do
        print(k, v)
    end
    print("===================in sandbox====================")
    i = start
    j = 4
    k = i + j
    print(("i:%s j:%s k:%s"):format(i, j, k))
end
env.call_inbox(t2, merge(_ENV, merge(_G, { start = 3 })))
print("=====================outside======================")
print(("i:%s j:%s k:%s"):format(i, j, k))

》》

===================in sandbox====================
i:3 j:4 k:7
=====================outside======================
i:nil j:nil k:nil

没有污染全局

    单步调试修改局部变量

    debug.sethook(debugfunc, "l")这个用来单步hook的用法就不多说了，每次单步的时候getfenv-》修改local 变量-》setfenv回去，就可以修改局部变量了

    local function testee2()
        local upper = 1
        return upper
    end
                                                                                                                                                                                 
    local function t1()
        if upper then
            upper = 10
        end
    end
    env.set_change_var_func(t1)
    debug.sethook(env.trace_env, "l")
    print(testee2())
    debug.sethook()
    print(upper)

    》》

    10

    nil

    里面主要是trace_env函数：

    local function trace_env(event, line)                                                 
        if not M.change_var_func then return end                                          
        local level = 2                                                                   
        vars = capture_vars(level + 1)                                                    
        call_inbox(M.change_var_func, vars)                                               
        restore_vars(level + 1, vars)                                                                                
    end

    其中的capture_vars和restore_vars是get/setfenv的进阶版，实现可以参考mobdebug库的源码

    总结

    虽然专研奇技淫巧不是正途，但是lua社区的确太小，很多东西都要自己研究一番，甚至要自己修各种bug或者5.1到5.2的兼容问题（在我至今学习1个月lua的时间里，已经不下10次修改第三方的代码了），所以专研奇技淫巧，提高自己对于lua语言的使用和理解也是一种快速的学习方式。

————————————————
版权声明：本文为CSDN博主「q_yang1987」的原创文章，遵循CC 4.0 BY-SA版权协议，转载请附上原文出处链接及本声明。
原文链接：https://blog.csdn.net/q_yang1987/article/details/52462842