wordpad: Updated Korean resource.
[wine.git] / server / debugger.c
blob4d0ac3d6be375fceec14a7a4980a33858698e696
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 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 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) );
112 return 1;
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;
119 obj_handle_t handle;
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;
126 return 1;
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 );
135 obj_handle_t handle;
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 );
145 return 0;
147 event->data.info.create_process.thread = handle;
149 handle = 0;
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 );
156 return 0;
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;
166 return 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;
173 return 1;
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;
180 return 1;
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 )))
190 return 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;
197 return 1;
200 static int fill_unload_dll_event( struct debug_event *event, void *arg )
202 event->data.info.unload_dll.base = arg;
203 return 1;
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;
210 return 1;
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;
243 assert( 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 */
258 return event;
260 return NULL;
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 );
292 break;
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 );
298 break;
299 case LOAD_DLL_DEBUG_EVENT:
300 if (event->data.info.load_dll.handle)
301 close_handle( debugger, event->data.info.load_dll.handle );
302 break;
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 )
327 struct list *ptr;
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 );
358 return 1;
362 /* not debugging this process, or no such event */
363 set_error( STATUS_ACCESS_DENIED ); /* FIXME */
364 return 0;
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 );
389 return NULL;
391 if (context)
393 memcpy( &event->context, context, sizeof(event->context) );
394 thread->context = &event->context;
396 return event;
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 );
405 if (event)
407 link_event( event );
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)
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, void *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)
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, NULL );
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 struct debug_event_exception data;
629 struct debug_event *event;
630 const CONTEXT *context = get_req_data();
631 const EXCEPTION_RECORD *rec = (const EXCEPTION_RECORD *)(context + 1);
633 if (get_req_data_size() < sizeof(*rec) + sizeof(*context))
635 set_error( STATUS_INVALID_PARAMETER );
636 return;
638 data.record = *rec;
639 data.first = req->first;
640 if ((event = alloc_debug_event( current, EXCEPTION_DEBUG_EVENT, &data, context )))
642 if ((reply->handle = alloc_handle( current->process, event, SYNCHRONIZE, 0 )))
644 link_event( event );
645 suspend_process( current->process );
647 release_object( event );
652 /* retrieve the status of an exception event */
653 DECL_HANDLER(get_exception_status)
655 struct debug_event *event;
657 if ((event = (struct debug_event *)get_handle_obj( current->process, req->handle,
658 0, &debug_event_ops )))
660 close_handle( current->process, req->handle );
661 if (event->state == EVENT_CONTINUED)
663 if (current->context == &event->context)
665 data_size_t size = min( sizeof(CONTEXT), get_reply_max_size() );
666 set_reply_data( &event->context, size );
667 current->context = NULL;
669 set_error( event->status );
671 else set_error( STATUS_PENDING );
672 release_object( event );
676 /* send an output string to the debugger */
677 DECL_HANDLER(output_debug_string)
679 struct debug_event_output_string data;
681 data.string = req->string;
682 data.unicode = req->unicode;
683 data.length = req->length;
684 generate_debug_event( current, OUTPUT_DEBUG_STRING_EVENT, &data );
687 /* simulate a breakpoint in a process */
688 DECL_HANDLER(debug_break)
690 struct process *process;
692 reply->self = 0;
693 if ((process = get_process_from_handle( req->handle, PROCESS_SET_INFORMATION /*FIXME*/ )))
695 if (process != current->process) break_process( process );
696 else reply->self = 1;
697 release_object( process );
701 /* set debugger kill on exit flag */
702 DECL_HANDLER(set_debugger_kill_on_exit)
704 if (!current->debug_ctx)
706 set_error( STATUS_ACCESS_DENIED );
707 return;
709 current->debug_ctx->kill_on_exit = req->kill_on_exit;