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-2018 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"
67 const char *strerror(int);
70 /* Some libc have stpcpy, some don't. Sigh...
71 * Roll our private implementation...
74 #define stpcpy strace_stpcpy
75 extern char *stpcpy(char *dst, const char *src);
78 /* Glibc has an efficient macro for sigemptyset
79 * (it just does one or two assignments of 0 to internal vector of longs).
81 #if defined(__GLIBC__) && defined(__sigemptyset) && !defined(sigemptyset)
82 # define sigemptyset __sigemptyset
85 /* Configuration section */
86 #ifndef DEFAULT_STRLEN
87 /* default maximum # of bytes printed in `printstr', change with -s switch */
88 # define DEFAULT_STRLEN 32
90 #ifndef DEFAULT_ACOLUMN
91 # define DEFAULT_ACOLUMN 40 /* default alignment column for results */
94 * Maximum number of args to a syscall.
96 * Make sure that all entries in all syscallent.h files have nargs <= MAX_ARGS!
97 * linux/<ARCH>/syscallent*.h:
98 * all have nargs <= 6 except mips o32 which has nargs <= 7.
101 # ifdef LINUX_MIPSO32
107 /* default sorting method for call profiling */
108 #ifndef DEFAULT_SORTBY
109 # define DEFAULT_SORTBY "time"
112 /* To force NOMMU build, set to 1 */
113 #define NOMMU_SYSTEM 0
116 # define ERESTARTSYS 512
118 #ifndef ERESTARTNOINTR
119 # define ERESTARTNOINTR 513
121 #ifndef ERESTARTNOHAND
122 # define ERESTARTNOHAND 514
124 #ifndef ERESTART_RESTARTBLOCK
125 # define ERESTART_RESTARTBLOCK 516
128 #define PERSONALITY0_WORDSIZE SIZEOF_LONG
129 #define PERSONALITY0_KLONGSIZE SIZEOF_KERNEL_LONG_T
130 #define PERSONALITY0_INCLUDE_PRINTERS_DECLS "native_printer_decls.h"
131 #define PERSONALITY0_INCLUDE_PRINTERS_DEFS "native_printer_defs.h"
133 #if SUPPORTED_PERSONALITIES > 1
134 # define PERSONALITY1_WORDSIZE 4
135 # define PERSONALITY1_KLONGSIZE PERSONALITY1_WORDSIZE
138 #if SUPPORTED_PERSONALITIES > 2
139 # define PERSONALITY2_WORDSIZE 4
140 # define PERSONALITY2_KLONGSIZE PERSONALITY0_KLONGSIZE
143 #if SUPPORTED_PERSONALITIES > 1 && defined HAVE_M32_MPERS
144 # define PERSONALITY1_INCLUDE_PRINTERS_DECLS "m32_printer_decls.h"
145 # define PERSONALITY1_INCLUDE_PRINTERS_DEFS "m32_printer_defs.h"
146 # define PERSONALITY1_INCLUDE_FUNCS "m32_funcs.h"
147 # define MPERS_m32_IOCTL_MACROS "ioctl_redefs1.h"
148 # define HAVE_PERSONALITY_1_MPERS 1
150 # define PERSONALITY1_INCLUDE_PRINTERS_DECLS "native_printer_decls.h"
151 # define PERSONALITY1_INCLUDE_PRINTERS_DEFS "native_printer_defs.h"
152 # define PERSONALITY1_INCLUDE_FUNCS "empty.h"
153 # define HAVE_PERSONALITY_1_MPERS 0
156 #if SUPPORTED_PERSONALITIES > 2 && defined HAVE_MX32_MPERS
157 # define PERSONALITY2_INCLUDE_FUNCS "mx32_funcs.h"
158 # define PERSONALITY2_INCLUDE_PRINTERS_DECLS "mx32_printer_decls.h"
159 # define PERSONALITY2_INCLUDE_PRINTERS_DEFS "mx32_printer_defs.h"
160 # define MPERS_mx32_IOCTL_MACROS "ioctl_redefs2.h"
161 # define HAVE_PERSONALITY_2_MPERS 1
163 # define PERSONALITY2_INCLUDE_PRINTERS_DECLS "native_printer_decls.h"
164 # define PERSONALITY2_INCLUDE_PRINTERS_DEFS "native_printer_defs.h"
165 # define PERSONALITY2_INCLUDE_FUNCS "empty.h"
166 # define HAVE_PERSONALITY_2_MPERS 0
169 typedef struct ioctlent {
174 #define INJECT_F_SIGNAL 0x01
175 #define INJECT_F_ERROR 0x02
176 #define INJECT_F_RETVAL 0x04
177 #define INJECT_F_DELAY_ENTER 0x08
178 #define INJECT_F_DELAY_EXIT 0x10
181 uint8_t flags; /* 5 of 8 flags are used so far */
182 uint8_t signo; /* NSIG <= 128 */
183 uint16_t rval_idx; /* index in retval_vec */
184 uint16_t delay_idx; /* index in delay_data_vec */
190 struct inject_data data;
193 #define MAX_ERRNO_VALUE 4095
195 /* Trace Control Block */
197 int flags; /* See below for TCB_ values */
198 int pid; /* If 0, this tcb is free */
199 int qual_flg; /* qual_flags[scno] or DEFAULT_QUAL_FLAGS + RAW */
200 unsigned long u_error; /* Error code */
201 kernel_ulong_t scno; /* System call number */
202 kernel_ulong_t u_arg[MAX_ARGS]; /* System call arguments */
203 kernel_long_t u_rval; /* Return value */
204 #if SUPPORTED_PERSONALITIES > 1
205 unsigned int currpers; /* Personality at the time of scno update */
207 int sys_func_rval; /* Syscall entry parser's return value */
208 int curcol; /* Output column for this process */
209 FILE *outf; /* Output file for this process */
210 const char *auxstr; /* Auxiliary info from syscall (see RVAL_STR) */
211 void *_priv_data; /* Private data for syscall decoding functions */
212 void (*_free_priv_data)(void *); /* Callback for freeing priv_data */
213 const struct_sysent *s_ent; /* sysent[scno] or dummy struct for bad scno */
214 const struct_sysent *s_prev_ent; /* for "resuming interrupted SYSCALL" msg */
215 struct inject_opts *inject_vec[SUPPORTED_PERSONALITIES];
216 struct timespec stime; /* System time usage as of last process wait */
217 struct timespec dtime; /* Delta for system time usage */
218 struct timespec etime; /* Syscall entry time */
219 struct timespec delay_expiration_time; /* When does the delay end */
221 struct mmap_cache_t *mmap_cache;
222 unsigned int mmap_cache_size;
223 unsigned int mmap_cache_generation;
225 #ifdef ENABLE_STACKTRACE
227 struct unwind_queue_t *unwind_queue;
232 /* We have attached to this process, but did not see it stopping yet */
233 #define TCB_STARTUP 0x01
234 #define TCB_IGNORE_ONE_SIGSTOP 0x02 /* Next SIGSTOP is to be ignored */
236 * Are we in system call entry or in syscall exit?
238 * This bit is set in syscall_entering_finish() and cleared in
239 * syscall_exiting_finish().
240 * Other stops which are possible directly after syscall entry (death, ptrace
241 * event stop) are handled without calling syscall_{entering,exiting}_*().
243 * Use entering(tcp) / exiting(tcp) to check this bit to make code more
246 #define TCB_INSYSCALL 0x04
247 #define TCB_ATTACHED 0x08 /* We attached to it already */
248 #define TCB_REPRINT 0x10 /* We should reprint this syscall on exit */
249 #define TCB_FILTERED 0x20 /* This system call has been filtered out */
250 #define TCB_TAMPERED 0x40 /* A syscall has been tampered with */
251 #define TCB_HIDE_LOG 0x80 /* We should hide everything (until execve) */
252 #define TCB_SKIP_DETACH_ON_FIRST_EXEC 0x100 /* -b execve should skip detach on first execve */
253 #define TCB_GRABBED 0x200 /* We grab the process and can catch it
254 * in the middle of a syscall */
255 #define TCB_RECOVERING 0x400 /* We try to recover after detecting incorrect
256 * syscall entering/exiting state */
257 #define TCB_INJECT_DELAY_EXIT 0x800 /* Current syscall needs to be delayed
259 #define TCB_DELAYED 0x1000 /* Current syscall has been delayed */
261 /* qualifier flags */
262 #define QUAL_TRACE 0x001 /* this system call should be traced */
263 #define QUAL_ABBREV 0x002 /* abbreviate the structures of this syscall */
264 #define QUAL_VERBOSE 0x004 /* decode the structures of this syscall */
265 #define QUAL_RAW 0x008 /* print all args in hex for this syscall */
266 #define QUAL_INJECT 0x010 /* tamper with this system call on purpose */
268 #define DEFAULT_QUAL_FLAGS (QUAL_TRACE | QUAL_ABBREV | QUAL_VERBOSE)
270 #define entering(tcp) (!((tcp)->flags & TCB_INSYSCALL))
271 #define exiting(tcp) ((tcp)->flags & TCB_INSYSCALL)
272 #define syserror(tcp) ((tcp)->u_error != 0)
273 #define traced(tcp) ((tcp)->qual_flg & QUAL_TRACE)
274 #define verbose(tcp) ((tcp)->qual_flg & QUAL_VERBOSE)
275 #define abbrev(tcp) ((tcp)->qual_flg & QUAL_ABBREV)
276 #define raw(tcp) ((tcp)->qual_flg & QUAL_RAW)
277 #define inject(tcp) ((tcp)->qual_flg & QUAL_INJECT)
278 #define filtered(tcp) ((tcp)->flags & TCB_FILTERED)
279 #define hide_log(tcp) ((tcp)->flags & TCB_HIDE_LOG)
280 #define syscall_tampered(tcp) ((tcp)->flags & TCB_TAMPERED)
281 #define recovering(tcp) ((tcp)->flags & TCB_RECOVERING)
282 #define inject_delay_exit(tcp) ((tcp)->flags & TCB_INJECT_DELAY_EXIT)
283 #define syscall_delayed(tcp) ((tcp)->flags & TCB_DELAYED)
287 extern const struct xlat addrfams[];
288 extern const struct xlat arp_hardware_types[];
289 extern const struct xlat at_flags[];
290 extern const struct xlat clocknames[];
291 extern const struct xlat dirent_types[];
293 /** Ethernet protocols list, sorted and unterminated, defined in sockaddr.c. */
294 extern const struct xlat ethernet_protocols[];
295 /** Ethernet protocols array size without terminating record. */
296 extern const size_t ethernet_protocols_size;
298 extern const struct xlat evdev_abs[];
299 extern const struct xlat iffflags[];
300 extern const struct xlat inet_protocols[];
301 extern const struct xlat ip_type_of_services[];
302 extern const struct xlat ipc_private[];
303 extern const struct xlat msg_flags[];
304 extern const struct xlat netlink_protocols[];
305 extern const struct xlat nl_netfilter_msg_types[];
306 extern const struct xlat nl_route_types[];
307 extern const struct xlat open_access_modes[];
308 extern const struct xlat open_mode_flags[];
309 extern const struct xlat resource_flags[];
310 extern const struct xlat routing_scopes[];
311 extern const struct xlat routing_table_ids[];
312 extern const struct xlat routing_types[];
313 extern const struct xlat seccomp_filter_flags[];
314 extern const struct xlat seccomp_ret_action[];
315 extern const struct xlat setns_types[];
316 extern const struct xlat sg_io_info[];
317 extern const struct xlat socketlayers[];
318 extern const struct xlat socktypes[];
319 extern const struct xlat tcp_state_flags[];
320 extern const struct xlat tcp_states[];
321 extern const struct xlat whence_codes[];
323 /* Format of syscall return values */
324 #define RVAL_UDECIMAL 000 /* unsigned decimal format */
325 #define RVAL_HEX 001 /* hex format */
326 #define RVAL_OCTAL 002 /* octal format */
327 #define RVAL_FD 010 /* file descriptor */
328 #define RVAL_MASK 013 /* mask for these values */
330 #define RVAL_STR 020 /* Print `auxstr' field after return val */
331 #define RVAL_NONE 040 /* Print nothing */
333 #define RVAL_DECODED 0100 /* syscall decoding finished */
334 #define RVAL_IOCTL_DECODED 0200 /* ioctl sub-parser successfully decoded
337 #define IOCTL_NUMBER_UNKNOWN 0
338 #define IOCTL_NUMBER_HANDLED 1
339 #define IOCTL_NUMBER_STOP_LOOKUP 010
341 #define indirect_ipccall(tcp) (tcp->s_ent->sys_flags & TRACE_INDIRECT_SUBCALL)
352 extern enum sock_proto get_proto_by_name(const char *);
365 extern cflag_t cflag;
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;
378 #define tracing_paths (global_path_set.num_selected != 0)
379 extern unsigned xflag;
380 extern unsigned followfork;
381 #ifdef ENABLE_STACKTRACE
382 /* if this is true do the stack trace for every system call */
383 extern bool stack_trace_enabled;
385 extern unsigned ptrace_setoptions;
386 extern unsigned max_strlen;
387 extern unsigned os_release;
388 #undef KERNEL_VERSION
389 #define KERNEL_VERSION(a, b, c) (((a) << 16) + ((b) << 8) + (c))
391 extern int read_int_from_file(struct tcb *, const char *, int *);
393 extern void set_sortby(const char *);
394 extern void set_overhead(int);
395 extern void print_pc(struct tcb *);
397 extern int syscall_entering_decode(struct tcb *);
398 extern int syscall_entering_trace(struct tcb *, unsigned int *);
399 extern void syscall_entering_finish(struct tcb *, int);
401 extern int syscall_exiting_decode(struct tcb *, struct timespec *);
402 extern int syscall_exiting_trace(struct tcb *, struct timespec *, int);
403 extern void syscall_exiting_finish(struct tcb *);
405 extern void count_syscall(struct tcb *, const struct timespec *);
406 extern void call_summary(FILE *);
408 extern void clear_regs(struct tcb *tcp);
409 extern int get_scno(struct tcb *);
410 extern kernel_ulong_t get_rt_sigframe_addr(struct tcb *);
413 * Convert a (shuffled) syscall number to the corresponding syscall name.
415 * @param scno Syscall number.
416 * @return String literal corresponding to the syscall number in case latter
417 * is valid; NULL otherwise.
419 extern const char *syscall_name(kernel_ulong_t scno);
421 * Convert a syscall name to the corresponding (shuffled) syscall number.
423 * @param s Syscall name.
424 * @param p Personality.
425 * @param start From which position in syscall entry table resume the search.
426 * @return Shuffled syscall number (ready to use against sysent_vec)
427 * if syscall name is found; -1 otherwise.
429 extern kernel_long_t scno_by_name(const char *s, unsigned p,
430 kernel_long_t start);
432 * Shuffle syscall numbers so that we don't have huge gaps in syscall table.
433 * The shuffling should be an involution: shuffle_scno(shuffle_scno(n)) == n.
435 * @param scno Raw or shuffled syscall number.
436 * @return Shuffled or raw syscall number, respectively.
438 extern kernel_ulong_t shuffle_scno(kernel_ulong_t scno);
439 extern const char *err_name(unsigned long err);
441 extern bool is_erestart(struct tcb *);
442 extern void temporarily_clear_syserror(struct tcb *);
443 extern void restore_cleared_syserror(struct tcb *);
445 extern void *get_tcb_priv_data(const struct tcb *);
446 extern int set_tcb_priv_data(struct tcb *, void *priv_data,
447 void (*free_priv_data)(void *));
448 extern void free_tcb_priv_data(struct tcb *);
450 static inline unsigned long get_tcb_priv_ulong(const struct tcb *tcp)
452 return (unsigned long) get_tcb_priv_data(tcp);
455 static inline int set_tcb_priv_ulong(struct tcb *tcp, unsigned long val)
457 return set_tcb_priv_data(tcp, (void *) val, 0);
461 umoven(struct tcb *, kernel_ulong_t addr, unsigned int len, void *laddr);
462 #define umove(pid, addr, objp) \
463 umoven((pid), (addr), sizeof(*(objp)), (void *) (objp))
466 umoven_or_printaddr64(struct tcb *, uint64_t addr,
467 unsigned int len, void *laddr);
468 #define umove_or_printaddr64(pid, addr, objp) \
469 umoven_or_printaddr64((pid), (addr), sizeof(*(objp)), (void *) (objp))
472 umoven_or_printaddr(struct tcb *tcp, const kernel_ulong_t addr,
473 unsigned int len, void *laddr)
475 return umoven_or_printaddr64(tcp, addr, len, laddr);
477 #define umove_or_printaddr(pid, addr, objp) \
478 umoven_or_printaddr((pid), (addr), sizeof(*(objp)), (void *) (objp))
481 umoven_or_printaddr64_ignore_syserror(struct tcb *, uint64_t addr,
482 unsigned int len, void *laddr);
485 umoven_or_printaddr_ignore_syserror(struct tcb *tcp, const kernel_ulong_t addr,
486 unsigned int len, void *laddr)
488 return umoven_or_printaddr64_ignore_syserror(tcp, addr, len, laddr);
492 umovestr(struct tcb *, kernel_ulong_t addr, unsigned int len, char *laddr);
494 extern int upeek(struct tcb *tcp, unsigned long, kernel_ulong_t *);
495 extern int upoke(struct tcb *tcp, unsigned long, kernel_ulong_t);
497 extern bool print_uint64_array_member(struct tcb *tcp, void *elem_buf,
498 size_t elem_size, void *data);
500 print_array(struct tcb *,
501 kernel_ulong_t start_addr,
505 int (*umoven_func)(struct tcb *,
509 bool (*print_func)(struct tcb *,
515 #if HAVE_ARCH_GETRVAL2
516 extern long getrval2(struct tcb *);
519 extern const char *signame(const int);
520 extern void pathtrace_select_set(const char *, struct path_set *);
521 extern bool pathtrace_match_set(struct tcb *, struct path_set *);
522 #define pathtrace_select(tcp) \
523 pathtrace_select_set(tcp, &global_path_set)
524 #define pathtrace_match(tcp) \
525 pathtrace_match_set(tcp, &global_path_set)
526 extern int getfdpath(struct tcb *, int, char *, unsigned);
527 extern unsigned long getfdinode(struct tcb *, int);
528 extern enum sock_proto getfdproto(struct tcb *, int);
530 extern const char *xlookup(const struct xlat *, const uint64_t);
531 extern const char *xlat_search(const struct xlat *, const size_t, const uint64_t);
534 struct dyxlat *dyxlat_alloc(size_t nmemb);
535 void dyxlat_free(struct dyxlat *);
536 const struct xlat *dyxlat_get(const struct dyxlat *);
537 void dyxlat_add_pair(struct dyxlat *, uint64_t val, const char *str, size_t len);
539 const struct xlat *genl_families_xlat(struct tcb *tcp);
541 extern unsigned long get_pagesize(void);
542 extern int next_set_bit(const void *bit_array, unsigned cur_bit, unsigned size_bits);
545 * Returns STR if it does not start with PREFIX,
546 * or a pointer to the first char in STR after PREFIX.
547 * The length of PREFIX is specified by PREFIX_LEN.
549 static inline const char *
550 str_strip_prefix_len(const char *str, const char *prefix, size_t prefix_len)
552 return strncmp(str, prefix, prefix_len) ? str : str + prefix_len;
555 #define STR_STRIP_PREFIX(str, prefix) \
556 str_strip_prefix_len((str), (prefix), sizeof(prefix) - 1)
558 #define QUOTE_0_TERMINATED 0x01
559 #define QUOTE_OMIT_LEADING_TRAILING_QUOTES 0x02
560 #define QUOTE_OMIT_TRAILING_0 0x08
561 #define QUOTE_FORCE_HEX 0x10
562 #define QUOTE_EMIT_COMMENT 0x20
564 extern int string_quote(const char *, char *, unsigned int, unsigned int,
565 const char *escape_chars);
566 extern int print_quoted_string_ex(const char *, unsigned int, unsigned int,
567 const char *escape_chars);
568 extern int print_quoted_string(const char *, unsigned int, unsigned int);
569 extern int print_quoted_cstring(const char *, unsigned int);
571 /* a refers to the lower numbered u_arg,
572 * b refers to the higher numbered u_arg
574 #ifdef WORDS_BIGENDIAN
575 # define ULONG_LONG(a, b) \
576 ((unsigned long long)(unsigned)(b) | ((unsigned long long)(a)<<32))
578 # define ULONG_LONG(a, b) \
579 ((unsigned long long)(unsigned)(a) | ((unsigned long long)(b)<<32))
581 extern int getllval(struct tcb *, unsigned long long *, int);
582 extern int printllval(struct tcb *, const char *, int)
583 ATTRIBUTE_FORMAT((printf, 2, 0));
585 extern void printaddr64(uint64_t addr);
586 extern void printaddr(kernel_ulong_t addr);
588 #define XLAT_STYLE_VERBOSITY_MASK (XLAT_STYLE_RAW | XLAT_STYLE_ABBREV)
589 #define XLAT_STYLE_FORMAT_SHIFT 2
590 #define XLAT_STYLE_FORMAT_MASK (1 << XLAT_STYLE_FORMAT_SHIFT)
594 * Special value that is used for passing to *print{xval,flags}*_ex
595 * routines that indicates that no overriding of user-supplied xlat
596 * verbosity/formatting configuration is intended.
598 XLAT_STYLE_DEFAULT = 0,
600 /** Print xlat value as is without xlat processing */
601 XLAT_STYLE_RAW = 1 << 0,
603 * Historic strace style, process xlat and print the result (xlat
604 * constant name/combination of flags), raw number only if nothing is
607 XLAT_STYLE_ABBREV = 1 << 1,
608 /** Always print both raw number and xlat processing result. */
609 XLAT_STYLE_VERBOSE = XLAT_STYLE_RAW | XLAT_STYLE_ABBREV,
611 XLAT_STYLE_FMT_X = 0 << XLAT_STYLE_FORMAT_SHIFT,
612 XLAT_STYLE_FMT_U = 1 << XLAT_STYLE_FORMAT_SHIFT,
615 extern enum xlat_style xlat_verbosity;
617 extern int printxvals_ex(uint64_t val, const char *dflt,
618 enum xlat_style style, const struct xlat *, ...)
620 #define printxvals(val_, dflt_, ...) \
621 printxvals_ex((val_), (dflt_), XLAT_STYLE_DEFAULT, __VA_ARGS__)
622 extern int printxval_searchn_ex(const struct xlat *xlat, size_t xlat_size,
623 uint64_t val, const char *dflt,
624 enum xlat_style style);
625 #define printxval_searchn(xlat_, xlat_size_, val_, dflt_) \
626 printxval_searchn_ex((xlat_), (xlat_size_), (val_), (dflt_), \
629 * Wrapper around printxval_searchn that passes ARRAY_SIZE - 1
630 * as the array size, as all arrays are XLAT_END-terminated and
631 * printxval_searchn expects a size without the terminating record.
633 #define printxval_search(xlat__, val__, dflt__) \
634 printxval_searchn(xlat__, ARRAY_SIZE(xlat__) - 1, val__, dflt__)
635 #define printxval_search_ex(xlat__, val__, dflt__) \
636 printxval_searchn_ex((xlat__), ARRAY_SIZE(xlat__) - 1, (val__), \
637 (dflt__), XLAT_STYLE_DEFAULT)
638 extern int sprintxval_ex(char *buf, size_t size, const struct xlat *xlat,
639 unsigned int val, const char *dflt,
640 enum xlat_style style);
641 #define sprintxval(buf_, size_, xlat_, val_, dflt_) \
642 sprintxval_ex((buf_), (size_), (xlat_), (val_), (dflt_), \
644 /** Print a value in accordance with xlat formatting settings. */
645 extern void print_xlat_ex(uint64_t val, const char *str, enum xlat_style style);
646 #define print_xlat(val_) \
647 print_xlat_ex((val_), #val_, XLAT_STYLE_DEFAULT)
649 extern int printargs(struct tcb *);
650 extern int printargs_u(struct tcb *);
651 extern int printargs_d(struct tcb *);
653 extern int printflags_ex(uint64_t flags, const char *dflt,
654 enum xlat_style style, const struct xlat *, ...)
656 extern const char *sprintflags_ex(const char *prefix, const struct xlat *xlat,
657 uint64_t flags, enum xlat_style style);
658 #define sprintflags(prefix_, xlat_, flags_) \
659 sprintflags_ex((prefix_), (xlat_), (flags_), XLAT_STYLE_DEFAULT)
660 extern const char *sprinttime(long long sec);
661 extern const char *sprinttime_nsec(long long sec, unsigned long long nsec);
662 extern const char *sprinttime_usec(long long sec, unsigned long long usec);
663 extern void print_symbolic_mode_t(unsigned int);
664 extern void print_numeric_umode_t(unsigned short);
665 extern void print_numeric_long_umask(unsigned long);
666 extern void print_dev_t(unsigned long long dev);
667 extern void print_abnormal_hi(kernel_ulong_t);
669 extern kernel_ulong_t *
670 fetch_indirect_syscall_args(struct tcb *, kernel_ulong_t addr, unsigned int n_args);
673 dumpiov_in_msghdr(struct tcb *, kernel_ulong_t addr, kernel_ulong_t data_size);
676 dumpiov_in_mmsghdr(struct tcb *, kernel_ulong_t addr);
679 dumpiov_upto(struct tcb *, int len, kernel_ulong_t addr, kernel_ulong_t data_size);
682 dumpstr(struct tcb *, kernel_ulong_t addr, int len);
685 printstr_ex(struct tcb *, kernel_ulong_t addr, kernel_ulong_t len,
686 unsigned int user_style);
689 printpathn(struct tcb *, kernel_ulong_t addr, unsigned int n);
692 printpath(struct tcb *, kernel_ulong_t addr);
694 #define TIMESPEC_TEXT_BUFSIZE \
695 (sizeof(long long) * 3 * 2 + sizeof("{tv_sec=-, tv_nsec=}"))
696 extern void printfd(struct tcb *, int);
697 extern void print_sockaddr(const void *sa, int len);
699 print_inet_addr(int af, const void *addr, unsigned int len, const char *var_name);
701 decode_inet_addr(struct tcb *, kernel_ulong_t addr,
702 unsigned int len, int family, const char *var_name);
703 extern const char *get_sockaddr_by_inode(struct tcb *, int fd, unsigned long inode);
704 extern bool print_sockaddr_by_inode(struct tcb *, int fd, unsigned long inode);
705 extern void print_dirfd(struct tcb *, int);
708 decode_sockaddr(struct tcb *, kernel_ulong_t addr, int addrlen);
710 extern void printuid(const char *, const unsigned int);
713 print_sigset_addr_len(struct tcb *, kernel_ulong_t addr, kernel_ulong_t len);
715 print_sigset_addr(struct tcb *, kernel_ulong_t addr);
717 extern const char *sprintsigmask_n(const char *, const void *, unsigned int);
718 #define tprintsigmask_addr(prefix, mask) \
719 tprints(sprintsigmask_n((prefix), (mask), sizeof(mask)))
720 extern void printsignal(int);
723 tprint_iov_upto(struct tcb *, kernel_ulong_t len, kernel_ulong_t addr,
724 enum iov_decode, kernel_ulong_t data_size);
727 decode_netlink(struct tcb *, int fd, kernel_ulong_t addr, kernel_ulong_t len);
729 extern void tprint_open_modes(unsigned int);
730 extern const char *sprint_open_modes(unsigned int);
733 decode_seccomp_fprog(struct tcb *, kernel_ulong_t addr);
736 print_seccomp_fprog(struct tcb *, kernel_ulong_t addr, unsigned short len);
739 decode_sock_fprog(struct tcb *, kernel_ulong_t addr);
742 print_sock_fprog(struct tcb *, kernel_ulong_t addr, unsigned short len);
745 extern void print_struct_stat(struct tcb *, const struct strace_stat *const st);
747 struct strace_statfs;
748 struct strace_keyctl_kdf_params;
751 print_struct_statfs(struct tcb *, kernel_ulong_t addr);
754 print_struct_statfs64(struct tcb *, kernel_ulong_t addr, kernel_ulong_t size);
756 extern void print_ifindex(unsigned int);
758 extern void print_bpf_filter_code(const uint16_t code, bool extended);
760 extern void qualify(const char *);
761 extern unsigned int qual_flags(const unsigned int);
763 #define DECL_IOCTL(name) \
765 name ## _ioctl(struct tcb *, unsigned int request, kernel_ulong_t arg) \
766 /* End of DECL_IOCTL definition. */
781 extern int decode_sg_io_v4(struct tcb *, const kernel_ulong_t arg);
782 extern void print_evdev_ff_type(const kernel_ulong_t val);
786 typedef bool (*netlink_decoder_t)(struct tcb *, const struct nlmsghdr *,
787 kernel_ulong_t addr, unsigned int len);
789 #define DECL_NETLINK(name) \
791 decode_netlink_ ## name(struct tcb *, const struct nlmsghdr *, \
792 kernel_ulong_t addr, unsigned int len) \
793 /* End of DECL_NETLINK definition. */
795 DECL_NETLINK(crypto);
796 DECL_NETLINK(netfilter);
798 DECL_NETLINK(selinux);
799 DECL_NETLINK(sock_diag);
802 decode_netlink_kobject_uevent(struct tcb *, kernel_ulong_t addr,
805 extern int ts_nz(const struct timespec *);
806 extern int ts_cmp(const struct timespec *, const struct timespec *);
807 extern double ts_float(const struct timespec *);
808 extern void ts_add(struct timespec *, const struct timespec *, const struct timespec *);
809 extern void ts_sub(struct timespec *, const struct timespec *, const struct timespec *);
810 extern void ts_mul(struct timespec *, const struct timespec *, int);
811 extern void ts_div(struct timespec *, const struct timespec *, int);
813 #ifdef ENABLE_STACKTRACE
814 extern void unwind_init(void);
815 extern void unwind_tcb_init(struct tcb *);
816 extern void unwind_tcb_fin(struct tcb *);
817 extern void unwind_tcb_print(struct tcb *);
818 extern void unwind_tcb_capture(struct tcb *);
822 printstrn(struct tcb *tcp, kernel_ulong_t addr, kernel_ulong_t len)
824 return printstr_ex(tcp, addr, len, 0);
828 printstr(struct tcb *tcp, kernel_ulong_t addr)
830 return printstr_ex(tcp, addr, -1, QUOTE_0_TERMINATED);
834 printflags64(const struct xlat *x, uint64_t flags, const char *dflt)
836 return printflags_ex(flags, dflt, XLAT_STYLE_DEFAULT, x, NULL);
840 printflags(const struct xlat *x, unsigned int flags, const char *dflt)
842 return printflags64(x, flags, dflt);
846 printxval64(const struct xlat *x, const uint64_t val, const char *dflt)
848 return printxvals(val, dflt, x, NULL);
852 printxval(const struct xlat *x, const unsigned int val, const char *dflt)
854 return printxvals(val, dflt, x, NULL);
858 printxval64_u(const struct xlat *x, const uint64_t val, const char *dflt)
860 return printxvals_ex(val, dflt, XLAT_STYLE_FMT_U, x, NULL);
864 printxval_u(const struct xlat *x, const unsigned int val, const char *dflt)
866 return printxvals_ex(val, dflt, XLAT_STYLE_FMT_U, x, NULL);
870 tprint_iov(struct tcb *tcp, kernel_ulong_t len, kernel_ulong_t addr,
871 enum iov_decode decode_iov)
873 tprint_iov_upto(tcp, len, addr, decode_iov, -1);
881 extern void print_timeval32_t(const timeval32_t *);
882 extern void printrusage32(struct tcb *, kernel_ulong_t);
883 extern const char *sprint_timeval32(struct tcb *, kernel_ulong_t addr);
884 extern void print_timeval32(struct tcb *, kernel_ulong_t addr);
885 extern void print_timeval32_utimes(struct tcb *, kernel_ulong_t addr);
886 extern void print_itimerval32(struct tcb *, kernel_ulong_t addr);
889 #ifdef HAVE_STRUCT_USER_DESC
891 * Filter what to print from the point of view of the get_thread_area syscall.
892 * Kernel copies only entry_number field at first and then tries to write the
895 enum user_desc_print_filter {
896 /* Print the "entering" part of struct user_desc - entry_number. */
897 USER_DESC_ENTERING = 1,
898 /* Print the "exiting" part of the structure. */
899 USER_DESC_EXITING = 2,
900 USER_DESC_BOTH = USER_DESC_ENTERING | USER_DESC_EXITING,
903 extern void print_user_desc(struct tcb *, kernel_ulong_t addr,
904 enum user_desc_print_filter filter);
907 /* Strace log generation machinery.
909 * printing_tcp: tcb which has incomplete line being printed right now.
910 * NULL if last line has been completed ('\n'-terminated).
911 * printleader(tcp) examines it, finishes incomplete line if needed,
912 * the sets it to tcp.
913 * line_ended() clears printing_tcp and resets ->curcol = 0.
914 * tcp->curcol == 0 check is also used to detect completeness
915 * of last line, since in -ff mode just checking printing_tcp for NULL
918 * If you change this code, test log generation in both -f and -ff modes
920 * strace -oLOG -f[f] test/threaded_execve
921 * strace -oLOG -f[f] test/sigkill_rain
922 * strace -oLOG -f[f] -p "`pidof web_browser`"
924 extern struct tcb *printing_tcp;
925 extern void printleader(struct tcb *);
926 extern void line_ended(void);
927 extern void tabto(void);
928 extern void tprintf(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2));
929 extern void tprints(const char *str);
930 extern void tprintf_comment(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2));
931 extern void tprints_comment(const char *str);
933 #if SUPPORTED_PERSONALITIES > 1
934 extern void set_personality(unsigned int personality);
935 extern unsigned current_personality;
937 # define set_personality(personality) ((void)0)
938 # define current_personality 0
941 #if SUPPORTED_PERSONALITIES == 1
942 # define current_wordsize PERSONALITY0_WORDSIZE
943 # define current_klongsize PERSONALITY0_KLONGSIZE
945 # if SUPPORTED_PERSONALITIES == 2 && PERSONALITY0_WORDSIZE == PERSONALITY1_WORDSIZE
946 # define current_wordsize PERSONALITY0_WORDSIZE
948 extern unsigned current_wordsize;
950 # if SUPPORTED_PERSONALITIES == 2 && PERSONALITY0_KLONGSIZE == PERSONALITY1_KLONGSIZE
951 # define current_klongsize PERSONALITY0_KLONGSIZE
953 extern unsigned current_klongsize;
957 #define max_addr() (~0ULL >> ((8 - current_wordsize) * 8))
958 #define max_kaddr() (~0ULL >> ((8 - current_klongsize) * 8))
961 * When u64 is interpreted by the kernel as an address, there is a difference
962 * in behaviour between 32-bit and 64-bit kernel in the way u64_to_user_ptr
963 * works (32-bit kernel trims higher bits during conversion which may result
964 * to a valid address). Since 32-bit strace cannot figure out what kind of
965 * kernel the tracee is running on, it has to account for both possibilities.
967 #if CAN_ARCH_BE_COMPAT_ON_64BIT_KERNEL
970 * Print raw 64-bit value as an address if it's too big to fit in strace's
974 print_big_u64_addr(const uint64_t addr)
976 if (sizeof(kernel_long_t) < 8 && addr > max_kaddr()) {
981 #else /* !CAN_ARCH_BE_COMPAT_ON_64BIT_KERNEL */
982 # define print_big_u64_addr(addr_) ((void) 0)
983 #endif /* CAN_ARCH_BE_COMPAT_ON_64BIT_KERNEL */
985 #if SIZEOF_KERNEL_LONG_T > 4 \
986 && (SIZEOF_LONG < SIZEOF_KERNEL_LONG_T || !defined(current_wordsize))
987 # define ANY_WORDSIZE_LESS_THAN_KERNEL_LONG 1
989 # define ANY_WORDSIZE_LESS_THAN_KERNEL_LONG 0
992 #define DECL_PRINTNUM(name) \
994 printnum_ ## name(struct tcb *, kernel_ulong_t addr, const char *fmt) \
995 ATTRIBUTE_FORMAT((printf, 3, 0)) \
996 /* End of DECL_PRINTNUM definition. */
998 DECL_PRINTNUM(short);
1000 DECL_PRINTNUM(int64);
1001 #undef DECL_PRINTNUM
1003 #define DECL_PRINTNUM_ADDR(name) \
1005 printnum_addr_ ## name(struct tcb *, kernel_ulong_t addr) \
1006 /* End of DECL_PRINTNUM_ADDR definition. */
1008 DECL_PRINTNUM_ADDR(int);
1009 DECL_PRINTNUM_ADDR(int64);
1010 #undef DECL_PRINTNUM_ADDR
1012 #ifndef current_wordsize
1014 printnum_long_int(struct tcb *, kernel_ulong_t addr,
1015 const char *fmt_long, const char *fmt_int)
1016 ATTRIBUTE_FORMAT((printf, 3, 0))
1017 ATTRIBUTE_FORMAT((printf, 4, 0));
1018 extern bool printnum_addr_long_int(struct tcb *, kernel_ulong_t addr);
1019 # define printnum_slong(tcp, addr) \
1020 printnum_long_int((tcp), (addr), "%" PRId64, "%d")
1021 # define printnum_ulong(tcp, addr) \
1022 printnum_long_int((tcp), (addr), "%" PRIu64, "%u")
1023 # define printnum_ptr(tcp, addr) \
1024 printnum_addr_long_int((tcp), (addr))
1025 #elif current_wordsize > 4
1026 # define printnum_slong(tcp, addr) \
1027 printnum_int64((tcp), (addr), "%" PRId64)
1028 # define printnum_ulong(tcp, addr) \
1029 printnum_int64((tcp), (addr), "%" PRIu64)
1030 # define printnum_ptr(tcp, addr) \
1031 printnum_addr_int64((tcp), (addr))
1032 #else /* current_wordsize == 4 */
1033 # define printnum_slong(tcp, addr) \
1034 printnum_int((tcp), (addr), "%d")
1035 # define printnum_ulong(tcp, addr) \
1036 printnum_int((tcp), (addr), "%u")
1037 # define printnum_ptr(tcp, addr) \
1038 printnum_addr_int((tcp), (addr))
1041 #ifndef current_klongsize
1042 extern bool printnum_addr_klong_int(struct tcb *, kernel_ulong_t addr);
1043 # define printnum_kptr(tcp, addr) \
1044 printnum_addr_klong_int((tcp), (addr))
1045 #elif current_klongsize > 4
1046 # define printnum_kptr(tcp, addr) \
1047 printnum_addr_int64((tcp), (addr))
1048 #else /* current_klongsize == 4 */
1049 # define printnum_kptr(tcp, addr) \
1050 printnum_addr_int((tcp), (addr))
1053 #define DECL_PRINTPAIR(name) \
1055 printpair_ ## name(struct tcb *, kernel_ulong_t addr, const char *fmt) \
1056 ATTRIBUTE_FORMAT((printf, 3, 0)) \
1057 /* End of DECL_PRINTPAIR definition. */
1059 DECL_PRINTPAIR(int);
1060 DECL_PRINTPAIR(int64);
1061 #undef DECL_PRINTPAIR
1063 static inline kernel_long_t
1064 truncate_klong_to_current_wordsize(const kernel_long_t v)
1066 #if ANY_WORDSIZE_LESS_THAN_KERNEL_LONG
1067 if (current_wordsize < sizeof(v)) {
1076 static inline kernel_ulong_t
1077 truncate_kulong_to_current_wordsize(const kernel_ulong_t v)
1079 #if ANY_WORDSIZE_LESS_THAN_KERNEL_LONG
1080 if (current_wordsize < sizeof(v)) {
1081 return (unsigned int) v;
1090 * Cast a pointer or a pointer-sized integer to kernel_ulong_t.
1092 #define ptr_to_kulong(v) ((kernel_ulong_t) (unsigned long) (v))
1095 * Zero-extend a signed integer type to unsigned long long.
1097 #define zero_extend_signed_to_ull(v) \
1098 (sizeof(v) == sizeof(char) ? (unsigned long long) (unsigned char) (v) : \
1099 sizeof(v) == sizeof(short) ? (unsigned long long) (unsigned short) (v) : \
1100 sizeof(v) == sizeof(int) ? (unsigned long long) (unsigned int) (v) : \
1101 sizeof(v) == sizeof(long) ? (unsigned long long) (unsigned long) (v) : \
1102 (unsigned long long) (v))
1105 * Sign-extend an unsigned integer type to long long.
1107 #define sign_extend_unsigned_to_ll(v) \
1108 (sizeof(v) == sizeof(char) ? (long long) (char) (v) : \
1109 sizeof(v) == sizeof(short) ? (long long) (short) (v) : \
1110 sizeof(v) == sizeof(int) ? (long long) (int) (v) : \
1111 sizeof(v) == sizeof(long) ? (long long) (long) (v) : \
1114 extern const struct_sysent sysent0[];
1115 extern const char *const errnoent0[];
1116 extern const char *const signalent0[];
1117 extern const struct_ioctlent ioctlent0[];
1119 extern const char *const personality_names[];
1121 #if SUPPORTED_PERSONALITIES > 1
1122 extern const struct_sysent *sysent;
1123 extern const char *const *errnoent;
1124 extern const char *const *signalent;
1125 extern const struct_ioctlent *ioctlent;
1127 # define sysent sysent0
1128 # define errnoent errnoent0
1129 # define signalent signalent0
1130 # define ioctlent ioctlent0
1133 extern unsigned nsyscalls;
1134 extern unsigned nerrnos;
1135 extern unsigned nsignals;
1136 extern unsigned nioctlents;
1138 extern const unsigned int nsyscall_vec[SUPPORTED_PERSONALITIES];
1139 extern const struct_sysent *const sysent_vec[SUPPORTED_PERSONALITIES];
1140 extern struct inject_opts *inject_vec[SUPPORTED_PERSONALITIES];
1142 #ifdef IN_MPERS_BOOTSTRAP
1143 /* Transform multi-line MPERS_PRINTER_DECL statements to one-liners. */
1144 # define MPERS_PRINTER_DECL(type, name, ...) MPERS_PRINTER_DECL(type, name, __VA_ARGS__)
1145 #else /* !IN_MPERS_BOOTSTRAP */
1146 # if SUPPORTED_PERSONALITIES > 1
1147 # include "printers.h"
1149 # include "native_printer_decls.h"
1151 # define MPERS_PRINTER_DECL(type, name, ...) type MPERS_FUNC_NAME(name)(__VA_ARGS__)
1152 #endif /* !IN_MPERS_BOOTSTRAP */
1154 /* Checks that sysent[scno] is not out of range. */
1156 scno_in_range(kernel_ulong_t scno)
1158 return scno < nsyscalls;
1162 * Checks whether scno is not out of range,
1163 * its corresponding sysent[scno].sys_func is non-NULL,
1164 * and its sysent[scno].sys_flags has no TRACE_INDIRECT_SUBCALL flag set.
1167 scno_is_valid(kernel_ulong_t scno)
1169 return scno_in_range(scno)
1170 && sysent[scno].sys_func
1171 && !(sysent[scno].sys_flags & TRACE_INDIRECT_SUBCALL);
1174 #define MPERS_FUNC_NAME__(prefix, name) prefix ## name
1175 #define MPERS_FUNC_NAME_(prefix, name) MPERS_FUNC_NAME__(prefix, name)
1176 #define MPERS_FUNC_NAME(name) MPERS_FUNC_NAME_(MPERS_PREFIX, name)
1178 #define SYS_FUNC_NAME(syscall_name) MPERS_FUNC_NAME(syscall_name)
1180 #define SYS_FUNC(syscall_name) int SYS_FUNC_NAME(sys_ ## syscall_name)(struct tcb *tcp)
1182 #endif /* !STRACE_DEFS_H */