2 * Unit tests for the debugger facility
4 * Copyright (c) 2007 Francois Gouget for CodeWeavers
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.
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.
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
27 #include "wine/test.h"
29 #ifndef STATUS_DEBUGGER_INACTIVE
30 #define STATUS_DEBUGGER_INACTIVE ((NTSTATUS) 0xC0000354)
34 #define PRINTF_ATTR(fmt,args) __attribute__((format (printf,fmt,args)))
36 #define PRINTF_ATTR(fmt,args)
39 #define child_ok (winetest_set_location(__FILE__, __LINE__), 0) ? (void)0 : test_child_ok
44 static BOOL (WINAPI *pCheckRemoteDebuggerPresent)(HANDLE,PBOOL);
45 static BOOL (WINAPI *pDebugActiveProcessStop)(DWORD);
46 static BOOL (WINAPI *pDebugSetProcessKillOnExit)(BOOL);
47 static BOOL (WINAPI *pIsDebuggerPresent)(void);
48 static struct _TEB * (WINAPI *pNtCurrentTeb)(void);
50 static LONG child_failures;
52 static void PRINTF_ATTR(2, 3) test_child_ok(int condition, const char *msg, ...)
56 va_start(valist, msg);
57 winetest_vok(condition, msg, valist);
59 if (!condition) ++child_failures;
62 /* Copied from the process test */
63 static void get_file_name(char* buf)
68 GetTempPathA(sizeof(path), path);
69 GetTempFileNameA(path, "wt", 0, buf);
72 typedef struct tag_reg_save_value
80 static DWORD save_value(HKEY hkey, const char *value, reg_save_value *saved)
86 ret=RegQueryValueExA(hkey, value, NULL, &saved->type, NULL, &saved->size);
87 if (ret == ERROR_SUCCESS)
89 saved->data=HeapAlloc(GetProcessHeap(), 0, saved->size);
90 RegQueryValueExA(hkey, value, NULL, &saved->type, saved->data, &saved->size);
95 static void restore_value(HKEY hkey, reg_save_value *saved)
99 RegSetValueExA(hkey, saved->name, 0, saved->type, saved->data, saved->size);
100 HeapFree(GetProcessHeap(), 0, saved->data);
103 RegDeleteValueA(hkey, saved->name);
106 static void get_events(const char* name, HANDLE *start_event, HANDLE *done_event)
108 const char* basename;
111 basename=strrchr(name, '\\');
112 basename=(basename ? basename+1 : name);
113 event_name=HeapAlloc(GetProcessHeap(), 0, 6+strlen(basename)+1);
115 sprintf(event_name, "start_%s", basename);
116 *start_event=CreateEvent(NULL, 0,0, event_name);
117 sprintf(event_name, "done_%s", basename);
118 *done_event=CreateEvent(NULL, 0,0, event_name);
119 HeapFree(GetProcessHeap(), 0, event_name);
122 static void save_blackbox(const char* logfile, void* blackbox, int size)
127 hFile=CreateFileA(logfile, GENERIC_WRITE, 0, NULL, CREATE_ALWAYS, 0, 0);
128 if (hFile == INVALID_HANDLE_VALUE)
130 WriteFile(hFile, blackbox, size, &written, NULL);
134 static int load_blackbox(const char* logfile, void* blackbox, int size)
140 hFile=CreateFileA(logfile, GENERIC_READ, 0, NULL, OPEN_EXISTING, 0, 0);
141 if (hFile == INVALID_HANDLE_VALUE)
143 ok(0, "unable to open '%s'\n", logfile);
146 ret=ReadFile(hFile, blackbox, size, &read, NULL);
147 ok(read == size, "wrong size for '%s': read=%d\n", logfile, read);
157 static void doCrash(int argc, char** argv)
163 crash_blackbox_t blackbox;
164 blackbox.pid=GetCurrentProcessId();
165 save_blackbox(argv[3], &blackbox, sizeof(blackbox));
169 trace("child: crashing...\n");
186 } debugger_blackbox_t;
188 static void doDebugger(int argc, char** argv)
191 debugger_blackbox_t blackbox;
192 HANDLE start_event = 0, done_event = 0, debug_event;
195 logfile=(argc >= 4 ? argv[3] : NULL);
196 blackbox.pid=(argc >= 5 ? atol(argv[4]) : 0);
198 blackbox.attach_err=0;
199 if (strstr(myARGV[2], "attach"))
201 blackbox.attach_rc=DebugActiveProcess(blackbox.pid);
202 if (!blackbox.attach_rc)
203 blackbox.attach_err=GetLastError();
206 blackbox.attach_rc=TRUE;
208 debug_event=(argc >= 6 ? (HANDLE)(INT_PTR)atol(argv[5]) : NULL);
209 blackbox.debug_err=0;
210 if (debug_event && strstr(myARGV[2], "event"))
212 blackbox.debug_rc=SetEvent(debug_event);
213 if (!blackbox.debug_rc)
214 blackbox.debug_err=GetLastError();
217 blackbox.debug_rc=TRUE;
221 get_events(logfile, &start_event, &done_event);
224 if (strstr(myARGV[2], "order"))
226 trace("debugger: waiting for the start signal...\n");
227 WaitForSingleObject(start_event, INFINITE);
230 blackbox.nokill_err=0;
231 if (strstr(myARGV[2], "nokill"))
233 blackbox.nokill_rc=pDebugSetProcessKillOnExit(FALSE);
234 if (!blackbox.nokill_rc)
235 blackbox.nokill_err=GetLastError();
238 blackbox.nokill_rc=TRUE;
240 blackbox.detach_err=0;
241 if (strstr(myARGV[2], "detach"))
243 blackbox.detach_rc=pDebugActiveProcessStop(blackbox.pid);
244 if (!blackbox.detach_rc)
245 blackbox.detach_err=GetLastError();
248 blackbox.detach_rc=TRUE;
252 save_blackbox(logfile, &blackbox, sizeof(blackbox));
254 trace("debugger: done debugging...\n");
255 SetEvent(done_event);
257 /* Just exit with a known value */
258 ExitProcess(0xdeadbeef);
261 static void crash_and_debug(HKEY hkey, const char* argv0, const char* dbgtasks)
264 HANDLE start_event, done_event;
266 char dbglog[MAX_PATH];
267 char childlog[MAX_PATH];
268 PROCESS_INFORMATION info;
269 STARTUPINFOA startup;
271 crash_blackbox_t crash_blackbox;
272 debugger_blackbox_t dbg_blackbox;
274 ret=RegSetValueExA(hkey, "auto", 0, REG_SZ, (BYTE*)"1", 2);
275 ok(ret == ERROR_SUCCESS, "unable to set AeDebug/auto: ret=%d\n", ret);
277 get_file_name(dbglog);
278 get_events(dbglog, &start_event, &done_event);
279 cmd=HeapAlloc(GetProcessHeap(), 0, strlen(argv0)+10+strlen(dbgtasks)+1+strlen(dbglog)+34+1);
280 sprintf(cmd, "%s debugger %s %s %%ld %%ld", argv0, dbgtasks, dbglog);
281 ret=RegSetValueExA(hkey, "debugger", 0, REG_SZ, (BYTE*)cmd, strlen(cmd)+1);
282 ok(ret == ERROR_SUCCESS, "unable to set AeDebug/debugger: ret=%d\n", ret);
283 HeapFree(GetProcessHeap(), 0, cmd);
285 get_file_name(childlog);
286 cmd=HeapAlloc(GetProcessHeap(), 0, strlen(argv0)+16+strlen(dbglog)+1);
287 sprintf(cmd, "%s debugger crash %s", argv0, childlog);
289 memset(&startup, 0, sizeof(startup));
290 startup.cb = sizeof(startup);
291 startup.dwFlags = STARTF_USESHOWWINDOW;
292 startup.wShowWindow = SW_SHOWNORMAL;
293 ret=CreateProcessA(NULL, cmd, NULL, NULL, FALSE, 0, NULL, NULL, &startup, &info);
294 ok(ret, "CreateProcess: err=%d\n", GetLastError());
295 HeapFree(GetProcessHeap(), 0, cmd);
296 CloseHandle(info.hThread);
298 /* The process exits... */
299 trace("waiting for child exit...\n");
300 ok(WaitForSingleObject(info.hProcess, 60000) == WAIT_OBJECT_0, "Timed out waiting for the child to crash\n");
301 ok(GetExitCodeProcess(info.hProcess, &exit_code), "GetExitCodeProcess failed: err=%d\n", GetLastError());
302 if (strstr(dbgtasks, "code2"))
304 /* If, after attaching to the debuggee, the debugger exits without
305 * detaching, then the debuggee gets a special exit code.
307 ok(exit_code == STATUS_DEBUGGER_INACTIVE ||
308 broken(exit_code == STATUS_ACCESS_VIOLATION) || /* Intermittent Vista+ */
309 broken(exit_code == 0xffffffff) || /* Win9x */
310 broken(exit_code == WAIT_ABANDONED), /* NT4, W2K */
311 "wrong exit code : %08x\n", exit_code);
314 ok(exit_code == STATUS_ACCESS_VIOLATION ||
315 broken(exit_code == WAIT_ABANDONED) || /* NT4, W2K, W2K3 */
316 broken(exit_code == 0xffffffff), /* Win9x, WinME */
317 "wrong exit code : %08x\n", exit_code);
318 CloseHandle(info.hProcess);
320 /* ...before the debugger */
321 if (strstr(dbgtasks, "order"))
322 ok(SetEvent(start_event), "SetEvent(start_event) failed\n");
324 trace("waiting for the debugger...\n");
325 ok(WaitForSingleObject(done_event, 60000) == WAIT_OBJECT_0, "Timed out waiting for the debugger\n");
327 assert(load_blackbox(childlog, &crash_blackbox, sizeof(crash_blackbox)));
328 assert(load_blackbox(dbglog, &dbg_blackbox, sizeof(dbg_blackbox)));
330 ok(dbg_blackbox.argc == 6, "wrong debugger argument count: %d\n", dbg_blackbox.argc);
331 ok(dbg_blackbox.pid == crash_blackbox.pid, "the child and debugged pids don't match: %d != %d\n", crash_blackbox.pid, dbg_blackbox.pid);
332 ok(dbg_blackbox.debug_rc, "debugger: SetEvent(debug_event) failed err=%d\n", dbg_blackbox.debug_err);
333 ok(dbg_blackbox.attach_rc, "DebugActiveProcess(%d) failed err=%d\n", dbg_blackbox.pid, dbg_blackbox.attach_err);
334 ok(dbg_blackbox.nokill_rc, "DebugSetProcessKillOnExit(FALSE) failed err=%d\n", dbg_blackbox.nokill_err);
335 ok(dbg_blackbox.detach_rc, "DebugActiveProcessStop(%d) failed err=%d\n", dbg_blackbox.pid, dbg_blackbox.detach_err);
337 assert(DeleteFileA(dbglog) != 0);
338 assert(DeleteFileA(childlog) != 0);
341 static void crash_and_winedbg(HKEY hkey, const char* argv0)
345 PROCESS_INFORMATION info;
346 STARTUPINFOA startup;
349 ret=RegSetValueExA(hkey, "auto", 0, REG_SZ, (BYTE*)"1", 2);
350 ok(ret == ERROR_SUCCESS, "unable to set AeDebug/auto: ret=%d\n", ret);
352 cmd=HeapAlloc(GetProcessHeap(), 0, strlen(argv0)+15+1);
353 sprintf(cmd, "%s debugger crash", argv0);
355 memset(&startup, 0, sizeof(startup));
356 startup.cb = sizeof(startup);
357 startup.dwFlags = STARTF_USESHOWWINDOW;
358 startup.wShowWindow = SW_SHOWNORMAL;
359 ret=CreateProcessA(NULL, cmd, NULL, NULL, FALSE, 0, NULL, NULL, &startup, &info);
360 ok(ret, "CreateProcess: err=%d\n", GetLastError());
361 HeapFree(GetProcessHeap(), 0, cmd);
362 CloseHandle(info.hThread);
364 trace("waiting for child exit...\n");
365 ok(WaitForSingleObject(info.hProcess, 60000) == WAIT_OBJECT_0, "Timed out waiting for the child to crash\n");
366 ok(GetExitCodeProcess(info.hProcess, &exit_code), "GetExitCodeProcess failed: err=%d\n", GetLastError());
367 ok(exit_code == STATUS_ACCESS_VIOLATION, "exit code = %08x\n", exit_code);
368 CloseHandle(info.hProcess);
371 static void test_ExitCode(void)
373 static const char* AeDebug="Software\\Microsoft\\Windows NT\\CurrentVersion\\AeDebug";
374 static const char* WineDbg="Software\\Wine\\WineDbg";
375 char test_exe[MAX_PATH];
379 reg_save_value auto_value;
380 reg_save_value debugger_value;
382 GetModuleFileNameA(GetModuleHandle(NULL), test_exe, sizeof(test_exe));
383 if (GetFileAttributes(test_exe) == INVALID_FILE_ATTRIBUTES)
384 strcat(test_exe, ".so");
385 if (GetFileAttributesA(test_exe) == INVALID_FILE_ATTRIBUTES)
387 ok(0, "could not find the test executable '%s'\n", test_exe);
391 ret=RegCreateKeyExA(HKEY_LOCAL_MACHINE, AeDebug, 0, NULL, REG_OPTION_NON_VOLATILE, KEY_ALL_ACCESS, NULL, &hkey, &disposition);
392 if (ret == ERROR_SUCCESS)
394 save_value(hkey, "auto", &auto_value);
395 save_value(hkey, "debugger", &debugger_value);
396 trace("HKLM\\%s\\debugger is set to '%s'\n", AeDebug, debugger_value.data);
398 else if (ret == ERROR_ACCESS_DENIED)
400 skip("not enough privileges to change the debugger\n");
403 else if (ret != ERROR_FILE_NOT_FOUND)
405 ok(0, "could not open the AeDebug key: %d\n", ret);
409 if (debugger_value.data && debugger_value.type == REG_SZ &&
410 strstr((char*)debugger_value.data, "winedbg --auto"))
413 ret=RegCreateKeyA(HKEY_CURRENT_USER, WineDbg, &hkeyWinedbg);
414 if (ret == ERROR_SUCCESS)
417 reg_save_value crash_dlg_value;
418 save_value(hkeyWinedbg, "ShowCrashDialog", &crash_dlg_value);
419 RegSetValueExA(hkeyWinedbg, "ShowCrashDialog", 0, REG_DWORD, (BYTE *)&zero, sizeof(DWORD));
420 crash_and_winedbg(hkey, test_exe);
421 restore_value(hkeyWinedbg, &crash_dlg_value);
422 RegCloseKey(hkeyWinedbg);
425 ok(0, "Couldn't access WineDbg Key - error %u\n", ret);
428 if (winetest_interactive)
429 /* Since the debugging process never sets the debug event, it isn't recognized
430 as a valid debugger and, after the debugger exits, Windows will show a dialog box
431 asking the user what to do */
432 crash_and_debug(hkey, test_exe, "dbg,none");
434 skip("\"none\" debugger test needs user interaction\n");
435 if (disposition == REG_CREATED_NEW_KEY)
436 win_skip("'dbg,event,order' test doesn't finish on Win9x/WinMe\n");
438 crash_and_debug(hkey, test_exe, "dbg,event,order");
439 crash_and_debug(hkey, test_exe, "dbg,attach,event,code2");
440 if (pDebugSetProcessKillOnExit)
441 crash_and_debug(hkey, test_exe, "dbg,attach,event,nokill");
443 win_skip("DebugSetProcessKillOnExit is not available\n");
444 if (pDebugActiveProcessStop)
445 crash_and_debug(hkey, test_exe, "dbg,attach,event,detach");
447 win_skip("DebugActiveProcessStop is not available\n");
449 if (disposition == REG_CREATED_NEW_KEY)
452 RegDeleteKeyA(HKEY_LOCAL_MACHINE, AeDebug);
456 restore_value(hkey, &auto_value);
457 restore_value(hkey, &debugger_value);
462 static void test_RemoteDebugger(void)
465 if(!pCheckRemoteDebuggerPresent)
467 win_skip("CheckRemoteDebuggerPresent is not available\n");
471 SetLastError(0xdeadbeef);
472 bret = pCheckRemoteDebuggerPresent(GetCurrentProcess(),&present);
473 ok(bret , "expected CheckRemoteDebuggerPresent to succeed\n");
474 ok(0xdeadbeef == GetLastError(),
475 "expected error to be unchanged, got %d/%x\n",GetLastError(), GetLastError());
478 SetLastError(0xdeadbeef);
479 bret = pCheckRemoteDebuggerPresent(NULL,&present);
480 ok(!bret , "expected CheckRemoteDebuggerPresent to fail\n");
481 ok(present, "expected parameter to be unchanged\n");
482 ok(ERROR_INVALID_PARAMETER == GetLastError(),
483 "expected error ERROR_INVALID_PARAMETER, got %d/%x\n",GetLastError(), GetLastError());
485 SetLastError(0xdeadbeef);
486 bret = pCheckRemoteDebuggerPresent(GetCurrentProcess(),NULL);
487 ok(!bret , "expected CheckRemoteDebuggerPresent to fail\n");
488 ok(ERROR_INVALID_PARAMETER == GetLastError(),
489 "expected error ERROR_INVALID_PARAMETER, got %d/%x\n",GetLastError(), GetLastError());
492 struct child_blackbox
497 static void doChild(int argc, char **argv)
499 struct child_blackbox blackbox;
500 const char *blackbox_file;
506 blackbox_file = argv[4];
507 sscanf(argv[3], "%08x", &ppid);
509 parent = OpenProcess(PROCESS_QUERY_INFORMATION, FALSE, ppid);
510 child_ok(!!parent, "OpenProcess failed, last error %#x.\n", GetLastError());
512 ret = pCheckRemoteDebuggerPresent(parent, &debug);
513 child_ok(ret, "CheckRemoteDebuggerPresent failed, last error %#x.\n", GetLastError());
514 child_ok(!debug, "Expected debug == 0, got %#x.\n", debug);
516 ret = DebugActiveProcess(ppid);
517 child_ok(ret, "DebugActiveProcess failed, last error %#x.\n", GetLastError());
519 ret = pCheckRemoteDebuggerPresent(parent, &debug);
520 child_ok(ret, "CheckRemoteDebuggerPresent failed, last error %#x.\n", GetLastError());
521 child_ok(debug, "Expected debug != 0, got %#x.\n", debug);
523 ret = pDebugActiveProcessStop(ppid);
524 child_ok(ret, "DebugActiveProcessStop failed, last error %#x.\n", GetLastError());
526 ret = pCheckRemoteDebuggerPresent(parent, &debug);
527 child_ok(ret, "CheckRemoteDebuggerPresent failed, last error %#x.\n", GetLastError());
528 child_ok(!debug, "Expected debug == 0, got %#x.\n", debug);
530 ret = CloseHandle(parent);
531 child_ok(ret, "CloseHandle failed, last error %#x.\n", GetLastError());
533 ret = pIsDebuggerPresent();
534 child_ok(ret, "Expected ret != 0, got %#x.\n", ret);
535 ret = pCheckRemoteDebuggerPresent(GetCurrentProcess(), &debug);
536 child_ok(ret, "CheckRemoteDebuggerPresent failed, last error %#x.\n", GetLastError());
537 child_ok(debug, "Expected debug != 0, got %#x.\n", debug);
541 pNtCurrentTeb()->Peb->BeingDebugged = FALSE;
543 ret = pIsDebuggerPresent();
544 child_ok(!ret, "Expected ret != 0, got %#x.\n", ret);
545 ret = pCheckRemoteDebuggerPresent(GetCurrentProcess(), &debug);
546 child_ok(ret, "CheckRemoteDebuggerPresent failed, last error %#x.\n", GetLastError());
547 child_ok(debug, "Expected debug != 0, got %#x.\n", debug);
549 pNtCurrentTeb()->Peb->BeingDebugged = TRUE;
552 blackbox.failures = child_failures;
553 save_blackbox(blackbox_file, &blackbox, sizeof(blackbox));
556 static void test_debug_loop(int argc, char **argv)
558 const char *arguments = " debugger child ";
559 struct child_blackbox blackbox;
560 char blackbox_file[MAX_PATH];
561 PROCESS_INFORMATION pi;
568 if (!pDebugActiveProcessStop || !pCheckRemoteDebuggerPresent)
570 win_skip("DebugActiveProcessStop or CheckRemoteDebuggerPresent not available, skipping test.\n");
574 pid = GetCurrentProcessId();
575 ret = DebugActiveProcess(pid);
576 ok(!ret, "DebugActiveProcess() succeeded on own process.\n");
578 get_file_name(blackbox_file);
579 cmd = HeapAlloc(GetProcessHeap(), 0, strlen(argv[0]) + strlen(arguments) + strlen(blackbox_file) + 10);
580 sprintf(cmd, "%s%s%08x %s", argv[0], arguments, pid, blackbox_file);
582 memset(&si, 0, sizeof(si));
584 ret = CreateProcessA(NULL, cmd, NULL, NULL, FALSE, DEBUG_PROCESS, NULL, NULL, &si, &pi);
585 ok(ret, "CreateProcess failed, last error %#x.\n", GetLastError());
587 HeapFree(GetProcessHeap(), 0, cmd);
589 ret = pCheckRemoteDebuggerPresent(pi.hProcess, &debug);
590 ok(ret, "CheckRemoteDebuggerPresent failed, last error %#x.\n", GetLastError());
591 ok(debug, "Expected debug != 0, got %#x.\n", debug);
597 ret = WaitForDebugEvent(&ev, INFINITE);
598 ok(ret, "WaitForDebugEvent failed, last error %#x.\n", GetLastError());
601 if (ev.dwDebugEventCode == EXIT_PROCESS_DEBUG_EVENT) break;
603 ret = ContinueDebugEvent(ev.dwProcessId, ev.dwThreadId, DBG_CONTINUE);
604 ok(ret, "ContinueDebugEvent failed, last error %#x.\n", GetLastError());
608 ret = CloseHandle(pi.hThread);
609 ok(ret, "CloseHandle failed, last error %#x.\n", GetLastError());
610 ret = CloseHandle(pi.hProcess);
611 ok(ret, "CloseHandle failed, last error %#x.\n", GetLastError());
613 load_blackbox(blackbox_file, &blackbox, sizeof(blackbox));
614 ok(!blackbox.failures, "Got %d failures from child process.\n", blackbox.failures);
616 ret = DeleteFileA(blackbox_file);
617 ok(ret, "DeleteFileA failed, last error %#x.\n", GetLastError());
624 hdll=GetModuleHandle("kernel32.dll");
625 pCheckRemoteDebuggerPresent=(void*)GetProcAddress(hdll, "CheckRemoteDebuggerPresent");
626 pDebugActiveProcessStop=(void*)GetProcAddress(hdll, "DebugActiveProcessStop");
627 pDebugSetProcessKillOnExit=(void*)GetProcAddress(hdll, "DebugSetProcessKillOnExit");
628 pIsDebuggerPresent=(void*)GetProcAddress(hdll, "IsDebuggerPresent");
629 hdll=GetModuleHandle("ntdll.dll");
630 if (hdll) pNtCurrentTeb = (void*)GetProcAddress(hdll, "NtCurrentTeb");
632 myARGC=winetest_get_mainargs(&myARGV);
633 if (myARGC >= 3 && strcmp(myARGV[2], "crash") == 0)
635 doCrash(myARGC, myARGV);
637 else if (myARGC >= 3 && strncmp(myARGV[2], "dbg,", 4) == 0)
639 doDebugger(myARGC, myARGV);
641 else if (myARGC >= 5 && !strcmp(myARGV[2], "child"))
643 doChild(myARGC, myARGV);
648 test_RemoteDebugger();
649 test_debug_loop(myARGC, myARGV);