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