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
40 enum debug_event_state
{ EVENT_QUEUED
, EVENT_SENT
, EVENT_CONTINUED
};
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_t context
; /* register context */
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
, const void *arg
)
117 const debug_event_t
*data
= arg
;
118 event
->data
.exception
= data
->exception
;
119 event
->data
.exception
.nb_params
= min( event
->data
.exception
.nb_params
, EXCEPTION_MAXIMUM_PARAMETERS
);
123 static int fill_create_thread_event( struct debug_event
*event
, const void *arg
)
125 struct process
*debugger
= event
->debugger
->process
;
126 struct thread
*thread
= event
->sender
;
127 const client_ptr_t
*entry
= arg
;
130 /* documented: THREAD_GET_CONTEXT | THREAD_SET_CONTEXT | THREAD_SUSPEND_RESUME */
131 if (!(handle
= alloc_handle( debugger
, thread
, THREAD_ALL_ACCESS
, 0 ))) return 0;
132 event
->data
.create_thread
.handle
= handle
;
133 event
->data
.create_thread
.teb
= thread
->teb
;
134 if (entry
) event
->data
.create_thread
.start
= *entry
;
138 static int fill_create_process_event( struct debug_event
*event
, const void *arg
)
140 struct process
*debugger
= event
->debugger
->process
;
141 struct thread
*thread
= event
->sender
;
142 struct process
*process
= thread
->process
;
143 struct process_dll
*exe_module
= get_process_exe_module( process
);
144 const client_ptr_t
*entry
= arg
;
147 /* documented: PROCESS_VM_READ | PROCESS_VM_WRITE */
148 if (!(handle
= alloc_handle( debugger
, process
, PROCESS_ALL_ACCESS
, 0 ))) return 0;
149 event
->data
.create_process
.process
= handle
;
151 /* documented: THREAD_GET_CONTEXT | THREAD_SET_CONTEXT | THREAD_SUSPEND_RESUME */
152 if (!(handle
= alloc_handle( debugger
, thread
, THREAD_ALL_ACCESS
, 0 )))
154 close_handle( debugger
, event
->data
.create_process
.process
);
157 event
->data
.create_process
.thread
= handle
;
160 if (exe_module
->file
&&
161 /* the doc says write access too, but this doesn't seem a good idea */
162 !(handle
= alloc_handle( debugger
, exe_module
->file
, GENERIC_READ
, 0 )))
164 close_handle( debugger
, event
->data
.create_process
.process
);
165 close_handle( debugger
, event
->data
.create_process
.thread
);
168 event
->data
.create_process
.file
= handle
;
169 event
->data
.create_process
.teb
= thread
->teb
;
170 event
->data
.create_process
.base
= exe_module
->base
;
171 event
->data
.create_process
.start
= *entry
;
172 event
->data
.create_process
.dbg_offset
= exe_module
->dbg_offset
;
173 event
->data
.create_process
.dbg_size
= exe_module
->dbg_size
;
174 event
->data
.create_process
.name
= exe_module
->name
;
175 event
->data
.create_process
.unicode
= 1;
179 static int fill_exit_thread_event( struct debug_event
*event
, const void *arg
)
181 const struct thread
*thread
= arg
;
182 event
->data
.exit
.exit_code
= thread
->exit_code
;
186 static int fill_exit_process_event( struct debug_event
*event
, const void *arg
)
188 const struct process
*process
= arg
;
189 event
->data
.exit
.exit_code
= process
->exit_code
;
193 static int fill_load_dll_event( struct debug_event
*event
, const void *arg
)
195 struct process
*debugger
= event
->debugger
->process
;
196 const struct process_dll
*dll
= arg
;
197 obj_handle_t handle
= 0;
199 if (dll
->file
&& !(handle
= alloc_handle( debugger
, dll
->file
, GENERIC_READ
, 0 )))
201 event
->data
.load_dll
.handle
= handle
;
202 event
->data
.load_dll
.base
= dll
->base
;
203 event
->data
.load_dll
.dbg_offset
= dll
->dbg_offset
;
204 event
->data
.load_dll
.dbg_size
= dll
->dbg_size
;
205 event
->data
.load_dll
.name
= dll
->name
;
206 event
->data
.load_dll
.unicode
= 1;
210 static int fill_unload_dll_event( struct debug_event
*event
, const void *arg
)
212 const mod_handle_t
*base
= arg
;
213 event
->data
.unload_dll
.base
= *base
;
217 static int fill_output_debug_string_event( struct debug_event
*event
, const void *arg
)
219 const debug_event_t
*data
= arg
;
220 event
->data
.output_string
= data
->output_string
;
224 typedef int (*fill_event_func
)( struct debug_event
*event
, const void *arg
);
226 #define NB_DEBUG_EVENTS OUTPUT_DEBUG_STRING_EVENT /* RIP_EVENT not supported */
228 static const fill_event_func fill_debug_event
[NB_DEBUG_EVENTS
] =
230 fill_exception_event
, /* EXCEPTION_DEBUG_EVENT */
231 fill_create_thread_event
, /* CREATE_THREAD_DEBUG_EVENT */
232 fill_create_process_event
, /* CREATE_PROCESS_DEBUG_EVENT */
233 fill_exit_thread_event
, /* EXIT_THREAD_DEBUG_EVENT */
234 fill_exit_process_event
, /* EXIT_PROCESS_DEBUG_EVENT */
235 fill_load_dll_event
, /* LOAD_DLL_DEBUG_EVENT */
236 fill_unload_dll_event
, /* UNLOAD_DLL_DEBUG_EVENT */
237 fill_output_debug_string_event
/* OUTPUT_DEBUG_STRING_EVENT */
241 /* unlink the first event from the queue */
242 static void unlink_event( struct debug_ctx
*debug_ctx
, struct debug_event
*event
)
244 list_remove( &event
->entry
);
245 if (event
->sender
->debug_event
== event
) event
->sender
->debug_event
= NULL
;
246 release_object( event
);
249 /* link an event at the end of the queue */
250 static void link_event( struct debug_event
*event
)
252 struct debug_ctx
*debug_ctx
= event
->debugger
->debug_ctx
;
255 grab_object( event
);
256 list_add_tail( &debug_ctx
->event_queue
, &event
->entry
);
257 if (!event
->sender
->debug_event
) wake_up( &debug_ctx
->obj
, 0 );
260 /* find the next event that we can send to the debugger */
261 static struct debug_event
*find_event_to_send( struct debug_ctx
*debug_ctx
)
263 struct debug_event
*event
;
265 LIST_FOR_EACH_ENTRY( event
, &debug_ctx
->event_queue
, struct debug_event
, entry
)
267 if (event
->state
== EVENT_SENT
) continue; /* already sent */
268 if (event
->sender
->debug_event
) continue; /* thread busy with another one */
274 static void debug_event_dump( struct object
*obj
, int verbose
)
276 struct debug_event
*debug_event
= (struct debug_event
*)obj
;
277 assert( obj
->ops
== &debug_event_ops
);
278 fprintf( stderr
, "Debug event sender=%p code=%d state=%d\n",
279 debug_event
->sender
, debug_event
->data
.code
, debug_event
->state
);
282 static int debug_event_signaled( struct object
*obj
, struct thread
*thread
)
284 struct debug_event
*debug_event
= (struct debug_event
*)obj
;
285 assert( obj
->ops
== &debug_event_ops
);
286 return debug_event
->state
== EVENT_CONTINUED
;
289 static void debug_event_destroy( struct object
*obj
)
291 struct debug_event
*event
= (struct debug_event
*)obj
;
292 assert( obj
->ops
== &debug_event_ops
);
294 /* If the event has been sent already, the handles are now under the */
295 /* responsibility of the debugger process, so we don't touch them */
296 if (event
->state
== EVENT_QUEUED
)
298 struct process
*debugger
= event
->debugger
->process
;
299 switch(event
->data
.code
)
301 case CREATE_THREAD_DEBUG_EVENT
:
302 close_handle( debugger
, event
->data
.create_thread
.handle
);
304 case CREATE_PROCESS_DEBUG_EVENT
:
305 if (event
->data
.create_process
.file
)
306 close_handle( debugger
, event
->data
.create_process
.file
);
307 close_handle( debugger
, event
->data
.create_process
.thread
);
308 close_handle( debugger
, event
->data
.create_process
.process
);
310 case LOAD_DLL_DEBUG_EVENT
:
311 if (event
->data
.load_dll
.handle
)
312 close_handle( debugger
, event
->data
.load_dll
.handle
);
316 if (event
->sender
->context
== &event
->context
) event
->sender
->context
= NULL
;
317 release_object( event
->sender
);
318 release_object( event
->debugger
);
321 static void debug_ctx_dump( struct object
*obj
, int verbose
)
323 struct debug_ctx
*debug_ctx
= (struct debug_ctx
*)obj
;
324 assert( obj
->ops
== &debug_ctx_ops
);
325 fprintf( stderr
, "Debug context head=%p tail=%p\n",
326 debug_ctx
->event_queue
.next
, debug_ctx
->event_queue
.prev
);
329 static int debug_ctx_signaled( struct object
*obj
, struct thread
*thread
)
331 struct debug_ctx
*debug_ctx
= (struct debug_ctx
*)obj
;
332 assert( obj
->ops
== &debug_ctx_ops
);
333 return find_event_to_send( debug_ctx
) != NULL
;
336 static void debug_ctx_destroy( struct object
*obj
)
339 struct debug_ctx
*debug_ctx
= (struct debug_ctx
*)obj
;
340 assert( obj
->ops
== &debug_ctx_ops
);
342 /* free all pending events */
343 while ((ptr
= list_head( &debug_ctx
->event_queue
)))
344 unlink_event( debug_ctx
, LIST_ENTRY( ptr
, struct debug_event
, entry
));
347 /* continue a debug event */
348 static int continue_debug_event( struct process
*process
, struct thread
*thread
, int status
)
350 struct debug_ctx
*debug_ctx
= current
->debug_ctx
;
352 if (debug_ctx
&& process
->debugger
== current
&& thread
->process
== process
)
354 struct debug_event
*event
;
356 /* find the event in the queue */
357 LIST_FOR_EACH_ENTRY( event
, &debug_ctx
->event_queue
, struct debug_event
, entry
)
359 if (event
->state
!= EVENT_SENT
) continue;
360 if (event
->sender
== thread
)
362 assert( event
->sender
->debug_event
== event
);
364 event
->status
= status
;
365 event
->state
= EVENT_CONTINUED
;
366 wake_up( &event
->obj
, 0 );
367 unlink_event( debug_ctx
, event
);
368 resume_process( process
);
373 /* not debugging this process, or no such event */
374 set_error( STATUS_ACCESS_DENIED
); /* FIXME */
378 /* alloc a debug event for a debugger */
379 static struct debug_event
*alloc_debug_event( struct thread
*thread
, int code
, const void *arg
)
381 struct thread
*debugger
= thread
->process
->debugger
;
382 struct debug_event
*event
;
384 assert( code
> 0 && code
<= NB_DEBUG_EVENTS
);
385 /* cannot queue a debug event for myself */
386 assert( debugger
->process
!= thread
->process
);
388 /* build the event */
389 if (!(event
= alloc_object( &debug_event_ops
))) return NULL
;
390 event
->state
= EVENT_QUEUED
;
391 event
->sender
= (struct thread
*)grab_object( thread
);
392 event
->debugger
= (struct thread
*)grab_object( debugger
);
393 memset( &event
->data
, 0, sizeof(event
->data
) );
395 if (!fill_debug_event
[code
-1]( event
, arg
))
397 event
->data
.code
= -1; /* make sure we don't attempt to close handles */
398 release_object( event
);
401 event
->data
.code
= code
;
405 /* generate a debug event from inside the server and queue it */
406 void generate_debug_event( struct thread
*thread
, int code
, const void *arg
)
408 if (thread
->process
->debugger
)
410 struct debug_event
*event
= alloc_debug_event( thread
, code
, arg
);
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 if (process
->debugger
) goto error
; /* already being debugged */
424 if (debugger
->process
== process
) goto error
;
425 if (!is_process_init_done( process
)) goto error
; /* still starting up */
426 if (list_empty( &process
->thread_list
)) goto error
; /* no thread running in the process */
428 /* don't let a debugger debug its console... won't work */
429 if (debugger
->process
->console
&& console_get_renderer(debugger
->process
->console
)->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
, *next
;
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 /* free all events from this process */
469 LIST_FOR_EACH_ENTRY_SAFE( event
, next
, &debug_ctx
->event_queue
, struct debug_event
, entry
)
471 if (event
->sender
->process
!= process
) continue;
473 assert( event
->state
!= EVENT_CONTINUED
);
474 event
->status
= DBG_CONTINUE
;
475 event
->state
= EVENT_CONTINUED
;
476 wake_up( &event
->obj
, 0 );
477 unlink_event( debug_ctx
, event
);
478 /* from queued debug event */
479 resume_process( process
);
482 /* remove relationships between process and its debugger */
483 process
->debugger
= NULL
;
484 if (!set_process_debug_flag( process
, 0 )) clear_error(); /* ignore error */
486 /* from this function */
487 resume_process( process
);
491 set_error( STATUS_ACCESS_DENIED
);
495 /* generate all startup events of a given process */
496 void generate_startup_debug_events( struct process
*process
, client_ptr_t entry
)
499 struct thread
*thread
, *first_thread
= get_process_first_thread( process
);
501 /* generate creation events */
502 LIST_FOR_EACH_ENTRY( thread
, &process
->thread_list
, struct thread
, proc_entry
)
504 if (thread
== first_thread
)
505 generate_debug_event( thread
, CREATE_PROCESS_DEBUG_EVENT
, &entry
);
507 generate_debug_event( thread
, CREATE_THREAD_DEBUG_EVENT
, NULL
);
510 /* generate dll events (in loading order, i.e. reverse list order) */
511 ptr
= list_tail( &process
->dlls
);
512 while (ptr
!= list_head( &process
->dlls
))
514 struct process_dll
*dll
= LIST_ENTRY( ptr
, struct process_dll
, entry
);
515 generate_debug_event( first_thread
, LOAD_DLL_DEBUG_EVENT
, dll
);
516 ptr
= list_prev( &process
->dlls
, ptr
);
520 /* set the debugger of a given process */
521 int set_process_debugger( struct process
*process
, struct thread
*debugger
)
523 struct debug_ctx
*debug_ctx
;
525 assert( !process
->debugger
);
527 if (!debugger
->debug_ctx
) /* need to allocate a context */
529 if (!(debug_ctx
= alloc_object( &debug_ctx_ops
))) return 0;
530 debug_ctx
->kill_on_exit
= 1;
531 list_init( &debug_ctx
->event_queue
);
532 debugger
->debug_ctx
= debug_ctx
;
534 process
->debugger
= debugger
;
538 /* a thread is exiting */
539 void debug_exit_thread( struct thread
*thread
)
541 if (thread
->debug_ctx
) /* this thread is a debugger */
543 if (thread
->debug_ctx
->kill_on_exit
)
545 /* kill all debugged processes */
546 kill_debugged_processes( thread
, STATUS_DEBUGGER_INACTIVE
);
550 detach_debugged_processes( thread
);
552 release_object( thread
->debug_ctx
);
553 thread
->debug_ctx
= NULL
;
557 /* Wait for a debug event */
558 DECL_HANDLER(wait_debug_event
)
560 struct debug_ctx
*debug_ctx
= current
->debug_ctx
;
561 struct debug_event
*event
;
563 if (!debug_ctx
) /* current thread is not a debugger */
565 set_error( STATUS_INVALID_HANDLE
);
569 if ((event
= find_event_to_send( debug_ctx
)))
571 data_size_t size
= get_reply_max_size();
572 event
->state
= EVENT_SENT
;
573 event
->sender
->debug_event
= event
;
574 reply
->pid
= get_process_id( event
->sender
->process
);
575 reply
->tid
= get_thread_id( event
->sender
);
576 if (size
> sizeof(debug_event_t
)) size
= sizeof(debug_event_t
);
577 set_reply_data( &event
->data
, size
);
579 else /* no event ready */
584 reply
->wait
= alloc_handle( current
->process
, debug_ctx
, SYNCHRONIZE
, 0 );
588 /* Continue a debug event */
589 DECL_HANDLER(continue_debug_event
)
591 struct process
*process
= get_process_from_id( req
->pid
);
594 struct thread
*thread
= get_thread_from_id( req
->tid
);
597 continue_debug_event( process
, thread
, req
->status
);
598 release_object( thread
);
600 release_object( process
);
604 /* Start debugging an existing process */
605 DECL_HANDLER(debug_process
)
607 struct process
*process
= get_process_from_id( req
->pid
);
608 if (!process
) return;
612 debugger_detach( process
, current
);
614 else if (debugger_attach( process
, current
))
616 generate_startup_debug_events( process
, 0 );
617 break_process( process
);
618 resume_process( process
);
620 release_object( process
);
623 /* queue an exception event */
624 DECL_HANDLER(queue_exception_event
)
627 if (current
->process
->debugger
)
630 struct debug_event
*event
;
632 if ((req
->len
% sizeof(client_ptr_t
)) != 0 ||
633 req
->len
> get_req_data_size() ||
634 req
->len
> EXCEPTION_MAXIMUM_PARAMETERS
* sizeof(client_ptr_t
))
636 set_error( STATUS_INVALID_PARAMETER
);
639 memset( &data
, 0, sizeof(data
) );
640 data
.exception
.first
= req
->first
;
641 data
.exception
.exc_code
= req
->code
;
642 data
.exception
.flags
= req
->flags
;
643 data
.exception
.record
= req
->record
;
644 data
.exception
.address
= req
->address
;
645 data
.exception
.nb_params
= req
->len
/ sizeof(client_ptr_t
);
646 memcpy( data
.exception
.params
, get_req_data(), req
->len
);
648 if ((event
= alloc_debug_event( current
, EXCEPTION_DEBUG_EVENT
, &data
)))
650 const context_t
*context
= (const context_t
*)((const char *)get_req_data() + req
->len
);
651 data_size_t size
= get_req_data_size() - req
->len
;
653 memset( &event
->context
, 0, sizeof(event
->context
) );
654 memcpy( &event
->context
, context
, min( sizeof(event
->context
), size
) );
655 current
->context
= &event
->context
;
657 if ((reply
->handle
= alloc_handle( current
->process
, event
, SYNCHRONIZE
, 0 )))
660 suspend_process( current
->process
);
662 release_object( event
);
667 /* retrieve the status of an exception event */
668 DECL_HANDLER(get_exception_status
)
670 struct debug_event
*event
;
672 if ((event
= (struct debug_event
*)get_handle_obj( current
->process
, req
->handle
,
673 0, &debug_event_ops
)))
675 close_handle( current
->process
, req
->handle
);
676 if (event
->state
== EVENT_CONTINUED
)
678 if (current
->context
== &event
->context
)
680 data_size_t size
= min( sizeof(context_t
), get_reply_max_size() );
681 set_reply_data( &event
->context
, size
);
682 current
->context
= NULL
;
684 set_error( event
->status
);
686 else set_error( STATUS_PENDING
);
687 release_object( event
);
691 /* send an output string to the debugger */
692 DECL_HANDLER(output_debug_string
)
696 data
.output_string
.string
= req
->string
;
697 data
.output_string
.length
= req
->length
;
698 generate_debug_event( current
, OUTPUT_DEBUG_STRING_EVENT
, &data
);
701 /* simulate a breakpoint in a process */
702 DECL_HANDLER(debug_break
)
704 struct process
*process
;
707 if ((process
= get_process_from_handle( req
->handle
, PROCESS_SET_INFORMATION
/*FIXME*/ )))
709 if (process
!= current
->process
) break_process( process
);
710 else reply
->self
= 1;
711 release_object( process
);
715 /* set debugger kill on exit flag */
716 DECL_HANDLER(set_debugger_kill_on_exit
)
718 if (!current
->debug_ctx
)
720 set_error( STATUS_ACCESS_DENIED
);
723 current
->debug_ctx
->kill_on_exit
= req
->kill_on_exit
;