dlls/kernel32/tests/debugger.c - wine - Git at Google

 /*
  * Unit tests for the debugger facility
  *
  * Copyright (c) 2007 Francois Gouget for CodeWeavers
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
  * version 2.1 of the License, or (at your option) any later version.
  *
  * This library is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  */

 #include <stdio.h>
 #include <assert.h>

 #include <windows.h>
 #include <winreg.h>
 #include "wine/test.h"

 static int    myARGC;
 static char** myARGV;


 /* Copied from the process test */
 static void get_file_name(char* buf)
 {
     char path[MAX_PATH];

     buf[0] = '\0';
     GetTempPathA(sizeof(path), path);
     GetTempFileNameA(path, "wt", 0, buf);
 }

 static void get_events(const char* name, HANDLE *start_event, HANDLE *done_event)
 {
     const char* basename;
     char* event_name;

     basename=strrchr(name, '\\');
     basename=(basename ? basename+1 : name);
     event_name=HeapAlloc(GetProcessHeap(), 0, 6+strlen(basename)+1);

     sprintf(event_name, "start_%s", basename);
     *start_event=CreateEvent(NULL, 0,0, event_name);
     sprintf(event_name, "done_%s", basename);
     *done_event=CreateEvent(NULL, 0,0, event_name);
     HeapFree(GetProcessHeap(), 0, event_name);
 }

 static void log_pid(const char* logfile, DWORD pid)
 {
     HANDLE hFile;
     DWORD written;

     hFile=CreateFileA(logfile, GENERIC_WRITE, 0, NULL, CREATE_ALWAYS, 0, 0);
     if (hFile == INVALID_HANDLE_VALUE)
         return;
     WriteFile(hFile, &pid, sizeof(pid), &written, NULL);
     CloseHandle(hFile);
 }

 static DWORD get_logged_pid(const char* logfile)
 {
     HANDLE hFile;
     DWORD pid, read;
     BOOL ret;

     hFile=CreateFileA(logfile, GENERIC_READ, 0, NULL, OPEN_EXISTING, 0, 0);
     if (hFile == INVALID_HANDLE_VALUE)
     {
         ok(0, "unable to open '%s'\n", logfile);
         return 0;
     }
     pid=0;
     read=sizeof(pid);
     ret=ReadFile(hFile, &pid, sizeof(pid), &read, NULL);
     ok(read == sizeof(pid), "wrong size for '%s': read=%d\n", logfile, read);
     CloseHandle(hFile);
     return pid;
 }

 static void doCrash(int argc,  char** argv)
 {
     char* p;
     const char* logfile;

     logfile=(argc >= 4 ? argv[3] : NULL);
     log_pid(logfile, GetCurrentProcessId());

     /* Just crash */
     trace("child: crashing...\n");
     p=NULL;
     *p=0;
 }

 static void doDebugger(int argc, char** argv)
 {
     const char* logfile;
     HANDLE start_event, done_event, debug_event;
     DWORD pid;

     ok(argc == 6, "wrong debugger argument count: %d\n", argc);
     logfile=(argc >= 4 ? argv[3] : NULL);
     pid=(argc >= 5 ? atol(argv[4]) : 0);
     debug_event=(argc >= 6 ? (HANDLE)atol(argv[5]) : NULL);
     if (debug_event && strcmp(myARGV[2], "dbgnoevent") != 0)
     {
         ok(SetEvent(debug_event), "debugger: SetEvent(debug_event) failed\n");
     }

     log_pid(logfile, pid);
     get_events(logfile, &start_event, &done_event);
     if (strcmp(myARGV[2], "dbgnoevent") != 0)
     {
         trace("debugger: waiting for the start signal...\n");
         WaitForSingleObject(start_event, INFINITE);
     }

     ok(SetEvent(done_event), "debugger: SetEvent(done_event) failed\n");
     trace("debugger: done debugging...\n");

     /* Just exit with a known value */
     ExitProcess(0xdeadbeef);
 }

 static void crash_and_debug(HKEY hkey, const char* argv0, const char* debugger)
 {
     DWORD ret;
     HANDLE start_event, done_event;
     char* cmd;
     char dbglog[MAX_PATH];
     char childlog[MAX_PATH];
     PROCESS_INFORMATION	info;
     STARTUPINFOA startup;
     DWORD exit_code;
     DWORD pid1, pid2;

     ret=RegSetValueExA(hkey, "auto", 0, REG_SZ, (BYTE*)"1", 2);
     ok(ret == ERROR_SUCCESS, "unable to set AeDebug/auto: ret=%d\n", ret);

     get_file_name(dbglog);
     get_events(dbglog, &start_event, &done_event);
     cmd=HeapAlloc(GetProcessHeap(), 0, strlen(argv0)+10+strlen(debugger)+1+strlen(dbglog)+34+1);
     sprintf(cmd, "%s debugger %s %s %%ld %%ld", argv0, debugger, dbglog);
     ret=RegSetValueExA(hkey, "debugger", 0, REG_SZ, (BYTE*)cmd, strlen(cmd)+1);
     ok(ret == ERROR_SUCCESS, "unable to set AeDebug/debugger: ret=%d\n", ret);
     HeapFree(GetProcessHeap(), 0, cmd);

     get_file_name(childlog);
     cmd=HeapAlloc(GetProcessHeap(), 0, strlen(argv0)+16+strlen(dbglog)+1);
     sprintf(cmd, "%s debugger crash %s", argv0, childlog);

     memset(&startup, 0, sizeof(startup));
     startup.cb = sizeof(startup);
     startup.dwFlags = STARTF_USESHOWWINDOW;
     startup.wShowWindow = SW_SHOWNORMAL;
     ret=CreateProcessA(NULL, cmd, NULL, NULL, FALSE, 0, NULL, NULL, &startup, &info);
     ok(ret, "CreateProcess: err=%d\n", GetLastError());
     HeapFree(GetProcessHeap(), 0, cmd);
     CloseHandle(info.hThread);

     /* The process exits... */
     trace("waiting for child exit...\n");
     ok(WaitForSingleObject(info.hProcess, 60000) == WAIT_OBJECT_0, "Timed out waiting for the child to crash\n");
     ok(GetExitCodeProcess(info.hProcess, &exit_code), "GetExitCodeProcess failed: err=%d\n", GetLastError());
     ok(exit_code == STATUS_ACCESS_VIOLATION, "exit code = %08x\n", exit_code);
     CloseHandle(info.hProcess);

     /* ...before the debugger */
     if (strcmp(debugger, "dbgnoevent") != 0)
         ok(SetEvent(start_event), "SetEvent(start_event) failed\n");

     trace("waiting for the debugger...\n");
     ok(WaitForSingleObject(done_event, 60000) == WAIT_OBJECT_0, "Timed out waiting for the debugger\n");

     pid1=get_logged_pid(dbglog);
     pid2=get_logged_pid(childlog);
     ok(pid1 == pid2, "the child and debugged pids don't match: %d != %d\n", pid1, pid2);
     assert(DeleteFileA(dbglog) != 0);
     assert(DeleteFileA(childlog) != 0);
 }

 static void test_ExitCode(void)
 {
     static const char* AeDebug="Software\\Microsoft\\Windows NT\\CurrentVersion\\AeDebug";
     char test_exe[MAX_PATH];
     DWORD ret;
     HKEY hkey;
     DWORD disposition;
     LPBYTE auto_val=NULL;
     DWORD auto_size, auto_type;
     LPBYTE debugger_val=NULL;
     DWORD debugger_size, debugger_type;

     GetModuleFileNameA(GetModuleHandle(NULL), test_exe, sizeof(test_exe));
     if (GetFileAttributes(test_exe) == INVALID_FILE_ATTRIBUTES)
         strcat(test_exe, ".so");
     if (GetFileAttributesA(test_exe) == INVALID_FILE_ATTRIBUTES)
     {
         ok(0, "could not find the test executable '%s'\n", test_exe);
         return;
     }

     ret=RegCreateKeyExA(HKEY_LOCAL_MACHINE, AeDebug, 0, NULL, REG_OPTION_NON_VOLATILE, KEY_ALL_ACCESS, NULL, &hkey, &disposition);
     if (ret == ERROR_SUCCESS)
     {
         auto_size=0;
         ret=RegQueryValueExA(hkey, "auto", NULL, &auto_type, NULL, &auto_size);
         if (ret == ERROR_SUCCESS)
         {
             auto_val=HeapAlloc(GetProcessHeap(), 0, auto_size);
             RegQueryValueExA(hkey, "auto", NULL, &auto_type, auto_val, &auto_size);
         }

         debugger_size=0;
         ret=RegQueryValueExA(hkey, "debugger", NULL, &debugger_type, NULL, &debugger_size);
         if (ret == ERROR_SUCCESS)
         {
             debugger_val=HeapAlloc(GetProcessHeap(), 0, debugger_size);
             RegQueryValueExA(hkey, "debugger", NULL, &debugger_type, debugger_val, &debugger_size);
         }
     }
     else if (ret == ERROR_ACCESS_DENIED)
     {
         skip("not enough privileges to change the debugger\n");
         return;
     }
     else if (ret != ERROR_FILE_NOT_FOUND)
     {
         ok(0, "could not open the AeDebug key: %d\n", ret);
         return;
     }

     crash_and_debug(hkey, test_exe, "dbgevent");
     crash_and_debug(hkey, test_exe, "dbgnoevent");

     if (disposition == REG_CREATED_NEW_KEY)
     {
         RegCloseKey(hkey);
         RegDeleteKeyA(HKEY_LOCAL_MACHINE, AeDebug);
     }
     else
     {
         if (auto_val)
         {
             RegSetValueExA(hkey, "auto", 0, auto_type, auto_val, auto_size);
             HeapFree(GetProcessHeap(), 0, auto_val);
         }
         else
             RegDeleteValueA(hkey, "auto");
         if (debugger_val)
         {
             RegSetValueExA(hkey, "debugger", 0, debugger_type, debugger_val, debugger_size);
             HeapFree(GetProcessHeap(), 0, debugger_val);
         }
         else
             RegDeleteValueA(hkey, "debugger");
         RegCloseKey(hkey);
     }
 }

 START_TEST(debugger)
 {

     myARGC=winetest_get_mainargs(&myARGV);

     if (myARGC >= 3 && strcmp(myARGV[2], "crash") == 0)
     {
         doCrash(myARGC, myARGV);
     }
     else if (myARGC >= 3 &&
              (strcmp(myARGV[2], "dbgevent") == 0 ||
               strcmp(myARGV[2], "dbgnoevent") == 0))
     {
         doDebugger(myARGC, myARGV);
     }
     else
     {
         test_ExitCode();
     }
 }
	/*
	* Unit tests for the debugger facility
	*
	* Copyright (c) 2007 Francois Gouget for CodeWeavers
	*
	* This library is free software; you can redistribute it and/or
	* modify it under the terms of the GNU Lesser General Public
	* License as published by the Free Software Foundation; either
	* version 2.1 of the License, or (at your option) any later version.
	*
	* This library is distributed in the hope that it will be useful,
	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	* Lesser General Public License for more details.
	*
	* You should have received a copy of the GNU Lesser General Public
	* License along with this library; if not, write to the Free Software
	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
	*/

	#include <stdio.h>
	#include <assert.h>

	#include <windows.h>
	#include <winreg.h>
	#include "wine/test.h"

	static int myARGC;
	static char** myARGV;


	/* Copied from the process test */
	static void get_file_name(char* buf)
	{
	char path[MAX_PATH];

	buf[0] = '\0';
	GetTempPathA(sizeof(path), path);
	GetTempFileNameA(path, "wt", 0, buf);
	}

	static void get_events(const char* name, HANDLE start_event, HANDLE done_event)
	{
	const char* basename;
	char* event_name;

	basename=strrchr(name, '\\');
	basename=(basename ? basename+1 : name);
	event_name=HeapAlloc(GetProcessHeap(), 0, 6+strlen(basename)+1);

	sprintf(event_name, "start_%s", basename);
	*start_event=CreateEvent(NULL, 0,0, event_name);
	sprintf(event_name, "done_%s", basename);
	*done_event=CreateEvent(NULL, 0,0, event_name);
	HeapFree(GetProcessHeap(), 0, event_name);
	}

	static void log_pid(const char* logfile, DWORD pid)
	{
	HANDLE hFile;
	DWORD written;

	hFile=CreateFileA(logfile, GENERIC_WRITE, 0, NULL, CREATE_ALWAYS, 0, 0);
	if (hFile == INVALID_HANDLE_VALUE)
	return;
	WriteFile(hFile, &pid, sizeof(pid), &written, NULL);
	CloseHandle(hFile);
	}

	static DWORD get_logged_pid(const char* logfile)
	{
	HANDLE hFile;
	DWORD pid, read;
	BOOL ret;

	hFile=CreateFileA(logfile, GENERIC_READ, 0, NULL, OPEN_EXISTING, 0, 0);
	if (hFile == INVALID_HANDLE_VALUE)
	{
	ok(0, "unable to open '%s'\n", logfile);
	return 0;
	}
	pid=0;
	read=sizeof(pid);
	ret=ReadFile(hFile, &pid, sizeof(pid), &read, NULL);
	ok(read == sizeof(pid), "wrong size for '%s': read=%d\n", logfile, read);
	CloseHandle(hFile);
	return pid;
	}

	static void doCrash(int argc, char** argv)
	{
	char* p;
	const char* logfile;

	logfile=(argc >= 4 ? argv[3] : NULL);
	log_pid(logfile, GetCurrentProcessId());

	/* Just crash */
	trace("child: crashing...\n");
	p=NULL;
	*p=0;
	}

	static void doDebugger(int argc, char** argv)
	{
	const char* logfile;
	HANDLE start_event, done_event, debug_event;
	DWORD pid;

	ok(argc == 6, "wrong debugger argument count: %d\n", argc);
	logfile=(argc >= 4 ? argv[3] : NULL);
	pid=(argc >= 5 ? atol(argv[4]) : 0);
	debug_event=(argc >= 6 ? (HANDLE)atol(argv[5]) : NULL);
	if (debug_event && strcmp(myARGV[2], "dbgnoevent") != 0)
	{
	ok(SetEvent(debug_event), "debugger: SetEvent(debug_event) failed\n");
	}

	log_pid(logfile, pid);
	get_events(logfile, &start_event, &done_event);
	if (strcmp(myARGV[2], "dbgnoevent") != 0)
	{
	trace("debugger: waiting for the start signal...\n");
	WaitForSingleObject(start_event, INFINITE);
	}

	ok(SetEvent(done_event), "debugger: SetEvent(done_event) failed\n");
	trace("debugger: done debugging...\n");

	/* Just exit with a known value */
	ExitProcess(0xdeadbeef);
	}

	static void crash_and_debug(HKEY hkey, const char* argv0, const char* debugger)
	{
	DWORD ret;
	HANDLE start_event, done_event;
	char* cmd;
	char dbglog[MAX_PATH];
	char childlog[MAX_PATH];
	PROCESS_INFORMATION info;
	STARTUPINFOA startup;
	DWORD exit_code;
	DWORD pid1, pid2;

	ret=RegSetValueExA(hkey, "auto", 0, REG_SZ, (BYTE*)"1", 2);
	ok(ret == ERROR_SUCCESS, "unable to set AeDebug/auto: ret=%d\n", ret);

	get_file_name(dbglog);
	get_events(dbglog, &start_event, &done_event);
	cmd=HeapAlloc(GetProcessHeap(), 0, strlen(argv0)+10+strlen(debugger)+1+strlen(dbglog)+34+1);
	sprintf(cmd, "%s debugger %s %s %%ld %%ld", argv0, debugger, dbglog);
	ret=RegSetValueExA(hkey, "debugger", 0, REG_SZ, (BYTE*)cmd, strlen(cmd)+1);
	ok(ret == ERROR_SUCCESS, "unable to set AeDebug/debugger: ret=%d\n", ret);
	HeapFree(GetProcessHeap(), 0, cmd);

	get_file_name(childlog);
	cmd=HeapAlloc(GetProcessHeap(), 0, strlen(argv0)+16+strlen(dbglog)+1);
	sprintf(cmd, "%s debugger crash %s", argv0, childlog);

	memset(&startup, 0, sizeof(startup));
	startup.cb = sizeof(startup);
	startup.dwFlags = STARTF_USESHOWWINDOW;
	startup.wShowWindow = SW_SHOWNORMAL;
	ret=CreateProcessA(NULL, cmd, NULL, NULL, FALSE, 0, NULL, NULL, &startup, &info);
	ok(ret, "CreateProcess: err=%d\n", GetLastError());
	HeapFree(GetProcessHeap(), 0, cmd);
	CloseHandle(info.hThread);

	/* The process exits... */
	trace("waiting for child exit...\n");
	ok(WaitForSingleObject(info.hProcess, 60000) == WAIT_OBJECT_0, "Timed out waiting for the child to crash\n");
	ok(GetExitCodeProcess(info.hProcess, &exit_code), "GetExitCodeProcess failed: err=%d\n", GetLastError());
	ok(exit_code == STATUS_ACCESS_VIOLATION, "exit code = %08x\n", exit_code);
	CloseHandle(info.hProcess);

	/* ...before the debugger */
	if (strcmp(debugger, "dbgnoevent") != 0)
	ok(SetEvent(start_event), "SetEvent(start_event) failed\n");

	trace("waiting for the debugger...\n");
	ok(WaitForSingleObject(done_event, 60000) == WAIT_OBJECT_0, "Timed out waiting for the debugger\n");

	pid1=get_logged_pid(dbglog);
	pid2=get_logged_pid(childlog);
	ok(pid1 == pid2, "the child and debugged pids don't match: %d != %d\n", pid1, pid2);
	assert(DeleteFileA(dbglog) != 0);
	assert(DeleteFileA(childlog) != 0);
	}

	static void test_ExitCode(void)
	{
	static const char* AeDebug="Software\\Microsoft\\Windows NT\\CurrentVersion\\AeDebug";
	char test_exe[MAX_PATH];
	DWORD ret;
	HKEY hkey;
	DWORD disposition;
	LPBYTE auto_val=NULL;
	DWORD auto_size, auto_type;
	LPBYTE debugger_val=NULL;
	DWORD debugger_size, debugger_type;

	GetModuleFileNameA(GetModuleHandle(NULL), test_exe, sizeof(test_exe));
	if (GetFileAttributes(test_exe) == INVALID_FILE_ATTRIBUTES)
	strcat(test_exe, ".so");
	if (GetFileAttributesA(test_exe) == INVALID_FILE_ATTRIBUTES)
	{
	ok(0, "could not find the test executable '%s'\n", test_exe);
	return;
	}

	ret=RegCreateKeyExA(HKEY_LOCAL_MACHINE, AeDebug, 0, NULL, REG_OPTION_NON_VOLATILE, KEY_ALL_ACCESS, NULL, &hkey, &disposition);
	if (ret == ERROR_SUCCESS)
	{
	auto_size=0;
	ret=RegQueryValueExA(hkey, "auto", NULL, &auto_type, NULL, &auto_size);
	if (ret == ERROR_SUCCESS)
	{
	auto_val=HeapAlloc(GetProcessHeap(), 0, auto_size);
	RegQueryValueExA(hkey, "auto", NULL, &auto_type, auto_val, &auto_size);
	}

	debugger_size=0;
	ret=RegQueryValueExA(hkey, "debugger", NULL, &debugger_type, NULL, &debugger_size);
	if (ret == ERROR_SUCCESS)
	{
	debugger_val=HeapAlloc(GetProcessHeap(), 0, debugger_size);
	RegQueryValueExA(hkey, "debugger", NULL, &debugger_type, debugger_val, &debugger_size);
	}
	}
	else if (ret == ERROR_ACCESS_DENIED)
	{
	skip("not enough privileges to change the debugger\n");
	return;
	}
	else if (ret != ERROR_FILE_NOT_FOUND)
	{
	ok(0, "could not open the AeDebug key: %d\n", ret);
	return;
	}

	crash_and_debug(hkey, test_exe, "dbgevent");
	crash_and_debug(hkey, test_exe, "dbgnoevent");

	if (disposition == REG_CREATED_NEW_KEY)
	{
	RegCloseKey(hkey);
	RegDeleteKeyA(HKEY_LOCAL_MACHINE, AeDebug);
	}
	else
	{
	if (auto_val)
	{
	RegSetValueExA(hkey, "auto", 0, auto_type, auto_val, auto_size);
	HeapFree(GetProcessHeap(), 0, auto_val);
	}
	else
	RegDeleteValueA(hkey, "auto");
	if (debugger_val)
	{
	RegSetValueExA(hkey, "debugger", 0, debugger_type, debugger_val, debugger_size);
	HeapFree(GetProcessHeap(), 0, debugger_val);
	}
	else
	RegDeleteValueA(hkey, "debugger");
	RegCloseKey(hkey);
	}
	}

	START_TEST(debugger)
	{

	myARGC=winetest_get_mainargs(&myARGV);

	if (myARGC >= 3 && strcmp(myARGV[2], "crash") == 0)
	{
	doCrash(myARGC, myARGV);
	}
	else if (myARGC >= 3 &&
	(strcmp(myARGV[2], "dbgevent") == 0 \|\|
	strcmp(myARGV[2], "dbgnoevent") == 0))
	{
	doDebugger(myARGC, myARGV);
	}
	else
	{
	test_ExitCode();
	}
	}