1 /* 2 * Copyright (c) 1991, 1992 Paul Kranenburg <pk (at) cs.few.eur.nl> 3 * Copyright (c) 1993 Branko Lankester <branko (at) hacktic.nl> 4 * Copyright (c) 1993, 1994, 1995, 1996 Rick Sladkey <jrs (at) world.std.com> 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 3. The name of the author may not be used to endorse or promote products 16 * derived from this software without specific prior written permission. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 19 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 20 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 21 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 22 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 23 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 27 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 28 */ 29 30 #ifndef STRACE_DEFS_H 31 #define STRACE_DEFS_H 32 33 #ifdef HAVE_CONFIG_H 34 # include "config.h" 35 #endif 36 37 #include <features.h> 38 #include <stdbool.h> 39 #include <stdint.h> 40 #include <inttypes.h> 41 #include <sys/types.h> 42 #include <stddef.h> 43 #include <unistd.h> 44 #include <stdlib.h> 45 #include <stdio.h> 46 /* Open-coding isprint(ch) et al proved more efficient than calling 47 * generalized libc interface. We don't *want* to do non-ASCII anyway. 48 */ 49 /* #include <ctype.h> */ 50 #include <string.h> 51 #include <errno.h> 52 #include <time.h> 53 #include <sys/time.h> 54 55 #include "kernel_types.h" 56 #include "mpers_type.h" 57 #include "gcc_compat.h" 58 #include "sysent.h" 59 60 #ifndef HAVE_STRERROR 61 const char *strerror(int); 62 #endif 63 #ifndef HAVE_STPCPY 64 /* Some libc have stpcpy, some don't. Sigh... 65 * Roll our private implementation... 66 */ 67 #undef stpcpy 68 #define stpcpy strace_stpcpy 69 extern char *stpcpy(char *dst, const char *src); 70 #endif 71 72 #ifndef offsetofend 73 # define offsetofend(type, member) \ 74 (offsetof(type, member) + sizeof(((type *)NULL)->member)) 75 #endif 76 77 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]) + MUST_BE_ARRAY(a)) 78 79 /* macros */ 80 #ifndef MAX 81 # define MAX(a, b) (((a) > (b)) ? (a) : (b)) 82 #endif 83 #ifndef MIN 84 # define MIN(a, b) (((a) < (b)) ? (a) : (b)) 85 #endif 86 #define CLAMP(val, min, max) MIN(MAX(min, val), max) 87 88 /* Glibc has an efficient macro for sigemptyset 89 * (it just does one or two assignments of 0 to internal vector of longs). 90 */ 91 #if defined(__GLIBC__) && defined(__sigemptyset) && !defined(sigemptyset) 92 # define sigemptyset __sigemptyset 93 #endif 94 95 /* Configuration section */ 96 #ifndef DEFAULT_STRLEN 97 /* default maximum # of bytes printed in `printstr', change with -s switch */ 98 # define DEFAULT_STRLEN 32 99 #endif 100 #ifndef DEFAULT_ACOLUMN 101 # define DEFAULT_ACOLUMN 40 /* default alignment column for results */ 102 #endif 103 /* 104 * Maximum number of args to a syscall. 105 * 106 * Make sure that all entries in all syscallent.h files have nargs <= MAX_ARGS! 107 * linux/<ARCH>/syscallent*.h: 108 * all have nargs <= 6 except mips o32 which has nargs <= 7. 109 */ 110 #ifndef MAX_ARGS 111 # ifdef LINUX_MIPSO32 112 # define MAX_ARGS 7 113 # else 114 # define MAX_ARGS 6 115 # endif 116 #endif 117 /* default sorting method for call profiling */ 118 #ifndef DEFAULT_SORTBY 119 # define DEFAULT_SORTBY "time" 120 #endif 121 /* 122 * Experimental code using PTRACE_SEIZE can be enabled here. 123 * This needs Linux kernel 3.4.x or later to work. 124 */ 125 #define USE_SEIZE 1 126 /* To force NOMMU build, set to 1 */ 127 #define NOMMU_SYSTEM 0 128 129 #ifndef ERESTARTSYS 130 # define ERESTARTSYS 512 131 #endif 132 #ifndef ERESTARTNOINTR 133 # define ERESTARTNOINTR 513 134 #endif 135 #ifndef ERESTARTNOHAND 136 # define ERESTARTNOHAND 514 137 #endif 138 #ifndef ERESTART_RESTARTBLOCK 139 # define ERESTART_RESTARTBLOCK 516 140 #endif 141 142 #if defined X86_64 143 # define SUPPORTED_PERSONALITIES 3 144 # define PERSONALITY2_WORDSIZE 4 145 # define PERSONALITY2_KLONGSIZE PERSONALITY0_KLONGSIZE 146 #elif defined AARCH64 \ 147 || defined POWERPC64 \ 148 || defined RISCV \ 149 || defined SPARC64 \ 150 || defined TILE \ 151 || defined X32 152 # define SUPPORTED_PERSONALITIES 2 153 #else 154 # define SUPPORTED_PERSONALITIES 1 155 #endif 156 157 #if defined TILE && defined __tilepro__ 158 # define DEFAULT_PERSONALITY 1 159 #else 160 # define DEFAULT_PERSONALITY 0 161 #endif 162 163 #define PERSONALITY0_WORDSIZE SIZEOF_LONG 164 #define PERSONALITY0_KLONGSIZE SIZEOF_KERNEL_LONG_T 165 #define PERSONALITY0_INCLUDE_PRINTERS_DECLS "native_printer_decls.h" 166 #define PERSONALITY0_INCLUDE_PRINTERS_DEFS "native_printer_defs.h" 167 168 #if SUPPORTED_PERSONALITIES > 1 169 # define PERSONALITY1_WORDSIZE 4 170 # define PERSONALITY1_KLONGSIZE PERSONALITY1_WORDSIZE 171 #endif 172 173 #if SUPPORTED_PERSONALITIES > 1 && defined HAVE_M32_MPERS 174 # define PERSONALITY1_INCLUDE_PRINTERS_DECLS "m32_printer_decls.h" 175 # define PERSONALITY1_INCLUDE_PRINTERS_DEFS "m32_printer_defs.h" 176 # define PERSONALITY1_INCLUDE_FUNCS "m32_funcs.h" 177 # define MPERS_m32_IOCTL_MACROS "ioctl_redefs1.h" 178 #else 179 # define PERSONALITY1_INCLUDE_PRINTERS_DECLS "native_printer_decls.h" 180 # define PERSONALITY1_INCLUDE_PRINTERS_DEFS "native_printer_defs.h" 181 # define PERSONALITY1_INCLUDE_FUNCS "empty.h" 182 #endif 183 184 #if SUPPORTED_PERSONALITIES > 2 && defined HAVE_MX32_MPERS 185 # define PERSONALITY2_INCLUDE_FUNCS "mx32_funcs.h" 186 # define PERSONALITY2_INCLUDE_PRINTERS_DECLS "mx32_printer_decls.h" 187 # define PERSONALITY2_INCLUDE_PRINTERS_DEFS "mx32_printer_defs.h" 188 # define MPERS_mx32_IOCTL_MACROS "ioctl_redefs2.h" 189 #else 190 # define PERSONALITY2_INCLUDE_PRINTERS_DECLS "native_printer_decls.h" 191 # define PERSONALITY2_INCLUDE_PRINTERS_DEFS "native_printer_defs.h" 192 # define PERSONALITY2_INCLUDE_FUNCS "empty.h" 193 #endif 194 195 typedef struct ioctlent { 196 const char *symbol; 197 unsigned int code; 198 } struct_ioctlent; 199 200 struct inject_opts { 201 uint16_t first; 202 uint16_t step; 203 uint16_t signo; 204 int rval; 205 }; 206 207 #define MAX_ERRNO_VALUE 4095 208 #define INJECT_OPTS_RVAL_DEFAULT (-(MAX_ERRNO_VALUE + 1)) 209 210 /* Trace Control Block */ 211 struct tcb { 212 int flags; /* See below for TCB_ values */ 213 int pid; /* If 0, this tcb is free */ 214 int qual_flg; /* qual_flags[scno] or DEFAULT_QUAL_FLAGS + RAW */ 215 unsigned long u_error; /* Error code */ 216 kernel_ulong_t scno; /* System call number */ 217 kernel_ulong_t u_arg[MAX_ARGS]; /* System call arguments */ 218 kernel_long_t u_rval; /* Return value */ 219 #if SUPPORTED_PERSONALITIES > 1 220 unsigned int currpers; /* Personality at the time of scno update */ 221 #endif 222 int sys_func_rval; /* Syscall entry parser's return value */ 223 int curcol; /* Output column for this process */ 224 FILE *outf; /* Output file for this process */ 225 const char *auxstr; /* Auxiliary info from syscall (see RVAL_STR) */ 226 void *_priv_data; /* Private data for syscall decoding functions */ 227 void (*_free_priv_data)(void *); /* Callback for freeing priv_data */ 228 const struct_sysent *s_ent; /* sysent[scno] or dummy struct for bad scno */ 229 const struct_sysent *s_prev_ent; /* for "resuming interrupted SYSCALL" msg */ 230 struct inject_opts *inject_vec[SUPPORTED_PERSONALITIES]; 231 struct timeval stime; /* System time usage as of last process wait */ 232 struct timeval dtime; /* Delta for system time usage */ 233 struct timeval etime; /* Syscall entry time */ 234 235 #ifdef USE_LIBUNWIND 236 struct UPT_info* libunwind_ui; 237 struct mmap_cache_t* mmap_cache; 238 unsigned int mmap_cache_size; 239 unsigned int mmap_cache_generation; 240 struct queue_t* queue; 241 #endif 242 }; 243 244 /* TCB flags */ 245 /* We have attached to this process, but did not see it stopping yet */ 246 #define TCB_STARTUP 0x01 247 #define TCB_IGNORE_ONE_SIGSTOP 0x02 /* Next SIGSTOP is to be ignored */ 248 /* 249 * Are we in system call entry or in syscall exit? 250 * 251 * This bit is set after all syscall entry processing is done. 252 * Therefore, this bit will be set when next ptrace stop occurs, 253 * which should be syscall exit stop. Other stops which are possible 254 * directly after syscall entry (death, ptrace event stop) 255 * are simpler and handled without calling trace_syscall(), therefore 256 * the places where TCB_INSYSCALL can be set but we aren't in syscall stop 257 * are limited to trace(), this condition is never observed in trace_syscall() 258 * and below. 259 * The bit is cleared after all syscall exit processing is done. 260 * 261 * Use entering(tcp) / exiting(tcp) to check this bit to make code more readable. 262 */ 263 #define TCB_INSYSCALL 0x04 264 #define TCB_ATTACHED 0x08 /* We attached to it already */ 265 #define TCB_REPRINT 0x10 /* We should reprint this syscall on exit */ 266 #define TCB_FILTERED 0x20 /* This system call has been filtered out */ 267 #define TCB_TAMPERED 0x40 /* A syscall has been tampered with */ 268 #define TCB_HIDE_LOG 0x80 /* We should hide everything (until execve) */ 269 #define TCB_SKIP_DETACH_ON_FIRST_EXEC 0x100 /* -b execve should skip detach on first execve */ 270 271 /* qualifier flags */ 272 #define QUAL_TRACE 0x001 /* this system call should be traced */ 273 #define QUAL_ABBREV 0x002 /* abbreviate the structures of this syscall */ 274 #define QUAL_VERBOSE 0x004 /* decode the structures of this syscall */ 275 #define QUAL_RAW 0x008 /* print all args in hex for this syscall */ 276 #define QUAL_INJECT 0x010 /* tamper with this system call on purpose */ 277 #define QUAL_SIGNAL 0x100 /* report events with this signal */ 278 #define QUAL_READ 0x200 /* dump data read from this file descriptor */ 279 #define QUAL_WRITE 0x400 /* dump data written to this file descriptor */ 280 281 #define DEFAULT_QUAL_FLAGS (QUAL_TRACE | QUAL_ABBREV | QUAL_VERBOSE) 282 283 #define entering(tcp) (!((tcp)->flags & TCB_INSYSCALL)) 284 #define exiting(tcp) ((tcp)->flags & TCB_INSYSCALL) 285 #define syserror(tcp) ((tcp)->u_error != 0) 286 #define verbose(tcp) ((tcp)->qual_flg & QUAL_VERBOSE) 287 #define abbrev(tcp) ((tcp)->qual_flg & QUAL_ABBREV) 288 #define filtered(tcp) ((tcp)->flags & TCB_FILTERED) 289 #define hide_log(tcp) ((tcp)->flags & TCB_HIDE_LOG) 290 291 #include "xlat.h" 292 293 extern const struct xlat addrfams[]; 294 extern const struct xlat at_flags[]; 295 extern const struct xlat dirent_types[]; 296 extern const struct xlat evdev_abs[]; 297 extern const struct xlat msg_flags[]; 298 extern const struct xlat open_access_modes[]; 299 extern const struct xlat open_mode_flags[]; 300 extern const struct xlat resource_flags[]; 301 extern const struct xlat sg_io_info[]; 302 extern const struct xlat socketlayers[]; 303 extern const struct xlat whence_codes[]; 304 305 /* Format of syscall return values */ 306 #define RVAL_DECIMAL 000 /* decimal format */ 307 #define RVAL_HEX 001 /* hex format */ 308 #define RVAL_OCTAL 002 /* octal format */ 309 #define RVAL_UDECIMAL 003 /* unsigned decimal format */ 310 #define RVAL_FD 010 /* file descriptor */ 311 #define RVAL_MASK 013 /* mask for these values */ 312 313 #define RVAL_STR 020 /* Print `auxstr' field after return val */ 314 #define RVAL_NONE 040 /* Print nothing */ 315 316 #define RVAL_DECODED 0100 /* syscall decoding finished */ 317 318 #define IOCTL_NUMBER_UNKNOWN 0 319 #define IOCTL_NUMBER_HANDLED 1 320 #define IOCTL_NUMBER_STOP_LOOKUP 010 321 322 #define indirect_ipccall(tcp) (tcp->s_ent->sys_flags & TRACE_INDIRECT_SUBCALL) 323 324 #if defined(ARM) || defined(AARCH64) \ 325 || defined(I386) || defined(X32) || defined(X86_64) \ 326 || defined(IA64) \ 327 || defined(BFIN) \ 328 || defined(M68K) \ 329 || defined(MICROBLAZE) \ 330 || defined(RISCV) \ 331 || defined(S390) \ 332 || defined(SH) || defined(SH64) \ 333 || defined(SPARC) || defined(SPARC64) \ 334 /**/ 335 # define NEED_UID16_PARSERS 1 336 #else 337 # define NEED_UID16_PARSERS 0 338 #endif 339 340 enum sock_proto { 341 SOCK_PROTO_UNKNOWN, 342 SOCK_PROTO_UNIX, 343 SOCK_PROTO_TCP, 344 SOCK_PROTO_UDP, 345 SOCK_PROTO_TCPv6, 346 SOCK_PROTO_UDPv6, 347 SOCK_PROTO_NETLINK 348 }; 349 extern enum sock_proto get_proto_by_name(const char *); 350 351 enum iov_decode { 352 IOV_DECODE_ADDR, 353 IOV_DECODE_STR, 354 IOV_DECODE_NETLINK 355 }; 356 357 typedef enum { 358 CFLAG_NONE = 0, 359 CFLAG_ONLY_STATS, 360 CFLAG_BOTH 361 } cflag_t; 362 extern cflag_t cflag; 363 extern bool debug_flag; 364 extern bool Tflag; 365 extern bool iflag; 366 extern bool count_wallclock; 367 extern unsigned int qflag; 368 extern bool not_failing_only; 369 extern unsigned int show_fd_path; 370 /* are we filtering traces based on paths? */ 371 extern const char **paths_selected; 372 #define tracing_paths (paths_selected != NULL) 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 void error_msg(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2)); 386 void perror_msg(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2)); 387 void error_msg_and_die(const char *fmt, ...) 388 ATTRIBUTE_FORMAT((printf, 1, 2)) ATTRIBUTE_NORETURN; 389 void error_msg_and_help(const char *fmt, ...) 390 ATTRIBUTE_FORMAT((printf, 1, 2)) ATTRIBUTE_NORETURN; 391 void perror_msg_and_die(const char *fmt, ...) 392 ATTRIBUTE_FORMAT((printf, 1, 2)) ATTRIBUTE_NORETURN; 393 void die_out_of_memory(void) ATTRIBUTE_NORETURN; 394 395 void *xmalloc(size_t size) ATTRIBUTE_MALLOC ATTRIBUTE_ALLOC_SIZE((1)); 396 void *xcalloc(size_t nmemb, size_t size) 397 ATTRIBUTE_MALLOC ATTRIBUTE_ALLOC_SIZE((1, 2)); 398 void *xreallocarray(void *ptr, size_t nmemb, size_t size) 399 ATTRIBUTE_ALLOC_SIZE((2, 3)); 400 char *xstrdup(const char *str) ATTRIBUTE_MALLOC; 401 402 extern int read_int_from_file(const char *, int *); 403 404 extern void set_sortby(const char *); 405 extern void set_overhead(int); 406 extern void print_pc(struct tcb *); 407 extern int trace_syscall(struct tcb *, unsigned int *); 408 extern void count_syscall(struct tcb *, const struct timeval *); 409 extern void call_summary(FILE *); 410 411 extern void clear_regs(void); 412 extern void get_regs(pid_t pid); 413 extern int get_scno(struct tcb *tcp); 414 /** 415 * Convert syscall number to syscall name. 416 * 417 * @param scno Syscall number. 418 * @return String literal corresponding to the syscall number in case latter 419 * is valid; NULL otherwise. 420 */ 421 extern const char *syscall_name(kernel_ulong_t scno); 422 extern const char *err_name(unsigned long err); 423 424 extern bool is_erestart(struct tcb *); 425 extern void temporarily_clear_syserror(struct tcb *); 426 extern void restore_cleared_syserror(struct tcb *); 427 428 extern void *get_tcb_priv_data(const struct tcb *); 429 extern int set_tcb_priv_data(struct tcb *, void *priv_data, 430 void (*free_priv_data)(void *)); 431 extern void free_tcb_priv_data(struct tcb *); 432 433 static inline unsigned long get_tcb_priv_ulong(const struct tcb *tcp) 434 { 435 return (unsigned long) get_tcb_priv_data(tcp); 436 } 437 438 static inline int set_tcb_priv_ulong(struct tcb *tcp, unsigned long val) 439 { 440 return set_tcb_priv_data(tcp, (void *) val, 0); 441 } 442 443 extern int 444 umoven(struct tcb *tcp, kernel_ulong_t addr, unsigned int len, void *laddr); 445 #define umove(pid, addr, objp) \ 446 umoven((pid), (addr), sizeof(*(objp)), (void *) (objp)) 447 448 extern int 449 umoven_or_printaddr(struct tcb *tcp, kernel_ulong_t addr, 450 unsigned int len, void *laddr); 451 #define umove_or_printaddr(pid, addr, objp) \ 452 umoven_or_printaddr((pid), (addr), sizeof(*(objp)), (void *) (objp)) 453 454 extern int 455 umoven_or_printaddr_ignore_syserror(struct tcb *tcp, kernel_ulong_t addr, 456 unsigned int len, void *laddr); 457 458 extern int 459 umovestr(struct tcb *tcp, kernel_ulong_t addr, unsigned int len, char *laddr); 460 461 extern int upeek(int pid, unsigned long, kernel_ulong_t *); 462 extern int upoke(int pid, unsigned long, kernel_ulong_t); 463 464 extern bool 465 print_array(struct tcb *tcp, 466 kernel_ulong_t start_addr, 467 size_t nmemb, 468 void *elem_buf, 469 size_t elem_size, 470 int (*umoven_func)(struct tcb *, 471 kernel_ulong_t, 472 unsigned int, 473 void *), 474 bool (*print_func)(struct tcb *, 475 void *elem_buf, 476 size_t elem_size, 477 void *opaque_data), 478 void *opaque_data); 479 480 #if defined ALPHA || defined IA64 || defined MIPS \ 481 || defined SH || defined SPARC || defined SPARC64 482 # define HAVE_GETRVAL2 483 extern long getrval2(struct tcb *); 484 #else 485 # undef HAVE_GETRVAL2 486 #endif 487 488 extern const char *signame(const int); 489 extern void pathtrace_select(const char *); 490 extern int pathtrace_match(struct tcb *); 491 extern int getfdpath(struct tcb *, int, char *, unsigned); 492 extern enum sock_proto getfdproto(struct tcb *, int); 493 494 extern const char *xlookup(const struct xlat *, const uint64_t); 495 extern const char *xlat_search(const struct xlat *, const size_t, const uint64_t); 496 497 extern unsigned long get_pagesize(void); 498 extern int 499 string_to_uint_ex(const char *str, char **endptr, 500 unsigned int max_val, const char *accepted_ending); 501 extern int string_to_uint(const char *str); 502 static inline int 503 string_to_uint_upto(const char *const str, unsigned int max_val) 504 { 505 return string_to_uint_ex(str, NULL, max_val, NULL); 506 } 507 extern int next_set_bit(const void *bit_array, unsigned cur_bit, unsigned size_bits); 508 509 #define QUOTE_0_TERMINATED 0x01 510 #define QUOTE_OMIT_LEADING_TRAILING_QUOTES 0x02 511 #define QUOTE_OMIT_TRAILING_0 0x08 512 #define QUOTE_FORCE_HEX 0x10 513 514 extern int string_quote(const char *, char *, unsigned int, unsigned int); 515 extern int print_quoted_string(const char *, unsigned int, unsigned int); 516 517 /* a refers to the lower numbered u_arg, 518 * b refers to the higher numbered u_arg 519 */ 520 #ifdef WORDS_BIGENDIAN 521 # define ULONG_LONG(a,b) \ 522 ((unsigned long long)(unsigned)(b) | ((unsigned long long)(a)<<32)) 523 #else 524 # define ULONG_LONG(a,b) \ 525 ((unsigned long long)(unsigned)(a) | ((unsigned long long)(b)<<32)) 526 #endif 527 extern int getllval(struct tcb *, unsigned long long *, int); 528 extern int printllval(struct tcb *, const char *, int) 529 ATTRIBUTE_FORMAT((printf, 2, 0)); 530 531 extern void printaddr(kernel_ulong_t addr); 532 extern int printxvals(const uint64_t, const char *, const struct xlat *, ...) 533 ATTRIBUTE_SENTINEL; 534 extern int printxval_searchn(const struct xlat *xlat, size_t xlat_size, 535 uint64_t val, const char *dflt); 536 #define printxval_search(xlat__, val__, dflt__) \ 537 printxval_searchn(xlat__, ARRAY_SIZE(xlat__), val__, dflt__) 538 extern int printargs(struct tcb *); 539 extern int printargs_u(struct tcb *); 540 extern int printargs_d(struct tcb *); 541 542 extern void addflags(const struct xlat *, uint64_t); 543 extern int printflags64(const struct xlat *, uint64_t, const char *); 544 extern const char *sprintflags(const char *, const struct xlat *, uint64_t); 545 extern const char *sprinttime(time_t); 546 extern void print_symbolic_mode_t(unsigned int); 547 extern void print_numeric_umode_t(unsigned short); 548 extern void print_numeric_long_umask(unsigned long); 549 extern void print_dev_t(unsigned long long dev); 550 551 extern void 552 dumpiov_in_msghdr(struct tcb *, kernel_ulong_t addr, kernel_ulong_t data_size); 553 554 extern void 555 dumpiov_in_mmsghdr(struct tcb *, kernel_ulong_t addr); 556 557 extern void 558 dumpiov_upto(struct tcb *, int len, kernel_ulong_t addr, kernel_ulong_t data_size); 559 560 extern void 561 dumpstr(struct tcb *, kernel_ulong_t addr, int len); 562 563 extern void 564 printstr_ex(struct tcb *, kernel_ulong_t addr, kernel_ulong_t len, 565 unsigned int user_style); 566 567 extern void 568 printpathn(struct tcb *, kernel_ulong_t addr, unsigned int n); 569 570 extern void 571 printpath(struct tcb *, kernel_ulong_t addr); 572 573 #define TIMESPEC_TEXT_BUFSIZE \ 574 (sizeof(intmax_t)*3 * 2 + sizeof("{tv_sec=%jd, tv_nsec=%jd}")) 575 extern void printfd(struct tcb *, int); 576 extern void print_sockaddr(struct tcb *tcp, const void *, int); 577 extern bool print_sockaddr_by_inode(const unsigned long, const enum sock_proto); 578 extern bool print_sockaddr_by_inode_cached(const unsigned long); 579 extern void print_dirfd(struct tcb *, int); 580 581 extern int 582 decode_sockaddr(struct tcb *, kernel_ulong_t addr, int addrlen); 583 584 extern void printuid(const char *, const unsigned int); 585 586 extern void 587 print_sigset_addr_len(struct tcb *, kernel_ulong_t addr, kernel_ulong_t len); 588 589 extern const char *sprintsigmask_n(const char *, const void *, unsigned int); 590 #define tprintsigmask_addr(prefix, mask) \ 591 tprints(sprintsigmask_n((prefix), (mask), sizeof(mask))) 592 extern void printsignal(int); 593 594 extern void 595 tprint_iov_upto(struct tcb *, kernel_ulong_t len, kernel_ulong_t addr, 596 enum iov_decode, kernel_ulong_t data_size); 597 598 extern void 599 decode_netlink(struct tcb *, kernel_ulong_t addr, kernel_ulong_t len); 600 601 extern void tprint_open_modes(unsigned int); 602 extern const char *sprint_open_modes(unsigned int); 603 604 extern void 605 print_seccomp_filter(struct tcb *, kernel_ulong_t addr); 606 607 extern void 608 print_seccomp_fprog(struct tcb *, kernel_ulong_t addr, unsigned short len); 609 610 struct strace_stat; 611 extern void print_struct_stat(struct tcb *tcp, const struct strace_stat *const st); 612 613 struct strace_statfs; 614 615 extern void 616 print_struct_statfs(struct tcb *, kernel_ulong_t addr); 617 618 extern void 619 print_struct_statfs64(struct tcb *, kernel_ulong_t addr, kernel_ulong_t size); 620 621 extern void print_ifindex(unsigned int); 622 623 struct number_set; 624 extern struct number_set read_set; 625 extern struct number_set write_set; 626 extern struct number_set signal_set; 627 628 extern bool is_number_in_set(unsigned int number, const struct number_set *); 629 extern void qualify(const char *); 630 extern unsigned int qual_flags(const unsigned int); 631 632 #define DECL_IOCTL(name) \ 633 extern int \ 634 name ## _ioctl(struct tcb *, unsigned int request, kernel_ulong_t arg) 635 DECL_IOCTL(dm); 636 DECL_IOCTL(file); 637 DECL_IOCTL(fs_x); 638 DECL_IOCTL(ptp); 639 DECL_IOCTL(scsi); 640 DECL_IOCTL(term); 641 DECL_IOCTL(ubi); 642 DECL_IOCTL(uffdio); 643 #undef DECL_IOCTL 644 645 extern int decode_sg_io_v4(struct tcb *, const kernel_ulong_t arg); 646 647 extern int tv_nz(const struct timeval *); 648 extern int tv_cmp(const struct timeval *, const struct timeval *); 649 extern double tv_float(const struct timeval *); 650 extern void tv_add(struct timeval *, const struct timeval *, const struct timeval *); 651 extern void tv_sub(struct timeval *, const struct timeval *, const struct timeval *); 652 extern void tv_mul(struct timeval *, const struct timeval *, int); 653 extern void tv_div(struct timeval *, const struct timeval *, int); 654 655 #ifdef USE_LIBUNWIND 656 extern void unwind_init(void); 657 extern void unwind_tcb_init(struct tcb *tcp); 658 extern void unwind_tcb_fin(struct tcb *tcp); 659 extern void unwind_cache_invalidate(struct tcb* tcp); 660 extern void unwind_print_stacktrace(struct tcb* tcp); 661 extern void unwind_capture_stacktrace(struct tcb* tcp); 662 #endif 663 664 static inline void 665 printstrn(struct tcb *tcp, kernel_ulong_t addr, kernel_ulong_t len) 666 { 667 printstr_ex(tcp, addr, len, 0); 668 } 669 670 static inline void 671 printstr(struct tcb *tcp, kernel_ulong_t addr) 672 { 673 printstr_ex(tcp, addr, -1, QUOTE_0_TERMINATED); 674 } 675 676 static inline int 677 printflags(const struct xlat *x, unsigned int flags, const char *dflt) 678 { 679 return printflags64(x, flags, dflt); 680 } 681 682 static inline int 683 printxval64(const struct xlat *x, const uint64_t val, const char *dflt) 684 { 685 return printxvals(val, dflt, x, NULL); 686 } 687 688 static inline int 689 printxval(const struct xlat *x, const unsigned int val, const char *dflt) 690 { 691 return printxvals(val, dflt, x, NULL); 692 } 693 694 static inline void 695 tprint_iov(struct tcb *tcp, kernel_ulong_t len, kernel_ulong_t addr, 696 enum iov_decode decode_iov) 697 { 698 tprint_iov_upto(tcp, len, addr, decode_iov, -1); 699 } 700 701 #ifdef ALPHA 702 typedef struct { 703 int tv_sec, tv_usec; 704 } timeval32_t; 705 706 extern void print_timeval32_t(const timeval32_t *); 707 extern void printrusage32(struct tcb *, kernel_ulong_t); 708 extern const char *sprint_timeval32(struct tcb *tcp, kernel_ulong_t); 709 extern void print_timeval32(struct tcb *tcp, kernel_ulong_t); 710 extern void print_timeval32_pair(struct tcb *tcp, kernel_ulong_t); 711 extern void print_itimerval32(struct tcb *tcp, kernel_ulong_t); 712 #endif 713 714 #ifdef HAVE_STRUCT_USER_DESC 715 extern void print_user_desc(struct tcb *, kernel_ulong_t addr); 716 #endif 717 718 /* Strace log generation machinery. 719 * 720 * printing_tcp: tcb which has incomplete line being printed right now. 721 * NULL if last line has been completed ('\n'-terminated). 722 * printleader(tcp) examines it, finishes incomplete line if needed, 723 * the sets it to tcp. 724 * line_ended() clears printing_tcp and resets ->curcol = 0. 725 * tcp->curcol == 0 check is also used to detect completeness 726 * of last line, since in -ff mode just checking printing_tcp for NULL 727 * is not enough. 728 * 729 * If you change this code, test log generation in both -f and -ff modes 730 * using: 731 * strace -oLOG -f[f] test/threaded_execve 732 * strace -oLOG -f[f] test/sigkill_rain 733 * strace -oLOG -f[f] -p "`pidof web_browser`" 734 */ 735 extern struct tcb *printing_tcp; 736 extern void printleader(struct tcb *); 737 extern void line_ended(void); 738 extern void tabto(void); 739 extern void tprintf(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2)); 740 extern void tprints(const char *str); 741 742 #if SUPPORTED_PERSONALITIES > 1 743 extern void set_personality(int personality); 744 extern unsigned current_personality; 745 #else 746 # define set_personality(personality) ((void)0) 747 # define current_personality 0 748 #endif 749 750 #if SUPPORTED_PERSONALITIES == 1 751 # define current_wordsize PERSONALITY0_WORDSIZE 752 # define current_klongsize PERSONALITY0_KLONGSIZE 753 #else 754 # if SUPPORTED_PERSONALITIES == 2 && PERSONALITY0_WORDSIZE == PERSONALITY1_WORDSIZE 755 # define current_wordsize PERSONALITY0_WORDSIZE 756 # else 757 extern unsigned current_wordsize; 758 # endif 759 # if SUPPORTED_PERSONALITIES == 2 && PERSONALITY0_KLONGSIZE == PERSONALITY1_KLONGSIZE 760 # define current_klongsize PERSONALITY0_KLONGSIZE 761 # else 762 extern unsigned current_klongsize; 763 # endif 764 #endif 765 766 #define ANY_WORDSIZE_LESS_THAN_KERNEL_LONG \ 767 (SIZEOF_KERNEL_LONG_T > 4 \ 768 && (SIZEOF_LONG < SIZEOF_KERNEL_LONG_T || !defined(current_wordsize))) 769 770 #define DECL_PRINTNUM(name) \ 771 extern bool \ 772 printnum_ ## name(struct tcb *, kernel_ulong_t addr, const char *fmt) \ 773 ATTRIBUTE_FORMAT((printf, 3, 0)) 774 DECL_PRINTNUM(short); 775 DECL_PRINTNUM(int); 776 DECL_PRINTNUM(int64); 777 #undef DECL_PRINTNUM 778 779 #define DECL_PRINTNUM_ADDR(name) \ 780 extern bool \ 781 printnum_addr_ ## name(struct tcb *, kernel_ulong_t addr) 782 DECL_PRINTNUM_ADDR(int); 783 DECL_PRINTNUM_ADDR(int64); 784 #undef DECL_PRINTNUM_ADDR 785 786 #ifndef current_wordsize 787 extern bool 788 printnum_long_int(struct tcb *, kernel_ulong_t addr, 789 const char *fmt_long, const char *fmt_int) 790 ATTRIBUTE_FORMAT((printf, 3, 0)) 791 ATTRIBUTE_FORMAT((printf, 4, 0)); 792 extern bool printnum_addr_long_int(struct tcb *, kernel_ulong_t addr); 793 # define printnum_slong(tcp, addr) \ 794 printnum_long_int((tcp), (addr), "%" PRId64, "%d") 795 # define printnum_ulong(tcp, addr) \ 796 printnum_long_int((tcp), (addr), "%" PRIu64, "%u") 797 # define printnum_ptr(tcp, addr) \ 798 printnum_addr_long_int((tcp), (addr)) 799 #elif current_wordsize > 4 800 # define printnum_slong(tcp, addr) \ 801 printnum_int64((tcp), (addr), "%" PRId64) 802 # define printnum_ulong(tcp, addr) \ 803 printnum_int64((tcp), (addr), "%" PRIu64) 804 # define printnum_ptr(tcp, addr) \ 805 printnum_addr_int64((tcp), (addr)) 806 #else /* current_wordsize == 4 */ 807 # define printnum_slong(tcp, addr) \ 808 printnum_int((tcp), (addr), "%d") 809 # define printnum_ulong(tcp, addr) \ 810 printnum_int((tcp), (addr), "%u") 811 # define printnum_ptr(tcp, addr) \ 812 printnum_addr_int((tcp), (addr)) 813 #endif 814 815 #ifndef current_klongsize 816 extern bool printnum_addr_klong_int(struct tcb *, kernel_ulong_t addr); 817 # define printnum_kptr(tcp, addr) \ 818 printnum_addr_klong_int((tcp), (addr)) 819 #elif current_klongsize > 4 820 # define printnum_kptr(tcp, addr) \ 821 printnum_addr_int64((tcp), (addr)) 822 #else /* current_klongsize == 4 */ 823 # define printnum_kptr(tcp, addr) \ 824 printnum_addr_int((tcp), (addr)) 825 #endif 826 827 #define DECL_PRINTPAIR(name) \ 828 extern bool \ 829 printpair_ ## name(struct tcb *, kernel_ulong_t addr, const char *fmt) \ 830 ATTRIBUTE_FORMAT((printf, 3, 0)) 831 DECL_PRINTPAIR(int); 832 DECL_PRINTPAIR(int64); 833 #undef DECL_PRINTPAIR 834 835 static inline kernel_long_t 836 truncate_klong_to_current_wordsize(const kernel_long_t v) 837 { 838 #if ANY_WORDSIZE_LESS_THAN_KERNEL_LONG 839 if (current_wordsize < sizeof(v)) { 840 return (int) v; 841 } else 842 #endif 843 { 844 return v; 845 } 846 } 847 848 static inline kernel_ulong_t 849 truncate_kulong_to_current_wordsize(const kernel_ulong_t v) 850 { 851 #if ANY_WORDSIZE_LESS_THAN_KERNEL_LONG 852 if (current_wordsize < sizeof(v)) { 853 return (unsigned int) v; 854 } else 855 #endif 856 { 857 return v; 858 } 859 } 860 861 /* 862 * Cast a pointer or a pointer-sized integer to kernel_ulong_t. 863 */ 864 #define ptr_to_kulong(v) ((kernel_ulong_t) (unsigned long) (v)) 865 866 /* 867 * Zero-extend a signed integer type to unsigned long long. 868 */ 869 #define zero_extend_signed_to_ull(v) \ 870 (sizeof(v) == sizeof(char) ? (unsigned long long) (unsigned char) (v) : \ 871 sizeof(v) == sizeof(short) ? (unsigned long long) (unsigned short) (v) : \ 872 sizeof(v) == sizeof(int) ? (unsigned long long) (unsigned int) (v) : \ 873 sizeof(v) == sizeof(long) ? (unsigned long long) (unsigned long) (v) : \ 874 (unsigned long long) (v)) 875 876 /* 877 * Sign-extend an unsigned integer type to long long. 878 */ 879 #define sign_extend_unsigned_to_ll(v) \ 880 (sizeof(v) == sizeof(char) ? (long long) (char) (v) : \ 881 sizeof(v) == sizeof(short) ? (long long) (short) (v) : \ 882 sizeof(v) == sizeof(int) ? (long long) (int) (v) : \ 883 sizeof(v) == sizeof(long) ? (long long) (long) (v) : \ 884 (long long) (v)) 885 886 extern const struct_sysent sysent0[]; 887 extern const char *const errnoent0[]; 888 extern const char *const signalent0[]; 889 extern const struct_ioctlent ioctlent0[]; 890 891 #if SUPPORTED_PERSONALITIES > 1 892 extern const struct_sysent *sysent; 893 extern const char *const *errnoent; 894 extern const char *const *signalent; 895 extern const struct_ioctlent *ioctlent; 896 #else 897 # define sysent sysent0 898 # define errnoent errnoent0 899 # define signalent signalent0 900 # define ioctlent ioctlent0 901 #endif 902 903 extern unsigned nsyscalls; 904 extern unsigned nerrnos; 905 extern unsigned nsignals; 906 extern unsigned nioctlents; 907 908 extern const unsigned int nsyscall_vec[SUPPORTED_PERSONALITIES]; 909 extern const struct_sysent *const sysent_vec[SUPPORTED_PERSONALITIES]; 910 extern struct inject_opts *inject_vec[SUPPORTED_PERSONALITIES]; 911 912 #ifdef IN_MPERS_BOOTSTRAP 913 /* Transform multi-line MPERS_PRINTER_DECL statements to one-liners. */ 914 # define MPERS_PRINTER_DECL(type, name, ...) MPERS_PRINTER_DECL(type, name, __VA_ARGS__) 915 #else /* !IN_MPERS_BOOTSTRAP */ 916 # if SUPPORTED_PERSONALITIES > 1 917 # include "printers.h" 918 # else 919 # include "native_printer_decls.h" 920 # endif 921 # define MPERS_PRINTER_DECL(type, name, ...) type MPERS_FUNC_NAME(name)(__VA_ARGS__) 922 #endif /* !IN_MPERS_BOOTSTRAP */ 923 924 /* Checks that sysent[scno] is not out of range. */ 925 static inline bool 926 scno_in_range(kernel_ulong_t scno) 927 { 928 return scno < nsyscalls; 929 } 930 931 /* 932 * Checks whether scno is not out of range, 933 * its corresponding sysent[scno].sys_func is non-NULL, 934 * and its sysent[scno].sys_flags has no TRACE_INDIRECT_SUBCALL flag set. 935 */ 936 static inline bool 937 scno_is_valid(kernel_ulong_t scno) 938 { 939 return scno_in_range(scno) 940 && sysent[scno].sys_func 941 && !(sysent[scno].sys_flags & TRACE_INDIRECT_SUBCALL); 942 } 943 944 #define MPERS_FUNC_NAME__(prefix, name) prefix ## name 945 #define MPERS_FUNC_NAME_(prefix, name) MPERS_FUNC_NAME__(prefix, name) 946 #define MPERS_FUNC_NAME(name) MPERS_FUNC_NAME_(MPERS_PREFIX, name) 947 948 #define SYS_FUNC_NAME(syscall_name) MPERS_FUNC_NAME(syscall_name) 949 950 #define SYS_FUNC(syscall_name) int SYS_FUNC_NAME(sys_ ## syscall_name)(struct tcb *tcp) 951 952 #if SIZEOF_KERNEL_LONG_T > SIZEOF_LONG 953 # define PRI_kl "ll" 954 #else 955 # define PRI_kl "l" 956 #endif 957 958 #define PRI_kld PRI_kl"d" 959 #define PRI_klu PRI_kl"u" 960 #define PRI_klx PRI_kl"x" 961 962 /* 963 * The kernel used to define 64-bit types on 64-bit systems on a per-arch 964 * basis. Some architectures would use unsigned long and others would use 965 * unsigned long long. These types were exported as part of the 966 * kernel-userspace ABI and now must be maintained forever. This matches 967 * what the kernel exports for each architecture so we don't need to cast 968 * every printing of __u64 or __s64 to stdint types. 969 */ 970 #if SIZEOF_LONG == 4 971 # define PRI__64 "ll" 972 #elif defined ALPHA || defined IA64 || defined MIPS || defined POWERPC 973 # define PRI__64 "l" 974 #else 975 # define PRI__64 "ll" 976 #endif 977 978 #define PRI__d64 PRI__64"d" 979 #define PRI__u64 PRI__64"u" 980 #define PRI__x64 PRI__64"x" 981 982 #endif /* !STRACE_DEFS_H */ 983
