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