winedump: Add support for dumping SZ_LINK and SPECIAL_FOLDER data blocks.
[wine.git] / server / debugger.c
blob37ddd689c693b249d9b9e781fed905a6d7f77491
1 /*
2 * Server-side debugger functions
4 * Copyright (C) 1999 Alexandre Julliard
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
21 #include "config.h"
22 #include "wine/port.h"
24 #include <assert.h>
25 #include <signal.h>
26 #include <string.h>
27 #include <stdarg.h>
28 #include <stdio.h>
30 #include "ntstatus.h"
31 #define WIN32_NO_STATUS
32 #include "windef.h"
33 #include "winternl.h"
35 #include "handle.h"
36 #include "process.h"
37 #include "thread.h"
38 #include "request.h"
40 enum debug_event_state { EVENT_QUEUED, EVENT_SENT, EVENT_CONTINUED };
42 /* debug event */
43 struct debug_event
45 struct object obj; /* object header */
46 struct list entry; /* entry in event queue */
47 struct thread *sender; /* thread which sent this event */
48 struct thread *debugger; /* debugger thread receiving the event */
49 enum debug_event_state state; /* event state */
50 int status; /* continuation status */
51 debug_event_t data; /* event data */
52 CONTEXT context; /* register context */
55 /* debug context */
56 struct debug_ctx
58 struct object obj; /* object header */
59 struct list event_queue; /* pending events queue */
60 int kill_on_exit;/* kill debuggees on debugger exit ? */
64 static void debug_event_dump( struct object *obj, int verbose );
65 static int debug_event_signaled( struct object *obj, struct thread *thread );
66 static void debug_event_destroy( struct object *obj );
68 static const struct object_ops debug_event_ops =
70 sizeof(struct debug_event), /* size */
71 debug_event_dump, /* dump */
72 no_get_type, /* get_type */
73 add_queue, /* add_queue */
74 remove_queue, /* remove_queue */
75 debug_event_signaled, /* signaled */
76 no_satisfied, /* satisfied */
77 no_signal, /* signal */
78 no_get_fd, /* get_fd */
79 no_map_access, /* map_access */
80 default_get_sd, /* get_sd */
81 default_set_sd, /* set_sd */
82 no_lookup_name, /* lookup_name */
83 no_open_file, /* open_file */
84 no_close_handle, /* close_handle */
85 debug_event_destroy /* destroy */
88 static void debug_ctx_dump( struct object *obj, int verbose );
89 static int debug_ctx_signaled( struct object *obj, struct thread *thread );
90 static void debug_ctx_destroy( struct object *obj );
92 static const struct object_ops debug_ctx_ops =
94 sizeof(struct debug_ctx), /* size */
95 debug_ctx_dump, /* dump */
96 no_get_type, /* get_type */
97 add_queue, /* add_queue */
98 remove_queue, /* remove_queue */
99 debug_ctx_signaled, /* signaled */
100 no_satisfied, /* satisfied */
101 no_signal, /* signal */
102 no_get_fd, /* get_fd */
103 no_map_access, /* map_access */
104 default_get_sd, /* get_sd */
105 default_set_sd, /* set_sd */
106 no_lookup_name, /* lookup_name */
107 no_open_file, /* open_file */
108 no_close_handle, /* close_handle */
109 debug_ctx_destroy /* destroy */
113 /* routines to build an event according to its type */
115 static int fill_exception_event( struct debug_event *event, void *arg )
117 memcpy( &event->data.info.exception, arg, sizeof(event->data.info.exception) );
118 return 1;
121 static int fill_create_thread_event( struct debug_event *event, void *arg )
123 struct process *debugger = event->debugger->process;
124 struct thread *thread = event->sender;
125 obj_handle_t handle;
127 /* documented: THREAD_GET_CONTEXT | THREAD_SET_CONTEXT | THREAD_SUSPEND_RESUME */
128 if (!(handle = alloc_handle( debugger, thread, THREAD_ALL_ACCESS, 0 ))) return 0;
129 event->data.info.create_thread.handle = handle;
130 event->data.info.create_thread.teb = thread->teb;
131 event->data.info.create_thread.start = arg;
132 return 1;
135 static int fill_create_process_event( struct debug_event *event, void *arg )
137 struct process *debugger = event->debugger->process;
138 struct thread *thread = event->sender;
139 struct process *process = thread->process;
140 struct process_dll *exe_module = get_process_exe_module( process );
141 obj_handle_t handle;
143 /* documented: PROCESS_VM_READ | PROCESS_VM_WRITE */
144 if (!(handle = alloc_handle( debugger, process, PROCESS_ALL_ACCESS, 0 ))) return 0;
145 event->data.info.create_process.process = handle;
147 /* documented: THREAD_GET_CONTEXT | THREAD_SET_CONTEXT | THREAD_SUSPEND_RESUME */
148 if (!(handle = alloc_handle( debugger, thread, THREAD_ALL_ACCESS, 0 )))
150 close_handle( debugger, event->data.info.create_process.process );
151 return 0;
153 event->data.info.create_process.thread = handle;
155 handle = 0;
156 if (exe_module->file &&
157 /* the doc says write access too, but this doesn't seem a good idea */
158 !(handle = alloc_handle( debugger, exe_module->file, GENERIC_READ, 0 )))
160 close_handle( debugger, event->data.info.create_process.process );
161 close_handle( debugger, event->data.info.create_process.thread );
162 return 0;
164 event->data.info.create_process.file = handle;
165 event->data.info.create_process.teb = thread->teb;
166 event->data.info.create_process.base = exe_module->base;
167 event->data.info.create_process.start = arg;
168 event->data.info.create_process.dbg_offset = exe_module->dbg_offset;
169 event->data.info.create_process.dbg_size = exe_module->dbg_size;
170 event->data.info.create_process.name = exe_module->name;
171 event->data.info.create_process.unicode = 1;
172 return 1;
175 static int fill_exit_thread_event( struct debug_event *event, void *arg )
177 struct thread *thread = arg;
178 event->data.info.exit.exit_code = thread->exit_code;
179 return 1;
182 static int fill_exit_process_event( struct debug_event *event, void *arg )
184 struct process *process = arg;
185 event->data.info.exit.exit_code = process->exit_code;
186 return 1;
189 static int fill_load_dll_event( struct debug_event *event, void *arg )
191 struct process *debugger = event->debugger->process;
192 struct process_dll *dll = arg;
193 obj_handle_t handle = 0;
195 if (dll->file && !(handle = alloc_handle( debugger, dll->file, GENERIC_READ, 0 )))
196 return 0;
197 event->data.info.load_dll.handle = handle;
198 event->data.info.load_dll.base = dll->base;
199 event->data.info.load_dll.dbg_offset = dll->dbg_offset;
200 event->data.info.load_dll.dbg_size = dll->dbg_size;
201 event->data.info.load_dll.name = dll->name;
202 event->data.info.load_dll.unicode = 1;
203 return 1;
206 static int fill_unload_dll_event( struct debug_event *event, void *arg )
208 event->data.info.unload_dll.base = arg;
209 return 1;
212 static int fill_output_debug_string_event( struct debug_event *event, void *arg )
214 struct debug_event_output_string *data = arg;
215 event->data.info.output_string = *data;
216 return 1;
219 typedef int (*fill_event_func)( struct debug_event *event, void *arg );
221 #define NB_DEBUG_EVENTS OUTPUT_DEBUG_STRING_EVENT /* RIP_EVENT not supported */
223 static const fill_event_func fill_debug_event[NB_DEBUG_EVENTS] =
225 fill_exception_event, /* EXCEPTION_DEBUG_EVENT */
226 fill_create_thread_event, /* CREATE_THREAD_DEBUG_EVENT */
227 fill_create_process_event, /* CREATE_PROCESS_DEBUG_EVENT */
228 fill_exit_thread_event, /* EXIT_THREAD_DEBUG_EVENT */
229 fill_exit_process_event, /* EXIT_PROCESS_DEBUG_EVENT */
230 fill_load_dll_event, /* LOAD_DLL_DEBUG_EVENT */
231 fill_unload_dll_event, /* UNLOAD_DLL_DEBUG_EVENT */
232 fill_output_debug_string_event /* OUTPUT_DEBUG_STRING_EVENT */
236 /* unlink the first event from the queue */
237 static void unlink_event( struct debug_ctx *debug_ctx, struct debug_event *event )
239 list_remove( &event->entry );
240 if (event->sender->debug_event == event) event->sender->debug_event = NULL;
241 release_object( event );
244 /* link an event at the end of the queue */
245 static void link_event( struct debug_event *event )
247 struct debug_ctx *debug_ctx = event->debugger->debug_ctx;
249 assert( debug_ctx );
250 grab_object( event );
251 list_add_tail( &debug_ctx->event_queue, &event->entry );
252 if (!event->sender->debug_event) wake_up( &debug_ctx->obj, 0 );
255 /* find the next event that we can send to the debugger */
256 static struct debug_event *find_event_to_send( struct debug_ctx *debug_ctx )
258 struct debug_event *event;
260 LIST_FOR_EACH_ENTRY( event, &debug_ctx->event_queue, struct debug_event, entry )
262 if (event->state == EVENT_SENT) continue; /* already sent */
263 if (event->sender->debug_event) continue; /* thread busy with another one */
264 return event;
266 return NULL;
269 static void debug_event_dump( struct object *obj, int verbose )
271 struct debug_event *debug_event = (struct debug_event *)obj;
272 assert( obj->ops == &debug_event_ops );
273 fprintf( stderr, "Debug event sender=%p code=%d state=%d\n",
274 debug_event->sender, debug_event->data.code, debug_event->state );
277 static int debug_event_signaled( struct object *obj, struct thread *thread )
279 struct debug_event *debug_event = (struct debug_event *)obj;
280 assert( obj->ops == &debug_event_ops );
281 return debug_event->state == EVENT_CONTINUED;
284 static void debug_event_destroy( struct object *obj )
286 struct debug_event *event = (struct debug_event *)obj;
287 assert( obj->ops == &debug_event_ops );
289 /* If the event has been sent already, the handles are now under the */
290 /* responsibility of the debugger process, so we don't touch them */
291 if (event->state == EVENT_QUEUED)
293 struct process *debugger = event->debugger->process;
294 switch(event->data.code)
296 case CREATE_THREAD_DEBUG_EVENT:
297 close_handle( debugger, event->data.info.create_thread.handle );
298 break;
299 case CREATE_PROCESS_DEBUG_EVENT:
300 if (event->data.info.create_process.file)
301 close_handle( debugger, event->data.info.create_process.file );
302 close_handle( debugger, event->data.info.create_process.thread );
303 close_handle( debugger, event->data.info.create_process.process );
304 break;
305 case LOAD_DLL_DEBUG_EVENT:
306 if (event->data.info.load_dll.handle)
307 close_handle( debugger, event->data.info.load_dll.handle );
308 break;
311 if (event->sender->context == &event->context) event->sender->context = NULL;
312 release_object( event->sender );
313 release_object( event->debugger );
316 static void debug_ctx_dump( struct object *obj, int verbose )
318 struct debug_ctx *debug_ctx = (struct debug_ctx *)obj;
319 assert( obj->ops == &debug_ctx_ops );
320 fprintf( stderr, "Debug context head=%p tail=%p\n",
321 debug_ctx->event_queue.next, debug_ctx->event_queue.prev );
324 static int debug_ctx_signaled( struct object *obj, struct thread *thread )
326 struct debug_ctx *debug_ctx = (struct debug_ctx *)obj;
327 assert( obj->ops == &debug_ctx_ops );
328 return find_event_to_send( debug_ctx ) != NULL;
331 static void debug_ctx_destroy( struct object *obj )
333 struct list *ptr;
334 struct debug_ctx *debug_ctx = (struct debug_ctx *)obj;
335 assert( obj->ops == &debug_ctx_ops );
337 /* free all pending events */
338 while ((ptr = list_head( &debug_ctx->event_queue )))
339 unlink_event( debug_ctx, LIST_ENTRY( ptr, struct debug_event, entry ));
342 /* continue a debug event */
343 static int continue_debug_event( struct process *process, struct thread *thread, int status )
345 struct debug_ctx *debug_ctx = current->debug_ctx;
347 if (debug_ctx && process->debugger == current && thread->process == process)
349 struct debug_event *event;
351 /* find the event in the queue */
352 LIST_FOR_EACH_ENTRY( event, &debug_ctx->event_queue, struct debug_event, entry )
354 if (event->state != EVENT_SENT) continue;
355 if (event->sender == thread)
357 assert( event->sender->debug_event == event );
359 event->status = status;
360 event->state = EVENT_CONTINUED;
361 wake_up( &event->obj, 0 );
362 unlink_event( debug_ctx, event );
363 resume_process( process );
364 return 1;
368 /* not debugging this process, or no such event */
369 set_error( STATUS_ACCESS_DENIED ); /* FIXME */
370 return 0;
373 /* alloc a debug event for a debugger */
374 static struct debug_event *alloc_debug_event( struct thread *thread, int code,
375 void *arg, const CONTEXT *context )
377 struct thread *debugger = thread->process->debugger;
378 struct debug_event *event;
380 assert( code > 0 && code <= NB_DEBUG_EVENTS );
381 /* cannot queue a debug event for myself */
382 assert( debugger->process != thread->process );
384 /* build the event */
385 if (!(event = alloc_object( &debug_event_ops ))) return NULL;
386 event->state = EVENT_QUEUED;
387 event->sender = (struct thread *)grab_object( thread );
388 event->debugger = (struct thread *)grab_object( debugger );
389 event->data.code = code;
391 if (!fill_debug_event[code-1]( event, arg ))
393 event->data.code = -1; /* make sure we don't attempt to close handles */
394 release_object( event );
395 return NULL;
397 if (context)
399 memcpy( &event->context, context, sizeof(event->context) );
400 thread->context = &event->context;
402 return event;
405 /* generate a debug event from inside the server and queue it */
406 void generate_debug_event( struct thread *thread, int code, void *arg )
408 if (thread->process->debugger)
410 struct debug_event *event = alloc_debug_event( thread, code, arg, NULL );
411 if (event)
413 link_event( event );
414 suspend_process( thread->process );
415 release_object( event );
420 /* attach a process to a debugger thread and suspend it */
421 static int debugger_attach( struct process *process, struct thread *debugger )
423 struct thread *thread;
425 if (process->debugger) goto error; /* already being debugged */
426 if (!is_process_init_done( process )) goto error; /* still starting up */
427 if (list_empty( &process->thread_list )) goto error; /* no thread running in the process */
429 /* make sure we don't create a debugging loop */
430 for (thread = debugger; thread; thread = thread->process->debugger)
431 if (thread->process == process) goto error;
433 /* don't let a debugger debug its console... won't work */
434 if (debugger->process->console && console_get_renderer(debugger->process->console)->process == process)
435 goto error;
437 suspend_process( process );
438 if (!set_process_debugger( process, debugger ))
440 resume_process( process );
441 return 0;
443 if (!set_process_debug_flag( process, 1 ))
445 process->debugger = NULL;
446 resume_process( process );
447 return 0;
449 return 1;
451 error:
452 set_error( STATUS_ACCESS_DENIED );
453 return 0;
457 /* detach a process from a debugger thread (and resume it ?) */
458 int debugger_detach( struct process *process, struct thread *debugger )
460 struct debug_event *event, *next;
461 struct debug_ctx *debug_ctx;
463 if (!process->debugger || process->debugger != debugger)
464 goto error; /* not currently debugged, or debugged by another debugger */
465 if (!debugger->debug_ctx ) goto error; /* should be a debugger */
466 /* init should be done, otherwise wouldn't be attached */
467 assert(is_process_init_done(process));
469 suspend_process( process );
470 /* send continue indication for all events */
471 debug_ctx = debugger->debug_ctx;
473 /* free all events from this process */
474 LIST_FOR_EACH_ENTRY_SAFE( event, next, &debug_ctx->event_queue, struct debug_event, entry )
476 if (event->sender->process != process) continue;
478 assert( event->state != EVENT_CONTINUED );
479 event->status = DBG_CONTINUE;
480 event->state = EVENT_CONTINUED;
481 wake_up( &event->obj, 0 );
482 unlink_event( debug_ctx, event );
483 /* from queued debug event */
484 resume_process( process );
487 /* remove relationships between process and its debugger */
488 process->debugger = NULL;
489 if (!set_process_debug_flag( process, 0 )) clear_error(); /* ignore error */
491 /* from this function */
492 resume_process( process );
493 return 0;
495 error:
496 set_error( STATUS_ACCESS_DENIED );
497 return 0;
500 /* generate all startup events of a given process */
501 void generate_startup_debug_events( struct process *process, void *entry )
503 struct list *ptr;
504 struct thread *thread, *first_thread = get_process_first_thread( process );
506 /* generate creation events */
507 LIST_FOR_EACH_ENTRY( thread, &process->thread_list, struct thread, proc_entry )
509 if (thread == first_thread)
510 generate_debug_event( thread, CREATE_PROCESS_DEBUG_EVENT, entry );
511 else
512 generate_debug_event( thread, CREATE_THREAD_DEBUG_EVENT, NULL );
515 /* generate dll events (in loading order, i.e. reverse list order) */
516 ptr = list_tail( &process->dlls );
517 while (ptr)
519 struct process_dll *dll = LIST_ENTRY( ptr, struct process_dll, entry );
520 generate_debug_event( first_thread, LOAD_DLL_DEBUG_EVENT, dll );
521 ptr = list_prev( &process->dlls, ptr );
525 /* set the debugger of a given process */
526 int set_process_debugger( struct process *process, struct thread *debugger )
528 struct debug_ctx *debug_ctx;
530 assert( !process->debugger );
532 if (!debugger->debug_ctx) /* need to allocate a context */
534 if (!(debug_ctx = alloc_object( &debug_ctx_ops ))) return 0;
535 debug_ctx->kill_on_exit = 1;
536 list_init( &debug_ctx->event_queue );
537 debugger->debug_ctx = debug_ctx;
539 process->debugger = debugger;
540 return 1;
543 /* a thread is exiting */
544 void debug_exit_thread( struct thread *thread )
546 if (thread->debug_ctx) /* this thread is a debugger */
548 if (thread->debug_ctx->kill_on_exit)
550 /* kill all debugged processes */
551 kill_debugged_processes( thread, STATUS_DEBUGGER_INACTIVE );
553 else
555 detach_debugged_processes( thread );
557 release_object( thread->debug_ctx );
558 thread->debug_ctx = NULL;
562 /* Wait for a debug event */
563 DECL_HANDLER(wait_debug_event)
565 struct debug_ctx *debug_ctx = current->debug_ctx;
566 struct debug_event *event;
568 if (!debug_ctx) /* current thread is not a debugger */
570 set_error( STATUS_INVALID_HANDLE );
571 return;
573 reply->wait = 0;
574 if ((event = find_event_to_send( debug_ctx )))
576 data_size_t size = get_reply_max_size();
577 event->state = EVENT_SENT;
578 event->sender->debug_event = event;
579 reply->pid = get_process_id( event->sender->process );
580 reply->tid = get_thread_id( event->sender );
581 if (size > sizeof(debug_event_t)) size = sizeof(debug_event_t);
582 set_reply_data( &event->data, size );
584 else /* no event ready */
586 reply->pid = 0;
587 reply->tid = 0;
588 if (req->get_handle)
589 reply->wait = alloc_handle( current->process, debug_ctx, SYNCHRONIZE, 0 );
593 /* Continue a debug event */
594 DECL_HANDLER(continue_debug_event)
596 struct process *process = get_process_from_id( req->pid );
597 if (process)
599 struct thread *thread = get_thread_from_id( req->tid );
600 if (thread)
602 continue_debug_event( process, thread, req->status );
603 release_object( thread );
605 release_object( process );
609 /* Start debugging an existing process */
610 DECL_HANDLER(debug_process)
612 struct process *process = get_process_from_id( req->pid );
613 if (!process) return;
615 if (!req->attach)
617 debugger_detach( process, current );
619 else if (debugger_attach( process, current ))
621 generate_startup_debug_events( process, NULL );
622 break_process( process );
623 resume_process( process );
625 release_object( process );
628 /* queue an exception event */
629 DECL_HANDLER(queue_exception_event)
631 reply->handle = 0;
632 if (current->process->debugger)
634 struct debug_event_exception data;
635 struct debug_event *event;
636 const CONTEXT *context = get_req_data();
637 const EXCEPTION_RECORD *rec = (const EXCEPTION_RECORD *)(context + 1);
639 if (get_req_data_size() < sizeof(*rec) + sizeof(*context))
641 set_error( STATUS_INVALID_PARAMETER );
642 return;
644 data.record = *rec;
645 data.first = req->first;
646 if ((event = alloc_debug_event( current, EXCEPTION_DEBUG_EVENT, &data, context )))
648 if ((reply->handle = alloc_handle( current->process, event, SYNCHRONIZE, 0 )))
650 link_event( event );
651 suspend_process( current->process );
653 release_object( event );
658 /* retrieve the status of an exception event */
659 DECL_HANDLER(get_exception_status)
661 struct debug_event *event;
663 if ((event = (struct debug_event *)get_handle_obj( current->process, req->handle,
664 0, &debug_event_ops )))
666 close_handle( current->process, req->handle );
667 if (event->state == EVENT_CONTINUED)
669 if (current->context == &event->context)
671 data_size_t size = min( sizeof(CONTEXT), get_reply_max_size() );
672 set_reply_data( &event->context, size );
673 current->context = NULL;
675 set_error( event->status );
677 else set_error( STATUS_PENDING );
678 release_object( event );
682 /* send an output string to the debugger */
683 DECL_HANDLER(output_debug_string)
685 struct debug_event_output_string data;
687 data.string = req->string;
688 data.unicode = req->unicode;
689 data.length = req->length;
690 generate_debug_event( current, OUTPUT_DEBUG_STRING_EVENT, &data );
693 /* simulate a breakpoint in a process */
694 DECL_HANDLER(debug_break)
696 struct process *process;
698 reply->self = 0;
699 if ((process = get_process_from_handle( req->handle, PROCESS_SET_INFORMATION /*FIXME*/ )))
701 if (process != current->process) break_process( process );
702 else reply->self = 1;
703 release_object( process );
707 /* set debugger kill on exit flag */
708 DECL_HANDLER(set_debugger_kill_on_exit)
710 if (!current->debug_ctx)
712 set_error( STATUS_ACCESS_DENIED );
713 return;
715 current->debug_ctx->kill_on_exit = req->kill_on_exit;