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_close_handle
, /* close_handle */
82 debug_event_destroy
/* destroy */
85 static void debug_ctx_dump( struct object
*obj
, int verbose
);
86 static int debug_ctx_signaled( struct object
*obj
, struct thread
*thread
);
87 static void debug_ctx_destroy( struct object
*obj
);
89 static const struct object_ops debug_ctx_ops
=
91 sizeof(struct debug_ctx
), /* size */
92 debug_ctx_dump
, /* dump */
93 add_queue
, /* add_queue */
94 remove_queue
, /* remove_queue */
95 debug_ctx_signaled
, /* signaled */
96 no_satisfied
, /* satisfied */
97 no_signal
, /* signal */
98 no_get_fd
, /* get_fd */
99 no_map_access
, /* map_access */
100 no_lookup_name
, /* lookup_name */
101 no_close_handle
, /* close_handle */
102 debug_ctx_destroy
/* destroy */
106 /* routines to build an event according to its type */
108 static int fill_exception_event( struct debug_event
*event
, void *arg
)
110 memcpy( &event
->data
.info
.exception
, arg
, sizeof(event
->data
.info
.exception
) );
114 static int fill_create_thread_event( struct debug_event
*event
, void *arg
)
116 struct process
*debugger
= event
->debugger
->process
;
117 struct thread
*thread
= event
->sender
;
120 /* documented: THREAD_GET_CONTEXT | THREAD_SET_CONTEXT | THREAD_SUSPEND_RESUME */
121 if (!(handle
= alloc_handle( debugger
, thread
, THREAD_ALL_ACCESS
, 0 ))) return 0;
122 event
->data
.info
.create_thread
.handle
= handle
;
123 event
->data
.info
.create_thread
.teb
= thread
->teb
;
124 event
->data
.info
.create_thread
.start
= arg
;
128 static int fill_create_process_event( struct debug_event
*event
, void *arg
)
130 struct process
*debugger
= event
->debugger
->process
;
131 struct thread
*thread
= event
->sender
;
132 struct process
*process
= thread
->process
;
133 struct process_dll
*exe_module
= get_process_exe_module( process
);
136 /* documented: PROCESS_VM_READ | PROCESS_VM_WRITE */
137 if (!(handle
= alloc_handle( debugger
, process
, PROCESS_ALL_ACCESS
, 0 ))) return 0;
138 event
->data
.info
.create_process
.process
= handle
;
140 /* documented: THREAD_GET_CONTEXT | THREAD_SET_CONTEXT | THREAD_SUSPEND_RESUME */
141 if (!(handle
= alloc_handle( debugger
, thread
, THREAD_ALL_ACCESS
, 0 )))
143 close_handle( debugger
, event
->data
.info
.create_process
.process
, NULL
);
146 event
->data
.info
.create_process
.thread
= handle
;
149 if (exe_module
->file
&&
150 /* the doc says write access too, but this doesn't seem a good idea */
151 !(handle
= alloc_handle( debugger
, exe_module
->file
, GENERIC_READ
, 0 )))
153 close_handle( debugger
, event
->data
.info
.create_process
.process
, NULL
);
154 close_handle( debugger
, event
->data
.info
.create_process
.thread
, NULL
);
157 event
->data
.info
.create_process
.file
= handle
;
158 event
->data
.info
.create_process
.teb
= thread
->teb
;
159 event
->data
.info
.create_process
.base
= exe_module
->base
;
160 event
->data
.info
.create_process
.start
= arg
;
161 event
->data
.info
.create_process
.dbg_offset
= exe_module
->dbg_offset
;
162 event
->data
.info
.create_process
.dbg_size
= exe_module
->dbg_size
;
163 event
->data
.info
.create_process
.name
= exe_module
->name
;
164 event
->data
.info
.create_process
.unicode
= 1;
168 static int fill_exit_thread_event( struct debug_event
*event
, void *arg
)
170 struct thread
*thread
= arg
;
171 event
->data
.info
.exit
.exit_code
= thread
->exit_code
;
175 static int fill_exit_process_event( struct debug_event
*event
, void *arg
)
177 struct process
*process
= arg
;
178 event
->data
.info
.exit
.exit_code
= process
->exit_code
;
182 static int fill_load_dll_event( struct debug_event
*event
, void *arg
)
184 struct process
*debugger
= event
->debugger
->process
;
185 struct process_dll
*dll
= arg
;
186 obj_handle_t handle
= 0;
188 if (dll
->file
&& !(handle
= alloc_handle( debugger
, dll
->file
, GENERIC_READ
, 0 )))
190 event
->data
.info
.load_dll
.handle
= handle
;
191 event
->data
.info
.load_dll
.base
= dll
->base
;
192 event
->data
.info
.load_dll
.dbg_offset
= dll
->dbg_offset
;
193 event
->data
.info
.load_dll
.dbg_size
= dll
->dbg_size
;
194 event
->data
.info
.load_dll
.name
= dll
->name
;
195 event
->data
.info
.load_dll
.unicode
= 1;
199 static int fill_unload_dll_event( struct debug_event
*event
, void *arg
)
201 event
->data
.info
.unload_dll
.base
= arg
;
205 static int fill_output_debug_string_event( struct debug_event
*event
, void *arg
)
207 struct debug_event_output_string
*data
= arg
;
208 event
->data
.info
.output_string
= *data
;
212 typedef int (*fill_event_func
)( struct debug_event
*event
, void *arg
);
214 #define NB_DEBUG_EVENTS OUTPUT_DEBUG_STRING_EVENT /* RIP_EVENT not supported */
216 static const fill_event_func fill_debug_event
[NB_DEBUG_EVENTS
] =
218 fill_exception_event
, /* EXCEPTION_DEBUG_EVENT */
219 fill_create_thread_event
, /* CREATE_THREAD_DEBUG_EVENT */
220 fill_create_process_event
, /* CREATE_PROCESS_DEBUG_EVENT */
221 fill_exit_thread_event
, /* EXIT_THREAD_DEBUG_EVENT */
222 fill_exit_process_event
, /* EXIT_PROCESS_DEBUG_EVENT */
223 fill_load_dll_event
, /* LOAD_DLL_DEBUG_EVENT */
224 fill_unload_dll_event
, /* UNLOAD_DLL_DEBUG_EVENT */
225 fill_output_debug_string_event
/* OUTPUT_DEBUG_STRING_EVENT */
229 /* unlink the first event from the queue */
230 static void unlink_event( struct debug_ctx
*debug_ctx
, struct debug_event
*event
)
232 list_remove( &event
->entry
);
233 if (event
->sender
->debug_event
== event
) event
->sender
->debug_event
= NULL
;
234 release_object( event
);
237 /* link an event at the end of the queue */
238 static void link_event( struct debug_event
*event
)
240 struct debug_ctx
*debug_ctx
= event
->debugger
->debug_ctx
;
243 grab_object( event
);
244 list_add_tail( &debug_ctx
->event_queue
, &event
->entry
);
245 if (!event
->sender
->debug_event
) wake_up( &debug_ctx
->obj
, 0 );
248 /* find the next event that we can send to the debugger */
249 static struct debug_event
*find_event_to_send( struct debug_ctx
*debug_ctx
)
251 struct debug_event
*event
;
253 LIST_FOR_EACH_ENTRY( event
, &debug_ctx
->event_queue
, struct debug_event
, entry
)
255 if (event
->state
== EVENT_SENT
) continue; /* already sent */
256 if (event
->sender
->debug_event
) continue; /* thread busy with another one */
262 static void debug_event_dump( struct object
*obj
, int verbose
)
264 struct debug_event
*debug_event
= (struct debug_event
*)obj
;
265 assert( obj
->ops
== &debug_event_ops
);
266 fprintf( stderr
, "Debug event sender=%p code=%d state=%d\n",
267 debug_event
->sender
, debug_event
->data
.code
, debug_event
->state
);
270 static int debug_event_signaled( struct object
*obj
, struct thread
*thread
)
272 struct debug_event
*debug_event
= (struct debug_event
*)obj
;
273 assert( obj
->ops
== &debug_event_ops
);
274 return debug_event
->state
== EVENT_CONTINUED
;
277 static void debug_event_destroy( struct object
*obj
)
279 struct debug_event
*event
= (struct debug_event
*)obj
;
280 assert( obj
->ops
== &debug_event_ops
);
282 /* If the event has been sent already, the handles are now under the */
283 /* responsibility of the debugger process, so we don't touch them */
284 if (event
->state
== EVENT_QUEUED
)
286 struct process
*debugger
= event
->debugger
->process
;
287 switch(event
->data
.code
)
289 case CREATE_THREAD_DEBUG_EVENT
:
290 close_handle( debugger
, event
->data
.info
.create_thread
.handle
, NULL
);
292 case CREATE_PROCESS_DEBUG_EVENT
:
293 if (event
->data
.info
.create_process
.file
)
294 close_handle( debugger
, event
->data
.info
.create_process
.file
, NULL
);
295 close_handle( debugger
, event
->data
.info
.create_process
.thread
, NULL
);
296 close_handle( debugger
, event
->data
.info
.create_process
.process
, NULL
);
298 case LOAD_DLL_DEBUG_EVENT
:
299 if (event
->data
.info
.load_dll
.handle
)
300 close_handle( debugger
, event
->data
.info
.load_dll
.handle
, NULL
);
304 if (event
->sender
->context
== &event
->context
) event
->sender
->context
= NULL
;
305 release_object( event
->sender
);
306 release_object( event
->debugger
);
309 static void debug_ctx_dump( struct object
*obj
, int verbose
)
311 struct debug_ctx
*debug_ctx
= (struct debug_ctx
*)obj
;
312 assert( obj
->ops
== &debug_ctx_ops
);
313 fprintf( stderr
, "Debug context head=%p tail=%p\n",
314 debug_ctx
->event_queue
.next
, debug_ctx
->event_queue
.prev
);
317 static int debug_ctx_signaled( struct object
*obj
, struct thread
*thread
)
319 struct debug_ctx
*debug_ctx
= (struct debug_ctx
*)obj
;
320 assert( obj
->ops
== &debug_ctx_ops
);
321 return find_event_to_send( debug_ctx
) != NULL
;
324 static void debug_ctx_destroy( struct object
*obj
)
327 struct debug_ctx
*debug_ctx
= (struct debug_ctx
*)obj
;
328 assert( obj
->ops
== &debug_ctx_ops
);
330 /* free all pending events */
331 while ((ptr
= list_head( &debug_ctx
->event_queue
)))
332 unlink_event( debug_ctx
, LIST_ENTRY( ptr
, struct debug_event
, entry
));
335 /* continue a debug event */
336 static int continue_debug_event( struct process
*process
, struct thread
*thread
, int status
)
338 struct debug_ctx
*debug_ctx
= current
->debug_ctx
;
340 if (debug_ctx
&& process
->debugger
== current
&& thread
->process
== process
)
342 struct debug_event
*event
;
344 /* find the event in the queue */
345 LIST_FOR_EACH_ENTRY( event
, &debug_ctx
->event_queue
, struct debug_event
, entry
)
347 if (event
->state
!= EVENT_SENT
) continue;
348 if (event
->sender
== thread
)
350 assert( event
->sender
->debug_event
== event
);
352 event
->status
= status
;
353 event
->state
= EVENT_CONTINUED
;
354 wake_up( &event
->obj
, 0 );
355 unlink_event( debug_ctx
, event
);
356 resume_process( process
);
361 /* not debugging this process, or no such event */
362 set_error( STATUS_ACCESS_DENIED
); /* FIXME */
366 /* alloc a debug event for a debugger */
367 static struct debug_event
*alloc_debug_event( struct thread
*thread
, int code
,
368 void *arg
, const CONTEXT
*context
)
370 struct thread
*debugger
= thread
->process
->debugger
;
371 struct debug_event
*event
;
373 assert( code
> 0 && code
<= NB_DEBUG_EVENTS
);
374 /* cannot queue a debug event for myself */
375 assert( debugger
->process
!= thread
->process
);
377 /* build the event */
378 if (!(event
= alloc_object( &debug_event_ops
))) return NULL
;
379 event
->state
= EVENT_QUEUED
;
380 event
->sender
= (struct thread
*)grab_object( thread
);
381 event
->debugger
= (struct thread
*)grab_object( debugger
);
382 event
->data
.code
= code
;
384 if (!fill_debug_event
[code
-1]( event
, arg
))
386 event
->data
.code
= -1; /* make sure we don't attempt to close handles */
387 release_object( event
);
392 memcpy( &event
->context
, context
, sizeof(event
->context
) );
393 thread
->context
= &event
->context
;
398 /* generate a debug event from inside the server and queue it */
399 void generate_debug_event( struct thread
*thread
, int code
, void *arg
)
401 if (thread
->process
->debugger
)
403 struct debug_event
*event
= alloc_debug_event( thread
, code
, arg
, NULL
);
407 suspend_process( thread
->process
);
408 release_object( event
);
413 /* attach a process to a debugger thread and suspend it */
414 static int debugger_attach( struct process
*process
, struct thread
*debugger
)
416 struct thread
*thread
;
418 if (process
->debugger
) goto error
; /* already being debugged */
419 if (!is_process_init_done( process
)) goto error
; /* still starting up */
420 if (list_empty( &process
->thread_list
)) goto error
; /* no thread running in the process */
422 /* make sure we don't create a debugging loop */
423 for (thread
= debugger
; thread
; thread
= thread
->process
->debugger
)
424 if (thread
->process
== process
) goto error
;
426 /* don't let a debugger debug its console... won't work */
427 if (debugger
->process
->console
&& debugger
->process
->console
->renderer
->process
== process
)
430 suspend_process( process
);
431 if (!set_process_debugger( process
, debugger
))
433 resume_process( process
);
436 if (!set_process_debug_flag( process
, 1 ))
438 process
->debugger
= NULL
;
439 resume_process( process
);
445 set_error( STATUS_ACCESS_DENIED
);
450 /* detach a process from a debugger thread (and resume it ?) */
451 int debugger_detach( struct process
*process
, struct thread
*debugger
)
453 struct debug_event
*event
;
454 struct debug_ctx
*debug_ctx
;
456 if (!process
->debugger
|| process
->debugger
!= debugger
)
457 goto error
; /* not currently debugged, or debugged by another debugger */
458 if (!debugger
->debug_ctx
) goto error
; /* should be a debugger */
459 /* init should be done, otherwise wouldn't be attached */
460 assert(is_process_init_done(process
));
462 suspend_process( process
);
463 /* send continue indication for all events */
464 debug_ctx
= debugger
->debug_ctx
;
466 /* find the event in the queue
467 * FIXME: could loop on process' threads and look the debug_event field */
468 LIST_FOR_EACH_ENTRY( event
, &debug_ctx
->event_queue
, struct debug_event
, entry
)
470 if (event
->state
!= EVENT_QUEUED
) continue;
472 if (event
->sender
->process
== process
)
474 assert( event
->sender
->debug_event
== event
);
475 event
->status
= DBG_CONTINUE
;
476 event
->state
= EVENT_CONTINUED
;
477 wake_up( &event
->obj
, 0 );
478 unlink_event( debug_ctx
, event
);
479 /* from queued debug event */
480 resume_process( process
);
485 /* remove relationships between process and its debugger */
486 process
->debugger
= NULL
;
487 if (!set_process_debug_flag( process
, 0 )) clear_error(); /* ignore error */
489 /* from this function */
490 resume_process( process
);
494 set_error( STATUS_ACCESS_DENIED
);
498 /* generate all startup events of a given process */
499 void generate_startup_debug_events( struct process
*process
, void *entry
)
502 struct thread
*thread
, *first_thread
= get_process_first_thread( process
);
504 /* generate creation events */
505 LIST_FOR_EACH_ENTRY( thread
, &process
->thread_list
, struct thread
, proc_entry
)
507 if (thread
== first_thread
)
508 generate_debug_event( thread
, CREATE_PROCESS_DEBUG_EVENT
, entry
);
510 generate_debug_event( thread
, CREATE_THREAD_DEBUG_EVENT
, NULL
);
513 /* generate dll events (in loading order, i.e. reverse list order) */
514 ptr
= list_tail( &process
->dlls
);
517 struct process_dll
*dll
= LIST_ENTRY( ptr
, struct process_dll
, entry
);
518 generate_debug_event( first_thread
, LOAD_DLL_DEBUG_EVENT
, dll
);
519 ptr
= list_prev( &process
->dlls
, ptr
);
523 /* set the debugger of a given process */
524 int set_process_debugger( struct process
*process
, struct thread
*debugger
)
526 struct debug_ctx
*debug_ctx
;
528 assert( !process
->debugger
);
530 if (!debugger
->debug_ctx
) /* need to allocate a context */
532 if (!(debug_ctx
= alloc_object( &debug_ctx_ops
))) return 0;
533 debug_ctx
->kill_on_exit
= 1;
534 list_init( &debug_ctx
->event_queue
);
535 debugger
->debug_ctx
= debug_ctx
;
537 process
->debugger
= debugger
;
541 /* a thread is exiting */
542 void debug_exit_thread( struct thread
*thread
)
544 if (thread
->debug_ctx
) /* this thread is a debugger */
546 if (thread
->debug_ctx
->kill_on_exit
)
548 /* kill all debugged processes */
549 kill_debugged_processes( thread
, thread
->exit_code
);
553 detach_debugged_processes( thread
);
555 release_object( thread
->debug_ctx
);
556 thread
->debug_ctx
= NULL
;
560 /* Wait for a debug event */
561 DECL_HANDLER(wait_debug_event
)
563 struct debug_ctx
*debug_ctx
= current
->debug_ctx
;
564 struct debug_event
*event
;
566 if (!debug_ctx
) /* current thread is not a debugger */
568 set_error( STATUS_INVALID_HANDLE
);
572 if ((event
= find_event_to_send( debug_ctx
)))
574 size_t size
= get_reply_max_size();
575 event
->state
= EVENT_SENT
;
576 event
->sender
->debug_event
= event
;
577 reply
->pid
= get_process_id( event
->sender
->process
);
578 reply
->tid
= get_thread_id( event
->sender
);
579 if (size
> sizeof(debug_event_t
)) size
= sizeof(debug_event_t
);
580 set_reply_data( &event
->data
, size
);
582 else /* no event ready */
587 reply
->wait
= alloc_handle( current
->process
, debug_ctx
, SYNCHRONIZE
, 0 );
591 /* Continue a debug event */
592 DECL_HANDLER(continue_debug_event
)
594 struct process
*process
= get_process_from_id( req
->pid
);
597 struct thread
*thread
= get_thread_from_id( req
->tid
);
600 continue_debug_event( process
, thread
, req
->status
);
601 release_object( thread
);
603 release_object( process
);
607 /* Start debugging an existing process */
608 DECL_HANDLER(debug_process
)
610 struct process
*process
= get_process_from_id( req
->pid
);
611 if (!process
) return;
615 debugger_detach( process
, current
);
617 else if (debugger_attach( process
, current
))
619 generate_startup_debug_events( process
, NULL
);
620 break_process( process
);
621 resume_process( process
);
623 release_object( process
);
626 /* queue an exception event */
627 DECL_HANDLER(queue_exception_event
)
630 if (current
->process
->debugger
)
632 struct debug_event_exception data
;
633 struct debug_event
*event
;
634 const CONTEXT
*context
= get_req_data();
635 const EXCEPTION_RECORD
*rec
= (const EXCEPTION_RECORD
*)(context
+ 1);
637 if (get_req_data_size() < sizeof(*rec
) + sizeof(*context
))
639 set_error( STATUS_INVALID_PARAMETER
);
643 data
.first
= req
->first
;
644 if ((event
= alloc_debug_event( current
, EXCEPTION_DEBUG_EVENT
, &data
, context
)))
646 if ((reply
->handle
= alloc_handle( current
->process
, event
, SYNCHRONIZE
, 0 )))
649 suspend_process( current
->process
);
651 release_object( event
);
656 /* retrieve the status of an exception event */
657 DECL_HANDLER(get_exception_status
)
659 struct debug_event
*event
;
661 if ((event
= (struct debug_event
*)get_handle_obj( current
->process
, req
->handle
,
662 0, &debug_event_ops
)))
664 close_handle( current
->process
, req
->handle
, NULL
);
665 if (event
->state
== EVENT_CONTINUED
)
667 if (current
->context
== &event
->context
)
669 size_t size
= min( sizeof(CONTEXT
), get_reply_max_size() );
670 set_reply_data( &event
->context
, size
);
671 current
->context
= NULL
;
673 set_error( event
->status
);
675 else set_error( STATUS_PENDING
);
676 release_object( event
);
680 /* send an output string to the debugger */
681 DECL_HANDLER(output_debug_string
)
683 struct debug_event_output_string data
;
685 data
.string
= req
->string
;
686 data
.unicode
= req
->unicode
;
687 data
.length
= req
->length
;
688 generate_debug_event( current
, OUTPUT_DEBUG_STRING_EVENT
, &data
);
691 /* simulate a breakpoint in a process */
692 DECL_HANDLER(debug_break
)
694 struct process
*process
;
697 if ((process
= get_process_from_handle( req
->handle
, PROCESS_SET_INFORMATION
/*FIXME*/ )))
699 if (process
!= current
->process
) break_process( process
);
700 else reply
->self
= 1;
701 release_object( process
);
705 /* set debugger kill on exit flag */
706 DECL_HANDLER(set_debugger_kill_on_exit
)
708 if (!current
->debug_ctx
)
710 set_error( STATUS_ACCESS_DENIED
);
713 current
->debug_ctx
->kill_on_exit
= req
->kill_on_exit
;