2 * i386 register context support
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
31 #ifdef HAVE_SYS_PTRACE_H
32 # include <sys/ptrace.h>
34 #ifdef HAVE_SYS_PARAM_H
35 # include <sys/param.h>
42 #ifndef PTRACE_PEEKUSER
43 # ifdef PTRACE_PEEKUSR /* libc5 uses USR not USER */
44 # define PTRACE_PEEKUSER PTRACE_PEEKUSR
46 # define PTRACE_PEEKUSER PT_READ_U
50 #ifndef PTRACE_POKEUSER
51 # ifdef PTRACE_POKEUSR /* libc5 uses USR not USER */
52 # define PTRACE_POKEUSER PTRACE_POKEUSR
54 # define PTRACE_POKEUSER PT_WRITE_U
58 #ifndef PTRACE_GETREGS
59 #define PTRACE_GETREGS PT_GETREGS
61 #ifndef PTRACE_GETFPREGS
62 #define PTRACE_GETFPREGS PT_GETFPREGS
64 #ifndef PTRACE_SETREGS
65 #define PTRACE_SETREGS PT_SETREGS
67 #ifndef PTRACE_SETFPREGS
68 #define PTRACE_SETFPREGS PT_SETFPREGS
72 #define PTRACE_GETDBREGS PT_GETDBREGS
76 #define PTRACE_SETDBREGS PT_SETDBREGS
80 #ifdef HAVE_SYS_USER_H
81 # include <sys/user.h>
84 /* user_regs definitions from asm/user.h */
85 struct kernel_user_regs_struct
87 long ebx, ecx, edx, esi, edi, ebp, eax;
88 unsigned short ds, __ds, es, __es;
89 unsigned short fs, __fs, gs, __gs;
91 unsigned short cs, __cs;
93 unsigned short ss, __ss;
96 /* debug register offset in struct user */
97 #define DR_OFFSET(dr) ((int)((((struct user *)0)->u_debugreg) + (dr)))
99 /* retrieve a debug register */
100 static inline int get_debug_reg( int pid, int num, DWORD *data )
102 int res = ptrace( PTRACE_PEEKUSER, pid, DR_OFFSET(num), 0 );
103 if ((res == -1) && errno)
112 /* retrieve a thread context */
113 static void get_thread_context( struct thread *thread, unsigned int flags, CONTEXT *context )
115 int pid = thread->unix_pid;
116 if (flags & CONTEXT_FULL)
118 struct kernel_user_regs_struct regs;
119 if (ptrace( PTRACE_GETREGS, pid, 0, ®s ) == -1) goto error;
120 if (flags & CONTEXT_INTEGER)
122 context->Eax = regs.eax;
123 context->Ebx = regs.ebx;
124 context->Ecx = regs.ecx;
125 context->Edx = regs.edx;
126 context->Esi = regs.esi;
127 context->Edi = regs.edi;
129 if (flags & CONTEXT_CONTROL)
131 context->Ebp = regs.ebp;
132 context->Esp = regs.esp;
133 context->Eip = regs.eip;
134 context->SegCs = regs.cs;
135 context->SegSs = regs.ss;
136 context->EFlags = regs.eflags;
138 if (flags & CONTEXT_SEGMENTS)
140 context->SegDs = regs.ds;
141 context->SegEs = regs.es;
142 context->SegFs = regs.fs;
143 context->SegGs = regs.gs;
146 if (flags & CONTEXT_DEBUG_REGISTERS)
148 if (get_debug_reg( pid, 0, &context->Dr0 ) == -1) goto error;
149 if (get_debug_reg( pid, 1, &context->Dr1 ) == -1) goto error;
150 if (get_debug_reg( pid, 2, &context->Dr2 ) == -1) goto error;
151 if (get_debug_reg( pid, 3, &context->Dr3 ) == -1) goto error;
152 if (get_debug_reg( pid, 6, &context->Dr6 ) == -1) goto error;
153 if (get_debug_reg( pid, 7, &context->Dr7 ) == -1) goto error;
155 if (flags & CONTEXT_FLOATING_POINT)
157 /* we can use context->FloatSave directly as it is using the */
158 /* correct structure (the same as fsave/frstor) */
159 if (ptrace( PTRACE_GETFPREGS, pid, 0, &context->FloatSave ) == -1) goto error;
160 context->FloatSave.Cr0NpxState = 0; /* FIXME */
168 /* set a thread context */
169 static void set_thread_context( struct thread *thread, unsigned int flags, const CONTEXT *context )
171 int pid = thread->unix_pid;
172 if (flags & CONTEXT_FULL)
174 struct kernel_user_regs_struct regs;
176 /* need to preserve some registers (at a minimum orig_eax must always be preserved) */
177 if (ptrace( PTRACE_GETREGS, pid, 0, ®s ) == -1) goto error;
179 if (flags & CONTEXT_INTEGER)
181 regs.eax = context->Eax;
182 regs.ebx = context->Ebx;
183 regs.ecx = context->Ecx;
184 regs.edx = context->Edx;
185 regs.esi = context->Esi;
186 regs.edi = context->Edi;
188 if (flags & CONTEXT_CONTROL)
190 regs.ebp = context->Ebp;
191 regs.esp = context->Esp;
192 regs.eip = context->Eip;
193 regs.cs = context->SegCs;
194 regs.ss = context->SegSs;
195 regs.eflags = context->EFlags;
197 if (flags & CONTEXT_SEGMENTS)
199 regs.ds = context->SegDs;
200 regs.es = context->SegEs;
201 regs.fs = context->SegFs;
202 regs.gs = context->SegGs;
204 if (ptrace( PTRACE_SETREGS, pid, 0, ®s ) == -1) goto error;
206 if (flags & CONTEXT_DEBUG_REGISTERS)
208 if (ptrace( PTRACE_POKEUSER, pid, DR_OFFSET(0), context->Dr0 ) == -1) goto error;
209 if (ptrace( PTRACE_POKEUSER, pid, DR_OFFSET(1), context->Dr1 ) == -1) goto error;
210 if (ptrace( PTRACE_POKEUSER, pid, DR_OFFSET(2), context->Dr2 ) == -1) goto error;
211 if (ptrace( PTRACE_POKEUSER, pid, DR_OFFSET(3), context->Dr3 ) == -1) goto error;
212 if (ptrace( PTRACE_POKEUSER, pid, DR_OFFSET(6), context->Dr6 ) == -1) goto error;
213 if (ptrace( PTRACE_POKEUSER, pid, DR_OFFSET(7), context->Dr7 ) == -1) goto error;
215 if (flags & CONTEXT_FLOATING_POINT)
217 /* we can use context->FloatSave directly as it is using the */
218 /* correct structure (the same as fsave/frstor) */
219 if (ptrace( PTRACE_SETFPREGS, pid, 0, &context->FloatSave ) == -1) goto error;
226 #elif defined(__sun) || defined(__sun__)
228 /* retrieve a thread context */
229 static void get_thread_context( struct thread *thread, unsigned int flags, CONTEXT *context )
231 int pid = thread->unix_pid;
232 if (flags & CONTEXT_FULL)
235 if (ptrace( PTRACE_GETREGS, pid, (int) ®s, 0 ) == -1) goto error;
236 if (flags & CONTEXT_INTEGER)
238 context->Eax = regs.r_eax;
239 context->Ebx = regs.r_ebx;
240 context->Ecx = regs.r_ecx;
241 context->Edx = regs.r_edx;
242 context->Esi = regs.r_esi;
243 context->Edi = regs.r_edi;
245 if (flags & CONTEXT_CONTROL)
247 context->Ebp = regs.r_ebp;
248 context->Esp = regs.r_esp;
249 context->Eip = regs.r_eip;
250 context->SegCs = regs.r_cs & 0xffff;
251 context->SegSs = regs.r_ss & 0xffff;
252 context->EFlags = regs.r_efl;
254 if (flags & CONTEXT_SEGMENTS)
256 context->SegDs = regs.r_ds & 0xffff;
257 context->SegEs = regs.r_es & 0xffff;
258 context->SegFs = regs.r_fs & 0xffff;
259 context->SegGs = regs.r_gs & 0xffff;
262 if (flags & CONTEXT_DEBUG_REGISTERS)
264 /* FIXME: How is this done on Solaris? */
266 if (flags & CONTEXT_FLOATING_POINT)
268 /* we can use context->FloatSave directly as it is using the */
269 /* correct structure (the same as fsave/frstor) */
270 if (ptrace( PTRACE_GETFPREGS, pid, (int) &context->FloatSave, 0 ) == -1) goto error;
271 context->FloatSave.Cr0NpxState = 0; /* FIXME */
279 /* set a thread context */
280 static void set_thread_context( struct thread *thread, unsigned int flags, const CONTEXT *context )
282 int pid = thread->unix_pid;
283 if (flags & CONTEXT_FULL)
286 if (((flags | CONTEXT_i386) & CONTEXT_FULL) != CONTEXT_FULL)
288 /* need to preserve some registers */
289 if (ptrace( PTRACE_GETREGS, pid, (int) ®s, 0 ) == -1) goto error;
291 if (flags & CONTEXT_INTEGER)
293 regs.r_eax = context->Eax;
294 regs.r_ebx = context->Ebx;
295 regs.r_ecx = context->Ecx;
296 regs.r_edx = context->Edx;
297 regs.r_esi = context->Esi;
298 regs.r_edi = context->Edi;
300 if (flags & CONTEXT_CONTROL)
302 regs.r_ebp = context->Ebp;
303 regs.r_esp = context->Esp;
304 regs.r_eip = context->Eip;
305 regs.r_cs = context->SegCs;
306 regs.r_ss = context->SegSs;
307 regs.r_efl = context->EFlags;
309 if (flags & CONTEXT_SEGMENTS)
311 regs.r_ds = context->SegDs;
312 regs.r_es = context->SegEs;
313 regs.r_fs = context->SegFs;
314 regs.r_gs = context->SegGs;
316 if (ptrace( PTRACE_SETREGS, pid, (int) ®s, 0 ) == -1) goto error;
318 if (flags & CONTEXT_DEBUG_REGISTERS)
320 /* FIXME: How is this done on Solaris? */
322 if (flags & CONTEXT_FLOATING_POINT)
324 /* we can use context->FloatSave directly as it is using the */
325 /* correct structure (the same as fsave/frstor) */
326 if (ptrace( PTRACE_SETFPREGS, pid, (int) &context->FloatSave, 0 ) == -1) goto error;
333 #elif defined(__FreeBSD__) || defined(__OpenBSD__) || defined(__NetBSD__)
334 #include <machine/reg.h>
336 /* retrieve a thread context */
337 static void get_thread_context( struct thread *thread, unsigned int flags, CONTEXT *context )
339 int pid = thread->unix_pid;
340 if (flags & CONTEXT_FULL)
343 if (ptrace( PTRACE_GETREGS, pid, (caddr_t) ®s, 0 ) == -1) goto error;
344 if (flags & CONTEXT_INTEGER)
346 context->Eax = regs.r_eax;
347 context->Ebx = regs.r_ebx;
348 context->Ecx = regs.r_ecx;
349 context->Edx = regs.r_edx;
350 context->Esi = regs.r_esi;
351 context->Edi = regs.r_edi;
353 if (flags & CONTEXT_CONTROL)
355 context->Ebp = regs.r_ebp;
356 context->Esp = regs.r_esp;
357 context->Eip = regs.r_eip;
358 context->SegCs = regs.r_cs & 0xffff;
359 context->SegSs = regs.r_ss & 0xffff;
360 context->EFlags = regs.r_eflags;
362 if (flags & CONTEXT_SEGMENTS)
364 context->SegDs = regs.r_ds & 0xffff;
365 context->SegEs = regs.r_es & 0xffff;
366 context->SegFs = regs.r_fs & 0xffff;
367 context->SegGs = regs.r_gs & 0xffff;
370 if (flags & CONTEXT_DEBUG_REGISTERS)
372 #ifdef PTRACE_GETDBREGS
374 if (ptrace( PTRACE_GETDBREGS, pid, (caddr_t) &dbregs, 0 ) == -1)
377 /* needed for FreeBSD, the structure fields have changed under 5.x */
378 context->Dr0 = DBREG_DRX((&dbregs), 0);
379 context->Dr1 = DBREG_DRX((&dbregs), 1);
380 context->Dr2 = DBREG_DRX((&dbregs), 2);
381 context->Dr3 = DBREG_DRX((&dbregs), 3);
382 context->Dr6 = DBREG_DRX((&dbregs), 6);
383 context->Dr7 = DBREG_DRX((&dbregs), 7);
385 context->Dr0 = dbregs.dr0;
386 context->Dr1 = dbregs.dr1;
387 context->Dr2 = dbregs.dr2;
388 context->Dr3 = dbregs.dr3;
389 context->Dr6 = dbregs.dr6;
390 context->Dr7 = dbregs.dr7;
395 if (flags & CONTEXT_FLOATING_POINT)
397 /* we can use context->FloatSave directly as it is using the */
398 /* correct structure (the same as fsave/frstor) */
399 if (ptrace( PTRACE_GETFPREGS, pid, (caddr_t) &context->FloatSave, 0 ) == -1) goto error;
400 context->FloatSave.Cr0NpxState = 0; /* FIXME */
408 /* set a thread context */
409 static void set_thread_context( struct thread *thread, unsigned int flags, const CONTEXT *context )
411 int pid = thread->unix_pid;
412 if (flags & CONTEXT_FULL)
415 if (((flags | CONTEXT_i386) & CONTEXT_FULL) != CONTEXT_FULL)
417 /* need to preserve some registers */
418 if (ptrace( PTRACE_GETREGS, pid, (caddr_t) ®s, 0 ) == -1) goto error;
420 if (flags & CONTEXT_INTEGER)
422 regs.r_eax = context->Eax;
423 regs.r_ebx = context->Ebx;
424 regs.r_ecx = context->Ecx;
425 regs.r_edx = context->Edx;
426 regs.r_esi = context->Esi;
427 regs.r_edi = context->Edi;
429 if (flags & CONTEXT_CONTROL)
431 regs.r_ebp = context->Ebp;
432 regs.r_esp = context->Esp;
433 regs.r_eip = context->Eip;
434 regs.r_cs = context->SegCs;
435 regs.r_ss = context->SegSs;
436 regs.r_eflags = context->EFlags;
438 if (flags & CONTEXT_SEGMENTS)
440 regs.r_ds = context->SegDs;
441 regs.r_es = context->SegEs;
442 regs.r_fs = context->SegFs;
443 regs.r_gs = context->SegGs;
445 if (ptrace( PTRACE_SETREGS, pid, (caddr_t) ®s, 0 ) == -1) goto error;
447 if (flags & CONTEXT_DEBUG_REGISTERS)
449 #ifdef PTRACE_SETDBREGS
452 /* needed for FreeBSD, the structure fields have changed under 5.x */
453 DBREG_DRX((&dbregs), 0) = context->Dr0;
454 DBREG_DRX((&dbregs), 1) = context->Dr1;
455 DBREG_DRX((&dbregs), 2) = context->Dr2;
456 DBREG_DRX((&dbregs), 3) = context->Dr3;
457 DBREG_DRX((&dbregs), 4) = 0;
458 DBREG_DRX((&dbregs), 5) = 0;
459 DBREG_DRX((&dbregs), 6) = context->Dr6;
460 DBREG_DRX((&dbregs), 7) = context->Dr7;
462 dbregs.dr0 = context->Dr0;
463 dbregs.dr1 = context->Dr1;
464 dbregs.dr2 = context->Dr2;
465 dbregs.dr3 = context->Dr3;
468 dbregs.dr6 = context->Dr6;
469 dbregs.dr7 = context->Dr7;
471 if (ptrace( PTRACE_SETDBREGS, pid, (caddr_t) &dbregs, 0 ) == -1)
475 if (flags & CONTEXT_FLOATING_POINT)
477 /* we can use context->FloatSave directly as it is using the */
478 /* correct structure (the same as fsave/frstor) */
479 if (ptrace( PTRACE_SETFPREGS, pid, (caddr_t) &context->FloatSave, 0 ) == -1) goto error;
486 #else /* linux || __sun__ || __FreeBSD__ */
487 #error You must implement get/set_thread_context for your platform
488 #endif /* linux || __sun__ || __FreeBSD__ */
491 /* copy a context structure according to the flags */
492 static void copy_context( CONTEXT *to, const CONTEXT *from, int flags )
494 if (flags & CONTEXT_CONTROL)
499 to->SegCs = from->SegCs;
500 to->SegSs = from->SegSs;
501 to->EFlags = from->EFlags;
503 if (flags & CONTEXT_INTEGER)
512 if (flags & CONTEXT_SEGMENTS)
514 to->SegDs = from->SegDs;
515 to->SegEs = from->SegEs;
516 to->SegFs = from->SegFs;
517 to->SegGs = from->SegGs;
519 if (flags & CONTEXT_FLOATING_POINT)
521 to->FloatSave = from->FloatSave;
523 /* we don't bother copying the debug registers, since they */
524 /* always need to be accessed by ptrace anyway */
527 /* retrieve the current instruction pointer of a thread */
528 void *get_thread_ip( struct thread *thread )
532 if (suspend_for_ptrace( thread ))
534 get_thread_context( thread, CONTEXT_CONTROL, &context );
535 resume_thread( thread );
537 return (void *)context.Eip;
540 /* determine if we should continue the thread in single-step mode */
541 int get_thread_single_step( struct thread *thread )
544 if (thread->context) return 0; /* don't single-step inside exception event */
545 get_thread_context( thread, CONTEXT_CONTROL, &context );
546 return (context.EFlags & 0x100) != 0;
549 /* retrieve the current context of a thread */
550 DECL_HANDLER(get_thread_context)
552 struct thread *thread;
554 int flags = req->flags & ~CONTEXT_i386; /* get rid of CPU id */
556 if (get_reply_max_size() < sizeof(CONTEXT))
558 set_error( STATUS_INVALID_PARAMETER );
561 if (!(thread = get_thread_from_handle( req->handle, THREAD_GET_CONTEXT ))) return;
563 if ((data = set_reply_data_size( sizeof(CONTEXT) )))
565 /* copy incoming context into reply */
566 memset( data, 0, sizeof(CONTEXT) );
567 memcpy( data, get_req_data(), min( get_req_data_size(), sizeof(CONTEXT) ));
569 if (thread->context) /* thread is inside an exception event */
571 copy_context( data, thread->context, flags );
572 flags &= CONTEXT_DEBUG_REGISTERS;
574 if (flags && suspend_for_ptrace( thread ))
576 get_thread_context( thread, flags, data );
577 resume_thread( thread );
580 release_object( thread );
584 /* set the current context of a thread */
585 DECL_HANDLER(set_thread_context)
587 struct thread *thread;
588 int flags = req->flags & ~CONTEXT_i386; /* get rid of CPU id */
590 if (get_req_data_size() < sizeof(CONTEXT))
592 set_error( STATUS_INVALID_PARAMETER );
595 if ((thread = get_thread_from_handle( req->handle, THREAD_SET_CONTEXT )))
597 if (thread->context) /* thread is inside an exception event */
599 copy_context( thread->context, get_req_data(), flags );
600 flags &= CONTEXT_DEBUG_REGISTERS;
602 if (flags && suspend_for_ptrace( thread ))
604 set_thread_context( thread, flags, get_req_data() );
605 resume_thread( thread );
607 release_object( thread );
611 #endif /* __i386__ */