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>
5 * Copyright (c) 2001-2017 The strace developers.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. The name of the author may not be used to endorse or promote products
17 * derived from this software without specific prior written permission.
19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
20 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
21 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
23 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
24 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42 #include <sys/types.h>
47 /* Open-coding isprint(ch) et al proved more efficient than calling
48 * generalized libc interface. We don't *want* to do non-ASCII anyway.
50 /* #include <ctype.h> */
56 #include "kernel_types.h"
57 #include "mpers_type.h"
58 #include "gcc_compat.h"
62 const char *strerror(int);
65 /* Some libc have stpcpy, some don't. Sigh...
66 * Roll our private implementation...
69 #define stpcpy strace_stpcpy
70 extern char *stpcpy(char *dst, const char *src);
74 # define offsetofend(type, member) \
75 (offsetof(type, member) + sizeof(((type *)NULL)->member))
78 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]) + MUST_BE_ARRAY(a))
82 # define MAX(a, b) (((a) > (b)) ? (a) : (b))
85 # define MIN(a, b) (((a) < (b)) ? (a) : (b))
87 #define CLAMP(val, min, max) MIN(MAX(min, val), max)
89 /* Glibc has an efficient macro for sigemptyset
90 * (it just does one or two assignments of 0 to internal vector of longs).
92 #if defined(__GLIBC__) && defined(__sigemptyset) && !defined(sigemptyset)
93 # define sigemptyset __sigemptyset
96 /* Configuration section */
97 #ifndef DEFAULT_STRLEN
98 /* default maximum # of bytes printed in `printstr', change with -s switch */
99 # define DEFAULT_STRLEN 32
101 #ifndef DEFAULT_ACOLUMN
102 # define DEFAULT_ACOLUMN 40 /* default alignment column for results */
105 * Maximum number of args to a syscall.
107 * Make sure that all entries in all syscallent.h files have nargs <= MAX_ARGS!
108 * linux/<ARCH>/syscallent*.h:
109 * all have nargs <= 6 except mips o32 which has nargs <= 7.
112 # ifdef LINUX_MIPSO32
118 /* default sorting method for call profiling */
119 #ifndef DEFAULT_SORTBY
120 # define DEFAULT_SORTBY "time"
123 * Experimental code using PTRACE_SEIZE can be enabled here.
124 * This needs Linux kernel 3.4.x or later to work.
127 /* To force NOMMU build, set to 1 */
128 #define NOMMU_SYSTEM 0
131 # define ERESTARTSYS 512
133 #ifndef ERESTARTNOINTR
134 # define ERESTARTNOINTR 513
136 #ifndef ERESTARTNOHAND
137 # define ERESTARTNOHAND 514
139 #ifndef ERESTART_RESTARTBLOCK
140 # define ERESTART_RESTARTBLOCK 516
144 # define SUPPORTED_PERSONALITIES 3
145 # define PERSONALITY2_WORDSIZE 4
146 # define PERSONALITY2_KLONGSIZE PERSONALITY0_KLONGSIZE
147 #elif defined AARCH64 \
148 || defined POWERPC64 \
153 # define SUPPORTED_PERSONALITIES 2
155 # define SUPPORTED_PERSONALITIES 1
158 #if defined TILE && defined __tilepro__
159 # define DEFAULT_PERSONALITY 1
161 # define DEFAULT_PERSONALITY 0
164 #define PERSONALITY0_WORDSIZE SIZEOF_LONG
165 #define PERSONALITY0_KLONGSIZE SIZEOF_KERNEL_LONG_T
166 #define PERSONALITY0_INCLUDE_PRINTERS_DECLS "native_printer_decls.h"
167 #define PERSONALITY0_INCLUDE_PRINTERS_DEFS "native_printer_defs.h"
169 #if SUPPORTED_PERSONALITIES > 1
170 # define PERSONALITY1_WORDSIZE 4
171 # define PERSONALITY1_KLONGSIZE PERSONALITY1_WORDSIZE
174 #if SUPPORTED_PERSONALITIES > 1 && defined HAVE_M32_MPERS
175 # define PERSONALITY1_INCLUDE_PRINTERS_DECLS "m32_printer_decls.h"
176 # define PERSONALITY1_INCLUDE_PRINTERS_DEFS "m32_printer_defs.h"
177 # define PERSONALITY1_INCLUDE_FUNCS "m32_funcs.h"
178 # define MPERS_m32_IOCTL_MACROS "ioctl_redefs1.h"
180 # define PERSONALITY1_INCLUDE_PRINTERS_DECLS "native_printer_decls.h"
181 # define PERSONALITY1_INCLUDE_PRINTERS_DEFS "native_printer_defs.h"
182 # define PERSONALITY1_INCLUDE_FUNCS "empty.h"
185 #if SUPPORTED_PERSONALITIES > 2 && defined HAVE_MX32_MPERS
186 # define PERSONALITY2_INCLUDE_FUNCS "mx32_funcs.h"
187 # define PERSONALITY2_INCLUDE_PRINTERS_DECLS "mx32_printer_decls.h"
188 # define PERSONALITY2_INCLUDE_PRINTERS_DEFS "mx32_printer_defs.h"
189 # define MPERS_mx32_IOCTL_MACROS "ioctl_redefs2.h"
191 # define PERSONALITY2_INCLUDE_PRINTERS_DECLS "native_printer_decls.h"
192 # define PERSONALITY2_INCLUDE_PRINTERS_DEFS "native_printer_defs.h"
193 # define PERSONALITY2_INCLUDE_FUNCS "empty.h"
196 typedef struct ioctlent {
208 #define MAX_ERRNO_VALUE 4095
209 #define INJECT_OPTS_RVAL_DEFAULT (-(MAX_ERRNO_VALUE + 1))
211 /* Trace Control Block */
213 int flags; /* See below for TCB_ values */
214 int pid; /* If 0, this tcb is free */
215 int qual_flg; /* qual_flags[scno] or DEFAULT_QUAL_FLAGS + RAW */
216 unsigned long u_error; /* Error code */
217 kernel_ulong_t scno; /* System call number */
218 kernel_ulong_t u_arg[MAX_ARGS]; /* System call arguments */
219 kernel_long_t u_rval; /* Return value */
220 #if SUPPORTED_PERSONALITIES > 1
221 unsigned int currpers; /* Personality at the time of scno update */
223 int sys_func_rval; /* Syscall entry parser's return value */
224 int curcol; /* Output column for this process */
225 FILE *outf; /* Output file for this process */
226 const char *auxstr; /* Auxiliary info from syscall (see RVAL_STR) */
227 void *_priv_data; /* Private data for syscall decoding functions */
228 void (*_free_priv_data)(void *); /* Callback for freeing priv_data */
229 const struct_sysent *s_ent; /* sysent[scno] or dummy struct for bad scno */
230 const struct_sysent *s_prev_ent; /* for "resuming interrupted SYSCALL" msg */
231 struct inject_opts *inject_vec[SUPPORTED_PERSONALITIES];
232 struct timeval stime; /* System time usage as of last process wait */
233 struct timeval dtime; /* Delta for system time usage */
234 struct timeval etime; /* Syscall entry time */
237 struct UPT_info* libunwind_ui;
238 struct mmap_cache_t* mmap_cache;
239 unsigned int mmap_cache_size;
240 unsigned int mmap_cache_generation;
241 struct queue_t* queue;
246 /* We have attached to this process, but did not see it stopping yet */
247 #define TCB_STARTUP 0x01
248 #define TCB_IGNORE_ONE_SIGSTOP 0x02 /* Next SIGSTOP is to be ignored */
250 * Are we in system call entry or in syscall exit?
252 * This bit is set in syscall_entering_finish() and cleared in
253 * syscall_exiting_finish().
254 * Other stops which are possible directly after syscall entry (death, ptrace
255 * event stop) are handled without calling syscall_{entering,exiting}_*().
257 * Use entering(tcp) / exiting(tcp) to check this bit to make code more
260 #define TCB_INSYSCALL 0x04
261 #define TCB_ATTACHED 0x08 /* We attached to it already */
262 #define TCB_REPRINT 0x10 /* We should reprint this syscall on exit */
263 #define TCB_FILTERED 0x20 /* This system call has been filtered out */
264 #define TCB_TAMPERED 0x40 /* A syscall has been tampered with */
265 #define TCB_HIDE_LOG 0x80 /* We should hide everything (until execve) */
266 #define TCB_SKIP_DETACH_ON_FIRST_EXEC 0x100 /* -b execve should skip detach on first execve */
268 /* qualifier flags */
269 #define QUAL_TRACE 0x001 /* this system call should be traced */
270 #define QUAL_ABBREV 0x002 /* abbreviate the structures of this syscall */
271 #define QUAL_VERBOSE 0x004 /* decode the structures of this syscall */
272 #define QUAL_RAW 0x008 /* print all args in hex for this syscall */
273 #define QUAL_INJECT 0x010 /* tamper with this system call on purpose */
274 #define QUAL_SIGNAL 0x100 /* report events with this signal */
275 #define QUAL_READ 0x200 /* dump data read from this file descriptor */
276 #define QUAL_WRITE 0x400 /* dump data written to this file descriptor */
278 #define DEFAULT_QUAL_FLAGS (QUAL_TRACE | QUAL_ABBREV | QUAL_VERBOSE)
280 #define entering(tcp) (!((tcp)->flags & TCB_INSYSCALL))
281 #define exiting(tcp) ((tcp)->flags & TCB_INSYSCALL)
282 #define syserror(tcp) ((tcp)->u_error != 0)
283 #define verbose(tcp) ((tcp)->qual_flg & QUAL_VERBOSE)
284 #define abbrev(tcp) ((tcp)->qual_flg & QUAL_ABBREV)
285 #define filtered(tcp) ((tcp)->flags & TCB_FILTERED)
286 #define hide_log(tcp) ((tcp)->flags & TCB_HIDE_LOG)
290 extern const struct xlat addrfams[];
291 extern const struct xlat at_flags[];
292 extern const struct xlat clocknames[];
293 extern const struct xlat dirent_types[];
294 extern const struct xlat evdev_abs[];
295 extern const struct xlat msg_flags[];
296 extern const struct xlat netlink_protocols[];
297 extern const struct xlat open_access_modes[];
298 extern const struct xlat open_mode_flags[];
299 extern const struct xlat resource_flags[];
300 extern const struct xlat setns_types[];
301 extern const struct xlat sg_io_info[];
302 extern const struct xlat socketlayers[];
303 extern const struct xlat whence_codes[];
305 /* Format of syscall return values */
306 #define RVAL_DECIMAL 000 /* decimal format */
307 #define RVAL_HEX 001 /* hex format */
308 #define RVAL_OCTAL 002 /* octal format */
309 #define RVAL_UDECIMAL 003 /* unsigned decimal format */
310 #define RVAL_FD 010 /* file descriptor */
311 #define RVAL_MASK 013 /* mask for these values */
313 #define RVAL_STR 020 /* Print `auxstr' field after return val */
314 #define RVAL_NONE 040 /* Print nothing */
316 #define RVAL_DECODED 0100 /* syscall decoding finished */
318 #define IOCTL_NUMBER_UNKNOWN 0
319 #define IOCTL_NUMBER_HANDLED 1
320 #define IOCTL_NUMBER_STOP_LOOKUP 010
322 #define indirect_ipccall(tcp) (tcp->s_ent->sys_flags & TRACE_INDIRECT_SUBCALL)
324 #if defined(ARM) || defined(AARCH64) \
325 || defined(I386) || defined(X32) || defined(X86_64) \
329 || defined(MICROBLAZE) \
332 || defined(SH) || defined(SH64) \
333 || defined(SPARC) || defined(SPARC64) \
335 # define NEED_UID16_PARSERS 1
337 # define NEED_UID16_PARSERS 0
349 extern enum sock_proto get_proto_by_name(const char *);
362 extern cflag_t cflag;
363 extern bool debug_flag;
366 extern bool count_wallclock;
367 extern unsigned int qflag;
368 extern bool not_failing_only;
369 extern unsigned int show_fd_path;
370 /* are we filtering traces based on paths? */
371 extern const char **paths_selected;
372 #define tracing_paths (paths_selected != NULL)
373 extern unsigned xflag;
374 extern unsigned followfork;
376 /* if this is true do the stack trace for every system call */
377 extern bool stack_trace_enabled;
379 extern unsigned ptrace_setoptions;
380 extern unsigned max_strlen;
381 extern unsigned os_release;
382 #undef KERNEL_VERSION
383 #define KERNEL_VERSION(a,b,c) (((a) << 16) + ((b) << 8) + (c))
385 void error_msg(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2));
386 void perror_msg(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2));
387 void error_msg_and_die(const char *fmt, ...)
388 ATTRIBUTE_FORMAT((printf, 1, 2)) ATTRIBUTE_NORETURN;
389 void error_msg_and_help(const char *fmt, ...)
390 ATTRIBUTE_FORMAT((printf, 1, 2)) ATTRIBUTE_NORETURN;
391 void perror_msg_and_die(const char *fmt, ...)
392 ATTRIBUTE_FORMAT((printf, 1, 2)) ATTRIBUTE_NORETURN;
393 void die_out_of_memory(void) ATTRIBUTE_NORETURN;
395 void *xmalloc(size_t size) ATTRIBUTE_MALLOC ATTRIBUTE_ALLOC_SIZE((1));
396 void *xcalloc(size_t nmemb, size_t size)
397 ATTRIBUTE_MALLOC ATTRIBUTE_ALLOC_SIZE((1, 2));
398 void *xreallocarray(void *ptr, size_t nmemb, size_t size)
399 ATTRIBUTE_ALLOC_SIZE((2, 3));
400 char *xstrdup(const char *str) ATTRIBUTE_MALLOC;
402 extern int read_int_from_file(const char *, int *);
404 extern void set_sortby(const char *);
405 extern void set_overhead(int);
406 extern void print_pc(struct tcb *);
408 extern int syscall_entering_decode(struct tcb *);
409 extern int syscall_entering_trace(struct tcb *, unsigned int *);
410 extern void syscall_entering_finish(struct tcb *, int);
412 extern int syscall_exiting_decode(struct tcb *, struct timeval *);
413 extern int syscall_exiting_trace(struct tcb *, struct timeval, int);
414 extern void syscall_exiting_finish(struct tcb *);
416 extern void count_syscall(struct tcb *, const struct timeval *);
417 extern void call_summary(FILE *);
419 extern void clear_regs(void);
420 extern int get_scno(struct tcb *);
421 extern kernel_ulong_t get_rt_sigframe_addr(struct tcb *);
424 * Convert syscall number to syscall name.
426 * @param scno Syscall number.
427 * @return String literal corresponding to the syscall number in case latter
428 * is valid; NULL otherwise.
430 extern const char *syscall_name(kernel_ulong_t scno);
431 extern const char *err_name(unsigned long err);
433 extern bool is_erestart(struct tcb *);
434 extern void temporarily_clear_syserror(struct tcb *);
435 extern void restore_cleared_syserror(struct tcb *);
437 extern void *get_tcb_priv_data(const struct tcb *);
438 extern int set_tcb_priv_data(struct tcb *, void *priv_data,
439 void (*free_priv_data)(void *));
440 extern void free_tcb_priv_data(struct tcb *);
442 static inline unsigned long get_tcb_priv_ulong(const struct tcb *tcp)
444 return (unsigned long) get_tcb_priv_data(tcp);
447 static inline int set_tcb_priv_ulong(struct tcb *tcp, unsigned long val)
449 return set_tcb_priv_data(tcp, (void *) val, 0);
453 umoven(struct tcb *tcp, kernel_ulong_t addr, unsigned int len, void *laddr);
454 #define umove(pid, addr, objp) \
455 umoven((pid), (addr), sizeof(*(objp)), (void *) (objp))
458 umoven_or_printaddr(struct tcb *tcp, kernel_ulong_t addr,
459 unsigned int len, void *laddr);
460 #define umove_or_printaddr(pid, addr, objp) \
461 umoven_or_printaddr((pid), (addr), sizeof(*(objp)), (void *) (objp))
464 umoven_or_printaddr_ignore_syserror(struct tcb *tcp, kernel_ulong_t addr,
465 unsigned int len, void *laddr);
468 umovestr(struct tcb *tcp, kernel_ulong_t addr, unsigned int len, char *laddr);
470 extern int upeek(int pid, unsigned long, kernel_ulong_t *);
471 extern int upoke(int pid, unsigned long, kernel_ulong_t);
474 print_array(struct tcb *tcp,
475 kernel_ulong_t start_addr,
479 int (*umoven_func)(struct tcb *,
483 bool (*print_func)(struct tcb *,
489 #if defined ALPHA || defined IA64 || defined MIPS \
490 || defined SH || defined SPARC || defined SPARC64
491 # define HAVE_GETRVAL2
492 extern long getrval2(struct tcb *);
494 # undef HAVE_GETRVAL2
497 extern const char *signame(const int);
498 extern void pathtrace_select(const char *);
499 extern int pathtrace_match(struct tcb *);
500 extern int getfdpath(struct tcb *, int, char *, unsigned);
501 extern unsigned long getfdinode(struct tcb *, int);
502 extern enum sock_proto getfdproto(struct tcb *, int);
504 extern const char *xlookup(const struct xlat *, const uint64_t);
505 extern const char *xlat_search(const struct xlat *, const size_t, const uint64_t);
507 extern unsigned long get_pagesize(void);
509 string_to_uint_ex(const char *str, char **endptr,
510 unsigned int max_val, const char *accepted_ending);
511 extern int string_to_uint(const char *str);
513 string_to_uint_upto(const char *const str, unsigned int max_val)
515 return string_to_uint_ex(str, NULL, max_val, NULL);
517 extern int next_set_bit(const void *bit_array, unsigned cur_bit, unsigned size_bits);
520 * Returns STR if it does not start with PREFIX,
521 * or a pointer to the first char in STR after PREFIX.
522 * The length of PREFIX is specified by PREFIX_LEN.
524 static inline const char *
525 str_strip_prefix_len(const char *str, const char *prefix, size_t prefix_len)
527 return strncmp(str, prefix, prefix_len) ? str : str + prefix_len;
530 #define STR_STRIP_PREFIX(str, prefix) \
531 str_strip_prefix_len((str), (prefix), sizeof(prefix) - 1)
533 #define QUOTE_0_TERMINATED 0x01
534 #define QUOTE_OMIT_LEADING_TRAILING_QUOTES 0x02
535 #define QUOTE_OMIT_TRAILING_0 0x08
536 #define QUOTE_FORCE_HEX 0x10
538 extern int string_quote(const char *, char *, unsigned int, unsigned int);
539 extern int print_quoted_string(const char *, unsigned int, unsigned int);
541 /* a refers to the lower numbered u_arg,
542 * b refers to the higher numbered u_arg
544 #ifdef WORDS_BIGENDIAN
545 # define ULONG_LONG(a,b) \
546 ((unsigned long long)(unsigned)(b) | ((unsigned long long)(a)<<32))
548 # define ULONG_LONG(a,b) \
549 ((unsigned long long)(unsigned)(a) | ((unsigned long long)(b)<<32))
551 extern int getllval(struct tcb *, unsigned long long *, int);
552 extern int printllval(struct tcb *, const char *, int)
553 ATTRIBUTE_FORMAT((printf, 2, 0));
555 extern void printaddr(kernel_ulong_t addr);
556 extern int printxvals(const uint64_t, const char *, const struct xlat *, ...)
558 extern int printxval_searchn(const struct xlat *xlat, size_t xlat_size,
559 uint64_t val, const char *dflt);
560 #define printxval_search(xlat__, val__, dflt__) \
561 printxval_searchn(xlat__, ARRAY_SIZE(xlat__), val__, dflt__)
562 extern int printargs(struct tcb *);
563 extern int printargs_u(struct tcb *);
564 extern int printargs_d(struct tcb *);
566 extern void addflags(const struct xlat *, uint64_t);
567 extern int printflags_ex(uint64_t, const char *, const struct xlat *, ...)
569 extern const char *sprintflags(const char *, const struct xlat *, uint64_t);
570 extern const char *sprinttime(long long sec);
571 extern const char *sprinttime_nsec(long long sec, unsigned long long nsec);
572 extern const char *sprinttime_usec(long long sec, unsigned long long usec);
573 extern void print_symbolic_mode_t(unsigned int);
574 extern void print_numeric_umode_t(unsigned short);
575 extern void print_numeric_long_umask(unsigned long);
576 extern void print_dev_t(unsigned long long dev);
577 extern void print_abnormal_hi(kernel_ulong_t);
580 dumpiov_in_msghdr(struct tcb *, kernel_ulong_t addr, kernel_ulong_t data_size);
583 dumpiov_in_mmsghdr(struct tcb *, kernel_ulong_t addr);
586 dumpiov_upto(struct tcb *, int len, kernel_ulong_t addr, kernel_ulong_t data_size);
589 dumpstr(struct tcb *, kernel_ulong_t addr, int len);
592 printstr_ex(struct tcb *, kernel_ulong_t addr, kernel_ulong_t len,
593 unsigned int user_style);
596 printpathn(struct tcb *, kernel_ulong_t addr, unsigned int n);
599 printpath(struct tcb *, kernel_ulong_t addr);
601 #define TIMESPEC_TEXT_BUFSIZE \
602 (sizeof(long long) * 3 * 2 + sizeof("{tv_sec=-, tv_nsec=}"))
603 extern void printfd(struct tcb *, int);
604 extern void print_sockaddr(struct tcb *tcp, const void *, int);
605 extern const char *get_sockaddr_by_inode(struct tcb *, int fd, unsigned long inode);
606 extern bool print_sockaddr_by_inode(struct tcb *, int fd, unsigned long inode);
607 extern void print_dirfd(struct tcb *, int);
610 decode_sockaddr(struct tcb *, kernel_ulong_t addr, int addrlen);
612 extern void printuid(const char *, const unsigned int);
615 print_sigset_addr_len(struct tcb *, kernel_ulong_t addr, kernel_ulong_t len);
617 print_sigset_addr(struct tcb *, kernel_ulong_t addr);
619 extern const char *sprintsigmask_n(const char *, const void *, unsigned int);
620 #define tprintsigmask_addr(prefix, mask) \
621 tprints(sprintsigmask_n((prefix), (mask), sizeof(mask)))
622 extern void printsignal(int);
625 tprint_iov_upto(struct tcb *, kernel_ulong_t len, kernel_ulong_t addr,
626 enum iov_decode, kernel_ulong_t data_size);
629 decode_netlink(struct tcb *, int fd, kernel_ulong_t addr, kernel_ulong_t len);
631 extern void tprint_open_modes(unsigned int);
632 extern const char *sprint_open_modes(unsigned int);
635 print_seccomp_filter(struct tcb *, kernel_ulong_t addr);
638 print_seccomp_fprog(struct tcb *, kernel_ulong_t addr, unsigned short len);
641 extern void print_struct_stat(struct tcb *tcp, const struct strace_stat *const st);
643 struct strace_statfs;
646 print_struct_statfs(struct tcb *, kernel_ulong_t addr);
649 print_struct_statfs64(struct tcb *, kernel_ulong_t addr, kernel_ulong_t size);
651 extern void print_ifindex(unsigned int);
654 extern struct number_set read_set;
655 extern struct number_set write_set;
656 extern struct number_set signal_set;
658 extern bool is_number_in_set(unsigned int number, const struct number_set *);
659 extern void qualify(const char *);
660 extern unsigned int qual_flags(const unsigned int);
662 #define DECL_IOCTL(name) \
664 name ## _ioctl(struct tcb *, unsigned int request, kernel_ulong_t arg)
676 extern int decode_sg_io_v4(struct tcb *, const kernel_ulong_t arg);
680 typedef bool (*netlink_decoder_t)(struct tcb *, const struct nlmsghdr *,
681 kernel_ulong_t addr, kernel_ulong_t len);
683 #define DECL_NETLINK(name) \
685 decode_netlink_ ## name(struct tcb *, const struct nlmsghdr *, \
686 kernel_ulong_t addr, kernel_ulong_t len)
687 DECL_NETLINK(sock_diag);
689 extern int tv_nz(const struct timeval *);
690 extern int tv_cmp(const struct timeval *, const struct timeval *);
691 extern double tv_float(const struct timeval *);
692 extern void tv_add(struct timeval *, const struct timeval *, const struct timeval *);
693 extern void tv_sub(struct timeval *, const struct timeval *, const struct timeval *);
694 extern void tv_mul(struct timeval *, const struct timeval *, int);
695 extern void tv_div(struct timeval *, const struct timeval *, int);
698 extern void unwind_init(void);
699 extern void unwind_tcb_init(struct tcb *tcp);
700 extern void unwind_tcb_fin(struct tcb *tcp);
701 extern void unwind_cache_invalidate(struct tcb* tcp);
702 extern void unwind_print_stacktrace(struct tcb* tcp);
703 extern void unwind_capture_stacktrace(struct tcb* tcp);
707 printstrn(struct tcb *tcp, kernel_ulong_t addr, kernel_ulong_t len)
709 printstr_ex(tcp, addr, len, 0);
713 printstr(struct tcb *tcp, kernel_ulong_t addr)
715 printstr_ex(tcp, addr, -1, QUOTE_0_TERMINATED);
719 printflags64(const struct xlat *x, uint64_t flags, const char *dflt)
721 return printflags_ex(flags, dflt, x, NULL);
725 printflags(const struct xlat *x, unsigned int flags, const char *dflt)
727 return printflags64(x, flags, dflt);
731 printxval64(const struct xlat *x, const uint64_t val, const char *dflt)
733 return printxvals(val, dflt, x, NULL);
737 printxval(const struct xlat *x, const unsigned int val, const char *dflt)
739 return printxvals(val, dflt, x, NULL);
743 tprint_iov(struct tcb *tcp, kernel_ulong_t len, kernel_ulong_t addr,
744 enum iov_decode decode_iov)
746 tprint_iov_upto(tcp, len, addr, decode_iov, -1);
754 extern void print_timeval32_t(const timeval32_t *);
755 extern void printrusage32(struct tcb *, kernel_ulong_t);
756 extern const char *sprint_timeval32(struct tcb *tcp, kernel_ulong_t);
757 extern void print_timeval32(struct tcb *tcp, kernel_ulong_t);
758 extern void print_timeval32_utimes(struct tcb *tcp, kernel_ulong_t);
759 extern void print_itimerval32(struct tcb *tcp, kernel_ulong_t);
762 #ifdef HAVE_STRUCT_USER_DESC
763 extern void print_user_desc(struct tcb *, kernel_ulong_t addr);
766 /* Strace log generation machinery.
768 * printing_tcp: tcb which has incomplete line being printed right now.
769 * NULL if last line has been completed ('\n'-terminated).
770 * printleader(tcp) examines it, finishes incomplete line if needed,
771 * the sets it to tcp.
772 * line_ended() clears printing_tcp and resets ->curcol = 0.
773 * tcp->curcol == 0 check is also used to detect completeness
774 * of last line, since in -ff mode just checking printing_tcp for NULL
777 * If you change this code, test log generation in both -f and -ff modes
779 * strace -oLOG -f[f] test/threaded_execve
780 * strace -oLOG -f[f] test/sigkill_rain
781 * strace -oLOG -f[f] -p "`pidof web_browser`"
783 extern struct tcb *printing_tcp;
784 extern void printleader(struct tcb *);
785 extern void line_ended(void);
786 extern void tabto(void);
787 extern void tprintf(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2));
788 extern void tprints(const char *str);
789 extern void tprintf_comment(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2));
790 extern void tprints_comment(const char *str);
792 #if SUPPORTED_PERSONALITIES > 1
793 extern void set_personality(int personality);
794 extern unsigned current_personality;
796 # define set_personality(personality) ((void)0)
797 # define current_personality 0
800 #if SUPPORTED_PERSONALITIES == 1
801 # define current_wordsize PERSONALITY0_WORDSIZE
802 # define current_klongsize PERSONALITY0_KLONGSIZE
804 # if SUPPORTED_PERSONALITIES == 2 && PERSONALITY0_WORDSIZE == PERSONALITY1_WORDSIZE
805 # define current_wordsize PERSONALITY0_WORDSIZE
807 extern unsigned current_wordsize;
809 # if SUPPORTED_PERSONALITIES == 2 && PERSONALITY0_KLONGSIZE == PERSONALITY1_KLONGSIZE
810 # define current_klongsize PERSONALITY0_KLONGSIZE
812 extern unsigned current_klongsize;
816 #define ANY_WORDSIZE_LESS_THAN_KERNEL_LONG \
817 (SIZEOF_KERNEL_LONG_T > 4 \
818 && (SIZEOF_LONG < SIZEOF_KERNEL_LONG_T || !defined(current_wordsize)))
820 #define DECL_PRINTNUM(name) \
822 printnum_ ## name(struct tcb *, kernel_ulong_t addr, const char *fmt) \
823 ATTRIBUTE_FORMAT((printf, 3, 0))
824 DECL_PRINTNUM(short);
826 DECL_PRINTNUM(int64);
829 #define DECL_PRINTNUM_ADDR(name) \
831 printnum_addr_ ## name(struct tcb *, kernel_ulong_t addr)
832 DECL_PRINTNUM_ADDR(int);
833 DECL_PRINTNUM_ADDR(int64);
834 #undef DECL_PRINTNUM_ADDR
836 #ifndef current_wordsize
838 printnum_long_int(struct tcb *, kernel_ulong_t addr,
839 const char *fmt_long, const char *fmt_int)
840 ATTRIBUTE_FORMAT((printf, 3, 0))
841 ATTRIBUTE_FORMAT((printf, 4, 0));
842 extern bool printnum_addr_long_int(struct tcb *, kernel_ulong_t addr);
843 # define printnum_slong(tcp, addr) \
844 printnum_long_int((tcp), (addr), "%" PRId64, "%d")
845 # define printnum_ulong(tcp, addr) \
846 printnum_long_int((tcp), (addr), "%" PRIu64, "%u")
847 # define printnum_ptr(tcp, addr) \
848 printnum_addr_long_int((tcp), (addr))
849 #elif current_wordsize > 4
850 # define printnum_slong(tcp, addr) \
851 printnum_int64((tcp), (addr), "%" PRId64)
852 # define printnum_ulong(tcp, addr) \
853 printnum_int64((tcp), (addr), "%" PRIu64)
854 # define printnum_ptr(tcp, addr) \
855 printnum_addr_int64((tcp), (addr))
856 #else /* current_wordsize == 4 */
857 # define printnum_slong(tcp, addr) \
858 printnum_int((tcp), (addr), "%d")
859 # define printnum_ulong(tcp, addr) \
860 printnum_int((tcp), (addr), "%u")
861 # define printnum_ptr(tcp, addr) \
862 printnum_addr_int((tcp), (addr))
865 #ifndef current_klongsize
866 extern bool printnum_addr_klong_int(struct tcb *, kernel_ulong_t addr);
867 # define printnum_kptr(tcp, addr) \
868 printnum_addr_klong_int((tcp), (addr))
869 #elif current_klongsize > 4
870 # define printnum_kptr(tcp, addr) \
871 printnum_addr_int64((tcp), (addr))
872 #else /* current_klongsize == 4 */
873 # define printnum_kptr(tcp, addr) \
874 printnum_addr_int((tcp), (addr))
877 #define DECL_PRINTPAIR(name) \
879 printpair_ ## name(struct tcb *, kernel_ulong_t addr, const char *fmt) \
880 ATTRIBUTE_FORMAT((printf, 3, 0))
882 DECL_PRINTPAIR(int64);
883 #undef DECL_PRINTPAIR
885 static inline kernel_long_t
886 truncate_klong_to_current_wordsize(const kernel_long_t v)
888 #if ANY_WORDSIZE_LESS_THAN_KERNEL_LONG
889 if (current_wordsize < sizeof(v)) {
898 static inline kernel_ulong_t
899 truncate_kulong_to_current_wordsize(const kernel_ulong_t v)
901 #if ANY_WORDSIZE_LESS_THAN_KERNEL_LONG
902 if (current_wordsize < sizeof(v)) {
903 return (unsigned int) v;
912 * Cast a pointer or a pointer-sized integer to kernel_ulong_t.
914 #define ptr_to_kulong(v) ((kernel_ulong_t) (unsigned long) (v))
917 * Zero-extend a signed integer type to unsigned long long.
919 #define zero_extend_signed_to_ull(v) \
920 (sizeof(v) == sizeof(char) ? (unsigned long long) (unsigned char) (v) : \
921 sizeof(v) == sizeof(short) ? (unsigned long long) (unsigned short) (v) : \
922 sizeof(v) == sizeof(int) ? (unsigned long long) (unsigned int) (v) : \
923 sizeof(v) == sizeof(long) ? (unsigned long long) (unsigned long) (v) : \
924 (unsigned long long) (v))
927 * Sign-extend an unsigned integer type to long long.
929 #define sign_extend_unsigned_to_ll(v) \
930 (sizeof(v) == sizeof(char) ? (long long) (char) (v) : \
931 sizeof(v) == sizeof(short) ? (long long) (short) (v) : \
932 sizeof(v) == sizeof(int) ? (long long) (int) (v) : \
933 sizeof(v) == sizeof(long) ? (long long) (long) (v) : \
936 extern const struct_sysent sysent0[];
937 extern const char *const errnoent0[];
938 extern const char *const signalent0[];
939 extern const struct_ioctlent ioctlent0[];
941 #if SUPPORTED_PERSONALITIES > 1
942 extern const struct_sysent *sysent;
943 extern const char *const *errnoent;
944 extern const char *const *signalent;
945 extern const struct_ioctlent *ioctlent;
947 # define sysent sysent0
948 # define errnoent errnoent0
949 # define signalent signalent0
950 # define ioctlent ioctlent0
953 extern unsigned nsyscalls;
954 extern unsigned nerrnos;
955 extern unsigned nsignals;
956 extern unsigned nioctlents;
958 extern const unsigned int nsyscall_vec[SUPPORTED_PERSONALITIES];
959 extern const struct_sysent *const sysent_vec[SUPPORTED_PERSONALITIES];
960 extern struct inject_opts *inject_vec[SUPPORTED_PERSONALITIES];
962 #ifdef IN_MPERS_BOOTSTRAP
963 /* Transform multi-line MPERS_PRINTER_DECL statements to one-liners. */
964 # define MPERS_PRINTER_DECL(type, name, ...) MPERS_PRINTER_DECL(type, name, __VA_ARGS__)
965 #else /* !IN_MPERS_BOOTSTRAP */
966 # if SUPPORTED_PERSONALITIES > 1
967 # include "printers.h"
969 # include "native_printer_decls.h"
971 # define MPERS_PRINTER_DECL(type, name, ...) type MPERS_FUNC_NAME(name)(__VA_ARGS__)
972 #endif /* !IN_MPERS_BOOTSTRAP */
974 /* Checks that sysent[scno] is not out of range. */
976 scno_in_range(kernel_ulong_t scno)
978 return scno < nsyscalls;
982 * Checks whether scno is not out of range,
983 * its corresponding sysent[scno].sys_func is non-NULL,
984 * and its sysent[scno].sys_flags has no TRACE_INDIRECT_SUBCALL flag set.
987 scno_is_valid(kernel_ulong_t scno)
989 return scno_in_range(scno)
990 && sysent[scno].sys_func
991 && !(sysent[scno].sys_flags & TRACE_INDIRECT_SUBCALL);
994 #define MPERS_FUNC_NAME__(prefix, name) prefix ## name
995 #define MPERS_FUNC_NAME_(prefix, name) MPERS_FUNC_NAME__(prefix, name)
996 #define MPERS_FUNC_NAME(name) MPERS_FUNC_NAME_(MPERS_PREFIX, name)
998 #define SYS_FUNC_NAME(syscall_name) MPERS_FUNC_NAME(syscall_name)
1000 #define SYS_FUNC(syscall_name) int SYS_FUNC_NAME(sys_ ## syscall_name)(struct tcb *tcp)
1002 #if SIZEOF_KERNEL_LONG_T > SIZEOF_LONG
1003 # define PRI_kl "ll"
1008 #define PRI_kld PRI_kl"d"
1009 #define PRI_klu PRI_kl"u"
1010 #define PRI_klx PRI_kl"x"
1013 * The kernel used to define 64-bit types on 64-bit systems on a per-arch
1014 * basis. Some architectures would use unsigned long and others would use
1015 * unsigned long long. These types were exported as part of the
1016 * kernel-userspace ABI and now must be maintained forever. This matches
1017 * what the kernel exports for each architecture so we don't need to cast
1018 * every printing of __u64 or __s64 to stdint types.
1020 #if SIZEOF_LONG == 4
1021 # define PRI__64 "ll"
1022 #elif defined ALPHA || defined IA64 || defined MIPS || defined POWERPC
1023 # define PRI__64 "l"
1025 # define PRI__64 "ll"
1028 #define PRI__d64 PRI__64"d"
1029 #define PRI__u64 PRI__64"u"
1030 #define PRI__x64 PRI__64"x"
1032 #endif /* !STRACE_DEFS_H */