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-2018 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 "arch_defs.h"
  57 #include "error_prints.h"
  58 #include "gcc_compat.h"
  59 #include "kernel_types.h"
  60 #include "macros.h"
  61 #include "mpers_type.h"
  62 #include "string_to_uint.h"
  63 #include "sysent.h"
  64 #include "xmalloc.h"
  65
  66 #ifndef HAVE_STRERROR
  67 const char *strerror(int);
  68 #endif
  69 #ifndef HAVE_STPCPY
  70 /* Some libc have stpcpy, some don't. Sigh...
  71  * Roll our private implementation...
  72  */
  73 #undef stpcpy
  74 #define stpcpy strace_stpcpy
  75 extern char *stpcpy(char *dst, const char *src);
  76 #endif
  77
  78 /* Glibc has an efficient macro for sigemptyset
  79  * (it just does one or two assignments of 0 to internal vector of longs).
  80  */
  81 #if defined(__GLIBC__) && defined(__sigemptyset) && !defined(sigemptyset)
  82 # define sigemptyset __sigemptyset
  83 #endif
  84
  85 /* Configuration section */
  86 #ifndef DEFAULT_STRLEN
  87 /* default maximum # of bytes printed in `printstr', change with -s switch */
  88 # define DEFAULT_STRLEN 32
  89 #endif
  90 #ifndef DEFAULT_ACOLUMN
  91 # define DEFAULT_ACOLUMN        40      /* default alignment column for results */
  92 #endif
  93 /*
  94  * Maximum number of args to a syscall.
  95  *
  96  * Make sure that all entries in all syscallent.h files have nargs <= MAX_ARGS!
  97  * linux/<ARCH>/syscallent*.h:
  98  *      all have nargs <= 6 except mips o32 which has nargs <= 7.
  99  */
 100 #ifndef MAX_ARGS
 101 # ifdef LINUX_MIPSO32
 102 #  define MAX_ARGS      7
 103 # else
 104 #  define MAX_ARGS      6
 105 # endif
 106 #endif
 107 /* default sorting method for call profiling */
 108 #ifndef DEFAULT_SORTBY
 109 # define DEFAULT_SORTBY "time"
 110 #endif
 111
 112 /* To force NOMMU build, set to 1 */
 113 #define NOMMU_SYSTEM 0
 114
 115 #ifndef ERESTARTSYS
 116 # define ERESTARTSYS    512
 117 #endif
 118 #ifndef ERESTARTNOINTR
 119 # define ERESTARTNOINTR 513
 120 #endif
 121 #ifndef ERESTARTNOHAND
 122 # define ERESTARTNOHAND 514
 123 #endif
 124 #ifndef ERESTART_RESTARTBLOCK
 125 # define ERESTART_RESTARTBLOCK 516
 126 #endif
 127
 128 #define PERSONALITY0_WORDSIZE  SIZEOF_LONG
 129 #define PERSONALITY0_KLONGSIZE SIZEOF_KERNEL_LONG_T
 130 #define PERSONALITY0_INCLUDE_PRINTERS_DECLS "native_printer_decls.h"
 131 #define PERSONALITY0_INCLUDE_PRINTERS_DEFS "native_printer_defs.h"
 132
 133 #if SUPPORTED_PERSONALITIES > 1
 134 # define PERSONALITY1_WORDSIZE  4
 135 # define PERSONALITY1_KLONGSIZE PERSONALITY1_WORDSIZE
 136 #endif
 137
 138 #if SUPPORTED_PERSONALITIES > 2
 139 # define PERSONALITY2_WORDSIZE  4
 140 # define PERSONALITY2_KLONGSIZE PERSONALITY0_KLONGSIZE
 141 #endif
 142
 143 #if SUPPORTED_PERSONALITIES > 1 && defined HAVE_M32_MPERS
 144 # define PERSONALITY1_INCLUDE_PRINTERS_DECLS "m32_printer_decls.h"
 145 # define PERSONALITY1_INCLUDE_PRINTERS_DEFS "m32_printer_defs.h"
 146 # define PERSONALITY1_INCLUDE_FUNCS "m32_funcs.h"
 147 # define MPERS_m32_IOCTL_MACROS "ioctl_redefs1.h"
 148 # define HAVE_PERSONALITY_1_MPERS 1
 149 #else
 150 # define PERSONALITY1_INCLUDE_PRINTERS_DECLS "native_printer_decls.h"
 151 # define PERSONALITY1_INCLUDE_PRINTERS_DEFS "native_printer_defs.h"
 152 # define PERSONALITY1_INCLUDE_FUNCS "empty.h"
 153 # define HAVE_PERSONALITY_1_MPERS 0
 154 #endif
 155
 156 #if SUPPORTED_PERSONALITIES > 2 && defined HAVE_MX32_MPERS
 157 # define PERSONALITY2_INCLUDE_FUNCS "mx32_funcs.h"
 158 # define PERSONALITY2_INCLUDE_PRINTERS_DECLS "mx32_printer_decls.h"
 159 # define PERSONALITY2_INCLUDE_PRINTERS_DEFS "mx32_printer_defs.h"
 160 # define MPERS_mx32_IOCTL_MACROS "ioctl_redefs2.h"
 161 # define HAVE_PERSONALITY_2_MPERS 1
 162 #else
 163 # define PERSONALITY2_INCLUDE_PRINTERS_DECLS "native_printer_decls.h"
 164 # define PERSONALITY2_INCLUDE_PRINTERS_DEFS "native_printer_defs.h"
 165 # define PERSONALITY2_INCLUDE_FUNCS "empty.h"
 166 # define HAVE_PERSONALITY_2_MPERS 0
 167 #endif
 168
 169 #ifdef WORDS_BIGENDIAN
 170 # define is_bigendian true
 171 #else
 172 # define is_bigendian false
 173 #endif
 174
 175 typedef struct ioctlent {
 176         const char *symbol;
 177         unsigned int code;
 178 } struct_ioctlent;
 179
 180 #define INJECT_F_SIGNAL         0x01
 181 #define INJECT_F_ERROR          0x02
 182 #define INJECT_F_RETVAL         0x04
 183 #define INJECT_F_DELAY_ENTER    0x08
 184 #define INJECT_F_DELAY_EXIT     0x10
 185 #define INJECT_F_SYSCALL        0x20
 186
 187 #define INJECT_ACTION_FLAGS     \
 188         (INJECT_F_SIGNAL        \
 189         |INJECT_F_ERROR         \
 190         |INJECT_F_RETVAL        \
 191         |INJECT_F_DELAY_ENTER   \
 192         |INJECT_F_DELAY_EXIT    \
 193         )
 194
 195 struct inject_data {
 196         uint8_t flags;          /* 6 of 8 flags are used so far */
 197         uint8_t signo;          /* NSIG <= 128 */
 198         uint16_t rval_idx;      /* index in retval_vec */
 199         uint16_t delay_idx;     /* index in delay_data_vec */
 200         uint16_t scno;          /* syscall to be injected instead of -1 */
 201 };
 202
 203 struct inject_opts {
 204         uint16_t first;
 205         uint16_t step;
 206         struct inject_data data;
 207 };
 208
 209 #define MAX_ERRNO_VALUE                 4095
 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 timespec stime;  /* System time usage as of last process wait */
 233         struct timespec dtime;  /* Delta for system time usage */
 234         struct timespec etime;  /* Syscall entry time */
 235         struct timespec delay_expiration_time; /* When does the delay end */
 236
 237         struct mmap_cache_t *mmap_cache;
 238
 239 #ifdef HAVE_LINUX_KVM_H
 240         struct vcpu_info *vcpu_info_list;
 241 #endif
 242
 243 #ifdef ENABLE_STACKTRACE
 244         void *unwind_ctx;
 245         struct unwind_queue_t *unwind_queue;
 246 #endif
 247 };
 248
 249 /* TCB flags */
 250 /* We have attached to this process, but did not see it stopping yet */
 251 #define TCB_STARTUP             0x01
 252 #define TCB_IGNORE_ONE_SIGSTOP  0x02    /* Next SIGSTOP is to be ignored */
 253 /*
 254  * Are we in system call entry or in syscall exit?
 255  *
 256  * This bit is set in syscall_entering_finish() and cleared in
 257  * syscall_exiting_finish().
 258  * Other stops which are possible directly after syscall entry (death, ptrace
 259  * event stop) are handled without calling syscall_{entering,exiting}_*().
 260  *
 261  * Use entering(tcp) / exiting(tcp) to check this bit to make code more
 262  * 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 #define TCB_GRABBED     0x200   /* We grab the process and can catch it
 272                                  * in the middle of a syscall */
 273 #define TCB_RECOVERING  0x400   /* We try to recover after detecting incorrect
 274                                  * syscall entering/exiting state */
 275 #define TCB_INJECT_DELAY_EXIT   0x800   /* Current syscall needs to be delayed
 276                                            on exit */
 277 #define TCB_DELAYED     0x1000  /* Current syscall has been delayed */
 278 #define TCB_TAMPERED_NO_FAIL 0x2000     /* We tamper tcb with syscall
 279                                            that should not fail. */
 280
 281 /* qualifier flags */
 282 #define QUAL_TRACE      0x001   /* this system call should be traced */
 283 #define QUAL_ABBREV     0x002   /* abbreviate the structures of this syscall */
 284 #define QUAL_VERBOSE    0x004   /* decode the structures of this syscall */
 285 #define QUAL_RAW        0x008   /* print all args in hex for this syscall */
 286 #define QUAL_INJECT     0x010   /* tamper with this system call on purpose */
 287
 288 #define DEFAULT_QUAL_FLAGS (QUAL_TRACE | QUAL_ABBREV | QUAL_VERBOSE)
 289
 290 #define entering(tcp)   (!((tcp)->flags & TCB_INSYSCALL))
 291 #define exiting(tcp)    ((tcp)->flags & TCB_INSYSCALL)
 292 #define syserror(tcp)   ((tcp)->u_error != 0)
 293 #define traced(tcp)     ((tcp)->qual_flg & QUAL_TRACE)
 294 #define verbose(tcp)    ((tcp)->qual_flg & QUAL_VERBOSE)
 295 #define abbrev(tcp)     ((tcp)->qual_flg & QUAL_ABBREV)
 296 #define raw(tcp)        ((tcp)->qual_flg & QUAL_RAW)
 297 #define inject(tcp)     ((tcp)->qual_flg & QUAL_INJECT)
 298 #define filtered(tcp)   ((tcp)->flags & TCB_FILTERED)
 299 #define hide_log(tcp)   ((tcp)->flags & TCB_HIDE_LOG)
 300 #define syscall_tampered(tcp)   ((tcp)->flags & TCB_TAMPERED)
 301 #define recovering(tcp) ((tcp)->flags & TCB_RECOVERING)
 302 #define inject_delay_exit(tcp)  ((tcp)->flags & TCB_INJECT_DELAY_EXIT)
 303 #define syscall_delayed(tcp)    ((tcp)->flags & TCB_DELAYED)
 304 #define syscall_tampered_nofail(tcp) ((tcp)->flags & TCB_TAMPERED_NO_FAIL)
 305
 306 #include "xlat.h"
 307
 308 extern const struct xlat addrfams[];
 309
 310 /** Protocol hardware identifiers array, sorted, defined in sockaddr.c. */
 311 extern const struct xlat arp_hardware_types[];
 312 /** Protocol hardware identifiers array size without terminating record. */
 313 extern const size_t arp_hardware_types_size;
 314
 315 extern const struct xlat at_flags[];
 316 extern const struct xlat clocknames[];
 317 extern const struct xlat dirent_types[];
 318
 319 /** Ethernet protocols list, sorted, defined in sockaddr.c. */
 320 extern const struct xlat ethernet_protocols[];
 321 /** Ethernet protocols array size without terminating record. */
 322 extern const size_t ethernet_protocols_size;
 323
 324 /** IP protocols list, sorted, defined in net.c. */
 325 extern const struct xlat inet_protocols[];
 326 /** IP protocols array size without terminating record. */
 327 extern const size_t inet_protocols_size;
 328
 329 extern const struct xlat evdev_abs[];
 330 /** Number of elements in evdev_abs array without the terminating record. */
 331 extern const size_t evdev_abs_size;
 332
 333 extern const struct xlat iffflags[];
 334 extern const struct xlat ip_type_of_services[];
 335 extern const struct xlat ipc_private[];
 336 extern const struct xlat msg_flags[];
 337 extern const struct xlat netlink_protocols[];
 338 extern const struct xlat nl_netfilter_msg_types[];
 339 extern const struct xlat nl_route_types[];
 340 extern const struct xlat open_access_modes[];
 341 extern const struct xlat open_mode_flags[];
 342 extern const struct xlat resource_flags[];
 343 extern const struct xlat routing_scopes[];
 344 extern const struct xlat routing_table_ids[];
 345 extern const struct xlat routing_types[];
 346 extern const struct xlat seccomp_filter_flags[];
 347 extern const struct xlat seccomp_ret_action[];
 348 extern const struct xlat setns_types[];
 349 extern const struct xlat sg_io_info[];
 350 extern const struct xlat socketlayers[];
 351 extern const struct xlat socktypes[];
 352 extern const struct xlat tcp_state_flags[];
 353 extern const struct xlat tcp_states[];
 354 extern const struct xlat whence_codes[];
 355
 356 /* Format of syscall return values */
 357 #define RVAL_UDECIMAL   000     /* unsigned decimal format */
 358 #define RVAL_HEX        001     /* hex format */
 359 #define RVAL_OCTAL      002     /* octal format */
 360 #define RVAL_FD         010     /* file descriptor */
 361 #define RVAL_MASK       013     /* mask for these values */
 362
 363 #define RVAL_STR        020     /* Print `auxstr' field after return val */
 364 #define RVAL_NONE       040     /* Print nothing */
 365
 366 #define RVAL_DECODED    0100    /* syscall decoding finished */
 367 #define RVAL_IOCTL_DECODED 0200 /* ioctl sub-parser successfully decoded
 368                                    the argument */
 369
 370 #define IOCTL_NUMBER_UNKNOWN 0
 371 #define IOCTL_NUMBER_HANDLED 1
 372 #define IOCTL_NUMBER_STOP_LOOKUP 010
 373
 374 #define indirect_ipccall(tcp) (tcp->s_ent->sys_flags & TRACE_INDIRECT_SUBCALL)
 375
 376 enum sock_proto {
 377         SOCK_PROTO_UNKNOWN,
 378         SOCK_PROTO_UNIX,
 379         SOCK_PROTO_TCP,
 380         SOCK_PROTO_UDP,
 381         SOCK_PROTO_TCPv6,
 382         SOCK_PROTO_UDPv6,
 383         SOCK_PROTO_NETLINK
 384 };
 385 extern enum sock_proto get_proto_by_name(const char *);
 386
 387 enum iov_decode {
 388         IOV_DECODE_ADDR,
 389         IOV_DECODE_STR,
 390         IOV_DECODE_NETLINK
 391 };
 392
 393 typedef enum {
 394         CFLAG_NONE = 0,
 395         CFLAG_ONLY_STATS,
 396         CFLAG_BOTH
 397 } cflag_t;
 398 extern cflag_t cflag;
 399 extern bool Tflag;
 400 extern bool iflag;
 401 extern bool count_wallclock;
 402 extern unsigned int qflag;
 403 extern bool not_failing_only;
 404 extern unsigned int show_fd_path;
 405 /* are we filtering traces based on paths? */
 406 extern struct path_set {
 407         const char **paths_selected;
 408         size_t num_selected;
 409         size_t size;
 410 } global_path_set;
 411 #define tracing_paths (global_path_set.num_selected != 0)
 412 extern unsigned xflag;
 413 extern unsigned followfork;
 414 #ifdef ENABLE_STACKTRACE
 415 /* if this is true do the stack trace for every system call */
 416 extern bool stack_trace_enabled;
 417 #endif
 418 extern unsigned ptrace_setoptions;
 419 extern unsigned max_strlen;
 420 extern unsigned os_release;
 421 #undef KERNEL_VERSION
 422 #define KERNEL_VERSION(a, b, c) (((a) << 16) + ((b) << 8) + (c))
 423
 424 extern int read_int_from_file(struct tcb *, const char *, int *);
 425
 426 extern void set_sortby(const char *);
 427 extern void set_overhead(int);
 428 extern void print_pc(struct tcb *);
 429
 430 extern int syscall_entering_decode(struct tcb *);
 431 extern int syscall_entering_trace(struct tcb *, unsigned int *);
 432 extern void syscall_entering_finish(struct tcb *, int);
 433
 434 extern int syscall_exiting_decode(struct tcb *, struct timespec *);
 435 extern int syscall_exiting_trace(struct tcb *, struct timespec *, int);
 436 extern void syscall_exiting_finish(struct tcb *);
 437
 438 extern void count_syscall(struct tcb *, const struct timespec *);
 439 extern void call_summary(FILE *);
 440
 441 extern void clear_regs(struct tcb *tcp);
 442 extern int get_scno(struct tcb *);
 443 extern kernel_ulong_t get_rt_sigframe_addr(struct tcb *);
 444
 445 /**
 446  * Convert a (shuffled) syscall number to the corresponding syscall name.
 447  *
 448  * @param scno Syscall number.
 449  * @return     String literal corresponding to the syscall number in case latter
 450  *             is valid; NULL otherwise.
 451  */
 452 extern const char *syscall_name(kernel_ulong_t scno);
 453 /**
 454  * Convert a syscall name to the corresponding (shuffled) syscall number.
 455  *
 456  * @param s     Syscall name.
 457  * @param p     Personality.
 458  * @param start From which position in syscall entry table resume the search.
 459  * @return      Shuffled syscall number (ready to use against sysent_vec)
 460  *              if syscall name is found; -1 otherwise.
 461  */
 462 extern kernel_long_t scno_by_name(const char *s, unsigned p,
 463                                   kernel_long_t start);
 464 /**
 465  * Shuffle syscall numbers so that we don't have huge gaps in syscall table.
 466  * The shuffling should be an involution: shuffle_scno(shuffle_scno(n)) == n.
 467  *
 468  * @param scno Raw or shuffled syscall number.
 469  * @return     Shuffled or raw syscall number, respectively.
 470  */
 471 extern kernel_ulong_t shuffle_scno(kernel_ulong_t scno);
 472 extern const char *err_name(unsigned long err);
 473
 474 extern bool is_erestart(struct tcb *);
 475 extern void temporarily_clear_syserror(struct tcb *);
 476 extern void restore_cleared_syserror(struct tcb *);
 477
 478 extern void *get_tcb_priv_data(const struct tcb *);
 479 extern int set_tcb_priv_data(struct tcb *, void *priv_data,
 480                              void (*free_priv_data)(void *));
 481 extern void free_tcb_priv_data(struct tcb *);
 482
 483 static inline unsigned long get_tcb_priv_ulong(const struct tcb *tcp)
 484 {
 485         return (unsigned long) get_tcb_priv_data(tcp);
 486 }
 487
 488 static inline int set_tcb_priv_ulong(struct tcb *tcp, unsigned long val)
 489 {
 490         return set_tcb_priv_data(tcp, (void *) val, 0);
 491 }
 492
 493 /**
 494  * @return 0 on success, -1 on error.
 495  */
 496 extern int
 497 umoven(struct tcb *, kernel_ulong_t addr, unsigned int len, void *laddr);
 498 #define umove(pid, addr, objp)  \
 499         umoven((pid), (addr), sizeof(*(objp)), (void *) (objp))
 500
 501 /**
 502  * @return true on success, false on error.
 503  */
 504 extern bool
 505 tfetch_mem64(struct tcb *, uint64_t addr, unsigned int len, void *laddr);
 506
 507 static inline bool
 508 tfetch_mem(struct tcb *tcp, const kernel_ulong_t addr,
 509            unsigned int len, void *laddr)
 510 {
 511         return tfetch_mem64(tcp, addr, len, laddr);
 512 }
 513 #define tfetch_obj(pid, addr, objp)     \
 514         tfetch_mem((pid), (addr), sizeof(*(objp)), (void *) (objp))
 515
 516 /**
 517  * @return true on success, false on error.
 518  */
 519 extern bool
 520 tfetch_mem64_ignore_syserror(struct tcb *, uint64_t addr,
 521                              unsigned int len, void *laddr);
 522
 523 static inline bool
 524 tfetch_mem_ignore_syserror(struct tcb *tcp, const kernel_ulong_t addr,
 525                            unsigned int len, void *laddr)
 526 {
 527         return tfetch_mem64_ignore_syserror(tcp, addr, len, laddr);
 528 }
 529
 530 /**
 531  * @return 0 on success, -1 on error (and print addr).
 532  */
 533 extern int
 534 umoven_or_printaddr64(struct tcb *, uint64_t addr,
 535                       unsigned int len, void *laddr);
 536 #define umove_or_printaddr64(pid, addr, objp)   \
 537         umoven_or_printaddr64((pid), (addr), sizeof(*(objp)), (void *) (objp))
 538
 539 static inline int
 540 umoven_or_printaddr(struct tcb *tcp, const kernel_ulong_t addr,
 541                     unsigned int len, void *laddr)
 542 {
 543         return umoven_or_printaddr64(tcp, addr, len, laddr);
 544 }
 545 #define umove_or_printaddr(pid, addr, objp)     \
 546         umoven_or_printaddr((pid), (addr), sizeof(*(objp)), (void *) (objp))
 547
 548 /**
 549  * @return 0 on success, -1 on error (and print addr).
 550  */
 551 extern int
 552 umoven_or_printaddr64_ignore_syserror(struct tcb *, uint64_t addr,
 553                                       unsigned int len, void *laddr);
 554 #define umove_or_printaddr64_ignore_syserror(pid, addr, objp)   \
 555         umoven_or_printaddr64_ignore_syserror((pid), (addr), sizeof(*(objp)), \
 556                                               (void *) (objp))
 557
 558 static inline int
 559 umoven_or_printaddr_ignore_syserror(struct tcb *tcp, const kernel_ulong_t addr,
 560                                     unsigned int len, void *laddr)
 561 {
 562         return umoven_or_printaddr64_ignore_syserror(tcp, addr, len, laddr);
 563 }
 564 #define umove_or_printaddr_ignore_syserror(pid, addr, objp)     \
 565         umoven_or_printaddr_ignore_syserror((pid), (addr), sizeof(*(objp)), \
 566                                             (void *) (objp))
 567
 568 /**
 569  * @return strlen + 1 on success, 0 on success and no NUL seen, -1 on error.
 570  */
 571 extern int
 572 umovestr(struct tcb *, kernel_ulong_t addr, unsigned int len, char *laddr);
 573
 574 extern int upeek(struct tcb *tcp, unsigned long, kernel_ulong_t *);
 575 extern int upoke(struct tcb *tcp, unsigned long, kernel_ulong_t);
 576
 577 #if HAVE_ARCH_GETRVAL2
 578 extern long getrval2(struct tcb *);
 579 #endif
 580
 581 extern const char *signame(const int);
 582 extern void pathtrace_select_set(const char *, struct path_set *);
 583 extern bool pathtrace_match_set(struct tcb *, struct path_set *);
 584
 585 static inline void
 586 pathtrace_select(const char *path)
 587 {
 588         return pathtrace_select_set(path, &global_path_set);
 589 }
 590
 591 static inline bool
 592 pathtrace_match(struct tcb *tcp)
 593 {
 594         return pathtrace_match_set(tcp, &global_path_set);
 595 }
 596
 597 extern int getfdpath(struct tcb *, int, char *, unsigned);
 598 extern unsigned long getfdinode(struct tcb *, int);
 599 extern enum sock_proto getfdproto(struct tcb *, int);
 600
 601 extern const char *xlookup(const struct xlat *, const uint64_t);
 602 extern const char *xlat_search(const struct xlat *, const size_t, const uint64_t);
 603 extern const char *xlat_idx(const struct xlat *xlat, size_t nmemb, uint64_t val);
 604
 605 struct dyxlat;
 606 struct dyxlat *dyxlat_alloc(size_t nmemb);
 607 void dyxlat_free(struct dyxlat *);
 608 const struct xlat *dyxlat_get(const struct dyxlat *);
 609 void dyxlat_add_pair(struct dyxlat *, uint64_t val, const char *str, size_t len);
 610
 611 const struct xlat *genl_families_xlat(struct tcb *tcp);
 612
 613 extern unsigned long get_pagesize(void);
 614 extern int next_set_bit(const void *bit_array, unsigned cur_bit, unsigned size_bits);
 615
 616 /*
 617  * Returns STR if it does not start with PREFIX,
 618  * or a pointer to the first char in STR after PREFIX.
 619  * The length of PREFIX is specified by PREFIX_LEN.
 620  */
 621 static inline const char *
 622 str_strip_prefix_len(const char *str, const char *prefix, size_t prefix_len)
 623 {
 624         return strncmp(str, prefix, prefix_len) ? str : str + prefix_len;
 625 }
 626
 627 #define STR_STRIP_PREFIX(str, prefix)   \
 628         str_strip_prefix_len((str), (prefix), sizeof(prefix) - 1)
 629
 630 #define QUOTE_0_TERMINATED                      0x01
 631 #define QUOTE_OMIT_LEADING_TRAILING_QUOTES      0x02
 632 #define QUOTE_OMIT_TRAILING_0                   0x08
 633 #define QUOTE_FORCE_HEX                         0x10
 634 #define QUOTE_EMIT_COMMENT                      0x20
 635
 636 extern int string_quote(const char *, char *, unsigned int, unsigned int,
 637                         const char *escape_chars);
 638 extern int print_quoted_string_ex(const char *, unsigned int, unsigned int,
 639                                   const char *escape_chars);
 640 extern int print_quoted_string(const char *, unsigned int, unsigned int);
 641 extern int print_quoted_cstring(const char *, unsigned int);
 642
 643 /* a refers to the lower numbered u_arg,
 644  * b refers to the higher numbered u_arg
 645  */
 646 #ifdef WORDS_BIGENDIAN
 647 # define ULONG_LONG(a, b) \
 648         ((unsigned long long)(unsigned)(b) | ((unsigned long long)(a)<<32))
 649 #else
 650 # define ULONG_LONG(a, b) \
 651         ((unsigned long long)(unsigned)(a) | ((unsigned long long)(b)<<32))
 652 #endif
 653 extern int getllval(struct tcb *, unsigned long long *, int);
 654 extern int printllval(struct tcb *, const char *, int)
 655         ATTRIBUTE_FORMAT((printf, 2, 0));
 656
 657 extern void printaddr64(uint64_t addr);
 658
 659 static inline void
 660 printaddr(const kernel_ulong_t addr)
 661 {
 662         printaddr64(addr);
 663 }
 664
 665 #define xlat_verbose(style_) ((style_) & XLAT_STYLE_VERBOSITY_MASK)
 666 #define xlat_format(style_)  ((style_) & XLAT_STYLE_FORMAT_MASK)
 667
 668 extern enum xlat_style xlat_verbosity;
 669
 670 extern int printxvals_ex(uint64_t val, const char *dflt,
 671                          enum xlat_style, const struct xlat *, ...)
 672         ATTRIBUTE_SENTINEL;
 673 #define printxvals(val_, dflt_, ...) \
 674         printxvals_ex((val_), (dflt_), XLAT_STYLE_DEFAULT, __VA_ARGS__)
 675
 676 extern int printxval_searchn_ex(const struct xlat *, size_t xlat_size,
 677                                 uint64_t val, const char *dflt,
 678                                 enum xlat_style);
 679
 680 static inline int
 681 printxval_searchn(const struct xlat *xlat, size_t xlat_size, uint64_t val,
 682                   const char *dflt)
 683 {
 684         return printxval_searchn_ex(xlat, xlat_size, val, dflt,
 685                                     XLAT_STYLE_DEFAULT);
 686 }
 687
 688 /**
 689  * Wrapper around printxval_searchn that passes ARRAY_SIZE - 1
 690  * as the array size, as all arrays are XLAT_END-terminated and
 691  * printxval_searchn expects a size without the terminating record.
 692  */
 693 #define printxval_search(xlat__, val__, dflt__) \
 694         printxval_searchn(xlat__, ARRAY_SIZE(xlat__) - 1, val__, dflt__)
 695 #define printxval_search_ex(xlat__, val__, dflt__) \
 696         printxval_searchn_ex((xlat__), ARRAY_SIZE(xlat__) - 1, (val__), \
 697                              (dflt__), XLAT_STYLE_DEFAULT)
 698
 699 extern int printxval_indexn_ex(const struct xlat *, size_t xlat_size,
 700                                uint64_t val, const char *dflt, enum xlat_style);
 701
 702 static inline int
 703 printxval_indexn(const struct xlat *xlat, size_t xlat_size, uint64_t val,
 704                  const char *dflt)
 705 {
 706         return printxval_indexn_ex(xlat, xlat_size, val, dflt,
 707                                    XLAT_STYLE_DEFAULT);
 708 }
 709
 710 #define printxval_index(xlat__, val__, dflt__) \
 711         printxval_indexn(xlat__, ARRAY_SIZE(xlat__) - 1, val__, dflt__)
 712 #define printxval_index_ex(xlat__, val__, dflt__) \
 713         printxval_indexn_ex((xlat__), ARRAY_SIZE(xlat__) - 1, (val__), \
 714                             (dflt__), XLAT_STYLE_DEFAULT)
 715
 716 extern int sprintxval_ex(char *buf, size_t size, const struct xlat *,
 717                          unsigned int val, const char *dflt, enum xlat_style);
 718
 719 static inline int
 720 sprintxval(char *buf, size_t size, const struct xlat *xlat, unsigned int val,
 721            const char *dflt)
 722 {
 723         return sprintxval_ex(buf, size, xlat, val, dflt, XLAT_STYLE_DEFAULT);
 724 }
 725
 726 extern void printxval_dispatch_ex(const struct xlat *, size_t xlat_size,
 727                                   uint64_t val, const char *dflt,
 728                                   enum xlat_type, enum xlat_style);
 729 static inline void
 730 printxval_dispatch(const struct xlat *xlat, size_t xlat_size, uint64_t val,
 731                    const char *dflt, enum xlat_type xt)
 732 {
 733         return printxval_dispatch_ex(xlat, xlat_size, val, dflt, xt,
 734                                      XLAT_STYLE_DEFAULT);
 735 }
 736
 737 /** Print a value in accordance with xlat formatting settings. */
 738 extern void print_xlat_ex(uint64_t val, const char *str, enum xlat_style style);
 739 #define print_xlat(val_) \
 740         print_xlat_ex((val_), #val_, XLAT_STYLE_DEFAULT)
 741 #define print_xlat32(val_) \
 742         print_xlat_ex((uint32_t) (val_), #val_, XLAT_STYLE_DEFAULT)
 743 #define print_xlat_u(val_) \
 744         print_xlat_ex((val_), #val_, XLAT_STYLE_FMT_U)
 745 #define print_xlat_d(val_) \
 746         print_xlat_ex((val_), #val_, XLAT_STYLE_FMT_D)
 747
 748 extern int printargs(struct tcb *);
 749 extern int printargs_u(struct tcb *);
 750 extern int printargs_d(struct tcb *);
 751
 752 extern int printflags_ex(uint64_t flags, const char *dflt,
 753                          enum xlat_style, const struct xlat *, ...)
 754         ATTRIBUTE_SENTINEL;
 755 extern const char *sprintflags_ex(const char *prefix, const struct xlat *,
 756                                   uint64_t flags, enum xlat_style);
 757
 758 static inline const char *
 759 sprintflags(const char *prefix, const struct xlat *xlat, uint64_t flags)
 760 {
 761         return sprintflags_ex(prefix, xlat, flags, XLAT_STYLE_DEFAULT);
 762 }
 763
 764 extern const char *sprinttime(long long sec);
 765 extern const char *sprinttime_nsec(long long sec, unsigned long long nsec);
 766 extern const char *sprinttime_usec(long long sec, unsigned long long usec);
 767
 768 extern const char *sprint_mac_addr(const uint8_t addr[], size_t size);
 769
 770 extern void print_symbolic_mode_t(unsigned int);
 771 extern void print_numeric_umode_t(unsigned short);
 772 extern void print_numeric_long_umask(unsigned long);
 773 extern void print_dev_t(unsigned long long dev);
 774 extern void print_abnormal_hi(kernel_ulong_t);
 775
 776 extern bool print_int32_array_member(struct tcb *, void *elem_buf,
 777                                      size_t elem_size, void *data);
 778 extern bool print_uint32_array_member(struct tcb *, void *elem_buf,
 779                                       size_t elem_size, void *data);
 780 extern bool print_uint64_array_member(struct tcb *, void *elem_buf,
 781                                       size_t elem_size, void *data);
 782
 783 typedef bool (*tfetch_mem_fn)(struct tcb *, kernel_ulong_t addr,
 784                               unsigned int size, void *dest);
 785 typedef bool (*print_fn)(struct tcb *, void *elem_buf,
 786                          size_t elem_size, void *opaque_data);
 787
 788 enum print_array_flag_bits {
 789         PAF_PRINT_INDICES_BIT = XLAT_STYLE_SPEC_BITS + 1,
 790         PAF_INDEX_XLAT_SORTED_BIT,
 791         PAF_INDEX_XLAT_VALUE_INDEXED_BIT,
 792 };
 793
 794 #define FLAG_(name_) name_ = 1 << name_##_BIT
 795
 796 enum print_array_flags {
 797         FLAG_(PAF_PRINT_INDICES),
 798         FLAG_(PAF_INDEX_XLAT_SORTED),
 799         FLAG_(PAF_INDEX_XLAT_VALUE_INDEXED),
 800 };
 801
 802 #undef FLAG_
 803
 804 /**
 805  * @param flags Combination of xlat style settings and additional flags from
 806  *              enum print_array_flags.
 807  */
 808 extern bool
 809 print_array_ex(struct tcb *,
 810                kernel_ulong_t start_addr,
 811                size_t nmemb,
 812                void *elem_buf,
 813                size_t elem_size,
 814                tfetch_mem_fn tfetch_mem_func,
 815                print_fn print_func,
 816                void *opaque_data,
 817                unsigned int flags,
 818                const struct xlat *index_xlat,
 819                size_t index_xlat_size,
 820                const char *index_dflt);
 821
 822 static inline bool
 823 print_array(struct tcb *const tcp,
 824             const kernel_ulong_t start_addr,
 825             const size_t nmemb,
 826             void *const elem_buf,
 827             const size_t elem_size,
 828             tfetch_mem_fn tfetch_mem_func,
 829             print_fn print_func,
 830             void *const opaque_data)
 831 {
 832         return print_array_ex(tcp, start_addr, nmemb, elem_buf, elem_size,
 833                               tfetch_mem_func, print_func, opaque_data,
 834                               0, NULL, 0, NULL);
 835 }
 836
 837 extern kernel_ulong_t *
 838 fetch_indirect_syscall_args(struct tcb *, kernel_ulong_t addr, unsigned int n_args);
 839
 840 extern void
 841 dumpiov_in_msghdr(struct tcb *, kernel_ulong_t addr, kernel_ulong_t data_size);
 842
 843 extern void
 844 dumpiov_in_mmsghdr(struct tcb *, kernel_ulong_t addr);
 845
 846 extern void
 847 dumpiov_upto(struct tcb *, int len, kernel_ulong_t addr, kernel_ulong_t data_size);
 848
 849 extern void
 850 dumpstr(struct tcb *, kernel_ulong_t addr, int len);
 851
 852 extern int
 853 printstr_ex(struct tcb *, kernel_ulong_t addr, kernel_ulong_t len,
 854             unsigned int user_style);
 855
 856 extern int
 857 printpathn(struct tcb *, kernel_ulong_t addr, unsigned int n);
 858
 859 extern int
 860 printpath(struct tcb *, kernel_ulong_t addr);
 861
 862 #define TIMESPEC_TEXT_BUFSIZE \
 863                 (sizeof(long long) * 3 * 2 + sizeof("{tv_sec=-, tv_nsec=}"))
 864 extern void printfd(struct tcb *, int);
 865 extern void print_sockaddr(const void *sa, int len);
 866 extern bool
 867 print_inet_addr(int af, const void *addr, unsigned int len, const char *var_name);
 868 extern bool
 869 decode_inet_addr(struct tcb *, kernel_ulong_t addr,
 870                  unsigned int len, int family, const char *var_name);
 871 extern const char *get_sockaddr_by_inode(struct tcb *, int fd, unsigned long inode);
 872 extern bool print_sockaddr_by_inode(struct tcb *, int fd, unsigned long inode);
 873 extern void print_dirfd(struct tcb *, int);
 874
 875 extern int
 876 decode_sockaddr(struct tcb *, kernel_ulong_t addr, int addrlen);
 877
 878 extern void printuid(const char *, const unsigned int);
 879
 880 extern void
 881 print_sigset_addr_len(struct tcb *, kernel_ulong_t addr, kernel_ulong_t len);
 882 extern void
 883 print_sigset_addr(struct tcb *, kernel_ulong_t addr);
 884
 885 extern const char *sprintsigmask_n(const char *, const void *, unsigned int);
 886 #define tprintsigmask_addr(prefix, mask) \
 887         tprints(sprintsigmask_n((prefix), (mask), sizeof(mask)))
 888 extern void printsignal(int);
 889
 890 extern void
 891 tprint_iov_upto(struct tcb *, kernel_ulong_t len, kernel_ulong_t addr,
 892                 enum iov_decode, kernel_ulong_t data_size);
 893
 894 extern void
 895 decode_netlink(struct tcb *, int fd, kernel_ulong_t addr, kernel_ulong_t len);
 896
 897 extern void tprint_open_modes(unsigned int);
 898 extern const char *sprint_open_modes(unsigned int);
 899
 900 extern void
 901 decode_seccomp_fprog(struct tcb *, kernel_ulong_t addr);
 902
 903 extern void
 904 print_seccomp_fprog(struct tcb *, kernel_ulong_t addr, unsigned short len);
 905
 906 extern void
 907 decode_sock_fprog(struct tcb *, kernel_ulong_t addr);
 908
 909 extern void
 910 print_sock_fprog(struct tcb *, kernel_ulong_t addr, unsigned short len);
 911
 912 struct strace_stat;
 913 extern void print_struct_stat(struct tcb *, const struct strace_stat *const st);
 914
 915 struct strace_statfs;
 916 struct strace_keyctl_kdf_params;
 917
 918 extern void
 919 print_struct_statfs(struct tcb *, kernel_ulong_t addr);
 920
 921 extern void
 922 print_struct_statfs64(struct tcb *, kernel_ulong_t addr, kernel_ulong_t size);
 923
 924 extern int
 925 fetch_perf_event_attr(struct tcb *const tcp, const kernel_ulong_t addr);
 926 extern void
 927 print_perf_event_attr(struct tcb *const tcp, const kernel_ulong_t addr);
 928
 929 extern void print_ifindex(unsigned int);
 930
 931 extern void print_bpf_filter_code(const uint16_t code, bool extended);
 932
 933 extern void qualify(const char *);
 934 extern unsigned int qual_flags(const unsigned int);
 935
 936 #define DECL_IOCTL(name)                                                \
 937 extern int                                                              \
 938 name ## _ioctl(struct tcb *, unsigned int request, kernel_ulong_t arg)  \
 939 /* End of DECL_IOCTL definition. */
 940
 941 DECL_IOCTL(dm);
 942 DECL_IOCTL(evdev);
 943 DECL_IOCTL(file);
 944 DECL_IOCTL(fs_x);
 945 DECL_IOCTL(inotify);
 946 DECL_IOCTL(kvm);
 947 DECL_IOCTL(nsfs);
 948 DECL_IOCTL(ptp);
 949 DECL_IOCTL(scsi);
 950 DECL_IOCTL(term);
 951 DECL_IOCTL(ubi);
 952 DECL_IOCTL(uffdio);
 953 #undef DECL_IOCTL
 954
 955 extern int decode_sg_io_v4(struct tcb *, const kernel_ulong_t arg);
 956 extern void print_evdev_ff_type(const kernel_ulong_t val);
 957
 958 struct nlmsghdr;
 959
 960 typedef bool (*netlink_decoder_t)(struct tcb *, const struct nlmsghdr *,
 961                                   kernel_ulong_t addr, unsigned int len);
 962
 963 #define DECL_NETLINK(name)                                              \
 964 extern bool                                                             \
 965 decode_netlink_ ## name(struct tcb *, const struct nlmsghdr *,          \
 966                         kernel_ulong_t addr, unsigned int len)          \
 967 /* End of DECL_NETLINK definition. */
 968
 969 DECL_NETLINK(crypto);
 970 DECL_NETLINK(netfilter);
 971 DECL_NETLINK(route);
 972 DECL_NETLINK(selinux);
 973 DECL_NETLINK(sock_diag);
 974
 975 extern void
 976 decode_netlink_kobject_uevent(struct tcb *, kernel_ulong_t addr,
 977                               kernel_ulong_t len);
 978
 979 extern int ts_nz(const struct timespec *);
 980 extern int ts_cmp(const struct timespec *, const struct timespec *);
 981 extern double ts_float(const struct timespec *);
 982 extern void ts_add(struct timespec *, const struct timespec *, const struct timespec *);
 983 extern void ts_sub(struct timespec *, const struct timespec *, const struct timespec *);
 984 extern void ts_mul(struct timespec *, const struct timespec *, int);
 985 extern void ts_div(struct timespec *, const struct timespec *, int);
 986
 987 #ifdef ENABLE_STACKTRACE
 988 extern void unwind_init(void);
 989 extern void unwind_tcb_init(struct tcb *);
 990 extern void unwind_tcb_fin(struct tcb *);
 991 extern void unwind_tcb_print(struct tcb *);
 992 extern void unwind_tcb_capture(struct tcb *);
 993 #endif
 994
 995 #ifdef HAVE_LINUX_KVM_H
 996 extern void kvm_run_structure_decoder_init(void);
 997 extern void kvm_vcpu_info_free(struct tcb *);
 998 #endif
 999
1000 static inline int
1001 printstrn(struct tcb *tcp, kernel_ulong_t addr, kernel_ulong_t len)
1002 {
1003         return printstr_ex(tcp, addr, len, 0);
1004 }
1005
1006 static inline int
1007 printstr(struct tcb *tcp, kernel_ulong_t addr)
1008 {
1009         return printstr_ex(tcp, addr, -1, QUOTE_0_TERMINATED);
1010 }
1011
1012 static inline int
1013 printflags64(const struct xlat *x, uint64_t flags, const char *dflt)
1014 {
1015         return printflags_ex(flags, dflt, XLAT_STYLE_DEFAULT, x, NULL);
1016 }
1017
1018 static inline int
1019 printflags(const struct xlat *x, unsigned int flags, const char *dflt)
1020 {
1021         return printflags64(x, flags, dflt);
1022 }
1023
1024 static inline int
1025 printxval64(const struct xlat *x, const uint64_t val, const char *dflt)
1026 {
1027         return printxvals(val, dflt, x, NULL);
1028 }
1029
1030 static inline int
1031 printxval(const struct xlat *x, const unsigned int val, const char *dflt)
1032 {
1033         return printxvals(val, dflt, x, NULL);
1034 }
1035
1036 static inline int
1037 printxval64_u(const struct xlat *x, const uint64_t val, const char *dflt)
1038 {
1039         return printxvals_ex(val, dflt, XLAT_STYLE_FMT_U, x, NULL);
1040 }
1041
1042 static inline int
1043 printxval_u(const struct xlat *x, const unsigned int val, const char *dflt)
1044 {
1045         return printxvals_ex(val, dflt, XLAT_STYLE_FMT_U, x, NULL);
1046 }
1047
1048 static inline int
1049 printxval64_d(const struct xlat *x, const int64_t val, const char *dflt)
1050 {
1051         return printxvals_ex(val, dflt, XLAT_STYLE_FMT_D, x, NULL);
1052 }
1053
1054 static inline int
1055 printxval_d(const struct xlat *x, const int val, const char *dflt)
1056 {
1057         return printxvals_ex(val, dflt, XLAT_STYLE_FMT_D, x, NULL);
1058 }
1059
1060 static inline void
1061 tprint_iov(struct tcb *tcp, kernel_ulong_t len, kernel_ulong_t addr,
1062            enum iov_decode decode_iov)
1063 {
1064         tprint_iov_upto(tcp, len, addr, decode_iov, -1);
1065 }
1066
1067 #ifdef ALPHA
1068 typedef struct {
1069         int tv_sec, tv_usec;
1070 } timeval32_t;
1071
1072 extern void print_timeval32_t(const timeval32_t *);
1073 extern void printrusage32(struct tcb *, kernel_ulong_t);
1074 extern const char *sprint_timeval32(struct tcb *, kernel_ulong_t addr);
1075 extern void print_timeval32(struct tcb *, kernel_ulong_t addr);
1076 extern void print_timeval32_utimes(struct tcb *, kernel_ulong_t addr);
1077 extern void print_itimerval32(struct tcb *, kernel_ulong_t addr);
1078 #endif
1079
1080 #ifdef HAVE_STRUCT_USER_DESC
1081 /**
1082  * Filter what to print from the point of view of the get_thread_area syscall.
1083  * Kernel copies only entry_number field at first and then tries to write the
1084  * whole structure.
1085  */
1086 enum user_desc_print_filter {
1087         /* Print the "entering" part of struct user_desc - entry_number.  */
1088         USER_DESC_ENTERING = 1,
1089         /* Print the "exiting" part of the structure.  */
1090         USER_DESC_EXITING  = 2,
1091         USER_DESC_BOTH     = USER_DESC_ENTERING | USER_DESC_EXITING,
1092 };
1093
1094 extern void print_user_desc(struct tcb *, kernel_ulong_t addr,
1095                             enum user_desc_print_filter filter);
1096 #endif
1097
1098 /* Strace log generation machinery.
1099  *
1100  * printing_tcp: tcb which has incomplete line being printed right now.
1101  * NULL if last line has been completed ('\n'-terminated).
1102  * printleader(tcp) examines it, finishes incomplete line if needed,
1103  * the sets it to tcp.
1104  * line_ended() clears printing_tcp and resets ->curcol = 0.
1105  * tcp->curcol == 0 check is also used to detect completeness
1106  * of last line, since in -ff mode just checking printing_tcp for NULL
1107  * is not enough.
1108  *
1109  * If you change this code, test log generation in both -f and -ff modes
1110  * using:
1111  * strace -oLOG -f[f] test/threaded_execve
1112  * strace -oLOG -f[f] test/sigkill_rain
1113  * strace -oLOG -f[f] -p "`pidof web_browser`"
1114  */
1115 extern struct tcb *printing_tcp;
1116 extern void printleader(struct tcb *);
1117 extern void line_ended(void);
1118 extern void tabto(void);
1119 extern void tprintf(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2));
1120 extern void tprints(const char *str);
1121 extern void tprintf_comment(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2));
1122 extern void tprints_comment(const char *str);
1123
1124 static inline void
1125 printaddr_comment(const kernel_ulong_t addr)
1126 {
1127         tprintf_comment("%#llx", (unsigned long long) addr);
1128 }
1129
1130 static inline void
1131 print_mac_addr(const char *prefix, const uint8_t addr[], size_t size)
1132 {
1133         tprints(prefix);
1134         tprints(sprint_mac_addr(addr, size));
1135 }
1136
1137 #if SUPPORTED_PERSONALITIES > 1
1138 extern void set_personality(unsigned int personality);
1139 extern unsigned current_personality;
1140 #else
1141 # define set_personality(personality) ((void)0)
1142 # define current_personality 0
1143 #endif
1144
1145 #if SUPPORTED_PERSONALITIES == 1
1146 # define current_wordsize PERSONALITY0_WORDSIZE
1147 # define current_klongsize PERSONALITY0_KLONGSIZE
1148 #else
1149 # if SUPPORTED_PERSONALITIES == 2 && PERSONALITY0_WORDSIZE == PERSONALITY1_WORDSIZE
1150 #  define current_wordsize PERSONALITY0_WORDSIZE
1151 # else
1152 extern unsigned current_wordsize;
1153 # endif
1154 # if SUPPORTED_PERSONALITIES == 2 && PERSONALITY0_KLONGSIZE == PERSONALITY1_KLONGSIZE
1155 #  define current_klongsize PERSONALITY0_KLONGSIZE
1156 # else
1157 extern unsigned current_klongsize;
1158 # endif
1159 #endif
1160
1161 #define max_addr() (~0ULL >> ((8 - current_wordsize) * 8))
1162 #define max_kaddr() (~0ULL >> ((8 - current_klongsize) * 8))
1163
1164 /*
1165  * When u64 is interpreted by the kernel as an address, there is a difference
1166  * in behaviour between 32-bit and 64-bit kernel in the way u64_to_user_ptr
1167  * works (32-bit kernel trims higher bits during conversion which may result
1168  * to a valid address).  Since 32-bit strace cannot figure out what kind of
1169  * kernel the tracee is running on, it has to account for both possibilities.
1170  */
1171 #if CAN_ARCH_BE_COMPAT_ON_64BIT_KERNEL
1172
1173 /**
1174  * Print raw 64-bit value as an address if it's too big to fit in strace's
1175  * kernel_long_t.
1176  */
1177 static inline void
1178 print_big_u64_addr(const uint64_t addr)
1179 {
1180         if (sizeof(kernel_long_t) < 8 && addr > max_kaddr()) {
1181                 printaddr64(addr);
1182                 tprints(" or ");
1183         }
1184 }
1185 #else /* !CAN_ARCH_BE_COMPAT_ON_64BIT_KERNEL */
1186 # define print_big_u64_addr(addr_) ((void) 0)
1187 #endif /* CAN_ARCH_BE_COMPAT_ON_64BIT_KERNEL */
1188
1189 #if SIZEOF_KERNEL_LONG_T > 4            \
1190  && (SIZEOF_LONG < SIZEOF_KERNEL_LONG_T || !defined(current_wordsize))
1191 # define ANY_WORDSIZE_LESS_THAN_KERNEL_LONG     1
1192 #else
1193 # define ANY_WORDSIZE_LESS_THAN_KERNEL_LONG     0
1194 #endif
1195
1196 #define DECL_PRINTNUM(name)                                             \
1197 extern bool                                                             \
1198 printnum_ ## name(struct tcb *, kernel_ulong_t addr, const char *fmt)   \
1199         ATTRIBUTE_FORMAT((printf, 3, 0))                                \
1200 /* End of DECL_PRINTNUM definition. */
1201
1202 DECL_PRINTNUM(short);
1203 DECL_PRINTNUM(int);
1204 DECL_PRINTNUM(int64);
1205 #undef DECL_PRINTNUM
1206
1207 #define DECL_PRINTNUM_ADDR(name)                                        \
1208 extern bool                                                             \
1209 printnum_addr_ ## name(struct tcb *, kernel_ulong_t addr)               \
1210 /* End of DECL_PRINTNUM_ADDR definition. */
1211
1212 DECL_PRINTNUM_ADDR(int);
1213 DECL_PRINTNUM_ADDR(int64);
1214 #undef DECL_PRINTNUM_ADDR
1215
1216 #ifndef current_wordsize
1217 extern bool
1218 printnum_long_int(struct tcb *, kernel_ulong_t addr,
1219                   const char *fmt_long, const char *fmt_int)
1220         ATTRIBUTE_FORMAT((printf, 3, 0))
1221         ATTRIBUTE_FORMAT((printf, 4, 0));
1222
1223 extern bool printnum_addr_long_int(struct tcb *, kernel_ulong_t addr);
1224
1225 static inline bool
1226 printnum_slong(struct tcb *tcp, kernel_ulong_t addr)
1227 {
1228         return printnum_long_int(tcp, addr, "%" PRId64, "%d");
1229 }
1230
1231 static inline bool
1232 printnum_ulong(struct tcb *tcp, kernel_ulong_t addr)
1233 {
1234         return printnum_long_int(tcp, addr, "%" PRIu64, "%u");
1235 }
1236
1237 static inline bool
1238 printnum_ptr(struct tcb *tcp, kernel_ulong_t addr)
1239 {
1240         return printnum_addr_long_int(tcp, addr);
1241 }
1242
1243 #elif current_wordsize > 4
1244
1245 static inline bool
1246 printnum_slong(struct tcb *tcp, kernel_ulong_t addr)
1247 {
1248         return printnum_int64(tcp, addr, "%" PRId64);
1249 }
1250
1251 static inline bool
1252 printnum_ulong(struct tcb *tcp, kernel_ulong_t addr)
1253 {
1254         return printnum_int64(tcp, addr, "%" PRIu64);
1255 }
1256
1257 static inline bool
1258 printnum_ptr(struct tcb *tcp, kernel_ulong_t addr)
1259 {
1260         return printnum_addr_int64(tcp, addr);
1261 }
1262
1263 #else /* current_wordsize == 4 */
1264
1265 static inline bool
1266 printnum_slong(struct tcb *tcp, kernel_ulong_t addr)
1267 {
1268         return printnum_int(tcp, addr, "%d");
1269 }
1270
1271 static inline bool
1272 printnum_ulong(struct tcb *tcp, kernel_ulong_t addr)
1273 {
1274         return printnum_int(tcp, addr, "%u");
1275 }
1276
1277 static inline bool
1278 printnum_ptr(struct tcb *tcp, kernel_ulong_t addr)
1279 {
1280         return printnum_addr_int(tcp, addr);
1281 }
1282
1283 #endif
1284
1285 #ifndef current_klongsize
1286 extern bool printnum_addr_klong_int(struct tcb *, kernel_ulong_t addr);
1287
1288 static inline bool
1289 printnum_kptr(struct tcb *tcp, kernel_ulong_t addr)
1290 {
1291         return printnum_addr_klong_int(tcp, addr);
1292 }
1293
1294 #elif current_klongsize > 4
1295
1296 static inline bool
1297 printnum_kptr(struct tcb *tcp, kernel_ulong_t addr)
1298 {
1299         return printnum_addr_int64(tcp, addr);
1300 }
1301
1302 #else /* current_klongsize == 4 */
1303
1304 static inline bool
1305 printnum_kptr(struct tcb *tcp, kernel_ulong_t addr)
1306 {
1307         return printnum_addr_int(tcp, addr);
1308 }
1309
1310 #endif
1311
1312 #define DECL_PRINTPAIR(name)                                            \
1313 extern bool                                                             \
1314 printpair_ ## name(struct tcb *, kernel_ulong_t addr, const char *fmt)  \
1315         ATTRIBUTE_FORMAT((printf, 3, 0))                                \
1316 /* End of DECL_PRINTPAIR definition. */
1317
1318 DECL_PRINTPAIR(int);
1319 DECL_PRINTPAIR(int64);
1320 #undef DECL_PRINTPAIR
1321
1322 static inline kernel_long_t
1323 truncate_klong_to_current_wordsize(const kernel_long_t v)
1324 {
1325 #if ANY_WORDSIZE_LESS_THAN_KERNEL_LONG
1326         if (current_wordsize < sizeof(v)) {
1327                 return (int) v;
1328         } else
1329 #endif
1330         {
1331                 return v;
1332         }
1333 }
1334
1335 static inline kernel_ulong_t
1336 truncate_kulong_to_current_wordsize(const kernel_ulong_t v)
1337 {
1338 #if ANY_WORDSIZE_LESS_THAN_KERNEL_LONG
1339         if (current_wordsize < sizeof(v)) {
1340                 return (unsigned int) v;
1341         } else
1342 #endif
1343         {
1344                 return v;
1345         }
1346 }
1347
1348 /*
1349  * Cast a pointer or a pointer-sized integer to kernel_ulong_t.
1350  */
1351 #define ptr_to_kulong(v) ((kernel_ulong_t) (unsigned long) (v))
1352
1353 /*
1354  * Zero-extend a signed integer type to unsigned long long.
1355  */
1356 #define zero_extend_signed_to_ull(v) \
1357         (sizeof(v) == sizeof(char) ? (unsigned long long) (unsigned char) (v) : \
1358          sizeof(v) == sizeof(short) ? (unsigned long long) (unsigned short) (v) : \
1359          sizeof(v) == sizeof(int) ? (unsigned long long) (unsigned int) (v) : \
1360          sizeof(v) == sizeof(long) ? (unsigned long long) (unsigned long) (v) : \
1361          (unsigned long long) (v))
1362
1363 /*
1364  * Sign-extend an unsigned integer type to long long.
1365  */
1366 #define sign_extend_unsigned_to_ll(v) \
1367         (sizeof(v) == sizeof(char) ? (long long) (char) (v) : \
1368          sizeof(v) == sizeof(short) ? (long long) (short) (v) : \
1369          sizeof(v) == sizeof(int) ? (long long) (int) (v) : \
1370          sizeof(v) == sizeof(long) ? (long long) (long) (v) : \
1371          (long long) (v))
1372
1373 extern const char *const errnoent[];
1374 extern const char *const signalent[];
1375 extern const unsigned int nerrnos;
1376 extern const unsigned int nsignals;
1377
1378 extern const struct_sysent sysent0[];
1379 extern const struct_ioctlent ioctlent0[];
1380
1381 extern const char *const personality_names[];
1382 /* Personality designators to be used for specifying personality */
1383 extern const char *const personality_designators[];
1384
1385 #if SUPPORTED_PERSONALITIES > 1
1386 extern const struct_sysent *sysent;
1387 extern const struct_ioctlent *ioctlent;
1388 #else
1389 # define sysent     sysent0
1390 # define ioctlent   ioctlent0
1391 #endif
1392
1393 extern unsigned nsyscalls;
1394 extern unsigned nioctlents;
1395
1396 extern const unsigned int nsyscall_vec[SUPPORTED_PERSONALITIES];
1397 extern const struct_sysent *const sysent_vec[SUPPORTED_PERSONALITIES];
1398 extern struct inject_opts *inject_vec[SUPPORTED_PERSONALITIES];
1399
1400 #ifdef IN_MPERS_BOOTSTRAP
1401 /* Transform multi-line MPERS_PRINTER_DECL statements to one-liners.  */
1402 # define MPERS_PRINTER_DECL(type, name, ...) MPERS_PRINTER_DECL(type, name, __VA_ARGS__)
1403 #else /* !IN_MPERS_BOOTSTRAP */
1404 # if SUPPORTED_PERSONALITIES > 1
1405 #  include "printers.h"
1406 # else
1407 #  include "native_printer_decls.h"
1408 # endif
1409 # define MPERS_PRINTER_DECL(type, name, ...) type MPERS_FUNC_NAME(name)(__VA_ARGS__)
1410 #endif /* !IN_MPERS_BOOTSTRAP */
1411
1412 /* Checks that sysent[scno] is not out of range. */
1413 static inline bool
1414 scno_in_range(kernel_ulong_t scno)
1415 {
1416         return scno < nsyscalls;
1417 }
1418
1419 /*
1420  * Checks whether scno is not out of range,
1421  * its corresponding sysent[scno].sys_func is non-NULL,
1422  * and its sysent[scno].sys_flags has no TRACE_INDIRECT_SUBCALL flag set.
1423  */
1424 static inline bool
1425 scno_is_valid(kernel_ulong_t scno)
1426 {
1427         return scno_in_range(scno)
1428                && sysent[scno].sys_func
1429                && !(sysent[scno].sys_flags & TRACE_INDIRECT_SUBCALL);
1430 }
1431
1432 #define MPERS_FUNC_NAME__(prefix, name) prefix ## name
1433 #define MPERS_FUNC_NAME_(prefix, name) MPERS_FUNC_NAME__(prefix, name)
1434 #define MPERS_FUNC_NAME(name) MPERS_FUNC_NAME_(MPERS_PREFIX, name)
1435
1436 #define SYS_FUNC_NAME(syscall_name) MPERS_FUNC_NAME(syscall_name)
1437
1438 #define SYS_FUNC(syscall_name) int SYS_FUNC_NAME(sys_ ## syscall_name)(struct tcb *tcp)
1439
1440 #endif /* !STRACE_DEFS_H */