]> granicus.if.org Git - strace/blob - defs.h
mmap_cache: add function to enable mmap_cache
[strace] / 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-2018 The strace developers.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. The name of the author may not be used to endorse or promote products
17  *    derived from this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
20  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
21  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
23  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
24  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef STRACE_DEFS_H
32 #define STRACE_DEFS_H
33
34 #ifdef HAVE_CONFIG_H
35 # include "config.h"
36 #endif
37
38 #include <features.h>
39 #include <stdbool.h>
40 #include <stdint.h>
41 #include <inttypes.h>
42 #include <sys/types.h>
43 #include <stddef.h>
44 #include <unistd.h>
45 #include <stdlib.h>
46 #include <stdio.h>
47 /* Open-coding isprint(ch) et al proved more efficient than calling
48  * generalized libc interface. We don't *want* to do non-ASCII anyway.
49  */
50 /* #include <ctype.h> */
51 #include <string.h>
52 #include <errno.h>
53 #include <time.h>
54 #include <sys/time.h>
55
56 #include "arch_defs.h"
57 #include "error_prints.h"
58 #include "gcc_compat.h"
59 #include "kernel_types.h"
60 #include "macros.h"
61 #include "mpers_type.h"
62 #include "string_to_uint.h"
63 #include "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 # define HAVE_PERSONALITY_1_MPERS 1
153 #else
154 # define PERSONALITY1_INCLUDE_PRINTERS_DECLS "native_printer_decls.h"
155 # define PERSONALITY1_INCLUDE_PRINTERS_DEFS "native_printer_defs.h"
156 # define PERSONALITY1_INCLUDE_FUNCS "empty.h"
157 # define HAVE_PERSONALITY_1_MPERS 0
158 #endif
159
160 #if SUPPORTED_PERSONALITIES > 2 && defined HAVE_MX32_MPERS
161 # define PERSONALITY2_INCLUDE_FUNCS "mx32_funcs.h"
162 # define PERSONALITY2_INCLUDE_PRINTERS_DECLS "mx32_printer_decls.h"
163 # define PERSONALITY2_INCLUDE_PRINTERS_DEFS "mx32_printer_defs.h"
164 # define MPERS_mx32_IOCTL_MACROS "ioctl_redefs2.h"
165 # define HAVE_PERSONALITY_2_MPERS 1
166 #else
167 # define PERSONALITY2_INCLUDE_PRINTERS_DECLS "native_printer_decls.h"
168 # define PERSONALITY2_INCLUDE_PRINTERS_DEFS "native_printer_defs.h"
169 # define PERSONALITY2_INCLUDE_FUNCS "empty.h"
170 # define HAVE_PERSONALITY_2_MPERS 0
171 #endif
172
173 typedef struct ioctlent {
174         const char *symbol;
175         unsigned int code;
176 } struct_ioctlent;
177
178 #define INJECT_F_SIGNAL 1
179 #define INJECT_F_RETVAL 2
180
181 struct inject_data {
182         uint16_t flags;
183         uint16_t signo;
184         kernel_long_t rval;
185 };
186
187 struct inject_opts {
188         uint16_t first;
189         uint16_t step;
190         struct inject_data data;
191 };
192
193 #define MAX_ERRNO_VALUE                 4095
194
195 /* Trace Control Block */
196 struct tcb {
197         int flags;              /* See below for TCB_ values */
198         int pid;                /* If 0, this tcb is free */
199         int qual_flg;           /* qual_flags[scno] or DEFAULT_QUAL_FLAGS + RAW */
200         unsigned long u_error;  /* Error code */
201         kernel_ulong_t scno;    /* System call number */
202         kernel_ulong_t u_arg[MAX_ARGS]; /* System call arguments */
203         kernel_long_t u_rval;   /* Return value */
204 #if SUPPORTED_PERSONALITIES > 1
205         unsigned int currpers;  /* Personality at the time of scno update */
206 #endif
207         int sys_func_rval;      /* Syscall entry parser's return value */
208         int curcol;             /* Output column for this process */
209         FILE *outf;             /* Output file for this process */
210         const char *auxstr;     /* Auxiliary info from syscall (see RVAL_STR) */
211         void *_priv_data;       /* Private data for syscall decoding functions */
212         void (*_free_priv_data)(void *); /* Callback for freeing priv_data */
213         const struct_sysent *s_ent; /* sysent[scno] or dummy struct for bad scno */
214         const struct_sysent *s_prev_ent; /* for "resuming interrupted SYSCALL" msg */
215         struct inject_opts *inject_vec[SUPPORTED_PERSONALITIES];
216         struct timeval stime;   /* System time usage as of last process wait */
217         struct timeval dtime;   /* Delta for system time usage */
218         struct timeval etime;   /* Syscall entry time */
219
220         struct mmap_cache_t *mmap_cache;
221         unsigned int mmap_cache_size;
222         unsigned int mmap_cache_generation;
223
224 #ifdef USE_LIBUNWIND
225         struct UPT_info *libunwind_ui;
226         struct queue_t *queue;
227 #endif
228 };
229
230 /* TCB flags */
231 /* We have attached to this process, but did not see it stopping yet */
232 #define TCB_STARTUP             0x01
233 #define TCB_IGNORE_ONE_SIGSTOP  0x02    /* Next SIGSTOP is to be ignored */
234 /*
235  * Are we in system call entry or in syscall exit?
236  *
237  * This bit is set in syscall_entering_finish() and cleared in
238  * syscall_exiting_finish().
239  * Other stops which are possible directly after syscall entry (death, ptrace
240  * event stop) are handled without calling syscall_{entering,exiting}_*().
241  *
242  * Use entering(tcp) / exiting(tcp) to check this bit to make code more
243  * readable.
244  */
245 #define TCB_INSYSCALL   0x04
246 #define TCB_ATTACHED    0x08    /* We attached to it already */
247 #define TCB_REPRINT     0x10    /* We should reprint this syscall on exit */
248 #define TCB_FILTERED    0x20    /* This system call has been filtered out */
249 #define TCB_TAMPERED    0x40    /* A syscall has been tampered with */
250 #define TCB_HIDE_LOG    0x80    /* We should hide everything (until execve) */
251 #define TCB_SKIP_DETACH_ON_FIRST_EXEC   0x100   /* -b execve should skip detach on first execve */
252 #define TCB_GRABBED     0x200   /* We grab the process and can catch it
253                                  * in the middle of a syscall */
254 #define TCB_RECOVERING  0x400   /* We try to recover after detecting incorrect
255                                  * syscall entering/exiting state */
256
257 /* qualifier flags */
258 #define QUAL_TRACE      0x001   /* this system call should be traced */
259 #define QUAL_ABBREV     0x002   /* abbreviate the structures of this syscall */
260 #define QUAL_VERBOSE    0x004   /* decode the structures of this syscall */
261 #define QUAL_RAW        0x008   /* print all args in hex for this syscall */
262 #define QUAL_INJECT     0x010   /* tamper with this system call on purpose */
263
264 #define DEFAULT_QUAL_FLAGS (QUAL_TRACE | QUAL_ABBREV | QUAL_VERBOSE)
265
266 #define entering(tcp)   (!((tcp)->flags & TCB_INSYSCALL))
267 #define exiting(tcp)    ((tcp)->flags & TCB_INSYSCALL)
268 #define syserror(tcp)   ((tcp)->u_error != 0)
269 #define traced(tcp)     ((tcp)->qual_flg & QUAL_TRACE)
270 #define verbose(tcp)    ((tcp)->qual_flg & QUAL_VERBOSE)
271 #define abbrev(tcp)     ((tcp)->qual_flg & QUAL_ABBREV)
272 #define raw(tcp)        ((tcp)->qual_flg & QUAL_RAW)
273 #define inject(tcp)     ((tcp)->qual_flg & QUAL_INJECT)
274 #define filtered(tcp)   ((tcp)->flags & TCB_FILTERED)
275 #define hide_log(tcp)   ((tcp)->flags & TCB_HIDE_LOG)
276 #define syscall_tampered(tcp)   ((tcp)->flags & TCB_TAMPERED)
277 #define recovering(tcp) ((tcp)->flags & TCB_RECOVERING)
278
279 #include "xlat.h"
280
281 extern const struct xlat addrfams[];
282 extern const struct xlat arp_hardware_types[];
283 extern const struct xlat at_flags[];
284 extern const struct xlat clocknames[];
285 extern const struct xlat dirent_types[];
286 extern const struct xlat ethernet_protocols[];
287 extern const struct xlat evdev_abs[];
288 extern const struct xlat iffflags[];
289 extern const struct xlat inet_protocols[];
290 extern const struct xlat ip_type_of_services[];
291 extern const struct xlat msg_flags[];
292 extern const struct xlat netlink_protocols[];
293 extern const struct xlat nl_route_types[];
294 extern const struct xlat open_access_modes[];
295 extern const struct xlat open_mode_flags[];
296 extern const struct xlat resource_flags[];
297 extern const struct xlat routing_scopes[];
298 extern const struct xlat routing_table_ids[];
299 extern const struct xlat routing_types[];
300 extern const struct xlat seccomp_ret_action[];
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 tcp_state_flags[];
306 extern const struct xlat tcp_states[];
307 extern const struct xlat whence_codes[];
308
309 /* Format of syscall return values */
310 #define RVAL_DECIMAL    000     /* decimal format */
311 #define RVAL_HEX        001     /* hex format */
312 #define RVAL_OCTAL      002     /* octal format */
313 #define RVAL_UDECIMAL   003     /* unsigned decimal format */
314 #define RVAL_FD         010     /* file descriptor */
315 #define RVAL_MASK       013     /* mask for these values */
316
317 #define RVAL_STR        020     /* Print `auxstr' field after return val */
318 #define RVAL_NONE       040     /* Print nothing */
319
320 #define RVAL_DECODED    0100    /* syscall decoding finished */
321 #define RVAL_IOCTL_DECODED 0200 /* ioctl sub-parser successfully decoded
322                                    the argument */
323 #define RVAL_PRINT_ERR_VAL 0400 /* Print decoded error code along with
324                                    syscall return value.  Needed for modify_ldt
325                                    that for some reason decides to return
326                                    an error with higher bits set to 0.  */
327
328 #define IOCTL_NUMBER_UNKNOWN 0
329 #define IOCTL_NUMBER_HANDLED 1
330 #define IOCTL_NUMBER_STOP_LOOKUP 010
331
332 #define indirect_ipccall(tcp) (tcp->s_ent->sys_flags & TRACE_INDIRECT_SUBCALL)
333
334 enum sock_proto {
335         SOCK_PROTO_UNKNOWN,
336         SOCK_PROTO_UNIX,
337         SOCK_PROTO_TCP,
338         SOCK_PROTO_UDP,
339         SOCK_PROTO_TCPv6,
340         SOCK_PROTO_UDPv6,
341         SOCK_PROTO_NETLINK
342 };
343 extern enum sock_proto get_proto_by_name(const char *);
344
345 enum iov_decode {
346         IOV_DECODE_ADDR,
347         IOV_DECODE_STR,
348         IOV_DECODE_NETLINK
349 };
350
351 typedef enum {
352         CFLAG_NONE = 0,
353         CFLAG_ONLY_STATS,
354         CFLAG_BOTH
355 } cflag_t;
356 extern cflag_t cflag;
357 extern bool Tflag;
358 extern bool iflag;
359 extern bool count_wallclock;
360 extern unsigned int qflag;
361 extern bool not_failing_only;
362 extern unsigned int show_fd_path;
363 /* are we filtering traces based on paths? */
364 extern struct path_set {
365         const char **paths_selected;
366         size_t num_selected;
367         size_t size;
368 } global_path_set;
369 #define tracing_paths (global_path_set.num_selected != 0)
370 extern unsigned xflag;
371 extern unsigned followfork;
372 #ifdef USE_LIBUNWIND
373 /* if this is true do the stack trace for every system call */
374 extern bool stack_trace_enabled;
375 #endif
376 extern unsigned ptrace_setoptions;
377 extern unsigned max_strlen;
378 extern unsigned os_release;
379 #undef KERNEL_VERSION
380 #define KERNEL_VERSION(a, b, c) (((a) << 16) + ((b) << 8) + (c))
381
382 extern int read_int_from_file(struct tcb *, const char *, int *);
383
384 extern void set_sortby(const char *);
385 extern void set_overhead(int);
386 extern void print_pc(struct tcb *);
387
388 extern int syscall_entering_decode(struct tcb *);
389 extern int syscall_entering_trace(struct tcb *, unsigned int *);
390 extern void syscall_entering_finish(struct tcb *, int);
391
392 extern int syscall_exiting_decode(struct tcb *, struct timeval *);
393 extern int syscall_exiting_trace(struct tcb *, struct timeval, int);
394 extern void syscall_exiting_finish(struct tcb *);
395
396 extern void count_syscall(struct tcb *, const struct timeval *);
397 extern void call_summary(FILE *);
398
399 extern void clear_regs(struct tcb *tcp);
400 extern int get_scno(struct tcb *);
401 extern kernel_ulong_t get_rt_sigframe_addr(struct tcb *);
402
403 /**
404  * Convert a (shuffled) syscall number to the corresponding syscall name.
405  *
406  * @param scno Syscall number.
407  * @return     String literal corresponding to the syscall number in case latter
408  *             is valid; NULL otherwise.
409  */
410 extern const char *syscall_name(kernel_ulong_t scno);
411 /**
412  * Convert a syscall name to the corresponding (shuffled) syscall number.
413  *
414  * @param s     Syscall name.
415  * @param p     Personality.
416  * @param start From which position in syscall entry table resume the search.
417  * @return      Shuffled syscall number (ready to use against sysent_vec)
418  *              if syscall name is found; -1 otherwise.
419  */
420 extern kernel_long_t scno_by_name(const char *s, unsigned p,
421                                   kernel_long_t start);
422 /**
423  * Shuffle syscall numbers so that we don't have huge gaps in syscall table.
424  * The shuffling should be an involution: shuffle_scno(shuffle_scno(n)) == n.
425  *
426  * @param scno Raw or shuffled syscall number.
427  * @return     Shuffled or raw syscall number, respectively.
428  */
429 extern kernel_ulong_t shuffle_scno(kernel_ulong_t scno);
430 extern const char *err_name(unsigned long err);
431
432 extern bool is_erestart(struct tcb *);
433 extern void temporarily_clear_syserror(struct tcb *);
434 extern void restore_cleared_syserror(struct tcb *);
435
436 extern void *get_tcb_priv_data(const struct tcb *);
437 extern int set_tcb_priv_data(struct tcb *, void *priv_data,
438                              void (*free_priv_data)(void *));
439 extern void free_tcb_priv_data(struct tcb *);
440
441 static inline unsigned long get_tcb_priv_ulong(const struct tcb *tcp)
442 {
443         return (unsigned long) get_tcb_priv_data(tcp);
444 }
445
446 static inline int set_tcb_priv_ulong(struct tcb *tcp, unsigned long val)
447 {
448         return set_tcb_priv_data(tcp, (void *) val, 0);
449 }
450
451 extern int
452 umoven(struct tcb *, kernel_ulong_t addr, unsigned int len, void *laddr);
453 #define umove(pid, addr, objp)  \
454         umoven((pid), (addr), sizeof(*(objp)), (void *) (objp))
455
456 extern int
457 umoven_or_printaddr(struct tcb *, kernel_ulong_t addr,
458                     unsigned int len, void *laddr);
459 #define umove_or_printaddr(pid, addr, objp)     \
460         umoven_or_printaddr((pid), (addr), sizeof(*(objp)), (void *) (objp))
461
462 extern int
463 umoven_or_printaddr_ignore_syserror(struct tcb *, kernel_ulong_t addr,
464                                     unsigned int len, void *laddr);
465
466 extern int
467 umovestr(struct tcb *, kernel_ulong_t addr, unsigned int len, char *laddr);
468
469 extern int upeek(struct tcb *tcp, unsigned long, kernel_ulong_t *);
470 extern int upoke(struct tcb *tcp, unsigned long, kernel_ulong_t);
471
472 extern bool
473 print_array(struct tcb *,
474             kernel_ulong_t start_addr,
475             size_t nmemb,
476             void *elem_buf,
477             size_t elem_size,
478             int (*umoven_func)(struct tcb *,
479                                      kernel_ulong_t,
480                                      unsigned int,
481                                      void *),
482             bool (*print_func)(struct tcb *,
483                                      void *elem_buf,
484                                      size_t elem_size,
485                                      void *opaque_data),
486             void *opaque_data);
487
488 #if HAVE_ARCH_GETRVAL2
489 extern long getrval2(struct tcb *);
490 #endif
491
492 extern const char *signame(const int);
493 extern void pathtrace_select_set(const char *, struct path_set *);
494 extern bool pathtrace_match_set(struct tcb *, struct path_set *);
495 #define pathtrace_select(tcp)   \
496         pathtrace_select_set(tcp, &global_path_set)
497 #define pathtrace_match(tcp)    \
498         pathtrace_match_set(tcp, &global_path_set)
499 extern int getfdpath(struct tcb *, int, char *, unsigned);
500 extern unsigned long getfdinode(struct tcb *, int);
501 extern enum sock_proto getfdproto(struct tcb *, int);
502
503 extern const char *xlookup(const struct xlat *, const uint64_t);
504 extern const char *xlat_search(const struct xlat *, const size_t, const uint64_t);
505
506 struct dyxlat;
507 struct dyxlat *dyxlat_alloc(size_t nmemb);
508 void dyxlat_free(struct dyxlat *);
509 const struct xlat *dyxlat_get(const struct dyxlat *);
510 void dyxlat_add_pair(struct dyxlat *, uint64_t val, const char *str, size_t len);
511
512 const struct xlat *genl_families_xlat(struct tcb *tcp);
513
514 extern unsigned long get_pagesize(void);
515 extern int next_set_bit(const void *bit_array, unsigned cur_bit, unsigned size_bits);
516
517 /*
518  * Returns STR if it does not start with PREFIX,
519  * or a pointer to the first char in STR after PREFIX.
520  * The length of PREFIX is specified by PREFIX_LEN.
521  */
522 static inline const char *
523 str_strip_prefix_len(const char *str, const char *prefix, size_t prefix_len)
524 {
525         return strncmp(str, prefix, prefix_len) ? str : str + prefix_len;
526 }
527
528 #define STR_STRIP_PREFIX(str, prefix)   \
529         str_strip_prefix_len((str), (prefix), sizeof(prefix) - 1)
530
531 #define QUOTE_0_TERMINATED                      0x01
532 #define QUOTE_OMIT_LEADING_TRAILING_QUOTES      0x02
533 #define QUOTE_OMIT_TRAILING_0                   0x08
534 #define QUOTE_FORCE_HEX                         0x10
535 #define QUOTE_EMIT_COMMENT                      0x20
536
537 extern int string_quote(const char *, char *, unsigned int, unsigned int);
538 extern int print_quoted_string(const char *, unsigned int, unsigned int);
539 extern int print_quoted_cstring(const char *, unsigned int);
540
541 /* a refers to the lower numbered u_arg,
542  * b refers to the higher numbered u_arg
543  */
544 #ifdef WORDS_BIGENDIAN
545 # define ULONG_LONG(a, b) \
546         ((unsigned long long)(unsigned)(b) | ((unsigned long long)(a)<<32))
547 #else
548 # define ULONG_LONG(a, b) \
549         ((unsigned long long)(unsigned)(a) | ((unsigned long long)(b)<<32))
550 #endif
551 extern int getllval(struct tcb *, unsigned long long *, int);
552 extern int printllval(struct tcb *, const char *, int)
553         ATTRIBUTE_FORMAT((printf, 2, 0));
554
555 extern void printaddr(kernel_ulong_t addr);
556 extern int printxvals(const uint64_t, const char *, const struct xlat *, ...)
557         ATTRIBUTE_SENTINEL;
558 extern int printxval_searchn(const struct xlat *xlat, size_t xlat_size,
559         uint64_t val, const char *dflt);
560 #define printxval_search(xlat__, val__, dflt__) \
561         printxval_searchn(xlat__, ARRAY_SIZE(xlat__), val__, dflt__)
562 extern int sprintxval(char *buf, size_t size, const struct xlat *,
563         unsigned int val, const char *dflt);
564 extern int printargs(struct tcb *);
565 extern int printargs_u(struct tcb *);
566 extern int printargs_d(struct tcb *);
567
568 extern void addflags(const struct xlat *, uint64_t);
569 extern int printflags_ex(uint64_t, const char *, const struct xlat *, ...)
570         ATTRIBUTE_SENTINEL;
571 extern const char *sprintflags(const char *, const struct xlat *, uint64_t);
572 extern const char *sprinttime(long long sec);
573 extern const char *sprinttime_nsec(long long sec, unsigned long long nsec);
574 extern const char *sprinttime_usec(long long sec, unsigned long long usec);
575 extern void print_symbolic_mode_t(unsigned int);
576 extern void print_numeric_umode_t(unsigned short);
577 extern void print_numeric_long_umask(unsigned long);
578 extern void print_dev_t(unsigned long long dev);
579 extern void print_abnormal_hi(kernel_ulong_t);
580
581 extern kernel_ulong_t *
582 fetch_indirect_syscall_args(struct tcb *, kernel_ulong_t addr, unsigned int n_args);
583
584 extern void
585 dumpiov_in_msghdr(struct tcb *, kernel_ulong_t addr, kernel_ulong_t data_size);
586
587 extern void
588 dumpiov_in_mmsghdr(struct tcb *, kernel_ulong_t addr);
589
590 extern void
591 dumpiov_upto(struct tcb *, int len, kernel_ulong_t addr, kernel_ulong_t data_size);
592
593 extern void
594 dumpstr(struct tcb *, kernel_ulong_t addr, int len);
595
596 extern int
597 printstr_ex(struct tcb *, kernel_ulong_t addr, kernel_ulong_t len,
598             unsigned int user_style);
599
600 extern int
601 printpathn(struct tcb *, kernel_ulong_t addr, unsigned int n);
602
603 extern int
604 printpath(struct tcb *, kernel_ulong_t addr);
605
606 #define TIMESPEC_TEXT_BUFSIZE \
607                 (sizeof(long long) * 3 * 2 + sizeof("{tv_sec=-, tv_nsec=}"))
608 extern void printfd(struct tcb *, int);
609 extern void print_sockaddr(const void *sa, int len);
610 extern bool
611 print_inet_addr(int af, const void *addr, unsigned int len, const char *var_name);
612 extern bool
613 decode_inet_addr(struct tcb *, kernel_ulong_t addr,
614                  unsigned int len, int family, const char *var_name);
615 extern const char *get_sockaddr_by_inode(struct tcb *, int fd, unsigned long inode);
616 extern bool print_sockaddr_by_inode(struct tcb *, int fd, unsigned long inode);
617 extern void print_dirfd(struct tcb *, int);
618
619 extern int
620 decode_sockaddr(struct tcb *, kernel_ulong_t addr, int addrlen);
621
622 extern void printuid(const char *, const unsigned int);
623
624 extern void
625 print_sigset_addr_len(struct tcb *, kernel_ulong_t addr, kernel_ulong_t len);
626 extern void
627 print_sigset_addr(struct tcb *, kernel_ulong_t addr);
628
629 extern const char *sprintsigmask_n(const char *, const void *, unsigned int);
630 #define tprintsigmask_addr(prefix, mask) \
631         tprints(sprintsigmask_n((prefix), (mask), sizeof(mask)))
632 extern void printsignal(int);
633
634 extern void
635 tprint_iov_upto(struct tcb *, kernel_ulong_t len, kernel_ulong_t addr,
636                 enum iov_decode, kernel_ulong_t data_size);
637
638 extern void
639 decode_netlink(struct tcb *, int fd, kernel_ulong_t addr, kernel_ulong_t len);
640
641 extern void tprint_open_modes(unsigned int);
642 extern const char *sprint_open_modes(unsigned int);
643
644 extern void
645 decode_seccomp_fprog(struct tcb *, kernel_ulong_t addr);
646
647 extern void
648 print_seccomp_fprog(struct tcb *, kernel_ulong_t addr, unsigned short len);
649
650 extern void
651 decode_sock_fprog(struct tcb *, kernel_ulong_t addr);
652
653 extern void
654 print_sock_fprog(struct tcb *, kernel_ulong_t addr, unsigned short len);
655
656 struct strace_stat;
657 extern void print_struct_stat(struct tcb *, const struct strace_stat *const st);
658
659 struct strace_statfs;
660 struct strace_keyctl_kdf_params;
661
662 extern void
663 print_struct_statfs(struct tcb *, kernel_ulong_t addr);
664
665 extern void
666 print_struct_statfs64(struct tcb *, kernel_ulong_t addr, kernel_ulong_t size);
667
668 extern void print_ifindex(unsigned int);
669
670 extern void qualify(const char *);
671 extern unsigned int qual_flags(const unsigned int);
672
673 #define DECL_IOCTL(name)                                                \
674 extern int                                                              \
675 name ## _ioctl(struct tcb *, unsigned int request, kernel_ulong_t arg)  \
676 /* End of DECL_IOCTL definition. */
677
678 DECL_IOCTL(dm);
679 DECL_IOCTL(file);
680 DECL_IOCTL(fs_x);
681 DECL_IOCTL(kvm);
682 DECL_IOCTL(nsfs);
683 DECL_IOCTL(ptp);
684 DECL_IOCTL(scsi);
685 DECL_IOCTL(term);
686 DECL_IOCTL(ubi);
687 DECL_IOCTL(uffdio);
688 #undef DECL_IOCTL
689
690 extern int decode_sg_io_v4(struct tcb *, const kernel_ulong_t arg);
691
692 struct nlmsghdr;
693
694 typedef bool (*netlink_decoder_t)(struct tcb *, const struct nlmsghdr *,
695                                   kernel_ulong_t addr, unsigned int len);
696
697 #define DECL_NETLINK(name)                                              \
698 extern bool                                                             \
699 decode_netlink_ ## name(struct tcb *, const struct nlmsghdr *,          \
700                         kernel_ulong_t addr, unsigned int len)          \
701 /* End of DECL_NETLINK definition. */
702
703 DECL_NETLINK(crypto);
704 DECL_NETLINK(route);
705 DECL_NETLINK(selinux);
706 DECL_NETLINK(sock_diag);
707
708 extern int tv_nz(const struct timeval *);
709 extern int tv_cmp(const struct timeval *, const struct timeval *);
710 extern double tv_float(const struct timeval *);
711 extern void tv_add(struct timeval *, const struct timeval *, const struct timeval *);
712 extern void tv_sub(struct timeval *, const struct timeval *, const struct timeval *);
713 extern void tv_mul(struct timeval *, const struct timeval *, int);
714 extern void tv_div(struct timeval *, const struct timeval *, int);
715
716 #ifdef USE_LIBUNWIND
717 extern void unwind_init(void);
718 extern void unwind_tcb_init(struct tcb *);
719 extern void unwind_tcb_fin(struct tcb *);
720 extern void unwind_print_stacktrace(struct tcb *);
721 extern void unwind_capture_stacktrace(struct tcb *);
722 #endif
723
724 /*
725  * Keep a sorted array of cache entries,
726  * so that we can binary search through it.
727  */
728 struct mmap_cache_t {
729         /**
730          * example entry:
731          * 7fabbb09b000-7fabbb09f000 r-xp 00179000 fc:00 1180246 /lib/libc-2.11.1.so
732          *
733          * start_addr  is 0x7fabbb09b000
734          * end_addr    is 0x7fabbb09f000
735          * mmap_offset is 0x179000
736          * protections is MMAP_CACHE_PROT_READABLE|MMAP_CACHE_PROT_EXECUTABLE
737          * binary_filename is "/lib/libc-2.11.1.so"
738          */
739         unsigned long start_addr;
740         unsigned long end_addr;
741         unsigned long mmap_offset;
742         unsigned char protections;
743         char *binary_filename;
744 };
745
746 enum mmap_cache_protection {
747         MMAP_CACHE_PROT_READABLE   = 1 << 0,
748         MMAP_CACHE_PROT_WRITABLE   = 1 << 1,
749         MMAP_CACHE_PROT_EXECUTABLE = 1 << 2,
750         MMAP_CACHE_PROT_SHARED     = 1 << 3,
751 };
752
753 enum mmap_cache_rebuild_result {
754         MMAP_CACHE_REBUILD_NOCACHE,
755         MMAP_CACHE_REBUILD_READY,
756         MMAP_CACHE_REBUILD_RENEWED,
757 };
758
759 extern void mmap_cache_enable(void);
760 extern bool mmap_cache_is_enabled(void);
761 extern void mmap_cache_invalidate(struct tcb *tcp);
762 extern void mmap_cache_delete(struct tcb *tcp, const char *caller);
763 extern enum mmap_cache_rebuild_result mmap_cache_rebuild_if_invalid(struct tcb *tcp, const char *caller);
764 extern struct mmap_cache_t *mmap_cache_search(struct tcb *tcp, unsigned long ip);
765
766 static inline int
767 printstrn(struct tcb *tcp, kernel_ulong_t addr, kernel_ulong_t len)
768 {
769         return printstr_ex(tcp, addr, len, 0);
770 }
771
772 static inline int
773 printstr(struct tcb *tcp, kernel_ulong_t addr)
774 {
775         return printstr_ex(tcp, addr, -1, QUOTE_0_TERMINATED);
776 }
777
778 static inline int
779 printflags64(const struct xlat *x, uint64_t flags, const char *dflt)
780 {
781         return printflags_ex(flags, dflt, x, NULL);
782 }
783
784 static inline int
785 printflags(const struct xlat *x, unsigned int flags, const char *dflt)
786 {
787         return printflags64(x, flags, dflt);
788 }
789
790 static inline int
791 printxval64(const struct xlat *x, const uint64_t val, const char *dflt)
792 {
793         return printxvals(val, dflt, x, NULL);
794 }
795
796 static inline int
797 printxval(const struct xlat *x, const unsigned int val, const char *dflt)
798 {
799         return printxvals(val, dflt, x, NULL);
800 }
801
802 static inline void
803 tprint_iov(struct tcb *tcp, kernel_ulong_t len, kernel_ulong_t addr,
804            enum iov_decode decode_iov)
805 {
806         tprint_iov_upto(tcp, len, addr, decode_iov, -1);
807 }
808
809 #ifdef ALPHA
810 typedef struct {
811         int tv_sec, tv_usec;
812 } timeval32_t;
813
814 extern void print_timeval32_t(const timeval32_t *);
815 extern void printrusage32(struct tcb *, kernel_ulong_t);
816 extern const char *sprint_timeval32(struct tcb *, kernel_ulong_t addr);
817 extern void print_timeval32(struct tcb *, kernel_ulong_t addr);
818 extern void print_timeval32_utimes(struct tcb *, kernel_ulong_t addr);
819 extern void print_itimerval32(struct tcb *, kernel_ulong_t addr);
820 #endif
821
822 #ifdef HAVE_STRUCT_USER_DESC
823 /**
824  * Filter what to print from the point of view of the get_thread_area syscall.
825  * Kernel copies only entry_number field at first and then tries to write the
826  * whole structure.
827  */
828 enum user_desc_print_filter {
829         /* Print the "entering" part of struct user_desc - entry_number.  */
830         USER_DESC_ENTERING = 1,
831         /* Print the "exiting" part of the structure.  */
832         USER_DESC_EXITING  = 2,
833         USER_DESC_BOTH     = USER_DESC_ENTERING | USER_DESC_EXITING,
834 };
835
836 extern void print_user_desc(struct tcb *, kernel_ulong_t addr,
837                             enum user_desc_print_filter filter);
838 #endif
839
840 /* Strace log generation machinery.
841  *
842  * printing_tcp: tcb which has incomplete line being printed right now.
843  * NULL if last line has been completed ('\n'-terminated).
844  * printleader(tcp) examines it, finishes incomplete line if needed,
845  * the sets it to tcp.
846  * line_ended() clears printing_tcp and resets ->curcol = 0.
847  * tcp->curcol == 0 check is also used to detect completeness
848  * of last line, since in -ff mode just checking printing_tcp for NULL
849  * is not enough.
850  *
851  * If you change this code, test log generation in both -f and -ff modes
852  * using:
853  * strace -oLOG -f[f] test/threaded_execve
854  * strace -oLOG -f[f] test/sigkill_rain
855  * strace -oLOG -f[f] -p "`pidof web_browser`"
856  */
857 extern struct tcb *printing_tcp;
858 extern void printleader(struct tcb *);
859 extern void line_ended(void);
860 extern void tabto(void);
861 extern void tprintf(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2));
862 extern void tprints(const char *str);
863 extern void tprintf_comment(const char *fmt, ...) ATTRIBUTE_FORMAT((printf, 1, 2));
864 extern void tprints_comment(const char *str);
865
866 #if SUPPORTED_PERSONALITIES > 1
867 extern void set_personality(unsigned int personality);
868 extern unsigned current_personality;
869 #else
870 # define set_personality(personality) ((void)0)
871 # define current_personality 0
872 #endif
873
874 #if SUPPORTED_PERSONALITIES == 1
875 # define current_wordsize PERSONALITY0_WORDSIZE
876 # define current_klongsize PERSONALITY0_KLONGSIZE
877 #else
878 # if SUPPORTED_PERSONALITIES == 2 && PERSONALITY0_WORDSIZE == PERSONALITY1_WORDSIZE
879 #  define current_wordsize PERSONALITY0_WORDSIZE
880 # else
881 extern unsigned current_wordsize;
882 # endif
883 # if SUPPORTED_PERSONALITIES == 2 && PERSONALITY0_KLONGSIZE == PERSONALITY1_KLONGSIZE
884 #  define current_klongsize PERSONALITY0_KLONGSIZE
885 # else
886 extern unsigned current_klongsize;
887 # endif
888 #endif
889
890 #if SIZEOF_KERNEL_LONG_T > 4            \
891  && (SIZEOF_LONG < SIZEOF_KERNEL_LONG_T || !defined(current_wordsize))
892 # define ANY_WORDSIZE_LESS_THAN_KERNEL_LONG     1
893 #else
894 # define ANY_WORDSIZE_LESS_THAN_KERNEL_LONG     0
895 #endif
896
897 #define DECL_PRINTNUM(name)                                             \
898 extern bool                                                             \
899 printnum_ ## name(struct tcb *, kernel_ulong_t addr, const char *fmt)   \
900         ATTRIBUTE_FORMAT((printf, 3, 0))                                \
901 /* End of DECL_PRINTNUM definition. */
902
903 DECL_PRINTNUM(short);
904 DECL_PRINTNUM(int);
905 DECL_PRINTNUM(int64);
906 #undef DECL_PRINTNUM
907
908 #define DECL_PRINTNUM_ADDR(name)                                        \
909 extern bool                                                             \
910 printnum_addr_ ## name(struct tcb *, kernel_ulong_t addr)               \
911 /* End of DECL_PRINTNUM_ADDR definition. */
912
913 DECL_PRINTNUM_ADDR(int);
914 DECL_PRINTNUM_ADDR(int64);
915 #undef DECL_PRINTNUM_ADDR
916
917 #ifndef current_wordsize
918 extern bool
919 printnum_long_int(struct tcb *, kernel_ulong_t addr,
920                   const char *fmt_long, const char *fmt_int)
921         ATTRIBUTE_FORMAT((printf, 3, 0))
922         ATTRIBUTE_FORMAT((printf, 4, 0));
923 extern bool printnum_addr_long_int(struct tcb *, kernel_ulong_t addr);
924 # define printnum_slong(tcp, addr) \
925         printnum_long_int((tcp), (addr), "%" PRId64, "%d")
926 # define printnum_ulong(tcp, addr) \
927         printnum_long_int((tcp), (addr), "%" PRIu64, "%u")
928 # define printnum_ptr(tcp, addr) \
929         printnum_addr_long_int((tcp), (addr))
930 #elif current_wordsize > 4
931 # define printnum_slong(tcp, addr) \
932         printnum_int64((tcp), (addr), "%" PRId64)
933 # define printnum_ulong(tcp, addr) \
934         printnum_int64((tcp), (addr), "%" PRIu64)
935 # define printnum_ptr(tcp, addr) \
936         printnum_addr_int64((tcp), (addr))
937 #else /* current_wordsize == 4 */
938 # define printnum_slong(tcp, addr) \
939         printnum_int((tcp), (addr), "%d")
940 # define printnum_ulong(tcp, addr) \
941         printnum_int((tcp), (addr), "%u")
942 # define printnum_ptr(tcp, addr) \
943         printnum_addr_int((tcp), (addr))
944 #endif
945
946 #ifndef current_klongsize
947 extern bool printnum_addr_klong_int(struct tcb *, kernel_ulong_t addr);
948 # define printnum_kptr(tcp, addr) \
949         printnum_addr_klong_int((tcp), (addr))
950 #elif current_klongsize > 4
951 # define printnum_kptr(tcp, addr) \
952         printnum_addr_int64((tcp), (addr))
953 #else /* current_klongsize == 4 */
954 # define printnum_kptr(tcp, addr) \
955         printnum_addr_int((tcp), (addr))
956 #endif
957
958 #define DECL_PRINTPAIR(name)                                            \
959 extern bool                                                             \
960 printpair_ ## name(struct tcb *, kernel_ulong_t addr, const char *fmt)  \
961         ATTRIBUTE_FORMAT((printf, 3, 0))                                \
962 /* End of DECL_PRINTPAIR definition. */
963
964 DECL_PRINTPAIR(int);
965 DECL_PRINTPAIR(int64);
966 #undef DECL_PRINTPAIR
967
968 static inline kernel_long_t
969 truncate_klong_to_current_wordsize(const kernel_long_t v)
970 {
971 #if ANY_WORDSIZE_LESS_THAN_KERNEL_LONG
972         if (current_wordsize < sizeof(v)) {
973                 return (int) v;
974         } else
975 #endif
976         {
977                 return v;
978         }
979 }
980
981 static inline kernel_ulong_t
982 truncate_kulong_to_current_wordsize(const kernel_ulong_t v)
983 {
984 #if ANY_WORDSIZE_LESS_THAN_KERNEL_LONG
985         if (current_wordsize < sizeof(v)) {
986                 return (unsigned int) v;
987         } else
988 #endif
989         {
990                 return v;
991         }
992 }
993
994 /*
995  * Cast a pointer or a pointer-sized integer to kernel_ulong_t.
996  */
997 #define ptr_to_kulong(v) ((kernel_ulong_t) (unsigned long) (v))
998
999 /*
1000  * Zero-extend a signed integer type to unsigned long long.
1001  */
1002 #define zero_extend_signed_to_ull(v) \
1003         (sizeof(v) == sizeof(char) ? (unsigned long long) (unsigned char) (v) : \
1004          sizeof(v) == sizeof(short) ? (unsigned long long) (unsigned short) (v) : \
1005          sizeof(v) == sizeof(int) ? (unsigned long long) (unsigned int) (v) : \
1006          sizeof(v) == sizeof(long) ? (unsigned long long) (unsigned long) (v) : \
1007          (unsigned long long) (v))
1008
1009 /*
1010  * Sign-extend an unsigned integer type to long long.
1011  */
1012 #define sign_extend_unsigned_to_ll(v) \
1013         (sizeof(v) == sizeof(char) ? (long long) (char) (v) : \
1014          sizeof(v) == sizeof(short) ? (long long) (short) (v) : \
1015          sizeof(v) == sizeof(int) ? (long long) (int) (v) : \
1016          sizeof(v) == sizeof(long) ? (long long) (long) (v) : \
1017          (long long) (v))
1018
1019 extern const struct_sysent sysent0[];
1020 extern const char *const errnoent0[];
1021 extern const char *const signalent0[];
1022 extern const struct_ioctlent ioctlent0[];
1023
1024 extern const char *const personality_names[];
1025
1026 #if SUPPORTED_PERSONALITIES > 1
1027 extern const struct_sysent *sysent;
1028 extern const char *const *errnoent;
1029 extern const char *const *signalent;
1030 extern const struct_ioctlent *ioctlent;
1031 #else
1032 # define sysent     sysent0
1033 # define errnoent   errnoent0
1034 # define signalent  signalent0
1035 # define ioctlent   ioctlent0
1036 #endif
1037
1038 extern unsigned nsyscalls;
1039 extern unsigned nerrnos;
1040 extern unsigned nsignals;
1041 extern unsigned nioctlents;
1042
1043 extern const unsigned int nsyscall_vec[SUPPORTED_PERSONALITIES];
1044 extern const struct_sysent *const sysent_vec[SUPPORTED_PERSONALITIES];
1045 extern struct inject_opts *inject_vec[SUPPORTED_PERSONALITIES];
1046
1047 #ifdef IN_MPERS_BOOTSTRAP
1048 /* Transform multi-line MPERS_PRINTER_DECL statements to one-liners.  */
1049 # define MPERS_PRINTER_DECL(type, name, ...) MPERS_PRINTER_DECL(type, name, __VA_ARGS__)
1050 #else /* !IN_MPERS_BOOTSTRAP */
1051 # if SUPPORTED_PERSONALITIES > 1
1052 #  include "printers.h"
1053 # else
1054 #  include "native_printer_decls.h"
1055 # endif
1056 # define MPERS_PRINTER_DECL(type, name, ...) type MPERS_FUNC_NAME(name)(__VA_ARGS__)
1057 #endif /* !IN_MPERS_BOOTSTRAP */
1058
1059 /* Checks that sysent[scno] is not out of range. */
1060 static inline bool
1061 scno_in_range(kernel_ulong_t scno)
1062 {
1063         return scno < nsyscalls;
1064 }
1065
1066 /*
1067  * Checks whether scno is not out of range,
1068  * its corresponding sysent[scno].sys_func is non-NULL,
1069  * and its sysent[scno].sys_flags has no TRACE_INDIRECT_SUBCALL flag set.
1070  */
1071 static inline bool
1072 scno_is_valid(kernel_ulong_t scno)
1073 {
1074         return scno_in_range(scno)
1075                && sysent[scno].sys_func
1076                && !(sysent[scno].sys_flags & TRACE_INDIRECT_SUBCALL);
1077 }
1078
1079 #define MPERS_FUNC_NAME__(prefix, name) prefix ## name
1080 #define MPERS_FUNC_NAME_(prefix, name) MPERS_FUNC_NAME__(prefix, name)
1081 #define MPERS_FUNC_NAME(name) MPERS_FUNC_NAME_(MPERS_PREFIX, name)
1082
1083 #define SYS_FUNC_NAME(syscall_name) MPERS_FUNC_NAME(syscall_name)
1084
1085 #define SYS_FUNC(syscall_name) int SYS_FUNC_NAME(sys_ ## syscall_name)(struct tcb *tcp)
1086
1087 #endif /* !STRACE_DEFS_H */