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
26 #include "wine/test.h"
28 #ifndef STATUS_DEBUGGER_INACTIVE
29 #define STATUS_DEBUGGER_INACTIVE ((NTSTATUS) 0xC0000354)
35 static BOOL (WINAPI *pDebugActiveProcessStop)(DWORD);
36 static BOOL (WINAPI *pDebugSetProcessKillOnExit)(BOOL);
38 /* Copied from the process test */
39 static void get_file_name(char* buf)
44 GetTempPathA(sizeof(path), path);
45 GetTempFileNameA(path, "wt", 0, buf);
48 typedef struct tag_reg_save_value
56 static DWORD save_value(HKEY hkey, const char *value, reg_save_value *saved)
62 ret=RegQueryValueExA(hkey, value, NULL, &saved->type, NULL, &saved->size);
63 if (ret == ERROR_SUCCESS)
65 saved->data=HeapAlloc(GetProcessHeap(), 0, saved->size);
66 RegQueryValueExA(hkey, value, NULL, &saved->type, saved->data, &saved->size);
71 static void restore_value(HKEY hkey, reg_save_value *saved)
75 RegSetValueExA(hkey, saved->name, 0, saved->type, saved->data, saved->size);
76 HeapFree(GetProcessHeap(), 0, saved->data);
79 RegDeleteValueA(hkey, saved->name);
82 static void get_events(const char* name, HANDLE *start_event, HANDLE *done_event)
87 basename=strrchr(name, '\\');
88 basename=(basename ? basename+1 : name);
89 event_name=HeapAlloc(GetProcessHeap(), 0, 6+strlen(basename)+1);
91 sprintf(event_name, "start_%s", basename);
92 *start_event=CreateEvent(NULL, 0,0, event_name);
93 sprintf(event_name, "done_%s", basename);
94 *done_event=CreateEvent(NULL, 0,0, event_name);
95 HeapFree(GetProcessHeap(), 0, event_name);
98 static void save_blackbox(const char* logfile, void* blackbox, int size)
103 hFile=CreateFileA(logfile, GENERIC_WRITE, 0, NULL, CREATE_ALWAYS, 0, 0);
104 if (hFile == INVALID_HANDLE_VALUE)
106 WriteFile(hFile, blackbox, size, &written, NULL);
110 static int load_blackbox(const char* logfile, void* blackbox, int size)
116 hFile=CreateFileA(logfile, GENERIC_READ, 0, NULL, OPEN_EXISTING, 0, 0);
117 if (hFile == INVALID_HANDLE_VALUE)
119 ok(0, "unable to open '%s'\n", logfile);
122 ret=ReadFile(hFile, blackbox, size, &read, NULL);
123 ok(read == size, "wrong size for '%s': read=%d\n", logfile, read);
133 static void doCrash(int argc, char** argv)
139 crash_blackbox_t blackbox;
140 blackbox.pid=GetCurrentProcessId();
141 save_blackbox(argv[3], &blackbox, sizeof(blackbox));
145 trace("child: crashing...\n");
162 } debugger_blackbox_t;
164 static void doDebugger(int argc, char** argv)
167 debugger_blackbox_t blackbox;
168 HANDLE start_event = 0, done_event = 0, debug_event;
171 logfile=(argc >= 4 ? argv[3] : NULL);
172 blackbox.pid=(argc >= 5 ? atol(argv[4]) : 0);
174 blackbox.attach_err=0;
175 if (strstr(myARGV[2], "attach"))
177 blackbox.attach_rc=DebugActiveProcess(blackbox.pid);
178 if (!blackbox.attach_rc)
179 blackbox.attach_err=GetLastError();
182 blackbox.attach_rc=TRUE;
184 debug_event=(argc >= 6 ? (HANDLE)(INT_PTR)atol(argv[5]) : NULL);
185 blackbox.debug_err=0;
186 if (debug_event && strstr(myARGV[2], "event"))
188 blackbox.debug_rc=SetEvent(debug_event);
189 if (!blackbox.debug_rc)
190 blackbox.debug_err=GetLastError();
193 blackbox.debug_rc=TRUE;
197 get_events(logfile, &start_event, &done_event);
200 if (strstr(myARGV[2], "order"))
202 trace("debugger: waiting for the start signal...\n");
203 WaitForSingleObject(start_event, INFINITE);
206 blackbox.nokill_err=0;
207 if (strstr(myARGV[2], "nokill"))
209 blackbox.nokill_rc=pDebugSetProcessKillOnExit(FALSE);
210 if (!blackbox.nokill_rc)
211 blackbox.nokill_err=GetLastError();
214 blackbox.nokill_rc=TRUE;
216 blackbox.detach_err=0;
217 if (strstr(myARGV[2], "detach"))
219 blackbox.detach_rc=pDebugActiveProcessStop(blackbox.pid);
220 if (!blackbox.detach_rc)
221 blackbox.detach_err=GetLastError();
224 blackbox.detach_rc=TRUE;
228 save_blackbox(logfile, &blackbox, sizeof(blackbox));
230 trace("debugger: done debugging...\n");
231 SetEvent(done_event);
233 /* Just exit with a known value */
234 ExitProcess(0xdeadbeef);
237 static void crash_and_debug(HKEY hkey, const char* argv0, const char* dbgtasks)
240 HANDLE start_event, done_event;
242 char dbglog[MAX_PATH];
243 char childlog[MAX_PATH];
244 PROCESS_INFORMATION info;
245 STARTUPINFOA startup;
247 crash_blackbox_t crash_blackbox;
248 debugger_blackbox_t dbg_blackbox;
250 ret=RegSetValueExA(hkey, "auto", 0, REG_SZ, (BYTE*)"1", 2);
251 ok(ret == ERROR_SUCCESS, "unable to set AeDebug/auto: ret=%d\n", ret);
253 get_file_name(dbglog);
254 get_events(dbglog, &start_event, &done_event);
255 cmd=HeapAlloc(GetProcessHeap(), 0, strlen(argv0)+10+strlen(dbgtasks)+1+strlen(dbglog)+34+1);
256 sprintf(cmd, "%s debugger %s %s %%ld %%ld", argv0, dbgtasks, dbglog);
257 ret=RegSetValueExA(hkey, "debugger", 0, REG_SZ, (BYTE*)cmd, strlen(cmd)+1);
258 ok(ret == ERROR_SUCCESS, "unable to set AeDebug/debugger: ret=%d\n", ret);
259 HeapFree(GetProcessHeap(), 0, cmd);
261 get_file_name(childlog);
262 cmd=HeapAlloc(GetProcessHeap(), 0, strlen(argv0)+16+strlen(dbglog)+1);
263 sprintf(cmd, "%s debugger crash %s", argv0, childlog);
265 memset(&startup, 0, sizeof(startup));
266 startup.cb = sizeof(startup);
267 startup.dwFlags = STARTF_USESHOWWINDOW;
268 startup.wShowWindow = SW_SHOWNORMAL;
269 ret=CreateProcessA(NULL, cmd, NULL, NULL, FALSE, 0, NULL, NULL, &startup, &info);
270 ok(ret, "CreateProcess: err=%d\n", GetLastError());
271 HeapFree(GetProcessHeap(), 0, cmd);
272 CloseHandle(info.hThread);
274 /* The process exits... */
275 trace("waiting for child exit...\n");
276 ok(WaitForSingleObject(info.hProcess, 60000) == WAIT_OBJECT_0, "Timed out waiting for the child to crash\n");
277 ok(GetExitCodeProcess(info.hProcess, &exit_code), "GetExitCodeProcess failed: err=%d\n", GetLastError());
278 if (strstr(dbgtasks, "code2"))
280 /* If, after attaching to the debuggee, the debugger exits without
281 * detaching, then the debuggee gets a special exit code.
283 ok(exit_code == 0xffffffff || /* Win 9x */
284 exit_code == 0x80 || /* NT4 */
285 exit_code == STATUS_DEBUGGER_INACTIVE, /* Win >= XP */
286 "wrong exit code : %08x\n", exit_code);
289 ok(exit_code == STATUS_ACCESS_VIOLATION ||
290 exit_code == WAIT_ABANDONED, /* win2k3 */
291 "exit code = %08x instead of STATUS_ACCESS_VIOLATION or WAIT_ABANDONED\n", exit_code);
292 CloseHandle(info.hProcess);
294 /* ...before the debugger */
295 if (strstr(dbgtasks, "order"))
296 ok(SetEvent(start_event), "SetEvent(start_event) failed\n");
298 trace("waiting for the debugger...\n");
299 ok(WaitForSingleObject(done_event, 60000) == WAIT_OBJECT_0, "Timed out waiting for the debugger\n");
301 assert(load_blackbox(childlog, &crash_blackbox, sizeof(crash_blackbox)));
302 assert(load_blackbox(dbglog, &dbg_blackbox, sizeof(dbg_blackbox)));
304 ok(dbg_blackbox.argc == 6, "wrong debugger argument count: %d\n", dbg_blackbox.argc);
305 ok(dbg_blackbox.pid == crash_blackbox.pid, "the child and debugged pids don't match: %d != %d\n", crash_blackbox.pid, dbg_blackbox.pid);
306 ok(dbg_blackbox.debug_rc, "debugger: SetEvent(debug_event) failed err=%d\n", dbg_blackbox.debug_err);
307 ok(dbg_blackbox.attach_rc, "DebugActiveProcess(%d) failed err=%d\n", dbg_blackbox.pid, dbg_blackbox.attach_err);
308 ok(dbg_blackbox.nokill_rc, "DebugSetProcessKillOnExit(FALSE) failed err=%d\n", dbg_blackbox.nokill_err);
309 ok(dbg_blackbox.detach_rc, "DebugActiveProcessStop(%d) failed err=%d\n", dbg_blackbox.pid, dbg_blackbox.detach_err);
311 assert(DeleteFileA(dbglog) != 0);
312 assert(DeleteFileA(childlog) != 0);
315 static void crash_and_winedbg(HKEY hkey, const char* argv0)
319 PROCESS_INFORMATION info;
320 STARTUPINFOA startup;
323 ret=RegSetValueExA(hkey, "auto", 0, REG_SZ, (BYTE*)"1", 2);
324 ok(ret == ERROR_SUCCESS, "unable to set AeDebug/auto: ret=%d\n", ret);
326 cmd=HeapAlloc(GetProcessHeap(), 0, strlen(argv0)+15+1);
327 sprintf(cmd, "%s debugger crash", argv0);
329 memset(&startup, 0, sizeof(startup));
330 startup.cb = sizeof(startup);
331 startup.dwFlags = STARTF_USESHOWWINDOW;
332 startup.wShowWindow = SW_SHOWNORMAL;
333 ret=CreateProcessA(NULL, cmd, NULL, NULL, FALSE, 0, NULL, NULL, &startup, &info);
334 ok(ret, "CreateProcess: err=%d\n", GetLastError());
335 HeapFree(GetProcessHeap(), 0, cmd);
336 CloseHandle(info.hThread);
338 trace("waiting for child exit...\n");
339 ok(WaitForSingleObject(info.hProcess, 60000) == WAIT_OBJECT_0, "Timed out waiting for the child to crash\n");
340 ok(GetExitCodeProcess(info.hProcess, &exit_code), "GetExitCodeProcess failed: err=%d\n", GetLastError());
341 ok(exit_code == STATUS_ACCESS_VIOLATION, "exit code = %08x\n", exit_code);
342 CloseHandle(info.hProcess);
345 static void test_ExitCode(void)
347 static const char* AeDebug="Software\\Microsoft\\Windows NT\\CurrentVersion\\AeDebug";
348 static const char* WineDbg="Software\\Wine\\WineDbg";
349 char test_exe[MAX_PATH];
353 reg_save_value auto_value;
354 reg_save_value debugger_value;
356 GetModuleFileNameA(GetModuleHandle(NULL), test_exe, sizeof(test_exe));
357 if (GetFileAttributes(test_exe) == INVALID_FILE_ATTRIBUTES)
358 strcat(test_exe, ".so");
359 if (GetFileAttributesA(test_exe) == INVALID_FILE_ATTRIBUTES)
361 ok(0, "could not find the test executable '%s'\n", test_exe);
365 ret=RegCreateKeyExA(HKEY_LOCAL_MACHINE, AeDebug, 0, NULL, REG_OPTION_NON_VOLATILE, KEY_ALL_ACCESS, NULL, &hkey, &disposition);
366 if (ret == ERROR_SUCCESS)
368 save_value(hkey, "auto", &auto_value);
369 save_value(hkey, "debugger", &debugger_value);
370 trace("HKLM\\%s\\debugger is set to '%s'\n", AeDebug, debugger_value.data);
372 else if (ret == ERROR_ACCESS_DENIED)
374 skip("not enough privileges to change the debugger\n");
377 else if (ret != ERROR_FILE_NOT_FOUND)
379 ok(0, "could not open the AeDebug key: %d\n", ret);
383 if (debugger_value.data && debugger_value.type == REG_SZ &&
384 strstr((char*)debugger_value.data, "winedbg --auto"))
387 ret=RegCreateKeyA(HKEY_CURRENT_USER, WineDbg, &hkeyWinedbg);
388 if (ret == ERROR_SUCCESS)
391 reg_save_value crash_dlg_value;
392 save_value(hkeyWinedbg, "ShowCrashDialog", &crash_dlg_value);
393 RegSetValueExA(hkeyWinedbg, "ShowCrashDialog", 0, REG_DWORD, (BYTE *)&zero, sizeof(DWORD));
394 crash_and_winedbg(hkey, test_exe);
395 restore_value(hkeyWinedbg, &crash_dlg_value);
396 RegCloseKey(hkeyWinedbg);
399 ok(0, "Couldn't access WineDbg Key - error %u\n", ret);
402 if (winetest_interactive)
403 /* Since the debugging process never sets the debug event, it isn't recognized
404 as a valid debugger and, after the debugger exits, Windows will show a dialog box
405 asking the user what to do */
406 crash_and_debug(hkey, test_exe, "dbg,none");
408 skip("\"none\" debugger test needs user interaction\n");
409 crash_and_debug(hkey, test_exe, "dbg,event,order");
410 crash_and_debug(hkey, test_exe, "dbg,attach,event,code2");
411 if (pDebugSetProcessKillOnExit)
412 crash_and_debug(hkey, test_exe, "dbg,attach,event,nokill");
413 if (pDebugActiveProcessStop)
414 crash_and_debug(hkey, test_exe, "dbg,attach,event,detach");
416 if (disposition == REG_CREATED_NEW_KEY)
419 RegDeleteKeyA(HKEY_LOCAL_MACHINE, AeDebug);
423 restore_value(hkey, &auto_value);
424 restore_value(hkey, &debugger_value);
433 hdll=GetModuleHandle("kernel32.dll");
434 pDebugActiveProcessStop=(void*)GetProcAddress(hdll, "DebugActiveProcessStop");
435 pDebugSetProcessKillOnExit=(void*)GetProcAddress(hdll, "DebugSetProcessKillOnExit");
437 myARGC=winetest_get_mainargs(&myARGV);
438 if (myARGC >= 3 && strcmp(myARGV[2], "crash") == 0)
440 doCrash(myARGC, myARGV);
442 else if (myARGC >= 3 && strncmp(myARGV[2], "dbg,", 4) == 0)
444 doDebugger(myARGC, myARGV);