Rendre une image plus facile à déboguer dans .NET

  • Article

Lors de la compilation de code non managé, vous pouvez configurer une image exécutable pour le débogage en définissant des commutateurs ou des options de ligne de commande de l’IDE. Par exemple, vous pouvez utiliser l’option de ligne de commande /Zi dans Visual C++ pour lui demander de produire des fichiers de symboles de débogage (extension de fichier .pdb). De même, l’option de ligne de commande /Od indique au compilateur de désactiver l’optimisation. Le code résultant s’exécute plus lentement, mais il est plus facile à déboguer quand c’est nécessaire.

Lors de la compilation de code managé .NET Framework, des compilateurs comme Visual C++, Visual Basic et C# compilent leur programme source en langage CIL (Common Intermediate Language). CIL est ensuite compilé en mode JIT, juste avant l’exécution, en code machine natif. Comme avec le code non managé, vous pouvez configurer une image exécutable pour le débogage en définissant des commutateurs ou des options de ligne de commande de l’IDE. Vous pouvez aussi configurer la compilation JIT pour le débogage presque de la même façon.

Cette configuration JIT a deux aspects :

  • Vous pouvez demander au compilateur JIT de générer des informations de suivi. Ceci permet au débogueur de faire correspondre une chaîne de code CIL à son équivalent en code machine, et d’effectuer le suivi des emplacements où les variables locales et les arguments de fonction sont stockés. Dans le .NET Framework version 2.0, le compilateur JIT génère toujours des informations de suivi : il n’y a donc pas besoin de les demander.

  • Vous pouvez demander au compilateur JIT de ne pas optimiser le code machine résultant.

Normalement, le compilateur qui génère le code CIL définit ces options du compilateur JIT de façon appropriée, en fonction des commutateurs ou des options de ligne de commande de l’IDE que vous spécifiez, par exemple /Od.

Dans certains cas, vous pouvez changer le comportement du compilateur JIT afin que le code machine généré soit plus facile à déboguer. Par exemple, vous pouvez générer des informations de suivi JIT pour une version commerciale ou pour l’optimisation du contrôle. Vous pouvez faire cela avec un fichier d’initialisation (.ini).

Par exemple, si l’assembly que vous voulez déboguer est nommé MyApp.exe, vous pouvez créer un fichier texte nommé MyApp.ini dans le même dossier sous le nom MyApp.exe, qui contient ces trois lignes :

[.NET Framework Debugging Control]
GenerateTrackingInfo=1
AllowOptimize=0

Vous pouvez définir la valeur de chaque option sur 0 ou 1. Les options absentes ont 0 comme valeur par défaut. La définition de GenerateTrackingInfo sur 1 et de AllowOptimize sur 0 est ce qui permet le débogage le plus facile.

À compter du .NET Framework 2.0, le compilateur JIT génère toujours des informations de suivi, quelle que soit la valeur de GenerateTrackingInfo ; la valeur de AllowOptimize a cependant néanmoins toujours un effet. Quand vous utilisez le générateur d’images natives Ngen.exe (Native Image Generator) pour précompiler l’image native sans optimisation, le fichier .ini doit être présent dans le dossier cible avec AllowOptimize=0 quand Ngen.exe s’exécute. Si vous avez précompilé un assembly sans optimisation, vous devez supprimer le code précompilé en utilisant l’option /uninstall de NGen.exe avant de réexécuter Ngen.exe pour précompiler le code avec optimisation. Si le fichier .ini n’est pas présent dans le dossier, par défaut, Ngen.exe précompile le code avec optimisation.

System.Diagnostics.DebuggableAttribute contrôle les paramètres pour un assembly. DebuggableAttribute comprend deux champs qui contrôlent si le compilateur JIT doit optimiser et/ou générer des informations de suivi. Dans .NET Framework 2.0 et ultérieur, le compilateur JIT génère toujours des informations de suivi.

Pour une build destinée à la commercialisation, les compilateurs ne définissent pas de DebuggableAttribute. Par défaut, le compilateur JIT génère du code machine avec les performances les plus élevées, mais le plus difficile à déboguer. L’activation du suivi dans JIT diminue légèrement les performances, tandis que la désactivation de l’optimisation les réduit considérablement.

DebuggableAttribute s’applique à la totalité d’un assembly, et non pas à des modules individuels dans l’assembly. Les outils de développement doivent donc attacher des attributs personnalisés au jeton de métadonnées de l’assembly si un assembly a déjà été créé, ou à la classe appelée System.Runtime.CompilerServices.AssemblyAttributesGoHere. L’outil ALink promeut ensuite ces attributs DebuggableAttribute de chaque module vers l’assembly dont ils font partie. Si un conflit se produit, l’opération ALink échoue.

Notes

Dans la version 1.0 du .NET Framework, le compilateur Microsoft Visual C++ ajoute DebuggableAttribute quand les options du compilateur /clr et /Zi sont spécifiées. Dans la version 1.1 du .NET Framework, vous devez ajouter DebuggableAttribute manuellement dans votre code ou en utiliser l’option de l’éditeur de liens /ASSEMBLYDEBUG.

Voir aussi