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