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