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