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-2017 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 "error_prints.h"
  57 #include "gcc_compat.h"
  58 #include "kernel_types.h"
  59 #include "macros.h"
  60 #include "mpers_type.h"
  61 #include "string_to_uint.h"
  62 #include "supported_personalities.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  * Experimental code using PTRACE_SEIZE can be enabled here.
 113  * This needs Linux kernel 3.4.x or later to work.
 114  */
 115 #define USE_SEIZE 1
 116 /* To force NOMMU build, set to 1 */
 117 #define NOMMU_SYSTEM 0
 118
 119 #ifndef ERESTARTSYS
 120 # define ERESTARTSYS    512
 121 #endif
 122 #ifndef ERESTARTNOINTR
 123 # define ERESTARTNOINTR 513
 124 #endif
 125 #ifndef ERESTARTNOHAND
 126 # define ERESTARTNOHAND 514
 127 #endif
 128 #ifndef ERESTART_RESTARTBLOCK
 129 # define ERESTART_RESTARTBLOCK 516
 130 #endif
 131
 132 #define PERSONALITY0_WORDSIZE  SIZEOF_LONG
 133 #define PERSONALITY0_KLONGSIZE SIZEOF_KERNEL_LONG_T
 134 #define PERSONALITY0_INCLUDE_PRINTERS_DECLS "native_printer_decls.h"
 135 #define PERSONALITY0_INCLUDE_PRINTERS_DEFS "native_printer_defs.h"
 136
 137 #if SUPPORTED_PERSONALITIES > 1
 138 # define PERSONALITY1_WORDSIZE  4
 139 # define PERSONALITY1_KLONGSIZE PERSONALITY1_WORDSIZE
 140 #endif
 141
 142 #if SUPPORTED_PERSONALITIES > 2
 143 # define PERSONALITY2_WORDSIZE  4
 144 # define PERSONALITY2_KLONGSIZE PERSONALITY0_KLONGSIZE
 145 #endif
 146
 147 #if SUPPORTED_PERSONALITIES > 1 && defined HAVE_M32_MPERS
 148 # define PERSONALITY1_INCLUDE_PRINTERS_DECLS "m32_printer_decls.h"
 149 # define PERSONALITY1_INCLUDE_PRINTERS_DEFS "m32_printer_defs.h"
 150 # define PERSONALITY1_INCLUDE_FUNCS "m32_funcs.h"
 151 # define MPERS_m32_IOCTL_MACROS "ioctl_redefs1.h"
 152 #else
 153 # define PERSONALITY1_INCLUDE_PRINTERS_DECLS "native_printer_decls.h"
 154 # define PERSONALITY1_INCLUDE_PRINTERS_DEFS "native_printer_defs.h"
 155 # define PERSONALITY1_INCLUDE_FUNCS "empty.h"
 156 #endif
 157
 158 #if SUPPORTED_PERSONALITIES > 2 && defined HAVE_MX32_MPERS
 159 # define PERSONALITY2_INCLUDE_FUNCS "mx32_funcs.h"
 160 # define PERSONALITY2_INCLUDE_PRINTERS_DECLS "mx32_printer_decls.h"
 161 # define PERSONALITY2_INCLUDE_PRINTERS_DEFS "mx32_printer_defs.h"
 162 # define MPERS_mx32_IOCTL_MACROS "ioctl_redefs2.h"
 163 #else
 164 # define PERSONALITY2_INCLUDE_PRINTERS_DECLS "native_printer_decls.h"
 165 # define PERSONALITY2_INCLUDE_PRINTERS_DEFS "native_printer_defs.h"
 166 # define PERSONALITY2_INCLUDE_FUNCS "empty.h"
 167 #endif
 168
 169 typedef struct ioctlent {
 170         const char *symbol;
 171         unsigned int code;
 172 } struct_ioctlent;
 173
 174 #define INJECT_F_SIGNAL 1
 175 #define INJECT_F_RETVAL 2
 176
 177 struct inject_data {
 178         uint16_t flags;
 179         uint16_t signo;
 180         int rval;
 181 };
 182
 183 struct inject_opts {
 184         uint16_t first;
 185         uint16_t step;
 186         struct inject_data data;
 187 };
 188
 189 #define MAX_ERRNO_VALUE                 4095
 190
 191 /* Trace Control Block */
 192 struct tcb {
 193         int flags;              /* See below for TCB_ values */
 194         int pid;                /* If 0, this tcb is free */
 195         int qual_flg;           /* qual_flags[scno] or DEFAULT_QUAL_FLAGS + RAW */
 196         unsigned long u_error;  /* Error code */
 197         kernel_ulong_t scno;    /* System call number */
 198         kernel_ulong_t u_arg[MAX_ARGS]; /* System call arguments */
 199         kernel_long_t u_rval;   /* Return value */
 200 #if SUPPORTED_PERSONALITIES > 1
 201         unsigned int currpers;  /* Personality at the time of scno update */
 202 #endif
 203         int sys_func_rval;      /* Syscall entry parser's return value */
 204         int curcol;             /* Output column for this process */
 205         FILE *outf;             /* Output file for this process */
 206         const char *auxstr;     /* Auxiliary info from syscall (see RVAL_STR) */
 207         void *_priv_data;       /* Private data for syscall decoding functions */
 208         void (*_free_priv_data)(void *); /* Callback for freeing priv_data */
 209         const struct_sysent *s_ent; /* sysent[scno] or dummy struct for bad scno */
 210         const struct_sysent *s_prev_ent; /* for "resuming interrupted SYSCALL" msg */
 211         struct inject_opts *inject_vec[SUPPORTED_PERSONALITIES];
 212         struct timeval stime;   /* System time usage as of last process wait */
 213         struct timeval dtime;   /* Delta for system time usage */
 214         struct timeval etime;   /* Syscall entry time */
 215
 216 #ifdef USE_LIBUNWIND
 217         struct UPT_info *libunwind_ui;
 218         struct mmap_cache_t *mmap_cache;
 219         unsigned int mmap_cache_size;
 220         unsigned int mmap_cache_generation;
 221         struct queue_t *queue;
 222 #endif
 223 };
 224
 225 /* TCB flags */
 226 /* We have attached to this process, but did not see it stopping yet */
 227 #define TCB_STARTUP             0x01
 228 #define TCB_IGNORE_ONE_SIGSTOP  0x02    /* Next SIGSTOP is to be ignored */
 229 /*
 230  * Are we in system call entry or in syscall exit?
 231  *
 232  * This bit is set in syscall_entering_finish() and cleared in
 233  * syscall_exiting_finish().
 234  * Other stops which are possible directly after syscall entry (death, ptrace
 235  * event stop) are handled without calling syscall_{entering,exiting}_*().
 236  *
 237  * Use entering(tcp) / exiting(tcp) to check this bit to make code more
 238  * readable.
 239  */
 240 #define TCB_INSYSCALL   0x04
 241 #define TCB_ATTACHED    0x08    /* We attached to it already */
 242 #define TCB_REPRINT     0x10    /* We should reprint this syscall on exit */
 243 #define TCB_FILTERED    0x20    /* This system call has been filtered out */
 244 #define TCB_TAMPERED    0x40    /* A syscall has been tampered with */
 245 #define TCB_HIDE_LOG    0x80    /* We should hide everything (until execve) */
 246 #define TCB_SKIP_DETACH_ON_FIRST_EXEC   0x100   /* -b execve should skip detach on first execve */
 247
 248 /* qualifier flags */
 249 #define QUAL_TRACE      0x001   /* this system call should be traced */
 250 #define QUAL_ABBREV     0x002   /* abbreviate the structures of this syscall */
 251 #define QUAL_VERBOSE    0x004   /* decode the structures of this syscall */
 252 #define QUAL_RAW        0x008   /* print all args in hex for this syscall */
 253 #define QUAL_INJECT     0x010   /* tamper with this system call on purpose */
 254
 255 #define DEFAULT_QUAL_FLAGS (QUAL_TRACE | QUAL_ABBREV | QUAL_VERBOSE)
 256
 257 #define entering(tcp)   (!((tcp)->flags & TCB_INSYSCALL))
 258 #define exiting(tcp)    ((tcp)->flags & TCB_INSYSCALL)
 259 #define syserror(tcp)   ((tcp)->u_error != 0)
 260 #define traced(tcp)     ((tcp)->qual_flg & QUAL_TRACE)
 261 #define verbose(tcp)    ((tcp)->qual_flg & QUAL_VERBOSE)
 262 #define abbrev(tcp)     ((tcp)->qual_flg & QUAL_ABBREV)
 263 #define raw(tcp)        ((tcp)->qual_flg & QUAL_RAW)
 264 #define inject(tcp)     ((tcp)->qual_flg & QUAL_INJECT)
 265 #define filtered(tcp)   ((tcp)->flags & TCB_FILTERED)
 266 #define hide_log(tcp)   ((tcp)->flags & TCB_HIDE_LOG)
 267
 268 #include "xlat.h"
 269
 270 extern const struct xlat addrfams[];
 271 extern const struct xlat arp_hardware_types[];
 272 extern const struct xlat at_flags[];
 273 extern const struct xlat clocknames[];
 274 extern const struct xlat dirent_types[];
 275 extern const struct xlat ethernet_protocols[];
 276 extern const struct xlat evdev_abs[];
 277 extern const struct xlat iffflags[];
 278 extern const struct xlat inet_protocols[];
 279 extern const struct xlat ip_type_of_services[];
 280 extern const struct xlat msg_flags[];
 281 extern const struct xlat netlink_protocols[];
 282 extern const struct xlat nl_route_types[];
 283 extern const struct xlat open_access_modes[];
 284 extern const struct xlat open_mode_flags[];
 285 extern const struct xlat resource_flags[];
 286 extern const struct xlat routing_scopes[];
 287 extern const struct xlat routing_table_ids[];
 288 extern const struct xlat routing_types[];
 289 extern const struct xlat seccomp_ret_action[];
 290 extern const struct xlat setns_types[];
 291 extern const struct xlat sg_io_info[];
 292 extern const struct xlat socketlayers[];
 293 extern const struct xlat socktypes[];
 294 extern const struct xlat tcp_state_flags[];
 295 extern const struct xlat tcp_states[];
 296 extern const struct xlat whence_codes[];
 297
 298 /* Format of syscall return values */
 299 #define RVAL_DECIMAL    000     /* decimal format */
 300 #define RVAL_HEX        001     /* hex format */
 301 #define RVAL_OCTAL      002     /* octal format */
 302 #define RVAL_UDECIMAL   003     /* unsigned decimal format */
 303 #define RVAL_FD         010     /* file descriptor */
 304 #define RVAL_MASK       013     /* mask for these values */
 305
 306 #define RVAL_STR        020     /* Print `auxstr' field after return val */
 307 #define RVAL_NONE       040     /* Print nothing */
 308
 309 #define RVAL_DECODED    0100    /* syscall decoding finished */
 310 #define RVAL_IOCTL_DECODED 0200 /* ioctl sub-parser successfully decoded
 311                                    the argument */
 312
 313 #define IOCTL_NUMBER_UNKNOWN 0
 314 #define IOCTL_NUMBER_HANDLED 1
 315 #define IOCTL_NUMBER_STOP_LOOKUP 010
 316
 317 #define indirect_ipccall(tcp) (tcp->s_ent->sys_flags & TRACE_INDIRECT_SUBCALL)
 318
 319 #if defined(ARM) || defined(AARCH64) \
 320  || defined(I386) || defined(X32) || defined(X86_64) \
 321  || defined(IA64) \
 322  || defined(BFIN) \
 323  || defined(M68K) \
 324  || defined(MICROBLAZE) \
 325  || defined(RISCV) \
 326  || defined(S390) \
 327  || defined(SH) || defined(SH64) \
 328  || defined(SPARC) || defined(SPARC64) \
 329  /**/
 330 # define NEED_UID16_PARSERS 1
 331 #else
 332 # define NEED_UID16_PARSERS 0
 333 #endif
 334
 335 enum sock_proto {
 336         SOCK_PROTO_UNKNOWN,
 337         SOCK_PROTO_UNIX,
 338         SOCK_PROTO_TCP,
 339         SOCK_PROTO_UDP,
 340         SOCK_PROTO_TCPv6,
 341         SOCK_PROTO_UDPv6,
 342         SOCK_PROTO_NETLINK
 343 };
 344 extern enum sock_proto get_proto_by_name(const char *);
 345
 346 enum iov_decode {
 347         IOV_DECODE_ADDR,
 348         IOV_DECODE_STR,
 349         IOV_DECODE_NETLINK
 350 };
 351
 352 typedef enum {
 353         CFLAG_NONE = 0,
 354         CFLAG_ONLY_STATS,
 355         CFLAG_BOTH
 356 } cflag_t;
 357 extern cflag_t cflag;
 358 extern bool debug_flag;
 359 extern bool Tflag;
 360 extern bool iflag;
 361 extern bool count_wallclock;
 362 extern unsigned int qflag;
 363 extern bool not_failing_only;
 364 extern unsigned int show_fd_path;
 365 /* are we filtering traces based on paths? */
 366 extern struct path_set {
 367         const char **paths_selected;
 368         unsigned int num_selected;
 369 } global_path_set;
 370 #define tracing_paths (global_path_set.num_selected != 0)
 371 extern unsigned xflag;
 372 extern unsigned followfork;
 373 #ifdef USE_LIBUNWIND
 374 /* if this is true do the stack trace for every system call */
 375 extern bool stack_trace_enabled;
 376 #endif
 377 extern unsigned ptrace_setoptions;
 378 extern unsigned max_strlen;
 379 extern unsigned os_release;
 380 #undef KERNEL_VERSION
 381 #define KERNEL_VERSION(a, b, c) (((a) << 16) + ((b) << 8) + (c))
 382
 383 extern int read_int_from_file(const char *, int *);
 384
 385 extern void set_sortby(const char *);
 386 extern void set_overhead(int);
 387 extern void print_pc(struct tcb *);
 388
 389 extern int syscall_entering_decode(struct tcb *);
 390 extern int syscall_entering_trace(struct tcb *, unsigned int *);
 391 extern void syscall_entering_finish(struct tcb *, int);
 392
 393 extern int syscall_exiting_decode(struct tcb *, struct timeval *);
 394 extern int syscall_exiting_trace(struct tcb *, struct timeval, int);
 395 extern void syscall_exiting_finish(struct tcb *);
 396
 397 extern void count_syscall(struct tcb *, const struct timeval *);
 398 extern void call_summary(FILE *);
 399
 400 extern void clear_regs(void);
 401 extern int get_scno(struct tcb *);
 402 extern kernel_ulong_t get_rt_sigframe_addr(struct tcb *);
 403
 404 /**
 405  * Convert syscall number to syscall name.
 406  *
 407  * @param scno Syscall number.
 408  * @return     String literal corresponding to the syscall number in case latter
 409  *             is valid; NULL otherwise.
 410  */
 411 extern const char *syscall_name(kernel_ulong_t scno);
 412 extern const char *err_name(unsigned long err);
 413
 414 extern bool is_erestart(struct tcb *);
 415 extern void temporarily_clear_syserror(struct tcb *);
 416 extern void restore_cleared_syserror(struct tcb *);
 417
 418 extern void *get_tcb_priv_data(const struct tcb *);
 419 extern int set_tcb_priv_data(struct tcb *, void *priv_data,
 420                              void (*free_priv_data)(void *));
 421 extern void free_tcb_priv_data(struct tcb *);
 422
 423 static inline unsigned long get_tcb_priv_ulong(const struct tcb *tcp)
 424 {
 425         return (unsigned long) get_tcb_priv_data(tcp);
 426 }
 427
 428 static inline int set_tcb_priv_ulong(struct tcb *tcp, unsigned long val)
 429 {
 430         return set_tcb_priv_data(tcp, (void *) val, 0);
 431 }
 432
 433 extern int
 434 umoven(struct tcb *, kernel_ulong_t addr, unsigned int len, void *laddr);
 435 #define umove(pid, addr, objp)  \
 436         umoven((pid), (addr), sizeof(*(objp)), (void *) (objp))
 437
 438 extern int
 439 umoven_or_printaddr(struct tcb *, kernel_ulong_t addr,
 440                     unsigned int len, void *laddr);
 441 #define umove_or_printaddr(pid, addr, objp)     \
 442         umoven_or_printaddr((pid), (addr), sizeof(*(objp)), (void *) (objp))
 443
 444 extern int
 445 umoven_or_printaddr_ignore_syserror(struct tcb *, kernel_ulong_t addr,
 446                                     unsigned int len, void *laddr);
 447
 448 extern int
 449 umovestr(struct tcb *, kernel_ulong_t addr, unsigned int len, char *laddr);
 450
 451 extern int upeek(int pid, unsigned long, kernel_ulong_t *);
 452 extern int upoke(int pid, unsigned long, kernel_ulong_t);
 453
 454 extern bool
 455 print_array(struct tcb *,
 456             kernel_ulong_t start_addr,
 457             size_t nmemb,
 458             void *elem_buf,
 459             size_t elem_size,
 460             int (*umoven_func)(struct tcb *,
 461                                      kernel_ulong_t,
 462                                      unsigned int,
 463                                      void *),
 464             bool (*print_func)(struct tcb *,
 465                                      void *elem_buf,
 466                                      size_t elem_size,
 467                                      void *opaque_data),
 468             void *opaque_data);
 469
 470 #if defined ALPHA || defined IA64 || defined MIPS \
 471  || defined SH || defined SPARC || defined SPARC64
 472 # define HAVE_GETRVAL2
 473 extern long getrval2(struct tcb *);
 474 #else
 475 # undef HAVE_GETRVAL2
 476 #endif
 477
 478 extern const char *signame(const int);
 479 extern void pathtrace_select_set(const char *, struct path_set *);
 480 extern bool pathtrace_match_set(struct tcb *, struct path_set *);
 481 #define pathtrace_select(tcp)   \
 482         pathtrace_select_set(tcp, &global_path_set)
 483 #define pathtrace_match(tcp)    \
 484         pathtrace_match_set(tcp, &global_path_set)
 485 extern int getfdpath(struct tcb *, int, char *, unsigned);
 486 extern unsigned long getfdinode(struct tcb *, int);
 487 extern enum sock_proto getfdproto(struct tcb *, int);
 488
 489 extern const char *xlookup(const struct xlat *, const uint64_t);
 490 extern const char *xlat_search(const struct xlat *, const size_t, const uint64_t);
 491
 492 struct dyxlat;
 493 struct dyxlat *dyxlat_alloc(size_t nmemb);
 494 void dyxlat_free(struct dyxlat *);
 495 const struct xlat *dyxlat_get(const struct dyxlat *);
 496 void dyxlat_add_pair(struct dyxlat *, uint64_t val, const char *str, size_t len);
 497
 498 const struct xlat *genl_families_xlat(void);
 499
 500 extern unsigned long get_pagesize(void);
 501 extern int next_set_bit(const void *bit_array, unsigned cur_bit, unsigned size_bits);
 502
 503 /*
 504  * Returns STR if it does not start with PREFIX,
 505  * or a pointer to the first char in STR after PREFIX.
 506  * The length of PREFIX is specified by PREFIX_LEN.
 507  */
 508 static inline const char *
 509 str_strip_prefix_len(const char *str, const char *prefix, size_t prefix_len)
 510 {
 511         return strncmp(str, prefix, prefix_len) ? str : str + prefix_len;
 512 }
 513
 514 #define STR_STRIP_PREFIX(str, prefix)   \
 515         str_strip_prefix_len((str), (prefix), sizeof(prefix) - 1)
 516
 517 #define QUOTE_0_TERMINATED                      0x01
 518 #define QUOTE_OMIT_LEADING_TRAILING_QUOTES      0x02
 519 #define QUOTE_OMIT_TRAILING_0                   0x08
 520 #define QUOTE_FORCE_HEX                         0x10
 521
 522 extern int string_quote(const char *, char *, unsigned int, unsigned int);
 523 extern int print_quoted_string(const char *, unsigned int, unsigned int);
 524 extern int print_quoted_cstring(const char *, unsigned int);
 525
 526 /* a refers to the lower numbered u_arg,
 527  * b refers to the higher numbered u_arg
 528  */
 529 #ifdef WORDS_BIGENDIAN
 530 # define ULONG_LONG(a, b) \
 531         ((unsigned long long)(unsigned)(b) | ((unsigned long long)(a)<<32))
 532 #else
 533 # define ULONG_LONG(a, b) \
 534         ((unsigned long long)(unsigned)(a) | ((unsigned long long)(b)<<32))
 535 #endif
 536 extern int getllval(struct tcb *, unsigned long long *, int);
 537 extern int printllval(struct tcb *, const char *, int)
 538         ATTRIBUTE_FORMAT((printf, 2, 0));
 539
 540 extern void printaddr(kernel_ulong_t addr);
 541 extern int printxvals(const uint64_t, const char *, const struct xlat *, ...)
 542         ATTRIBUTE_SENTINEL;
 543 extern int printxval_searchn(const struct xlat *xlat, size_t xlat_size,
 544         uint64_t val, const char *dflt);
 545 #define printxval_search(xlat__, val__, dflt__) \
 546         printxval_searchn(xlat__, ARRAY_SIZE(xlat__), val__, dflt__)
 547 extern int printargs(struct tcb *);
 548 extern int printargs_u(struct tcb *);
 549 extern int printargs_d(struct tcb *);
 550
 551 extern void addflags(const struct xlat *, uint64_t);
 552 extern int printflags_ex(uint64_t, const char *, const struct xlat *, ...)
 553         ATTRIBUTE_SENTINEL;
 554 extern const char *sprintflags(const char *, const struct xlat *, uint64_t);
 555 extern const char *sprinttime(long long sec);
 556 extern const char *sprinttime_nsec(long long sec, unsigned long long nsec);
 557 extern const char *sprinttime_usec(long long sec, unsigned long long usec);
 558 extern void print_symbolic_mode_t(unsigned int);
 559 extern void print_numeric_umode_t(unsigned short);
 560 extern void print_numeric_long_umask(unsigned long);
 561 extern void print_dev_t(unsigned long long dev);
 562 extern void print_abnormal_hi(kernel_ulong_t);
 563
 564 extern void
 565 dumpiov_in_msghdr(struct tcb *, kernel_ulong_t addr, kernel_ulong_t data_size);
 566
 567 extern void
 568 dumpiov_in_mmsghdr(struct tcb *, kernel_ulong_t addr);
 569
 570 extern void
 571 dumpiov_upto(struct tcb *, int len, kernel_ulong_t addr, kernel_ulong_t data_size);
 572
 573 extern void
 574 dumpstr(struct tcb *, kernel_ulong_t addr, int len);
 575
 576 extern void
 577 printstr_ex(struct tcb *, kernel_ulong_t addr, kernel_ulong_t len,
 578             unsigned int user_style);
 579
 580 extern void
 581 printpathn(struct tcb *, kernel_ulong_t addr, unsigned int n);
 582
 583 extern void
 584 printpath(struct tcb *, kernel_ulong_t addr);
 585
 586 #define TIMESPEC_TEXT_BUFSIZE \
 587                 (sizeof(long long) * 3 * 2 + sizeof("{tv_sec=-, tv_nsec=}"))
 588 extern void printfd(struct tcb *, int);
 589 extern void print_sockaddr(const void *sa, int len);
 590 extern bool
 591 print_inet_addr(int af, const void *addr, unsigned int len, const char *var_name);
 592 extern bool
 593 decode_inet_addr(struct tcb *, kernel_ulong_t addr,
 594                  unsigned int len, int family, const char *var_name);
 595 extern const char *get_sockaddr_by_inode(struct tcb *, int fd, unsigned long inode);
 596 extern bool print_sockaddr_by_inode(struct tcb *, int fd, unsigned long inode);
 597 extern void print_dirfd(struct tcb *, int);
 598
 599 extern int
 600 decode_sockaddr(struct tcb *, kernel_ulong_t addr, int addrlen);
 601
 602 extern void printuid(const char *, const unsigned int);
 603
 604 extern void
 605 print_sigset_addr_len(struct tcb *, kernel_ulong_t addr, kernel_ulong_t len);
 606 extern void
 607 print_sigset_addr(struct tcb *, kernel_ulong_t addr);
 608
 609 extern const char *sprintsigmask_n(const char *, const void *, unsigned int);
 610 #define tprintsigmask_addr(prefix, mask) \
 611         tprints(sprintsigmask_n((prefix), (mask), sizeof(mask)))
 612 extern void printsignal(int);
 613
 614 extern void
 615 tprint_iov_upto(struct tcb *, kernel_ulong_t len, kernel_ulong_t addr,
 616                 enum iov_decode, kernel_ulong_t data_size);
 617
 618 extern void
 619 decode_netlink(struct tcb *, int fd, kernel_ulong_t addr, kernel_ulong_t len);
 620
 621 extern void tprint_open_modes(unsigned int);
 622 extern const char *sprint_open_modes(unsigned int);
 623
 624 extern void
 625 decode_seccomp_fprog(struct tcb *, kernel_ulong_t addr);
 626
 627 extern void
 628 print_seccomp_fprog(struct tcb *, kernel_ulong_t addr, unsigned short len);
 629
 630 extern void
 631 decode_sock_fprog(struct tcb *, kernel_ulong_t addr);
 632
 633 extern void
 634 print_sock_fprog(struct tcb *, kernel_ulong_t addr, unsigned short len);
 635
 636 struct strace_stat;
 637 extern void print_struct_stat(struct tcb *, const struct strace_stat *const st);
 638
 639 struct strace_statfs;
 640 struct strace_keyctl_kdf_params;
 641
 642 extern void
 643 print_struct_statfs(struct tcb *, kernel_ulong_t addr);
 644
 645 extern void
 646 print_struct_statfs64(struct tcb *, kernel_ulong_t addr, kernel_ulong_t size);
 647
 648 extern void print_ifindex(unsigned int);
 649
 650 extern void qualify(const char *);
 651 extern unsigned int qual_flags(const unsigned int);
 652
 653 #define DECL_IOCTL(name)                                                \
 654 extern int                                                              \
 655 name ## _ioctl(struct tcb *, unsigned int request, kernel_ulong_t arg)  \
 656 /* End of DECL_IOCTL definition. */
 657
 658 DECL_IOCTL(dm);
 659 DECL_IOCTL(file);
 660 DECL_IOCTL(fs_x);
 661 DECL_IOCTL(kvm);
 662 DECL_IOCTL(nsfs);
 663 DECL_IOCTL(ptp);
 664 DECL_IOCTL(scsi);
 665 DECL_IOCTL(term);
 666 DECL_IOCTL(ubi);
 667 DECL_IOCTL(uffdio);
 668 #undef DECL_IOCTL
 669
 670 extern int decode_sg_io_v4(struct tcb *, const kernel_ulong_t arg);
 671
 672 struct nlmsghdr;
 673
 674 typedef bool (*netlink_decoder_t)(struct tcb *, const struct nlmsghdr *,
 675                                   kernel_ulong_t addr, unsigned int len);
 676
 677 #define DECL_NETLINK(name)                                              \
 678 extern bool                                                             \
 679 decode_netlink_ ## name(struct tcb *, const struct nlmsghdr *,          \
 680                         kernel_ulong_t addr, unsigned int len)          \
 681 /* End of DECL_NETLINK definition. */
 682
 683 DECL_NETLINK(crypto);
 684 DECL_NETLINK(route);
 685 DECL_NETLINK(selinux);
 686 DECL_NETLINK(sock_diag);
 687
 688 extern int tv_nz(const struct timeval *);
 689 extern int tv_cmp(const struct timeval *, const struct timeval *);
 690 extern double tv_float(const struct timeval *);
 691 extern void tv_add(struct timeval *, const struct timeval *, const struct timeval *);
 692 extern void tv_sub(struct timeval *, const struct timeval *, const struct timeval *);
 693 extern void tv_mul(struct timeval *, const struct timeval *, int);
 694 extern void tv_div(struct timeval *, const struct timeval *, int);
 695
 696 #ifdef USE_LIBUNWIND
 697 extern void unwind_init(void);
 698 extern void unwind_tcb_init(struct tcb *);
 699 extern void unwind_tcb_fin(struct tcb *);
 700 extern void unwind_cache_invalidate(struct tcb *);
 701 extern void unwind_print_stacktrace(struct tcb *);
 702 extern void unwind_capture_stacktrace(struct tcb *);
 703 #endif
 704
 705 static inline void
 706 printstrn(struct tcb *tcp, kernel_ulong_t addr, kernel_ulong_t len)
 707 {
 708         printstr_ex(tcp, addr, len, 0);
 709 }
 710
 711 static inline void
 712 printstr(struct tcb *tcp, kernel_ulong_t addr)
 713 {
 714         printstr_ex(tcp, addr, -1, QUOTE_0_TERMINATED);
 715 }
 716
 717 static inline int
 718 printflags64(const struct xlat *x, uint64_t flags, const char *dflt)
 719 {
 720         return printflags_ex(flags, dflt, x, NULL);
 721 }
 722
 723 static inline int
 724 printflags(const struct xlat *x, unsigned int flags, const char *dflt)
 725 {
 726         return printflags64(x, flags, dflt);
 727 }
 728
 729 static inline int
 730 printxval64(const struct xlat *x, const uint64_t val, const char *dflt)
 731 {
 732         return printxvals(val, dflt, x, NULL);
 733 }
 734
 735 static inline int
 736 printxval(const struct xlat *x, const unsigned int val, const char *dflt)
 737 {
 738         return printxvals(val, dflt, x, NULL);
 739 }
 740
 741 static inline void
 742 tprint_iov(struct tcb *tcp, kernel_ulong_t len, kernel_ulong_t addr,
 743            enum iov_decode decode_iov)
 744 {
 745         tprint_iov_upto(tcp, len, addr, decode_iov, -1);
 746 }
 747
 748 #ifdef ALPHA
 749 typedef struct {
 750         int tv_sec, tv_usec;
 751 } timeval32_t;
 752
 753 extern void print_timeval32_t(const timeval32_t *);
 754 extern void printrusage32(struct tcb *, kernel_ulong_t);
 755 extern const char *sprint_timeval32(struct tcb *, kernel_ulong_t addr);
 756 extern void print_timeval32(struct tcb *, kernel_ulong_t addr);
 757 extern void print_timeval32_utimes(struct tcb *, kernel_ulong_t addr);
 758 extern void print_itimerval32(struct tcb *, kernel_ulong_t addr);
 759 #endif
 760
 761 #ifdef HAVE_STRUCT_USER_DESC
 762 extern void print_user_desc(struct tcb *, kernel_ulong_t addr);
 763 #endif
 764
 765 /* Strace log generation machinery.
 766  *
 767  * printing_tcp: tcb which has incomplete line being printed right now.
 768  * NULL if last line has been completed ('\n'-terminated).
 769  * printleader(tcp) examines it, finishes incomplete line if needed,
 770  * the sets it to tcp.
 771  * line_ended() clears printing_tcp and resets ->curcol = 0.
 772  * tcp->curcol == 0 check is also used to detect completeness
 773  * of last line, since in -ff mode just checking printing_tcp for NULL
 774  * is not enough.
 775  *
 776  * If you change this code, test log generation in both -f and -ff modes
 777  * using:
 778  * strace -oLOG -f[f] test/threaded_execve
 779  * strace -oLOG -f[f] test/sigkill_rain
 780  * strace -oLOG -f[f] -p "`pidof web_browser`"
 781  */
 782 extern struct tcb *printing_tcp;
 783 extern void printleader(struct tcb *);
 784 extern void line_ended(void);
 785 extern void tabto(void);
 786 extern void tprintf(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2));
 787 extern void tprints(const char *str);
 788 extern void tprintf_comment(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2));
 789 extern void tprints_comment(const char *str);
 790
 791 #if SUPPORTED_PERSONALITIES > 1
 792 extern void set_personality(int personality);
 793 extern unsigned current_personality;
 794 #else
 795 # define set_personality(personality) ((void)0)
 796 # define current_personality 0
 797 #endif
 798
 799 #if SUPPORTED_PERSONALITIES == 1
 800 # define current_wordsize PERSONALITY0_WORDSIZE
 801 # define current_klongsize PERSONALITY0_KLONGSIZE
 802 #else
 803 # if SUPPORTED_PERSONALITIES == 2 && PERSONALITY0_WORDSIZE == PERSONALITY1_WORDSIZE
 804 #  define current_wordsize PERSONALITY0_WORDSIZE
 805 # else
 806 extern unsigned current_wordsize;
 807 # endif
 808 # if SUPPORTED_PERSONALITIES == 2 && PERSONALITY0_KLONGSIZE == PERSONALITY1_KLONGSIZE
 809 #  define current_klongsize PERSONALITY0_KLONGSIZE
 810 # else
 811 extern unsigned current_klongsize;
 812 # endif
 813 #endif
 814
 815 #define ANY_WORDSIZE_LESS_THAN_KERNEL_LONG      \
 816         (SIZEOF_KERNEL_LONG_T > 4               \
 817          && (SIZEOF_LONG < SIZEOF_KERNEL_LONG_T || !defined(current_wordsize)))
 818
 819 #define DECL_PRINTNUM(name)                                             \
 820 extern bool                                                             \
 821 printnum_ ## name(struct tcb *, kernel_ulong_t addr, const char *fmt)   \
 822         ATTRIBUTE_FORMAT((printf, 3, 0))                                \
 823 /* End of DECL_PRINTNUM definition. */
 824
 825 DECL_PRINTNUM(short);
 826 DECL_PRINTNUM(int);
 827 DECL_PRINTNUM(int64);
 828 #undef DECL_PRINTNUM
 829
 830 #define DECL_PRINTNUM_ADDR(name)                                        \
 831 extern bool                                                             \
 832 printnum_addr_ ## name(struct tcb *, kernel_ulong_t addr)               \
 833 /* End of DECL_PRINTNUM_ADDR definition. */
 834
 835 DECL_PRINTNUM_ADDR(int);
 836 DECL_PRINTNUM_ADDR(int64);
 837 #undef DECL_PRINTNUM_ADDR
 838
 839 #ifndef current_wordsize
 840 extern bool
 841 printnum_long_int(struct tcb *, kernel_ulong_t addr,
 842                   const char *fmt_long, const char *fmt_int)
 843         ATTRIBUTE_FORMAT((printf, 3, 0))
 844         ATTRIBUTE_FORMAT((printf, 4, 0));
 845 extern bool printnum_addr_long_int(struct tcb *, kernel_ulong_t addr);
 846 # define printnum_slong(tcp, addr) \
 847         printnum_long_int((tcp), (addr), "%" PRId64, "%d")
 848 # define printnum_ulong(tcp, addr) \
 849         printnum_long_int((tcp), (addr), "%" PRIu64, "%u")
 850 # define printnum_ptr(tcp, addr) \
 851         printnum_addr_long_int((tcp), (addr))
 852 #elif current_wordsize > 4
 853 # define printnum_slong(tcp, addr) \
 854         printnum_int64((tcp), (addr), "%" PRId64)
 855 # define printnum_ulong(tcp, addr) \
 856         printnum_int64((tcp), (addr), "%" PRIu64)
 857 # define printnum_ptr(tcp, addr) \
 858         printnum_addr_int64((tcp), (addr))
 859 #else /* current_wordsize == 4 */
 860 # define printnum_slong(tcp, addr) \
 861         printnum_int((tcp), (addr), "%d")
 862 # define printnum_ulong(tcp, addr) \
 863         printnum_int((tcp), (addr), "%u")
 864 # define printnum_ptr(tcp, addr) \
 865         printnum_addr_int((tcp), (addr))
 866 #endif
 867
 868 #ifndef current_klongsize
 869 extern bool printnum_addr_klong_int(struct tcb *, kernel_ulong_t addr);
 870 # define printnum_kptr(tcp, addr) \
 871         printnum_addr_klong_int((tcp), (addr))
 872 #elif current_klongsize > 4
 873 # define printnum_kptr(tcp, addr) \
 874         printnum_addr_int64((tcp), (addr))
 875 #else /* current_klongsize == 4 */
 876 # define printnum_kptr(tcp, addr) \
 877         printnum_addr_int((tcp), (addr))
 878 #endif
 879
 880 #define DECL_PRINTPAIR(name)                                            \
 881 extern bool                                                             \
 882 printpair_ ## name(struct tcb *, kernel_ulong_t addr, const char *fmt)  \
 883         ATTRIBUTE_FORMAT((printf, 3, 0))                                \
 884 /* End of DECL_PRINTPAIR definition. */
 885
 886 DECL_PRINTPAIR(int);
 887 DECL_PRINTPAIR(int64);
 888 #undef DECL_PRINTPAIR
 889
 890 static inline kernel_long_t
 891 truncate_klong_to_current_wordsize(const kernel_long_t v)
 892 {
 893 #if ANY_WORDSIZE_LESS_THAN_KERNEL_LONG
 894         if (current_wordsize < sizeof(v)) {
 895                 return (int) v;
 896         } else
 897 #endif
 898         {
 899                 return v;
 900         }
 901 }
 902
 903 static inline kernel_ulong_t
 904 truncate_kulong_to_current_wordsize(const kernel_ulong_t v)
 905 {
 906 #if ANY_WORDSIZE_LESS_THAN_KERNEL_LONG
 907         if (current_wordsize < sizeof(v)) {
 908                 return (unsigned int) v;
 909         } else
 910 #endif
 911         {
 912                 return v;
 913         }
 914 }
 915
 916 /*
 917  * Cast a pointer or a pointer-sized integer to kernel_ulong_t.
 918  */
 919 #define ptr_to_kulong(v) ((kernel_ulong_t) (unsigned long) (v))
 920
 921 /*
 922  * Zero-extend a signed integer type to unsigned long long.
 923  */
 924 #define zero_extend_signed_to_ull(v) \
 925         (sizeof(v) == sizeof(char) ? (unsigned long long) (unsigned char) (v) : \
 926          sizeof(v) == sizeof(short) ? (unsigned long long) (unsigned short) (v) : \
 927          sizeof(v) == sizeof(int) ? (unsigned long long) (unsigned int) (v) : \
 928          sizeof(v) == sizeof(long) ? (unsigned long long) (unsigned long) (v) : \
 929          (unsigned long long) (v))
 930
 931 /*
 932  * Sign-extend an unsigned integer type to long long.
 933  */
 934 #define sign_extend_unsigned_to_ll(v) \
 935         (sizeof(v) == sizeof(char) ? (long long) (char) (v) : \
 936          sizeof(v) == sizeof(short) ? (long long) (short) (v) : \
 937          sizeof(v) == sizeof(int) ? (long long) (int) (v) : \
 938          sizeof(v) == sizeof(long) ? (long long) (long) (v) : \
 939          (long long) (v))
 940
 941 extern const struct_sysent sysent0[];
 942 extern const char *const errnoent0[];
 943 extern const char *const signalent0[];
 944 extern const struct_ioctlent ioctlent0[];
 945
 946 #if SUPPORTED_PERSONALITIES > 1
 947 extern const struct_sysent *sysent;
 948 extern const char *const *errnoent;
 949 extern const char *const *signalent;
 950 extern const struct_ioctlent *ioctlent;
 951 #else
 952 # define sysent     sysent0
 953 # define errnoent   errnoent0
 954 # define signalent  signalent0
 955 # define ioctlent   ioctlent0
 956 #endif
 957
 958 extern unsigned nsyscalls;
 959 extern unsigned nerrnos;
 960 extern unsigned nsignals;
 961 extern unsigned nioctlents;
 962
 963 extern const unsigned int nsyscall_vec[SUPPORTED_PERSONALITIES];
 964 extern const struct_sysent *const sysent_vec[SUPPORTED_PERSONALITIES];
 965 extern struct inject_opts *inject_vec[SUPPORTED_PERSONALITIES];
 966
 967 #ifdef IN_MPERS_BOOTSTRAP
 968 /* Transform multi-line MPERS_PRINTER_DECL statements to one-liners.  */
 969 # define MPERS_PRINTER_DECL(type, name, ...) MPERS_PRINTER_DECL(type, name, __VA_ARGS__)
 970 #else /* !IN_MPERS_BOOTSTRAP */
 971 # if SUPPORTED_PERSONALITIES > 1
 972 #  include "printers.h"
 973 # else
 974 #  include "native_printer_decls.h"
 975 # endif
 976 # define MPERS_PRINTER_DECL(type, name, ...) type MPERS_FUNC_NAME(name)(__VA_ARGS__)
 977 #endif /* !IN_MPERS_BOOTSTRAP */
 978
 979 /* Checks that sysent[scno] is not out of range. */
 980 static inline bool
 981 scno_in_range(kernel_ulong_t scno)
 982 {
 983         return scno < nsyscalls;
 984 }
 985
 986 /*
 987  * Checks whether scno is not out of range,
 988  * its corresponding sysent[scno].sys_func is non-NULL,
 989  * and its sysent[scno].sys_flags has no TRACE_INDIRECT_SUBCALL flag set.
 990  */
 991 static inline bool
 992 scno_is_valid(kernel_ulong_t scno)
 993 {
 994         return scno_in_range(scno)
 995                && sysent[scno].sys_func
 996                && !(sysent[scno].sys_flags & TRACE_INDIRECT_SUBCALL);
 997 }
 998
 999 #define MPERS_FUNC_NAME__(prefix, name) prefix ## name
1000 #define MPERS_FUNC_NAME_(prefix, name) MPERS_FUNC_NAME__(prefix, name)
1001 #define MPERS_FUNC_NAME(name) MPERS_FUNC_NAME_(MPERS_PREFIX, name)
1002
1003 #define SYS_FUNC_NAME(syscall_name) MPERS_FUNC_NAME(syscall_name)
1004
1005 #define SYS_FUNC(syscall_name) int SYS_FUNC_NAME(sys_ ## syscall_name)(struct tcb *tcp)
1006
1007 #endif /* !STRACE_DEFS_H */