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 struct _TEB * (WINAPI *pNtCurrentTeb)(void);
49 static LONG child_failures;
51 static void PRINTF_ATTR(2, 3) test_child_ok(int condition, const char *msg, ...)
55 va_start(valist, msg);
56 winetest_vok(condition, msg, valist);
58 if (!condition) ++child_failures;
61 /* Copied from the process test */
62 static void get_file_name(char* buf)
67 GetTempPathA(sizeof(path), path);
68 GetTempFileNameA(path, "wt", 0, buf);
71 typedef struct tag_reg_save_value
79 static DWORD save_value(HKEY hkey, const char *value, reg_save_value *saved)
85 ret=RegQueryValueExA(hkey, value, NULL, &saved->type, NULL, &saved->size);
86 if (ret == ERROR_SUCCESS)
88 saved->data=HeapAlloc(GetProcessHeap(), 0, saved->size);
89 RegQueryValueExA(hkey, value, NULL, &saved->type, saved->data, &saved->size);
94 static void restore_value(HKEY hkey, reg_save_value *saved)
98 RegSetValueExA(hkey, saved->name, 0, saved->type, saved->data, saved->size);
99 HeapFree(GetProcessHeap(), 0, saved->data);
102 RegDeleteValueA(hkey, saved->name);
105 static void get_events(const char* name, HANDLE *start_event, HANDLE *done_event)
107 const char* basename;
110 basename=strrchr(name, '\\');
111 basename=(basename ? basename+1 : name);
112 event_name=HeapAlloc(GetProcessHeap(), 0, 6+strlen(basename)+1);
114 sprintf(event_name, "start_%s", basename);
115 *start_event=CreateEvent(NULL, 0,0, event_name);
116 sprintf(event_name, "done_%s", basename);
117 *done_event=CreateEvent(NULL, 0,0, event_name);
118 HeapFree(GetProcessHeap(), 0, event_name);
121 static void save_blackbox(const char* logfile, void* blackbox, int size)
126 hFile=CreateFileA(logfile, GENERIC_WRITE, 0, NULL, CREATE_ALWAYS, 0, 0);
127 if (hFile == INVALID_HANDLE_VALUE)
129 WriteFile(hFile, blackbox, size, &written, NULL);
133 static int load_blackbox(const char* logfile, void* blackbox, int size)
139 hFile=CreateFileA(logfile, GENERIC_READ, 0, NULL, OPEN_EXISTING, 0, 0);
140 if (hFile == INVALID_HANDLE_VALUE)
142 ok(0, "unable to open '%s'\n", logfile);
145 ret=ReadFile(hFile, blackbox, size, &read, NULL);
146 ok(read == size, "wrong size for '%s': read=%d\n", logfile, read);
156 static void doCrash(int argc, char** argv)
162 crash_blackbox_t blackbox;
163 blackbox.pid=GetCurrentProcessId();
164 save_blackbox(argv[3], &blackbox, sizeof(blackbox));
168 trace("child: crashing...\n");
185 } debugger_blackbox_t;
187 static void doDebugger(int argc, char** argv)
190 debugger_blackbox_t blackbox;
191 HANDLE start_event = 0, done_event = 0, debug_event;
194 logfile=(argc >= 4 ? argv[3] : NULL);
195 blackbox.pid=(argc >= 5 ? atol(argv[4]) : 0);
197 blackbox.attach_err=0;
198 if (strstr(myARGV[2], "attach"))
200 blackbox.attach_rc=DebugActiveProcess(blackbox.pid);
201 if (!blackbox.attach_rc)
202 blackbox.attach_err=GetLastError();
205 blackbox.attach_rc=TRUE;
207 debug_event=(argc >= 6 ? (HANDLE)(INT_PTR)atol(argv[5]) : NULL);
208 blackbox.debug_err=0;
209 if (debug_event && strstr(myARGV[2], "event"))
211 blackbox.debug_rc=SetEvent(debug_event);
212 if (!blackbox.debug_rc)
213 blackbox.debug_err=GetLastError();
216 blackbox.debug_rc=TRUE;
220 get_events(logfile, &start_event, &done_event);
223 if (strstr(myARGV[2], "order"))
225 trace("debugger: waiting for the start signal...\n");
226 WaitForSingleObject(start_event, INFINITE);
229 blackbox.nokill_err=0;
230 if (strstr(myARGV[2], "nokill"))
232 blackbox.nokill_rc=pDebugSetProcessKillOnExit(FALSE);
233 if (!blackbox.nokill_rc)
234 blackbox.nokill_err=GetLastError();
237 blackbox.nokill_rc=TRUE;
239 blackbox.detach_err=0;
240 if (strstr(myARGV[2], "detach"))
242 blackbox.detach_rc=pDebugActiveProcessStop(blackbox.pid);
243 if (!blackbox.detach_rc)
244 blackbox.detach_err=GetLastError();
247 blackbox.detach_rc=TRUE;
251 save_blackbox(logfile, &blackbox, sizeof(blackbox));
253 trace("debugger: done debugging...\n");
254 SetEvent(done_event);
256 /* Just exit with a known value */
257 ExitProcess(0xdeadbeef);
260 static void crash_and_debug(HKEY hkey, const char* argv0, const char* dbgtasks)
263 HANDLE start_event, done_event;
265 char dbglog[MAX_PATH];
266 char childlog[MAX_PATH];
267 PROCESS_INFORMATION info;
268 STARTUPINFOA startup;
270 crash_blackbox_t crash_blackbox;
271 debugger_blackbox_t dbg_blackbox;
273 ret=RegSetValueExA(hkey, "auto", 0, REG_SZ, (BYTE*)"1", 2);
274 ok(ret == ERROR_SUCCESS, "unable to set AeDebug/auto: ret=%d\n", ret);
276 get_file_name(dbglog);
277 get_events(dbglog, &start_event, &done_event);
278 cmd=HeapAlloc(GetProcessHeap(), 0, strlen(argv0)+10+strlen(dbgtasks)+1+strlen(dbglog)+34+1);
279 sprintf(cmd, "%s debugger %s %s %%ld %%ld", argv0, dbgtasks, dbglog);
280 ret=RegSetValueExA(hkey, "debugger", 0, REG_SZ, (BYTE*)cmd, strlen(cmd)+1);
281 ok(ret == ERROR_SUCCESS, "unable to set AeDebug/debugger: ret=%d\n", ret);
282 HeapFree(GetProcessHeap(), 0, cmd);
284 get_file_name(childlog);
285 cmd=HeapAlloc(GetProcessHeap(), 0, strlen(argv0)+16+strlen(dbglog)+1);
286 sprintf(cmd, "%s debugger crash %s", argv0, childlog);
288 memset(&startup, 0, sizeof(startup));
289 startup.cb = sizeof(startup);
290 startup.dwFlags = STARTF_USESHOWWINDOW;
291 startup.wShowWindow = SW_SHOWNORMAL;
292 ret=CreateProcessA(NULL, cmd, NULL, NULL, FALSE, 0, NULL, NULL, &startup, &info);
293 ok(ret, "CreateProcess: err=%d\n", GetLastError());
294 HeapFree(GetProcessHeap(), 0, cmd);
295 CloseHandle(info.hThread);
297 /* The process exits... */
298 trace("waiting for child exit...\n");
299 ok(WaitForSingleObject(info.hProcess, 60000) == WAIT_OBJECT_0, "Timed out waiting for the child to crash\n");
300 ok(GetExitCodeProcess(info.hProcess, &exit_code), "GetExitCodeProcess failed: err=%d\n", GetLastError());
301 if (strstr(dbgtasks, "code2"))
303 /* If, after attaching to the debuggee, the debugger exits without
304 * detaching, then the debuggee gets a special exit code.
306 ok(exit_code == STATUS_DEBUGGER_INACTIVE ||
307 broken(exit_code == STATUS_ACCESS_VIOLATION) || /* Intermittent Vista+ */
308 broken(exit_code == 0xffffffff) || /* Win9x */
309 broken(exit_code == WAIT_ABANDONED), /* NT4, W2K */
310 "wrong exit code : %08x\n", exit_code);
313 ok(exit_code == STATUS_ACCESS_VIOLATION ||
314 broken(exit_code == WAIT_ABANDONED) || /* NT4, W2K, W2K3 */
315 broken(exit_code == 0xffffffff), /* Win9x, WinME */
316 "wrong exit code : %08x\n", exit_code);
317 CloseHandle(info.hProcess);
319 /* ...before the debugger */
320 if (strstr(dbgtasks, "order"))
321 ok(SetEvent(start_event), "SetEvent(start_event) failed\n");
323 trace("waiting for the debugger...\n");
324 ok(WaitForSingleObject(done_event, 60000) == WAIT_OBJECT_0, "Timed out waiting for the debugger\n");
326 assert(load_blackbox(childlog, &crash_blackbox, sizeof(crash_blackbox)));
327 assert(load_blackbox(dbglog, &dbg_blackbox, sizeof(dbg_blackbox)));
329 ok(dbg_blackbox.argc == 6, "wrong debugger argument count: %d\n", dbg_blackbox.argc);
330 ok(dbg_blackbox.pid == crash_blackbox.pid, "the child and debugged pids don't match: %d != %d\n", crash_blackbox.pid, dbg_blackbox.pid);
331 ok(dbg_blackbox.debug_rc, "debugger: SetEvent(debug_event) failed err=%d\n", dbg_blackbox.debug_err);
332 ok(dbg_blackbox.attach_rc, "DebugActiveProcess(%d) failed err=%d\n", dbg_blackbox.pid, dbg_blackbox.attach_err);
333 ok(dbg_blackbox.nokill_rc, "DebugSetProcessKillOnExit(FALSE) failed err=%d\n", dbg_blackbox.nokill_err);
334 ok(dbg_blackbox.detach_rc, "DebugActiveProcessStop(%d) failed err=%d\n", dbg_blackbox.pid, dbg_blackbox.detach_err);
336 assert(DeleteFileA(dbglog) != 0);
337 assert(DeleteFileA(childlog) != 0);
340 static void crash_and_winedbg(HKEY hkey, const char* argv0)
344 PROCESS_INFORMATION info;
345 STARTUPINFOA startup;
348 ret=RegSetValueExA(hkey, "auto", 0, REG_SZ, (BYTE*)"1", 2);
349 ok(ret == ERROR_SUCCESS, "unable to set AeDebug/auto: ret=%d\n", ret);
351 cmd=HeapAlloc(GetProcessHeap(), 0, strlen(argv0)+15+1);
352 sprintf(cmd, "%s debugger crash", argv0);
354 memset(&startup, 0, sizeof(startup));
355 startup.cb = sizeof(startup);
356 startup.dwFlags = STARTF_USESHOWWINDOW;
357 startup.wShowWindow = SW_SHOWNORMAL;
358 ret=CreateProcessA(NULL, cmd, NULL, NULL, FALSE, 0, NULL, NULL, &startup, &info);
359 ok(ret, "CreateProcess: err=%d\n", GetLastError());
360 HeapFree(GetProcessHeap(), 0, cmd);
361 CloseHandle(info.hThread);
363 trace("waiting for child exit...\n");
364 ok(WaitForSingleObject(info.hProcess, 60000) == WAIT_OBJECT_0, "Timed out waiting for the child to crash\n");
365 ok(GetExitCodeProcess(info.hProcess, &exit_code), "GetExitCodeProcess failed: err=%d\n", GetLastError());
366 ok(exit_code == STATUS_ACCESS_VIOLATION, "exit code = %08x\n", exit_code);
367 CloseHandle(info.hProcess);
370 static void test_ExitCode(void)
372 static const char* AeDebug="Software\\Microsoft\\Windows NT\\CurrentVersion\\AeDebug";
373 static const char* WineDbg="Software\\Wine\\WineDbg";
374 char test_exe[MAX_PATH];
378 reg_save_value auto_value;
379 reg_save_value debugger_value;
381 GetModuleFileNameA(GetModuleHandle(NULL), test_exe, sizeof(test_exe));
382 if (GetFileAttributes(test_exe) == INVALID_FILE_ATTRIBUTES)
383 strcat(test_exe, ".so");
384 if (GetFileAttributesA(test_exe) == INVALID_FILE_ATTRIBUTES)
386 ok(0, "could not find the test executable '%s'\n", test_exe);
390 ret=RegCreateKeyExA(HKEY_LOCAL_MACHINE, AeDebug, 0, NULL, REG_OPTION_NON_VOLATILE, KEY_ALL_ACCESS, NULL, &hkey, &disposition);
391 if (ret == ERROR_SUCCESS)
393 save_value(hkey, "auto", &auto_value);
394 save_value(hkey, "debugger", &debugger_value);
395 trace("HKLM\\%s\\debugger is set to '%s'\n", AeDebug, debugger_value.data);
397 else if (ret == ERROR_ACCESS_DENIED)
399 skip("not enough privileges to change the debugger\n");
402 else if (ret != ERROR_FILE_NOT_FOUND)
404 ok(0, "could not open the AeDebug key: %d\n", ret);
408 if (debugger_value.data && debugger_value.type == REG_SZ &&
409 strstr((char*)debugger_value.data, "winedbg --auto"))
412 ret=RegCreateKeyA(HKEY_CURRENT_USER, WineDbg, &hkeyWinedbg);
413 if (ret == ERROR_SUCCESS)
416 reg_save_value crash_dlg_value;
417 save_value(hkeyWinedbg, "ShowCrashDialog", &crash_dlg_value);
418 RegSetValueExA(hkeyWinedbg, "ShowCrashDialog", 0, REG_DWORD, (BYTE *)&zero, sizeof(DWORD));
419 crash_and_winedbg(hkey, test_exe);
420 restore_value(hkeyWinedbg, &crash_dlg_value);
421 RegCloseKey(hkeyWinedbg);
424 ok(0, "Couldn't access WineDbg Key - error %u\n", ret);
427 if (winetest_interactive)
428 /* Since the debugging process never sets the debug event, it isn't recognized
429 as a valid debugger and, after the debugger exits, Windows will show a dialog box
430 asking the user what to do */
431 crash_and_debug(hkey, test_exe, "dbg,none");
433 skip("\"none\" debugger test needs user interaction\n");
434 if (disposition == REG_CREATED_NEW_KEY)
435 win_skip("'dbg,event,order' test doesn't finish on Win9x/WinMe\n");
437 crash_and_debug(hkey, test_exe, "dbg,event,order");
438 crash_and_debug(hkey, test_exe, "dbg,attach,event,code2");
439 if (pDebugSetProcessKillOnExit)
440 crash_and_debug(hkey, test_exe, "dbg,attach,event,nokill");
442 win_skip("DebugSetProcessKillOnExit is not available\n");
443 if (pDebugActiveProcessStop)
444 crash_and_debug(hkey, test_exe, "dbg,attach,event,detach");
446 win_skip("DebugActiveProcessStop is not available\n");
448 if (disposition == REG_CREATED_NEW_KEY)
451 RegDeleteKeyA(HKEY_LOCAL_MACHINE, AeDebug);
455 restore_value(hkey, &auto_value);
456 restore_value(hkey, &debugger_value);
461 static void test_RemoteDebugger(void)
464 if(!pCheckRemoteDebuggerPresent)
466 win_skip("CheckRemoteDebuggerPresent is not available\n");
470 SetLastError(0xdeadbeef);
471 bret = pCheckRemoteDebuggerPresent(GetCurrentProcess(),&present);
472 ok(bret , "expected CheckRemoteDebuggerPresent to succeed\n");
473 ok(0xdeadbeef == GetLastError(),
474 "expected error to be unchanged, got %d/%x\n",GetLastError(), GetLastError());
477 SetLastError(0xdeadbeef);
478 bret = pCheckRemoteDebuggerPresent(NULL,&present);
479 ok(!bret , "expected CheckRemoteDebuggerPresent to fail\n");
480 ok(present, "expected parameter to be unchanged\n");
481 ok(ERROR_INVALID_PARAMETER == GetLastError(),
482 "expected error ERROR_INVALID_PARAMETER, got %d/%x\n",GetLastError(), GetLastError());
484 SetLastError(0xdeadbeef);
485 bret = pCheckRemoteDebuggerPresent(GetCurrentProcess(),NULL);
486 ok(!bret , "expected CheckRemoteDebuggerPresent to fail\n");
487 ok(ERROR_INVALID_PARAMETER == GetLastError(),
488 "expected error ERROR_INVALID_PARAMETER, got %d/%x\n",GetLastError(), GetLastError());
491 struct child_blackbox
496 static void doChild(int argc, char **argv)
498 struct child_blackbox blackbox;
499 const char *blackbox_file;
505 blackbox_file = argv[4];
506 sscanf(argv[3], "%08x", &ppid);
508 parent = OpenProcess(PROCESS_QUERY_INFORMATION, FALSE, ppid);
509 child_ok(!!parent, "OpenProcess failed, last error %#x.\n", GetLastError());
511 ret = pCheckRemoteDebuggerPresent(parent, &debug);
512 child_ok(ret, "CheckRemoteDebuggerPresent failed, last error %#x.\n", GetLastError());
513 child_ok(!debug, "Expected debug == 0, got %#x.\n", debug);
515 ret = DebugActiveProcess(ppid);
516 child_ok(ret, "DebugActiveProcess failed, last error %#x.\n", GetLastError());
518 ret = pCheckRemoteDebuggerPresent(parent, &debug);
519 child_ok(ret, "CheckRemoteDebuggerPresent failed, last error %#x.\n", GetLastError());
520 child_ok(debug, "Expected debug != 0, got %#x.\n", debug);
522 ret = pDebugActiveProcessStop(ppid);
523 child_ok(ret, "DebugActiveProcessStop failed, last error %#x.\n", GetLastError());
525 ret = pCheckRemoteDebuggerPresent(parent, &debug);
526 child_ok(ret, "CheckRemoteDebuggerPresent failed, last error %#x.\n", GetLastError());
527 child_ok(!debug, "Expected debug == 0, got %#x.\n", debug);
529 ret = CloseHandle(parent);
530 child_ok(ret, "CloseHandle failed, last error %#x.\n", GetLastError());
532 ret = IsDebuggerPresent();
533 child_ok(ret, "Expected ret != 0, got %#x.\n", ret);
534 ret = pCheckRemoteDebuggerPresent(GetCurrentProcess(), &debug);
535 child_ok(ret, "CheckRemoteDebuggerPresent failed, last error %#x.\n", GetLastError());
536 child_ok(debug, "Expected debug != 0, got %#x.\n", debug);
540 pNtCurrentTeb()->Peb->BeingDebugged = FALSE;
542 ret = IsDebuggerPresent();
543 child_ok(!ret, "Expected ret != 0, got %#x.\n", ret);
544 ret = pCheckRemoteDebuggerPresent(GetCurrentProcess(), &debug);
545 child_ok(ret, "CheckRemoteDebuggerPresent failed, last error %#x.\n", GetLastError());
546 child_ok(debug, "Expected debug != 0, got %#x.\n", debug);
548 pNtCurrentTeb()->Peb->BeingDebugged = TRUE;
551 blackbox.failures = child_failures;
552 save_blackbox(blackbox_file, &blackbox, sizeof(blackbox));
555 static void test_debug_loop(int argc, char **argv)
557 const char *arguments = " debugger child ";
558 struct child_blackbox blackbox;
559 char blackbox_file[MAX_PATH];
560 PROCESS_INFORMATION pi;
567 if (!pDebugActiveProcessStop || !pCheckRemoteDebuggerPresent)
569 win_skip("DebugActiveProcessStop or CheckRemoteDebuggerPresent not available, skipping test.\n");
573 pid = GetCurrentProcessId();
574 ret = DebugActiveProcess(pid);
575 ok(!ret, "DebugActiveProcess() succeeded on own process.\n");
577 get_file_name(blackbox_file);
578 cmd = HeapAlloc(GetProcessHeap(), 0, strlen(argv[0]) + strlen(arguments) + strlen(blackbox_file) + 10);
579 sprintf(cmd, "%s%s%08x %s", argv[0], arguments, pid, blackbox_file);
581 memset(&si, 0, sizeof(si));
583 ret = CreateProcessA(NULL, cmd, NULL, NULL, FALSE, DEBUG_PROCESS, NULL, NULL, &si, &pi);
584 ok(ret, "CreateProcess failed, last error %#x.\n", GetLastError());
586 HeapFree(GetProcessHeap(), 0, cmd);
588 ret = pCheckRemoteDebuggerPresent(pi.hProcess, &debug);
589 ok(ret, "CheckRemoteDebuggerPresent failed, last error %#x.\n", GetLastError());
590 ok(debug, "Expected debug != 0, got %#x.\n", debug);
596 ret = WaitForDebugEvent(&ev, INFINITE);
597 ok(ret, "WaitForDebugEvent failed, last error %#x.\n", GetLastError());
600 if (ev.dwDebugEventCode == EXIT_PROCESS_DEBUG_EVENT) break;
602 ret = ContinueDebugEvent(ev.dwProcessId, ev.dwThreadId, DBG_CONTINUE);
603 ok(ret, "ContinueDebugEvent failed, last error %#x.\n", GetLastError());
607 ret = CloseHandle(pi.hThread);
608 ok(ret, "CloseHandle failed, last error %#x.\n", GetLastError());
609 ret = CloseHandle(pi.hProcess);
610 ok(ret, "CloseHandle failed, last error %#x.\n", GetLastError());
612 load_blackbox(blackbox_file, &blackbox, sizeof(blackbox));
613 ok(!blackbox.failures, "Got %d failures from child process.\n", blackbox.failures);
615 ret = DeleteFileA(blackbox_file);
616 ok(ret, "DeleteFileA failed, last error %#x.\n", GetLastError());
623 hdll=GetModuleHandle("kernel32.dll");
624 pCheckRemoteDebuggerPresent=(void*)GetProcAddress(hdll, "CheckRemoteDebuggerPresent");
625 pDebugActiveProcessStop=(void*)GetProcAddress(hdll, "DebugActiveProcessStop");
626 pDebugSetProcessKillOnExit=(void*)GetProcAddress(hdll, "DebugSetProcessKillOnExit");
627 hdll=GetModuleHandle("ntdll.dll");
628 if (hdll) pNtCurrentTeb = (void*)GetProcAddress(hdll, "NtCurrentTeb");
630 myARGC=winetest_get_mainargs(&myARGV);
631 if (myARGC >= 3 && strcmp(myARGV[2], "crash") == 0)
633 doCrash(myARGC, myARGV);
635 else if (myARGC >= 3 && strncmp(myARGV[2], "dbg,", 4) == 0)
637 doDebugger(myARGC, myARGV);
639 else if (myARGC >= 5 && !strcmp(myARGV[2], "child"))
641 doChild(myARGC, myARGV);
646 test_RemoteDebugger();
647 test_debug_loop(myARGC, myARGV);