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