Tutoriel : Déboguer son programme avec GDB

Installation

Sous Linux/Unix

GDB est disponible dans la plupart des dépôts et peut également être téléchargé directement sur le site officiel.

Si vous ne savez pas comment installer un programme depuis les dépôts, référez-vous au tutoriel du site, dans la partie Linux : "Installer des programmes avec apt-get".

Si GDB n'est pas dans vos dépôts, téléchargez les sources de la dernière version et compilez-les. Ça devrait se faire facilement, je vous donne les étapes principales, si vous rencontrez un problème référez-vous au site de votre distribution pour trouver comment compiler (rem. remplacez les X.X par les numéros de la dernière version stable) :

wget http://ftp.gnu.org/gnu/gdb/gdb-X.X.tar.gz
tar -xvvf gdb-X.X.tar.gz
cd gdb-X.X.tar.gz
./configure
make
make install

Lancement d'une session

GDB fonctionne sur le principe d'une invite de commandes. Pour démarrer une session, on lance simplement GDB en lui passant éventuellement des paramètres. Le moyen le plus courant de démarrer une session est de préciser l'exécutable qu'on veut débugger en paramètre :

gdb program

Lorsqu'un programme plante, vous avez certainement déjà lu "(core dumped)". Cela signifie en fait que le système a enregistré dans un fichier une copie de ce qui se trouvait en mémoire au moment du plantage (la zone du programme qui a planté uniquement). C'est parfois utile pour faire des vérifications, mais ce n'est pas simple et donc nous n'en parlerons pas ici. Cependant, sachez que GDB permet de spécifier le nom de ce fichier comme second argument :

gdb program dumpfile

Parfois on souhaite déboguer un exécutable qui est déjà lancé, ce qu'on peut faire en précisant en second paramètre l'identifiant du processus. En général pour voir la liste des processus lancés, on utilise la commande ps (lisez la page man pour plus d'informations). Attention cependant, il ne doit pas y avoir de fichier portant le même nom que l'id du processus, sinon GDB va utiliser ce fichier comme fichier de dump au lieu de se référer au processus (ce qui peut avoir des effets désastreux).

gdb program 1234

Lorsque vous lancez GDB, il commence par vous afficher quelques informations légales. Vous pouvez préciser de ne pas afficher ces informations avec le paramètre -silent (ou -quiet ou encore -q) :

gdb program -silent

Une fois que vous avez lancé GDB, vous devez entrer des commandes pour lui indiquer quoi faire. D'ailleurs, GDB ne lance pas l'exécution du programme tant que vous ne le lui indiquez pas. Une ligne de commande GDB commence par le nom de la commande, qui peut être suivi par des paramètres. Si vous validez une ligne blanche, GDB répète la commande précédente. Vous pouvez également utiliser des abréviations au lieu des noms complets des commandes. Vous pouvez également placer des commentaires, ceux-ci commencent par # et se terminent à la fin de la ligne (donc marquent la fin de la commande).

$gdb program -q
(gdb) command params #comment
...

Comme dans un terminal, vous pouvez utiliser l'auto-complétion avec la touche TAB.

Obtenir de l'aide sur une commande

Vous pouvez obtenir des informations sur les commandes grâce à "help" (abr. "h"). Si vous ne précisez pas la commande, GDB affiche les catégories de commandes disponibles. De même, si vous précisez une catégorie de commandes, GDB vous affichera la liste des commandes. Enfin, si vous précisez une commande ou son abréviation, GDB vous affichera les informations la concernant.

$gdb -q
(gdb) help
List of classes of commands:
 
aliases -- Aliases of other commands
breakpoints -- Making program stop at certain points
data -- Examining data
files -- Specifying and examining files
internals -- Maintenance commands
obscure -- Obscure features
running -- Running the program
stack -- Examining the stack
status -- Status inquiries
support -- Support facilities
tracepoints -- Tracing of program execution without stopping the program
user-defined -- User-defined commands
 
Type "help" followed by a class name for a list of commands in that class.
Type "help all" for the list of all commands.
Type "help" followed by command name for full documentation.
Type "apropos word" to search for commands related to "word".
Command name abbreviations are allowed if unambiguous.

Comme indiqué, vous pouvez également utiliser "help all" pour obtenir la liste des toutes les commandes (classées par catégories).

Pour effectuer une recherche dans l'aide, il suffit d'utiliser la commande "apropos" qui prend comme paramètre une chaine à rechercher :

(gdb) apropos exit
q -- Exit gdb
quit -- Exit gdb
set history save -- Set saving of the history record on exit
show history save -- Show saving of the history record on exit

Maintenant que nous avons quelques bases, il est temps de nous lancer dans le véritable travail du débogueur.

Compiler avec les informations de débogage

Pour déboguer un programme, il est nécessaire de pouvoir obtenir certaines informations le concernant, comme le nom et le type des variables, ainsi que les numéros de lignes correspondant aux instructions. Pour pouvoir les obtenir, on doit le préciser lors de la compilation. La plupart du temps, il s'agit de l'option "-g", cependant, vous devriez vérifier dans la documentation de votre compilateur.

GCC et NASM, par exemple, permettent de compiler avec les informations de débogage :

$ g++ -g myprogram.cpp
$ nasm -g myprogram.asm

Lancer l'exécution

Il est temps de passer à la phase qui nous intéresse, l'exécution du programme. Rien de plus simple, il s'agit de la commande "run" (abr. "r"). Vous pouvez lui passer autant de paramètres que vous le souhaitez, ils seront simplement passés comme paramètres au programme exécuté.

(gdb) run args
...
(gdb)

Le programme s'exécute alors normalement, jusqu'à ce qu'il se termine. Dès qu'il a fini de s'exécuter, ou lorsqu'il rencontre une erreur, vous revenez à l'invite de commandes de gdb. Il existe une autre commande pour lancer le programme : "start", qui contrairement à "run", place un point d'arrêt (breakpoint) à l'entrée du programme. Pour un programme réalisé en C par exemple, ce point d'arrêt sera placé à l'endroit du main().
Il est important de noter que le point d'entrée n'est pas toujours la première chose exécutée dans un programme. En C++, les constructeurs d'objets globaux et statiques sont appelés avant le main(), dans une phase dite "d'élaboration". Nous verrons plus tard comment placer des points d'arrêt précis.
Comme pour "run", vous pouvez spécifier les paramètres du programme.

(gdb) start args
...
(gdb)

Contexte d'exécution

Lorsque vous démarrez un programme, il hérite de certaines propriétés : les variables d'environnement, les arguments de ligne de commande, et le dossier courant.
Le dossier courant, c'est le dossier dans lequel vous exécutez le programme. Il est utilisé par exemple lorsque vous ouvrez un fichier sans préciser de chemin, le programme regarde alors dans ce répertoire courant.
Les arguments de ligne de commande, c'est ce que vous ajoutez après le nom de l'exécutable pour le lancer (ex : "$ g++ monfichier.cpp", g++ est le nom de l'exécutable, et "monfichier.cpp" est un argument).
Enfin, les variables d'environnement sont des variables globales, accessibles par tous les programmes. On y retrouve par exemple la variable PATH, qui donne des chemins vers les répertoires où chercher les exécutables (par exemple, lorsque vous lancez "$ g++", le programme gcc se trouve dans un de ces répertoires).

L'ensemble de ces paramètres est appelé le "contexte d'exécution" d'un programme. Et bien entendu, vous pourriez avoir besoin (ou juste une folle envie) de modifier ces paramètres. GDB propose donc des commandes pour y accéder.

(gdb) show args
Affiche la ligne d'arguments actuelle du programme.

(gdb) set args arguments
Règle la ligne d'arguments à "arguments" (vous pouvez aussi passer les arguments comme paramètres à start ou run).

(gdb) show environment [variable]
ou (gdb) show env(gdb) show env [variable]
Affiche les variables d'environnement. Si vous précisez un nom de variable (ex : PATH), seule cette variable est affichée.
Vous pouvez aussi utiliser "(gdb) show paths" pour afficher la variable PATH.

(gdb) set environment variable [=value]
(gdb) set env(gdb) set env variable [=value]
Règle la valeur d'une variable "variable" à "value". Si vous ne donnez pas de valeur, celle-ci sera une chaîne vide.
Vous pouvez aussi utiliser "(gdb) path [newpath]" pour ajouter newpath à la liste des répertoires d'exécutables.

(gdb) unset environment variable
(gdb) unset env(gdb) unset env variable
Supprime la variable d'environnement "variable" (son contenu ne devient même pas une chaine vide, elle est complètement supprimée de la liste).

(gdb) pwd
Affiche le répertoire courant.

(gdb) cd directory
Règle le répertoire courant à "directory".

Les entrées et sorties

Si votre programme utilise les entrées et sorties standards, les opérations d'entrée et de sortie seront effectuées dans le même terminal que GDB. Vous pouvez, pour plus de clarté par exemple, changer le terminal du programme exécuté.

Vous pouvez savoir dans quel terminal vous êtes avec "$ tty". Si vous êtes déjà dans gdb, inutile d'en sortir :

(gdb) show inferior-tty
Affiche le terminal courant utilisé pour le programme exécuté.

(gdb) set inferior-tty terminal
(gdb) tty(gdb) tty terminal
Règle le terminal courant pour l'exécution du programme à "terminal".

Exemple :

TERMINAL /dev/pts/2

(gdb) tty /dev/pts/3
(gdb) run
(gdb)

TERMINAL /dev/pts/3

$ Sorties et entrées du programme exécuté par GDB...

Stopper l'exécution

Vous pouvez décider de stopper l'exécution du programme en cours. Il suffit d'utiliser la commande kill :

(gdb) kill
Kill the program being debugged? (y or n) y
(gdb)

Pour contrôler l'exécution d'un programme, on utilise des points d'arrêt. On donne à GDB une liste d'endroits où il doit faire une pause dans l'exécution. Cela permet par exemple de vérifier l'état d'une variable ou le contenu d'un registre. Comme nous l'avons vu plus tôt, il est possible de placer automatiquement un point d'arrêt au point d'entrée du programme, avec la commande "start". Cependant, si le programme comporte plusieurs milliers de lignes, nous n'allons pas faire tourner tout le programme au "pas à pas" (une instruction à la fois, nous verrons plus tard comment faire), nous allons plutôt placer des points d'arrêt aux endroits qui nous intéressent.

Il y a trois façons de préciser un point d'arrêt :

• indiquer un endroit précis (fonction, ligne, fichier) ;

• lors de la modification d'une variable (ou à sa lecture) ;

• lorsqu'un certain événement se produit (création d'un nouveau processus, chargement d'une librairie, throw ou catch d'une exception, etc.).

Respectivement, ces trois types de points d'arrêt se nomment breakpoints, watchpoints (points de surveillance), et catchpoints (points d'interception).

Lorsque GDB interrompt le programme, il affiche la raison de l'arrêt, la ligne de l'instruction suivante (la prochaine qui sera exécutée) et l'invite de commande :

(gdb) r
Starting program: main
Breakpoint 3, main () at sample1.cpp:9
9           a = a / b;
(gdb)

(gdb) info break [breaknum]
Affiche la liste des points d'arrêt. Si vous précisez un numéro (et non une position), vous ne verrez que les infos qui concernent ce point d'arrêt.

Les breakpoints

GDB s'arrête juste avant l'instruction qui suit le breakpoint. Cela signifie par exemple que si vous demandez à GDB de s'arrêter à la ligne 17, il va s'arrêter juste au début de la ligne, sans l'exécuter.

(gdb) break [position]
Si on ne donne pas de position, GDB s'arrêtera à la prochaine instruction qui sera exécutée. Sinon on peut spécifier l'endroit où le programme sera arrêté :

• en donnant un numéro de ligne (break 123) du fichier courant ;

• en donnant un décalage en lignes par rapport à la prochaine instruction (break +5 #s'arrêter 5 lignes après la prochaine instruction) ;

• en donnant un nom de fichier et un numéro de ligne (break monfichier.cpp:123) ;

• en donnant un nom de fonction (break ma_fonction) ;

• en donnant un nom de fichier et de fonction (break monfichier.cpp:ma_fonction) ;

• en donnant une adresse (break *adresse #adresse peut être un nombre, une variable, une expression...).
  Exemple : "(gdb) break *(0x80F523 + maVariable).

Remarque : en précisant une fonction, plusieurs breakpoints peuvent êtres placés, par exemple avec un programme écrit en C++ où on aurait surchargé la fonction.

(gdb) break [position] if condition
On peut aussi préciser une condition d'arrêt. GDB va alors évaluer (calculer) cette condition juste avant de s'arrêter, pour savoir s'il doit ou non continuer. Exemple :

(gdb) break 123 if a+b < 0

GDB arrêtera alors l'exécution du programme à la ligne 123 seulement si a+b est négatif. La condition est écrite avec la syntaxe du langage utilisé pour le programme.

Parfois, vous ne souhaitez vous arrêter qu'une fois (par exemple, seulement lors du premier appel à une fonction). Il suffit alors d'utiliser "tbreak" à la place de "break", en l'utilisant exactement de la même manière.

(gdb) clear [position]
Supprime le breakpoint correspondant à la position indiquée. Comme précédemment, ne pas indiquer de position suppose qu'il s'agit de l'instruction suivante.

Ajouter un watchpoint

(gdb) watch variable
Indique à GDB de s'arrêter dès que la variable est modifiée. L'instruction qu'il vous affiche correspond donc à celle qui sera exécutée juste après (et non pas à celle qui a modifié la variable, puisqu'elle a déjà été exécutée).
Vous pouvez également utiliser une expression, par exemple "a*b", pour indiquer à GDB de ne s'arrêter que lorsque (a*b) aura été modifié. Mais il faut bien noter que pour surveiller une expression, GDB est obligé de surveiller chaque variable de cette expression et d'évaluer le résultat.

(gdb) rwatch variable
Indique à GDB de s'arrêter dès que la variable est accédée par le programme (r pour "read").

(gdb) awatch variable
Indique à GDB de s'arrêter aussi bien lorsque la variable est modifiée que lorsqu'elle est lue.

Ajouter un catchpoint

Le plus simple est que je vous donne l'aide traduite. Si vous ne savez pas à quoi correspond un événement, c'est que vous n'en avez pas besoin pour l'instant. ^^

Intercepter un signal :
        catch signal              - Tous les signaux
        catch signal <signame>    - Seulement le signal <signame>
Intercepter une exception :
        catch throw               - Toutes les exceptions lorsqu'elles sont lancées (throw...)
        catch throw <exceptname>  - Seulement l'exception <exceptname> lorsqu'elle est lancée (throw...)
        catch catch               - Toutes les exceptions lorsqu'elles sont catchées
        catch catch <exceptname>  - Seulement l'exception <exceptname> lorsqu'elle est catchée
Intercepter les événements de threads :
        catch thread_start        - Lors de la création d'un nouveau thread
        catch thread_exit         - Lors de la fermeture d'un thread
        catch thread_join         - Lors d'un join de threads
Intercepter les événements de processus :
        catch start               - Lors de la création d'un nouveau procesus
        catch exit                - Lors de la fermeture d'un processus
        catch fork                - Lors d'un appel à fork()
        catch vfork               - Lors d'un appel à vfork()
        catch exec                - Lors d'un appel à exec()
Intercepter les chargements/déchargements de librairies dynamiques :
        catch load                - Lors du chargement de n'importe quelle librairie
        catch load <libname>      - Lors du chargement de la librairie <libname>
        catch unload              - Lors du déchargement de n'importe quelle librairie
        catch unload <libname>    - Lors du déchargement de la librairie <libname>

Tout comme pour break, on peut vouloir placer un catchpoint qui n'aura effet qu'une seule fois. Il suffit d'utiliser "tcatch" au lieu de "catch".

Supprimer un point d'arrêt

Dans les commandes suivantes, si [breaknum] n'est pas spécifié, cela signifie "tous les points d'arrêt".

(gdb) delete [breaknum]
Supprime le point d'arrêt numéro "breaknum".

(gdb) disable [breaknum]
Désactive un point d'arrêt, mais ne le supprime pas (GDB ne s'arrêtera pas, mais vous pourrez toujours le réactiver par la suite).

(gdb) enable [breaknum]
Active un point d'arrêt.

(gdb) enable [breaknum] once
Active un point d'arrêt pour un seul passage. Dès qu'il est atteint une fois, il est désactivé automatiquement.

(gdb) enable [breaknum] delete
Active un point d'arrêt pour un seul passage. Dès qu'il est atteint une fois, il est automatiquement supprimé.

Continuer l'exécution

Lorsque le programme est interrompu, GDB vous passe l'invite de commande. Vous pouvez y entrer toutes les commandes que vous souhaitez. Une fois que vous souhaitez continuer l'exécution du programme, il suffit d'entrer la commande "continue" (abr. "c").

Vous pouvez également utiliser le mode "pas à pas" (step-by-step en anglais). Il y a plusieurs façons de faire, dont les plus utiles sont :

(gdb) step [count]
Exécute les [count] prochaines lignes de code. Si count n'est pas spécifié, il vaut 1. Si l'instruction est un appel de fonction, step va passer à l'intérieur de cette fonction. Attention cependant, step ne peut aller que dans les fichiers qui ont des informations de débogage (il a besoin des numéros de ligne).

(gdb) next [count]
Comme "step", exécute les [count] prochaines lignes de code. La différence étant que si l'instruction est un appel de fonction, next ne s'arrêtera pas à l'intérieur de celle-ci, mais bien à la ligne suivant l'appel de la fonction.

(gdb) until
Exécute toutes les instructions jusqu'à ce que le programme arrive à une ligne qui suit la ligne actuelle. C'est utile dans le cas de boucles. Par exemple, la boucle suivante en C++ :

for (int i=0;i<1000;++i)
    cout << i;

Avec step ou next, GDB va s'arrêter 1000 fois sur ces deux lignes (en fait, 1001 fois pour la première, la 1001e fois la seconde n'est plus exécutée car i est alors égal à 1000 , et 1000 /< 1000 ^^ ).
Avec until, GDB ne va s'y arrêter que la première fois, puis il s'arrêtera seulement à la prochaine ligne.

Avec tout ce que nous venons de voir, vous êtes capables de lancer et d'arrêter l'exécution d'un programme. Mais cela suffit rarement à trouver la cause d'un plantage. Maintenant, lorsque le programme plante, on aimerait connaître l'état de certaines variables, pouvoir les modifier, ou encore savoir exactement à quel moment le programme a planté.

Examiner des variables

Rien plus simple, il suffit d'utiliser la commande "print" (abr. "p") en précisant le nom de la variable. Attention, il faut que la variable existe au moment où vous demandez l'affichage. Petit exemple :

void myfunc();
 
int main(){
    char msg[] = "Hello World!";
    myfunc();
    return 0;
}
 
void myfunc(){
    int boo = 16;
}

(gdb) break 5
(gdb) r
Starting program: main
 
Breakpoint 1, main () at sample1.cpp:5
5           myfunc();
(gdb)print msg
$1 = "Hello World!"
(gdb) print boo
No symbol "boo" in current context.

Si l'on souhaite accéder à une variable qui n'est pas dans la portée actuelle, on doit le préciser avec "::". Cependant, les variables hors de la portée courante sont rarement définies, elle ne le seront en fait que lorsque le programme sera dans ce bloc. À quoi peut bien servir de vouloir y accéder alors ? Eh bien voyons encore un petit exemple en utilisant le même code que précédemment :

(gdb) break 10
(gdb) r
Starting program: main
 
Breakpoint 1, main () at sample1.cpp:10
10          int boo = 16;
(gdb) print msg
No symbol "msg" in current context.
(gdb) print main::msg
$2 = "Hello World!"

Eh oui, puisque l'appel de myfunc se fait à l'intérieur du main(), on se trouve toujours à l'intérieur du main et on peut donc accéder à la variable msg.

Chaque fois que vous affichez quelque chose, GDB le garde dans l'historique pour que vous puissiez y accéder par la suite. C'est pour cette raison que vous voyez des "$1 = ...", $1 signifie qu'il s'agit de la première valeur que vous affichez. "print $1" permet d'ailleurs d'afficher $1 (mais crée du coup une nouvelle entrée dans l'historique). Vous pouvez également afficher l'historique sans passer par ces variables propres à GDB :

(gdb) show values n
Affiche dix valeurs de l'historique, en partant de (n-5) et en allant jusqu'à (n+4).

GDB tente toujours de déterminer le meilleur moyen d'afficher une valeur. Mais il est tout à fait possible de choisir le format, en utilisant :

(gdb) print /format expr
Affiche "expr" en utilisant le format spécifié. L'espace avant le "/" est obsolète (car une commande ne pouvant pas contenir de slash, GDB s'arrête de toute manière juste avant), mais il ne doit pas y en avoir après. Les formats sont les suivants :

• x : entier affiché en hexadécimal ;

• d : entier signé ;

• u : entier non-signé ;

• o : entier affiché en octal ;

• t : entier affiché en binaire ;

• a : adresse ;

• c : caractère ;

• f : nombre à virgule flottante (float).

(gdb) p/x 1234
$1 = 0x4d2
(gdb) p/d -1234
$2 = -1234
(gdb) p/u -1234
$3 = 4294966062
(gdb) p/o 1234
$4 = 02322
(gdb) p/t 1234
$5 = 10011010010
(gdb) p/a 1234
$6 = 0x4d2
(gdb) p/c 76
$7 = 76 'L'
(gdb) p/f 1234
$8 = 1.7292023e-42

On peut forcer GDB à afficher un vecteur, en utilisant "@" :

(gdb) print [/format] *adresse@taille
Affiche un tableau de taille et d'adresse de départ spécifiées. Chaque élément du tableau est affiché dans le format choisi.

(gdb) p/c *msg@5
$1 = {72 'H', 101 'e', 108 'l', 108 'l', 111 'o'}

Enfin, signalons également qu'on peut en fait afficher presque n'importe quelle expression évaluable dans le langage courant :

(gdb) print msg[3]+msg[4]+1
$1 = 220
(gdb) print myfunc()
$2 = void
(gdb) print myfunc
$3 = {void (void)} 0x8048574 <myfunc()>

Examiner la mémoire et les registres

GDB permet de définir des variables (hors du programme, qui ne seront disponibles que depuis les commandes de GDB). Quand nous avons parlé des valeurs placées dans l'historique, eh bien en réalité chaque valeur $1, $2... est une nouvelle variable créée par GDB, c'est pourquoi on peut les afficher avec print. Mais il existe aussi d'autres variables spéciales : les registres. Ces variables, qui portent le nom des registres du processeur (et du coprocesseur) permettent d'accéder aux registres. Par exemple, le registre EAX est accessible via $eax. On peut également voir les informations de tous les registres avec "info".

Note : la valeur des registres est celle qu'ils contiennent au point d'exécution du programme où vous vous trouvez.

(gdb) info all-registers
Affiche la liste complète des registres.

(gdb) info registers
Affiche la liste des registres principaux.

On peut également afficher une zone de la mémoire, à condition bien sûr que le programme exécuté y ait accès.

(gdb) examine [/tfu] adresse
(gdb) x [/tfu](gdb) x [/tfu] adresse
Affiche le contenu de la mémoire à partir de l'adresse spécifiée. Vous pouvez utiliser des expressions, par exemple un nom de fonction, une adresse contenue dans une variable, etc. Vous pouvez également préciser la taille de la zone à afficher (en octets), le format d'affichage (avec un des formats vu plus haut¹) et la taille d'une unité (b = 1 octet, h = 2 octets, w = 4 octets, g = 8 octets). Vous n'êtes pas obligés de préciser les trois options. ;)

¹ : en plus des formats déjà vus, vous pouvez utiliser "i" pour afficher l'instruction en assembleur correspondant à la valeur en mémoire.

Exemples :

(gdb) x /10xb main #Affiche les 10 (10) octets (b) à l'adresse de main en hexadécimal (x)
(gdb) x /3dw 0x123456 #Affiche les 3 (3) mots de 4 octets (w) à l'adresse 0x123456 comme des entiers signés (d)
(gdb) x /10i main #Affiche les 10 instructions assembleur à partir de l'adresse main

Modifier une variable ou un registre

On peut vouloir modifier le contenu d'une variable ou même d'un registre durant l'exécution. Par exemple si on se rend compte qu'on divise par 0 mais qu'on souhaite continuer l'exécution, on peut modifier la valeur d'une variable lorsqu'on arrive à l'endroit qui pose problème.

(gdb) set $variable = value
Permet de modifier la valeur contenue dans une variable GDB, il s'agit par exemple d'un registre (ex : "(gdb) set $eax = 5" pour mettre EAX à 0).
Si la variable n'existe pas, elle est créée.

(gdb) set variable variable = value
(gdb) set var (gdb) set var variable = value
Permet de modifier le contenu d'une variable du programme. Vous ne pouvez pas en créer de nouvelle, et vous ne pouvez pas non plus modifier la taille d'une variable, donc faites attention à ne pas placer n'importe quoi dedans. ^^

Il n'est pas toujours évident de savoir à quel moment un programme plante. Par exemple, si l'erreur se trouve dans une fonction (recevant par exemple des paramètres erronés), qui est appelée de différents endroits, on voudrait savoir qui l'a appelée. GDB fournit donc plusieurs commandes permettant de se repérer dans l'exécution du programme.

Mais avant de voir ces commandes, un peu de théorie s'impose. Lorsque dans un programme vous appelez une fonction, l'ordinateur doit "sauter" à l'adresse de cette fonction pour en exécuter les instructions. Mais il est nécessaire, pour pouvoir faire cet appel correctement, de sauvegarder des informations. Par exemple, l'ordinateur doit savoir à quel endroit il doit revenir une fois qu'il termine l'exécution de la fonction. Il faut donc, au minimum, sauvegarder cette adresse avant de faire le saut. Il faut aussi passer les arguments à la fonction, ce qui se fait en général en utilisant une pile (une zone mémoire où on va ajouter et retirer des informations, allez voir sur Wikipédia si vous voulez plus de détails, ça peut être très intéressant). Et il se peut même que dans une fonction, on en appelle d'autres. Il faut donc, à chaque appel, sauvegarder certaines valeurs (en général des registres). Chaque fonction a donc ce qu'on appelle une "frame" (abr. "f"), qui correspond à un ensemble d'informations la concernant.

(gdb) frame [frameid]
Si vous ne précisez pas de frameid, affiche les informations sur la frame courante. Sinon, se place dans la frame indiquée et en affiche les informations.
Remarque : changer de frame ne perturbe pas l'exécution du programme. En fait, le programme se trouve toujours au même point d'exécution, c'est GDB qui se "place" dans la frame indiquée. Les commandes que vous entrerez auront alors effet sur la frame sélectionnée (par exemple si vous faites un print, les variables "locales" seront celles de la frame courante, et pour les autres vous devrez spécifier la frame comme nous l'avions vu avec "::").

(gdb) select-frame frameid
Se place dans la frame indiquée.

(gdb) up [n]
Remonte de n frames (ou de 1 si n n'est pas spécifié).

(gdb) down [n]
Descend de n frames (ou de 1 si n n'est pas spécifié).

(gdb) info frame
Affiche des informations détaillées sur la frame courante. On y trouve par exemple les registres qui ont été sauvegardés, l'adresse de la frame précédente, etc.

Backtrace : le stack de frames

Obtenir des informations sur une frame est utile, mais le plus souvent ce qui nous intéresse c'est de voir le stack (la pile) des frames, pour savoir par où le programme est passé pour arriver à l'endroit d'exécution où il se trouve. Il existe pour ce faire une commande toute simple, "backtrace" (abr. "bt"). Prenons le code C++ suivant :

#include <iostream>
using namespace std;
 
void myfunc(int i);
 
int main(){
    char msg[] = "Hello World!";
    myfunc(2);
    return 0;
}
 
void myfunc(int i){
    int boo = 16;
    if (i > 0) myfunc(i-1);
}

(gdb) backtrace
Affiche le stack d'appel (liste des frames).

Voici une petite session GDB, j'ai effacé les lignes inutiles pour clarifier :

(gdb) break myfunc
(gdb) run
Breakpoint 1, myfunc (i=2) at sample1.cpp:13
(gdb) bt
#0  myfunc (i=2) at sample1.cpp:13
#1  0x080485e2 in main () at sample1.cpp:8
(gdb) continue
Breakpoint 1, myfunc (i=1) at sample1.cpp:13
(gdb) bt
#0  myfunc (i=1) at sample1.cpp:13
#1  0x08048595 in myfunc (i=2) at sample1.cpp:14
#2  0x080485e2 in main () at sample1.cpp:8
(gdb) continue
Breakpoint 1, myfunc (i=0) at sample1.cpp:13
(gdb) bt
#0  myfunc (i=0) at sample1.cpp:13
#1  0x08048595 in myfunc (i=1) at sample1.cpp:14
#2  0x08048595 in myfunc (i=2) at sample1.cpp:14
#3  0x080485e2 in main () at sample1.cpp:8

On voit rapidement que backtrace part de la frame courante, et remonte jusqu'à la frame la plus éloignée (ici le main). On peut voir pour chaque frame son numéro (#...), l'adresse où elle commence (là où se trouve le code en mémoire), suivie du nom de la fonction et des paramètres passés, ainsi que du fichier et de la ligne où elle se trouve. Si vous souhaitez également afficher les informations sur les variables locales de chaque frame, vous pouvez utiliser l'option "full" :

(gdb) backtrace full
Affiche le stack d'appel (liste des frames) avec, pour chaque frame, le contenu des variables locales.

Changer le point d'exécution

Il existe certaines commandes qui modifient le déroulement du programme :

(gdb) jump position
Continue l'exécution à l'endroit spécifié. Comme pour les points d'arrêt, la position peut être indiquée :

• en donnant un numéro de ligne ;

• en donnant un décalage en lignes par rapport à la prochaine instruction ;

• en donnant un nom de fichier et un numéro de ligne ;

• en donnant un nom de fonction ;

• en donnant un nom de fichier et de fonction ;

• en donnant une adresse.

Attention à ce que vous faites, car si vous passez d'une fonction à une autre, n'oubliez pas qu'il faudra peut-être régler vous même les paramètres (avec set var).

(gdb) return [value]
Exécute l'instruction de retour de la fonction dans laquelle vous vous trouvez. Vous pouvez préciser la valeur de retour.
Par exemple, si vous interrompez l'exécution dans la fonction myfunc(), vous pouvez utiliser return, ce qui quittera la fonction.

(gdb) call expression
Call est identique à print, sauf qu'il n'affiche le résultat que s'il est différent de void. En fait, avec print comme avec call, vous pouvez appeler des fonctions :

(gdb) print myfunc(5)
$1 = void
(gdb) call myfunc(5)
(gdb)

Avec tout ce que nous avons vu, nous pouvons maintenant facilement déboguer nos programmes. Voici un petit exemple assez simple.

#include <stdio.h>
 
int main(){
    char * Buffer;
    printf("Nom? ");
    scanf("%s", Buffer);
    return 0;
}

Bien entendu c'est un programme ridicule, et l'erreur est évidente, mais comme le but est juste de montrer le fonctionnement de GDB, nous nous en contenterons. Compilons :

$ g++ -Wall -Wextra -pedantic -ansi -g -o main sample1.cpp

Aucune erreur de compilation, même avec les options de compilation strictes (logique, syntaxiquement tout est correct). Mais lorsqu'on lance le programme, on obtient une segmentation fault dès qu'on entre quelque chose au clavier. Utilisons GDB :

$ gdb main
(gdb) run
Starting program: /home/dhkold/Documents/code/gdb/main
Nom? DHKold
 
Program received signal SIGSEGV, Segmentation fault.
0xb7d70dae in _IO_vfscanf () from /lib/tls/i686/cmov/libc.so.6

Voyons maintenant où nous nous trouvons :

(gdb) bt
#0  0xb7d70dae in _IO_vfscanf () from /lib/tls/i686/cmov/libc.so.6
#1  0xb7d784cb in scanf () from /lib/tls/i686/cmov/libc.so.6
#2  0x080484b4 in main () at sample1.cpp:7

L'erreur vient donc de l'appel à scanf fait depuis la ligne 7. Et en effet, Buffer n'est pas alloué et pointe sur n'importe quoi. On peut simplement recompiler après avoir corrigé, mais on peut aussi vérifier que l'erreur vient bien de là :

(gdb) start
Breakpoint 1 at 0x8048495: file sample1.cpp, line 6.
Starting program: /home/dhkold/Documents/code/gdb/main
main () at sample1.cpp:6
6           printf("Nom? ");
(gdb) set var Buffer = malloc(50)
(gdb) print Buffer
$1 = 0x804a008 ""
(gdb) c
Continuing.
Nom? DHKold
 
Program exited normally.

Et voilà, c'est donc bien Buffer qui pose problème, et il suffit de l'allouer pour ne plus avoir d'erreur. J'espère que ce tout petit exemple vous a permis de voir comment utiliser les commandes GDB que nous avons étudiées durant ce tutoriel. N'hésitez pas à aller lire la documentation sur le site de GDB, elle est en anglais et n'est pas toujours très claire, mais si vous connaissez déjà les bases vous devriez pouvoir vous y retrouver.

Voilà qui est fait, vous devriez maintenant être capables de vous servir de GDB correctement.