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