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 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 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 no_lookup_name
, /* lookup_name */
81 no_open_file
, /* open_file */
82 no_close_handle
, /* close_handle */
83 debug_event_destroy
/* destroy */
86 static void debug_ctx_dump( struct object
*obj
, int verbose
);
87 static int debug_ctx_signaled( struct object
*obj
, struct thread
*thread
);
88 static void debug_ctx_destroy( struct object
*obj
);
90 static const struct object_ops debug_ctx_ops
=
92 sizeof(struct debug_ctx
), /* size */
93 debug_ctx_dump
, /* dump */
94 add_queue
, /* add_queue */
95 remove_queue
, /* remove_queue */
96 debug_ctx_signaled
, /* signaled */
97 no_satisfied
, /* satisfied */
98 no_signal
, /* signal */
99 no_get_fd
, /* get_fd */
100 no_map_access
, /* map_access */
101 no_lookup_name
, /* lookup_name */
102 no_open_file
, /* open_file */
103 no_close_handle
, /* close_handle */
104 debug_ctx_destroy
/* destroy */
108 /* routines to build an event according to its type */
110 static int fill_exception_event( struct debug_event
*event
, void *arg
)
112 memcpy( &event
->data
.info
.exception
, arg
, sizeof(event
->data
.info
.exception
) );
116 static int fill_create_thread_event( struct debug_event
*event
, void *arg
)
118 struct process
*debugger
= event
->debugger
->process
;
119 struct thread
*thread
= event
->sender
;
122 /* documented: THREAD_GET_CONTEXT | THREAD_SET_CONTEXT | THREAD_SUSPEND_RESUME */
123 if (!(handle
= alloc_handle( debugger
, thread
, THREAD_ALL_ACCESS
, 0 ))) return 0;
124 event
->data
.info
.create_thread
.handle
= handle
;
125 event
->data
.info
.create_thread
.teb
= thread
->teb
;
126 event
->data
.info
.create_thread
.start
= arg
;
130 static int fill_create_process_event( struct debug_event
*event
, void *arg
)
132 struct process
*debugger
= event
->debugger
->process
;
133 struct thread
*thread
= event
->sender
;
134 struct process
*process
= thread
->process
;
135 struct process_dll
*exe_module
= get_process_exe_module( process
);
138 /* documented: PROCESS_VM_READ | PROCESS_VM_WRITE */
139 if (!(handle
= alloc_handle( debugger
, process
, PROCESS_ALL_ACCESS
, 0 ))) return 0;
140 event
->data
.info
.create_process
.process
= handle
;
142 /* documented: THREAD_GET_CONTEXT | THREAD_SET_CONTEXT | THREAD_SUSPEND_RESUME */
143 if (!(handle
= alloc_handle( debugger
, thread
, THREAD_ALL_ACCESS
, 0 )))
145 close_handle( debugger
, event
->data
.info
.create_process
.process
);
148 event
->data
.info
.create_process
.thread
= handle
;
151 if (exe_module
->file
&&
152 /* the doc says write access too, but this doesn't seem a good idea */
153 !(handle
= alloc_handle( debugger
, exe_module
->file
, GENERIC_READ
, 0 )))
155 close_handle( debugger
, event
->data
.info
.create_process
.process
);
156 close_handle( debugger
, event
->data
.info
.create_process
.thread
);
159 event
->data
.info
.create_process
.file
= handle
;
160 event
->data
.info
.create_process
.teb
= thread
->teb
;
161 event
->data
.info
.create_process
.base
= exe_module
->base
;
162 event
->data
.info
.create_process
.start
= arg
;
163 event
->data
.info
.create_process
.dbg_offset
= exe_module
->dbg_offset
;
164 event
->data
.info
.create_process
.dbg_size
= exe_module
->dbg_size
;
165 event
->data
.info
.create_process
.name
= exe_module
->name
;
166 event
->data
.info
.create_process
.unicode
= 1;
170 static int fill_exit_thread_event( struct debug_event
*event
, void *arg
)
172 struct thread
*thread
= arg
;
173 event
->data
.info
.exit
.exit_code
= thread
->exit_code
;
177 static int fill_exit_process_event( struct debug_event
*event
, void *arg
)
179 struct process
*process
= arg
;
180 event
->data
.info
.exit
.exit_code
= process
->exit_code
;
184 static int fill_load_dll_event( struct debug_event
*event
, void *arg
)
186 struct process
*debugger
= event
->debugger
->process
;
187 struct process_dll
*dll
= arg
;
188 obj_handle_t handle
= 0;
190 if (dll
->file
&& !(handle
= alloc_handle( debugger
, dll
->file
, GENERIC_READ
, 0 )))
192 event
->data
.info
.load_dll
.handle
= handle
;
193 event
->data
.info
.load_dll
.base
= dll
->base
;
194 event
->data
.info
.load_dll
.dbg_offset
= dll
->dbg_offset
;
195 event
->data
.info
.load_dll
.dbg_size
= dll
->dbg_size
;
196 event
->data
.info
.load_dll
.name
= dll
->name
;
197 event
->data
.info
.load_dll
.unicode
= 1;
201 static int fill_unload_dll_event( struct debug_event
*event
, void *arg
)
203 event
->data
.info
.unload_dll
.base
= arg
;
207 static int fill_output_debug_string_event( struct debug_event
*event
, void *arg
)
209 struct debug_event_output_string
*data
= arg
;
210 event
->data
.info
.output_string
= *data
;
214 typedef int (*fill_event_func
)( struct debug_event
*event
, void *arg
);
216 #define NB_DEBUG_EVENTS OUTPUT_DEBUG_STRING_EVENT /* RIP_EVENT not supported */
218 static const fill_event_func fill_debug_event
[NB_DEBUG_EVENTS
] =
220 fill_exception_event
, /* EXCEPTION_DEBUG_EVENT */
221 fill_create_thread_event
, /* CREATE_THREAD_DEBUG_EVENT */
222 fill_create_process_event
, /* CREATE_PROCESS_DEBUG_EVENT */
223 fill_exit_thread_event
, /* EXIT_THREAD_DEBUG_EVENT */
224 fill_exit_process_event
, /* EXIT_PROCESS_DEBUG_EVENT */
225 fill_load_dll_event
, /* LOAD_DLL_DEBUG_EVENT */
226 fill_unload_dll_event
, /* UNLOAD_DLL_DEBUG_EVENT */
227 fill_output_debug_string_event
/* OUTPUT_DEBUG_STRING_EVENT */
231 /* unlink the first event from the queue */
232 static void unlink_event( struct debug_ctx
*debug_ctx
, struct debug_event
*event
)
234 list_remove( &event
->entry
);
235 if (event
->sender
->debug_event
== event
) event
->sender
->debug_event
= NULL
;
236 release_object( event
);
239 /* link an event at the end of the queue */
240 static void link_event( struct debug_event
*event
)
242 struct debug_ctx
*debug_ctx
= event
->debugger
->debug_ctx
;
245 grab_object( event
);
246 list_add_tail( &debug_ctx
->event_queue
, &event
->entry
);
247 if (!event
->sender
->debug_event
) wake_up( &debug_ctx
->obj
, 0 );
250 /* find the next event that we can send to the debugger */
251 static struct debug_event
*find_event_to_send( struct debug_ctx
*debug_ctx
)
253 struct debug_event
*event
;
255 LIST_FOR_EACH_ENTRY( event
, &debug_ctx
->event_queue
, struct debug_event
, entry
)
257 if (event
->state
== EVENT_SENT
) continue; /* already sent */
258 if (event
->sender
->debug_event
) continue; /* thread busy with another one */
264 static void debug_event_dump( struct object
*obj
, int verbose
)
266 struct debug_event
*debug_event
= (struct debug_event
*)obj
;
267 assert( obj
->ops
== &debug_event_ops
);
268 fprintf( stderr
, "Debug event sender=%p code=%d state=%d\n",
269 debug_event
->sender
, debug_event
->data
.code
, debug_event
->state
);
272 static int debug_event_signaled( struct object
*obj
, struct thread
*thread
)
274 struct debug_event
*debug_event
= (struct debug_event
*)obj
;
275 assert( obj
->ops
== &debug_event_ops
);
276 return debug_event
->state
== EVENT_CONTINUED
;
279 static void debug_event_destroy( struct object
*obj
)
281 struct debug_event
*event
= (struct debug_event
*)obj
;
282 assert( obj
->ops
== &debug_event_ops
);
284 /* If the event has been sent already, the handles are now under the */
285 /* responsibility of the debugger process, so we don't touch them */
286 if (event
->state
== EVENT_QUEUED
)
288 struct process
*debugger
= event
->debugger
->process
;
289 switch(event
->data
.code
)
291 case CREATE_THREAD_DEBUG_EVENT
:
292 close_handle( debugger
, event
->data
.info
.create_thread
.handle
);
294 case CREATE_PROCESS_DEBUG_EVENT
:
295 if (event
->data
.info
.create_process
.file
)
296 close_handle( debugger
, event
->data
.info
.create_process
.file
);
297 close_handle( debugger
, event
->data
.info
.create_process
.thread
);
298 close_handle( debugger
, event
->data
.info
.create_process
.process
);
300 case LOAD_DLL_DEBUG_EVENT
:
301 if (event
->data
.info
.load_dll
.handle
)
302 close_handle( debugger
, event
->data
.info
.load_dll
.handle
);
306 if (event
->sender
->context
== &event
->context
) event
->sender
->context
= NULL
;
307 release_object( event
->sender
);
308 release_object( event
->debugger
);
311 static void debug_ctx_dump( struct object
*obj
, int verbose
)
313 struct debug_ctx
*debug_ctx
= (struct debug_ctx
*)obj
;
314 assert( obj
->ops
== &debug_ctx_ops
);
315 fprintf( stderr
, "Debug context head=%p tail=%p\n",
316 debug_ctx
->event_queue
.next
, debug_ctx
->event_queue
.prev
);
319 static int debug_ctx_signaled( struct object
*obj
, struct thread
*thread
)
321 struct debug_ctx
*debug_ctx
= (struct debug_ctx
*)obj
;
322 assert( obj
->ops
== &debug_ctx_ops
);
323 return find_event_to_send( debug_ctx
) != NULL
;
326 static void debug_ctx_destroy( struct object
*obj
)
329 struct debug_ctx
*debug_ctx
= (struct debug_ctx
*)obj
;
330 assert( obj
->ops
== &debug_ctx_ops
);
332 /* free all pending events */
333 while ((ptr
= list_head( &debug_ctx
->event_queue
)))
334 unlink_event( debug_ctx
, LIST_ENTRY( ptr
, struct debug_event
, entry
));
337 /* continue a debug event */
338 static int continue_debug_event( struct process
*process
, struct thread
*thread
, int status
)
340 struct debug_ctx
*debug_ctx
= current
->debug_ctx
;
342 if (debug_ctx
&& process
->debugger
== current
&& thread
->process
== process
)
344 struct debug_event
*event
;
346 /* find the event in the queue */
347 LIST_FOR_EACH_ENTRY( event
, &debug_ctx
->event_queue
, struct debug_event
, entry
)
349 if (event
->state
!= EVENT_SENT
) continue;
350 if (event
->sender
== thread
)
352 assert( event
->sender
->debug_event
== event
);
354 event
->status
= status
;
355 event
->state
= EVENT_CONTINUED
;
356 wake_up( &event
->obj
, 0 );
357 unlink_event( debug_ctx
, event
);
358 resume_process( process
);
363 /* not debugging this process, or no such event */
364 set_error( STATUS_ACCESS_DENIED
); /* FIXME */
368 /* alloc a debug event for a debugger */
369 static struct debug_event
*alloc_debug_event( struct thread
*thread
, int code
,
370 void *arg
, const CONTEXT
*context
)
372 struct thread
*debugger
= thread
->process
->debugger
;
373 struct debug_event
*event
;
375 assert( code
> 0 && code
<= NB_DEBUG_EVENTS
);
376 /* cannot queue a debug event for myself */
377 assert( debugger
->process
!= thread
->process
);
379 /* build the event */
380 if (!(event
= alloc_object( &debug_event_ops
))) return NULL
;
381 event
->state
= EVENT_QUEUED
;
382 event
->sender
= (struct thread
*)grab_object( thread
);
383 event
->debugger
= (struct thread
*)grab_object( debugger
);
384 event
->data
.code
= code
;
386 if (!fill_debug_event
[code
-1]( event
, arg
))
388 event
->data
.code
= -1; /* make sure we don't attempt to close handles */
389 release_object( event
);
394 memcpy( &event
->context
, context
, sizeof(event
->context
) );
395 thread
->context
= &event
->context
;
400 /* generate a debug event from inside the server and queue it */
401 void generate_debug_event( struct thread
*thread
, int code
, void *arg
)
403 if (thread
->process
->debugger
)
405 struct debug_event
*event
= alloc_debug_event( thread
, code
, arg
, NULL
);
409 suspend_process( thread
->process
);
410 release_object( event
);
415 /* attach a process to a debugger thread and suspend it */
416 static int debugger_attach( struct process
*process
, struct thread
*debugger
)
418 struct thread
*thread
;
420 if (process
->debugger
) goto error
; /* already being debugged */
421 if (!is_process_init_done( process
)) goto error
; /* still starting up */
422 if (list_empty( &process
->thread_list
)) goto error
; /* no thread running in the process */
424 /* make sure we don't create a debugging loop */
425 for (thread
= debugger
; thread
; thread
= thread
->process
->debugger
)
426 if (thread
->process
== process
) goto error
;
428 /* don't let a debugger debug its console... won't work */
429 if (debugger
->process
->console
&& debugger
->process
->console
->renderer
->process
== process
)
432 suspend_process( process
);
433 if (!set_process_debugger( process
, debugger
))
435 resume_process( process
);
438 if (!set_process_debug_flag( process
, 1 ))
440 process
->debugger
= NULL
;
441 resume_process( process
);
447 set_error( STATUS_ACCESS_DENIED
);
452 /* detach a process from a debugger thread (and resume it ?) */
453 int debugger_detach( struct process
*process
, struct thread
*debugger
)
455 struct debug_event
*event
;
456 struct debug_ctx
*debug_ctx
;
458 if (!process
->debugger
|| process
->debugger
!= debugger
)
459 goto error
; /* not currently debugged, or debugged by another debugger */
460 if (!debugger
->debug_ctx
) goto error
; /* should be a debugger */
461 /* init should be done, otherwise wouldn't be attached */
462 assert(is_process_init_done(process
));
464 suspend_process( process
);
465 /* send continue indication for all events */
466 debug_ctx
= debugger
->debug_ctx
;
468 /* find the event in the queue
469 * FIXME: could loop on process' threads and look the debug_event field */
470 LIST_FOR_EACH_ENTRY( event
, &debug_ctx
->event_queue
, struct debug_event
, entry
)
472 if (event
->state
!= EVENT_QUEUED
) continue;
474 if (event
->sender
->process
== process
)
476 assert( event
->sender
->debug_event
== event
);
477 event
->status
= DBG_CONTINUE
;
478 event
->state
= EVENT_CONTINUED
;
479 wake_up( &event
->obj
, 0 );
480 unlink_event( debug_ctx
, event
);
481 /* from queued debug event */
482 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
);
496 set_error( STATUS_ACCESS_DENIED
);
500 /* generate all startup events of a given process */
501 void generate_startup_debug_events( struct process
*process
, void *entry
)
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
);
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
);
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
;
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
, thread
->exit_code
);
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
);
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 */
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
);
599 struct thread
*thread
= get_thread_from_id( req
->tid
);
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;
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
)
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
);
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 )))
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
;
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
);
715 current
->debug_ctx
->kill_on_exit
= req
->kill_on_exit
;