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 #ifdef HAVE_CONFIG_H
  31 # include "config.h"
  32 #endif
  33
  34 #include <features.h>
  35 #ifdef HAVE_STDBOOL_H
  36 # include <stdbool.h>
  37 #endif
  38 #include <stdint.h>
  39 #include <inttypes.h>
  40 #include <sys/types.h>
  41 #ifdef STDC_HEADERS
  42 # include <stddef.h>
  43 #endif
  44 #include <unistd.h>
  45 #include <stdlib.h>
  46 #include <stdio.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.
  49  */
  50 /* #include <ctype.h> */
  51 #include <string.h>
  52 #include <errno.h>
  53 #include <time.h>
  54 #include <sys/time.h>
  55 #include <sys/syscall.h>
  56
  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 offsetof
  73 # define offsetof(type, member) \
  74         (((char *) &(((type *) NULL)->member)) - ((char *) (type *) NULL))
  75 #endif
  76
  77 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
  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(SPARC) || defined(SPARC64)
 152 # define PERSONALITY0_WORDSIZE 4
 153 # if defined(SPARC64)
 154 #  define SUPPORTED_PERSONALITIES 2
 155 #  define PERSONALITY1_WORDSIZE 8
 156 #  ifdef HAVE_M32_MPERS
 157 #   define PERSONALITY1_INCLUDE_FUNCS "m32_funcs.h"
 158 #   define PERSONALITY1_INCLUDE_PRINTERS_DECLS "m32_printer_decls.h"
 159 #   define PERSONALITY1_INCLUDE_PRINTERS_DEFS "m32_printer_defs.h"
 160 #   define MPERS_m32_IOCTL_MACROS "ioctl_redefs1.h"
 161 #  endif
 162 # endif
 163 #endif
 164
 165 #ifdef X86_64
 166 # define SUPPORTED_PERSONALITIES 3
 167 # define PERSONALITY0_WORDSIZE 8
 168 # define PERSONALITY1_WORDSIZE 4
 169 # define PERSONALITY2_WORDSIZE 4
 170 # ifdef HAVE_M32_MPERS
 171 #  define PERSONALITY1_INCLUDE_FUNCS "m32_funcs.h"
 172 #  define PERSONALITY1_INCLUDE_PRINTERS_DECLS "m32_printer_decls.h"
 173 #  define PERSONALITY1_INCLUDE_PRINTERS_DEFS "m32_printer_defs.h"
 174 #  define MPERS_m32_IOCTL_MACROS "ioctl_redefs1.h"
 175 # endif
 176 # ifdef HAVE_MX32_MPERS
 177 #  define PERSONALITY2_INCLUDE_FUNCS "mx32_funcs.h"
 178 #  define PERSONALITY2_INCLUDE_PRINTERS_DECLS "mx32_printer_decls.h"
 179 #  define PERSONALITY2_INCLUDE_PRINTERS_DEFS "mx32_printer_defs.h"
 180 #  define MPERS_mx32_IOCTL_MACROS "ioctl_redefs2.h"
 181 # endif
 182 #endif
 183
 184 #ifdef X32
 185 # define SUPPORTED_PERSONALITIES 2
 186 # define PERSONALITY0_WORDSIZE 4
 187 # define PERSONALITY1_WORDSIZE 4
 188 # ifdef HAVE_M32_MPERS
 189 #  define PERSONALITY1_INCLUDE_FUNCS "m32_funcs.h"
 190 #  define PERSONALITY1_INCLUDE_PRINTERS_DECLS "m32_printer_decls.h"
 191 #  define PERSONALITY1_INCLUDE_PRINTERS_DEFS "m32_printer_defs.h"
 192 #  define MPERS_m32_IOCTL_MACROS "ioctl_redefs1.h"
 193 # endif
 194 #endif
 195
 196 #ifdef ARM
 197 /* one personality */
 198 #endif
 199
 200 #ifdef AARCH64
 201 /* The existing ARM personality, then AArch64 */
 202 # define SUPPORTED_PERSONALITIES 2
 203 # define PERSONALITY0_WORDSIZE 8
 204 # define PERSONALITY1_WORDSIZE 4
 205 # ifdef HAVE_M32_MPERS
 206 #  define PERSONALITY1_INCLUDE_FUNCS "m32_funcs.h"
 207 #  define PERSONALITY1_INCLUDE_PRINTERS_DECLS "m32_printer_decls.h"
 208 #  define PERSONALITY1_INCLUDE_PRINTERS_DEFS "m32_printer_defs.h"
 209 #  define MPERS_m32_IOCTL_MACROS "ioctl_redefs1.h"
 210 # endif
 211 #endif
 212
 213 #ifdef POWERPC64
 214 # define SUPPORTED_PERSONALITIES 2
 215 # define PERSONALITY0_WORDSIZE 8
 216 # define PERSONALITY1_WORDSIZE 4
 217 # ifdef HAVE_M32_MPERS
 218 #  define PERSONALITY1_INCLUDE_FUNCS "m32_funcs.h"
 219 #  define PERSONALITY1_INCLUDE_PRINTERS_DECLS "m32_printer_decls.h"
 220 #  define PERSONALITY1_INCLUDE_PRINTERS_DEFS "m32_printer_defs.h"
 221 #  define MPERS_m32_IOCTL_MACROS "ioctl_redefs1.h"
 222 # endif
 223 #endif
 224
 225 #ifdef TILE
 226 # define SUPPORTED_PERSONALITIES 2
 227 # define PERSONALITY0_WORDSIZE 8
 228 # define PERSONALITY1_WORDSIZE 4
 229 # ifdef __tilepro__
 230 #  define DEFAULT_PERSONALITY 1
 231 # endif
 232 # ifdef HAVE_M32_MPERS
 233 #  define PERSONALITY1_INCLUDE_FUNCS "m32_funcs.h"
 234 #  define PERSONALITY1_INCLUDE_PRINTERS_DECLS "m32_printer_decls.h"
 235 #  define PERSONALITY1_INCLUDE_PRINTERS_DEFS "m32_printer_defs.h"
 236 #  define MPERS_m32_IOCTL_MACROS "ioctl_redefs1.h"
 237 # endif
 238 #endif
 239
 240 #ifndef SUPPORTED_PERSONALITIES
 241 # define SUPPORTED_PERSONALITIES 1
 242 #endif
 243 #ifndef DEFAULT_PERSONALITY
 244 # define DEFAULT_PERSONALITY 0
 245 #endif
 246 #ifndef PERSONALITY0_WORDSIZE
 247 # define PERSONALITY0_WORDSIZE SIZEOF_LONG
 248 #endif
 249
 250 #ifndef PERSONALITY0_INCLUDE_PRINTERS_DECLS
 251 # define PERSONALITY0_INCLUDE_PRINTERS_DECLS "native_printer_decls.h"
 252 #endif
 253 #ifndef PERSONALITY0_INCLUDE_PRINTERS_DEFS
 254 # define PERSONALITY0_INCLUDE_PRINTERS_DEFS "native_printer_defs.h"
 255 #endif
 256
 257 #ifndef PERSONALITY1_INCLUDE_PRINTERS_DECLS
 258 # define PERSONALITY1_INCLUDE_PRINTERS_DECLS "native_printer_decls.h"
 259 #endif
 260 #ifndef PERSONALITY1_INCLUDE_PRINTERS_DEFS
 261 # define PERSONALITY1_INCLUDE_PRINTERS_DEFS "native_printer_defs.h"
 262 #endif
 263
 264 #ifndef PERSONALITY2_INCLUDE_PRINTERS_DECLS
 265 # define PERSONALITY2_INCLUDE_PRINTERS_DECLS "native_printer_decls.h"
 266 #endif
 267 #ifndef PERSONALITY2_INCLUDE_PRINTERS_DEFS
 268 # define PERSONALITY2_INCLUDE_PRINTERS_DEFS "native_printer_defs.h"
 269 #endif
 270
 271 #ifndef PERSONALITY1_INCLUDE_FUNCS
 272 # define PERSONALITY1_INCLUDE_FUNCS "empty.h"
 273 #endif
 274 #ifndef PERSONALITY2_INCLUDE_FUNCS
 275 # define PERSONALITY2_INCLUDE_FUNCS "empty.h"
 276 #endif
 277
 278 typedef struct sysent {
 279         unsigned nargs;
 280         int     sys_flags;
 281         int     sen;
 282         int     (*sys_func)();
 283         const char *sys_name;
 284 } struct_sysent;
 285
 286 typedef struct ioctlent {
 287         const char *symbol;
 288         unsigned int code;
 289 } struct_ioctlent;
 290
 291 #if defined LINUX_MIPSN32 || defined X32
 292 # define HAVE_STRUCT_TCB_EXT_ARG 1
 293 #else
 294 # define HAVE_STRUCT_TCB_EXT_ARG 0
 295 #endif
 296
 297 /* Trace Control Block */
 298 struct tcb {
 299         int flags;              /* See below for TCB_ values */
 300         int pid;                /* If 0, this tcb is free */
 301         int qual_flg;           /* qual_flags[scno] or DEFAULT_QUAL_FLAGS + RAW */
 302         int u_error;            /* Error code */
 303         long scno;              /* System call number */
 304         long u_arg[MAX_ARGS];   /* System call arguments */
 305 #if HAVE_STRUCT_TCB_EXT_ARG
 306         long long ext_arg[MAX_ARGS];
 307         long long u_lrval;      /* long long return value */
 308 #endif
 309         long u_rval;            /* Return value */
 310 #if SUPPORTED_PERSONALITIES > 1
 311         unsigned int currpers;  /* Personality at the time of scno update */
 312 #endif
 313         int sys_func_rval;      /* Syscall entry parser's return value */
 314         int curcol;             /* Output column for this process */
 315         FILE *outf;             /* Output file for this process */
 316         const char *auxstr;     /* Auxiliary info from syscall (see RVAL_STR) */
 317         const struct_sysent *s_ent; /* sysent[scno] or dummy struct for bad scno */
 318         const struct_sysent *s_prev_ent; /* for "resuming interrupted SYSCALL" msg */
 319         struct timeval stime;   /* System time usage as of last process wait */
 320         struct timeval dtime;   /* Delta for system time usage */
 321         struct timeval etime;   /* Syscall entry time */
 322
 323 #ifdef USE_LIBUNWIND
 324         struct UPT_info* libunwind_ui;
 325         struct mmap_cache_t* mmap_cache;
 326         unsigned int mmap_cache_size;
 327         unsigned int mmap_cache_generation;
 328         struct queue_t* queue;
 329 #endif
 330 };
 331
 332 /* TCB flags */
 333 /* We have attached to this process, but did not see it stopping yet */
 334 #define TCB_STARTUP             0x01
 335 #define TCB_IGNORE_ONE_SIGSTOP  0x02    /* Next SIGSTOP is to be ignored */
 336 /*
 337  * Are we in system call entry or in syscall exit?
 338  *
 339  * This bit is set after all syscall entry processing is done.
 340  * Therefore, this bit will be set when next ptrace stop occurs,
 341  * which should be syscall exit stop. Other stops which are possible
 342  * directly after syscall entry (death, ptrace event stop)
 343  * are simpler and handled without calling trace_syscall(), therefore
 344  * the places where TCB_INSYSCALL can be set but we aren't in syscall stop
 345  * are limited to trace(), this condition is never observed in trace_syscall()
 346  * and below.
 347  * The bit is cleared after all syscall exit processing is done.
 348  *
 349  * Use entering(tcp) / exiting(tcp) to check this bit to make code more readable.
 350  */
 351 #define TCB_INSYSCALL   0x04
 352 #define TCB_ATTACHED    0x08    /* We attached to it already */
 353 #define TCB_REPRINT     0x10    /* We should reprint this syscall on exit */
 354 #define TCB_FILTERED    0x20    /* This system call has been filtered out */
 355
 356 /* qualifier flags */
 357 #define QUAL_TRACE      0x001   /* this system call should be traced */
 358 #define QUAL_ABBREV     0x002   /* abbreviate the structures of this syscall */
 359 #define QUAL_VERBOSE    0x004   /* decode the structures of this syscall */
 360 #define QUAL_RAW        0x008   /* print all args in hex for this syscall */
 361 #define QUAL_SIGNAL     0x010   /* report events with this signal */
 362 #define QUAL_READ       0x020   /* dump data read on this file descriptor */
 363 #define QUAL_WRITE      0x040   /* dump data written to this file descriptor */
 364 typedef uint8_t qualbits_t;
 365
 366 #define DEFAULT_QUAL_FLAGS (QUAL_TRACE | QUAL_ABBREV | QUAL_VERBOSE)
 367
 368 #define entering(tcp)   (!((tcp)->flags & TCB_INSYSCALL))
 369 #define exiting(tcp)    ((tcp)->flags & TCB_INSYSCALL)
 370 #define syserror(tcp)   ((tcp)->u_error != 0)
 371 #define verbose(tcp)    ((tcp)->qual_flg & QUAL_VERBOSE)
 372 #define abbrev(tcp)     ((tcp)->qual_flg & QUAL_ABBREV)
 373 #define filtered(tcp)   ((tcp)->flags & TCB_FILTERED)
 374
 375 #include "xlat.h"
 376
 377 extern const struct xlat at_flags[];
 378 extern const struct xlat dirent_types[];
 379 extern const struct xlat evdev_abs[];
 380 extern const struct xlat open_access_modes[];
 381 extern const struct xlat open_mode_flags[];
 382 extern const struct xlat resource_flags[];
 383 extern const struct xlat whence_codes[];
 384
 385 /* Format of syscall return values */
 386 #define RVAL_DECIMAL    000     /* decimal format */
 387 #define RVAL_HEX        001     /* hex format */
 388 #define RVAL_OCTAL      002     /* octal format */
 389 #define RVAL_UDECIMAL   003     /* unsigned decimal format */
 390 #if HAVE_STRUCT_TCB_EXT_ARG
 391 # if 0 /* unused so far */
 392 #  define RVAL_LDECIMAL 004     /* long decimal format */
 393 #  define RVAL_LHEX     005     /* long hex format */
 394 #  define RVAL_LOCTAL   006     /* long octal format */
 395 # endif
 396 # define RVAL_LUDECIMAL 007     /* long unsigned decimal format */
 397 #endif /* HAVE_STRUCT_TCB_EXT_ARG */
 398 #define RVAL_FD         010     /* file descriptor */
 399 #define RVAL_MASK       017     /* mask for these values */
 400
 401 #define RVAL_STR        020     /* Print `auxstr' field after return val */
 402 #define RVAL_NONE       040     /* Print nothing */
 403
 404 #define RVAL_DECODED    0100    /* syscall decoding finished */
 405
 406 #define TRACE_FILE      001     /* Trace file-related syscalls. */
 407 #define TRACE_IPC       002     /* Trace IPC-related syscalls. */
 408 #define TRACE_NETWORK   004     /* Trace network-related syscalls. */
 409 #define TRACE_PROCESS   010     /* Trace process-related syscalls. */
 410 #define TRACE_SIGNAL    020     /* Trace signal-related syscalls. */
 411 #define TRACE_DESC      040     /* Trace file descriptor-related syscalls. */
 412 #define TRACE_MEMORY    0100    /* Trace memory mapping-related syscalls. */
 413 #define SYSCALL_NEVER_FAILS     0200    /* Syscall is always successful. */
 414 #define STACKTRACE_INVALIDATE_CACHE 0400  /* Trigger proc/maps cache updating */
 415 #define STACKTRACE_CAPTURE_ON_ENTER 01000 /* Capture stacktrace on "entering" stage */
 416 #define TRACE_INDIRECT_SUBCALL  02000   /* Syscall is an indirect socket/ipc subcall. */
 417
 418 #define IOCTL_NUMBER_UNKNOWN 0
 419 #define IOCTL_NUMBER_HANDLED 1
 420 #define IOCTL_NUMBER_STOP_LOOKUP 010
 421
 422 #define indirect_ipccall(tcp) (tcp->s_ent->sys_flags & TRACE_INDIRECT_SUBCALL)
 423
 424 #if defined(ARM) || defined(AARCH64) \
 425  || defined(I386) || defined(X32) || defined(X86_64) \
 426  || defined(IA64) \
 427  || defined(BFIN) \
 428  || defined(M68K) \
 429  || defined(MICROBLAZE) \
 430  || defined(S390) \
 431  || defined(SH) || defined(SH64) \
 432  || defined(SPARC) || defined(SPARC64) \
 433  /**/
 434 # define NEED_UID16_PARSERS 1
 435 #else
 436 # define NEED_UID16_PARSERS 0
 437 #endif
 438
 439 enum sock_proto {
 440         SOCK_PROTO_UNKNOWN,
 441         SOCK_PROTO_UNIX,
 442         SOCK_PROTO_TCP,
 443         SOCK_PROTO_UDP,
 444         SOCK_PROTO_TCPv6,
 445         SOCK_PROTO_UDPv6,
 446         SOCK_PROTO_NETLINK
 447 };
 448 extern enum sock_proto get_proto_by_name(const char *);
 449
 450 enum iov_decode {
 451         IOV_DECODE_ADDR,
 452         IOV_DECODE_STR
 453 };
 454
 455 typedef enum {
 456         CFLAG_NONE = 0,
 457         CFLAG_ONLY_STATS,
 458         CFLAG_BOTH
 459 } cflag_t;
 460 extern cflag_t cflag;
 461 extern bool debug_flag;
 462 extern bool Tflag;
 463 extern bool iflag;
 464 extern bool count_wallclock;
 465 extern unsigned int qflag;
 466 extern bool not_failing_only;
 467 extern unsigned int show_fd_path;
 468 extern bool hide_log_until_execve;
 469 /* are we filtering traces based on paths? */
 470 extern const char **paths_selected;
 471 #define tracing_paths (paths_selected != NULL)
 472 extern unsigned xflag;
 473 extern unsigned followfork;
 474 #ifdef USE_LIBUNWIND
 475 /* if this is true do the stack trace for every system call */
 476 extern bool stack_trace_enabled;
 477 #endif
 478 extern unsigned ptrace_setoptions;
 479 extern unsigned max_strlen;
 480 extern unsigned os_release;
 481 #undef KERNEL_VERSION
 482 #define KERNEL_VERSION(a,b,c) (((a) << 16) + ((b) << 8) + (c))
 483
 484 void error_msg(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2));
 485 void perror_msg(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2));
 486 void error_msg_and_die(const char *fmt, ...)
 487         ATTRIBUTE_FORMAT((printf, 1, 2)) ATTRIBUTE_NORETURN;
 488 void error_msg_and_help(const char *fmt, ...)
 489         ATTRIBUTE_FORMAT((printf, 1, 2)) ATTRIBUTE_NORETURN;
 490 void perror_msg_and_die(const char *fmt, ...)
 491         ATTRIBUTE_FORMAT((printf, 1, 2)) ATTRIBUTE_NORETURN;
 492 void die_out_of_memory(void) ATTRIBUTE_NORETURN;
 493
 494 void *xmalloc(size_t size) ATTRIBUTE_MALLOC ATTRIBUTE_ALLOC_SIZE((1));
 495 void *xcalloc(size_t nmemb, size_t size)
 496         ATTRIBUTE_MALLOC ATTRIBUTE_ALLOC_SIZE((1, 2));
 497 void *xreallocarray(void *ptr, size_t nmemb, size_t size)
 498         ATTRIBUTE_ALLOC_SIZE((2, 3));
 499 char *xstrdup(const char *str) ATTRIBUTE_MALLOC;
 500
 501 #if USE_CUSTOM_PRINTF
 502 /*
 503  * See comment in vsprintf.c for allowed formats.
 504  * Short version: %h[h]u, %zu, %tu are not allowed, use %[l[l]]u.
 505  */
 506 int strace_vfprintf(FILE *fp, const char *fmt, va_list args);
 507 #else
 508 # define strace_vfprintf vfprintf
 509 #endif
 510
 511 extern void set_sortby(const char *);
 512 extern void set_overhead(int);
 513 extern void qualify(const char *);
 514 extern void print_pc(struct tcb *);
 515 extern int trace_syscall(struct tcb *);
 516 extern void count_syscall(struct tcb *, const struct timeval *);
 517 extern void call_summary(FILE *);
 518
 519 extern void clear_regs(void);
 520 extern void get_regs(pid_t pid);
 521 extern int get_scno(struct tcb *tcp);
 522 extern const char *syscall_name(long scno);
 523
 524 extern bool is_erestart(struct tcb *);
 525 extern void temporarily_clear_syserror(struct tcb *);
 526 extern void restore_cleared_syserror(struct tcb *);
 527
 528 extern int umoven(struct tcb *, long, unsigned int, void *);
 529 #define umove(pid, addr, objp)  \
 530         umoven((pid), (addr), sizeof(*(objp)), (void *) (objp))
 531 extern int umoven_or_printaddr(struct tcb *, long, unsigned int, void *);
 532 #define umove_or_printaddr(pid, addr, objp)     \
 533         umoven_or_printaddr((pid), (addr), sizeof(*(objp)), (void *) (objp))
 534 extern int umovestr(struct tcb *, long, unsigned int, char *);
 535 extern int upeek(int pid, long, long *);
 536
 537 extern bool
 538 print_array(struct tcb *tcp,
 539             const unsigned long start_addr,
 540             const size_t nmemb,
 541             void *const elem_buf,
 542             const size_t elem_size,
 543             int (*const umoven_func)(struct tcb *,
 544                                      long,
 545                                      unsigned int,
 546                                      void *),
 547             bool (*const print_func)(struct tcb *,
 548                                      void *elem_buf,
 549                                      size_t elem_size,
 550                                      void *opaque_data),
 551             void *const opaque_data);
 552
 553 #if defined ALPHA || defined IA64 || defined MIPS \
 554  || defined SH || defined SPARC || defined SPARC64
 555 # define HAVE_GETRVAL2
 556 extern long getrval2(struct tcb *);
 557 #else
 558 # undef HAVE_GETRVAL2
 559 #endif
 560
 561 extern const char *signame(const int);
 562 extern void pathtrace_select(const char *);
 563 extern int pathtrace_match(struct tcb *);
 564 extern int getfdpath(struct tcb *, int, char *, unsigned);
 565
 566 extern const char *xlookup(const struct xlat *, const uint64_t);
 567 extern const char *xlat_search(const struct xlat *, const size_t, const uint64_t);
 568
 569 extern unsigned long get_pagesize(void);
 570 extern int string_to_uint(const char *str);
 571 extern int next_set_bit(const void *bit_array, unsigned cur_bit, unsigned size_bits);
 572
 573 #define QUOTE_0_TERMINATED                      0x01
 574 #define QUOTE_OMIT_LEADING_TRAILING_QUOTES      0x02
 575
 576 extern int string_quote(const char *, char *, unsigned int, unsigned int);
 577 extern int print_quoted_string(const char *, unsigned int, unsigned int);
 578
 579 /* a refers to the lower numbered u_arg,
 580  * b refers to the higher numbered u_arg
 581  */
 582 #ifdef WORDS_BIGENDIAN
 583 # define LONG_LONG(a,b) \
 584         ((long long)((unsigned long long)(unsigned)(b) | ((unsigned long long)(a)<<32)))
 585 #else
 586 # define LONG_LONG(a,b) \
 587         ((long long)((unsigned long long)(unsigned)(a) | ((unsigned long long)(b)<<32)))
 588 #endif
 589 extern int getllval(struct tcb *, unsigned long long *, int);
 590 extern int printllval(struct tcb *, const char *, int)
 591         ATTRIBUTE_FORMAT((printf, 2, 0));
 592
 593 extern void printaddr(long);
 594 extern void printxvals(const uint64_t, const char *, const struct xlat *, ...)
 595         ATTRIBUTE_SENTINEL;
 596 extern int printargs(struct tcb *);
 597 extern int printargs_u(struct tcb *);
 598 extern int printargs_d(struct tcb *);
 599
 600 extern void addflags(const struct xlat *, uint64_t);
 601 extern int printflags64(const struct xlat *, uint64_t, const char *);
 602 extern const char *sprintflags(const char *, const struct xlat *, uint64_t);
 603 extern const char *sprintmode(unsigned int);
 604 extern const char *sprinttime(time_t);
 605 extern void dumpiov_in_msghdr(struct tcb *, long, unsigned long);
 606 extern void dumpiov_in_mmsghdr(struct tcb *, long);
 607 extern void dumpiov_upto(struct tcb *, int, long, unsigned long);
 608 #define dumpiov(tcp, len, addr) \
 609         dumpiov_upto((tcp), (len), (addr), (unsigned long) -1L)
 610 extern void dumpstr(struct tcb *, long, int);
 611 extern void printstr(struct tcb *, long, long);
 612 extern bool printnum_short(struct tcb *, long, const char *)
 613         ATTRIBUTE_FORMAT((printf, 3, 0));
 614 extern bool printnum_int(struct tcb *, long, const char *)
 615         ATTRIBUTE_FORMAT((printf, 3, 0));
 616 extern bool printnum_int64(struct tcb *, long, const char *)
 617         ATTRIBUTE_FORMAT((printf, 3, 0));
 618
 619 #if SUPPORTED_PERSONALITIES > 1 && SIZEOF_LONG > 4
 620 extern bool printnum_long_int(struct tcb *, long, const char *, const char *)
 621         ATTRIBUTE_FORMAT((printf, 3, 0))
 622         ATTRIBUTE_FORMAT((printf, 4, 0));
 623 # define printnum_slong(tcp, addr) \
 624         printnum_long_int((tcp), (addr), "%" PRId64, "%d")
 625 # define printnum_ulong(tcp, addr) \
 626         printnum_long_int((tcp), (addr), "%" PRIu64, "%u")
 627 # define printnum_ptr(tcp, addr) \
 628         printnum_long_int((tcp), (addr), "%#" PRIx64, "%#x")
 629 #elif SIZEOF_LONG > 4
 630 # define printnum_slong(tcp, addr) \
 631         printnum_int64((tcp), (addr), "%" PRId64)
 632 # define printnum_ulong(tcp, addr) \
 633         printnum_int64((tcp), (addr), "%" PRIu64)
 634 # define printnum_ptr(tcp, addr) \
 635         printnum_int64((tcp), (addr), "%#" PRIx64)
 636 #else
 637 # define printnum_slong(tcp, addr) \
 638         printnum_int((tcp), (addr), "%d")
 639 # define printnum_ulong(tcp, addr) \
 640         printnum_int((tcp), (addr), "%u")
 641 # define printnum_ptr(tcp, addr) \
 642         printnum_int((tcp), (addr), "%#x")
 643 #endif
 644
 645 extern bool printpair_int(struct tcb *, long, const char *)
 646         ATTRIBUTE_FORMAT((printf, 3, 0));
 647 extern bool printpair_int64(struct tcb *, long, const char *)
 648         ATTRIBUTE_FORMAT((printf, 3, 0));
 649 extern void printpath(struct tcb *, long);
 650 extern void printpathn(struct tcb *, long, unsigned int);
 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 extern int printsock(struct tcb *, long, int);
 659 extern void print_sock_optmgmt(struct tcb *, long, int);
 660 #ifdef ALPHA
 661 extern void printrusage32(struct tcb *, long);
 662 extern const char *sprint_timeval32(struct tcb *tcp, long);
 663 extern void print_timeval32(struct tcb *tcp, long);
 664 extern void print_timeval32_pair(struct tcb *tcp, long);
 665 extern void print_itimerval32(struct tcb *tcp, long);
 666 #endif
 667 extern void printuid(const char *, const unsigned int);
 668 extern void print_sigset_addr_len(struct tcb *, long, long);
 669 extern const char *sprintsigmask_n(const char *, const void *, unsigned int);
 670 #define tprintsigmask_addr(prefix, mask) \
 671         tprints(sprintsigmask_n((prefix), (mask), sizeof(mask)))
 672 extern void printsignal(int);
 673 extern void tprint_iov(struct tcb *, unsigned long, unsigned long, enum iov_decode);
 674 extern void tprint_iov_upto(struct tcb *, unsigned long, unsigned long,
 675                             enum iov_decode, unsigned long);
 676 extern void tprint_open_modes(unsigned int);
 677 extern const char *sprint_open_modes(unsigned int);
 678 extern void print_seccomp_filter(struct tcb *, unsigned long);
 679 extern void print_seccomp_fprog(struct tcb *, unsigned long, unsigned short);
 680
 681 struct strace_statfs;
 682 extern void print_struct_statfs(struct tcb *tcp, long);
 683 extern void print_struct_statfs64(struct tcb *tcp, long, unsigned long);
 684
 685 extern int file_ioctl(struct tcb *, const unsigned int, long);
 686 extern int fs_x_ioctl(struct tcb *, const unsigned int, long);
 687 extern int loop_ioctl(struct tcb *, const unsigned int, long);
 688 extern int ptp_ioctl(struct tcb *, const unsigned int, long);
 689 extern int scsi_ioctl(struct tcb *, const unsigned int, long);
 690 extern int sock_ioctl(struct tcb *, const unsigned int, long);
 691 extern int term_ioctl(struct tcb *, const unsigned int, long);
 692 extern int ubi_ioctl(struct tcb *, const unsigned int, long);
 693 extern int uffdio_ioctl(struct tcb *, const unsigned int, long);
 694
 695 extern int tv_nz(const struct timeval *);
 696 extern int tv_cmp(const struct timeval *, const struct timeval *);
 697 extern double tv_float(const struct timeval *);
 698 extern void tv_add(struct timeval *, const struct timeval *, const struct timeval *);
 699 extern void tv_sub(struct timeval *, const struct timeval *, const struct timeval *);
 700 extern void tv_mul(struct timeval *, const struct timeval *, int);
 701 extern void tv_div(struct timeval *, const struct timeval *, int);
 702
 703 #ifdef USE_LIBUNWIND
 704 extern void unwind_init(void);
 705 extern void unwind_tcb_init(struct tcb *tcp);
 706 extern void unwind_tcb_fin(struct tcb *tcp);
 707 extern void unwind_cache_invalidate(struct tcb* tcp);
 708 extern void unwind_print_stacktrace(struct tcb* tcp);
 709 extern void unwind_capture_stacktrace(struct tcb* tcp);
 710 #endif
 711
 712 static inline int
 713 printflags(const struct xlat *x, unsigned int flags, const char *dflt)
 714 {
 715         return printflags64(x, flags, dflt);
 716 }
 717
 718 static inline int
 719 printflags_long(const struct xlat *x, unsigned long flags, const char *dflt)
 720 {
 721         return printflags64(x, flags, dflt);
 722 }
 723
 724 static inline void
 725 printxval64(const struct xlat *x, const uint64_t val, const char *dflt)
 726 {
 727         printxvals(val, dflt, x, NULL);
 728 }
 729
 730 static inline void
 731 printxval(const struct xlat *x, const unsigned int val, const char *dflt)
 732 {
 733         printxvals(val, dflt, x, NULL);
 734 }
 735
 736 static inline void
 737 printxval_long(const struct xlat *x, const unsigned long val, const char *dflt)
 738 {
 739         printxvals(val, dflt, x, NULL);
 740 }
 741
 742 /* Strace log generation machinery.
 743  *
 744  * printing_tcp: tcb which has incomplete line being printed right now.
 745  * NULL if last line has been completed ('\n'-terminated).
 746  * printleader(tcp) examines it, finishes incomplete line if needed,
 747  * the sets it to tcp.
 748  * line_ended() clears printing_tcp and resets ->curcol = 0.
 749  * tcp->curcol == 0 check is also used to detect completeness
 750  * of last line, since in -ff mode just checking printing_tcp for NULL
 751  * is not enough.
 752  *
 753  * If you change this code, test log generation in both -f and -ff modes
 754  * using:
 755  * strace -oLOG -f[f] test/threaded_execve
 756  * strace -oLOG -f[f] test/sigkill_rain
 757  * strace -oLOG -f[f] -p "`pidof web_browser`"
 758  */
 759 extern struct tcb *printing_tcp;
 760 extern void printleader(struct tcb *);
 761 extern void line_ended(void);
 762 extern void tabto(void);
 763 extern void tprintf(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2));
 764 extern void tprints(const char *str);
 765
 766 #if SUPPORTED_PERSONALITIES > 1
 767 extern void set_personality(int personality);
 768 extern unsigned current_personality;
 769 #else
 770 # define set_personality(personality) ((void)0)
 771 # define current_personality 0
 772 #endif
 773
 774 #if SUPPORTED_PERSONALITIES == 1
 775 # define current_wordsize PERSONALITY0_WORDSIZE
 776 #else
 777 # if SUPPORTED_PERSONALITIES == 2 && PERSONALITY0_WORDSIZE == PERSONALITY1_WORDSIZE
 778 #  define current_wordsize PERSONALITY0_WORDSIZE
 779 # else
 780 extern unsigned current_wordsize;
 781 # endif
 782 #endif
 783
 784 /* In many, many places we play fast and loose and use
 785  * tprintf("%d", (int) tcp->u_arg[N]) to print fds, pids etc.
 786  * We probably need to use widen_to_long() instead:
 787  */
 788 #if SUPPORTED_PERSONALITIES > 1 && SIZEOF_LONG > 4
 789 # define widen_to_long(v) (current_wordsize == 4 ? (long)(int32_t)(v) : (long)(v))
 790 #else
 791 # define widen_to_long(v) ((long)(v))
 792 #endif
 793
 794 /*
 795  * Widen without sign-extension a signed integer type to unsigned long long.
 796  */
 797 #define widen_to_ull(v) \
 798         (sizeof(v) == sizeof(int) ? (unsigned long long) (unsigned int) (v) : \
 799          sizeof(v) == sizeof(long) ? (unsigned long long) (unsigned long) (v) : \
 800          (unsigned long long) (v))
 801
 802 extern const struct_sysent sysent0[];
 803 extern const char *const errnoent0[];
 804 extern const char *const signalent0[];
 805 extern const struct_ioctlent ioctlent0[];
 806 extern qualbits_t *qual_vec[SUPPORTED_PERSONALITIES];
 807 #define qual_flags (qual_vec[current_personality])
 808
 809 #if SUPPORTED_PERSONALITIES > 1
 810 extern const struct_sysent *sysent;
 811 extern const char *const *errnoent;
 812 extern const char *const *signalent;
 813 extern const struct_ioctlent *ioctlent;
 814 #else
 815 # define sysent     sysent0
 816 # define errnoent   errnoent0
 817 # define signalent  signalent0
 818 # define ioctlent   ioctlent0
 819 #endif
 820
 821 extern unsigned nsyscalls;
 822 extern unsigned nerrnos;
 823 extern unsigned nsignals;
 824 extern unsigned nioctlents;
 825 extern unsigned num_quals;
 826
 827 #ifdef IN_MPERS_BOOTSTRAP
 828 /* Transform multi-line MPERS_PRINTER_DECL statements to one-liners.  */
 829 # define MPERS_PRINTER_DECL(type, name, ...) MPERS_PRINTER_DECL(type, name, __VA_ARGS__)
 830 #else /* !IN_MPERS_BOOTSTRAP */
 831 # if SUPPORTED_PERSONALITIES > 1
 832 #  include "printers.h"
 833 # else
 834 #  include "native_printer_decls.h"
 835 # endif
 836 # define MPERS_PRINTER_DECL(type, name, ...) type MPERS_FUNC_NAME(name)(__VA_ARGS__)
 837 #endif /* !IN_MPERS_BOOTSTRAP */
 838
 839 /*
 840  * If you need non-NULL sysent[scno].sys_func and sysent[scno].sys_name
 841  */
 842 #define SCNO_IS_VALID(scno) \
 843         ((unsigned long)(scno) < nsyscalls && sysent[scno].sys_func)
 844
 845 /* Only ensures that sysent[scno] isn't out of range */
 846 #define SCNO_IN_RANGE(scno) \
 847         ((unsigned long)(scno) < nsyscalls)
 848
 849 #define MPERS_FUNC_NAME__(prefix, name) prefix ## name
 850 #define MPERS_FUNC_NAME_(prefix, name) MPERS_FUNC_NAME__(prefix, name)
 851 #define MPERS_FUNC_NAME(name) MPERS_FUNC_NAME_(MPERS_PREFIX, name)
 852
 853 #define SYS_FUNC_NAME(syscall_name) MPERS_FUNC_NAME(syscall_name)
 854
 855 #define SYS_FUNC(syscall_name) int SYS_FUNC_NAME(sys_ ## syscall_name)(struct tcb *tcp)
 856
 857 /*
 858  * The kernel used to define 64-bit types on 64-bit systems on a per-arch
 859  * basis.  Some architectures would use unsigned long and others would use
 860  * unsigned long long.  These types were exported as part of the
 861  * kernel-userspace ABI and now must be maintained forever.  This matches
 862  * what the kernel exports for each architecture so we don't need to cast
 863  * every printing of __u64 or __s64 to stdint types.
 864  */
 865 #if SIZEOF_LONG == 4
 866 # define PRI__64 "ll"
 867 #elif defined ALPHA || defined IA64 || defined MIPS || defined POWERPC
 868 # define PRI__64 "l"
 869 #else
 870 # define PRI__64 "ll"
 871 #endif
 872
 873 #define PRI__d64 PRI__64"d"
 874 #define PRI__u64 PRI__64"u"
 875 #define PRI__x64 PRI__64"x"