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 #if defined LINUX_MIPSN32 || defined X32
 224 # define HAVE_STRUCT_TCB_EXT_ARG 1
 225 #else
 226 # define HAVE_STRUCT_TCB_EXT_ARG 0
 227 #endif
 228
 229 /* Trace Control Block */
 230 struct tcb {
 231         int flags;              /* See below for TCB_ values */
 232         int pid;                /* If 0, this tcb is free */
 233         int qual_flg;           /* qual_flags[scno] or DEFAULT_QUAL_FLAGS + RAW */
 234         unsigned long u_error;  /* Error code */
 235         kernel_scno_t scno;     /* System call number */
 236         kernel_ureg_t u_arg[MAX_ARGS];  /* System call arguments */
 237 #if HAVE_STRUCT_TCB_EXT_ARG
 238         unsigned long long ext_arg[MAX_ARGS];
 239         long long u_lrval;      /* long long return value */
 240 #endif
 241         long u_rval;            /* Return value */
 242 #if SUPPORTED_PERSONALITIES > 1
 243         unsigned int currpers;  /* Personality at the time of scno update */
 244 #endif
 245         int sys_func_rval;      /* Syscall entry parser's return value */
 246         int curcol;             /* Output column for this process */
 247         FILE *outf;             /* Output file for this process */
 248         const char *auxstr;     /* Auxiliary info from syscall (see RVAL_STR) */
 249         void *_priv_data;       /* Private data for syscall decoding functions */
 250         void (*_free_priv_data)(void *); /* Callback for freeing priv_data */
 251         const struct_sysent *s_ent; /* sysent[scno] or dummy struct for bad scno */
 252         const struct_sysent *s_prev_ent; /* for "resuming interrupted SYSCALL" msg */
 253         struct fault_opts *fault_vec[SUPPORTED_PERSONALITIES];
 254         struct timeval stime;   /* System time usage as of last process wait */
 255         struct timeval dtime;   /* Delta for system time usage */
 256         struct timeval etime;   /* Syscall entry time */
 257
 258 #ifdef USE_LIBUNWIND
 259         struct UPT_info* libunwind_ui;
 260         struct mmap_cache_t* mmap_cache;
 261         unsigned int mmap_cache_size;
 262         unsigned int mmap_cache_generation;
 263         struct queue_t* queue;
 264 #endif
 265 };
 266
 267 /* TCB flags */
 268 /* We have attached to this process, but did not see it stopping yet */
 269 #define TCB_STARTUP             0x01
 270 #define TCB_IGNORE_ONE_SIGSTOP  0x02    /* Next SIGSTOP is to be ignored */
 271 /*
 272  * Are we in system call entry or in syscall exit?
 273  *
 274  * This bit is set after all syscall entry processing is done.
 275  * Therefore, this bit will be set when next ptrace stop occurs,
 276  * which should be syscall exit stop. Other stops which are possible
 277  * directly after syscall entry (death, ptrace event stop)
 278  * are simpler and handled without calling trace_syscall(), therefore
 279  * the places where TCB_INSYSCALL can be set but we aren't in syscall stop
 280  * are limited to trace(), this condition is never observed in trace_syscall()
 281  * and below.
 282  * The bit is cleared after all syscall exit processing is done.
 283  *
 284  * Use entering(tcp) / exiting(tcp) to check this bit to make code more readable.
 285  */
 286 #define TCB_INSYSCALL   0x04
 287 #define TCB_ATTACHED    0x08    /* We attached to it already */
 288 #define TCB_REPRINT     0x10    /* We should reprint this syscall on exit */
 289 #define TCB_FILTERED    0x20    /* This system call has been filtered out */
 290 #define TCB_FAULT_INJ   0x40    /* A syscall fault has been injected */
 291 #define TCB_HIDE_LOG    0x80    /* We should hide everything (until execve) */
 292 #define TCB_SKIP_DETACH_ON_FIRST_EXEC   0x100   /* -b execve should skip detach on first execve */
 293
 294 /* qualifier flags */
 295 #define QUAL_TRACE      0x001   /* this system call should be traced */
 296 #define QUAL_ABBREV     0x002   /* abbreviate the structures of this syscall */
 297 #define QUAL_VERBOSE    0x004   /* decode the structures of this syscall */
 298 #define QUAL_RAW        0x008   /* print all args in hex for this syscall */
 299 #define QUAL_FAULT      0x010   /* fail this system call on purpose */
 300 #define QUAL_SIGNAL     0x100   /* report events with this signal */
 301 #define QUAL_READ       0x200   /* dump data read from this file descriptor */
 302 #define QUAL_WRITE      0x400   /* dump data written to this file descriptor */
 303
 304 #define DEFAULT_QUAL_FLAGS (QUAL_TRACE | QUAL_ABBREV | QUAL_VERBOSE)
 305
 306 #define entering(tcp)   (!((tcp)->flags & TCB_INSYSCALL))
 307 #define exiting(tcp)    ((tcp)->flags & TCB_INSYSCALL)
 308 #define syserror(tcp)   ((tcp)->u_error != 0)
 309 #define verbose(tcp)    ((tcp)->qual_flg & QUAL_VERBOSE)
 310 #define abbrev(tcp)     ((tcp)->qual_flg & QUAL_ABBREV)
 311 #define filtered(tcp)   ((tcp)->flags & TCB_FILTERED)
 312 #define hide_log(tcp)   ((tcp)->flags & TCB_HIDE_LOG)
 313
 314 #include "xlat.h"
 315
 316 extern const struct xlat addrfams[];
 317 extern const struct xlat at_flags[];
 318 extern const struct xlat dirent_types[];
 319 extern const struct xlat evdev_abs[];
 320 extern const struct xlat msg_flags[];
 321 extern const struct xlat open_access_modes[];
 322 extern const struct xlat open_mode_flags[];
 323 extern const struct xlat resource_flags[];
 324 extern const struct xlat socketlayers[];
 325 extern const struct xlat whence_codes[];
 326
 327 /* Format of syscall return values */
 328 #define RVAL_DECIMAL    000     /* decimal format */
 329 #define RVAL_HEX        001     /* hex format */
 330 #define RVAL_OCTAL      002     /* octal format */
 331 #define RVAL_UDECIMAL   003     /* unsigned decimal format */
 332 #if HAVE_STRUCT_TCB_EXT_ARG
 333 # if 0 /* unused so far */
 334 #  define RVAL_LDECIMAL 004     /* long decimal format */
 335 #  define RVAL_LHEX     005     /* long hex format */
 336 #  define RVAL_LOCTAL   006     /* long octal format */
 337 # endif
 338 # define RVAL_LUDECIMAL 007     /* long unsigned decimal format */
 339 #endif /* HAVE_STRUCT_TCB_EXT_ARG */
 340 #define RVAL_FD         010     /* file descriptor */
 341 #define RVAL_MASK       017     /* mask for these values */
 342
 343 #define RVAL_STR        020     /* Print `auxstr' field after return val */
 344 #define RVAL_NONE       040     /* Print nothing */
 345
 346 #define RVAL_DECODED    0100    /* syscall decoding finished */
 347
 348 #define TRACE_FILE      001     /* Trace file-related syscalls. */
 349 #define TRACE_IPC       002     /* Trace IPC-related syscalls. */
 350 #define TRACE_NETWORK   004     /* Trace network-related syscalls. */
 351 #define TRACE_PROCESS   010     /* Trace process-related syscalls. */
 352 #define TRACE_SIGNAL    020     /* Trace signal-related syscalls. */
 353 #define TRACE_DESC      040     /* Trace file descriptor-related syscalls. */
 354 #define TRACE_MEMORY    0100    /* Trace memory mapping-related syscalls. */
 355 #define SYSCALL_NEVER_FAILS     0200    /* Syscall is always successful. */
 356 #define STACKTRACE_INVALIDATE_CACHE 0400  /* Trigger proc/maps cache updating */
 357 #define STACKTRACE_CAPTURE_ON_ENTER 01000 /* Capture stacktrace on "entering" stage */
 358 #define TRACE_INDIRECT_SUBCALL  02000   /* Syscall is an indirect socket/ipc subcall. */
 359 #define COMPAT_SYSCALL_TYPES    04000   /* A compat syscall that uses compat types. */
 360
 361 #define IOCTL_NUMBER_UNKNOWN 0
 362 #define IOCTL_NUMBER_HANDLED 1
 363 #define IOCTL_NUMBER_STOP_LOOKUP 010
 364
 365 #define indirect_ipccall(tcp) (tcp->s_ent->sys_flags & TRACE_INDIRECT_SUBCALL)
 366
 367 #if defined(ARM) || defined(AARCH64) \
 368  || defined(I386) || defined(X32) || defined(X86_64) \
 369  || defined(IA64) \
 370  || defined(BFIN) \
 371  || defined(M68K) \
 372  || defined(MICROBLAZE) \
 373  || defined(RISCV) \
 374  || defined(S390) \
 375  || defined(SH) || defined(SH64) \
 376  || defined(SPARC) || defined(SPARC64) \
 377  /**/
 378 # define NEED_UID16_PARSERS 1
 379 #else
 380 # define NEED_UID16_PARSERS 0
 381 #endif
 382
 383 enum sock_proto {
 384         SOCK_PROTO_UNKNOWN,
 385         SOCK_PROTO_UNIX,
 386         SOCK_PROTO_TCP,
 387         SOCK_PROTO_UDP,
 388         SOCK_PROTO_TCPv6,
 389         SOCK_PROTO_UDPv6,
 390         SOCK_PROTO_NETLINK
 391 };
 392 extern enum sock_proto get_proto_by_name(const char *);
 393
 394 enum iov_decode {
 395         IOV_DECODE_ADDR,
 396         IOV_DECODE_STR,
 397         IOV_DECODE_NETLINK
 398 };
 399
 400 typedef enum {
 401         CFLAG_NONE = 0,
 402         CFLAG_ONLY_STATS,
 403         CFLAG_BOTH
 404 } cflag_t;
 405 extern cflag_t cflag;
 406 extern bool debug_flag;
 407 extern bool Tflag;
 408 extern bool iflag;
 409 extern bool count_wallclock;
 410 extern unsigned int qflag;
 411 extern bool not_failing_only;
 412 extern unsigned int show_fd_path;
 413 /* are we filtering traces based on paths? */
 414 extern const char **paths_selected;
 415 #define tracing_paths (paths_selected != NULL)
 416 extern unsigned xflag;
 417 extern unsigned followfork;
 418 #ifdef USE_LIBUNWIND
 419 /* if this is true do the stack trace for every system call */
 420 extern bool stack_trace_enabled;
 421 #endif
 422 extern unsigned ptrace_setoptions;
 423 extern unsigned max_strlen;
 424 extern unsigned os_release;
 425 #undef KERNEL_VERSION
 426 #define KERNEL_VERSION(a,b,c) (((a) << 16) + ((b) << 8) + (c))
 427
 428 void error_msg(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2));
 429 void perror_msg(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2));
 430 void error_msg_and_die(const char *fmt, ...)
 431         ATTRIBUTE_FORMAT((printf, 1, 2)) ATTRIBUTE_NORETURN;
 432 void error_msg_and_help(const char *fmt, ...)
 433         ATTRIBUTE_FORMAT((printf, 1, 2)) ATTRIBUTE_NORETURN;
 434 void perror_msg_and_die(const char *fmt, ...)
 435         ATTRIBUTE_FORMAT((printf, 1, 2)) ATTRIBUTE_NORETURN;
 436 void die_out_of_memory(void) ATTRIBUTE_NORETURN;
 437
 438 void *xmalloc(size_t size) ATTRIBUTE_MALLOC ATTRIBUTE_ALLOC_SIZE((1));
 439 void *xcalloc(size_t nmemb, size_t size)
 440         ATTRIBUTE_MALLOC ATTRIBUTE_ALLOC_SIZE((1, 2));
 441 void *xreallocarray(void *ptr, size_t nmemb, size_t size)
 442         ATTRIBUTE_ALLOC_SIZE((2, 3));
 443 char *xstrdup(const char *str) ATTRIBUTE_MALLOC;
 444
 445 #if USE_CUSTOM_PRINTF
 446 /*
 447  * See comment in vsprintf.c for allowed formats.
 448  * Short version: %h[h]u, %zu, %tu are not allowed, use %[l[l]]u.
 449  */
 450 int strace_vfprintf(FILE *fp, const char *fmt, va_list args);
 451 #else
 452 # define strace_vfprintf vfprintf
 453 #endif
 454
 455 extern int read_int_from_file(const char *, int *);
 456
 457 extern void set_sortby(const char *);
 458 extern void set_overhead(int);
 459 extern void print_pc(struct tcb *);
 460 extern int trace_syscall(struct tcb *);
 461 extern void count_syscall(struct tcb *, const struct timeval *);
 462 extern void call_summary(FILE *);
 463
 464 extern void clear_regs(void);
 465 extern void get_regs(pid_t pid);
 466 extern int get_scno(struct tcb *tcp);
 467 /**
 468  * Convert syscall number to syscall name.
 469  *
 470  * @param scno Syscall number.
 471  * @return     String literal corresponding to the syscall number in case latter
 472  *             is valid; NULL otherwise.
 473  */
 474 extern const char *syscall_name(kernel_scno_t scno);
 475 extern const char *err_name(unsigned long err);
 476
 477 extern bool is_erestart(struct tcb *);
 478 extern void temporarily_clear_syserror(struct tcb *);
 479 extern void restore_cleared_syserror(struct tcb *);
 480
 481 extern void *get_tcb_priv_data(const struct tcb *);
 482 extern int set_tcb_priv_data(struct tcb *, void *priv_data,
 483                              void (*free_priv_data)(void *));
 484 extern void free_tcb_priv_data(struct tcb *);
 485
 486 static inline unsigned long get_tcb_priv_ulong(const struct tcb *tcp)
 487 {
 488         return (unsigned long) get_tcb_priv_data(tcp);
 489 }
 490
 491 static inline int set_tcb_priv_ulong(struct tcb *tcp, unsigned long val)
 492 {
 493         return set_tcb_priv_data(tcp, (void *) val, 0);
 494 }
 495
 496 extern int
 497 umoven(struct tcb *tcp, kernel_ureg_t addr, unsigned int len, void *laddr);
 498 #define umove(pid, addr, objp)  \
 499         umoven((pid), (addr), sizeof(*(objp)), (void *) (objp))
 500
 501 extern int
 502 umoven_or_printaddr(struct tcb *tcp, kernel_ureg_t addr,
 503                     unsigned int len, void *laddr);
 504 #define umove_or_printaddr(pid, addr, objp)     \
 505         umoven_or_printaddr((pid), (addr), sizeof(*(objp)), (void *) (objp))
 506
 507 extern int
 508 umoven_or_printaddr_ignore_syserror(struct tcb *tcp, kernel_ureg_t addr,
 509                                     unsigned int len, void *laddr);
 510
 511 extern int
 512 umovestr(struct tcb *tcp, kernel_ureg_t addr, unsigned int len, char *laddr);
 513
 514 extern int upeek(int pid, long, long *);
 515 extern int upoke(int pid, long, long);
 516
 517 extern bool
 518 print_array(struct tcb *tcp,
 519             kernel_ureg_t start_addr,
 520             size_t nmemb,
 521             void *elem_buf,
 522             size_t elem_size,
 523             int (*umoven_func)(struct tcb *,
 524                                      kernel_ureg_t,
 525                                      unsigned int,
 526                                      void *),
 527             bool (*print_func)(struct tcb *,
 528                                      void *elem_buf,
 529                                      size_t elem_size,
 530                                      void *opaque_data),
 531             void *opaque_data);
 532
 533 #if defined ALPHA || defined IA64 || defined MIPS \
 534  || defined SH || defined SPARC || defined SPARC64
 535 # define HAVE_GETRVAL2
 536 extern long getrval2(struct tcb *);
 537 #else
 538 # undef HAVE_GETRVAL2
 539 #endif
 540
 541 extern const char *signame(const int);
 542 extern void pathtrace_select(const char *);
 543 extern int pathtrace_match(struct tcb *);
 544 extern int getfdpath(struct tcb *, int, char *, unsigned);
 545 extern enum sock_proto getfdproto(struct tcb *, int);
 546
 547 extern const char *xlookup(const struct xlat *, const uint64_t);
 548 extern const char *xlat_search(const struct xlat *, const size_t, const uint64_t);
 549
 550 extern unsigned long get_pagesize(void);
 551 extern int
 552 string_to_uint_ex(const char *str, char **endptr,
 553                   unsigned int max_val, const char *accepted_ending);
 554 extern int string_to_uint(const char *str);
 555 static inline int
 556 string_to_uint_upto(const char *const str, unsigned int max_val)
 557 {
 558         return string_to_uint_ex(str, NULL, max_val, NULL);
 559 }
 560 extern int next_set_bit(const void *bit_array, unsigned cur_bit, unsigned size_bits);
 561
 562 #define QUOTE_0_TERMINATED                      0x01
 563 #define QUOTE_OMIT_LEADING_TRAILING_QUOTES      0x02
 564 #define QUOTE_OMIT_TRAILING_0                   0x08
 565
 566 extern int string_quote(const char *, char *, unsigned int, unsigned int);
 567 extern int print_quoted_string(const char *, unsigned int, unsigned int);
 568
 569 /* a refers to the lower numbered u_arg,
 570  * b refers to the higher numbered u_arg
 571  */
 572 #ifdef WORDS_BIGENDIAN
 573 # define ULONG_LONG(a,b) \
 574         ((unsigned long long)(unsigned)(b) | ((unsigned long long)(a)<<32))
 575 #else
 576 # define ULONG_LONG(a,b) \
 577         ((unsigned long long)(unsigned)(a) | ((unsigned long long)(b)<<32))
 578 #endif
 579 extern int getllval(struct tcb *, unsigned long long *, int);
 580 extern int printllval(struct tcb *, const char *, int)
 581         ATTRIBUTE_FORMAT((printf, 2, 0));
 582
 583 extern void printaddr_klu(kernel_ulong_t addr);
 584 extern int printxvals(const uint64_t, const char *, const struct xlat *, ...)
 585         ATTRIBUTE_SENTINEL;
 586 extern int printxval_searchn(const struct xlat *xlat, size_t xlat_size,
 587         uint64_t val, const char *dflt);
 588 #define printxval_search(xlat__, val__, dflt__) \
 589         printxval_searchn(xlat__, ARRAY_SIZE(xlat__), val__, dflt__)
 590 extern kernel_ulong_t getarg_klu(struct tcb *tcp, int argn);
 591 extern int printargs(struct tcb *);
 592 extern int printargs_u(struct tcb *);
 593 extern int printargs_d(struct tcb *);
 594
 595 extern void addflags(const struct xlat *, uint64_t);
 596 extern int printflags64(const struct xlat *, uint64_t, const char *);
 597 extern const char *sprintflags(const char *, const struct xlat *, uint64_t);
 598 extern const char *sprinttime(time_t);
 599 extern void print_symbolic_mode_t(unsigned int);
 600 extern void print_numeric_umode_t(unsigned short);
 601 extern void print_numeric_long_umask(unsigned long);
 602
 603 extern void
 604 dumpiov_in_msghdr(struct tcb *, kernel_ureg_t addr, unsigned long data_size);
 605
 606 extern void
 607 dumpiov_in_mmsghdr(struct tcb *, kernel_ureg_t addr);
 608
 609 extern void
 610 dumpiov_upto(struct tcb *, int len, kernel_ureg_t addr, unsigned long data_size);
 611
 612 extern void
 613 dumpstr(struct tcb *, kernel_ureg_t addr, int len);
 614
 615 extern void
 616 printstr_ex(struct tcb *, kernel_ureg_t addr, long len,
 617             unsigned int user_style);
 618
 619 #define DECL_PRINTNUM(name)                                             \
 620 extern bool                                                             \
 621 printnum_ ## name(struct tcb *, kernel_ureg_t addr, const char *fmt)    \
 622         ATTRIBUTE_FORMAT((printf, 3, 0))
 623 DECL_PRINTNUM(short);
 624 DECL_PRINTNUM(int);
 625 DECL_PRINTNUM(int64);
 626 #undef DECL_PRINTNUM
 627
 628 #if SUPPORTED_PERSONALITIES > 1 && SIZEOF_LONG > 4
 629 extern bool
 630 printnum_long_int(struct tcb *, kernel_ureg_t addr,
 631                   const char *fmt_long, const char *fmt_int)
 632         ATTRIBUTE_FORMAT((printf, 3, 0))
 633         ATTRIBUTE_FORMAT((printf, 4, 0));
 634 # define printnum_slong(tcp, addr) \
 635         printnum_long_int((tcp), (addr), "%" PRId64, "%d")
 636 # define printnum_ulong(tcp, addr) \
 637         printnum_long_int((tcp), (addr), "%" PRIu64, "%u")
 638 # define printnum_ptr(tcp, addr) \
 639         printnum_long_int((tcp), (addr), "%#" PRIx64, "%#x")
 640 #elif SIZEOF_LONG > 4
 641 # define printnum_slong(tcp, addr) \
 642         printnum_int64((tcp), (addr), "%" PRId64)
 643 # define printnum_ulong(tcp, addr) \
 644         printnum_int64((tcp), (addr), "%" PRIu64)
 645 # define printnum_ptr(tcp, addr) \
 646         printnum_int64((tcp), (addr), "%#" PRIx64)
 647 #else
 648 # define printnum_slong(tcp, addr) \
 649         printnum_int((tcp), (addr), "%d")
 650 # define printnum_ulong(tcp, addr) \
 651         printnum_int((tcp), (addr), "%u")
 652 # define printnum_ptr(tcp, addr) \
 653         printnum_int((tcp), (addr), "%#x")
 654 #endif
 655
 656 #define DECL_PRINTPAIR(name)                                            \
 657 extern bool                                                             \
 658 printpair_ ## name(struct tcb *, kernel_ureg_t addr, const char *fmt)   \
 659         ATTRIBUTE_FORMAT((printf, 3, 0))
 660 DECL_PRINTPAIR(int);
 661 DECL_PRINTPAIR(int64);
 662 #undef DECL_PRINTPAIR
 663
 664 extern void
 665 printpathn(struct tcb *, kernel_ureg_t addr, unsigned int n);
 666
 667 extern void
 668 printpath(struct tcb *, kernel_ureg_t addr);
 669
 670 #define TIMESPEC_TEXT_BUFSIZE \
 671                 (sizeof(intmax_t)*3 * 2 + sizeof("{tv_sec=%jd, tv_nsec=%jd}"))
 672 extern void printfd(struct tcb *, int);
 673 extern void print_sockaddr(struct tcb *tcp, const void *, int);
 674 extern bool print_sockaddr_by_inode(const unsigned long, const enum sock_proto);
 675 extern bool print_sockaddr_by_inode_cached(const unsigned long);
 676 extern void print_dirfd(struct tcb *, int);
 677
 678 extern int
 679 decode_sockaddr(struct tcb *, kernel_ureg_t addr, int addrlen);
 680
 681 extern void printuid(const char *, const unsigned int);
 682
 683 extern void
 684 print_sigset_addr_len(struct tcb *, kernel_ureg_t addr, long len);
 685
 686 extern const char *sprintsigmask_n(const char *, const void *, unsigned int);
 687 #define tprintsigmask_addr(prefix, mask) \
 688         tprints(sprintsigmask_n((prefix), (mask), sizeof(mask)))
 689 extern void printsignal(int);
 690
 691 extern void
 692 tprint_iov_upto(struct tcb *, unsigned long len, kernel_ureg_t addr,
 693                 enum iov_decode, unsigned long data_size);
 694
 695 extern void
 696 decode_netlink(struct tcb *, kernel_ureg_t addr, unsigned long len);
 697
 698 extern void tprint_open_modes(unsigned int);
 699 extern const char *sprint_open_modes(unsigned int);
 700
 701 extern void
 702 print_seccomp_filter(struct tcb *, kernel_ureg_t addr);
 703
 704 extern void
 705 print_seccomp_fprog(struct tcb *, kernel_ureg_t addr, unsigned short len);
 706
 707 struct strace_stat;
 708 extern void print_struct_stat(struct tcb *tcp, const struct strace_stat *const st);
 709
 710 struct strace_statfs;
 711
 712 extern void
 713 print_struct_statfs(struct tcb *, kernel_ureg_t addr);
 714
 715 extern void
 716 print_struct_statfs64(struct tcb *, kernel_ureg_t addr, unsigned long size);
 717
 718 extern void print_ifindex(unsigned int);
 719
 720 struct number_set;
 721 extern struct number_set read_set;
 722 extern struct number_set write_set;
 723 extern struct number_set signal_set;
 724
 725 extern bool is_number_in_set(unsigned int number, const struct number_set *);
 726 extern void qualify(const char *);
 727 extern unsigned int qual_flags(const unsigned int);
 728
 729 #define DECL_IOCTL(name)                                                \
 730 extern int                                                              \
 731 name ## _ioctl(struct tcb *, unsigned int request, kernel_ureg_t arg)
 732 DECL_IOCTL(dm);
 733 DECL_IOCTL(file);
 734 DECL_IOCTL(fs_x);
 735 DECL_IOCTL(loop);
 736 DECL_IOCTL(ptp);
 737 DECL_IOCTL(scsi);
 738 DECL_IOCTL(sock);
 739 DECL_IOCTL(term);
 740 DECL_IOCTL(ubi);
 741 DECL_IOCTL(uffdio);
 742 #undef DECL_IOCTL
 743
 744 extern int tv_nz(const struct timeval *);
 745 extern int tv_cmp(const struct timeval *, const struct timeval *);
 746 extern double tv_float(const struct timeval *);
 747 extern void tv_add(struct timeval *, const struct timeval *, const struct timeval *);
 748 extern void tv_sub(struct timeval *, const struct timeval *, const struct timeval *);
 749 extern void tv_mul(struct timeval *, const struct timeval *, int);
 750 extern void tv_div(struct timeval *, const struct timeval *, int);
 751
 752 #ifdef USE_LIBUNWIND
 753 extern void unwind_init(void);
 754 extern void unwind_tcb_init(struct tcb *tcp);
 755 extern void unwind_tcb_fin(struct tcb *tcp);
 756 extern void unwind_cache_invalidate(struct tcb* tcp);
 757 extern void unwind_print_stacktrace(struct tcb* tcp);
 758 extern void unwind_capture_stacktrace(struct tcb* tcp);
 759 #endif
 760
 761 static inline void
 762 printaddr(kernel_ureg_t addr)
 763 {
 764         printaddr_klu(addr);
 765 }
 766
 767 static inline void
 768 printstr(struct tcb *tcp, kernel_ureg_t addr, long len)
 769 {
 770         printstr_ex(tcp, addr, len, 0);
 771 }
 772
 773 static inline int
 774 printflags(const struct xlat *x, unsigned int flags, const char *dflt)
 775 {
 776         return printflags64(x, flags, dflt);
 777 }
 778
 779 static inline int
 780 printflags_long(const struct xlat *x, unsigned long flags, const char *dflt)
 781 {
 782         return printflags64(x, flags, dflt);
 783 }
 784
 785 static inline int
 786 printxval64(const struct xlat *x, const uint64_t val, const char *dflt)
 787 {
 788         return printxvals(val, dflt, x, NULL);
 789 }
 790
 791 static inline int
 792 printxval(const struct xlat *x, const unsigned int val, const char *dflt)
 793 {
 794         return printxvals(val, dflt, x, NULL);
 795 }
 796
 797 static inline int
 798 printxval_long(const struct xlat *x, const unsigned long val, const char *dflt)
 799 {
 800         return printxvals(val, dflt, x, NULL);
 801 }
 802
 803 static inline void
 804 tprint_iov(struct tcb *tcp, unsigned long len, kernel_ureg_t addr,
 805            enum iov_decode decode_iov)
 806 {
 807         tprint_iov_upto(tcp, len, addr, decode_iov, -1UL);
 808 }
 809
 810 #ifdef ALPHA
 811 typedef struct {
 812         int tv_sec, tv_usec;
 813 } timeval32_t;
 814
 815 extern void print_timeval32_t(const timeval32_t *);
 816 extern void printrusage32(struct tcb *, long);
 817 extern const char *sprint_timeval32(struct tcb *tcp, kernel_ureg_t);
 818 extern void print_timeval32(struct tcb *tcp, kernel_ureg_t);
 819 extern void print_timeval32_pair(struct tcb *tcp, kernel_ureg_t);
 820 extern void print_itimerval32(struct tcb *tcp, kernel_ureg_t);
 821 #endif
 822
 823 #ifdef HAVE_STRUCT_USER_DESC
 824 extern void print_user_desc(struct tcb *, kernel_ureg_t addr);
 825 #endif
 826
 827 /* Strace log generation machinery.
 828  *
 829  * printing_tcp: tcb which has incomplete line being printed right now.
 830  * NULL if last line has been completed ('\n'-terminated).
 831  * printleader(tcp) examines it, finishes incomplete line if needed,
 832  * the sets it to tcp.
 833  * line_ended() clears printing_tcp and resets ->curcol = 0.
 834  * tcp->curcol == 0 check is also used to detect completeness
 835  * of last line, since in -ff mode just checking printing_tcp for NULL
 836  * is not enough.
 837  *
 838  * If you change this code, test log generation in both -f and -ff modes
 839  * using:
 840  * strace -oLOG -f[f] test/threaded_execve
 841  * strace -oLOG -f[f] test/sigkill_rain
 842  * strace -oLOG -f[f] -p "`pidof web_browser`"
 843  */
 844 extern struct tcb *printing_tcp;
 845 extern void printleader(struct tcb *);
 846 extern void line_ended(void);
 847 extern void tabto(void);
 848 extern void tprintf(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2));
 849 extern void tprints(const char *str);
 850
 851 #if SUPPORTED_PERSONALITIES > 1
 852 extern void set_personality(int personality);
 853 extern unsigned current_personality;
 854 #else
 855 # define set_personality(personality) ((void)0)
 856 # define current_personality 0
 857 #endif
 858
 859 #if SUPPORTED_PERSONALITIES == 1
 860 # define current_wordsize PERSONALITY0_WORDSIZE
 861 # define current_klongsize PERSONALITY0_KLONGSIZE
 862 #else
 863 # if SUPPORTED_PERSONALITIES == 2 && PERSONALITY0_WORDSIZE == PERSONALITY1_WORDSIZE
 864 #  define current_wordsize PERSONALITY0_WORDSIZE
 865 # else
 866 extern unsigned current_wordsize;
 867 # endif
 868 # if SUPPORTED_PERSONALITIES == 2 && PERSONALITY0_KLONGSIZE == PERSONALITY1_KLONGSIZE
 869 #  define current_klongsize PERSONALITY0_KLONGSIZE
 870 # else
 871 extern unsigned current_klongsize;
 872 # endif
 873 #endif
 874
 875 /* In many, many places we play fast and loose and use
 876  * tprintf("%d", (int) tcp->u_arg[N]) to print fds, pids etc.
 877  * We probably need to use widen_to_long() instead:
 878  */
 879 #if SUPPORTED_PERSONALITIES > 1 && SIZEOF_LONG > 4
 880 # define widen_to_long(v) (current_wordsize == 4 ? (long)(int32_t)(v) : (long)(v))
 881 #else
 882 # define widen_to_long(v) ((long)(v))
 883 #endif
 884
 885 #if SUPPORTED_PERSONALITIES > 1 && SIZEOF_LONG > 4
 886 # define widen_to_ulong(v) \
 887         (current_wordsize == 4 ? (unsigned long) (uint32_t) (v) : \
 888                 (unsigned long) (v))
 889 #else
 890 # define widen_to_ulong(v) ((unsigned long)(v))
 891 #endif
 892
 893 /*
 894  * Zero-extend a signed integer type to unsigned long long.
 895  */
 896 #define zero_extend_signed_to_ull(v) \
 897         (sizeof(v) == sizeof(char) ? (unsigned long long) (unsigned char) (v) : \
 898          sizeof(v) == sizeof(short) ? (unsigned long long) (unsigned short) (v) : \
 899          sizeof(v) == sizeof(int) ? (unsigned long long) (unsigned int) (v) : \
 900          sizeof(v) == sizeof(long) ? (unsigned long long) (unsigned long) (v) : \
 901          (unsigned long long) (v))
 902
 903 /*
 904  * Sign-extend an unsigned integer type to long long.
 905  */
 906 #define sign_extend_unsigned_to_ll(v) \
 907         (sizeof(v) == sizeof(char) ? (long long) (char) (v) : \
 908          sizeof(v) == sizeof(short) ? (long long) (short) (v) : \
 909          sizeof(v) == sizeof(int) ? (long long) (int) (v) : \
 910          sizeof(v) == sizeof(long) ? (long long) (long) (v) : \
 911          (long long) (v))
 912
 913 extern const struct_sysent sysent0[];
 914 extern const char *const errnoent0[];
 915 extern const char *const signalent0[];
 916 extern const struct_ioctlent ioctlent0[];
 917
 918 #if SUPPORTED_PERSONALITIES > 1
 919 extern const struct_sysent *sysent;
 920 extern const char *const *errnoent;
 921 extern const char *const *signalent;
 922 extern const struct_ioctlent *ioctlent;
 923 #else
 924 # define sysent     sysent0
 925 # define errnoent   errnoent0
 926 # define signalent  signalent0
 927 # define ioctlent   ioctlent0
 928 #endif
 929
 930 extern unsigned nsyscalls;
 931 extern unsigned nerrnos;
 932 extern unsigned nsignals;
 933 extern unsigned nioctlents;
 934
 935 extern const unsigned int nsyscall_vec[SUPPORTED_PERSONALITIES];
 936 extern const struct_sysent *const sysent_vec[SUPPORTED_PERSONALITIES];
 937 extern struct fault_opts *fault_vec[SUPPORTED_PERSONALITIES];
 938
 939 #ifdef IN_MPERS_BOOTSTRAP
 940 /* Transform multi-line MPERS_PRINTER_DECL statements to one-liners.  */
 941 # define MPERS_PRINTER_DECL(type, name, ...) MPERS_PRINTER_DECL(type, name, __VA_ARGS__)
 942 #else /* !IN_MPERS_BOOTSTRAP */
 943 # if SUPPORTED_PERSONALITIES > 1
 944 #  include "printers.h"
 945 # else
 946 #  include "native_printer_decls.h"
 947 # endif
 948 # define MPERS_PRINTER_DECL(type, name, ...) type MPERS_FUNC_NAME(name)(__VA_ARGS__)
 949 #endif /* !IN_MPERS_BOOTSTRAP */
 950
 951 /* Checks that sysent[scno] is not out of range. */
 952 static inline bool
 953 scno_in_range(kernel_scno_t scno)
 954 {
 955         return scno < nsyscalls;
 956 }
 957
 958 /*
 959  * Checks whether scno is not out of range,
 960  * its corresponding sysent[scno].sys_func is non-NULL,
 961  * and its sysent[scno].sys_flags has no TRACE_INDIRECT_SUBCALL flag set.
 962  */
 963 static inline bool
 964 scno_is_valid(kernel_scno_t scno)
 965 {
 966         return scno_in_range(scno)
 967                && sysent[scno].sys_func
 968                && !(sysent[scno].sys_flags & TRACE_INDIRECT_SUBCALL);
 969 }
 970
 971 #define MPERS_FUNC_NAME__(prefix, name) prefix ## name
 972 #define MPERS_FUNC_NAME_(prefix, name) MPERS_FUNC_NAME__(prefix, name)
 973 #define MPERS_FUNC_NAME(name) MPERS_FUNC_NAME_(MPERS_PREFIX, name)
 974
 975 #define SYS_FUNC_NAME(syscall_name) MPERS_FUNC_NAME(syscall_name)
 976
 977 #define SYS_FUNC(syscall_name) int SYS_FUNC_NAME(sys_ ## syscall_name)(struct tcb *tcp)
 978
 979 #if SIZEOF_KERNEL_LONG_T > SIZEOF_LONG
 980 # define PRI_kl "ll"
 981 #else
 982 # define PRI_kl "l"
 983 #endif
 984
 985 #define PRI_kld PRI_kl"d"
 986 #define PRI_klu PRI_kl"u"
 987 #define PRI_klx PRI_kl"x"
 988
 989 /*
 990  * The kernel used to define 64-bit types on 64-bit systems on a per-arch
 991  * basis.  Some architectures would use unsigned long and others would use
 992  * unsigned long long.  These types were exported as part of the
 993  * kernel-userspace ABI and now must be maintained forever.  This matches
 994  * what the kernel exports for each architecture so we don't need to cast
 995  * every printing of __u64 or __s64 to stdint types.
 996  */
 997 #if SIZEOF_LONG == 4
 998 # define PRI__64 "ll"
 999 #elif defined ALPHA || defined IA64 || defined MIPS || defined POWERPC
1000 # define PRI__64 "l"
1001 #else
1002 # define PRI__64 "ll"
1003 #endif
1004
1005 #define PRI__d64 PRI__64"d"
1006 #define PRI__u64 PRI__64"u"
1007 #define PRI__x64 PRI__64"x"
1008
1009 #endif /* !STRACE_DEFS_H */