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