2 * Copyright (c) 1991, 1992 Paul Kranenburg <pk@cs.few.eur.nl>
3 * Copyright (c) 1993 Branko Lankester <branko@hacktic.nl>
4 * Copyright (c) 1993, 1994, 1995, 1996 Rick Sladkey <jrs@world.std.com>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. The name of the author may not be used to endorse or promote products
16 * derived from this software without specific prior written permission.
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 #ifdef _LARGEFILE64_SOURCE
36 /* This is the macro everything checks before using foo64 names. */
37 # ifndef _LFS64_LARGEFILE
38 # define _LFS64_LARGEFILE 1
45 #include <sys/types.h>
54 #include <sys/syscall.h>
63 /* Configuration section */
66 # define MAX_QUALS 7000 /* maximum number of syscalls, signals, etc. */
68 # define MAX_QUALS 2048 /* maximum number of syscalls, signals, etc. */
71 #ifndef DEFAULT_STRLEN
72 /* default maximum # of bytes printed in `printstr', change with -s switch */
73 # define DEFAULT_STRLEN 32
75 #ifndef DEFAULT_ACOLUMN
76 # define DEFAULT_ACOLUMN 40 /* default alignment column for results */
79 * Maximum number of args to a syscall.
81 * Make sure that all entries in all syscallent.h files have nargs <= MAX_ARGS!
82 * linux/<ARCH>/syscallent.h: all have nargs <= 6.
87 /* default sorting method for call profiling */
88 #ifndef DEFAULT_SORTBY
89 # define DEFAULT_SORTBY "time"
92 #if defined(SPARC) || defined(SPARC64)
95 #if defined(MIPS) && _MIPS_SIM == _MIPS_SIM_ABI32
96 # define LINUX_MIPSO32
98 #if defined(MIPS) && _MIPS_SIM == _MIPS_SIM_NABI32
99 # define LINUX_MIPSN32
100 # define LINUX_MIPS64
102 #if defined(MIPS) && _MIPS_SIM == _MIPS_SIM_ABI64
103 # define LINUX_MIPSN64
104 # define LINUX_MIPS64
107 #if (defined(LINUXSPARC) || defined(X86_64) || defined(ARM) || defined(AVR32)) && defined(__GLIBC__)
108 # include <sys/ptrace.h>
110 /* Work around awkward prototype in ptrace.h. */
111 # define ptrace xptrace
112 # include <sys/ptrace.h>
116 # include <asm/ptrace.h>
119 extern long ptrace(int, int, char *, long);
122 #if !defined(__GLIBC__)
123 # define PTRACE_PEEKUSER PTRACE_PEEKUSR
124 # define PTRACE_POKEUSER PTRACE_POKEUSR
126 #if defined(X86_64) || defined(I386)
127 /* For struct pt_regs. x86 strace uses PTRACE_GETREGS.
128 * PTRACE_GETREGS returns registers in the layout of this struct.
130 # include <asm/ptrace.h>
147 # define PT_GR20 (20*4)
148 # define PT_GR26 (26*4)
149 # define PT_GR28 (28*4)
150 # define PT_IAOQ0 (106*4)
151 # define PT_IAOQ1 (107*4)
154 /* SH64 Linux - this code assumes the following kernel API for system calls:
156 System Call Offset 16 (actually, (syscall no.) | (0x1n << 16),
157 where n = no. of parameters.
158 Other regs Offset 24+
160 On entry: R2-7 = parameters 1-6 (as many as necessary)
161 On return: R9 = result. */
163 /* Offset for peeks of registers */
164 # define REG_OFFSET (24)
165 # define REG_GENERAL(x) (8*(x)+REG_OFFSET)
166 # define REG_PC (0*8)
167 # define REG_SYSCALL (2*8)
170 #define SUPPORTED_PERSONALITIES 1
171 #define DEFAULT_PERSONALITY 0
174 /* Indexes into the pt_regs.u_reg[] array -- UREG_XX from kernel are all off
175 * by 1 and use Ix instead of Ox. These work for both 32 and 64 bit Linux. */
179 # define PERSONALITY0_WORDSIZE 4
180 # define PERSONALITY1_WORDSIZE 4
181 # undef SUPPORTED_PERSONALITIES
182 # if defined(SPARC64)
183 # include <asm/psrcompat.h>
184 # define SUPPORTED_PERSONALITIES 3
185 # define PERSONALITY2_WORDSIZE 8
187 # include <asm/psr.h>
188 # define SUPPORTED_PERSONALITIES 2
189 # endif /* SPARC64 */
190 #endif /* LINUXSPARC */
193 # undef SUPPORTED_PERSONALITIES
194 # define SUPPORTED_PERSONALITIES 2
195 # define PERSONALITY0_WORDSIZE 8
196 # define PERSONALITY1_WORDSIZE 4
200 # undef SUPPORTED_PERSONALITIES
201 # define SUPPORTED_PERSONALITIES 2
202 # define PERSONALITY0_WORDSIZE 4
203 # define PERSONALITY1_WORDSIZE 4
207 # undef SUPPORTED_PERSONALITIES
208 # define SUPPORTED_PERSONALITIES 2
209 # define PERSONALITY0_WORDSIZE 8
210 # define PERSONALITY1_WORDSIZE 4
213 #if !HAVE_DECL_PTRACE_SETOPTIONS
214 # define PTRACE_SETOPTIONS 0x4200
216 #if !HAVE_DECL_PTRACE_GETEVENTMSG
217 # define PTRACE_GETEVENTMSG 0x4201
219 #if !HAVE_DECL_PTRACE_GETSIGINFO
220 # define PTRACE_GETSIGINFO 0x4202
223 #if !HAVE_DECL_PTRACE_O_TRACESYSGOOD
224 # define PTRACE_O_TRACESYSGOOD 0x00000001
226 #if !HAVE_DECL_PTRACE_O_TRACEFORK
227 # define PTRACE_O_TRACEFORK 0x00000002
229 #if !HAVE_DECL_PTRACE_O_TRACEVFORK
230 # define PTRACE_O_TRACEVFORK 0x00000004
232 #if !HAVE_DECL_PTRACE_O_TRACECLONE
233 # define PTRACE_O_TRACECLONE 0x00000008
235 #if !HAVE_DECL_PTRACE_O_TRACEEXEC
236 # define PTRACE_O_TRACEEXEC 0x00000010
238 #if !HAVE_DECL_PTRACE_O_TRACEEXIT
239 # define PTRACE_O_TRACEEXIT 0x00000040
242 #if !HAVE_DECL_PTRACE_EVENT_FORK
243 # define PTRACE_EVENT_FORK 1
245 #if !HAVE_DECL_PTRACE_EVENT_VFORK
246 # define PTRACE_EVENT_VFORK 2
248 #if !HAVE_DECL_PTRACE_EVENT_CLONE
249 # define PTRACE_EVENT_CLONE 3
251 #if !HAVE_DECL_PTRACE_EVENT_EXEC
252 # define PTRACE_EVENT_EXEC 4
254 #if !HAVE_DECL_PTRACE_EVENT_VFORK_DONE
255 # define PTRACE_EVENT_VFORK_DONE 5
257 #if !HAVE_DECL_PTRACE_EVENT_EXIT
258 # define PTRACE_EVENT_EXIT 6
261 /* Experimental code using PTRACE_SEIZE can be enabled here: */
262 //# define USE_SEIZE 1
266 # define PTRACE_SEIZE 0x4206
267 # undef PTRACE_INTERRUPT
268 # define PTRACE_INTERRUPT 0x4207
269 # undef PTRACE_LISTEN
270 # define PTRACE_LISTEN 0x4208
271 # undef PTRACE_SEIZE_DEVEL
272 # define PTRACE_SEIZE_DEVEL 0x80000000
273 # undef PTRACE_EVENT_STOP
274 # define PTRACE_EVENT_STOP 7
275 # define PTRACE_EVENT_STOP1 128
278 #if !defined __GNUC__
279 # define __attribute__(x) /*nothing*/
282 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
285 extern struct pt_regs i386_regs;
288 /* Trace Control Block */
290 int flags; /* See below for TCB_ values */
291 int pid; /* Process Id of this entry */
292 int u_nargs; /* System call argument count */
293 int u_error; /* Error code */
294 long scno; /* System call number */
295 long u_arg[MAX_ARGS]; /* System call arguments */
296 #if defined(LINUX_MIPSN32)
297 long long ext_arg[MAX_ARGS]; /* System call arguments */
299 long u_rval; /* (first) return value */
300 #ifdef HAVE_LONG_LONG
301 long long u_lrval; /* long long return value */
304 #if SUPPORTED_PERSONALITIES > 1
305 int currpers; /* Personality at the time of scno update */
307 int curcol; /* Output column for this process */
308 FILE *outf; /* Output file for this process */
309 const char *auxstr; /* Auxiliary info from syscall (see RVAL_STR) */
310 struct timeval stime; /* System time usage as of last process wait */
311 struct timeval dtime; /* Delta for system time usage */
312 struct timeval etime; /* Syscall entry time */
313 /* Support for tracing forked processes */
314 long baddr; /* `Breakpoint' address */
315 long inst[2]; /* Instructions on above */
319 #define TCB_INUSE 00001 /* This table entry is in use */
320 /* We have attached to this process, but did not see it stopping yet */
321 #define TCB_STARTUP 00002
322 #define TCB_IGNORE_ONE_SIGSTOP 00004 /* Next SIGSTOP is to be ignored */
324 * Are we in system call entry or in syscall exit?
326 * This bit is set after all syscall entry processing is done.
327 * Therefore, this bit will be set when next ptrace stop occurs,
328 * which should be syscall exit stop. Other stops which are possible
329 * directly after syscall entry (death, ptrace event stop)
330 * are simpler and handled without calling trace_syscall(), therefore
331 * the places where TCB_INSYSCALL can be set but we aren't in syscall stop
332 * are limited to trace(), this condition is never observed in trace_syscall()
334 * The bit is cleared after all syscall exit processing is done.
335 * User-generated SIGTRAPs and post-execve SIGTRAP make it necessary
336 * to be very careful and NOT set TCB_INSYSCALL bit when they are encountered.
337 * TCB_WAITEXECVE bit is used for this purpose (see below).
339 * Use entering(tcp) / exiting(tcp) to check this bit to make code more readable.
341 #define TCB_INSYSCALL 00010
342 #define TCB_ATTACHED 00020 /* It is attached already */
343 /* Are we PROG from "strace PROG [ARGS]" invocation? */
344 #define TCB_STRACE_CHILD 00040
345 #define TCB_BPTSET 00100 /* "Breakpoint" set after fork(2) */
346 #define TCB_REPRINT 01000 /* We should reprint this syscall on exit */
347 #define TCB_FILTERED 02000 /* This system call has been filtered out */
348 /* x86 does not need TCB_WAITEXECVE.
349 * It can detect SIGTRAP by looking at eax/rax.
350 * See "not a syscall entry (eax = %ld)\n" message
351 * in syscall_fixup_on_sysenter().
353 #if defined(ALPHA) || defined(AVR32) || defined(SPARC) || defined(SPARC64) \
354 || defined(POWERPC) || defined(IA64) || defined(HPPA) \
355 || defined(SH) || defined(SH64) || defined(S390) || defined(S390X) \
356 || defined(ARM) || defined(MIPS) || defined(BFIN) || defined(TILE)
357 /* This tracee has entered into execve syscall. Expect post-execve SIGTRAP
358 * to happen. (When it is detected, tracee is continued and this bit is cleared.)
360 # define TCB_WAITEXECVE 04000
363 /* qualifier flags */
364 #define QUAL_TRACE 0001 /* this system call should be traced */
365 #define QUAL_ABBREV 0002 /* abbreviate the structures of this syscall */
366 #define QUAL_VERBOSE 0004 /* decode the structures of this syscall */
367 #define QUAL_RAW 0010 /* print all args in hex for this syscall */
368 #define QUAL_SIGNAL 0020 /* report events with this signal */
369 #define QUAL_FAULT 0040 /* report events with this fault */
370 #define QUAL_READ 0100 /* dump data read on this file descriptor */
371 #define QUAL_WRITE 0200 /* dump data written to this file descriptor */
373 #define entering(tcp) (!((tcp)->flags & TCB_INSYSCALL))
374 #define exiting(tcp) ((tcp)->flags & TCB_INSYSCALL)
375 #define syserror(tcp) ((tcp)->u_error != 0)
376 #define verbose(tcp) (qual_flags[(tcp)->scno] & QUAL_VERBOSE)
377 #define abbrev(tcp) (qual_flags[(tcp)->scno] & QUAL_ABBREV)
378 #define filtered(tcp) ((tcp)->flags & TCB_FILTERED)
385 extern const struct xlat open_mode_flags[];
386 extern const struct xlat addrfams[];
387 extern const struct xlat struct_user_offsets[];
388 extern const struct xlat open_access_modes[];
390 /* Format of syscall return values */
391 #define RVAL_DECIMAL 000 /* decimal format */
392 #define RVAL_HEX 001 /* hex format */
393 #define RVAL_OCTAL 002 /* octal format */
394 #define RVAL_UDECIMAL 003 /* unsigned decimal format */
395 #define RVAL_LDECIMAL 004 /* long decimal format */
396 #define RVAL_LHEX 005 /* long hex format */
397 #define RVAL_LOCTAL 006 /* long octal format */
398 #define RVAL_LUDECIMAL 007 /* long unsigned decimal format */
399 #define RVAL_MASK 007 /* mask for these values */
401 #define RVAL_STR 010 /* Print `auxstr' field after return val */
402 #define RVAL_NONE 020 /* Print nothing */
405 # define offsetof(type, member) (((char *) &(((type *) NULL)->member)) - \
406 ((char *) (type *) NULL))
409 /* get offset of member within a user struct */
410 #define uoff(member) offsetof(struct user, member)
412 #define TRACE_FILE 001 /* Trace file-related syscalls. */
413 #define TRACE_IPC 002 /* Trace IPC-related syscalls. */
414 #define TRACE_NETWORK 004 /* Trace network-related syscalls. */
415 #define TRACE_PROCESS 010 /* Trace process-related syscalls. */
416 #define TRACE_SIGNAL 020 /* Trace signal-related syscalls. */
417 #define TRACE_DESC 040 /* Trace file descriptor-related syscalls. */
418 #define SYSCALL_NEVER_FAILS 0100 /* Syscall is always successful. */
425 extern cflag_t cflag;
426 extern int *qual_flags;
427 extern bool debug_flag;
430 extern bool not_failing_only;
431 extern bool show_fd_path;
432 extern bool tracing_paths;
433 extern unsigned int xflag;
434 extern unsigned int followfork;
435 extern unsigned int ptrace_setoptions;
436 extern unsigned int max_strlen;
438 enum bitness_t { BITNESS_CURRENT = 0, BITNESS_32 };
440 void error_msg(const char *fmt, ...) __attribute__ ((format(printf, 1, 2)));
441 void perror_msg(const char *fmt, ...) __attribute__ ((format(printf, 1, 2)));
442 void error_msg_and_die(const char *fmt, ...) __attribute__ ((noreturn, format(printf, 1, 2)));
443 void perror_msg_and_die(const char *fmt, ...) __attribute__ ((noreturn, format(printf, 1, 2)));
444 void die_out_of_memory(void) __attribute__ ((noreturn));
446 extern void set_personality(int personality);
447 extern const char *xlookup(const struct xlat *, int);
448 extern struct tcb *alloc_tcb(int, int);
449 extern void droptcb(struct tcb *);
451 #define alloctcb(pid) alloc_tcb((pid), 1)
453 extern void set_sortby(const char *);
454 extern void set_overhead(int);
455 extern void qualify(const char *);
456 extern int ptrace_restart(int request, struct tcb *tcp, int sig);
457 extern int trace_syscall(struct tcb *);
458 extern void count_syscall(struct tcb *, struct timeval *);
459 extern void printxval(const struct xlat *, int, const char *);
460 extern int printargs(struct tcb *);
461 extern int printargs_lu(struct tcb *);
462 extern int printargs_ld(struct tcb *);
463 extern void addflags(const struct xlat *, int);
464 extern int printflags(const struct xlat *, int, const char *);
465 extern const char *sprintflags(const char *, const struct xlat *, int);
466 extern int umoven(struct tcb *, long, int, char *);
467 extern int umovestr(struct tcb *, long, int, char *);
468 extern int upeek(struct tcb *, long, long *);
469 extern void dumpiov(struct tcb *, int, long);
470 extern void dumpstr(struct tcb *, long, int);
471 extern void printstr(struct tcb *, long, int);
472 extern void printnum(struct tcb *, long, const char *);
473 extern void printnum_int(struct tcb *, long, const char *);
474 extern void printpath(struct tcb *, long);
475 extern void printpathn(struct tcb *, long, int);
476 #define TIMESPEC_TEXT_BUFSIZE (sizeof(long)*3 * 2 + sizeof("{%u, %u}"))
477 #define TIMEVAL_TEXT_BUFSIZE TIMESPEC_TEXT_BUFSIZE
478 extern void printtv_bitness(struct tcb *, long, enum bitness_t, int);
479 extern char *sprinttv(char *, struct tcb *, long, enum bitness_t, int special);
480 extern void print_timespec(struct tcb *, long);
481 extern void sprint_timespec(char *, struct tcb *, long);
482 #ifdef HAVE_SIGINFO_T
483 extern void printsiginfo(siginfo_t *, int);
485 extern const char *getfdpath(struct tcb *, int);
486 extern void printfd(struct tcb *, int);
487 extern void printsock(struct tcb *, long, int);
488 extern void print_sock_optmgmt(struct tcb *, long, int);
489 extern void printrusage(struct tcb *, long);
491 extern void printrusage32(struct tcb *, long);
493 extern void printuid(const char *, unsigned long);
494 extern int clearbpt(struct tcb *);
496 * On Linux, "setbpt" is a misnomer: we don't set a breakpoint
497 * (IOW: no poking in user's text segment),
498 * instead we change fork/vfork/clone into clone(CLONE_PTRACE).
499 * On newer kernels, we use PTRACE_O_TRACECLONE/TRACE[V]FORK instead.
501 extern int setbpt(struct tcb *);
502 extern void printcall(struct tcb *);
503 extern const char *signame(int);
504 extern void print_sigset(struct tcb *, long, int);
505 extern void printsignal(int);
508 extern void call_summary(FILE *);
509 extern void tprint_iov(struct tcb *, unsigned long, unsigned long, int decode_iov);
510 extern void tprint_open_modes(mode_t);
511 extern const char *sprint_open_modes(mode_t);
512 extern int is_restart_error(struct tcb *);
514 extern int pathtrace_select(const char *);
515 extern int pathtrace_match(struct tcb *);
517 extern int change_syscall(struct tcb *, int);
518 extern int internal_fork(struct tcb *);
519 extern int internal_exec(struct tcb *);
521 extern const struct ioctlent *ioctl_lookup(long);
522 extern const struct ioctlent *ioctl_next_match(const struct ioctlent *);
523 extern int ioctl_decode(struct tcb *, long, long);
524 extern int term_ioctl(struct tcb *, long, long);
525 extern int sock_ioctl(struct tcb *, long, long);
526 extern int proc_ioctl(struct tcb *, int, int);
527 extern int rtc_ioctl(struct tcb *, long, long);
528 extern int scsi_ioctl(struct tcb *, long, long);
529 extern int block_ioctl(struct tcb *, long, long);
531 extern int tv_nz(struct timeval *);
532 extern int tv_cmp(struct timeval *, struct timeval *);
533 extern double tv_float(struct timeval *);
534 extern void tv_add(struct timeval *, struct timeval *, struct timeval *);
535 extern void tv_sub(struct timeval *, struct timeval *, struct timeval *);
536 extern void tv_mul(struct timeval *, struct timeval *, int);
537 extern void tv_div(struct timeval *, struct timeval *, int);
539 #if !defined HAVE_STPCPY
540 /* Some libc have stpcpy, some don't. Sigh...
541 * Roll our private implementation...
544 #define stpcpy strace_stpcpy
545 extern char *stpcpy(char *dst, const char *src);
548 #if defined(SPARC) || defined(SPARC64) || defined(IA64) || defined(SH)
549 extern long getrval2(struct tcb *);
552 /* Strace log generation machinery.
554 * printing_tcp: tcb which has incomplete line being printed right now.
555 * NULL if last line has been completed ('\n'-terminated).
556 * printleader(tcp) examines it, finishes incomplete line if needed,
557 * the sets it to tcp.
558 * line_ended() clears printing_tcp and resets ->curcol = 0.
559 * tcp->curcol == 0 check is also used to detect completeness
560 * of last line, since in -ff mode just checking printing_tcp for NULL
563 * If you change this code, test log generation in both -f and -ff modes
565 * strace -oLOG -f[f] test/threaded_execve
566 * strace -oLOG -f[f] test/sigkill_rain
567 * strace -oLOG -f[f] -p "`pidof web_browser`"
569 extern struct tcb *printing_tcp;
570 extern void printleader(struct tcb *);
571 extern void line_ended(void);
572 extern void tabto(void);
573 extern void tprintf(const char *fmt, ...) __attribute__ ((format (printf, 1, 2)));
574 extern void tprints(const char *str);
576 #define umove(pid, addr, objp) \
577 umoven((pid), (addr), sizeof *(objp), (char *) (objp))
579 #define printtv(tcp, addr) \
580 printtv_bitness((tcp), (addr), BITNESS_CURRENT, 0)
581 #define printtv_special(tcp, addr) \
582 printtv_bitness((tcp), (addr), BITNESS_CURRENT, 1)
584 #ifndef HAVE_STRERROR
585 const char *strerror(int);
587 #ifndef HAVE_STRSIGNAL
588 const char *strsignal(int);
591 extern int current_personality;
592 extern const int personality_wordsize[];
598 const char *sys_name;
607 extern const struct sysent *sysent;
608 extern unsigned nsyscalls;
609 extern const char *const *errnoent;
610 extern unsigned nerrnos;
611 extern const struct ioctlent *ioctlent;
612 extern unsigned nioctlents;
613 extern const char *const *signalent;
614 extern unsigned nsignals;
616 #define SCNO_IN_RANGE(scno) \
617 ((unsigned long)(scno) < nsyscalls && sysent[scno].sys_func)
621 /* _l refers to the lower numbered u_arg,
622 * _h refers to the higher numbered u_arg
625 #if HAVE_LITTLE_ENDIAN_LONG_LONG
626 #define LONG_LONG(_l,_h) \
627 ((long long)((unsigned long long)(unsigned)(_l) | ((unsigned long long)(_h)<<32)))
629 #define LONG_LONG(_l,_h) \
630 ((long long)((unsigned long long)(unsigned)(_h) | ((unsigned long long)(_l)<<32)))
633 extern int printllval(struct tcb *, const char *, int);