1 /*
2 * Unit tests for the debugger facility
3 *
4 * Copyright (c) 2007 Francois Gouget for CodeWeavers
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 <stdio.h>
22 #include <assert.h>
23
24 #include <windows.h>
25 #include <winreg.h>
26 #include "wine/test.h"
27
28 #ifndef STATUS_DEBUGGER_INACTIVE
29 #define STATUS_DEBUGGER_INACTIVE ((NTSTATUS) 0xC0000354)
30 #endif
31
32 static int myARGC;
33 static char** myARGV;
34
35 static BOOL (WINAPI *pDebugActiveProcessStop)(DWORD);
36 static BOOL (WINAPI *pDebugSetProcessKillOnExit)(BOOL);
37
38 /* Copied from the process test */
39 static void get_file_name(char* buf)
40 {
41 char path[MAX_PATH];
42
43 buf[0] = '\0';
44 GetTempPathA(sizeof(path), path);
45 GetTempFileNameA(path, "wt", 0, buf);
46 }
47
48 static void get_events(const char* name, HANDLE *start_event, HANDLE *done_event)
49 {
50 const char* basename;
51 char* event_name;
52
53 basename=strrchr(name, '\\');
54 basename=(basename ? basename+1 : name);
55 event_name=HeapAlloc(GetProcessHeap(), 0, 6+strlen(basename)+1);
56
57 sprintf(event_name, "start_%s", basename);
58 *start_event=CreateEvent(NULL, 0,0, event_name);
59 sprintf(event_name, "done_%s", basename);
60 *done_event=CreateEvent(NULL, 0,0, event_name);
61 HeapFree(GetProcessHeap(), 0, event_name);
62 }
63
64 static void save_blackbox(const char* logfile, void* blackbox, int size)
65 {
66 HANDLE hFile;
67 DWORD written;
68
69 hFile=CreateFileA(logfile, GENERIC_WRITE, 0, NULL, CREATE_ALWAYS, 0, 0);
70 if (hFile == INVALID_HANDLE_VALUE)
71 return;
72 WriteFile(hFile, blackbox, size, &written, NULL);
73 CloseHandle(hFile);
74 }
75
76 static int load_blackbox(const char* logfile, void* blackbox, int size)
77 {
78 HANDLE hFile;
79 DWORD read;
80 BOOL ret;
81
82 hFile=CreateFileA(logfile, GENERIC_READ, 0, NULL, OPEN_EXISTING, 0, 0);
83 if (hFile == INVALID_HANDLE_VALUE)
84 {
85 ok(0, "unable to open '%s'\n", logfile);
86 return 0;
87 }
88 ret=ReadFile(hFile, blackbox, size, &read, NULL);
89 ok(read == size, "wrong size for '%s': read=%d\n", logfile, read);
90 CloseHandle(hFile);
91 return 1;
92 }
93
94 typedef struct
95 {
96 DWORD pid;
97 } crash_blackbox_t;
98
99 static void doCrash(int argc, char** argv)
100 {
101 char* p;
102
103 if (argc >= 4)
104 {
105 crash_blackbox_t blackbox;
106 blackbox.pid=GetCurrentProcessId();
107 save_blackbox(argv[3], &blackbox, sizeof(blackbox));
108 }
109
110 /* Just crash */
111 trace("child: crashing...\n");
112 p=NULL;
113 *p=0;
114 }
115
116 typedef struct
117 {
118 int argc;
119 DWORD pid;
120 BOOL debug_rc;
121 DWORD debug_err;
122 BOOL attach_rc;
123 DWORD attach_err;
124 BOOL nokill_rc;
125 DWORD nokill_err;
126 BOOL detach_rc;
127 DWORD detach_err;
128 } debugger_blackbox_t;
129
130 static void doDebugger(int argc, char** argv)
131 {
132 const char* logfile;
133 debugger_blackbox_t blackbox;
134 HANDLE start_event, done_event, debug_event;
135
136 blackbox.argc=argc;
137 logfile=(argc >= 4 ? argv[3] : NULL);
138 blackbox.pid=(argc >= 5 ? atol(argv[4]) : 0);
139
140 if (strstr(myARGV[2], "attach"))
141 {
142 blackbox.attach_rc=DebugActiveProcess(blackbox.pid);
143 if (!blackbox.attach_rc)
144 blackbox.attach_err=GetLastError();
145 }
146 else
147 blackbox.attach_rc=TRUE;
148
149 debug_event=(argc >= 6 ? (HANDLE)atol(argv[5]) : NULL);
150 if (debug_event && strstr(myARGV[2], "event"))
151 {
152 blackbox.debug_rc=SetEvent(debug_event);
153 if (!blackbox.debug_rc)
154 blackbox.debug_err=GetLastError();
155 }
156 else
157 blackbox.debug_rc=TRUE;
158
159 get_events(logfile, &start_event, &done_event);
160 if (strstr(myARGV[2], "order"))
161 {
162 trace("debugger: waiting for the start signal...\n");
163 WaitForSingleObject(start_event, INFINITE);
164 }
165
166 if (strstr(myARGV[2], "nokill"))
167 {
168 blackbox.nokill_rc=pDebugSetProcessKillOnExit(FALSE);
169 if (!blackbox.nokill_rc)
170 blackbox.nokill_err=GetLastError();
171 }
172 else
173 blackbox.nokill_rc=TRUE;
174
175 if (strstr(myARGV[2], "detach"))
176 {
177 blackbox.detach_rc=pDebugActiveProcessStop(blackbox.pid);
178 if (!blackbox.detach_rc)
179 blackbox.detach_err=GetLastError();
180 }
181 else
182 blackbox.detach_rc=TRUE;
183
184 save_blackbox(logfile, &blackbox, sizeof(blackbox));
185 trace("debugger: done debugging...\n");
186 SetEvent(done_event);
187
188 /* Just exit with a known value */
189 ExitProcess(0xdeadbeef);
190 }
191
192 static void crash_and_debug(HKEY hkey, const char* argv0, const char* dbgtasks)
193 {
194 DWORD ret;
195 HANDLE start_event, done_event;
196 char* cmd;
197 char dbglog[MAX_PATH];
198 char childlog[MAX_PATH];
199 PROCESS_INFORMATION info;
200 STARTUPINFOA startup;
201 DWORD exit_code;
202 crash_blackbox_t crash_blackbox;
203 debugger_blackbox_t dbg_blackbox;
204
205 ret=RegSetValueExA(hkey, "auto", 0, REG_SZ, (BYTE*)"1", 2);
206 ok(ret == ERROR_SUCCESS, "unable to set AeDebug/auto: ret=%d\n", ret);
207
208 get_file_name(dbglog);
209 get_events(dbglog, &start_event, &done_event);
210 cmd=HeapAlloc(GetProcessHeap(), 0, strlen(argv0)+10+strlen(dbgtasks)+1+strlen(dbglog)+34+1);
211 sprintf(cmd, "%s debugger %s %s %%ld %%ld", argv0, dbgtasks, dbglog);
212 ret=RegSetValueExA(hkey, "debugger", 0, REG_SZ, (BYTE*)cmd, strlen(cmd)+1);
213 ok(ret == ERROR_SUCCESS, "unable to set AeDebug/debugger: ret=%d\n", ret);
214 HeapFree(GetProcessHeap(), 0, cmd);
215
216 get_file_name(childlog);
217 cmd=HeapAlloc(GetProcessHeap(), 0, strlen(argv0)+16+strlen(dbglog)+1);
218 sprintf(cmd, "%s debugger crash %s", argv0, childlog);
219
220 memset(&startup, 0, sizeof(startup));
221 startup.cb = sizeof(startup);
222 startup.dwFlags = STARTF_USESHOWWINDOW;
223 startup.wShowWindow = SW_SHOWNORMAL;
224 ret=CreateProcessA(NULL, cmd, NULL, NULL, FALSE, 0, NULL, NULL, &startup, &info);
225 ok(ret, "CreateProcess: err=%d\n", GetLastError());
226 HeapFree(GetProcessHeap(), 0, cmd);
227 CloseHandle(info.hThread);
228
229 /* The process exits... */
230 trace("waiting for child exit...\n");
231 ok(WaitForSingleObject(info.hProcess, 60000) == WAIT_OBJECT_0, "Timed out waiting for the child to crash\n");
232 ok(GetExitCodeProcess(info.hProcess, &exit_code), "GetExitCodeProcess failed: err=%d\n", GetLastError());
233 if (strstr(dbgtasks, "code2"))
234 {
235 /* If, after attaching to the debuggee, the debugger exits without
236 * detaching, then the debuggee gets a special exit code.
237 */
238 ok(exit_code == 0xffffffff || /* Win 9x */
239 exit_code == 0x80 || /* NT4 */
240 exit_code == STATUS_DEBUGGER_INACTIVE, /* Win >= XP */
241 "wrong exit code : %08x\n", exit_code);
242 }
243 else
244 ok(exit_code == STATUS_ACCESS_VIOLATION ||
245 exit_code == WAIT_ABANDONED, /* win2k3 */
246 "exit code = %08x instead of STATUS_ACCESS_VIOLATION or WAIT_ABANDONED\n", exit_code);
247 CloseHandle(info.hProcess);
248
249 /* ...before the debugger */
250 if (strstr(dbgtasks, "order"))
251 ok(SetEvent(start_event), "SetEvent(start_event) failed\n");
252
253 trace("waiting for the debugger...\n");
254 ok(WaitForSingleObject(done_event, 60000) == WAIT_OBJECT_0, "Timed out waiting for the debugger\n");
255
256 assert(load_blackbox(childlog, &crash_blackbox, sizeof(crash_blackbox)));
257 assert(load_blackbox(dbglog, &dbg_blackbox, sizeof(dbg_blackbox)));
258
259 ok(dbg_blackbox.argc == 6, "wrong debugger argument count: %d\n", dbg_blackbox.argc);
260 ok(dbg_blackbox.pid == crash_blackbox.pid, "the child and debugged pids don't match: %d != %d\n", crash_blackbox.pid, dbg_blackbox.pid);
261 ok(dbg_blackbox.debug_rc, "debugger: SetEvent(debug_event) failed err=%d\n", dbg_blackbox.debug_err);
262 ok(dbg_blackbox.attach_rc, "DebugActiveProcess(%d) failed err=%d\n", dbg_blackbox.pid, dbg_blackbox.attach_err);
263 ok(dbg_blackbox.nokill_rc, "DebugSetProcessKillOnExit(FALSE) failed err=%d\n", dbg_blackbox.nokill_err);
264 ok(dbg_blackbox.detach_rc, "DebugActiveProcessStop(%d) failed err=%d\n", dbg_blackbox.pid, dbg_blackbox.detach_err);
265
266 assert(DeleteFileA(dbglog) != 0);
267 assert(DeleteFileA(childlog) != 0);
268 }
269
270 static void crash_and_winedbg(HKEY hkey, const char* argv0)
271 {
272 DWORD ret;
273 char* cmd;
274 PROCESS_INFORMATION info;
275 STARTUPINFOA startup;
276 DWORD exit_code;
277
278 ret=RegSetValueExA(hkey, "auto", 0, REG_SZ, (BYTE*)"1", 2);
279 ok(ret == ERROR_SUCCESS, "unable to set AeDebug/auto: ret=%d\n", ret);
280
281 cmd=HeapAlloc(GetProcessHeap(), 0, strlen(argv0)+15+1);
282 sprintf(cmd, "%s debugger crash", argv0);
283
284 memset(&startup, 0, sizeof(startup));
285 startup.cb = sizeof(startup);
286 startup.dwFlags = STARTF_USESHOWWINDOW;
287 startup.wShowWindow = SW_SHOWNORMAL;
288 ret=CreateProcessA(NULL, cmd, NULL, NULL, FALSE, 0, NULL, NULL, &startup, &info);
289 ok(ret, "CreateProcess: err=%d\n", GetLastError());
290 HeapFree(GetProcessHeap(), 0, cmd);
291 CloseHandle(info.hThread);
292
293 trace("waiting for child exit...\n");
294 ok(WaitForSingleObject(info.hProcess, 60000) == WAIT_OBJECT_0, "Timed out waiting for the child to crash\n");
295 ok(GetExitCodeProcess(info.hProcess, &exit_code), "GetExitCodeProcess failed: err=%d\n", GetLastError());
296 ok(exit_code == STATUS_ACCESS_VIOLATION, "exit code = %08x\n", exit_code);
297 CloseHandle(info.hProcess);
298 }
299
300 static void test_ExitCode(void)
301 {
302 static const char* AeDebug="Software\\Microsoft\\Windows NT\\CurrentVersion\\AeDebug";
303 char test_exe[MAX_PATH];
304 DWORD ret;
305 HKEY hkey;
306 DWORD disposition;
307 LPBYTE auto_val=NULL;
308 DWORD auto_size, auto_type;
309 LPBYTE debugger_val=NULL;
310 DWORD debugger_size, debugger_type;
311
312 GetModuleFileNameA(GetModuleHandle(NULL), test_exe, sizeof(test_exe));
313 if (GetFileAttributes(test_exe) == INVALID_FILE_ATTRIBUTES)
314 strcat(test_exe, ".so");
315 if (GetFileAttributesA(test_exe) == INVALID_FILE_ATTRIBUTES)
316 {
317 ok(0, "could not find the test executable '%s'\n", test_exe);
318 return;
319 }
320
321 ret=RegCreateKeyExA(HKEY_LOCAL_MACHINE, AeDebug, 0, NULL, REG_OPTION_NON_VOLATILE, KEY_ALL_ACCESS, NULL, &hkey, &disposition);
322 if (ret == ERROR_SUCCESS)
323 {
324 auto_size=0;
325 ret=RegQueryValueExA(hkey, "auto", NULL, &auto_type, NULL, &auto_size);
326 if (ret == ERROR_SUCCESS)
327 {
328 auto_val=HeapAlloc(GetProcessHeap(), 0, auto_size);
329 RegQueryValueExA(hkey, "auto", NULL, &auto_type, auto_val, &auto_size);
330 }
331
332 debugger_size=0;
333 ret=RegQueryValueExA(hkey, "debugger", NULL, &debugger_type, NULL, &debugger_size);
334 if (ret == ERROR_SUCCESS)
335 {
336 debugger_val=HeapAlloc(GetProcessHeap(), 0, debugger_size);
337 RegQueryValueExA(hkey, "debugger", NULL, &debugger_type, debugger_val, &debugger_size);
338 }
339 }
340 else if (ret == ERROR_ACCESS_DENIED)
341 {
342 skip("not enough privileges to change the debugger\n");
343 return;
344 }
345 else if (ret != ERROR_FILE_NOT_FOUND)
346 {
347 ok(0, "could not open the AeDebug key: %d\n", ret);
348 return;
349 }
350
351 if (debugger_val && debugger_type == REG_SZ &&
352 strstr((char*)debugger_val, "winedbg --auto"))
353 crash_and_winedbg(hkey, test_exe);
354
355 crash_and_debug(hkey, test_exe, "dbg,none");
356 crash_and_debug(hkey, test_exe, "dbg,event,order");
357 crash_and_debug(hkey, test_exe, "dbg,attach,event,code2");
358 if (pDebugSetProcessKillOnExit)
359 crash_and_debug(hkey, test_exe, "dbg,attach,event,nokill");
360 if (pDebugActiveProcessStop)
361 crash_and_debug(hkey, test_exe, "dbg,attach,event,detach");
362
363 if (disposition == REG_CREATED_NEW_KEY)
364 {
365 RegCloseKey(hkey);
366 RegDeleteKeyA(HKEY_LOCAL_MACHINE, AeDebug);
367 }
368 else
369 {
370 if (auto_val)
371 {
372 RegSetValueExA(hkey, "auto", 0, auto_type, auto_val, auto_size);
373 HeapFree(GetProcessHeap(), 0, auto_val);
374 }
375 else
376 RegDeleteValueA(hkey, "auto");
377 if (debugger_val)
378 {
379 RegSetValueExA(hkey, "debugger", 0, debugger_type, debugger_val, debugger_size);
380 HeapFree(GetProcessHeap(), 0, debugger_val);
381 }
382 else
383 RegDeleteValueA(hkey, "debugger");
384 RegCloseKey(hkey);
385 }
386 }
387
388 START_TEST(debugger)
389 {
390 HMODULE hdll;
391
392 hdll=GetModuleHandle("kernel32.dll");
393 pDebugActiveProcessStop=(void*)GetProcAddress(hdll, "DebugActiveProcessStop");
394 pDebugSetProcessKillOnExit=(void*)GetProcAddress(hdll, "DebugSetProcessKillOnExit");
395
396 myARGC=winetest_get_mainargs(&myARGV);
397 if (myARGC >= 3 && strcmp(myARGV[2], "crash") == 0)
398 {
399 doCrash(myARGC, myARGV);
400 }
401 else if (myARGC >= 3 && strncmp(myARGV[2], "dbg,", 4) == 0)
402 {
403 doDebugger(myARGC, myARGV);
404 }
405 else
406 {
407 test_ExitCode();
408 }
409 }
410
This page was automatically generated by the
LXR engine.
Visit the LXR main site for more
information.