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