Pourquoi la recherche de l'initialiseur d'un type déclencherait-elle une exception NullReferenceException?

194

Cela m'a dérouté. J'essayais d'optimiser certains tests pour Noda Time, où nous avons une vérification d'initialisation de type. J'ai pensé découvrir si un type avait un initialiseur de type (constructeur statique ou variables statiques avec initialiseurs) avant de tout charger dans un nouveau AppDomain. À ma grande surprise, un petit test de cela a jeté NullReferenceException- malgré l'absence de valeurs nulles dans mon code. Il lève uniquement l'exception lorsqu'il est compilé sans informations de débogage.

Voici un programme court mais complet pour illustrer le problème:

using System;

class Test
{
    static Test() {}

    static void Main()
    {
        var cctor = typeof(Test).TypeInitializer;
        Console.WriteLine("Got initializer? {0}", cctor != null);
    }    
}

Et une transcription de la compilation et de la sortie:

c:\Users\Jon\Test>csc Test.cs
Microsoft (R) Visual C# Compiler version 4.0.30319.17626
for Microsoft (R) .NET Framework 4.5
Copyright (C) Microsoft Corporation. All rights reserved.


c:\Users\Jon\Test>test

Unhandled Exception: System.NullReferenceException: Object reference not set to
an instance of an object.
   at System.RuntimeType.GetConstructorImpl(BindingFlags bindingAttr, Binder bin
der, CallingConventions callConvention, Type[] types, ParameterModifier[] modifi
ers)
   at Test.Main()

c:\Users\Jon\Test>csc /debug+ Test.cs
Microsoft (R) Visual C# Compiler version 4.0.30319.17626
for Microsoft (R) .NET Framework 4.5
Copyright (C) Microsoft Corporation. All rights reserved.


c:\Users\Jon\Test>test
Got initializer? True

Vous remarquerez maintenant que j'utilise .NET 4.5 (la version candidate) - ce qui peut être pertinent ici. C'est un peu difficile pour moi de le tester avec les différents autres frameworks originaux (en particulier "vanilla" .NET 4) mais si quelqu'un d'autre a un accès facile aux machines avec d'autres frameworks, je serais intéressé par les résultats.

Autres détails:

  • Je suis sur une machine x64, mais ce problème se produit avec les assemblys x86 et x64
  • C'est le «débogage» du code appelant qui fait la différence - même si dans le cas de test ci-dessus, il le teste sur son propre assemblage, lorsque j'ai essayé cela contre Noda Time, je n'ai pas eu à recompiler NodaTime.dllpour voir les différences - juste Test.csqui s'y référait.
  • L'exécution de l'assemblage "cassé" sur Mono 2.10.8 ne lance pas

Des idées? Bogue du framework?

EDIT: Curieux et curieux. Si vous retirez l' Console.WriteLineappel:

using System;

class Test
{
    static Test() {}

    static void Main()
    {
        var cctor = typeof(Test).TypeInitializer;
    }    
}

Il échoue désormais uniquement lorsqu'il est compilé avec csc /o- /debug-. Si vous activez les optimisations, ( /o+) cela fonctionne. Mais si vous incluez l' Console.WriteLineappel conformément à l'original, les deux versions échoueront.

Jon Skeet
la source
92
Heh - "bien qu'il n'y ait pas de valeurs nulles dans mon code" cela pourrait en fait être la première fois dans l'histoire SO enregistrée que la carte "le bug n'est pas dans mon code" a été jouée avec succès.
Marc Gravell
1
Renvoie True très bien sans aucun débogage effectuant le premier test de cmdline avec .NET 4 Framework, compilateur Visual C # 4.0.30319.1
Kerry
2
@MarcGravell: Oui, alors que je suis normalement très sceptique de dire "il n'y a pas de bug dans mon code" dans ce cas, quand il y a une seule expression en jeu, et l'exception est un NullReferenceException(qui devrait toujours indiquer un bug), il le fait vraiment regardez douteux. Je soupçonne fortement qu'il s'agit d' un bogue .NET 4.5, j'ai raté la fenêtre pour le corriger ...
Jon Skeet
15
@ JonSkeet: Nous savons tous que le SP1 de MS est le vrai RTM; p
leppie
1
@leppie: Non, csc /o+ /debug- Test.cséchoue aussi pour moi, ce qui est étrange.
Jon Skeet

Réponses:

284

avec csc test.cs:

(196c.1874): Access violation - code c0000005 (first chance)
mscorlib_ni!System.RuntimeType.GetConstructorImpl(System.Reflection.BindingFlags, System.Reflection.Binder, System.Reflection.CallingConventions, System.Type[], System.Reflection.ParameterModifier[])+0xa3:
000007fe`e5735403 488b4608        mov     rax,qword ptr [rsi+8] ds:00000000`00000008=????????????????

Essayer de charger à partir de [rsi+8]quand @rsiest NULL. Permet d'inspecter la fonction:

0:000> ln 000007fe`e5735403
(000007fe`e5735360)   mscorlib_ni!System.RuntimeType.GetConstructorImpl(System.Reflection.BindingFlags, System.Reflection.Binder, System.Reflection.CallingConventions, System.Type[], System.Reflection.ParameterModifier[])+0xa3
0:000> uf 000007fe`e5735360
Flow analysis was incomplete, some code may be missing
mscorlib_ni!System.RuntimeType.GetConstructorImpl(System.Reflection.BindingFlags, System.Reflection.Binder, System.Reflection.CallingConventions, System.Type[], System.Reflection.ParameterModifier[]):
000007fe`e5735360 53              push    rbx
000007fe`e5735361 55              push    rbp
000007fe`e5735362 56              push    rsi
000007fe`e5735363 57              push    rdi
000007fe`e5735364 4154            push    r12
000007fe`e5735366 4883ec30        sub     rsp,30h
000007fe`e573536a 498bf8          mov     rdi,r8
000007fe`e573536d 8bea            mov     ebp,edx
000007fe`e573536f 48c744242800000000 mov   qword ptr [rsp+28h],0
000007fe`e5735378 488bb42480000000 mov     rsi,qword ptr [rsp+80h]
000007fe`e5735380 4889742420      mov     qword ptr [rsp+20h],rsi
000007fe`e5735385 41b903000000    mov     r9d,3
...    
mscorlib_ni!System.RuntimeType.GetConstructorImpl(System.Reflection.BindingFlags, System.Reflection.Binder, System.Reflection.CallingConventions, System.Type[], System.Reflection.ParameterModifier[])+0x97:
000007fe`e57353f7 488b4b08        mov     rcx,qword ptr [rbx+8]
000007fe`e57353fb 85c9            test    ecx,ecx
000007fe`e57353fd 0f848e000000    je      mscorlib_ni!System.RuntimeType.GetConstructorImpl(System.Reflection.BindingFlags, System.Reflection.Binder, System.Reflection.CallingConventions, System.Type[], System.Reflection.ParameterModifier[])+0x131 (000007fe`e5735491)

mscorlib_ni!System.RuntimeType.GetConstructorImpl(System.Reflection.BindingFlags, System.Reflection.Binder, System.Reflection.CallingConventions, System.Type[], System.Reflection.ParameterModifier[])+0xa3:
000007fe`e5735403 488b4608        mov     rax,qword ptr [rsi+8]
000007fe`e5735407 85c0            test    eax,eax
000007fe`e5735409 7545            jne     mscorlib_ni!System.RuntimeType.GetConstructorImpl(System.Reflection.BindingFlags, System.Reflection.Binder, System.Reflection.CallingConventions, System.Type[], System.Reflection.ParameterModifier[])+0xf0 (000007fe`e5735450)
...

@rsiest chargé au début de [rsp+20h]donc il doit être passé par l'appelant. Regardons l'appelant:

0:000> k3
Child-SP          RetAddr           Call Site
00000000`001fec70 000007fe`8d450110 mscorlib_ni!System.RuntimeType.GetConstructorImpl(System.Reflection.BindingFlags, System.Reflection.Binder, System.Reflection.CallingConventions, System.Type[], System.Reflection.ParameterModifier[])+0xa3
00000000`001fecd0 000007fe`ecb6e073 image00000000_01120000!Test.Main()+0x60
00000000`001fed20 000007fe`ecb6dcb2 clr!CoUninitializeEE+0x7ae1f
0:000> ln 000007fe`8d450110
(000007fe`8d4500b0)   image00000000_01120000!Test.Main()+0x60
0:000> uf 000007fe`8d4500b0
image00000000_01120000!Test.Main():
000007fe`8d4500b0 53              push    rbx
000007fe`8d4500b1 4883ec40        sub     rsp,40h
000007fe`8d4500b5 e8a69ba658      call    mscorlib_ni!System.Console.get_In() (000007fe`e5eb9c60)
000007fe`8d4500ba 4c8bd8          mov     r11,rax
000007fe`8d4500bd 498b03          mov     rax,qword ptr [r11]
000007fe`8d4500c0 488b5048        mov     rdx,qword ptr [rax+48h]
000007fe`8d4500c4 498bcb          mov     rcx,r11
000007fe`8d4500c7 ff5238          call    qword ptr [rdx+38h]
000007fe`8d4500ca 488d0d7737eeff  lea     rcx,[000007fe`8d333848]
000007fe`8d4500d1 e88acb715f      call    clr!CoUninitializeEE+0x79a0c (000007fe`ecb6cc60)
000007fe`8d4500d6 4c8bd8          mov     r11,rax
000007fe`8d4500d9 48b92012531200000000 mov rcx,12531220h
000007fe`8d4500e3 488b09          mov     rcx,qword ptr [rcx]
000007fe`8d4500e6 498b03          mov     rax,qword ptr [r11]
000007fe`8d4500e9 4c8b5068        mov     r10,qword ptr [rax+68h]
000007fe`8d4500ed 48c744242800000000 mov   qword ptr [rsp+28h],0
000007fe`8d4500f6 48894c2420      mov     qword ptr [rsp+20h],rcx
000007fe`8d4500fb 41b903000000    mov     r9d,3
000007fe`8d450101 4533c0          xor     r8d,r8d
000007fe`8d450104 ba38000000      mov     edx,38h
000007fe`8d450109 498bcb          mov     rcx,r11
000007fe`8d45010c 41ff5228        call    qword ptr [r10+28h]
000007fe`8d450110 48bb1032531200000000 mov rbx,12533210h
000007fe`8d45011a 488b1b          mov     rbx,qword ptr [rbx]
000007fe`8d45011d 33d2            xor     edx,edx
000007fe`8d45011f 488bc8          mov     rcx,rax
000007fe`8d450122 e829452e58      call    mscorlib_ni!System.Reflection.ConstructorInfo.op_Equality(System.Reflection.ConstructorInfo, System.Reflection.ConstructorInfo) (000007fe`e5734650)
000007fe`8d450127 0fb6c8          movzx   ecx,al
000007fe`8d45012a 33c0            xor     eax,eax
000007fe`8d45012c 85c9            test    ecx,ecx
000007fe`8d45012e 0f94c0          sete    al
000007fe`8d450131 0fb6c8          movzx   ecx,al
000007fe`8d450134 894c2430        mov     dword ptr [rsp+30h],ecx
000007fe`8d450138 488d542430      lea     rdx,[rsp+30h]
000007fe`8d45013d 488d0d24224958  lea     rcx,[mscorlib_ni+0x682368 (000007fe`e58e2368)]
000007fe`8d450144 e807246a5f      call    clr+0x2550 (000007fe`ecaf2550)
000007fe`8d450149 488bd0          mov     rdx,rax
000007fe`8d45014c 488bcb          mov     rcx,rbx
000007fe`8d45014f e81cab2758      call    mscorlib_ni!System.Console.WriteLine(System.String, System.Object) (000007fe`e56cac70)
000007fe`8d450154 90              nop
000007fe`8d450155 4883c440        add     rsp,40h
000007fe`8d450159 5b              pop     rbx
000007fe`8d45015a c3              ret

(Mon démontage s'affiche System.Console.get_Inparce que j'ai ajouté un Console.GetLine()fichier dans test.cs pour avoir la possibilité de casser le débogueur. J'ai validé que cela ne change pas le comportement).

Nous sommes dans cet appel: 000007fe8d45010c 41ff5228 call qword ptr [r10+28h](notre adresse ret de trame AV est l'instruction juste après cela call).

Permet de comparer cela avec ce qui se passe lors de la compilation csc /debug test.cs. Nous pouvons mettre en place un bp 000007fee5735360, heureusement le module se charge à la même adresse. Sur l'instruction qui charge @rsi:

0:000> r
rax=000007fee58e2f30 rbx=00000000027c6258 rcx=00000000027c6258
rdx=0000000000000038 rsi=00000000002debd8 rdi=0000000000000000
rip=000007fee5735378 rsp=00000000002de990 rbp=0000000000000038
 r8=0000000000000000  r9=0000000000000003 r10=000007fee58831c8
r11=00000000002de9c0 r12=0000000000000000 r13=00000000002dedc0
r14=00000000002dec58 r15=0000000000000004
iopl=0         nv up ei pl nz na po nc
cs=0033  ss=002b  ds=002b  es=002b  fs=0053  gs=002b             efl=00000206
mscorlib_ni!System.RuntimeType.GetConstructorImpl(System.Reflection.BindingFlags, System.Reflection.Binder, System.Reflection.CallingConventions, System.Type[], System.Reflection.ParameterModifier[])+0x18:
000007fe`e5735378 488bb42480000000 mov     rsi,qword ptr [rsp+80h] ss:00000000`002dea10=a0627c0200000000

Notez que @rsic'est 00000000002debd8. Parcourir la fonction montre que c'est l'adresse qui sera déréférencée plus tard à l'endroit où les mauvaises bombes exe (c'est-à-dire @rsine changent pas). La pile est très intéressante car elle montre un cadre supplémentaire :

0:000> k3
Child-SP          RetAddr           Call Site
00000000`002de990 000007fe`e5eddf68 mscorlib_ni!System.RuntimeType.GetConstructorImpl(System.Reflection.BindingFlags, System.Reflection.Binder, System.Reflection.CallingConventions, System.Type[], System.Reflection.ParameterModifier[])+0x18
00000000`002de9f0 000007fe`8d460119 mscorlib_ni!System.Type.get_TypeInitializer()+0x48
00000000`002dea30 000007fe`ecb6e073 good!Test.Main()+0x49*** WARNING: Unable to verify checksum for good.exe

0:000> ln 000007fe`e5eddf68
(000007fe`e5eddf20)   mscorlib_ni!System.Type.get_TypeInitializer()+0x48
0:000> uf 000007fe`e5eddf20
mscorlib_ni!System.Type.get_TypeInitializer():
000007fe`e5eddf20 53              push    rbx
000007fe`e5eddf21 4883ec30        sub     rsp,30h
000007fe`e5eddf25 488bd9          mov     rbx,rcx
000007fe`e5eddf28 ba22010000      mov     edx,122h
000007fe`e5eddf2d b901000000      mov     ecx,1
000007fe`e5eddf32 e8d1a075ff      call    CORINFO_HELP_GETSHARED_GCSTATIC_BASE (000007fe`e5638008)
000007fe`e5eddf37 488b88f0010000  mov     rcx,qword ptr [rax+1F0h]
000007fe`e5eddf3e 488b03          mov     rax,qword ptr [rbx]
000007fe`e5eddf41 4c8b5068        mov     r10,qword ptr [rax+68h]
000007fe`e5eddf45 48c744242800000000 mov   qword ptr [rsp+28h],0
000007fe`e5eddf4e 48894c2420      mov     qword ptr [rsp+20h],rcx
000007fe`e5eddf53 41b903000000    mov     r9d,3
000007fe`e5eddf59 4533c0          xor     r8d,r8d
000007fe`e5eddf5c ba38000000      mov     edx,38h
000007fe`e5eddf61 488bcb          mov     rcx,rbx
000007fe`e5eddf64 41ff5228        call    qword ptr [r10+28h]
000007fe`e5eddf68 90              nop
000007fe`e5eddf69 4883c430        add     rsp,30h
000007fe`e5eddf6d 5b              pop     rbx
000007fe`e5eddf6e c3              ret
0:000> ln 000007fe`8d460119

L'appel est le même call qword ptr [r10+28h]que celui que nous avons vu auparavant, donc dans le mauvais cas, cette fonction était probablement intégrée dans le Main(), donc le fait qu'il y ait un cadre supplémentaire est un hareng rouge. Si nous regardons la préparation de ce que call qword ptr [r10+28h]nous remarquons cette instruction: mov qword ptr [rsp+20h],rcx. C'est ce qui charge l'adresse qui est finalement déréférencée en tant que @rsi. Dans le bon cas, voici comment @rcxest chargé:

000007fe`e5eddf32 e8d1a075ff      call    CORINFO_HELP_GETSHARED_GCSTATIC_BASE (000007fe`e5638008)
000007fe`e5eddf37 488b88f0010000  mov     rcx,qword ptr [rax+1F0h]

Dans le mauvais cas, cela semble très différent:

000007fe`8d4600d9 48b92012721200000000 mov rcx,12721220h
000007fe`8d4600e3 488b09          mov     rcx,qword ptr [rcx]

C'est très différent. Contrairement au bon cas qui appelle CORINFO_HELP_GETSHARED_GCSTATIC_BASE et lit ce qui finit comme le pointeur critique qui provoque l'AV d'un membre à l'offset 1F0dans une structure de retour, le code optimisé le charge à partir d'une adresse statique. Et bien sûr, 12721220h contient NULL:

0:000> dp 12721220h L8
00000000`12721220  00000000`00000000 00000000`00000000
00000000`12721230  00000000`00000000 00000000`02722198
00000000`12721240  00000000`027221c8 00000000`027221f8
00000000`12721250  00000000`02722228 00000000`02722258

Malheureusement, il est trop tard pour moi pour approfondir en ce moment, le démontage de CORINFO_HELP_GETSHARED_GCSTATIC_BASEest loin d'être anodin. Je poste ceci dans l'espoir que quelqu'un plus compétent en interne CLR puisse avoir du sens (comme vous pouvez le voir, j'ai vraiment considéré le problème uniquement à partir des instructions natives POV et complètement ignoré IL).

Remus Rusanu
la source
46
Vous méritez beaucoup plus de représentants que cela pour vos compétences en débogage.
JSB
23
Il s'agit d'un bug d'optimiseur. CORINFO * est un pointeur de fonction, il appelle JIT_GetSharedGCStaticBase. Je suppose qu'il a déclenché par la nouvelle fonctionnalité jit d'arrière-plan 4.5 et accède à un champ avant son initialisation, oubliant de jit la classe. Signalez cela sur connect.microsoft.com
Hans Passant
28
Ce n'est pas nécessaire. Nous cherchons déjà. Vous avez tout à fait raison, ce qui se passe, c'est que parce que nous allouons directement une instance de RuntimeType, le cctor de Type n'est jamais appelé, donc Type.EmptyTypes reste nul et c'est ce qui est transmis à GetConstructor.
Kirill Osenkov
3
Existe-t-il un livre que je peux lire pour acquérir ces compétences de débogage? (De préférence commençant par "Idiots Guide to" ou se terminant par "for Dummies")
Igby Largeman
1
@IgbyLargeman: le débogage avancé de Windows est assez bon.
Remus Rusanu
10

Comme je crois avoir trouvé de nouvelles découvertes intéressantes sur le problème, j'ai décidé de les ajouter comme réponse, reconnaissant en même temps qu'ils ne traitent pas du "pourquoi cela se produit" dans la question initiale. Peut-être que quelqu'un qui en sait plus sur le fonctionnement interne des types impliqués peut publier une réponse édifiante basée également sur les observations que je poste.

J'ai également réussi à reproduire le problème sur ma machine et j'ai suivi une connexion avec l' interface System.Runtime.InteropServices._Type , qui est implémentée par la System.Typeclasse.

Au départ, j'ai trouvé au moins 3 approches de contournement pour résoudre le problème:

  1. Il suffit de lancer le Typeà l' _Typeintérieur de la Mainméthode:

    var cctor = ((_Type)typeof(Test)).TypeInitializer;
  2. Ou en vous assurant que l'approche 1 a été utilisée précédemment dans la méthode:

    var warmUp = ((_Type)typeof(Test)).TypeInitializer; 
    var cctor = ((Type)typeof(Test)).TypeInitializer;
  3. Ou en ajoutant un champ statique à la Testclasse et en l'initialisant (en le convertissant en _Type):

    static ConstructorInfo _dummy1 = (typeof(object) as _Type).TypeInitializer;

Plus tard, j'ai découvert que si nous ne voulons pas impliquer l' System.Runtime.InteropServices._Typeinterface dans les solutions de contournement, le problème ne se produit pas non plus par:

  1. Ajouter un champ statique à la Testclasse et l'initialiser (sans le transtyper _Type):

    static ConstructorInfo _dummy2 = typeof(object).TypeInitializer;
  2. Ou en initialisant la cctorvariable elle-même en tant que champ statique de la classe:

    static ConstructorInfo cctor = typeof(Test).TypeInitializer;

J'attends vos commentaires avec impatience.

Alex Filipovici
la source