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 "gcc_compat.h"
59 #include "mpers_type.h"
63 const char *strerror(int);
66 /* Some libc have stpcpy, some don't. Sigh...
67 * Roll our private implementation...
70 #define stpcpy strace_stpcpy
71 extern char *stpcpy(char *dst, const char *src);
75 # define offsetofend(type, member) \
76 (offsetof(type, member) + sizeof(((type *)NULL)->member))
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
130 # define ERESTARTSYS 512
132 #ifndef ERESTARTNOINTR
133 # define ERESTARTNOINTR 513
135 #ifndef ERESTARTNOHAND
136 # define ERESTARTNOHAND 514
138 #ifndef ERESTART_RESTARTBLOCK
139 # define ERESTART_RESTARTBLOCK 516
143 # define SUPPORTED_PERSONALITIES 3
144 # define PERSONALITY2_WORDSIZE 4
145 # define PERSONALITY2_KLONGSIZE PERSONALITY0_KLONGSIZE
146 #elif defined AARCH64 \
147 || defined POWERPC64 \
152 # define SUPPORTED_PERSONALITIES 2
154 # define SUPPORTED_PERSONALITIES 1
157 #if defined TILE && defined __tilepro__
158 # define DEFAULT_PERSONALITY 1
160 # define DEFAULT_PERSONALITY 0
163 #define PERSONALITY0_WORDSIZE SIZEOF_LONG
164 #define PERSONALITY0_KLONGSIZE SIZEOF_KERNEL_LONG_T
165 #define PERSONALITY0_INCLUDE_PRINTERS_DECLS "native_printer_decls.h"
166 #define PERSONALITY0_INCLUDE_PRINTERS_DEFS "native_printer_defs.h"
168 #if SUPPORTED_PERSONALITIES > 1
169 # define PERSONALITY1_WORDSIZE 4
170 # define PERSONALITY1_KLONGSIZE PERSONALITY1_WORDSIZE
173 #if SUPPORTED_PERSONALITIES > 1 && defined HAVE_M32_MPERS
174 # define PERSONALITY1_INCLUDE_PRINTERS_DECLS "m32_printer_decls.h"
175 # define PERSONALITY1_INCLUDE_PRINTERS_DEFS "m32_printer_defs.h"
176 # define PERSONALITY1_INCLUDE_FUNCS "m32_funcs.h"
177 # define MPERS_m32_IOCTL_MACROS "ioctl_redefs1.h"
179 # define PERSONALITY1_INCLUDE_PRINTERS_DECLS "native_printer_decls.h"
180 # define PERSONALITY1_INCLUDE_PRINTERS_DEFS "native_printer_defs.h"
181 # define PERSONALITY1_INCLUDE_FUNCS "empty.h"
184 #if SUPPORTED_PERSONALITIES > 2 && defined HAVE_MX32_MPERS
185 # define PERSONALITY2_INCLUDE_FUNCS "mx32_funcs.h"
186 # define PERSONALITY2_INCLUDE_PRINTERS_DECLS "mx32_printer_decls.h"
187 # define PERSONALITY2_INCLUDE_PRINTERS_DEFS "mx32_printer_defs.h"
188 # define MPERS_mx32_IOCTL_MACROS "ioctl_redefs2.h"
190 # define PERSONALITY2_INCLUDE_PRINTERS_DECLS "native_printer_decls.h"
191 # define PERSONALITY2_INCLUDE_PRINTERS_DEFS "native_printer_defs.h"
192 # define PERSONALITY2_INCLUDE_FUNCS "empty.h"
195 typedef struct ioctlent {
207 #define MAX_ERRNO_VALUE 4095
208 #define INJECT_OPTS_RVAL_DEFAULT (-(MAX_ERRNO_VALUE + 1))
210 /* Trace Control Block */
212 int flags; /* See below for TCB_ values */
213 int pid; /* If 0, this tcb is free */
214 int qual_flg; /* qual_flags[scno] or DEFAULT_QUAL_FLAGS + RAW */
215 unsigned long u_error; /* Error code */
216 kernel_ulong_t scno; /* System call number */
217 kernel_ulong_t u_arg[MAX_ARGS]; /* System call arguments */
218 kernel_long_t u_rval; /* Return value */
219 #if SUPPORTED_PERSONALITIES > 1
220 unsigned int currpers; /* Personality at the time of scno update */
222 int sys_func_rval; /* Syscall entry parser's return value */
223 int curcol; /* Output column for this process */
224 FILE *outf; /* Output file for this process */
225 const char *auxstr; /* Auxiliary info from syscall (see RVAL_STR) */
226 void *_priv_data; /* Private data for syscall decoding functions */
227 void (*_free_priv_data)(void *); /* Callback for freeing priv_data */
228 const struct_sysent *s_ent; /* sysent[scno] or dummy struct for bad scno */
229 const struct_sysent *s_prev_ent; /* for "resuming interrupted SYSCALL" msg */
230 struct inject_opts *inject_vec[SUPPORTED_PERSONALITIES];
231 struct timeval stime; /* System time usage as of last process wait */
232 struct timeval dtime; /* Delta for system time usage */
233 struct timeval etime; /* Syscall entry time */
236 struct UPT_info *libunwind_ui;
237 struct mmap_cache_t *mmap_cache;
238 unsigned int mmap_cache_size;
239 unsigned int mmap_cache_generation;
240 struct queue_t *queue;
245 /* We have attached to this process, but did not see it stopping yet */
246 #define TCB_STARTUP 0x01
247 #define TCB_IGNORE_ONE_SIGSTOP 0x02 /* Next SIGSTOP is to be ignored */
249 * Are we in system call entry or in syscall exit?
251 * This bit is set in syscall_entering_finish() and cleared in
252 * syscall_exiting_finish().
253 * Other stops which are possible directly after syscall entry (death, ptrace
254 * event stop) are handled without calling syscall_{entering,exiting}_*().
256 * Use entering(tcp) / exiting(tcp) to check this bit to make code more
259 #define TCB_INSYSCALL 0x04
260 #define TCB_ATTACHED 0x08 /* We attached to it already */
261 #define TCB_REPRINT 0x10 /* We should reprint this syscall on exit */
262 #define TCB_FILTERED 0x20 /* This system call has been filtered out */
263 #define TCB_TAMPERED 0x40 /* A syscall has been tampered with */
264 #define TCB_HIDE_LOG 0x80 /* We should hide everything (until execve) */
265 #define TCB_SKIP_DETACH_ON_FIRST_EXEC 0x100 /* -b execve should skip detach on first execve */
267 /* qualifier flags */
268 #define QUAL_TRACE 0x001 /* this system call should be traced */
269 #define QUAL_ABBREV 0x002 /* abbreviate the structures of this syscall */
270 #define QUAL_VERBOSE 0x004 /* decode the structures of this syscall */
271 #define QUAL_RAW 0x008 /* print all args in hex for this syscall */
272 #define QUAL_INJECT 0x010 /* tamper with this system call on purpose */
273 #define QUAL_SIGNAL 0x100 /* report events with this signal */
274 #define QUAL_READ 0x200 /* dump data read from this file descriptor */
275 #define QUAL_WRITE 0x400 /* dump data written to this file descriptor */
277 #define DEFAULT_QUAL_FLAGS (QUAL_TRACE | QUAL_ABBREV | QUAL_VERBOSE)
279 #define entering(tcp) (!((tcp)->flags & TCB_INSYSCALL))
280 #define exiting(tcp) ((tcp)->flags & TCB_INSYSCALL)
281 #define syserror(tcp) ((tcp)->u_error != 0)
282 #define verbose(tcp) ((tcp)->qual_flg & QUAL_VERBOSE)
283 #define abbrev(tcp) ((tcp)->qual_flg & QUAL_ABBREV)
284 #define filtered(tcp) ((tcp)->flags & TCB_FILTERED)
285 #define hide_log(tcp) ((tcp)->flags & TCB_HIDE_LOG)
289 extern const struct xlat addrfams[];
290 extern const struct xlat at_flags[];
291 extern const struct xlat clocknames[];
292 extern const struct xlat dirent_types[];
293 extern const struct xlat ethernet_protocols[];
294 extern const struct xlat evdev_abs[];
295 extern const struct xlat inet_protocols[];
296 extern const struct xlat msg_flags[];
297 extern const struct xlat netlink_protocols[];
298 extern const struct xlat open_access_modes[];
299 extern const struct xlat open_mode_flags[];
300 extern const struct xlat resource_flags[];
301 extern const struct xlat setns_types[];
302 extern const struct xlat sg_io_info[];
303 extern const struct xlat socketlayers[];
304 extern const struct xlat socktypes[];
305 extern const struct xlat whence_codes[];
307 /* Format of syscall return values */
308 #define RVAL_DECIMAL 000 /* decimal format */
309 #define RVAL_HEX 001 /* hex format */
310 #define RVAL_OCTAL 002 /* octal format */
311 #define RVAL_UDECIMAL 003 /* unsigned decimal format */
312 #define RVAL_FD 010 /* file descriptor */
313 #define RVAL_MASK 013 /* mask for these values */
315 #define RVAL_STR 020 /* Print `auxstr' field after return val */
316 #define RVAL_NONE 040 /* Print nothing */
318 #define RVAL_DECODED 0100 /* syscall decoding finished */
320 #define IOCTL_NUMBER_UNKNOWN 0
321 #define IOCTL_NUMBER_HANDLED 1
322 #define IOCTL_NUMBER_STOP_LOOKUP 010
324 #define indirect_ipccall(tcp) (tcp->s_ent->sys_flags & TRACE_INDIRECT_SUBCALL)
326 #if defined(ARM) || defined(AARCH64) \
327 || defined(I386) || defined(X32) || defined(X86_64) \
331 || defined(MICROBLAZE) \
334 || defined(SH) || defined(SH64) \
335 || defined(SPARC) || defined(SPARC64) \
337 # define NEED_UID16_PARSERS 1
339 # define NEED_UID16_PARSERS 0
351 extern enum sock_proto get_proto_by_name(const char *);
364 extern cflag_t cflag;
365 extern bool debug_flag;
368 extern bool count_wallclock;
369 extern unsigned int qflag;
370 extern bool not_failing_only;
371 extern unsigned int show_fd_path;
372 /* are we filtering traces based on paths? */
373 extern struct path_set {
374 const char **paths_selected;
375 unsigned int num_selected;
377 #define tracing_paths (global_path_set.num_selected != 0)
378 extern unsigned xflag;
379 extern unsigned followfork;
381 /* if this is true do the stack trace for every system call */
382 extern bool stack_trace_enabled;
384 extern unsigned ptrace_setoptions;
385 extern unsigned max_strlen;
386 extern unsigned os_release;
387 #undef KERNEL_VERSION
388 #define KERNEL_VERSION(a, b, c) (((a) << 16) + ((b) << 8) + (c))
390 void error_msg(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2));
391 void perror_msg(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2));
392 void error_msg_and_die(const char *fmt, ...)
393 ATTRIBUTE_FORMAT((printf, 1, 2)) ATTRIBUTE_NORETURN;
394 void error_msg_and_help(const char *fmt, ...)
395 ATTRIBUTE_FORMAT((printf, 1, 2)) ATTRIBUTE_NORETURN;
396 void perror_msg_and_die(const char *fmt, ...)
397 ATTRIBUTE_FORMAT((printf, 1, 2)) ATTRIBUTE_NORETURN;
399 void *xmalloc(size_t size) ATTRIBUTE_MALLOC ATTRIBUTE_ALLOC_SIZE((1));
400 void *xcalloc(size_t nmemb, size_t size)
401 ATTRIBUTE_MALLOC ATTRIBUTE_ALLOC_SIZE((1, 2));
402 void *xreallocarray(void *ptr, size_t nmemb, size_t size)
403 ATTRIBUTE_ALLOC_SIZE((2, 3));
404 char *xstrdup(const char *str) ATTRIBUTE_MALLOC;
405 char *xstrndup(const char *str, size_t n) ATTRIBUTE_MALLOC;
407 extern int read_int_from_file(const char *, int *);
409 extern void set_sortby(const char *);
410 extern void set_overhead(int);
411 extern void print_pc(struct tcb *);
413 extern int syscall_entering_decode(struct tcb *);
414 extern int syscall_entering_trace(struct tcb *, unsigned int *);
415 extern void syscall_entering_finish(struct tcb *, int);
417 extern int syscall_exiting_decode(struct tcb *, struct timeval *);
418 extern int syscall_exiting_trace(struct tcb *, struct timeval, int);
419 extern void syscall_exiting_finish(struct tcb *);
421 extern void count_syscall(struct tcb *, const struct timeval *);
422 extern void call_summary(FILE *);
424 extern void clear_regs(void);
425 extern int get_scno(struct tcb *);
426 extern kernel_ulong_t get_rt_sigframe_addr(struct tcb *);
429 * Convert syscall number to syscall name.
431 * @param scno Syscall number.
432 * @return String literal corresponding to the syscall number in case latter
433 * is valid; NULL otherwise.
435 extern const char *syscall_name(kernel_ulong_t scno);
436 extern const char *err_name(unsigned long err);
438 extern bool is_erestart(struct tcb *);
439 extern void temporarily_clear_syserror(struct tcb *);
440 extern void restore_cleared_syserror(struct tcb *);
442 extern void *get_tcb_priv_data(const struct tcb *);
443 extern int set_tcb_priv_data(struct tcb *, void *priv_data,
444 void (*free_priv_data)(void *));
445 extern void free_tcb_priv_data(struct tcb *);
447 static inline unsigned long get_tcb_priv_ulong(const struct tcb *tcp)
449 return (unsigned long) get_tcb_priv_data(tcp);
452 static inline int set_tcb_priv_ulong(struct tcb *tcp, unsigned long val)
454 return set_tcb_priv_data(tcp, (void *) val, 0);
458 umoven(struct tcb *, kernel_ulong_t addr, unsigned int len, void *laddr);
459 #define umove(pid, addr, objp) \
460 umoven((pid), (addr), sizeof(*(objp)), (void *) (objp))
463 umoven_or_printaddr(struct tcb *, kernel_ulong_t addr,
464 unsigned int len, void *laddr);
465 #define umove_or_printaddr(pid, addr, objp) \
466 umoven_or_printaddr((pid), (addr), sizeof(*(objp)), (void *) (objp))
469 umoven_or_printaddr_ignore_syserror(struct tcb *, kernel_ulong_t addr,
470 unsigned int len, void *laddr);
473 umovestr(struct tcb *, kernel_ulong_t addr, unsigned int len, char *laddr);
475 extern int upeek(int pid, unsigned long, kernel_ulong_t *);
476 extern int upoke(int pid, unsigned long, kernel_ulong_t);
479 print_array(struct tcb *,
480 kernel_ulong_t start_addr,
484 int (*umoven_func)(struct tcb *,
488 bool (*print_func)(struct tcb *,
494 #if defined ALPHA || defined IA64 || defined MIPS \
495 || defined SH || defined SPARC || defined SPARC64
496 # define HAVE_GETRVAL2
497 extern long getrval2(struct tcb *);
499 # undef HAVE_GETRVAL2
502 extern const char *signame(const int);
503 extern void pathtrace_select_set(const char *, struct path_set *);
504 extern bool pathtrace_match_set(struct tcb *, struct path_set *);
505 #define pathtrace_select(tcp) \
506 pathtrace_select_set(tcp, &global_path_set)
507 #define pathtrace_match(tcp) \
508 pathtrace_match_set(tcp, &global_path_set)
509 extern int getfdpath(struct tcb *, int, char *, unsigned);
510 extern unsigned long getfdinode(struct tcb *, int);
511 extern enum sock_proto getfdproto(struct tcb *, int);
513 extern const char *xlookup(const struct xlat *, const uint64_t);
514 extern const char *xlat_search(const struct xlat *, const size_t, const uint64_t);
517 struct dyxlat *dyxlat_alloc(size_t nmemb);
518 void dyxlat_free(struct dyxlat *);
519 const struct xlat *dyxlat_get(const struct dyxlat *);
520 void dyxlat_add_pair(struct dyxlat *, uint64_t val, const char *str, size_t len);
522 const struct xlat *genl_families_xlat(void);
524 extern unsigned long get_pagesize(void);
526 string_to_uint_ex(const char *str, char **endptr,
527 unsigned int max_val, const char *accepted_ending);
528 extern int string_to_uint(const char *str);
530 string_to_uint_upto(const char *const str, unsigned int max_val)
532 return string_to_uint_ex(str, NULL, max_val, NULL);
534 extern int next_set_bit(const void *bit_array, unsigned cur_bit, unsigned size_bits);
537 * Returns STR if it does not start with PREFIX,
538 * or a pointer to the first char in STR after PREFIX.
539 * The length of PREFIX is specified by PREFIX_LEN.
541 static inline const char *
542 str_strip_prefix_len(const char *str, const char *prefix, size_t prefix_len)
544 return strncmp(str, prefix, prefix_len) ? str : str + prefix_len;
547 #define STR_STRIP_PREFIX(str, prefix) \
548 str_strip_prefix_len((str), (prefix), sizeof(prefix) - 1)
550 #define QUOTE_0_TERMINATED 0x01
551 #define QUOTE_OMIT_LEADING_TRAILING_QUOTES 0x02
552 #define QUOTE_OMIT_TRAILING_0 0x08
553 #define QUOTE_FORCE_HEX 0x10
555 extern int string_quote(const char *, char *, unsigned int, unsigned int);
556 extern int print_quoted_string(const char *, unsigned int, unsigned int);
558 /* a refers to the lower numbered u_arg,
559 * b refers to the higher numbered u_arg
561 #ifdef WORDS_BIGENDIAN
562 # define ULONG_LONG(a, b) \
563 ((unsigned long long)(unsigned)(b) | ((unsigned long long)(a)<<32))
565 # define ULONG_LONG(a, b) \
566 ((unsigned long long)(unsigned)(a) | ((unsigned long long)(b)<<32))
568 extern int getllval(struct tcb *, unsigned long long *, int);
569 extern int printllval(struct tcb *, const char *, int)
570 ATTRIBUTE_FORMAT((printf, 2, 0));
572 extern void printaddr(kernel_ulong_t addr);
573 extern int printxvals(const uint64_t, const char *, const struct xlat *, ...)
575 extern int printxval_searchn(const struct xlat *xlat, size_t xlat_size,
576 uint64_t val, const char *dflt);
577 #define printxval_search(xlat__, val__, dflt__) \
578 printxval_searchn(xlat__, ARRAY_SIZE(xlat__), val__, dflt__)
579 extern int printargs(struct tcb *);
580 extern int printargs_u(struct tcb *);
581 extern int printargs_d(struct tcb *);
583 extern void addflags(const struct xlat *, uint64_t);
584 extern int printflags_ex(uint64_t, const char *, const struct xlat *, ...)
586 extern const char *sprintflags(const char *, const struct xlat *, uint64_t);
587 extern const char *sprinttime(long long sec);
588 extern const char *sprinttime_nsec(long long sec, unsigned long long nsec);
589 extern const char *sprinttime_usec(long long sec, unsigned long long usec);
590 extern void print_symbolic_mode_t(unsigned int);
591 extern void print_numeric_umode_t(unsigned short);
592 extern void print_numeric_long_umask(unsigned long);
593 extern void print_dev_t(unsigned long long dev);
594 extern void print_abnormal_hi(kernel_ulong_t);
597 dumpiov_in_msghdr(struct tcb *, kernel_ulong_t addr, kernel_ulong_t data_size);
600 dumpiov_in_mmsghdr(struct tcb *, kernel_ulong_t addr);
603 dumpiov_upto(struct tcb *, int len, kernel_ulong_t addr, kernel_ulong_t data_size);
606 dumpstr(struct tcb *, kernel_ulong_t addr, int len);
609 printstr_ex(struct tcb *, kernel_ulong_t addr, kernel_ulong_t len,
610 unsigned int user_style);
613 printpathn(struct tcb *, kernel_ulong_t addr, unsigned int n);
616 printpath(struct tcb *, kernel_ulong_t addr);
618 #define TIMESPEC_TEXT_BUFSIZE \
619 (sizeof(long long) * 3 * 2 + sizeof("{tv_sec=-, tv_nsec=}"))
620 extern void printfd(struct tcb *, int);
621 extern void print_sockaddr(const void *sa, int len);
623 print_inet_addr(int af, const void *addr, unsigned int len, const char *var_name);
624 extern const char *get_sockaddr_by_inode(struct tcb *, int fd, unsigned long inode);
625 extern bool print_sockaddr_by_inode(struct tcb *, int fd, unsigned long inode);
626 extern void print_dirfd(struct tcb *, int);
629 decode_sockaddr(struct tcb *, kernel_ulong_t addr, int addrlen);
631 extern void printuid(const char *, const unsigned int);
634 print_sigset_addr_len(struct tcb *, kernel_ulong_t addr, kernel_ulong_t len);
636 print_sigset_addr(struct tcb *, kernel_ulong_t addr);
638 extern const char *sprintsigmask_n(const char *, const void *, unsigned int);
639 #define tprintsigmask_addr(prefix, mask) \
640 tprints(sprintsigmask_n((prefix), (mask), sizeof(mask)))
641 extern void printsignal(int);
644 tprint_iov_upto(struct tcb *, kernel_ulong_t len, kernel_ulong_t addr,
645 enum iov_decode, kernel_ulong_t data_size);
648 decode_netlink(struct tcb *, int fd, kernel_ulong_t addr, kernel_ulong_t len);
650 extern void tprint_open_modes(unsigned int);
651 extern const char *sprint_open_modes(unsigned int);
654 decode_seccomp_fprog(struct tcb *, kernel_ulong_t addr);
657 print_seccomp_fprog(struct tcb *, kernel_ulong_t addr, unsigned short len);
660 decode_sock_fprog(struct tcb *, kernel_ulong_t addr);
663 print_sock_fprog(struct tcb *, kernel_ulong_t addr, unsigned short len);
666 extern void print_struct_stat(struct tcb *, const struct strace_stat *const st);
668 struct strace_statfs;
671 print_struct_statfs(struct tcb *, kernel_ulong_t addr);
674 print_struct_statfs64(struct tcb *, kernel_ulong_t addr, kernel_ulong_t size);
676 extern void print_ifindex(unsigned int);
679 extern struct number_set read_set;
680 extern struct number_set write_set;
681 extern struct number_set signal_set;
683 extern bool is_number_in_set(unsigned int number, const struct number_set *);
684 extern void qualify(const char *);
685 extern unsigned int qual_flags(const unsigned int);
687 #define DECL_IOCTL(name) \
689 name ## _ioctl(struct tcb *, unsigned int request, kernel_ulong_t arg)
701 extern int decode_sg_io_v4(struct tcb *, const kernel_ulong_t arg);
705 typedef bool (*netlink_decoder_t)(struct tcb *, const struct nlmsghdr *,
706 kernel_ulong_t addr, kernel_ulong_t len);
708 #define DECL_NETLINK(name) \
710 decode_netlink_ ## name(struct tcb *, const struct nlmsghdr *, \
711 kernel_ulong_t addr, kernel_ulong_t len)
712 DECL_NETLINK(sock_diag);
714 extern int tv_nz(const struct timeval *);
715 extern int tv_cmp(const struct timeval *, const struct timeval *);
716 extern double tv_float(const struct timeval *);
717 extern void tv_add(struct timeval *, const struct timeval *, const struct timeval *);
718 extern void tv_sub(struct timeval *, const struct timeval *, const struct timeval *);
719 extern void tv_mul(struct timeval *, const struct timeval *, int);
720 extern void tv_div(struct timeval *, const struct timeval *, int);
723 extern void unwind_init(void);
724 extern void unwind_tcb_init(struct tcb *);
725 extern void unwind_tcb_fin(struct tcb *);
726 extern void unwind_cache_invalidate(struct tcb *);
727 extern void unwind_print_stacktrace(struct tcb *);
728 extern void unwind_capture_stacktrace(struct tcb *);
732 printstrn(struct tcb *tcp, kernel_ulong_t addr, kernel_ulong_t len)
734 printstr_ex(tcp, addr, len, 0);
738 printstr(struct tcb *tcp, kernel_ulong_t addr)
740 printstr_ex(tcp, addr, -1, QUOTE_0_TERMINATED);
744 printflags64(const struct xlat *x, uint64_t flags, const char *dflt)
746 return printflags_ex(flags, dflt, x, NULL);
750 printflags(const struct xlat *x, unsigned int flags, const char *dflt)
752 return printflags64(x, flags, dflt);
756 printxval64(const struct xlat *x, const uint64_t val, const char *dflt)
758 return printxvals(val, dflt, x, NULL);
762 printxval(const struct xlat *x, const unsigned int val, const char *dflt)
764 return printxvals(val, dflt, x, NULL);
768 tprint_iov(struct tcb *tcp, kernel_ulong_t len, kernel_ulong_t addr,
769 enum iov_decode decode_iov)
771 tprint_iov_upto(tcp, len, addr, decode_iov, -1);
779 extern void print_timeval32_t(const timeval32_t *);
780 extern void printrusage32(struct tcb *, kernel_ulong_t);
781 extern const char *sprint_timeval32(struct tcb *, kernel_ulong_t addr);
782 extern void print_timeval32(struct tcb *, kernel_ulong_t addr);
783 extern void print_timeval32_utimes(struct tcb *, kernel_ulong_t addr);
784 extern void print_itimerval32(struct tcb *, kernel_ulong_t addr);
787 #ifdef HAVE_STRUCT_USER_DESC
788 extern void print_user_desc(struct tcb *, kernel_ulong_t addr);
791 /* Strace log generation machinery.
793 * printing_tcp: tcb which has incomplete line being printed right now.
794 * NULL if last line has been completed ('\n'-terminated).
795 * printleader(tcp) examines it, finishes incomplete line if needed,
796 * the sets it to tcp.
797 * line_ended() clears printing_tcp and resets ->curcol = 0.
798 * tcp->curcol == 0 check is also used to detect completeness
799 * of last line, since in -ff mode just checking printing_tcp for NULL
802 * If you change this code, test log generation in both -f and -ff modes
804 * strace -oLOG -f[f] test/threaded_execve
805 * strace -oLOG -f[f] test/sigkill_rain
806 * strace -oLOG -f[f] -p "`pidof web_browser`"
808 extern struct tcb *printing_tcp;
809 extern void printleader(struct tcb *);
810 extern void line_ended(void);
811 extern void tabto(void);
812 extern void tprintf(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2));
813 extern void tprints(const char *str);
814 extern void tprintf_comment(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2));
815 extern void tprints_comment(const char *str);
817 #if SUPPORTED_PERSONALITIES > 1
818 extern void set_personality(int personality);
819 extern unsigned current_personality;
821 # define set_personality(personality) ((void)0)
822 # define current_personality 0
825 #if SUPPORTED_PERSONALITIES == 1
826 # define current_wordsize PERSONALITY0_WORDSIZE
827 # define current_klongsize PERSONALITY0_KLONGSIZE
829 # if SUPPORTED_PERSONALITIES == 2 && PERSONALITY0_WORDSIZE == PERSONALITY1_WORDSIZE
830 # define current_wordsize PERSONALITY0_WORDSIZE
832 extern unsigned current_wordsize;
834 # if SUPPORTED_PERSONALITIES == 2 && PERSONALITY0_KLONGSIZE == PERSONALITY1_KLONGSIZE
835 # define current_klongsize PERSONALITY0_KLONGSIZE
837 extern unsigned current_klongsize;
841 #define ANY_WORDSIZE_LESS_THAN_KERNEL_LONG \
842 (SIZEOF_KERNEL_LONG_T > 4 \
843 && (SIZEOF_LONG < SIZEOF_KERNEL_LONG_T || !defined(current_wordsize)))
845 #define DECL_PRINTNUM(name) \
847 printnum_ ## name(struct tcb *, kernel_ulong_t addr, const char *fmt) \
848 ATTRIBUTE_FORMAT((printf, 3, 0))
849 DECL_PRINTNUM(short);
851 DECL_PRINTNUM(int64);
854 #define DECL_PRINTNUM_ADDR(name) \
856 printnum_addr_ ## name(struct tcb *, kernel_ulong_t addr)
857 DECL_PRINTNUM_ADDR(int);
858 DECL_PRINTNUM_ADDR(int64);
859 #undef DECL_PRINTNUM_ADDR
861 #ifndef current_wordsize
863 printnum_long_int(struct tcb *, kernel_ulong_t addr,
864 const char *fmt_long, const char *fmt_int)
865 ATTRIBUTE_FORMAT((printf, 3, 0))
866 ATTRIBUTE_FORMAT((printf, 4, 0));
867 extern bool printnum_addr_long_int(struct tcb *, kernel_ulong_t addr);
868 # define printnum_slong(tcp, addr) \
869 printnum_long_int((tcp), (addr), "%" PRId64, "%d")
870 # define printnum_ulong(tcp, addr) \
871 printnum_long_int((tcp), (addr), "%" PRIu64, "%u")
872 # define printnum_ptr(tcp, addr) \
873 printnum_addr_long_int((tcp), (addr))
874 #elif current_wordsize > 4
875 # define printnum_slong(tcp, addr) \
876 printnum_int64((tcp), (addr), "%" PRId64)
877 # define printnum_ulong(tcp, addr) \
878 printnum_int64((tcp), (addr), "%" PRIu64)
879 # define printnum_ptr(tcp, addr) \
880 printnum_addr_int64((tcp), (addr))
881 #else /* current_wordsize == 4 */
882 # define printnum_slong(tcp, addr) \
883 printnum_int((tcp), (addr), "%d")
884 # define printnum_ulong(tcp, addr) \
885 printnum_int((tcp), (addr), "%u")
886 # define printnum_ptr(tcp, addr) \
887 printnum_addr_int((tcp), (addr))
890 #ifndef current_klongsize
891 extern bool printnum_addr_klong_int(struct tcb *, kernel_ulong_t addr);
892 # define printnum_kptr(tcp, addr) \
893 printnum_addr_klong_int((tcp), (addr))
894 #elif current_klongsize > 4
895 # define printnum_kptr(tcp, addr) \
896 printnum_addr_int64((tcp), (addr))
897 #else /* current_klongsize == 4 */
898 # define printnum_kptr(tcp, addr) \
899 printnum_addr_int((tcp), (addr))
902 #define DECL_PRINTPAIR(name) \
904 printpair_ ## name(struct tcb *, kernel_ulong_t addr, const char *fmt) \
905 ATTRIBUTE_FORMAT((printf, 3, 0))
907 DECL_PRINTPAIR(int64);
908 #undef DECL_PRINTPAIR
910 static inline kernel_long_t
911 truncate_klong_to_current_wordsize(const kernel_long_t v)
913 #if ANY_WORDSIZE_LESS_THAN_KERNEL_LONG
914 if (current_wordsize < sizeof(v)) {
923 static inline kernel_ulong_t
924 truncate_kulong_to_current_wordsize(const kernel_ulong_t v)
926 #if ANY_WORDSIZE_LESS_THAN_KERNEL_LONG
927 if (current_wordsize < sizeof(v)) {
928 return (unsigned int) v;
937 * Cast a pointer or a pointer-sized integer to kernel_ulong_t.
939 #define ptr_to_kulong(v) ((kernel_ulong_t) (unsigned long) (v))
942 * Zero-extend a signed integer type to unsigned long long.
944 #define zero_extend_signed_to_ull(v) \
945 (sizeof(v) == sizeof(char) ? (unsigned long long) (unsigned char) (v) : \
946 sizeof(v) == sizeof(short) ? (unsigned long long) (unsigned short) (v) : \
947 sizeof(v) == sizeof(int) ? (unsigned long long) (unsigned int) (v) : \
948 sizeof(v) == sizeof(long) ? (unsigned long long) (unsigned long) (v) : \
949 (unsigned long long) (v))
952 * Sign-extend an unsigned integer type to long long.
954 #define sign_extend_unsigned_to_ll(v) \
955 (sizeof(v) == sizeof(char) ? (long long) (char) (v) : \
956 sizeof(v) == sizeof(short) ? (long long) (short) (v) : \
957 sizeof(v) == sizeof(int) ? (long long) (int) (v) : \
958 sizeof(v) == sizeof(long) ? (long long) (long) (v) : \
961 extern const struct_sysent sysent0[];
962 extern const char *const errnoent0[];
963 extern const char *const signalent0[];
964 extern const struct_ioctlent ioctlent0[];
966 #if SUPPORTED_PERSONALITIES > 1
967 extern const struct_sysent *sysent;
968 extern const char *const *errnoent;
969 extern const char *const *signalent;
970 extern const struct_ioctlent *ioctlent;
972 # define sysent sysent0
973 # define errnoent errnoent0
974 # define signalent signalent0
975 # define ioctlent ioctlent0
978 extern unsigned nsyscalls;
979 extern unsigned nerrnos;
980 extern unsigned nsignals;
981 extern unsigned nioctlents;
983 extern const unsigned int nsyscall_vec[SUPPORTED_PERSONALITIES];
984 extern const struct_sysent *const sysent_vec[SUPPORTED_PERSONALITIES];
985 extern struct inject_opts *inject_vec[SUPPORTED_PERSONALITIES];
987 #ifdef IN_MPERS_BOOTSTRAP
988 /* Transform multi-line MPERS_PRINTER_DECL statements to one-liners. */
989 # define MPERS_PRINTER_DECL(type, name, ...) MPERS_PRINTER_DECL(type, name, __VA_ARGS__)
990 #else /* !IN_MPERS_BOOTSTRAP */
991 # if SUPPORTED_PERSONALITIES > 1
992 # include "printers.h"
994 # include "native_printer_decls.h"
996 # define MPERS_PRINTER_DECL(type, name, ...) type MPERS_FUNC_NAME(name)(__VA_ARGS__)
997 #endif /* !IN_MPERS_BOOTSTRAP */
999 /* Checks that sysent[scno] is not out of range. */
1001 scno_in_range(kernel_ulong_t scno)
1003 return scno < nsyscalls;
1007 * Checks whether scno is not out of range,
1008 * its corresponding sysent[scno].sys_func is non-NULL,
1009 * and its sysent[scno].sys_flags has no TRACE_INDIRECT_SUBCALL flag set.
1012 scno_is_valid(kernel_ulong_t scno)
1014 return scno_in_range(scno)
1015 && sysent[scno].sys_func
1016 && !(sysent[scno].sys_flags & TRACE_INDIRECT_SUBCALL);
1019 #define MPERS_FUNC_NAME__(prefix, name) prefix ## name
1020 #define MPERS_FUNC_NAME_(prefix, name) MPERS_FUNC_NAME__(prefix, name)
1021 #define MPERS_FUNC_NAME(name) MPERS_FUNC_NAME_(MPERS_PREFIX, name)
1023 #define SYS_FUNC_NAME(syscall_name) MPERS_FUNC_NAME(syscall_name)
1025 #define SYS_FUNC(syscall_name) int SYS_FUNC_NAME(sys_ ## syscall_name)(struct tcb *tcp)
1027 #if SIZEOF_KERNEL_LONG_T > SIZEOF_LONG
1028 # define PRI_kl "ll"
1033 #define PRI_kld PRI_kl"d"
1034 #define PRI_klu PRI_kl"u"
1035 #define PRI_klx PRI_kl"x"
1038 * The kernel used to define 64-bit types on 64-bit systems on a per-arch
1039 * basis. Some architectures would use unsigned long and others would use
1040 * unsigned long long. These types were exported as part of the
1041 * kernel-userspace ABI and now must be maintained forever. This matches
1042 * what the kernel exports for each architecture so we don't need to cast
1043 * every printing of __u64 or __s64 to stdint types.
1045 #if SIZEOF_LONG == 4
1046 # define PRI__64 "ll"
1047 #elif defined ALPHA || defined IA64 || defined MIPS || defined POWERPC
1048 # define PRI__64 "l"
1050 # define PRI__64 "ll"
1053 #define PRI__d64 PRI__64"d"
1054 #define PRI__u64 PRI__64"u"
1055 #define PRI__x64 PRI__64"x"
1057 #endif /* !STRACE_DEFS_H */