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  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. The name of the author may not be used to endorse or promote products
  16  *    derived from this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  19  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  20  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  21  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  23  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30 #ifndef STRACE_DEFS_H
  31 #define STRACE_DEFS_H
  32
  33 #ifdef HAVE_CONFIG_H
  34 # include "config.h"
  35 #endif
  36
  37 #include <features.h>
  38 #include <stdbool.h>
  39 #include <stdint.h>
  40 #include <inttypes.h>
  41 #include <sys/types.h>
  42 #include <stddef.h>
  43 #include <unistd.h>
  44 #include <stdlib.h>
  45 #include <stdio.h>
  46 /* Open-coding isprint(ch) et al proved more efficient than calling
  47  * generalized libc interface. We don't *want* to do non-ASCII anyway.
  48  */
  49 /* #include <ctype.h> */
  50 #include <string.h>
  51 #include <errno.h>
  52 #include <time.h>
  53 #include <sys/time.h>
  54
  55 #include "kernel_types.h"
  56 #include "mpers_type.h"
  57 #include "gcc_compat.h"
  58 #include "sysent.h"
  59
  60 #ifndef HAVE_STRERROR
  61 const char *strerror(int);
  62 #endif
  63 #ifndef HAVE_STPCPY
  64 /* Some libc have stpcpy, some don't. Sigh...
  65  * Roll our private implementation...
  66  */
  67 #undef stpcpy
  68 #define stpcpy strace_stpcpy
  69 extern char *stpcpy(char *dst, const char *src);
  70 #endif
  71
  72 #ifndef offsetofend
  73 # define offsetofend(type, member) \
  74         (offsetof(type, member) + sizeof(((type *)NULL)->member))
  75 #endif
  76
  77 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]) + MUST_BE_ARRAY(a))
  78
  79 /* macros */
  80 #ifndef MAX
  81 # define MAX(a, b)              (((a) > (b)) ? (a) : (b))
  82 #endif
  83 #ifndef MIN
  84 # define MIN(a, b)              (((a) < (b)) ? (a) : (b))
  85 #endif
  86 #define CLAMP(val, min, max) MIN(MAX(min, val), max)
  87
  88 /* Glibc has an efficient macro for sigemptyset
  89  * (it just does one or two assignments of 0 to internal vector of longs).
  90  */
  91 #if defined(__GLIBC__) && defined(__sigemptyset) && !defined(sigemptyset)
  92 # define sigemptyset __sigemptyset
  93 #endif
  94
  95 /* Configuration section */
  96 #ifndef DEFAULT_STRLEN
  97 /* default maximum # of bytes printed in `printstr', change with -s switch */
  98 # define DEFAULT_STRLEN 32
  99 #endif
 100 #ifndef DEFAULT_ACOLUMN
 101 # define DEFAULT_ACOLUMN        40      /* default alignment column for results */
 102 #endif
 103 /*
 104  * Maximum number of args to a syscall.
 105  *
 106  * Make sure that all entries in all syscallent.h files have nargs <= MAX_ARGS!
 107  * linux/<ARCH>/syscallent*.h:
 108  *      all have nargs <= 6 except mips o32 which has nargs <= 7.
 109  */
 110 #ifndef MAX_ARGS
 111 # ifdef LINUX_MIPSO32
 112 #  define MAX_ARGS      7
 113 # else
 114 #  define MAX_ARGS      6
 115 # endif
 116 #endif
 117 /* default sorting method for call profiling */
 118 #ifndef DEFAULT_SORTBY
 119 # define DEFAULT_SORTBY "time"
 120 #endif
 121 /*
 122  * Experimental code using PTRACE_SEIZE can be enabled here.
 123  * This needs Linux kernel 3.4.x or later to work.
 124  */
 125 #define USE_SEIZE 1
 126 /* To force NOMMU build, set to 1 */
 127 #define NOMMU_SYSTEM 0
 128
 129 #ifndef ERESTARTSYS
 130 # define ERESTARTSYS    512
 131 #endif
 132 #ifndef ERESTARTNOINTR
 133 # define ERESTARTNOINTR 513
 134 #endif
 135 #ifndef ERESTARTNOHAND
 136 # define ERESTARTNOHAND 514
 137 #endif
 138 #ifndef ERESTART_RESTARTBLOCK
 139 # define ERESTART_RESTARTBLOCK 516
 140 #endif
 141
 142 #if defined X86_64
 143 # define SUPPORTED_PERSONALITIES 3
 144 # define PERSONALITY2_WORDSIZE  4
 145 # define PERSONALITY2_KLONGSIZE PERSONALITY0_KLONGSIZE
 146 #elif defined AARCH64 \
 147    || defined POWERPC64 \
 148    || defined RISCV \
 149    || defined SPARC64 \
 150    || defined TILE \
 151    || defined X32
 152 # define SUPPORTED_PERSONALITIES 2
 153 #else
 154 # define SUPPORTED_PERSONALITIES 1
 155 #endif
 156
 157 #if defined TILE && defined __tilepro__
 158 # define DEFAULT_PERSONALITY 1
 159 #else
 160 # define DEFAULT_PERSONALITY 0
 161 #endif
 162
 163 #define PERSONALITY0_WORDSIZE  SIZEOF_LONG
 164 #define PERSONALITY0_KLONGSIZE SIZEOF_KERNEL_LONG_T
 165 #define PERSONALITY0_INCLUDE_PRINTERS_DECLS "native_printer_decls.h"
 166 #define PERSONALITY0_INCLUDE_PRINTERS_DEFS "native_printer_defs.h"
 167
 168 #if SUPPORTED_PERSONALITIES > 1
 169 # define PERSONALITY1_WORDSIZE  4
 170 # define PERSONALITY1_KLONGSIZE PERSONALITY1_WORDSIZE
 171 #endif
 172
 173 #if SUPPORTED_PERSONALITIES > 1 && defined HAVE_M32_MPERS
 174 # define PERSONALITY1_INCLUDE_PRINTERS_DECLS "m32_printer_decls.h"
 175 # define PERSONALITY1_INCLUDE_PRINTERS_DEFS "m32_printer_defs.h"
 176 # define PERSONALITY1_INCLUDE_FUNCS "m32_funcs.h"
 177 # define MPERS_m32_IOCTL_MACROS "ioctl_redefs1.h"
 178 #else
 179 # define PERSONALITY1_INCLUDE_PRINTERS_DECLS "native_printer_decls.h"
 180 # define PERSONALITY1_INCLUDE_PRINTERS_DEFS "native_printer_defs.h"
 181 # define PERSONALITY1_INCLUDE_FUNCS "empty.h"
 182 #endif
 183
 184 #if SUPPORTED_PERSONALITIES > 2 && defined HAVE_MX32_MPERS
 185 # define PERSONALITY2_INCLUDE_FUNCS "mx32_funcs.h"
 186 # define PERSONALITY2_INCLUDE_PRINTERS_DECLS "mx32_printer_decls.h"
 187 # define PERSONALITY2_INCLUDE_PRINTERS_DEFS "mx32_printer_defs.h"
 188 # define MPERS_mx32_IOCTL_MACROS "ioctl_redefs2.h"
 189 #else
 190 # define PERSONALITY2_INCLUDE_PRINTERS_DECLS "native_printer_decls.h"
 191 # define PERSONALITY2_INCLUDE_PRINTERS_DEFS "native_printer_defs.h"
 192 # define PERSONALITY2_INCLUDE_FUNCS "empty.h"
 193 #endif
 194
 195 typedef struct ioctlent {
 196         const char *symbol;
 197         unsigned int code;
 198 } struct_ioctlent;
 199
 200 struct fault_opts {
 201         uint16_t first;
 202         uint16_t step;
 203         int16_t err;
 204         uint16_t signo;
 205 };
 206
 207 /* Trace Control Block */
 208 struct tcb {
 209         int flags;              /* See below for TCB_ values */
 210         int pid;                /* If 0, this tcb is free */
 211         int qual_flg;           /* qual_flags[scno] or DEFAULT_QUAL_FLAGS + RAW */
 212         unsigned long u_error;  /* Error code */
 213         kernel_ulong_t scno;    /* System call number */
 214         kernel_ulong_t u_arg[MAX_ARGS]; /* System call arguments */
 215         kernel_long_t u_rval;   /* Return value */
 216 #if SUPPORTED_PERSONALITIES > 1
 217         unsigned int currpers;  /* Personality at the time of scno update */
 218 #endif
 219         int sys_func_rval;      /* Syscall entry parser's return value */
 220         int curcol;             /* Output column for this process */
 221         FILE *outf;             /* Output file for this process */
 222         const char *auxstr;     /* Auxiliary info from syscall (see RVAL_STR) */
 223         void *_priv_data;       /* Private data for syscall decoding functions */
 224         void (*_free_priv_data)(void *); /* Callback for freeing priv_data */
 225         const struct_sysent *s_ent; /* sysent[scno] or dummy struct for bad scno */
 226         const struct_sysent *s_prev_ent; /* for "resuming interrupted SYSCALL" msg */
 227         struct fault_opts *fault_vec[SUPPORTED_PERSONALITIES];
 228         struct timeval stime;   /* System time usage as of last process wait */
 229         struct timeval dtime;   /* Delta for system time usage */
 230         struct timeval etime;   /* Syscall entry time */
 231
 232 #ifdef USE_LIBUNWIND
 233         struct UPT_info* libunwind_ui;
 234         struct mmap_cache_t* mmap_cache;
 235         unsigned int mmap_cache_size;
 236         unsigned int mmap_cache_generation;
 237         struct queue_t* queue;
 238 #endif
 239 };
 240
 241 /* TCB flags */
 242 /* We have attached to this process, but did not see it stopping yet */
 243 #define TCB_STARTUP             0x01
 244 #define TCB_IGNORE_ONE_SIGSTOP  0x02    /* Next SIGSTOP is to be ignored */
 245 /*
 246  * Are we in system call entry or in syscall exit?
 247  *
 248  * This bit is set after all syscall entry processing is done.
 249  * Therefore, this bit will be set when next ptrace stop occurs,
 250  * which should be syscall exit stop. Other stops which are possible
 251  * directly after syscall entry (death, ptrace event stop)
 252  * are simpler and handled without calling trace_syscall(), therefore
 253  * the places where TCB_INSYSCALL can be set but we aren't in syscall stop
 254  * are limited to trace(), this condition is never observed in trace_syscall()
 255  * and below.
 256  * The bit is cleared after all syscall exit processing is done.
 257  *
 258  * Use entering(tcp) / exiting(tcp) to check this bit to make code more 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_FAULT_INJ   0x40    /* A syscall fault has been injected */
 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_FAULT      0x010   /* fail 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 dirent_types[];
 293 extern const struct xlat evdev_abs[];
 294 extern const struct xlat msg_flags[];
 295 extern const struct xlat open_access_modes[];
 296 extern const struct xlat open_mode_flags[];
 297 extern const struct xlat resource_flags[];
 298 extern const struct xlat socketlayers[];
 299 extern const struct xlat whence_codes[];
 300
 301 /* Format of syscall return values */
 302 #define RVAL_DECIMAL    000     /* decimal format */
 303 #define RVAL_HEX        001     /* hex format */
 304 #define RVAL_OCTAL      002     /* octal format */
 305 #define RVAL_UDECIMAL   003     /* unsigned decimal format */
 306 #define RVAL_FD         010     /* file descriptor */
 307 #define RVAL_MASK       013     /* mask for these values */
 308
 309 #define RVAL_STR        020     /* Print `auxstr' field after return val */
 310 #define RVAL_NONE       040     /* Print nothing */
 311
 312 #define RVAL_DECODED    0100    /* syscall decoding finished */
 313
 314 #define IOCTL_NUMBER_UNKNOWN 0
 315 #define IOCTL_NUMBER_HANDLED 1
 316 #define IOCTL_NUMBER_STOP_LOOKUP 010
 317
 318 #define indirect_ipccall(tcp) (tcp->s_ent->sys_flags & TRACE_INDIRECT_SUBCALL)
 319
 320 #if defined(ARM) || defined(AARCH64) \
 321  || defined(I386) || defined(X32) || defined(X86_64) \
 322  || defined(IA64) \
 323  || defined(BFIN) \
 324  || defined(M68K) \
 325  || defined(MICROBLAZE) \
 326  || defined(RISCV) \
 327  || defined(S390) \
 328  || defined(SH) || defined(SH64) \
 329  || defined(SPARC) || defined(SPARC64) \
 330  /**/
 331 # define NEED_UID16_PARSERS 1
 332 #else
 333 # define NEED_UID16_PARSERS 0
 334 #endif
 335
 336 enum sock_proto {
 337         SOCK_PROTO_UNKNOWN,
 338         SOCK_PROTO_UNIX,
 339         SOCK_PROTO_TCP,
 340         SOCK_PROTO_UDP,
 341         SOCK_PROTO_TCPv6,
 342         SOCK_PROTO_UDPv6,
 343         SOCK_PROTO_NETLINK
 344 };
 345 extern enum sock_proto get_proto_by_name(const char *);
 346
 347 enum iov_decode {
 348         IOV_DECODE_ADDR,
 349         IOV_DECODE_STR,
 350         IOV_DECODE_NETLINK
 351 };
 352
 353 typedef enum {
 354         CFLAG_NONE = 0,
 355         CFLAG_ONLY_STATS,
 356         CFLAG_BOTH
 357 } cflag_t;
 358 extern cflag_t cflag;
 359 extern bool debug_flag;
 360 extern bool Tflag;
 361 extern bool iflag;
 362 extern bool count_wallclock;
 363 extern unsigned int qflag;
 364 extern bool not_failing_only;
 365 extern unsigned int show_fd_path;
 366 /* are we filtering traces based on paths? */
 367 extern const char **paths_selected;
 368 #define tracing_paths (paths_selected != NULL)
 369 extern unsigned xflag;
 370 extern unsigned followfork;
 371 #ifdef USE_LIBUNWIND
 372 /* if this is true do the stack trace for every system call */
 373 extern bool stack_trace_enabled;
 374 #endif
 375 extern unsigned ptrace_setoptions;
 376 extern unsigned max_strlen;
 377 extern unsigned os_release;
 378 #undef KERNEL_VERSION
 379 #define KERNEL_VERSION(a,b,c) (((a) << 16) + ((b) << 8) + (c))
 380
 381 void error_msg(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2));
 382 void perror_msg(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2));
 383 void error_msg_and_die(const char *fmt, ...)
 384         ATTRIBUTE_FORMAT((printf, 1, 2)) ATTRIBUTE_NORETURN;
 385 void error_msg_and_help(const char *fmt, ...)
 386         ATTRIBUTE_FORMAT((printf, 1, 2)) ATTRIBUTE_NORETURN;
 387 void perror_msg_and_die(const char *fmt, ...)
 388         ATTRIBUTE_FORMAT((printf, 1, 2)) ATTRIBUTE_NORETURN;
 389 void die_out_of_memory(void) ATTRIBUTE_NORETURN;
 390
 391 void *xmalloc(size_t size) ATTRIBUTE_MALLOC ATTRIBUTE_ALLOC_SIZE((1));
 392 void *xcalloc(size_t nmemb, size_t size)
 393         ATTRIBUTE_MALLOC ATTRIBUTE_ALLOC_SIZE((1, 2));
 394 void *xreallocarray(void *ptr, size_t nmemb, size_t size)
 395         ATTRIBUTE_ALLOC_SIZE((2, 3));
 396 char *xstrdup(const char *str) ATTRIBUTE_MALLOC;
 397
 398 extern int read_int_from_file(const char *, int *);
 399
 400 extern void set_sortby(const char *);
 401 extern void set_overhead(int);
 402 extern void print_pc(struct tcb *);
 403 extern int trace_syscall(struct tcb *, unsigned int *);
 404 extern void count_syscall(struct tcb *, const struct timeval *);
 405 extern void call_summary(FILE *);
 406
 407 extern void clear_regs(void);
 408 extern void get_regs(pid_t pid);
 409 extern int get_scno(struct tcb *tcp);
 410 /**
 411  * Convert syscall number to syscall name.
 412  *
 413  * @param scno Syscall number.
 414  * @return     String literal corresponding to the syscall number in case latter
 415  *             is valid; NULL otherwise.
 416  */
 417 extern const char *syscall_name(kernel_ulong_t scno);
 418 extern const char *err_name(unsigned long err);
 419
 420 extern bool is_erestart(struct tcb *);
 421 extern void temporarily_clear_syserror(struct tcb *);
 422 extern void restore_cleared_syserror(struct tcb *);
 423
 424 extern void *get_tcb_priv_data(const struct tcb *);
 425 extern int set_tcb_priv_data(struct tcb *, void *priv_data,
 426                              void (*free_priv_data)(void *));
 427 extern void free_tcb_priv_data(struct tcb *);
 428
 429 static inline unsigned long get_tcb_priv_ulong(const struct tcb *tcp)
 430 {
 431         return (unsigned long) get_tcb_priv_data(tcp);
 432 }
 433
 434 static inline int set_tcb_priv_ulong(struct tcb *tcp, unsigned long val)
 435 {
 436         return set_tcb_priv_data(tcp, (void *) val, 0);
 437 }
 438
 439 extern int
 440 umoven(struct tcb *tcp, kernel_ulong_t addr, unsigned int len, void *laddr);
 441 #define umove(pid, addr, objp)  \
 442         umoven((pid), (addr), sizeof(*(objp)), (void *) (objp))
 443
 444 extern int
 445 umoven_or_printaddr(struct tcb *tcp, kernel_ulong_t addr,
 446                     unsigned int len, void *laddr);
 447 #define umove_or_printaddr(pid, addr, objp)     \
 448         umoven_or_printaddr((pid), (addr), sizeof(*(objp)), (void *) (objp))
 449
 450 extern int
 451 umoven_or_printaddr_ignore_syserror(struct tcb *tcp, kernel_ulong_t addr,
 452                                     unsigned int len, void *laddr);
 453
 454 extern int
 455 umovestr(struct tcb *tcp, kernel_ulong_t addr, unsigned int len, char *laddr);
 456
 457 extern int upeek(int pid, unsigned long, kernel_ulong_t *);
 458 extern int upoke(int pid, unsigned long, kernel_ulong_t);
 459
 460 extern bool
 461 print_array(struct tcb *tcp,
 462             kernel_ulong_t start_addr,
 463             size_t nmemb,
 464             void *elem_buf,
 465             size_t elem_size,
 466             int (*umoven_func)(struct tcb *,
 467                                      kernel_ulong_t,
 468                                      unsigned int,
 469                                      void *),
 470             bool (*print_func)(struct tcb *,
 471                                      void *elem_buf,
 472                                      size_t elem_size,
 473                                      void *opaque_data),
 474             void *opaque_data);
 475
 476 #if defined ALPHA || defined IA64 || defined MIPS \
 477  || defined SH || defined SPARC || defined SPARC64
 478 # define HAVE_GETRVAL2
 479 extern long getrval2(struct tcb *);
 480 #else
 481 # undef HAVE_GETRVAL2
 482 #endif
 483
 484 extern const char *signame(const int);
 485 extern void pathtrace_select(const char *);
 486 extern int pathtrace_match(struct tcb *);
 487 extern int getfdpath(struct tcb *, int, char *, unsigned);
 488 extern enum sock_proto getfdproto(struct tcb *, int);
 489
 490 extern const char *xlookup(const struct xlat *, const uint64_t);
 491 extern const char *xlat_search(const struct xlat *, const size_t, const uint64_t);
 492
 493 extern unsigned long get_pagesize(void);
 494 extern int
 495 string_to_uint_ex(const char *str, char **endptr,
 496                   unsigned int max_val, const char *accepted_ending);
 497 extern int string_to_uint(const char *str);
 498 static inline int
 499 string_to_uint_upto(const char *const str, unsigned int max_val)
 500 {
 501         return string_to_uint_ex(str, NULL, max_val, NULL);
 502 }
 503 extern int next_set_bit(const void *bit_array, unsigned cur_bit, unsigned size_bits);
 504
 505 #define QUOTE_0_TERMINATED                      0x01
 506 #define QUOTE_OMIT_LEADING_TRAILING_QUOTES      0x02
 507 #define QUOTE_OMIT_TRAILING_0                   0x08
 508 #define QUOTE_FORCE_HEX                         0x10
 509
 510 extern int string_quote(const char *, char *, unsigned int, unsigned int);
 511 extern int print_quoted_string(const char *, unsigned int, unsigned int);
 512
 513 /* a refers to the lower numbered u_arg,
 514  * b refers to the higher numbered u_arg
 515  */
 516 #ifdef WORDS_BIGENDIAN
 517 # define ULONG_LONG(a,b) \
 518         ((unsigned long long)(unsigned)(b) | ((unsigned long long)(a)<<32))
 519 #else
 520 # define ULONG_LONG(a,b) \
 521         ((unsigned long long)(unsigned)(a) | ((unsigned long long)(b)<<32))
 522 #endif
 523 extern int getllval(struct tcb *, unsigned long long *, int);
 524 extern int printllval(struct tcb *, const char *, int)
 525         ATTRIBUTE_FORMAT((printf, 2, 0));
 526
 527 extern void printaddr(kernel_ulong_t addr);
 528 extern int printxvals(const uint64_t, const char *, const struct xlat *, ...)
 529         ATTRIBUTE_SENTINEL;
 530 extern int printxval_searchn(const struct xlat *xlat, size_t xlat_size,
 531         uint64_t val, const char *dflt);
 532 #define printxval_search(xlat__, val__, dflt__) \
 533         printxval_searchn(xlat__, ARRAY_SIZE(xlat__), val__, dflt__)
 534 extern int printargs(struct tcb *);
 535 extern int printargs_u(struct tcb *);
 536 extern int printargs_d(struct tcb *);
 537
 538 extern void addflags(const struct xlat *, uint64_t);
 539 extern int printflags64(const struct xlat *, uint64_t, const char *);
 540 extern const char *sprintflags(const char *, const struct xlat *, uint64_t);
 541 extern const char *sprinttime(time_t);
 542 extern void print_symbolic_mode_t(unsigned int);
 543 extern void print_numeric_umode_t(unsigned short);
 544 extern void print_numeric_long_umask(unsigned long);
 545 extern void print_dev_t(unsigned long long dev);
 546
 547 extern void
 548 dumpiov_in_msghdr(struct tcb *, kernel_ulong_t addr, kernel_ulong_t data_size);
 549
 550 extern void
 551 dumpiov_in_mmsghdr(struct tcb *, kernel_ulong_t addr);
 552
 553 extern void
 554 dumpiov_upto(struct tcb *, int len, kernel_ulong_t addr, kernel_ulong_t data_size);
 555
 556 extern void
 557 dumpstr(struct tcb *, kernel_ulong_t addr, int len);
 558
 559 extern void
 560 printstr_ex(struct tcb *, kernel_ulong_t addr, kernel_ulong_t len,
 561             unsigned int user_style);
 562
 563 extern void
 564 printpathn(struct tcb *, kernel_ulong_t addr, unsigned int n);
 565
 566 extern void
 567 printpath(struct tcb *, kernel_ulong_t addr);
 568
 569 #define TIMESPEC_TEXT_BUFSIZE \
 570                 (sizeof(intmax_t)*3 * 2 + sizeof("{tv_sec=%jd, tv_nsec=%jd}"))
 571 extern void printfd(struct tcb *, int);
 572 extern void print_sockaddr(struct tcb *tcp, const void *, int);
 573 extern bool print_sockaddr_by_inode(const unsigned long, const enum sock_proto);
 574 extern bool print_sockaddr_by_inode_cached(const unsigned long);
 575 extern void print_dirfd(struct tcb *, int);
 576
 577 extern int
 578 decode_sockaddr(struct tcb *, kernel_ulong_t addr, int addrlen);
 579
 580 extern void printuid(const char *, const unsigned int);
 581
 582 extern void
 583 print_sigset_addr_len(struct tcb *, kernel_ulong_t addr, kernel_ulong_t len);
 584
 585 extern const char *sprintsigmask_n(const char *, const void *, unsigned int);
 586 #define tprintsigmask_addr(prefix, mask) \
 587         tprints(sprintsigmask_n((prefix), (mask), sizeof(mask)))
 588 extern void printsignal(int);
 589
 590 extern void
 591 tprint_iov_upto(struct tcb *, kernel_ulong_t len, kernel_ulong_t addr,
 592                 enum iov_decode, kernel_ulong_t data_size);
 593
 594 extern void
 595 decode_netlink(struct tcb *, kernel_ulong_t addr, kernel_ulong_t len);
 596
 597 extern void tprint_open_modes(unsigned int);
 598 extern const char *sprint_open_modes(unsigned int);
 599
 600 extern void
 601 print_seccomp_filter(struct tcb *, kernel_ulong_t addr);
 602
 603 extern void
 604 print_seccomp_fprog(struct tcb *, kernel_ulong_t addr, unsigned short len);
 605
 606 struct strace_stat;
 607 extern void print_struct_stat(struct tcb *tcp, const struct strace_stat *const st);
 608
 609 struct strace_statfs;
 610
 611 extern void
 612 print_struct_statfs(struct tcb *, kernel_ulong_t addr);
 613
 614 extern void
 615 print_struct_statfs64(struct tcb *, kernel_ulong_t addr, kernel_ulong_t size);
 616
 617 extern void print_ifindex(unsigned int);
 618
 619 struct number_set;
 620 extern struct number_set read_set;
 621 extern struct number_set write_set;
 622 extern struct number_set signal_set;
 623
 624 extern bool is_number_in_set(unsigned int number, const struct number_set *);
 625 extern void qualify(const char *);
 626 extern unsigned int qual_flags(const unsigned int);
 627
 628 #define DECL_IOCTL(name)                                                \
 629 extern int                                                              \
 630 name ## _ioctl(struct tcb *, unsigned int request, kernel_ulong_t arg)
 631 DECL_IOCTL(dm);
 632 DECL_IOCTL(file);
 633 DECL_IOCTL(fs_x);
 634 DECL_IOCTL(ptp);
 635 DECL_IOCTL(scsi);
 636 DECL_IOCTL(term);
 637 DECL_IOCTL(ubi);
 638 DECL_IOCTL(uffdio);
 639 #undef DECL_IOCTL
 640
 641 extern int decode_sg_io_v3(struct tcb *, const kernel_ulong_t arg);
 642 extern int decode_sg_io_v4(struct tcb *, const kernel_ulong_t arg);
 643
 644 extern int tv_nz(const struct timeval *);
 645 extern int tv_cmp(const struct timeval *, const struct timeval *);
 646 extern double tv_float(const struct timeval *);
 647 extern void tv_add(struct timeval *, const struct timeval *, const struct timeval *);
 648 extern void tv_sub(struct timeval *, const struct timeval *, const struct timeval *);
 649 extern void tv_mul(struct timeval *, const struct timeval *, int);
 650 extern void tv_div(struct timeval *, const struct timeval *, int);
 651
 652 #ifdef USE_LIBUNWIND
 653 extern void unwind_init(void);
 654 extern void unwind_tcb_init(struct tcb *tcp);
 655 extern void unwind_tcb_fin(struct tcb *tcp);
 656 extern void unwind_cache_invalidate(struct tcb* tcp);
 657 extern void unwind_print_stacktrace(struct tcb* tcp);
 658 extern void unwind_capture_stacktrace(struct tcb* tcp);
 659 #endif
 660
 661 static inline void
 662 printstrn(struct tcb *tcp, kernel_ulong_t addr, kernel_ulong_t len)
 663 {
 664         printstr_ex(tcp, addr, len, 0);
 665 }
 666
 667 static inline void
 668 printstr(struct tcb *tcp, kernel_ulong_t addr)
 669 {
 670         printstr_ex(tcp, addr, -1, QUOTE_0_TERMINATED);
 671 }
 672
 673 static inline int
 674 printflags(const struct xlat *x, unsigned int flags, const char *dflt)
 675 {
 676         return printflags64(x, flags, dflt);
 677 }
 678
 679 static inline int
 680 printxval64(const struct xlat *x, const uint64_t val, const char *dflt)
 681 {
 682         return printxvals(val, dflt, x, NULL);
 683 }
 684
 685 static inline int
 686 printxval(const struct xlat *x, const unsigned int val, const char *dflt)
 687 {
 688         return printxvals(val, dflt, x, NULL);
 689 }
 690
 691 static inline void
 692 tprint_iov(struct tcb *tcp, kernel_ulong_t len, kernel_ulong_t addr,
 693            enum iov_decode decode_iov)
 694 {
 695         tprint_iov_upto(tcp, len, addr, decode_iov, -1);
 696 }
 697
 698 #ifdef ALPHA
 699 typedef struct {
 700         int tv_sec, tv_usec;
 701 } timeval32_t;
 702
 703 extern void print_timeval32_t(const timeval32_t *);
 704 extern void printrusage32(struct tcb *, kernel_ulong_t);
 705 extern const char *sprint_timeval32(struct tcb *tcp, kernel_ulong_t);
 706 extern void print_timeval32(struct tcb *tcp, kernel_ulong_t);
 707 extern void print_timeval32_pair(struct tcb *tcp, kernel_ulong_t);
 708 extern void print_itimerval32(struct tcb *tcp, kernel_ulong_t);
 709 #endif
 710
 711 #ifdef HAVE_STRUCT_USER_DESC
 712 extern void print_user_desc(struct tcb *, kernel_ulong_t addr);
 713 #endif
 714
 715 /* Strace log generation machinery.
 716  *
 717  * printing_tcp: tcb which has incomplete line being printed right now.
 718  * NULL if last line has been completed ('\n'-terminated).
 719  * printleader(tcp) examines it, finishes incomplete line if needed,
 720  * the sets it to tcp.
 721  * line_ended() clears printing_tcp and resets ->curcol = 0.
 722  * tcp->curcol == 0 check is also used to detect completeness
 723  * of last line, since in -ff mode just checking printing_tcp for NULL
 724  * is not enough.
 725  *
 726  * If you change this code, test log generation in both -f and -ff modes
 727  * using:
 728  * strace -oLOG -f[f] test/threaded_execve
 729  * strace -oLOG -f[f] test/sigkill_rain
 730  * strace -oLOG -f[f] -p "`pidof web_browser`"
 731  */
 732 extern struct tcb *printing_tcp;
 733 extern void printleader(struct tcb *);
 734 extern void line_ended(void);
 735 extern void tabto(void);
 736 extern void tprintf(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2));
 737 extern void tprints(const char *str);
 738
 739 #if SUPPORTED_PERSONALITIES > 1
 740 extern void set_personality(int personality);
 741 extern unsigned current_personality;
 742 #else
 743 # define set_personality(personality) ((void)0)
 744 # define current_personality 0
 745 #endif
 746
 747 #if SUPPORTED_PERSONALITIES == 1
 748 # define current_wordsize PERSONALITY0_WORDSIZE
 749 # define current_klongsize PERSONALITY0_KLONGSIZE
 750 #else
 751 # if SUPPORTED_PERSONALITIES == 2 && PERSONALITY0_WORDSIZE == PERSONALITY1_WORDSIZE
 752 #  define current_wordsize PERSONALITY0_WORDSIZE
 753 # else
 754 extern unsigned current_wordsize;
 755 # endif
 756 # if SUPPORTED_PERSONALITIES == 2 && PERSONALITY0_KLONGSIZE == PERSONALITY1_KLONGSIZE
 757 #  define current_klongsize PERSONALITY0_KLONGSIZE
 758 # else
 759 extern unsigned current_klongsize;
 760 # endif
 761 #endif
 762
 763 #define ANY_WORDSIZE_LESS_THAN_KERNEL_LONG      \
 764         (SIZEOF_KERNEL_LONG_T > 4               \
 765          && (SIZEOF_LONG < SIZEOF_KERNEL_LONG_T || !defined(current_wordsize)))
 766
 767 #define DECL_PRINTNUM(name)                                             \
 768 extern bool                                                             \
 769 printnum_ ## name(struct tcb *, kernel_ulong_t addr, const char *fmt)   \
 770         ATTRIBUTE_FORMAT((printf, 3, 0))
 771 DECL_PRINTNUM(short);
 772 DECL_PRINTNUM(int);
 773 DECL_PRINTNUM(int64);
 774 #undef DECL_PRINTNUM
 775
 776 #define DECL_PRINTNUM_ADDR(name)                                        \
 777 extern bool                                                             \
 778 printnum_addr_ ## name(struct tcb *, kernel_ulong_t addr)
 779 DECL_PRINTNUM_ADDR(int);
 780 DECL_PRINTNUM_ADDR(int64);
 781 #undef DECL_PRINTNUM_ADDR
 782
 783 #ifndef current_wordsize
 784 extern bool
 785 printnum_long_int(struct tcb *, kernel_ulong_t addr,
 786                   const char *fmt_long, const char *fmt_int)
 787         ATTRIBUTE_FORMAT((printf, 3, 0))
 788         ATTRIBUTE_FORMAT((printf, 4, 0));
 789 extern bool printnum_addr_long_int(struct tcb *, kernel_ulong_t addr);
 790 # define printnum_slong(tcp, addr) \
 791         printnum_long_int((tcp), (addr), "%" PRId64, "%d")
 792 # define printnum_ulong(tcp, addr) \
 793         printnum_long_int((tcp), (addr), "%" PRIu64, "%u")
 794 # define printnum_ptr(tcp, addr) \
 795         printnum_addr_long_int((tcp), (addr))
 796 #elif current_wordsize > 4
 797 # define printnum_slong(tcp, addr) \
 798         printnum_int64((tcp), (addr), "%" PRId64)
 799 # define printnum_ulong(tcp, addr) \
 800         printnum_int64((tcp), (addr), "%" PRIu64)
 801 # define printnum_ptr(tcp, addr) \
 802         printnum_addr_int64((tcp), (addr))
 803 #else /* current_wordsize == 4 */
 804 # define printnum_slong(tcp, addr) \
 805         printnum_int((tcp), (addr), "%d")
 806 # define printnum_ulong(tcp, addr) \
 807         printnum_int((tcp), (addr), "%u")
 808 # define printnum_ptr(tcp, addr) \
 809         printnum_addr_int((tcp), (addr))
 810 #endif
 811
 812 #ifndef current_klongsize
 813 extern bool printnum_addr_klong_int(struct tcb *, kernel_ulong_t addr);
 814 # define printnum_kptr(tcp, addr) \
 815         printnum_addr_klong_int((tcp), (addr))
 816 #elif current_klongsize > 4
 817 # define printnum_kptr(tcp, addr) \
 818         printnum_addr_int64((tcp), (addr))
 819 #else /* current_klongsize == 4 */
 820 # define printnum_kptr(tcp, addr) \
 821         printnum_addr_int((tcp), (addr))
 822 #endif
 823
 824 #define DECL_PRINTPAIR(name)                                            \
 825 extern bool                                                             \
 826 printpair_ ## name(struct tcb *, kernel_ulong_t addr, const char *fmt)  \
 827         ATTRIBUTE_FORMAT((printf, 3, 0))
 828 DECL_PRINTPAIR(int);
 829 DECL_PRINTPAIR(int64);
 830 #undef DECL_PRINTPAIR
 831
 832 static inline kernel_long_t
 833 truncate_klong_to_current_wordsize(const kernel_long_t v)
 834 {
 835 #if ANY_WORDSIZE_LESS_THAN_KERNEL_LONG
 836         if (current_wordsize < sizeof(v)) {
 837                 return (int) v;
 838         } else
 839 #endif
 840         {
 841                 return v;
 842         }
 843 }
 844
 845 static inline kernel_ulong_t
 846 truncate_kulong_to_current_wordsize(const kernel_ulong_t v)
 847 {
 848 #if ANY_WORDSIZE_LESS_THAN_KERNEL_LONG
 849         if (current_wordsize < sizeof(v)) {
 850                 return (unsigned int) v;
 851         } else
 852 #endif
 853         {
 854                 return v;
 855         }
 856 }
 857
 858 /*
 859  * Cast a pointer or a pointer-sized integer to kernel_ulong_t.
 860  */
 861 #define ptr_to_kulong(v) ((kernel_ulong_t) (unsigned long) (v))
 862
 863 /*
 864  * Zero-extend a signed integer type to unsigned long long.
 865  */
 866 #define zero_extend_signed_to_ull(v) \
 867         (sizeof(v) == sizeof(char) ? (unsigned long long) (unsigned char) (v) : \
 868          sizeof(v) == sizeof(short) ? (unsigned long long) (unsigned short) (v) : \
 869          sizeof(v) == sizeof(int) ? (unsigned long long) (unsigned int) (v) : \
 870          sizeof(v) == sizeof(long) ? (unsigned long long) (unsigned long) (v) : \
 871          (unsigned long long) (v))
 872
 873 /*
 874  * Sign-extend an unsigned integer type to long long.
 875  */
 876 #define sign_extend_unsigned_to_ll(v) \
 877         (sizeof(v) == sizeof(char) ? (long long) (char) (v) : \
 878          sizeof(v) == sizeof(short) ? (long long) (short) (v) : \
 879          sizeof(v) == sizeof(int) ? (long long) (int) (v) : \
 880          sizeof(v) == sizeof(long) ? (long long) (long) (v) : \
 881          (long long) (v))
 882
 883 extern const struct_sysent sysent0[];
 884 extern const char *const errnoent0[];
 885 extern const char *const signalent0[];
 886 extern const struct_ioctlent ioctlent0[];
 887
 888 #if SUPPORTED_PERSONALITIES > 1
 889 extern const struct_sysent *sysent;
 890 extern const char *const *errnoent;
 891 extern const char *const *signalent;
 892 extern const struct_ioctlent *ioctlent;
 893 #else
 894 # define sysent     sysent0
 895 # define errnoent   errnoent0
 896 # define signalent  signalent0
 897 # define ioctlent   ioctlent0
 898 #endif
 899
 900 extern unsigned nsyscalls;
 901 extern unsigned nerrnos;
 902 extern unsigned nsignals;
 903 extern unsigned nioctlents;
 904
 905 extern const unsigned int nsyscall_vec[SUPPORTED_PERSONALITIES];
 906 extern const struct_sysent *const sysent_vec[SUPPORTED_PERSONALITIES];
 907 extern struct fault_opts *fault_vec[SUPPORTED_PERSONALITIES];
 908
 909 #ifdef IN_MPERS_BOOTSTRAP
 910 /* Transform multi-line MPERS_PRINTER_DECL statements to one-liners.  */
 911 # define MPERS_PRINTER_DECL(type, name, ...) MPERS_PRINTER_DECL(type, name, __VA_ARGS__)
 912 #else /* !IN_MPERS_BOOTSTRAP */
 913 # if SUPPORTED_PERSONALITIES > 1
 914 #  include "printers.h"
 915 # else
 916 #  include "native_printer_decls.h"
 917 # endif
 918 # define MPERS_PRINTER_DECL(type, name, ...) type MPERS_FUNC_NAME(name)(__VA_ARGS__)
 919 #endif /* !IN_MPERS_BOOTSTRAP */
 920
 921 /* Checks that sysent[scno] is not out of range. */
 922 static inline bool
 923 scno_in_range(kernel_ulong_t scno)
 924 {
 925         return scno < nsyscalls;
 926 }
 927
 928 /*
 929  * Checks whether scno is not out of range,
 930  * its corresponding sysent[scno].sys_func is non-NULL,
 931  * and its sysent[scno].sys_flags has no TRACE_INDIRECT_SUBCALL flag set.
 932  */
 933 static inline bool
 934 scno_is_valid(kernel_ulong_t scno)
 935 {
 936         return scno_in_range(scno)
 937                && sysent[scno].sys_func
 938                && !(sysent[scno].sys_flags & TRACE_INDIRECT_SUBCALL);
 939 }
 940
 941 #define MPERS_FUNC_NAME__(prefix, name) prefix ## name
 942 #define MPERS_FUNC_NAME_(prefix, name) MPERS_FUNC_NAME__(prefix, name)
 943 #define MPERS_FUNC_NAME(name) MPERS_FUNC_NAME_(MPERS_PREFIX, name)
 944
 945 #define SYS_FUNC_NAME(syscall_name) MPERS_FUNC_NAME(syscall_name)
 946
 947 #define SYS_FUNC(syscall_name) int SYS_FUNC_NAME(sys_ ## syscall_name)(struct tcb *tcp)
 948
 949 #if SIZEOF_KERNEL_LONG_T > SIZEOF_LONG
 950 # define PRI_kl "ll"
 951 #else
 952 # define PRI_kl "l"
 953 #endif
 954
 955 #define PRI_kld PRI_kl"d"
 956 #define PRI_klu PRI_kl"u"
 957 #define PRI_klx PRI_kl"x"
 958
 959 /*
 960  * The kernel used to define 64-bit types on 64-bit systems on a per-arch
 961  * basis.  Some architectures would use unsigned long and others would use
 962  * unsigned long long.  These types were exported as part of the
 963  * kernel-userspace ABI and now must be maintained forever.  This matches
 964  * what the kernel exports for each architecture so we don't need to cast
 965  * every printing of __u64 or __s64 to stdint types.
 966  */
 967 #if SIZEOF_LONG == 4
 968 # define PRI__64 "ll"
 969 #elif defined ALPHA || defined IA64 || defined MIPS || defined POWERPC
 970 # define PRI__64 "l"
 971 #else
 972 # define PRI__64 "ll"
 973 #endif
 974
 975 #define PRI__d64 PRI__64"d"
 976 #define PRI__u64 PRI__64"u"
 977 #define PRI__x64 PRI__64"x"
 978
 979 #endif /* !STRACE_DEFS_H */