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 "error_prints.h"
57 #include "gcc_compat.h"
58 #include "kernel_types.h"
60 #include "mpers_type.h"
65 const char *strerror(int);
68 /* Some libc have stpcpy, some don't. Sigh...
69 * Roll our private implementation...
72 #define stpcpy strace_stpcpy
73 extern char *stpcpy(char *dst, const char *src);
78 # define MAX(a, b) (((a) > (b)) ? (a) : (b))
81 # define MIN(a, b) (((a) < (b)) ? (a) : (b))
83 #define CLAMP(val, min, max) MIN(MAX(min, val), max)
85 /* Glibc has an efficient macro for sigemptyset
86 * (it just does one or two assignments of 0 to internal vector of longs).
88 #if defined(__GLIBC__) && defined(__sigemptyset) && !defined(sigemptyset)
89 # define sigemptyset __sigemptyset
92 /* Configuration section */
93 #ifndef DEFAULT_STRLEN
94 /* default maximum # of bytes printed in `printstr', change with -s switch */
95 # define DEFAULT_STRLEN 32
97 #ifndef DEFAULT_ACOLUMN
98 # define DEFAULT_ACOLUMN 40 /* default alignment column for results */
101 * Maximum number of args to a syscall.
103 * Make sure that all entries in all syscallent.h files have nargs <= MAX_ARGS!
104 * linux/<ARCH>/syscallent*.h:
105 * all have nargs <= 6 except mips o32 which has nargs <= 7.
108 # ifdef LINUX_MIPSO32
114 /* default sorting method for call profiling */
115 #ifndef DEFAULT_SORTBY
116 # define DEFAULT_SORTBY "time"
119 * Experimental code using PTRACE_SEIZE can be enabled here.
120 * This needs Linux kernel 3.4.x or later to work.
123 /* To force NOMMU build, set to 1 */
124 #define NOMMU_SYSTEM 0
127 # define ERESTARTSYS 512
129 #ifndef ERESTARTNOINTR
130 # define ERESTARTNOINTR 513
132 #ifndef ERESTARTNOHAND
133 # define ERESTARTNOHAND 514
135 #ifndef ERESTART_RESTARTBLOCK
136 # define ERESTART_RESTARTBLOCK 516
140 # define SUPPORTED_PERSONALITIES 3
141 # define PERSONALITY2_WORDSIZE 4
142 # define PERSONALITY2_KLONGSIZE PERSONALITY0_KLONGSIZE
143 #elif defined AARCH64 \
144 || defined POWERPC64 \
149 # define SUPPORTED_PERSONALITIES 2
151 # define SUPPORTED_PERSONALITIES 1
154 #if defined TILE && defined __tilepro__
155 # define DEFAULT_PERSONALITY 1
157 # define DEFAULT_PERSONALITY 0
160 #define PERSONALITY0_WORDSIZE SIZEOF_LONG
161 #define PERSONALITY0_KLONGSIZE SIZEOF_KERNEL_LONG_T
162 #define PERSONALITY0_INCLUDE_PRINTERS_DECLS "native_printer_decls.h"
163 #define PERSONALITY0_INCLUDE_PRINTERS_DEFS "native_printer_defs.h"
165 #if SUPPORTED_PERSONALITIES > 1
166 # define PERSONALITY1_WORDSIZE 4
167 # define PERSONALITY1_KLONGSIZE PERSONALITY1_WORDSIZE
170 #if SUPPORTED_PERSONALITIES > 1 && defined HAVE_M32_MPERS
171 # define PERSONALITY1_INCLUDE_PRINTERS_DECLS "m32_printer_decls.h"
172 # define PERSONALITY1_INCLUDE_PRINTERS_DEFS "m32_printer_defs.h"
173 # define PERSONALITY1_INCLUDE_FUNCS "m32_funcs.h"
174 # define MPERS_m32_IOCTL_MACROS "ioctl_redefs1.h"
176 # define PERSONALITY1_INCLUDE_PRINTERS_DECLS "native_printer_decls.h"
177 # define PERSONALITY1_INCLUDE_PRINTERS_DEFS "native_printer_defs.h"
178 # define PERSONALITY1_INCLUDE_FUNCS "empty.h"
181 #if SUPPORTED_PERSONALITIES > 2 && defined HAVE_MX32_MPERS
182 # define PERSONALITY2_INCLUDE_FUNCS "mx32_funcs.h"
183 # define PERSONALITY2_INCLUDE_PRINTERS_DECLS "mx32_printer_decls.h"
184 # define PERSONALITY2_INCLUDE_PRINTERS_DEFS "mx32_printer_defs.h"
185 # define MPERS_mx32_IOCTL_MACROS "ioctl_redefs2.h"
187 # define PERSONALITY2_INCLUDE_PRINTERS_DECLS "native_printer_decls.h"
188 # define PERSONALITY2_INCLUDE_PRINTERS_DEFS "native_printer_defs.h"
189 # define PERSONALITY2_INCLUDE_FUNCS "empty.h"
192 typedef struct ioctlent {
204 #define MAX_ERRNO_VALUE 4095
205 #define INJECT_OPTS_RVAL_DEFAULT (-(MAX_ERRNO_VALUE + 1))
207 /* Trace Control Block */
209 int flags; /* See below for TCB_ values */
210 int pid; /* If 0, this tcb is free */
211 int qual_flg; /* qual_flags[scno] or DEFAULT_QUAL_FLAGS + RAW */
212 unsigned long u_error; /* Error code */
213 kernel_ulong_t scno; /* System call number */
214 kernel_ulong_t u_arg[MAX_ARGS]; /* System call arguments */
215 kernel_long_t u_rval; /* Return value */
216 #if SUPPORTED_PERSONALITIES > 1
217 unsigned int currpers; /* Personality at the time of scno update */
219 int sys_func_rval; /* Syscall entry parser's return value */
220 int curcol; /* Output column for this process */
221 FILE *outf; /* Output file for this process */
222 const char *auxstr; /* Auxiliary info from syscall (see RVAL_STR) */
223 void *_priv_data; /* Private data for syscall decoding functions */
224 void (*_free_priv_data)(void *); /* Callback for freeing priv_data */
225 const struct_sysent *s_ent; /* sysent[scno] or dummy struct for bad scno */
226 const struct_sysent *s_prev_ent; /* for "resuming interrupted SYSCALL" msg */
227 struct inject_opts *inject_vec[SUPPORTED_PERSONALITIES];
228 struct timeval stime; /* System time usage as of last process wait */
229 struct timeval dtime; /* Delta for system time usage */
230 struct timeval etime; /* Syscall entry time */
233 struct UPT_info *libunwind_ui;
234 struct mmap_cache_t *mmap_cache;
235 unsigned int mmap_cache_size;
236 unsigned int mmap_cache_generation;
237 struct queue_t *queue;
242 /* We have attached to this process, but did not see it stopping yet */
243 #define TCB_STARTUP 0x01
244 #define TCB_IGNORE_ONE_SIGSTOP 0x02 /* Next SIGSTOP is to be ignored */
246 * Are we in system call entry or in syscall exit?
248 * This bit is set in syscall_entering_finish() and cleared in
249 * syscall_exiting_finish().
250 * Other stops which are possible directly after syscall entry (death, ptrace
251 * event stop) are handled without calling syscall_{entering,exiting}_*().
253 * Use entering(tcp) / exiting(tcp) to check this bit to make code more
256 #define TCB_INSYSCALL 0x04
257 #define TCB_ATTACHED 0x08 /* We attached to it already */
258 #define TCB_REPRINT 0x10 /* We should reprint this syscall on exit */
259 #define TCB_FILTERED 0x20 /* This system call has been filtered out */
260 #define TCB_TAMPERED 0x40 /* A syscall has been tampered with */
261 #define TCB_HIDE_LOG 0x80 /* We should hide everything (until execve) */
262 #define TCB_SKIP_DETACH_ON_FIRST_EXEC 0x100 /* -b execve should skip detach on first execve */
264 /* qualifier flags */
265 #define QUAL_TRACE 0x001 /* this system call should be traced */
266 #define QUAL_ABBREV 0x002 /* abbreviate the structures of this syscall */
267 #define QUAL_VERBOSE 0x004 /* decode the structures of this syscall */
268 #define QUAL_RAW 0x008 /* print all args in hex for this syscall */
269 #define QUAL_INJECT 0x010 /* tamper with this system call on purpose */
270 #define QUAL_SIGNAL 0x100 /* report events with this signal */
271 #define QUAL_READ 0x200 /* dump data read from this file descriptor */
272 #define QUAL_WRITE 0x400 /* dump data written to this file descriptor */
274 #define DEFAULT_QUAL_FLAGS (QUAL_TRACE | QUAL_ABBREV | QUAL_VERBOSE)
276 #define entering(tcp) (!((tcp)->flags & TCB_INSYSCALL))
277 #define exiting(tcp) ((tcp)->flags & TCB_INSYSCALL)
278 #define syserror(tcp) ((tcp)->u_error != 0)
279 #define verbose(tcp) ((tcp)->qual_flg & QUAL_VERBOSE)
280 #define abbrev(tcp) ((tcp)->qual_flg & QUAL_ABBREV)
281 #define filtered(tcp) ((tcp)->flags & TCB_FILTERED)
282 #define hide_log(tcp) ((tcp)->flags & TCB_HIDE_LOG)
286 extern const struct xlat addrfams[];
287 extern const struct xlat arp_hardware_types[];
288 extern const struct xlat at_flags[];
289 extern const struct xlat clocknames[];
290 extern const struct xlat dirent_types[];
291 extern const struct xlat ethernet_protocols[];
292 extern const struct xlat evdev_abs[];
293 extern const struct xlat iffflags[];
294 extern const struct xlat inet_protocols[];
295 extern const struct xlat msg_flags[];
296 extern const struct xlat netlink_protocols[];
297 extern const struct xlat nl_route_types[];
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 tcp_state_flags[];
306 extern const struct xlat tcp_states[];
307 extern const struct xlat whence_codes[];
309 /* Format of syscall return values */
310 #define RVAL_DECIMAL 000 /* decimal format */
311 #define RVAL_HEX 001 /* hex format */
312 #define RVAL_OCTAL 002 /* octal format */
313 #define RVAL_UDECIMAL 003 /* unsigned decimal format */
314 #define RVAL_FD 010 /* file descriptor */
315 #define RVAL_MASK 013 /* mask for these values */
317 #define RVAL_STR 020 /* Print `auxstr' field after return val */
318 #define RVAL_NONE 040 /* Print nothing */
320 #define RVAL_DECODED 0100 /* syscall decoding finished */
322 #define IOCTL_NUMBER_UNKNOWN 0
323 #define IOCTL_NUMBER_HANDLED 1
324 #define IOCTL_NUMBER_STOP_LOOKUP 010
326 #define indirect_ipccall(tcp) (tcp->s_ent->sys_flags & TRACE_INDIRECT_SUBCALL)
328 #if defined(ARM) || defined(AARCH64) \
329 || defined(I386) || defined(X32) || defined(X86_64) \
333 || defined(MICROBLAZE) \
336 || defined(SH) || defined(SH64) \
337 || defined(SPARC) || defined(SPARC64) \
339 # define NEED_UID16_PARSERS 1
341 # define NEED_UID16_PARSERS 0
353 extern enum sock_proto get_proto_by_name(const char *);
366 extern cflag_t cflag;
367 extern bool debug_flag;
370 extern bool count_wallclock;
371 extern unsigned int qflag;
372 extern bool not_failing_only;
373 extern unsigned int show_fd_path;
374 /* are we filtering traces based on paths? */
375 extern struct path_set {
376 const char **paths_selected;
377 unsigned int num_selected;
379 #define tracing_paths (global_path_set.num_selected != 0)
380 extern unsigned xflag;
381 extern unsigned followfork;
383 /* if this is true do the stack trace for every system call */
384 extern bool stack_trace_enabled;
386 extern unsigned ptrace_setoptions;
387 extern unsigned max_strlen;
388 extern unsigned os_release;
389 #undef KERNEL_VERSION
390 #define KERNEL_VERSION(a, b, c) (((a) << 16) + ((b) << 8) + (c))
392 extern int read_int_from_file(const char *, int *);
394 extern void set_sortby(const char *);
395 extern void set_overhead(int);
396 extern void print_pc(struct tcb *);
398 extern int syscall_entering_decode(struct tcb *);
399 extern int syscall_entering_trace(struct tcb *, unsigned int *);
400 extern void syscall_entering_finish(struct tcb *, int);
402 extern int syscall_exiting_decode(struct tcb *, struct timeval *);
403 extern int syscall_exiting_trace(struct tcb *, struct timeval, int);
404 extern void syscall_exiting_finish(struct tcb *);
406 extern void count_syscall(struct tcb *, const struct timeval *);
407 extern void call_summary(FILE *);
409 extern void clear_regs(void);
410 extern int get_scno(struct tcb *);
411 extern kernel_ulong_t get_rt_sigframe_addr(struct tcb *);
414 * Convert syscall number to syscall name.
416 * @param scno Syscall number.
417 * @return String literal corresponding to the syscall number in case latter
418 * is valid; NULL otherwise.
420 extern const char *syscall_name(kernel_ulong_t scno);
421 extern const char *err_name(unsigned long err);
423 extern bool is_erestart(struct tcb *);
424 extern void temporarily_clear_syserror(struct tcb *);
425 extern void restore_cleared_syserror(struct tcb *);
427 extern void *get_tcb_priv_data(const struct tcb *);
428 extern int set_tcb_priv_data(struct tcb *, void *priv_data,
429 void (*free_priv_data)(void *));
430 extern void free_tcb_priv_data(struct tcb *);
432 static inline unsigned long get_tcb_priv_ulong(const struct tcb *tcp)
434 return (unsigned long) get_tcb_priv_data(tcp);
437 static inline int set_tcb_priv_ulong(struct tcb *tcp, unsigned long val)
439 return set_tcb_priv_data(tcp, (void *) val, 0);
443 umoven(struct tcb *, kernel_ulong_t addr, unsigned int len, void *laddr);
444 #define umove(pid, addr, objp) \
445 umoven((pid), (addr), sizeof(*(objp)), (void *) (objp))
448 umoven_or_printaddr(struct tcb *, kernel_ulong_t addr,
449 unsigned int len, void *laddr);
450 #define umove_or_printaddr(pid, addr, objp) \
451 umoven_or_printaddr((pid), (addr), sizeof(*(objp)), (void *) (objp))
454 umoven_or_printaddr_ignore_syserror(struct tcb *, kernel_ulong_t addr,
455 unsigned int len, void *laddr);
458 umovestr(struct tcb *, kernel_ulong_t addr, unsigned int len, char *laddr);
460 extern int upeek(int pid, unsigned long, kernel_ulong_t *);
461 extern int upoke(int pid, unsigned long, kernel_ulong_t);
464 print_array(struct tcb *,
465 kernel_ulong_t start_addr,
469 int (*umoven_func)(struct tcb *,
473 bool (*print_func)(struct tcb *,
479 #if defined ALPHA || defined IA64 || defined MIPS \
480 || defined SH || defined SPARC || defined SPARC64
481 # define HAVE_GETRVAL2
482 extern long getrval2(struct tcb *);
484 # undef HAVE_GETRVAL2
487 extern const char *signame(const int);
488 extern void pathtrace_select_set(const char *, struct path_set *);
489 extern bool pathtrace_match_set(struct tcb *, struct path_set *);
490 #define pathtrace_select(tcp) \
491 pathtrace_select_set(tcp, &global_path_set)
492 #define pathtrace_match(tcp) \
493 pathtrace_match_set(tcp, &global_path_set)
494 extern int getfdpath(struct tcb *, int, char *, unsigned);
495 extern unsigned long getfdinode(struct tcb *, int);
496 extern enum sock_proto getfdproto(struct tcb *, int);
498 extern const char *xlookup(const struct xlat *, const uint64_t);
499 extern const char *xlat_search(const struct xlat *, const size_t, const uint64_t);
502 struct dyxlat *dyxlat_alloc(size_t nmemb);
503 void dyxlat_free(struct dyxlat *);
504 const struct xlat *dyxlat_get(const struct dyxlat *);
505 void dyxlat_add_pair(struct dyxlat *, uint64_t val, const char *str, size_t len);
507 const struct xlat *genl_families_xlat(void);
509 extern unsigned long get_pagesize(void);
511 string_to_uint_ex(const char *str, char **endptr,
512 unsigned int max_val, const char *accepted_ending);
513 extern int string_to_uint(const char *str);
515 string_to_uint_upto(const char *const str, unsigned int max_val)
517 return string_to_uint_ex(str, NULL, max_val, NULL);
519 extern int next_set_bit(const void *bit_array, unsigned cur_bit, unsigned size_bits);
522 * Returns STR if it does not start with PREFIX,
523 * or a pointer to the first char in STR after PREFIX.
524 * The length of PREFIX is specified by PREFIX_LEN.
526 static inline const char *
527 str_strip_prefix_len(const char *str, const char *prefix, size_t prefix_len)
529 return strncmp(str, prefix, prefix_len) ? str : str + prefix_len;
532 #define STR_STRIP_PREFIX(str, prefix) \
533 str_strip_prefix_len((str), (prefix), sizeof(prefix) - 1)
535 #define QUOTE_0_TERMINATED 0x01
536 #define QUOTE_OMIT_LEADING_TRAILING_QUOTES 0x02
537 #define QUOTE_OMIT_TRAILING_0 0x08
538 #define QUOTE_FORCE_HEX 0x10
540 extern int string_quote(const char *, char *, unsigned int, unsigned int);
541 extern int print_quoted_string(const char *, unsigned int, unsigned int);
542 extern int print_quoted_cstring(const char *, unsigned int);
544 /* a refers to the lower numbered u_arg,
545 * b refers to the higher numbered u_arg
547 #ifdef WORDS_BIGENDIAN
548 # define ULONG_LONG(a, b) \
549 ((unsigned long long)(unsigned)(b) | ((unsigned long long)(a)<<32))
551 # define ULONG_LONG(a, b) \
552 ((unsigned long long)(unsigned)(a) | ((unsigned long long)(b)<<32))
554 extern int getllval(struct tcb *, unsigned long long *, int);
555 extern int printllval(struct tcb *, const char *, int)
556 ATTRIBUTE_FORMAT((printf, 2, 0));
558 extern void printaddr(kernel_ulong_t addr);
559 extern int printxvals(const uint64_t, const char *, const struct xlat *, ...)
561 extern int printxval_searchn(const struct xlat *xlat, size_t xlat_size,
562 uint64_t val, const char *dflt);
563 #define printxval_search(xlat__, val__, dflt__) \
564 printxval_searchn(xlat__, ARRAY_SIZE(xlat__), val__, dflt__)
565 extern int printargs(struct tcb *);
566 extern int printargs_u(struct tcb *);
567 extern int printargs_d(struct tcb *);
569 extern void addflags(const struct xlat *, uint64_t);
570 extern int printflags_ex(uint64_t, const char *, const struct xlat *, ...)
572 extern const char *sprintflags(const char *, const struct xlat *, uint64_t);
573 extern const char *sprinttime(long long sec);
574 extern const char *sprinttime_nsec(long long sec, unsigned long long nsec);
575 extern const char *sprinttime_usec(long long sec, unsigned long long usec);
576 extern void print_symbolic_mode_t(unsigned int);
577 extern void print_numeric_umode_t(unsigned short);
578 extern void print_numeric_long_umask(unsigned long);
579 extern void print_dev_t(unsigned long long dev);
580 extern void print_abnormal_hi(kernel_ulong_t);
583 dumpiov_in_msghdr(struct tcb *, kernel_ulong_t addr, kernel_ulong_t data_size);
586 dumpiov_in_mmsghdr(struct tcb *, kernel_ulong_t addr);
589 dumpiov_upto(struct tcb *, int len, kernel_ulong_t addr, kernel_ulong_t data_size);
592 dumpstr(struct tcb *, kernel_ulong_t addr, int len);
595 printstr_ex(struct tcb *, kernel_ulong_t addr, kernel_ulong_t len,
596 unsigned int user_style);
599 printpathn(struct tcb *, kernel_ulong_t addr, unsigned int n);
602 printpath(struct tcb *, kernel_ulong_t addr);
604 #define TIMESPEC_TEXT_BUFSIZE \
605 (sizeof(long long) * 3 * 2 + sizeof("{tv_sec=-, tv_nsec=}"))
606 extern void printfd(struct tcb *, int);
607 extern void print_sockaddr(const void *sa, int len);
609 print_inet_addr(int af, const void *addr, unsigned int len, const char *var_name);
610 extern const char *get_sockaddr_by_inode(struct tcb *, int fd, unsigned long inode);
611 extern bool print_sockaddr_by_inode(struct tcb *, int fd, unsigned long inode);
612 extern void print_dirfd(struct tcb *, int);
615 decode_sockaddr(struct tcb *, kernel_ulong_t addr, int addrlen);
617 extern void printuid(const char *, const unsigned int);
620 print_sigset_addr_len(struct tcb *, kernel_ulong_t addr, kernel_ulong_t len);
622 print_sigset_addr(struct tcb *, kernel_ulong_t addr);
624 extern const char *sprintsigmask_n(const char *, const void *, unsigned int);
625 #define tprintsigmask_addr(prefix, mask) \
626 tprints(sprintsigmask_n((prefix), (mask), sizeof(mask)))
627 extern void printsignal(int);
630 tprint_iov_upto(struct tcb *, kernel_ulong_t len, kernel_ulong_t addr,
631 enum iov_decode, kernel_ulong_t data_size);
634 decode_netlink(struct tcb *, int fd, kernel_ulong_t addr, kernel_ulong_t len);
636 extern void tprint_open_modes(unsigned int);
637 extern const char *sprint_open_modes(unsigned int);
640 decode_seccomp_fprog(struct tcb *, kernel_ulong_t addr);
643 print_seccomp_fprog(struct tcb *, kernel_ulong_t addr, unsigned short len);
646 decode_sock_fprog(struct tcb *, kernel_ulong_t addr);
649 print_sock_fprog(struct tcb *, kernel_ulong_t addr, unsigned short len);
652 extern void print_struct_stat(struct tcb *, const struct strace_stat *const st);
654 struct strace_statfs;
657 print_struct_statfs(struct tcb *, kernel_ulong_t addr);
660 print_struct_statfs64(struct tcb *, kernel_ulong_t addr, kernel_ulong_t size);
662 extern void print_ifindex(unsigned int);
665 extern struct number_set read_set;
666 extern struct number_set write_set;
667 extern struct number_set signal_set;
669 extern bool is_number_in_set(unsigned int number, const struct number_set *);
670 extern void qualify(const char *);
671 extern unsigned int qual_flags(const unsigned int);
673 #define DECL_IOCTL(name) \
675 name ## _ioctl(struct tcb *, unsigned int request, kernel_ulong_t arg) \
676 /* End of DECL_IOCTL definition. */
689 extern int decode_sg_io_v4(struct tcb *, const kernel_ulong_t arg);
693 typedef bool (*netlink_decoder_t)(struct tcb *, const struct nlmsghdr *,
694 kernel_ulong_t addr, unsigned int len);
696 #define DECL_NETLINK(name) \
698 decode_netlink_ ## name(struct tcb *, const struct nlmsghdr *, \
699 kernel_ulong_t addr, unsigned int len) \
700 /* End of DECL_NETLINK definition. */
702 DECL_NETLINK(crypto);
704 DECL_NETLINK(selinux);
705 DECL_NETLINK(sock_diag);
707 extern int tv_nz(const struct timeval *);
708 extern int tv_cmp(const struct timeval *, const struct timeval *);
709 extern double tv_float(const struct timeval *);
710 extern void tv_add(struct timeval *, const struct timeval *, const struct timeval *);
711 extern void tv_sub(struct timeval *, const struct timeval *, const struct timeval *);
712 extern void tv_mul(struct timeval *, const struct timeval *, int);
713 extern void tv_div(struct timeval *, const struct timeval *, int);
716 extern void unwind_init(void);
717 extern void unwind_tcb_init(struct tcb *);
718 extern void unwind_tcb_fin(struct tcb *);
719 extern void unwind_cache_invalidate(struct tcb *);
720 extern void unwind_print_stacktrace(struct tcb *);
721 extern void unwind_capture_stacktrace(struct tcb *);
725 printstrn(struct tcb *tcp, kernel_ulong_t addr, kernel_ulong_t len)
727 printstr_ex(tcp, addr, len, 0);
731 printstr(struct tcb *tcp, kernel_ulong_t addr)
733 printstr_ex(tcp, addr, -1, QUOTE_0_TERMINATED);
737 printflags64(const struct xlat *x, uint64_t flags, const char *dflt)
739 return printflags_ex(flags, dflt, x, NULL);
743 printflags(const struct xlat *x, unsigned int flags, const char *dflt)
745 return printflags64(x, flags, dflt);
749 printxval64(const struct xlat *x, const uint64_t val, const char *dflt)
751 return printxvals(val, dflt, x, NULL);
755 printxval(const struct xlat *x, const unsigned int val, const char *dflt)
757 return printxvals(val, dflt, x, NULL);
761 tprint_iov(struct tcb *tcp, kernel_ulong_t len, kernel_ulong_t addr,
762 enum iov_decode decode_iov)
764 tprint_iov_upto(tcp, len, addr, decode_iov, -1);
772 extern void print_timeval32_t(const timeval32_t *);
773 extern void printrusage32(struct tcb *, kernel_ulong_t);
774 extern const char *sprint_timeval32(struct tcb *, kernel_ulong_t addr);
775 extern void print_timeval32(struct tcb *, kernel_ulong_t addr);
776 extern void print_timeval32_utimes(struct tcb *, kernel_ulong_t addr);
777 extern void print_itimerval32(struct tcb *, kernel_ulong_t addr);
780 #ifdef HAVE_STRUCT_USER_DESC
781 extern void print_user_desc(struct tcb *, kernel_ulong_t addr);
784 /* Strace log generation machinery.
786 * printing_tcp: tcb which has incomplete line being printed right now.
787 * NULL if last line has been completed ('\n'-terminated).
788 * printleader(tcp) examines it, finishes incomplete line if needed,
789 * the sets it to tcp.
790 * line_ended() clears printing_tcp and resets ->curcol = 0.
791 * tcp->curcol == 0 check is also used to detect completeness
792 * of last line, since in -ff mode just checking printing_tcp for NULL
795 * If you change this code, test log generation in both -f and -ff modes
797 * strace -oLOG -f[f] test/threaded_execve
798 * strace -oLOG -f[f] test/sigkill_rain
799 * strace -oLOG -f[f] -p "`pidof web_browser`"
801 extern struct tcb *printing_tcp;
802 extern void printleader(struct tcb *);
803 extern void line_ended(void);
804 extern void tabto(void);
805 extern void tprintf(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2));
806 extern void tprints(const char *str);
807 extern void tprintf_comment(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2));
808 extern void tprints_comment(const char *str);
810 #if SUPPORTED_PERSONALITIES > 1
811 extern void set_personality(int personality);
812 extern unsigned current_personality;
814 # define set_personality(personality) ((void)0)
815 # define current_personality 0
818 #if SUPPORTED_PERSONALITIES == 1
819 # define current_wordsize PERSONALITY0_WORDSIZE
820 # define current_klongsize PERSONALITY0_KLONGSIZE
822 # if SUPPORTED_PERSONALITIES == 2 && PERSONALITY0_WORDSIZE == PERSONALITY1_WORDSIZE
823 # define current_wordsize PERSONALITY0_WORDSIZE
825 extern unsigned current_wordsize;
827 # if SUPPORTED_PERSONALITIES == 2 && PERSONALITY0_KLONGSIZE == PERSONALITY1_KLONGSIZE
828 # define current_klongsize PERSONALITY0_KLONGSIZE
830 extern unsigned current_klongsize;
834 #define ANY_WORDSIZE_LESS_THAN_KERNEL_LONG \
835 (SIZEOF_KERNEL_LONG_T > 4 \
836 && (SIZEOF_LONG < SIZEOF_KERNEL_LONG_T || !defined(current_wordsize)))
838 #define DECL_PRINTNUM(name) \
840 printnum_ ## name(struct tcb *, kernel_ulong_t addr, const char *fmt) \
841 ATTRIBUTE_FORMAT((printf, 3, 0)) \
842 /* End of DECL_PRINTNUM definition. */
844 DECL_PRINTNUM(short);
846 DECL_PRINTNUM(int64);
849 #define DECL_PRINTNUM_ADDR(name) \
851 printnum_addr_ ## name(struct tcb *, kernel_ulong_t addr) \
852 /* End of DECL_PRINTNUM_ADDR definition. */
854 DECL_PRINTNUM_ADDR(int);
855 DECL_PRINTNUM_ADDR(int64);
856 #undef DECL_PRINTNUM_ADDR
858 #ifndef current_wordsize
860 printnum_long_int(struct tcb *, kernel_ulong_t addr,
861 const char *fmt_long, const char *fmt_int)
862 ATTRIBUTE_FORMAT((printf, 3, 0))
863 ATTRIBUTE_FORMAT((printf, 4, 0));
864 extern bool printnum_addr_long_int(struct tcb *, kernel_ulong_t addr);
865 # define printnum_slong(tcp, addr) \
866 printnum_long_int((tcp), (addr), "%" PRId64, "%d")
867 # define printnum_ulong(tcp, addr) \
868 printnum_long_int((tcp), (addr), "%" PRIu64, "%u")
869 # define printnum_ptr(tcp, addr) \
870 printnum_addr_long_int((tcp), (addr))
871 #elif current_wordsize > 4
872 # define printnum_slong(tcp, addr) \
873 printnum_int64((tcp), (addr), "%" PRId64)
874 # define printnum_ulong(tcp, addr) \
875 printnum_int64((tcp), (addr), "%" PRIu64)
876 # define printnum_ptr(tcp, addr) \
877 printnum_addr_int64((tcp), (addr))
878 #else /* current_wordsize == 4 */
879 # define printnum_slong(tcp, addr) \
880 printnum_int((tcp), (addr), "%d")
881 # define printnum_ulong(tcp, addr) \
882 printnum_int((tcp), (addr), "%u")
883 # define printnum_ptr(tcp, addr) \
884 printnum_addr_int((tcp), (addr))
887 #ifndef current_klongsize
888 extern bool printnum_addr_klong_int(struct tcb *, kernel_ulong_t addr);
889 # define printnum_kptr(tcp, addr) \
890 printnum_addr_klong_int((tcp), (addr))
891 #elif current_klongsize > 4
892 # define printnum_kptr(tcp, addr) \
893 printnum_addr_int64((tcp), (addr))
894 #else /* current_klongsize == 4 */
895 # define printnum_kptr(tcp, addr) \
896 printnum_addr_int((tcp), (addr))
899 #define DECL_PRINTPAIR(name) \
901 printpair_ ## name(struct tcb *, kernel_ulong_t addr, const char *fmt) \
902 ATTRIBUTE_FORMAT((printf, 3, 0)) \
903 /* End of DECL_PRINTPAIR definition. */
906 DECL_PRINTPAIR(int64);
907 #undef DECL_PRINTPAIR
909 static inline kernel_long_t
910 truncate_klong_to_current_wordsize(const kernel_long_t v)
912 #if ANY_WORDSIZE_LESS_THAN_KERNEL_LONG
913 if (current_wordsize < sizeof(v)) {
922 static inline kernel_ulong_t
923 truncate_kulong_to_current_wordsize(const kernel_ulong_t v)
925 #if ANY_WORDSIZE_LESS_THAN_KERNEL_LONG
926 if (current_wordsize < sizeof(v)) {
927 return (unsigned int) v;
936 * Cast a pointer or a pointer-sized integer to kernel_ulong_t.
938 #define ptr_to_kulong(v) ((kernel_ulong_t) (unsigned long) (v))
941 * Zero-extend a signed integer type to unsigned long long.
943 #define zero_extend_signed_to_ull(v) \
944 (sizeof(v) == sizeof(char) ? (unsigned long long) (unsigned char) (v) : \
945 sizeof(v) == sizeof(short) ? (unsigned long long) (unsigned short) (v) : \
946 sizeof(v) == sizeof(int) ? (unsigned long long) (unsigned int) (v) : \
947 sizeof(v) == sizeof(long) ? (unsigned long long) (unsigned long) (v) : \
948 (unsigned long long) (v))
951 * Sign-extend an unsigned integer type to long long.
953 #define sign_extend_unsigned_to_ll(v) \
954 (sizeof(v) == sizeof(char) ? (long long) (char) (v) : \
955 sizeof(v) == sizeof(short) ? (long long) (short) (v) : \
956 sizeof(v) == sizeof(int) ? (long long) (int) (v) : \
957 sizeof(v) == sizeof(long) ? (long long) (long) (v) : \
960 extern const struct_sysent sysent0[];
961 extern const char *const errnoent0[];
962 extern const char *const signalent0[];
963 extern const struct_ioctlent ioctlent0[];
965 #if SUPPORTED_PERSONALITIES > 1
966 extern const struct_sysent *sysent;
967 extern const char *const *errnoent;
968 extern const char *const *signalent;
969 extern const struct_ioctlent *ioctlent;
971 # define sysent sysent0
972 # define errnoent errnoent0
973 # define signalent signalent0
974 # define ioctlent ioctlent0
977 extern unsigned nsyscalls;
978 extern unsigned nerrnos;
979 extern unsigned nsignals;
980 extern unsigned nioctlents;
982 extern const unsigned int nsyscall_vec[SUPPORTED_PERSONALITIES];
983 extern const struct_sysent *const sysent_vec[SUPPORTED_PERSONALITIES];
984 extern struct inject_opts *inject_vec[SUPPORTED_PERSONALITIES];
986 #ifdef IN_MPERS_BOOTSTRAP
987 /* Transform multi-line MPERS_PRINTER_DECL statements to one-liners. */
988 # define MPERS_PRINTER_DECL(type, name, ...) MPERS_PRINTER_DECL(type, name, __VA_ARGS__)
989 #else /* !IN_MPERS_BOOTSTRAP */
990 # if SUPPORTED_PERSONALITIES > 1
991 # include "printers.h"
993 # include "native_printer_decls.h"
995 # define MPERS_PRINTER_DECL(type, name, ...) type MPERS_FUNC_NAME(name)(__VA_ARGS__)
996 #endif /* !IN_MPERS_BOOTSTRAP */
998 /* Checks that sysent[scno] is not out of range. */
1000 scno_in_range(kernel_ulong_t scno)
1002 return scno < nsyscalls;
1006 * Checks whether scno is not out of range,
1007 * its corresponding sysent[scno].sys_func is non-NULL,
1008 * and its sysent[scno].sys_flags has no TRACE_INDIRECT_SUBCALL flag set.
1011 scno_is_valid(kernel_ulong_t scno)
1013 return scno_in_range(scno)
1014 && sysent[scno].sys_func
1015 && !(sysent[scno].sys_flags & TRACE_INDIRECT_SUBCALL);
1018 #define MPERS_FUNC_NAME__(prefix, name) prefix ## name
1019 #define MPERS_FUNC_NAME_(prefix, name) MPERS_FUNC_NAME__(prefix, name)
1020 #define MPERS_FUNC_NAME(name) MPERS_FUNC_NAME_(MPERS_PREFIX, name)
1022 #define SYS_FUNC_NAME(syscall_name) MPERS_FUNC_NAME(syscall_name)
1024 #define SYS_FUNC(syscall_name) int SYS_FUNC_NAME(sys_ ## syscall_name)(struct tcb *tcp)
1026 #endif /* !STRACE_DEFS_H */