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 "arch_defs.h"
57 #include "error_prints.h"
58 #include "gcc_compat.h"
59 #include "kernel_types.h"
61 #include "mpers_type.h"
62 #include "string_to_uint.h"
63 #include "supported_personalities.h"
68 const char *strerror(int);
71 /* Some libc have stpcpy, some don't. Sigh...
72 * Roll our private implementation...
75 #define stpcpy strace_stpcpy
76 extern char *stpcpy(char *dst, const char *src);
79 /* Glibc has an efficient macro for sigemptyset
80 * (it just does one or two assignments of 0 to internal vector of longs).
82 #if defined(__GLIBC__) && defined(__sigemptyset) && !defined(sigemptyset)
83 # define sigemptyset __sigemptyset
86 /* Configuration section */
87 #ifndef DEFAULT_STRLEN
88 /* default maximum # of bytes printed in `printstr', change with -s switch */
89 # define DEFAULT_STRLEN 32
91 #ifndef DEFAULT_ACOLUMN
92 # define DEFAULT_ACOLUMN 40 /* default alignment column for results */
95 * Maximum number of args to a syscall.
97 * Make sure that all entries in all syscallent.h files have nargs <= MAX_ARGS!
98 * linux/<ARCH>/syscallent*.h:
99 * all have nargs <= 6 except mips o32 which has nargs <= 7.
102 # ifdef LINUX_MIPSO32
108 /* default sorting method for call profiling */
109 #ifndef DEFAULT_SORTBY
110 # define DEFAULT_SORTBY "time"
113 * Experimental code using PTRACE_SEIZE can be enabled here.
114 * This needs Linux kernel 3.4.x or later to work.
117 /* To force NOMMU build, set to 1 */
118 #define NOMMU_SYSTEM 0
121 # define ERESTARTSYS 512
123 #ifndef ERESTARTNOINTR
124 # define ERESTARTNOINTR 513
126 #ifndef ERESTARTNOHAND
127 # define ERESTARTNOHAND 514
129 #ifndef ERESTART_RESTARTBLOCK
130 # define ERESTART_RESTARTBLOCK 516
133 #define PERSONALITY0_WORDSIZE SIZEOF_LONG
134 #define PERSONALITY0_KLONGSIZE SIZEOF_KERNEL_LONG_T
135 #define PERSONALITY0_INCLUDE_PRINTERS_DECLS "native_printer_decls.h"
136 #define PERSONALITY0_INCLUDE_PRINTERS_DEFS "native_printer_defs.h"
138 #if SUPPORTED_PERSONALITIES > 1
139 # define PERSONALITY1_WORDSIZE 4
140 # define PERSONALITY1_KLONGSIZE PERSONALITY1_WORDSIZE
143 #if SUPPORTED_PERSONALITIES > 2
144 # define PERSONALITY2_WORDSIZE 4
145 # define PERSONALITY2_KLONGSIZE PERSONALITY0_KLONGSIZE
148 #if SUPPORTED_PERSONALITIES > 1 && defined HAVE_M32_MPERS
149 # define PERSONALITY1_INCLUDE_PRINTERS_DECLS "m32_printer_decls.h"
150 # define PERSONALITY1_INCLUDE_PRINTERS_DEFS "m32_printer_defs.h"
151 # define PERSONALITY1_INCLUDE_FUNCS "m32_funcs.h"
152 # define MPERS_m32_IOCTL_MACROS "ioctl_redefs1.h"
153 # define HAVE_PERSONALITY_1_MPERS 1
155 # define PERSONALITY1_INCLUDE_PRINTERS_DECLS "native_printer_decls.h"
156 # define PERSONALITY1_INCLUDE_PRINTERS_DEFS "native_printer_defs.h"
157 # define PERSONALITY1_INCLUDE_FUNCS "empty.h"
158 # define HAVE_PERSONALITY_1_MPERS 0
161 #if SUPPORTED_PERSONALITIES > 2 && defined HAVE_MX32_MPERS
162 # define PERSONALITY2_INCLUDE_FUNCS "mx32_funcs.h"
163 # define PERSONALITY2_INCLUDE_PRINTERS_DECLS "mx32_printer_decls.h"
164 # define PERSONALITY2_INCLUDE_PRINTERS_DEFS "mx32_printer_defs.h"
165 # define MPERS_mx32_IOCTL_MACROS "ioctl_redefs2.h"
166 # define HAVE_PERSONALITY_2_MPERS 1
168 # define PERSONALITY2_INCLUDE_PRINTERS_DECLS "native_printer_decls.h"
169 # define PERSONALITY2_INCLUDE_PRINTERS_DEFS "native_printer_defs.h"
170 # define PERSONALITY2_INCLUDE_FUNCS "empty.h"
171 # define HAVE_PERSONALITY_2_MPERS 0
174 typedef struct ioctlent {
179 #define INJECT_F_SIGNAL 1
180 #define INJECT_F_RETVAL 2
191 struct inject_data data;
194 #define MAX_ERRNO_VALUE 4095
196 /* Trace Control Block */
198 int flags; /* See below for TCB_ values */
199 int pid; /* If 0, this tcb is free */
200 int qual_flg; /* qual_flags[scno] or DEFAULT_QUAL_FLAGS + RAW */
201 unsigned long u_error; /* Error code */
202 kernel_ulong_t scno; /* System call number */
203 kernel_ulong_t u_arg[MAX_ARGS]; /* System call arguments */
204 kernel_long_t u_rval; /* Return value */
205 #if SUPPORTED_PERSONALITIES > 1
206 unsigned int currpers; /* Personality at the time of scno update */
208 int sys_func_rval; /* Syscall entry parser's return value */
209 int curcol; /* Output column for this process */
210 FILE *outf; /* Output file for this process */
211 const char *auxstr; /* Auxiliary info from syscall (see RVAL_STR) */
212 void *_priv_data; /* Private data for syscall decoding functions */
213 void (*_free_priv_data)(void *); /* Callback for freeing priv_data */
214 const struct_sysent *s_ent; /* sysent[scno] or dummy struct for bad scno */
215 const struct_sysent *s_prev_ent; /* for "resuming interrupted SYSCALL" msg */
216 struct inject_opts *inject_vec[SUPPORTED_PERSONALITIES];
217 struct timeval stime; /* System time usage as of last process wait */
218 struct timeval dtime; /* Delta for system time usage */
219 struct timeval etime; /* Syscall entry time */
222 struct UPT_info *libunwind_ui;
223 struct mmap_cache_t *mmap_cache;
224 unsigned int mmap_cache_size;
225 unsigned int mmap_cache_generation;
226 struct queue_t *queue;
231 /* We have attached to this process, but did not see it stopping yet */
232 #define TCB_STARTUP 0x01
233 #define TCB_IGNORE_ONE_SIGSTOP 0x02 /* Next SIGSTOP is to be ignored */
235 * Are we in system call entry or in syscall exit?
237 * This bit is set in syscall_entering_finish() and cleared in
238 * syscall_exiting_finish().
239 * Other stops which are possible directly after syscall entry (death, ptrace
240 * event stop) are handled without calling syscall_{entering,exiting}_*().
242 * Use entering(tcp) / exiting(tcp) to check this bit to make code more
245 #define TCB_INSYSCALL 0x04
246 #define TCB_ATTACHED 0x08 /* We attached to it already */
247 #define TCB_REPRINT 0x10 /* We should reprint this syscall on exit */
248 #define TCB_FILTERED 0x20 /* This system call has been filtered out */
249 #define TCB_TAMPERED 0x40 /* A syscall has been tampered with */
250 #define TCB_HIDE_LOG 0x80 /* We should hide everything (until execve) */
251 #define TCB_SKIP_DETACH_ON_FIRST_EXEC 0x100 /* -b execve should skip detach on first execve */
252 #define TCB_GRABBED 0x200 /* We grab the process and can catch it
253 * in the middle of a syscall */
255 /* qualifier flags */
256 #define QUAL_TRACE 0x001 /* this system call should be traced */
257 #define QUAL_ABBREV 0x002 /* abbreviate the structures of this syscall */
258 #define QUAL_VERBOSE 0x004 /* decode the structures of this syscall */
259 #define QUAL_RAW 0x008 /* print all args in hex for this syscall */
260 #define QUAL_INJECT 0x010 /* tamper with this system call on purpose */
262 #define DEFAULT_QUAL_FLAGS (QUAL_TRACE | QUAL_ABBREV | QUAL_VERBOSE)
264 #define entering(tcp) (!((tcp)->flags & TCB_INSYSCALL))
265 #define exiting(tcp) ((tcp)->flags & TCB_INSYSCALL)
266 #define syserror(tcp) ((tcp)->u_error != 0)
267 #define traced(tcp) ((tcp)->qual_flg & QUAL_TRACE)
268 #define verbose(tcp) ((tcp)->qual_flg & QUAL_VERBOSE)
269 #define abbrev(tcp) ((tcp)->qual_flg & QUAL_ABBREV)
270 #define raw(tcp) ((tcp)->qual_flg & QUAL_RAW)
271 #define inject(tcp) ((tcp)->qual_flg & QUAL_INJECT)
272 #define filtered(tcp) ((tcp)->flags & TCB_FILTERED)
273 #define hide_log(tcp) ((tcp)->flags & TCB_HIDE_LOG)
274 #define syscall_tampered(tcp) ((tcp)->flags & TCB_TAMPERED)
278 extern const struct xlat addrfams[];
279 extern const struct xlat arp_hardware_types[];
280 extern const struct xlat at_flags[];
281 extern const struct xlat clocknames[];
282 extern const struct xlat dirent_types[];
283 extern const struct xlat ethernet_protocols[];
284 extern const struct xlat evdev_abs[];
285 extern const struct xlat iffflags[];
286 extern const struct xlat inet_protocols[];
287 extern const struct xlat ip_type_of_services[];
288 extern const struct xlat msg_flags[];
289 extern const struct xlat netlink_protocols[];
290 extern const struct xlat nl_route_types[];
291 extern const struct xlat open_access_modes[];
292 extern const struct xlat open_mode_flags[];
293 extern const struct xlat resource_flags[];
294 extern const struct xlat routing_scopes[];
295 extern const struct xlat routing_table_ids[];
296 extern const struct xlat routing_types[];
297 extern const struct xlat seccomp_ret_action[];
298 extern const struct xlat setns_types[];
299 extern const struct xlat sg_io_info[];
300 extern const struct xlat socketlayers[];
301 extern const struct xlat socktypes[];
302 extern const struct xlat tcp_state_flags[];
303 extern const struct xlat tcp_states[];
304 extern const struct xlat whence_codes[];
306 /* Format of syscall return values */
307 #define RVAL_DECIMAL 000 /* decimal format */
308 #define RVAL_HEX 001 /* hex format */
309 #define RVAL_OCTAL 002 /* octal format */
310 #define RVAL_UDECIMAL 003 /* unsigned decimal format */
311 #define RVAL_FD 010 /* file descriptor */
312 #define RVAL_MASK 013 /* mask for these values */
314 #define RVAL_STR 020 /* Print `auxstr' field after return val */
315 #define RVAL_NONE 040 /* Print nothing */
317 #define RVAL_DECODED 0100 /* syscall decoding finished */
318 #define RVAL_IOCTL_DECODED 0200 /* ioctl sub-parser successfully decoded
320 #define RVAL_PRINT_ERR_VAL 0400 /* Print decoded error code along with
321 syscall return value. Needed for modify_ldt
322 that for some reason decides to return
323 an error with higher bits set to 0. */
325 #define IOCTL_NUMBER_UNKNOWN 0
326 #define IOCTL_NUMBER_HANDLED 1
327 #define IOCTL_NUMBER_STOP_LOOKUP 010
329 #define indirect_ipccall(tcp) (tcp->s_ent->sys_flags & TRACE_INDIRECT_SUBCALL)
331 #if defined(ARM) || defined(AARCH64) \
332 || defined(I386) || defined(X32) || defined(X86_64) \
336 || defined(MICROBLAZE) \
338 || defined(S390) || defined(S390X) \
339 || defined(SH) || defined(SH64) \
340 || defined(SPARC) || defined(SPARC64) \
342 # define NEED_UID16_PARSERS 1
344 # define NEED_UID16_PARSERS 0
356 extern enum sock_proto get_proto_by_name(const char *);
369 extern cflag_t cflag;
372 extern bool count_wallclock;
373 extern unsigned int qflag;
374 extern bool not_failing_only;
375 extern unsigned int show_fd_path;
376 /* are we filtering traces based on paths? */
377 extern struct path_set {
378 const char **paths_selected;
382 #define tracing_paths (global_path_set.num_selected != 0)
383 extern unsigned xflag;
384 extern unsigned followfork;
386 /* if this is true do the stack trace for every system call */
387 extern bool stack_trace_enabled;
389 extern unsigned ptrace_setoptions;
390 extern unsigned max_strlen;
391 extern unsigned os_release;
392 #undef KERNEL_VERSION
393 #define KERNEL_VERSION(a, b, c) (((a) << 16) + ((b) << 8) + (c))
395 extern int read_int_from_file(struct tcb *, const char *, int *);
397 extern void set_sortby(const char *);
398 extern void set_overhead(int);
399 extern void print_pc(struct tcb *);
401 extern int syscall_entering_decode(struct tcb *);
402 extern int syscall_entering_trace(struct tcb *, unsigned int *);
403 extern void syscall_entering_finish(struct tcb *, int);
405 extern int syscall_exiting_decode(struct tcb *, struct timeval *);
406 extern int syscall_exiting_trace(struct tcb *, struct timeval, int);
407 extern void syscall_exiting_finish(struct tcb *);
409 extern void count_syscall(struct tcb *, const struct timeval *);
410 extern void call_summary(FILE *);
412 extern void clear_regs(struct tcb *tcp);
413 extern int get_scno(struct tcb *);
414 extern kernel_ulong_t get_rt_sigframe_addr(struct tcb *);
417 * Convert syscall number to syscall name.
419 * @param scno Syscall number.
420 * @return String literal corresponding to the syscall number in case latter
421 * is valid; NULL otherwise.
423 extern const char *syscall_name(kernel_ulong_t scno);
424 extern const char *err_name(unsigned long err);
426 extern bool is_erestart(struct tcb *);
427 extern void temporarily_clear_syserror(struct tcb *);
428 extern void restore_cleared_syserror(struct tcb *);
430 extern void *get_tcb_priv_data(const struct tcb *);
431 extern int set_tcb_priv_data(struct tcb *, void *priv_data,
432 void (*free_priv_data)(void *));
433 extern void free_tcb_priv_data(struct tcb *);
435 static inline unsigned long get_tcb_priv_ulong(const struct tcb *tcp)
437 return (unsigned long) get_tcb_priv_data(tcp);
440 static inline int set_tcb_priv_ulong(struct tcb *tcp, unsigned long val)
442 return set_tcb_priv_data(tcp, (void *) val, 0);
446 umoven(struct tcb *, kernel_ulong_t addr, unsigned int len, void *laddr);
447 #define umove(pid, addr, objp) \
448 umoven((pid), (addr), sizeof(*(objp)), (void *) (objp))
451 umoven_or_printaddr(struct tcb *, kernel_ulong_t addr,
452 unsigned int len, void *laddr);
453 #define umove_or_printaddr(pid, addr, objp) \
454 umoven_or_printaddr((pid), (addr), sizeof(*(objp)), (void *) (objp))
457 umoven_or_printaddr_ignore_syserror(struct tcb *, kernel_ulong_t addr,
458 unsigned int len, void *laddr);
461 umovestr(struct tcb *, kernel_ulong_t addr, unsigned int len, char *laddr);
463 extern int upeek(struct tcb *tcp, unsigned long, kernel_ulong_t *);
464 extern int upoke(struct tcb *tcp, unsigned long, kernel_ulong_t);
467 print_array(struct tcb *,
468 kernel_ulong_t start_addr,
472 int (*umoven_func)(struct tcb *,
476 bool (*print_func)(struct tcb *,
482 #if HAVE_ARCH_GETRVAL2
483 extern long getrval2(struct tcb *);
486 extern const char *signame(const int);
487 extern void pathtrace_select_set(const char *, struct path_set *);
488 extern bool pathtrace_match_set(struct tcb *, struct path_set *);
489 #define pathtrace_select(tcp) \
490 pathtrace_select_set(tcp, &global_path_set)
491 #define pathtrace_match(tcp) \
492 pathtrace_match_set(tcp, &global_path_set)
493 extern int getfdpath(struct tcb *, int, char *, unsigned);
494 extern unsigned long getfdinode(struct tcb *, int);
495 extern enum sock_proto getfdproto(struct tcb *, int);
497 extern const char *xlookup(const struct xlat *, const uint64_t);
498 extern const char *xlat_search(const struct xlat *, const size_t, const uint64_t);
501 struct dyxlat *dyxlat_alloc(size_t nmemb);
502 void dyxlat_free(struct dyxlat *);
503 const struct xlat *dyxlat_get(const struct dyxlat *);
504 void dyxlat_add_pair(struct dyxlat *, uint64_t val, const char *str, size_t len);
506 const struct xlat *genl_families_xlat(struct tcb *tcp);
508 extern unsigned long get_pagesize(void);
509 extern int next_set_bit(const void *bit_array, unsigned cur_bit, unsigned size_bits);
512 * Returns STR if it does not start with PREFIX,
513 * or a pointer to the first char in STR after PREFIX.
514 * The length of PREFIX is specified by PREFIX_LEN.
516 static inline const char *
517 str_strip_prefix_len(const char *str, const char *prefix, size_t prefix_len)
519 return strncmp(str, prefix, prefix_len) ? str : str + prefix_len;
522 #define STR_STRIP_PREFIX(str, prefix) \
523 str_strip_prefix_len((str), (prefix), sizeof(prefix) - 1)
525 #define QUOTE_0_TERMINATED 0x01
526 #define QUOTE_OMIT_LEADING_TRAILING_QUOTES 0x02
527 #define QUOTE_OMIT_TRAILING_0 0x08
528 #define QUOTE_FORCE_HEX 0x10
530 extern int string_quote(const char *, char *, unsigned int, unsigned int);
531 extern int print_quoted_string(const char *, unsigned int, unsigned int);
532 extern int print_quoted_cstring(const char *, unsigned int);
534 /* a refers to the lower numbered u_arg,
535 * b refers to the higher numbered u_arg
537 #ifdef WORDS_BIGENDIAN
538 # define ULONG_LONG(a, b) \
539 ((unsigned long long)(unsigned)(b) | ((unsigned long long)(a)<<32))
541 # define ULONG_LONG(a, b) \
542 ((unsigned long long)(unsigned)(a) | ((unsigned long long)(b)<<32))
544 extern int getllval(struct tcb *, unsigned long long *, int);
545 extern int printllval(struct tcb *, const char *, int)
546 ATTRIBUTE_FORMAT((printf, 2, 0));
548 extern void printaddr(kernel_ulong_t addr);
549 extern int printxvals(const uint64_t, const char *, const struct xlat *, ...)
551 extern int printxval_searchn(const struct xlat *xlat, size_t xlat_size,
552 uint64_t val, const char *dflt);
553 #define printxval_search(xlat__, val__, dflt__) \
554 printxval_searchn(xlat__, ARRAY_SIZE(xlat__), val__, dflt__)
555 extern int sprintxval(char *buf, size_t size, const struct xlat *,
556 unsigned int val, const char *dflt);
557 extern int printargs(struct tcb *);
558 extern int printargs_u(struct tcb *);
559 extern int printargs_d(struct tcb *);
561 extern void addflags(const struct xlat *, uint64_t);
562 extern int printflags_ex(uint64_t, const char *, const struct xlat *, ...)
564 extern const char *sprintflags(const char *, const struct xlat *, uint64_t);
565 extern const char *sprinttime(long long sec);
566 extern const char *sprinttime_nsec(long long sec, unsigned long long nsec);
567 extern const char *sprinttime_usec(long long sec, unsigned long long usec);
568 extern void print_symbolic_mode_t(unsigned int);
569 extern void print_numeric_umode_t(unsigned short);
570 extern void print_numeric_long_umask(unsigned long);
571 extern void print_dev_t(unsigned long long dev);
572 extern void print_abnormal_hi(kernel_ulong_t);
574 #if HAVE_ARCH_OLD_MMAP
575 extern kernel_ulong_t *fetch_old_mmap_args(struct tcb *tcp);
579 dumpiov_in_msghdr(struct tcb *, kernel_ulong_t addr, kernel_ulong_t data_size);
582 dumpiov_in_mmsghdr(struct tcb *, kernel_ulong_t addr);
585 dumpiov_upto(struct tcb *, int len, kernel_ulong_t addr, kernel_ulong_t data_size);
588 dumpstr(struct tcb *, kernel_ulong_t addr, int len);
591 printstr_ex(struct tcb *, kernel_ulong_t addr, kernel_ulong_t len,
592 unsigned int user_style);
595 printpathn(struct tcb *, kernel_ulong_t addr, unsigned int n);
598 printpath(struct tcb *, kernel_ulong_t addr);
600 #define TIMESPEC_TEXT_BUFSIZE \
601 (sizeof(long long) * 3 * 2 + sizeof("{tv_sec=-, tv_nsec=}"))
602 extern void printfd(struct tcb *, int);
603 extern void print_sockaddr(const void *sa, int len);
605 print_inet_addr(int af, const void *addr, unsigned int len, const char *var_name);
607 decode_inet_addr(struct tcb *, kernel_ulong_t addr,
608 unsigned int len, int family, const char *var_name);
609 extern const char *get_sockaddr_by_inode(struct tcb *, int fd, unsigned long inode);
610 extern bool print_sockaddr_by_inode(struct tcb *, int fd, unsigned long inode);
611 extern void print_dirfd(struct tcb *, int);
614 decode_sockaddr(struct tcb *, kernel_ulong_t addr, int addrlen);
616 extern void printuid(const char *, const unsigned int);
619 print_sigset_addr_len(struct tcb *, kernel_ulong_t addr, kernel_ulong_t len);
621 print_sigset_addr(struct tcb *, kernel_ulong_t addr);
623 extern const char *sprintsigmask_n(const char *, const void *, unsigned int);
624 #define tprintsigmask_addr(prefix, mask) \
625 tprints(sprintsigmask_n((prefix), (mask), sizeof(mask)))
626 extern void printsignal(int);
629 tprint_iov_upto(struct tcb *, kernel_ulong_t len, kernel_ulong_t addr,
630 enum iov_decode, kernel_ulong_t data_size);
633 decode_netlink(struct tcb *, int fd, kernel_ulong_t addr, kernel_ulong_t len);
635 extern void tprint_open_modes(unsigned int);
636 extern const char *sprint_open_modes(unsigned int);
639 decode_seccomp_fprog(struct tcb *, kernel_ulong_t addr);
642 print_seccomp_fprog(struct tcb *, kernel_ulong_t addr, unsigned short len);
645 decode_sock_fprog(struct tcb *, kernel_ulong_t addr);
648 print_sock_fprog(struct tcb *, kernel_ulong_t addr, unsigned short len);
651 extern void print_struct_stat(struct tcb *, const struct strace_stat *const st);
653 struct strace_statfs;
654 struct strace_keyctl_kdf_params;
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);
664 extern void qualify(const char *);
665 extern unsigned int qual_flags(const unsigned int);
667 #define DECL_IOCTL(name) \
669 name ## _ioctl(struct tcb *, unsigned int request, kernel_ulong_t arg) \
670 /* End of DECL_IOCTL definition. */
684 extern int decode_sg_io_v4(struct tcb *, const kernel_ulong_t arg);
688 typedef bool (*netlink_decoder_t)(struct tcb *, const struct nlmsghdr *,
689 kernel_ulong_t addr, unsigned int len);
691 #define DECL_NETLINK(name) \
693 decode_netlink_ ## name(struct tcb *, const struct nlmsghdr *, \
694 kernel_ulong_t addr, unsigned int len) \
695 /* End of DECL_NETLINK definition. */
697 DECL_NETLINK(crypto);
699 DECL_NETLINK(selinux);
700 DECL_NETLINK(sock_diag);
702 extern int tv_nz(const struct timeval *);
703 extern int tv_cmp(const struct timeval *, const struct timeval *);
704 extern double tv_float(const struct timeval *);
705 extern void tv_add(struct timeval *, const struct timeval *, const struct timeval *);
706 extern void tv_sub(struct timeval *, const struct timeval *, const struct timeval *);
707 extern void tv_mul(struct timeval *, const struct timeval *, int);
708 extern void tv_div(struct timeval *, const struct timeval *, int);
711 extern void unwind_init(void);
712 extern void unwind_tcb_init(struct tcb *);
713 extern void unwind_tcb_fin(struct tcb *);
714 extern void unwind_cache_invalidate(struct tcb *);
715 extern void unwind_print_stacktrace(struct tcb *);
716 extern void unwind_capture_stacktrace(struct tcb *);
720 printstrn(struct tcb *tcp, kernel_ulong_t addr, kernel_ulong_t len)
722 return printstr_ex(tcp, addr, len, 0);
726 printstr(struct tcb *tcp, kernel_ulong_t addr)
728 return printstr_ex(tcp, addr, -1, QUOTE_0_TERMINATED);
732 printflags64(const struct xlat *x, uint64_t flags, const char *dflt)
734 return printflags_ex(flags, dflt, x, NULL);
738 printflags(const struct xlat *x, unsigned int flags, const char *dflt)
740 return printflags64(x, flags, dflt);
744 printxval64(const struct xlat *x, const uint64_t val, const char *dflt)
746 return printxvals(val, dflt, x, NULL);
750 printxval(const struct xlat *x, const unsigned int val, const char *dflt)
752 return printxvals(val, dflt, x, NULL);
756 tprint_iov(struct tcb *tcp, kernel_ulong_t len, kernel_ulong_t addr,
757 enum iov_decode decode_iov)
759 tprint_iov_upto(tcp, len, addr, decode_iov, -1);
767 extern void print_timeval32_t(const timeval32_t *);
768 extern void printrusage32(struct tcb *, kernel_ulong_t);
769 extern const char *sprint_timeval32(struct tcb *, kernel_ulong_t addr);
770 extern void print_timeval32(struct tcb *, kernel_ulong_t addr);
771 extern void print_timeval32_utimes(struct tcb *, kernel_ulong_t addr);
772 extern void print_itimerval32(struct tcb *, kernel_ulong_t addr);
775 #ifdef HAVE_STRUCT_USER_DESC
777 * Filter what to print from the point of view of the get_thread_area syscall.
778 * Kernel copies only entry_number field at first and then tries to write the
781 enum user_desc_print_filter {
782 /* Print the "entering" part of struct user_desc - entry_number. */
783 USER_DESC_ENTERING = 1,
784 /* Print the "exiting" part of the structure. */
785 USER_DESC_EXITING = 2,
786 USER_DESC_BOTH = USER_DESC_ENTERING | USER_DESC_EXITING,
789 extern void print_user_desc(struct tcb *, kernel_ulong_t addr,
790 enum user_desc_print_filter filter);
793 /* Strace log generation machinery.
795 * printing_tcp: tcb which has incomplete line being printed right now.
796 * NULL if last line has been completed ('\n'-terminated).
797 * printleader(tcp) examines it, finishes incomplete line if needed,
798 * the sets it to tcp.
799 * line_ended() clears printing_tcp and resets ->curcol = 0.
800 * tcp->curcol == 0 check is also used to detect completeness
801 * of last line, since in -ff mode just checking printing_tcp for NULL
804 * If you change this code, test log generation in both -f and -ff modes
806 * strace -oLOG -f[f] test/threaded_execve
807 * strace -oLOG -f[f] test/sigkill_rain
808 * strace -oLOG -f[f] -p "`pidof web_browser`"
810 extern struct tcb *printing_tcp;
811 extern void printleader(struct tcb *);
812 extern void line_ended(void);
813 extern void tabto(void);
814 extern void tprintf(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2));
815 extern void tprints(const char *str);
816 extern void tprintf_comment(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2));
817 extern void tprints_comment(const char *str);
819 #if SUPPORTED_PERSONALITIES > 1
820 extern void set_personality(unsigned int personality);
821 extern unsigned current_personality;
823 # define set_personality(personality) ((void)0)
824 # define current_personality 0
827 #if SUPPORTED_PERSONALITIES == 1
828 # define current_wordsize PERSONALITY0_WORDSIZE
829 # define current_klongsize PERSONALITY0_KLONGSIZE
831 # if SUPPORTED_PERSONALITIES == 2 && PERSONALITY0_WORDSIZE == PERSONALITY1_WORDSIZE
832 # define current_wordsize PERSONALITY0_WORDSIZE
834 extern unsigned current_wordsize;
836 # if SUPPORTED_PERSONALITIES == 2 && PERSONALITY0_KLONGSIZE == PERSONALITY1_KLONGSIZE
837 # define current_klongsize PERSONALITY0_KLONGSIZE
839 extern unsigned current_klongsize;
843 #if SIZEOF_KERNEL_LONG_T > 4 \
844 && (SIZEOF_LONG < SIZEOF_KERNEL_LONG_T || !defined(current_wordsize))
845 # define ANY_WORDSIZE_LESS_THAN_KERNEL_LONG 1
847 # define ANY_WORDSIZE_LESS_THAN_KERNEL_LONG 0
850 #define DECL_PRINTNUM(name) \
852 printnum_ ## name(struct tcb *, kernel_ulong_t addr, const char *fmt) \
853 ATTRIBUTE_FORMAT((printf, 3, 0)) \
854 /* End of DECL_PRINTNUM definition. */
856 DECL_PRINTNUM(short);
858 DECL_PRINTNUM(int64);
861 #define DECL_PRINTNUM_ADDR(name) \
863 printnum_addr_ ## name(struct tcb *, kernel_ulong_t addr) \
864 /* End of DECL_PRINTNUM_ADDR definition. */
866 DECL_PRINTNUM_ADDR(int);
867 DECL_PRINTNUM_ADDR(int64);
868 #undef DECL_PRINTNUM_ADDR
870 #ifndef current_wordsize
872 printnum_long_int(struct tcb *, kernel_ulong_t addr,
873 const char *fmt_long, const char *fmt_int)
874 ATTRIBUTE_FORMAT((printf, 3, 0))
875 ATTRIBUTE_FORMAT((printf, 4, 0));
876 extern bool printnum_addr_long_int(struct tcb *, kernel_ulong_t addr);
877 # define printnum_slong(tcp, addr) \
878 printnum_long_int((tcp), (addr), "%" PRId64, "%d")
879 # define printnum_ulong(tcp, addr) \
880 printnum_long_int((tcp), (addr), "%" PRIu64, "%u")
881 # define printnum_ptr(tcp, addr) \
882 printnum_addr_long_int((tcp), (addr))
883 #elif current_wordsize > 4
884 # define printnum_slong(tcp, addr) \
885 printnum_int64((tcp), (addr), "%" PRId64)
886 # define printnum_ulong(tcp, addr) \
887 printnum_int64((tcp), (addr), "%" PRIu64)
888 # define printnum_ptr(tcp, addr) \
889 printnum_addr_int64((tcp), (addr))
890 #else /* current_wordsize == 4 */
891 # define printnum_slong(tcp, addr) \
892 printnum_int((tcp), (addr), "%d")
893 # define printnum_ulong(tcp, addr) \
894 printnum_int((tcp), (addr), "%u")
895 # define printnum_ptr(tcp, addr) \
896 printnum_addr_int((tcp), (addr))
899 #ifndef current_klongsize
900 extern bool printnum_addr_klong_int(struct tcb *, kernel_ulong_t addr);
901 # define printnum_kptr(tcp, addr) \
902 printnum_addr_klong_int((tcp), (addr))
903 #elif current_klongsize > 4
904 # define printnum_kptr(tcp, addr) \
905 printnum_addr_int64((tcp), (addr))
906 #else /* current_klongsize == 4 */
907 # define printnum_kptr(tcp, addr) \
908 printnum_addr_int((tcp), (addr))
911 #define DECL_PRINTPAIR(name) \
913 printpair_ ## name(struct tcb *, kernel_ulong_t addr, const char *fmt) \
914 ATTRIBUTE_FORMAT((printf, 3, 0)) \
915 /* End of DECL_PRINTPAIR definition. */
918 DECL_PRINTPAIR(int64);
919 #undef DECL_PRINTPAIR
921 static inline kernel_long_t
922 truncate_klong_to_current_wordsize(const kernel_long_t v)
924 #if ANY_WORDSIZE_LESS_THAN_KERNEL_LONG
925 if (current_wordsize < sizeof(v)) {
934 static inline kernel_ulong_t
935 truncate_kulong_to_current_wordsize(const kernel_ulong_t v)
937 #if ANY_WORDSIZE_LESS_THAN_KERNEL_LONG
938 if (current_wordsize < sizeof(v)) {
939 return (unsigned int) v;
948 * Cast a pointer or a pointer-sized integer to kernel_ulong_t.
950 #define ptr_to_kulong(v) ((kernel_ulong_t) (unsigned long) (v))
953 * Zero-extend a signed integer type to unsigned long long.
955 #define zero_extend_signed_to_ull(v) \
956 (sizeof(v) == sizeof(char) ? (unsigned long long) (unsigned char) (v) : \
957 sizeof(v) == sizeof(short) ? (unsigned long long) (unsigned short) (v) : \
958 sizeof(v) == sizeof(int) ? (unsigned long long) (unsigned int) (v) : \
959 sizeof(v) == sizeof(long) ? (unsigned long long) (unsigned long) (v) : \
960 (unsigned long long) (v))
963 * Sign-extend an unsigned integer type to long long.
965 #define sign_extend_unsigned_to_ll(v) \
966 (sizeof(v) == sizeof(char) ? (long long) (char) (v) : \
967 sizeof(v) == sizeof(short) ? (long long) (short) (v) : \
968 sizeof(v) == sizeof(int) ? (long long) (int) (v) : \
969 sizeof(v) == sizeof(long) ? (long long) (long) (v) : \
972 extern const struct_sysent sysent0[];
973 extern const char *const errnoent0[];
974 extern const char *const signalent0[];
975 extern const struct_ioctlent ioctlent0[];
977 extern const char *const personality_names[];
979 #if SUPPORTED_PERSONALITIES > 1
980 extern const struct_sysent *sysent;
981 extern const char *const *errnoent;
982 extern const char *const *signalent;
983 extern const struct_ioctlent *ioctlent;
985 # define sysent sysent0
986 # define errnoent errnoent0
987 # define signalent signalent0
988 # define ioctlent ioctlent0
991 extern unsigned nsyscalls;
992 extern unsigned nerrnos;
993 extern unsigned nsignals;
994 extern unsigned nioctlents;
996 extern const unsigned int nsyscall_vec[SUPPORTED_PERSONALITIES];
997 extern const struct_sysent *const sysent_vec[SUPPORTED_PERSONALITIES];
998 extern struct inject_opts *inject_vec[SUPPORTED_PERSONALITIES];
1000 #ifdef IN_MPERS_BOOTSTRAP
1001 /* Transform multi-line MPERS_PRINTER_DECL statements to one-liners. */
1002 # define MPERS_PRINTER_DECL(type, name, ...) MPERS_PRINTER_DECL(type, name, __VA_ARGS__)
1003 #else /* !IN_MPERS_BOOTSTRAP */
1004 # if SUPPORTED_PERSONALITIES > 1
1005 # include "printers.h"
1007 # include "native_printer_decls.h"
1009 # define MPERS_PRINTER_DECL(type, name, ...) type MPERS_FUNC_NAME(name)(__VA_ARGS__)
1010 #endif /* !IN_MPERS_BOOTSTRAP */
1012 /* Checks that sysent[scno] is not out of range. */
1014 scno_in_range(kernel_ulong_t scno)
1016 return scno < nsyscalls;
1020 * Checks whether scno is not out of range,
1021 * its corresponding sysent[scno].sys_func is non-NULL,
1022 * and its sysent[scno].sys_flags has no TRACE_INDIRECT_SUBCALL flag set.
1025 scno_is_valid(kernel_ulong_t scno)
1027 return scno_in_range(scno)
1028 && sysent[scno].sys_func
1029 && !(sysent[scno].sys_flags & TRACE_INDIRECT_SUBCALL);
1032 #define MPERS_FUNC_NAME__(prefix, name) prefix ## name
1033 #define MPERS_FUNC_NAME_(prefix, name) MPERS_FUNC_NAME__(prefix, name)
1034 #define MPERS_FUNC_NAME(name) MPERS_FUNC_NAME_(MPERS_PREFIX, name)
1036 #define SYS_FUNC_NAME(syscall_name) MPERS_FUNC_NAME(syscall_name)
1038 #define SYS_FUNC(syscall_name) int SYS_FUNC_NAME(sys_ ## syscall_name)(struct tcb *tcp)
1040 #endif /* !STRACE_DEFS_H */