shlwapi/tests: Fix a test failure on NT4.
[wine/hacks.git] / server / debugger.c
blob727f3be6182b1ee61ff16849047f4e1a7b4ede98
1 /*
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
21 #include "config.h"
22 #include "wine/port.h"
24 #include <assert.h>
25 #include <signal.h>
26 #include <string.h>
27 #include <stdarg.h>
28 #include <stdio.h>
30 #include "ntstatus.h"
31 #define WIN32_NO_STATUS
32 #include "windef.h"
33 #include "winternl.h"
35 #include "handle.h"
36 #include "process.h"
37 #include "thread.h"
38 #include "request.h"
40 enum debug_event_state { EVENT_QUEUED, EVENT_SENT, EVENT_CONTINUED };
42 /* debug event */
43 struct debug_event
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 */
55 /* debug context */
56 struct debug_ctx
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 );
120 return 1;
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;
128 obj_handle_t handle;
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;
135 return 1;
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;
145 obj_handle_t handle;
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 );
155 return 0;
157 event->data.create_process.thread = handle;
159 handle = 0;
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 );
166 return 0;
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;
176 return 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;
183 return 1;
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;
190 return 1;
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 )))
200 return 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;
207 return 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;
214 return 1;
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;
221 return 1;
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;
254 assert( 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 */
269 return event;
271 return NULL;
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 );
303 break;
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 );
309 break;
310 case LOAD_DLL_DEBUG_EVENT:
311 if (event->data.load_dll.handle)
312 close_handle( debugger, event->data.load_dll.handle );
313 break;
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 )
338 struct list *ptr;
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 );
369 return 1;
373 /* not debugging this process, or no such event */
374 set_error( STATUS_ACCESS_DENIED ); /* FIXME */
375 return 0;
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 );
399 return NULL;
401 event->data.code = code;
402 return event;
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 );
411 if (event)
413 link_event( event );
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 (!is_process_init_done( process )) goto error; /* still starting up */
425 if (list_empty( &process->thread_list )) goto error; /* no thread running in the process */
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)
429 goto error;
431 suspend_process( process );
432 if (!set_process_debugger( process, debugger ))
434 resume_process( process );
435 return 0;
437 if (!set_process_debug_flag( process, 1 ))
439 process->debugger = NULL;
440 resume_process( process );
441 return 0;
443 return 1;
445 error:
446 set_error( STATUS_ACCESS_DENIED );
447 return 0;
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, *next;
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 /* free all events from this process */
468 LIST_FOR_EACH_ENTRY_SAFE( event, next, &debug_ctx->event_queue, struct debug_event, entry )
470 if (event->sender->process != process) continue;
472 assert( event->state != EVENT_CONTINUED );
473 event->status = DBG_CONTINUE;
474 event->state = EVENT_CONTINUED;
475 wake_up( &event->obj, 0 );
476 unlink_event( debug_ctx, event );
477 /* from queued debug event */
478 resume_process( process );
481 /* remove relationships between process and its debugger */
482 process->debugger = NULL;
483 if (!set_process_debug_flag( process, 0 )) clear_error(); /* ignore error */
485 /* from this function */
486 resume_process( process );
487 return 0;
489 error:
490 set_error( STATUS_ACCESS_DENIED );
491 return 0;
494 /* generate all startup events of a given process */
495 void generate_startup_debug_events( struct process *process, client_ptr_t entry )
497 struct list *ptr;
498 struct thread *thread, *first_thread = get_process_first_thread( process );
500 /* generate creation events */
501 LIST_FOR_EACH_ENTRY( thread, &process->thread_list, struct thread, proc_entry )
503 if (thread == first_thread)
504 generate_debug_event( thread, CREATE_PROCESS_DEBUG_EVENT, &entry );
505 else
506 generate_debug_event( thread, CREATE_THREAD_DEBUG_EVENT, NULL );
509 /* generate dll events (in loading order, i.e. reverse list order) */
510 ptr = list_tail( &process->dlls );
511 while (ptr != list_head( &process->dlls ))
513 struct process_dll *dll = LIST_ENTRY( ptr, struct process_dll, entry );
514 generate_debug_event( first_thread, LOAD_DLL_DEBUG_EVENT, dll );
515 ptr = list_prev( &process->dlls, ptr );
519 /* set the debugger of a given process */
520 int set_process_debugger( struct process *process, struct thread *debugger )
522 struct debug_ctx *debug_ctx;
524 assert( !process->debugger );
526 if (!debugger->debug_ctx) /* need to allocate a context */
528 if (!(debug_ctx = alloc_object( &debug_ctx_ops ))) return 0;
529 debug_ctx->kill_on_exit = 1;
530 list_init( &debug_ctx->event_queue );
531 debugger->debug_ctx = debug_ctx;
533 process->debugger = debugger;
534 return 1;
537 /* a thread is exiting */
538 void debug_exit_thread( struct thread *thread )
540 if (thread->debug_ctx) /* this thread is a debugger */
542 if (thread->debug_ctx->kill_on_exit)
544 /* kill all debugged processes */
545 kill_debugged_processes( thread, STATUS_DEBUGGER_INACTIVE );
547 else
549 detach_debugged_processes( thread );
551 release_object( thread->debug_ctx );
552 thread->debug_ctx = NULL;
556 /* Wait for a debug event */
557 DECL_HANDLER(wait_debug_event)
559 struct debug_ctx *debug_ctx = current->debug_ctx;
560 struct debug_event *event;
562 if (!debug_ctx) /* current thread is not a debugger */
564 set_error( STATUS_INVALID_HANDLE );
565 return;
567 reply->wait = 0;
568 if ((event = find_event_to_send( debug_ctx )))
570 data_size_t size = get_reply_max_size();
571 event->state = EVENT_SENT;
572 event->sender->debug_event = event;
573 reply->pid = get_process_id( event->sender->process );
574 reply->tid = get_thread_id( event->sender );
575 if (size > sizeof(debug_event_t)) size = sizeof(debug_event_t);
576 set_reply_data( &event->data, size );
578 else /* no event ready */
580 reply->pid = 0;
581 reply->tid = 0;
582 if (req->get_handle)
583 reply->wait = alloc_handle( current->process, debug_ctx, SYNCHRONIZE, 0 );
587 /* Continue a debug event */
588 DECL_HANDLER(continue_debug_event)
590 struct process *process = get_process_from_id( req->pid );
591 if (process)
593 struct thread *thread = get_thread_from_id( req->tid );
594 if (thread)
596 continue_debug_event( process, thread, req->status );
597 release_object( thread );
599 release_object( process );
603 /* Start debugging an existing process */
604 DECL_HANDLER(debug_process)
606 struct process *process = get_process_from_id( req->pid );
607 if (!process) return;
609 if (!req->attach)
611 debugger_detach( process, current );
613 else if (debugger_attach( process, current ))
615 generate_startup_debug_events( process, 0 );
616 break_process( process );
617 resume_process( process );
619 release_object( process );
622 /* queue an exception event */
623 DECL_HANDLER(queue_exception_event)
625 reply->handle = 0;
626 if (current->process->debugger)
628 debug_event_t data;
629 struct debug_event *event;
631 if ((req->len % sizeof(client_ptr_t)) != 0 ||
632 req->len > get_req_data_size() ||
633 req->len > EXCEPTION_MAXIMUM_PARAMETERS * sizeof(client_ptr_t))
635 set_error( STATUS_INVALID_PARAMETER );
636 return;
638 memset( &data, 0, sizeof(data) );
639 data.exception.first = req->first;
640 data.exception.exc_code = req->code;
641 data.exception.flags = req->flags;
642 data.exception.record = req->record;
643 data.exception.address = req->address;
644 data.exception.nb_params = req->len / sizeof(client_ptr_t);
645 memcpy( data.exception.params, get_req_data(), req->len );
647 if ((event = alloc_debug_event( current, EXCEPTION_DEBUG_EVENT, &data )))
649 const context_t *context = (const context_t *)((char *)get_req_data() + req->len);
650 data_size_t size = get_req_data_size() - req->len;
652 memset( &event->context, 0, sizeof(event->context) );
653 memcpy( &event->context, context, min( sizeof(event->context), size ) );
654 current->context = &event->context;
656 if ((reply->handle = alloc_handle( current->process, event, SYNCHRONIZE, 0 )))
658 link_event( event );
659 suspend_process( current->process );
661 release_object( event );
666 /* retrieve the status of an exception event */
667 DECL_HANDLER(get_exception_status)
669 struct debug_event *event;
671 if ((event = (struct debug_event *)get_handle_obj( current->process, req->handle,
672 0, &debug_event_ops )))
674 close_handle( current->process, req->handle );
675 if (event->state == EVENT_CONTINUED)
677 if (current->context == &event->context)
679 data_size_t size = min( sizeof(context_t), get_reply_max_size() );
680 set_reply_data( &event->context, size );
681 current->context = NULL;
683 set_error( event->status );
685 else set_error( STATUS_PENDING );
686 release_object( event );
690 /* send an output string to the debugger */
691 DECL_HANDLER(output_debug_string)
693 debug_event_t data;
695 data.output_string.string = req->string;
696 data.output_string.length = req->length;
697 generate_debug_event( current, OUTPUT_DEBUG_STRING_EVENT, &data );
700 /* simulate a breakpoint in a process */
701 DECL_HANDLER(debug_break)
703 struct process *process;
705 reply->self = 0;
706 if ((process = get_process_from_handle( req->handle, PROCESS_SET_INFORMATION /*FIXME*/ )))
708 if (process != current->process) break_process( process );
709 else reply->self = 1;
710 release_object( process );
714 /* set debugger kill on exit flag */
715 DECL_HANDLER(set_debugger_kill_on_exit)
717 if (!current->debug_ctx)
719 set_error( STATUS_ACCESS_DENIED );
720 return;
722 current->debug_ctx->kill_on_exit = req->kill_on_exit;