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 at_flags[];
 288 extern const struct xlat clocknames[];
 289 extern const struct xlat dirent_types[];
 290 extern const struct xlat ethernet_protocols[];
 291 extern const struct xlat evdev_abs[];
 292 extern const struct xlat inet_protocols[];
 293 extern const struct xlat msg_flags[];
 294 extern const struct xlat netlink_protocols[];
 295 extern const struct xlat open_access_modes[];
 296 extern const struct xlat open_mode_flags[];
 297 extern const struct xlat resource_flags[];
 298 extern const struct xlat setns_types[];
 299 extern const struct xlat sg_io_info[];
 300 extern const struct xlat socketlayers[];
 301 extern const struct xlat socktypes[];
 302 extern const struct xlat tcp_state_flags[];
 303 extern const struct xlat tcp_states[];
 304 extern const struct xlat whence_codes[];
 305
 306 /* Format of syscall return values */
 307 #define RVAL_DECIMAL    000     /* decimal format */
 308 #define RVAL_HEX        001     /* hex format */
 309 #define RVAL_OCTAL      002     /* octal format */
 310 #define RVAL_UDECIMAL   003     /* unsigned decimal format */
 311 #define RVAL_FD         010     /* file descriptor */
 312 #define RVAL_MASK       013     /* mask for these values */
 313
 314 #define RVAL_STR        020     /* Print `auxstr' field after return val */
 315 #define RVAL_NONE       040     /* Print nothing */
 316
 317 #define RVAL_DECODED    0100    /* syscall decoding finished */
 318
 319 #define IOCTL_NUMBER_UNKNOWN 0
 320 #define IOCTL_NUMBER_HANDLED 1
 321 #define IOCTL_NUMBER_STOP_LOOKUP 010
 322
 323 #define indirect_ipccall(tcp) (tcp->s_ent->sys_flags & TRACE_INDIRECT_SUBCALL)
 324
 325 #if defined(ARM) || defined(AARCH64) \
 326  || defined(I386) || defined(X32) || defined(X86_64) \
 327  || defined(IA64) \
 328  || defined(BFIN) \
 329  || defined(M68K) \
 330  || defined(MICROBLAZE) \
 331  || defined(RISCV) \
 332  || defined(S390) \
 333  || defined(SH) || defined(SH64) \
 334  || defined(SPARC) || defined(SPARC64) \
 335  /**/
 336 # define NEED_UID16_PARSERS 1
 337 #else
 338 # define NEED_UID16_PARSERS 0
 339 #endif
 340
 341 enum sock_proto {
 342         SOCK_PROTO_UNKNOWN,
 343         SOCK_PROTO_UNIX,
 344         SOCK_PROTO_TCP,
 345         SOCK_PROTO_UDP,
 346         SOCK_PROTO_TCPv6,
 347         SOCK_PROTO_UDPv6,
 348         SOCK_PROTO_NETLINK
 349 };
 350 extern enum sock_proto get_proto_by_name(const char *);
 351
 352 enum iov_decode {
 353         IOV_DECODE_ADDR,
 354         IOV_DECODE_STR,
 355         IOV_DECODE_NETLINK
 356 };
 357
 358 typedef enum {
 359         CFLAG_NONE = 0,
 360         CFLAG_ONLY_STATS,
 361         CFLAG_BOTH
 362 } cflag_t;
 363 extern cflag_t cflag;
 364 extern bool debug_flag;
 365 extern bool Tflag;
 366 extern bool iflag;
 367 extern bool count_wallclock;
 368 extern unsigned int qflag;
 369 extern bool not_failing_only;
 370 extern unsigned int show_fd_path;
 371 /* are we filtering traces based on paths? */
 372 extern struct path_set {
 373         const char **paths_selected;
 374         unsigned int num_selected;
 375 } global_path_set;
 376 #define tracing_paths (global_path_set.num_selected != 0)
 377 extern unsigned xflag;
 378 extern unsigned followfork;
 379 #ifdef USE_LIBUNWIND
 380 /* if this is true do the stack trace for every system call */
 381 extern bool stack_trace_enabled;
 382 #endif
 383 extern unsigned ptrace_setoptions;
 384 extern unsigned max_strlen;
 385 extern unsigned os_release;
 386 #undef KERNEL_VERSION
 387 #define KERNEL_VERSION(a, b, c) (((a) << 16) + ((b) << 8) + (c))
 388
 389 extern int read_int_from_file(const char *, int *);
 390
 391 extern void set_sortby(const char *);
 392 extern void set_overhead(int);
 393 extern void print_pc(struct tcb *);
 394
 395 extern int syscall_entering_decode(struct tcb *);
 396 extern int syscall_entering_trace(struct tcb *, unsigned int *);
 397 extern void syscall_entering_finish(struct tcb *, int);
 398
 399 extern int syscall_exiting_decode(struct tcb *, struct timeval *);
 400 extern int syscall_exiting_trace(struct tcb *, struct timeval, int);
 401 extern void syscall_exiting_finish(struct tcb *);
 402
 403 extern void count_syscall(struct tcb *, const struct timeval *);
 404 extern void call_summary(FILE *);
 405
 406 extern void clear_regs(void);
 407 extern int get_scno(struct tcb *);
 408 extern kernel_ulong_t get_rt_sigframe_addr(struct tcb *);
 409
 410 /**
 411  * Convert syscall number to syscall name.
 412  *
 413  * @param scno Syscall number.
 414  * @return     String literal corresponding to the syscall number in case latter
 415  *             is valid; NULL otherwise.
 416  */
 417 extern const char *syscall_name(kernel_ulong_t scno);
 418 extern const char *err_name(unsigned long err);
 419
 420 extern bool is_erestart(struct tcb *);
 421 extern void temporarily_clear_syserror(struct tcb *);
 422 extern void restore_cleared_syserror(struct tcb *);
 423
 424 extern void *get_tcb_priv_data(const struct tcb *);
 425 extern int set_tcb_priv_data(struct tcb *, void *priv_data,
 426                              void (*free_priv_data)(void *));
 427 extern void free_tcb_priv_data(struct tcb *);
 428
 429 static inline unsigned long get_tcb_priv_ulong(const struct tcb *tcp)
 430 {
 431         return (unsigned long) get_tcb_priv_data(tcp);
 432 }
 433
 434 static inline int set_tcb_priv_ulong(struct tcb *tcp, unsigned long val)
 435 {
 436         return set_tcb_priv_data(tcp, (void *) val, 0);
 437 }
 438
 439 extern int
 440 umoven(struct tcb *, kernel_ulong_t addr, unsigned int len, void *laddr);
 441 #define umove(pid, addr, objp)  \
 442         umoven((pid), (addr), sizeof(*(objp)), (void *) (objp))
 443
 444 extern int
 445 umoven_or_printaddr(struct tcb *, kernel_ulong_t addr,
 446                     unsigned int len, void *laddr);
 447 #define umove_or_printaddr(pid, addr, objp)     \
 448         umoven_or_printaddr((pid), (addr), sizeof(*(objp)), (void *) (objp))
 449
 450 extern int
 451 umoven_or_printaddr_ignore_syserror(struct tcb *, kernel_ulong_t addr,
 452                                     unsigned int len, void *laddr);
 453
 454 extern int
 455 umovestr(struct tcb *, kernel_ulong_t addr, unsigned int len, char *laddr);
 456
 457 extern int upeek(int pid, unsigned long, kernel_ulong_t *);
 458 extern int upoke(int pid, unsigned long, kernel_ulong_t);
 459
 460 extern bool
 461 print_array(struct tcb *,
 462             kernel_ulong_t start_addr,
 463             size_t nmemb,
 464             void *elem_buf,
 465             size_t elem_size,
 466             int (*umoven_func)(struct tcb *,
 467                                      kernel_ulong_t,
 468                                      unsigned int,
 469                                      void *),
 470             bool (*print_func)(struct tcb *,
 471                                      void *elem_buf,
 472                                      size_t elem_size,
 473                                      void *opaque_data),
 474             void *opaque_data);
 475
 476 #if defined ALPHA || defined IA64 || defined MIPS \
 477  || defined SH || defined SPARC || defined SPARC64
 478 # define HAVE_GETRVAL2
 479 extern long getrval2(struct tcb *);
 480 #else
 481 # undef HAVE_GETRVAL2
 482 #endif
 483
 484 extern const char *signame(const int);
 485 extern void pathtrace_select_set(const char *, struct path_set *);
 486 extern bool pathtrace_match_set(struct tcb *, struct path_set *);
 487 #define pathtrace_select(tcp)   \
 488         pathtrace_select_set(tcp, &global_path_set)
 489 #define pathtrace_match(tcp)    \
 490         pathtrace_match_set(tcp, &global_path_set)
 491 extern int getfdpath(struct tcb *, int, char *, unsigned);
 492 extern unsigned long getfdinode(struct tcb *, int);
 493 extern enum sock_proto getfdproto(struct tcb *, int);
 494
 495 extern const char *xlookup(const struct xlat *, const uint64_t);
 496 extern const char *xlat_search(const struct xlat *, const size_t, const uint64_t);
 497
 498 struct dyxlat;
 499 struct dyxlat *dyxlat_alloc(size_t nmemb);
 500 void dyxlat_free(struct dyxlat *);
 501 const struct xlat *dyxlat_get(const struct dyxlat *);
 502 void dyxlat_add_pair(struct dyxlat *, uint64_t val, const char *str, size_t len);
 503
 504 const struct xlat *genl_families_xlat(void);
 505
 506 extern unsigned long get_pagesize(void);
 507 extern int
 508 string_to_uint_ex(const char *str, char **endptr,
 509                   unsigned int max_val, const char *accepted_ending);
 510 extern int string_to_uint(const char *str);
 511 static inline int
 512 string_to_uint_upto(const char *const str, unsigned int max_val)
 513 {
 514         return string_to_uint_ex(str, NULL, max_val, NULL);
 515 }
 516 extern int next_set_bit(const void *bit_array, unsigned cur_bit, unsigned size_bits);
 517
 518 /*
 519  * Returns STR if it does not start with PREFIX,
 520  * or a pointer to the first char in STR after PREFIX.
 521  * The length of PREFIX is specified by PREFIX_LEN.
 522  */
 523 static inline const char *
 524 str_strip_prefix_len(const char *str, const char *prefix, size_t prefix_len)
 525 {
 526         return strncmp(str, prefix, prefix_len) ? str : str + prefix_len;
 527 }
 528
 529 #define STR_STRIP_PREFIX(str, prefix)   \
 530         str_strip_prefix_len((str), (prefix), sizeof(prefix) - 1)
 531
 532 #define QUOTE_0_TERMINATED                      0x01
 533 #define QUOTE_OMIT_LEADING_TRAILING_QUOTES      0x02
 534 #define QUOTE_OMIT_TRAILING_0                   0x08
 535 #define QUOTE_FORCE_HEX                         0x10
 536
 537 extern int string_quote(const char *, char *, unsigned int, unsigned int);
 538 extern int print_quoted_string(const char *, unsigned int, unsigned int);
 539 extern int print_quoted_cstring(const char *, unsigned int);
 540
 541 /* a refers to the lower numbered u_arg,
 542  * b refers to the higher numbered u_arg
 543  */
 544 #ifdef WORDS_BIGENDIAN
 545 # define ULONG_LONG(a, b) \
 546         ((unsigned long long)(unsigned)(b) | ((unsigned long long)(a)<<32))
 547 #else
 548 # define ULONG_LONG(a, b) \
 549         ((unsigned long long)(unsigned)(a) | ((unsigned long long)(b)<<32))
 550 #endif
 551 extern int getllval(struct tcb *, unsigned long long *, int);
 552 extern int printllval(struct tcb *, const char *, int)
 553         ATTRIBUTE_FORMAT((printf, 2, 0));
 554
 555 extern void printaddr(kernel_ulong_t addr);
 556 extern int printxvals(const uint64_t, const char *, const struct xlat *, ...)
 557         ATTRIBUTE_SENTINEL;
 558 extern int printxval_searchn(const struct xlat *xlat, size_t xlat_size,
 559         uint64_t val, const char *dflt);
 560 #define printxval_search(xlat__, val__, dflt__) \
 561         printxval_searchn(xlat__, ARRAY_SIZE(xlat__), val__, dflt__)
 562 extern int printargs(struct tcb *);
 563 extern int printargs_u(struct tcb *);
 564 extern int printargs_d(struct tcb *);
 565
 566 extern void addflags(const struct xlat *, uint64_t);
 567 extern int printflags_ex(uint64_t, const char *, const struct xlat *, ...)
 568         ATTRIBUTE_SENTINEL;
 569 extern const char *sprintflags(const char *, const struct xlat *, uint64_t);
 570 extern const char *sprinttime(long long sec);
 571 extern const char *sprinttime_nsec(long long sec, unsigned long long nsec);
 572 extern const char *sprinttime_usec(long long sec, unsigned long long usec);
 573 extern void print_symbolic_mode_t(unsigned int);
 574 extern void print_numeric_umode_t(unsigned short);
 575 extern void print_numeric_long_umask(unsigned long);
 576 extern void print_dev_t(unsigned long long dev);
 577 extern void print_abnormal_hi(kernel_ulong_t);
 578
 579 extern void
 580 dumpiov_in_msghdr(struct tcb *, kernel_ulong_t addr, kernel_ulong_t data_size);
 581
 582 extern void
 583 dumpiov_in_mmsghdr(struct tcb *, kernel_ulong_t addr);
 584
 585 extern void
 586 dumpiov_upto(struct tcb *, int len, kernel_ulong_t addr, kernel_ulong_t data_size);
 587
 588 extern void
 589 dumpstr(struct tcb *, kernel_ulong_t addr, int len);
 590
 591 extern void
 592 printstr_ex(struct tcb *, kernel_ulong_t addr, kernel_ulong_t len,
 593             unsigned int user_style);
 594
 595 extern void
 596 printpathn(struct tcb *, kernel_ulong_t addr, unsigned int n);
 597
 598 extern void
 599 printpath(struct tcb *, kernel_ulong_t addr);
 600
 601 #define TIMESPEC_TEXT_BUFSIZE \
 602                 (sizeof(long long) * 3 * 2 + sizeof("{tv_sec=-, tv_nsec=}"))
 603 extern void printfd(struct tcb *, int);
 604 extern void print_sockaddr(const void *sa, int len);
 605 extern bool
 606 print_inet_addr(int af, const void *addr, unsigned int len, const char *var_name);
 607 extern const char *get_sockaddr_by_inode(struct tcb *, int fd, unsigned long inode);
 608 extern bool print_sockaddr_by_inode(struct tcb *, int fd, unsigned long inode);
 609 extern void print_dirfd(struct tcb *, int);
 610
 611 extern int
 612 decode_sockaddr(struct tcb *, kernel_ulong_t addr, int addrlen);
 613
 614 extern void printuid(const char *, const unsigned int);
 615
 616 extern void
 617 print_sigset_addr_len(struct tcb *, kernel_ulong_t addr, kernel_ulong_t len);
 618 extern void
 619 print_sigset_addr(struct tcb *, kernel_ulong_t addr);
 620
 621 extern const char *sprintsigmask_n(const char *, const void *, unsigned int);
 622 #define tprintsigmask_addr(prefix, mask) \
 623         tprints(sprintsigmask_n((prefix), (mask), sizeof(mask)))
 624 extern void printsignal(int);
 625
 626 extern void
 627 tprint_iov_upto(struct tcb *, kernel_ulong_t len, kernel_ulong_t addr,
 628                 enum iov_decode, kernel_ulong_t data_size);
 629
 630 extern void
 631 decode_netlink(struct tcb *, int fd, kernel_ulong_t addr, kernel_ulong_t len);
 632
 633 extern void tprint_open_modes(unsigned int);
 634 extern const char *sprint_open_modes(unsigned int);
 635
 636 extern void
 637 decode_seccomp_fprog(struct tcb *, kernel_ulong_t addr);
 638
 639 extern void
 640 print_seccomp_fprog(struct tcb *, kernel_ulong_t addr, unsigned short len);
 641
 642 extern void
 643 decode_sock_fprog(struct tcb *, kernel_ulong_t addr);
 644
 645 extern void
 646 print_sock_fprog(struct tcb *, kernel_ulong_t addr, unsigned short len);
 647
 648 struct strace_stat;
 649 extern void print_struct_stat(struct tcb *, const struct strace_stat *const st);
 650
 651 struct strace_statfs;
 652
 653 extern void
 654 print_struct_statfs(struct tcb *, kernel_ulong_t addr);
 655
 656 extern void
 657 print_struct_statfs64(struct tcb *, kernel_ulong_t addr, kernel_ulong_t size);
 658
 659 extern void print_ifindex(unsigned int);
 660
 661 struct number_set;
 662 extern struct number_set read_set;
 663 extern struct number_set write_set;
 664 extern struct number_set signal_set;
 665
 666 extern bool is_number_in_set(unsigned int number, const struct number_set *);
 667 extern void qualify(const char *);
 668 extern unsigned int qual_flags(const unsigned int);
 669
 670 #define DECL_IOCTL(name)                                                \
 671 extern int                                                              \
 672 name ## _ioctl(struct tcb *, unsigned int request, kernel_ulong_t arg)  \
 673 /* End of DECL_IOCTL definition. */
 674
 675 DECL_IOCTL(dm);
 676 DECL_IOCTL(file);
 677 DECL_IOCTL(fs_x);
 678 DECL_IOCTL(nsfs);
 679 DECL_IOCTL(ptp);
 680 DECL_IOCTL(scsi);
 681 DECL_IOCTL(term);
 682 DECL_IOCTL(ubi);
 683 DECL_IOCTL(uffdio);
 684 #undef DECL_IOCTL
 685
 686 extern int decode_sg_io_v4(struct tcb *, const kernel_ulong_t arg);
 687
 688 struct nlmsghdr;
 689
 690 typedef bool (*netlink_decoder_t)(struct tcb *, const struct nlmsghdr *,
 691                                   kernel_ulong_t addr, unsigned int len);
 692
 693 #define DECL_NETLINK(name)                                              \
 694 extern bool                                                             \
 695 decode_netlink_ ## name(struct tcb *, const struct nlmsghdr *,          \
 696                         kernel_ulong_t addr, unsigned int len)          \
 697 /* End of DECL_NETLINK definition. */
 698
 699 DECL_NETLINK(crypto);
 700 DECL_NETLINK(selinux);
 701 DECL_NETLINK(sock_diag);
 702
 703 extern int tv_nz(const struct timeval *);
 704 extern int tv_cmp(const struct timeval *, const struct timeval *);
 705 extern double tv_float(const struct timeval *);
 706 extern void tv_add(struct timeval *, const struct timeval *, const struct timeval *);
 707 extern void tv_sub(struct timeval *, const struct timeval *, const struct timeval *);
 708 extern void tv_mul(struct timeval *, const struct timeval *, int);
 709 extern void tv_div(struct timeval *, const struct timeval *, int);
 710
 711 #ifdef USE_LIBUNWIND
 712 extern void unwind_init(void);
 713 extern void unwind_tcb_init(struct tcb *);
 714 extern void unwind_tcb_fin(struct tcb *);
 715 extern void unwind_cache_invalidate(struct tcb *);
 716 extern void unwind_print_stacktrace(struct tcb *);
 717 extern void unwind_capture_stacktrace(struct tcb *);
 718 #endif
 719
 720 static inline void
 721 printstrn(struct tcb *tcp, kernel_ulong_t addr, kernel_ulong_t len)
 722 {
 723         printstr_ex(tcp, addr, len, 0);
 724 }
 725
 726 static inline void
 727 printstr(struct tcb *tcp, kernel_ulong_t addr)
 728 {
 729         printstr_ex(tcp, addr, -1, QUOTE_0_TERMINATED);
 730 }
 731
 732 static inline int
 733 printflags64(const struct xlat *x, uint64_t flags, const char *dflt)
 734 {
 735         return printflags_ex(flags, dflt, x, NULL);
 736 }
 737
 738 static inline int
 739 printflags(const struct xlat *x, unsigned int flags, const char *dflt)
 740 {
 741         return printflags64(x, flags, dflt);
 742 }
 743
 744 static inline int
 745 printxval64(const struct xlat *x, const uint64_t val, const char *dflt)
 746 {
 747         return printxvals(val, dflt, x, NULL);
 748 }
 749
 750 static inline int
 751 printxval(const struct xlat *x, const unsigned int val, const char *dflt)
 752 {
 753         return printxvals(val, dflt, x, NULL);
 754 }
 755
 756 static inline void
 757 tprint_iov(struct tcb *tcp, kernel_ulong_t len, kernel_ulong_t addr,
 758            enum iov_decode decode_iov)
 759 {
 760         tprint_iov_upto(tcp, len, addr, decode_iov, -1);
 761 }
 762
 763 #ifdef ALPHA
 764 typedef struct {
 765         int tv_sec, tv_usec;
 766 } timeval32_t;
 767
 768 extern void print_timeval32_t(const timeval32_t *);
 769 extern void printrusage32(struct tcb *, kernel_ulong_t);
 770 extern const char *sprint_timeval32(struct tcb *, kernel_ulong_t addr);
 771 extern void print_timeval32(struct tcb *, kernel_ulong_t addr);
 772 extern void print_timeval32_utimes(struct tcb *, kernel_ulong_t addr);
 773 extern void print_itimerval32(struct tcb *, kernel_ulong_t addr);
 774 #endif
 775
 776 #ifdef HAVE_STRUCT_USER_DESC
 777 extern void print_user_desc(struct tcb *, kernel_ulong_t addr);
 778 #endif
 779
 780 /* Strace log generation machinery.
 781  *
 782  * printing_tcp: tcb which has incomplete line being printed right now.
 783  * NULL if last line has been completed ('\n'-terminated).
 784  * printleader(tcp) examines it, finishes incomplete line if needed,
 785  * the sets it to tcp.
 786  * line_ended() clears printing_tcp and resets ->curcol = 0.
 787  * tcp->curcol == 0 check is also used to detect completeness
 788  * of last line, since in -ff mode just checking printing_tcp for NULL
 789  * is not enough.
 790  *
 791  * If you change this code, test log generation in both -f and -ff modes
 792  * using:
 793  * strace -oLOG -f[f] test/threaded_execve
 794  * strace -oLOG -f[f] test/sigkill_rain
 795  * strace -oLOG -f[f] -p "`pidof web_browser`"
 796  */
 797 extern struct tcb *printing_tcp;
 798 extern void printleader(struct tcb *);
 799 extern void line_ended(void);
 800 extern void tabto(void);
 801 extern void tprintf(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2));
 802 extern void tprints(const char *str);
 803 extern void tprintf_comment(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2));
 804 extern void tprints_comment(const char *str);
 805
 806 #if SUPPORTED_PERSONALITIES > 1
 807 extern void set_personality(int personality);
 808 extern unsigned current_personality;
 809 #else
 810 # define set_personality(personality) ((void)0)
 811 # define current_personality 0
 812 #endif
 813
 814 #if SUPPORTED_PERSONALITIES == 1
 815 # define current_wordsize PERSONALITY0_WORDSIZE
 816 # define current_klongsize PERSONALITY0_KLONGSIZE
 817 #else
 818 # if SUPPORTED_PERSONALITIES == 2 && PERSONALITY0_WORDSIZE == PERSONALITY1_WORDSIZE
 819 #  define current_wordsize PERSONALITY0_WORDSIZE
 820 # else
 821 extern unsigned current_wordsize;
 822 # endif
 823 # if SUPPORTED_PERSONALITIES == 2 && PERSONALITY0_KLONGSIZE == PERSONALITY1_KLONGSIZE
 824 #  define current_klongsize PERSONALITY0_KLONGSIZE
 825 # else
 826 extern unsigned current_klongsize;
 827 # endif
 828 #endif
 829
 830 #define ANY_WORDSIZE_LESS_THAN_KERNEL_LONG      \
 831         (SIZEOF_KERNEL_LONG_T > 4               \
 832          && (SIZEOF_LONG < SIZEOF_KERNEL_LONG_T || !defined(current_wordsize)))
 833
 834 #define DECL_PRINTNUM(name)                                             \
 835 extern bool                                                             \
 836 printnum_ ## name(struct tcb *, kernel_ulong_t addr, const char *fmt)   \
 837         ATTRIBUTE_FORMAT((printf, 3, 0))                                \
 838 /* End of DECL_PRINTNUM definition. */
 839
 840 DECL_PRINTNUM(short);
 841 DECL_PRINTNUM(int);
 842 DECL_PRINTNUM(int64);
 843 #undef DECL_PRINTNUM
 844
 845 #define DECL_PRINTNUM_ADDR(name)                                        \
 846 extern bool                                                             \
 847 printnum_addr_ ## name(struct tcb *, kernel_ulong_t addr)               \
 848 /* End of DECL_PRINTNUM_ADDR definition. */
 849
 850 DECL_PRINTNUM_ADDR(int);
 851 DECL_PRINTNUM_ADDR(int64);
 852 #undef DECL_PRINTNUM_ADDR
 853
 854 #ifndef current_wordsize
 855 extern bool
 856 printnum_long_int(struct tcb *, kernel_ulong_t addr,
 857                   const char *fmt_long, const char *fmt_int)
 858         ATTRIBUTE_FORMAT((printf, 3, 0))
 859         ATTRIBUTE_FORMAT((printf, 4, 0));
 860 extern bool printnum_addr_long_int(struct tcb *, kernel_ulong_t addr);
 861 # define printnum_slong(tcp, addr) \
 862         printnum_long_int((tcp), (addr), "%" PRId64, "%d")
 863 # define printnum_ulong(tcp, addr) \
 864         printnum_long_int((tcp), (addr), "%" PRIu64, "%u")
 865 # define printnum_ptr(tcp, addr) \
 866         printnum_addr_long_int((tcp), (addr))
 867 #elif current_wordsize > 4
 868 # define printnum_slong(tcp, addr) \
 869         printnum_int64((tcp), (addr), "%" PRId64)
 870 # define printnum_ulong(tcp, addr) \
 871         printnum_int64((tcp), (addr), "%" PRIu64)
 872 # define printnum_ptr(tcp, addr) \
 873         printnum_addr_int64((tcp), (addr))
 874 #else /* current_wordsize == 4 */
 875 # define printnum_slong(tcp, addr) \
 876         printnum_int((tcp), (addr), "%d")
 877 # define printnum_ulong(tcp, addr) \
 878         printnum_int((tcp), (addr), "%u")
 879 # define printnum_ptr(tcp, addr) \
 880         printnum_addr_int((tcp), (addr))
 881 #endif
 882
 883 #ifndef current_klongsize
 884 extern bool printnum_addr_klong_int(struct tcb *, kernel_ulong_t addr);
 885 # define printnum_kptr(tcp, addr) \
 886         printnum_addr_klong_int((tcp), (addr))
 887 #elif current_klongsize > 4
 888 # define printnum_kptr(tcp, addr) \
 889         printnum_addr_int64((tcp), (addr))
 890 #else /* current_klongsize == 4 */
 891 # define printnum_kptr(tcp, addr) \
 892         printnum_addr_int((tcp), (addr))
 893 #endif
 894
 895 #define DECL_PRINTPAIR(name)                                            \
 896 extern bool                                                             \
 897 printpair_ ## name(struct tcb *, kernel_ulong_t addr, const char *fmt)  \
 898         ATTRIBUTE_FORMAT((printf, 3, 0))                                \
 899 /* End of DECL_PRINTPAIR definition. */
 900
 901 DECL_PRINTPAIR(int);
 902 DECL_PRINTPAIR(int64);
 903 #undef DECL_PRINTPAIR
 904
 905 static inline kernel_long_t
 906 truncate_klong_to_current_wordsize(const kernel_long_t v)
 907 {
 908 #if ANY_WORDSIZE_LESS_THAN_KERNEL_LONG
 909         if (current_wordsize < sizeof(v)) {
 910                 return (int) v;
 911         } else
 912 #endif
 913         {
 914                 return v;
 915         }
 916 }
 917
 918 static inline kernel_ulong_t
 919 truncate_kulong_to_current_wordsize(const kernel_ulong_t v)
 920 {
 921 #if ANY_WORDSIZE_LESS_THAN_KERNEL_LONG
 922         if (current_wordsize < sizeof(v)) {
 923                 return (unsigned int) v;
 924         } else
 925 #endif
 926         {
 927                 return v;
 928         }
 929 }
 930
 931 /*
 932  * Cast a pointer or a pointer-sized integer to kernel_ulong_t.
 933  */
 934 #define ptr_to_kulong(v) ((kernel_ulong_t) (unsigned long) (v))
 935
 936 /*
 937  * Zero-extend a signed integer type to unsigned long long.
 938  */
 939 #define zero_extend_signed_to_ull(v) \
 940         (sizeof(v) == sizeof(char) ? (unsigned long long) (unsigned char) (v) : \
 941          sizeof(v) == sizeof(short) ? (unsigned long long) (unsigned short) (v) : \
 942          sizeof(v) == sizeof(int) ? (unsigned long long) (unsigned int) (v) : \
 943          sizeof(v) == sizeof(long) ? (unsigned long long) (unsigned long) (v) : \
 944          (unsigned long long) (v))
 945
 946 /*
 947  * Sign-extend an unsigned integer type to long long.
 948  */
 949 #define sign_extend_unsigned_to_ll(v) \
 950         (sizeof(v) == sizeof(char) ? (long long) (char) (v) : \
 951          sizeof(v) == sizeof(short) ? (long long) (short) (v) : \
 952          sizeof(v) == sizeof(int) ? (long long) (int) (v) : \
 953          sizeof(v) == sizeof(long) ? (long long) (long) (v) : \
 954          (long long) (v))
 955
 956 extern const struct_sysent sysent0[];
 957 extern const char *const errnoent0[];
 958 extern const char *const signalent0[];
 959 extern const struct_ioctlent ioctlent0[];
 960
 961 #if SUPPORTED_PERSONALITIES > 1
 962 extern const struct_sysent *sysent;
 963 extern const char *const *errnoent;
 964 extern const char *const *signalent;
 965 extern const struct_ioctlent *ioctlent;
 966 #else
 967 # define sysent     sysent0
 968 # define errnoent   errnoent0
 969 # define signalent  signalent0
 970 # define ioctlent   ioctlent0
 971 #endif
 972
 973 extern unsigned nsyscalls;
 974 extern unsigned nerrnos;
 975 extern unsigned nsignals;
 976 extern unsigned nioctlents;
 977
 978 extern const unsigned int nsyscall_vec[SUPPORTED_PERSONALITIES];
 979 extern const struct_sysent *const sysent_vec[SUPPORTED_PERSONALITIES];
 980 extern struct inject_opts *inject_vec[SUPPORTED_PERSONALITIES];
 981
 982 #ifdef IN_MPERS_BOOTSTRAP
 983 /* Transform multi-line MPERS_PRINTER_DECL statements to one-liners.  */
 984 # define MPERS_PRINTER_DECL(type, name, ...) MPERS_PRINTER_DECL(type, name, __VA_ARGS__)
 985 #else /* !IN_MPERS_BOOTSTRAP */
 986 # if SUPPORTED_PERSONALITIES > 1
 987 #  include "printers.h"
 988 # else
 989 #  include "native_printer_decls.h"
 990 # endif
 991 # define MPERS_PRINTER_DECL(type, name, ...) type MPERS_FUNC_NAME(name)(__VA_ARGS__)
 992 #endif /* !IN_MPERS_BOOTSTRAP */
 993
 994 /* Checks that sysent[scno] is not out of range. */
 995 static inline bool
 996 scno_in_range(kernel_ulong_t scno)
 997 {
 998         return scno < nsyscalls;
 999 }
1000
1001 /*
1002  * Checks whether scno is not out of range,
1003  * its corresponding sysent[scno].sys_func is non-NULL,
1004  * and its sysent[scno].sys_flags has no TRACE_INDIRECT_SUBCALL flag set.
1005  */
1006 static inline bool
1007 scno_is_valid(kernel_ulong_t scno)
1008 {
1009         return scno_in_range(scno)
1010                && sysent[scno].sys_func
1011                && !(sysent[scno].sys_flags & TRACE_INDIRECT_SUBCALL);
1012 }
1013
1014 #define MPERS_FUNC_NAME__(prefix, name) prefix ## name
1015 #define MPERS_FUNC_NAME_(prefix, name) MPERS_FUNC_NAME__(prefix, name)
1016 #define MPERS_FUNC_NAME(name) MPERS_FUNC_NAME_(MPERS_PREFIX, name)
1017
1018 #define SYS_FUNC_NAME(syscall_name) MPERS_FUNC_NAME(syscall_name)
1019
1020 #define SYS_FUNC(syscall_name) int SYS_FUNC_NAME(sys_ ## syscall_name)(struct tcb *tcp)
1021
1022 #endif /* !STRACE_DEFS_H */