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