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