perldebug - Débogage de Perl
Tout d'abord, avez-vous essayé d'utiliser l'option -w ?
Si vous invoquez Perl avec l'option -d, votre script tournera dans le débogueur de sources Perl. Il fonctionne comme un environnement Perl interactif, demandant des commandes de débogage qui vous laissent examiner le code source, placer des points d'arrêt, obtenir des traces des états passés de la pile, changer les valeurs des variables, etc. C'est si pratique que vous lancez souvent le débogueur tout seul juste pour tester interactivement des constructions en Perl afin de voir ce qu'elles font. Par exemple :
$ perl -d -e 42
En Perl, le débogueur n'est pas un programme séparé à la façon dont c'est habituellement le cas dans l'environnement compilé typique. À la place, l'option -d dit au compilateur d'insérer des informations sur le source dans les arbres d'analyse qu'il va donner à l'interpréteur. Cela signfie que votre code doit d'abord se compiler correctement pour que le débogueur travaille dessus. Puis lorsque l'interpréteur démarre, il précharge une bibliothèque Perl spéciale contenant le débogueur lui-même.
Le programme s'arrêtera juste avant la première instruction de son exécution (mais voyez plus bas en ce qui concerne les instructions pendant la compilation) et vous demandera d'entrer une commande de débogage. Contrairement à ce qu'on pourrait attendre, lorsque le débogueur d'arrête et vous montre une ligne de code, il affiche toujours la ligne qu'il est sur le point d'exécuter, plutôt que celle qu'il vient juste d'exécuter.
Toute commande non reconnue par le débogueur est directement executée
evaluée) comme du code Perl dans le paquetage courant (Le débogueur
utilise le paquetage DB pour gérer les informations sur son propre
état).
Tout espace blanc précédant ou suivant un texte entré au prompt du
débogueur est d'abord supprimé avant tout autre traitement. Si une
commande de débogage coïncide avec une fonction de votre propre
programme, faites précéder simplement la fonction par quelque chose
qui n'a pas l'air d'une commande de débogage, tel qu'un ;, ou
peut-être un +, ou en l'encadrant avec des parenthèses ou des
accolades.
Le débogueur comprend les commandes suivantes :
Si vous fournissez une autre commande de débogage comme argument de la
commande h, elle affichera uniquement la description de cette
commande. L'argument spécial h h produira un listage d'aide plus
compact, conçu pour tenir en un seul écran.
Si la sortie de la commande h (ou de toute commande, en fait) est
plus longue que votre écran, faites-la précéder d'un symbole de tube
pour qu'elle soit affichée page par page, comme dans
DB> |h
Vous pouvez changer le programme de pagination utilisé via la commande
O pager=....
print {$DB::OUT} expr dans le paquetage courant. Cela
signifie en particulier que, puisque c'est simplement la propre
fonction print de Perl, les structures de données imbriquées et les
objets ne sont pas affichés, contrairement à ce qui se passe avec la
commande x.
Le handle de fichier DB::OUT est ouvert vers /dev/tty, quelle
que soit la redirection possible de STDOUT.
print. Voir Dumpvalue si vous aimeriez faire cela
vous-même.
Le format de sortie est gouverné par de multiples options décrites sous Options.
main) en utilisant un joli afficheur de données (les
hachages montrent leurs couples clé-valeur de façon que vous voyiez
qui correspond à qui, les caractères de contrôles sont rendus
affichables, etc.). Assuez-vous de ne pas placer là de spécificateur
de type (comme $), mais juste les noms de symboles, comme ceci :
V DB filename line
Utilisez ~pattern et !pattern pour avoir des expressions
rationnelles positives et négatives.
Ceci est similaire au fait d'appeler la commande x pour chaque
variable applicable.
V currentpackage [vars].
PrintRet est mise (valeur par défaut).
n ou s.
incr+1 lignes en commençant à min.
min à max. l - est synonyme de -.
eval. Si filename n'est pas un chemin complet tel
que trouvé dans les valeurs de %INC, il est considéré être une
expression rationnelle.
Ooption AutoTrace).
b 237 $x > 30
b 237 ++$count237 < 11
b 33 /pattern/i
1. vérifie la présence d'un point d'arrêt sur cette ligne 2. affiche la ligne si nécessaire (trace) 3. effectue toutes les actions associées à cette ligne 4. interroge l'utilisateur en cas de point d'arrêt ou de pas à pas 5. évalue la ligne
Par exemple, ceci affichera $foo chaque fois que la ligne 53 sera passée :
a 53 print "DB FOUND $foo\n"
1.
O +pager="less -MQeicsNfr" pour appeler less avec
ces options spécifiques. Vous pouvez utiliser des apostrophes ou des
guillemets, mais si vous le faites, vous devez protéger toutes les
occurrences d'apostrophes ou de guillemets (respectivement) dans la
valeur, ainsi que les échappements les précédant immédiatement mais ne
devant pas les protéger. En d'autres termes, vous suivez les règles de
guillemettage indépendamment du symbole ; e.g. : O option='this
isn\'t bad' or O option="She said, \"Isn't it?\"".
Pour des raisons historiques, le =value est optionnel, mais a pour
valeur par défaut 1 uniquement lorsque cette valeur est sûre --
c'est-à-dre principalement pour les options booléennes. Il vaut
toujours mieux affecter une valeur spécifique en utilisant
=. L'option peut être abrégé, mais ne devrait probablement pas
l'être par souci de clarté. Plusieurs options peuvent être définies
ensemble. Voir Options pour en trouver une liste.
command est absent, toutes les actions
sont effacées !
command est absent, toutes les actions sont
effacées !
command est
absent, toutes les actions sont effacées !
Puisque cette commande est en quelque sorte nouvelle, un avertissement
est généré s'il apparaît que vous avez accidentellement entré un
bloc. Si c'est ce que vous vouliez faire, écrivez-le sous la forme
;{ ... } ou même do { ... }.
O recallCommand.
O shellBang. Notez que le shell courant de
l'utilisateur (en fait, sa variable $ENV{SHELL}) sera utilisé, ce
qui peut interférer avec une interprétation correxte du statut ou du
signal de sortie et les informations de coredump.
exit deux fois peut fonctionner.
Placez l'option inhibit_exit à 0 si vous voulez être en mesure de
sauter jusqu'à la fin du script. Vous pouvez aussi avoir besoin de
placer $finished à 0 si vous voulez avancer pas à pas dans la
destruction globale.
exec()utant une nouvelle session. Nous
essayons de maintenir votre historique en cours de route, mais
certains réglages internes et les options de la ligne de commande
peuvent être perdus.
Les réglages suivants sont actuellement préservés : l'historique, les points d'arrêt, les actions, les options du débogueur, et les options de ligne de commande de Perl -w, -I, and -e.
|dbcmd mais un select temporaire de DB::OUT est
réalisé.
= quit q
ou liste les alias définis.
Config sont
utilisées pour invoquer man via le MANPATH correct ou l'option
-M manpath. Les recherches ratées de la forme XXX
correspondant à des pages de manuel connues de la forme perlXXX
seront réessayées. Ceci vous permet de taper man debug ou man op
depuis le débogueur.
Sur les systèmes tarditionnellement privés d'une commande man utilisable, le débogueur invoque perldoc. Cette détermination est occasionnellement incorrecte à cause de vendeurs récalcitrants ou, de façon plus fort à propos, du fait d'utilisateurs entreprenants. Si vous tombez dans une de ces catégories, fixez simplement manuellement la variable $DB::doccmd pour qu'elle pointe vers le visualisateur permettant de lire la documentation Perl sur votre système. Ceci peut être placé dans un fichier rc, ou défini via une affectation directe. Nous attendons toujours un exemple fonctionnel de quelque chose ressemblant à :
$DB::doccmd = 'netscape -remote http://something.here/';
Le débogueur a de nombreuses options définissables via la commande
O, soit de façon interactive, soit via l'environnement ou un
fichier rc.
recallCommand, ShellBang!, ce
qui est malheureux.
pager|). Par défaut, $ENV{PAGER} sera utilisé. Puisque le
debogueur utilise les caractéristiques de votre terminal courant pour
les caractères gras et le soulignement, si le pager choisi ne transmet
pas sans changements les séquences d'échappement, la sortie de
certaines commandes du débogueur ne seront plus lisible après qu'elles
aient traversé le pager.
tkRunningsignalLevel, warnLevel, dieLevelPour désactiver ce mode sûr par défaut, placez ces valeurs à quelque
chose supérieur à 0. À un niveau de 1, vous obtenez une trace pour
tous les types d'avertissements (c'est souvent gênant) et toutes les
exceptions (c'est souvent pratique). Malheureusement, le débogueur ne
peut pas discerner les exceptions fatales et non-fatales. Si
dieLevel vaut 1, alors vos exceptions non-fatales sont aussi
tracées et altérées sans cérémonie si elle proviennent de chaînes
evaluées ou de tout type d'eval à l'intérieur des modules que
vous essayez de charger. Si dieLevel est à 2, le débogueur ne se
soucie pas de leur provenance : il usurpe vos handlers d'exceptions et
affiche une trace, puis modifie toutes les exceptions avec ses propres
embellissements. Ceci peut être utile pour certaines traces
particulières, mais tend à désespérément détruire tout programme qui
prend au sérieux sa gestion des exceptions.
AutoTracet, mais pouvant être mise
dans PERLDB_OPTS).
LineInfo|visual_perl_db), alors un court
message est utilisé. C'est le mécanisme mis en oeuvre pour interagir
avec un éditeur esclave ou un débogueur visuel, comme les hooks
spéciaux de vi ou d'emacs, ou le débogueur graphique ddd.
inhibit_exitPrintRetr s'il est mis (par
défaut).
ornamentsframeframe & 2 est faux, les messages sont affichés
uniquement lors de l'entrée (L'affichage à la sortie peut être utile
si les messages sont entrecroisés).
Si frame & 4 est faux, les arguments des fonctions sont affichés en
plus du contexte et des infos sur l'appelant. Si frame & 8 est
faux, les FETCH surchargés chaînifiés (stringify) et liés
(tie, NDT) sont autorisés sur les arguments affichés. Si frame & 16
est faux, la valeur de retour du sous-programme est affichée.
La longueur à partir de laquelle la liste d'arguments est tronquée est régie par l'option suivante :
maxTraceLenframe est mis.
Les options suivantes affectent ce qui se produit avec les commandes
V, X, et x :
arrayDepth, hashDepthcompactDump, veryCompactcompactDump est utilisé, les tableaux courts peuvent être affichés
sur une seule ligne.
globPrintDumpDBFilesDumpPackagesDumpReusedquote, HighBit, undefPrintquote est auto ; on peut permettre le vidage soit entre
guillemets, soit entre apostrophes en la fixant à " ou '
respectivement. Par défaut, les caractères dont le bit de poids fort
est mis sont affichés tels quels.
UsageOnlyPendant le démarrage, les options sont initialisées à partir de
$ENV{PERLDB_OPTS}. Vous pouvez y placer les options
d'initialisation TTY, noTTY, ReadLine, et NonStop.
Si votre fichier rc contient :
parse_options("NonStop=1 LineInfo=db.out AutoTrace");
alors votre script s'exécutera sans intervention humaine, plaçant les
informations de trace dans le fichier db.out (Si vous
l'interrompez, vous avez intérêt à réinitialiser LineInfo sur
/dev/tty si vous voulez voir quelque chose).
TTYnoTTYNonStop, sans se
connecter à un TTY. En cas d'interruption (ou si le contrôle passe au
débogueur via un réglage explicite de $DB::signal ou de $DB::single
par le script Perl), il se connecte au TTY spécifié par l'option
TTY au démarrage, ou à un TTY trouvé lors de l'exécution en
utilisant le module Term::Rendezvous de votre choix.
Ce module doit implémenter une méthode appelée new qui retourne un
objet contenant deux méthodes : IN et OUT. Celles-ci devraient
retourner deux handles de fichiers à utiliser pour déboguer les
entrées et sorties, respectivement. La méthode new devrait
inspecter un argument contenant la valeur de $ENV{PERLDB_NOTTY} au
démarrage, ou de "/tmp/perldbtty$$" autrement. Ce fichier n'est pas
inspecté du point de vue de la correction de son appartenance, des
risques de sécurité sont donc théoriquement possibles.
ReadLineNonStopVoici un exemple de l'utilisation de la variable $ENV{PERLDB_OPTS} :
$ PERLDB_OPTS="NonStop frame=2" perl -d myprogram
Ceci exécutera le script myprogram sans intervention humaine,
affichant l'arbre des appels avec leurs points d'entrée et de
sortie. Notez que NonStop=1 frame=2 est équivalent à N
f=2, et qu'à l'origine, les options ne pouvait être abrégées que par
leur première lettre (modulo les options Dump*). Il est néanmoins
recommandé que vous les énonciez toujours complètement dans un souci
de lisibilité et de compatibilité future.
D'autres examples incluent
$ PERLDB_OPTS="NonStop frame=2" perl -d myprogram
qui exécute le script de façon non interactive, affichant les infos à
chaque entrée dans un sous-programme et pour chaque ligne exécutée du
fichier appelé listing (Si vous l'interrompez, vous feriez mieux de
réinitialiser LineInfo vers quelque chose d'``interactif'' !).
D'autres exemples incluent (en utilisant la syntaxe standard du shell pour montrer les valeurs des variable d'environnement) :
$ ( PERLDB_OPTS="NonStop frame=1 AutoTrace LineInfo=tperl.out"
perl -d myprogram )
qui peut être utile pour déboguer un programme qui utilise lui-même
Term::ReadLine. N'oubliez pas de détacher le shell du TTY dans la
fenêtre qui correcpond à /dev/ttyXX, en entrant une commande comme,
disons
$ sleep 1000000
Voir Debugger Internals dans la page de manuel perldebguts pour plus de détails.
DB<8>
ou même
DB<<17>>
où ce nombre est le numéro de la commande, que vous utiliseriez pour y
accéder avec le mécanisme intégré d'historique à la mode de
csh. Par exemple, !17 répéterait la commande numéro 17. La
profondeur des signes inférieur à et supérieur à indique la profondeur
d'imbrication du débogueur. Vous pouvez obtenir plus d'un ensemble de
signes d'inégalité, par exemple, si vous êtes déjà sur un point
d'arrêt et que vous affichez le résultat d'un appel de fonction qui
lui-même contient un point d'arrêt, ou si vous sautez dans une
expression via la commande s/n/t expression.
DB<1> for (1..4) { \
cont: print "ok\n"; \
cont: }
ok
ok
ok
ok
Notez que cette affaire de protection d'une fin de ligne est spécifique aux commandes interactives tapées dans le débogueur.
T :
$ = main::infested called from file `Ambulation.pm' line 10
@ = Ambulation::legs(1, 2, 3, 4) called from file `camel_flea' line 7
$ = main::pests('bactrian', 4) called from file `camel_flea' line 4
Le caractère à gauche ci-dessus indique le contexte dans lequel la
fonction a été appelée, avec $ et @ désignant les contextes
scalaires et de liste respectivement, et . un contexte vide (qui
est en fait une sorte de contexte scalaire). L'affichage ci-dessus
signifie que vous étiez dans la fonction main::infested lorsque
vous avez effectué le vidage de la pile, et qu'elle a été appelée dans
un contexte scalaire à la ligne 10 du fichier Ambulation.pm, mais
sans aucun argument, ce qui indique qu'elle a été appelée en tant que
&infested. La ligne suivante de la pile montre que la fonction
Ambulation::legs a été appelée dans un contexte de liste depuis le
fichier camel_flea, avec quatre arguments. La dernière ligne montre
que main::pests a été appelée dans un contexte scalaire, elle aussi
depuis camel_flea, mais à la ligne 4.
Si vous exécutez la commande T depuis l'intérieur d'une instruction
use active, la trace contiendra à la fois une ligne pour require
et une ligne pour eval.
l peut produire :
DB<<13>> l
101: @i{@i} = ();
102:b @isa{@i,$pack} = ()
103 if(exists $i{$prevpack} || exists $isa{$pack});
104 }
105
106 next
107==> if(exists $isa{$pack});
108
109:a if ($extra-- > 0) {
110: %isa = ($pack,1);
Les lignes sur lesquelles on peut placer un point d'arrêt sont
indiquées avec :. Les lignes ayant un point d'arrêt sont indiquées
par b et celles ayant une actions par a. La ligne sur le point
d'être exécutée est indiquée par =>.
frame est utilisée, le débogueur affiche les
entrées dans les sous-programmes (et optionnellement les sorties) dans
des styles différents. Voir la page de manuel perldebguts pour des exemples
incroyablement longs de tout ceci.
Si vous avez des instructions exécutables lors de la compilation
(comme du code contenu dans un bloc BEGIN ou CHECK ou une instruction
use), elles ne seront pas stoppées par le débogueur, bien que
les requires et les blocs INIT le soient, et les instructions de
compilation peuvent être tracées avec l'option AutoTrace mise dans
PERLDB_OPTS. Depuis votre propre code Perl, toutefois, vous pouvez
transférer de nouveau le contrôle au débogueur en utilisant
l'instruction suivante, qui est inoffensive si le débogueur n'est pas
actif :
$DB::single = 1;
Si vous fixez $DB::single à 2, cela équivaut à avoir juste tapé la
commande n, tandis qu'une valeur de 1 représente la commande
s. La variable $DB::trace devrait être mise à 1 pour simuler le
fait d'avoir tapée la commande t.
Une autre façon de déboguer le code exécutable lors de la compilation est de démarrer le débogueur, de placer un point d'arrêt sur le load d'un module :
DB<7> b load f:/perllib/lib/Carp.pm
Will stop on load of `f:/perllib/lib/Carp.pm'.
puis de redémarrer le débogueur en utilisant la commande R (si
possible). On peut utiliser b compile subname pour obtenir la même
chose.
Le débogueur contient probablement suffisamment de hooks de
configuration pour que vous n'ayez jamais à le modifier
vous-même. Vous pouvez changer le comportement du débogueur depuis le
débogueur lui-même, en utilisant sa commande O, depuis la ligne de
commande via la variable d'environnement PERLDB_OPTS, et par des
fichiers de personnalisation.
Vous pouvez réaliser une certaine personnalisation en installant un fichier .perldb contenant du code d'initialisation. Par exemple, vous pourriez créer des alias ainsi (le dernier en est un que tout le monde s'attend à y voir) :
$DB::alias{'len'} = 's/^len(.*)/p length($1)/';
$DB::alias{'stop'} = 's/^stop (at|in)/b/';
$DB::alias{'ps'} = 's/^ps\b/p scalar /';
$DB::alias{'quit'} = 's/^quit(\s*)/exit/';
Vous pouvez changer les options de .perldb en utilisant des appels comme celui-ci :
parse_options("NonStop=1 LineInfo=db.out AutoTrace=1 frame=2");
Le code est exécuté dans le paquetage DB. Notez que .perldb est
traité avant PERLDB_OPTS. Si .perldb définit le sous-programme
afterinit, cette fonction est appelée après que l'initialisation du
débogueur soit terminée. .perldb peut être contenu dans le
répertoire courant, ou dans le répertoire home. Puisque ce fichier est
utilisé par Perl et peut contenir des commandes arbitraires, pour des
raisons de sécurité, il doit être la propriété du superutilisateur ou
de l'utilisateur courant, et modifiable par personne d'autre que son
propriétaire.
Si vous voulez modifier le débogueur, copiez et renommez perl5db.pl
dans la bibliothèque Perl et bidouillez-le à coeur joie. Vous voudrez
ensuite fixer votre variable d'environnement PERL5DB pour qu'elle
dise quelque chose comme ceci :
BEGIN { require "myperl5db.pl" }
En dernier recours, vous pouvez aussi utiliser PERL5DB pour personnaliser le
débogueur en modifiant directement des variables internes ou en
appelant des fonctions du débogueur.
Notez que toute variable ou fonction n'étant pas documentée ici (ou dans la page de manuel perldebguts) est considérée réservée à un usage interne uniquement, et est sujette en tant que telle à des modifications sans préavis.
Tel que Perl est distribué, le seul historique de ligne de commande fourni est simpliste, vérifiant la présence de points d'exclamation en début de ligne. Toutefois, si vous installez les modules Term::ReadKey et Term::ReadLine du CPAN, vous aurez des possibilités d'édition comparables à celle que fournit le programme readline(3) du projet GNU. Recherchez-les dans le répertoire modules/by-module/Term du CPAN. Ceux-ci ne supportent toutefois pas l'édition normale de ligne de commande de vi.
Une complétion rudimentaire de la ligne de commande est aussi disponible. Malheureusement, les noms des variables lexicales ne sont pas disponible dans la complétion.
Si la version d'emacs de la FSF est installée sur votre système, il peut interagir avec le débogueur Perl pour fournir un environnement de développement intégré cousin de ses interactions avec les débogueurs C.
Perl est aussi fourni avec un fichier de démarrage pour faire agir emacs comme un éditeur dirigé par la syntaxe comprenant (en partie) la syntaxe de Perl. Regardez dans le répertoire emacs de la distribution des sources de Perl.
Une configuration similaire de Tom Christiansen pour l'interaction avec toute version de vi et du X window system est aussi disponible. Celle-ci fonctionne de façon similaire au support multifenêtré intégré que fournit emacs, où c'est le débogueur qui dirige l'interface. Toutefois, à l'heure où ces lignes sont rédigées, la localisation finale de cet outil dans la distribution de Perl est encore incertaine.
Les utilisateurs de vi devraient aussi s'intéresser à vim et gvim, les versions pour rongeurs et huisseries, pour colorier les mots-clés de Perl.
Notez que seul perl peut vraiment analyser du Perl, ce qui fait que tous ces outils d'aide à l'ingénierie logicielle manquent un peu leur but, en particulier si vous ne programmez pas en Perl comme le ferait un programmeur C.
Si vous désirez fournir un débogueur alternatif à Perl, invoquez juste votre script avec un deux points et un argument de paquetage donné au drapeau -d. Un des débogueurs alternatifs les plus populaires pour Perl est le profileur Perl. Devel::Prof est maintenant inclus dans la distribution standard de Perl. Pour profiler votre programme Perl contenu dans le fichier mycode.pl, tapez juste :
$ perl -d:DProf mycode.pl
Lorsque le script se terminera, le profileur écrira les informations de profil dans un fichier appelé tmon.out. Un outil tel que dprofpp, lui aussi fourni dans la distribution standard de Perl, peut être utilisé pour interpréter les informations de ce profil.
use re 'debug' vous permet de voir les détails sanglants sur la
façon dont le moteur d'expressions rationnelles de Perl fonctionne. De
façon à comprendre ces sorties typiquement volumineuses, on doit non
seulement avoir une certaine idée de la façon dont les recherches
d'expressions rationnelles fonctionnent en général, mais aussi
connaître la façon dont Perl compile en interne ses expressions
rationnelles pour en faire des automates. Ces sujets sont explorés en
détails dans +Débogage des expressions rationnelles dans la page de manuel perldebguts.
Perl contient un support interne du reporting de son propre usage de la mémoire, mais ceci est un concept plutôt avancé qui requiert une compréhension de la façon dont l'allocation mémoire fonctionne. Voir Débogage de l'usage de la mémoire par Perl dans la page de manuel perldebguts pour les détails.
Vous avez essayé l'option -w, n'est-ce pas ?
Voir aussi la page de manuel perldebguts, re, DB, la page de manuel Devel::Dprof, dprofpp, Dumpvalue et la page de manuel perlrun.
Vous ne pouvez pas obtenir d'informations concernant les frames de la pile ou de toute façon les fonctions de débogage qui n'ont pas été compilées par Perl, comme celles des extensions C ou C++.
Si vous modifiez vos arguments @_ dans un sous-programme (comme avec
shift ou pop), la trace de la pile ne vous en montrera pas les
valeurs originales.
Le débogueur ne fonctionne actuellement pas en conjonction avec l'option de ligne de commande -W, puisqu'elle n'est elle-même pas exempte d'avertissements.
Si vous êtes dans un appel système lent (comme wait, accept, ou
read depuis le clavier ou une socket) et que vous n'avez pas mis en
place votre propre handler $SIG{INT}, alors vous ne pourrez pas
revenir au débogueur par CTRL-C, parce que le propre handler
$SIG{INT} du débogueur ne sait pas qu'il doit lever une exception
pour faire un longjmp(3) hors d'un appel système lent.
Cette traduction française correspond à la version anglaise distribuée avec perl 5.6.0. Pour en savoir plus concernant ces traductions, consultez http://www.enstimac.fr/Perl/ .
Roland Trique <roland.trique@uhb.fr>
Personne pour l'instant.