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.
41 #include <sys/types.h>
46 /* Open-coding isprint(ch) et al proved more efficient than calling
47 * generalized libc interface. We don't *want* to do non-ASCII anyway.
49 /* #include <ctype.h> */
54 #include <asm/unistd.h>
56 #include "kernel_types.h"
57 #include "mpers_type.h"
58 #include "gcc_compat.h"
61 const char *strerror(int);
64 /* Some libc have stpcpy, some don't. Sigh...
65 * Roll our private implementation...
68 #define stpcpy strace_stpcpy
69 extern char *stpcpy(char *dst, const char *src);
73 # define offsetofend(type, member) \
74 (offsetof(type, member) + sizeof(((type *)NULL)->member))
77 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]) + MUST_BE_ARRAY(a))
81 # define MAX(a, b) (((a) > (b)) ? (a) : (b))
84 # define MIN(a, b) (((a) < (b)) ? (a) : (b))
86 #define CLAMP(val, min, max) MIN(MAX(min, val), max)
88 /* Glibc has an efficient macro for sigemptyset
89 * (it just does one or two assignments of 0 to internal vector of longs).
91 #if defined(__GLIBC__) && defined(__sigemptyset) && !defined(sigemptyset)
92 # define sigemptyset __sigemptyset
95 /* Configuration section */
96 #ifndef DEFAULT_STRLEN
97 /* default maximum # of bytes printed in `printstr', change with -s switch */
98 # define DEFAULT_STRLEN 32
100 #ifndef DEFAULT_ACOLUMN
101 # define DEFAULT_ACOLUMN 40 /* default alignment column for results */
104 * Maximum number of args to a syscall.
106 * Make sure that all entries in all syscallent.h files have nargs <= MAX_ARGS!
107 * linux/<ARCH>/syscallent*.h:
108 * all have nargs <= 6 except mips o32 which has nargs <= 7.
111 # ifdef LINUX_MIPSO32
117 /* default sorting method for call profiling */
118 #ifndef DEFAULT_SORTBY
119 # define DEFAULT_SORTBY "time"
122 * Experimental code using PTRACE_SEIZE can be enabled here.
123 * This needs Linux kernel 3.4.x or later to work.
126 /* To force NOMMU build, set to 1 */
127 #define NOMMU_SYSTEM 0
129 * Set to 1 to use speed-optimized vfprintf implementation.
130 * It results in strace using about 5% less CPU in user space
131 * (compared to glibc version).
132 * But strace spends a lot of time in kernel space,
133 * so overall it does not appear to be a significant win.
134 * Thus disabled by default.
136 #define USE_CUSTOM_PRINTF 0
139 # define ERESTARTSYS 512
141 #ifndef ERESTARTNOINTR
142 # define ERESTARTNOINTR 513
144 #ifndef ERESTARTNOHAND
145 # define ERESTARTNOHAND 514
147 #ifndef ERESTART_RESTARTBLOCK
148 # define ERESTART_RESTARTBLOCK 516
152 # define SUPPORTED_PERSONALITIES 3
153 # define PERSONALITY2_WORDSIZE 4
154 # define PERSONALITY2_KLONGSIZE PERSONALITY0_KLONGSIZE
155 #elif defined AARCH64 \
156 || defined POWERPC64 \
161 # define SUPPORTED_PERSONALITIES 2
163 # define SUPPORTED_PERSONALITIES 1
166 #if defined TILE && defined __tilepro__
167 # define DEFAULT_PERSONALITY 1
169 # define DEFAULT_PERSONALITY 0
172 #define PERSONALITY0_WORDSIZE SIZEOF_LONG
173 #define PERSONALITY0_KLONGSIZE SIZEOF_KERNEL_LONG_T
174 #define PERSONALITY0_INCLUDE_PRINTERS_DECLS "native_printer_decls.h"
175 #define PERSONALITY0_INCLUDE_PRINTERS_DEFS "native_printer_defs.h"
177 #if SUPPORTED_PERSONALITIES > 1
178 # define PERSONALITY1_WORDSIZE 4
179 # define PERSONALITY1_KLONGSIZE PERSONALITY1_WORDSIZE
182 #if SUPPORTED_PERSONALITIES > 1 && defined HAVE_M32_MPERS
183 # define PERSONALITY1_INCLUDE_PRINTERS_DECLS "m32_printer_decls.h"
184 # define PERSONALITY1_INCLUDE_PRINTERS_DEFS "m32_printer_defs.h"
185 # define PERSONALITY1_INCLUDE_FUNCS "m32_funcs.h"
186 # define MPERS_m32_IOCTL_MACROS "ioctl_redefs1.h"
188 # define PERSONALITY1_INCLUDE_PRINTERS_DECLS "native_printer_decls.h"
189 # define PERSONALITY1_INCLUDE_PRINTERS_DEFS "native_printer_defs.h"
190 # define PERSONALITY1_INCLUDE_FUNCS "empty.h"
193 #if SUPPORTED_PERSONALITIES > 2 && defined HAVE_MX32_MPERS
194 # define PERSONALITY2_INCLUDE_FUNCS "mx32_funcs.h"
195 # define PERSONALITY2_INCLUDE_PRINTERS_DECLS "mx32_printer_decls.h"
196 # define PERSONALITY2_INCLUDE_PRINTERS_DEFS "mx32_printer_defs.h"
197 # define MPERS_mx32_IOCTL_MACROS "ioctl_redefs2.h"
199 # define PERSONALITY2_INCLUDE_PRINTERS_DECLS "native_printer_decls.h"
200 # define PERSONALITY2_INCLUDE_PRINTERS_DEFS "native_printer_defs.h"
201 # define PERSONALITY2_INCLUDE_FUNCS "empty.h"
204 typedef struct sysent {
209 const char *sys_name;
212 typedef struct ioctlent {
223 #if defined LINUX_MIPSN32 || defined X32
224 # define HAVE_STRUCT_TCB_EXT_ARG 1
226 # define HAVE_STRUCT_TCB_EXT_ARG 0
229 /* Trace Control Block */
231 int flags; /* See below for TCB_ values */
232 int pid; /* If 0, this tcb is free */
233 int qual_flg; /* qual_flags[scno] or DEFAULT_QUAL_FLAGS + RAW */
234 unsigned long u_error; /* Error code */
235 kernel_scno_t scno; /* System call number */
236 kernel_ureg_t u_arg[MAX_ARGS]; /* System call arguments */
237 #if HAVE_STRUCT_TCB_EXT_ARG
238 unsigned long long ext_arg[MAX_ARGS];
239 long long u_lrval; /* long long return value */
241 long u_rval; /* Return value */
242 #if SUPPORTED_PERSONALITIES > 1
243 unsigned int currpers; /* Personality at the time of scno update */
245 int sys_func_rval; /* Syscall entry parser's return value */
246 int curcol; /* Output column for this process */
247 FILE *outf; /* Output file for this process */
248 const char *auxstr; /* Auxiliary info from syscall (see RVAL_STR) */
249 void *_priv_data; /* Private data for syscall decoding functions */
250 void (*_free_priv_data)(void *); /* Callback for freeing priv_data */
251 const struct_sysent *s_ent; /* sysent[scno] or dummy struct for bad scno */
252 const struct_sysent *s_prev_ent; /* for "resuming interrupted SYSCALL" msg */
253 struct fault_opts *fault_vec[SUPPORTED_PERSONALITIES];
254 struct timeval stime; /* System time usage as of last process wait */
255 struct timeval dtime; /* Delta for system time usage */
256 struct timeval etime; /* Syscall entry time */
259 struct UPT_info* libunwind_ui;
260 struct mmap_cache_t* mmap_cache;
261 unsigned int mmap_cache_size;
262 unsigned int mmap_cache_generation;
263 struct queue_t* queue;
268 /* We have attached to this process, but did not see it stopping yet */
269 #define TCB_STARTUP 0x01
270 #define TCB_IGNORE_ONE_SIGSTOP 0x02 /* Next SIGSTOP is to be ignored */
272 * Are we in system call entry or in syscall exit?
274 * This bit is set after all syscall entry processing is done.
275 * Therefore, this bit will be set when next ptrace stop occurs,
276 * which should be syscall exit stop. Other stops which are possible
277 * directly after syscall entry (death, ptrace event stop)
278 * are simpler and handled without calling trace_syscall(), therefore
279 * the places where TCB_INSYSCALL can be set but we aren't in syscall stop
280 * are limited to trace(), this condition is never observed in trace_syscall()
282 * The bit is cleared after all syscall exit processing is done.
284 * Use entering(tcp) / exiting(tcp) to check this bit to make code more readable.
286 #define TCB_INSYSCALL 0x04
287 #define TCB_ATTACHED 0x08 /* We attached to it already */
288 #define TCB_REPRINT 0x10 /* We should reprint this syscall on exit */
289 #define TCB_FILTERED 0x20 /* This system call has been filtered out */
290 #define TCB_FAULT_INJ 0x40 /* A syscall fault has been injected */
291 #define TCB_HIDE_LOG 0x80 /* We should hide everything (until execve) */
292 #define TCB_SKIP_DETACH_ON_FIRST_EXEC 0x100 /* -b execve should skip detach on first execve */
294 /* qualifier flags */
295 #define QUAL_TRACE 0x001 /* this system call should be traced */
296 #define QUAL_ABBREV 0x002 /* abbreviate the structures of this syscall */
297 #define QUAL_VERBOSE 0x004 /* decode the structures of this syscall */
298 #define QUAL_RAW 0x008 /* print all args in hex for this syscall */
299 #define QUAL_FAULT 0x010 /* fail this system call on purpose */
300 #define QUAL_SIGNAL 0x100 /* report events with this signal */
301 #define QUAL_READ 0x200 /* dump data read from this file descriptor */
302 #define QUAL_WRITE 0x400 /* dump data written to this file descriptor */
304 #define DEFAULT_QUAL_FLAGS (QUAL_TRACE | QUAL_ABBREV | QUAL_VERBOSE)
306 #define entering(tcp) (!((tcp)->flags & TCB_INSYSCALL))
307 #define exiting(tcp) ((tcp)->flags & TCB_INSYSCALL)
308 #define syserror(tcp) ((tcp)->u_error != 0)
309 #define verbose(tcp) ((tcp)->qual_flg & QUAL_VERBOSE)
310 #define abbrev(tcp) ((tcp)->qual_flg & QUAL_ABBREV)
311 #define filtered(tcp) ((tcp)->flags & TCB_FILTERED)
312 #define hide_log(tcp) ((tcp)->flags & TCB_HIDE_LOG)
316 extern const struct xlat addrfams[];
317 extern const struct xlat at_flags[];
318 extern const struct xlat dirent_types[];
319 extern const struct xlat evdev_abs[];
320 extern const struct xlat msg_flags[];
321 extern const struct xlat open_access_modes[];
322 extern const struct xlat open_mode_flags[];
323 extern const struct xlat resource_flags[];
324 extern const struct xlat socketlayers[];
325 extern const struct xlat whence_codes[];
327 /* Format of syscall return values */
328 #define RVAL_DECIMAL 000 /* decimal format */
329 #define RVAL_HEX 001 /* hex format */
330 #define RVAL_OCTAL 002 /* octal format */
331 #define RVAL_UDECIMAL 003 /* unsigned decimal format */
332 #if HAVE_STRUCT_TCB_EXT_ARG
333 # if 0 /* unused so far */
334 # define RVAL_LDECIMAL 004 /* long decimal format */
335 # define RVAL_LHEX 005 /* long hex format */
336 # define RVAL_LOCTAL 006 /* long octal format */
338 # define RVAL_LUDECIMAL 007 /* long unsigned decimal format */
339 #endif /* HAVE_STRUCT_TCB_EXT_ARG */
340 #define RVAL_FD 010 /* file descriptor */
341 #define RVAL_MASK 017 /* mask for these values */
343 #define RVAL_STR 020 /* Print `auxstr' field after return val */
344 #define RVAL_NONE 040 /* Print nothing */
346 #define RVAL_DECODED 0100 /* syscall decoding finished */
348 #define TRACE_FILE 001 /* Trace file-related syscalls. */
349 #define TRACE_IPC 002 /* Trace IPC-related syscalls. */
350 #define TRACE_NETWORK 004 /* Trace network-related syscalls. */
351 #define TRACE_PROCESS 010 /* Trace process-related syscalls. */
352 #define TRACE_SIGNAL 020 /* Trace signal-related syscalls. */
353 #define TRACE_DESC 040 /* Trace file descriptor-related syscalls. */
354 #define TRACE_MEMORY 0100 /* Trace memory mapping-related syscalls. */
355 #define SYSCALL_NEVER_FAILS 0200 /* Syscall is always successful. */
356 #define STACKTRACE_INVALIDATE_CACHE 0400 /* Trigger proc/maps cache updating */
357 #define STACKTRACE_CAPTURE_ON_ENTER 01000 /* Capture stacktrace on "entering" stage */
358 #define TRACE_INDIRECT_SUBCALL 02000 /* Syscall is an indirect socket/ipc subcall. */
359 #define COMPAT_SYSCALL_TYPES 04000 /* A compat syscall that uses compat types. */
361 #define IOCTL_NUMBER_UNKNOWN 0
362 #define IOCTL_NUMBER_HANDLED 1
363 #define IOCTL_NUMBER_STOP_LOOKUP 010
365 #define indirect_ipccall(tcp) (tcp->s_ent->sys_flags & TRACE_INDIRECT_SUBCALL)
367 #if defined(ARM) || defined(AARCH64) \
368 || defined(I386) || defined(X32) || defined(X86_64) \
372 || defined(MICROBLAZE) \
375 || defined(SH) || defined(SH64) \
376 || defined(SPARC) || defined(SPARC64) \
378 # define NEED_UID16_PARSERS 1
380 # define NEED_UID16_PARSERS 0
392 extern enum sock_proto get_proto_by_name(const char *);
405 extern cflag_t cflag;
406 extern bool debug_flag;
409 extern bool count_wallclock;
410 extern unsigned int qflag;
411 extern bool not_failing_only;
412 extern unsigned int show_fd_path;
413 /* are we filtering traces based on paths? */
414 extern const char **paths_selected;
415 #define tracing_paths (paths_selected != NULL)
416 extern unsigned xflag;
417 extern unsigned followfork;
419 /* if this is true do the stack trace for every system call */
420 extern bool stack_trace_enabled;
422 extern unsigned ptrace_setoptions;
423 extern unsigned max_strlen;
424 extern unsigned os_release;
425 #undef KERNEL_VERSION
426 #define KERNEL_VERSION(a,b,c) (((a) << 16) + ((b) << 8) + (c))
428 void error_msg(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2));
429 void perror_msg(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2));
430 void error_msg_and_die(const char *fmt, ...)
431 ATTRIBUTE_FORMAT((printf, 1, 2)) ATTRIBUTE_NORETURN;
432 void error_msg_and_help(const char *fmt, ...)
433 ATTRIBUTE_FORMAT((printf, 1, 2)) ATTRIBUTE_NORETURN;
434 void perror_msg_and_die(const char *fmt, ...)
435 ATTRIBUTE_FORMAT((printf, 1, 2)) ATTRIBUTE_NORETURN;
436 void die_out_of_memory(void) ATTRIBUTE_NORETURN;
438 void *xmalloc(size_t size) ATTRIBUTE_MALLOC ATTRIBUTE_ALLOC_SIZE((1));
439 void *xcalloc(size_t nmemb, size_t size)
440 ATTRIBUTE_MALLOC ATTRIBUTE_ALLOC_SIZE((1, 2));
441 void *xreallocarray(void *ptr, size_t nmemb, size_t size)
442 ATTRIBUTE_ALLOC_SIZE((2, 3));
443 char *xstrdup(const char *str) ATTRIBUTE_MALLOC;
445 #if USE_CUSTOM_PRINTF
447 * See comment in vsprintf.c for allowed formats.
448 * Short version: %h[h]u, %zu, %tu are not allowed, use %[l[l]]u.
450 int strace_vfprintf(FILE *fp, const char *fmt, va_list args);
452 # define strace_vfprintf vfprintf
455 extern int read_int_from_file(const char *, int *);
457 extern void set_sortby(const char *);
458 extern void set_overhead(int);
459 extern void print_pc(struct tcb *);
460 extern int trace_syscall(struct tcb *);
461 extern void count_syscall(struct tcb *, const struct timeval *);
462 extern void call_summary(FILE *);
464 extern void clear_regs(void);
465 extern void get_regs(pid_t pid);
466 extern int get_scno(struct tcb *tcp);
468 * Convert syscall number to syscall name.
470 * @param scno Syscall number.
471 * @return String literal corresponding to the syscall number in case latter
472 * is valid; NULL otherwise.
474 extern const char *syscall_name(kernel_scno_t scno);
475 extern const char *err_name(unsigned long err);
477 extern bool is_erestart(struct tcb *);
478 extern void temporarily_clear_syserror(struct tcb *);
479 extern void restore_cleared_syserror(struct tcb *);
481 extern void *get_tcb_priv_data(const struct tcb *);
482 extern int set_tcb_priv_data(struct tcb *, void *priv_data,
483 void (*free_priv_data)(void *));
484 extern void free_tcb_priv_data(struct tcb *);
486 static inline unsigned long get_tcb_priv_ulong(const struct tcb *tcp)
488 return (unsigned long) get_tcb_priv_data(tcp);
491 static inline int set_tcb_priv_ulong(struct tcb *tcp, unsigned long val)
493 return set_tcb_priv_data(tcp, (void *) val, 0);
497 umoven(struct tcb *tcp, kernel_ureg_t addr, unsigned int len, void *laddr);
498 #define umove(pid, addr, objp) \
499 umoven((pid), (addr), sizeof(*(objp)), (void *) (objp))
502 umoven_or_printaddr(struct tcb *tcp, kernel_ureg_t addr,
503 unsigned int len, void *laddr);
504 #define umove_or_printaddr(pid, addr, objp) \
505 umoven_or_printaddr((pid), (addr), sizeof(*(objp)), (void *) (objp))
508 umoven_or_printaddr_ignore_syserror(struct tcb *tcp, kernel_ureg_t addr,
509 unsigned int len, void *laddr);
512 umovestr(struct tcb *tcp, kernel_ureg_t addr, unsigned int len, char *laddr);
514 extern int upeek(int pid, long, long *);
515 extern int upoke(int pid, long, long);
518 print_array(struct tcb *tcp,
519 kernel_ureg_t start_addr,
523 int (*umoven_func)(struct tcb *,
527 bool (*print_func)(struct tcb *,
533 #if defined ALPHA || defined IA64 || defined MIPS \
534 || defined SH || defined SPARC || defined SPARC64
535 # define HAVE_GETRVAL2
536 extern long getrval2(struct tcb *);
538 # undef HAVE_GETRVAL2
541 extern const char *signame(const int);
542 extern void pathtrace_select(const char *);
543 extern int pathtrace_match(struct tcb *);
544 extern int getfdpath(struct tcb *, int, char *, unsigned);
545 extern enum sock_proto getfdproto(struct tcb *, int);
547 extern const char *xlookup(const struct xlat *, const uint64_t);
548 extern const char *xlat_search(const struct xlat *, const size_t, const uint64_t);
550 extern unsigned long get_pagesize(void);
552 string_to_uint_ex(const char *str, char **endptr,
553 unsigned int max_val, const char *accepted_ending);
554 extern int string_to_uint(const char *str);
556 string_to_uint_upto(const char *const str, unsigned int max_val)
558 return string_to_uint_ex(str, NULL, max_val, NULL);
560 extern int next_set_bit(const void *bit_array, unsigned cur_bit, unsigned size_bits);
562 #define QUOTE_0_TERMINATED 0x01
563 #define QUOTE_OMIT_LEADING_TRAILING_QUOTES 0x02
564 #define QUOTE_OMIT_TRAILING_0 0x08
566 extern int string_quote(const char *, char *, unsigned int, unsigned int);
567 extern int print_quoted_string(const char *, unsigned int, unsigned int);
569 /* a refers to the lower numbered u_arg,
570 * b refers to the higher numbered u_arg
572 #ifdef WORDS_BIGENDIAN
573 # define ULONG_LONG(a,b) \
574 ((unsigned long long)(unsigned)(b) | ((unsigned long long)(a)<<32))
576 # define ULONG_LONG(a,b) \
577 ((unsigned long long)(unsigned)(a) | ((unsigned long long)(b)<<32))
579 extern int getllval(struct tcb *, unsigned long long *, int);
580 extern int printllval(struct tcb *, const char *, int)
581 ATTRIBUTE_FORMAT((printf, 2, 0));
583 extern void printaddr_klu(kernel_ulong_t addr);
584 extern int printxvals(const uint64_t, const char *, const struct xlat *, ...)
586 extern int printxval_searchn(const struct xlat *xlat, size_t xlat_size,
587 uint64_t val, const char *dflt);
588 #define printxval_search(xlat__, val__, dflt__) \
589 printxval_searchn(xlat__, ARRAY_SIZE(xlat__), val__, dflt__)
590 extern kernel_ulong_t getarg_klu(struct tcb *tcp, int argn);
591 extern int printargs(struct tcb *);
592 extern int printargs_u(struct tcb *);
593 extern int printargs_d(struct tcb *);
595 extern void addflags(const struct xlat *, uint64_t);
596 extern int printflags64(const struct xlat *, uint64_t, const char *);
597 extern const char *sprintflags(const char *, const struct xlat *, uint64_t);
598 extern const char *sprinttime(time_t);
599 extern void print_symbolic_mode_t(unsigned int);
600 extern void print_numeric_umode_t(unsigned short);
601 extern void print_numeric_long_umask(unsigned long);
604 dumpiov_in_msghdr(struct tcb *, kernel_ureg_t addr, unsigned long data_size);
607 dumpiov_in_mmsghdr(struct tcb *, kernel_ureg_t addr);
610 dumpiov_upto(struct tcb *, int len, kernel_ureg_t addr, unsigned long data_size);
613 dumpstr(struct tcb *, kernel_ureg_t addr, int len);
616 printstr_ex(struct tcb *, kernel_ureg_t addr, kernel_ureg_t len,
617 unsigned int user_style);
619 #define DECL_PRINTNUM(name) \
621 printnum_ ## name(struct tcb *, kernel_ureg_t addr, const char *fmt) \
622 ATTRIBUTE_FORMAT((printf, 3, 0))
623 DECL_PRINTNUM(short);
625 DECL_PRINTNUM(int64);
628 #if SUPPORTED_PERSONALITIES > 1 && SIZEOF_LONG > 4
630 printnum_long_int(struct tcb *, kernel_ureg_t addr,
631 const char *fmt_long, const char *fmt_int)
632 ATTRIBUTE_FORMAT((printf, 3, 0))
633 ATTRIBUTE_FORMAT((printf, 4, 0));
634 # define printnum_slong(tcp, addr) \
635 printnum_long_int((tcp), (addr), "%" PRId64, "%d")
636 # define printnum_ulong(tcp, addr) \
637 printnum_long_int((tcp), (addr), "%" PRIu64, "%u")
638 # define printnum_ptr(tcp, addr) \
639 printnum_long_int((tcp), (addr), "%#" PRIx64, "%#x")
640 #elif SIZEOF_LONG > 4
641 # define printnum_slong(tcp, addr) \
642 printnum_int64((tcp), (addr), "%" PRId64)
643 # define printnum_ulong(tcp, addr) \
644 printnum_int64((tcp), (addr), "%" PRIu64)
645 # define printnum_ptr(tcp, addr) \
646 printnum_int64((tcp), (addr), "%#" PRIx64)
648 # define printnum_slong(tcp, addr) \
649 printnum_int((tcp), (addr), "%d")
650 # define printnum_ulong(tcp, addr) \
651 printnum_int((tcp), (addr), "%u")
652 # define printnum_ptr(tcp, addr) \
653 printnum_int((tcp), (addr), "%#x")
656 #define DECL_PRINTPAIR(name) \
658 printpair_ ## name(struct tcb *, kernel_ureg_t addr, const char *fmt) \
659 ATTRIBUTE_FORMAT((printf, 3, 0))
661 DECL_PRINTPAIR(int64);
662 #undef DECL_PRINTPAIR
665 printpathn(struct tcb *, kernel_ureg_t addr, unsigned int n);
668 printpath(struct tcb *, kernel_ureg_t addr);
670 #define TIMESPEC_TEXT_BUFSIZE \
671 (sizeof(intmax_t)*3 * 2 + sizeof("{tv_sec=%jd, tv_nsec=%jd}"))
672 extern void printfd(struct tcb *, int);
673 extern void print_sockaddr(struct tcb *tcp, const void *, int);
674 extern bool print_sockaddr_by_inode(const unsigned long, const enum sock_proto);
675 extern bool print_sockaddr_by_inode_cached(const unsigned long);
676 extern void print_dirfd(struct tcb *, int);
679 decode_sockaddr(struct tcb *, kernel_ureg_t addr, int addrlen);
681 extern void printuid(const char *, const unsigned int);
684 print_sigset_addr_len(struct tcb *, kernel_ureg_t addr, kernel_ureg_t len);
686 extern const char *sprintsigmask_n(const char *, const void *, unsigned int);
687 #define tprintsigmask_addr(prefix, mask) \
688 tprints(sprintsigmask_n((prefix), (mask), sizeof(mask)))
689 extern void printsignal(int);
692 tprint_iov_upto(struct tcb *, kernel_ureg_t len, kernel_ureg_t addr,
693 enum iov_decode, kernel_ureg_t data_size);
696 decode_netlink(struct tcb *, kernel_ureg_t addr, unsigned long len);
698 extern void tprint_open_modes(unsigned int);
699 extern const char *sprint_open_modes(unsigned int);
702 print_seccomp_filter(struct tcb *, kernel_ureg_t addr);
705 print_seccomp_fprog(struct tcb *, kernel_ureg_t addr, unsigned short len);
708 extern void print_struct_stat(struct tcb *tcp, const struct strace_stat *const st);
710 struct strace_statfs;
713 print_struct_statfs(struct tcb *, kernel_ureg_t addr);
716 print_struct_statfs64(struct tcb *, kernel_ureg_t addr, unsigned long size);
718 extern void print_ifindex(unsigned int);
721 extern struct number_set read_set;
722 extern struct number_set write_set;
723 extern struct number_set signal_set;
725 extern bool is_number_in_set(unsigned int number, const struct number_set *);
726 extern void qualify(const char *);
727 extern unsigned int qual_flags(const unsigned int);
729 #define DECL_IOCTL(name) \
731 name ## _ioctl(struct tcb *, unsigned int request, kernel_ureg_t arg)
744 extern int tv_nz(const struct timeval *);
745 extern int tv_cmp(const struct timeval *, const struct timeval *);
746 extern double tv_float(const struct timeval *);
747 extern void tv_add(struct timeval *, const struct timeval *, const struct timeval *);
748 extern void tv_sub(struct timeval *, const struct timeval *, const struct timeval *);
749 extern void tv_mul(struct timeval *, const struct timeval *, int);
750 extern void tv_div(struct timeval *, const struct timeval *, int);
753 extern void unwind_init(void);
754 extern void unwind_tcb_init(struct tcb *tcp);
755 extern void unwind_tcb_fin(struct tcb *tcp);
756 extern void unwind_cache_invalidate(struct tcb* tcp);
757 extern void unwind_print_stacktrace(struct tcb* tcp);
758 extern void unwind_capture_stacktrace(struct tcb* tcp);
762 printaddr(kernel_ureg_t addr)
768 printstrn(struct tcb *tcp, kernel_ureg_t addr, kernel_ureg_t len)
770 printstr_ex(tcp, addr, len, 0);
774 printstr(struct tcb *tcp, kernel_ureg_t addr)
776 printstr_ex(tcp, addr, -1, QUOTE_0_TERMINATED);
780 printflags(const struct xlat *x, unsigned int flags, const char *dflt)
782 return printflags64(x, flags, dflt);
786 printflags_long(const struct xlat *x, unsigned long flags, const char *dflt)
788 return printflags64(x, flags, dflt);
792 printxval64(const struct xlat *x, const uint64_t val, const char *dflt)
794 return printxvals(val, dflt, x, NULL);
798 printxval(const struct xlat *x, const unsigned int val, const char *dflt)
800 return printxvals(val, dflt, x, NULL);
804 printxval_long(const struct xlat *x, const unsigned long val, const char *dflt)
806 return printxvals(val, dflt, x, NULL);
810 tprint_iov(struct tcb *tcp, kernel_ureg_t len, kernel_ureg_t addr,
811 enum iov_decode decode_iov)
813 tprint_iov_upto(tcp, len, addr, decode_iov, -1);
821 extern void print_timeval32_t(const timeval32_t *);
822 extern void printrusage32(struct tcb *, kernel_ureg_t);
823 extern const char *sprint_timeval32(struct tcb *tcp, kernel_ureg_t);
824 extern void print_timeval32(struct tcb *tcp, kernel_ureg_t);
825 extern void print_timeval32_pair(struct tcb *tcp, kernel_ureg_t);
826 extern void print_itimerval32(struct tcb *tcp, kernel_ureg_t);
829 #ifdef HAVE_STRUCT_USER_DESC
830 extern void print_user_desc(struct tcb *, kernel_ureg_t addr);
833 /* Strace log generation machinery.
835 * printing_tcp: tcb which has incomplete line being printed right now.
836 * NULL if last line has been completed ('\n'-terminated).
837 * printleader(tcp) examines it, finishes incomplete line if needed,
838 * the sets it to tcp.
839 * line_ended() clears printing_tcp and resets ->curcol = 0.
840 * tcp->curcol == 0 check is also used to detect completeness
841 * of last line, since in -ff mode just checking printing_tcp for NULL
844 * If you change this code, test log generation in both -f and -ff modes
846 * strace -oLOG -f[f] test/threaded_execve
847 * strace -oLOG -f[f] test/sigkill_rain
848 * strace -oLOG -f[f] -p "`pidof web_browser`"
850 extern struct tcb *printing_tcp;
851 extern void printleader(struct tcb *);
852 extern void line_ended(void);
853 extern void tabto(void);
854 extern void tprintf(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2));
855 extern void tprints(const char *str);
857 #if SUPPORTED_PERSONALITIES > 1
858 extern void set_personality(int personality);
859 extern unsigned current_personality;
861 # define set_personality(personality) ((void)0)
862 # define current_personality 0
865 #if SUPPORTED_PERSONALITIES == 1
866 # define current_wordsize PERSONALITY0_WORDSIZE
867 # define current_klongsize PERSONALITY0_KLONGSIZE
869 # if SUPPORTED_PERSONALITIES == 2 && PERSONALITY0_WORDSIZE == PERSONALITY1_WORDSIZE
870 # define current_wordsize PERSONALITY0_WORDSIZE
872 extern unsigned current_wordsize;
874 # if SUPPORTED_PERSONALITIES == 2 && PERSONALITY0_KLONGSIZE == PERSONALITY1_KLONGSIZE
875 # define current_klongsize PERSONALITY0_KLONGSIZE
877 extern unsigned current_klongsize;
881 /* In many, many places we play fast and loose and use
882 * tprintf("%d", (int) tcp->u_arg[N]) to print fds, pids etc.
883 * We probably need to use widen_to_long() instead:
885 #if SUPPORTED_PERSONALITIES > 1 && SIZEOF_LONG > 4
886 # define widen_to_long(v) (current_wordsize == 4 ? (long)(int32_t)(v) : (long)(v))
888 # define widen_to_long(v) ((long)(v))
891 #if SUPPORTED_PERSONALITIES > 1 && SIZEOF_LONG > 4
892 # define widen_to_ulong(v) \
893 (current_wordsize == 4 ? (unsigned long) (uint32_t) (v) : \
896 # define widen_to_ulong(v) ((unsigned long)(v))
900 * Zero-extend a signed integer type to unsigned long long.
902 #define zero_extend_signed_to_ull(v) \
903 (sizeof(v) == sizeof(char) ? (unsigned long long) (unsigned char) (v) : \
904 sizeof(v) == sizeof(short) ? (unsigned long long) (unsigned short) (v) : \
905 sizeof(v) == sizeof(int) ? (unsigned long long) (unsigned int) (v) : \
906 sizeof(v) == sizeof(long) ? (unsigned long long) (unsigned long) (v) : \
907 (unsigned long long) (v))
910 * Sign-extend an unsigned integer type to long long.
912 #define sign_extend_unsigned_to_ll(v) \
913 (sizeof(v) == sizeof(char) ? (long long) (char) (v) : \
914 sizeof(v) == sizeof(short) ? (long long) (short) (v) : \
915 sizeof(v) == sizeof(int) ? (long long) (int) (v) : \
916 sizeof(v) == sizeof(long) ? (long long) (long) (v) : \
919 extern const struct_sysent sysent0[];
920 extern const char *const errnoent0[];
921 extern const char *const signalent0[];
922 extern const struct_ioctlent ioctlent0[];
924 #if SUPPORTED_PERSONALITIES > 1
925 extern const struct_sysent *sysent;
926 extern const char *const *errnoent;
927 extern const char *const *signalent;
928 extern const struct_ioctlent *ioctlent;
930 # define sysent sysent0
931 # define errnoent errnoent0
932 # define signalent signalent0
933 # define ioctlent ioctlent0
936 extern unsigned nsyscalls;
937 extern unsigned nerrnos;
938 extern unsigned nsignals;
939 extern unsigned nioctlents;
941 extern const unsigned int nsyscall_vec[SUPPORTED_PERSONALITIES];
942 extern const struct_sysent *const sysent_vec[SUPPORTED_PERSONALITIES];
943 extern struct fault_opts *fault_vec[SUPPORTED_PERSONALITIES];
945 #ifdef IN_MPERS_BOOTSTRAP
946 /* Transform multi-line MPERS_PRINTER_DECL statements to one-liners. */
947 # define MPERS_PRINTER_DECL(type, name, ...) MPERS_PRINTER_DECL(type, name, __VA_ARGS__)
948 #else /* !IN_MPERS_BOOTSTRAP */
949 # if SUPPORTED_PERSONALITIES > 1
950 # include "printers.h"
952 # include "native_printer_decls.h"
954 # define MPERS_PRINTER_DECL(type, name, ...) type MPERS_FUNC_NAME(name)(__VA_ARGS__)
955 #endif /* !IN_MPERS_BOOTSTRAP */
957 /* Checks that sysent[scno] is not out of range. */
959 scno_in_range(kernel_scno_t scno)
961 return scno < nsyscalls;
965 * Checks whether scno is not out of range,
966 * its corresponding sysent[scno].sys_func is non-NULL,
967 * and its sysent[scno].sys_flags has no TRACE_INDIRECT_SUBCALL flag set.
970 scno_is_valid(kernel_scno_t scno)
972 return scno_in_range(scno)
973 && sysent[scno].sys_func
974 && !(sysent[scno].sys_flags & TRACE_INDIRECT_SUBCALL);
977 #define MPERS_FUNC_NAME__(prefix, name) prefix ## name
978 #define MPERS_FUNC_NAME_(prefix, name) MPERS_FUNC_NAME__(prefix, name)
979 #define MPERS_FUNC_NAME(name) MPERS_FUNC_NAME_(MPERS_PREFIX, name)
981 #define SYS_FUNC_NAME(syscall_name) MPERS_FUNC_NAME(syscall_name)
983 #define SYS_FUNC(syscall_name) int SYS_FUNC_NAME(sys_ ## syscall_name)(struct tcb *tcp)
985 #if SIZEOF_KERNEL_LONG_T > SIZEOF_LONG
991 #define PRI_kld PRI_kl"d"
992 #define PRI_klu PRI_kl"u"
993 #define PRI_klx PRI_kl"x"
996 * The kernel used to define 64-bit types on 64-bit systems on a per-arch
997 * basis. Some architectures would use unsigned long and others would use
998 * unsigned long long. These types were exported as part of the
999 * kernel-userspace ABI and now must be maintained forever. This matches
1000 * what the kernel exports for each architecture so we don't need to cast
1001 * every printing of __u64 or __s64 to stdint types.
1003 #if SIZEOF_LONG == 4
1004 # define PRI__64 "ll"
1005 #elif defined ALPHA || defined IA64 || defined MIPS || defined POWERPC
1006 # define PRI__64 "l"
1008 # define PRI__64 "ll"
1011 #define PRI__d64 PRI__64"d"
1012 #define PRI__u64 PRI__64"u"
1013 #define PRI__x64 PRI__64"x"
1015 #endif /* !STRACE_DEFS_H */