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
22 #include "wine/port.h"
31 #define WIN32_NO_STATUS
41 enum debug_event_state { EVENT_QUEUED, EVENT_SENT, EVENT_CONTINUED };
46 struct object obj; /* object header */
47 struct list entry; /* entry in event queue */
48 struct thread *sender; /* thread which sent this event */
49 struct thread *debugger; /* debugger thread receiving the event */
50 enum debug_event_state state; /* event state */
51 int status; /* continuation status */
52 debug_event_t data; /* event data */
53 context_t context; /* register context */
59 struct object obj; /* object header */
60 struct list event_queue; /* pending events queue */
61 int kill_on_exit;/* kill debuggees on debugger exit ? */
65 static void debug_event_dump( struct object *obj, int verbose );
66 static int debug_event_signaled( struct object *obj, struct thread *thread );
67 static void debug_event_destroy( struct object *obj );
69 static const struct object_ops debug_event_ops =
71 sizeof(struct debug_event), /* size */
72 debug_event_dump, /* dump */
73 no_get_type, /* get_type */
74 add_queue, /* add_queue */
75 remove_queue, /* remove_queue */
76 debug_event_signaled, /* signaled */
77 no_satisfied, /* satisfied */
78 no_signal, /* signal */
79 no_get_fd, /* get_fd */
80 no_map_access, /* map_access */
81 default_get_sd, /* get_sd */
82 default_set_sd, /* set_sd */
83 no_lookup_name, /* lookup_name */
84 no_open_file, /* open_file */
85 no_close_handle, /* close_handle */
86 debug_event_destroy /* destroy */
89 static void debug_ctx_dump( struct object *obj, int verbose );
90 static int debug_ctx_signaled( struct object *obj, struct thread *thread );
91 static void debug_ctx_destroy( struct object *obj );
93 static const struct object_ops debug_ctx_ops =
95 sizeof(struct debug_ctx), /* size */
96 debug_ctx_dump, /* dump */
97 no_get_type, /* get_type */
98 add_queue, /* add_queue */
99 remove_queue, /* remove_queue */
100 debug_ctx_signaled, /* signaled */
101 no_satisfied, /* satisfied */
102 no_signal, /* signal */
103 no_get_fd, /* get_fd */
104 no_map_access, /* map_access */
105 default_get_sd, /* get_sd */
106 default_set_sd, /* set_sd */
107 no_lookup_name, /* lookup_name */
108 no_open_file, /* open_file */
109 no_close_handle, /* close_handle */
110 debug_ctx_destroy /* destroy */
114 /* routines to build an event according to its type */
116 static int fill_exception_event( struct debug_event *event, const void *arg )
118 const debug_event_t *data = arg;
119 event->data.exception = data->exception;
120 event->data.exception.nb_params = min( event->data.exception.nb_params, EXCEPTION_MAXIMUM_PARAMETERS );
124 static int fill_create_thread_event( struct debug_event *event, const void *arg )
126 struct process *debugger = event->debugger->process;
127 struct thread *thread = event->sender;
128 const client_ptr_t *entry = arg;
131 /* documented: THREAD_GET_CONTEXT | THREAD_SET_CONTEXT | THREAD_SUSPEND_RESUME */
132 if (!(handle = alloc_handle( debugger, thread, THREAD_ALL_ACCESS, 0 ))) return 0;
133 event->data.create_thread.handle = handle;
134 event->data.create_thread.teb = thread->teb;
135 if (entry) event->data.create_thread.start = *entry;
139 static int fill_create_process_event( struct debug_event *event, const void *arg )
141 struct process *debugger = event->debugger->process;
142 struct thread *thread = event->sender;
143 struct process *process = thread->process;
144 struct process_dll *exe_module = get_process_exe_module( process );
145 const client_ptr_t *entry = arg;
148 /* documented: PROCESS_VM_READ | PROCESS_VM_WRITE */
149 if (!(handle = alloc_handle( debugger, process, PROCESS_ALL_ACCESS, 0 ))) return 0;
150 event->data.create_process.process = handle;
152 /* documented: THREAD_GET_CONTEXT | THREAD_SET_CONTEXT | THREAD_SUSPEND_RESUME */
153 if (!(handle = alloc_handle( debugger, thread, THREAD_ALL_ACCESS, 0 )))
155 close_handle( debugger, event->data.create_process.process );
158 event->data.create_process.thread = handle;
161 if (exe_module->mapping &&
162 /* the doc says write access too, but this doesn't seem a good idea */
163 !(handle = open_mapping_file( debugger, exe_module->mapping, GENERIC_READ, 0 )))
165 close_handle( debugger, event->data.create_process.process );
166 close_handle( debugger, event->data.create_process.thread );
169 event->data.create_process.file = handle;
170 event->data.create_process.teb = thread->teb;
171 event->data.create_process.base = exe_module->base;
172 event->data.create_process.start = *entry;
173 event->data.create_process.dbg_offset = exe_module->dbg_offset;
174 event->data.create_process.dbg_size = exe_module->dbg_size;
175 event->data.create_process.name = exe_module->name;
176 event->data.create_process.unicode = 1;
180 static int fill_exit_thread_event( struct debug_event *event, const void *arg )
182 const struct thread *thread = arg;
183 event->data.exit.exit_code = thread->exit_code;
187 static int fill_exit_process_event( struct debug_event *event, const void *arg )
189 const struct process *process = arg;
190 event->data.exit.exit_code = process->exit_code;
194 static int fill_load_dll_event( struct debug_event *event, const void *arg )
196 struct process *debugger = event->debugger->process;
197 const struct process_dll *dll = arg;
198 obj_handle_t handle = 0;
200 if (dll->mapping && !(handle = open_mapping_file( debugger, dll->mapping, GENERIC_READ, 0 )))
202 event->data.load_dll.handle = handle;
203 event->data.load_dll.base = dll->base;
204 event->data.load_dll.dbg_offset = dll->dbg_offset;
205 event->data.load_dll.dbg_size = dll->dbg_size;
206 event->data.load_dll.name = dll->name;
207 event->data.load_dll.unicode = 1;
211 static int fill_unload_dll_event( struct debug_event *event, const void *arg )
213 const mod_handle_t *base = arg;
214 event->data.unload_dll.base = *base;
218 static int fill_output_debug_string_event( struct debug_event *event, const void *arg )
220 const debug_event_t *data = arg;
221 event->data.output_string = data->output_string;
225 typedef int (*fill_event_func)( struct debug_event *event, const void *arg );
227 #define NB_DEBUG_EVENTS OUTPUT_DEBUG_STRING_EVENT /* RIP_EVENT not supported */
229 static const fill_event_func fill_debug_event[NB_DEBUG_EVENTS] =
231 fill_exception_event, /* EXCEPTION_DEBUG_EVENT */
232 fill_create_thread_event, /* CREATE_THREAD_DEBUG_EVENT */
233 fill_create_process_event, /* CREATE_PROCESS_DEBUG_EVENT */
234 fill_exit_thread_event, /* EXIT_THREAD_DEBUG_EVENT */
235 fill_exit_process_event, /* EXIT_PROCESS_DEBUG_EVENT */
236 fill_load_dll_event, /* LOAD_DLL_DEBUG_EVENT */
237 fill_unload_dll_event, /* UNLOAD_DLL_DEBUG_EVENT */
238 fill_output_debug_string_event /* OUTPUT_DEBUG_STRING_EVENT */
242 /* unlink the first event from the queue */
243 static void unlink_event( struct debug_ctx *debug_ctx, struct debug_event *event )
245 list_remove( &event->entry );
246 if (event->sender->debug_event == event) event->sender->debug_event = NULL;
247 release_object( event );
250 /* link an event at the end of the queue */
251 static void link_event( struct debug_event *event )
253 struct debug_ctx *debug_ctx = event->debugger->debug_ctx;
256 grab_object( event );
257 list_add_tail( &debug_ctx->event_queue, &event->entry );
258 if (!event->sender->debug_event) wake_up( &debug_ctx->obj, 0 );
261 /* find the next event that we can send to the debugger */
262 static struct debug_event *find_event_to_send( struct debug_ctx *debug_ctx )
264 struct debug_event *event;
266 LIST_FOR_EACH_ENTRY( event, &debug_ctx->event_queue, struct debug_event, entry )
268 if (event->state == EVENT_SENT) continue; /* already sent */
269 if (event->sender->debug_event) continue; /* thread busy with another one */
275 static void debug_event_dump( struct object *obj, int verbose )
277 struct debug_event *debug_event = (struct debug_event *)obj;
278 assert( obj->ops == &debug_event_ops );
279 fprintf( stderr, "Debug event sender=%p code=%d state=%d\n",
280 debug_event->sender, debug_event->data.code, debug_event->state );
283 static int debug_event_signaled( struct object *obj, struct thread *thread )
285 struct debug_event *debug_event = (struct debug_event *)obj;
286 assert( obj->ops == &debug_event_ops );
287 return debug_event->state == EVENT_CONTINUED;
290 static void debug_event_destroy( struct object *obj )
292 struct debug_event *event = (struct debug_event *)obj;
293 assert( obj->ops == &debug_event_ops );
295 /* If the event has been sent already, the handles are now under the */
296 /* responsibility of the debugger process, so we don't touch them */
297 if (event->state == EVENT_QUEUED)
299 struct process *debugger = event->debugger->process;
300 switch(event->data.code)
302 case CREATE_THREAD_DEBUG_EVENT:
303 close_handle( debugger, event->data.create_thread.handle );
305 case CREATE_PROCESS_DEBUG_EVENT:
306 if (event->data.create_process.file)
307 close_handle( debugger, event->data.create_process.file );
308 close_handle( debugger, event->data.create_process.thread );
309 close_handle( debugger, event->data.create_process.process );
311 case LOAD_DLL_DEBUG_EVENT:
312 if (event->data.load_dll.handle)
313 close_handle( debugger, event->data.load_dll.handle );
317 if (event->sender->context == &event->context) event->sender->context = NULL;
318 release_object( event->sender );
319 release_object( event->debugger );
322 static void debug_ctx_dump( struct object *obj, int verbose )
324 struct debug_ctx *debug_ctx = (struct debug_ctx *)obj;
325 assert( obj->ops == &debug_ctx_ops );
326 fprintf( stderr, "Debug context head=%p tail=%p\n",
327 debug_ctx->event_queue.next, debug_ctx->event_queue.prev );
330 static int debug_ctx_signaled( struct object *obj, struct thread *thread )
332 struct debug_ctx *debug_ctx = (struct debug_ctx *)obj;
333 assert( obj->ops == &debug_ctx_ops );
334 return find_event_to_send( debug_ctx ) != NULL;
337 static void debug_ctx_destroy( struct object *obj )
340 struct debug_ctx *debug_ctx = (struct debug_ctx *)obj;
341 assert( obj->ops == &debug_ctx_ops );
343 /* free all pending events */
344 while ((ptr = list_head( &debug_ctx->event_queue )))
345 unlink_event( debug_ctx, LIST_ENTRY( ptr, struct debug_event, entry ));
348 /* continue a debug event */
349 static int continue_debug_event( struct process *process, struct thread *thread, int status )
351 struct debug_ctx *debug_ctx = current->debug_ctx;
353 if (debug_ctx && process->debugger == current && thread->process == process)
355 struct debug_event *event;
357 /* find the event in the queue */
358 LIST_FOR_EACH_ENTRY( event, &debug_ctx->event_queue, struct debug_event, entry )
360 if (event->state != EVENT_SENT) continue;
361 if (event->sender == thread)
363 assert( event->sender->debug_event == event );
365 event->status = status;
366 event->state = EVENT_CONTINUED;
367 wake_up( &event->obj, 0 );
368 unlink_event( debug_ctx, event );
369 resume_process( process );
374 /* not debugging this process, or no such event */
375 set_error( STATUS_ACCESS_DENIED ); /* FIXME */
379 /* alloc a debug event for a debugger */
380 static struct debug_event *alloc_debug_event( struct thread *thread, int code, const void *arg )
382 struct thread *debugger = thread->process->debugger;
383 struct debug_event *event;
385 assert( code > 0 && code <= NB_DEBUG_EVENTS );
386 /* cannot queue a debug event for myself */
387 assert( debugger->process != thread->process );
389 /* build the event */
390 if (!(event = alloc_object( &debug_event_ops ))) return NULL;
391 event->state = EVENT_QUEUED;
392 event->sender = (struct thread *)grab_object( thread );
393 event->debugger = (struct thread *)grab_object( debugger );
394 memset( &event->data, 0, sizeof(event->data) );
396 if (!fill_debug_event[code-1]( event, arg ))
398 event->data.code = -1; /* make sure we don't attempt to close handles */
399 release_object( event );
402 event->data.code = code;
406 /* generate a debug event from inside the server and queue it */
407 void generate_debug_event( struct thread *thread, int code, const void *arg )
409 if (thread->process->debugger)
411 struct debug_event *event = alloc_debug_event( thread, code, arg );
415 suspend_process( thread->process );
416 release_object( event );
418 clear_error(); /* ignore errors */
422 /* attach a process to a debugger thread and suspend it */
423 static int debugger_attach( struct process *process, struct thread *debugger )
425 if (process->debugger) goto error; /* already being debugged */
426 if (debugger->process == process) goto error;
427 if (!is_process_init_done( process )) goto error; /* still starting up */
428 if (list_empty( &process->thread_list )) goto error; /* no thread running in the process */
430 /* don't let a debugger debug its console... won't work */
431 if (debugger->process->console)
433 struct thread *renderer = console_get_renderer(debugger->process->console);
434 if (renderer && renderer->process == process)
438 suspend_process( process );
439 if (!set_process_debugger( process, debugger ))
441 resume_process( process );
444 if (!set_process_debug_flag( process, 1 ))
446 process->debugger = NULL;
447 resume_process( process );
453 set_error( STATUS_ACCESS_DENIED );
458 /* detach a process from a debugger thread (and resume it ?) */
459 int debugger_detach( struct process *process, struct thread *debugger )
461 struct debug_event *event, *next;
462 struct debug_ctx *debug_ctx;
464 if (!process->debugger || process->debugger != debugger)
465 goto error; /* not currently debugged, or debugged by another debugger */
466 if (!debugger->debug_ctx ) goto error; /* should be a debugger */
467 /* init should be done, otherwise wouldn't be attached */
468 assert(is_process_init_done(process));
470 suspend_process( process );
471 /* send continue indication for all events */
472 debug_ctx = debugger->debug_ctx;
474 /* free all events from this process */
475 LIST_FOR_EACH_ENTRY_SAFE( event, next, &debug_ctx->event_queue, struct debug_event, entry )
477 if (event->sender->process != process) continue;
479 assert( event->state != EVENT_CONTINUED );
480 event->status = DBG_CONTINUE;
481 event->state = EVENT_CONTINUED;
482 wake_up( &event->obj, 0 );
483 unlink_event( debug_ctx, event );
484 /* from queued debug event */
485 resume_process( process );
488 /* remove relationships between process and its debugger */
489 process->debugger = NULL;
490 if (!set_process_debug_flag( process, 0 )) clear_error(); /* ignore error */
492 /* from this function */
493 resume_process( process );
497 set_error( STATUS_ACCESS_DENIED );
501 /* generate all startup events of a given process */
502 void generate_startup_debug_events( struct process *process, client_ptr_t entry )
505 struct thread *thread, *first_thread = get_process_first_thread( process );
507 /* generate creation events */
508 LIST_FOR_EACH_ENTRY( thread, &process->thread_list, struct thread, proc_entry )
510 if (thread == first_thread)
511 generate_debug_event( thread, CREATE_PROCESS_DEBUG_EVENT, &entry );
513 generate_debug_event( thread, CREATE_THREAD_DEBUG_EVENT, NULL );
516 /* generate dll events (in loading order, i.e. reverse list order) */
517 ptr = list_tail( &process->dlls );
518 while (ptr != list_head( &process->dlls ))
520 struct process_dll *dll = LIST_ENTRY( ptr, struct process_dll, entry );
521 generate_debug_event( first_thread, LOAD_DLL_DEBUG_EVENT, dll );
522 ptr = list_prev( &process->dlls, ptr );
526 /* set the debugger of a given process */
527 int set_process_debugger( struct process *process, struct thread *debugger )
529 struct debug_ctx *debug_ctx;
531 assert( !process->debugger );
533 if (!debugger->debug_ctx) /* need to allocate a context */
535 if (!(debug_ctx = alloc_object( &debug_ctx_ops ))) return 0;
536 debug_ctx->kill_on_exit = 1;
537 list_init( &debug_ctx->event_queue );
538 debugger->debug_ctx = debug_ctx;
540 process->debugger = debugger;
544 /* a thread is exiting */
545 void debug_exit_thread( struct thread *thread )
547 if (thread->debug_ctx) /* this thread is a debugger */
549 if (thread->debug_ctx->kill_on_exit)
551 /* kill all debugged processes */
552 kill_debugged_processes( thread, STATUS_DEBUGGER_INACTIVE );
556 detach_debugged_processes( thread );
558 release_object( thread->debug_ctx );
559 thread->debug_ctx = NULL;
563 /* Wait for a debug event */
564 DECL_HANDLER(wait_debug_event)
566 struct debug_ctx *debug_ctx = current->debug_ctx;
567 struct debug_event *event;
569 if (!debug_ctx) /* current thread is not a debugger */
571 set_error( STATUS_INVALID_HANDLE );
575 if ((event = find_event_to_send( debug_ctx )))
577 data_size_t size = get_reply_max_size();
578 event->state = EVENT_SENT;
579 event->sender->debug_event = event;
580 reply->pid = get_process_id( event->sender->process );
581 reply->tid = get_thread_id( event->sender );
582 if (size > sizeof(debug_event_t)) size = sizeof(debug_event_t);
583 set_reply_data( &event->data, size );
585 else /* no event ready */
590 reply->wait = alloc_handle( current->process, debug_ctx, SYNCHRONIZE, 0 );
594 /* Continue a debug event */
595 DECL_HANDLER(continue_debug_event)
597 struct process *process = get_process_from_id( req->pid );
600 struct thread *thread = get_thread_from_id( req->tid );
603 continue_debug_event( process, thread, req->status );
604 release_object( thread );
606 release_object( process );
610 /* Start debugging an existing process */
611 DECL_HANDLER(debug_process)
613 struct process *process = get_process_from_id( req->pid );
614 if (!process) return;
618 debugger_detach( process, current );
620 else if (debugger_attach( process, current ))
622 generate_startup_debug_events( process, 0 );
623 break_process( process );
624 resume_process( process );
626 release_object( process );
629 /* queue an exception event */
630 DECL_HANDLER(queue_exception_event)
633 if (current->process->debugger)
636 struct debug_event *event;
638 if ((req->len % sizeof(client_ptr_t)) != 0 ||
639 req->len > get_req_data_size() ||
640 req->len > EXCEPTION_MAXIMUM_PARAMETERS * sizeof(client_ptr_t))
642 set_error( STATUS_INVALID_PARAMETER );
645 memset( &data, 0, sizeof(data) );
646 data.exception.first = req->first;
647 data.exception.exc_code = req->code;
648 data.exception.flags = req->flags;
649 data.exception.record = req->record;
650 data.exception.address = req->address;
651 data.exception.nb_params = req->len / sizeof(client_ptr_t);
652 memcpy( data.exception.params, get_req_data(), req->len );
654 if ((event = alloc_debug_event( current, EXCEPTION_DEBUG_EVENT, &data )))
656 const context_t *context = (const context_t *)((const char *)get_req_data() + req->len);
657 data_size_t size = get_req_data_size() - req->len;
659 memset( &event->context, 0, sizeof(event->context) );
660 memcpy( &event->context, context, min( sizeof(event->context), size ) );
661 current->context = &event->context;
663 if ((reply->handle = alloc_handle( current->process, event, SYNCHRONIZE, 0 )))
666 suspend_process( current->process );
668 release_object( event );
673 /* retrieve the status of an exception event */
674 DECL_HANDLER(get_exception_status)
676 struct debug_event *event;
678 if ((event = (struct debug_event *)get_handle_obj( current->process, req->handle,
679 0, &debug_event_ops )))
681 close_handle( current->process, req->handle );
682 if (event->state == EVENT_CONTINUED)
684 if (current->context == &event->context)
686 data_size_t size = min( sizeof(context_t), get_reply_max_size() );
687 set_reply_data( &event->context, size );
688 current->context = NULL;
690 set_error( event->status );
692 else set_error( STATUS_PENDING );
693 release_object( event );
697 /* send an output string to the debugger */
698 DECL_HANDLER(output_debug_string)
702 data.output_string.string = req->string;
703 data.output_string.length = req->length;
704 generate_debug_event( current, OUTPUT_DEBUG_STRING_EVENT, &data );
707 /* simulate a breakpoint in a process */
708 DECL_HANDLER(debug_break)
710 struct process *process;
713 if ((process = get_process_from_handle( req->handle, PROCESS_SET_INFORMATION /*FIXME*/ )))
715 if (process != current->process) break_process( process );
716 else reply->self = 1;
717 release_object( process );
721 /* set debugger kill on exit flag */
722 DECL_HANDLER(set_debugger_kill_on_exit)
724 if (!current->debug_ctx)
726 set_error( STATUS_ACCESS_DENIED );
729 current->debug_ctx->kill_on_exit = req->kill_on_exit;