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