granicus.if.org Git - strace/blob - defs.h

   1 /*
   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  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. The name of the author may not be used to endorse or promote products
  16  *    derived from this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  19  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  20  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  21  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  23  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30 #ifndef STRACE_DEFS_H
  31 #define STRACE_DEFS_H
  32
  33 #ifdef HAVE_CONFIG_H
  34 # include "config.h"
  35 #endif
  36
  37 #include <features.h>
  38 #include <stdbool.h>
  39 #include <stdint.h>
  40 #include <inttypes.h>
  41 #include <sys/types.h>
  42 #include <stddef.h>
  43 #include <unistd.h>
  44 #include <stdlib.h>
  45 #include <stdio.h>
  46 /* Open-coding isprint(ch) et al proved more efficient than calling
  47  * generalized libc interface. We don't *want* to do non-ASCII anyway.
  48  */
  49 /* #include <ctype.h> */
  50 #include <string.h>
  51 #include <errno.h>
  52 #include <time.h>
  53 #include <sys/time.h>
  54 #include <asm/unistd.h>
  55
  56 #include "kernel_types.h"
  57 #include "mpers_type.h"
  58 #include "gcc_compat.h"
  59
  60 #ifndef HAVE_STRERROR
  61 const char *strerror(int);
  62 #endif
  63 #ifndef HAVE_STPCPY
  64 /* Some libc have stpcpy, some don't. Sigh...
  65  * Roll our private implementation...
  66  */
  67 #undef stpcpy
  68 #define stpcpy strace_stpcpy
  69 extern char *stpcpy(char *dst, const char *src);
  70 #endif
  71
  72 #ifndef offsetofend
  73 # define offsetofend(type, member) \
  74         (offsetof(type, member) + sizeof(((type *)NULL)->member))
  75 #endif
  76
  77 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]) + MUST_BE_ARRAY(a))
  78
  79 /* macros */
  80 #ifndef MAX
  81 # define MAX(a, b)              (((a) > (b)) ? (a) : (b))
  82 #endif
  83 #ifndef MIN
  84 # define MIN(a, b)              (((a) < (b)) ? (a) : (b))
  85 #endif
  86 #define CLAMP(val, min, max) MIN(MAX(min, val), max)
  87
  88 /* Glibc has an efficient macro for sigemptyset
  89  * (it just does one or two assignments of 0 to internal vector of longs).
  90  */
  91 #if defined(__GLIBC__) && defined(__sigemptyset) && !defined(sigemptyset)
  92 # define sigemptyset __sigemptyset
  93 #endif
  94
  95 /* Configuration section */
  96 #ifndef DEFAULT_STRLEN
  97 /* default maximum # of bytes printed in `printstr', change with -s switch */
  98 # define DEFAULT_STRLEN 32
  99 #endif
 100 #ifndef DEFAULT_ACOLUMN
 101 # define DEFAULT_ACOLUMN        40      /* default alignment column for results */
 102 #endif
 103 /*
 104  * Maximum number of args to a syscall.
 105  *
 106  * Make sure that all entries in all syscallent.h files have nargs <= MAX_ARGS!
 107  * linux/<ARCH>/syscallent*.h:
 108  *      all have nargs <= 6 except mips o32 which has nargs <= 7.
 109  */
 110 #ifndef MAX_ARGS
 111 # ifdef LINUX_MIPSO32
 112 #  define MAX_ARGS      7
 113 # else
 114 #  define MAX_ARGS      6
 115 # endif
 116 #endif
 117 /* default sorting method for call profiling */
 118 #ifndef DEFAULT_SORTBY
 119 # define DEFAULT_SORTBY "time"
 120 #endif
 121 /*
 122  * Experimental code using PTRACE_SEIZE can be enabled here.
 123  * This needs Linux kernel 3.4.x or later to work.
 124  */
 125 #define USE_SEIZE 1
 126 /* To force NOMMU build, set to 1 */
 127 #define NOMMU_SYSTEM 0
 128 /*
 129  * Set to 1 to use speed-optimized vfprintf implementation.
 130  * It results in strace using about 5% less CPU in user space
 131  * (compared to glibc version).
 132  * But strace spends a lot of time in kernel space,
 133  * so overall it does not appear to be a significant win.
 134  * Thus disabled by default.
 135  */
 136 #define USE_CUSTOM_PRINTF 0
 137
 138 #ifndef ERESTARTSYS
 139 # define ERESTARTSYS    512
 140 #endif
 141 #ifndef ERESTARTNOINTR
 142 # define ERESTARTNOINTR 513
 143 #endif
 144 #ifndef ERESTARTNOHAND
 145 # define ERESTARTNOHAND 514
 146 #endif
 147 #ifndef ERESTART_RESTARTBLOCK
 148 # define ERESTART_RESTARTBLOCK 516
 149 #endif
 150
 151 #if defined X86_64
 152 # define SUPPORTED_PERSONALITIES 3
 153 # define PERSONALITY2_WORDSIZE  4
 154 # define PERSONALITY2_KLONGSIZE PERSONALITY0_KLONGSIZE
 155 #elif defined AARCH64 \
 156    || defined POWERPC64 \
 157    || defined RISCV \
 158    || defined SPARC64 \
 159    || defined TILE \
 160    || defined X32
 161 # define SUPPORTED_PERSONALITIES 2
 162 #else
 163 # define SUPPORTED_PERSONALITIES 1
 164 #endif
 165
 166 #if defined TILE && defined __tilepro__
 167 # define DEFAULT_PERSONALITY 1
 168 #else
 169 # define DEFAULT_PERSONALITY 0
 170 #endif
 171
 172 #define PERSONALITY0_WORDSIZE  SIZEOF_LONG
 173 #define PERSONALITY0_KLONGSIZE SIZEOF_KERNEL_LONG_T
 174 #define PERSONALITY0_INCLUDE_PRINTERS_DECLS "native_printer_decls.h"
 175 #define PERSONALITY0_INCLUDE_PRINTERS_DEFS "native_printer_defs.h"
 176
 177 #if SUPPORTED_PERSONALITIES > 1
 178 # define PERSONALITY1_WORDSIZE  4
 179 # define PERSONALITY1_KLONGSIZE PERSONALITY1_WORDSIZE
 180 #endif
 181
 182 #if SUPPORTED_PERSONALITIES > 1 && defined HAVE_M32_MPERS
 183 # define PERSONALITY1_INCLUDE_PRINTERS_DECLS "m32_printer_decls.h"
 184 # define PERSONALITY1_INCLUDE_PRINTERS_DEFS "m32_printer_defs.h"
 185 # define PERSONALITY1_INCLUDE_FUNCS "m32_funcs.h"
 186 # define MPERS_m32_IOCTL_MACROS "ioctl_redefs1.h"
 187 #else
 188 # define PERSONALITY1_INCLUDE_PRINTERS_DECLS "native_printer_decls.h"
 189 # define PERSONALITY1_INCLUDE_PRINTERS_DEFS "native_printer_defs.h"
 190 # define PERSONALITY1_INCLUDE_FUNCS "empty.h"
 191 #endif
 192
 193 #if SUPPORTED_PERSONALITIES > 2 && defined HAVE_MX32_MPERS
 194 # define PERSONALITY2_INCLUDE_FUNCS "mx32_funcs.h"
 195 # define PERSONALITY2_INCLUDE_PRINTERS_DECLS "mx32_printer_decls.h"
 196 # define PERSONALITY2_INCLUDE_PRINTERS_DEFS "mx32_printer_defs.h"
 197 # define MPERS_mx32_IOCTL_MACROS "ioctl_redefs2.h"
 198 #else
 199 # define PERSONALITY2_INCLUDE_PRINTERS_DECLS "native_printer_decls.h"
 200 # define PERSONALITY2_INCLUDE_PRINTERS_DEFS "native_printer_defs.h"
 201 # define PERSONALITY2_INCLUDE_FUNCS "empty.h"
 202 #endif
 203
 204 typedef struct sysent {
 205         unsigned nargs;
 206         int     sys_flags;
 207         int     sen;
 208         int     (*sys_func)();
 209         const char *sys_name;
 210 } struct_sysent;
 211
 212 typedef struct ioctlent {
 213         const char *symbol;
 214         unsigned int code;
 215 } struct_ioctlent;
 216
 217 struct fault_opts {
 218         uint16_t first;
 219         uint16_t step;
 220         uint16_t err;
 221 };
 222
 223 /* Trace Control Block */
 224 struct tcb {
 225         int flags;              /* See below for TCB_ values */
 226         int pid;                /* If 0, this tcb is free */
 227         int qual_flg;           /* qual_flags[scno] or DEFAULT_QUAL_FLAGS + RAW */
 228         unsigned long u_error;  /* Error code */
 229         kernel_ulong_t scno;    /* System call number */
 230         kernel_ulong_t u_arg[MAX_ARGS]; /* System call arguments */
 231         kernel_long_t u_rval;   /* Return value */
 232 #if SUPPORTED_PERSONALITIES > 1
 233         unsigned int currpers;  /* Personality at the time of scno update */
 234 #endif
 235         int sys_func_rval;      /* Syscall entry parser's return value */
 236         int curcol;             /* Output column for this process */
 237         FILE *outf;             /* Output file for this process */
 238         const char *auxstr;     /* Auxiliary info from syscall (see RVAL_STR) */
 239         void *_priv_data;       /* Private data for syscall decoding functions */
 240         void (*_free_priv_data)(void *); /* Callback for freeing priv_data */
 241         const struct_sysent *s_ent; /* sysent[scno] or dummy struct for bad scno */
 242         const struct_sysent *s_prev_ent; /* for "resuming interrupted SYSCALL" msg */
 243         struct fault_opts *fault_vec[SUPPORTED_PERSONALITIES];
 244         struct timeval stime;   /* System time usage as of last process wait */
 245         struct timeval dtime;   /* Delta for system time usage */
 246         struct timeval etime;   /* Syscall entry time */
 247
 248 #ifdef USE_LIBUNWIND
 249         struct UPT_info* libunwind_ui;
 250         struct mmap_cache_t* mmap_cache;
 251         unsigned int mmap_cache_size;
 252         unsigned int mmap_cache_generation;
 253         struct queue_t* queue;
 254 #endif
 255 };
 256
 257 /* TCB flags */
 258 /* We have attached to this process, but did not see it stopping yet */
 259 #define TCB_STARTUP             0x01
 260 #define TCB_IGNORE_ONE_SIGSTOP  0x02    /* Next SIGSTOP is to be ignored */
 261 /*
 262  * Are we in system call entry or in syscall exit?
 263  *
 264  * This bit is set after all syscall entry processing is done.
 265  * Therefore, this bit will be set when next ptrace stop occurs,
 266  * which should be syscall exit stop. Other stops which are possible
 267  * directly after syscall entry (death, ptrace event stop)
 268  * are simpler and handled without calling trace_syscall(), therefore
 269  * the places where TCB_INSYSCALL can be set but we aren't in syscall stop
 270  * are limited to trace(), this condition is never observed in trace_syscall()
 271  * and below.
 272  * The bit is cleared after all syscall exit processing is done.
 273  *
 274  * Use entering(tcp) / exiting(tcp) to check this bit to make code more readable.
 275  */
 276 #define TCB_INSYSCALL   0x04
 277 #define TCB_ATTACHED    0x08    /* We attached to it already */
 278 #define TCB_REPRINT     0x10    /* We should reprint this syscall on exit */
 279 #define TCB_FILTERED    0x20    /* This system call has been filtered out */
 280 #define TCB_FAULT_INJ   0x40    /* A syscall fault has been injected */
 281 #define TCB_HIDE_LOG    0x80    /* We should hide everything (until execve) */
 282 #define TCB_SKIP_DETACH_ON_FIRST_EXEC   0x100   /* -b execve should skip detach on first execve */
 283
 284 /* qualifier flags */
 285 #define QUAL_TRACE      0x001   /* this system call should be traced */
 286 #define QUAL_ABBREV     0x002   /* abbreviate the structures of this syscall */
 287 #define QUAL_VERBOSE    0x004   /* decode the structures of this syscall */
 288 #define QUAL_RAW        0x008   /* print all args in hex for this syscall */
 289 #define QUAL_FAULT      0x010   /* fail this system call on purpose */
 290 #define QUAL_SIGNAL     0x100   /* report events with this signal */
 291 #define QUAL_READ       0x200   /* dump data read from this file descriptor */
 292 #define QUAL_WRITE      0x400   /* dump data written to this file descriptor */
 293
 294 #define DEFAULT_QUAL_FLAGS (QUAL_TRACE | QUAL_ABBREV | QUAL_VERBOSE)
 295
 296 #define entering(tcp)   (!((tcp)->flags & TCB_INSYSCALL))
 297 #define exiting(tcp)    ((tcp)->flags & TCB_INSYSCALL)
 298 #define syserror(tcp)   ((tcp)->u_error != 0)
 299 #define verbose(tcp)    ((tcp)->qual_flg & QUAL_VERBOSE)
 300 #define abbrev(tcp)     ((tcp)->qual_flg & QUAL_ABBREV)
 301 #define filtered(tcp)   ((tcp)->flags & TCB_FILTERED)
 302 #define hide_log(tcp)   ((tcp)->flags & TCB_HIDE_LOG)
 303
 304 #include "xlat.h"
 305
 306 extern const struct xlat addrfams[];
 307 extern const struct xlat at_flags[];
 308 extern const struct xlat dirent_types[];
 309 extern const struct xlat evdev_abs[];
 310 extern const struct xlat msg_flags[];
 311 extern const struct xlat open_access_modes[];
 312 extern const struct xlat open_mode_flags[];
 313 extern const struct xlat resource_flags[];
 314 extern const struct xlat socketlayers[];
 315 extern const struct xlat whence_codes[];
 316
 317 /* Format of syscall return values */
 318 #define RVAL_DECIMAL    000     /* decimal format */
 319 #define RVAL_HEX        001     /* hex format */
 320 #define RVAL_OCTAL      002     /* octal format */
 321 #define RVAL_UDECIMAL   003     /* unsigned decimal format */
 322 #define RVAL_FD         010     /* file descriptor */
 323 #define RVAL_MASK       013     /* mask for these values */
 324
 325 #define RVAL_STR        020     /* Print `auxstr' field after return val */
 326 #define RVAL_NONE       040     /* Print nothing */
 327
 328 #define RVAL_DECODED    0100    /* syscall decoding finished */
 329
 330 #define TRACE_FILE      001     /* Trace file-related syscalls. */
 331 #define TRACE_IPC       002     /* Trace IPC-related syscalls. */
 332 #define TRACE_NETWORK   004     /* Trace network-related syscalls. */
 333 #define TRACE_PROCESS   010     /* Trace process-related syscalls. */
 334 #define TRACE_SIGNAL    020     /* Trace signal-related syscalls. */
 335 #define TRACE_DESC      040     /* Trace file descriptor-related syscalls. */
 336 #define TRACE_MEMORY    0100    /* Trace memory mapping-related syscalls. */
 337 #define SYSCALL_NEVER_FAILS     0200    /* Syscall is always successful. */
 338 #define STACKTRACE_INVALIDATE_CACHE 0400  /* Trigger proc/maps cache updating */
 339 #define STACKTRACE_CAPTURE_ON_ENTER 01000 /* Capture stacktrace on "entering" stage */
 340 #define TRACE_INDIRECT_SUBCALL  02000   /* Syscall is an indirect socket/ipc subcall. */
 341 #define COMPAT_SYSCALL_TYPES    04000   /* A compat syscall that uses compat types. */
 342
 343 #define IOCTL_NUMBER_UNKNOWN 0
 344 #define IOCTL_NUMBER_HANDLED 1
 345 #define IOCTL_NUMBER_STOP_LOOKUP 010
 346
 347 #define indirect_ipccall(tcp) (tcp->s_ent->sys_flags & TRACE_INDIRECT_SUBCALL)
 348
 349 #if defined(ARM) || defined(AARCH64) \
 350  || defined(I386) || defined(X32) || defined(X86_64) \
 351  || defined(IA64) \
 352  || defined(BFIN) \
 353  || defined(M68K) \
 354  || defined(MICROBLAZE) \
 355  || defined(RISCV) \
 356  || defined(S390) \
 357  || defined(SH) || defined(SH64) \
 358  || defined(SPARC) || defined(SPARC64) \
 359  /**/
 360 # define NEED_UID16_PARSERS 1
 361 #else
 362 # define NEED_UID16_PARSERS 0
 363 #endif
 364
 365 enum sock_proto {
 366         SOCK_PROTO_UNKNOWN,
 367         SOCK_PROTO_UNIX,
 368         SOCK_PROTO_TCP,
 369         SOCK_PROTO_UDP,
 370         SOCK_PROTO_TCPv6,
 371         SOCK_PROTO_UDPv6,
 372         SOCK_PROTO_NETLINK
 373 };
 374 extern enum sock_proto get_proto_by_name(const char *);
 375
 376 enum iov_decode {
 377         IOV_DECODE_ADDR,
 378         IOV_DECODE_STR,
 379         IOV_DECODE_NETLINK
 380 };
 381
 382 typedef enum {
 383         CFLAG_NONE = 0,
 384         CFLAG_ONLY_STATS,
 385         CFLAG_BOTH
 386 } cflag_t;
 387 extern cflag_t cflag;
 388 extern bool debug_flag;
 389 extern bool Tflag;
 390 extern bool iflag;
 391 extern bool count_wallclock;
 392 extern unsigned int qflag;
 393 extern bool not_failing_only;
 394 extern unsigned int show_fd_path;
 395 /* are we filtering traces based on paths? */
 396 extern const char **paths_selected;
 397 #define tracing_paths (paths_selected != NULL)
 398 extern unsigned xflag;
 399 extern unsigned followfork;
 400 #ifdef USE_LIBUNWIND
 401 /* if this is true do the stack trace for every system call */
 402 extern bool stack_trace_enabled;
 403 #endif
 404 extern unsigned ptrace_setoptions;
 405 extern unsigned max_strlen;
 406 extern unsigned os_release;
 407 #undef KERNEL_VERSION
 408 #define KERNEL_VERSION(a,b,c) (((a) << 16) + ((b) << 8) + (c))
 409
 410 void error_msg(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2));
 411 void perror_msg(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2));
 412 void error_msg_and_die(const char *fmt, ...)
 413         ATTRIBUTE_FORMAT((printf, 1, 2)) ATTRIBUTE_NORETURN;
 414 void error_msg_and_help(const char *fmt, ...)
 415         ATTRIBUTE_FORMAT((printf, 1, 2)) ATTRIBUTE_NORETURN;
 416 void perror_msg_and_die(const char *fmt, ...)
 417         ATTRIBUTE_FORMAT((printf, 1, 2)) ATTRIBUTE_NORETURN;
 418 void die_out_of_memory(void) ATTRIBUTE_NORETURN;
 419
 420 void *xmalloc(size_t size) ATTRIBUTE_MALLOC ATTRIBUTE_ALLOC_SIZE((1));
 421 void *xcalloc(size_t nmemb, size_t size)
 422         ATTRIBUTE_MALLOC ATTRIBUTE_ALLOC_SIZE((1, 2));
 423 void *xreallocarray(void *ptr, size_t nmemb, size_t size)
 424         ATTRIBUTE_ALLOC_SIZE((2, 3));
 425 char *xstrdup(const char *str) ATTRIBUTE_MALLOC;
 426
 427 #if USE_CUSTOM_PRINTF
 428 /*
 429  * See comment in vsprintf.c for allowed formats.
 430  * Short version: %h[h]u, %zu, %tu are not allowed, use %[l[l]]u.
 431  */
 432 int strace_vfprintf(FILE *fp, const char *fmt, va_list args);
 433 #else
 434 # define strace_vfprintf vfprintf
 435 #endif
 436
 437 extern int read_int_from_file(const char *, int *);
 438
 439 extern void set_sortby(const char *);
 440 extern void set_overhead(int);
 441 extern void print_pc(struct tcb *);
 442 extern int trace_syscall(struct tcb *);
 443 extern void count_syscall(struct tcb *, const struct timeval *);
 444 extern void call_summary(FILE *);
 445
 446 extern void clear_regs(void);
 447 extern void get_regs(pid_t pid);
 448 extern int get_scno(struct tcb *tcp);
 449 /**
 450  * Convert syscall number to syscall name.
 451  *
 452  * @param scno Syscall number.
 453  * @return     String literal corresponding to the syscall number in case latter
 454  *             is valid; NULL otherwise.
 455  */
 456 extern const char *syscall_name(kernel_ulong_t scno);
 457 extern const char *err_name(unsigned long err);
 458
 459 extern bool is_erestart(struct tcb *);
 460 extern void temporarily_clear_syserror(struct tcb *);
 461 extern void restore_cleared_syserror(struct tcb *);
 462
 463 extern void *get_tcb_priv_data(const struct tcb *);
 464 extern int set_tcb_priv_data(struct tcb *, void *priv_data,
 465                              void (*free_priv_data)(void *));
 466 extern void free_tcb_priv_data(struct tcb *);
 467
 468 static inline unsigned long get_tcb_priv_ulong(const struct tcb *tcp)
 469 {
 470         return (unsigned long) get_tcb_priv_data(tcp);
 471 }
 472
 473 static inline int set_tcb_priv_ulong(struct tcb *tcp, unsigned long val)
 474 {
 475         return set_tcb_priv_data(tcp, (void *) val, 0);
 476 }
 477
 478 extern int
 479 umoven(struct tcb *tcp, kernel_ulong_t addr, unsigned int len, void *laddr);
 480 #define umove(pid, addr, objp)  \
 481         umoven((pid), (addr), sizeof(*(objp)), (void *) (objp))
 482
 483 extern int
 484 umoven_or_printaddr(struct tcb *tcp, kernel_ulong_t addr,
 485                     unsigned int len, void *laddr);
 486 #define umove_or_printaddr(pid, addr, objp)     \
 487         umoven_or_printaddr((pid), (addr), sizeof(*(objp)), (void *) (objp))
 488
 489 extern int
 490 umoven_or_printaddr_ignore_syserror(struct tcb *tcp, kernel_ulong_t addr,
 491                                     unsigned int len, void *laddr);
 492
 493 extern int
 494 umovestr(struct tcb *tcp, kernel_ulong_t addr, unsigned int len, char *laddr);
 495
 496 extern int upeek(int pid, unsigned long, kernel_ulong_t *);
 497 extern int upoke(int pid, unsigned long, kernel_ulong_t);
 498
 499 extern bool
 500 print_array(struct tcb *tcp,
 501             kernel_ulong_t start_addr,
 502             size_t nmemb,
 503             void *elem_buf,
 504             size_t elem_size,
 505             int (*umoven_func)(struct tcb *,
 506                                      kernel_ulong_t,
 507                                      unsigned int,
 508                                      void *),
 509             bool (*print_func)(struct tcb *,
 510                                      void *elem_buf,
 511                                      size_t elem_size,
 512                                      void *opaque_data),
 513             void *opaque_data);
 514
 515 #if defined ALPHA || defined IA64 || defined MIPS \
 516  || defined SH || defined SPARC || defined SPARC64
 517 # define HAVE_GETRVAL2
 518 extern long getrval2(struct tcb *);
 519 #else
 520 # undef HAVE_GETRVAL2
 521 #endif
 522
 523 extern const char *signame(const int);
 524 extern void pathtrace_select(const char *);
 525 extern int pathtrace_match(struct tcb *);
 526 extern int getfdpath(struct tcb *, int, char *, unsigned);
 527 extern enum sock_proto getfdproto(struct tcb *, int);
 528
 529 extern const char *xlookup(const struct xlat *, const uint64_t);
 530 extern const char *xlat_search(const struct xlat *, const size_t, const uint64_t);
 531
 532 extern unsigned long get_pagesize(void);
 533 extern int
 534 string_to_uint_ex(const char *str, char **endptr,
 535                   unsigned int max_val, const char *accepted_ending);
 536 extern int string_to_uint(const char *str);
 537 static inline int
 538 string_to_uint_upto(const char *const str, unsigned int max_val)
 539 {
 540         return string_to_uint_ex(str, NULL, max_val, NULL);
 541 }
 542 extern int next_set_bit(const void *bit_array, unsigned cur_bit, unsigned size_bits);
 543
 544 #define QUOTE_0_TERMINATED                      0x01
 545 #define QUOTE_OMIT_LEADING_TRAILING_QUOTES      0x02
 546 #define QUOTE_OMIT_TRAILING_0                   0x08
 547
 548 extern int string_quote(const char *, char *, unsigned int, unsigned int);
 549 extern int print_quoted_string(const char *, unsigned int, unsigned int);
 550
 551 /* a refers to the lower numbered u_arg,
 552  * b refers to the higher numbered u_arg
 553  */
 554 #ifdef WORDS_BIGENDIAN
 555 # define ULONG_LONG(a,b) \
 556         ((unsigned long long)(unsigned)(b) | ((unsigned long long)(a)<<32))
 557 #else
 558 # define ULONG_LONG(a,b) \
 559         ((unsigned long long)(unsigned)(a) | ((unsigned long long)(b)<<32))
 560 #endif
 561 extern int getllval(struct tcb *, unsigned long long *, int);
 562 extern int printllval(struct tcb *, const char *, int)
 563         ATTRIBUTE_FORMAT((printf, 2, 0));
 564
 565 extern void printaddr(kernel_ulong_t addr);
 566 extern int printxvals(const uint64_t, const char *, const struct xlat *, ...)
 567         ATTRIBUTE_SENTINEL;
 568 extern int printxval_searchn(const struct xlat *xlat, size_t xlat_size,
 569         uint64_t val, const char *dflt);
 570 #define printxval_search(xlat__, val__, dflt__) \
 571         printxval_searchn(xlat__, ARRAY_SIZE(xlat__), val__, dflt__)
 572 extern int printargs(struct tcb *);
 573 extern int printargs_u(struct tcb *);
 574 extern int printargs_d(struct tcb *);
 575
 576 extern void addflags(const struct xlat *, uint64_t);
 577 extern int printflags64(const struct xlat *, uint64_t, const char *);
 578 extern const char *sprintflags(const char *, const struct xlat *, uint64_t);
 579 extern const char *sprinttime(time_t);
 580 extern void print_symbolic_mode_t(unsigned int);
 581 extern void print_numeric_umode_t(unsigned short);
 582 extern void print_numeric_long_umask(unsigned long);
 583
 584 extern void
 585 dumpiov_in_msghdr(struct tcb *, kernel_ulong_t addr, kernel_ulong_t data_size);
 586
 587 extern void
 588 dumpiov_in_mmsghdr(struct tcb *, kernel_ulong_t addr);
 589
 590 extern void
 591 dumpiov_upto(struct tcb *, int len, kernel_ulong_t addr, kernel_ulong_t data_size);
 592
 593 extern void
 594 dumpstr(struct tcb *, kernel_ulong_t addr, int len);
 595
 596 extern void
 597 printstr_ex(struct tcb *, kernel_ulong_t addr, kernel_ulong_t len,
 598             unsigned int user_style);
 599
 600 #define DECL_PRINTNUM(name)                                             \
 601 extern bool                                                             \
 602 printnum_ ## name(struct tcb *, kernel_ulong_t addr, const char *fmt)   \
 603         ATTRIBUTE_FORMAT((printf, 3, 0))
 604 DECL_PRINTNUM(short);
 605 DECL_PRINTNUM(int);
 606 DECL_PRINTNUM(int64);
 607 #undef DECL_PRINTNUM
 608
 609 #if SUPPORTED_PERSONALITIES > 1 && SIZEOF_LONG > 4
 610 extern bool
 611 printnum_long_int(struct tcb *, kernel_ulong_t addr,
 612                   const char *fmt_long, const char *fmt_int)
 613         ATTRIBUTE_FORMAT((printf, 3, 0))
 614         ATTRIBUTE_FORMAT((printf, 4, 0));
 615 # define printnum_slong(tcp, addr) \
 616         printnum_long_int((tcp), (addr), "%" PRId64, "%d")
 617 # define printnum_ulong(tcp, addr) \
 618         printnum_long_int((tcp), (addr), "%" PRIu64, "%u")
 619 # define printnum_ptr(tcp, addr) \
 620         printnum_long_int((tcp), (addr), "%#" PRIx64, "%#x")
 621 #elif SIZEOF_LONG > 4
 622 # define printnum_slong(tcp, addr) \
 623         printnum_int64((tcp), (addr), "%" PRId64)
 624 # define printnum_ulong(tcp, addr) \
 625         printnum_int64((tcp), (addr), "%" PRIu64)
 626 # define printnum_ptr(tcp, addr) \
 627         printnum_int64((tcp), (addr), "%#" PRIx64)
 628 #else
 629 # define printnum_slong(tcp, addr) \
 630         printnum_int((tcp), (addr), "%d")
 631 # define printnum_ulong(tcp, addr) \
 632         printnum_int((tcp), (addr), "%u")
 633 # define printnum_ptr(tcp, addr) \
 634         printnum_int((tcp), (addr), "%#x")
 635 #endif
 636
 637 #define DECL_PRINTPAIR(name)                                            \
 638 extern bool                                                             \
 639 printpair_ ## name(struct tcb *, kernel_ulong_t addr, const char *fmt)  \
 640         ATTRIBUTE_FORMAT((printf, 3, 0))
 641 DECL_PRINTPAIR(int);
 642 DECL_PRINTPAIR(int64);
 643 #undef DECL_PRINTPAIR
 644
 645 extern void
 646 printpathn(struct tcb *, kernel_ulong_t addr, unsigned int n);
 647
 648 extern void
 649 printpath(struct tcb *, kernel_ulong_t addr);
 650
 651 #define TIMESPEC_TEXT_BUFSIZE \
 652                 (sizeof(intmax_t)*3 * 2 + sizeof("{tv_sec=%jd, tv_nsec=%jd}"))
 653 extern void printfd(struct tcb *, int);
 654 extern void print_sockaddr(struct tcb *tcp, const void *, int);
 655 extern bool print_sockaddr_by_inode(const unsigned long, const enum sock_proto);
 656 extern bool print_sockaddr_by_inode_cached(const unsigned long);
 657 extern void print_dirfd(struct tcb *, int);
 658
 659 extern int
 660 decode_sockaddr(struct tcb *, kernel_ulong_t addr, int addrlen);
 661
 662 extern void printuid(const char *, const unsigned int);
 663
 664 extern void
 665 print_sigset_addr_len(struct tcb *, kernel_ulong_t addr, kernel_ulong_t len);
 666
 667 extern const char *sprintsigmask_n(const char *, const void *, unsigned int);
 668 #define tprintsigmask_addr(prefix, mask) \
 669         tprints(sprintsigmask_n((prefix), (mask), sizeof(mask)))
 670 extern void printsignal(int);
 671
 672 extern void
 673 tprint_iov_upto(struct tcb *, kernel_ulong_t len, kernel_ulong_t addr,
 674                 enum iov_decode, kernel_ulong_t data_size);
 675
 676 extern void
 677 decode_netlink(struct tcb *, kernel_ulong_t addr, kernel_ulong_t len);
 678
 679 extern void tprint_open_modes(unsigned int);
 680 extern const char *sprint_open_modes(unsigned int);
 681
 682 extern void
 683 print_seccomp_filter(struct tcb *, kernel_ulong_t addr);
 684
 685 extern void
 686 print_seccomp_fprog(struct tcb *, kernel_ulong_t addr, unsigned short len);
 687
 688 struct strace_stat;
 689 extern void print_struct_stat(struct tcb *tcp, const struct strace_stat *const st);
 690
 691 struct strace_statfs;
 692
 693 extern void
 694 print_struct_statfs(struct tcb *, kernel_ulong_t addr);
 695
 696 extern void
 697 print_struct_statfs64(struct tcb *, kernel_ulong_t addr, kernel_ulong_t size);
 698
 699 extern void print_ifindex(unsigned int);
 700
 701 struct number_set;
 702 extern struct number_set read_set;
 703 extern struct number_set write_set;
 704 extern struct number_set signal_set;
 705
 706 extern bool is_number_in_set(unsigned int number, const struct number_set *);
 707 extern void qualify(const char *);
 708 extern unsigned int qual_flags(const unsigned int);
 709
 710 #define DECL_IOCTL(name)                                                \
 711 extern int                                                              \
 712 name ## _ioctl(struct tcb *, unsigned int request, kernel_ulong_t arg)
 713 DECL_IOCTL(dm);
 714 DECL_IOCTL(file);
 715 DECL_IOCTL(fs_x);
 716 DECL_IOCTL(loop);
 717 DECL_IOCTL(ptp);
 718 DECL_IOCTL(scsi);
 719 DECL_IOCTL(sock);
 720 DECL_IOCTL(term);
 721 DECL_IOCTL(ubi);
 722 DECL_IOCTL(uffdio);
 723 #undef DECL_IOCTL
 724
 725 extern int tv_nz(const struct timeval *);
 726 extern int tv_cmp(const struct timeval *, const struct timeval *);
 727 extern double tv_float(const struct timeval *);
 728 extern void tv_add(struct timeval *, const struct timeval *, const struct timeval *);
 729 extern void tv_sub(struct timeval *, const struct timeval *, const struct timeval *);
 730 extern void tv_mul(struct timeval *, const struct timeval *, int);
 731 extern void tv_div(struct timeval *, const struct timeval *, int);
 732
 733 #ifdef USE_LIBUNWIND
 734 extern void unwind_init(void);
 735 extern void unwind_tcb_init(struct tcb *tcp);
 736 extern void unwind_tcb_fin(struct tcb *tcp);
 737 extern void unwind_cache_invalidate(struct tcb* tcp);
 738 extern void unwind_print_stacktrace(struct tcb* tcp);
 739 extern void unwind_capture_stacktrace(struct tcb* tcp);
 740 #endif
 741
 742 static inline void
 743 printstrn(struct tcb *tcp, kernel_ulong_t addr, kernel_ulong_t len)
 744 {
 745         printstr_ex(tcp, addr, len, 0);
 746 }
 747
 748 static inline void
 749 printstr(struct tcb *tcp, kernel_ulong_t addr)
 750 {
 751         printstr_ex(tcp, addr, -1, QUOTE_0_TERMINATED);
 752 }
 753
 754 static inline int
 755 printflags(const struct xlat *x, unsigned int flags, const char *dflt)
 756 {
 757         return printflags64(x, flags, dflt);
 758 }
 759
 760 static inline int
 761 printxval64(const struct xlat *x, const uint64_t val, const char *dflt)
 762 {
 763         return printxvals(val, dflt, x, NULL);
 764 }
 765
 766 static inline int
 767 printxval(const struct xlat *x, const unsigned int val, const char *dflt)
 768 {
 769         return printxvals(val, dflt, x, NULL);
 770 }
 771
 772 static inline void
 773 tprint_iov(struct tcb *tcp, kernel_ulong_t len, kernel_ulong_t addr,
 774            enum iov_decode decode_iov)
 775 {
 776         tprint_iov_upto(tcp, len, addr, decode_iov, -1);
 777 }
 778
 779 #ifdef ALPHA
 780 typedef struct {
 781         int tv_sec, tv_usec;
 782 } timeval32_t;
 783
 784 extern void print_timeval32_t(const timeval32_t *);
 785 extern void printrusage32(struct tcb *, kernel_ulong_t);
 786 extern const char *sprint_timeval32(struct tcb *tcp, kernel_ulong_t);
 787 extern void print_timeval32(struct tcb *tcp, kernel_ulong_t);
 788 extern void print_timeval32_pair(struct tcb *tcp, kernel_ulong_t);
 789 extern void print_itimerval32(struct tcb *tcp, kernel_ulong_t);
 790 #endif
 791
 792 #ifdef HAVE_STRUCT_USER_DESC
 793 extern void print_user_desc(struct tcb *, kernel_ulong_t addr);
 794 #endif
 795
 796 /* Strace log generation machinery.
 797  *
 798  * printing_tcp: tcb which has incomplete line being printed right now.
 799  * NULL if last line has been completed ('\n'-terminated).
 800  * printleader(tcp) examines it, finishes incomplete line if needed,
 801  * the sets it to tcp.
 802  * line_ended() clears printing_tcp and resets ->curcol = 0.
 803  * tcp->curcol == 0 check is also used to detect completeness
 804  * of last line, since in -ff mode just checking printing_tcp for NULL
 805  * is not enough.
 806  *
 807  * If you change this code, test log generation in both -f and -ff modes
 808  * using:
 809  * strace -oLOG -f[f] test/threaded_execve
 810  * strace -oLOG -f[f] test/sigkill_rain
 811  * strace -oLOG -f[f] -p "`pidof web_browser`"
 812  */
 813 extern struct tcb *printing_tcp;
 814 extern void printleader(struct tcb *);
 815 extern void line_ended(void);
 816 extern void tabto(void);
 817 extern void tprintf(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2));
 818 extern void tprints(const char *str);
 819
 820 #if SUPPORTED_PERSONALITIES > 1
 821 extern void set_personality(int personality);
 822 extern unsigned current_personality;
 823 #else
 824 # define set_personality(personality) ((void)0)
 825 # define current_personality 0
 826 #endif
 827
 828 #if SUPPORTED_PERSONALITIES == 1
 829 # define current_wordsize PERSONALITY0_WORDSIZE
 830 # define current_klongsize PERSONALITY0_KLONGSIZE
 831 #else
 832 # if SUPPORTED_PERSONALITIES == 2 && PERSONALITY0_WORDSIZE == PERSONALITY1_WORDSIZE
 833 #  define current_wordsize PERSONALITY0_WORDSIZE
 834 # else
 835 extern unsigned current_wordsize;
 836 # endif
 837 # if SUPPORTED_PERSONALITIES == 2 && PERSONALITY0_KLONGSIZE == PERSONALITY1_KLONGSIZE
 838 #  define current_klongsize PERSONALITY0_KLONGSIZE
 839 # else
 840 extern unsigned current_klongsize;
 841 # endif
 842 #endif
 843
 844 /* In many, many places we play fast and loose and use
 845  * tprintf("%d", (int) tcp->u_arg[N]) to print fds, pids etc.
 846  * We probably need to use widen_to_long() instead:
 847  */
 848 #if SUPPORTED_PERSONALITIES > 1 && SIZEOF_LONG > 4
 849 # define widen_to_long(v) (current_wordsize == 4 ? (long)(int32_t)(v) : (long)(v))
 850 #else
 851 # define widen_to_long(v) ((long)(v))
 852 #endif
 853
 854 #if SUPPORTED_PERSONALITIES > 1 && SIZEOF_LONG > 4
 855 # define widen_to_ulong(v) \
 856         (current_wordsize == 4 ? (unsigned long) (uint32_t) (v) : \
 857                 (unsigned long) (v))
 858 #else
 859 # define widen_to_ulong(v) ((unsigned long)(v))
 860 #endif
 861
 862 /*
 863  * Cast a pointer or a pointer-sized integer to kernel_ulong_t.
 864  */
 865 #define ptr_to_kulong(v) ((kernel_ulong_t) (unsigned long) (v))
 866
 867 /*
 868  * Zero-extend a signed integer type to unsigned long long.
 869  */
 870 #define zero_extend_signed_to_ull(v) \
 871         (sizeof(v) == sizeof(char) ? (unsigned long long) (unsigned char) (v) : \
 872          sizeof(v) == sizeof(short) ? (unsigned long long) (unsigned short) (v) : \
 873          sizeof(v) == sizeof(int) ? (unsigned long long) (unsigned int) (v) : \
 874          sizeof(v) == sizeof(long) ? (unsigned long long) (unsigned long) (v) : \
 875          (unsigned long long) (v))
 876
 877 /*
 878  * Sign-extend an unsigned integer type to long long.
 879  */
 880 #define sign_extend_unsigned_to_ll(v) \
 881         (sizeof(v) == sizeof(char) ? (long long) (char) (v) : \
 882          sizeof(v) == sizeof(short) ? (long long) (short) (v) : \
 883          sizeof(v) == sizeof(int) ? (long long) (int) (v) : \
 884          sizeof(v) == sizeof(long) ? (long long) (long) (v) : \
 885          (long long) (v))
 886
 887 extern const struct_sysent sysent0[];
 888 extern const char *const errnoent0[];
 889 extern const char *const signalent0[];
 890 extern const struct_ioctlent ioctlent0[];
 891
 892 #if SUPPORTED_PERSONALITIES > 1
 893 extern const struct_sysent *sysent;
 894 extern const char *const *errnoent;
 895 extern const char *const *signalent;
 896 extern const struct_ioctlent *ioctlent;
 897 #else
 898 # define sysent     sysent0
 899 # define errnoent   errnoent0
 900 # define signalent  signalent0
 901 # define ioctlent   ioctlent0
 902 #endif
 903
 904 extern unsigned nsyscalls;
 905 extern unsigned nerrnos;
 906 extern unsigned nsignals;
 907 extern unsigned nioctlents;
 908
 909 extern const unsigned int nsyscall_vec[SUPPORTED_PERSONALITIES];
 910 extern const struct_sysent *const sysent_vec[SUPPORTED_PERSONALITIES];
 911 extern struct fault_opts *fault_vec[SUPPORTED_PERSONALITIES];
 912
 913 #ifdef IN_MPERS_BOOTSTRAP
 914 /* Transform multi-line MPERS_PRINTER_DECL statements to one-liners.  */
 915 # define MPERS_PRINTER_DECL(type, name, ...) MPERS_PRINTER_DECL(type, name, __VA_ARGS__)
 916 #else /* !IN_MPERS_BOOTSTRAP */
 917 # if SUPPORTED_PERSONALITIES > 1
 918 #  include "printers.h"
 919 # else
 920 #  include "native_printer_decls.h"
 921 # endif
 922 # define MPERS_PRINTER_DECL(type, name, ...) type MPERS_FUNC_NAME(name)(__VA_ARGS__)
 923 #endif /* !IN_MPERS_BOOTSTRAP */
 924
 925 /* Checks that sysent[scno] is not out of range. */
 926 static inline bool
 927 scno_in_range(kernel_ulong_t scno)
 928 {
 929         return scno < nsyscalls;
 930 }
 931
 932 /*
 933  * Checks whether scno is not out of range,
 934  * its corresponding sysent[scno].sys_func is non-NULL,
 935  * and its sysent[scno].sys_flags has no TRACE_INDIRECT_SUBCALL flag set.
 936  */
 937 static inline bool
 938 scno_is_valid(kernel_ulong_t scno)
 939 {
 940         return scno_in_range(scno)
 941                && sysent[scno].sys_func
 942                && !(sysent[scno].sys_flags & TRACE_INDIRECT_SUBCALL);
 943 }
 944
 945 #define MPERS_FUNC_NAME__(prefix, name) prefix ## name
 946 #define MPERS_FUNC_NAME_(prefix, name) MPERS_FUNC_NAME__(prefix, name)
 947 #define MPERS_FUNC_NAME(name) MPERS_FUNC_NAME_(MPERS_PREFIX, name)
 948
 949 #define SYS_FUNC_NAME(syscall_name) MPERS_FUNC_NAME(syscall_name)
 950
 951 #define SYS_FUNC(syscall_name) int SYS_FUNC_NAME(sys_ ## syscall_name)(struct tcb *tcp)
 952
 953 #if SIZEOF_KERNEL_LONG_T > SIZEOF_LONG
 954 # define PRI_kl "ll"
 955 #else
 956 # define PRI_kl "l"
 957 #endif
 958
 959 #define PRI_kld PRI_kl"d"
 960 #define PRI_klu PRI_kl"u"
 961 #define PRI_klx PRI_kl"x"
 962
 963 /*
 964  * The kernel used to define 64-bit types on 64-bit systems on a per-arch
 965  * basis.  Some architectures would use unsigned long and others would use
 966  * unsigned long long.  These types were exported as part of the
 967  * kernel-userspace ABI and now must be maintained forever.  This matches
 968  * what the kernel exports for each architecture so we don't need to cast
 969  * every printing of __u64 or __s64 to stdint types.
 970  */
 971 #if SIZEOF_LONG == 4
 972 # define PRI__64 "ll"
 973 #elif defined ALPHA || defined IA64 || defined MIPS || defined POWERPC
 974 # define PRI__64 "l"
 975 #else
 976 # define PRI__64 "ll"
 977 #endif
 978
 979 #define PRI__d64 PRI__64"d"
 980 #define PRI__u64 PRI__64"u"
 981 #define PRI__x64 PRI__64"x"
 982
 983 #endif /* !STRACE_DEFS_H */