2 * Copyright (c) 1991, 1992 Paul Kranenburg <pk@cs.few.eur.nl>
3 * Copyright (c) 1993 Branko Lankester <branko@hacktic.nl>
4 * Copyright (c) 1993, 1994, 1995, 1996 Rick Sladkey <jrs@world.std.com>
5 * Copyright (c) 2001-2017 The strace developers.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. The name of the author may not be used to endorse or promote products
17 * derived from this software without specific prior written permission.
19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
20 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
21 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
23 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
24 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42 #include <sys/types.h>
47 /* Open-coding isprint(ch) et al proved more efficient than calling
48 * generalized libc interface. We don't *want* to do non-ASCII anyway.
50 /* #include <ctype.h> */
56 #include "error_prints.h"
57 #include "gcc_compat.h"
58 #include "kernel_types.h"
60 #include "mpers_type.h"
61 #include "string_to_uint.h"
62 #include "supported_personalities.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 * Experimental code using PTRACE_SEIZE can be enabled here.
113 * This needs Linux kernel 3.4.x or later to work.
116 /* To force NOMMU build, set to 1 */
117 #define NOMMU_SYSTEM 0
120 # define ERESTARTSYS 512
122 #ifndef ERESTARTNOINTR
123 # define ERESTARTNOINTR 513
125 #ifndef ERESTARTNOHAND
126 # define ERESTARTNOHAND 514
128 #ifndef ERESTART_RESTARTBLOCK
129 # define ERESTART_RESTARTBLOCK 516
132 #define PERSONALITY0_WORDSIZE SIZEOF_LONG
133 #define PERSONALITY0_KLONGSIZE SIZEOF_KERNEL_LONG_T
134 #define PERSONALITY0_INCLUDE_PRINTERS_DECLS "native_printer_decls.h"
135 #define PERSONALITY0_INCLUDE_PRINTERS_DEFS "native_printer_defs.h"
137 #if SUPPORTED_PERSONALITIES > 1
138 # define PERSONALITY1_WORDSIZE 4
139 # define PERSONALITY1_KLONGSIZE PERSONALITY1_WORDSIZE
142 #if SUPPORTED_PERSONALITIES > 2
143 # define PERSONALITY2_WORDSIZE 4
144 # define PERSONALITY2_KLONGSIZE PERSONALITY0_KLONGSIZE
147 #if SUPPORTED_PERSONALITIES > 1 && defined HAVE_M32_MPERS
148 # define PERSONALITY1_INCLUDE_PRINTERS_DECLS "m32_printer_decls.h"
149 # define PERSONALITY1_INCLUDE_PRINTERS_DEFS "m32_printer_defs.h"
150 # define PERSONALITY1_INCLUDE_FUNCS "m32_funcs.h"
151 # define MPERS_m32_IOCTL_MACROS "ioctl_redefs1.h"
153 # define PERSONALITY1_INCLUDE_PRINTERS_DECLS "native_printer_decls.h"
154 # define PERSONALITY1_INCLUDE_PRINTERS_DEFS "native_printer_defs.h"
155 # define PERSONALITY1_INCLUDE_FUNCS "empty.h"
158 #if SUPPORTED_PERSONALITIES > 2 && defined HAVE_MX32_MPERS
159 # define PERSONALITY2_INCLUDE_FUNCS "mx32_funcs.h"
160 # define PERSONALITY2_INCLUDE_PRINTERS_DECLS "mx32_printer_decls.h"
161 # define PERSONALITY2_INCLUDE_PRINTERS_DEFS "mx32_printer_defs.h"
162 # define MPERS_mx32_IOCTL_MACROS "ioctl_redefs2.h"
164 # define PERSONALITY2_INCLUDE_PRINTERS_DECLS "native_printer_decls.h"
165 # define PERSONALITY2_INCLUDE_PRINTERS_DEFS "native_printer_defs.h"
166 # define PERSONALITY2_INCLUDE_FUNCS "empty.h"
169 typedef struct ioctlent {
174 #define INJECT_F_SIGNAL 1
175 #define INJECT_F_RETVAL 2
186 struct inject_data data;
189 #define MAX_ERRNO_VALUE 4095
191 /* Trace Control Block */
193 int flags; /* See below for TCB_ values */
194 int pid; /* If 0, this tcb is free */
195 int qual_flg; /* qual_flags[scno] or DEFAULT_QUAL_FLAGS + RAW */
196 unsigned long u_error; /* Error code */
197 kernel_ulong_t scno; /* System call number */
198 kernel_ulong_t u_arg[MAX_ARGS]; /* System call arguments */
199 kernel_long_t u_rval; /* Return value */
200 #if SUPPORTED_PERSONALITIES > 1
201 unsigned int currpers; /* Personality at the time of scno update */
203 int sys_func_rval; /* Syscall entry parser's return value */
204 int curcol; /* Output column for this process */
205 FILE *outf; /* Output file for this process */
206 const char *auxstr; /* Auxiliary info from syscall (see RVAL_STR) */
207 void *_priv_data; /* Private data for syscall decoding functions */
208 void (*_free_priv_data)(void *); /* Callback for freeing priv_data */
209 const struct_sysent *s_ent; /* sysent[scno] or dummy struct for bad scno */
210 const struct_sysent *s_prev_ent; /* for "resuming interrupted SYSCALL" msg */
211 struct inject_opts *inject_vec[SUPPORTED_PERSONALITIES];
212 struct timeval stime; /* System time usage as of last process wait */
213 struct timeval dtime; /* Delta for system time usage */
214 struct timeval etime; /* Syscall entry time */
217 struct UPT_info *libunwind_ui;
218 struct mmap_cache_t *mmap_cache;
219 unsigned int mmap_cache_size;
220 unsigned int mmap_cache_generation;
221 struct queue_t *queue;
226 /* We have attached to this process, but did not see it stopping yet */
227 #define TCB_STARTUP 0x01
228 #define TCB_IGNORE_ONE_SIGSTOP 0x02 /* Next SIGSTOP is to be ignored */
230 * Are we in system call entry or in syscall exit?
232 * This bit is set in syscall_entering_finish() and cleared in
233 * syscall_exiting_finish().
234 * Other stops which are possible directly after syscall entry (death, ptrace
235 * event stop) are handled without calling syscall_{entering,exiting}_*().
237 * Use entering(tcp) / exiting(tcp) to check this bit to make code more
240 #define TCB_INSYSCALL 0x04
241 #define TCB_ATTACHED 0x08 /* We attached to it already */
242 #define TCB_REPRINT 0x10 /* We should reprint this syscall on exit */
243 #define TCB_FILTERED 0x20 /* This system call has been filtered out */
244 #define TCB_TAMPERED 0x40 /* A syscall has been tampered with */
245 #define TCB_HIDE_LOG 0x80 /* We should hide everything (until execve) */
246 #define TCB_SKIP_DETACH_ON_FIRST_EXEC 0x100 /* -b execve should skip detach on first execve */
247 #define TCB_GRABBED 0x200 /* We grab the process and can catch it
248 * in the middle of a syscall */
250 /* qualifier flags */
251 #define QUAL_TRACE 0x001 /* this system call should be traced */
252 #define QUAL_ABBREV 0x002 /* abbreviate the structures of this syscall */
253 #define QUAL_VERBOSE 0x004 /* decode the structures of this syscall */
254 #define QUAL_RAW 0x008 /* print all args in hex for this syscall */
255 #define QUAL_INJECT 0x010 /* tamper with this system call on purpose */
257 #define DEFAULT_QUAL_FLAGS (QUAL_TRACE | QUAL_ABBREV | QUAL_VERBOSE)
259 #define entering(tcp) (!((tcp)->flags & TCB_INSYSCALL))
260 #define exiting(tcp) ((tcp)->flags & TCB_INSYSCALL)
261 #define syserror(tcp) ((tcp)->u_error != 0)
262 #define traced(tcp) ((tcp)->qual_flg & QUAL_TRACE)
263 #define verbose(tcp) ((tcp)->qual_flg & QUAL_VERBOSE)
264 #define abbrev(tcp) ((tcp)->qual_flg & QUAL_ABBREV)
265 #define raw(tcp) ((tcp)->qual_flg & QUAL_RAW)
266 #define inject(tcp) ((tcp)->qual_flg & QUAL_INJECT)
267 #define filtered(tcp) ((tcp)->flags & TCB_FILTERED)
268 #define hide_log(tcp) ((tcp)->flags & TCB_HIDE_LOG)
272 extern const struct xlat addrfams[];
273 extern const struct xlat arp_hardware_types[];
274 extern const struct xlat at_flags[];
275 extern const struct xlat clocknames[];
276 extern const struct xlat dirent_types[];
277 extern const struct xlat ethernet_protocols[];
278 extern const struct xlat evdev_abs[];
279 extern const struct xlat iffflags[];
280 extern const struct xlat inet_protocols[];
281 extern const struct xlat ip_type_of_services[];
282 extern const struct xlat msg_flags[];
283 extern const struct xlat netlink_protocols[];
284 extern const struct xlat nl_route_types[];
285 extern const struct xlat open_access_modes[];
286 extern const struct xlat open_mode_flags[];
287 extern const struct xlat resource_flags[];
288 extern const struct xlat routing_scopes[];
289 extern const struct xlat routing_table_ids[];
290 extern const struct xlat routing_types[];
291 extern const struct xlat seccomp_ret_action[];
292 extern const struct xlat setns_types[];
293 extern const struct xlat sg_io_info[];
294 extern const struct xlat socketlayers[];
295 extern const struct xlat socktypes[];
296 extern const struct xlat tcp_state_flags[];
297 extern const struct xlat tcp_states[];
298 extern const struct xlat whence_codes[];
300 /* Format of syscall return values */
301 #define RVAL_DECIMAL 000 /* decimal format */
302 #define RVAL_HEX 001 /* hex format */
303 #define RVAL_OCTAL 002 /* octal format */
304 #define RVAL_UDECIMAL 003 /* unsigned decimal format */
305 #define RVAL_FD 010 /* file descriptor */
306 #define RVAL_MASK 013 /* mask for these values */
308 #define RVAL_STR 020 /* Print `auxstr' field after return val */
309 #define RVAL_NONE 040 /* Print nothing */
311 #define RVAL_DECODED 0100 /* syscall decoding finished */
312 #define RVAL_IOCTL_DECODED 0200 /* ioctl sub-parser successfully decoded
315 #define IOCTL_NUMBER_UNKNOWN 0
316 #define IOCTL_NUMBER_HANDLED 1
317 #define IOCTL_NUMBER_STOP_LOOKUP 010
319 #define indirect_ipccall(tcp) (tcp->s_ent->sys_flags & TRACE_INDIRECT_SUBCALL)
321 #if defined(ARM) || defined(AARCH64) \
322 || defined(I386) || defined(X32) || defined(X86_64) \
326 || defined(MICROBLAZE) \
329 || defined(SH) || defined(SH64) \
330 || defined(SPARC) || defined(SPARC64) \
332 # define NEED_UID16_PARSERS 1
334 # define NEED_UID16_PARSERS 0
346 extern enum sock_proto get_proto_by_name(const char *);
359 extern cflag_t cflag;
362 extern bool count_wallclock;
363 extern unsigned int qflag;
364 extern bool not_failing_only;
365 extern unsigned int show_fd_path;
366 /* are we filtering traces based on paths? */
367 extern struct path_set {
368 const char **paths_selected;
372 #define tracing_paths (global_path_set.num_selected != 0)
373 extern unsigned xflag;
374 extern unsigned followfork;
376 /* if this is true do the stack trace for every system call */
377 extern bool stack_trace_enabled;
379 extern unsigned ptrace_setoptions;
380 extern unsigned max_strlen;
381 extern unsigned os_release;
382 #undef KERNEL_VERSION
383 #define KERNEL_VERSION(a, b, c) (((a) << 16) + ((b) << 8) + (c))
385 extern int read_int_from_file(const char *, int *);
387 extern void set_sortby(const char *);
388 extern void set_overhead(int);
389 extern void print_pc(struct tcb *);
391 extern int syscall_entering_decode(struct tcb *);
392 extern int syscall_entering_trace(struct tcb *, unsigned int *);
393 extern void syscall_entering_finish(struct tcb *, int);
395 extern int syscall_exiting_decode(struct tcb *, struct timeval *);
396 extern int syscall_exiting_trace(struct tcb *, struct timeval, int);
397 extern void syscall_exiting_finish(struct tcb *);
399 extern void count_syscall(struct tcb *, const struct timeval *);
400 extern void call_summary(FILE *);
402 extern void clear_regs(void);
403 extern int get_scno(struct tcb *);
404 extern kernel_ulong_t get_rt_sigframe_addr(struct tcb *);
407 * Convert syscall number to syscall name.
409 * @param scno Syscall number.
410 * @return String literal corresponding to the syscall number in case latter
411 * is valid; NULL otherwise.
413 extern const char *syscall_name(kernel_ulong_t scno);
414 extern const char *err_name(unsigned long err);
416 extern bool is_erestart(struct tcb *);
417 extern void temporarily_clear_syserror(struct tcb *);
418 extern void restore_cleared_syserror(struct tcb *);
420 extern void *get_tcb_priv_data(const struct tcb *);
421 extern int set_tcb_priv_data(struct tcb *, void *priv_data,
422 void (*free_priv_data)(void *));
423 extern void free_tcb_priv_data(struct tcb *);
425 static inline unsigned long get_tcb_priv_ulong(const struct tcb *tcp)
427 return (unsigned long) get_tcb_priv_data(tcp);
430 static inline int set_tcb_priv_ulong(struct tcb *tcp, unsigned long val)
432 return set_tcb_priv_data(tcp, (void *) val, 0);
436 umoven(struct tcb *, kernel_ulong_t addr, unsigned int len, void *laddr);
437 #define umove(pid, addr, objp) \
438 umoven((pid), (addr), sizeof(*(objp)), (void *) (objp))
441 umoven_or_printaddr(struct tcb *, kernel_ulong_t addr,
442 unsigned int len, void *laddr);
443 #define umove_or_printaddr(pid, addr, objp) \
444 umoven_or_printaddr((pid), (addr), sizeof(*(objp)), (void *) (objp))
447 umoven_or_printaddr_ignore_syserror(struct tcb *, kernel_ulong_t addr,
448 unsigned int len, void *laddr);
451 umovestr(struct tcb *, kernel_ulong_t addr, unsigned int len, char *laddr);
453 extern int upeek(struct tcb *tcp, unsigned long, kernel_ulong_t *);
454 extern int upoke(struct tcb *tcp, unsigned long, kernel_ulong_t);
457 print_array(struct tcb *,
458 kernel_ulong_t start_addr,
462 int (*umoven_func)(struct tcb *,
466 bool (*print_func)(struct tcb *,
472 #if defined ALPHA || defined IA64 || defined MIPS \
473 || defined SH || defined SPARC || defined SPARC64
474 # define HAVE_GETRVAL2
475 extern long getrval2(struct tcb *);
477 # undef HAVE_GETRVAL2
480 extern const char *signame(const int);
481 extern void pathtrace_select_set(const char *, struct path_set *);
482 extern bool pathtrace_match_set(struct tcb *, struct path_set *);
483 #define pathtrace_select(tcp) \
484 pathtrace_select_set(tcp, &global_path_set)
485 #define pathtrace_match(tcp) \
486 pathtrace_match_set(tcp, &global_path_set)
487 extern int getfdpath(struct tcb *, int, char *, unsigned);
488 extern unsigned long getfdinode(struct tcb *, int);
489 extern enum sock_proto getfdproto(struct tcb *, int);
491 extern const char *xlookup(const struct xlat *, const uint64_t);
492 extern const char *xlat_search(const struct xlat *, const size_t, const uint64_t);
495 struct dyxlat *dyxlat_alloc(size_t nmemb);
496 void dyxlat_free(struct dyxlat *);
497 const struct xlat *dyxlat_get(const struct dyxlat *);
498 void dyxlat_add_pair(struct dyxlat *, uint64_t val, const char *str, size_t len);
500 const struct xlat *genl_families_xlat(void);
502 extern unsigned long get_pagesize(void);
503 extern int next_set_bit(const void *bit_array, unsigned cur_bit, unsigned size_bits);
506 * Returns STR if it does not start with PREFIX,
507 * or a pointer to the first char in STR after PREFIX.
508 * The length of PREFIX is specified by PREFIX_LEN.
510 static inline const char *
511 str_strip_prefix_len(const char *str, const char *prefix, size_t prefix_len)
513 return strncmp(str, prefix, prefix_len) ? str : str + prefix_len;
516 #define STR_STRIP_PREFIX(str, prefix) \
517 str_strip_prefix_len((str), (prefix), sizeof(prefix) - 1)
519 #define QUOTE_0_TERMINATED 0x01
520 #define QUOTE_OMIT_LEADING_TRAILING_QUOTES 0x02
521 #define QUOTE_OMIT_TRAILING_0 0x08
522 #define QUOTE_FORCE_HEX 0x10
524 extern int string_quote(const char *, char *, unsigned int, unsigned int);
525 extern int print_quoted_string(const char *, unsigned int, unsigned int);
526 extern int print_quoted_cstring(const char *, unsigned int);
528 /* a refers to the lower numbered u_arg,
529 * b refers to the higher numbered u_arg
531 #ifdef WORDS_BIGENDIAN
532 # define ULONG_LONG(a, b) \
533 ((unsigned long long)(unsigned)(b) | ((unsigned long long)(a)<<32))
535 # define ULONG_LONG(a, b) \
536 ((unsigned long long)(unsigned)(a) | ((unsigned long long)(b)<<32))
538 extern int getllval(struct tcb *, unsigned long long *, int);
539 extern int printllval(struct tcb *, const char *, int)
540 ATTRIBUTE_FORMAT((printf, 2, 0));
542 extern void printaddr(kernel_ulong_t addr);
543 extern int printxvals(const uint64_t, const char *, const struct xlat *, ...)
545 extern int printxval_searchn(const struct xlat *xlat, size_t xlat_size,
546 uint64_t val, const char *dflt);
547 #define printxval_search(xlat__, val__, dflt__) \
548 printxval_searchn(xlat__, ARRAY_SIZE(xlat__), val__, dflt__)
549 extern int printargs(struct tcb *);
550 extern int printargs_u(struct tcb *);
551 extern int printargs_d(struct tcb *);
553 extern void addflags(const struct xlat *, uint64_t);
554 extern int printflags_ex(uint64_t, const char *, const struct xlat *, ...)
556 extern const char *sprintflags(const char *, const struct xlat *, uint64_t);
557 extern const char *sprinttime(long long sec);
558 extern const char *sprinttime_nsec(long long sec, unsigned long long nsec);
559 extern const char *sprinttime_usec(long long sec, unsigned long long usec);
560 extern void print_symbolic_mode_t(unsigned int);
561 extern void print_numeric_umode_t(unsigned short);
562 extern void print_numeric_long_umask(unsigned long);
563 extern void print_dev_t(unsigned long long dev);
564 extern void print_abnormal_hi(kernel_ulong_t);
567 dumpiov_in_msghdr(struct tcb *, kernel_ulong_t addr, kernel_ulong_t data_size);
570 dumpiov_in_mmsghdr(struct tcb *, kernel_ulong_t addr);
573 dumpiov_upto(struct tcb *, int len, kernel_ulong_t addr, kernel_ulong_t data_size);
576 dumpstr(struct tcb *, kernel_ulong_t addr, int len);
579 printstr_ex(struct tcb *, kernel_ulong_t addr, kernel_ulong_t len,
580 unsigned int user_style);
583 printpathn(struct tcb *, kernel_ulong_t addr, unsigned int n);
586 printpath(struct tcb *, kernel_ulong_t addr);
588 #define TIMESPEC_TEXT_BUFSIZE \
589 (sizeof(long long) * 3 * 2 + sizeof("{tv_sec=-, tv_nsec=}"))
590 extern void printfd(struct tcb *, int);
591 extern void print_sockaddr(const void *sa, int len);
593 print_inet_addr(int af, const void *addr, unsigned int len, const char *var_name);
595 decode_inet_addr(struct tcb *, kernel_ulong_t addr,
596 unsigned int len, int family, const char *var_name);
597 extern const char *get_sockaddr_by_inode(struct tcb *, int fd, unsigned long inode);
598 extern bool print_sockaddr_by_inode(struct tcb *, int fd, unsigned long inode);
599 extern void print_dirfd(struct tcb *, int);
602 decode_sockaddr(struct tcb *, kernel_ulong_t addr, int addrlen);
604 extern void printuid(const char *, const unsigned int);
607 print_sigset_addr_len(struct tcb *, kernel_ulong_t addr, kernel_ulong_t len);
609 print_sigset_addr(struct tcb *, kernel_ulong_t addr);
611 extern const char *sprintsigmask_n(const char *, const void *, unsigned int);
612 #define tprintsigmask_addr(prefix, mask) \
613 tprints(sprintsigmask_n((prefix), (mask), sizeof(mask)))
614 extern void printsignal(int);
617 tprint_iov_upto(struct tcb *, kernel_ulong_t len, kernel_ulong_t addr,
618 enum iov_decode, kernel_ulong_t data_size);
621 decode_netlink(struct tcb *, int fd, kernel_ulong_t addr, kernel_ulong_t len);
623 extern void tprint_open_modes(unsigned int);
624 extern const char *sprint_open_modes(unsigned int);
627 decode_seccomp_fprog(struct tcb *, kernel_ulong_t addr);
630 print_seccomp_fprog(struct tcb *, kernel_ulong_t addr, unsigned short len);
633 decode_sock_fprog(struct tcb *, kernel_ulong_t addr);
636 print_sock_fprog(struct tcb *, kernel_ulong_t addr, unsigned short len);
639 extern void print_struct_stat(struct tcb *, const struct strace_stat *const st);
641 struct strace_statfs;
642 struct strace_keyctl_kdf_params;
645 print_struct_statfs(struct tcb *, kernel_ulong_t addr);
648 print_struct_statfs64(struct tcb *, kernel_ulong_t addr, kernel_ulong_t size);
650 extern void print_ifindex(unsigned int);
652 extern void qualify(const char *);
653 extern unsigned int qual_flags(const unsigned int);
655 #define DECL_IOCTL(name) \
657 name ## _ioctl(struct tcb *, unsigned int request, kernel_ulong_t arg) \
658 /* End of DECL_IOCTL definition. */
672 extern int decode_sg_io_v4(struct tcb *, const kernel_ulong_t arg);
676 typedef bool (*netlink_decoder_t)(struct tcb *, const struct nlmsghdr *,
677 kernel_ulong_t addr, unsigned int len);
679 #define DECL_NETLINK(name) \
681 decode_netlink_ ## name(struct tcb *, const struct nlmsghdr *, \
682 kernel_ulong_t addr, unsigned int len) \
683 /* End of DECL_NETLINK definition. */
685 DECL_NETLINK(crypto);
687 DECL_NETLINK(selinux);
688 DECL_NETLINK(sock_diag);
690 extern int tv_nz(const struct timeval *);
691 extern int tv_cmp(const struct timeval *, const struct timeval *);
692 extern double tv_float(const struct timeval *);
693 extern void tv_add(struct timeval *, const struct timeval *, const struct timeval *);
694 extern void tv_sub(struct timeval *, const struct timeval *, const struct timeval *);
695 extern void tv_mul(struct timeval *, const struct timeval *, int);
696 extern void tv_div(struct timeval *, const struct timeval *, int);
699 extern void unwind_init(void);
700 extern void unwind_tcb_init(struct tcb *);
701 extern void unwind_tcb_fin(struct tcb *);
702 extern void unwind_cache_invalidate(struct tcb *);
703 extern void unwind_print_stacktrace(struct tcb *);
704 extern void unwind_capture_stacktrace(struct tcb *);
708 printstrn(struct tcb *tcp, kernel_ulong_t addr, kernel_ulong_t len)
710 printstr_ex(tcp, addr, len, 0);
714 printstr(struct tcb *tcp, kernel_ulong_t addr)
716 printstr_ex(tcp, addr, -1, QUOTE_0_TERMINATED);
720 printflags64(const struct xlat *x, uint64_t flags, const char *dflt)
722 return printflags_ex(flags, dflt, x, NULL);
726 printflags(const struct xlat *x, unsigned int flags, const char *dflt)
728 return printflags64(x, flags, dflt);
732 printxval64(const struct xlat *x, const uint64_t val, const char *dflt)
734 return printxvals(val, dflt, x, NULL);
738 printxval(const struct xlat *x, const unsigned int val, const char *dflt)
740 return printxvals(val, dflt, x, NULL);
744 tprint_iov(struct tcb *tcp, kernel_ulong_t len, kernel_ulong_t addr,
745 enum iov_decode decode_iov)
747 tprint_iov_upto(tcp, len, addr, decode_iov, -1);
755 extern void print_timeval32_t(const timeval32_t *);
756 extern void printrusage32(struct tcb *, kernel_ulong_t);
757 extern const char *sprint_timeval32(struct tcb *, kernel_ulong_t addr);
758 extern void print_timeval32(struct tcb *, kernel_ulong_t addr);
759 extern void print_timeval32_utimes(struct tcb *, kernel_ulong_t addr);
760 extern void print_itimerval32(struct tcb *, kernel_ulong_t addr);
763 #ifdef HAVE_STRUCT_USER_DESC
764 extern void print_user_desc(struct tcb *, kernel_ulong_t addr);
767 /* Strace log generation machinery.
769 * printing_tcp: tcb which has incomplete line being printed right now.
770 * NULL if last line has been completed ('\n'-terminated).
771 * printleader(tcp) examines it, finishes incomplete line if needed,
772 * the sets it to tcp.
773 * line_ended() clears printing_tcp and resets ->curcol = 0.
774 * tcp->curcol == 0 check is also used to detect completeness
775 * of last line, since in -ff mode just checking printing_tcp for NULL
778 * If you change this code, test log generation in both -f and -ff modes
780 * strace -oLOG -f[f] test/threaded_execve
781 * strace -oLOG -f[f] test/sigkill_rain
782 * strace -oLOG -f[f] -p "`pidof web_browser`"
784 extern struct tcb *printing_tcp;
785 extern void printleader(struct tcb *);
786 extern void line_ended(void);
787 extern void tabto(void);
788 extern void tprintf(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2));
789 extern void tprints(const char *str);
790 extern void tprintf_comment(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2));
791 extern void tprints_comment(const char *str);
793 #if SUPPORTED_PERSONALITIES > 1
794 extern void set_personality(int personality);
795 extern unsigned current_personality;
797 # define set_personality(personality) ((void)0)
798 # define current_personality 0
801 #if SUPPORTED_PERSONALITIES == 1
802 # define current_wordsize PERSONALITY0_WORDSIZE
803 # define current_klongsize PERSONALITY0_KLONGSIZE
805 # if SUPPORTED_PERSONALITIES == 2 && PERSONALITY0_WORDSIZE == PERSONALITY1_WORDSIZE
806 # define current_wordsize PERSONALITY0_WORDSIZE
808 extern unsigned current_wordsize;
810 # if SUPPORTED_PERSONALITIES == 2 && PERSONALITY0_KLONGSIZE == PERSONALITY1_KLONGSIZE
811 # define current_klongsize PERSONALITY0_KLONGSIZE
813 extern unsigned current_klongsize;
817 #define ANY_WORDSIZE_LESS_THAN_KERNEL_LONG \
818 (SIZEOF_KERNEL_LONG_T > 4 \
819 && (SIZEOF_LONG < SIZEOF_KERNEL_LONG_T || !defined(current_wordsize)))
821 #define DECL_PRINTNUM(name) \
823 printnum_ ## name(struct tcb *, kernel_ulong_t addr, const char *fmt) \
824 ATTRIBUTE_FORMAT((printf, 3, 0)) \
825 /* End of DECL_PRINTNUM definition. */
827 DECL_PRINTNUM(short);
829 DECL_PRINTNUM(int64);
832 #define DECL_PRINTNUM_ADDR(name) \
834 printnum_addr_ ## name(struct tcb *, kernel_ulong_t addr) \
835 /* End of DECL_PRINTNUM_ADDR definition. */
837 DECL_PRINTNUM_ADDR(int);
838 DECL_PRINTNUM_ADDR(int64);
839 #undef DECL_PRINTNUM_ADDR
841 #ifndef current_wordsize
843 printnum_long_int(struct tcb *, kernel_ulong_t addr,
844 const char *fmt_long, const char *fmt_int)
845 ATTRIBUTE_FORMAT((printf, 3, 0))
846 ATTRIBUTE_FORMAT((printf, 4, 0));
847 extern bool printnum_addr_long_int(struct tcb *, kernel_ulong_t addr);
848 # define printnum_slong(tcp, addr) \
849 printnum_long_int((tcp), (addr), "%" PRId64, "%d")
850 # define printnum_ulong(tcp, addr) \
851 printnum_long_int((tcp), (addr), "%" PRIu64, "%u")
852 # define printnum_ptr(tcp, addr) \
853 printnum_addr_long_int((tcp), (addr))
854 #elif current_wordsize > 4
855 # define printnum_slong(tcp, addr) \
856 printnum_int64((tcp), (addr), "%" PRId64)
857 # define printnum_ulong(tcp, addr) \
858 printnum_int64((tcp), (addr), "%" PRIu64)
859 # define printnum_ptr(tcp, addr) \
860 printnum_addr_int64((tcp), (addr))
861 #else /* current_wordsize == 4 */
862 # define printnum_slong(tcp, addr) \
863 printnum_int((tcp), (addr), "%d")
864 # define printnum_ulong(tcp, addr) \
865 printnum_int((tcp), (addr), "%u")
866 # define printnum_ptr(tcp, addr) \
867 printnum_addr_int((tcp), (addr))
870 #ifndef current_klongsize
871 extern bool printnum_addr_klong_int(struct tcb *, kernel_ulong_t addr);
872 # define printnum_kptr(tcp, addr) \
873 printnum_addr_klong_int((tcp), (addr))
874 #elif current_klongsize > 4
875 # define printnum_kptr(tcp, addr) \
876 printnum_addr_int64((tcp), (addr))
877 #else /* current_klongsize == 4 */
878 # define printnum_kptr(tcp, addr) \
879 printnum_addr_int((tcp), (addr))
882 #define DECL_PRINTPAIR(name) \
884 printpair_ ## name(struct tcb *, kernel_ulong_t addr, const char *fmt) \
885 ATTRIBUTE_FORMAT((printf, 3, 0)) \
886 /* End of DECL_PRINTPAIR definition. */
889 DECL_PRINTPAIR(int64);
890 #undef DECL_PRINTPAIR
892 static inline kernel_long_t
893 truncate_klong_to_current_wordsize(const kernel_long_t v)
895 #if ANY_WORDSIZE_LESS_THAN_KERNEL_LONG
896 if (current_wordsize < sizeof(v)) {
905 static inline kernel_ulong_t
906 truncate_kulong_to_current_wordsize(const kernel_ulong_t v)
908 #if ANY_WORDSIZE_LESS_THAN_KERNEL_LONG
909 if (current_wordsize < sizeof(v)) {
910 return (unsigned int) v;
919 * Cast a pointer or a pointer-sized integer to kernel_ulong_t.
921 #define ptr_to_kulong(v) ((kernel_ulong_t) (unsigned long) (v))
924 * Zero-extend a signed integer type to unsigned long long.
926 #define zero_extend_signed_to_ull(v) \
927 (sizeof(v) == sizeof(char) ? (unsigned long long) (unsigned char) (v) : \
928 sizeof(v) == sizeof(short) ? (unsigned long long) (unsigned short) (v) : \
929 sizeof(v) == sizeof(int) ? (unsigned long long) (unsigned int) (v) : \
930 sizeof(v) == sizeof(long) ? (unsigned long long) (unsigned long) (v) : \
931 (unsigned long long) (v))
934 * Sign-extend an unsigned integer type to long long.
936 #define sign_extend_unsigned_to_ll(v) \
937 (sizeof(v) == sizeof(char) ? (long long) (char) (v) : \
938 sizeof(v) == sizeof(short) ? (long long) (short) (v) : \
939 sizeof(v) == sizeof(int) ? (long long) (int) (v) : \
940 sizeof(v) == sizeof(long) ? (long long) (long) (v) : \
943 extern const struct_sysent sysent0[];
944 extern const char *const errnoent0[];
945 extern const char *const signalent0[];
946 extern const struct_ioctlent ioctlent0[];
948 #if SUPPORTED_PERSONALITIES > 1
949 extern const struct_sysent *sysent;
950 extern const char *const *errnoent;
951 extern const char *const *signalent;
952 extern const struct_ioctlent *ioctlent;
954 # define sysent sysent0
955 # define errnoent errnoent0
956 # define signalent signalent0
957 # define ioctlent ioctlent0
960 extern unsigned nsyscalls;
961 extern unsigned nerrnos;
962 extern unsigned nsignals;
963 extern unsigned nioctlents;
965 extern const unsigned int nsyscall_vec[SUPPORTED_PERSONALITIES];
966 extern const struct_sysent *const sysent_vec[SUPPORTED_PERSONALITIES];
967 extern struct inject_opts *inject_vec[SUPPORTED_PERSONALITIES];
969 #ifdef IN_MPERS_BOOTSTRAP
970 /* Transform multi-line MPERS_PRINTER_DECL statements to one-liners. */
971 # define MPERS_PRINTER_DECL(type, name, ...) MPERS_PRINTER_DECL(type, name, __VA_ARGS__)
972 #else /* !IN_MPERS_BOOTSTRAP */
973 # if SUPPORTED_PERSONALITIES > 1
974 # include "printers.h"
976 # include "native_printer_decls.h"
978 # define MPERS_PRINTER_DECL(type, name, ...) type MPERS_FUNC_NAME(name)(__VA_ARGS__)
979 #endif /* !IN_MPERS_BOOTSTRAP */
981 /* Checks that sysent[scno] is not out of range. */
983 scno_in_range(kernel_ulong_t scno)
985 return scno < nsyscalls;
989 * Checks whether scno is not out of range,
990 * its corresponding sysent[scno].sys_func is non-NULL,
991 * and its sysent[scno].sys_flags has no TRACE_INDIRECT_SUBCALL flag set.
994 scno_is_valid(kernel_ulong_t scno)
996 return scno_in_range(scno)
997 && sysent[scno].sys_func
998 && !(sysent[scno].sys_flags & TRACE_INDIRECT_SUBCALL);
1001 #define MPERS_FUNC_NAME__(prefix, name) prefix ## name
1002 #define MPERS_FUNC_NAME_(prefix, name) MPERS_FUNC_NAME__(prefix, name)
1003 #define MPERS_FUNC_NAME(name) MPERS_FUNC_NAME_(MPERS_PREFIX, name)
1005 #define SYS_FUNC_NAME(syscall_name) MPERS_FUNC_NAME(syscall_name)
1007 #define SYS_FUNC(syscall_name) int SYS_FUNC_NAME(sys_ ## syscall_name)(struct tcb *tcp)
1009 #endif /* !STRACE_DEFS_H */