2 * Server-side ptrace 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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
28 #include <sys/types.h>
29 #ifdef HAVE_SYS_PTRACE_H
30 # include <sys/ptrace.h>
32 #ifdef HAVE_SYS_PARAM_H
33 # include <sys/param.h>
35 #ifdef HAVE_SYS_WAIT_H
36 # include <sys/wait.h>
41 #define WIN32_NO_STATUS
51 #define PTRACE_CONT PT_CONTINUE
53 #ifndef PTRACE_SINGLESTEP
54 #define PTRACE_SINGLESTEP PT_STEP
57 #define PTRACE_ATTACH PT_ATTACH
60 #define PTRACE_DETACH PT_DETACH
62 #ifndef PTRACE_PEEKDATA
63 #define PTRACE_PEEKDATA PT_READ_D
65 #ifndef PTRACE_POKEDATA
66 #define PTRACE_POKEDATA PT_WRITE_D
68 #ifndef PTRACE_PEEKUSER
69 #define PTRACE_PEEKUSER PT_READ_U
71 #ifndef PTRACE_POKEUSER
72 #define PTRACE_POKEUSER PT_WRITE_U
76 #define PTRACE_GETDBREGS PT_GETDBREGS
79 #define PTRACE_SETDBREGS PT_SETDBREGS
82 #ifndef HAVE_SYS_PTRACE_H
89 inline static int ptrace(int req
, ...) { errno
= EPERM
; return -1; /*FAIL*/ }
90 #endif /* HAVE_SYS_PTRACE_H */
92 /* handle a status returned by wait4 */
93 static int handle_child_status( struct thread
*thread
, int pid
, int status
, int want_sig
)
95 if (WIFSTOPPED(status
))
97 int sig
= WSTOPSIG(status
);
98 if (debug_level
&& thread
)
99 fprintf( stderr
, "%04x: *signal* signal=%d\n", thread
->id
, sig
);
102 /* ignore other signals for now */
103 ptrace( PTRACE_CONT
, pid
, (caddr_t
)1, sig
);
107 if (thread
&& (WIFSIGNALED(status
) || WIFEXITED(status
)))
109 thread
->unix_pid
= -1;
110 thread
->unix_tid
= -1;
113 if (WIFSIGNALED(status
))
114 fprintf( stderr
, "%04x: *exited* signal=%d\n",
115 thread
->id
, WTERMSIG(status
) );
117 fprintf( stderr
, "%04x: *exited* status=%d\n",
118 thread
->id
, WEXITSTATUS(status
) );
124 /* wait4 wrapper to handle missing __WALL flag in older kernels */
125 static inline pid_t
wait4_wrapper( pid_t pid
, int *status
, int options
, struct rusage
*usage
)
128 static int wall_flag
= __WALL
;
132 pid_t ret
= wait4( pid
, status
, options
| wall_flag
, usage
);
133 if (ret
!= -1 || !wall_flag
|| errno
!= EINVAL
) return ret
;
137 return wait4( pid
, status
, options
, usage
);
141 /* handle a SIGCHLD signal */
142 void sigchld_callback(void)
148 if (!(pid
= wait4_wrapper( -1, &status
, WUNTRACED
| WNOHANG
, NULL
))) break;
151 struct thread
*thread
= get_thread_from_tid( pid
);
152 if (!thread
) thread
= get_thread_from_pid( pid
);
153 handle_child_status( thread
, pid
, status
, -1 );
159 /* return the Unix pid to use in ptrace calls for a given thread */
160 static int get_ptrace_pid( struct thread
*thread
)
162 if (thread
->unix_tid
!= -1) return thread
->unix_tid
;
163 return thread
->unix_pid
;
166 /* wait for a ptraced child to get a certain signal */
167 static int wait4_thread( struct thread
*thread
, int signal
)
174 if ((res
= wait4_wrapper( get_ptrace_pid(thread
), &status
, WUNTRACED
, NULL
)) == -1)
178 if (!watchdog_triggered()) continue;
179 if (debug_level
) fprintf( stderr
, "%04x: *watchdog* wait4 aborted\n", thread
->id
);
181 else if (errno
== ECHILD
) /* must have died */
183 thread
->unix_pid
= -1;
184 thread
->unix_tid
= -1;
186 else perror( "wait4" );
190 res
= handle_child_status( thread
, res
, status
, signal
);
191 if (!res
|| res
== signal
) break;
194 return (thread
->unix_pid
!= -1);
197 /* send a signal to a specific thread */
198 static inline int tkill( int tgid
, int pid
, int sig
)
204 __asm__( "pushl %%ebx\n\t"
209 : "0" (270) /*SYS_tgkill*/, "r" (tgid
), "c" (pid
), "d" (sig
) );
211 __asm__( "pushl %%ebx\n\t"
216 : "0" (238) /*SYS_tkill*/, "r" (pid
), "c" (sig
) );
217 # elif defined(__x86_64__)
218 __asm__( "syscall" : "=a" (ret
)
219 : "0" (200) /*SYS_tkill*/, "D" (pid
), "S" (sig
) );
221 #endif /* __linux__ */
223 if (ret
>= 0) return ret
;
228 /* initialize the process tracing mechanism */
229 void init_tracing_mechanism(void)
231 /* no initialization needed for ptrace */
234 /* initialize the per-process tracing mechanism */
235 void init_process_tracing( struct process
*process
)
237 /* ptrace setup is done on-demand */
240 /* terminate the per-process tracing mechanism */
241 void finish_process_tracing( struct process
*process
)
245 /* send a Unix signal to a specific thread */
246 int send_thread_signal( struct thread
*thread
, int sig
)
250 if (thread
->unix_pid
!= -1)
252 if (thread
->unix_tid
!= -1)
254 ret
= tkill( thread
->unix_pid
, thread
->unix_tid
, sig
);
255 if (ret
== -1 && errno
== ENOSYS
) ret
= kill( thread
->unix_pid
, sig
);
257 else ret
= kill( thread
->unix_pid
, sig
);
259 if (ret
== -1 && errno
== ESRCH
) /* thread got killed */
261 thread
->unix_pid
= -1;
262 thread
->unix_tid
= -1;
265 if (debug_level
&& ret
!= -1)
266 fprintf( stderr
, "%04x: *sent signal* signal=%d\n", thread
->id
, sig
);
270 /* resume a thread after we have used ptrace on it */
271 static void resume_after_ptrace( struct thread
*thread
)
273 if (thread
->unix_pid
== -1) return;
274 if (ptrace( PTRACE_DETACH
, get_ptrace_pid(thread
), (caddr_t
)1, 0 ) == -1)
276 if (errno
== ESRCH
) thread
->unix_pid
= thread
->unix_tid
= -1; /* thread got killed */
280 /* suspend a thread to allow using ptrace on it */
281 /* you must do a resume_after_ptrace when finished with the thread */
282 static int suspend_for_ptrace( struct thread
*thread
)
284 /* can't stop a thread while initialisation is in progress */
285 if (thread
->unix_pid
== -1 || !is_process_init_done(thread
->process
)) goto error
;
287 /* this may fail if the client is already being debugged */
288 if (ptrace( PTRACE_ATTACH
, get_ptrace_pid(thread
), 0, 0 ) == -1)
290 if (errno
== ESRCH
) thread
->unix_pid
= thread
->unix_tid
= -1; /* thread got killed */
293 if (wait4_thread( thread
, SIGSTOP
)) return 1;
294 resume_after_ptrace( thread
);
296 set_error( STATUS_ACCESS_DENIED
);
300 /* read an int from a thread address space */
301 static int read_thread_int( struct thread
*thread
, int *addr
, int *data
)
304 *data
= ptrace( PTRACE_PEEKDATA
, get_ptrace_pid(thread
), (caddr_t
)addr
, 0 );
305 if ( *data
== -1 && errno
)
313 /* write an int to a thread address space */
314 static int write_thread_int( struct thread
*thread
, int *addr
, int data
, unsigned int mask
)
319 if (read_thread_int( thread
, addr
, &res
) == -1) return -1;
320 data
= (data
& mask
) | (res
& ~mask
);
322 if ((res
= ptrace( PTRACE_POKEDATA
, get_ptrace_pid(thread
), (caddr_t
)addr
, data
)) == -1)
327 /* return a thread of the process suitable for ptracing */
328 static struct thread
*get_ptrace_thread( struct process
*process
)
330 struct thread
*thread
;
332 LIST_FOR_EACH_ENTRY( thread
, &process
->thread_list
, struct thread
, proc_entry
)
334 if (thread
->unix_pid
!= -1) return thread
;
336 set_error( STATUS_ACCESS_DENIED
); /* process is dead */
340 /* read data from a process memory space */
341 int read_process_memory( struct process
*process
, const void *ptr
, data_size_t size
, char *dest
)
343 struct thread
*thread
= get_ptrace_thread( process
);
344 unsigned int first_offset
, last_offset
, len
;
347 if (!thread
) return 0;
349 first_offset
= (unsigned long)ptr
% sizeof(int);
350 last_offset
= (size
+ first_offset
) % sizeof(int);
351 if (!last_offset
) last_offset
= sizeof(int);
353 addr
= (int *)((char *)ptr
- first_offset
);
354 len
= (size
+ first_offset
+ sizeof(int) - 1) / sizeof(int);
356 if (suspend_for_ptrace( thread
))
360 if (read_thread_int( thread
, addr
++, &data
) == -1) goto done
;
361 memcpy( dest
, (char *)&data
+ first_offset
, sizeof(int) - first_offset
);
362 dest
+= sizeof(int) - first_offset
;
369 if (read_thread_int( thread
, addr
++, &data
) == -1) goto done
;
370 memcpy( dest
, &data
, sizeof(int) );
375 if (read_thread_int( thread
, addr
++, &data
) == -1) goto done
;
376 memcpy( dest
, (char *)&data
+ first_offset
, last_offset
- first_offset
);
380 resume_after_ptrace( thread
);
385 /* make sure we can write to the whole address range */
386 /* len is the total size (in ints) */
387 static int check_process_write_access( struct thread
*thread
, int *addr
, data_size_t len
)
389 int page
= get_page_size() / sizeof(int);
393 if (write_thread_int( thread
, addr
, 0, 0 ) == -1) return 0;
394 if (len
<= page
) break;
398 return (write_thread_int( thread
, addr
+ len
- 1, 0, 0 ) != -1);
401 /* write data to a process memory space */
402 int write_process_memory( struct process
*process
, void *ptr
, data_size_t size
, const char *src
)
404 struct thread
*thread
= get_ptrace_thread( process
);
405 int ret
= 0, data
= 0;
408 unsigned int first_mask
, first_offset
, last_mask
, last_offset
;
410 if (!thread
) return 0;
412 /* compute the mask for the first int */
414 first_offset
= (unsigned long)ptr
% sizeof(int);
415 memset( &first_mask
, 0, first_offset
);
417 /* compute the mask for the last int */
418 last_offset
= (size
+ first_offset
) % sizeof(int);
419 if (!last_offset
) last_offset
= sizeof(int);
421 memset( &last_mask
, 0xff, last_offset
);
423 addr
= (int *)((char *)ptr
- first_offset
);
424 len
= (size
+ first_offset
+ sizeof(int) - 1) / sizeof(int);
426 if (suspend_for_ptrace( thread
))
428 if (!check_process_write_access( thread
, addr
, len
))
430 set_error( STATUS_ACCESS_DENIED
);
433 /* first word is special */
436 memcpy( (char *)&data
+ first_offset
, src
, sizeof(int) - first_offset
);
437 src
+= sizeof(int) - first_offset
;
438 if (write_thread_int( thread
, addr
++, data
, first_mask
) == -1) goto done
;
442 else last_mask
&= first_mask
;
446 memcpy( &data
, src
, sizeof(int) );
448 if (write_thread_int( thread
, addr
++, data
, ~0 ) == -1) goto done
;
452 /* last word is special too */
453 memcpy( (char *)&data
+ first_offset
, src
, last_offset
- first_offset
);
454 if (write_thread_int( thread
, addr
, data
, last_mask
) == -1) goto done
;
458 resume_after_ptrace( thread
);
463 /* retrieve an LDT selector entry */
464 void get_selector_entry( struct thread
*thread
, int entry
, unsigned int *base
,
465 unsigned int *limit
, unsigned char *flags
)
467 if (!thread
->process
->ldt_copy
)
469 set_error( STATUS_ACCESS_DENIED
);
474 set_error( STATUS_ACCESS_VIOLATION
);
477 if (suspend_for_ptrace( thread
))
479 unsigned char flags_buf
[4];
480 int *addr
= (int *)thread
->process
->ldt_copy
+ entry
;
481 if (read_thread_int( thread
, addr
, (int *)base
) == -1) goto done
;
482 if (read_thread_int( thread
, addr
+ 8192, (int *)limit
) == -1) goto done
;
483 addr
= (int *)thread
->process
->ldt_copy
+ 2*8192 + (entry
>> 2);
484 if (read_thread_int( thread
, addr
, (int *)flags_buf
) == -1) goto done
;
485 *flags
= flags_buf
[entry
& 3];
487 resume_after_ptrace( thread
);
492 #if defined(linux) && (defined(__i386__) || defined(__x86_64__))
494 #ifdef HAVE_SYS_USER_H
495 # include <sys/user.h>
498 /* debug register offset in struct user */
499 #define DR_OFFSET(dr) ((((struct user *)0)->u_debugreg) + (dr))
501 /* retrieve the thread x86 registers */
502 void get_thread_context( struct thread
*thread
, CONTEXT
*context
, unsigned int flags
)
504 int i
, pid
= get_ptrace_pid(thread
);
507 /* all other regs are handled on the client side */
508 assert( (flags
| CONTEXT_i386
) == CONTEXT_DEBUG_REGISTERS
);
510 if (!suspend_for_ptrace( thread
)) return;
512 for (i
= 0; i
< 8; i
++)
514 if (i
== 4 || i
== 5) continue;
516 data
[i
] = ptrace( PTRACE_PEEKUSER
, pid
, DR_OFFSET(i
), 0 );
517 if ((data
[i
] == -1) && errno
)
523 context
->Dr0
= data
[0];
524 context
->Dr1
= data
[1];
525 context
->Dr2
= data
[2];
526 context
->Dr3
= data
[3];
527 context
->Dr6
= data
[6];
528 context
->Dr7
= data
[7];
529 context
->ContextFlags
|= CONTEXT_DEBUG_REGISTERS
;
531 resume_after_ptrace( thread
);
534 /* set the thread x86 registers */
535 void set_thread_context( struct thread
*thread
, const CONTEXT
*context
, unsigned int flags
)
537 int pid
= get_ptrace_pid( thread
);
539 /* all other regs are handled on the client side */
540 assert( (flags
| CONTEXT_i386
) == CONTEXT_DEBUG_REGISTERS
);
542 if (!suspend_for_ptrace( thread
)) return;
544 if (ptrace( PTRACE_POKEUSER
, pid
, DR_OFFSET(0), context
->Dr0
) == -1) goto error
;
545 if (thread
->context
) thread
->context
->Dr0
= context
->Dr0
;
546 if (ptrace( PTRACE_POKEUSER
, pid
, DR_OFFSET(1), context
->Dr1
) == -1) goto error
;
547 if (thread
->context
) thread
->context
->Dr1
= context
->Dr1
;
548 if (ptrace( PTRACE_POKEUSER
, pid
, DR_OFFSET(2), context
->Dr2
) == -1) goto error
;
549 if (thread
->context
) thread
->context
->Dr2
= context
->Dr2
;
550 if (ptrace( PTRACE_POKEUSER
, pid
, DR_OFFSET(3), context
->Dr3
) == -1) goto error
;
551 if (thread
->context
) thread
->context
->Dr3
= context
->Dr3
;
552 if (ptrace( PTRACE_POKEUSER
, pid
, DR_OFFSET(6), context
->Dr6
) == -1) goto error
;
553 if (thread
->context
) thread
->context
->Dr6
= context
->Dr6
;
554 if (ptrace( PTRACE_POKEUSER
, pid
, DR_OFFSET(7), context
->Dr7
) == -1) goto error
;
555 if (thread
->context
) thread
->context
->Dr7
= context
->Dr7
;
556 resume_after_ptrace( thread
);
560 resume_after_ptrace( thread
);
563 #elif defined(__i386__) && defined(PTRACE_GETDBREGS) && defined(PTRACE_SETDBREGS) && \
564 (defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__OpenBSD__) || defined(__NetBSD__))
566 #include <machine/reg.h>
568 /* retrieve the thread x86 registers */
569 void get_thread_context( struct thread
*thread
, CONTEXT
*context
, unsigned int flags
)
571 int pid
= get_ptrace_pid(thread
);
574 /* all other regs are handled on the client side */
575 assert( (flags
| CONTEXT_i386
) == CONTEXT_DEBUG_REGISTERS
);
577 if (!suspend_for_ptrace( thread
)) return;
579 if (ptrace( PTRACE_GETDBREGS
, pid
, (caddr_t
) &dbregs
, 0 ) == -1) file_set_error();
583 /* needed for FreeBSD, the structure fields have changed under 5.x */
584 context
->Dr0
= DBREG_DRX((&dbregs
), 0);
585 context
->Dr1
= DBREG_DRX((&dbregs
), 1);
586 context
->Dr2
= DBREG_DRX((&dbregs
), 2);
587 context
->Dr3
= DBREG_DRX((&dbregs
), 3);
588 context
->Dr6
= DBREG_DRX((&dbregs
), 6);
589 context
->Dr7
= DBREG_DRX((&dbregs
), 7);
591 context
->Dr0
= dbregs
.dr0
;
592 context
->Dr1
= dbregs
.dr1
;
593 context
->Dr2
= dbregs
.dr2
;
594 context
->Dr3
= dbregs
.dr3
;
595 context
->Dr6
= dbregs
.dr6
;
596 context
->Dr7
= dbregs
.dr7
;
598 context
->ContextFlags
|= CONTEXT_DEBUG_REGISTERS
;
600 resume_after_ptrace( thread
);
603 /* set the thread x86 registers */
604 void set_thread_context( struct thread
*thread
, const CONTEXT
*context
, unsigned int flags
)
606 int pid
= get_ptrace_pid(thread
);
609 /* all other regs are handled on the client side */
610 assert( (flags
| CONTEXT_i386
) == CONTEXT_DEBUG_REGISTERS
);
612 if (!suspend_for_ptrace( thread
)) return;
615 /* needed for FreeBSD, the structure fields have changed under 5.x */
616 DBREG_DRX((&dbregs
), 0) = context
->Dr0
;
617 DBREG_DRX((&dbregs
), 1) = context
->Dr1
;
618 DBREG_DRX((&dbregs
), 2) = context
->Dr2
;
619 DBREG_DRX((&dbregs
), 3) = context
->Dr3
;
620 DBREG_DRX((&dbregs
), 4) = 0;
621 DBREG_DRX((&dbregs
), 5) = 0;
622 DBREG_DRX((&dbregs
), 6) = context
->Dr6
;
623 DBREG_DRX((&dbregs
), 7) = context
->Dr7
;
625 dbregs
.dr0
= context
->Dr0
;
626 dbregs
.dr1
= context
->Dr1
;
627 dbregs
.dr2
= context
->Dr2
;
628 dbregs
.dr3
= context
->Dr3
;
631 dbregs
.dr6
= context
->Dr6
;
632 dbregs
.dr7
= context
->Dr7
;
634 if (ptrace( PTRACE_SETDBREGS
, pid
, (caddr_t
) &dbregs
, 0 ) == -1) file_set_error();
635 else if (thread
->context
) /* update the cached values */
637 thread
->context
->Dr0
= context
->Dr0
;
638 thread
->context
->Dr1
= context
->Dr1
;
639 thread
->context
->Dr2
= context
->Dr2
;
640 thread
->context
->Dr3
= context
->Dr3
;
641 thread
->context
->Dr6
= context
->Dr6
;
642 thread
->context
->Dr7
= context
->Dr7
;
644 resume_after_ptrace( thread
);
647 #else /* linux || __FreeBSD__ */
649 /* retrieve the thread x86 registers */
650 void get_thread_context( struct thread
*thread
, CONTEXT
*context
, unsigned int flags
)
654 /* set the thread x86 debug registers */
655 void set_thread_context( struct thread
*thread
, const CONTEXT
*context
, unsigned int flags
)
659 #endif /* linux || __FreeBSD__ */
661 #endif /* USE_PTRACE */