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 0 on success, -1 on error (and print addr).
 477  */
 478 extern int
 479 umoven_or_printaddr64(struct tcb *, uint64_t addr,
 480                       unsigned int len, void *laddr);
 481 #define umove_or_printaddr64(pid, addr, objp)   \
 482         umoven_or_printaddr64((pid), (addr), sizeof(*(objp)), (void *) (objp))
 483
 484 static inline int
 485 umoven_or_printaddr(struct tcb *tcp, const kernel_ulong_t addr,
 486                     unsigned int len, void *laddr)
 487 {
 488         return umoven_or_printaddr64(tcp, addr, len, laddr);
 489 }
 490 #define umove_or_printaddr(pid, addr, objp)     \
 491         umoven_or_printaddr((pid), (addr), sizeof(*(objp)), (void *) (objp))
 492
 493 /**
 494  * @return 0 on success, -1 on error (and print addr).
 495  */
 496 extern int
 497 umoven_or_printaddr64_ignore_syserror(struct tcb *, uint64_t addr,
 498                                       unsigned int len, void *laddr);
 499 #define umove_or_printaddr64_ignore_syserror(pid, addr, objp)   \
 500         umoven_or_printaddr64_ignore_syserror((pid), (addr), sizeof(*(objp)), \
 501                                               (void *) (objp))
 502
 503 static inline int
 504 umoven_or_printaddr_ignore_syserror(struct tcb *tcp, const kernel_ulong_t addr,
 505                                     unsigned int len, void *laddr)
 506 {
 507         return umoven_or_printaddr64_ignore_syserror(tcp, addr, len, laddr);
 508 }
 509 #define umove_or_printaddr_ignore_syserror(pid, addr, objp)     \
 510         umoven_or_printaddr_ignore_syserror((pid), (addr), sizeof(*(objp)), \
 511                                             (void *) (objp))
 512
 513 /**
 514  * @return strlen + 1 on success, 0 on success and no NUL seen, -1 on error.
 515  */
 516 extern int
 517 umovestr(struct tcb *, kernel_ulong_t addr, unsigned int len, char *laddr);
 518
 519 extern int upeek(struct tcb *tcp, unsigned long, kernel_ulong_t *);
 520 extern int upoke(struct tcb *tcp, unsigned long, kernel_ulong_t);
 521
 522 #if HAVE_ARCH_GETRVAL2
 523 extern long getrval2(struct tcb *);
 524 #endif
 525
 526 extern const char *signame(const int);
 527 extern void pathtrace_select_set(const char *, struct path_set *);
 528 extern bool pathtrace_match_set(struct tcb *, struct path_set *);
 529
 530 static inline void
 531 pathtrace_select(const char *path)
 532 {
 533         return pathtrace_select_set(path, &global_path_set);
 534 }
 535
 536 static inline bool
 537 pathtrace_match(struct tcb *tcp)
 538 {
 539         return pathtrace_match_set(tcp, &global_path_set);
 540 }
 541
 542 extern int getfdpath(struct tcb *, int, char *, unsigned);
 543 extern unsigned long getfdinode(struct tcb *, int);
 544 extern enum sock_proto getfdproto(struct tcb *, int);
 545
 546 extern const char *xlookup(const struct xlat *, const uint64_t);
 547 extern const char *xlat_search(const struct xlat *, const size_t, const uint64_t);
 548 extern const char *xlat_idx(const struct xlat *xlat, size_t nmemb, uint64_t val);
 549
 550 struct dyxlat;
 551 struct dyxlat *dyxlat_alloc(size_t nmemb);
 552 void dyxlat_free(struct dyxlat *);
 553 const struct xlat *dyxlat_get(const struct dyxlat *);
 554 void dyxlat_add_pair(struct dyxlat *, uint64_t val, const char *str, size_t len);
 555
 556 const struct xlat *genl_families_xlat(struct tcb *tcp);
 557
 558 extern unsigned long get_pagesize(void);
 559 extern int next_set_bit(const void *bit_array, unsigned cur_bit, unsigned size_bits);
 560
 561 /*
 562  * Returns STR if it does not start with PREFIX,
 563  * or a pointer to the first char in STR after PREFIX.
 564  * The length of PREFIX is specified by PREFIX_LEN.
 565  */
 566 static inline const char *
 567 str_strip_prefix_len(const char *str, const char *prefix, size_t prefix_len)
 568 {
 569         return strncmp(str, prefix, prefix_len) ? str : str + prefix_len;
 570 }
 571
 572 #define STR_STRIP_PREFIX(str, prefix)   \
 573         str_strip_prefix_len((str), (prefix), sizeof(prefix) - 1)
 574
 575 #define QUOTE_0_TERMINATED                      0x01
 576 #define QUOTE_OMIT_LEADING_TRAILING_QUOTES      0x02
 577 #define QUOTE_OMIT_TRAILING_0                   0x08
 578 #define QUOTE_FORCE_HEX                         0x10
 579 #define QUOTE_EMIT_COMMENT                      0x20
 580
 581 extern int string_quote(const char *, char *, unsigned int, unsigned int,
 582                         const char *escape_chars);
 583 extern int print_quoted_string_ex(const char *, unsigned int, unsigned int,
 584                                   const char *escape_chars);
 585 extern int print_quoted_string(const char *, unsigned int, unsigned int);
 586 extern int print_quoted_cstring(const char *, unsigned int);
 587
 588 /* a refers to the lower numbered u_arg,
 589  * b refers to the higher numbered u_arg
 590  */
 591 #ifdef WORDS_BIGENDIAN
 592 # define ULONG_LONG(a, b) \
 593         ((unsigned long long)(unsigned)(b) | ((unsigned long long)(a)<<32))
 594 #else
 595 # define ULONG_LONG(a, b) \
 596         ((unsigned long long)(unsigned)(a) | ((unsigned long long)(b)<<32))
 597 #endif
 598 extern int getllval(struct tcb *, unsigned long long *, int);
 599 extern int printllval(struct tcb *, const char *, int)
 600         ATTRIBUTE_FORMAT((printf, 2, 0));
 601
 602 extern void printaddr64(uint64_t addr);
 603
 604 static inline void
 605 printaddr(const kernel_ulong_t addr)
 606 {
 607         printaddr64(addr);
 608 }
 609
 610 #define XLAT_STYLE_VERBOSITY_MASK (XLAT_STYLE_RAW | XLAT_STYLE_ABBREV)
 611 #define XLAT_STYLE_FORMAT_SHIFT   2
 612 #define XLAT_STYLE_FORMAT_MASK    (3 << XLAT_STYLE_FORMAT_SHIFT)
 613
 614 #define xlat_verbose(style_) ((style_) & XLAT_STYLE_VERBOSITY_MASK)
 615 #define xlat_format(style_)  ((style_) & XLAT_STYLE_FORMAT_MASK)
 616
 617 enum xlat_type {
 618         XT_NORMAL,
 619         XT_SORTED,
 620         XT_INDEXED,
 621 };
 622
 623 enum xlat_style {
 624         /**
 625          * Special value that is used for passing to *print{xval,flags}*_ex
 626          * routines that indicates that no overriding of user-supplied xlat
 627          * verbosity/formatting configuration is intended.
 628          */
 629         XLAT_STYLE_DEFAULT = 0,
 630
 631         /** Print xlat value as is without xlat processing */
 632         XLAT_STYLE_RAW     = 1 << 0,
 633         /**
 634          * Historic strace style, process xlat and print the result (xlat
 635          * constant name/combination of flags), raw number only if nothing is
 636          * found.
 637          */
 638         XLAT_STYLE_ABBREV  = 1 << 1,
 639         /** Always print both raw number and xlat processing result. */
 640         XLAT_STYLE_VERBOSE = XLAT_STYLE_RAW | XLAT_STYLE_ABBREV,
 641
 642         XLAT_STYLE_FMT_X   = 0 << XLAT_STYLE_FORMAT_SHIFT,
 643         XLAT_STYLE_FMT_U   = 1 << XLAT_STYLE_FORMAT_SHIFT,
 644         XLAT_STYLE_FMT_D   = 2 << XLAT_STYLE_FORMAT_SHIFT,
 645 };
 646
 647 extern enum xlat_style xlat_verbosity;
 648
 649 extern int printxvals_ex(uint64_t val, const char *dflt,
 650                          enum xlat_style, const struct xlat *, ...)
 651         ATTRIBUTE_SENTINEL;
 652 #define printxvals(val_, dflt_, ...) \
 653         printxvals_ex((val_), (dflt_), XLAT_STYLE_DEFAULT, __VA_ARGS__)
 654
 655 extern int printxval_searchn_ex(const struct xlat *, size_t xlat_size,
 656                                 uint64_t val, const char *dflt,
 657                                 enum xlat_style);
 658
 659 static inline int
 660 printxval_searchn(const struct xlat *xlat, size_t xlat_size, uint64_t val,
 661                   const char *dflt)
 662 {
 663         return printxval_searchn_ex(xlat, xlat_size, val, dflt,
 664                                     XLAT_STYLE_DEFAULT);
 665 }
 666
 667 /**
 668  * Wrapper around printxval_searchn that passes ARRAY_SIZE - 1
 669  * as the array size, as all arrays are XLAT_END-terminated and
 670  * printxval_searchn expects a size without the terminating record.
 671  */
 672 #define printxval_search(xlat__, val__, dflt__) \
 673         printxval_searchn(xlat__, ARRAY_SIZE(xlat__) - 1, val__, dflt__)
 674 #define printxval_search_ex(xlat__, val__, dflt__) \
 675         printxval_searchn_ex((xlat__), ARRAY_SIZE(xlat__) - 1, (val__), \
 676                              (dflt__), XLAT_STYLE_DEFAULT)
 677
 678 extern int printxval_indexn_ex(const struct xlat *, size_t xlat_size,
 679                                uint64_t val, const char *dflt, enum xlat_style);
 680
 681 static inline int
 682 printxval_indexn(const struct xlat *xlat, size_t xlat_size, uint64_t val,
 683                  const char *dflt)
 684 {
 685         return printxval_indexn_ex(xlat, xlat_size, val, dflt,
 686                                    XLAT_STYLE_DEFAULT);
 687 }
 688
 689 #define printxval_index(xlat__, val__, dflt__) \
 690         printxval_indexn(xlat__, ARRAY_SIZE(xlat__) - 1, val__, dflt__)
 691 #define printxval_index_ex(xlat__, val__, dflt__) \
 692         printxval_indexn_ex((xlat__), ARRAY_SIZE(xlat__) - 1, (val__), \
 693                             (dflt__), XLAT_STYLE_DEFAULT)
 694
 695 extern int sprintxval_ex(char *buf, size_t size, const struct xlat *,
 696                          unsigned int val, const char *dflt, enum xlat_style);
 697
 698 static inline int
 699 sprintxval(char *buf, size_t size, const struct xlat *xlat, unsigned int val,
 700            const char *dflt)
 701 {
 702         return sprintxval_ex(buf, size, xlat, val, dflt, XLAT_STYLE_DEFAULT);
 703 }
 704
 705 extern void printxval_dispatch_ex(const struct xlat *, size_t xlat_size,
 706                                   uint64_t val, const char *dflt,
 707                                   enum xlat_type, enum xlat_style);
 708 static inline void
 709 printxval_dispatch(const struct xlat *xlat, size_t xlat_size, uint64_t val,
 710                    const char *dflt, enum xlat_type xt)
 711 {
 712         return printxval_dispatch_ex(xlat, xlat_size, val, dflt, xt,
 713                                      XLAT_STYLE_DEFAULT);
 714 }
 715
 716 /** Print a value in accordance with xlat formatting settings. */
 717 extern void print_xlat_ex(uint64_t val, const char *str, enum xlat_style style);
 718 #define print_xlat(val_) \
 719         print_xlat_ex((val_), #val_, XLAT_STYLE_DEFAULT)
 720 #define print_xlat32(val_) \
 721         print_xlat_ex((uint32_t) (val_), #val_, XLAT_STYLE_DEFAULT)
 722 #define print_xlat_u(val_) \
 723         print_xlat_ex((val_), #val_, XLAT_STYLE_FMT_U)
 724 #define print_xlat_d(val_) \
 725         print_xlat_ex((val_), #val_, XLAT_STYLE_FMT_D)
 726
 727 extern int printargs(struct tcb *);
 728 extern int printargs_u(struct tcb *);
 729 extern int printargs_d(struct tcb *);
 730
 731 extern int printflags_ex(uint64_t flags, const char *dflt,
 732                          enum xlat_style, const struct xlat *, ...)
 733         ATTRIBUTE_SENTINEL;
 734 extern const char *sprintflags_ex(const char *prefix, const struct xlat *,
 735                                   uint64_t flags, enum xlat_style);
 736
 737 static inline const char *
 738 sprintflags(const char *prefix, const struct xlat *xlat, uint64_t flags)
 739 {
 740         return sprintflags_ex(prefix, xlat, flags, XLAT_STYLE_DEFAULT);
 741 }
 742
 743 extern const char *sprinttime(long long sec);
 744 extern const char *sprinttime_nsec(long long sec, unsigned long long nsec);
 745 extern const char *sprinttime_usec(long long sec, unsigned long long usec);
 746
 747 extern const char *sprint_mac_addr(const uint8_t addr[], size_t size);
 748
 749 extern void print_symbolic_mode_t(unsigned int);
 750 extern void print_numeric_umode_t(unsigned short);
 751 extern void print_numeric_long_umask(unsigned long);
 752 extern void print_dev_t(unsigned long long dev);
 753 extern void print_abnormal_hi(kernel_ulong_t);
 754
 755 extern bool print_int32_array_member(struct tcb *, void *elem_buf,
 756                                      size_t elem_size, void *data);
 757 extern bool print_uint32_array_member(struct tcb *, void *elem_buf,
 758                                       size_t elem_size, void *data);
 759 extern bool print_uint64_array_member(struct tcb *, void *elem_buf,
 760                                       size_t elem_size, void *data);
 761
 762 extern bool
 763 print_array(struct tcb *,
 764             kernel_ulong_t start_addr,
 765             size_t nmemb,
 766             void *elem_buf,
 767             size_t elem_size,
 768             int (*umoven_func)(struct tcb *,
 769                                      kernel_ulong_t,
 770                                      unsigned int,
 771                                      void *),
 772             bool (*print_func)(struct tcb *,
 773                                      void *elem_buf,
 774                                      size_t elem_size,
 775                                      void *opaque_data),
 776             void *opaque_data);
 777
 778 extern kernel_ulong_t *
 779 fetch_indirect_syscall_args(struct tcb *, kernel_ulong_t addr, unsigned int n_args);
 780
 781 extern void
 782 dumpiov_in_msghdr(struct tcb *, kernel_ulong_t addr, kernel_ulong_t data_size);
 783
 784 extern void
 785 dumpiov_in_mmsghdr(struct tcb *, kernel_ulong_t addr);
 786
 787 extern void
 788 dumpiov_upto(struct tcb *, int len, kernel_ulong_t addr, kernel_ulong_t data_size);
 789
 790 extern void
 791 dumpstr(struct tcb *, kernel_ulong_t addr, int len);
 792
 793 extern int
 794 printstr_ex(struct tcb *, kernel_ulong_t addr, kernel_ulong_t len,
 795             unsigned int user_style);
 796
 797 extern int
 798 printpathn(struct tcb *, kernel_ulong_t addr, unsigned int n);
 799
 800 extern int
 801 printpath(struct tcb *, kernel_ulong_t addr);
 802
 803 #define TIMESPEC_TEXT_BUFSIZE \
 804                 (sizeof(long long) * 3 * 2 + sizeof("{tv_sec=-, tv_nsec=}"))
 805 extern void printfd(struct tcb *, int);
 806 extern void print_sockaddr(const void *sa, int len);
 807 extern bool
 808 print_inet_addr(int af, const void *addr, unsigned int len, const char *var_name);
 809 extern bool
 810 decode_inet_addr(struct tcb *, kernel_ulong_t addr,
 811                  unsigned int len, int family, const char *var_name);
 812 extern const char *get_sockaddr_by_inode(struct tcb *, int fd, unsigned long inode);
 813 extern bool print_sockaddr_by_inode(struct tcb *, int fd, unsigned long inode);
 814 extern void print_dirfd(struct tcb *, int);
 815
 816 extern int
 817 decode_sockaddr(struct tcb *, kernel_ulong_t addr, int addrlen);
 818
 819 extern void printuid(const char *, const unsigned int);
 820
 821 extern void
 822 print_sigset_addr_len(struct tcb *, kernel_ulong_t addr, kernel_ulong_t len);
 823 extern void
 824 print_sigset_addr(struct tcb *, kernel_ulong_t addr);
 825
 826 extern const char *sprintsigmask_n(const char *, const void *, unsigned int);
 827 #define tprintsigmask_addr(prefix, mask) \
 828         tprints(sprintsigmask_n((prefix), (mask), sizeof(mask)))
 829 extern void printsignal(int);
 830
 831 extern void
 832 tprint_iov_upto(struct tcb *, kernel_ulong_t len, kernel_ulong_t addr,
 833                 enum iov_decode, kernel_ulong_t data_size);
 834
 835 extern void
 836 decode_netlink(struct tcb *, int fd, kernel_ulong_t addr, kernel_ulong_t len);
 837
 838 extern void tprint_open_modes(unsigned int);
 839 extern const char *sprint_open_modes(unsigned int);
 840
 841 extern void
 842 decode_seccomp_fprog(struct tcb *, kernel_ulong_t addr);
 843
 844 extern void
 845 print_seccomp_fprog(struct tcb *, kernel_ulong_t addr, unsigned short len);
 846
 847 extern void
 848 decode_sock_fprog(struct tcb *, kernel_ulong_t addr);
 849
 850 extern void
 851 print_sock_fprog(struct tcb *, kernel_ulong_t addr, unsigned short len);
 852
 853 struct strace_stat;
 854 extern void print_struct_stat(struct tcb *, const struct strace_stat *const st);
 855
 856 struct strace_statfs;
 857 struct strace_keyctl_kdf_params;
 858
 859 extern void
 860 print_struct_statfs(struct tcb *, kernel_ulong_t addr);
 861
 862 extern void
 863 print_struct_statfs64(struct tcb *, kernel_ulong_t addr, kernel_ulong_t size);
 864
 865 extern int
 866 fetch_perf_event_attr(struct tcb *const tcp, const kernel_ulong_t addr);
 867 extern void
 868 print_perf_event_attr(struct tcb *const tcp, const kernel_ulong_t addr);
 869
 870 extern void print_ifindex(unsigned int);
 871
 872 extern void print_bpf_filter_code(const uint16_t code, bool extended);
 873
 874 extern void qualify(const char *);
 875 extern unsigned int qual_flags(const unsigned int);
 876
 877 #define DECL_IOCTL(name)                                                \
 878 extern int                                                              \
 879 name ## _ioctl(struct tcb *, unsigned int request, kernel_ulong_t arg)  \
 880 /* End of DECL_IOCTL definition. */
 881
 882 DECL_IOCTL(dm);
 883 DECL_IOCTL(evdev);
 884 DECL_IOCTL(file);
 885 DECL_IOCTL(fs_x);
 886 DECL_IOCTL(inotify);
 887 DECL_IOCTL(kvm);
 888 DECL_IOCTL(nsfs);
 889 DECL_IOCTL(ptp);
 890 DECL_IOCTL(scsi);
 891 DECL_IOCTL(term);
 892 DECL_IOCTL(ubi);
 893 DECL_IOCTL(uffdio);
 894 #undef DECL_IOCTL
 895
 896 extern int decode_sg_io_v4(struct tcb *, const kernel_ulong_t arg);
 897 extern void print_evdev_ff_type(const kernel_ulong_t val);
 898
 899 struct nlmsghdr;
 900
 901 typedef bool (*netlink_decoder_t)(struct tcb *, const struct nlmsghdr *,
 902                                   kernel_ulong_t addr, unsigned int len);
 903
 904 #define DECL_NETLINK(name)                                              \
 905 extern bool                                                             \
 906 decode_netlink_ ## name(struct tcb *, const struct nlmsghdr *,          \
 907                         kernel_ulong_t addr, unsigned int len)          \
 908 /* End of DECL_NETLINK definition. */
 909
 910 DECL_NETLINK(crypto);
 911 DECL_NETLINK(netfilter);
 912 DECL_NETLINK(route);
 913 DECL_NETLINK(selinux);
 914 DECL_NETLINK(sock_diag);
 915
 916 extern void
 917 decode_netlink_kobject_uevent(struct tcb *, kernel_ulong_t addr,
 918                               kernel_ulong_t len);
 919
 920 extern int ts_nz(const struct timespec *);
 921 extern int ts_cmp(const struct timespec *, const struct timespec *);
 922 extern double ts_float(const struct timespec *);
 923 extern void ts_add(struct timespec *, const struct timespec *, const struct timespec *);
 924 extern void ts_sub(struct timespec *, const struct timespec *, const struct timespec *);
 925 extern void ts_mul(struct timespec *, const struct timespec *, int);
 926 extern void ts_div(struct timespec *, const struct timespec *, int);
 927
 928 #ifdef ENABLE_STACKTRACE
 929 extern void unwind_init(void);
 930 extern void unwind_tcb_init(struct tcb *);
 931 extern void unwind_tcb_fin(struct tcb *);
 932 extern void unwind_tcb_print(struct tcb *);
 933 extern void unwind_tcb_capture(struct tcb *);
 934 #endif
 935
 936 static inline int
 937 printstrn(struct tcb *tcp, kernel_ulong_t addr, kernel_ulong_t len)
 938 {
 939         return printstr_ex(tcp, addr, len, 0);
 940 }
 941
 942 static inline int
 943 printstr(struct tcb *tcp, kernel_ulong_t addr)
 944 {
 945         return printstr_ex(tcp, addr, -1, QUOTE_0_TERMINATED);
 946 }
 947
 948 static inline int
 949 printflags64(const struct xlat *x, uint64_t flags, const char *dflt)
 950 {
 951         return printflags_ex(flags, dflt, XLAT_STYLE_DEFAULT, x, NULL);
 952 }
 953
 954 static inline int
 955 printflags(const struct xlat *x, unsigned int flags, const char *dflt)
 956 {
 957         return printflags64(x, flags, dflt);
 958 }
 959
 960 static inline int
 961 printxval64(const struct xlat *x, const uint64_t val, const char *dflt)
 962 {
 963         return printxvals(val, dflt, x, NULL);
 964 }
 965
 966 static inline int
 967 printxval(const struct xlat *x, const unsigned int val, const char *dflt)
 968 {
 969         return printxvals(val, dflt, x, NULL);
 970 }
 971
 972 static inline int
 973 printxval64_u(const struct xlat *x, const uint64_t val, const char *dflt)
 974 {
 975         return printxvals_ex(val, dflt, XLAT_STYLE_FMT_U, x, NULL);
 976 }
 977
 978 static inline int
 979 printxval_u(const struct xlat *x, const unsigned int val, const char *dflt)
 980 {
 981         return printxvals_ex(val, dflt, XLAT_STYLE_FMT_U, x, NULL);
 982 }
 983
 984 static inline int
 985 printxval64_d(const struct xlat *x, const int64_t val, const char *dflt)
 986 {
 987         return printxvals_ex(val, dflt, XLAT_STYLE_FMT_D, x, NULL);
 988 }
 989
 990 static inline int
 991 printxval_d(const struct xlat *x, const int val, const char *dflt)
 992 {
 993         return printxvals_ex(val, dflt, XLAT_STYLE_FMT_D, x, NULL);
 994 }
 995
 996 static inline void
 997 tprint_iov(struct tcb *tcp, kernel_ulong_t len, kernel_ulong_t addr,
 998            enum iov_decode decode_iov)
 999 {
1000         tprint_iov_upto(tcp, len, addr, decode_iov, -1);
1001 }
1002
1003 #ifdef ALPHA
1004 typedef struct {
1005         int tv_sec, tv_usec;
1006 } timeval32_t;
1007
1008 extern void print_timeval32_t(const timeval32_t *);
1009 extern void printrusage32(struct tcb *, kernel_ulong_t);
1010 extern const char *sprint_timeval32(struct tcb *, kernel_ulong_t addr);
1011 extern void print_timeval32(struct tcb *, kernel_ulong_t addr);
1012 extern void print_timeval32_utimes(struct tcb *, kernel_ulong_t addr);
1013 extern void print_itimerval32(struct tcb *, kernel_ulong_t addr);
1014 #endif
1015
1016 #ifdef HAVE_STRUCT_USER_DESC
1017 /**
1018  * Filter what to print from the point of view of the get_thread_area syscall.
1019  * Kernel copies only entry_number field at first and then tries to write the
1020  * whole structure.
1021  */
1022 enum user_desc_print_filter {
1023         /* Print the "entering" part of struct user_desc - entry_number.  */
1024         USER_DESC_ENTERING = 1,
1025         /* Print the "exiting" part of the structure.  */
1026         USER_DESC_EXITING  = 2,
1027         USER_DESC_BOTH     = USER_DESC_ENTERING | USER_DESC_EXITING,
1028 };
1029
1030 extern void print_user_desc(struct tcb *, kernel_ulong_t addr,
1031                             enum user_desc_print_filter filter);
1032 #endif
1033
1034 /* Strace log generation machinery.
1035  *
1036  * printing_tcp: tcb which has incomplete line being printed right now.
1037  * NULL if last line has been completed ('\n'-terminated).
1038  * printleader(tcp) examines it, finishes incomplete line if needed,
1039  * the sets it to tcp.
1040  * line_ended() clears printing_tcp and resets ->curcol = 0.
1041  * tcp->curcol == 0 check is also used to detect completeness
1042  * of last line, since in -ff mode just checking printing_tcp for NULL
1043  * is not enough.
1044  *
1045  * If you change this code, test log generation in both -f and -ff modes
1046  * using:
1047  * strace -oLOG -f[f] test/threaded_execve
1048  * strace -oLOG -f[f] test/sigkill_rain
1049  * strace -oLOG -f[f] -p "`pidof web_browser`"
1050  */
1051 extern struct tcb *printing_tcp;
1052 extern void printleader(struct tcb *);
1053 extern void line_ended(void);
1054 extern void tabto(void);
1055 extern void tprintf(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2));
1056 extern void tprints(const char *str);
1057 extern void tprintf_comment(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2));
1058 extern void tprints_comment(const char *str);
1059
1060 static inline void
1061 print_mac_addr(const char *prefix, const uint8_t addr[], size_t size)
1062 {
1063         tprints(prefix);
1064         tprints(sprint_mac_addr(addr, size));
1065 }
1066
1067 #if SUPPORTED_PERSONALITIES > 1
1068 extern void set_personality(unsigned int personality);
1069 extern unsigned current_personality;
1070 #else
1071 # define set_personality(personality) ((void)0)
1072 # define current_personality 0
1073 #endif
1074
1075 #if SUPPORTED_PERSONALITIES == 1
1076 # define current_wordsize PERSONALITY0_WORDSIZE
1077 # define current_klongsize PERSONALITY0_KLONGSIZE
1078 #else
1079 # if SUPPORTED_PERSONALITIES == 2 && PERSONALITY0_WORDSIZE == PERSONALITY1_WORDSIZE
1080 #  define current_wordsize PERSONALITY0_WORDSIZE
1081 # else
1082 extern unsigned current_wordsize;
1083 # endif
1084 # if SUPPORTED_PERSONALITIES == 2 && PERSONALITY0_KLONGSIZE == PERSONALITY1_KLONGSIZE
1085 #  define current_klongsize PERSONALITY0_KLONGSIZE
1086 # else
1087 extern unsigned current_klongsize;
1088 # endif
1089 #endif
1090
1091 #define max_addr() (~0ULL >> ((8 - current_wordsize) * 8))
1092 #define max_kaddr() (~0ULL >> ((8 - current_klongsize) * 8))
1093
1094 /*
1095  * When u64 is interpreted by the kernel as an address, there is a difference
1096  * in behaviour between 32-bit and 64-bit kernel in the way u64_to_user_ptr
1097  * works (32-bit kernel trims higher bits during conversion which may result
1098  * to a valid address).  Since 32-bit strace cannot figure out what kind of
1099  * kernel the tracee is running on, it has to account for both possibilities.
1100  */
1101 #if CAN_ARCH_BE_COMPAT_ON_64BIT_KERNEL
1102
1103 /**
1104  * Print raw 64-bit value as an address if it's too big to fit in strace's
1105  * kernel_long_t.
1106  */
1107 static inline void
1108 print_big_u64_addr(const uint64_t addr)
1109 {
1110         if (sizeof(kernel_long_t) < 8 && addr > max_kaddr()) {
1111                 printaddr64(addr);
1112                 tprints(" or ");
1113         }
1114 }
1115 #else /* !CAN_ARCH_BE_COMPAT_ON_64BIT_KERNEL */
1116 # define print_big_u64_addr(addr_) ((void) 0)
1117 #endif /* CAN_ARCH_BE_COMPAT_ON_64BIT_KERNEL */
1118
1119 #if SIZEOF_KERNEL_LONG_T > 4            \
1120  && (SIZEOF_LONG < SIZEOF_KERNEL_LONG_T || !defined(current_wordsize))
1121 # define ANY_WORDSIZE_LESS_THAN_KERNEL_LONG     1
1122 #else
1123 # define ANY_WORDSIZE_LESS_THAN_KERNEL_LONG     0
1124 #endif
1125
1126 #define DECL_PRINTNUM(name)                                             \
1127 extern bool                                                             \
1128 printnum_ ## name(struct tcb *, kernel_ulong_t addr, const char *fmt)   \
1129         ATTRIBUTE_FORMAT((printf, 3, 0))                                \
1130 /* End of DECL_PRINTNUM definition. */
1131
1132 DECL_PRINTNUM(short);
1133 DECL_PRINTNUM(int);
1134 DECL_PRINTNUM(int64);
1135 #undef DECL_PRINTNUM
1136
1137 #define DECL_PRINTNUM_ADDR(name)                                        \
1138 extern bool                                                             \
1139 printnum_addr_ ## name(struct tcb *, kernel_ulong_t addr)               \
1140 /* End of DECL_PRINTNUM_ADDR definition. */
1141
1142 DECL_PRINTNUM_ADDR(int);
1143 DECL_PRINTNUM_ADDR(int64);
1144 #undef DECL_PRINTNUM_ADDR
1145
1146 #ifndef current_wordsize
1147 extern bool
1148 printnum_long_int(struct tcb *, kernel_ulong_t addr,
1149                   const char *fmt_long, const char *fmt_int)
1150         ATTRIBUTE_FORMAT((printf, 3, 0))
1151         ATTRIBUTE_FORMAT((printf, 4, 0));
1152
1153 extern bool printnum_addr_long_int(struct tcb *, kernel_ulong_t addr);
1154
1155 static inline bool
1156 printnum_slong(struct tcb *tcp, kernel_ulong_t addr)
1157 {
1158         return printnum_long_int(tcp, addr, "%" PRId64, "%d");
1159 }
1160
1161 static inline bool
1162 printnum_ulong(struct tcb *tcp, kernel_ulong_t addr)
1163 {
1164         return printnum_long_int(tcp, addr, "%" PRIu64, "%u");
1165 }
1166
1167 static inline bool
1168 printnum_ptr(struct tcb *tcp, kernel_ulong_t addr)
1169 {
1170         return printnum_addr_long_int(tcp, addr);
1171 }
1172
1173 #elif current_wordsize > 4
1174
1175 static inline bool
1176 printnum_slong(struct tcb *tcp, kernel_ulong_t addr)
1177 {
1178         return printnum_int64(tcp, addr, "%" PRId64);
1179 }
1180
1181 static inline bool
1182 printnum_ulong(struct tcb *tcp, kernel_ulong_t addr)
1183 {
1184         return printnum_int64(tcp, addr, "%" PRIu64);
1185 }
1186
1187 static inline bool
1188 printnum_ptr(struct tcb *tcp, kernel_ulong_t addr)
1189 {
1190         return printnum_addr_int64(tcp, addr);
1191 }
1192
1193 #else /* current_wordsize == 4 */
1194
1195 static inline bool
1196 printnum_slong(struct tcb *tcp, kernel_ulong_t addr)
1197 {
1198         return printnum_int(tcp, addr, "%d");
1199 }
1200
1201 static inline bool
1202 printnum_ulong(struct tcb *tcp, kernel_ulong_t addr)
1203 {
1204         return printnum_int(tcp, addr, "%u");
1205 }
1206
1207 static inline bool
1208 printnum_ptr(struct tcb *tcp, kernel_ulong_t addr)
1209 {
1210         return printnum_addr_int(tcp, addr);
1211 }
1212
1213 #endif
1214
1215 #ifndef current_klongsize
1216 extern bool printnum_addr_klong_int(struct tcb *, kernel_ulong_t addr);
1217
1218 static inline bool
1219 printnum_kptr(struct tcb *tcp, kernel_ulong_t addr)
1220 {
1221         return printnum_addr_klong_int(tcp, addr);
1222 }
1223
1224 #elif current_klongsize > 4
1225
1226 static inline bool
1227 printnum_kptr(struct tcb *tcp, kernel_ulong_t addr)
1228 {
1229         return printnum_addr_int64(tcp, addr);
1230 }
1231
1232 #else /* current_klongsize == 4 */
1233
1234 static inline bool
1235 printnum_kptr(struct tcb *tcp, kernel_ulong_t addr)
1236 {
1237         return printnum_addr_int(tcp, addr);
1238 }
1239
1240 #endif
1241
1242 #define DECL_PRINTPAIR(name)                                            \
1243 extern bool                                                             \
1244 printpair_ ## name(struct tcb *, kernel_ulong_t addr, const char *fmt)  \
1245         ATTRIBUTE_FORMAT((printf, 3, 0))                                \
1246 /* End of DECL_PRINTPAIR definition. */
1247
1248 DECL_PRINTPAIR(int);
1249 DECL_PRINTPAIR(int64);
1250 #undef DECL_PRINTPAIR
1251
1252 static inline kernel_long_t
1253 truncate_klong_to_current_wordsize(const kernel_long_t v)
1254 {
1255 #if ANY_WORDSIZE_LESS_THAN_KERNEL_LONG
1256         if (current_wordsize < sizeof(v)) {
1257                 return (int) v;
1258         } else
1259 #endif
1260         {
1261                 return v;
1262         }
1263 }
1264
1265 static inline kernel_ulong_t
1266 truncate_kulong_to_current_wordsize(const kernel_ulong_t v)
1267 {
1268 #if ANY_WORDSIZE_LESS_THAN_KERNEL_LONG
1269         if (current_wordsize < sizeof(v)) {
1270                 return (unsigned int) v;
1271         } else
1272 #endif
1273         {
1274                 return v;
1275         }
1276 }
1277
1278 /*
1279  * Cast a pointer or a pointer-sized integer to kernel_ulong_t.
1280  */
1281 #define ptr_to_kulong(v) ((kernel_ulong_t) (unsigned long) (v))
1282
1283 /*
1284  * Zero-extend a signed integer type to unsigned long long.
1285  */
1286 #define zero_extend_signed_to_ull(v) \
1287         (sizeof(v) == sizeof(char) ? (unsigned long long) (unsigned char) (v) : \
1288          sizeof(v) == sizeof(short) ? (unsigned long long) (unsigned short) (v) : \
1289          sizeof(v) == sizeof(int) ? (unsigned long long) (unsigned int) (v) : \
1290          sizeof(v) == sizeof(long) ? (unsigned long long) (unsigned long) (v) : \
1291          (unsigned long long) (v))
1292
1293 /*
1294  * Sign-extend an unsigned integer type to long long.
1295  */
1296 #define sign_extend_unsigned_to_ll(v) \
1297         (sizeof(v) == sizeof(char) ? (long long) (char) (v) : \
1298          sizeof(v) == sizeof(short) ? (long long) (short) (v) : \
1299          sizeof(v) == sizeof(int) ? (long long) (int) (v) : \
1300          sizeof(v) == sizeof(long) ? (long long) (long) (v) : \
1301          (long long) (v))
1302
1303 extern const char *const errnoent[];
1304 extern const char *const signalent[];
1305 extern const unsigned int nerrnos;
1306 extern const unsigned int nsignals;
1307
1308 extern const struct_sysent sysent0[];
1309 extern const struct_ioctlent ioctlent0[];
1310
1311 extern const char *const personality_names[];
1312
1313 #if SUPPORTED_PERSONALITIES > 1
1314 extern const struct_sysent *sysent;
1315 extern const struct_ioctlent *ioctlent;
1316 #else
1317 # define sysent     sysent0
1318 # define ioctlent   ioctlent0
1319 #endif
1320
1321 extern unsigned nsyscalls;
1322 extern unsigned nioctlents;
1323
1324 extern const unsigned int nsyscall_vec[SUPPORTED_PERSONALITIES];
1325 extern const struct_sysent *const sysent_vec[SUPPORTED_PERSONALITIES];
1326 extern struct inject_opts *inject_vec[SUPPORTED_PERSONALITIES];
1327
1328 #ifdef IN_MPERS_BOOTSTRAP
1329 /* Transform multi-line MPERS_PRINTER_DECL statements to one-liners.  */
1330 # define MPERS_PRINTER_DECL(type, name, ...) MPERS_PRINTER_DECL(type, name, __VA_ARGS__)
1331 #else /* !IN_MPERS_BOOTSTRAP */
1332 # if SUPPORTED_PERSONALITIES > 1
1333 #  include "printers.h"
1334 # else
1335 #  include "native_printer_decls.h"
1336 # endif
1337 # define MPERS_PRINTER_DECL(type, name, ...) type MPERS_FUNC_NAME(name)(__VA_ARGS__)
1338 #endif /* !IN_MPERS_BOOTSTRAP */
1339
1340 /* Checks that sysent[scno] is not out of range. */
1341 static inline bool
1342 scno_in_range(kernel_ulong_t scno)
1343 {
1344         return scno < nsyscalls;
1345 }
1346
1347 /*
1348  * Checks whether scno is not out of range,
1349  * its corresponding sysent[scno].sys_func is non-NULL,
1350  * and its sysent[scno].sys_flags has no TRACE_INDIRECT_SUBCALL flag set.
1351  */
1352 static inline bool
1353 scno_is_valid(kernel_ulong_t scno)
1354 {
1355         return scno_in_range(scno)
1356                && sysent[scno].sys_func
1357                && !(sysent[scno].sys_flags & TRACE_INDIRECT_SUBCALL);
1358 }
1359
1360 #define MPERS_FUNC_NAME__(prefix, name) prefix ## name
1361 #define MPERS_FUNC_NAME_(prefix, name) MPERS_FUNC_NAME__(prefix, name)
1362 #define MPERS_FUNC_NAME(name) MPERS_FUNC_NAME_(MPERS_PREFIX, name)
1363
1364 #define SYS_FUNC_NAME(syscall_name) MPERS_FUNC_NAME(syscall_name)
1365
1366 #define SYS_FUNC(syscall_name) int SYS_FUNC_NAME(sys_ ## syscall_name)(struct tcb *tcp)
1367
1368 #endif /* !STRACE_DEFS_H */