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 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 add_queue
, /* add_queue */
73 remove_queue
, /* remove_queue */
74 debug_event_signaled
, /* signaled */
75 no_satisfied
, /* satisfied */
76 no_signal
, /* signal */
77 no_get_fd
, /* get_fd */
78 no_map_access
, /* map_access */
79 no_lookup_name
, /* lookup_name */
80 no_open_file
, /* open_file */
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_open_file
, /* open_file */
102 no_close_handle
, /* close_handle */
103 debug_ctx_destroy
/* destroy */
107 /* routines to build an event according to its type */
109 static int fill_exception_event( struct debug_event
*event
, void *arg
)
111 memcpy( &event
->data
.info
.exception
, arg
, sizeof(event
->data
.info
.exception
) );
115 static int fill_create_thread_event( struct debug_event
*event
, void *arg
)
117 struct process
*debugger
= event
->debugger
->process
;
118 struct thread
*thread
= event
->sender
;
121 /* documented: THREAD_GET_CONTEXT | THREAD_SET_CONTEXT | THREAD_SUSPEND_RESUME */
122 if (!(handle
= alloc_handle( debugger
, thread
, THREAD_ALL_ACCESS
, 0 ))) return 0;
123 event
->data
.info
.create_thread
.handle
= handle
;
124 event
->data
.info
.create_thread
.teb
= thread
->teb
;
125 event
->data
.info
.create_thread
.start
= arg
;
129 static int fill_create_process_event( struct debug_event
*event
, void *arg
)
131 struct process
*debugger
= event
->debugger
->process
;
132 struct thread
*thread
= event
->sender
;
133 struct process
*process
= thread
->process
;
134 struct process_dll
*exe_module
= get_process_exe_module( process
);
137 /* documented: PROCESS_VM_READ | PROCESS_VM_WRITE */
138 if (!(handle
= alloc_handle( debugger
, process
, PROCESS_ALL_ACCESS
, 0 ))) return 0;
139 event
->data
.info
.create_process
.process
= handle
;
141 /* documented: THREAD_GET_CONTEXT | THREAD_SET_CONTEXT | THREAD_SUSPEND_RESUME */
142 if (!(handle
= alloc_handle( debugger
, thread
, THREAD_ALL_ACCESS
, 0 )))
144 close_handle( debugger
, event
->data
.info
.create_process
.process
);
147 event
->data
.info
.create_process
.thread
= handle
;
150 if (exe_module
->file
&&
151 /* the doc says write access too, but this doesn't seem a good idea */
152 !(handle
= alloc_handle( debugger
, exe_module
->file
, GENERIC_READ
, 0 )))
154 close_handle( debugger
, event
->data
.info
.create_process
.process
);
155 close_handle( debugger
, event
->data
.info
.create_process
.thread
);
158 event
->data
.info
.create_process
.file
= handle
;
159 event
->data
.info
.create_process
.teb
= thread
->teb
;
160 event
->data
.info
.create_process
.base
= exe_module
->base
;
161 event
->data
.info
.create_process
.start
= arg
;
162 event
->data
.info
.create_process
.dbg_offset
= exe_module
->dbg_offset
;
163 event
->data
.info
.create_process
.dbg_size
= exe_module
->dbg_size
;
164 event
->data
.info
.create_process
.name
= exe_module
->name
;
165 event
->data
.info
.create_process
.unicode
= 1;
169 static int fill_exit_thread_event( struct debug_event
*event
, void *arg
)
171 struct thread
*thread
= arg
;
172 event
->data
.info
.exit
.exit_code
= thread
->exit_code
;
176 static int fill_exit_process_event( struct debug_event
*event
, void *arg
)
178 struct process
*process
= arg
;
179 event
->data
.info
.exit
.exit_code
= process
->exit_code
;
183 static int fill_load_dll_event( struct debug_event
*event
, void *arg
)
185 struct process
*debugger
= event
->debugger
->process
;
186 struct process_dll
*dll
= arg
;
187 obj_handle_t handle
= 0;
189 if (dll
->file
&& !(handle
= alloc_handle( debugger
, dll
->file
, GENERIC_READ
, 0 )))
191 event
->data
.info
.load_dll
.handle
= handle
;
192 event
->data
.info
.load_dll
.base
= dll
->base
;
193 event
->data
.info
.load_dll
.dbg_offset
= dll
->dbg_offset
;
194 event
->data
.info
.load_dll
.dbg_size
= dll
->dbg_size
;
195 event
->data
.info
.load_dll
.name
= dll
->name
;
196 event
->data
.info
.load_dll
.unicode
= 1;
200 static int fill_unload_dll_event( struct debug_event
*event
, void *arg
)
202 event
->data
.info
.unload_dll
.base
= arg
;
206 static int fill_output_debug_string_event( struct debug_event
*event
, void *arg
)
208 struct debug_event_output_string
*data
= arg
;
209 event
->data
.info
.output_string
= *data
;
213 typedef int (*fill_event_func
)( struct debug_event
*event
, void *arg
);
215 #define NB_DEBUG_EVENTS OUTPUT_DEBUG_STRING_EVENT /* RIP_EVENT not supported */
217 static const fill_event_func fill_debug_event
[NB_DEBUG_EVENTS
] =
219 fill_exception_event
, /* EXCEPTION_DEBUG_EVENT */
220 fill_create_thread_event
, /* CREATE_THREAD_DEBUG_EVENT */
221 fill_create_process_event
, /* CREATE_PROCESS_DEBUG_EVENT */
222 fill_exit_thread_event
, /* EXIT_THREAD_DEBUG_EVENT */
223 fill_exit_process_event
, /* EXIT_PROCESS_DEBUG_EVENT */
224 fill_load_dll_event
, /* LOAD_DLL_DEBUG_EVENT */
225 fill_unload_dll_event
, /* UNLOAD_DLL_DEBUG_EVENT */
226 fill_output_debug_string_event
/* OUTPUT_DEBUG_STRING_EVENT */
230 /* unlink the first event from the queue */
231 static void unlink_event( struct debug_ctx
*debug_ctx
, struct debug_event
*event
)
233 list_remove( &event
->entry
);
234 if (event
->sender
->debug_event
== event
) event
->sender
->debug_event
= NULL
;
235 release_object( event
);
238 /* link an event at the end of the queue */
239 static void link_event( struct debug_event
*event
)
241 struct debug_ctx
*debug_ctx
= event
->debugger
->debug_ctx
;
244 grab_object( event
);
245 list_add_tail( &debug_ctx
->event_queue
, &event
->entry
);
246 if (!event
->sender
->debug_event
) wake_up( &debug_ctx
->obj
, 0 );
249 /* find the next event that we can send to the debugger */
250 static struct debug_event
*find_event_to_send( struct debug_ctx
*debug_ctx
)
252 struct debug_event
*event
;
254 LIST_FOR_EACH_ENTRY( event
, &debug_ctx
->event_queue
, struct debug_event
, entry
)
256 if (event
->state
== EVENT_SENT
) continue; /* already sent */
257 if (event
->sender
->debug_event
) continue; /* thread busy with another one */
263 static void debug_event_dump( struct object
*obj
, int verbose
)
265 struct debug_event
*debug_event
= (struct debug_event
*)obj
;
266 assert( obj
->ops
== &debug_event_ops
);
267 fprintf( stderr
, "Debug event sender=%p code=%d state=%d\n",
268 debug_event
->sender
, debug_event
->data
.code
, debug_event
->state
);
271 static int debug_event_signaled( struct object
*obj
, struct thread
*thread
)
273 struct debug_event
*debug_event
= (struct debug_event
*)obj
;
274 assert( obj
->ops
== &debug_event_ops
);
275 return debug_event
->state
== EVENT_CONTINUED
;
278 static void debug_event_destroy( struct object
*obj
)
280 struct debug_event
*event
= (struct debug_event
*)obj
;
281 assert( obj
->ops
== &debug_event_ops
);
283 /* If the event has been sent already, the handles are now under the */
284 /* responsibility of the debugger process, so we don't touch them */
285 if (event
->state
== EVENT_QUEUED
)
287 struct process
*debugger
= event
->debugger
->process
;
288 switch(event
->data
.code
)
290 case CREATE_THREAD_DEBUG_EVENT
:
291 close_handle( debugger
, event
->data
.info
.create_thread
.handle
);
293 case CREATE_PROCESS_DEBUG_EVENT
:
294 if (event
->data
.info
.create_process
.file
)
295 close_handle( debugger
, event
->data
.info
.create_process
.file
);
296 close_handle( debugger
, event
->data
.info
.create_process
.thread
);
297 close_handle( debugger
, event
->data
.info
.create_process
.process
);
299 case LOAD_DLL_DEBUG_EVENT
:
300 if (event
->data
.info
.load_dll
.handle
)
301 close_handle( debugger
, event
->data
.info
.load_dll
.handle
);
305 if (event
->sender
->context
== &event
->context
) event
->sender
->context
= NULL
;
306 release_object( event
->sender
);
307 release_object( event
->debugger
);
310 static void debug_ctx_dump( struct object
*obj
, int verbose
)
312 struct debug_ctx
*debug_ctx
= (struct debug_ctx
*)obj
;
313 assert( obj
->ops
== &debug_ctx_ops
);
314 fprintf( stderr
, "Debug context head=%p tail=%p\n",
315 debug_ctx
->event_queue
.next
, debug_ctx
->event_queue
.prev
);
318 static int debug_ctx_signaled( struct object
*obj
, struct thread
*thread
)
320 struct debug_ctx
*debug_ctx
= (struct debug_ctx
*)obj
;
321 assert( obj
->ops
== &debug_ctx_ops
);
322 return find_event_to_send( debug_ctx
) != NULL
;
325 static void debug_ctx_destroy( struct object
*obj
)
328 struct debug_ctx
*debug_ctx
= (struct debug_ctx
*)obj
;
329 assert( obj
->ops
== &debug_ctx_ops
);
331 /* free all pending events */
332 while ((ptr
= list_head( &debug_ctx
->event_queue
)))
333 unlink_event( debug_ctx
, LIST_ENTRY( ptr
, struct debug_event
, entry
));
336 /* continue a debug event */
337 static int continue_debug_event( struct process
*process
, struct thread
*thread
, int status
)
339 struct debug_ctx
*debug_ctx
= current
->debug_ctx
;
341 if (debug_ctx
&& process
->debugger
== current
&& thread
->process
== process
)
343 struct debug_event
*event
;
345 /* find the event in the queue */
346 LIST_FOR_EACH_ENTRY( event
, &debug_ctx
->event_queue
, struct debug_event
, entry
)
348 if (event
->state
!= EVENT_SENT
) continue;
349 if (event
->sender
== thread
)
351 assert( event
->sender
->debug_event
== event
);
353 event
->status
= status
;
354 event
->state
= EVENT_CONTINUED
;
355 wake_up( &event
->obj
, 0 );
356 unlink_event( debug_ctx
, event
);
357 resume_process( process
);
362 /* not debugging this process, or no such event */
363 set_error( STATUS_ACCESS_DENIED
); /* FIXME */
367 /* alloc a debug event for a debugger */
368 static struct debug_event
*alloc_debug_event( struct thread
*thread
, int code
,
369 void *arg
, const CONTEXT
*context
)
371 struct thread
*debugger
= thread
->process
->debugger
;
372 struct debug_event
*event
;
374 assert( code
> 0 && code
<= NB_DEBUG_EVENTS
);
375 /* cannot queue a debug event for myself */
376 assert( debugger
->process
!= thread
->process
);
378 /* build the event */
379 if (!(event
= alloc_object( &debug_event_ops
))) return NULL
;
380 event
->state
= EVENT_QUEUED
;
381 event
->sender
= (struct thread
*)grab_object( thread
);
382 event
->debugger
= (struct thread
*)grab_object( debugger
);
383 event
->data
.code
= code
;
385 if (!fill_debug_event
[code
-1]( event
, arg
))
387 event
->data
.code
= -1; /* make sure we don't attempt to close handles */
388 release_object( event
);
393 memcpy( &event
->context
, context
, sizeof(event
->context
) );
394 thread
->context
= &event
->context
;
399 /* generate a debug event from inside the server and queue it */
400 void generate_debug_event( struct thread
*thread
, int code
, void *arg
)
402 if (thread
->process
->debugger
)
404 struct debug_event
*event
= alloc_debug_event( thread
, code
, arg
, NULL
);
408 suspend_process( thread
->process
);
409 release_object( event
);
414 /* attach a process to a debugger thread and suspend it */
415 static int debugger_attach( struct process
*process
, struct thread
*debugger
)
417 struct thread
*thread
;
419 if (process
->debugger
) goto error
; /* already being debugged */
420 if (!is_process_init_done( process
)) goto error
; /* still starting up */
421 if (list_empty( &process
->thread_list
)) goto error
; /* no thread running in the process */
423 /* make sure we don't create a debugging loop */
424 for (thread
= debugger
; thread
; thread
= thread
->process
->debugger
)
425 if (thread
->process
== process
) goto error
;
427 /* don't let a debugger debug its console... won't work */
428 if (debugger
->process
->console
&& console_get_renderer(debugger
->process
->console
)->process
== process
)
431 suspend_process( process
);
432 if (!set_process_debugger( process
, debugger
))
434 resume_process( process
);
437 if (!set_process_debug_flag( process
, 1 ))
439 process
->debugger
= NULL
;
440 resume_process( process
);
446 set_error( STATUS_ACCESS_DENIED
);
451 /* detach a process from a debugger thread (and resume it ?) */
452 int debugger_detach( struct process
*process
, struct thread
*debugger
)
454 struct debug_event
*event
;
455 struct debug_ctx
*debug_ctx
;
457 if (!process
->debugger
|| process
->debugger
!= debugger
)
458 goto error
; /* not currently debugged, or debugged by another debugger */
459 if (!debugger
->debug_ctx
) goto error
; /* should be a debugger */
460 /* init should be done, otherwise wouldn't be attached */
461 assert(is_process_init_done(process
));
463 suspend_process( process
);
464 /* send continue indication for all events */
465 debug_ctx
= debugger
->debug_ctx
;
467 /* find the event in the queue
468 * FIXME: could loop on process' threads and look the debug_event field */
469 LIST_FOR_EACH_ENTRY( event
, &debug_ctx
->event_queue
, struct debug_event
, entry
)
471 if (event
->state
!= EVENT_QUEUED
) continue;
473 if (event
->sender
->process
== process
)
475 assert( event
->sender
->debug_event
== event
);
476 event
->status
= DBG_CONTINUE
;
477 event
->state
= EVENT_CONTINUED
;
478 wake_up( &event
->obj
, 0 );
479 unlink_event( debug_ctx
, event
);
480 /* from queued debug event */
481 resume_process( process
);
486 /* remove relationships between process and its debugger */
487 process
->debugger
= NULL
;
488 if (!set_process_debug_flag( process
, 0 )) clear_error(); /* ignore error */
490 /* from this function */
491 resume_process( process
);
495 set_error( STATUS_ACCESS_DENIED
);
499 /* generate all startup events of a given process */
500 void generate_startup_debug_events( struct process
*process
, void *entry
)
503 struct thread
*thread
, *first_thread
= get_process_first_thread( process
);
505 /* generate creation events */
506 LIST_FOR_EACH_ENTRY( thread
, &process
->thread_list
, struct thread
, proc_entry
)
508 if (thread
== first_thread
)
509 generate_debug_event( thread
, CREATE_PROCESS_DEBUG_EVENT
, entry
);
511 generate_debug_event( thread
, CREATE_THREAD_DEBUG_EVENT
, NULL
);
514 /* generate dll events (in loading order, i.e. reverse list order) */
515 ptr
= list_tail( &process
->dlls
);
518 struct process_dll
*dll
= LIST_ENTRY( ptr
, struct process_dll
, entry
);
519 generate_debug_event( first_thread
, LOAD_DLL_DEBUG_EVENT
, dll
);
520 ptr
= list_prev( &process
->dlls
, ptr
);
524 /* set the debugger of a given process */
525 int set_process_debugger( struct process
*process
, struct thread
*debugger
)
527 struct debug_ctx
*debug_ctx
;
529 assert( !process
->debugger
);
531 if (!debugger
->debug_ctx
) /* need to allocate a context */
533 if (!(debug_ctx
= alloc_object( &debug_ctx_ops
))) return 0;
534 debug_ctx
->kill_on_exit
= 1;
535 list_init( &debug_ctx
->event_queue
);
536 debugger
->debug_ctx
= debug_ctx
;
538 process
->debugger
= debugger
;
542 /* a thread is exiting */
543 void debug_exit_thread( struct thread
*thread
)
545 if (thread
->debug_ctx
) /* this thread is a debugger */
547 if (thread
->debug_ctx
->kill_on_exit
)
549 /* kill all debugged processes */
550 kill_debugged_processes( thread
, thread
->exit_code
);
554 detach_debugged_processes( thread
);
556 release_object( thread
->debug_ctx
);
557 thread
->debug_ctx
= NULL
;
561 /* Wait for a debug event */
562 DECL_HANDLER(wait_debug_event
)
564 struct debug_ctx
*debug_ctx
= current
->debug_ctx
;
565 struct debug_event
*event
;
567 if (!debug_ctx
) /* current thread is not a debugger */
569 set_error( STATUS_INVALID_HANDLE
);
573 if ((event
= find_event_to_send( debug_ctx
)))
575 data_size_t size
= get_reply_max_size();
576 event
->state
= EVENT_SENT
;
577 event
->sender
->debug_event
= event
;
578 reply
->pid
= get_process_id( event
->sender
->process
);
579 reply
->tid
= get_thread_id( event
->sender
);
580 if (size
> sizeof(debug_event_t
)) size
= sizeof(debug_event_t
);
581 set_reply_data( &event
->data
, size
);
583 else /* no event ready */
588 reply
->wait
= alloc_handle( current
->process
, debug_ctx
, SYNCHRONIZE
, 0 );
592 /* Continue a debug event */
593 DECL_HANDLER(continue_debug_event
)
595 struct process
*process
= get_process_from_id( req
->pid
);
598 struct thread
*thread
= get_thread_from_id( req
->tid
);
601 continue_debug_event( process
, thread
, req
->status
);
602 release_object( thread
);
604 release_object( process
);
608 /* Start debugging an existing process */
609 DECL_HANDLER(debug_process
)
611 struct process
*process
= get_process_from_id( req
->pid
);
612 if (!process
) return;
616 debugger_detach( process
, current
);
618 else if (debugger_attach( process
, current
))
620 generate_startup_debug_events( process
, NULL
);
621 break_process( process
);
622 resume_process( process
);
624 release_object( process
);
627 /* queue an exception event */
628 DECL_HANDLER(queue_exception_event
)
631 if (current
->process
->debugger
)
633 struct debug_event_exception data
;
634 struct debug_event
*event
;
635 const CONTEXT
*context
= get_req_data();
636 const EXCEPTION_RECORD
*rec
= (const EXCEPTION_RECORD
*)(context
+ 1);
638 if (get_req_data_size() < sizeof(*rec
) + sizeof(*context
))
640 set_error( STATUS_INVALID_PARAMETER
);
644 data
.first
= req
->first
;
645 if ((event
= alloc_debug_event( current
, EXCEPTION_DEBUG_EVENT
, &data
, context
)))
647 if ((reply
->handle
= alloc_handle( current
->process
, event
, SYNCHRONIZE
, 0 )))
650 suspend_process( current
->process
);
652 release_object( event
);
657 /* retrieve the status of an exception event */
658 DECL_HANDLER(get_exception_status
)
660 struct debug_event
*event
;
662 if ((event
= (struct debug_event
*)get_handle_obj( current
->process
, req
->handle
,
663 0, &debug_event_ops
)))
665 close_handle( current
->process
, req
->handle
);
666 if (event
->state
== EVENT_CONTINUED
)
668 if (current
->context
== &event
->context
)
670 data_size_t size
= min( sizeof(CONTEXT
), get_reply_max_size() );
671 set_reply_data( &event
->context
, size
);
672 current
->context
= NULL
;
674 set_error( event
->status
);
676 else set_error( STATUS_PENDING
);
677 release_object( event
);
681 /* send an output string to the debugger */
682 DECL_HANDLER(output_debug_string
)
684 struct debug_event_output_string data
;
686 data
.string
= req
->string
;
687 data
.unicode
= req
->unicode
;
688 data
.length
= req
->length
;
689 generate_debug_event( current
, OUTPUT_DEBUG_STRING_EVENT
, &data
);
692 /* simulate a breakpoint in a process */
693 DECL_HANDLER(debug_break
)
695 struct process
*process
;
698 if ((process
= get_process_from_handle( req
->handle
, PROCESS_SET_INFORMATION
/*FIXME*/ )))
700 if (process
!= current
->process
) break_process( process
);
701 else reply
->self
= 1;
702 release_object( process
);
706 /* set debugger kill on exit flag */
707 DECL_HANDLER(set_debugger_kill_on_exit
)
709 if (!current
->debug_ctx
)
711 set_error( STATUS_ACCESS_DENIED
);
714 current
->debug_ctx
->kill_on_exit
= req
->kill_on_exit
;