Quel est le principe d'implémentation du débogueur dans la machine virtuelle Python ?

Le débogueur est une partie très importante d'un langage de programmation. Le débogueur est un outil utilisé pour diagnostiquer et corriger les erreurs de code (ou bugs). Il permet aux développeurs de visualiser et d'analyser le code étape par étape pendant l'exécution du programme. . État et comportement, il peut aider les développeurs à diagnostiquer et à corriger les erreurs de code, à comprendre le comportement du programme et à optimiser les performances. Le débogueur est un outil très puissant dans n’importe quel langage de programmation et peut améliorer l’efficacité du développement et la qualité du code.

Laissez le programme s'arrêter

Le point le plus important si nous devons déboguer un programme est que si nous arrêtons le programme, nous ne pouvons qu'arrêter l'exécution du programme Observez le statut d'exécution du programme. Par exemple, nous devons déboguer la table de multiplication 99 :

def m99():
    for i in range(1, 10):
        for j in range(1, i + 1):
            print(f"{i}x{j}={i*j}", end='\t')
        print()


if __name__ == '__main__':
    m99()

Exécutez maintenant la commande python -m pdb pdbusage.py pour déboguer le programme ci-dessus :

#🎜 🎜 #(py3.8) ➜ pdb_test git:(master) ✗ python -m pdb pdbusage.py

> /Users/xxxx/Desktop/workdir/dive-into-cpython/code/pdb_test/pdbusage.py ( 3)()
-> def m99():
(Pdb) s
> code /pdb_test/pdbusage.py(10)()
-> si __name__ == '__main__':
(Pdb) s
> Bureau /workdir/dive-into-cpython/code/pdb_test/pdbusage.py(11)()
-> Appelez --
> /Users/xxxx/Desktop/workdir/dive-into-cpython/code/pdb_test/pdbusage.py(3)m99()
-> 🎜 🎜#(Pdb) s
> /Users/xxxx/Desktop/workdir/dive-into-cpython/code/pdb_test/pdbusage.py(4)m99()
-> dans la plage (1, 10):
(Pdb) s
> /Users/xxxx/Desktop/workdir/dive-into-cpython/code/pdb_test/pdbusage.py(5)m99() # 🎜🎜#-> pour j dans la plage (1, i + 1):
(Pdb) s
> /Users/xxxx/Desktop/workdir/dive-into-cpython/code/ pdb_test /pdbusage.py(6)m99()
-> print(f"{i}x{j}={i*j}", end='t')
(Pdb) p i
1
(Pdb)


Bien sûr, vous pouvez également déboguer dans l'IDE :

#🎜🎜 #

D'après notre expérience de débogage, il est facile de savoir que la première et la plus importante chose pour déboguer un programme est que le programme doit pouvoir s'arrêter à l'endroit où nous avons défini le point d'arrêt

# 🎜🎜#cpython King Explosion Mechanism— tracing

La question est maintenant : comment le programme ci-dessus s'arrête-t-il lorsqu'il est exécuté ?

D'après l'étude précédente, nous pouvons comprendre que l'exécution d'un programme python doit d'abord être compilée en bytecode python par le compilateur python, puis transmise à la machine virtuelle python pour exécution si. le programme doit être arrêté. La machine virtuelle doit fournir une interface au programme Python de la couche supérieure afin que lorsque le programme est exécuté, elle puisse savoir où il est actuellement exécuté. Ce mystérieux mécanisme est caché dans le module sys. En fait, ce module est responsable de presque toutes les interfaces que nous utilisons pour interagir avec l'interpréteur python. Une fonction très importante pour implémenter le débogueur est la fonction sys.settrace. Cette fonction définira une fonction de suivi pour le thread lorsque la machine virtuelle a un appel de fonction et exécute une ligne de code, ou même après avoir exécuté un bytecode, cette fonction. sera exécuté.

Pour implémenter un débogueur de code source Python, vous devez configurer la fonction de traçage dans le système. Cette fonction est spécifique au thread ; pour prendre en charge le débogage multithread, une fonction de traçage doit être enregistrée pour chaque thread en cours de débogage, à l'aide de settrace() ou de threading.settrace() .

La fonction de suivi doit avoir trois paramètres : frame, event et arg. frame est le cadre de pile actuel. l'événement est une chaîne : 'call', 'line', 'return', 'exception', 'opcode', 'c_call' ou 'c_exception'. arg dépend du type d'événement.

La fonction de suivi est appelée à chaque fois qu'une nouvelle portée locale est entrée (événement défini sur 'call') ; elle doit renvoyer une référence à la fonction de suivi locale pour la nouvelle portée, ou Aucun si vous ne souhaitez pas de suivi dans cette portée.

Si une erreur se produit dans la fonction trace, elle sera désactivée, tout comme l'appel de settrace(None). La signification de l'événement

est la suivante :

appel, une fonction est appelée (ou d'autres blocs de code sont saisis). Lorsque vous appelez une fonction de trace locale, spécifiez arg comme None et spécifiez la fonction locale dans la valeur de retour.

line, une nouvelle ligne de code sera exécutée et la valeur du paramètre arg est None .

• return, la fonction (ou autre bloc de code) est sur le point de revenir. Lorsqu'un événement est provoqué par une exception, la fonction de traçage locale est appelée et renvoie la valeur argument None. Les valeurs de retour des fonctions de suivi sont ignorées.

• exception, une exception s'est produite. Appelez la fonction de traçage locale ; arg est un tuple (exception, valeur, traceback) ; la valeur de retour spécifie la nouvelle fonction de traçage locale.

• opcode，解释器即将执行新的字节码指令。执行本地追踪函数，arg为空，返回一个新的本地追踪函数。默认情况下，不会发出每个操作码的事件：必须通过在帧上设置 f_trace_opcodes 为 True 来显式请求。

• c_call，一个 c 函数将要被调用。

• c_exception，调用 c 函数的时候产生了异常。

自己动手实现一个简单的调试器

我们将在此章节中实现一个简单的调试器，以帮助大家理解调试器的实现原理。调试器的实现代码如下所示，只有短短几十行却可以帮助我们深入去理解调试器的原理，我们先看一下实现的效果在后文当中再去分析具体的实现：

import sys

file = sys.argv[1]
with open(file, "r+") as fp:
    code = fp.read()
lines = code.split("\n")


def do_line(frame, event, arg):
    print("debugging line:", lines[frame.f_lineno - 1])
    return debug


def debug(frame, event, arg):
    if event == "line":
        while True:
            _ = input("(Pdb)")
            if _ == 'n':
                return do_line(frame, event, arg)
            elif _.startswith('p'):
                _, v = _.split()
                v = eval(v, frame.f_globals, frame.f_locals)
                print(v)
            elif _ == 'q':
                sys.exit(0)
    return debug


if __name__ == '__main__':
    sys.settrace(debug)
    exec(code, None, None)
    sys.settrace(None)

在上面的程序当中使用如下：

• 输入 n 执行一行代码。

• p name 打印变量 name 。

• q 退出调试。

现在我们执行上面的程序，进行程序调试：

(py3.10) ➜  pdb_test git:(master) ✗ python mydebugger.py pdbusage.py
(Pdb)n
debugging line: def m99():
(Pdb)n
debugging line: if __name__ == '__main__':
(Pdb)n
debugging line:     m99()
(Pdb)n
debugging line:     for i in range(1, 10):
(Pdb)n
debugging line:         for j in range(1, i + 1):
(Pdb)n
debugging line:             print(f"{i}x{j}={i*j}", end='\t')
1x1=1   (Pdb)n
debugging line:         for j in range(1, i + 1):
(Pdb)p i
1
(Pdb)p j
1
(Pdb)q
(py3.10) ➜  pdb_test git:(master) ✗ 

可以看到我们的程序真正的被调试起来了。

现在我们来分析一下我们自己实现的简易版本的调试器，在前文当中我们已经提到了 sys.settrace 函数，调用这个函数时需要传递一个函数作为参数，被传入的函数需要接受三个参数：

• frame，当前正在执行的栈帧。

• event，事件的类别，这一点在前面的文件当中已经提到了。

• arg，参数这一点在前面也已经提到了。

• 同时需要注意的是这个函数也需要有一个返回值，python 虚拟机在下一次事件发生的时候会调用返回的这个函数，如果返回 None 那么就不会在发生事件的时候调用 tracing 函数了，这是代码当中为什么在 debug 返回 debug 的原因。

我们只对 line 这个事件进行处理，然后进行死循环，只有输入 n 指令的时候才会执行下一行，然后打印正在执行的行，这个时候就会退出函数 debug ，程序就会继续执行了。python 内置的 eval 函数可以获取变量的值。

python 官方调试器源码分析

python 官方的调试器为 pdb 这个是 python 标准库自带的，我们可以通过 python -m pdb xx.py 去调试文件 xx.py 。这里我们只分析核心代码：

代码位置：bdp.py 下面的 Bdb 类

    def run(self, cmd, globals=None, locals=None):
        """Debug a statement executed via the exec() function.

        globals defaults to __main__.dict; locals defaults to globals.
        """
        if globals is None:
            import __main__
            globals = __main__.__dict__
        if locals is None:
            locals = globals
        self.reset()
        if isinstance(cmd, str):
            cmd = compile(cmd, "<string>", "exec")
        sys.settrace(self.trace_dispatch)
        try:
            exec(cmd, globals, locals)
        except BdbQuit:
            pass
        finally:
            self.quitting = True
            sys.settrace(None)

上面的函数主要是使用 sys.settrace 函数进行 tracing 操作，当有事件发生的时候就能够捕捉了。在上面的代码当中 tracing 函数为 self.trace_dispatch 我们再来看这个函数的代码：

    def trace_dispatch(self, frame, event, arg):
        """Dispatch a trace function for debugged frames based on the event.

        This function is installed as the trace function for debugged
        frames. Its return value is the new trace function, which is
        usually itself. The default implementation decides how to
        dispatch a frame, depending on the type of event (passed in as a
        string) that is about to be executed.

        The event can be one of the following:
            line: A new line of code is going to be executed.
            call: A function is about to be called or another code block
                  is entered.
            return: A function or other code block is about to return.
            exception: An exception has occurred.
            c_call: A C function is about to be called.
            c_return: A C function has returned.
            c_exception: A C function has raised an exception.

        For the Python events, specialized functions (see the dispatch_*()
        methods) are called.  For the C events, no action is taken.

        The arg parameter depends on the previous event.
        """
        if self.quitting:
            return # None
        if event == 'line':
            print("In line")
            return self.dispatch_line(frame)
        if event == 'call':
            print("In call")
            return self.dispatch_call(frame, arg)
        if event == 'return':
            print("In return")
            return self.dispatch_return(frame, arg)
        if event == 'exception':
            print("In execption")
            return self.dispatch_exception(frame, arg)
        if event == 'c_call':
            print("In c_call")
            return self.trace_dispatch
        if event == 'c_exception':
            print("In c_exception")
            return self.trace_dispatch
        if event == 'c_return':
            print("In c_return")
            return self.trace_dispatch
        print('bdb.Bdb.dispatch: unknown debugging event:', repr(event))
        return self.trace_dispatch

从上面的代码当中可以看到每一种事件都有一个对应的处理函数，在本文当中我们主要分析 函数 dispatch_line，这个处理 line 事件的函数。

    def dispatch_line(self, frame):
        """Invoke user function and return trace function for line event.

        If the debugger stops on the current line, invoke
        self.user_line(). Raise BdbQuit if self.quitting is set.
        Return self.trace_dispatch to continue tracing in this scope.
        """
        if self.stop_here(frame) or self.break_here(frame):
            self.user_line(frame)
            if self.quitting: raise BdbQuit
        return self.trace_dispatch

这个函数首先会判断是否需要在当前行停下来，如果需要停下来就需要进入 user_line 这个函数，后面的调用链函数比较长，我们直接看最后执行的函数，根据我们使用 pdb 的经验来看，最终肯定是一个 while 循环让我们可以不断的输入指令进行处理：

    def cmdloop(self, intro=None):
        """Repeatedly issue a prompt, accept input, parse an initial prefix
        off the received input, and dispatch to action methods, passing them
        the remainder of the line as argument.

        """
        print("In cmdloop")
        self.preloop()
        if self.use_rawinput and self.completekey:
            try:
                import readline
                self.old_completer = readline.get_completer()
                readline.set_completer(self.complete)
                readline.parse_and_bind(self.completekey+": complete")
            except ImportError:
                pass
        try:
            if intro is not None:
                self.intro = intro
            print(f"{self.intro = }")
            if self.intro:
                self.stdout.write(str(self.intro)+"\n")
            stop = None
            while not stop:
                print(f"{self.cmdqueue = }")
                if self.cmdqueue:
                    line = self.cmdqueue.pop(0)
                else:
                    print(f"{self.prompt = } {self.use_rawinput}")
                    if self.use_rawinput:
                        try:
                            # 核心逻辑就在这里 不断的要求输入然后进行处理
                            line = input(self.prompt) # self.prompt = '(Pdb)'
                        except EOFError:
                            line = 'EOF'
                    else:
                        self.stdout.write(self.prompt)
                        self.stdout.flush()
                        line = self.stdin.readline()
                        if not len(line):
                            line = 'EOF'
                        else:
                            line = line.rstrip('\r\n')

                line = self.precmd(line)
                stop = self.onecmd(line) # 这个函数就是处理我们输入的字符串的比如 p n 等等
                stop = self.postcmd(stop, line)
            self.postloop()
        finally:
            if self.use_rawinput and self.completekey:
                try:
                    import readline
                    readline.set_completer(self.old_completer)
                except ImportError:
                    pass

    def onecmd(self, line):
        """Interpret the argument as though it had been typed in response
        to the prompt.

        This may be overridden, but should not normally need to be;
        see the precmd() and postcmd() methods for useful execution hooks.
        The return value is a flag indicating whether interpretation of
        commands by the interpreter should stop.

        """
        cmd, arg, line = self.parseline(line)
        if not line:
            return self.emptyline()
        if cmd is None:
            return self.default(line)
        self.lastcmd = line
        if line == 'EOF' :
            self.lastcmd = ''
        if cmd == '':
            return self.default(line)
        else:
            try:
                # 根据下面的代码可以分析了解到如果我们执行命令 p 执行的函数为 do_p
                func = getattr(self, 'do_' + cmd)
            except AttributeError:
                return self.default(line)
            return func(arg)

现在我们再来看一下 do_p 打印一个表达式是如何实现的：

    def do_p(self, arg):
        """p expression
        Print the value of the expression.
        """
        self._msg_val_func(arg, repr)

    def _msg_val_func(self, arg, func):
        try:
            val = self._getval(arg)
        except:
            return  # _getval() has displayed the error
        try:
            self.message(func(val))
        except:
            self._error_exc()

    def _getval(self, arg):
        try:
            # 看到这里就破案了这不是和我们自己实现的 pdb 获取变量的方式一样嘛 都是
            # 使用当前执行栈帧的全局和局部变量交给 eval 函数处理 并且将它的返回值输出
            return eval(arg, self.curframe.f_globals, self.curframe_locals)
        except:
            self._error_exc()
            raise

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!