ntdll: Fix up instruction pointer in context inside raise_exception.
[wine] / dlls / ntdll / tests / exception.c
1 /*
2  * Unit test suite for ntdll exceptions
3  *
4  * Copyright 2005 Alexandre Julliard
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
19  */
20
21 #include <stdarg.h>
22 #include <stdio.h>
23
24 #ifndef _WIN32_WINNT
25 #define _WIN32_WINNT 0x500 /* For NTSTATUS */
26 #endif
27
28 #include "ntstatus.h"
29 #define WIN32_NO_STATUS
30 #include "windef.h"
31 #include "winbase.h"
32 #include "winnt.h"
33 #include "winreg.h"
34 #include "winternl.h"
35 #include "excpt.h"
36 #include "wine/test.h"
37
38 #ifdef __i386__
39 static int      my_argc;
40 static char**   my_argv;
41 static int      test_stage;
42
43 static struct _TEB * (WINAPI *pNtCurrentTeb)(void);
44 static NTSTATUS  (WINAPI *pNtGetContextThread)(HANDLE,CONTEXT*);
45 static NTSTATUS  (WINAPI *pNtSetContextThread)(HANDLE,CONTEXT*);
46 static NTSTATUS  (WINAPI *pRtlRaiseException)(EXCEPTION_RECORD *rec);
47 static PVOID     (WINAPI *pRtlAddVectoredExceptionHandler)(ULONG first, PVECTORED_EXCEPTION_HANDLER func);
48 static ULONG     (WINAPI *pRtlRemoveVectoredExceptionHandler)(PVOID handler);
49 static NTSTATUS  (WINAPI *pNtReadVirtualMemory)(HANDLE, const void*, void*, SIZE_T, SIZE_T*);
50 static NTSTATUS  (WINAPI *pNtTerminateProcess)(HANDLE handle, LONG exit_code);
51 static void *code_mem;
52
53 /* Test various instruction combinations that cause a protection fault on the i386,
54  * and check what the resulting exception looks like.
55  */
56
57 static const struct exception
58 {
59     BYTE     code[18];   /* asm code */
60     BYTE     offset;     /* offset of faulting instruction */
61     BYTE     length;     /* length of faulting instruction */
62     NTSTATUS status;     /* expected status code */
63     DWORD    nb_params;  /* expected number of parameters */
64     DWORD    params[4];  /* expected parameters */
65 } exceptions[] =
66 {
67     /* test some privileged instructions */
68     { { 0xfb, 0xc3 },  /* sti; ret */
69       0, 1, STATUS_PRIVILEGED_INSTRUCTION, 0 },
70     { { 0x6c, 0xc3 },  /* insb (%dx); ret */
71       0, 1, STATUS_PRIVILEGED_INSTRUCTION, 0 },
72     { { 0x6d, 0xc3 },  /* insl (%dx); ret */
73       0, 1, STATUS_PRIVILEGED_INSTRUCTION, 0 },
74     { { 0x6e, 0xc3 },  /* outsb (%dx); ret */
75       0, 1, STATUS_PRIVILEGED_INSTRUCTION, 0 },
76     { { 0x6f, 0xc3 },  /* outsl (%dx); ret */
77       0, 1, STATUS_PRIVILEGED_INSTRUCTION, 0 },
78     { { 0xe4, 0x11, 0xc3 },  /* inb $0x11,%al; ret */
79       0, 2, STATUS_PRIVILEGED_INSTRUCTION, 0 },
80     { { 0xe5, 0x11, 0xc3 },  /* inl $0x11,%eax; ret */
81       0, 2, STATUS_PRIVILEGED_INSTRUCTION, 0 },
82     { { 0xe6, 0x11, 0xc3 },  /* outb %al,$0x11; ret */
83       0, 2, STATUS_PRIVILEGED_INSTRUCTION, 0 },
84     { { 0xe7, 0x11, 0xc3 },  /* outl %eax,$0x11; ret */
85       0, 2, STATUS_PRIVILEGED_INSTRUCTION, 0 },
86     { { 0xed, 0xc3 },  /* inl (%dx),%eax; ret */
87       0, 1, STATUS_PRIVILEGED_INSTRUCTION, 0 },
88     { { 0xee, 0xc3 },  /* outb %al,(%dx); ret */
89       0, 1, STATUS_PRIVILEGED_INSTRUCTION, 0 },
90     { { 0xef, 0xc3 },  /* outl %eax,(%dx); ret */
91       0, 1, STATUS_PRIVILEGED_INSTRUCTION, 0 },
92     { { 0xf4, 0xc3 },  /* hlt; ret */
93       0, 1, STATUS_PRIVILEGED_INSTRUCTION, 0 },
94     { { 0xfa, 0xc3 },  /* cli; ret */
95       0, 1, STATUS_PRIVILEGED_INSTRUCTION, 0 },
96
97     /* test long jump to invalid selector */
98     { { 0xea, 0, 0, 0, 0, 0, 0, 0xc3 },  /* ljmp $0,$0; ret */
99       0, 7, STATUS_ACCESS_VIOLATION, 2, { 0, 0xffffffff } },
100
101     /* test iret to invalid selector */
102     { { 0x6a, 0x00, 0x6a, 0x00, 0x6a, 0x00, 0xcf, 0x83, 0xc4, 0x0c, 0xc3 },
103       /* pushl $0; pushl $0; pushl $0; iret; addl $12,%esp; ret */
104       6, 1, STATUS_ACCESS_VIOLATION, 2, { 0, 0xffffffff } },
105
106     /* test loading an invalid selector */
107     { { 0xb8, 0xef, 0xbe, 0x00, 0x00, 0x8e, 0xe8, 0xc3 },  /* mov $beef,%ax; mov %ax,%gs; ret */
108       5, 2, STATUS_ACCESS_VIOLATION, 2, { 0, 0xbee8 } },
109
110     /* test accessing a zero selector */
111     { { 0x06, 0x31, 0xc0, 0x8e, 0xc0, 0x26, 0xa1, 0, 0, 0, 0, 0x07, 0xc3 },
112           /* push %es; xor %eax,%eax; mov %ax,%es; mov %es:(0),%ax; pop %es */
113       5, 6, STATUS_ACCESS_VIOLATION, 2, { 0, 0xffffffff } },
114
115     /* test moving %cs -> %ss */
116     { { 0x0e, 0x17, 0x58, 0xc3 },  /* pushl %cs; popl %ss; popl %eax; ret */
117       1, 1, STATUS_ACCESS_VIOLATION, 2, { 0, 0xffffffff } },
118
119     /* test overlong instruction (limit is 16 bytes) */
120     { { 0x64,0x64,0x64,0x64,0x64,0x64,0x64,0x64,0x64,0x64,0x64,0x64,0x64,0x64,0x64,0xfa,0xc3 },
121       0, 16, STATUS_ILLEGAL_INSTRUCTION, 0 },
122     { { 0x64,0x64,0x64,0x64,0x64,0x64,0x64,0x64,0x64,0x64,0x64,0x64,0x64,0x64,0xfa,0xc3 },
123       0, 15, STATUS_PRIVILEGED_INSTRUCTION, 0 },
124
125     /* test invalid interrupt */
126     { { 0xcd, 0xff, 0xc3 },   /* int $0xff; ret */
127       0, 2, STATUS_ACCESS_VIOLATION, 2, { 0, 0xffffffff } },
128
129     /* test moves to/from Crx */
130     { { 0x0f, 0x20, 0xc0, 0xc3 },  /* movl %cr0,%eax; ret */
131       0, 3, STATUS_PRIVILEGED_INSTRUCTION, 0 },
132     { { 0x0f, 0x20, 0xe0, 0xc3 },  /* movl %cr4,%eax; ret */
133       0, 3, STATUS_PRIVILEGED_INSTRUCTION, 0 },
134     { { 0x0f, 0x22, 0xc0, 0xc3 },  /* movl %eax,%cr0; ret */
135       0, 3, STATUS_PRIVILEGED_INSTRUCTION, 0 },
136     { { 0x0f, 0x22, 0xe0, 0xc3 },  /* movl %eax,%cr4; ret */
137       0, 3, STATUS_PRIVILEGED_INSTRUCTION, 0 },
138
139     /* test moves to/from Drx */
140     { { 0x0f, 0x21, 0xc0, 0xc3 },  /* movl %dr0,%eax; ret */
141       0, 3, STATUS_PRIVILEGED_INSTRUCTION, 0 },
142     { { 0x0f, 0x21, 0xc8, 0xc3 },  /* movl %dr1,%eax; ret */
143       0, 3, STATUS_PRIVILEGED_INSTRUCTION, 0 },
144     { { 0x0f, 0x21, 0xf8, 0xc3 },  /* movl %dr7,%eax; ret */
145       0, 3, STATUS_PRIVILEGED_INSTRUCTION, 0 },
146     { { 0x0f, 0x23, 0xc0, 0xc3 },  /* movl %eax,%dr0; ret */
147       0, 3, STATUS_PRIVILEGED_INSTRUCTION, 0 },
148     { { 0x0f, 0x23, 0xc8, 0xc3 },  /* movl %eax,%dr1; ret */
149       0, 3, STATUS_PRIVILEGED_INSTRUCTION, 0 },
150     { { 0x0f, 0x23, 0xf8, 0xc3 },  /* movl %eax,%dr7; ret */
151       0, 3, STATUS_PRIVILEGED_INSTRUCTION, 0 },
152
153     /* test memory reads */
154     { { 0xa1, 0xfc, 0xff, 0xff, 0xff, 0xc3 },  /* movl 0xfffffffc,%eax; ret */
155       0, 5, STATUS_ACCESS_VIOLATION, 2, { 0, 0xfffffffc } },
156     { { 0xa1, 0xfd, 0xff, 0xff, 0xff, 0xc3 },  /* movl 0xfffffffd,%eax; ret */
157       0, 5, STATUS_ACCESS_VIOLATION, 2, { 0, 0xfffffffd } },
158     { { 0xa1, 0xfe, 0xff, 0xff, 0xff, 0xc3 },  /* movl 0xfffffffe,%eax; ret */
159       0, 5, STATUS_ACCESS_VIOLATION, 2, { 0, 0xfffffffe } },
160     { { 0xa1, 0xff, 0xff, 0xff, 0xff, 0xc3 },  /* movl 0xffffffff,%eax; ret */
161       0, 5, STATUS_ACCESS_VIOLATION, 2, { 0, 0xffffffff } },
162
163     /* test memory writes */
164     { { 0xa3, 0xfc, 0xff, 0xff, 0xff, 0xc3 },  /* movl %eax,0xfffffffc; ret */
165       0, 5, STATUS_ACCESS_VIOLATION, 2, { 1, 0xfffffffc } },
166     { { 0xa3, 0xfd, 0xff, 0xff, 0xff, 0xc3 },  /* movl %eax,0xfffffffd; ret */
167       0, 5, STATUS_ACCESS_VIOLATION, 2, { 1, 0xfffffffd } },
168     { { 0xa3, 0xfe, 0xff, 0xff, 0xff, 0xc3 },  /* movl %eax,0xfffffffe; ret */
169       0, 5, STATUS_ACCESS_VIOLATION, 2, { 1, 0xfffffffe } },
170     { { 0xa3, 0xff, 0xff, 0xff, 0xff, 0xc3 },  /* movl %eax,0xffffffff; ret */
171       0, 5, STATUS_ACCESS_VIOLATION, 2, { 1, 0xffffffff } },
172 };
173
174 static int got_exception;
175 static BOOL have_vectored_api;
176
177 static void run_exception_test(const void *handler, const void* context,
178                                const void *code, unsigned int code_size)
179 {
180     struct {
181         EXCEPTION_REGISTRATION_RECORD frame;
182         const void *context;
183     } exc_frame;
184     void (*func)(void) = code_mem;
185
186     exc_frame.frame.Handler = handler;
187     exc_frame.frame.Prev = pNtCurrentTeb()->Tib.ExceptionList;
188     exc_frame.context = context;
189
190     memcpy(code_mem, code, code_size);
191
192     pNtCurrentTeb()->Tib.ExceptionList = &exc_frame.frame;
193     func();
194     pNtCurrentTeb()->Tib.ExceptionList = exc_frame.frame.Prev;
195 }
196
197 LONG CALLBACK rtlraiseexception_vectored_handler(EXCEPTION_POINTERS *ExceptionInfo)
198 {
199     PCONTEXT context = ExceptionInfo->ContextRecord;
200     PEXCEPTION_RECORD rec = ExceptionInfo->ExceptionRecord;
201     trace("vect. handler %08x addr:%p context.Eip:%x\n", rec->ExceptionCode,
202           rec->ExceptionAddress, context->Eip);
203
204     todo_wine {
205     ok(rec->ExceptionAddress == (char *)code_mem + 0xb, "ExceptionAddress at %p instead of %p\n",
206        rec->ExceptionAddress, (char *)code_mem + 0xb);
207
208     if (pNtCurrentTeb()->Peb->BeingDebugged)
209         ok((void *)context->Eax == pRtlRaiseException, "debugger managed to modify Eax to %x should be %p\n",
210            context->Eax, pRtlRaiseException);
211     }
212
213     /* check that context.Eip is fixed up only for EXCEPTION_BREAKPOINT
214      * even if raised by RtlRaiseException
215      */
216     if(rec->ExceptionCode == EXCEPTION_BREAKPOINT)
217     {
218         ok(context->Eip == (DWORD)code_mem + 0xa, "Eip at %x instead of %x\n",
219            context->Eip, (DWORD)code_mem + 0xa);
220     }
221     else
222     {
223         ok(context->Eip == (DWORD)code_mem + 0xb, "Eip at %x instead of %x\n",
224            context->Eip, (DWORD)code_mem + 0xb);
225     }
226
227     /* test if context change is preserved from vectored handler to stack handlers */
228     context->Eax = 0xf00f00f0;
229     return EXCEPTION_CONTINUE_SEARCH;
230 }
231
232 static DWORD rtlraiseexception_handler( EXCEPTION_RECORD *rec, EXCEPTION_REGISTRATION_RECORD *frame,
233                       CONTEXT *context, EXCEPTION_REGISTRATION_RECORD **dispatcher )
234 {
235     trace( "exception: %08x flags:%x addr:%p context: Eip:%x\n",
236            rec->ExceptionCode, rec->ExceptionFlags, rec->ExceptionAddress, context->Eip );
237
238     todo_wine {
239     ok(rec->ExceptionAddress == (char *)code_mem + 0xb, "ExceptionAddress at %p instead of %p\n",
240        rec->ExceptionAddress, (char *)code_mem + 0xb);
241     }
242
243     /* check that context.Eip is fixed up only for EXCEPTION_BREAKPOINT
244      * even if raised by RtlRaiseException
245      */
246     if(rec->ExceptionCode == EXCEPTION_BREAKPOINT)
247     {
248         ok(context->Eip == (DWORD)code_mem + 0xa, "Eip at %x instead of %x\n",
249            context->Eip, (DWORD)code_mem + 0xa);
250     }
251     else
252     {
253         ok(context->Eip == (DWORD)code_mem + 0xb, "Eip at %x instead of %x\n",
254            context->Eip, (DWORD)code_mem + 0xb);
255     }
256
257     if(have_vectored_api)
258         ok(context->Eax == 0xf00f00f0, "Eax is %x, should have been set to 0xf00f00f0 in vectored handler\n",
259            context->Eax);
260
261     /* give the debugger a chance to examine the state a second time */
262     /* without the exception handler changing Eip */
263     if (test_stage == 2)
264         return ExceptionContinueSearch;
265
266     /* Eip in context is decreased by 1
267      * Increase it again, else execution will continue in the middle of a instruction */
268     if(rec->ExceptionCode == EXCEPTION_BREAKPOINT && (context->Eip == (DWORD)code_mem + 0xa))
269         context->Eip += 1;
270     return ExceptionContinueExecution;
271 }
272
273
274 static const BYTE call_one_arg_code[] = {
275         0x8b, 0x44, 0x24, 0x08, /* mov 0x8(%esp),%eax */
276         0x50,                   /* push %eax */
277         0x8b, 0x44, 0x24, 0x08, /* mov 0x8(%esp),%eax */
278         0xff, 0xd0,             /* call *%eax */
279         0x90,                   /* nop */
280         0x90,                   /* nop */
281         0x90,                   /* nop */
282         0x90,                   /* nop */
283         0xc3,                   /* ret */
284 };
285
286
287 static void run_rtlraiseexception_test(DWORD exceptioncode)
288 {
289     EXCEPTION_REGISTRATION_RECORD frame;
290     EXCEPTION_RECORD record;
291     PVOID vectored_handler = NULL;
292
293     void (*func)(void* function, EXCEPTION_RECORD* record) = code_mem;
294
295     record.ExceptionCode = exceptioncode;
296     record.ExceptionFlags = 0;
297     record.ExceptionRecord = NULL;
298     record.ExceptionAddress = NULL; /* does not matter, copied return address */
299     record.NumberParameters = 0;
300
301     frame.Handler = rtlraiseexception_handler;
302     frame.Prev = pNtCurrentTeb()->Tib.ExceptionList;
303
304     memcpy(code_mem, call_one_arg_code, sizeof(call_one_arg_code));
305
306     pNtCurrentTeb()->Tib.ExceptionList = &frame;
307     if (have_vectored_api)
308     {
309         vectored_handler = pRtlAddVectoredExceptionHandler(TRUE, &rtlraiseexception_vectored_handler);
310         ok(vectored_handler != 0, "RtlAddVectoredExceptionHandler failed\n");
311     }
312
313     func(pRtlRaiseException, &record);
314
315     if (have_vectored_api)
316         pRtlRemoveVectoredExceptionHandler(vectored_handler);
317     pNtCurrentTeb()->Tib.ExceptionList = frame.Prev;
318 }
319
320 static void test_rtlraiseexception(void)
321 {
322     if (!pRtlRaiseException)
323     {
324         skip("RtlRaiseException not found\n");
325         return;
326     }
327
328     /* test without debugger */
329     run_rtlraiseexception_test(0x12345);
330     run_rtlraiseexception_test(EXCEPTION_BREAKPOINT);
331     run_rtlraiseexception_test(EXCEPTION_INVALID_HANDLE);
332 }
333
334 static DWORD handler( EXCEPTION_RECORD *rec, EXCEPTION_REGISTRATION_RECORD *frame,
335                       CONTEXT *context, EXCEPTION_REGISTRATION_RECORD **dispatcher )
336 {
337     const struct exception *except = *(const struct exception **)(frame + 1);
338     unsigned int i, entry = except - exceptions;
339
340     got_exception++;
341     trace( "exception: %x flags:%x addr:%p\n",
342            rec->ExceptionCode, rec->ExceptionFlags, rec->ExceptionAddress );
343
344     ok( rec->ExceptionCode == except->status,
345         "%u: Wrong exception code %x/%x\n", entry, rec->ExceptionCode, except->status );
346     ok( rec->ExceptionAddress == (char*)code_mem + except->offset,
347         "%u: Wrong exception address %p/%p\n", entry,
348         rec->ExceptionAddress, (char*)code_mem + except->offset );
349
350     ok( rec->NumberParameters == except->nb_params,
351         "%u: Wrong number of parameters %u/%u\n", entry, rec->NumberParameters, except->nb_params );
352
353     /* Most CPUs (except Intel Core apparently) report a segment limit violation */
354     /* instead of page faults for accesses beyond 0xffffffff */
355     if (except->nb_params == 2 && except->params[1] >= 0xfffffffd)
356     {
357         if (rec->ExceptionInformation[0] == 0 && rec->ExceptionInformation[1] == 0xffffffff)
358             goto skip_params;
359     }
360
361     for (i = 0; i < rec->NumberParameters; i++)
362         ok( rec->ExceptionInformation[i] == except->params[i],
363             "%u: Wrong parameter %d: %lx/%x\n",
364             entry, i, rec->ExceptionInformation[i], except->params[i] );
365
366 skip_params:
367     /* don't handle exception if it's not the address we expected */
368     if (rec->ExceptionAddress != (char*)code_mem + except->offset) return ExceptionContinueSearch;
369
370     context->Eip += except->length;
371     return ExceptionContinueExecution;
372 }
373
374 static void test_prot_fault(void)
375 {
376     unsigned int i;
377
378     for (i = 0; i < sizeof(exceptions)/sizeof(exceptions[0]); i++)
379     {
380         got_exception = 0;
381         run_exception_test(handler, &exceptions[i], &exceptions[i].code,
382                            sizeof(exceptions[i].code));
383         if (!i && !got_exception)
384         {
385             trace( "No exception, assuming win9x, no point in testing further\n" );
386             break;
387         }
388         ok( got_exception == (exceptions[i].status != 0),
389             "%u: bad exception count %d\n", i, got_exception );
390     }
391 }
392
393 /* test handling of debug registers */
394 static DWORD dreg_handler( EXCEPTION_RECORD *rec, EXCEPTION_REGISTRATION_RECORD *frame,
395                       CONTEXT *context, EXCEPTION_REGISTRATION_RECORD **dispatcher )
396 {
397     context->Eip += 2;  /* Skips the popl (%eax) */
398     context->Dr0 = 0x42424242;
399     context->Dr1 = 0;
400     context->Dr2 = 0;
401     context->Dr3 = 0;
402     context->Dr6 = 0;
403     context->Dr7 = 0x155;
404     return ExceptionContinueExecution;
405 }
406
407 static const BYTE segfault_code[5] = {
408         0x31, 0xc0, /* xor    %eax,%eax */
409         0x8f, 0x00, /* popl   (%eax) - cause exception */
410         0xc3        /* ret */
411 };
412
413 /* test the single step exception behaviour */
414 static DWORD single_step_handler( EXCEPTION_RECORD *rec, EXCEPTION_REGISTRATION_RECORD *frame,
415                                   CONTEXT *context, EXCEPTION_REGISTRATION_RECORD **dispatcher )
416 {
417     got_exception++;
418     ok (!(context->EFlags & 0x100), "eflags has single stepping bit set\n");
419
420     if( got_exception < 3)
421         context->EFlags |= 0x100;  /* single step until popf instruction */
422     else {
423         /* show that the last single step exception on the popf instruction
424          * (which removed the TF bit), still is a EXCEPTION_SINGLE_STEP exception */
425         ok( rec->ExceptionCode == EXCEPTION_SINGLE_STEP,
426             "exception is not EXCEPTION_SINGLE_STEP: %x\n", rec->ExceptionCode);
427     }
428
429     return ExceptionContinueExecution;
430 }
431
432 static const BYTE single_stepcode[] = {
433     0x9c,               /* pushf */
434     0x58,               /* pop   %eax */
435     0x0d,0,1,0,0,       /* or    $0x100,%eax */
436     0x50,               /* push   %eax */
437     0x9d,               /* popf    */
438     0x35,0,1,0,0,       /* xor    $0x100,%eax */
439     0x50,               /* push   %eax */
440     0x9d,               /* popf    */
441     0xc3
442 };
443
444 /* Test the alignment check (AC) flag handling. */
445 static const BYTE align_check_code[] = {
446     0x55,                       /* push   %ebp */
447     0x89,0xe5,                  /* mov    %esp,%ebp */
448     0x9c,                       /* pushf   */
449     0x58,                       /* pop    %eax */
450     0x0d,0,0,4,0,               /* or     $0x40000,%eax */
451     0x50,                       /* push   %eax */
452     0x9d,                       /* popf    */
453     0x89,0xe0,                  /* mov %esp, %eax */
454     0x8b,0x40,0x1,              /* mov 0x1(%eax), %eax - cause exception */
455     0x9c,                       /* pushf   */
456     0x58,                       /* pop    %eax */
457     0x35,0,0,4,0,               /* xor    $0x40000,%eax */
458     0x50,                       /* push   %eax */
459     0x9d,                       /* popf    */
460     0x5d,                       /* pop    %ebp */
461     0xc3,                       /* ret     */
462 };
463
464 static DWORD align_check_handler( EXCEPTION_RECORD *rec, EXCEPTION_REGISTRATION_RECORD *frame,
465                                   CONTEXT *context, EXCEPTION_REGISTRATION_RECORD **dispatcher )
466 {
467     ok (!(context->EFlags & 0x40000), "eflags has AC bit set\n");
468     got_exception++;
469     return ExceptionContinueExecution;
470 }
471
472 /* test single stepping over hardware breakpoint */
473 static DWORD bpx_handler( EXCEPTION_RECORD *rec, EXCEPTION_REGISTRATION_RECORD *frame,
474                           CONTEXT *context, EXCEPTION_REGISTRATION_RECORD **dispatcher )
475 {
476     got_exception++;
477     ok( rec->ExceptionCode == EXCEPTION_SINGLE_STEP,
478         "wrong exception code: %x\n", rec->ExceptionCode);
479
480     if(got_exception == 1) {
481         /* hw bp exception on first nop */
482         ok( context->Eip == (DWORD)code_mem, "eip is wrong:  %x instead of %x\n",
483                                              context->Eip, (DWORD)code_mem);
484         ok( (context->Dr6 & 0xf) == 1, "B0 flag is not set in Dr6\n");
485         ok( !(context->Dr6 & 0x4000), "BS flag is set in Dr6\n");
486         context->Dr0 = context->Dr0 + 1;  /* set hw bp again on next instruction */
487         context->EFlags |= 0x100;       /* enable single stepping */
488     } else if(  got_exception == 2) {
489         /* single step exception on second nop */
490         ok( context->Eip == (DWORD)code_mem + 1, "eip is wrong: %x instead of %x\n",
491                                                  context->Eip, (DWORD)code_mem + 1);
492         todo_wine{ ok( (context->Dr6 & 0x4000), "BS flag is not set in Dr6\n"); };
493        /* depending on the win version the B0 bit is already set here as well
494         ok( (context->Dr6 & 0xf) == 0, "B0...3 flags in Dr6 shouldn't be set\n"); */
495         context->EFlags |= 0x100;
496     } else if( got_exception == 3) {
497         /* hw bp exception on second nop */
498         ok( context->Eip == (DWORD)code_mem + 1, "eip is wrong: %x instead of %x\n",
499                                                  context->Eip, (DWORD)code_mem + 1);
500         todo_wine{ ok( (context->Dr6 & 0xf) == 1, "B0 flag is not set in Dr6\n"); };
501         ok( !(context->Dr6 & 0x4000), "BS flag is set in Dr6\n");
502         context->Dr0 = 0;       /* clear breakpoint */
503         context->EFlags |= 0x100;
504     } else {
505         /* single step exception on ret */
506         ok( context->Eip == (DWORD)code_mem + 2, "eip is wrong: %x instead of %x\n",
507                                                  context->Eip, (DWORD)code_mem + 2);
508         ok( (context->Dr6 & 0xf) == 0, "B0...3 flags in Dr6 shouldn't be set\n");
509         todo_wine{ ok( (context->Dr6 & 0x4000), "BS flag is not set in Dr6\n"); };
510     }
511
512     context->Dr6 = 0;  /* clear status register */
513     return ExceptionContinueExecution;
514 }
515
516 static const BYTE dummy_code[] = { 0x90, 0x90, 0xc3 };  /* nop, nop, ret */
517
518 /* test int3 handling */
519 static DWORD int3_handler( EXCEPTION_RECORD *rec, EXCEPTION_REGISTRATION_RECORD *frame,
520                            CONTEXT *context, EXCEPTION_REGISTRATION_RECORD **dispatcher )
521 {
522     ok( rec->ExceptionAddress == code_mem, "exception address not at: %p, but at %p\n",
523                                            code_mem,  rec->ExceptionAddress);
524     ok( context->Eip == (DWORD)code_mem, "eip not at: %p, but at %#x\n", code_mem, context->Eip);
525     if(context->Eip == (DWORD)code_mem) context->Eip++; /* skip breakpoint */
526
527     return ExceptionContinueExecution;
528 }
529
530 static const BYTE int3_code[] = { 0xCC, 0xc3 };  /* int 3, ret */
531
532
533 static void test_exceptions(void)
534 {
535     CONTEXT ctx;
536     NTSTATUS res;
537
538     if (!pNtGetContextThread || !pNtSetContextThread)
539     {
540         trace( "NtGetContextThread/NtSetContextThread not found, skipping tests\n" );
541         return;
542     }
543
544     /* test handling of debug registers */
545     run_exception_test(dreg_handler, NULL, &segfault_code, sizeof(segfault_code));
546
547     ctx.ContextFlags = CONTEXT_DEBUG_REGISTERS;
548     res = pNtGetContextThread(GetCurrentThread(), &ctx);
549     ok (res == STATUS_SUCCESS,"NtGetContextThread failed with %x\n", res);
550     ok(ctx.Dr0 == 0x42424242,"failed to set debugregister 0 to 0x42424242, got %x\n", ctx.Dr0);
551     ok((ctx.Dr7 & ~0xdc00) == 0x155,"failed to set debugregister 7 to 0x155, got %x\n", ctx.Dr7);
552
553     /* test single stepping behavior */
554     got_exception = 0;
555     run_exception_test(single_step_handler, NULL, &single_stepcode, sizeof(single_stepcode));
556     ok(got_exception == 3, "expected 3 single step exceptions, got %d\n", got_exception);
557
558     /* test alignment exceptions */
559     got_exception = 0;
560     run_exception_test(align_check_handler, NULL, align_check_code, sizeof(align_check_code));
561     ok(got_exception == 0, "got %d alignment faults, expected 0\n", got_exception);
562
563     /* test single stepping over hardware breakpoint */
564     memset(&ctx, 0, sizeof(ctx));
565     ctx.Dr0 = (DWORD) code_mem;  /* set hw bp on first nop */
566     ctx.Dr7 = 3;
567     ctx.ContextFlags = CONTEXT_DEBUG_REGISTERS;
568     res = pNtSetContextThread( GetCurrentThread(), &ctx);
569     ok( res == STATUS_SUCCESS, "NtSetContextThread faild with %x\n", res);
570
571     got_exception = 0;
572     run_exception_test(bpx_handler, NULL, dummy_code, sizeof(dummy_code));
573     ok( got_exception == 4,"expected 4 exceptions, got %d\n", got_exception);
574
575     /* test int3 handling */
576     run_exception_test(int3_handler, NULL, int3_code, sizeof(int3_code));
577 }
578
579 static void test_debugger(void)
580 {
581     char cmdline[MAX_PATH];
582     PROCESS_INFORMATION pi;
583     STARTUPINFO si = { 0 };
584     DEBUG_EVENT de;
585     DWORD continuestatus;
586     PVOID code_mem_address = NULL;
587     NTSTATUS status;
588     SIZE_T size_read;
589     BOOL ret;
590     int counter = 0;
591     si.cb = sizeof(si);
592
593     if(!pNtGetContextThread || !pNtSetContextThread || !pNtReadVirtualMemory || !pNtTerminateProcess)
594     {
595         skip("NtGetContextThread, NtSetContextThread, NtReadVirtualMemory or NtTerminateProcess not found\n)");
596         return;
597     }
598
599     sprintf(cmdline, "%s %s %s", my_argv[0], my_argv[1], "debuggee");
600     ret = CreateProcess(NULL, cmdline, NULL, NULL, FALSE, DEBUG_PROCESS, NULL, NULL, &si, &pi);
601     ok(ret, "could not create child process error: %u\n", GetLastError());
602     if (!ret)
603         return;
604
605     do
606     {
607         continuestatus = DBG_CONTINUE;
608         ok(WaitForDebugEvent(&de, INFINITE), "reading debug event\n");
609
610         if (de.dwThreadId != pi.dwThreadId)
611         {
612             trace("event %d not coming from main thread, ignoring\n", de.dwDebugEventCode);
613             ContinueDebugEvent(de.dwProcessId, de.dwThreadId, DBG_CONTINUE);
614             continue;
615         }
616
617         if (de.dwDebugEventCode == CREATE_PROCESS_DEBUG_EVENT)
618         {
619             if(de.u.CreateProcessInfo.lpBaseOfImage != pNtCurrentTeb()->Peb->ImageBaseAddress)
620             {
621                 skip("child process loaded at different address, terminating it\n");
622                 pNtTerminateProcess(pi.hProcess, 1);
623             }
624         }
625         else if (de.dwDebugEventCode == EXCEPTION_DEBUG_EVENT)
626         {
627             CONTEXT ctx;
628             int stage;
629
630             counter++;
631             status = pNtReadVirtualMemory(pi.hProcess, &code_mem, &code_mem_address,
632                                           sizeof(code_mem_address), &size_read);
633             ok(!status,"NtReadVirtualMemory failed with 0x%x\n", status);
634             status = pNtReadVirtualMemory(pi.hProcess, &test_stage, &stage,
635                                           sizeof(stage), &size_read);
636             ok(!status,"NtReadVirtualMemory failed with 0x%x\n", status);
637
638             ctx.ContextFlags = CONTEXT_FULL;
639             status = pNtGetContextThread(pi.hThread, &ctx);
640             ok(!status, "NtGetContextThread failed with 0x%x\n", status);
641
642             trace("exception 0x%x at %p firstchance=%d Eip=0x%x, Eax=0x%x\n",
643                   de.u.Exception.ExceptionRecord.ExceptionCode,
644                   de.u.Exception.ExceptionRecord.ExceptionAddress, de.u.Exception.dwFirstChance, ctx.Eip, ctx.Eax);
645
646             if (counter > 100)
647             {
648                 ok(FALSE, "got way too many exceptions, probaby caught in a infinite loop, terminating child\n");
649                 pNtTerminateProcess(pi.hProcess, 1);
650             }
651             else if (counter >= 2) /* skip startup breakpoint */
652             {
653                 if (stage == 1)
654                 {
655                     ok((char *)ctx.Eip == (char *)code_mem_address + 0xb, "Eip at %x instead of %p\n",
656                        ctx.Eip, (char *)code_mem_address + 0xb);
657                     /* setting the context from debugger does not affect the context, the exception handlers gets */
658                     /* uncomment once wine is fixed */
659                     /* ctx.Eip = 0x12345; */
660                     ctx.Eax = 0xf00f00f1;
661
662                     /* let the debuggee handle the exception */
663                     continuestatus = DBG_EXCEPTION_NOT_HANDLED;
664                 }
665                 else if (stage == 2)
666                 {
667                     if (de.u.Exception.dwFirstChance)
668                     {
669                         /* debugger gets first chance exception with unmodified ctx.Eip */
670                         ok((char *)ctx.Eip == (char *)code_mem_address + 0xb, "Eip at 0x%x instead of %p\n",
671                             ctx.Eip, (char *)code_mem_address + 0xb);
672
673                         /* setting the context from debugger does not affect the context, the exception handlers gets */
674                         /* uncomment once wine is fixed */
675                         /* ctx.Eip = 0x12345; */
676                         ctx.Eax = 0xf00f00f1;
677
678                         /* pass exception to debuggee
679                          * exception will not be handled and
680                          * a second chance exception will be raised */
681                         continuestatus = DBG_EXCEPTION_NOT_HANDLED;
682                     }
683                     else
684                     {
685                         /* debugger gets context after exception handler has played with it */
686                         /* ctx.Eip is the same value the exception handler got */
687                         if (de.u.Exception.ExceptionRecord.ExceptionCode == EXCEPTION_BREAKPOINT)
688                         {
689                             ok((char *)ctx.Eip == (char *)code_mem_address + 0xa, "Eip at 0x%x instead of %p\n",
690                                 ctx.Eip, (char *)code_mem_address + 0xa);
691                             /* need to fixup Eip for debuggee */
692                             if ((char *)ctx.Eip == (char *)code_mem_address + 0xa)
693                                 ctx.Eip += 1;
694                         }
695                         else
696                             ok((char *)ctx.Eip == (char *)code_mem_address + 0xb, "Eip at 0x%x instead of %p\n",
697                                 ctx.Eip, (char *)code_mem_address + 0xb);
698                         /* here we handle exception */
699                     }
700                 }
701                 else
702                     ok(FALSE, "unexpected stage %d\n", stage);
703
704                 status = pNtSetContextThread(pi.hThread, &ctx);
705                 ok(!status, "NtSetContextThread failed with 0x%x\n", status);
706             }
707         }
708
709         ContinueDebugEvent(de.dwProcessId, de.dwThreadId, continuestatus);
710
711     } while (de.dwDebugEventCode != EXIT_PROCESS_DEBUG_EVENT);
712
713     ok(CloseHandle(pi.hThread) != 0, "error %u\n", GetLastError());
714     ok(CloseHandle(pi.hProcess) != 0, "error %u\n", GetLastError());
715
716     return;
717 }
718
719 static DWORD simd_fault_handler( EXCEPTION_RECORD *rec, EXCEPTION_REGISTRATION_RECORD *frame,
720                                  CONTEXT *context, EXCEPTION_REGISTRATION_RECORD **dispatcher )
721 {
722     int *stage = *(int **)(frame + 1);
723
724     got_exception++;
725
726     if( *stage == 1) {
727         /* fault while executing sse instruction */
728         context->Eip += 3; /* skip addps */
729         return ExceptionContinueExecution;
730     }
731
732     /* stage 2 - divide by zero fault */
733     if( rec->ExceptionCode == EXCEPTION_ILLEGAL_INSTRUCTION)
734         skip("system doesn't support SIMD exceptions\n");
735     else {
736         ok( rec->ExceptionCode ==  STATUS_FLOAT_MULTIPLE_TRAPS,
737             "exception code: %#x, should be %#x\n",
738             rec->ExceptionCode,  STATUS_FLOAT_MULTIPLE_TRAPS);
739         ok( rec->NumberParameters == 1, "# of params: %i, should be 1\n",
740             rec->NumberParameters);
741         if( rec->NumberParameters == 1 )
742             ok( rec->ExceptionInformation[0] == 0, "param #1: %lx, should be 0\n", rec->ExceptionInformation[0]);
743     }
744
745     context->Eip += 3; /* skip divps */
746
747     return ExceptionContinueExecution;
748 }
749
750 static const BYTE simd_exception_test[] = {
751     0x83, 0xec, 0x4,                     /* sub $0x4, %esp       */
752     0x0f, 0xae, 0x1c, 0x24,              /* stmxcsr (%esp)       */
753     0x66, 0x81, 0x24, 0x24, 0xff, 0xfd,  /* andw $0xfdff,(%esp)  * enable divide by */
754     0x0f, 0xae, 0x14, 0x24,              /* ldmxcsr (%esp)       * zero exceptions  */
755     0x6a, 0x01,                          /* push   $0x1          */
756     0x6a, 0x01,                          /* push   $0x1          */
757     0x6a, 0x01,                          /* push   $0x1          */
758     0x6a, 0x01,                          /* push   $0x1          */
759     0x0f, 0x10, 0x0c, 0x24,              /* movups (%esp),%xmm1  * fill dividend  */
760     0x0f, 0x57, 0xc0,                    /* xorps  %xmm0,%xmm0   * clear divisor  */
761     0x0f, 0x5e, 0xc8,                    /* divps  %xmm0,%xmm1   * generate fault */
762     0x83, 0xc4, 0x10,                    /* add    $0x10,%esp    */
763     0x66, 0x81, 0x0c, 0x24, 0x00, 0x02,  /* orw    $0x200,(%esp) * disable exceptions */
764     0x0f, 0xae, 0x14, 0x24,              /* ldmxcsr (%esp)       */
765     0x83, 0xc4, 0x04,                    /* add    $0x4,%esp     */
766     0xc3,                                /* ret */
767 };
768
769 static const BYTE sse_check[] = {
770     0x0f, 0x58, 0xc8,                    /* addps  %xmm0,%xmm1 */
771     0xc3,                                /* ret */
772 };
773
774 static void test_simd_exceptions(void)
775 {
776     int stage;
777
778     /* test if CPU & OS can do sse */
779     stage = 1;
780     got_exception = 0;
781     run_exception_test(simd_fault_handler, &stage, sse_check, sizeof(sse_check));
782     if(got_exception) {
783         skip("system doesn't support SSE\n");
784         return;
785     }
786
787     /* generate a SIMD exception */
788     stage = 2;
789     got_exception = 0;
790     run_exception_test(simd_fault_handler, &stage, simd_exception_test,
791                        sizeof(simd_exception_test));
792     ok( got_exception == 1, "got exception: %i, should be 1\n", got_exception);
793 }
794
795 #endif  /* __i386__ */
796
797 START_TEST(exception)
798 {
799 #ifdef __i386__
800     pNtCurrentTeb = (void *)GetProcAddress( GetModuleHandleA("ntdll.dll"), "NtCurrentTeb" );
801     pNtGetContextThread  = (void *)GetProcAddress( GetModuleHandleA("ntdll.dll"), "NtGetContextThread" );
802     pNtSetContextThread  = (void *)GetProcAddress( GetModuleHandleA("ntdll.dll"), "NtSetContextThread" );
803     pNtReadVirtualMemory = (void *)GetProcAddress( GetModuleHandleA("ntdll.dll"), "NtReadVirtualMemory" );
804     pRtlRaiseException   = (void *)GetProcAddress( GetModuleHandleA("ntdll.dll"), "RtlRaiseException" );
805     pNtTerminateProcess  = (void *)GetProcAddress( GetModuleHandleA("ntdll.dll"), "NtTerminateProcess" );
806     pRtlAddVectoredExceptionHandler    = (void *)GetProcAddress( GetModuleHandleA("ntdll.dll"),
807                                                                  "RtlAddVectoredExceptionHandler" );
808     pRtlRemoveVectoredExceptionHandler = (void *)GetProcAddress( GetModuleHandleA("ntdll.dll"),
809                                                                  "RtlRemoveVectoredExceptionHandler" );
810     if (!pNtCurrentTeb)
811     {
812         trace( "NtCurrentTeb not found, skipping tests\n" );
813         return;
814     }
815
816     if (pRtlAddVectoredExceptionHandler && pRtlRemoveVectoredExceptionHandler)
817         have_vectored_api = TRUE;
818     else
819         skip("RtlAddVectoredExceptionHandler or RtlRemoveVectoredExceptionHandler not found\n");
820
821     /* 1024 byte should be sufficient */
822     code_mem = VirtualAlloc(NULL, 1024, MEM_RESERVE | MEM_COMMIT, PAGE_EXECUTE_READWRITE);
823     if(!code_mem) {
824         trace("VirtualAlloc failed\n");
825         return;
826     }
827
828     my_argc = winetest_get_mainargs( &my_argv );
829     if (my_argc >= 3)
830     {
831         /* child must be run under a debugger */
832         if (!pNtCurrentTeb()->Peb->BeingDebugged)
833         {
834             ok(FALSE, "child process not being debugged?\n");
835             return;
836         }
837
838         if (pRtlRaiseException)
839         {
840             test_stage = 1;
841             run_rtlraiseexception_test(0x12345);
842             run_rtlraiseexception_test(EXCEPTION_BREAKPOINT);
843             run_rtlraiseexception_test(EXCEPTION_INVALID_HANDLE);
844             test_stage = 2;
845             run_rtlraiseexception_test(0x12345);
846             run_rtlraiseexception_test(EXCEPTION_BREAKPOINT);
847             run_rtlraiseexception_test(EXCEPTION_INVALID_HANDLE);
848         }
849         else
850             skip( "RtlRaiseException not found\n" );
851
852         /* rest of tests only run in parent */
853         return;
854     }
855
856     test_prot_fault();
857     test_exceptions();
858     test_rtlraiseexception();
859     test_debugger();
860     test_simd_exceptions();
861
862     VirtualFree(code_mem, 1024, MEM_RELEASE);
863 #endif
864 }