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 msg_flags[];
303 extern const struct xlat netlink_protocols[];
304 extern const struct xlat nl_netfilter_msg_types[];
305 extern const struct xlat nl_route_types[];
306 extern const struct xlat open_access_modes[];
307 extern const struct xlat open_mode_flags[];
308 extern const struct xlat resource_flags[];
309 extern const struct xlat routing_scopes[];
310 extern const struct xlat routing_table_ids[];
311 extern const struct xlat routing_types[];
312 extern const struct xlat seccomp_filter_flags[];
313 extern const struct xlat seccomp_ret_action[];
314 extern const struct xlat setns_types[];
315 extern const struct xlat sg_io_info[];
316 extern const struct xlat socketlayers[];
317 extern const struct xlat socktypes[];
318 extern const struct xlat tcp_state_flags[];
319 extern const struct xlat tcp_states[];
320 extern const struct xlat whence_codes[];
322 /* Format of syscall return values */
323 #define RVAL_UDECIMAL 000 /* unsigned decimal format */
324 #define RVAL_HEX 001 /* hex format */
325 #define RVAL_OCTAL 002 /* octal format */
326 #define RVAL_FD 010 /* file descriptor */
327 #define RVAL_MASK 013 /* mask for these values */
329 #define RVAL_STR 020 /* Print `auxstr' field after return val */
330 #define RVAL_NONE 040 /* Print nothing */
332 #define RVAL_DECODED 0100 /* syscall decoding finished */
333 #define RVAL_IOCTL_DECODED 0200 /* ioctl sub-parser successfully decoded
336 #define IOCTL_NUMBER_UNKNOWN 0
337 #define IOCTL_NUMBER_HANDLED 1
338 #define IOCTL_NUMBER_STOP_LOOKUP 010
340 #define indirect_ipccall(tcp) (tcp->s_ent->sys_flags & TRACE_INDIRECT_SUBCALL)
351 extern enum sock_proto get_proto_by_name(const char *);
364 extern cflag_t cflag;
367 extern bool count_wallclock;
368 extern unsigned int qflag;
369 extern bool not_failing_only;
370 extern unsigned int show_fd_path;
371 /* are we filtering traces based on paths? */
372 extern struct path_set {
373 const char **paths_selected;
377 #define tracing_paths (global_path_set.num_selected != 0)
378 extern unsigned xflag;
379 extern unsigned followfork;
380 #ifdef ENABLE_STACKTRACE
381 /* if this is true do the stack trace for every system call */
382 extern bool stack_trace_enabled;
384 extern unsigned ptrace_setoptions;
385 extern unsigned max_strlen;
386 extern unsigned os_release;
387 #undef KERNEL_VERSION
388 #define KERNEL_VERSION(a, b, c) (((a) << 16) + ((b) << 8) + (c))
390 extern int read_int_from_file(struct tcb *, const char *, int *);
392 extern void set_sortby(const char *);
393 extern void set_overhead(int);
394 extern void print_pc(struct tcb *);
396 extern int syscall_entering_decode(struct tcb *);
397 extern int syscall_entering_trace(struct tcb *, unsigned int *);
398 extern void syscall_entering_finish(struct tcb *, int);
400 extern int syscall_exiting_decode(struct tcb *, struct timespec *);
401 extern int syscall_exiting_trace(struct tcb *, struct timespec *, int);
402 extern void syscall_exiting_finish(struct tcb *);
404 extern void count_syscall(struct tcb *, const struct timespec *);
405 extern void call_summary(FILE *);
407 extern void clear_regs(struct tcb *tcp);
408 extern int get_scno(struct tcb *);
409 extern kernel_ulong_t get_rt_sigframe_addr(struct tcb *);
412 * Convert a (shuffled) syscall number to the corresponding syscall name.
414 * @param scno Syscall number.
415 * @return String literal corresponding to the syscall number in case latter
416 * is valid; NULL otherwise.
418 extern const char *syscall_name(kernel_ulong_t scno);
420 * Convert a syscall name to the corresponding (shuffled) syscall number.
422 * @param s Syscall name.
423 * @param p Personality.
424 * @param start From which position in syscall entry table resume the search.
425 * @return Shuffled syscall number (ready to use against sysent_vec)
426 * if syscall name is found; -1 otherwise.
428 extern kernel_long_t scno_by_name(const char *s, unsigned p,
429 kernel_long_t start);
431 * Shuffle syscall numbers so that we don't have huge gaps in syscall table.
432 * The shuffling should be an involution: shuffle_scno(shuffle_scno(n)) == n.
434 * @param scno Raw or shuffled syscall number.
435 * @return Shuffled or raw syscall number, respectively.
437 extern kernel_ulong_t shuffle_scno(kernel_ulong_t scno);
438 extern const char *err_name(unsigned long err);
440 extern bool is_erestart(struct tcb *);
441 extern void temporarily_clear_syserror(struct tcb *);
442 extern void restore_cleared_syserror(struct tcb *);
444 extern void *get_tcb_priv_data(const struct tcb *);
445 extern int set_tcb_priv_data(struct tcb *, void *priv_data,
446 void (*free_priv_data)(void *));
447 extern void free_tcb_priv_data(struct tcb *);
449 static inline unsigned long get_tcb_priv_ulong(const struct tcb *tcp)
451 return (unsigned long) get_tcb_priv_data(tcp);
454 static inline int set_tcb_priv_ulong(struct tcb *tcp, unsigned long val)
456 return set_tcb_priv_data(tcp, (void *) val, 0);
460 umoven(struct tcb *, kernel_ulong_t addr, unsigned int len, void *laddr);
461 #define umove(pid, addr, objp) \
462 umoven((pid), (addr), sizeof(*(objp)), (void *) (objp))
465 umoven_or_printaddr(struct tcb *, kernel_ulong_t addr,
466 unsigned int len, void *laddr);
467 #define umove_or_printaddr(pid, addr, objp) \
468 umoven_or_printaddr((pid), (addr), sizeof(*(objp)), (void *) (objp))
471 umoven_or_printaddr_ignore_syserror(struct tcb *, kernel_ulong_t addr,
472 unsigned int len, void *laddr);
475 umovestr(struct tcb *, kernel_ulong_t addr, unsigned int len, char *laddr);
477 extern int upeek(struct tcb *tcp, unsigned long, kernel_ulong_t *);
478 extern int upoke(struct tcb *tcp, unsigned long, kernel_ulong_t);
481 print_array(struct tcb *,
482 kernel_ulong_t start_addr,
486 int (*umoven_func)(struct tcb *,
490 bool (*print_func)(struct tcb *,
496 #if HAVE_ARCH_GETRVAL2
497 extern long getrval2(struct tcb *);
500 extern const char *signame(const int);
501 extern void pathtrace_select_set(const char *, struct path_set *);
502 extern bool pathtrace_match_set(struct tcb *, struct path_set *);
503 #define pathtrace_select(tcp) \
504 pathtrace_select_set(tcp, &global_path_set)
505 #define pathtrace_match(tcp) \
506 pathtrace_match_set(tcp, &global_path_set)
507 extern int getfdpath(struct tcb *, int, char *, unsigned);
508 extern unsigned long getfdinode(struct tcb *, int);
509 extern enum sock_proto getfdproto(struct tcb *, int);
511 extern const char *xlookup(const struct xlat *, const uint64_t);
512 extern const char *xlat_search(const struct xlat *, const size_t, const uint64_t);
515 struct dyxlat *dyxlat_alloc(size_t nmemb);
516 void dyxlat_free(struct dyxlat *);
517 const struct xlat *dyxlat_get(const struct dyxlat *);
518 void dyxlat_add_pair(struct dyxlat *, uint64_t val, const char *str, size_t len);
520 const struct xlat *genl_families_xlat(struct tcb *tcp);
522 extern unsigned long get_pagesize(void);
523 extern int next_set_bit(const void *bit_array, unsigned cur_bit, unsigned size_bits);
526 * Returns STR if it does not start with PREFIX,
527 * or a pointer to the first char in STR after PREFIX.
528 * The length of PREFIX is specified by PREFIX_LEN.
530 static inline const char *
531 str_strip_prefix_len(const char *str, const char *prefix, size_t prefix_len)
533 return strncmp(str, prefix, prefix_len) ? str : str + prefix_len;
536 #define STR_STRIP_PREFIX(str, prefix) \
537 str_strip_prefix_len((str), (prefix), sizeof(prefix) - 1)
539 #define QUOTE_0_TERMINATED 0x01
540 #define QUOTE_OMIT_LEADING_TRAILING_QUOTES 0x02
541 #define QUOTE_OMIT_TRAILING_0 0x08
542 #define QUOTE_FORCE_HEX 0x10
543 #define QUOTE_EMIT_COMMENT 0x20
545 extern int string_quote(const char *, char *, unsigned int, unsigned int,
546 const char *escape_chars);
547 extern int print_quoted_string_ex(const char *, unsigned int, unsigned int,
548 const char *escape_chars);
549 extern int print_quoted_string(const char *, unsigned int, unsigned int);
550 extern int print_quoted_cstring(const char *, unsigned int);
552 /* a refers to the lower numbered u_arg,
553 * b refers to the higher numbered u_arg
555 #ifdef WORDS_BIGENDIAN
556 # define ULONG_LONG(a, b) \
557 ((unsigned long long)(unsigned)(b) | ((unsigned long long)(a)<<32))
559 # define ULONG_LONG(a, b) \
560 ((unsigned long long)(unsigned)(a) | ((unsigned long long)(b)<<32))
562 extern int getllval(struct tcb *, unsigned long long *, int);
563 extern int printllval(struct tcb *, const char *, int)
564 ATTRIBUTE_FORMAT((printf, 2, 0));
566 extern void printaddr64(uint64_t addr);
567 extern void printaddr(kernel_ulong_t addr);
568 extern int printxvals(const uint64_t, const char *, const struct xlat *, ...)
570 extern int printxval_searchn(const struct xlat *xlat, size_t xlat_size,
571 uint64_t val, const char *dflt);
573 * Wrapper around printxval_searchn that passes ARRAY_SIZE - 1
574 * as the array size, as all arrays are XLAT_END-terminated and
575 * printxval_searchn expects a size without the terminating record.
577 #define printxval_search(xlat__, val__, dflt__) \
578 printxval_searchn(xlat__, ARRAY_SIZE(xlat__) - 1, val__, dflt__)
579 extern int sprintxval(char *buf, size_t size, const struct xlat *,
580 unsigned int val, const char *dflt);
581 extern int printargs(struct tcb *);
582 extern int printargs_u(struct tcb *);
583 extern int printargs_d(struct tcb *);
585 extern int printflags_ex(uint64_t, const char *, const struct xlat *, ...)
587 extern const char *sprintflags(const char *, const struct xlat *, uint64_t);
588 extern const char *sprinttime(long long sec);
589 extern const char *sprinttime_nsec(long long sec, unsigned long long nsec);
590 extern const char *sprinttime_usec(long long sec, unsigned long long usec);
591 extern void print_symbolic_mode_t(unsigned int);
592 extern void print_numeric_umode_t(unsigned short);
593 extern void print_numeric_long_umask(unsigned long);
594 extern void print_dev_t(unsigned long long dev);
595 extern void print_abnormal_hi(kernel_ulong_t);
597 extern kernel_ulong_t *
598 fetch_indirect_syscall_args(struct tcb *, kernel_ulong_t addr, unsigned int n_args);
601 dumpiov_in_msghdr(struct tcb *, kernel_ulong_t addr, kernel_ulong_t data_size);
604 dumpiov_in_mmsghdr(struct tcb *, kernel_ulong_t addr);
607 dumpiov_upto(struct tcb *, int len, kernel_ulong_t addr, kernel_ulong_t data_size);
610 dumpstr(struct tcb *, kernel_ulong_t addr, int len);
613 printstr_ex(struct tcb *, kernel_ulong_t addr, kernel_ulong_t len,
614 unsigned int user_style);
617 printpathn(struct tcb *, kernel_ulong_t addr, unsigned int n);
620 printpath(struct tcb *, kernel_ulong_t addr);
622 #define TIMESPEC_TEXT_BUFSIZE \
623 (sizeof(long long) * 3 * 2 + sizeof("{tv_sec=-, tv_nsec=}"))
624 extern void printfd(struct tcb *, int);
625 extern void print_sockaddr(const void *sa, int len);
627 print_inet_addr(int af, const void *addr, unsigned int len, const char *var_name);
629 decode_inet_addr(struct tcb *, kernel_ulong_t addr,
630 unsigned int len, int family, const char *var_name);
631 extern const char *get_sockaddr_by_inode(struct tcb *, int fd, unsigned long inode);
632 extern bool print_sockaddr_by_inode(struct tcb *, int fd, unsigned long inode);
633 extern void print_dirfd(struct tcb *, int);
636 decode_sockaddr(struct tcb *, kernel_ulong_t addr, int addrlen);
638 extern void printuid(const char *, const unsigned int);
641 print_sigset_addr_len(struct tcb *, kernel_ulong_t addr, kernel_ulong_t len);
643 print_sigset_addr(struct tcb *, kernel_ulong_t addr);
645 extern const char *sprintsigmask_n(const char *, const void *, unsigned int);
646 #define tprintsigmask_addr(prefix, mask) \
647 tprints(sprintsigmask_n((prefix), (mask), sizeof(mask)))
648 extern void printsignal(int);
651 tprint_iov_upto(struct tcb *, kernel_ulong_t len, kernel_ulong_t addr,
652 enum iov_decode, kernel_ulong_t data_size);
655 decode_netlink(struct tcb *, int fd, kernel_ulong_t addr, kernel_ulong_t len);
657 extern void tprint_open_modes(unsigned int);
658 extern const char *sprint_open_modes(unsigned int);
661 decode_seccomp_fprog(struct tcb *, kernel_ulong_t addr);
664 print_seccomp_fprog(struct tcb *, kernel_ulong_t addr, unsigned short len);
667 decode_sock_fprog(struct tcb *, kernel_ulong_t addr);
670 print_sock_fprog(struct tcb *, kernel_ulong_t addr, unsigned short len);
673 extern void print_struct_stat(struct tcb *, const struct strace_stat *const st);
675 struct strace_statfs;
676 struct strace_keyctl_kdf_params;
679 print_struct_statfs(struct tcb *, kernel_ulong_t addr);
682 print_struct_statfs64(struct tcb *, kernel_ulong_t addr, kernel_ulong_t size);
684 extern void print_ifindex(unsigned int);
686 extern void qualify(const char *);
687 extern unsigned int qual_flags(const unsigned int);
689 #define DECL_IOCTL(name) \
691 name ## _ioctl(struct tcb *, unsigned int request, kernel_ulong_t arg) \
692 /* End of DECL_IOCTL definition. */
707 extern int decode_sg_io_v4(struct tcb *, const kernel_ulong_t arg);
708 extern void print_evdev_ff_type(const kernel_ulong_t val);
712 typedef bool (*netlink_decoder_t)(struct tcb *, const struct nlmsghdr *,
713 kernel_ulong_t addr, unsigned int len);
715 #define DECL_NETLINK(name) \
717 decode_netlink_ ## name(struct tcb *, const struct nlmsghdr *, \
718 kernel_ulong_t addr, unsigned int len) \
719 /* End of DECL_NETLINK definition. */
721 DECL_NETLINK(crypto);
722 DECL_NETLINK(netfilter);
724 DECL_NETLINK(selinux);
725 DECL_NETLINK(sock_diag);
727 extern int ts_nz(const struct timespec *);
728 extern int ts_cmp(const struct timespec *, const struct timespec *);
729 extern double ts_float(const struct timespec *);
730 extern void ts_add(struct timespec *, const struct timespec *, const struct timespec *);
731 extern void ts_sub(struct timespec *, const struct timespec *, const struct timespec *);
732 extern void ts_mul(struct timespec *, const struct timespec *, int);
733 extern void ts_div(struct timespec *, const struct timespec *, int);
735 #ifdef ENABLE_STACKTRACE
736 extern void unwind_init(void);
737 extern void unwind_tcb_init(struct tcb *);
738 extern void unwind_tcb_fin(struct tcb *);
739 extern void unwind_tcb_print(struct tcb *);
740 extern void unwind_tcb_capture(struct tcb *);
744 printstrn(struct tcb *tcp, kernel_ulong_t addr, kernel_ulong_t len)
746 return printstr_ex(tcp, addr, len, 0);
750 printstr(struct tcb *tcp, kernel_ulong_t addr)
752 return printstr_ex(tcp, addr, -1, QUOTE_0_TERMINATED);
756 printflags64(const struct xlat *x, uint64_t flags, const char *dflt)
758 return printflags_ex(flags, dflt, x, NULL);
762 printflags(const struct xlat *x, unsigned int flags, const char *dflt)
764 return printflags64(x, flags, dflt);
768 printxval64(const struct xlat *x, const uint64_t val, const char *dflt)
770 return printxvals(val, dflt, x, NULL);
774 printxval(const struct xlat *x, const unsigned int val, const char *dflt)
776 return printxvals(val, dflt, x, NULL);
780 tprint_iov(struct tcb *tcp, kernel_ulong_t len, kernel_ulong_t addr,
781 enum iov_decode decode_iov)
783 tprint_iov_upto(tcp, len, addr, decode_iov, -1);
791 extern void print_timeval32_t(const timeval32_t *);
792 extern void printrusage32(struct tcb *, kernel_ulong_t);
793 extern const char *sprint_timeval32(struct tcb *, kernel_ulong_t addr);
794 extern void print_timeval32(struct tcb *, kernel_ulong_t addr);
795 extern void print_timeval32_utimes(struct tcb *, kernel_ulong_t addr);
796 extern void print_itimerval32(struct tcb *, kernel_ulong_t addr);
799 #ifdef HAVE_STRUCT_USER_DESC
801 * Filter what to print from the point of view of the get_thread_area syscall.
802 * Kernel copies only entry_number field at first and then tries to write the
805 enum user_desc_print_filter {
806 /* Print the "entering" part of struct user_desc - entry_number. */
807 USER_DESC_ENTERING = 1,
808 /* Print the "exiting" part of the structure. */
809 USER_DESC_EXITING = 2,
810 USER_DESC_BOTH = USER_DESC_ENTERING | USER_DESC_EXITING,
813 extern void print_user_desc(struct tcb *, kernel_ulong_t addr,
814 enum user_desc_print_filter filter);
817 /* Strace log generation machinery.
819 * printing_tcp: tcb which has incomplete line being printed right now.
820 * NULL if last line has been completed ('\n'-terminated).
821 * printleader(tcp) examines it, finishes incomplete line if needed,
822 * the sets it to tcp.
823 * line_ended() clears printing_tcp and resets ->curcol = 0.
824 * tcp->curcol == 0 check is also used to detect completeness
825 * of last line, since in -ff mode just checking printing_tcp for NULL
828 * If you change this code, test log generation in both -f and -ff modes
830 * strace -oLOG -f[f] test/threaded_execve
831 * strace -oLOG -f[f] test/sigkill_rain
832 * strace -oLOG -f[f] -p "`pidof web_browser`"
834 extern struct tcb *printing_tcp;
835 extern void printleader(struct tcb *);
836 extern void line_ended(void);
837 extern void tabto(void);
838 extern void tprintf(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2));
839 extern void tprints(const char *str);
840 extern void tprintf_comment(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2));
841 extern void tprints_comment(const char *str);
843 #if SUPPORTED_PERSONALITIES > 1
844 extern void set_personality(unsigned int personality);
845 extern unsigned current_personality;
847 # define set_personality(personality) ((void)0)
848 # define current_personality 0
851 #if SUPPORTED_PERSONALITIES == 1
852 # define current_wordsize PERSONALITY0_WORDSIZE
853 # define current_klongsize PERSONALITY0_KLONGSIZE
855 # if SUPPORTED_PERSONALITIES == 2 && PERSONALITY0_WORDSIZE == PERSONALITY1_WORDSIZE
856 # define current_wordsize PERSONALITY0_WORDSIZE
858 extern unsigned current_wordsize;
860 # if SUPPORTED_PERSONALITIES == 2 && PERSONALITY0_KLONGSIZE == PERSONALITY1_KLONGSIZE
861 # define current_klongsize PERSONALITY0_KLONGSIZE
863 extern unsigned current_klongsize;
867 #define max_addr() (~0ULL >> ((8 - current_wordsize) * 8))
868 #define max_kaddr() (~0ULL >> ((8 - current_klongsize) * 8))
871 * When u64 is interpreted by the kernel as an address, there is a difference
872 * in behaviour between 32-bit and 64-bit kernel in the way u64_to_user_ptr
873 * works (32-bit kernel trims higher bits during conversion which may result
874 * to a valid address). Since 32-bit strace cannot figure out what kind of
875 * kernel the tracee is running on, it has to account for both possibilities.
877 #if CAN_ARCH_BE_COMPAT_ON_64BIT_KERNEL
880 * Print raw 64-bit value as an address if it's too big to fit in strace's
884 print_big_u64_addr(const uint64_t addr)
886 if (sizeof(kernel_long_t) < 8 && addr > max_kaddr()) {
891 #else /* !CAN_ARCH_BE_COMPAT_ON_64BIT_KERNEL */
892 # define print_big_u64_addr(addr_) ((void) 0)
893 #endif /* CAN_ARCH_BE_COMPAT_ON_64BIT_KERNEL */
895 #if SIZEOF_KERNEL_LONG_T > 4 \
896 && (SIZEOF_LONG < SIZEOF_KERNEL_LONG_T || !defined(current_wordsize))
897 # define ANY_WORDSIZE_LESS_THAN_KERNEL_LONG 1
899 # define ANY_WORDSIZE_LESS_THAN_KERNEL_LONG 0
902 #define DECL_PRINTNUM(name) \
904 printnum_ ## name(struct tcb *, kernel_ulong_t addr, const char *fmt) \
905 ATTRIBUTE_FORMAT((printf, 3, 0)) \
906 /* End of DECL_PRINTNUM definition. */
908 DECL_PRINTNUM(short);
910 DECL_PRINTNUM(int64);
913 #define DECL_PRINTNUM_ADDR(name) \
915 printnum_addr_ ## name(struct tcb *, kernel_ulong_t addr) \
916 /* End of DECL_PRINTNUM_ADDR definition. */
918 DECL_PRINTNUM_ADDR(int);
919 DECL_PRINTNUM_ADDR(int64);
920 #undef DECL_PRINTNUM_ADDR
922 #ifndef current_wordsize
924 printnum_long_int(struct tcb *, kernel_ulong_t addr,
925 const char *fmt_long, const char *fmt_int)
926 ATTRIBUTE_FORMAT((printf, 3, 0))
927 ATTRIBUTE_FORMAT((printf, 4, 0));
928 extern bool printnum_addr_long_int(struct tcb *, kernel_ulong_t addr);
929 # define printnum_slong(tcp, addr) \
930 printnum_long_int((tcp), (addr), "%" PRId64, "%d")
931 # define printnum_ulong(tcp, addr) \
932 printnum_long_int((tcp), (addr), "%" PRIu64, "%u")
933 # define printnum_ptr(tcp, addr) \
934 printnum_addr_long_int((tcp), (addr))
935 #elif current_wordsize > 4
936 # define printnum_slong(tcp, addr) \
937 printnum_int64((tcp), (addr), "%" PRId64)
938 # define printnum_ulong(tcp, addr) \
939 printnum_int64((tcp), (addr), "%" PRIu64)
940 # define printnum_ptr(tcp, addr) \
941 printnum_addr_int64((tcp), (addr))
942 #else /* current_wordsize == 4 */
943 # define printnum_slong(tcp, addr) \
944 printnum_int((tcp), (addr), "%d")
945 # define printnum_ulong(tcp, addr) \
946 printnum_int((tcp), (addr), "%u")
947 # define printnum_ptr(tcp, addr) \
948 printnum_addr_int((tcp), (addr))
951 #ifndef current_klongsize
952 extern bool printnum_addr_klong_int(struct tcb *, kernel_ulong_t addr);
953 # define printnum_kptr(tcp, addr) \
954 printnum_addr_klong_int((tcp), (addr))
955 #elif current_klongsize > 4
956 # define printnum_kptr(tcp, addr) \
957 printnum_addr_int64((tcp), (addr))
958 #else /* current_klongsize == 4 */
959 # define printnum_kptr(tcp, addr) \
960 printnum_addr_int((tcp), (addr))
963 #define DECL_PRINTPAIR(name) \
965 printpair_ ## name(struct tcb *, kernel_ulong_t addr, const char *fmt) \
966 ATTRIBUTE_FORMAT((printf, 3, 0)) \
967 /* End of DECL_PRINTPAIR definition. */
970 DECL_PRINTPAIR(int64);
971 #undef DECL_PRINTPAIR
973 static inline kernel_long_t
974 truncate_klong_to_current_wordsize(const kernel_long_t v)
976 #if ANY_WORDSIZE_LESS_THAN_KERNEL_LONG
977 if (current_wordsize < sizeof(v)) {
986 static inline kernel_ulong_t
987 truncate_kulong_to_current_wordsize(const kernel_ulong_t v)
989 #if ANY_WORDSIZE_LESS_THAN_KERNEL_LONG
990 if (current_wordsize < sizeof(v)) {
991 return (unsigned int) v;
1000 * Cast a pointer or a pointer-sized integer to kernel_ulong_t.
1002 #define ptr_to_kulong(v) ((kernel_ulong_t) (unsigned long) (v))
1005 * Zero-extend a signed integer type to unsigned long long.
1007 #define zero_extend_signed_to_ull(v) \
1008 (sizeof(v) == sizeof(char) ? (unsigned long long) (unsigned char) (v) : \
1009 sizeof(v) == sizeof(short) ? (unsigned long long) (unsigned short) (v) : \
1010 sizeof(v) == sizeof(int) ? (unsigned long long) (unsigned int) (v) : \
1011 sizeof(v) == sizeof(long) ? (unsigned long long) (unsigned long) (v) : \
1012 (unsigned long long) (v))
1015 * Sign-extend an unsigned integer type to long long.
1017 #define sign_extend_unsigned_to_ll(v) \
1018 (sizeof(v) == sizeof(char) ? (long long) (char) (v) : \
1019 sizeof(v) == sizeof(short) ? (long long) (short) (v) : \
1020 sizeof(v) == sizeof(int) ? (long long) (int) (v) : \
1021 sizeof(v) == sizeof(long) ? (long long) (long) (v) : \
1024 extern const struct_sysent sysent0[];
1025 extern const char *const errnoent0[];
1026 extern const char *const signalent0[];
1027 extern const struct_ioctlent ioctlent0[];
1029 extern const char *const personality_names[];
1031 #if SUPPORTED_PERSONALITIES > 1
1032 extern const struct_sysent *sysent;
1033 extern const char *const *errnoent;
1034 extern const char *const *signalent;
1035 extern const struct_ioctlent *ioctlent;
1037 # define sysent sysent0
1038 # define errnoent errnoent0
1039 # define signalent signalent0
1040 # define ioctlent ioctlent0
1043 extern unsigned nsyscalls;
1044 extern unsigned nerrnos;
1045 extern unsigned nsignals;
1046 extern unsigned nioctlents;
1048 extern const unsigned int nsyscall_vec[SUPPORTED_PERSONALITIES];
1049 extern const struct_sysent *const sysent_vec[SUPPORTED_PERSONALITIES];
1050 extern struct inject_opts *inject_vec[SUPPORTED_PERSONALITIES];
1052 #ifdef IN_MPERS_BOOTSTRAP
1053 /* Transform multi-line MPERS_PRINTER_DECL statements to one-liners. */
1054 # define MPERS_PRINTER_DECL(type, name, ...) MPERS_PRINTER_DECL(type, name, __VA_ARGS__)
1055 #else /* !IN_MPERS_BOOTSTRAP */
1056 # if SUPPORTED_PERSONALITIES > 1
1057 # include "printers.h"
1059 # include "native_printer_decls.h"
1061 # define MPERS_PRINTER_DECL(type, name, ...) type MPERS_FUNC_NAME(name)(__VA_ARGS__)
1062 #endif /* !IN_MPERS_BOOTSTRAP */
1064 /* Checks that sysent[scno] is not out of range. */
1066 scno_in_range(kernel_ulong_t scno)
1068 return scno < nsyscalls;
1072 * Checks whether scno is not out of range,
1073 * its corresponding sysent[scno].sys_func is non-NULL,
1074 * and its sysent[scno].sys_flags has no TRACE_INDIRECT_SUBCALL flag set.
1077 scno_is_valid(kernel_ulong_t scno)
1079 return scno_in_range(scno)
1080 && sysent[scno].sys_func
1081 && !(sysent[scno].sys_flags & TRACE_INDIRECT_SUBCALL);
1084 #define MPERS_FUNC_NAME__(prefix, name) prefix ## name
1085 #define MPERS_FUNC_NAME_(prefix, name) MPERS_FUNC_NAME__(prefix, name)
1086 #define MPERS_FUNC_NAME(name) MPERS_FUNC_NAME_(MPERS_PREFIX, name)
1088 #define SYS_FUNC_NAME(syscall_name) MPERS_FUNC_NAME(syscall_name)
1090 #define SYS_FUNC(syscall_name) int SYS_FUNC_NAME(sys_ ## syscall_name)(struct tcb *tcp)
1092 #endif /* !STRACE_DEFS_H */