dlls: Assorted spelling fixes.
[wine] / dlls / kernel32 / debugger.c
1 /*
2  * Win32 debugger functions
3  *
4  * Copyright (C) 1999 Alexandre Julliard
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 "config.h"
22 #include <stdio.h>
23 #include <string.h>
24
25 #include "ntstatus.h"
26 #define WIN32_NO_STATUS
27 #include "winerror.h"
28 #include "wine/server.h"
29 #include "kernel_private.h"
30 #include "wine/debug.h"
31
32 WINE_DEFAULT_DEBUG_CHANNEL(debugstr);
33
34
35 /******************************************************************************
36  *           WaitForDebugEvent   (KERNEL32.@)
37  *
38  *  Waits for a debugging event to occur in a process being debugged before
39  *  filling out the debug event structure.
40  *
41  * PARAMS
42  *  event   [O] Address of structure for event information.
43  *  timeout [I] Number of milliseconds to wait for event.
44  *
45  * RETURNS
46  *
47  *  Returns true if a debug event occurred and false if the call timed out.
48  */
49 BOOL WINAPI WaitForDebugEvent(
50     LPDEBUG_EVENT event,
51     DWORD         timeout)
52 {
53     BOOL ret;
54     DWORD i, res;
55
56     for (;;)
57     {
58         HANDLE wait = 0;
59         debug_event_t data;
60         SERVER_START_REQ( wait_debug_event )
61         {
62             req->get_handle = (timeout != 0);
63             wine_server_set_reply( req, &data, sizeof(data) );
64             if (!(ret = !wine_server_call_err( req ))) goto done;
65
66             if (!wine_server_reply_size(reply))  /* timeout */
67             {
68                 wait = wine_server_ptr_handle( reply->wait );
69                 ret = FALSE;
70                 goto done;
71             }
72             event->dwDebugEventCode = data.code;
73             event->dwProcessId      = (DWORD)reply->pid;
74             event->dwThreadId       = (DWORD)reply->tid;
75             switch(data.code)
76             {
77             case EXCEPTION_DEBUG_EVENT:
78                 event->u.Exception.dwFirstChance = data.exception.first;
79                 event->u.Exception.ExceptionRecord.ExceptionCode    = data.exception.exc_code;
80                 event->u.Exception.ExceptionRecord.ExceptionFlags   = data.exception.flags;
81                 event->u.Exception.ExceptionRecord.ExceptionRecord  = wine_server_get_ptr( data.exception.record );
82                 event->u.Exception.ExceptionRecord.ExceptionAddress = wine_server_get_ptr( data.exception.address );
83                 event->u.Exception.ExceptionRecord.NumberParameters = data.exception.nb_params;
84                 for (i = 0; i < data.exception.nb_params; i++)
85                     event->u.Exception.ExceptionRecord.ExceptionInformation[i] = data.exception.params[i];
86                 break;
87             case CREATE_THREAD_DEBUG_EVENT:
88                 event->u.CreateThread.hThread           = wine_server_ptr_handle( data.create_thread.handle );
89                 event->u.CreateThread.lpThreadLocalBase = wine_server_get_ptr( data.create_thread.teb );
90                 event->u.CreateThread.lpStartAddress    = wine_server_get_ptr( data.create_thread.start );
91                 break;
92             case CREATE_PROCESS_DEBUG_EVENT:
93                 event->u.CreateProcessInfo.hFile                 = wine_server_ptr_handle( data.create_process.file );
94                 event->u.CreateProcessInfo.hProcess              = wine_server_ptr_handle( data.create_process.process );
95                 event->u.CreateProcessInfo.hThread               = wine_server_ptr_handle( data.create_process.thread );
96                 event->u.CreateProcessInfo.lpBaseOfImage         = wine_server_get_ptr( data.create_process.base );
97                 event->u.CreateProcessInfo.dwDebugInfoFileOffset = data.create_process.dbg_offset;
98                 event->u.CreateProcessInfo.nDebugInfoSize        = data.create_process.dbg_size;
99                 event->u.CreateProcessInfo.lpThreadLocalBase     = wine_server_get_ptr( data.create_process.teb );
100                 event->u.CreateProcessInfo.lpStartAddress        = wine_server_get_ptr( data.create_process.start );
101                 event->u.CreateProcessInfo.lpImageName           = wine_server_get_ptr( data.create_process.name );
102                 event->u.CreateProcessInfo.fUnicode              = data.create_process.unicode;
103                 break;
104             case EXIT_THREAD_DEBUG_EVENT:
105                 event->u.ExitThread.dwExitCode = data.exit.exit_code;
106                 break;
107             case EXIT_PROCESS_DEBUG_EVENT:
108                 event->u.ExitProcess.dwExitCode = data.exit.exit_code;
109                 break;
110             case LOAD_DLL_DEBUG_EVENT:
111                 event->u.LoadDll.hFile                 = wine_server_ptr_handle( data.load_dll.handle );
112                 event->u.LoadDll.lpBaseOfDll           = wine_server_get_ptr( data.load_dll.base );
113                 event->u.LoadDll.dwDebugInfoFileOffset = data.load_dll.dbg_offset;
114                 event->u.LoadDll.nDebugInfoSize        = data.load_dll.dbg_size;
115                 event->u.LoadDll.lpImageName           = wine_server_get_ptr( data.load_dll.name );
116                 event->u.LoadDll.fUnicode              = data.load_dll.unicode;
117                 break;
118             case UNLOAD_DLL_DEBUG_EVENT:
119                 event->u.UnloadDll.lpBaseOfDll = wine_server_get_ptr( data.unload_dll.base );
120                 break;
121             case OUTPUT_DEBUG_STRING_EVENT:
122                 event->u.DebugString.lpDebugStringData  = wine_server_get_ptr( data.output_string.string );
123                 event->u.DebugString.fUnicode           = FALSE;
124                 event->u.DebugString.nDebugStringLength = data.output_string.length;
125                 break;
126             case RIP_EVENT:
127                 event->u.RipInfo.dwError = data.rip_info.error;
128                 event->u.RipInfo.dwType  = data.rip_info.type;
129                 break;
130             }
131         done:
132             /* nothing */ ;
133         }
134         SERVER_END_REQ;
135         if (ret) return TRUE;
136         if (!wait) break;
137         res = WaitForSingleObject( wait, timeout );
138         CloseHandle( wait );
139         if (res != STATUS_WAIT_0) break;
140     }
141     SetLastError( ERROR_SEM_TIMEOUT );
142     return FALSE;
143 }
144
145
146 /**********************************************************************
147  *           ContinueDebugEvent   (KERNEL32.@)
148  *
149  *  Enables a thread that previously produced a debug event to continue.
150  *
151  * PARAMS
152  *  pid    [I] The id of the process to continue.
153  *  tid    [I] The id of the thread to continue.
154  *  status [I] The rule to apply to unhandled exeptions.
155  *
156  * RETURNS
157  *
158  *  True if the debugger is listed as the processes owner and the process
159  *  and thread are valid.
160  */
161 BOOL WINAPI ContinueDebugEvent(
162     DWORD pid,
163     DWORD tid,
164     DWORD status)
165 {
166     BOOL ret;
167     SERVER_START_REQ( continue_debug_event )
168     {
169         req->pid    = pid;
170         req->tid    = tid;
171         req->status = status;
172         ret = !wine_server_call_err( req );
173     }
174     SERVER_END_REQ;
175     return ret;
176 }
177
178
179 /**********************************************************************
180  *           DebugActiveProcess   (KERNEL32.@)
181  *
182  *  Attempts to attach the debugger to a process.
183  *
184  * PARAMS
185  *  pid [I] The process to be debugged.
186  *
187  * RETURNS
188  *
189  *  True if the debugger was attached to process.
190  */
191 BOOL WINAPI DebugActiveProcess( DWORD pid )
192 {
193     BOOL ret;
194     SERVER_START_REQ( debug_process )
195     {
196         req->pid = pid;
197         req->attach = 1;
198         ret = !wine_server_call_err( req );
199     }
200     SERVER_END_REQ;
201     return ret;
202 }
203
204 /**********************************************************************
205  *           DebugActiveProcessStop   (KERNEL32.@)
206  *
207  *  Attempts to detach the debugger from a process.
208  *
209  * PARAMS
210  *  pid [I] The process to be detached.
211  *
212  * RETURNS
213  *
214  *  True if the debugger was detached from the process.
215  */
216 BOOL WINAPI DebugActiveProcessStop( DWORD pid )
217 {
218     BOOL ret;
219     SERVER_START_REQ( debug_process )
220     {
221         req->pid = pid;
222         req->attach = 0;
223         ret = !wine_server_call_err( req );
224     }
225     SERVER_END_REQ;
226     return ret;
227 }
228
229
230 /***********************************************************************
231  *           OutputDebugStringA   (KERNEL32.@)
232  *
233  *  Output by an application of an ascii string to a debugger (if attached)
234  *  and program log.
235  *
236  * PARAMS
237  *  str [I] The message to be logged and given to the debugger.
238  *
239  * RETURNS
240  *
241  *  Nothing.
242  */
243 void WINAPI OutputDebugStringA( LPCSTR str )
244 {
245     static HANDLE DBWinMutex = NULL;
246     static BOOL mutex_inited = FALSE;
247
248     /* send string to attached debugger */
249     SERVER_START_REQ( output_debug_string )
250     {
251         req->string  = wine_server_client_ptr( str );
252         req->length  = strlen(str) + 1;
253         wine_server_call( req );
254     }
255     SERVER_END_REQ;
256
257     WARN("%s\n", debugstr_a(str));
258
259     /* send string to a system-wide monitor */
260     /* FIXME should only send to monitor if no debuggers are attached */
261
262     if (!mutex_inited)
263     {
264         /* first call to OutputDebugString, initialize mutex handle */
265         static const WCHAR mutexname[] = {'D','B','W','i','n','M','u','t','e','x',0};
266         HANDLE mutex = CreateMutexExW( NULL, mutexname, 0, SYNCHRONIZE );
267         if (mutex)
268         {
269             if (InterlockedCompareExchangePointer( &DBWinMutex, mutex, 0 ) != 0)
270             {
271                 /* someone beat us here... */
272                 CloseHandle( mutex );
273             }
274         }
275         mutex_inited = TRUE;
276     }
277
278     if (DBWinMutex)
279     {
280         static const WCHAR shmname[] = {'D','B','W','I','N','_','B','U','F','F','E','R',0};
281         static const WCHAR eventbuffername[] = {'D','B','W','I','N','_','B','U','F','F','E','R','_','R','E','A','D','Y',0};
282         static const WCHAR eventdataname[] = {'D','B','W','I','N','_','D','A','T','A','_','R','E','A','D','Y',0};
283         HANDLE mapping;
284
285         mapping = OpenFileMappingW( FILE_MAP_WRITE, FALSE, shmname );
286         if (mapping)
287         {
288             LPVOID buffer;
289             HANDLE eventbuffer, eventdata;
290
291             buffer = MapViewOfFile( mapping, FILE_MAP_WRITE, 0, 0, 0 );
292             eventbuffer = OpenEventW( SYNCHRONIZE, FALSE, eventbuffername );
293             eventdata = OpenEventW( EVENT_MODIFY_STATE, FALSE, eventdataname );
294
295             if (buffer && eventbuffer && eventdata)
296             {
297                 /* monitor is present, synchronize with other OutputDebugString invocations */
298                 WaitForSingleObject( DBWinMutex, INFINITE );
299
300                 /* acquire control over the buffer */
301                 if (WaitForSingleObject( eventbuffer, 10000 ) == WAIT_OBJECT_0)
302                 {
303                     int str_len;
304                     struct _mon_buffer_t {
305                         DWORD pid;
306                         char buffer[1];
307                     } *mon_buffer = (struct _mon_buffer_t*) buffer;
308
309                     str_len = strlen( str );
310                     if (str_len > (4096 - sizeof(DWORD) - 1))
311                         str_len = 4096 - sizeof(DWORD) - 1;
312
313                     mon_buffer->pid = GetCurrentProcessId();
314                     memcpy( mon_buffer->buffer, str, str_len );
315                     mon_buffer->buffer[str_len] = 0;
316
317                     /* signal data ready */
318                     SetEvent( eventdata );
319                 }
320                 ReleaseMutex( DBWinMutex );
321             }
322
323             if (buffer)
324                 UnmapViewOfFile( buffer );
325             if (eventbuffer)
326                 CloseHandle( eventbuffer );
327             if (eventdata)
328                 CloseHandle( eventdata );
329             CloseHandle( mapping );
330         }
331     }
332 }
333
334
335 /***********************************************************************
336  *           OutputDebugStringW   (KERNEL32.@)
337  *
338  *  Output by an application of a unicode string to a debugger (if attached)
339  *  and program log.
340  *
341  * PARAMS
342  *  str [I] The message to be logged and given to the debugger.
343  *
344  * RETURNS
345  *
346  *  Nothing.
347  */
348 void WINAPI OutputDebugStringW( LPCWSTR str )
349 {
350     UNICODE_STRING strW;
351     STRING strA;
352
353     RtlInitUnicodeString( &strW, str );
354     if (!RtlUnicodeStringToAnsiString( &strA, &strW, TRUE ))
355     {
356         OutputDebugStringA( strA.Buffer );
357         RtlFreeAnsiString( &strA );
358     }
359 }
360
361
362 /***********************************************************************
363  *           DebugBreak   (KERNEL32.@)
364  *
365  *  Raises an exception so that a debugger (if attached)
366  *  can take some action.
367  */
368 #if defined(__i386__) || defined(__x86_64__)
369 __ASM_STDCALL_FUNC( DebugBreak, 0, "jmp " __ASM_NAME("DbgBreakPoint") )
370 #else
371 void WINAPI DebugBreak(void)
372 {
373     DbgBreakPoint();
374 }
375 #endif
376
377 /***********************************************************************
378  *           DebugBreakProcess   (KERNEL32.@)
379  *
380  *  Raises an exception so that a debugger (if attached)
381  *  can take some action. Same as DebugBreak, but applies to any process.
382  *
383  * PARAMS
384  *  hProc [I] Process to break into.
385  *
386  * RETURNS
387  *
388  *  True if successful.
389  */
390 BOOL WINAPI DebugBreakProcess(HANDLE hProc)
391 {
392     BOOL ret, self;
393
394     TRACE("(%p)\n", hProc);
395
396     SERVER_START_REQ( debug_break )
397     {
398         req->handle = wine_server_obj_handle( hProc );
399         ret = !wine_server_call_err( req );
400         self = ret && reply->self;
401     }
402     SERVER_END_REQ;
403     if (self) DbgBreakPoint();
404     return ret;
405 }
406
407
408 /***********************************************************************
409  *           IsDebuggerPresent   (KERNEL32.@)
410  *
411  *  Allows a process to determine if there is a debugger attached.
412  *
413  * PARAMS
414  *
415  * RETURNS
416  *
417  *  True if there is a debugger attached.
418  */
419 BOOL WINAPI IsDebuggerPresent(void)
420 {
421     return NtCurrentTeb()->Peb->BeingDebugged;
422 }
423
424 /***********************************************************************
425  *           CheckRemoteDebuggerPresent   (KERNEL32.@)
426  *
427  *  Allows a process to determine if there is a remote debugger
428  *  attached.
429  *
430  * PARAMS
431  *
432  * RETURNS
433  *
434  *  TRUE because it is a stub.
435  */
436 BOOL WINAPI CheckRemoteDebuggerPresent(HANDLE process, PBOOL DebuggerPresent)
437 {
438     NTSTATUS status;
439     DWORD_PTR port;
440
441     if(!process || !DebuggerPresent)
442     {
443         SetLastError(ERROR_INVALID_PARAMETER);
444         return FALSE;
445     }
446
447     status = NtQueryInformationProcess(process, ProcessDebugPort, &port, sizeof(port), NULL);
448     if (status != STATUS_SUCCESS)
449     {
450         SetLastError(RtlNtStatusToDosError(status));
451         return FALSE;
452     }
453
454     *DebuggerPresent = !!port;
455     return TRUE;
456 }
457
458 /***********************************************************************
459  *           DebugSetProcessKillOnExit                    (KERNEL32.@)
460  *
461  * Let a debugger decide whether a debuggee will be killed upon debugger
462  * termination.
463  *
464  * PARAMS
465  *  kill [I] If set to true then kill the process on exit.
466  *
467  * RETURNS
468  *  True if successful, false otherwise.
469  */
470 BOOL WINAPI DebugSetProcessKillOnExit(BOOL kill)
471 {
472     BOOL ret = FALSE;
473
474     SERVER_START_REQ( set_debugger_kill_on_exit )
475     {
476         req->kill_on_exit = kill;
477         ret = !wine_server_call_err( req );
478     }
479     SERVER_END_REQ;
480     return ret;
481 }